forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
extension_ime_util.h
86 lines (66 loc) · 3.45 KB
/
extension_ime_util.h
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
// Copyright 2013 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 CHROMEOS_IME_EXTENSION_IME_UTIL_H_
#define CHROMEOS_IME_EXTENSION_IME_UTIL_H_
#include <string>
#include "base/auto_reset.h"
#include "chromeos/chromeos_export.h"
namespace chromeos {
// Extension IME related utilities.
namespace extension_ime_util {
// Returns InputMethodID for |engine_id| in |extension_id| of extension IME.
// This function does not check |extension_id| is installed extension IME nor
// |engine_id| is really a member of |extension_id|.
std::string CHROMEOS_EXPORT GetInputMethodID(const std::string& extension_id,
const std::string& engine_id);
// Returns InputMethodID for |engine_id| in |extension_id| of component
// extension IME, This function does not check |extension_id| is component one
// nor |engine_id| is really a member of |extension_id|.
std::string CHROMEOS_EXPORT GetComponentInputMethodID(
const std::string& extension_id,
const std::string& engine_id);
// Returns extension ID if |input_method_id| is extension IME ID or component
// extension IME ID. Otherwise returns an empty string ("").
std::string CHROMEOS_EXPORT GetExtensionIDFromInputMethodID(
const std::string& input_method_id);
// Returns InputMethodID from keyboard layout (xkb) id (e.g. xkb:fr:fra).
std::string CHROMEOS_EXPORT GetInputMethodIDByKeyboardLayout(
const std::string& keyboard_layout_id);
// Returns true if |input_method_id| is extension IME ID. This function does not
// check |input_method_id| is installed extension IME.
bool CHROMEOS_EXPORT IsExtensionIME(const std::string& input_method_id);
// Returns true if |input_method_id| is component extension IME ID. This
// function does not check |input_method_id| is really whitelisted one or not.
// If you want to check |input_method_id| is whitelisted component extension
// IME, please use ComponentExtensionIMEManager::IsWhitelisted instead.
bool CHROMEOS_EXPORT IsComponentExtensionIME(
const std::string& input_method_id);
// Returns true if the |input_method| is a member of |extension_id| of extension
// IME, otherwise returns false.
bool CHROMEOS_EXPORT IsMemberOfExtension(const std::string& input_method_id,
const std::string& extension_id);
// Returns true if the |input_method_id| is the extension based xkb keyboard,
// otherwise returns false.
bool CHROMEOS_EXPORT IsKeyboardLayoutExtension(
const std::string& input_method_id);
// Returns true to use the wrapped extension keyboards instead of the legacy
// xkb keyboards, returns false otherwise.
bool CHROMEOS_EXPORT UseWrappedExtensionKeyboardLayouts();
// Gets legacy xkb id (e.g. xkb:us::eng) from the new extension based xkb id
// (e.g. _comp_ime_...xkb:us::eng). If the given id is not prefixed with
// 'xkb:', just return the same as the given id.
std::string CHROMEOS_EXPORT MaybeGetLegacyXkbId(
const std::string& input_method_id);
// The scoped class to temporarily set the flag to use extension based xkb
// keyboards for testing.
class CHROMEOS_EXPORT ScopedUseExtensionKeyboardFlagForTesting {
public:
explicit ScopedUseExtensionKeyboardFlagForTesting(bool new_flag);
~ScopedUseExtensionKeyboardFlagForTesting();
private:
base::AutoReset<bool> auto_reset_;
};
} // namespace extension_ime_util
} // namespace chromeos
#endif // CHROMEOS_IME_EXTENSION_IME_UTIL_H_