PrivateExtractIcons.c File Reference

#include "precomp.h"
#include <stdio.h>
#include <versionhelpers.h>

Include dependency graph for PrivateExtractIcons.c:

Go to the source code of this file.

Classes
struct	tagPAIRSTESTS

Functions
BOOL	IsValidIcon (HICON hIco)
BOOL	FileExists (PCWSTR FileName)
BOOL	ResourceToFile (INT i, PCWSTR FileName)
void	TestPairExtraction (void)
	START_TEST (PrivateExtractIcons)

Variables
struct {
PCWSTR   FilePath
UINT   cIcons
UINT   cTotalIcons
BOOL   bhIconValid
}	IconTests []
struct {
PCWSTR   FileName
INT   ResourceId
}	IconFiles []
static const struct tagPAIRSTESTS	g_pairs []

Function Documentation

FileExists()

BOOL FileExists

(

PCWSTR

FileName

)

Definition at line 26 of file PrivateExtractIcons.c.

{
    DWORD Attribute = GetFileAttributesW(FileName);
 
    return (Attribute != INVALID_FILE_ATTRIBUTES &&
            !(Attribute & FILE_ATTRIBUTE_DIRECTORY));
}

Referenced by ResourceToFile().

IsValidIcon()

BOOL IsValidIcon

(

HICON

hIco

)

Definition at line 13 of file PrivateExtractIcons.c.

{
    ICONINFO info = { 0 };
 
    if (!hIco || !GetIconInfo(hIco, &info))
        return FALSE;
 
    DeleteObject(info.hbmMask);
    if (info.hbmColor)
        DeleteObject(info.hbmColor);
    return TRUE;
}

Referenced by TestPairExtraction().

ResourceToFile()

BOOL ResourceToFile	(	INT	i,
		PCWSTR	FileName
	)

Definition at line 34 of file PrivateExtractIcons.c.

{
    FILE *fout;
    HGLOBAL hData;
    HRSRC hRes;
    PVOID pResLock;
    UINT iSize;
 
    if (FileExists(FileName))
    {
        /* We should only be using %temp% paths, so deleting here should be OK */
        printf("Deleting '%S' that already exists.\n", FileName);
        DeleteFileW(FileName);
    }
 
    hRes = FindResourceW(NULL, MAKEINTRESOURCEW(i), MAKEINTRESOURCEW(RT_RCDATA));
    if (hRes == NULL)
    {
        skip("Could not locate resource (%d). Exiting now\n", i);
        return FALSE;
    }
 
    iSize = SizeofResource(NULL, hRes);
 
    hData = LoadResource(NULL, hRes);
    if (hData == NULL)
    {
        skip("Could not load resource (%d). Exiting now\n", i);
        return FALSE;
    }
 
    // Lock the resource into global memory.
    pResLock = LockResource(hData);
    if (pResLock == NULL)
    {
        skip("Could not lock resource (%d). Exiting now\n", i);
        return FALSE;
    }
 
    fout = _wfopen(FileName, L"wb");
    fwrite(pResLock, iSize, 1, fout);
    fclose(fout);
    return TRUE;
}

Referenced by START_TEST().

START_TEST()

START_TEST

(

PrivateExtractIcons

)

Definition at line 129 of file PrivateExtractIcons.c.

