locale.c File Reference

#include <rtl.h>
#include <debug.h>

Include dependency graph for locale.c:

Go to the source code of this file.

Classes
struct	_LOCALE_ENTRY

Macros
#define	NDEBUG
#define	MAX_PRIMARY_LANGUAGE   0x3FF
#define	MAX_BASIC_LCID   0x5FFF
#define	LCID_ALT_NAME   0x00100000
#define	LOWERCASE_CHAR(Char)    (((Char) >= 'A' && (Char) <= 'Z') ? ((Char) + ('a' - 'A')) : (Char))

Typedefs
typedef struct _LOCALE_ENTRY	LOCALE_ENTRY

Functions
NTSTATUS NTAPI	RtlpInitializeLocaleTable (VOID)
	Initializes the locale index table, that maps the LCIDs to their indexes in the alphabetical table, and is sorted by LCID.
static _Must_inspect_result_ ULONG	FindIndexByLcid (_In_ LCID Lcid)
static _Must_inspect_result_ INT	CompareLocaleNames (_In_ PCSTR AsciiLocaleName, _In_ PCUNICODE_STRING UnicodeLocaleName)
static _Must_inspect_result_ ULONG	FindIndexByLocaleName (_In_ PCUNICODE_STRING LocaleName)
static _Must_inspect_result_ BOOLEAN	CopyAsciizToUnicodeString (_Inout_ PUNICODE_STRING UnicodeString, _In_ PCSTR AsciiString)
static BOOLEAN	IsNeutralLocale (_In_ LCID Lcid)
NTSTATUS NTAPI	RtlLcidToLocaleName (_In_ LCID Lcid, _Inout_ PUNICODE_STRING LocaleName, _In_ ULONG Flags, _In_ BOOLEAN AllocateDestinationString)
static _Must_inspect_result_ NTSTATUS	RtlpLocaleNameToLcidInternal (_In_ PCUNICODE_STRING LocaleName, _Out_ PLCID Lcid, _In_ ULONG Flags)
NTSTATUS NTAPI	RtlLocaleNameToLcid (_In_ PCWSTR LocaleName, _Out_ PLCID Lcid, _In_ ULONG Flags)
	_Success_ (return !=FALSE)
BOOLEAN NTAPI	RtlIsValidLocaleName (_In_ LPCWSTR LocaleName, _In_ ULONG Flags)
NTSTATUS NTAPI	RtlConvertLCIDToString (_In_ LCID LcidValue, _In_ ULONG Base, _In_ ULONG Padding, _Out_writes_(Size) PWSTR pResultBuf, _In_ ULONG Size)

Variables
LCID	RtlpUserDefaultLcid
LCID	RtlpSystemDefaultLcid
static const LOCALE_ENTRY	RtlpLocaleTable []
static USHORT	RtlpLocaleIndexTable [_ARRAYSIZE(RtlpLocaleTable)]

Macro Definition Documentation

LCID_ALT_NAME

#define LCID_ALT_NAME   0x00100000

Definition at line 21 of file locale.c.

LOWERCASE_CHAR

#define LOWERCASE_CHAR

(

Char

)

(((Char) >= 'A' && (Char) <= 'Z') ? ((Char) + ('a' - 'A')) : (Char))

Definition at line 576 of file locale.c.

MAX_BASIC_LCID

#define MAX_BASIC_LCID   0x5FFF

Definition at line 19 of file locale.c.

MAX_PRIMARY_LANGUAGE

#define MAX_PRIMARY_LANGUAGE   0x3FF

Definition at line 18 of file locale.c.

NDEBUG

#define NDEBUG

Definition at line 10 of file locale.c.

Typedef Documentation

LOCALE_ENTRY

typedef struct _LOCALE_ENTRY LOCALE_ENTRY

Function Documentation

_Success_()

_Success_

(

return !

= FALSE

)

Definition at line 855 of file locale.c.

{
    NTSTATUS Status;
 
    /* Forward to RtlLcidToLocaleName, include neutral names */
    Status = RtlLcidToLocaleName(Lcid, String, RTL_LOCALE_ALLOW_NEUTRAL_NAMES, FALSE);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("RtlLcidToLocaleName failed with status 0x%lx\n", Status);
        return FALSE;
    }
 
    return TRUE;
}

CompareLocaleNames()

static _Must_inspect_result_ INT CompareLocaleNames ( _In_ PCSTR  AsciiLocaleName, _In_ PCUNICODE_STRING  UnicodeLocaleName  )

static

Definition at line 582 of file locale.c.

