CEnumMergedFolder Class Reference

Inheritance diagram for CEnumMergedFolder:

Collaboration diagram for CEnumMergedFolder:

Public Member Functions
	CEnumMergedFolder ()
virtual	~CEnumMergedFolder ()
int	DsaDeleteCallback (LocalPidlInfo *info)
HRESULT	SetSources (IShellFolder *userLocal, IShellFolder *allUSers)
HRESULT	Begin (HWND hwndOwner, SHCONTF flags)
HRESULT	FindPidlInList (HWND hwndOwner, LPCITEMIDLIST pcidl, LocalPidlInfo *pinfo)
HRESULT	FindByName (HWND hwndOwner, LPCWSTR strParsingName, LocalPidlInfo *pinfo)
virtual HRESULT STDMETHODCALLTYPE	Next (ULONG celt, LPITEMIDLIST *rgelt, ULONG *pceltFetched)
virtual HRESULT STDMETHODCALLTYPE	Skip (ULONG celt)
virtual HRESULT STDMETHODCALLTYPE	Reset ()
virtual HRESULT STDMETHODCALLTYPE	Clone (IEnumIDList **ppenum)
Public Member Functions inherited from ATL::CComObjectRootEx< CComMultiThreadModelNoCS >
	~CComObjectRootEx ()
ULONG	InternalAddRef ()
ULONG	InternalRelease ()
void	Lock ()
void	Unlock ()
HRESULT	_AtlInitialConstruct ()
Public Member Functions inherited from ATL::CComObjectRootBase
	CComObjectRootBase ()
	~CComObjectRootBase ()
void	SetVoid (void *)
HRESULT	_AtlFinalConstruct ()
HRESULT	FinalConstruct ()
void	InternalFinalConstructAddRef ()
void	InternalFinalConstructRelease ()
void	FinalRelease ()
Public Member Functions inherited from IEnumIDList
HRESULT	Next ([in] ULONG celt, [out, size_is(celt), length_is(*pceltFetched)] PITEMID_CHILD *rgelt, [out] ULONG *pceltFetched)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Static Public Member Functions
static int CALLBACK	s_DsaDeleteCallback (void *pItem, void *pData)
Static Public Member Functions inherited from ATL::CComObjectRootBase
static void WINAPI	ObjectMain (bool)
static const struct _ATL_CATMAP_ENTRY *	GetCategoryMap ()
static HRESULT WINAPI	InternalQueryInterface (void *pThis, const _ATL_INTMAP_ENTRY *pEntries, REFIID iid, void **ppvObject)

Private Attributes
CComPtr< IShellFolder >	m_UserLocalFolder
CComPtr< IShellFolder >	m_AllUSersFolder
HWND	m_HwndOwner
SHCONTF	m_Flags
HDSA	m_hDsa
UINT	m_hDsaIndex
UINT	m_hDsaCount

Additional Inherited Members
Public Types inherited from IEnumIDList
typedef IEnumIDList *	LPENUMIDLIST
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
Public Attributes inherited from ATL::CComObjectRootBase
LONG	m_dwRef

Detailed Description

Definition at line 37 of file CMergedFolder.cpp.

Constructor & Destructor Documentation

CEnumMergedFolder()

CEnumMergedFolder::CEnumMergedFolder

(

)

Definition at line 83 of file CMergedFolder.cpp.

                                     :
    m_UserLocalFolder(NULL),
    m_AllUSersFolder(NULL),
    m_HwndOwner(NULL),
    m_Flags(0),
    m_hDsa(NULL),
    m_hDsaIndex(0),
    m_hDsaCount(0)
{
}

~CEnumMergedFolder()

CEnumMergedFolder::~CEnumMergedFolder ( )

virtual

Definition at line 94 of file CMergedFolder.cpp.

{
    DSA_DestroyCallback(m_hDsa, s_DsaDeleteCallback, this);
}

Member Function Documentation

Begin()

