[reactos] 01/01: [IMM32] Many renamings and 'Win:' info (#4438)

[Katayama Hirofumi MZ]

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=bc8a4ac37b3d34a9b44d7…

commit bc8a4ac37b3d34a9b44d736be098199d6f6d91df
Author:     Katayama Hirofumi MZ <katayama.hirofumi.mz(a)gmail.com>
AuthorDate: Sat Apr 9 10:41:39 2022 +0900
Commit:     GitHub <noreply(a)github.com>
CommitDate: Sat Apr 9 10:41:39 2022 +0900

    [IMM32] Many renamings and 'Win:' info (#4438)
    
    - Add many Win: comments.
    - s/Imm32UnloadIME/Imm32FreeIME/
    - s/Imm32LoadImeInfo/Imm32LoadIME/
    - s/g_hImm32Inst/ghImm32Inst/
    - s/Imm32AllocAndBuildHimcList/Imm32BuildHimcList/
    - s/Imm32SelectLayout/Imm32SelectInputContext/
    CORE-11700
---
 dll/win32/imm32/candidate.c |  2 ++
 dll/win32/imm32/ime.c       | 20 ++++++++++++--------
 dll/win32/imm32/imm.c       | 31 +++++++++++++++++--------------
 dll/win32/imm32/precomp.h   |  5 ++---
 dll/win32/imm32/utils.c     | 13 ++++++++++++-
 5 files changed, 45 insertions(+), 26 deletions(-)

diff --git a/dll/win32/imm32/candidate.c b/dll/win32/imm32/candidate.c
index 3fc12bfbeaa..028d1233fa3 100644
--- a/dll/win32/imm32/candidate.c
+++ b/dll/win32/imm32/candidate.c
@@ -9,6 +9,7 @@
 
 WINE_DEFAULT_DEBUG_CHANNEL(imm);
 
+// Win: InternalGetCandidateListWtoA
 DWORD APIENTRY
 CandidateListWideToAnsi(const CANDIDATELIST *pWideCL, LPCANDIDATELIST pAnsiCL, DWORD
dwBufLen,
                         UINT uCodePage)
@@ -78,6 +79,7 @@ CandidateListWideToAnsi(const CANDIDATELIST *pWideCL, LPCANDIDATELIST
pAnsiCL, D
     return dwBufLen;
 }
 
+// Win: InternalGetCandidateListAtoW
 DWORD APIENTRY
 CandidateListAnsiToWide(const CANDIDATELIST *pAnsiCL, LPCANDIDATELIST pWideCL, DWORD
dwBufLen,
                         UINT uCodePage)
diff --git a/dll/win32/imm32/ime.c b/dll/win32/imm32/ime.c
index 327dc2f49fb..5b7720363aa 100644
--- a/dll/win32/imm32/ime.c
+++ b/dll/win32/imm32/ime.c
@@ -16,6 +16,7 @@ WINE_DEFAULT_DEBUG_CHANNEL(imm);
 RTL_CRITICAL_SECTION gcsImeDpi; // Win: gcsImeDpi
 PIMEDPI gpImeDpiList = NULL; // Win: gpImeDpi
 
+// Win: ImmGetImeDpi
 PIMEDPI APIENTRY Imm32FindImeDpi(HKL hKL)
 {
     PIMEDPI pImeDpi;
@@ -32,7 +33,7 @@ PIMEDPI APIENTRY Imm32FindImeDpi(HKL hKL)
 }
 
 // Win: UnloadIME
-VOID APIENTRY Imm32UnloadIME(PIMEDPI pImeDpi, BOOL bDestroy)
+VOID APIENTRY Imm32FreeIME(PIMEDPI pImeDpi, BOOL bDestroy)
 {
     if (pImeDpi->hInst == NULL)
         return;
@@ -42,6 +43,7 @@ VOID APIENTRY Imm32UnloadIME(PIMEDPI pImeDpi, BOOL bDestroy)
     pImeDpi->hInst = NULL;
 }
 
+// Win: InquireIme
 BOOL APIENTRY Imm32InquireIme(PIMEDPI pImeDpi)
 {
     WCHAR szUIClass[64];
@@ -147,7 +149,8 @@ BOOL APIENTRY Imm32InquireIme(PIMEDPI pImeDpi)
     return GetClassInfoW(pImeDpi->hInst, pImeDpi->szUIClass, &wcW);
 }
 
-BOOL APIENTRY Imm32LoadImeInfo(PIMEINFOEX pImeInfoEx, PIMEDPI pImeDpi)
+// Win: LoadIME
+BOOL APIENTRY Imm32LoadIME(PIMEINFOEX pImeInfoEx, PIMEDPI pImeDpi)
 {
     WCHAR szPath[MAX_PATH];
     HINSTANCE hIME;
@@ -163,7 +166,7 @@ BOOL APIENTRY Imm32LoadImeInfo(PIMEINFOEX pImeInfoEx, PIMEDPI
pImeDpi)
         hIME = LoadLibraryW(szPath);
         if (hIME == NULL)
         {
-            ERR("Imm32LoadImeInfo: LoadLibraryW(%S) failed\n", szPath);
+            ERR("Imm32LoadIME: LoadLibraryW(%S) failed\n", szPath);
             return FALSE;
         }
     }
@@ -215,6 +218,7 @@ Failed:
     return ret;
 }
 
+// Win: LoadImeDpi
 PIMEDPI APIENTRY Ime32LoadImeDpi(HKL hKL, BOOL bLock)
 {
     IMEINFOEX ImeInfoEx;
@@ -242,7 +246,7 @@ PIMEDPI APIENTRY Ime32LoadImeDpi(HKL hKL, BOOL bLock)
         uCodePage = CP_ACP;
     pImeDpiNew->uCodePage = uCodePage;
 
-    if (!Imm32LoadImeInfo(&ImeInfoEx, pImeDpiNew))
+    if (!Imm32LoadIME(&ImeInfoEx, pImeDpiNew))
     {
         ImmLocalFree(pImeDpiNew);
         return FALSE;
@@ -257,8 +261,7 @@ PIMEDPI APIENTRY Ime32LoadImeDpi(HKL hKL, BOOL bLock)
             pImeDpiFound->dwFlags &= ~IMEDPI_FLAG_LOCKED;
 
         RtlLeaveCriticalSection(&gcsImeDpi);
-
-        Imm32UnloadIME(pImeDpiNew, FALSE);
+        Imm32FreeIME(pImeDpiNew, FALSE);
         ImmLocalFree(pImeDpiNew);
         return pImeDpiFound;
     }
@@ -304,6 +307,7 @@ ImeDpi_Escape(PIMEDPI pImeDpi, HIMC hIMC, UINT uSubFunc, LPVOID
lpData, HKL hKL)
     return 0;
 }
 
+// Win: ImmUnloadIME
 BOOL APIENTRY Imm32ReleaseIME(HKL hKL)
 {
     BOOL ret = TRUE;
@@ -343,7 +347,7 @@ BOOL APIENTRY Imm32ReleaseIME(HKL hKL)
         }
     }
 
