utils.h File Reference

General-purpose utility functions (wrappers around or reimplementations of Win32 APIs). More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
INT WINAPI	K32LoadStringExW (IN HINSTANCE hInstance OPTIONAL, IN UINT uID, IN LANGID LanguageId, OUT LPWSTR lpBuffer, IN INT nBufferMax)
INT WINAPI	K32LoadStringW (IN HINSTANCE hInstance OPTIONAL, IN UINT uID, OUT LPWSTR lpBuffer, IN INT nBufferMax)
DWORD WINAPI	FormatMessageSafeW (IN DWORD dwFlags, IN LPCVOID lpSource OPTIONAL, IN DWORD dwMessageId, IN DWORD dwLanguageId, OUT LPWSTR lpBuffer, IN DWORD nSize, IN va_list *Arguments OPTIONAL)
LANGID	ConSetThreadUILanguage (IN LANGID LangId OPTIONAL)
BOOL	IsTTYHandle (IN HANDLE hHandle)
BOOL	IsConsoleHandle (IN HANDLE hHandle)

Detailed Description

General-purpose utility functions (wrappers around or reimplementations of Win32 APIs).

Definition in file utils.h.

Function Documentation

ConSetThreadUILanguage()

LANGID ConSetThreadUILanguage

(

IN LANGID LangId

OPTIONAL

)

Definition at line 352 of file utils.c.

{
    /* The function pointer is shared amongst all threads */
    static volatile LANGID (WINAPI *pfnSetThreadUILanguage)(LANGID) = NULL;
 
    if (!pfnSetThreadUILanguage)
    {
        /* Load the API from kernel32 */
        PVOID pFunc = (PVOID)GetProcAddress(GetModuleHandleW(L"kernel32.dll"), "SetThreadUILanguage");
        if (!pFunc)
        {
            /* Fail since the API is not available */
            return 0;
        }
        /* Set the function pointer in case it hasn't been already set by another thread */
        InterlockedCompareExchangePointer((PVOID*)&pfnSetThreadUILanguage, pFunc, NULL);
        // ASSERT(pfnSetThreadUILanguage);
    }
    return pfnSetThreadUILanguage(LangId);
}

Referenced by _tmain(), cmd_start(), Execute(), SetConsoleCPState(), and wmain().

FormatMessageSafeW()

DWORD WINAPI FormatMessageSafeW	(	IN DWORD	dwFlags,
		IN LPCVOID lpSource	OPTIONAL,
		IN DWORD	dwMessageId,
		IN DWORD	dwLanguageId,
		OUT LPWSTR	lpBuffer,
		IN DWORD	nSize,
		IN va_list *Arguments	OPTIONAL
	)

Definition at line 254 of file utils.c.

{
    DWORD dwLength = 0;
 
    _SEH2_TRY
    {
        /*
         * Retrieve the message string. Wrap in SEH
         * to protect from invalid string parameters.
         */
        _SEH2_TRY
        {
            dwLength = FormatMessageW(dwFlags,
                                      lpSource,
                                      dwMessageId,
                                      dwLanguageId,
                                      lpBuffer,
                                      nSize,
                                      Arguments);
        }
        _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER)
        {
            dwLength = 0;
 
            /*
             * An exception occurred while calling FormatMessage, this is usually
             * the sign that a parameter was invalid, either 'lpBuffer' was NULL
             * but we did not pass the flag FORMAT_MESSAGE_ALLOCATE_BUFFER, or the
             * array pointer 'Arguments' was NULL or did not contain enough elements,
             * and we did not pass the flag FORMAT_MESSAGE_IGNORE_INSERTS, and the
             * message string expected too many inserts.
             * In this last case only, we can call again FormatMessage but ignore
             * explicitly the inserts. The string that we will return to the user
             * will not be pre-formatted.
             */
            if (((dwFlags & FORMAT_MESSAGE_ALLOCATE_BUFFER) || lpBuffer) &&
                !(dwFlags & FORMAT_MESSAGE_IGNORE_INSERTS))
            {
                /* Remove any possible harmful flags and always ignore inserts */
                dwFlags &= ~FORMAT_MESSAGE_ARGUMENT_ARRAY;
                dwFlags |=  FORMAT_MESSAGE_IGNORE_INSERTS;
 
                /* If this call also throws an exception, we are really dead */
                dwLength = FormatMessageW(dwFlags,
                                          lpSource,
                                          dwMessageId,
                                          dwLanguageId,
                                          lpBuffer,
                                          nSize,
                                          NULL /* Arguments */);
            }
        }
        _SEH2_END;
    }
    _SEH2_FINALLY
    {
    }
    _SEH2_END;
 
    return dwLength;
}