{
    HICON ahIcon;
    UINT i, aIconId, cIcons, cIcoTotal;
    WCHAR PathBuffer[MAX_PATH];
    UINT Shell32WinIcoCount = IsWindowsVistaOrGreater() ? 326 : 239; /* 239 on W2K3SP2, 326 on Win10 */
 
    /* Extract icons */
    for (i = 0; i < _countof(IconFiles); ++i)
    {
        ExpandEnvironmentStringsW(IconFiles[i].FileName, PathBuffer, _countof(PathBuffer));
 
        if (!ResourceToFile(IconFiles[i].ResourceId, PathBuffer))
            goto Cleanup;
    }
 
    TestPairExtraction();
 
    for (i = 0; i < _countof(IconTests); ++i)
    {
        /* Get total number of icon groups in file.
         * None of the hard numbers in the function matter since we have
         * two NULLs for the Icon Handle and Count to be set. */
        cIcoTotal = PrivateExtractIconsW(IconTests[i].FilePath, 0, 16, 16, NULL, NULL, 0, 0);
        ok((i == 3 ?
              cIcoTotal > 232 && cIcoTotal <= Shell32WinIcoCount :  /* shell32 case: ROS has 233, Windows has >= 239 icon groups. */
              cIcoTotal == IconTests[i].cTotalIcons),
           "PrivateExtractIconsW(%u): "
           "got %u, expected %u\n", i, cIcoTotal, IconTests[i].cTotalIcons);
 
        /* Always test extraction of the FIRST icon (index 0) */
        ahIcon = (HICON)UlongToHandle(0xdeadbeef);
        aIconId = 0xdeadbeef;
        cIcons = PrivateExtractIconsW(IconTests[i].FilePath, 0, 16, 16, &ahIcon, &aIconId, 1, 0);
        ok(cIcons == IconTests[i].cIcons, "PrivateExtractIconsW(%u): got %u, expected %u\n", i, cIcons, IconTests[i].cIcons);
        ok(ahIcon != (HICON)UlongToHandle(0xdeadbeef), "PrivateExtractIconsW(%u): icon not set\n", i);
        ok((IconTests[i].bhIconValid && ahIcon) || (!IconTests[i].bhIconValid && !ahIcon),
            "PrivateExtractIconsW(%u): icon expected to be %s, but got 0x%p\n",
            i, IconTests[i].bhIconValid ? "valid" : "not valid", ahIcon);
        if (cIcons == 0xFFFFFFFF)
        {
            ok(aIconId == 0xdeadbeef,
               "PrivateExtractIconsW(%u): id should not be set to 0x%x\n",
               i, aIconId);
        }
        else
        {
            ok(aIconId != 0xdeadbeef, "PrivateExtractIconsW(%u): id not set\n", i);
        }
        if (ahIcon && ahIcon != (HICON)UlongToHandle(0xdeadbeef))
            DestroyIcon(ahIcon);
    }
 
Cleanup:
    for (i = 0; i < _countof(IconFiles); ++i)
    {
        ExpandEnvironmentStringsW(IconFiles[i].FileName, PathBuffer, _countof(PathBuffer));
        DeleteFileW(PathBuffer);
    }
}

TestPairExtraction()

void TestPairExtraction

(

void

)

Definition at line 223 of file PrivateExtractIcons.c.

{
    const HICON hInvalidIcon = (HICON)(INT_PTR)-2;
    const BOOL IsNT6 = IsWindowsVistaOrGreater();
    for (UINT i = 0; i < _countof(g_pairs); ++i)
    {
        UINT j, Count, ExpectedCount;
        int RetVal, ExpectedRet;
        UINT IcoSize = MAKELONG(32, g_pairs[i].UseHigh ? 16 : 0);
        PCWSTR pszPath = g_pairs[i].Library ? L"%SystemRoot%\\system32\\shell32.dll" : L"%temp%\\sysicon.ico";
        HICON hIcons[8];
        for (j = 0; j < _countof(hIcons); ++j)
            hIcons[j] = hInvalidIcon;
 
        RetVal = PrivateExtractIconsW(pszPath, 0, IcoSize, IcoSize, hIcons, NULL, g_pairs[i].InCount, 0);
        for (j = 0, Count = 0; j < _countof(hIcons); ++j)
        {
            if (hIcons[j] != hInvalidIcon && IsValidIcon(hIcons[j]))
            {
                DestroyIcon(hIcons[j]);
                ++Count;
            }
        }
 
        ExpectedRet = !IsNT6 ? g_pairs[i].ReturnNT5 : g_pairs[i].ReturnNT6;
        ExpectedCount = !IsNT6 ? g_pairs[i].CountNT5 : g_pairs[i].CountNT6;
        ok(RetVal == ExpectedRet, "Test %u: RetVal must be %d but got %d\n", i, ExpectedRet, RetVal);
        ok(Count == ExpectedCount, "Test %u: Count must be %u but got %u\n", i, ExpectedCount, Count);
    }
}

Referenced by START_TEST().

Variable Documentation

bhIconValid

BOOL bhIconValid

Definition at line 84 of file PrivateExtractIcons.c.

Referenced by START_TEST().

cIcons

UINT cIcons

Definition at line 82 of file PrivateExtractIcons.c.

Referenced by START_TEST(), and test_PrivateExtractIcons().

