CRegFolder.cpp File Reference

#include <precomp.h>

Include dependency graph for CRegFolder.cpp:

Go to the source code of this file.

Classes
struct	CRegFolderInfo
class	CRegFolderEnum
class	CRegFolder

Enumerations
enum	REGFOLDERCOLUMNINDEX { COL_NAME = SHFSF_COL_NAME , COL_TYPE = SHFSF_COL_TYPE , COL_INFOTIP = SHFSF_COL_COMMENT , REGFOLDERCOLUMNCOUNT = max(COL_INFOTIP, COL_TYPE) + 1 }

Functions
	WINE_DEFAULT_DEBUG_CHANNEL (shell)
static HRESULT	CRegItemContextMenu_CreateInstance (PCIDLIST_ABSOLUTE pidlFolder, HWND hwnd, UINT cidl, PCUITEMID_CHILD_ARRAY apidl, IShellFolder *psf, IContextMenu **ppcm)
HRESULT	FormatGUIDKey (LPWSTR KeyName, SIZE_T KeySize, LPCWSTR RegPath, const GUID *riid)
static DWORD	SHELL_QueryCLSIDValue (_In_ REFCLSID clsid, _In_opt_ LPCWSTR SubKey, _In_opt_ LPCWSTR Value, _In_opt_ PVOID pData, _In_opt_ PDWORD pSize)
static bool	HasCLSIDShellFolderValue (REFCLSID clsid, LPCWSTR Value)
static UINT	GetRegItemCLSIDOffset (PIDLTYPE type)
static BYTE	GetRegItemOrder (REFCLSID clsid)
static LPITEMIDLIST	CreateRegItem (PIDLTYPE type, REFCLSID clsid, int order=-1)
static LPITEMIDLIST	CreateRegItem (PIDLTYPE type, LPCWSTR clsidstr)
HRESULT	CGuidItemExtractIcon_CreateInstance (LPCITEMIDLIST pidl, REFIID iid, LPVOID *ppvOut)
static HRESULT CALLBACK	RegFolderContextMenuCallback (IShellFolder *psf, HWND hwnd, IDataObject *pdtobj, UINT uMsg, WPARAM wParam, LPARAM lParam)
HRESULT	CRegFolder_CreateInstance (PREGFOLDERINITDATA pInit, LPCITEMIDLIST pidlRoot, REFIID riid, void **ppv)

Enumeration Type Documentation

REGFOLDERCOLUMNINDEX

enum REGFOLDERCOLUMNINDEX

Enumerator
COL_NAME
COL_TYPE
COL_INFOTIP
REGFOLDERCOLUMNCOUNT

Definition at line 313 of file CRegFolder.cpp.

{
    COL_NAME = SHFSF_COL_NAME,
    COL_TYPE = SHFSF_COL_TYPE,
    COL_INFOTIP = SHFSF_COL_COMMENT,
    REGFOLDERCOLUMNCOUNT = max(COL_INFOTIP, COL_TYPE) + 1
};

Function Documentation

CGuidItemExtractIcon_CreateInstance()

HRESULT CGuidItemExtractIcon_CreateInstance	(	LPCITEMIDLIST	pidl,
		REFIID	iid,
		LPVOID *	ppvOut
	)

Definition at line 141 of file CRegFolder.cpp.

