CDefaultContextMenu.cpp File Reference

#include "precomp.h"
#include <compat_undoc.h>

Include dependency graph for CDefaultContextMenu.cpp:

Go to the source code of this file.

Classes
struct	_DynamicShellEntry_
struct	_StaticShellEntry_
struct	_StaticInvokeCommandMap_
class	CDefaultContextMenu

Macros
#define	MAX_VERB   260
#define	DCM_FCIDM_SHVIEW_OFFSET   0x7000

Typedefs
typedef struct _DynamicShellEntry_	DynamicShellEntry
typedef struct _DynamicShellEntry_ *	PDynamicShellEntry
typedef struct _StaticShellEntry_	StaticShellEntry
typedef struct _StaticShellEntry_ *	PStaticShellEntry

Functions
	WINE_DEFAULT_DEBUG_CHANNEL (dmenu)
static HRESULT	SHELL_GetRegCLSID (HKEY hKey, LPCWSTR SubKey, LPCWSTR Value, CLSID &clsid)
static BOOL	InsertMenuItemAt (HMENU hMenu, UINT Pos, UINT Flags)
static void	DCMA_DestroyEntry (DCMENTRY &dcme)
void	DCMA_Destroy (HDCMA hDCMA)
UINT	DCMA_InsertMenuItems (_In_ HDCMA hDCMA, _In_ HDCIA hDCIA, _In_opt_ LPCITEMIDLIST pidlFolder, _In_opt_ IDataObject *pDO, _In_opt_ HKEY *pKeys, _In_opt_ UINT nKeys, _In_ QCMINFO *pQCMI, _In_opt_ UINT fCmf, _In_opt_ IUnknown *pUnkSite)
HRESULT	DCMA_InvokeCommand (HDCMA hDCMA, CMINVOKECOMMANDINFO *pICI)
PCSTR	MapFcidmCmdToVerb (_In_ UINT_PTR CmdId)
UINT	MapVerbToDfmCmd (_In_ LPCSTR verba)
static HRESULT	MapVerbToCmdId (PVOID Verb, BOOL IsUnicode, IContextMenu *pCM, UINT idFirst, UINT idLast)
static bool	IsVerbListSeparator (WCHAR Ch)
static int	FindVerbInDefaultVerbList (LPCWSTR List, LPCWSTR Verb)
EXTERN_C HRESULT	SHELL32_EnumDefaultVerbList (LPCWSTR List, UINT Index, LPWSTR Verb, SIZE_T cchMax)
static HRESULT	GetFriendlyVerb (_In_ PCWSTR pszVerb, _Out_ PWSTR pszBuf, _In_ SIZE_T cchMax)
static BOOL	HasClipboardData ()
BOOL WINAPI	_InsertMenuItemW (HMENU hMenu, UINT indexMenu, BOOL fByPosition, UINT wID, UINT fType, LPCWSTR dwTypeData, UINT fState)
HRESULT	SHGetMenuIdFromMenuMsg (UINT uMsg, LPARAM lParam, UINT *CmdId)
static HRESULT	CDefaultContextMenu_CreateInstance (const DEFCONTEXTMENU *pdcm, LPFNDFMCALLBACK lpfn, REFIID riid, void **ppv)
HRESULT WINAPI	SHCreateDefaultContextMenu (const DEFCONTEXTMENU *pdcm, REFIID riid, void **ppv)
HRESULT WINAPI	CDefFolderMenu_Create2 (PCIDLIST_ABSOLUTE pidlFolder, HWND hwnd, UINT cidl, PCUITEMID_CHILD_ARRAY apidl, IShellFolder *psf, LPFNDFMCALLBACK lpfn, UINT nKeys, const HKEY *ahkeyClsKeys, IContextMenu **ppcm)

Variables
static const struct _StaticInvokeCommandMap_	g_StaticInvokeCmdMap []

Macro Definition Documentation

DCM_FCIDM_SHVIEW_OFFSET

#define DCM_FCIDM_SHVIEW_OFFSET   0x7000

Definition at line 155 of file CDefaultContextMenu.cpp.

MAX_VERB

#define MAX_VERB   260

