atom.c File Reference

#include <k32.h>
#include <debug.h>

Include dependency graph for atom.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
PVOID WINAPI	InternalInitAtomTable (VOID)
ATOM WINAPI	InternalAddAtom (BOOLEAN Local, BOOLEAN Unicode, LPCSTR AtomName)
ATOM WINAPI	InternalFindAtom (BOOLEAN Local, BOOLEAN Unicode, LPCSTR AtomName)
ATOM WINAPI	InternalDeleteAtom (BOOLEAN Local, ATOM Atom)
UINT WINAPI	InternalGetAtomName (BOOLEAN Local, BOOLEAN Unicode, ATOM Atom, LPSTR AtomName, DWORD Size)
ATOM WINAPI	GlobalAddAtomA (LPCSTR lpString)
ATOM WINAPI	GlobalAddAtomW (LPCWSTR lpString)
ATOM WINAPI	GlobalDeleteAtom (ATOM nAtom)
ATOM WINAPI	GlobalFindAtomA (LPCSTR lpString)
ATOM WINAPI	GlobalFindAtomW (LPCWSTR lpString)
UINT WINAPI	GlobalGetAtomNameA (ATOM nAtom, LPSTR lpBuffer, int nSize)
UINT WINAPI	GlobalGetAtomNameW (ATOM nAtom, LPWSTR lpBuffer, int nSize)
BOOL WINAPI	InitAtomTable (DWORD nSize)
ATOM WINAPI	AddAtomA (LPCSTR lpString)
ATOM WINAPI	AddAtomW (LPCWSTR lpString)
ATOM WINAPI	DeleteAtom (ATOM nAtom)
ATOM WINAPI	FindAtomA (LPCSTR lpString)
ATOM WINAPI	FindAtomW (LPCWSTR lpString)
UINT WINAPI	GetAtomNameA (ATOM nAtom, LPSTR lpBuffer, int nSize)
UINT WINAPI	GetAtomNameW (ATOM nAtom, LPWSTR lpBuffer, int nSize)

Variables
PRTL_ATOM_TABLE	BaseLocalAtomTable = NULL

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 12 of file atom.c.

Function Documentation

AddAtomA()

ATOM WINAPI AddAtomA

(

LPCSTR

lpString

)

Definition at line 526 of file atom.c.

{
    return InternalAddAtom(TRUE, FALSE, lpString);
}

Referenced by test_local_add_atom(), test_local_error_handling(), test_local_get_atom_name(), and WDML_CreateString().

AddAtomW()

ATOM WINAPI AddAtomW

(

LPCWSTR

lpString

)

Definition at line 536 of file atom.c.

{
    return InternalAddAtom(TRUE, TRUE, (LPSTR)lpString);
}

Referenced by test_local_add_atom(), test_local_error_handling(), test_local_get_atom_name(), UXTHEME_SetWindowProperty(), and WDML_CreateString().

DeleteAtom()

ATOM WINAPI DeleteAtom

(

ATOM

nAtom

)

Definition at line 546 of file atom.c.

{
    return InternalDeleteAtom(TRUE, nAtom);
}

Referenced by UXTHEME_SetWindowProperty(), and WDML_DecHSZ().

FindAtomA()

ATOM WINAPI FindAtomA

(

LPCSTR

lpString

)

Definition at line 556 of file atom.c.

{
    return InternalFindAtom(TRUE, FALSE, lpString);
}

Referenced by test_DdeCreateStringHandleW(), test_local_add_atom(), test_local_error_handling(), and test_RegisterClipboardFormatA().

FindAtomW()

ATOM WINAPI FindAtomW

(

LPCWSTR

lpString

)

Definition at line 566 of file atom.c.

{
    return InternalFindAtom(TRUE, TRUE, (LPSTR)lpString);
 
}

Referenced by test_DdeCreateStringHandleW(), test_local_add_atom(), and test_local_error_handling().

GetAtomNameA()

UINT WINAPI GetAtomNameA	(	ATOM	nAtom,
		LPSTR	lpBuffer,
		int	nSize
	)

Definition at line 577 of file atom.c.

{
    return InternalGetAtomName(TRUE, FALSE, nAtom, lpBuffer, (DWORD)nSize);
}

Referenced by test_local_get_atom_name(), test_RegisterClipboardFormatA(), and WDML_QueryString().

GetAtomNameW()