-    Imm32UnloadIME(pImeDpi0, TRUE);
+    Imm32FreeIME(pImeDpi0, TRUE);
     ImmLocalFree(pImeDpi0);
 
 Quit:
@@ -789,7 +793,7 @@ VOID WINAPI ImmUnlockImeDpi(PIMEDPI pImeDpi)
         }
     }
 
-    Imm32UnloadIME(pImeDpi, TRUE);
+    Imm32FreeIME(pImeDpi, TRUE);
     ImmLocalFree(pImeDpi);
 
     RtlLeaveCriticalSection(&gcsImeDpi);
diff --git a/dll/win32/imm32/imm.c b/dll/win32/imm32/imm.c
index 2260a50e74e..4a440d9fb41 100644
--- a/dll/win32/imm32/imm.c
+++ b/dll/win32/imm32/imm.c
@@ -13,10 +13,10 @@
 
 WINE_DEFAULT_DEBUG_CHANNEL(imm);
 
-HMODULE g_hImm32Inst = NULL;
-PSERVERINFO gpsi = NULL;
-SHAREDINFO gSharedInfo = { NULL };
-BYTE g_bClientRegd = FALSE;
+HMODULE ghImm32Inst = NULL; // Win: ghInst
+PSERVERINFO gpsi = NULL; // Win: gpsi
+SHAREDINFO gSharedInfo = { NULL }; // Win: gSharedInfo
+BYTE gfImmInitialized = FALSE; // Win: gfInitialized
 
 // Win: ImmInitializeGlobals
 static BOOL APIENTRY ImmInitializeGlobals(HMODULE hMod)
