CMruPidlList Class Reference

Inheritance diagram for CMruPidlList:

Collaboration diagram for CMruPidlList:

Public Member Functions
	CMruPidlList ()
	~CMruPidlList () override
HRESULT	GetEmptySlot (UINT *pnNodeSlot)
void	EmptyNodeSlot (UINT nNodeSlot)
STDMETHODIMP	QueryInterface (REFIID riid, void **ppvObj) override
	STDMETHODIMP_ (ULONG) AddRef() override
	STDMETHODIMP_ (ULONG) Release() override
STDMETHODIMP	InitList (UINT cMRUSize, HKEY hKey, LPCWSTR pszSubKey) override
STDMETHODIMP	UsePidl (LPCITEMIDLIST pidl, UINT *pnNodeSlot) override
STDMETHODIMP	QueryPidl (LPCITEMIDLIST pidl, UINT cSlots, UINT *pnNodeSlots, UINT *pcNodeSlots) override
STDMETHODIMP	PruneKids (LPCITEMIDLIST pidl) override
Public Member Functions inherited from CMruNode
	CMruNode ()
	CMruNode (CMruNode *pParent, UINT iSlot)
	~CMruNode () override
CMruNode *	GetParent ()
HRESULT	BindToSlot (UINT iSlot, IShellFolder **ppSF)
HRESULT	GetNode (BOOL bAdd, LPCITEMIDLIST pidl, CMruNode **pNewNode)
HRESULT	GetNodeSlot (UINT *pnNodeSlot)
HRESULT	SetNodeSlot (UINT nNodeSlot)
HRESULT	RemoveLeast (UINT *pnNodeSlot)
HRESULT	Clear (CMruPidlList *pList)
Public Member Functions inherited from CMruLongList
	CMruLongList ()
	~CMruLongList () override
Public Member Functions inherited from CMruBase
	CMruBase ()
virtual	~CMruBase ()
STDMETHODIMP	QueryInterface (REFIID riid, void **ppvObj) override
	STDMETHODIMP_ (ULONG) AddRef() override
	STDMETHODIMP_ (ULONG) Release() override
STDMETHODIMP	InitData (UINT cCapacity, UINT flags, HKEY hKey, LPCWSTR pszSubKey OPTIONAL, SLOTCOMPARE fnCompare OPTIONAL) override
STDMETHODIMP	AddData (LPCVOID pvData, DWORD cbData, UINT *piSlot) override
STDMETHODIMP	FindData (LPCVOID pvData, DWORD cbData, UINT *piSlot) override
STDMETHODIMP	GetData (UINT iSlot, LPVOID pvData, DWORD cbData) override
STDMETHODIMP	QueryInfo (UINT iSlot, UINT *piGotSlot, DWORD *pcbData) override
STDMETHODIMP	Delete (UINT iSlot) override
virtual BOOL	_IsEqual (const SLOTITEMDATA *pItem, LPCVOID pvData, UINT cbData) const
virtual DWORD	_DeleteValue (LPCWSTR pszValue)
virtual HRESULT	_InitSlots ()=0
virtual void	_SaveSlots ()=0
virtual UINT	_UpdateSlots (UINT iSlot)=0
virtual void	_SlotString (UINT iSlot, LPWSTR psz, DWORD cch)=0
virtual HRESULT	_GetSlot (UINT iSlot, UINT *puSlot)=0
virtual HRESULT	_RemoveSlot (UINT iSlot, UINT *puSlot)=0

