mlng.cpp File Reference

#include "precomp.h"
#include <shellapi.h>
#include <imm.h>
#include <imm32_undoc.h>
#include <shlobj.h>
#include <shlwapi.h>
#include <shlwapi_undoc.h>
#include <strsafe.h>
#include <assert.h>
#include "mlng.h"
#include <wine/debug.h>

Include dependency graph for mlng.cpp:

Go to the source code of this file.

Functions
	WINE_DEFAULT_DEBUG_CHANNEL (msctf)
DWORD	GetSpecialKLID (_In_ HKL hKL)
	@implemented
DWORD	GetHKLSubstitute (_In_ HKL hKL)
	@implemented
static BOOL	GetKbdLayoutNameFromReg (_In_ HKL hKL, _Out_ LPWSTR pszDesc, _In_ UINT cchDesc)
	@implemented
static BOOL	GetHKLName (_In_ HKL hKL, _Out_ LPWSTR pszDesc, _In_ UINT cchDesc)
	@implemented
static BOOL	GetHKLDesctription (_In_ HKL hKL, _Out_ LPWSTR pszDesc, _In_ UINT cchDesc, _Out_ LPWSTR pszImeFileName, _In_ UINT cchImeFileName)
	@implemented
HICON	GetIconFromFile (_In_ INT cx, _In_ INT cy, _In_ LPCWSTR pszFileName, _In_ INT iIcon)
	@implemented
static BOOL	EnsureIconImageList (VOID)
	@implemented
static INT	GetPhysicalFontHeight (LOGFONTW *plf)
	@implemented
INT	InatAddIcon (_In_ HICON hIcon)
	@implemented
HICON	InatCreateIconBySize (_In_ LANGID LangID, _In_ INT nWidth, _In_ INT nHeight, _In_ const LOGFONTW *plf)
	@implemented
HICON	InatCreateIcon (_In_ LANGID LangID)
	@implemented
BOOL	InatGetIconSize (_Out_ INT *pcx, _Out_ INT *pcy)
	@implemented
INT	InatGetImageCount (VOID)
	@implemented
VOID	InatRemoveAll (VOID)
	@implemented
VOID	UninitINAT (VOID)
	@implemented
static BOOL	CheckMlngInfo (VOID)
	@implemented
static VOID	DestroyMlngInfo (VOID)
	@implemented
static VOID	CreateMlngInfo (VOID)
	@implemented
EXTERN_C VOID WINAPI	TF_InitMlngInfo (VOID)
EXTERN_C INT WINAPI	TF_MlngInfoCount (VOID)
EXTERN_C HICON WINAPI	TF_InatExtractIcon (_In_ INT iKL)
EXTERN_C INT WINAPI	TF_GetMlngIconIndex (_In_ INT iKL)
EXTERN_C BOOL WINAPI	TF_GetMlngHKL (_In_ INT iKL, _Out_opt_ HKL *phKL, _Out_opt_ LPWSTR pszDesc, _In_ INT cchDesc)

Variables
CRITICAL_SECTION	g_cs
CicArray< MLNGINFO > *	g_pMlngInfo = NULL
CStaticIconList	g_IconList
static HKL	s_hCacheKL = NULL
static DWORD	s_dwCacheKLID = 0

Function Documentation

CheckMlngInfo()

static BOOL CheckMlngInfo ( VOID  )

static

@implemented

Definition at line 508 of file mlng.cpp.

{
    if (!g_pMlngInfo)
        return TRUE; // Needs creation
 
    INT cKLs = ::GetKeyboardLayoutList(0, NULL);
    if (cKLs != TF_MlngInfoCount())
        return TRUE; // Needs refresh
 
    if (!cKLs)
        return FALSE;
 
    HKL *phKLs = (HKL*)cicMemAlloc(cKLs * sizeof(HKL));
    if (!phKLs)
        return FALSE;
 
    ::GetKeyboardLayoutList(cKLs, phKLs);
 
    assert(g_pMlngInfo);
 
    BOOL ret = FALSE;
    for (INT iKL = 0; iKL < cKLs; ++iKL)
    {
        if ((*g_pMlngInfo)[iKL].m_hKL != phKLs[iKL])
        {
            ret = TRUE; // Needs refresh
            break;
        }
    }
 
    cicMemFree(phKLs);
    return ret;
}