{
    CComPtr<IDefaultExtractIconInit>    initIcon;
    HRESULT hr;
    GUID const * riid;
    int icon_idx;
    WCHAR wTemp[MAX_PATH];
 
    hr = SHCreateDefaultExtractIcon(IID_PPV_ARG(IDefaultExtractIconInit,&initIcon));
    if (FAILED(hr))
        return hr;
 
    if (_ILIsDesktop(pidl))
    {
        initIcon->SetNormalIcon(swShell32Name, -IDI_SHELL_DESKTOP);
        return initIcon->QueryInterface(iid, ppvOut);
    }
 
    riid = _ILGetGUIDPointer(pidl);
    if (!riid)
        return E_FAIL;
 
    /* Choose a correct icon for Recycle Bin (full or empty) */
    const WCHAR* iconname = NULL;
    if (_ILIsBitBucket(pidl))
    {
        CComPtr<IEnumIDList> EnumIDList;
        CoInitialize(NULL);
 
        CComPtr<IShellFolder2> psfRecycleBin;
        CComPtr<IShellFolder> psfDesktop;
        hr = SHGetDesktopFolder(&psfDesktop);
 
        if (SUCCEEDED(hr))
            hr = psfDesktop->BindToObject(pidl, NULL, IID_PPV_ARG(IShellFolder2, &psfRecycleBin));
        if (SUCCEEDED(hr))
            hr = psfRecycleBin->EnumObjects(NULL, SHCONTF_FOLDERS | SHCONTF_NONFOLDERS, &EnumIDList);
 
        ULONG itemcount;
        LPITEMIDLIST pidl = NULL;
        if (SUCCEEDED(hr) && (hr = EnumIDList->Next(1, &pidl, &itemcount)) == S_OK)
        {
            CoTaskMemFree(pidl);
            iconname = L"Full";
        } else {
            iconname = L"Empty";
        }
    }
 
    /* Prepare registry path for loading icons of My Computer and other shell extensions */
    WCHAR KeyName[MAX_PATH];
 
    hr = FormatGUIDKey(KeyName, _countof(KeyName),
                       L"SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Explorer\\CLSID\\%s",
                       riid);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    /* Load icon for the current user */
    BOOL ret = HCU_GetIconW(KeyName, wTemp, iconname, _countof(wTemp), &icon_idx);
    if (!ret)
    {
        /* Failed, load default system-wide icon */
        hr = FormatGUIDKey(KeyName, _countof(KeyName), L"CLSID\\%s", riid);
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
 
        ret = HCR_GetIconW(KeyName, wTemp, iconname, _countof(wTemp), &icon_idx);
    }
 
    if (ret)
    {
        /* Success, set loaded icon */
        initIcon->SetNormalIcon(wTemp, icon_idx);
    }
    else
    {
        /* Everything has failed, set blank paper icon */
        WARN("Failed to load an icon for the item, setting blank icon\n");
        initIcon->SetNormalIcon(swShell32Name, IDI_SHELL_DOCUMENT - 1);
    }
 
    return initIcon->QueryInterface(iid, ppvOut);
}

Referenced by CRegFolder::GetUIObjectOf().

CreateRegItem() [1/2]

static LPITEMIDLIST CreateRegItem ( PIDLTYPE  type, LPCWSTR  clsidstr  )

static

Definition at line 90 of file CRegFolder.cpp.

{
    CLSID clsid;
    return SUCCEEDED(CLSIDFromString(clsidstr, &clsid)) ? CreateRegItem(type, clsid) : NULL;
}

CreateRegItem() [2/2]

static LPITEMIDLIST CreateRegItem ( PIDLTYPE  type, REFCLSID  clsid, int  order = -1  )

static

Definition at line 70 of file CRegFolder.cpp.

{
#if 1 // FIXME: CControlPanelFolder is not ready for this yet
    if (type == PT_CONTROLS_NEWREGITEM)
        type = PT_CONTROLS_OLDREGITEM;
#endif
    const UINT offset = GetRegItemCLSIDOffset(type);
    const UINT cb = offset + sizeof(CLSID), cbTotal = cb + sizeof(WORD);
    LPITEMIDLIST pidl = (LPITEMIDLIST)SHAlloc(cbTotal);
    if (pidl)
    {
        ZeroMemory(pidl, cbTotal); // Note: This also initializes the terminator WORD
        pidl->mkid.cb = cb;
        pidl->mkid.abID[0] = type;
        pidl->mkid.abID[1] = order >= 0 ? (BYTE)order : GetRegItemOrder(clsid);
        *(CLSID*)(SIZE_T(pidl) + offset) = clsid;
    }
    return pidl;
}

Referenced by CRegFolderEnum::AddItemsFromKey(), CRegFolderInfo::CreateItem(), CreateRegItem(), and CRegFolder::ParseDisplayName().