Protected Member Functions
BOOL	_LoadNodeSlots ()
void	_SaveNodeSlots ()
HRESULT	_InitNodeSlots ()
Protected Member Functions inherited from CMruNode
BOOL	_InitLate ()
BOOL	_IsEqual (SLOTITEMDATA *pItem, LPCVOID pvData, UINT cbData)
DWORD	_DeleteValue (LPCWSTR pszValue) override
HRESULT	_CreateNode (UINT iSlot, CMruNode **ppNewNode)
HRESULT	_AddPidl (UINT iSlot, LPCITEMIDLIST pidl)
HRESULT	_FindPidl (LPCITEMIDLIST pidl, UINT *piSlot)
HRESULT	_GetPidlSlot (LPCITEMIDLIST pidl, BOOL bAdd, UINT *piSlot)
Protected Member Functions inherited from CMruLongList
void	_ImportShortList ()
HRESULT	_InitSlots () override
void	_SaveSlots () override
UINT	_UpdateSlots (UINT iSlot) override
void	_SlotString (UINT iSlot, LPWSTR psz, DWORD cch) override
HRESULT	_GetSlot (UINT iSlot, UINT *puSlot) override
HRESULT	_RemoveSlot (UINT iSlot, UINT *puSlot) override
Protected Member Functions inherited from CMruBase
HRESULT	_LoadItem (UINT iSlot)
HRESULT	_AddItem (UINT iSlot, LPCVOID pvData, DWORD cbData)
HRESULT	_GetItem (UINT iSlot, SLOTITEMDATA **ppItem)
void	_DeleteItem (UINT iSlot)
HRESULT	_GetSlotItem (UINT iSlot, SLOTITEMDATA **ppItem)
void	_CheckUsedSlots ()
HRESULT	_UseEmptySlot (UINT *piSlot)

Protected Attributes
LPBYTE	m_pbNodeSlots = NULL
DWORD	m_cMaxNodeSlots = 0
HANDLE	m_hMutex = NULL
Protected Attributes inherited from CMruNode
UINT	m_iSlot = 0
CMruNode *	m_pParent = NULL
IShellFolder *	m_pShellFolder = NULL
Protected Attributes inherited from CMruLongList
UINT *	m_puSlotData = NULL
Protected Attributes inherited from CMruBase
LONG	m_cRefs = 1
DWORD	m_dwFlags = 0
BOOL	m_bNeedSave = FALSE
BOOL	m_bChecked = FALSE
HKEY	m_hKey = NULL
DWORD	m_cSlotRooms = 0
DWORD	m_cSlots = 0
SLOTCOMPARE	m_fnCompare = NULL
SLOTITEMDATA *	m_pSlots = NULL

Additional Inherited Members
Static Public Member Functions inherited from CMruBase
static void *	operator new (size_t size)
static void	operator delete (void *ptr)

Detailed Description

Definition at line 967 of file mrulist.cpp.

Constructor & Destructor Documentation

CMruPidlList()

CMruPidlList::CMruPidlList ( )

inline

Definition at line 981 of file mrulist.cpp.

{ }

~CMruPidlList()

CMruPidlList::~CMruPidlList ( )

override

Definition at line 1009 of file mrulist.cpp.

{
    m_pbNodeSlots = (LPBYTE)::LocalFree(m_pbNodeSlots);
    if (m_hMutex)
    {
        ::CloseHandle(m_hMutex);
        m_hMutex = NULL;
    }
}

Member Function Documentation

_InitNodeSlots()

HRESULT CMruPidlList::_InitNodeSlots ( )

protected

Definition at line 1050 of file mrulist.cpp.

{
    m_pbNodeSlots = (BYTE*)LocalAlloc(LPTR, m_cSlotRooms * sizeof(BYTE));
    if (!m_pbNodeSlots)
        return E_OUTOFMEMORY;
 
    _LoadNodeSlots();
    m_bNeedSave = TRUE;
    _SaveNodeSlots();
 
    return S_OK;
}

Referenced by InitList().

_LoadNodeSlots()

BOOL CMruPidlList::_LoadNodeSlots ( )

protected

Definition at line 1035 of file mrulist.cpp.

{
    DWORD cbNodeSlots = m_cSlotRooms * sizeof(BYTE);
    if (SHGetValueW(m_hKey, NULL, L"NodeSlots", NULL, m_pbNodeSlots, &cbNodeSlots) != ERROR_SUCCESS)
        return FALSE;
    m_cMaxNodeSlots = cbNodeSlots / sizeof(BYTE);
    return TRUE;
}

Referenced by _InitNodeSlots(), GetEmptySlot(), and PruneKids().

_SaveNodeSlots()

void CMruPidlList::_SaveNodeSlots ( )

protected

Definition at line 1044 of file mrulist.cpp.