Definition at line 15 of file CDefaultContextMenu.cpp.

Typedef Documentation

DynamicShellEntry

typedef struct _DynamicShellEntry_ DynamicShellEntry

PDynamicShellEntry

typedef struct _DynamicShellEntry_ * PDynamicShellEntry

PStaticShellEntry

typedef struct _StaticShellEntry_ * PStaticShellEntry

StaticShellEntry

typedef struct _StaticShellEntry_ StaticShellEntry

Function Documentation

_InsertMenuItemW()

BOOL WINAPI _InsertMenuItemW	(	HMENU	hMenu,
		UINT	indexMenu,
		BOOL	fByPosition,
		UINT	wID,
		UINT	fType,
		LPCWSTR	dwTypeData,
		UINT	fState
	)

Definition at line 884 of file CDefaultContextMenu.cpp.

{
    MENUITEMINFOW mii;
    WCHAR wszText[100];
 
    ZeroMemory(&mii, sizeof(mii));
    mii.cbSize = sizeof(mii);
    if (fType == MFT_SEPARATOR)
        mii.fMask = MIIM_ID | MIIM_TYPE;
    else if (fType == MFT_STRING)
    {
        mii.fMask = MIIM_ID | MIIM_TYPE | MIIM_STATE;
        if (IS_INTRESOURCE(dwTypeData))
        {
            if (LoadStringW(shell32_hInstance, LOWORD((ULONG_PTR)dwTypeData), wszText, _countof(wszText)))
                mii.dwTypeData = wszText;
            else
            {
                ERR("failed to load string %p\n", dwTypeData);
                return FALSE;
            }
        }
        else
            mii.dwTypeData = (LPWSTR)dwTypeData;
        mii.fState = fState;
    }
 
    mii.wID = wID;
    mii.fType = fType;
    return InsertMenuItemW(hMenu, indexMenu, fByPosition, &mii);
}

CDefaultContextMenu_CreateInstance()

static HRESULT CDefaultContextMenu_CreateInstance ( const DEFCONTEXTMENU *  pdcm, LPFNDFMCALLBACK  lpfn, REFIID  riid, void **  ppv  )

static

Definition at line 1922 of file CDefaultContextMenu.cpp.

{
    return ShellObjectCreatorInit<CDefaultContextMenu>(pdcm, lpfn, riid, ppv);
}

Referenced by CDefFolderMenu_Create2(), and SHCreateDefaultContextMenu().

CDefFolderMenu_Create2()

HRESULT WINAPI CDefFolderMenu_Create2	(	PCIDLIST_ABSOLUTE	pidlFolder,
		HWND	hwnd,
		UINT	cidl,
		PCUITEMID_CHILD_ARRAY	apidl,
		IShellFolder *	psf,
		LPFNDFMCALLBACK	lpfn,
		UINT	nKeys,
		const HKEY *	ahkeyClsKeys,
		IContextMenu **	ppcm
	)

Definition at line 1955 of file CDefaultContextMenu.cpp.

{
    DEFCONTEXTMENU dcm;
    dcm.hwnd = hwnd;
    dcm.pcmcb = NULL;
    dcm.pidlFolder = pidlFolder;
    dcm.psf = psf;
    dcm.cidl = cidl;
    dcm.apidl = apidl;
    dcm.punkAssociationInfo = NULL;
    dcm.cKeys = nKeys;
    dcm.aKeys = ahkeyClsKeys;
 
    HRESULT hr = CDefaultContextMenu_CreateInstance(&dcm, lpfn, IID_PPV_ARG(IContextMenu, ppcm));
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    return S_OK;
}

Referenced by _CFontMenu_CreateInstance(), CDrivesContextMenu_CreateInstance(), CCabFolder::CreateViewObject(), CNetFolder::CreateViewObject(), CRegItemContextMenu_CreateInstance(), CZipFolder::GetUIObjectOf(), CCabFolder::GetUIObjectOf(), CNetFolder::GetUIObjectOf(), and CCommonFolder< TSelf, TItemId, TExtractIcon >::GetUIObjectOf().

DCMA_Destroy()

void DCMA_Destroy

(

HDCMA

hDCMA

)