UINT WINAPI GetAtomNameW	(	ATOM	nAtom,
		LPWSTR	lpBuffer,
		int	nSize
	)

Definition at line 589 of file atom.c.

{
    return InternalGetAtomName(TRUE,
                               TRUE,
                               nAtom,
                               (LPSTR)lpBuffer,
                               (DWORD)nSize);
}

Referenced by DdeCmpStringHandles(), DdeCreateDataHandle(), test_local_get_atom_name(), UXTHEME_GetWindowProperty(), WDML_MakeAtomFromHsz(), and WDML_QueryString().

GlobalAddAtomA()

ATOM WINAPI GlobalAddAtomA

(

LPCSTR

lpString

)

Definition at line 434 of file atom.c.

{
    return InternalAddAtom(FALSE, FALSE, lpString);
}

Referenced by test_add_atom(), test_error_handling(), test_get_atom_name(), test_handles(), and test_msg_client().

GlobalAddAtomW()

ATOM WINAPI GlobalAddAtomW

(

LPCWSTR

lpString

)

Definition at line 444 of file atom.c.

{
    return InternalAddAtom(FALSE, TRUE, (LPSTR)lpString);
}

Referenced by Control_DoLaunch(), dde_server_wndprocA(), dde_server_wndprocW(), DllMain(), HotkeyThread(), LresultFromObject(), SetPropW(), START_TEST(), test_add_atom(), test_error_handling(), test_get_atom_name(), THEMING_Initialize(), UXTHEME_InitSystem(), and WDML_MakeAtomFromHsz().

GlobalDeleteAtom()

ATOM WINAPI GlobalDeleteAtom

(

ATOM

nAtom

)

Definition at line 454 of file atom.c.

{
    return InternalDeleteAtom(FALSE, nAtom);
}

Referenced by Control_DoLaunch(), dde_msg_client_wndproc(), dde_server_wndprocA(), dde_server_wndprocW(), DdeConnect(), DdePostAdvise(), DdeReconnect(), DllMain(), HotkeyThread(), ObjectFromLresult(), START_TEST(), test_msg_client(), WDML_ClientProc(), WDML_ClientQueueAdvise(), WDML_ClientQueuePoke(), WDML_ClientQueueRequest(), WDML_ClientQueueUnadvise(), WDML_HandleAdviseReply(), WDML_HandleIncomingData(), WDML_HandlePokeReply(), WDML_HandleRequestReply(), WDML_HandleUnadviseReply(), and WDML_RemoveServer().

GlobalFindAtomA()

ATOM WINAPI GlobalFindAtomA

(

LPCSTR

lpString

)

Definition at line 464 of file atom.c.

{
    return InternalFindAtom(FALSE, FALSE, lpString);
}

Referenced by test_add_atom(), test_DdeCreateStringHandleW(), test_error_handling(), and test_RegisterClipboardFormatA().

GlobalFindAtomW()

ATOM WINAPI GlobalFindAtomW

(

LPCWSTR

lpString

)

Definition at line 474 of file atom.c.

{
    return InternalFindAtom(FALSE, TRUE, (LPSTR)lpString);
}

Referenced by Control_DoLaunch(), GetPropW(), RemovePropW(), START_TEST(), test_add_atom(), test_DdeCreateStringHandleW(), and test_error_handling().

GlobalGetAtomNameA()

UINT WINAPI GlobalGetAtomNameA	(	ATOM	nAtom,
		LPSTR	lpBuffer,
		int	nSize
	)

Definition at line 484 of file atom.c.

{
    return InternalGetAtomName(FALSE, FALSE, nAtom, lpBuffer, (DWORD)nSize);
}

Referenced by dde_msg_client_wndproc(), dde_server_wndproc(), EnumPropsA(), EnumPropsExA(), SPY_GetMsgStuff(), test_get_atom_name(), test_handles(), and test_RegisterClipboardFormatA().

GlobalGetAtomNameW()

UINT WINAPI GlobalGetAtomNameW	(	ATOM	nAtom,
		LPWSTR	lpBuffer,
		int	nSize
	)

Definition at line 496 of file atom.c.

{
    return InternalGetAtomName(FALSE,
                               TRUE,
                               nAtom,
                               (LPSTR)lpBuffer,
                               (DWORD)nSize);
}

Referenced by EnumPropsExW(), EnumPropsW(), ObjectFromLresult(), test_get_atom_name(), and WDML_MakeHszFromAtom().

