immuser.h File Reference

#include <imm.h>
#include <immp.h>
#include <ime.h>
#include <imep.h>

Go to the source code of this file.

Classes
struct	tagCLIENTIMC
struct	tagIMEDPI
struct	tagIMEDPI::_tagImeFunctions
struct	tagIMEPRIVATESAVER
struct	tagIMEMODESAVER
Defines
#define	InitImcCrit(pClientImc)   RtlInitializeCriticalSection(&pClientImc->cs)
#define	DeleteImcCrit(pClientImc)   RtlDeleteCriticalSection(&pClientImc->cs)
#define	EnterImcCrit(pClientImc)   RtlEnterCriticalSection(&pClientImc->cs)
#define	LeaveImcCrit(pClientImc)   RtlLeaveCriticalSection(&pClientImc->cs)
#define	IMEDPI_UNLOADED   1
#define	IMEDPI_UNLOCKUNLOAD   2
Typedefs
typedef tagCLIENTIMC	CLIENTIMC
typedef tagCLIENTIMC *	PCLIENTIMC
typedef BOOL(CALLBACK *	PFNINQUIREA )(LPIMEINFO, LPSTR, DWORD)
typedef BOOL(CALLBACK *	PFNINQUIREW )(LPIMEINFO, LPWSTR, DWORD)
typedef DWORD(CALLBACK *	PFNCONVLISTA )(HIMC, LPCSTR, LPCANDIDATELIST, DWORD, UINT)
typedef DWORD(CALLBACK *	PFNCONVLISTW )(HIMC, LPCWSTR, LPCANDIDATELIST, DWORD, UINT)
typedef BOOL(CALLBACK *	PFNREGWORDA )(LPCSTR, DWORD, LPCSTR)
typedef BOOL(CALLBACK *	PFNREGWORDW )(LPCWSTR, DWORD, LPCWSTR)
typedef BOOL(CALLBACK *	PFNUNREGWORDA )(LPCSTR, DWORD, LPCSTR)
typedef BOOL(CALLBACK *	PFNUNREGWORDW )(LPCWSTR, DWORD, LPCWSTR)
typedef UINT(CALLBACK *	PFNGETREGWORDSTYA )(UINT, LPSTYLEBUFA)
typedef UINT(CALLBACK *	PFNGETREGWORDSTYW )(UINT, LPSTYLEBUFW)
typedef UINT(CALLBACK *	PFNENUMREGWORDA )(REGISTERWORDENUMPROCA, LPCSTR, DWORD, LPCSTR, LPVOID)
typedef UINT(CALLBACK *	PFNENUMREGWORDW )(REGISTERWORDENUMPROCW, LPCWSTR, DWORD, LPCWSTR, LPVOID)
typedef BOOL(CALLBACK *	PFNCONFIGURE )(HKL, HWND, DWORD, LPVOID)
typedef BOOL(CALLBACK *	PFNDESTROY )(UINT)
typedef LRESULT(CALLBACK *	PFNESCAPE )(HIMC, UINT, LPVOID)
typedef BOOL(CALLBACK *	PFNPROCESSKEY )(HIMC, UINT, LPARAM, CONST LPBYTE)
typedef BOOL(CALLBACK *	PFNSELECT )(HIMC, BOOL)
typedef BOOL(CALLBACK *	PFNSETACTIVEC )(HIMC, BOOL)
typedef UINT(CALLBACK *	PFNTOASCEX )(UINT, UINT, CONST LPBYTE, PTRANSMSGLIST, UINT, HIMC)
typedef BOOL(CALLBACK *	PFNNOTIFY )(HIMC, DWORD, DWORD, DWORD)
typedef BOOL(CALLBACK *	PFNSETCOMPSTR )(HIMC, DWORD, LPCVOID, DWORD, LPCVOID, DWORD)
typedef DWORD(CALLBACK *	PFNGETIMEMENUITEMS )(HIMC, DWORD, DWORD, LPVOID, LPVOID, DWORD)
typedef tagIMEDPI	IMEDPI
typedef tagIMEDPI *	PIMEDPI
typedef tagIMEPRIVATESAVER	IMEPRIVATEMODESAVER
typedef tagIMEPRIVATESAVER *	PIMEPRIVATEMODESAVER
typedef tagIMEMODESAVER	IMEMODESAVER
typedef tagIMEMODESAVER *	PIMEMODESAVER
Functions
BOOL	ImmSetActiveContext (HWND hWnd, HIMC hImc, BOOL fActivate)
BOOL WINAPI	ImmLoadIME (HKL hKL)
BOOL WINAPI	ImmUnloadIME (HKL hKL)
BOOL WINAPI	ImmFreeLayout (DWORD dwFlag)
BOOL WINAPI	ImmActivateLayout (HKL hSelKL)
BOOL WINAPI	ImmLoadLayout (HKL hKL, PIMEINFOEX piiex)
BOOL WINAPI	ImmDisableIme (DWORD dwThreadId)
PCLIENTIMC WINAPI	ImmLockClientImc (HIMC hImc)
VOID WINAPI	ImmUnlockClientImc (PCLIENTIMC pClientImc)
PIMEDPI WINAPI	ImmLockImeDpi (HKL hKL)
VOID WINAPI	ImmUnlockImeDpi (PIMEDPI pImeDpi)
BOOL WINAPI	ImmGetImeInfoEx (PIMEINFOEX piiex, IMEINFOEXCLASS SearchType, PVOID pvSearchKey)
DWORD WINAPI	ImmProcessKey (HWND hWnd, HKL hkl, UINT uVKey, LPARAM lParam, DWORD dwHotKeyID)
BOOL	ImmTranslateMessage (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
VOID	ImmInitializeHotKeys (BOOL bUserLoggedOn)

---

Define Documentation

#define DeleteImcCrit (  pClientImc   )     RtlDeleteCriticalSection(&pClientImc->cs)

Definition at line 33 of file immuser.h. Referenced by ImmUnlockClientImc().

#define EnterImcCrit (  pClientImc   )     RtlEnterCriticalSection(&pClientImc->cs)

Definition at line 34 of file immuser.h. Referenced by InternalImmLockIMC().

#define IMEDPI_UNLOADED   1

Definition at line 63 of file immuser.h. Referenced by ImmLockImeDpi(), ImmUnloadIME(), and ImmUnlockImeDpi().

#define IMEDPI_UNLOCKUNLOAD   2

Definition at line 64 of file immuser.h. Referenced by ImmUnlockImeDpi(), and LoadImeDpi().

#define InitImcCrit (  pClientImc   )     RtlInitializeCriticalSection(&pClientImc->cs)

Definition at line 32 of file immuser.h. Referenced by ImmCreateContext(), and ImmLockClientImc().

#define LeaveImcCrit (  pClientImc   )     RtlLeaveCriticalSection(&pClientImc->cs)

Definition at line 35 of file immuser.h. Referenced by InternalImmLockIMC().

---

Typedef Documentation

typedef struct tagCLIENTIMC CLIENTIMC

Referenced by ImmCreateContext().

typedef struct tagIMEDPI IMEDPI

typedef struct tagIMEMODESAVER IMEMODESAVER

typedef struct tagIMEPRIVATESAVER IMEPRIVATEMODESAVER

typedef struct tagCLIENTIMC * PCLIENTIMC

Referenced by ImmEnableIME().

typedef BOOL(CALLBACK* PFNCONFIGURE)(HKL, HWND, DWORD, LPVOID)

Definition at line 52 of file immuser.h.

typedef DWORD(CALLBACK* PFNCONVLISTA)(HIMC, LPCSTR, LPCANDIDATELIST, DWORD, UINT)

Definition at line 42 of file immuser.h.

typedef DWORD(CALLBACK* PFNCONVLISTW)(HIMC, LPCWSTR, LPCANDIDATELIST, DWORD, UINT)

Definition at line 43 of file immuser.h.

typedef BOOL(CALLBACK* PFNDESTROY)(UINT)

Definition at line 53 of file immuser.h.

typedef UINT(CALLBACK* PFNENUMREGWORDA)(REGISTERWORDENUMPROCA, LPCSTR, DWORD, LPCSTR, LPVOID)

Definition at line 50 of file immuser.h.

typedef UINT(CALLBACK* PFNENUMREGWORDW)(REGISTERWORDENUMPROCW, LPCWSTR, DWORD, LPCWSTR, LPVOID)

Definition at line 51 of file immuser.h.

typedef LRESULT(CALLBACK* PFNESCAPE)(HIMC, UINT, LPVOID)

Definition at line 54 of file immuser.h.

typedef DWORD(CALLBACK* PFNGETIMEMENUITEMS)(HIMC, DWORD, DWORD, LPVOID, LPVOID, DWORD)

Definition at line 61 of file immuser.h.

typedef UINT(CALLBACK* PFNGETREGWORDSTYA)(UINT, LPSTYLEBUFA)

Definition at line 48 of file immuser.h.

typedef UINT(CALLBACK* PFNGETREGWORDSTYW)(UINT, LPSTYLEBUFW)

Definition at line 49 of file immuser.h.

typedef BOOL(CALLBACK* PFNINQUIREA)(LPIMEINFO, LPSTR, DWORD)

Definition at line 40 of file immuser.h.

typedef BOOL(CALLBACK* PFNINQUIREW)(LPIMEINFO, LPWSTR, DWORD)

Definition at line 41 of file immuser.h.

typedef BOOL(CALLBACK* PFNNOTIFY)(HIMC, DWORD, DWORD, DWORD)

Definition at line 59 of file immuser.h.

typedef BOOL(CALLBACK* PFNPROCESSKEY)(HIMC, UINT, LPARAM, CONST LPBYTE)

Definition at line 55 of file immuser.h.

typedef BOOL(CALLBACK* PFNREGWORDA)(LPCSTR, DWORD, LPCSTR)

Definition at line 44 of file immuser.h.

typedef BOOL(CALLBACK* PFNREGWORDW)(LPCWSTR, DWORD, LPCWSTR)

Definition at line 45 of file immuser.h.

typedef BOOL(CALLBACK* PFNSELECT)(HIMC, BOOL)

Definition at line 56 of file immuser.h.

typedef BOOL(CALLBACK* PFNSETACTIVEC)(HIMC, BOOL)

Definition at line 57 of file immuser.h.

typedef BOOL(CALLBACK* PFNSETCOMPSTR)(HIMC, DWORD, LPCVOID, DWORD, LPCVOID, DWORD)

Definition at line 60 of file immuser.h.

typedef UINT(CALLBACK* PFNTOASCEX)(UINT, UINT, CONST LPBYTE, PTRANSMSGLIST, UINT, HIMC)

Definition at line 58 of file immuser.h.

typedef BOOL(CALLBACK* PFNUNREGWORDA)(LPCSTR, DWORD, LPCSTR)

Definition at line 46 of file immuser.h.

typedef BOOL(CALLBACK* PFNUNREGWORDW)(LPCWSTR, DWORD, LPCWSTR)

Definition at line 47 of file immuser.h.

typedef struct tagIMEDPI * PIMEDPI

Referenced by ImmCallImeConsoleIME().

typedef struct tagIMEMODESAVER * PIMEMODESAVER

Referenced by GetImeModeSaver().

typedef struct tagIMEPRIVATESAVER * PIMEPRIVATEMODESAVER

Referenced by DestroyImeModeSaver().

---

Function Documentation

BOOL WINAPI ImmActivateLayout (  HKL  hSelKL  )

Definition at line 495 of file immime.c. References BOOL, _CLIENTINFO::CI_flags, CI_INPUTCONTEXT_REINIT, DWORD, FALSE, GetClientInfo, GetKeyboardLayout(), tagSELECTCONTEXT_ENUM::hSelKL, tagSELECTCONTEXT_ENUM::hUnSelKL, tagIMEDPI::ImeInfo, ImmEnumInputContext(), ImmGetDefaultIMEWnd(), ImmLoadIME(), ImmLockImeDpi(), ImmUnlockImeDpi(), IsWindow(), NotifyIMEProc(), NtUserSetThreadLayoutHandles(), NULL, SelectContextProc(), SendMessage(), and TRUE. Referenced by _InitializeImmEntryTable(). { HKL hUnSelKL; HWND hWndDefaultIme; SCE sce; DWORD dwCPS; PIMEDPI pImeDpi; BOOLEAN fOptimizeActivation = TRUE; hUnSelKL = GetKeyboardLayout(0); { PCLIENTINFO pClientInfo = GetClientInfo(); if (pClientInfo->CI_flags & CI_INPUTCONTEXT_REINIT) { fOptimizeActivation = FALSE; } } /* * if already current active, do nothing */ if (hUnSelKL == hSelKL && fOptimizeActivation) return TRUE; ImmLoadIME(hSelKL); if (hUnSelKL != hSelKL) { pImeDpi = ImmLockImeDpi(hUnSelKL); if (pImeDpi != NULL) { /* * Send out CPS_CANCEL or CPS_COMPLETE to every input * context assoicated to window(s) created by this thread. * Starting from SUR, we only assoicate input context to window created * by the same thread. */ dwCPS = (pImeDpi->ImeInfo.fdwProperty & IME_PROP_COMPLETE_ON_UNSELECT) ? CPS_COMPLETE : CPS_CANCEL; ImmUnlockImeDpi(pImeDpi); ImmEnumInputContext(0, NotifyIMEProc, dwCPS); } hWndDefaultIme = ImmGetDefaultIMEWnd(NULL); if (IsWindow(hWndDefaultIme)) SendMessage(hWndDefaultIme, WM_IME_SELECT, FALSE, (LPARAM)hUnSelKL); /* * This is the time to update the kernel side layout handles. * We must do this before sending WM_IME_SELECT. */ NtUserSetThreadLayoutHandles(hSelKL, hUnSelKL); } /* * Unselect and select input context(s). */ sce.hSelKL = hSelKL; sce.hUnSelKL = hUnSelKL; ImmEnumInputContext(0, (IMCENUMPROC)SelectContextProc, (LPARAM)&sce); /* * inform UI select after all hIMC select */ if (IsWindow(hWndDefaultIme)) SendMessage(hWndDefaultIme, WM_IME_SELECT, TRUE, (LPARAM)hSelKL); return (TRUE); }

BOOL WINAPI ImmDisableIme (  DWORD  dwThreadId  )

BOOL WINAPI ImmFreeLayout (  DWORD  dwFlag  )

Definition at line 416 of file immime.c. References BOOL, FALSE, gcsImeDpi, GetKeyboardLayout(), gpImeDpi, tagIMEDPI::hKL, IFL_DEACTIVATEIME, IFL_UNLOADIME, ImmLocalAlloc(), ImmLocalFree, ImmUnloadIME(), IS_IME_KBDLAYOUT, L, LoadKeyboardLayoutW(), NULL, tagIMEDPI::pNext, TRUE, and UINT. Referenced by _InitializeImmEntryTable(). { PIMEDPI pImeDpi; HKL *phklRoot, hklCurrent; WCHAR pwszNonImeKLID[KL_NAMELENGTH]; UINT nLayouts, uNonImeKLID = 0, i; hklCurrent = GetKeyboardLayout(0); switch (dwFlag) { case IFL_DEACTIVATEIME: /* * Do nothing if no IME to be deactivated. */ if (!IS_IME_KBDLAYOUT(hklCurrent)) return TRUE; /* * Deactivate IME based layout by activating a non-IME based * keyboard layout. */ uNonImeKLID = (UINT)LANGIDFROMLCID(GetSystemDefaultLCID()); nLayouts = GetKeyboardLayoutList(0, NULL); if (nLayouts != 0) { phklRoot = ImmLocalAlloc(0, nLayouts * sizeof(HKL)); if (phklRoot == NULL) return FALSE; nLayouts = GetKeyboardLayoutList(nLayouts, phklRoot); for (i = 0; i < nLayouts && IS_IME_KBDLAYOUT(phklRoot[i]); i++) ; if (i < nLayouts) uNonImeKLID = HandleToUlong(phklRoot[i]) & 0xffff; ImmLocalFree(phklRoot); } wsprintf(pwszNonImeKLID, L"%08x", uNonImeKLID); if (LoadKeyboardLayoutW(pwszNonImeKLID, KLF_ACTIVATE) == NULL) { RIPMSG1(RIP_WARNING, "ImmFreeLayout: LoadKeyboardLayoutW(%S, KLF_ACTIVATE) failed. Trying 00000409", pwszNonImeKLID); // Somehow it failed (probably a bad setup), let's try // 409 KL, which should be installed on all localized NTs. if (LoadKeyboardLayoutW(L"00000409", KLF_ACTIVATE | KLF_FAILSAFE) == NULL) { RIPMSG0(RIP_WARNING, "LoadKeyboardLayoutW(00000409) failed either. will try NULL."); } } break; case IFL_UNLOADIME: RtlEnterCriticalSection(&gcsImeDpi); UnloadImeDpiLoop: for (pImeDpi = gpImeDpi; pImeDpi != NULL; pImeDpi = pImeDpi->pNext) { if (ImmUnloadIME(pImeDpi->hKL)) goto UnloadImeDpiLoop; // Rescan as list was updated. } RtlLeaveCriticalSection(&gcsImeDpi); break; default: { HKL hklFlag = (HKL)LongToHandle( dwFlag ); if (IS_IME_KBDLAYOUT(hklFlag) && hklFlag != hklCurrent) { ImmUnloadIME(hklFlag); } } break; } return TRUE; }

BOOL WINAPI ImmGetImeInfoEx (  PIMEINFOEX  piiex, IMEINFOEXCLASS  SearchType, PVOID  pvSearchKey )

Definition at line 876 of file w32/ntuser/imm/misc.c. References BOOL, FALSE, tagIMEINFOEX::hkl, ImeInfoExImeFileName, ImeInfoExKeyboardLayout, ImmAssert, IS_IME_KBDLAYOUT, NtUserGetImeInfoEx(), NULL, and tagIMEINFOEX::wszImeFile. Referenced by _InitializeImmEntryTable(), ImmGetDescriptionA(), ImmGetDescriptionW(), ImmGetIMEFileNameA(), ImmGetIMEFileNameW(), ImmGetProperty(), ImmIMPQueryIMEW(), ImmIMPSetIMEW(), ImmInstallIMEW(), ImmIsIME(), IMPGetIMEWorker(), and LoadImeDpi(). { ImmAssert(piiex != NULL && pvSearchKey != NULL); switch (SearchType) { case ImeInfoExKeyboardLayout: piiex->hkl = *((HKL *)pvSearchKey); /* * Quick return for non-IME based keyboard layout */ if (!IS_IME_KBDLAYOUT(piiex->hkl)) return FALSE; break; case ImeInfoExImeFileName: wcscpy(piiex->wszImeFile, (PWSTR)pvSearchKey); break; default: return FALSE; } return NtUserGetImeInfoEx(piiex, SearchType); }

VOID ImmInitializeHotKeys (  BOOL  bUserLoggedOn  )

BOOL WINAPI ImmLoadIME (  HKL  hKL  )

Definition at line 346 of file immime.c. References BOOL, FALSE, ImmGetImeDpi(), IS_IME_KBDLAYOUT, LoadImeDpi(), and NULL. Referenced by _InitializeImmEntryTable(), and ImmActivateLayout(). { PIMEDPI pImeDpi; /* * Non IME based keyboard layout doesn't have IMEDPI. */ if (!IS_IME_KBDLAYOUT(hKL)) return FALSE; pImeDpi = ImmGetImeDpi(hKL); if (pImeDpi == NULL) pImeDpi = LoadImeDpi(hKL, FALSE); return (pImeDpi != NULL); }

BOOL WINAPI ImmLoadLayout (  HKL  hKL, PIMEINFOEX  piiex )

Definition at line 38 of file layime.c. References BOOL, DWORD, FALSE, tagIMEINFOEX::fLoadFlag, gszRegKbdLayout, gszValImeFile, tagIMEINFOEX::hkl, IM_FILE_SIZE, IMEF_NONLOAD, L, LoadVersionInfo(), MAX_PATH, NT_SUCCESS, NTSTATUS(), NULL, RtlIntegerToUnicodeString(), Status, and tagIMEINFOEX::wszImeFile. Referenced by _InitializeImmEntryTable(). { UNICODE_STRING strIme; WCHAR wszIme[MAX_PATH]; HKEY hKeyKbdLayout, hKeyIme; NTSTATUS Status; DWORD dwTmp; LONG lRet; strIme.Buffer = wszIme; strIme.MaximumLength = sizeof(wszIme); Status = RtlIntegerToUnicodeString(HandleToUlong(hKL), 16, &strIme); if (!NT_SUCCESS(Status)) { return(FALSE); } lRet = RegOpenKey(HKEY_LOCAL_MACHINE, gszRegKbdLayout, &hKeyKbdLayout); if ( lRet != ERROR_SUCCESS ) { return(FALSE); } lRet = RegOpenKey(hKeyKbdLayout, strIme.Buffer, &hKeyIme); if ( lRet != ERROR_SUCCESS ) { RegCloseKey(hKeyKbdLayout); return(FALSE); } dwTmp = IM_FILE_SIZE; lRet = RegQueryValueEx(hKeyIme, gszValImeFile, NULL, NULL, (LPBYTE)piiex->wszImeFile, &dwTmp); if ( lRet != ERROR_SUCCESS ) { RegCloseKey(hKeyIme); RegCloseKey(hKeyKbdLayout); return(FALSE); } piiex->wszImeFile[IM_FILE_SIZE - 1] = L'\0'; RegCloseKey(hKeyIme); RegCloseKey(hKeyKbdLayout); piiex->hkl = hKL; piiex->fLoadFlag = IMEF_NONLOAD; return LoadVersionInfo(piiex); }

PCLIENTIMC WINAPI ImmLockClientImc (  HIMC  hImc  )

Definition at line 689 of file w32/ntuser/imm/misc.c. References tagCLIENTIMC::cLockObj, tagIMC::dwClientImcData, tagCLIENTIMC::dwImeCompatFlags, DWORD, HMValidateHandle(), IMCF_DEFAULTIMC, IMCF_INDESTROY, ImmLocalAlloc(), ImmLocalFree, InitImcCrit, NtUserGetThreadState(), NtUserUpdateInputContext(), NULL, NULL_HIMC, SetICF, TestICF, TestInputContextProcess(), TYPE_INPUTCONTEXT, and UpdateClientInputContext. Referenced by CreateInputContext(), ImmEnableIME(), ImmGenerateMessage(), ImmGetAppCompatFlags(), ImmGetCandidateListCountWorker(), ImmGetCandidateListWorker(), ImmGetCompositionFontA(), ImmGetCompositionFontW(), ImmGetCompositionStringA(), ImmGetCompositionStringW(), ImmGetGuideLineWorker(), ImmGetIMCLockCount(), ImmGetSaveContext(), ImmPostMessages(), ImmRequestMessageWorker(), ImmSetActiveContext(), ImmSetCompositionFontA(), ImmSetCompositionFontW(), ImmUnlockIMC(), InternalImmLockIMC(), IsAnsiIMC(), MySetCompFont(), SelectInputContext(), and SetFontForMCWVERTICAL(). { PIMC pImc; PCLIENTIMC pClientImc; if (hImc == NULL_HIMC) return NULL; pImc = HMValidateHandle((HANDLE)hImc, TYPE_INPUTCONTEXT); /* * Cannot access input context from other process. */ if (pImc == NULL || !TestInputContextProcess(pImc)) return NULL; pClientImc = (PCLIENTIMC)pImc->dwClientImcData; if (pClientImc == NULL) { /* * We delay the creation of client side per-thread default Imc. * Now, this is the time to create it. */ pClientImc = ImmLocalAlloc(HEAP_ZERO_MEMORY, sizeof(CLIENTIMC)); if (pClientImc == NULL) return NULL; InitImcCrit(pClientImc); pClientImc->dwImeCompatFlags = (DWORD)NtUserGetThreadState(UserThreadStateImeCompatFlags); /* * Update the kernel side input context. */ if (!NtUserUpdateInputContext(hImc, UpdateClientInputContext, (ULONG_PTR)pClientImc)) { ImmLocalFree(pClientImc); return NULL; } /* * Marks with default input context signature. */ SetICF(pClientImc, IMCF_DEFAULTIMC); } else if (TestICF(pClientImc, IMCF_INDESTROY)) { /* * Cannot access destroyed input context. */ return NULL; } InterlockedIncrement(&pClientImc->cLockObj); return pClientImc; }

PIMEDPI WINAPI ImmLockImeDpi (  HKL  hKL  )

Definition at line 793 of file w32/ntuser/imm/misc.c. References tagIMEDPI::cLock, tagIMEDPI::dwFlag, gcsImeDpi, gpImeDpi, tagIMEDPI::hKL, IMEDPI_UNLOADED, NULL, and tagIMEDPI::pNext. Referenced by _InitializeImmEntryTable(), CreateInputContext(), DestroyInputContext(), FindOrLoadImeDpi(), HotKeyIDDispatcher(), ImmActivateLayout(), ImmCallImeConsoleIME(), ImmCreateSoftKeyboard(), ImmGetImeMenuItemsWorker(), ImmNotifyIME(), ImmProcessKey(), ImmSetActiveContext(), ImmSetCompositionStringWorker(), ImmTranslateMessage(), JCloseOpen(), MakeIMENotify(), SelectInputContext(), and TransHanjaMode(). { PIMEDPI pImeDpi; RtlEnterCriticalSection(&gcsImeDpi); pImeDpi = gpImeDpi; while (pImeDpi != NULL && pImeDpi->hKL != hKL) pImeDpi = pImeDpi->pNext; if (pImeDpi != NULL) { if (pImeDpi->dwFlag & IMEDPI_UNLOADED) pImeDpi = NULL; else pImeDpi->cLock++; } RtlLeaveCriticalSection(&gcsImeDpi); return (PIMEDPI)pImeDpi; }

DWORD WINAPI ImmProcessKey (  HWND  hWnd, HKL  hkl, UINT  uVKey, LPARAM  lParam, DWORD  dwHotKeyID )

Definition at line 30 of file ntuser/imm/input.c. References BYTE, DWORD, FALSE, GetKeyboardState, HotKeyIDDispatcher(), hWnd, tagIMEDPI::ImeInfo, tagIMEDPI::_tagImeFunctions::ImeProcessKey, ImmAssert, ImmGetAppCompatFlags(), ImmGetContext(), ImmLocalAlloc(), ImmLocalFree, ImmLockIMC(), ImmLockImeDpi(), ImmReleaseContext(), ImmTranslateMessage(), ImmUnlockIMC(), ImmUnlockImeDpi(), IPHK_HOTKEY, IPHK_PROCESSBYIME, NULL, PBYTE, tagIMEDPI::pfn, TRUE, and UINT. Referenced by ImmCallImeConsoleIME(). { HIMC hIMC = ImmGetContext(hWnd); PIMEDPI pImeDpi = ImmLockImeDpi(hkl); DWORD dwReturn = 0; #if DBG if (dwHotKeyID >= IME_KHOTKEY_FIRST && dwHotKeyID <= IME_KHOTKEY_LAST) { TAGMSG2(DBGTAG_IMM, "ImmProcessKey: Kor IME Hotkeys should not come here: dwHotKeyID=%x, uVKey=%x", dwHotKeyID, uVKey); } #endif ImmAssert(dwHotKeyID != IME_KHOTKEY_ENGLISH && dwHotKeyID != IME_KHOTKEY_SHAPE_TOGGLE && dwHotKeyID != IME_KHOTKEY_HANJACONVERT); // // call ImeProcessKey // if (pImeDpi != NULL) { PINPUTCONTEXT pInputContext = ImmLockIMC(hIMC); if (pInputContext != NULL) { BOOLEAN fTruncateWideVK = FALSE; BOOLEAN fCallIme = TRUE; BOOLEAN fSkipThisKey = FALSE; #ifdef LATER // // if the current imc is not open and IME doesn't need // keys when being closed, we don't pass any keyboard // input to ime except hotkey and keys that change // the keyboard status. // if ((pImeDpi->fdwProperty & IME_PROP_NO_KEYS_ON_CLOSE) && !pInputContext->fOpen && uVKey != VK_SHIFT && uVKey != VK_CONTROL && uVKey != VK_CAPITAL && uVKey != VK_KANA && uVKey != VK_NUMLOCK && uVKey != VK_SCROLL) { // Check if Korea Hanja conversion mode if(!(pimc->fdwConvMode & IME_CMODE_HANJACONVERT)) { fCallIme = FALSE; } } else #endif // // Protect IMEs which are unaware of wide virtual keys. // if ((BYTE)uVKey == VK_PACKET && (pImeDpi->ImeInfo.fdwProperty & IME_PROP_ACCEPT_WIDE_VKEY) == 0) { if (pImeDpi->ImeInfo.fdwProperty & IME_PROP_UNICODE) { // // Since this IME is not ready to accept wide VKey, we should // truncate it. // fTruncateWideVK = TRUE; } else { // // Hmm, this guy is ANSI IME, and does not declare Wide Vkey awareness. // Let's guess this one is not ready to accept Wide Vkey, so let's not // pass it to this guy. // And if it is opened, we'd better skip this key for safety. // fCallIme = FALSE; if (pInputContext->fOpen) { fSkipThisKey = TRUE; } } } if (fCallIme) { PBYTE pbKeyState = (PBYTE)ImmLocalAlloc(0, 256); ImmAssert(fSkipThisKey == FALSE); if (pbKeyState != NULL) { if (GetKeyboardState(pbKeyState)) { UINT uVKeyIme = uVKey; if (fTruncateWideVK) { uVKeyIme &= 0xffff; } if ( (*pImeDpi->pfn.ImeProcessKey)(hIMC, uVKeyIme, lParam, pbKeyState) ) { // // if the return value of ImeProcessKey is TRUE, // it means the key is the one that the ime is // waiting for. // pInputContext->fChgMsg = TRUE; pInputContext->uSavedVKey = uVKey; dwReturn |= IPHK_PROCESSBYIME; } } ImmLocalFree(pbKeyState); } } else if (fSkipThisKey) { dwReturn |= IPHK_SKIPTHISKEY; ImmAssert((dwReturn & (IPHK_PROCESSBYIME | IPHK_HOTKEY)) == 0); } ImmUnlockIMC(hIMC); } ImmUnlockImeDpi(pImeDpi); } // // call hotkey handler // if (dwHotKeyID != IME_INVALID_HOTKEY && HotKeyIDDispatcher(hWnd, hIMC, hkl, dwHotKeyID)) { // Backward compat: // On Japanese system, some applications may want VK_KANJI. if ((uVKey != VK_KANJI) || (dwHotKeyID != IME_JHOTKEY_CLOSE_OPEN)) { dwReturn |= IPHK_HOTKEY; } } // // some 3.x application doesn't like to see // VK_PROCESSKEY. // if (dwReturn & IPHK_PROCESSBYIME) { DWORD dwImeCompat = ImmGetAppCompatFlags(hIMC); if (dwImeCompat & IMECOMPAT_NOVKPROCESSKEY) { // Korea 3.x application doesn't like to see dummy finalize VK_PROCESSKEY // and IME hot key. if ( PRIMARYLANGID(LANGIDFROMLCID(GetSystemDefaultLCID())) == LANG_KOREAN && ( (uVKey == VK_PROCESSKEY) || (dwReturn & IPHK_HOTKEY) ) ) { ImmReleaseContext(hWnd, hIMC); return dwReturn; } ImmTranslateMessage(hWnd, WM_KEYDOWN, VK_PROCESSKEY, lParam); dwReturn &= ~IPHK_PROCESSBYIME; dwReturn |= IPHK_SKIPTHISKEY; } } ImmReleaseContext(hWnd, hIMC); return dwReturn; }

BOOL ImmSetActiveContext (  HWND  hWnd, HIMC  hImc, BOOL  fActivate )

Definition at line 309 of file w32/ntuser/imm/context.c. References BOOL, ClrICF, DWORD, FALSE, GetKeyboardLayout(), GETPTI, hWnd, IGSC_DEFIMCFALLBACK, IMCF_ACTIVE, tagIMEDPI::_tagImeFunctions::ImeSetActiveContext, ImmGetDefaultIMEWnd(), ImmGetSaveContext(), ImmLockClientImc(), ImmLockIMC(), ImmLockImeDpi(), ImmUnlockClientImc(), ImmUnlockIMC(), ImmUnlockImeDpi(), IS_IME_ENABLED, IsWindow(), NtUserNotifyIMEStatus(), NULL, NULL_HIMC, tagIMEDPI::pfn, PtiCurrent, SendMessage(), SetICF, TRUE, and ValidateHwnd. Referenced by ImmAssociateContext(), ImmAssociateContextEx(), ImmEnableIME(), and ImmSetActiveContextConsoleIME(). { PCLIENTIMC pClientImc; PINPUTCONTEXT pInputContext; PIMEDPI pImeDpi; DWORD dwISC; HIMC hSaveImc; HWND hDefImeWnd; DWORD dwOpenStatus = 0; DWORD dwConversion = 0; #ifdef DEBUG PWND pWnd = ValidateHwnd(hWnd); if (pWnd != NULL && GETPTI(pWnd) != PtiCurrent()) { RIPMSG1(RIP_WARNING, "hWnd (=%lx) is not of current thread.", hWnd); } #endif if (!IS_IME_ENABLED()) { return FALSE; } dwISC = ISC_SHOWUIALL; pClientImc = ImmLockClientImc(hImc); if (!fActivate) { if (pClientImc != NULL) ClrICF(pClientImc, IMCF_ACTIVE); goto NotifySetActive; } if (hImc == NULL_HIMC) { hSaveImc = ImmGetSaveContext(hWnd, IGSC_DEFIMCFALLBACK); pInputContext = ImmLockIMC(hSaveImc); if (pInputContext != NULL) { pInputContext->hWnd = hWnd; ImmUnlockIMC(hSaveImc); } goto NotifySetActive; } /* * Non-NULL input context, window handle have to be updated. */ if (pClientImc == NULL) return FALSE; pInputContext = ImmLockIMC(hImc); if (pInputContext == NULL) { ImmUnlockClientImc(pClientImc); return FALSE; } pInputContext->hWnd = hWnd; SetICF(pClientImc, IMCF_ACTIVE); #ifdef LATER // Do uNumLangVKey checking later #endif if (pInputContext->fdw31Compat & F31COMPAT_MCWHIDDEN) dwISC = ISC_SHOWUIALL - ISC_SHOWUICOMPOSITIONWINDOW; dwOpenStatus = (DWORD)pInputContext->fOpen; dwConversion = pInputContext->fdwConversion; ImmUnlockIMC(hImc); NotifySetActive: pImeDpi = ImmLockImeDpi(GetKeyboardLayout(0)); if (pImeDpi != NULL) { (*pImeDpi->pfn.ImeSetActiveContext)(hImc, fActivate); ImmUnlockImeDpi(pImeDpi); } /* * Notify UI */ if (IsWindow(hWnd)) { SendMessage(hWnd, WM_IME_SETCONTEXT, fActivate, dwISC); /* * send notify to shell / keyboard driver */ if ( fActivate ) NtUserNotifyIMEStatus( hWnd, dwOpenStatus, dwConversion ); } else if (!fActivate) { /* * Because hWnd is not there (maybe destroyed), we send * WM_IME_SETCONTEXT to the default IME window. */ if ((hDefImeWnd = ImmGetDefaultIMEWnd(NULL)) != NULL) { SendMessage(hDefImeWnd, WM_IME_SETCONTEXT, fActivate, dwISC); } else { RIPMSG0(RIP_WARNING, "ImmSetActiveContext: can't send WM_IME_SETCONTEXT(FALSE)."); } } #ifdef DEBUG else { RIPMSG0(RIP_WARNING, "ImmSetActiveContext: can't send WM_IME_SETCONTEXT(TRUE)."); } #endif #ifdef LATER // Implements ProcessIMCEvent() later. #endif if (pClientImc != NULL) ImmUnlockClientImc(pClientImc); return TRUE; }

BOOL ImmTranslateMessage (  HWND  hwnd, UINT  message, WPARAM  wParam, LPARAM  lParam )

Definition at line 196 of file ntuser/imm/input.c. References BOOL, BYTE, DWORD, FALSE, GetKeyboardLayout(), GetKeyboardState, GetWindowThreadProcessId(), tagIMEDPI::ImeInfo, tagIMEDPI::_tagImeFunctions::ImeToAsciiEx, ImmAssert, ImmGetContext(), ImmLocalAlloc(), ImmLocalFree, ImmLockIMC(), ImmLockIMCC(), ImmLockImeDpi(), ImmPostMessages(), ImmReleaseContext(), ImmUnlockIMC(), ImmUnlockIMCC(), ImmUnlockImeDpi(), INT, NULL, PBYTE, tagIMEDPI::pfn, ToAsciiEx(), ToUnicode(), TRANSMSGCOUNT, TRUE, and UINT. Referenced by CharHandlerFromConsole(), and ImmProcessKey(). { HIMC hImc; PINPUTCONTEXT pInputContext; BOOL fReturn = FALSE; HKL hkl; PIMEDPI pImeDpi = NULL; PBYTE pbKeyState; PTRANSMSG pTransMsg; PTRANSMSGLIST pTransMsgList; DWORD dwSize; UINT uVKey; INT iNum; UNREFERENCED_PARAMETER(wParam); // // we're interested in only those keyboard messages. // switch (message) { case WM_KEYDOWN: case WM_KEYUP: case WM_SYSKEYDOWN: case WM_SYSKEYUP: break; default: return FALSE; } // // input context is necessary for further handling // hImc = ImmGetContext(hwnd); pInputContext = ImmLockIMC(hImc); if (pInputContext == NULL) { ImmReleaseContext(hwnd, hImc); return FALSE; } // // At first, handle VK_PROCESSKEY generated by IME. // if (!pInputContext->fChgMsg) { if ((iNum=pInputContext->dwNumMsgBuf) != 0) { pTransMsg = (PTRANSMSG)ImmLockIMCC(pInputContext->hMsgBuf); if (pTransMsg != NULL) { ImmPostMessages(hwnd, hImc, iNum, pTransMsg); ImmUnlockIMCC(pInputContext->hMsgBuf); fReturn = TRUE; } pInputContext->dwNumMsgBuf = 0; } goto ExitITM; } pInputContext->fChgMsg = FALSE; // // retrieve the keyboard layout and IME entry points // hkl = GetKeyboardLayout( GetWindowThreadProcessId(hwnd, NULL) ); pImeDpi = ImmLockImeDpi(hkl); if (pImeDpi == NULL) { RIPMSG1(RIP_WARNING, "ImmTranslateMessage pImeDpi is NULL(hkl=%x)", hkl); goto ExitITM; } pbKeyState = ImmLocalAlloc(0, 256); if ( pbKeyState == NULL ) { RIPMSG0(RIP_WARNING, "ImmTranslateMessage out of memory" ); goto ExitITM; } if (!GetKeyboardState(pbKeyState)) { RIPMSG0(RIP_WARNING, "ImmTranslateMessage GetKeyboardState() failed" ); ImmLocalFree( pbKeyState ); goto ExitITM; } // // Translate the saved vkey into character code if needed // uVKey = pInputContext->uSavedVKey; if (pImeDpi->ImeInfo.fdwProperty & IME_PROP_KBD_CHAR_FIRST) { if (pImeDpi->ImeInfo.fdwProperty & IME_PROP_UNICODE) { WCHAR wcTemp; iNum = ToUnicode(pInputContext->uSavedVKey, // virtual-key code HIWORD(lParam), // scan code pbKeyState, // key-state array &wcTemp, // buffer for translated key 1, // size of buffer 0); if (iNum == 1) { // // hi word : unicode character code // hi byte of lo word : zero // lo byte of lo word : virtual key // uVKey = (uVKey & 0x00ff) | ((UINT)wcTemp << 16); } } else { WORD wTemp = 0; iNum = ToAsciiEx(pInputContext->uSavedVKey, // virtual-key code HIWORD(lParam), // scan code pbKeyState, // key-state array &wTemp, // buffer for translated key 0, // active-menu flag hkl); ImmAssert(iNum <= 2); if (iNum > 0) { // // hi word : should be zero // hi byte of lo word : character code // lo byte of lo word : virtual key // uVKey = (uVKey & 0x00FF) | ((UINT)wTemp << 8); if ((BYTE)uVKey == VK_PACKET) { // // If ANSI IME is wide vkey aware, its ImeToAsciiEx will receive the uVKey // as follows: // // 31 24 23 16 15 8 7 0 // +----------------+-----------------------------+-------------------+---------------+ // | 24~31:reserved | 16~23:trailing byte(if any) | 8~15:leading byte | 0~7:VK_PACKET | // +----------------+-----------------------------+-------------------+---------------+ // ImmAssert(pImeDpi->ImeInfo.fdwProperty & IME_PROP_ACCEPT_WIDE_VKEY); } else { uVKey &= 0xffff; } } } } dwSize = FIELD_OFFSET(TRANSMSGLIST, TransMsg) + TRANSMSGCOUNT * sizeof(TRANSMSG); pTransMsgList = (PTRANSMSGLIST)ImmLocalAlloc(0, dwSize); if (pTransMsgList == NULL) { RIPMSG0(RIP_WARNING, "ImmTranslateMessage out of memory" ); ImmLocalFree(pbKeyState); goto ExitITM; } pTransMsgList->uMsgCount = TRANSMSGCOUNT; iNum = (*pImeDpi->pfn.ImeToAsciiEx)(uVKey, HIWORD(lParam), pbKeyState, pTransMsgList, 0, hImc); if (iNum > TRANSMSGCOUNT) { // // The message buffer is not big enough. IME put messages // into hMsgBuf in the input context. // pTransMsg = (PTRANSMSG)ImmLockIMCC(pInputContext->hMsgBuf); if (pTransMsg != NULL) { ImmPostMessages(hwnd, hImc, iNum, pTransMsg); ImmUnlockIMCC(pInputContext->hMsgBuf); } #ifdef LATER // Shouldn't we need this ? fReturn = TRUE; #endif } else if (iNum > 0) { ImmPostMessages(hwnd, hImc, iNum, &pTransMsgList->TransMsg[0]); fReturn = TRUE; } ImmLocalFree(pbKeyState); ImmLocalFree(pTransMsgList); ExitITM: ImmUnlockImeDpi(pImeDpi); ImmUnlockIMC(hImc); ImmReleaseContext(hwnd, hImc); return fReturn; }

BOOL WINAPI ImmUnloadIME (  HKL  hKL  )

Definition at line 365 of file immime.c. References BOOL, tagIMEDPI::cLock, tagIMEDPI::dwFlag, FALSE, gcsImeDpi, gpImeDpi, tagIMEDPI::hKL, IMEDPI_UNLOADED, ImmLocalFree, NULL, tagIMEDPI::pNext, TRUE, and UnloadIME(). Referenced by ImmFreeLayout(). { PIMEDPI pImeDpi, pImeDpiT; RtlEnterCriticalSection(&gcsImeDpi); pImeDpi = gpImeDpi; while (pImeDpi != NULL && pImeDpi->hKL != hKL) pImeDpi = pImeDpi->pNext; if (pImeDpi == NULL) { RtlLeaveCriticalSection(&gcsImeDpi); return TRUE; } else if (pImeDpi->cLock != 0) { pImeDpi->dwFlag |= IMEDPI_UNLOADED; RtlLeaveCriticalSection(&gcsImeDpi); return FALSE; } /* * Unlink it. */ if (gpImeDpi == pImeDpi) { gpImeDpi = pImeDpi->pNext; } else { pImeDpiT = gpImeDpi; while (pImeDpiT != NULL && pImeDpiT->pNext != pImeDpi) pImeDpiT = pImeDpiT->pNext; if (pImeDpiT != NULL) pImeDpiT->pNext = pImeDpi->pNext; } /* * Unload the IME DLL. */ UnloadIME(pImeDpi, TRUE); ImmLocalFree(pImeDpi); RtlLeaveCriticalSection(&gcsImeDpi); return TRUE; }

VOID WINAPI ImmUnlockClientImc (  PCLIENTIMC  pClientImc  )

Definition at line 747 of file w32/ntuser/imm/misc.c. References tagCLIENTIMC::cLockObj, DeleteImcCrit, tagCLIENTIMC::hInputContext, IMCF_INDESTROY, ImmLocalFree, NULL, TestICF, and VOID(). Referenced by CreateInputContext(), DestroyInputContext(), ImmEnableIME(), ImmGenerateMessage(), ImmGetAppCompatFlags(), ImmGetCandidateListCountWorker(), ImmGetCandidateListWorker(), ImmGetCompositionFontA(), ImmGetCompositionFontW(), ImmGetCompositionStringA(), ImmGetCompositionStringW(), ImmGetGuideLineWorker(), ImmGetIMCLockCount(), ImmGetSaveContext(), ImmPostMessages(), ImmRequestMessageWorker(), ImmSetActiveContext(), ImmSetCompositionFontA(), ImmSetCompositionFontW(), ImmUnlockIMC(), InternalImmLockIMC(), IsAnsiIMC(), MySetCompFont(), SelectInputContext(), and SetFontForMCWVERTICAL(). { if (InterlockedDecrement(&pClientImc->cLockObj) == 0) { if (TestICF(pClientImc, IMCF_INDESTROY)) { if (pClientImc->hInputContext != NULL) LocalFree(pClientImc->hInputContext); DeleteImcCrit(pClientImc); ImmLocalFree(pClientImc); } } return; }

VOID WINAPI ImmUnlockImeDpi (  PIMEDPI  pImeDpi  )

Definition at line 824 of file w32/ntuser/imm/misc.c. References tagIMEDPI::cLock, tagIMEDPI::dwFlag, gcsImeDpi, gpImeDpi, IMEDPI_UNLOADED, IMEDPI_UNLOCKUNLOAD, tagIMEDPI::ImeInfo, ImmLocalFree, NULL, tagIMEDPI::pNext, TRUE, UnloadIME(), and VOID(). Referenced by _InitializeImmEntryTable(), CreateInputContext(), DestroyInputContext(), HotKeyIDDispatcher(), ImmActivateLayout(), ImmConfigureIMEA(), ImmConfigureIMEW(), ImmCreateSoftKeyboard(), ImmEnumRegisterWordA(), ImmEnumRegisterWordW(), ImmEscapeA(), ImmEscapeW(), ImmGetConversionListA(), ImmGetConversionListW(), ImmGetImeMenuItemsWorker(), ImmGetProperty(), ImmGetRegisterWordStyleA(), ImmGetRegisterWordStyleW(), ImmNotifyIME(), ImmPenAuxInput(), ImmProcessKey(), ImmRegisterWordA(), ImmRegisterWordW(), ImmSetActiveContext(), ImmSetCompositionStringWorker(), ImmTranslateMessage(), ImmUnregisterWordA(), ImmUnregisterWordW(), JCloseOpen(), MakeIMENotify(), SelectInputContext(), and TransHanjaMode(). { PIMEDPI pImeDpiT; if (pImeDpi == NULL) return; RtlEnterCriticalSection(&gcsImeDpi); if (--pImeDpi->cLock == 0) { if ((pImeDpi->dwFlag & IMEDPI_UNLOADED) || ((pImeDpi->dwFlag & IMEDPI_UNLOCKUNLOAD) && (pImeDpi->ImeInfo.fdwProperty & IME_PROP_END_UNLOAD))) { /* * Unlink it. */ if (gpImeDpi == pImeDpi) { gpImeDpi = pImeDpi->pNext; } else { pImeDpiT = gpImeDpi; while (pImeDpiT != NULL && pImeDpiT->pNext != pImeDpi) pImeDpiT = pImeDpiT->pNext; if (pImeDpiT != NULL) pImeDpiT->pNext = pImeDpi->pNext; } /* * Unload the IME DLL. */ UnloadIME(pImeDpi, TRUE); ImmLocalFree(pImeDpi); } } RtlLeaveCriticalSection(&gcsImeDpi); return; }

---