HRESULT CEnumMergedFolder::Begin	(	HWND	hwndOwner,
		SHCONTF	flags
	)

Definition at line 124 of file CMergedFolder.cpp.

{
    HRESULT hr;
    LPITEMIDLIST pidl = NULL;

    if (m_hDsa && m_HwndOwner == hwndOwner && m_Flags == flags)
    {
        return Reset();
    }

    TRACE("Search conditions changed, recreating list...\n");

    CComPtr<IEnumIDList> userLocal;
    CComPtr<IEnumIDList> allUsers;

    hr = m_UserLocalFolder->EnumObjects(hwndOwner, flags, &userLocal);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
    hr = m_AllUSersFolder->EnumObjects(hwndOwner, flags, &allUsers);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;

    if (!m_hDsa)
    {
        m_hDsa = DSA_Create(sizeof(LocalPidlInfo), 10);
    }

    DSA_EnumCallback(m_hDsa, s_DsaDeleteCallback, this);
    DSA_DeleteAllItems(m_hDsa);
    m_hDsaCount = 0;

    // The sources are not ordered so load all of the items for the user folder first
    TRACE("Loading Local entries...\n");
    for (;;)
    {
        hr = userLocal->Next(1, &pidl, NULL);
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;

        if (hr == S_FALSE)
            break;

        LPWSTR name;
        STRRET str = { STRRET_WSTR };
        hr = m_UserLocalFolder->GetDisplayNameOf(pidl, SHGDN_FORPARSING | SHGDN_INFOLDER, &str);
        if (FAILED(hr))
            return hr;
        StrRetToStrW(&str, pidl, &name);

        LocalPidlInfo info = {
            FALSE,
            m_UserLocalFolder,
            ILClone(pidl),
            NULL,
            name
        };

        ILFree(pidl);

        TRACE("Inserting item %d with name %S\n", m_hDsaCount, name);
        int idx = DSA_InsertItem(m_hDsa, DSA_APPEND, &info);
        TRACE("New index: %d\n", idx);

        m_hDsaCount++;
    }

    // Then load the items for the common folder
    TRACE("Loading Common entries...\n");
    for (;;)
    {
        hr = allUsers->Next(1, &pidl, NULL);
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;

        if (hr == S_FALSE)
            break;

        LPWSTR name;
        STRRET str = { STRRET_WSTR };
        hr = m_AllUSersFolder->GetDisplayNameOf(pidl, SHGDN_FORPARSING | SHGDN_INFOLDER, &str);
        if (FAILED(hr))
            return hr;
        StrRetToStrW(&str, pidl, &name);

        LocalPidlInfo info = {
            FALSE,
            m_AllUSersFolder,
            ILClone(pidl),
            NULL,
            name
        };

        ILFree(pidl);

        // Try to find an existing entry with the same name, and makr it as shared.
        // FIXME: This is sub-optimal, a hash table would be a lot more efficient.
        BOOL bShared = FALSE;
        for (int i = 0; i < (int)m_hDsaCount; i++)
        {
            LocalPidlInfo *pInfo = (LocalPidlInfo *) DSA_GetItemPtr(m_hDsa, i);

            int order = CompareStringW(GetThreadLocale(), NORM_IGNORECASE,
                                   pInfo->parseName, lstrlenW(pInfo->parseName),
                                   info.parseName, lstrlenW(info.parseName));

            if (order == CSTR_EQUAL)
            {
                TRACE("Item name already exists! Marking '%S' as shared ...\n", name);
                bShared = TRUE;
                pInfo->shared = TRUE;
                pInfo->pidl2 = info.pidl;
                CoTaskMemFree(name);
                break;
            }
        }

        // If an entry was not found, add a new one for this item
        if (!bShared)
        {
            TRACE("Inserting item %d with name %S\n", m_hDsaCount, name);
            int idx = DSA_InsertItem(m_hDsa, DSA_APPEND, &info);
            TRACE("New index: %d\n", idx);

            m_hDsaCount++;
        }
    }

    m_HwndOwner = hwndOwner;
    m_Flags = flags;

    return Reset();
}