CRegFolder_CreateInstance()

HRESULT CRegFolder_CreateInstance	(	PREGFOLDERINITDATA	pInit,
		LPCITEMIDLIST	pidlRoot,
		REFIID	riid,
		void **	ppv
	)

Definition at line 1002 of file CRegFolder.cpp.

{
    return ShellObjectCreatorInit<CRegFolder>(pInit, pidlRoot, riid, ppv);
}

Referenced by CDesktopFolder::FinalConstruct(), CDrivesFolder::FinalConstruct(), and CControlPanelFolder::Initialize().

CRegItemContextMenu_CreateInstance()

static HRESULT CRegItemContextMenu_CreateInstance ( PCIDLIST_ABSOLUTE  pidlFolder, HWND  hwnd, UINT  cidl, PCUITEMID_CHILD_ARRAY  apidl, IShellFolder *  psf, IContextMenu **  ppcm  )

static

Definition at line 972 of file CRegFolder.cpp.

{
    HKEY hKeys[3];
    UINT cKeys = 0;
 
    const GUID *pGuid = _ILGetGUIDPointer(apidl[0]);
    if (pGuid)
    {
        WCHAR key[sizeof("CLSID\\") + 38];
        wcscpy(key, L"CLSID\\");
        StringFromGUID2(*pGuid, &key[6], 39);
        AddClassKeyToArray(key, hKeys, &cKeys);
    }
 
    // FIXME: CRegFolder should be aggregated by its outer folder and should
    // provide the attributes for all required non-registry folders.
    // It currently does not so we have to ask the outer folder ourself so
    // that we get the correct attributes for My Computer etc.
    CComPtr<IShellFolder> pOuterSF;
    SHBindToObject(NULL, pidlFolder, IID_PPV_ARG(IShellFolder, &pOuterSF));
 
    SFGAOF att = (psf && cidl) ? SHGetAttributes(pOuterSF ? pOuterSF.p : psf, apidl[0], SFGAO_FOLDER) : 0;
    if ((att & SFGAO_FOLDER) && (!pGuid || !HasCLSIDShellFolderValue(*pGuid, L"HideFolderVerbs")))
        AddClassKeyToArray(L"Folder", hKeys, &cKeys);
 
    return CDefFolderMenu_Create2(pidlFolder, hwnd, cidl, apidl, psf, RegFolderContextMenuCallback, cKeys, hKeys, ppcm);
}

Referenced by CRegFolder::GetUIObjectOf().

FormatGUIDKey()

HRESULT FormatGUIDKey	(	LPWSTR	KeyName,
		SIZE_T	KeySize,
		LPCWSTR	RegPath,
		const GUID *	riid
	)

Definition at line 31 of file CRegFolder.cpp.

{
    WCHAR xriid[CHARS_IN_GUID];
    StringFromGUID2(*riid, xriid, _countof(xriid));
    return StringCchPrintfW(KeyName, KeySize, RegPath, xriid);
}

Referenced by CGuidItemExtractIcon_CreateInstance(), and CRegFolder::SetNameOf().

GetRegItemCLSIDOffset()

static UINT GetRegItemCLSIDOffset ( PIDLTYPE  type )

inlinestatic

Definition at line 57 of file CRegFolder.cpp.

{
    return type == PT_CONTROLS_NEWREGITEM ? 14 : 4;
}

Referenced by CreateRegItem(), CRegFolderInfo::GetCLSIDOffset(), and CRegFolderInfo::IsRegItem().

GetRegItemOrder()

static BYTE GetRegItemOrder ( REFCLSID  clsid )

static

Definition at line 62 of file CRegFolder.cpp.

{
    DWORD dwOrder, cb = sizeof(dwOrder);
    if (SHELL_QueryCLSIDValue(clsid, NULL, L"SortOrderIndex", &dwOrder, &cb) || cb != sizeof(dwOrder))
        dwOrder = REGITEMORDER_DEFAULT;
    return (BYTE)dwOrder;
}

Referenced by CreateRegItem().