@@ -24,16 +24,16 @@ static BOOL APIENTRY ImmInitializeGlobals(HMODULE hMod)
     NTSTATUS status;
 
     if (hMod)
-        g_hImm32Inst = hMod;
+        ghImm32Inst = hMod;
 
-    if (g_bClientRegd)
+    if (gfImmInitialized)
         return TRUE;
 
     status = RtlInitializeCriticalSection(&gcsImeDpi);
     if (NT_ERROR(status))
         return FALSE;
 
-    g_bClientRegd = TRUE;
+    gfImmInitialized = TRUE;
     return TRUE;
 }
 
@@ -178,7 +178,8 @@ Retry:
     return TRUE;
 }
 
-VOID APIENTRY Imm32SelectLayout(HKL hNewKL, HKL hOldKL, HIMC hIMC)
+// Win: SelectInputContext
+VOID APIENTRY Imm32SelectInputContext(HKL hNewKL, HKL hOldKL, HIMC hIMC)
 {
     PCLIENTIMC pClientImc;
     LPINPUTCONTEXTDX pIC;
@@ -424,14 +425,16 @@ typedef struct SELECT_LAYOUT
     HKL hOldKL;
 } SELECT_LAYOUT, *LPSELECT_LAYOUT;
 
-static BOOL CALLBACK Imm32SelectLayoutProc(HIMC hIMC, LPARAM lParam)
+// Win: SelectContextProc
+static BOOL CALLBACK Imm32SelectContextProc(HIMC hIMC, LPARAM lParam)
 {
     LPSELECT_LAYOUT pSelect = (LPSELECT_LAYOUT)lParam;
-    Imm32SelectLayout(pSelect->hNewKL, pSelect->hOldKL, hIMC);
+    Imm32SelectInputContext(pSelect->hNewKL, pSelect->hOldKL, hIMC);
     return TRUE;
 }
 
-static BOOL CALLBACK Imm32NotifyCompStrProc(HIMC hIMC, LPARAM lParam)
+// Win: NotifyIMEProc
+static BOOL CALLBACK Imm32NotifyIMEProc(HIMC hIMC, LPARAM lParam)
 {
     ImmNotifyIME(hIMC, NI_COMPOSITIONSTR, (DWORD)lParam, 0);
     return TRUE;
@@ -466,7 +469,7 @@ BOOL WINAPI ImmActivateLayout(HKL hKL)
                 lParam = CPS_CANCEL;
             ImmUnlockImeDpi(pImeDpi);
 
-            ImmEnumInputContext(0, Imm32NotifyCompStrProc, lParam);
+            ImmEnumInputContext(0, Imm32NotifyIMEProc, lParam);
         }
 
         hwndDefIME = ImmGetDefaultIMEWnd(NULL);
@@ -478,7 +481,7 @@ BOOL WINAPI ImmActivateLayout(HKL hKL)
 
     SelectLayout.hNewKL = hKL;
     SelectLayout.hOldKL = hOldKL;
