SysImgList.cpp

Go to the documentation of this file.

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Project: uLib - User mode library.
// Module: Access the system image lists (the hard-core way).
// Author: Copyright (c) Love Nystrom
// License: NNOSL (BSD descendant, see NNOSL.txt in the base directory).
//
// [Ref] http://www.catch22.net/tuts/system-image-list
//
// NOTE: Direct use of ImageList_Draw results in superior speed,
// far outperforming both ImageList_GetIcon/DrawIconEx and IImageList::Draw.
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#include <uLib/SysImgList.h>

HIMAGELIST SysImgList::hSmall = NULL;
HIMAGELIST SysImgList::hLarge = NULL;

HMODULE SysImgList::_hShell32 = NULL;

BOOL (WINAPI *SysImgList::Shell_GetImageLists)( HIMAGELIST* pimlLarge, HIMAGELIST* pimSmall )
    = NULL; // @71

BOOL (WINAPI *SysImgList::FileIconInit)( BOOL bFullInit )
    = NULL; // @660

SysImgList::SysImgList()
{
    memset( &Info, 0, sizeof(Info) );

    if (!_hShell32) _hShell32 = LoadLibrary( _T("Shell32.dll") );
    // Note: Do not unload Shell32, or the lists will be /gone/.
    if (_hShell32)
    {
        if (!Shell_GetImageLists)
            (FARPROC&) Shell_GetImageLists = GetProcAddress( _hShell32, (LPCSTR)71 );

        if (!FileIconInit)
            (FARPROC&) FileIconInit = GetProcAddress( _hShell32, (LPCSTR)660 );
    }
    if (!(hSmall && hLarge))
    {
        // I've been told that calling FileIconInit(true) causes the image lists to be
        // fully populated for this process whereas SHGetFileInfo gets a "holey" list.
        // However, empirical tests on Win7 indicate the lists are identical.

        if (FileIconInit) FileIconInit( true );
        if (Shell_GetImageLists) Shell_GetImageLists( &hLarge, &hSmall );

        // Note: Shell_GetImageLists is flagged as potentially retiring.
        // If that comes to be (God forbid), a kludge alternate is:
        // CSTR Omni = _T("C:\\"); // Omnipresent?
        // SHFILEINFO sfi = {0};
        // UINT Flg = SHGFI_SYSICONINDEX;
        // hLarge = (HIMAGELIST) SHGetFileInfo( Omni, 0, &sfi, sizeof(sfi), Flg );
        // Flg |= SHGFI_SMALLICON;
        // hSmall = (HIMAGELIST) SHGetFileInfo( Omni, 0, &sfi, sizeof(sfi), Flg );
    }
}

UINT SysImgList::Count()
{
    // Both lists appear to have the same nr of images.
    return ImageList_GetImageCount( hSmall );
}

HICON SysImgList::GetSmallIcon( UINT Ix )
{
    return ImageList_GetIcon( hSmall, Ix, ILD_NORMAL ); // ILD_TRANSPARENT
}

HICON SysImgList::GetLargeIcon( UINT Ix )
{
    return ImageList_GetIcon( hLarge, Ix, ILD_NORMAL ); // ILD_TRANSPARENT
}

int SysImgList::GetFiletypeIconIndex( CSTR dotExt, bool Small )
{
    int Ix, Flg = SHGFI_SYSICONINDEX| SHGFI_USEFILEATTRIBUTES;
    if (Small) Flg |= SHGFI_SMALLICON;

    // SHGetFileInfo returns the imagelist handle. However, we already have
    // both of those, so we'll just use it as a boolean success indicator.

    HIMAGELIST hIml = (HIMAGELIST)
        SHGetFileInfo( dotExt, FILE_ATTRIBUTE_NORMAL, &Info, sizeof(Info), Flg );
    if (hIml) Ix = Info.iIcon;
    else Ix = I_NOIMAGE;
    return Ix;
}

int SysImgList::GetFileIconIndex( CSTR FName, bool Small )
{
    int Ix, Flg = SHGFI_SYSICONINDEX;
    HIMAGELIST hIml = (HIMAGELIST)
        SHGetFileInfo( FName, FILE_ATTRIBUTE_NORMAL, &Info, sizeof(Info), Flg );
    if (hIml) Ix = Info.iIcon;
    else Ix = I_NOIMAGE;
    return Ix;
}

bool SysImgList::ReplaceIcon( UINT Ix, HINSTANCE hInst, CSTR Id )
{
    HICON hIco = LoadIcon( hInst, Id );
    if (hIco) ImageList_ReplaceIcon( hLarge, Ix, hIco );
    hIco = LoadSmallIcon( hInst, Id );
    if (hIco) ImageList_ReplaceIcon( hSmall, Ix, hIco );
    return (hIco != NULL);
}

#if !SYSIMG_USE_COMIFACE
// FIXME: Adding icons directly seems to clash with Shell's internal ops.
// It appears the sysimg list uses an internal count separate from that
// of the HIMAGELIST itself. (If so, an unwise design.)

int SysImgList::AddIcon( HINSTANCE hInst, CSTR Id )
{
    int ix = ImageList_AddIcon( hLarge, LoadIcon( hInstance, Id ));
    ix = ImageList_AddIcon( hSmall, LoadSmallIcon( hInstance, Id ));
    return ix;
}

#else // Use IImageList (seems to comply w sysimg list internals).

int SysImgList::AddIcon( HINSTANCE hInst, CSTR Id )
{
    IImageList* pIml;
    int imgIx = -1;

    // Using IImageList seems to be the only reliable way of adding icons.
    // So forego the hard-core and use IImagelist to add the resource icon
    // to both our small and large image lists.

    bool inited = ShellFuncInitialized();
    if (!inited) InitShellFunc();

    if (SUCCEEDED( SHGetImageList( SHIL_LARGE, IID_IImageList, (void**)&pIml )))
    {
        pIml->ReplaceIcon( -1, LoadIcon( hInst, Id ), &imgIx );
        pIml->Release();
     }
    if (SUCCEEDED( SHGetImageList( SHIL_SMALL, IID_IImageList, (void**)&pIml )))
    {
        pIml->ReplaceIcon( -1, LoadSmallIcon( hInst, Id ), &imgIx );
        pIml->Release();
    }

    if (!inited) DoneShellFunc();
    return imgIx;
}
#endif

// EOF