Referenced by TF_InitMlngInfo().

CreateMlngInfo()

static VOID CreateMlngInfo ( VOID  )

static

@implemented

Definition at line 553 of file mlng.cpp.

{
    if (!g_pMlngInfo)
    {
        g_pMlngInfo = new(cicNoThrow) CicArray<MLNGINFO>();
        if (!g_pMlngInfo)
            return;
    }
 
    if (!EnsureIconImageList())
        return;
 
    INT cKLs = ::GetKeyboardLayoutList(0, NULL);
    HKL *phKLs = (HKL*)cicMemAllocClear(cKLs * sizeof(HKL));
    if (!phKLs)
        return;
 
    ::GetKeyboardLayoutList(cKLs, phKLs);
 
    for (INT iKL = 0; iKL < cKLs; ++iKL)
    {
        MLNGINFO& info = (*g_pMlngInfo)[iKL];
        info.m_hKL = phKLs[iKL];
        info.m_bInitDesc = FALSE;
        info.m_bInitIcon = FALSE;
    }
 
    cicMemFree(phKLs);
}

Referenced by TF_InitMlngInfo().

DestroyMlngInfo()

static VOID DestroyMlngInfo ( VOID  )

static

@implemented

Definition at line 543 of file mlng.cpp.

{
    if (!g_pMlngInfo)
        return;
 
    delete g_pMlngInfo;
    g_pMlngInfo = NULL;
}

Referenced by TF_InitMlngInfo().

EnsureIconImageList()

static BOOL EnsureIconImageList ( VOID  )

static

@implemented

Definition at line 218 of file mlng.cpp.

{
    if (!CStaticIconList::s_cx)
        g_IconList.Init(::GetSystemMetrics(SM_CYSMICON), ::GetSystemMetrics(SM_CXSMICON));
 
    return TRUE;
}

Referenced by CreateMlngInfo(), and InatAddIcon().

GetHKLDesctription()

static BOOL GetHKLDesctription ( _In_ HKL  hKL, _Out_ LPWSTR  pszDesc, _In_ UINT  cchDesc, _Out_ LPWSTR  pszImeFileName, _In_ UINT  cchImeFileName  )

static

@implemented

Definition at line 177 of file mlng.cpp.

{
    pszDesc[0] = pszImeFileName[0] = UNICODE_NULL;
 
    if (!IS_IME_HKL(hKL))
        return GetHKLName(hKL, pszDesc, cchDesc);
 
    if (GetKbdLayoutNameFromReg(hKL, pszDesc, cchDesc))
        return TRUE;
 
    if (!::ImmGetDescriptionW(hKL, pszDesc, cchDesc))
    {
        *pszDesc = UNICODE_NULL;
        return GetHKLName(hKL, pszDesc, cchDesc);
    }
 
    if (!::ImmGetIMEFileNameW(hKL, pszImeFileName, cchImeFileName))
        *pszImeFileName = UNICODE_NULL;
 
    return TRUE;
}

Referenced by MLNGINFO::InitDesc(), and MLNGINFO::InitIcon().

GetHKLName()

static BOOL GetHKLName ( _In_ HKL  hKL, _Out_ LPWSTR  pszDesc, _In_ UINT  cchDesc  )

static

@implemented

Definition at line 162 of file mlng.cpp.

{
    if (::GetLocaleInfoW(LOWORD(hKL), LOCALE_SLANGUAGE, pszDesc, cchDesc))
        return TRUE;
 
    *pszDesc = UNICODE_NULL;
 
    if (LOWORD(hKL) == HIWORD(hKL))
        return FALSE;
 
    return GetKbdLayoutNameFromReg(hKL, pszDesc, cchDesc);
}

Referenced by GetHKLDesctription().

GetHKLSubstitute()

DWORD GetHKLSubstitute

(

_In_ HKL

hKL

)

@implemented

Definition at line 87 of file mlng.cpp.