Referenced by FindByName(), and FindPidlInList().

Clone()

HRESULT STDMETHODCALLTYPE CEnumMergedFolder::Clone ( IEnumIDList **  ppenum )

virtual

Implements IEnumIDList.

Definition at line 376 of file CMergedFolder.cpp.

{
    UNIMPLEMENTED;
    return E_NOTIMPL;
}

DsaDeleteCallback()

int CEnumMergedFolder::DsaDeleteCallback

(

LocalPidlInfo *

info

)

Definition at line 99 of file CMergedFolder.cpp.

{
    ILFree(info->pidl);
    if (info->pidl2)
        ILFree(info->pidl2);
    CoTaskMemFree((LPVOID)info->parseName);
    return 0;
}

Referenced by s_DsaDeleteCallback().

FindByName()

HRESULT CEnumMergedFolder::FindByName	(	HWND	hwndOwner,
		LPCWSTR	strParsingName,
		LocalPidlInfo *	pinfo
	)

Definition at line 295 of file CMergedFolder.cpp.

{
    if (!m_hDsa)
    {
        Begin(hwndOwner, SHCONTF_FOLDERS | SHCONTF_NONFOLDERS);
    }

    TRACE("Searching for '%S' in a list of %d items\n", strParsingName, m_hDsaCount);

    for (int i = 0; i < (int) m_hDsaCount; i++)
    {
        LocalPidlInfo * pInfo = (LocalPidlInfo *) DSA_GetItemPtr(m_hDsa, i);
        if (!pInfo)
            return E_FAIL;

        int order = CompareStringW(GetThreadLocale(), NORM_IGNORECASE,
                                   pInfo->parseName, lstrlenW(pInfo->parseName),
                                   strParsingName, lstrlenW(strParsingName));
        switch (order)
        {
        case CSTR_EQUAL:
            *pinfo = *pInfo;
            return S_OK;
        default:
            continue;
        }
    }

    TRACE("Pidl not found\n");
    return HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND);
}

FindPidlInList()

HRESULT CEnumMergedFolder::FindPidlInList	(	HWND	hwndOwner,
		LPCITEMIDLIST	pcidl,
		LocalPidlInfo *	pinfo
	)

Definition at line 257 of file CMergedFolder.cpp.

{
    HRESULT hr;

    if (!m_hDsa)
    {
        Begin(hwndOwner, SHCONTF_FOLDERS | SHCONTF_NONFOLDERS);
    }

    TRACE("Searching for pidl { cb=%d } in a list of %d items\n", pcidl->mkid.cb, m_hDsaCount);

    for (int i = 0; i < (int)m_hDsaCount; i++)
    {
        LocalPidlInfo * pInfo = (LocalPidlInfo *) DSA_GetItemPtr(m_hDsa, i);
        if (!pInfo)
            return E_FAIL;
        
        TRACE("Comparing with item at %d with parent %p and pidl { cb=%d }\n", i, pInfo->parent, pInfo->pidl->mkid.cb);

        hr = pInfo->parent->CompareIDs(0, pInfo->pidl, pcidl);
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;

        if (hr == S_OK)
        {
            *pinfo = *pInfo;
            return S_OK;
        }
        else
        {
            TRACE("Comparison returned %d\n", (int) (short) (hr & 0xFFFF));
        }
    }

    TRACE("Pidl not found\n");
    return HRESULT_FROM_WIN32(ERROR_FILE_NOT_FOUND);
}

Next()

HRESULT STDMETHODCALLTYPE CEnumMergedFolder::Next ( ULONG  celt, LPITEMIDLIST *  rgelt, ULONG *  pceltFetched  )

virtual

Definition at line 327 of file CMergedFolder.cpp.

