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
|
// Copyright (c) 2012 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.
#ifndef CHROME_BROWSER_EXTENSIONS_API_INPUT_IME_INPUT_IME_API_H_
#define CHROME_BROWSER_EXTENSIONS_API_INPUT_IME_INPUT_IME_API_H_
#include <map>
#include <string>
#include <vector>
#include "base/macros.h"
#include "base/memory/singleton.h"
#include "base/scoped_observer.h"
#include "base/values.h"
#include "build/build_config.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/input_method/input_method_engine_base.h"
#include "chrome/common/extensions/api/input_ime.h"
#include "components/keyed_service/core/keyed_service.h"
#include "content/public/browser/notification_observer.h"
#include "content/public/browser/notification_registrar.h"
#include "extensions/browser/browser_context_keyed_api_factory.h"
#include "extensions/browser/event_router.h"
#include "extensions/browser/extension_function.h"
#include "extensions/browser/extension_registry_observer.h"
#include "extensions/common/extension.h"
#include "ui/base/ime/ime_bridge_observer.h"
#include "ui/base/ime/ime_engine_handler_interface.h"
#include "ui/base/ime/text_input_flags.h"
#if defined(OS_CHROMEOS)
#include "chrome/browser/extensions/api/input_ime/input_ime_api_chromeos.h"
#elif defined(OS_LINUX) || defined(OS_WIN)
#include "chrome/browser/extensions/api/input_ime/input_ime_api_nonchromeos.h"
#endif // defined(OS_CHROMEOS)
class Profile;
namespace ui {
class IMEEngineHandlerInterface;
class ImeObserver : public input_method::InputMethodEngineBase::Observer {
public:
ImeObserver(const std::string& extension_id, Profile* profile);
~ImeObserver() override = default;
// input_method::InputMethodEngineBase::Observer overrides.
void OnActivate(const std::string& component_id) override;
void OnFocus(const IMEEngineHandlerInterface::InputContext& context) override;
void OnBlur(int context_id) override;
void OnKeyEvent(
const std::string& component_id,
const input_method::InputMethodEngineBase::KeyboardEvent& event,
IMEEngineHandlerInterface::KeyEventDoneCallback key_data) override;
void OnReset(const std::string& component_id) override;
void OnDeactivated(const std::string& component_id) override;
void OnCompositionBoundsChanged(
const std::vector<gfx::Rect>& bounds) override;
void OnSurroundingTextChanged(const std::string& component_id,
const std::string& text,
int cursor_pos,
int anchor_pos,
int offset_pos) override;
protected:
// Helper function used to forward the given event to the |profile_|'s event
// router, which dipatches the event the extension with |extension_id_|.
virtual void DispatchEventToExtension(
extensions::events::HistogramValue histogram_value,
const std::string& event_name,
std::unique_ptr<base::ListValue> args) = 0;
// Returns the type of the current screen.
virtual std::string GetCurrentScreenType() = 0;
// Returns true if the extension is ready to accept key event, otherwise
// returns false.
bool ShouldForwardKeyEvent() const;
// Returns true if there are any listeners on the given event.
// TODO(https://crbug.com/835699): Merge this with |ExtensionHasListener|.
bool HasListener(const std::string& event_name) const;
// Returns true if the extension has any listeners on the given event.
bool ExtensionHasListener(const std::string& event_name) const;
// Functions used to convert InputContext struct to string
std::string ConvertInputContextType(
IMEEngineHandlerInterface::InputContext input_context);
virtual bool ConvertInputContextAutoCorrect(
IMEEngineHandlerInterface::InputContext input_context);
virtual bool ConvertInputContextAutoComplete(
IMEEngineHandlerInterface::InputContext input_context);
virtual bool ConvertInputContextSpellCheck(
IMEEngineHandlerInterface::InputContext input_context);
std::string extension_id_;
Profile* profile_;
private:
extensions::api::input_ime::AutoCapitalizeType
ConvertInputContextAutoCapitalize(
IMEEngineHandlerInterface::InputContext input_context);
DISALLOW_COPY_AND_ASSIGN(ImeObserver);
};
} // namespace ui
namespace extensions {
class InputImeEventRouter;
class ExtensionRegistry;
class InputImeEventRouterFactory {
public:
static InputImeEventRouterFactory* GetInstance();
InputImeEventRouter* GetRouter(Profile* profile);
void RemoveProfile(Profile* profile);
private:
friend struct base::DefaultSingletonTraits<InputImeEventRouterFactory>;
InputImeEventRouterFactory();
~InputImeEventRouterFactory();
std::map<Profile*, InputImeEventRouter*, ProfileCompare> router_map_;
DISALLOW_COPY_AND_ASSIGN(InputImeEventRouterFactory);
};
class InputImeKeyEventHandledFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("input.ime.keyEventHandled",
INPUT_IME_KEYEVENTHANDLED)
protected:
~InputImeKeyEventHandledFunction() override = default;
// ExtensionFunction:
ResponseAction Run() override;
};
class InputImeSetCompositionFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("input.ime.setComposition",
INPUT_IME_SETCOMPOSITION)
protected:
~InputImeSetCompositionFunction() override = default;
// ExtensionFunction:
ResponseAction Run() override;
};
class InputImeCommitTextFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("input.ime.commitText", INPUT_IME_COMMITTEXT)
protected:
~InputImeCommitTextFunction() override = default;
// ExtensionFunction:
ResponseAction Run() override;
};
class InputImeSendKeyEventsFunction : public ExtensionFunction {
public:
DECLARE_EXTENSION_FUNCTION("input.ime.sendKeyEvents", INPUT_IME_SENDKEYEVENTS)
protected:
~InputImeSendKeyEventsFunction() override = default;
// ExtensionFunction:
ResponseAction Run() override;
};
class InputImeAPI : public BrowserContextKeyedAPI,
public ExtensionRegistryObserver,
public EventRouter::Observer,
public content::NotificationObserver {
public:
explicit InputImeAPI(content::BrowserContext* context);
~InputImeAPI() override;
// BrowserContextKeyedAPI implementation.
static BrowserContextKeyedAPIFactory<InputImeAPI>* GetFactoryInstance();
void Shutdown() override;
// ExtensionRegistryObserver implementation.
void OnExtensionLoaded(content::BrowserContext* browser_context,
const Extension* extension) override;
void OnExtensionUnloaded(content::BrowserContext* browser_context,
const Extension* extension,
UnloadedExtensionReason reason) override;
// EventRouter::Observer implementation.
void OnListenerAdded(const EventListenerInfo& details) override;
// content::NotificationObserver:
void Observe(int type,
const content::NotificationSource& source,
const content::NotificationDetails& details) override;
private:
friend class BrowserContextKeyedAPIFactory<InputImeAPI>;
InputImeEventRouter* input_ime_event_router();
// BrowserContextKeyedAPI implementation.
static const char* service_name() {
return "InputImeAPI";
}
static const bool kServiceIsNULLWhileTesting = true;
content::BrowserContext* const browser_context_;
// Listen to extension load, unloaded notifications.
ScopedObserver<ExtensionRegistry, ExtensionRegistryObserver>
extension_registry_observer_{this};
content::NotificationRegistrar registrar_;
std::unique_ptr<ui::IMEBridgeObserver> observer_;
};
InputImeEventRouter* GetInputImeEventRouter(Profile* profile);
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_API_INPUT_IME_INPUT_IME_API_H_
|