{
    DWORD cbNodeSlots = m_cMaxNodeSlots * sizeof(BYTE);
    SHSetValueW(m_hKey, NULL, L"NodeSlots", REG_BINARY, m_pbNodeSlots, cbNodeSlots);
}

Referenced by _InitNodeSlots(), GetEmptySlot(), and PruneKids().

EmptyNodeSlot()

void CMruPidlList::EmptyNodeSlot

(

UINT

nNodeSlot

)

Definition at line 1239 of file mrulist.cpp.

{
    m_pbNodeSlots[nNodeSlot - 1] = 0; // nNodeSlot is 1-base
    m_bNeedSave = TRUE;
}

GetEmptySlot()

HRESULT CMruPidlList::GetEmptySlot

(

UINT *

pnNodeSlot

)

Definition at line 1063 of file mrulist.cpp.

{
    *pnNodeSlot = 0;
 
    if (!_LoadNodeSlots())
        return E_FAIL;
 
    if (m_cMaxNodeSlots < m_cSlotRooms)
    {
        m_pbNodeSlots[m_cMaxNodeSlots] = SLOT_SET;
        *pnNodeSlot = ++m_cMaxNodeSlots;
        _SaveNodeSlots();
        return S_OK;
    }
 
    for (UINT iNodeSlot = 0; iNodeSlot < m_cMaxNodeSlots; ++iNodeSlot)
    {
        if (m_pbNodeSlots[iNodeSlot] & SLOT_SET)
            continue;
 
        m_pbNodeSlots[iNodeSlot] = SLOT_SET;
        *pnNodeSlot = iNodeSlot + 1; // nNodeSlot is 1-base
        _SaveNodeSlots();
        return S_OK;
    }
 
    HRESULT hr = E_FAIL;
    if (SUCCEEDED(RemoveLeast(pnNodeSlot)) && *pnNodeSlot)
        hr = S_OK;
 
    _SaveNodeSlots();
    return hr;
}

Referenced by UsePidl().

InitList()

STDMETHODIMP CMruPidlList::InitList ( UINT  cMRUSize, HKEY  hKey, LPCWSTR  pszSubKey  )

override

Definition at line 1097 of file mrulist.cpp.

{
    TRACE("%p -> %u %p %s\n", this, cMRUSize, hKey, debugstr_w(pszSubKey));
 
    HRESULT hr = InitData(cMRUSize, 0, hKey, pszSubKey, NULL);
    if (FAILED(hr))
    {
        ERR("0x%08lX\n", hr);
        return hr;
    }
 
    hr = _InitNodeSlots();
    if (FAILED(hr))
    {
        ERR("0x%08lX\n", hr);
        return hr;
    }
 
    m_hMutex = ::CreateMutexW(NULL, FALSE, L"Shell.CMruPidlList");
    if (!m_hMutex)
    {
        hr = HRESULT_FROM_WIN32(GetLastError());
        ERR("0x%08lX\n", hr);
    }
 
    return hr;
}

PruneKids()

STDMETHODIMP CMruPidlList::PruneKids ( LPCITEMIDLIST  pidl )

override

Definition at line 1208 of file mrulist.cpp.

{
    TRACE("%p -> %p\n", this, pidl);
 
    CSafeMutex mutex;
    HRESULT hr = mutex.Enter(m_hMutex);
    if (FAILED(hr))
    {
        ERR("0x%08lX\n", hr);
        return hr;
    }
 
    if (!_LoadNodeSlots())
        return hr;
 
    CMruNode *pNode;
    hr = GetNode(FALSE, pidl, &pNode);
    if (FAILED(hr))
        return hr;
 
    if (hr == S_OK)
        hr = pNode->Clear(this);
    else
        hr = E_FAIL;
 
    pNode->Release();
 
    _SaveNodeSlots();
    return hr;
}

QueryInterface()

STDMETHODIMP CMruPidlList::QueryInterface ( REFIID  riid, void **  ppvObj  )

override

Definition at line 1019 of file mrulist.cpp.

{
    if (!ppvObj)
        return E_POINTER;
 
    if (::IsEqualGUID(riid, IID_IMruPidlList) || ::IsEqualGUID(riid, IID_IUnknown))
    {
        *ppvObj = static_cast<IMruPidlList*>(this);
        AddRef();
        return S_OK;
    }
 
    ERR("%s: E_NOINTERFACE\n", debugstr_guid(&riid));
    return E_NOINTERFACE;
}