Definition at line 44 of file CDefaultContextMenu.cpp.

{
    UINT i = 0;
    for (DCMENTRY *p; (p = DCMA_GetEntry(hDCMA, i)) != NULL; ++i)
        DCMA_DestroyEntry(*p);
    DSA_Destroy(hDCMA);
}

Referenced by CFSDropTarget::_GetEffectFromMenu().

DCMA_DestroyEntry()

static void DCMA_DestroyEntry ( DCMENTRY &  dcme )

static

Definition at line 35 of file CDefaultContextMenu.cpp.

{
    if (!dcme.pCM)
        return;
    IUnknown_SetSite(dcme.pCM, NULL);
    dcme.pCM->Release();
    dcme.pCM = NULL;
}

Referenced by DCMA_Destroy(), and DCMA_InsertMenuItems().

DCMA_InsertMenuItems()

UINT DCMA_InsertMenuItems	(	_In_ HDCMA	hDCMA,
		_In_ HDCIA	hDCIA,
		_In_opt_ LPCITEMIDLIST	pidlFolder,
		_In_opt_ IDataObject *	pDO,
		_In_opt_ HKEY *	pKeys,
		_In_opt_ UINT	nKeys,
		_In_ QCMINFO *	pQCMI,
		_In_opt_ UINT	fCmf,
		_In_opt_ IUnknown *	pUnkSite
	)

Definition at line 52 of file CDefaultContextMenu.cpp.

{
    UINT idCmdBase = pQCMI->idCmdFirst, idCmdFirst = idCmdBase;
    UINT nOffset = 0;
 
    // Insert in reverse order
    for (int iCls = DCIA_GetCount(hDCIA) - 1; iCls >= 0; --iCls)
    {
        REFCLSID clsid = *DCIA_GetEntry(hDCIA, iCls);
        if (fCmf & CMF_DEFAULTONLY)
        {
            WCHAR szKey[MAX_PATH];
            wcscpy(szKey, L"CLSID\\");
            StringFromGUID2(clsid, szKey + _countof(L"CLSID\\") - 1, CHARS_IN_GUID);
            wcscpy(szKey + _countof(L"CLSID\\") - 1 + CHARS_IN_GUID - 1, L"\\shellex\\MayChangeDefaultMenu");
            if (!RegKeyExists(HKEY_CLASSES_ROOT, szKey))
                continue;
        }
 
        for (UINT iKey = 0; iKey < nKeys; ++iKey)
        {
            CComPtr<IShellExtInit> pInit;
            HRESULT hr = SHExtCoCreateInstance(NULL, &clsid, NULL, IID_PPV_ARG(IShellExtInit, &pInit));
            if (FAILED(hr))
                break;
            if (FAILED(hr = pInit->Initialize(pidlFolder, pDO, pKeys[iKey])))
                continue;
 
            IContextMenu *pCM;
            if (FAILED(hr = pInit->QueryInterface(IID_PPV_ARG(IContextMenu, &pCM))))
                break;
            IUnknown_SetSite(pCM, pUnkSite);
 
            hr = pCM->QueryContextMenu(pQCMI->hmenu, pQCMI->indexMenu + nOffset, idCmdFirst, pQCMI->idCmdLast, fCmf);
            const UINT nCount = HRESULT_CODE(hr);
            const UINT idThisFirst = idCmdFirst - idCmdBase;
            DCMENTRY dcme = { pCM, idThisFirst, idThisFirst + nCount - 1 };
            if (hr > 0)
            {
                idCmdFirst += nCount;
                if (DSA_AppendItem(hDCMA, &dcme) >= 0)
                {
                    if (nOffset == 0 && GetMenuDefaultItem(pQCMI->hmenu, TRUE, 0) == 0)
                        nOffset++; // Insert new items below the default
                    break;
                }
            }
            DCMA_DestroyEntry(dcme);
        }
    }
    return idCmdFirst;
}

Referenced by CFSDropTarget::_GetEffectFromMenu().

DCMA_InvokeCommand()

HRESULT DCMA_InvokeCommand	(	HDCMA	hDCMA,
		CMINVOKECOMMANDINFO *	pICI
	)

