utility.cpp File Reference

#include "objects.h"
#include <strsafe.h>
#include <wine/debug.h>

Include dependency graph for utility.cpp:

Go to the source code of this file.

Macros
#define	PATH_VALID_ELEMENT

Functions
	WINE_DEFAULT_DEBUG_CHANNEL (shdocvw)
static INT_PTR	GetMenuItemIdByPos (HMENU hMenu, UINT Pos)
static BOOL	IsMenuSeparator (HMENU hMenu, UINT Pos)
EXTERN_C HRESULT	SHELL_GetIDListFromObject (IUnknown *punk, PIDLIST_ABSOLUTE *ppidl)
static HRESULT	SHELL_CompareAbsoluteIDs (LPARAM lParam, PCIDLIST_ABSOLUTE a, PCIDLIST_ABSOLUTE b)
EXTERN_C BOOL	SHELL_IsEqualAbsoluteID (PCIDLIST_ABSOLUTE a, PCIDLIST_ABSOLUTE b)
EXTERN_C BOOL	SHELL_IsVerb (IContextMenu *pcm, UINT_PTR idCmd, LPCWSTR Verb)
static int	SHELL_FindVerbPos (IContextMenu *pcm, UINT idCmdFirst, HMENU hMenu, LPCWSTR Verb)
EXTERN_C VOID	SHELL_RemoveVerb (IContextMenu *pcm, UINT idCmdFirst, HMENU hMenu, LPCWSTR Verb)
EXTERN_C BOOL	_ILIsDesktop (LPCITEMIDLIST pidl)
EXTERN_C BOOL WINAPI	IEILIsEqual (_In_ LPCITEMIDLIST pidl1, _In_ LPCITEMIDLIST pidl2, _In_ BOOL bUnknown)
static VOID	SHDOCVW_PathDeleteInvalidChars (LPWSTR pszDisplayName)
static HRESULT	SHDOCVW_CreateShortcut (_In_ LPCWSTR pszLnkFileName, _In_ PCIDLIST_ABSOLUTE pidlTarget, _In_opt_ LPCWSTR pszDescription)
EXTERN_C HRESULT WINAPI	AddUrlToFavorites (_In_ HWND hwnd, _In_ LPCWSTR pszUrlW, _In_opt_ LPCWSTR pszTitleW, _In_ BOOL fDisplayUI)

Macro Definition Documentation

PATH_VALID_ELEMENT

#define PATH_VALID_ELEMENT

Value:

    ( \
    PATH_CHAR_CLASS_DOT | PATH_CHAR_CLASS_SEMICOLON | PATH_CHAR_CLASS_COMMA | \
    PATH_CHAR_CLASS_SPACE | PATH_CHAR_CLASS_OTHER_VALID \
)

Function Documentation

_ILIsDesktop()

EXTERN_C BOOL _ILIsDesktop ( LPCITEMIDLIST  pidl )

inline

Definition at line 123 of file utility.cpp.

{
    return (pidl == NULL || pidl->mkid.cb == 0);
}

AddUrlToFavorites()

EXTERN_C HRESULT WINAPI AddUrlToFavorites	(	_In_ HWND	hwnd,
		_In_ LPCWSTR	pszUrlW,
		_In_opt_ LPCWSTR	pszTitleW,
		_In_ BOOL	fDisplayUI
	)

Definition at line 192 of file utility.cpp.

{
    TRACE("%p, %s, %s, %d\n", hwnd, wine_dbgstr_w(pszUrlW), wine_dbgstr_w(pszTitleW), fDisplayUI);
 
    if (fDisplayUI)
        FIXME("fDisplayUI\n"); // NOTE: Use SHBrowseForFolder callback
 
    if (PathIsURLW(pszUrlW))
        FIXME("Internet Shortcut\n");
 
    CComHeapPtr<ITEMIDLIST> pidl;
    HRESULT hr = SHParseDisplayName(pszUrlW, NULL, &pidl, 0, NULL);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    // Get title
    WCHAR szTitle[MAX_PATH];
    if (pszTitleW)
        StringCchCopyW(szTitle, _countof(szTitle), pszTitleW);
    else
        ILGetDisplayNameEx(NULL, pidl, szTitle, ILGDN_NORMAL);
 
    // Delete invalid characters
    SHDOCVW_PathDeleteInvalidChars(szTitle);
 
    // Build shortcut pathname
    WCHAR szPath[MAX_PATH];
    if (!SHGetSpecialFolderPathW(hwnd, szPath, CSIDL_FAVORITES, TRUE))
        return E_FAIL;
    PathAppendW(szPath, szTitle);
    PathAddExtensionW(szPath, L".lnk");
 
    return SHDOCVW_CreateShortcut(szPath, pidl, NULL);
}