InitAtomTable()

BOOL WINAPI InitAtomTable

(

DWORD

nSize

)

Definition at line 512 of file atom.c.

{
    /* Normalize size */
    if (nSize < 4 || nSize > 511) nSize = 37;
 
    DPRINT("Here\n");
    return NT_SUCCESS(RtlCreateAtomTable(nSize, &BaseLocalAtomTable));
}

InternalAddAtom()

ATOM WINAPI InternalAddAtom	(	BOOLEAN	Local,
		BOOLEAN	Unicode,
		LPCSTR	AtomName
	)

Definition at line 32 of file atom.c.

{
    NTSTATUS Status;
    ANSI_STRING AnsiString;
    UNICODE_STRING UnicodeString;
    PUNICODE_STRING AtomNameString;
    ATOM Atom = INVALID_ATOM;
 
    /* Check if it's an integer atom */
    if ((ULONG_PTR)AtomName <= 0xFFFF)
    {
        /* Convert the name to an atom */
        Atom = (ATOM)PtrToShort((PVOID)AtomName);
        if (Atom >= MAXINTATOM)
        {
            /* Fail, atom number too large */
            BaseSetLastNTError(STATUS_INVALID_PARAMETER);
            return INVALID_ATOM;
        }
 
        /* Return it */
        return Atom;
    }
    else
    {
        /* Check if this is a unicode atom */
        if (Unicode)
        {
            /* Use a unicode string */
            AtomNameString = &UnicodeString;
            RtlInitUnicodeString(AtomNameString, (LPWSTR)AtomName);
            Status = STATUS_SUCCESS;
        }
        else
        {
            /* Use an ansi string */
            RtlInitAnsiString(&AnsiString, AtomName );
 
            /* Check if we can abuse the TEB */
            if (AnsiString.MaximumLength > 260)
            {
                /* We can't, allocate a new string */
                AtomNameString = &UnicodeString;
                Status = RtlAnsiStringToUnicodeString(AtomNameString,
                                                      &AnsiString,
                                                      TRUE);
            }
            else
            {
                /* We can! Get the TEB String */
                AtomNameString = &NtCurrentTeb()->StaticUnicodeString;
 
                /* Convert it into the TEB */
                Status = RtlAnsiStringToUnicodeString(AtomNameString,
                                                      &AnsiString,
                                                      FALSE);
            }
        }
 
        /* Check for failure */
        if (!NT_SUCCESS(Status))
        {
            BaseSetLastNTError(Status);
            return Atom;
        }
    }
 
    /* Check if we're doing local add */
    if (Local)
    {
        /* Do a local add */
        Status = RtlAddAtomToAtomTable(InternalInitAtomTable(),
                                       AtomNameString->Buffer,
                                       &Atom);
    }
    else
    {
        /* Do a global add */
        Status = NtAddAtom(AtomNameString->Buffer,
                           AtomNameString->Length,
                           &Atom);
    }
 
    /* Check for failure */
    if (!NT_SUCCESS(Status)) BaseSetLastNTError(Status);
 
    /* Check if we were non-static ANSI */
    if (!(Unicode) && (AtomNameString == &UnicodeString))
    {
        /* Free the allocated buffer */
        RtlFreeUnicodeString(AtomNameString);
    }
 
    /* Return the atom */
    return Atom;
}

Referenced by AddAtomA(), AddAtomW(), GlobalAddAtomA(), and GlobalAddAtomW().

InternalDeleteAtom()

ATOM WINAPI InternalDeleteAtom	(	BOOLEAN	Local,
		ATOM	Atom
	)

Definition at line 245 of file atom.c.

{
    NTSTATUS Status;
 
    /* Validate it */
    if (Atom >= MAXINTATOM)
    {
        /* Check if it's a local delete */
        if (Local)
        {
            /* Delete it locally */
            Status = RtlDeleteAtomFromAtomTable(InternalInitAtomTable(), Atom);
        }
        else
        {
            /* Delete it globall */
            Status = NtDeleteAtom(Atom);
        }
 
        /* Check for success */
        if (!NT_SUCCESS(Status))
        {
            /* Fail */
            BaseSetLastNTError(Status);
            return INVALID_ATOM;
        }
    }
 
    /* Return failure */
    return 0;
}

Referenced by DeleteAtom(), and GlobalDeleteAtom().