Definition at line 114 of file CDefaultContextMenu.cpp.

{
    HRESULT hr = S_FALSE;
    for (UINT i = 0;; ++i)
    {
        DCMENTRY *p = DCMA_GetEntry(hDCMA, i);
        if (!p)
            return hr;
 
        UINT id = LOWORD(pICI->lpVerb);
        if (!IS_INTRESOURCE(pICI->lpVerb))
        {
            if (SUCCEEDED(hr = p->pCM->InvokeCommand(pICI)))
                return hr;
        }
        else if (id >= p->idCmdFirst && id <= p->idCmdLast)
        {
            CMINVOKECOMMANDINFOEX ici;
            CopyMemory(&ici, pICI, min(sizeof(ici), pICI->cbSize));
            ici.cbSize = min(sizeof(ici), pICI->cbSize);
            ici.lpVerb = MAKEINTRESOURCEA(id - p->idCmdFirst);
            ici.lpVerbW = (PWSTR)ici.lpVerb;
            return p->pCM->InvokeCommand((CMINVOKECOMMANDINFO*)&ici);
        }
    }
}

Referenced by CFSDropTarget::_GetEffectFromMenu().

FindVerbInDefaultVerbList()

static int FindVerbInDefaultVerbList ( LPCWSTR  List, LPCWSTR  Verb  )

static

Definition at line 227 of file CDefaultContextMenu.cpp.

{
    for (UINT index = 0; *List; ++index)
    {
        while (IsVerbListSeparator(*List))
            List++;
        LPCWSTR Start = List;
        while (*List && !IsVerbListSeparator(*List))
            List++;
        // "List > Start" to verify that the list item is non-empty to avoid the edge case where Verb is "" and the list contains ",,"
        if (!_wcsnicmp(Verb, Start, List - Start) && List > Start)
            return index;
    }
    return -1;
}

Referenced by CDefaultContextMenu::AddStaticContextMenusToMenu().

GetFriendlyVerb()

static HRESULT GetFriendlyVerb ( _In_ PCWSTR  pszVerb, _Out_ PWSTR  pszBuf, _In_ SIZE_T  cchMax  )

static

Definition at line 258 of file CDefaultContextMenu.cpp.

{
    static const struct { PCWSTR pszVerb; WORD iResId; } map[] =
    {
        // { L"open", IDS_OPEN_VERB }, These two have already been handled
        // { L"explore", IDS_EXPLORE_VERB },
        { L"edit", IDS_EDIT_VERB },
        { L"print", IDS_PRINT_VERB },
        { L"runas", IDS_RUNAS_VERB },
        { L"openas", IDS_OPEN_VERB },
        { L"find", IDS_FIND_VERB },
    };
    for (SIZE_T i = 0; i < _countof(map); ++i)
    {
        if (!_wcsicmp(pszVerb, map[i].pszVerb) &&
            LoadStringW(shell32_hInstance, map[i].iResId, pszBuf, cchMax))
        {
            return S_OK;
        }
    }
 
    // Try to make a friendly verb based on the verb subkey
    if (pszVerb[0] < 127 && !StrChrW(pszVerb, '&') && SUCCEEDED(StringCchCopyW(pszBuf + 1, --cchMax, pszVerb)))
    {
        *pszBuf = L'&';
        return S_OK; // This can be changed to S_FALSE if the caller needs to know we faked it
    }
    return E_FAIL;
}

Referenced by CDefaultContextMenu::AddStaticContextMenusToMenu().

HasClipboardData()

static BOOL HasClipboardData ( )

static

Definition at line 545 of file CDefaultContextMenu.cpp.

{
    BOOL bRet = FALSE;
    CComPtr<IDataObject> pDataObj;
 
    if (SUCCEEDED(OleGetClipboard(&pDataObj)))
    {
        FORMATETC formatetc;
 
        TRACE("pDataObj=%p\n", pDataObj.p);
 
        /* Set the FORMATETC structure*/
        InitFormatEtc(formatetc, RegisterClipboardFormatW(CFSTR_SHELLIDLIST), TYMED_HGLOBAL);
        bRet = SUCCEEDED(pDataObj->QueryGetData(&formatetc));
    }
 
    return bRet;
}