QueryPidl()

STDMETHODIMP CMruPidlList::QueryPidl ( LPCITEMIDLIST  pidl, UINT  cSlots, UINT *  pnNodeSlots, UINT *  pcNodeSlots  )

override

Definition at line 1161 of file mrulist.cpp.

{
    TRACE("%p -> %p %u %p %p\n", this, pidl, cSlots, pnNodeSlots, pcNodeSlots);
 
    CSafeMutex mutex;
    HRESULT hr = mutex.Enter(m_hMutex);
    if (FAILED(hr))
    {
        ERR("0x%08lX\n", hr);
        return hr;
    }
 
    *pcNodeSlots = 0;
 
    CMruNode *pNode;
    hr = GetNode(FALSE, pidl, &pNode);
    if (FAILED(hr))
    {
        ERR("0x%08lX\n", hr);
        return hr;
    }
 
    while (pNode && *pcNodeSlots < cSlots)
    {
        CMruNode *pParent = pNode->GetParent();
        if (SUCCEEDED(pNode->GetNodeSlot(&pnNodeSlots[*pcNodeSlots])))
            ++(*pcNodeSlots);
        else if (hr == S_OK && !*pcNodeSlots)
            hr = S_FALSE;
 
        pNode->Release();
        pNode = pParent;
    }
 
    if (pNode)
        pNode->Release();
 
    if (SUCCEEDED(hr) && !*pcNodeSlots)
        hr = E_FAIL;
 
    return hr;
}

STDMETHODIMP_() [1/2]

CMruPidlList::STDMETHODIMP_ ( ULONG  )

inlineoverride

Definition at line 989 of file mrulist.cpp.

    {
        return CMruBase::AddRef();
    }

STDMETHODIMP_() [2/2]

CMruPidlList::STDMETHODIMP_ ( ULONG  )

inlineoverride

Definition at line 993 of file mrulist.cpp.

    {
        return CMruBase::Release();
    }

UsePidl()

STDMETHODIMP CMruPidlList::UsePidl ( LPCITEMIDLIST  pidl, UINT *  pnNodeSlot  )

override

Definition at line 1125 of file mrulist.cpp.

{
    TRACE("%p -> %p %p\n", this, pidl, pnNodeSlot);
 
    CSafeMutex mutex;
    HRESULT hr = mutex.Enter(m_hMutex);
    if (FAILED(hr))
    {
        ERR("0x%08lX\n", hr);
        return hr;
    }
 
    *pnNodeSlot = 0;
 
    CMruNode *pNode;
    hr = GetNode(TRUE, pidl, &pNode);
    if (FAILED(hr))
    {
        ERR("0x%08lX\n", hr);
        return hr;
    }
 
    hr = pNode->GetNodeSlot(pnNodeSlot);
    if (FAILED(hr))
    {
        hr = GetEmptySlot(pnNodeSlot);
        if (SUCCEEDED(hr))
        {
            hr = pNode->SetNodeSlot(*pnNodeSlot);
        }
    }
 
    pNode->Release();
    return hr;
}

Member Data Documentation

m_cMaxNodeSlots

DWORD CMruPidlList::m_cMaxNodeSlots = 0

protected

Definition at line 973 of file mrulist.cpp.

Referenced by _LoadNodeSlots(), _SaveNodeSlots(), and GetEmptySlot().

m_hMutex

HANDLE CMruPidlList::m_hMutex = NULL

protected

Definition at line 974 of file mrulist.cpp.

Referenced by InitList(), PruneKids(), QueryPidl(), UsePidl(), and ~CMruPidlList().

m_pbNodeSlots

LPBYTE CMruPidlList::m_pbNodeSlots = NULL

protected

Definition at line 972 of file mrulist.cpp.

Referenced by _InitNodeSlots(), _LoadNodeSlots(), _SaveNodeSlots(), EmptyNodeSlot(), GetEmptySlot(), and ~CMruPidlList().

---

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

• dll/win32/shdocvw/mrulist.cpp