File: TSFStaticSink.h

package info (click to toggle)
firefox 147.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,683,484 kB
  • sloc: cpp: 7,607,246; javascript: 6,533,185; ansic: 3,775,227; python: 1,415,393; xml: 634,561; asm: 438,951; java: 186,241; sh: 62,752; makefile: 18,079; objc: 13,092; perl: 12,808; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (184 lines) | stat: -rw-r--r-- 5,798 bytes parent folder | download | duplicates (2)
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
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef TSFStaticSink_h
#define TSFStaticSink_h

#include <msctf.h>
#include <windows.h>
#include <winuser.h>

#include "TSFTextInputProcessorList.h"
#include "WinUtils.h"

#include "mozilla/RefPtr.h"
#include "mozilla/StaticPtr.h"

namespace mozilla::widget {

class TSFStaticSink final : public ITfInputProcessorProfileActivationSink {
 public:
  static TSFStaticSink* GetInstance();

  static void Shutdown() {
    if (sInstance) {
      sInstance->Destroy();
      sInstance = nullptr;
    }
  }

  bool Init(ITfThreadMgr* aThreadMgr,
            ITfInputProcessorProfiles* aInputProcessorProfiles);
  STDMETHODIMP QueryInterface(REFIID riid, void** ppv) {
    *ppv = nullptr;
    if (IID_IUnknown == riid ||
        IID_ITfInputProcessorProfileActivationSink == riid) {
      *ppv = static_cast<ITfInputProcessorProfileActivationSink*>(this);
    }
    if (*ppv) {
      AddRef();
      return S_OK;
    }
    return E_NOINTERFACE;
  }

  NS_INLINE_DECL_IUNKNOWN_REFCOUNTING(TSFStaticSink)

  [[nodiscard]] const nsString& GetActiveTIPKeyboardDescription() const {
    return mActiveTIPKeyboardDescription;
  }

  [[nodiscard]] static bool IsIMM_IMEActive() {
    // Use IMM API until TSFStaticSink starts to work.
    if (!sInstance || !sInstance->EnsureInitActiveTIPKeyboard()) {
      return IsIMM_IME(::GetKeyboardLayout(0));
    }
    return sInstance->mIsIMM_IME;
  }

  [[nodiscard]] static bool IsIMM_IME(HKL aHKL) {
    return (::ImmGetIMEFileNameW(aHKL, nullptr, 0) > 0);
  }

  [[nodiscard]] static bool IsTraditionalChinese() {
    EnsureInstance();
    return sInstance && sInstance->IsTraditionalChineseInternal();
  }
  [[nodiscard]] static bool IsSimplifiedChinese() {
    EnsureInstance();
    return sInstance && sInstance->IsSimplifiedChineseInternal();
  }
  [[nodiscard]] static bool IsJapanese() {
    EnsureInstance();
    return sInstance && sInstance->IsJapaneseInternal();
  }
  [[nodiscard]] static bool IsKorean() {
    EnsureInstance();
    return sInstance && sInstance->IsKoreanInternal();
  }

  /**
   * ActiveTIP() returns an ID for currently active TIP.
   * Please note that this method is expensive due to needs a lot of GUID
   * comparisons if active language ID is one of CJKT.  If you need to
   * check TIPs for a specific language, you should check current language
   * first.
   */
  [[nodiscard]] static TextInputProcessorID ActiveTIP() {
    EnsureInstance();
    if (!sInstance || !sInstance->EnsureInitActiveTIPKeyboard()) {
      return TextInputProcessorID::Unknown;
    }
    sInstance->ComputeActiveTextInputProcessor();
    if (NS_WARN_IF(sInstance->mActiveTIP ==
                   TextInputProcessorID::NotComputed)) {
      return TextInputProcessorID::Unknown;
    }
    return sInstance->mActiveTIP;
  }

  static bool GetActiveTIPNameForTelemetry(nsAString& aName);

  static bool IsMSChangJieOrMSQuickActive();
  static bool IsMSPinyinOrMSWubiActive();
  static bool IsMSJapaneseIMEActive();
  static bool IsGoogleJapaneseInputActive();
  static bool IsATOKActive();

  // Note that ATOK 2011 - 2016 refers native caret position for deciding its
  // popup window position.
  static bool IsATOKReferringNativeCaretActive();

 private:
  static void EnsureInstance() {
    if (!sInstance) {
      RefPtr<TSFStaticSink> staticSink = GetInstance();
      (void)staticSink;
    }
  }

  [[nodiscard]] bool IsTraditionalChineseInternal() const {
    return mLangID == 0x0404;
  }
  [[nodiscard]] bool IsSimplifiedChineseInternal() const {
    return mLangID == 0x0804;
  }
  [[nodiscard]] bool IsJapaneseInternal() const { return mLangID == 0x0411; }
  [[nodiscard]] bool IsKoreanInternal() const { return mLangID == 0x0412; }
  [[nodiscard]] bool IsATOKActiveInternal();

  void ComputeActiveTextInputProcessor();

  [[nodiscard]] TextInputProcessorID ComputeActiveTIPAsJapanese();
  [[nodiscard]] TextInputProcessorID ComputeActiveTIPAsTraditionalChinese();
  [[nodiscard]] TextInputProcessorID ComputeActiveTIPAsSimplifiedChinese();
  [[nodiscard]] TextInputProcessorID ComputeActiveTIPAsKorean();

 public:  // ITfInputProcessorProfileActivationSink
  STDMETHODIMP OnActivated(DWORD, LANGID, REFCLSID, REFGUID, REFGUID, HKL,
                           DWORD);

 private:
  TSFStaticSink() = default;
  virtual ~TSFStaticSink() = default;

  bool EnsureInitActiveTIPKeyboard();

  void Destroy();

  void GetTIPDescription(REFCLSID aTextService, LANGID aLangID,
                         REFGUID aProfile, nsAString& aDescription);
  [[nodiscard]] bool IsTIPCategoryKeyboard(REFCLSID aTextService,
                                           LANGID aLangID, REFGUID aProfile);

  TextInputProcessorID mActiveTIP = TextInputProcessorID::NotComputed;

  // Cookie of installing ITfInputProcessorProfileActivationSink
  DWORD mIPProfileCookie = TF_INVALID_COOKIE;

  LANGID mLangID = 0;

  // True if current IME is implemented with IMM.
  bool mIsIMM_IME = false;
  // True if OnActivated() is already called
  bool mOnActivatedCalled = false;

  RefPtr<ITfThreadMgr> mThreadMgr;
  RefPtr<ITfInputProcessorProfiles> mInputProcessorProfiles;

  // Active TIP keyboard's description.  If active language profile isn't TIP,
  // i.e., IMM-IME or just a keyboard layout, this is empty.
  nsString mActiveTIPKeyboardDescription;

  // Active TIP's GUID and CLSID
  GUID mActiveTIPGUID = GUID_NULL;
  CLSID mActiveTIPCLSID = CLSID_NULL;

  static StaticRefPtr<TSFStaticSink> sInstance;
};

}  // namespace mozilla::widget

#endif  // #ifndef TSFStaticSink_h