Referenced by CShellBrowser::OnAddToFavorites().

GetMenuItemIdByPos()

static INT_PTR GetMenuItemIdByPos ( HMENU  hMenu, UINT  Pos  )

inlinestatic

Definition at line 16 of file utility.cpp.

{
    MENUITEMINFOW mii;
    mii.cbSize = FIELD_OFFSET(MENUITEMINFOW, hbmpItem); /* USER32 version agnostic */
    mii.fMask = MIIM_ID; /* GetMenuItemID does not handle sub-menus, this does */
    mii.cch = 0;
    return GetMenuItemInfoW(hMenu, Pos, TRUE, &mii) ? mii.wID : -1;
}

Referenced by SHELL_FindVerbPos().

IEILIsEqual()

EXTERN_C BOOL WINAPI IEILIsEqual	(	_In_ LPCITEMIDLIST	pidl1,
		_In_ LPCITEMIDLIST	pidl2,
		_In_ BOOL	bUnknown
	)

Definition at line 132 of file utility.cpp.

{
    UINT cb1 = ILGetSize(pidl1), cb2 = ILGetSize(pidl2);
    if (cb1 == cb2 && memcmp(pidl1, pidl2, cb1) == 0)
        return TRUE;
 
    FIXME("%p, %p\n", pidl1, pidl2);
    return FALSE;
}

Referenced by CMruBase::_IsEqual().

IsMenuSeparator()

static BOOL IsMenuSeparator ( HMENU  hMenu, UINT  Pos  )

inlinestatic

Definition at line 26 of file utility.cpp.

{
    MENUITEMINFOW mii;
    mii.cbSize = FIELD_OFFSET(MENUITEMINFOW, hbmpItem); /* USER32 version agnostic */
    mii.fMask = MIIM_FTYPE;
    mii.cch = 0;
    return GetMenuItemInfoW(hMenu, Pos, TRUE, &mii) && (mii.fType & MFT_SEPARATOR);
}

Referenced by SHELL_RemoveVerb().

SHDOCVW_CreateShortcut()

static HRESULT SHDOCVW_CreateShortcut ( _In_ LPCWSTR  pszLnkFileName, _In_ PCIDLIST_ABSOLUTE  pidlTarget, _In_opt_ LPCWSTR  pszDescription  )

static

Definition at line 162 of file utility.cpp.

{
    HRESULT hr;
 
    CComPtr<IShellLink> psl;
    hr = CoCreateInstance(CLSID_ShellLink, NULL,  CLSCTX_INPROC_SERVER,
                          IID_PPV_ARG(IShellLink, &psl));
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    psl->SetIDList(pidlTarget);
 
    if (pszDescription)
        psl->SetDescription(pszDescription);
 
    CComPtr<IPersistFile> ppf;
    hr = psl->QueryInterface(IID_PPV_ARG(IPersistFile, &ppf));
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    return ppf->Save(pszLnkFileName, TRUE);
}

Referenced by AddUrlToFavorites().

SHDOCVW_PathDeleteInvalidChars()

static VOID SHDOCVW_PathDeleteInvalidChars ( LPWSTR  pszDisplayName )

static

Definition at line 146 of file utility.cpp.

{
#define PATH_VALID_ELEMENT ( \
    PATH_CHAR_CLASS_DOT | PATH_CHAR_CLASS_SEMICOLON | PATH_CHAR_CLASS_COMMA | \
    PATH_CHAR_CLASS_SPACE | PATH_CHAR_CLASS_OTHER_VALID \
)
    PWCHAR pch, pchSrc;
    for (pch = pchSrc = pszDisplayName; *pchSrc; ++pchSrc)
    {
        if (PathIsValidCharW(*pchSrc, PATH_VALID_ELEMENT))
            *pch++ = *pchSrc;
    }
    *pch = UNICODE_NULL;
}

Referenced by AddUrlToFavorites().

SHELL_CompareAbsoluteIDs()

static HRESULT SHELL_CompareAbsoluteIDs ( LPARAM  lParam, PCIDLIST_ABSOLUTE  a, PCIDLIST_ABSOLUTE  b  )

static

Definition at line 58 of file utility.cpp.