Referenced by CDefaultContextMenu::QueryContextMenu().

InsertMenuItemAt()

static BOOL InsertMenuItemAt ( HMENU  hMenu, UINT  Pos, UINT  Flags  )

static

Definition at line 26 of file CDefaultContextMenu.cpp.

{
    MENUITEMINFOW mii;
    mii.cbSize = FIELD_OFFSET(MENUITEMINFOW, hbmpItem); // USER32 version agnostic
    mii.fMask = MIIM_TYPE;
    mii.fType = Flags;
    return InsertMenuItemW(hMenu, Pos, TRUE, &mii);
}

Referenced by CDefaultContextMenu::AddStaticContextMenusToMenu().

IsVerbListSeparator()

static bool IsVerbListSeparator ( WCHAR  Ch )

inlinestatic

Definition at line 222 of file CDefaultContextMenu.cpp.

{
    return Ch == L' ' || Ch == L','; // learn.microsoft.com/en-us/windows/win32/shell/context-menu-handlers
}

Referenced by FindVerbInDefaultVerbList(), and SHELL32_EnumDefaultVerbList().

MapFcidmCmdToVerb()

PCSTR MapFcidmCmdToVerb

(

_In_ UINT_PTR

CmdId

)

Definition at line 183 of file CDefaultContextMenu.cpp.

{
    for (SIZE_T i = 0; i < _countof(g_StaticInvokeCmdMap); ++i)
    {
        if (g_StaticInvokeCmdMap[i].IntVerb == CmdId && CmdId)
            return g_StaticInvokeCmdMap[i].szStringVerb;
    }
    return NULL;
}

Referenced by CDefView::InvokeContextMenuCommand().

MapVerbToCmdId()

static HRESULT MapVerbToCmdId ( PVOID  Verb, BOOL  IsUnicode, IContextMenu *  pCM, UINT  idFirst, UINT  idLast  )

static

Definition at line 204 of file CDefaultContextMenu.cpp.

{
    const UINT gcs = IsUnicode ? GCS_VERBW : GCS_VERBA;
    for (UINT id = idFirst; id <= idLast; ++id)
    {
        WCHAR buf[MAX_PATH];
        *buf = UNICODE_NULL;
        HRESULT hr = pCM->GetCommandString(id, gcs, NULL, (LPSTR)buf, _countof(buf));
        if (FAILED(hr) || !*buf)
            continue;
        else if (IsUnicode && !_wcsicmp((LPWSTR)Verb, buf))
            return id;
        else if (!IsUnicode && !lstrcmpiA((LPSTR)Verb, (LPSTR)buf))
            return id;
    }
    return HRESULT_FROM_WIN32(ERROR_NOT_FOUND);
}

MapVerbToDfmCmd()

UINT MapVerbToDfmCmd

(

_In_ LPCSTR

verba

)

Definition at line 193 of file CDefaultContextMenu.cpp.

{
    for (UINT i = 0; i < _countof(g_StaticInvokeCmdMap); ++i)
    {
        if (!lstrcmpiA(g_StaticInvokeCmdMap[i].szStringVerb, verba))
            return (int)g_StaticInvokeCmdMap[i].DfmCmd;
    }
    return 0;
}

Referenced by GetDfmCmd().

SHCreateDefaultContextMenu()

HRESULT WINAPI SHCreateDefaultContextMenu	(	const DEFCONTEXTMENU *	pdcm,
		REFIID	riid,
		void **	ppv
	)

Definition at line 1934 of file CDefaultContextMenu.cpp.

{
    HRESULT hr;
 
    if (!ppv)
        return E_INVALIDARG;
 
    hr = CDefaultContextMenu_CreateInstance(pdcm, NULL, riid, ppv);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    return S_OK;
}

Referenced by CDesktopFolder::CreateViewObject(), CDrivesFolder::CreateViewObject(), CFSFolder::CreateViewObject(), CDesktopFolder::GetUIObjectOf(), CFSFolder::GetUIObjectOf(), and init_function_pointers().

SHELL32_EnumDefaultVerbList()