HasCLSIDShellFolderValue()

static bool HasCLSIDShellFolderValue ( REFCLSID  clsid, LPCWSTR  Value  )

static

Definition at line 52 of file CRegFolder.cpp.

{
    return SHELL_QueryCLSIDValue(clsid, L"ShellFolder", Value, NULL, NULL) == ERROR_SUCCESS;
}

Referenced by CRegItemContextMenu_CreateInstance().

RegFolderContextMenuCallback()

static HRESULT CALLBACK RegFolderContextMenuCallback ( IShellFolder *  psf, HWND  hwnd, IDataObject *  pdtobj, UINT  uMsg, WPARAM  wParam, LPARAM  lParam  )

static

Definition at line 922 of file CRegFolder.cpp.

{
    if (uMsg != DFM_INVOKECOMMAND || wParam != DFM_CMD_PROPERTIES)
        return SHELL32_DefaultContextMenuCallBack(psf, pdtobj, uMsg);
 
    PIDLIST_ABSOLUTE pidlFolder;
    PUITEMID_CHILD *apidl;
    UINT cidl;
    HRESULT hr = SH_GetApidlFromDataObject(pdtobj, &pidlFolder, &apidl, &cidl);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    const CLSID* pCLSID;
    CRegFolder *pRegFolder = static_cast<CRegFolder*>(psf);
    const REQUIREDREGITEM* pRequired = pRegFolder->IsRequiredItem(apidl[0]);
    if (pRequired && pRequired->pszCpl)
    {
        WCHAR buf[MAX_PATH];
        wsprintfW(buf, L"%hs", const_cast<LPCSTR>(pRequired->pszCpl));
        hr = SHELL_ExecuteControlPanelCPL(hwnd, buf) ? S_OK : E_FAIL;
    }
#if 0 // Should never happen, CDesktopFolder.cpp handles this
    else if (_ILIsDesktop(pidlFolder) && _ILIsDesktop(apidl[0]))
    {
        hr = SHELL_ExecuteControlPanelCPL(hwnd, L"desk.cpl") ? S_OK : E_FAIL;
    }
#endif
    else if ((pCLSID = pRegFolder->IsRegItem(apidl[0])) != NULL)
    {
        if (CLSID_MyDocuments != *pCLSID)
        {
            hr = SHELL32_ShowShellExtensionProperties(pCLSID, pdtobj);
        }
        else
        {
            FIXME("ROS MyDocs must implement IShellPropSheetExt\n");
            hr = S_FALSE; // Just display the filesystem properties
        }
    }
    else
    {
        hr = S_FALSE; // Tell the caller to run the default action
    }
 
    SHFree(pidlFolder);
    _ILFreeaPidl(apidl, cidl);
    return hr;
}

Referenced by CRegItemContextMenu_CreateInstance().

SHELL_QueryCLSIDValue()

static DWORD SHELL_QueryCLSIDValue ( _In_ REFCLSID  clsid, _In_opt_ LPCWSTR  SubKey, _In_opt_ LPCWSTR  Value, _In_opt_ PVOID  pData, _In_opt_ PDWORD  pSize  )

static

Definition at line 38 of file CRegFolder.cpp.

{
    const UINT cchGuid = CHARS_IN_GUID - 1, cchClsidSlash = sizeof("CLSID\\") - 1;
    WCHAR Path[200];
    wcscpy(Path, L"CLSID\\");
    StringFromGUID2(clsid, Path + 6, CHARS_IN_GUID);
    if (SubKey)
    {
        *(Path + cchClsidSlash + cchGuid) = L'\\';
        wcscpy(Path + cchClsidSlash + cchGuid + 1, SubKey);
    }
    return RegGetValueW(HKEY_CLASSES_ROOT, Path, Value, RRF_RT_ANY, NULL, pData, pSize);
}

Referenced by GetRegItemOrder(), and HasCLSIDShellFolderValue().

WINE_DEFAULT_DEBUG_CHANNEL()

WINE_DEFAULT_DEBUG_CHANNEL

(

shell

)