{
    ULONG i;
 
    /* Do a case-insensitive comparison. */
    for (i = 0; i < UnicodeLocaleName->Length / sizeof(WCHAR); i++)
    {
        /* Make the 2 chars lower case for comparison */
        CHAR Char1 = LOWERCASE_CHAR(AsciiLocaleName[i]);
        WCHAR Char2 = LOWERCASE_CHAR(UnicodeLocaleName->Buffer[i]);
 
        /* Keep comparing, while they are equal */
        if (Char1 == Char2)
        {
            continue;
        }
 
        /* Check if the ASCII string ends first */
        if (AsciiLocaleName[i] == '\0')
        {
            /* The 1st string is shorter than the 2nd, i.e. smaller */
            return -1;
        }
 
        /* Return the difference between the two characters */
        return (INT)Char1 - (INT)Char2;
    }
 
    /* The strings match up to the lenth of the unicode string.
       If the ASCII string ends here, they are equal. */
    if (AsciiLocaleName[i] == '\0')
    {
        return 0;
    }
 
    /* The 1st string is longer than the 2nd, i.e. larger */
    return 1;
}

Referenced by FindIndexByLocaleName().

CopyAsciizToUnicodeString()

static _Must_inspect_result_ BOOLEAN CopyAsciizToUnicodeString ( _Inout_ PUNICODE_STRING  UnicodeString, _In_ PCSTR  AsciiString  )

static

Definition at line 661 of file locale.c.

{
    SIZE_T AsciiLength = strlen(AsciiString);
 
    /* Make sure we can copy the full string, including the terminating 0 */
    if (UnicodeString->MaximumLength < (AsciiLength + 1) * sizeof(WCHAR))
    {
        return FALSE;
    }
 
    /* Copy the string manually */
    for (SIZE_T i = 0; i < AsciiLength; i++)
    {
        UnicodeString->Buffer[i] = (WCHAR)AsciiString[i];
    }
 
    /* Add the terminating 0 and update the Length */
    UnicodeString->Buffer[AsciiLength] = UNICODE_NULL;
    UnicodeString->Length = (USHORT)(AsciiLength * sizeof(WCHAR));
 
    return TRUE;
}

Referenced by RtlLcidToLocaleName().

FindIndexByLcid()

static _Must_inspect_result_ ULONG FindIndexByLcid ( _In_ LCID  Lcid )

static

Definition at line 540 of file locale.c.

{
    USHORT TableIndex;
    LONG Low = 0;
    LONG High = ARRAYSIZE(RtlpLocaleTable) - 1;
    LONG Middle;
    LCID CurrentLcid;
 
    while (Low <= High)
    {
        Middle = (Low + High) / 2;
 
        /* Use the indirection table to get the real table entry */
        TableIndex = RtlpLocaleIndexTable[Middle];
        ASSERT(TableIndex < ARRAYSIZE(RtlpLocaleTable));
 
        /* Compare the LCID (including the alternative name flag!) */
        CurrentLcid = RtlpLocaleTable[TableIndex].Lcid;
        if (CurrentLcid < Lcid)
        {
            Low = Middle + 1;
        }
        else if (CurrentLcid > Lcid)
        {
            High = Middle - 1;
        }
        else /* CurrentLcid == Lcid */
        {
            return RtlpLocaleIndexTable[Middle];
        }
    }
 
    return MAXULONG;
}

Referenced by RtlLcidToLocaleName().

FindIndexByLocaleName()

static _Must_inspect_result_ ULONG FindIndexByLocaleName ( _In_ PCUNICODE_STRING  LocaleName )

static

Definition at line 626 of file locale.c.

{
    LONG Low = 0;
    LONG High = ARRAYSIZE(RtlpLocaleTable) - 1;
    LONG Middle;
    PCSTR CurrentLocaleName;
    INT CompareResult;
 
    while (Low <= High)
    {
        Middle = (Low + High) / 2;
 
        CurrentLocaleName = RtlpLocaleTable[Middle].Locale;
        CompareResult = CompareLocaleNames(CurrentLocaleName, LocaleName);
        if (CompareResult < 0)
        {
            Low = Middle + 1;
        }
        else if (CompareResult > 0)
        {
            High = Middle - 1;
        }
        else /* CompareResult == 0 */
        {
            return Middle;
        }
    }
 
    return MAXULONG;
}

Referenced by RtlpLocaleNameToLcidInternal().

IsNeutralLocale()

static BOOLEAN IsNeutralLocale ( _In_ LCID  Lcid )

static

Definition at line 688 of file locale.c.