EXTERN_C HRESULT SHELL32_EnumDefaultVerbList	(	LPCWSTR	List,
		UINT	Index,
		LPWSTR	Verb,
		SIZE_T	cchMax
	)

Definition at line 243 of file CDefaultContextMenu.cpp.

{
    for (UINT i = 0; *List; ++i)
    {
        while (IsVerbListSeparator(*List))
            List++;
        LPCWSTR Start = List;
        while (*List && !IsVerbListSeparator(*List))
            List++;
        if (List > Start && i == Index)
            return StringCchCopyNW(Verb, cchMax, Start, List - Start);
    }
    return HRESULT_FROM_WIN32(ERROR_NO_MORE_ITEMS);
}

Referenced by HCR_GetDefaultVerbW().

SHELL_GetRegCLSID()

static HRESULT SHELL_GetRegCLSID ( HKEY  hKey, LPCWSTR  SubKey, LPCWSTR  Value, CLSID &  clsid  )

static

Definition at line 18 of file CDefaultContextMenu.cpp.

{
    WCHAR buf[42];
    DWORD cb = sizeof(buf);
    DWORD err = RegGetValueW(hKey, SubKey, Value, RRF_RT_REG_SZ, NULL, buf, &cb);
    return !err ? CLSIDFromString(buf, &clsid) : HRESULT_FROM_WIN32(err);
}

Referenced by CDefaultContextMenu::InvokeRegVerb().

SHGetMenuIdFromMenuMsg()

HRESULT SHGetMenuIdFromMenuMsg	(	UINT	uMsg,
		LPARAM	lParam,
		UINT *	CmdId
	)

Definition at line 1850 of file CDefaultContextMenu.cpp.

{
    if (uMsg == WM_DRAWITEM)
    {
        DRAWITEMSTRUCT* pDrawStruct = reinterpret_cast<DRAWITEMSTRUCT*>(lParam);
        *CmdId = pDrawStruct->itemID;
        return S_OK;
    }
    else if (uMsg == WM_MEASUREITEM)
    {
        MEASUREITEMSTRUCT* pMeasureStruct = reinterpret_cast<MEASUREITEMSTRUCT*>(lParam);
        *CmdId = pMeasureStruct->itemID;
        return S_OK;
    }
    return E_FAIL;
}

Referenced by CDefaultContextMenu::HandleMenuMsg2().

WINE_DEFAULT_DEBUG_CHANNEL()

WINE_DEFAULT_DEBUG_CHANNEL

(

dmenu

)

Variable Documentation

g_StaticInvokeCmdMap

const struct _StaticInvokeCommandMap_ g_StaticInvokeCmdMap[]

static

Initial value:

=
{
    { "runas", 0 },  
    { "print", 0 },  
    { "preview", 0 }, 
    { "open",            FCIDM_SHVIEW_OPEN },
    { CMDSTR_NEWFOLDERA, FCIDM_SHVIEW_NEWFOLDER,  (SHORT)DFM_CMD_NEWFOLDER },
    { "cut",             FCIDM_SHVIEW_CUT,         },
    { "copy",            FCIDM_SHVIEW_COPY,       (SHORT)DFM_CMD_COPY },
    { "paste",           FCIDM_SHVIEW_INSERT,     (SHORT)DFM_CMD_PASTE },
    { "link",            FCIDM_SHVIEW_CREATELINK, (SHORT)DFM_CMD_LINK },
    { "delete",          FCIDM_SHVIEW_DELETE,     (SHORT)DFM_CMD_DELETE },
    { "properties",      FCIDM_SHVIEW_PROPERTIES, (SHORT)DFM_CMD_PROPERTIES },
    { "rename",          FCIDM_SHVIEW_RENAME,     (SHORT)DFM_CMD_RENAME },
    { "copyto",          FCIDM_SHVIEW_COPYTO },
    { "moveto",          FCIDM_SHVIEW_MOVETO },
}

Referenced by CDefaultContextMenu::GetCommandString(), MapFcidmCmdToVerb(), CDefaultContextMenu::MapVerbToCmdId(), MapVerbToDfmCmd(), and CDefaultContextMenu::TryPickDefault().