{
    if (IS_IME_HKL(hKL))
        return HandleToUlong(hKL);
 
    DWORD dwKLID;
    if (HIWORD(hKL) == LOWORD(hKL))
        dwKLID = LOWORD(hKL);
    else if (IS_SPECIAL_HKL(hKL))
        dwKLID = GetSpecialKLID(hKL);
    else
        dwKLID = HandleToUlong(hKL);
 
    if (dwKLID == 0)
        return HandleToUlong(hKL);
 
    CicRegKey regKey;
    LSTATUS error = regKey.Open(HKEY_CURRENT_USER, L"Keyboard Layout\\Substitutes");
    if (error == ERROR_SUCCESS)
    {
        WCHAR szName[MAX_PATH], szValue[MAX_PATH];
        DWORD dwIndex, dwValue;
        for (dwIndex = 0; ; ++dwIndex)
        {
            error = regKey.EnumValue(dwIndex, szName, _countof(szName));
            szName[_countof(szName) - 1] = UNICODE_NULL; // Avoid buffer overrun
            if (error != ERROR_SUCCESS)
                break;
 
            error = regKey.QuerySz(szName, szValue, _countof(szValue));
            szValue[_countof(szValue) - 1] = UNICODE_NULL; // Avoid buffer overrun
            if (error != ERROR_SUCCESS)
                break;
 
            dwValue = wcstoul(szValue, NULL, 16);
            if ((dwKLID & ~SPECIAL_MASK) == dwValue)
            {
                dwKLID = wcstoul(szName, NULL, 16);
                break;
            }
        }
    }
 
    return dwKLID;
}

Referenced by GetKbdLayoutNameFromReg().

GetIconFromFile()

HICON GetIconFromFile	(	_In_ INT	cx,
		_In_ INT	cy,
		_In_ LPCWSTR	pszFileName,
		_In_ INT	iIcon
	)

@implemented

Definition at line 205 of file mlng.cpp.

{
    HICON hIcon;
 
    if (cx <= GetSystemMetrics(SM_CXSMICON))
        ::ExtractIconExW(pszFileName, iIcon, NULL, &hIcon, 1);
    else
        ::ExtractIconExW(pszFileName, iIcon, &hIcon, NULL, 1);
 
    return hIcon;
}

Referenced by MLNGINFO::InitIcon().

GetKbdLayoutNameFromReg()

static BOOL GetKbdLayoutNameFromReg ( _In_ HKL  hKL, _Out_ LPWSTR  pszDesc, _In_ UINT  cchDesc  )

static

@implemented

Definition at line 135 of file mlng.cpp.

{
    const DWORD dwKLID = GetHKLSubstitute(hKL);
 
    WCHAR szSubKey[MAX_PATH];
    StringCchPrintfW(szSubKey, _countof(szSubKey),
                     L"SYSTEM\\CurrentControlSet\\Control\\Keyboard Layouts\\%08lX",
                     dwKLID);
 
    CicRegKey regKey;
    LSTATUS error = regKey.Open(HKEY_LOCAL_MACHINE, szSubKey);
    if (error != ERROR_SUCCESS)
        return FALSE;
 
    if (SHLoadRegUIStringW(regKey, L"Layout Display Name", pszDesc, cchDesc) == S_OK)
    {
        pszDesc[cchDesc - 1] = UNICODE_NULL; // Avoid buffer overrun
        return TRUE;
    }
 
    error = regKey.QuerySz(L"Layout Text", pszDesc, cchDesc);
    pszDesc[cchDesc - 1] = UNICODE_NULL; // Avoid buffer overrun
    return (error == ERROR_SUCCESS);
}

Referenced by GetHKLDesctription(), and GetHKLName().

GetPhysicalFontHeight()

static INT GetPhysicalFontHeight ( LOGFONTW *  plf )

static

@implemented

Definition at line 227 of file mlng.cpp.