-    ImmEnumInputContext(0, Imm32SelectLayoutProc, (LPARAM)&SelectLayout);
+    ImmEnumInputContext(0, Imm32SelectContextProc, (LPARAM)&SelectLayout);
 
     if (IsWindow(hwndDefIME))
         SendMessageW(hwndDefIME, WM_IME_SELECT, TRUE, (LPARAM)hKL);
@@ -1099,7 +1102,7 @@ BOOL WINAPI ImmEnumInputContext(DWORD dwThreadId, IMCENUMPROC lpfn,
LPARAM lPara
 
     TRACE("(%lu, %p, %p)\n", dwThreadId, lpfn, lParam);
 
-    dwCount = Imm32AllocAndBuildHimcList(dwThreadId, &phList);
+    dwCount = Imm32BuildHimcList(dwThreadId, &phList);
     if (!dwCount)
         return FALSE;
 
diff --git a/dll/win32/imm32/precomp.h b/dll/win32/imm32/precomp.h
index d6310c7e536..f80fe47781c 100644
--- a/dll/win32/imm32/precomp.h
+++ b/dll/win32/imm32/precomp.h
@@ -69,12 +69,11 @@ typedef struct REG_IME
     WCHAR szFileName[80];   /* The IME module filename */
 } REG_IME, *PREG_IME;
 
-extern HMODULE g_hImm32Inst;
+extern HMODULE ghImm32Inst;
 extern RTL_CRITICAL_SECTION gcsImeDpi;
 extern PIMEDPI gpImeDpiList;
 extern PSERVERINFO gpsi;
 extern SHAREDINFO gSharedInfo;
-extern BYTE g_bClientRegd;
 extern HANDLE ghImmHeap;
 
 BOOL Imm32GetSystemLibraryPath(LPWSTR pszPath, DWORD cchPath, LPCWSTR pszFileName);
@@ -127,7 +126,7 @@ BOOL APIENTRY
 Imm32MakeIMENotify(HIMC hIMC, HWND hwnd, DWORD dwAction, DWORD_PTR dwIndex, DWORD_PTR
dwValue,
                    DWORD_PTR dwCommand, DWORD_PTR dwData);
 