Referenced by ConMsgPrintfV(), and ConResMsgPrintfExV().

IsConsoleHandle()

BOOL IsConsoleHandle

(

IN HANDLE

hHandle

)

Definition at line 419 of file utils.c.

{
    DWORD dwMode;
 
    /* Check whether the handle may be that of a console... */
    if ((GetFileType(hHandle) & ~FILE_TYPE_REMOTE) != FILE_TYPE_CHAR)
        return FALSE;
 
    /*
     * It may be. Perform another test. The idea comes from the
     * MSDN description of the WriteConsole API:
     *
     * "WriteConsole fails if it is used with a standard handle
     *  that is redirected to a file. If an application processes
     *  multilingual output that can be redirected, determine whether
     *  the output handle is a console handle (one method is to call
     *  the GetConsoleMode function and check whether it succeeds).
     *  If the handle is a console handle, call WriteConsole. If the
     *  handle is not a console handle, the output is redirected and
     *  you should call WriteFile to perform the I/O."
     */
    return GetConsoleMode(hHandle, &dwMode);
}

IsTTYHandle()

BOOL IsTTYHandle

(

IN HANDLE

hHandle

)

Definition at line 393 of file utils.c.

{
    /*
     * More general test than IsConsoleHandle(). Consoles, as well as serial
     * (communications) ports, etc... verify this test, but only consoles
     * verify the IsConsoleHandle() test: indeed the latter checks whether
     * the handle is really handled by the console subsystem.
     */
    return ((GetFileType(hHandle) & ~FILE_TYPE_REMOTE) == FILE_TYPE_CHAR);
}

Referenced by ConClearLine(), ConClearScreen(), ConGetScreenInfo(), and ConRingBell().

K32LoadStringExW()

INT WINAPI K32LoadStringExW	(	IN HINSTANCE hInstance	OPTIONAL,
		IN UINT	uID,
		IN LANGID	LanguageId,
		OUT LPWSTR	lpBuffer,
		IN INT	nBufferMax
	)

Definition at line 99 of file utils.c.

{
    HRSRC hrsrc;
    HGLOBAL hmem;
    WCHAR *p;
    UINT i;
 
    if (!lpBuffer)
        return 0;
 
    /* Use LOWORD (incremented by 1) as ResourceID */
    /* There are always blocks of 16 strings */
    hrsrc = FindResourceExW(hInstance,
                            (LPCWSTR)RT_STRING,
                            MAKEINTRESOURCEW((LOWORD(uID) >> 4) + 1),
                            LanguageId);
    if (!hrsrc) return 0;
 
    hmem = LoadResource(hInstance, hrsrc);
    if (!hmem) return 0;
 
    p = LockResource(hmem);
    // FreeResource(hmem);
 
    /* Find the string we're looking for */
    uID &= 0x000F; /* Position in the block, same as % 16 */
    for (i = 0; i < uID; i++)
        p += *p + 1;
 
    /*
     * If nBufferMax == 0, then return a read-only pointer
     * to the resource itself in lpBuffer it is assumed that
     * lpBuffer is actually a (LPWSTR*).
     */
    if (nBufferMax == 0)
    {
        *((LPWSTR*)lpBuffer) = p + 1;
        return *p;
    }
 
    i = min(nBufferMax - 1, *p);
    if (i > 0)
    {
        memcpy(lpBuffer, p + 1, i * sizeof(WCHAR));
        lpBuffer[i] = L'\0';
    }
    else
    {
        if (nBufferMax > 1)
        {
            lpBuffer[0] = L'\0';
            return 0;
        }
    }
 
    return i;
}

Referenced by ConResMsgPrintfExV(), ConResPrintfExV(), ConResPutsEx(), and K32LoadStringW().

K32LoadStringW()

INT WINAPI K32LoadStringW	(	IN HINSTANCE hInstance	OPTIONAL,
		IN UINT	uID,
		OUT LPWSTR	lpBuffer,
		IN INT	nBufferMax
	)

Definition at line 173 of file utils.c.

{
    // NOTE: Instead of using LANG_NEUTRAL, one might use LANG_USER_DEFAULT...
    return K32LoadStringExW(hInstance, uID,
                            MAKELANGID(LANG_NEUTRAL, SUBLANG_NEUTRAL),
                            lpBuffer, nBufferMax);
}

Referenced by ConResPagingEx(), HelpCommand(), HelpCommandList(), PagePrompt(), Usage(), WlanPrintCurrentStatus(), WlanScan(), and wmain().