{
    HDC hDC = ::GetDC(NULL);
    HFONT hFont = ::CreateFontIndirectW(plf);
    HGDIOBJ hFontOld = ::SelectObject(hDC, hFont);
    TEXTMETRICW tm;
    ::GetTextMetricsW(hDC, &tm);
    INT ret = tm.tmExternalLeading + tm.tmHeight;
    ::SelectObject(hDC, hFontOld);
    ::DeleteObject(hFont);
    ::ReleaseDC(NULL, hDC);
    return ret;
}

Referenced by InatCreateIcon().

GetSpecialKLID()

DWORD GetSpecialKLID

(

_In_ HKL

hKL

)

@implemented

Definition at line 40 of file mlng.cpp.

{
    assert(IS_SPECIAL_HKL(hKL));
 
    if (s_hCacheKL == hKL && s_dwCacheKLID != 0)
        return s_dwCacheKLID;
 
    s_dwCacheKLID = 0;
 
    CicRegKey regKey1;
    LSTATUS error = regKey1.Open(HKEY_LOCAL_MACHINE,
                                 L"SYSTEM\\CurrentControlSet\\Control\\Keyboard Layouts");
    if (error != ERROR_SUCCESS)
        return 0;
 
    WCHAR szName[16], szLayoutId[16];
    const DWORD dwSpecialId = SPECIALIDFROMHKL(hKL);
    for (DWORD dwIndex = 0; ; ++dwIndex)
    {
        error = ::RegEnumKeyW(regKey1, dwIndex, szName, _countof(szName));
        szName[_countof(szName) - 1] = UNICODE_NULL; // Avoid buffer overrun
        if (error != ERROR_SUCCESS)
            break;
 
        CicRegKey regKey2;
        error = regKey2.Open(regKey1, szName);
        if (error != ERROR_SUCCESS)
            break;
 
        error = regKey2.QuerySz(L"Layout Id", szLayoutId, _countof(szLayoutId));
        szLayoutId[_countof(szLayoutId) - 1] = UNICODE_NULL; // Avoid buffer overrun
        if (error == ERROR_SUCCESS)
            continue;
 
        DWORD dwLayoutId = wcstoul(szLayoutId, NULL, 16);
        if (dwLayoutId == dwSpecialId)
        {
            s_hCacheKL = hKL;
            s_dwCacheKLID = wcstoul(szName, NULL, 16);
            break;
        }
    }
 
    return s_dwCacheKLID;
}

Referenced by GetHKLSubstitute().

InatAddIcon()

INT InatAddIcon

(

_In_ HICON

hIcon

)

@implemented

Definition at line 246 of file mlng.cpp.

{
    if (!EnsureIconImageList())
        return -1;
    return g_IconList.AddIcon(hIcon);
}

Referenced by MLNGINFO::InitIcon().

InatCreateIcon()

HICON InatCreateIcon

(

_In_ LANGID

LangID

)

@implemented

Definition at line 310 of file mlng.cpp.

{
    INT cxSmIcon = ::GetSystemMetrics(SM_CXSMICON), cySmIcon = ::GetSystemMetrics(SM_CYSMICON);
 
    LOGFONTW lf;
    if (!SystemParametersInfoW(SPI_GETICONTITLELOGFONT, sizeof(LOGFONTW), &lf, 0))
        return NULL;
 
    if (cySmIcon < GetPhysicalFontHeight(&lf))
    {
        lf.lfWidth = 0;
        lf.lfHeight = - (7 * cySmIcon) / 10;
    }
 
    return InatCreateIconBySize(LangID, cxSmIcon, cySmIcon, &lf);
}

Referenced by MLNGINFO::InitIcon().

InatCreateIconBySize()

HICON InatCreateIconBySize	(	_In_ LANGID	LangID,
		_In_ INT	nWidth,
		_In_ INT	nHeight,
		_In_ const LOGFONTW *	plf
	)

@implemented

Definition at line 255 of file mlng.cpp.

