[IMM32][SDK] Add install.c and move some code (reactos#8032)

Splitting IME installation code for code readability.
JIRA issue: CORE-19268
- Add win32ss/user/imm32/install.c.
- Move some code to install.c.
- Add SAL annotations. Use debugstr_a/_w macro.
- Modify <imm32_undoc.h>.
- Don't CharUpperW for IME pathname due to
  security reason.

Author: katahiromz

sdk/include/reactos/imm32_undoc.h

@@ -230,6 +230,14 @@ BOOL WINAPI ImmSetActiveContext(_In_ HWND hwnd, _In_ HIMC hIMC, _In_ BOOL fFlag)
 BOOL WINAPI ImmLoadIME(_In_ HKL hKL);
 DWORD WINAPI ImmProcessKey(_In_ HWND, _In_ HKL, _In_ UINT, _In_ LPARAM, _In_ DWORD);
 LRESULT WINAPI ImmPutImeMenuItemsIntoMappedFile(_In_ HIMC hIMC);
+BOOL WINAPI ImmWINNLSGetEnableStatus(_In_opt_ HWND hWnd);
+BOOL WINAPI ImmSetActiveContextConsoleIME(_In_ HWND hwnd, _In_ BOOL fFlag);
+
+LRESULT WINAPI
+ImmSystemHandler(
+    _In_ HIMC hIMC,
+    _Inout_opt_ WPARAM wParam,
+    _Inout_opt_ LPARAM lParam);
 
 BOOL WINAPI ImmIMPGetIMEA(_In_opt_ HWND hWnd, _Out_ LPIMEPROA pImePro);
 BOOL WINAPI ImmIMPGetIMEW(_In_opt_ HWND hWnd, _Out_ LPIMEPROW pImePro);
@@ -251,9 +259,9 @@ VOID WINAPI CtfImmCoUninitialize(VOID);
 VOID WINAPI CtfImmEnterCoInitCountSkipMode(VOID);
 BOOL WINAPI CtfImmLeaveCoInitCountSkipMode(VOID);
 HRESULT WINAPI CtfImmLastEnabledWndDestroy(_In_ BOOL bCreate);
-BOOL WINAPI CtfImmIsCiceroStartedInThread(VOID);
 HRESULT WINAPI CtfImmTIMActivate(_In_ HKL hKL);
 BOOL WINAPI CtfImmIsTextFrameServiceDisabled(VOID);
+BOOL WINAPI CtfImmIsCiceroEnabled(VOID);
 
 LRESULT WINAPI
 CtfImmDispatchDefImeMessage(

win32ss/user/imm32/CMakeLists.txt

@@ -14,6 +14,7 @@ list(APPEND SOURCE
     imemenu.c
     imepro.c
     imm.c
+    install.c
     keymsg.c
     regword.c
     softkbd.c

win32ss/user/imm32/candidate.c

@@ -9,7 +9,8 @@
 
 WINE_DEFAULT_DEBUG_CHANNEL(imm);
 
-// Win: InternalGetCandidateListWtoA
+#define ROUNDUP4(n) (((n) + 3) & ~3)  /* DWORD alignment */
+
 DWORD APIENTRY
 CandidateListWideToAnsi(const CANDIDATELIST *pWideCL, LPCANDIDATELIST pAnsiCL, DWORD dwBufLen,
                         UINT uCodePage)

win32ss/user/imm32/ctf.c

@@ -1130,52 +1130,52 @@ CtfImmTIMActivate(_In_ HKL hKL)
     {
         TRACE("g_disable_CUAS_flag\n");
         GetWin32ClientInfo()->CI_flags |= CI_TSFDISABLED;
-        return FALSE;
+        return S_OK;
     }
 
     if (GetWin32ClientInfo()->CI_flags & CI_TSFDISABLED)
     {
         TRACE("CI_TSFDISABLED\n");
-        return FALSE;
+        return S_OK;
     }
 
     if (Imm32IsTIMDisabledInRegistry())
     {
         TRACE("TIM is disabled in registry\n");
         GetWin32ClientInfo()->CI_flags |= CI_TSFDISABLED;
-        return FALSE;
+        return S_OK;
     }
 
     if (!Imm32IsInteractiveUserLogon() || Imm32IsRunningInMsoobe())
     {
         TRACE("TIM is disabled due to LOGON or MSOBE\n");
-        return FALSE;
+        return S_OK;
     }
 
     if (!Imm32IsCUASEnabledInRegistry())
     {
         TRACE("CUAS is disabled in registry\n");
         GetWin32ClientInfo()->CI_flags |= CI_TSFDISABLED;
-        return FALSE;
+        return S_OK;
     }
 
     if (NtCurrentTeb()->ProcessEnvironmentBlock->AppCompatFlags.LowPart & 0x100)
     {
         TRACE("CUAS is disabled by AppCompatFlags\n");
         GetWin32ClientInfo()->CI_flags |= CI_TSFDISABLED;
-        return FALSE;
+        return S_OK;
     }
 
     if (RtlIsThreadWithinLoaderCallout() || Imm32InsideLoaderLock())
     {
         TRACE("TIM is disabled by Loader\n");
-        return FALSE;
+        return S_OK;
     }
 
     if (!IS_CICERO_MODE() || IS_16BIT_MODE())
     {
         TRACE("TIM is disabled because CICERO mode is unset\n");
-        return FALSE;
+        return S_OK;
     }
 
     if (IS_IME_HKL(hKL))

win32ss/user/imm32/ime.c

@@ -424,138 +424,6 @@ BOOL APIENTRY Imm32ReleaseIME(HKL hKL)
     return ret;
 }
 
-/***********************************************************************
- *		ImmInstallIMEA (IMM32.@)
- */
-HKL WINAPI ImmInstallIMEA(LPCSTR lpszIMEFileName, LPCSTR lpszLayoutText)
-{
-    HKL hKL = NULL;
-    LPWSTR pszFileNameW = NULL, pszLayoutTextW = NULL;
-
-    TRACE("(%s, %s)\n", lpszIMEFileName, lpszLayoutText);
-
-    pszFileNameW = Imm32WideFromAnsi(CP_ACP, lpszIMEFileName);
-    if (IS_NULL_UNEXPECTEDLY(pszFileNameW))
-        goto Quit;
-
-    pszLayoutTextW = Imm32WideFromAnsi(CP_ACP, lpszLayoutText);
-    if (IS_NULL_UNEXPECTEDLY(pszLayoutTextW))
-        goto Quit;
-
-    hKL = ImmInstallIMEW(pszFileNameW, pszLayoutTextW);
-
-Quit:
-    ImmLocalFree(pszFileNameW);
-    ImmLocalFree(pszLayoutTextW);
-    return hKL;
-}
-
-/***********************************************************************
- *		ImmInstallIMEW (IMM32.@)
- */
-HKL WINAPI ImmInstallIMEW(LPCWSTR lpszIMEFileName, LPCWSTR lpszLayoutText)
-{
-    WCHAR szImeFileName[MAX_PATH], szImeDestPath[MAX_PATH], szImeKey[20];
-    IMEINFOEX InfoEx;
-    LPWSTR pchFilePart;
-    UINT iLayout, cLayouts;
-    HKL hNewKL;
-    WORD wLangID;
-    PREG_IME pLayouts = NULL;
-
-    TRACE("(%S, %S)\n", lpszIMEFileName, lpszLayoutText);
-
-    GetFullPathNameW(lpszIMEFileName, _countof(szImeFileName), szImeFileName, &pchFilePart);
-    CharUpperW(szImeFileName);
-    if (IS_NULL_UNEXPECTEDLY(pchFilePart))
-        return NULL;
-
-    /* Load the IME version info */
-    InfoEx.hkl = hNewKL = NULL;
-    StringCchCopyW(InfoEx.wszImeFile, _countof(InfoEx.wszImeFile), pchFilePart);
-    if (!Imm32LoadImeVerInfo(&InfoEx) || !InfoEx.hkl)
-    {
-        ERR("\n");
-        return NULL;
-    }
-    wLangID = LOWORD(InfoEx.hkl);
-
-    /* Get the IME layouts from registry */
-    cLayouts = Imm32GetImeLayout(NULL, 0);
-    if (cLayouts)
-    {
-        pLayouts = ImmLocalAlloc(0, cLayouts * sizeof(REG_IME));
-        if (IS_NULL_UNEXPECTEDLY(pLayouts))
-            return NULL;
-
-        if (!Imm32GetImeLayout(pLayouts, cLayouts))
-        {
-            ERR("\n");
-            ImmLocalFree(pLayouts);
-            return NULL;
-        }
-
-        for (iLayout = 0; iLayout < cLayouts; ++iLayout)
-        {
-            if (lstrcmpiW(pLayouts[iLayout].szFileName, pchFilePart) == 0)
-            {
-                if (wLangID != LOWORD(pLayouts[iLayout].hKL))
-                {
-                    ERR("\n");
-                    goto Quit; /* The language is different */
-                }
-
-                hNewKL = pLayouts[iLayout].hKL; /* Found */
-                break;
-            }
-        }
-    }
-
-    /* If the IME for the specified filename is valid, then unload it now */
-    if (ImmGetImeInfoEx(&InfoEx, ImeInfoExImeFileName, pchFilePart) &&
-        !UnloadKeyboardLayout(InfoEx.hkl))
-    {
-        ERR("\n");
-        hNewKL = NULL;
-        goto Quit;
-    }
-
-    Imm32GetSystemLibraryPath(szImeDestPath, _countof(szImeDestPath), pchFilePart);
-    CharUpperW(szImeDestPath);
-
-    /* If the source and the destination pathnames were different, then copy the IME file */
-    if (lstrcmpiW(szImeFileName, szImeDestPath) != 0 &&
-        !Imm32CopyImeFile(szImeFileName, szImeDestPath))
-    {
-        ERR("\n");
-        hNewKL = NULL;
-        goto Quit;
-    }
-
-    if (hNewKL == NULL)
-        hNewKL = Imm32AssignNewLayout(cLayouts, pLayouts, wLangID);
-
-    if (hNewKL)
-    {
-        /* Write the IME layout to registry */
-        if (Imm32WriteImeLayout(hNewKL, pchFilePart, lpszLayoutText))
-        {
-            /* Load the keyboard layout */
-            StringCchPrintfW(szImeKey, _countof(szImeKey), L"%08X", HandleToUlong(hNewKL));
-            hNewKL = LoadKeyboardLayoutW(szImeKey, KLF_REPLACELANG);
-        }
-        else
-        {
-            ERR("\n");
-            hNewKL = NULL;
-        }
-    }
-
-Quit:
-    ImmLocalFree(pLayouts);
-    return hNewKL;
-}
-
 /***********************************************************************
  *		ImmIsIME (IMM32.@)
  */

win32ss/user/imm32/imm.c

@@ -54,7 +54,10 @@ static BOOL APIENTRY ImmInitializeGlobals(HMODULE hMod)
  *		ImmRegisterClient(IMM32.@)
  *       ( Undocumented, called from user32.dll )
  */
-BOOL WINAPI ImmRegisterClient(PSHAREDINFO ptr, HINSTANCE hMod)
+BOOL WINAPI
+ImmRegisterClient(
+    _Inout_ PSHAREDINFO ptr,
+    _In_ HINSTANCE hMod)
 {
     gSharedInfo = *ptr;
     gpsi = gSharedInfo.psi;
@@ -1000,8 +1003,10 @@ VOID WINAPI ImmUnlockClientImc(PCLIENTIMC pClientImc)
     ImmLocalFree(pClientImc);
 }
 
-// Win: ImmGetSaveContext
-static HIMC APIENTRY ImmGetSaveContext(HWND hWnd, DWORD dwContextFlags)
+static HIMC
+ImmGetSaveContext(
+    _In_opt_ HWND hWnd,
+    _In_ DWORD dwContextFlags)
 {
     HIMC hIMC;
     PCLIENTIMC pClientImc;
@@ -1219,8 +1224,8 @@ BOOL WINAPI ImmSetActiveContext(HWND hWnd, HIMC hIMC, BOOL fActive)
 /***********************************************************************
  *              ImmWINNLSGetEnableStatus (IMM32.@)
  */
-
-BOOL WINAPI ImmWINNLSGetEnableStatus(HWND hWnd)
+BOOL WINAPI
+ImmWINNLSGetEnableStatus(_In_opt_ HWND hWnd)
 {
     if (!Imm32IsSystemJapaneseOrKorean())
     {
@@ -1234,7 +1239,10 @@ BOOL WINAPI ImmWINNLSGetEnableStatus(HWND hWnd)
 /***********************************************************************
  *              ImmSetActiveContextConsoleIME(IMM32.@)
  */
-BOOL WINAPI ImmSetActiveContextConsoleIME(HWND hwnd, BOOL fFlag)
+BOOL WINAPI
+ImmSetActiveContextConsoleIME(
+    _In_ HWND hwnd,
+    _In_ BOOL fFlag)
 {
     HIMC hIMC;
     TRACE("(%p, %d)\n", hwnd, fFlag);