{
    if (pceltFetched)
        *pceltFetched = 0;

    if (m_hDsaIndex == m_hDsaCount)
        return S_FALSE;

    for (int i = 0; i < (int)celt;)
    {
        LocalPidlInfo * tinfo = (LocalPidlInfo *) DSA_GetItemPtr(m_hDsa, m_hDsaIndex);
        if (!tinfo)
            return E_FAIL;

        LocalPidlInfo info = *tinfo;

        TRACE("Returning next item at %d with parent %p and pidl { cb=%d }\n", m_hDsaIndex, info.parent, info.pidl->mkid.cb);

        // FIXME: ILClone shouldn't be needed here! This should be causing leaks
        if (rgelt) rgelt[i] = ILClone(info.pidl);
        i++;

        m_hDsaIndex++;
        if (m_hDsaIndex == m_hDsaCount)
        {
            if (pceltFetched)
                *pceltFetched = i;
            return (i == (int)celt) ? S_OK : S_FALSE;
        }
    }

    if (pceltFetched) *pceltFetched = celt;
    return S_OK;
}

Referenced by Skip().

Reset()

HRESULT STDMETHODCALLTYPE CEnumMergedFolder::Reset ( void  )

virtual

Implements IEnumIDList.

Definition at line 370 of file CMergedFolder.cpp.

{
    m_hDsaIndex = 0;
    return S_OK;
}

Referenced by Begin().

s_DsaDeleteCallback()

int CALLBACK CEnumMergedFolder::s_DsaDeleteCallback ( void *  pItem, void *  pData  )

static

Definition at line 108 of file CMergedFolder.cpp.

{
    CEnumMergedFolder * mf = (CEnumMergedFolder*) pData;
    LocalPidlInfo  * item = (LocalPidlInfo*) pItem;
    return mf->DsaDeleteCallback(item);
}

Referenced by Begin(), and ~CEnumMergedFolder().

SetSources()

HRESULT CEnumMergedFolder::SetSources	(	IShellFolder *	userLocal,
		IShellFolder *	allUSers
	)

Definition at line 115 of file CMergedFolder.cpp.

{
    m_UserLocalFolder = userLocal;
    m_AllUSersFolder = allUSers;

    TRACE("SetSources %p %p\n", userLocal, allUSers);
    return S_OK;
}

Skip()

HRESULT STDMETHODCALLTYPE CEnumMergedFolder::Skip ( ULONG  celt )

virtual

Implements IEnumIDList.

Definition at line 365 of file CMergedFolder.cpp.

{
    return Next(celt, NULL, NULL);
}

Member Data Documentation

m_AllUSersFolder

CComPtr<IShellFolder> CEnumMergedFolder::m_AllUSersFolder

private

Definition at line 44 of file CMergedFolder.cpp.

Referenced by Begin(), and SetSources().

m_Flags

SHCONTF CEnumMergedFolder::m_Flags

private

Definition at line 47 of file CMergedFolder.cpp.

Referenced by Begin().

m_hDsa

HDSA CEnumMergedFolder::m_hDsa

private

Definition at line 49 of file CMergedFolder.cpp.

Referenced by Begin(), FindByName(), FindPidlInList(), Next(), and ~CEnumMergedFolder().

m_hDsaCount

UINT CEnumMergedFolder::m_hDsaCount

private

Definition at line 51 of file CMergedFolder.cpp.

Referenced by Begin(), FindByName(), FindPidlInList(), and Next().

m_hDsaIndex

UINT CEnumMergedFolder::m_hDsaIndex

private

Definition at line 50 of file CMergedFolder.cpp.

Referenced by Next(), and Reset().

m_HwndOwner

HWND CEnumMergedFolder::m_HwndOwner

private

Definition at line 46 of file CMergedFolder.cpp.

Referenced by Begin().

m_UserLocalFolder

CComPtr<IShellFolder> CEnumMergedFolder::m_UserLocalFolder

private

Definition at line 43 of file CMergedFolder.cpp.

Referenced by Begin(), and SetSources().

---

The documentation for this class was generated from the following file:

• dll/win32/shell32/shellmenu/CMergedFolder.cpp