{
    WCHAR szText[64];
    BOOL ret = ::GetLocaleInfoW(LangID, LOCALE_NOUSEROVERRIDE | LOCALE_SABBREVLANGNAME,
                                szText, _countof(szText));
    if (!ret)
        szText[0] = szText[1] = L'?';
 
    szText[2] = UNICODE_NULL;
    CharUpperW(szText);
 
    HFONT hFont = ::CreateFontIndirectW(plf);
    if (!hFont)
        return NULL;
 
    HDC hDC = ::GetDC(NULL);
    HDC hMemDC = ::CreateCompatibleDC(hDC);
    HBITMAP hbmColor = ::CreateCompatibleBitmap(hDC, nWidth, nHeight);
    HBITMAP hbmMask = ::CreateBitmap(nWidth, nHeight, 1, 1, NULL);
    ::ReleaseDC(NULL, hDC);
 
    HICON hIcon = NULL;
    HGDIOBJ hbmOld = ::SelectObject(hMemDC, hbmColor);
    HGDIOBJ hFontOld = ::SelectObject(hMemDC, hFont);
    if (hMemDC && hbmColor && hbmMask)
    {
        ::SetBkColor(hMemDC, ::GetSysColor(COLOR_HIGHLIGHT));
        ::SetTextColor(hMemDC, ::GetSysColor(COLOR_HIGHLIGHTTEXT));
 
        RECT rc = { 0, 0, nWidth, nHeight };
        ::ExtTextOutW(hMemDC, 0, 0, ETO_OPAQUE, &rc, L"", 0, NULL);
 
        ::DrawTextW(hMemDC, szText, 2, &rc, DT_SINGLELINE | DT_CENTER | DT_VCENTER);
        ::SelectObject(hMemDC, hbmMask);
 
        ::PatBlt(hMemDC, 0, 0, nWidth, nHeight, BLACKNESS);
 
        ICONINFO IconInfo = { TRUE, 0, 0, hbmMask, hbmColor };
        hIcon = ::CreateIconIndirect(&IconInfo);
    }
    ::SelectObject(hMemDC, hFontOld);
    ::SelectObject(hMemDC, hbmOld);
 
    ::DeleteObject(hbmMask);
    ::DeleteObject(hbmColor);
    ::DeleteDC(hMemDC);
    ::DeleteObject(hFont);
    return hIcon;
}

Referenced by InatCreateIcon().

InatGetIconSize()

BOOL InatGetIconSize	(	_Out_ INT *	pcx,
		_Out_ INT *	pcy
	)

@implemented

Definition at line 328 of file mlng.cpp.

{
    g_IconList.GetIconSize(pcx, pcy);
    return TRUE;
}

Referenced by MLNGINFO::InitIcon().

InatGetImageCount()

INT InatGetImageCount

(

VOID

)

@implemented

Definition at line 335 of file mlng.cpp.

{
    return g_IconList.GetImageCount();
}

InatRemoveAll()

VOID InatRemoveAll

(

VOID

)

@implemented

Definition at line 341 of file mlng.cpp.

{
    if (CStaticIconList::s_cx)
        g_IconList.RemoveAll(FALSE);
}

TF_GetMlngHKL()

EXTERN_C BOOL WINAPI TF_GetMlngHKL	(	_In_ INT	iKL,
		_Out_opt_ HKL *	phKL,
		_Out_opt_ LPWSTR	pszDesc,
		_In_ INT	cchDesc
	)

Definition at line 658 of file mlng.cpp.

{
    TRACE("(%d, %p, %p, %d)\n", iKL, phKL, pszDesc, cchDesc);
 
    BOOL ret = FALSE;
 
    ::EnterCriticalSection(&g_cs);
 
    assert(g_pMlngInfo);
 
    if (iKL < (INT)g_pMlngInfo->size())
    {
        MLNGINFO& info = (*g_pMlngInfo)[iKL];
 
        if (phKL)
            *phKL = info.m_hKL;
 
        if (pszDesc)
            StringCchCopyW(pszDesc, cchDesc, info.GetDesc());
 
        ret = TRUE;
    }
 
    ::LeaveCriticalSection(&g_cs);
 
    return ret;
}

Referenced by GethKLDesc(), GetIconIndexFromhKL(), CLBarInatItem::InitMenu(), and CLBarInatItem::OnMenuSelect().

TF_GetMlngIconIndex()

EXTERN_C INT WINAPI TF_GetMlngIconIndex

(

_In_ INT

iKL

)

