1 /*
2 * Copyright (c) 2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #include "core/common/ime/text_input_client.h"
17
18 #include "core/pipeline_ng/pipeline_context.h"
19
20 namespace OHOS::Ace {
21 namespace {
22 using tic = TextInputClient; // give it a shorter name to maintain a good code layout
23 }
24
25 // Here declares function keys which can be handled by TextInputClient.
26 std::map<KeyComb, std::function<bool(TextInputClient*)>> TextInputClient::functionKeys_ = {
27 { KeyComb(KeyCode::KEY_ESCAPE), &tic::HandleOnEscape },
__anon1d5a884c0202() 28 { KeyComb(KeyCode::KEY_TAB), [](tic* c) -> bool { return c->HandleOnTab(false); } },
__anon1d5a884c0302() 29 { KeyComb(KeyCode::KEY_TAB, KEY_SHIFT), [](tic* c) -> bool { return c->HandleOnTab(true); } },
30 };
31
32 // Here declares keyboard shortcuts which should be handled and consumed by TextInputClient.
33 std::map<KeyComb, std::function<void(TextInputClient*)>> TextInputClient::keyboardShortCuts_ = {
34 // actions
35 #if defined(MAC_PLATFORM)
36 { KeyComb(KeyCode::KEY_A, KEY_META), &tic::HandleOnSelectAll },
__anon1d5a884c0402() 37 { KeyComb(KeyCode::KEY_C, KEY_META), [](tic* c) -> void { c->HandleOnCopy(true); } },
__anon1d5a884c0502() 38 { KeyComb(KeyCode::KEY_D, KEY_META), [](tic* c) -> void { c->HandleOnDelete(true); } },
39 { KeyComb(KeyCode::KEY_V, KEY_META), &tic::HandleOnPaste },
40 { KeyComb(KeyCode::KEY_X, KEY_META), &tic::HandleOnCut },
41 { KeyComb(KeyCode::KEY_Y, KEY_META), &tic::HandleOnRedoAction },
42 { KeyComb(KeyCode::KEY_Z, KEY_META), &tic::HandleOnUndoAction },
43 { KeyComb(KeyCode::KEY_Z, KEY_META | KEY_SHIFT), &tic::HandleOnRedoAction },
44 #else
45 { KeyComb(KeyCode::KEY_A, KEY_CTRL), &tic::HandleOnSelectAll },
46 { KeyComb(KeyCode::KEY_C, KEY_CTRL), [](tic* c) -> void { c->HandleOnCopy(true); } },
47 { KeyComb(KeyCode::KEY_D, KEY_CTRL), [](tic* c) -> void { c->HandleOnDelete(true); } },
48 { KeyComb(KeyCode::KEY_V, KEY_CTRL), &tic::HandleOnPaste },
49 { KeyComb(KeyCode::KEY_X, KEY_CTRL), &tic::HandleOnCut },
50 { KeyComb(KeyCode::KEY_Y, KEY_CTRL), &tic::HandleOnRedoAction },
51 { KeyComb(KeyCode::KEY_Z, KEY_CTRL), &tic::HandleOnUndoAction },
52 { KeyComb(KeyCode::KEY_Z, KEY_CTRL | KEY_SHIFT), &tic::HandleOnRedoAction },
53 #endif
__anon1d5a884c0602() 54 { KeyComb(KeyCode::KEY_DEL), [](tic* c) -> void { c->HandleOnDelete(true); } },
__anon1d5a884c0702() 55 { KeyComb(KeyCode::KEY_FORWARD_DEL), [](tic* c) -> void { c->HandleOnDelete(false); } },
__anon1d5a884c0802() 56 { KeyComb(KeyCode::KEY_DEL, KEY_CTRL), [](tic* c) -> void { c->HandleOnDeleteComb(true); } },
__anon1d5a884c0902() 57 { KeyComb(KeyCode::KEY_FORWARD_DEL, KEY_CTRL), [](tic* c) -> void { c->HandleOnDeleteComb(false); } },
__anon1d5a884c0a02() 58 { KeyComb(KeyCode::KEY_INSERT, KEY_CTRL), [](tic* c) -> void { c->HandleOnCopy(true); } },
59 { KeyComb(KeyCode::KEY_INSERT, KEY_SHIFT), &tic::HandleOnPaste },
60 { KeyComb(KeyCode::KEY_PASTE), &tic::HandleOnPaste },
61 { KeyComb(KeyCode::KEY_F10, KEY_SHIFT), &tic::HandleOnShowMenu },
62 { KeyComb(KeyCode::KEY_MENU), &tic::HandleOnShowMenu },
63 { KeyComb(KeyCode::KEY_ENTER), &tic::HandleOnEnter },
64 { KeyComb(KeyCode::KEY_NUMPAD_ENTER), &tic::HandleOnEnter },
65 { KeyComb(KeyCode::KEY_DPAD_CENTER), &tic::HandleOnEnter },
66 { KeyComb(KeyCode::KEY_ENTER, KEY_CTRL), &tic::HandleOnEnter },
67 { KeyComb(KeyCode::KEY_NUMPAD_ENTER, KEY_CTRL), &tic::HandleOnEnter },
68 { KeyComb(KeyCode::KEY_DPAD_CENTER, KEY_CTRL), &tic::HandleOnEnter },
69 // caret move keys
__anon1d5a884c0b02() 70 { KeyComb(KeyCode::KEY_DPAD_LEFT), [](tic* c) -> void { c->CursorMove(CaretMoveIntent::Left); } },
__anon1d5a884c0c02() 71 { KeyComb(KeyCode::KEY_DPAD_RIGHT), [](tic* c) -> void { c->CursorMove(CaretMoveIntent::Right); } },
__anon1d5a884c0d02() 72 { KeyComb(KeyCode::KEY_DPAD_UP), [](tic* c) -> void { c->CursorMove(CaretMoveIntent::Up); } },
__anon1d5a884c0e02() 73 { KeyComb(KeyCode::KEY_DPAD_DOWN), [](tic* c) -> void { c->CursorMove(CaretMoveIntent::Down); } },
__anon1d5a884c0f02() 74 { KeyComb(KeyCode::KEY_MOVE_HOME), [](tic* c) -> void { c->CursorMove(CaretMoveIntent::LineBegin); } },
__anon1d5a884c1002() 75 { KeyComb(KeyCode::KEY_MOVE_END), [](tic* c) -> void { c->CursorMove(CaretMoveIntent::LineEnd); } },
__anon1d5a884c1102() 76 { KeyComb(KeyCode::KEY_DPAD_LEFT, KEY_CTRL), [](tic* c) -> void { c->CursorMove(CaretMoveIntent::LeftWord); } },
__anon1d5a884c1202() 77 { KeyComb(KeyCode::KEY_DPAD_RIGHT, KEY_CTRL), [](tic* c) -> void { c->CursorMove(CaretMoveIntent::RightWord); } },
__anon1d5a884c1302() 78 { KeyComb(KeyCode::KEY_DPAD_UP, KEY_CTRL), [](tic* c) -> void { c->CursorMove(CaretMoveIntent::ParagraghBegin); } },
__anon1d5a884c1402() 79 { KeyComb(KeyCode::KEY_DPAD_DOWN, KEY_CTRL), [](tic* c) -> void { c->CursorMove(CaretMoveIntent::ParagraghEnd); } },
__anon1d5a884c1502() 80 { KeyComb(KeyCode::KEY_MOVE_HOME, KEY_CTRL), [](tic* c) -> void { c->CursorMove(CaretMoveIntent::Home); } },
__anon1d5a884c1602() 81 { KeyComb(KeyCode::KEY_MOVE_END, KEY_CTRL), [](tic* c) -> void { c->CursorMove(CaretMoveIntent::End); } },
82 // select key combinations
__anon1d5a884c1702() 83 { KeyComb(KeyCode::KEY_DPAD_LEFT, KEY_SHIFT), [](tic* c) -> void { c->HandleSelect(CaretMoveIntent::Left); } },
__anon1d5a884c1802() 84 { KeyComb(KeyCode::KEY_DPAD_RIGHT, KEY_SHIFT), [](tic* c) -> void { c->HandleSelect(CaretMoveIntent::Right); } },
__anon1d5a884c1902() 85 { KeyComb(KeyCode::KEY_DPAD_UP, KEY_SHIFT), [](tic* c) -> void { c->HandleSelect(CaretMoveIntent::Up); } },
__anon1d5a884c1a02() 86 { KeyComb(KeyCode::KEY_DPAD_DOWN, KEY_SHIFT), [](tic* c) -> void { c->HandleSelect(CaretMoveIntent::Down); } },
__anon1d5a884c1b02() 87 { KeyComb(KeyCode::KEY_MOVE_HOME, KEY_SHIFT), [](tic* c) -> void { c->HandleSelect(CaretMoveIntent::LineBegin); } },
__anon1d5a884c1c02() 88 { KeyComb(KeyCode::KEY_MOVE_END, KEY_SHIFT), [](tic* c) -> void { c->HandleSelect(CaretMoveIntent::LineEnd); } },
89 { KeyComb(KeyCode::KEY_DPAD_LEFT, KEY_CTRL | KEY_SHIFT),
__anon1d5a884c1d02() 90 [](tic* c) -> void { c->HandleSelect(CaretMoveIntent::LeftWord); } },
91 { KeyComb(KeyCode::KEY_DPAD_RIGHT, KEY_CTRL | KEY_SHIFT),
__anon1d5a884c1e02() 92 [](tic* c) -> void { c->HandleSelect(CaretMoveIntent::RightWord); } },
93 { KeyComb(KeyCode::KEY_DPAD_UP, KEY_CTRL | KEY_SHIFT),
__anon1d5a884c1f02() 94 [](tic* c) -> void { c->CursorMove(CaretMoveIntent::ParagraghBegin); } },
95 { KeyComb(KeyCode::KEY_DPAD_DOWN, KEY_CTRL | KEY_SHIFT),
__anon1d5a884c2002() 96 [](tic* c) -> void { c->CursorMove(CaretMoveIntent::ParagraghEnd); } },
97 { KeyComb(KeyCode::KEY_MOVE_HOME, KEY_CTRL | KEY_SHIFT),
__anon1d5a884c2102() 98 [](tic* c) -> void { c->CursorMove(CaretMoveIntent::Home); } },
99 { KeyComb(KeyCode::KEY_MOVE_END, KEY_CTRL | KEY_SHIFT),
__anon1d5a884c2202() 100 [](tic* c) -> void { c->CursorMove(CaretMoveIntent::End); } },
__anon1d5a884c2302() 101 { KeyComb(KeyCode::KEY_B, KEY_CTRL), [](tic* c) -> void { c->HandleSelectFontStyle(KeyCode::KEY_B); } },
__anon1d5a884c2402() 102 { KeyComb(KeyCode::KEY_I, KEY_CTRL), [](tic* c) -> void { c->HandleSelectFontStyle(KeyCode::KEY_I); } },
__anon1d5a884c2502() 103 { KeyComb(KeyCode::KEY_U, KEY_CTRL), [](tic* c) -> void { c->HandleSelectFontStyle(KeyCode::KEY_U); } },
104 };
105
NotifyKeyboardHeight(uint32_t height)106 void TextInputClient::NotifyKeyboardHeight(uint32_t height)
107 {
108 auto pipeline = NG::PipelineContext::GetCurrentContext();
109 CHECK_NULL_VOID(pipeline);
110 auto manager = pipeline->GetSafeAreaManager();
111 CHECK_NULL_VOID(manager);
112 manager->SetkeyboardHeightConsideringUIExtension(height);
113 }
114
HandleKeyEvent(const KeyEvent & keyEvent)115 bool TextInputClient::HandleKeyEvent(const KeyEvent& keyEvent)
116 {
117 if (keyEvent.action != KeyAction::DOWN) {
118 return false;
119 }
120 uint32_t ctrlFlag =
121 (keyEvent.HasKey(KeyCode::KEY_CTRL_LEFT) || keyEvent.HasKey(KeyCode::KEY_CTRL_RIGHT) ? KEY_CTRL : KEY_NULL);
122 bool vFlag = keyEvent.HasKey(KeyCode::KEY_V);
123 if (!keyEvent.msg.empty() && ctrlFlag == KEY_CTRL && vFlag) {
124 InsertValue(keyEvent.msg);
125 return true;
126 }
127 uint32_t modKeyFlags =
128 (keyEvent.HasKey(KeyCode::KEY_ALT_LEFT) || keyEvent.HasKey(KeyCode::KEY_ALT_RIGHT) ? KEY_ALT : KEY_NULL) |
129 (keyEvent.HasKey(KeyCode::KEY_SHIFT_LEFT) || keyEvent.HasKey(KeyCode::KEY_SHIFT_RIGHT) ? KEY_SHIFT : KEY_NULL) |
130 (keyEvent.HasKey(KeyCode::KEY_CTRL_LEFT) || keyEvent.HasKey(KeyCode::KEY_CTRL_RIGHT) ? KEY_CTRL : KEY_NULL) |
131 (keyEvent.HasKey(KeyCode::KEY_META_LEFT) || keyEvent.HasKey(KeyCode::KEY_META_RIGHT) ? KEY_META : KEY_NULL);
132 if (modKeyFlags == KEY_NULL || modKeyFlags == KEY_SHIFT) {
133 auto value = keyEvent.ConvertCodeToString();
134 if (value != "") {
135 InsertValue(value, true);
136 return true;
137 }
138 }
139 auto iterFunctionKeys = functionKeys_.find(KeyComb(keyEvent.code, modKeyFlags));
140 if (iterFunctionKeys != functionKeys_.end()) {
141 TAG_LOGD(AceLogTag::ACE_KEYBOARD, "find a function key, key code: %{public}d, modKeyFlags: %{public}d",
142 static_cast<int32_t>(keyEvent.code), modKeyFlags);
143 return iterFunctionKeys->second(this);
144 }
145 auto iterKeyboardShortCuts = keyboardShortCuts_.find(KeyComb(keyEvent.code, modKeyFlags));
146 if (iterKeyboardShortCuts != keyboardShortCuts_.end()) {
147 TAG_LOGD(AceLogTag::ACE_KEYBOARD, "find a keyboard shortcut, key code: %{public}d, modKeyFlags: %{public}d",
148 static_cast<int32_t>(keyEvent.code), modKeyFlags);
149 iterKeyboardShortCuts->second(this);
150 return true;
151 }
152 return false;
153 }
154 } // namespace OHOS::Ace
155