{
    /* Check if the LCID is within the neutral locale range */
    if (((Lcid <= MAX_PRIMARY_LANGUAGE) && (Lcid != LOCALE_INVARIANT)) ||
        (Lcid == 0x0460) /* ks-Arab */ ||
        ((Lcid & 0xFFFF) > MAX_BASIC_LCID))
    {
        return TRUE;
    }
 
    return FALSE;
}

Referenced by RtlLcidToLocaleName(), and RtlpLocaleNameToLcidInternal().

RtlConvertLCIDToString()

NTSTATUS NTAPI RtlConvertLCIDToString	(	_In_ LCID	LcidValue,
		_In_ ULONG	Base,
		_In_ ULONG	Padding,
		_Out_writes_(Size) PWSTR	pResultBuf,
		_In_ ULONG	Size
	)

Definition at line 914 of file locale.c.

{
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

RtlIsValidLocaleName()

BOOLEAN NTAPI RtlIsValidLocaleName	(	_In_ LPCWSTR	LocaleName,
		_In_ ULONG	Flags
	)

Definition at line 904 of file locale.c.

{
    UNIMPLEMENTED;
    return TRUE;
}

RtlLcidToLocaleName()

NTSTATUS NTAPI RtlLcidToLocaleName	(	_In_ LCID	Lcid,
		_Inout_ PUNICODE_STRING	LocaleName,
		_In_ ULONG	Flags,
		_In_ BOOLEAN	AllocateDestinationString
	)

Definition at line 704 of file locale.c.

{
    ULONG LocaleIndex;
 
    /* Check for invalid flags */
    if (Flags & ~0x2)
    {
        DPRINT1("RtlLcidToLocaleName: Invalid flags: 0x%lx\n", Flags);
        return STATUS_INVALID_PARAMETER_3;
    }
 
    /* Check if the LocaleName buffer is valid */
    if ((LocaleName == NULL) || (LocaleName->Buffer == NULL))
    {
        DPRINT1("RtlLcidToLocaleName: Invalid buffer\n");
        return STATUS_INVALID_PARAMETER_2;
    }
 
    /* Validate LCID */
    if (Lcid & ~NLS_VALID_LOCALE_MASK)
    {
        DPRINT1("RtlLcidToLocaleName: Invalid LCID: 0x%lx\n", Lcid);
        return STATUS_INVALID_PARAMETER_1;
    }
 
    /* Check if neutral locales were requested */
    if ((Flags & RTL_LOCALE_ALLOW_NEUTRAL_NAMES) == 0)
    {
        /* Check if this is a neutral locale */
        if (IsNeutralLocale(Lcid))
        {
            DPRINT("RtlLcidToLocaleName: Neutral LCID: 0x%lx\n", Lcid);
            return STATUS_INVALID_PARAMETER_1;
        }
    }
 
    /* Handle special LCIDs */
    switch (Lcid)
    {
        case LOCALE_USER_DEFAULT:
            Lcid = RtlpUserDefaultLcid;
            break;
 
        case LOCALE_SYSTEM_DEFAULT:
        case LOCALE_CUSTOM_DEFAULT:
            Lcid = RtlpSystemDefaultLcid;
            break;
 
        case LOCALE_CUSTOM_UI_DEFAULT:
            return STATUS_UNSUCCESSFUL;
    }
 
    /* Try to find the locale by LCID */
    LocaleIndex = FindIndexByLcid(Lcid);
    if (LocaleIndex == MAXULONG)
    {
        DPRINT("RtlLcidToLocaleName: LCID 0x%lx not found\n", Lcid);
        return STATUS_INVALID_PARAMETER_1;
    }
 
    /* Copy the locale name to the buffer */
    if (!CopyAsciizToUnicodeString(LocaleName, RtlpLocaleTable[LocaleIndex].Locale))
    {
        DPRINT("RtlLcidToLocaleName: Buffer too small\n");
        return STATUS_BUFFER_TOO_SMALL;
    }
 
    return STATUS_SUCCESS;
}

RtlLocaleNameToLcid()

NTSTATUS NTAPI RtlLocaleNameToLcid	(	_In_ PCWSTR	LocaleName,
		_Out_ PLCID	Lcid,
		_In_ ULONG	Flags
	)

Definition at line 841 of file locale.c.

{
    UNICODE_STRING LocaleNameString;
 
    /* Convert the string to a UNICODE_STRING */
    RtlInitUnicodeString(&LocaleNameString, LocaleName);
 
    /* Forward to internal function */
    return RtlpLocaleNameToLcidInternal(&LocaleNameString, Lcid, Flags);
}

RtlpInitializeLocaleTable()

NTSTATUS NTAPI RtlpInitializeLocaleTable

(

VOID

)

Initializes the locale index table, that maps the LCIDs to their indexes in the alphabetical table, and is sorted by LCID.

Definition at line 515 of file locale.c.

{
    NtQueryDefaultLocale(TRUE, &RtlpUserDefaultLcid);
    NtQueryDefaultLocale(FALSE, &RtlpSystemDefaultLcid);
 
    for (USHORT i = 0; i < ARRAYSIZE(RtlpLocaleTable); i++)
    {
        LCID Lcid = RtlpLocaleTable[i].Lcid;
        USHORT j = i;
 
        while ((j > 0) && (RtlpLocaleTable[RtlpLocaleIndexTable[j - 1]].Lcid > Lcid))
        {
            RtlpLocaleIndexTable[j] = RtlpLocaleIndexTable[j - 1];
            j--;
        }
 
        RtlpLocaleIndexTable[j] = i;
    }
 
    return STATUS_SUCCESS;
}

Referenced by DllMain(), LdrpInitializeProcess(), and Phase1InitializationDiscard().

RtlpLocaleNameToLcidInternal()

static _Must_inspect_result_ NTSTATUS RtlpLocaleNameToLcidInternal ( _In_ PCUNICODE_STRING  LocaleName, _Out_ PLCID  Lcid, _In_ ULONG  Flags  )

static

Definition at line 781 of file locale.c.

{
    ULONG LocaleIndex;
    LCID FoundLcid;
 
    /* Check if LocaleName points to a valid unicode string */
    if ((LocaleName == NULL) || (LocaleName->Buffer == NULL))
    {
        DPRINT1("RtlpLocaleNameToLcidInternal: Invalid buffer\n");
        return STATUS_INVALID_PARAMETER_1;
    }
 
    /* Check if the Lcid pointer is valid */
    if (Lcid == NULL)
    {
        DPRINT1("RtlpLocaleNameToLcidInternal: Lcid is NULL\n");
        return STATUS_INVALID_PARAMETER_2;
    }
 
    /* Check for invalid flags */
    if (Flags & ~0x3)
    {
        DPRINT1("RtlpLocaleNameToLcidInternal: Invalid flags: 0x%lx\n", Flags);
        return STATUS_INVALID_PARAMETER_3;
    }
 
    /* Try to find the locale */
    LocaleIndex = FindIndexByLocaleName(LocaleName);
    if (LocaleIndex == MAXULONG)
    {
        DPRINT("RtlpLocaleNameToLcidInternal: Locale name not found\n");
        return STATUS_INVALID_PARAMETER_1;
    }
 
    /* Extract the LCID without the flags */
    FoundLcid = RtlpLocaleTable[LocaleIndex].Lcid & NLS_VALID_LOCALE_MASK;
 
    /* Check if neutral locales were requested */
    if ((Flags & RTL_LOCALE_ALLOW_NEUTRAL_NAMES) == 0)
    {
        /* Check if this is a neutral locale */
        if (IsNeutralLocale(FoundLcid))
        {
            DPRINT("RtlpLocaleNameToLcidInternal: Neutral LCID: 0x%lx\n", FoundLcid);
            return STATUS_INVALID_PARAMETER_1;
        }
    }
 
    /* Copy the LCID to the output buffer */
    *Lcid = FoundLcid;
 
    return STATUS_SUCCESS;
}

Referenced by RtlLocaleNameToLcid().

Variable Documentation

RtlpLocaleIndexTable

USHORT RtlpLocaleIndexTable[_ARRAYSIZE(RtlpLocaleTable)]

static

Definition at line 506 of file locale.c.

Referenced by FindIndexByLcid(), and RtlpInitializeLocaleTable().

RtlpLocaleTable

const LOCALE_ENTRY RtlpLocaleTable[]

static

Definition at line 34 of file locale.c.

Referenced by FindIndexByLcid(), FindIndexByLocaleName(), RtlLcidToLocaleName(), RtlpInitializeLocaleTable(), and RtlpLocaleNameToLcidInternal().

RtlpSystemDefaultLcid

LCID RtlpSystemDefaultLcid

Definition at line 24 of file locale.c.

Referenced by RtlLcidToLocaleName(), and RtlpInitializeLocaleTable().

RtlpUserDefaultLcid

LCID RtlpUserDefaultLcid

Definition at line 23 of file locale.c.

Referenced by RtlLcidToLocaleName(), and RtlpInitializeLocaleTable().