InternalFindAtom()

ATOM WINAPI InternalFindAtom	(	BOOLEAN	Local,
		BOOLEAN	Unicode,
		LPCSTR	AtomName
	)

Definition at line 133 of file atom.c.

{
    NTSTATUS Status;
    ANSI_STRING AnsiString;
    UNICODE_STRING UnicodeString;
    PUNICODE_STRING AtomNameString;
    ATOM Atom = INVALID_ATOM;
 
    /* Check if it's an integer atom */
    if ((ULONG_PTR)AtomName <= 0xFFFF)
    {
        /* Convert the name to an atom */
        Atom = (ATOM)PtrToShort((PVOID)AtomName);
        if (Atom >= MAXINTATOM)
        {
            /* Fail, atom number too large */
            BaseSetLastNTError(STATUS_INVALID_PARAMETER);
            DPRINT1("Invalid atom\n");
        }
 
        /* Return it */
        return Atom;
    }
    else
    {
        /* Check if this is a unicode atom */
        if (Unicode)
        {
            /* Use a unicode string */
            AtomNameString = &UnicodeString;
            RtlInitUnicodeString(AtomNameString, (LPWSTR)AtomName);
            Status = STATUS_SUCCESS;
        }
        else
        {
            /* Use an ansi string */
            RtlInitAnsiString(&AnsiString, AtomName);
 
            /* Check if we can abuse the TEB */
            if (AnsiString.MaximumLength > 260)
            {
                /* We can't, allocate a new string */
                AtomNameString = &UnicodeString;
                Status = RtlAnsiStringToUnicodeString(AtomNameString,
                                                      &AnsiString,
                                                      TRUE);
            }
            else
            {
                /* We can! Get the TEB String */
                AtomNameString = &NtCurrentTeb()->StaticUnicodeString;
 
                /* Convert it into the TEB */
                Status = RtlAnsiStringToUnicodeString(AtomNameString,
                                                      &AnsiString,
                                                      FALSE);
            }
        }
 
        /* Check for failure */
        if (!NT_SUCCESS(Status))
        {
            DPRINT1("Failed\n");
            BaseSetLastNTError(Status);
            return Atom;
        }
    }
 
    /* Check if we're doing local lookup */
    if (Local)
    {
        /* Do a local lookup */
        Status = RtlLookupAtomInAtomTable(InternalInitAtomTable(),
                                          AtomNameString->Buffer,
                                          &Atom);
    }
    else
    {
        /* Do a global search */
        if (!AtomNameString->Length)
        {
            /* This is illegal in win32 */
            DPRINT1("No name given\n");
            Status = STATUS_OBJECT_NAME_NOT_FOUND;
        }
        else
        {
            /* Call the global function */
            Status = NtFindAtom(AtomNameString->Buffer,
                                AtomNameString->Length,
                                &Atom);
        }
    }
 
    /* Check for failure */
    if (!NT_SUCCESS(Status)) BaseSetLastNTError(Status);
 
    /* Check if we were non-static ANSI */
    if (!(Unicode) && (AtomNameString == &UnicodeString))
    {
        /* Free the allocated buffer */
        RtlFreeUnicodeString(AtomNameString);
    }
 
    /* Return the atom */
    return Atom;
}

Referenced by FindAtomA(), FindAtomW(), GlobalFindAtomA(), and GlobalFindAtomW().

InternalGetAtomName()

UINT WINAPI InternalGetAtomName	(	BOOLEAN	Local,
		BOOLEAN	Unicode,
		ATOM	Atom,
		LPSTR	AtomName,
		DWORD	Size
	)

Definition at line 280 of file atom.c.