-DWORD APIENTRY Imm32AllocAndBuildHimcList(DWORD dwThreadId, HIMC **pphList);
+DWORD APIENTRY Imm32BuildHimcList(DWORD dwThreadId, HIMC **pphList);
 
 INT APIENTRY
 Imm32ImeMenuAnsiToWide(const IMEMENUITEMINFOA *pItemA, LPIMEMENUITEMINFOW pItemW,
diff --git a/dll/win32/imm32/utils.c b/dll/win32/imm32/utils.c
index 319a670ec69..810bd0acd58 100644
--- a/dll/win32/imm32/utils.c
+++ b/dll/win32/imm32/utils.c
@@ -15,6 +15,7 @@ WINE_DEFAULT_DEBUG_CHANNEL(imm);
 
 HANDLE ghImmHeap = NULL; // Win: pImmHeap
 
+// Win: StrToUInt
 HRESULT APIENTRY
 Imm32StrToUInt(LPCWSTR pszText, LPDWORD pdwValue, ULONG nBase)
 {
@@ -266,7 +267,8 @@ Imm32MakeIMENotify(HIMC hIMC, HWND hwnd, DWORD dwAction, DWORD_PTR
dwIndex, DWOR
     return TRUE;
 }
 
-DWORD APIENTRY Imm32AllocAndBuildHimcList(DWORD dwThreadId, HIMC **pphList)
+// Win: BuildHimcList
+DWORD APIENTRY Imm32BuildHimcList(DWORD dwThreadId, HIMC **pphList)
 {
 #define INITIAL_COUNT 0x40
 #define MAX_RETRY 10
@@ -304,6 +306,7 @@ DWORD APIENTRY Imm32AllocAndBuildHimcList(DWORD dwThreadId, HIMC
**pphList)
 #undef MAX_RETRY
 }
 
+// Win: ConvertImeMenuItemInfoAtoW
 INT APIENTRY
 Imm32ImeMenuAnsiToWide(const IMEMENUITEMINFOA *pItemA, LPIMEMENUITEMINFOW pItemW,
                        UINT uCodePage, BOOL bBitmap)
@@ -330,6 +333,7 @@ Imm32ImeMenuAnsiToWide(const IMEMENUITEMINFOA *pItemA,
LPIMEMENUITEMINFOW pItemW
     return ret;
 }
 
+// Win: ConvertImeMenuItemInfoWtoA
 INT APIENTRY
 Imm32ImeMenuWideToAnsi(const IMEMENUITEMINFOW *pItemW, LPIMEMENUITEMINFOA pItemA,
                        UINT uCodePage)
@@ -353,6 +357,7 @@ Imm32ImeMenuWideToAnsi(const IMEMENUITEMINFOW *pItemW,
LPIMEMENUITEMINFOA pItemA
     return ret;
 }
 
+// Win: GetImeModeSaver
 PIME_STATE APIENTRY
 Imm32FetchImeState(LPINPUTCONTEXTDX pIC, HKL hKL)
 {
@@ -376,6 +381,7 @@ Imm32FetchImeState(LPINPUTCONTEXTDX pIC, HKL hKL)
     return pState;
 }
 
+// Win: GetImePrivateModeSaver
 PIME_SUBSTATE APIENTRY
 Imm32FetchImeSubState(PIME_STATE pState, HKL hKL)
 {
@@ -395,6 +401,7 @@ Imm32FetchImeSubState(PIME_STATE pState, HKL hKL)
     return pSubState;
 }
 
+// Win: RestorePrivateMode
 BOOL APIENTRY
 Imm32LoadImeStateSentence(LPINPUTCONTEXTDX pIC, PIME_STATE pState, HKL hKL)
 {
@@ -407,6 +414,7 @@ Imm32LoadImeStateSentence(LPINPUTCONTEXTDX pIC, PIME_STATE pState, HKL
hKL)
     return FALSE;
 }
 
+// Win: SavePrivateMode
 BOOL APIENTRY
 Imm32SaveImeStateSentence(LPINPUTCONTEXTDX pIC, PIME_STATE pState, HKL hKL)
 {
@@ -550,6 +558,7 @@ static FN_GetFileVersionInfoW s_fnGetFileVersionInfoW = NULL;
 static FN_GetFileVersionInfoSizeW s_fnGetFileVersionInfoSizeW = NULL;
 static FN_VerQueryValueW s_fnVerQueryValueW = NULL;
 
+// Win: LoadFixVersionInfo
 static BOOL APIENTRY Imm32LoadImeFixedInfo(PIMEINFOEX pInfoEx, LPCVOID pVerInfo)
 {
     UINT cbFixed = 0;
@@ -566,6 +575,7 @@ static BOOL APIENTRY Imm32LoadImeFixedInfo(PIMEINFOEX pInfoEx, LPCVOID
pVerInfo)
     return TRUE;
 }
 
+// Win: GetVersionDatum
 static LPWSTR APIENTRY
 Imm32GetVerInfoValue(LPCVOID pVerInfo, LPWSTR pszKey, DWORD cchKey, LPCWSTR pszName)
 {
@@ -582,6 +592,7 @@ Imm32GetVerInfoValue(LPCVOID pVerInfo, LPWSTR pszKey, DWORD cchKey,
LPCWSTR pszN
     return (cbValue ? pszValue : NULL);
 }
 
+// Win: LoadVarVersionInfo
 BOOL APIENTRY Imm32LoadImeLangAndDesc(PIMEINFOEX pInfoEx, LPCVOID pVerInfo)
 {
     BOOL ret;