{
    IShellFolder *psf;
    HRESULT hr = SHGetDesktopFolder(&psf);
    if (FAILED(hr))
        return hr;
    hr = psf->CompareIDs(lParam, a, b);
    psf->Release();
    return hr;
}

Referenced by SHELL_IsEqualAbsoluteID().

SHELL_FindVerbPos()

static int SHELL_FindVerbPos ( IContextMenu *  pcm, UINT  idCmdFirst, HMENU  hMenu, LPCWSTR  Verb  )

static

Definition at line 93 of file utility.cpp.

{
    for (UINT i = 0, c = GetMenuItemCount(hMenu); i < c; ++i)
    {
        INT_PTR id = GetMenuItemIdByPos(hMenu, i);
        if (id != -1 && SHELL_IsVerb(pcm, id - idCmdFirst, Verb))
            return i;
    }
    return -1;
}

Referenced by SHELL_RemoveVerb().

SHELL_GetIDListFromObject()

EXTERN_C HRESULT SHELL_GetIDListFromObject	(	IUnknown *	punk,
		PIDLIST_ABSOLUTE *	ppidl
	)

Definition at line 36 of file utility.cpp.

{
#if DLL_EXPORT_VERSION >= _WIN32_WINNT_VISTA && 0 // FIXME: SHELL32 not ready yet
    return SHGetIDListFromObject(punk, ppidl);
#else
    HRESULT hr;
    IPersistFolder2 *pf2;
    if (SUCCEEDED(hr = punk->QueryInterface(IID_PPV_ARG(IPersistFolder2, &pf2))))
    {
        hr = pf2->GetCurFolder(ppidl);
        pf2->Release();
    }
    IPersistIDList *pil;
    if (FAILED(hr) && SUCCEEDED(hr = punk->QueryInterface(IID_PPV_ARG(IPersistIDList, &pil))))
    {
        hr = pil->GetIDList(ppidl);
        pil->Release();
    }
    return hr;
#endif
}

Referenced by SHDOCVW_GetCurrentLocationFromView().

SHELL_IsEqualAbsoluteID()

EXTERN_C BOOL SHELL_IsEqualAbsoluteID	(	PCIDLIST_ABSOLUTE	a,
		PCIDLIST_ABSOLUTE	b
	)

Definition at line 70 of file utility.cpp.

{
    return !SHELL_CompareAbsoluteIDs(SHCIDS_CANONICALONLY, a, b);
}

SHELL_IsVerb()

EXTERN_C BOOL SHELL_IsVerb	(	IContextMenu *	pcm,
		UINT_PTR	idCmd,
		LPCWSTR	Verb
	)

Definition at line 76 of file utility.cpp.

{
    HRESULT hr;
    WCHAR wide[MAX_PATH];
    if (SUCCEEDED(hr = pcm->GetCommandString(idCmd, GCS_VERBW, NULL, (LPSTR)wide, _countof(wide))))
        return !lstrcmpiW(wide, Verb);
 
    CHAR ansi[_countof(wide)], buf[MAX_PATH];
    if (SHUnicodeToAnsi(Verb, buf, _countof(buf)))
    {
        if (SUCCEEDED(hr = pcm->GetCommandString(idCmd, GCS_VERBA, NULL, ansi, _countof(ansi))))
            return !lstrcmpiA(ansi, buf);
    }
    return FALSE;
}

Referenced by SHELL_FindVerbPos().

SHELL_RemoveVerb()

EXTERN_C VOID SHELL_RemoveVerb	(	IContextMenu *	pcm,
		UINT	idCmdFirst,
		HMENU	hMenu,
		LPCWSTR	Verb
	)

Definition at line 105 of file utility.cpp.

{
    int nPos = SHELL_FindVerbPos(pcm, idCmdFirst, hMenu, Verb);
    if (nPos < 0)
        return;
    int nCount = GetMenuItemCount(hMenu);
    BOOL bSepBefore = nPos && IsMenuSeparator(hMenu, nPos - 1);
    BOOL bSepAfter = IsMenuSeparator(hMenu, nPos + 1);
    if (DeleteMenu(hMenu, nPos, MF_BYPOSITION))
    {
        if ((bSepBefore && bSepAfter) || (bSepAfter && nPos == 0))
            DeleteMenu(hMenu, nPos, MF_BYPOSITION);
        else if (bSepBefore && nPos + 1 == nCount)
            DeleteMenu(hMenu, nPos - 1, MF_BYPOSITION);
    }
}

WINE_DEFAULT_DEBUG_CHANNEL()

WINE_DEFAULT_DEBUG_CHANNEL

(

shdocvw

)