{
    NTSTATUS Status;
    DWORD RetVal = 0;
    ANSI_STRING AnsiString;
    UNICODE_STRING UnicodeString;
    PVOID TempBuffer = NULL;
    PWSTR AtomNameString;
    ULONG AtomInfoLength;
    ULONG AtomNameLength;
    PATOM_BASIC_INFORMATION AtomInfo;
 
    /* Normalize the size as not to overflow */
    if (!Unicode && Size > 0x7000) Size = 0x7000;
 
    /* Make sure it's valid too */
    if (!Size)
    {
        BaseSetLastNTError(STATUS_BUFFER_OVERFLOW);
        return 0;
    }
    if (!Atom)
    {
        BaseSetLastNTError(STATUS_INVALID_PARAMETER);
        return 0;
    }
 
    /* Check if this is a global query */
    if (Local)
    {
        /* Set the query length */
        AtomNameLength = Size * sizeof(WCHAR);
 
        /* If it's unicode, just keep the name */
        if (Unicode)
        {
            AtomNameString = (PWSTR)AtomName;
        }
        else
        {
            /* Allocate memory for the ansi buffer */
            TempBuffer = RtlAllocateHeap(RtlGetProcessHeap(),
                                         0,
                                         AtomNameLength);
            AtomNameString = TempBuffer;
        }
 
        /* Query the name */
        Status = RtlQueryAtomInAtomTable(InternalInitAtomTable(),
                                         Atom,
                                         NULL,
                                         NULL,
                                         AtomNameString,
                                         &AtomNameLength);
    }
    else
    {
        /* We're going to do a global query, so allocate a buffer */
        AtomInfoLength = sizeof(ATOM_BASIC_INFORMATION) +
                         (Size * sizeof(WCHAR));
        AtomInfo = TempBuffer = RtlAllocateHeap(RtlGetProcessHeap(),
                                                0,
                                                AtomInfoLength);
 
        if (!AtomInfo)
        {
            BaseSetLastNTError(STATUS_NO_MEMORY);
            return 0;
        }
 
        /* Query the name */
        Status = NtQueryInformationAtom(Atom,
                                        AtomBasicInformation,
                                        AtomInfo,
                                        AtomInfoLength,
                                        &AtomInfoLength);
        if (NT_SUCCESS(Status))
        {
            /* Success. Update the length and get the name */
            AtomNameLength = (ULONG)AtomInfo->NameLength;
            AtomNameString = AtomInfo->Name;
        }
    }
 
    /* Check for global success */
    if (NT_SUCCESS(Status))
    {
        /* Check if it was unicode */
        if (Unicode)
        {
            /* We return the length in chars */
            RetVal = AtomNameLength / sizeof(WCHAR);
 
            /* Copy the memory if this was a global query */
            if (AtomNameString != (PWSTR)AtomName)
            {
                RtlMoveMemory(AtomName, AtomNameString, AtomNameLength);
            }
 
            /* And null-terminate it if the buffer was too large */
            if (RetVal < Size)
            {
                ((PWCHAR)AtomName)[RetVal] = UNICODE_NULL;
            }
        }
        else
        {
            /* First create a unicode string with our data */
            UnicodeString.Buffer = AtomNameString;
            UnicodeString.Length = (USHORT)AtomNameLength;
            UnicodeString.MaximumLength = (USHORT)(UnicodeString.Length +
                                                   sizeof(WCHAR));
 
            /* Now prepare an ansi string for conversion */
            AnsiString.Buffer = AtomName;
            AnsiString.Length = 0;
            AnsiString.MaximumLength = (USHORT)Size;
 
            /* Convert it */
            Status = RtlUnicodeStringToAnsiString(&AnsiString,
                                                  &UnicodeString,
                                                  FALSE);
 
            /* Return the length */
            if (NT_SUCCESS(Status)) RetVal = AnsiString.Length;
        }
    }
 
    /* Free the temporary buffer if we have one */
    if (TempBuffer) RtlFreeHeap(RtlGetProcessHeap(), 0, TempBuffer);
 
    /* Check for failure */
    if (!NT_SUCCESS(Status))
    {
        /* Fail */
        DPRINT("Failed: %lx\n", Status);
        BaseSetLastNTError(Status);
    }
 
    /* Return length */
    return RetVal;
}

Referenced by GetAtomNameA(), GetAtomNameW(), GlobalGetAtomNameA(), and GlobalGetAtomNameW().

InternalInitAtomTable()

PVOID WINAPI InternalInitAtomTable

(

VOID

)

Definition at line 23 of file atom.c.

{
    /* Create or return the local table */
    if (!BaseLocalAtomTable) RtlCreateAtomTable(0, &BaseLocalAtomTable);
    return BaseLocalAtomTable;
}

Referenced by InternalAddAtom(), InternalDeleteAtom(), InternalFindAtom(), and InternalGetAtomName().

Variable Documentation

BaseLocalAtomTable

PRTL_ATOM_TABLE BaseLocalAtomTable = NULL

Definition at line 17 of file atom.c.

Referenced by InitAtomTable(), and InternalInitAtomTable().