cTotalIcons

UINT cTotalIcons

Definition at line 83 of file PrivateExtractIcons.c.

FileName

PCWSTR FileName

Definition at line 118 of file PrivateExtractIcons.c.

FilePath

PCWSTR FilePath

Definition at line 81 of file PrivateExtractIcons.c.

Referenced by AddBackslash(), BcdOpenStoreFromFile(), BiAddStoreFromFile(), BiLoadHive(), ChangeACLsOfFiles(), ChangeFileACL(), CmpAddDriverToList(), CmpAddToHiveFileList(), CmpCmdHiveOpen(), DosCreateFile(), DosCreateFileEx(), DosOpenFile(), EfiInitpConvertEfiFilePath(), EfiInitpCreateApplicationEntry(), EtfsOpen(), FileIoCopyFileName(), FileIoCopyParentDirectoryPath(), filesys_GetFile(), FileTableCompareWithSameAttributes(), FileTableCompareWithSubsetAttributes(), GetPathOfFile(), load_class(), load_progid(), LoadAndBootWindows(), LoadReactOSSetup(), PeLdrLoadBootImage(), PeLdrLoadImage(), PeLdrLoadImageEx(), PrintDaclsOfFiles(), PrintFileDacl(), ReadBootCodeFromFile(), RxCreateVNetRoot(), START_TEST(), StoreNameInSft(), StrDupShortenPath(), WinLdrAddDriverToList(), and WinLdrLoadDeviceDriver().

g_pairs

const struct tagPAIRSTESTS g_pairs[]

static

Initial value:

=
{
    { 0, 0, 0,     1, 1, 1, 1 },
    { 0, 0, 1,     0, 0, 0, 0 },
    { 0, 1, 0,     1, 2, 1, 2 },
    { 0, 1, 1,     0, 0, 0, 0 },
    { 1, 0, 0,     1, 1, 1, 1 },
    { 1, 0, 1,     1, 1, 1, 1 },
    { 1, 1, 0,     1, 2, 1, 2 },
    { 1, 1, 1,     2, 2, 0, 0 },
    { 2, 0, 0,     1, 1, 1, 1 },
    { 2, 0, 1,     2, 2, 2, 2 },
    { 2, 1, 0,     1, 2, 1, 2 },
    { 2, 1, 1,     2, 2, 2, 2 }, 
    { 3, 0, 0,     1, 1, 1, 1 },
    { 3, 0, 1,     3, 3, 3, 3 },
    { 3, 1, 0,     1, 2, 1, 2 },
    { 3, 1, 1,     4, 4, 0, 0 },
    { 4, 0, 0,     1, 1, 1, 1 },
    { 4, 0, 1,     4, 4, 4, 4 },
    { 4, 1, 0,     1, 2, 1, 2 },
    { 4, 1, 1,     4, 4, 4, 4 }
}

Referenced by TestPairExtraction().

struct { ... } IconFiles[]

Initial value:

=
{
    {L"%temp%\\ROS.ico", IDR_ICONS_PNG},
    {L"%temp%\\sysicon.ico", IDR_ICONS_NORMAL},
    {L"%temp%\\cpimg2e.exe", IDR_EXE_NORMAL}
}

Referenced by START_TEST().

struct { ... } IconTests[]

Initial value:

=
{
    
    {L"notepad.exe", 1, 1, TRUE},
    {L"%SystemRoot%\\System32\\cmd.exe", 1, 1, TRUE},
 
    
    {L"%SystemRoot%\\System32\\autochk.exe", 0, 0, FALSE},
 
    
    {L"%SystemRoot%\\System32\\shell32.dll", 1, 233, TRUE},
 
    
    {L"%SystemRoot%\\non-existent-file.sdf", 0xFFFFFFFF, 0, FALSE},
 
    
    {L"%SystemRoot%\\explorer.exe", 1, 18, TRUE},
 
    
    {L"%temp%\\sysicon.ico", 1, 1, TRUE},
 
    
    {L"%temp%\\ROS.ico", 1, 1, TRUE},
 
    
    {L"%temp%\\cpimg2e.exe", 1, 1, TRUE},
}

Referenced by START_TEST().

ResourceId

INT ResourceId

Definition at line 119 of file PrivateExtractIcons.c.

Referenced by START_TEST().