Definition at line 634 of file mlng.cpp.

{
    TRACE("(%d)\n", iKL);
 
    INT iIcon = -1;
 
    ::EnterCriticalSection(&g_cs);
 
    assert(g_pMlngInfo);
 
    if (iKL < (INT)g_pMlngInfo->size())
        iIcon = (*g_pMlngInfo)[iKL].GetIconIndex();
 
    ::LeaveCriticalSection(&g_cs);
 
    return iIcon;
}

Referenced by GetIconIndexFromhKL().

TF_InatExtractIcon()

EXTERN_C HICON WINAPI TF_InatExtractIcon

(

_In_ INT

iKL

)

Definition at line 623 of file mlng.cpp.

{
    TRACE("(%d)\n", iKL);
    return g_IconList.ExtractIcon(iKL);
}

Referenced by CLBarInatItem::GetIcon(), and CLBarInatItem::InitMenu().

TF_InitMlngInfo()

EXTERN_C VOID WINAPI TF_InitMlngInfo

(

VOID

)

Definition at line 588 of file mlng.cpp.

{
    TRACE("()\n");
 
    ::EnterCriticalSection(&g_cs);
 
    if (CheckMlngInfo())
    {
        DestroyMlngInfo();
        CreateMlngInfo();
    }
 
    ::LeaveCriticalSection(&g_cs);
}

Referenced by CLBarInatItem::CLBarInatItem(), and CLBarInatItem::InitMenu().

TF_MlngInfoCount()

EXTERN_C INT WINAPI TF_MlngInfoCount

(

VOID

)

Definition at line 608 of file mlng.cpp.

{
    TRACE("()\n");
 
    if (!g_pMlngInfo)
        return 0;
 
    return (INT)g_pMlngInfo->size();
}

Referenced by CheckMlngInfo(), CLBarInatItem::CLBarInatItem(), GethKLDesc(), GetIconIndexFromhKL(), and CLBarInatItem::InitMenu().

UninitINAT()

VOID UninitINAT

(

VOID

)

@implemented

Definition at line 348 of file mlng.cpp.

{
    g_IconList.RemoveAll(TRUE);
 
    if (g_pMlngInfo)
    {
        delete g_pMlngInfo;
        g_pMlngInfo = NULL;
    }
}

Referenced by ProcessDetach().

WINE_DEFAULT_DEBUG_CHANNEL()

WINE_DEFAULT_DEBUG_CHANNEL

(

msctf

)

Variable Documentation

g_cs

CRITICAL_SECTION g_cs

extern

Definition at line 25 of file utils.cpp.

Referenced by CStaticIconList::AddIcon(), CStaticIconList::ExtractIcon(), CStaticIconList::GetIconSize(), CStaticIconList::GetImageCount(), CStaticIconList::Init(), ProcessAttach(), ProcessDetach(), CStaticIconList::RemoveAll(), TF_GetMlngHKL(), TF_GetMlngIconIndex(), and TF_InitMlngInfo().

g_IconList

CStaticIconList g_IconList

Definition at line 29 of file mlng.cpp.

Referenced by CStaticIconList::AddIcon(), EnsureIconImageList(), CStaticIconList::ExtractIcon(), CStaticIconList::GetImageCount(), InatAddIcon(), InatGetIconSize(), InatGetImageCount(), InatRemoveAll(), CStaticIconList::RemoveAll(), TF_InatExtractIcon(), and UninitINAT().

g_pMlngInfo

CicArray<MLNGINFO>* g_pMlngInfo = NULL

Definition at line 26 of file mlng.cpp.

Referenced by CheckMlngInfo(), CreateMlngInfo(), DestroyMlngInfo(), TF_GetMlngHKL(), TF_GetMlngIconIndex(), TF_MlngInfoCount(), and UninitINAT().

s_dwCacheKLID

DWORD s_dwCacheKLID = 0

static

Definition at line 33 of file mlng.cpp.

Referenced by GetSpecialKLID().

s_hCacheKL

HKL s_hCacheKL = NULL

static

Definition at line 32 of file mlng.cpp.

Referenced by GetSpecialKLID().