1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
// Copyright (c) 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "ui/aura/mus/input_method_mus.h"
#include <utility>
#include "services/ws/public/mojom/constants.mojom.h"
#include "services/ws/public/mojom/ime/ime.mojom.h"
#include "services/ws/public/mojom/window_tree_constants.mojom.h"
#include "ui/aura/mus/input_method_mus_delegate.h"
#include "ui/aura/mus/text_input_client_impl.h"
#include "ui/base/ime/text_input_client.h"
#include "ui/events/event.h"
#include "ui/platform_window/mojo/ime_type_converters.h"
#include "ui/platform_window/mojo/text_input_state.mojom.h"
using ws::mojom::EventResult;
namespace aura {
namespace {
void CallEventResultCallback(InputMethodMus::EventResultCallback ack_callback,
bool handled) {
// |ack_callback| can be null if the standard form of DispatchKeyEvent() is
// called instead of the version which provides a callback. In mus+ash we
// use the version with callback, but some unittests use the standard form.
if (!ack_callback)
return;
std::move(ack_callback)
.Run(handled ? EventResult::HANDLED : EventResult::UNHANDLED);
}
} // namespace
////////////////////////////////////////////////////////////////////////////////
// InputMethodMus, public:
InputMethodMus::InputMethodMus(
ui::internal::InputMethodDelegate* delegate,
InputMethodMusDelegate* input_method_mus_delegate)
: input_method_mus_delegate_(input_method_mus_delegate) {
SetDelegate(delegate);
}
InputMethodMus::~InputMethodMus() {
// Mus won't dispatch the next key event until the existing one is acked. We
// may have KeyEvents sent to IME and awaiting the result, we need to ack
// them otherwise mus won't process the next event until it times out.
AckPendingCallbacks();
}
void InputMethodMus::Init(service_manager::Connector* connector) {
if (connector)
connector->BindInterface(ws::mojom::kServiceName, &ime_driver_);
}
ui::EventDispatchDetails InputMethodMus::DispatchKeyEvent(
ui::KeyEvent* event,
EventResultCallback ack_callback) {
DCHECK(event->type() == ui::ET_KEY_PRESSED ||
event->type() == ui::ET_KEY_RELEASED);
// If no text input client, do nothing.
if (!GetTextInputClient()) {
return DispatchKeyEventPostIME(
event,
base::BindOnce(&CallEventResultCallback, std::move(ack_callback)));
}
return SendKeyEventToInputMethod(*event, std::move(ack_callback));
}
////////////////////////////////////////////////////////////////////////////////
// InputMethodMus, ui::InputMethod implementation:
void InputMethodMus::OnFocus() {
InputMethodBase::OnFocus();
UpdateTextInputType();
}
void InputMethodMus::OnBlur() {
InputMethodBase::OnBlur();
UpdateTextInputType();
}
ui::EventDispatchDetails InputMethodMus::DispatchKeyEvent(ui::KeyEvent* event) {
ui::EventDispatchDetails dispatch_details =
DispatchKeyEvent(event, EventResultCallback());
// Mark the event as handled so that EventGenerator doesn't attempt to
// deliver event as well.
event->SetHandled();
return dispatch_details;
}
void InputMethodMus::OnTextInputTypeChanged(const ui::TextInputClient* client) {
InputMethodBase::OnTextInputTypeChanged(client);
if (!IsTextInputClientFocused(client))
return;
UpdateTextInputType();
if (!input_method_)
return;
auto text_input_state = ws::mojom::TextInputState::New(
client->GetTextInputType(), client->GetTextInputMode(),
client->GetTextDirection(), client->GetTextInputFlags());
input_method_->OnTextInputStateChanged(std::move(text_input_state));
}
void InputMethodMus::OnCaretBoundsChanged(const ui::TextInputClient* client) {
if (!IsTextInputClientFocused(client))
return;
if (input_method_)
input_method_->OnCaretBoundsChanged(client->GetCaretBounds());
NotifyTextInputCaretBoundsChanged(client);
}
void InputMethodMus::CancelComposition(const ui::TextInputClient* client) {
if (!IsTextInputClientFocused(client))
return;
if (input_method_)
input_method_->CancelComposition();
}
void InputMethodMus::OnInputLocaleChanged() {
// TODO(moshayedi): crbug.com/637418. Not supported in ChromeOS. Investigate
// whether we want to support this or not.
NOTIMPLEMENTED_LOG_ONCE();
}
bool InputMethodMus::IsCandidatePopupOpen() const {
// TODO(moshayedi): crbug.com/637416. Implement this properly when we have a
// mean for displaying candidate list popup.
NOTIMPLEMENTED_LOG_ONCE();
return false;
}
void InputMethodMus::ShowVirtualKeyboardIfEnabled() {
InputMethodBase::ShowVirtualKeyboardIfEnabled();
if (input_method_)
input_method_->ShowVirtualKeyboardIfEnabled();
}
ui::EventDispatchDetails InputMethodMus::SendKeyEventToInputMethod(
const ui::KeyEvent& event,
EventResultCallback ack_callback) {
if (!input_method_) {
// This code path is hit in tests that don't connect to the server.
DCHECK(!ack_callback);
std::unique_ptr<ui::Event> event_clone = ui::Event::Clone(event);
return DispatchKeyEventPostIME(event_clone->AsKeyEvent(),
base::NullCallback());
}
// IME driver will notify us whether it handled the event or not by calling
// ProcessKeyEventCallback(), in which we will run the |ack_callback| to tell
// the window server if client handled the event or not.
pending_callbacks_.push_back(std::move(ack_callback));
input_method_->ProcessKeyEvent(
ui::Event::Clone(event),
base::BindOnce(&InputMethodMus::ProcessKeyEventCallback,
base::Unretained(this), event));
return ui::EventDispatchDetails();
}
void InputMethodMus::OnDidChangeFocusedClient(
ui::TextInputClient* focused_before,
ui::TextInputClient* focused) {
InputMethodBase::OnDidChangeFocusedClient(focused_before, focused);
UpdateTextInputType();
// We are about to close the pipe with pending callbacks. Closing the pipe
// results in none of the callbacks being run. We have to run the callbacks
// else mus won't process the next event immediately.
AckPendingCallbacks();
if (!focused) {
input_method_ = nullptr;
input_method_ptr_.reset();
text_input_client_.reset();
return;
}
text_input_client_ =
std::make_unique<TextInputClientImpl>(focused, delegate());
if (ime_driver_) {
ws::mojom::SessionDetailsPtr details = ws::mojom::SessionDetails::New();
details->state = ws::mojom::TextInputState::New(
focused->GetTextInputType(), focused->GetTextInputMode(),
focused->GetTextDirection(), focused->GetTextInputFlags());
details->caret_bounds = focused->GetCaretBounds();
ime_driver_->StartSession(MakeRequest(&input_method_ptr_),
text_input_client_->CreateInterfacePtrAndBind(),
std::move(details));
input_method_ = input_method_ptr_.get();
}
}
void InputMethodMus::UpdateTextInputType() {
ui::TextInputType type = GetTextInputType();
ui::mojom::TextInputStatePtr state = ui::mojom::TextInputState::New();
state->type = mojo::ConvertTo<ui::mojom::TextInputType>(type);
if (input_method_mus_delegate_) {
if (type != ui::TEXT_INPUT_TYPE_NONE)
input_method_mus_delegate_->SetImeVisibility(true, std::move(state));
else
input_method_mus_delegate_->SetTextInputState(std::move(state));
}
}
void InputMethodMus::AckPendingCallbacks() {
for (auto& callback : pending_callbacks_) {
if (callback)
std::move(callback).Run(EventResult::HANDLED);
}
pending_callbacks_.clear();
}
void InputMethodMus::ProcessKeyEventCallback(
const ui::KeyEvent& event,
bool handled) {
// Remove the callback as DispatchKeyEventPostIME() may lead to calling
// AckPendingCallbacksUnhandled(), which mutates |pending_callbacks_|.
DCHECK(!pending_callbacks_.empty());
EventResultCallback ack_callback = std::move(pending_callbacks_.front());
pending_callbacks_.pop_front();
CallEventResultCallback(std::move(ack_callback), handled);
}
} // namespace aura
|
