xref: /reactos/dll/win32/imm32/precomp.h (revision ccef43f3)
1 /*
2  * PROJECT:     ReactOS IMM32
3  * LICENSE:     LGPL-2.1-or-later (https://spdx.org/licenses/LGPL-2.1-or-later)
4  * PURPOSE:     Implementing IMM32
5  * COPYRIGHT:   Copyright 1998 Patrik Stridvall
6  *              Copyright 2002, 2003, 2007 CodeWeavers, Aric Stewart
7  *              Copyright 2017 James Tabor <james.tabor@reactos.org>
8  *              Copyright 2018 Amine Khaldi <amine.khaldi@reactos.org>
9  *              Copyright 2020 Oleg Dubinskiy <oleg.dubinskij2013@yandex.ua>
10  *              Copyright 2020-2022 Katayama Hirofumi MZ <katayama.hirofumi.mz@gmail.com>
11  */
12 
13 #pragma once
14 
15 #include <stdio.h>
16 #include <stdlib.h>
17 
18 /* PSDK/NDK Headers */
19 #define WIN32_NO_STATUS
20 #include <windef.h>
21 #include <winbase.h>
22 #include <wingdi.h>
23 #include <winuser.h>
24 #include <winnls.h>
25 #include <winreg.h>
26 #include <winnls32.h>
27 #include <winver.h>
28 
29 #include <imm.h>
30 #include <ddk/immdev.h>
31 
32 #define NTOS_MODE_USER
33 #include <ndk/umtypes.h>
34 #include <ndk/pstypes.h>
35 #include <ndk/rtlfuncs.h>
36 
37 /* Public Win32K Headers */
38 #include "ntuser.h"
39 #include "ntwin32.h"
40 
41 /* Undocumented user definitions */
42 #include <undocuser.h>
43 #include <imm32_undoc.h>
44 
45 #include <strsafe.h>
46 
47 #include <wine/debug.h>
48 #include <wine/list.h>
49 
50 #define IMM_INIT_MAGIC          0x19650412
51 #define IMM_INVALID_CANDFORM    ULONG_MAX
52 #define INVALID_HOTKEY_ID       0xFFFFFFFF
53 #define MAX_CANDIDATEFORM       4
54 #define MAX_IMM_FILENAME        80
55 
56 #define LANGID_CHINESE_SIMPLIFIED   MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_SIMPLIFIED)
57 #define LANGID_CHINESE_TRADITIONAL  MAKELANGID(LANG_CHINESE, SUBLANG_CHINESE_TRADITIONAL)
58 #define LANGID_JAPANESE             MAKELANGID(LANG_JAPANESE, SUBLANG_DEFAULT)
59 
60 #define REGKEY_KEYBOARD_LAYOUTS     L"System\\CurrentControlSet\\Control\\Keyboard Layouts"
61 #define REGKEY_IMM                  L"Software\\Microsoft\\Windows NT\\CurrentVersion\\IMM"
62 
63 #define ROUNDUP4(n) (((n) + 3) & ~3)  /* DWORD alignment */
64 
65 typedef struct REG_IME
66 {
67     HKL hKL;
68     WCHAR szImeKey[20];     /* "E0XXYYYY": "E0XX" is the device handle. "YYYY" is a LANGID. */
69     WCHAR szFileName[80];   /* The IME module filename */
70 } REG_IME, *PREG_IME;
71 
72 extern HMODULE ghImm32Inst;
73 extern RTL_CRITICAL_SECTION gcsImeDpi;
74 extern PIMEDPI gpImeDpiList;
75 extern PSERVERINFO gpsi;
76 extern SHAREDINFO gSharedInfo;
77 extern HANDLE ghImmHeap;
78 
79 BOOL Imm32GetSystemLibraryPath(LPWSTR pszPath, DWORD cchPath, LPCWSTR pszFileName);
80 VOID APIENTRY LogFontAnsiToWide(const LOGFONTA *plfA, LPLOGFONTW plfW);
81 VOID APIENTRY LogFontWideToAnsi(const LOGFONTW *plfW, LPLOGFONTA plfA);
82 LPVOID FASTCALL ValidateHandleNoErr(HANDLE hObject, UINT uType);
83 LPVOID FASTCALL ValidateHandle(HANDLE hObject, UINT uType);
84 #define ValidateHwndNoErr(hwnd) ValidateHandleNoErr((hwnd), TYPE_WINDOW)
85 #define ValidateHwnd(hwnd) ValidateHandle((hwnd), TYPE_WINDOW)
86 BOOL APIENTRY Imm32CheckImcProcess(PIMC pIMC);
87 
88 LPVOID APIENTRY ImmLocalAlloc(DWORD dwFlags, DWORD dwBytes);
89 #define ImmLocalFree(lpData) HeapFree(ghImmHeap, 0, (lpData))
90 
91 LPWSTR APIENTRY Imm32WideFromAnsi(UINT uCodePage, LPCSTR pszA);
92 LPSTR APIENTRY Imm32AnsiFromWide(UINT uCodePage, LPCWSTR pszW);
93 LONG APIENTRY IchWideFromAnsi(LONG cchAnsi, LPCSTR pchAnsi, UINT uCodePage);
94 LONG APIENTRY IchAnsiFromWide(LONG cchWide, LPCWSTR pchWide, UINT uCodePage);
95 PIMEDPI APIENTRY Imm32FindOrLoadImeDpi(HKL hKL);
96 LPINPUTCONTEXT APIENTRY Imm32InternalLockIMC(HIMC hIMC, BOOL fSelect);
97 BOOL APIENTRY Imm32ReleaseIME(HKL hKL);
98 BOOL APIENTRY Imm32IsSystemJapaneseOrKorean(VOID);
99 BOOL APIENTRY Imm32IsCrossThreadAccess(HIMC hIMC);
100 BOOL APIENTRY Imm32IsCrossProcessAccess(HWND hWnd);
101 BOOL WINAPI Imm32IsImcAnsi(HIMC hIMC);
102 
103 #if 0
104     #define UNEXPECTED() ASSERT(FALSE)
105 #else
106     #define UNEXPECTED() 0
107 #endif
108 
109 /*
110  * Unexpected Condition Checkers
111  * --- Examine the condition, and then generate trace log if necessary.
112  */
113 #ifdef NDEBUG /* on Release */
114 #define IS_NULL_UNEXPECTEDLY(p) (!(p))
115 #define IS_ZERO_UNEXPECTEDLY(p) (!(p))
116 #define IS_TRUE_UNEXPECTEDLY(x) (x)
117 #define IS_FALSE_UNEXPECTEDLY(x) (!(x))
118 #define IS_ERROR_UNEXPECTEDLY(x) (!(x))
119 #else /* on Debug */
120 #define IS_NULL_UNEXPECTEDLY(p) \
121     (!(p) ? (ros_dbg_log(__WINE_DBCL_ERR, __wine_dbch___default, \
122                          __FILE__, __FUNCTION__, __LINE__, "%s was NULL\n", #p), UNEXPECTED(), TRUE) \
123           : FALSE)
124 #define IS_ZERO_UNEXPECTEDLY(p) \
125     (!(p) ? (ros_dbg_log(__WINE_DBCL_ERR, __wine_dbch___default, \
126                          __FILE__, __FUNCTION__, __LINE__, "%s was zero\n", #p), UNEXPECTED(), TRUE) \
127           : FALSE)
128 #define IS_TRUE_UNEXPECTEDLY(x) \
129     ((x) ? (ros_dbg_log(__WINE_DBCL_ERR, __wine_dbch___default, \
130                         __FILE__, __FUNCTION__, __LINE__, "%s was non-zero\n", #x), UNEXPECTED(), TRUE) \
131          : FALSE)
132 #define IS_FALSE_UNEXPECTEDLY(x) \
133     ((!(x)) ? (ros_dbg_log(__WINE_DBCL_ERR, __wine_dbch___default, \
134                            __FILE__, __FUNCTION__, __LINE__, "%s was FALSE\n", #x), UNEXPECTED(), TRUE) \
135             : FALSE)
136 #define IS_ERROR_UNEXPECTEDLY(x) \
137     ((x) != ERROR_SUCCESS ? (ros_dbg_log(__WINE_DBCL_ERR, __wine_dbch___default, \
138                                           __FILE__, __FUNCTION__, __LINE__, \
139                                           "%s was 0x%X\n", #x, (x)), TRUE) \
140                           : FALSE)
141 #endif
142 
143 #define IS_CROSS_THREAD_HIMC(hIMC)     IS_TRUE_UNEXPECTEDLY(Imm32IsCrossThreadAccess(hIMC))
144 #define IS_CROSS_PROCESS_HWND(hWnd)    IS_TRUE_UNEXPECTEDLY(Imm32IsCrossProcessAccess(hWnd))
145 #define ImeDpi_IsUnicode(pImeDpi)      ((pImeDpi)->ImeInfo.fdwProperty & IME_PROP_UNICODE)
146 #define IS_16BIT_MODE()                (GetWin32ClientInfo()->dwTIFlags & TIF_16BIT)
147 
148 DWORD APIENTRY
149 CandidateListWideToAnsi(const CANDIDATELIST *pWideCL, LPCANDIDATELIST pAnsiCL, DWORD dwBufLen,
150                         UINT uCodePage);
151 DWORD APIENTRY
152 CandidateListAnsiToWide(const CANDIDATELIST *pAnsiCL, LPCANDIDATELIST pWideCL, DWORD dwBufLen,
153                         UINT uCodePage);
154 
155 BOOL APIENTRY
156 Imm32MakeIMENotify(HIMC hIMC, HWND hwnd, DWORD dwAction, DWORD_PTR dwIndex, DWORD_PTR dwValue,
157                    DWORD_PTR dwCommand, DWORD_PTR dwData);
158 
159 DWORD APIENTRY Imm32BuildHimcList(DWORD dwThreadId, HIMC **pphList);
160 
161 INT APIENTRY
162 Imm32ImeMenuAnsiToWide(const IMEMENUITEMINFOA *pItemA, LPIMEMENUITEMINFOW pItemW,
163                        UINT uCodePage, BOOL bBitmap);
164 INT APIENTRY
165 Imm32ImeMenuWideToAnsi(const IMEMENUITEMINFOW *pItemW, LPIMEMENUITEMINFOA pItemA,
166                        UINT uCodePage);
167 
168 PIME_STATE APIENTRY Imm32FetchImeState(LPINPUTCONTEXTDX pIC, HKL hKL);
169 PIME_SUBSTATE APIENTRY Imm32FetchImeSubState(PIME_STATE pState, HKL hKL);
170 
171 BOOL APIENTRY
172 Imm32LoadImeStateSentence(LPINPUTCONTEXTDX pIC, PIME_STATE pState, HKL hKL);
173 BOOL APIENTRY
174 Imm32SaveImeStateSentence(LPINPUTCONTEXTDX pIC, PIME_STATE pState, HKL hKL);
175 
176 DWORD APIENTRY
177 Imm32ReconvertAnsiFromWide(LPRECONVERTSTRING pDest, const RECONVERTSTRING *pSrc, UINT uCodePage);
178 DWORD APIENTRY
179 Imm32ReconvertWideFromAnsi(LPRECONVERTSTRING pDest, const RECONVERTSTRING *pSrc, UINT uCodePage);
180 
181 HRESULT APIENTRY Imm32StrToUInt(LPCWSTR pszText, LPDWORD pdwValue, ULONG nBase);
182 HRESULT APIENTRY Imm32UIntToStr(DWORD dwValue, ULONG nBase, LPWSTR pszBuff, USHORT cchBuff);
183 BOOL APIENTRY Imm32LoadImeVerInfo(PIMEINFOEX pImeInfoEx);
184 UINT APIENTRY Imm32GetImeLayout(PREG_IME pLayouts, UINT cLayouts);
185 BOOL APIENTRY Imm32WriteImeLayout(HKL hKL, LPCWSTR pchFilePart, LPCWSTR pszLayoutText);
186 HKL APIENTRY Imm32AssignNewLayout(UINT cKLs, const REG_IME *pLayouts, WORD wLangID);
187 BOOL APIENTRY Imm32CopyImeFile(LPWSTR pszOldFile, LPCWSTR pszNewFile);
188 PTHREADINFO FASTCALL Imm32CurrentPti(VOID);
189 
190 HBITMAP Imm32LoadBitmapFromBytes(const BYTE *pb);
191 BOOL Imm32StoreBitmapToBytes(HBITMAP hbm, LPBYTE pbData, DWORD cbDataMax);
192