CMruBase Class Reference

Inheritance diagram for CMruBase:

Collaboration diagram for CMruBase:

Public Member Functions
	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

Static Public Member Functions
static void *	operator new (size_t size)
static void	operator delete (void *ptr)

Protected Member Functions
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
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

Detailed Description

Definition at line 91 of file mrulist.cpp.

Constructor & Destructor Documentation

CMruBase()

CMruBase::CMruBase

(

)

Definition at line 156 of file mrulist.cpp.

{
    ::InterlockedIncrement(&SHDOCVW_refCount);
}

~CMruBase()

CMruBase::~CMruBase ( )

virtual

Definition at line 161 of file mrulist.cpp.

{
    if (m_hKey)
    {
        ::RegCloseKey(m_hKey);
        m_hKey = NULL;
    }
 
    if (m_pSlots)
    {
        for (UINT iSlot = 0; iSlot < m_cSlots; ++iSlot)
        {
            m_pSlots[iSlot].pvData = ::LocalFree(m_pSlots[iSlot].pvData);
        }
 
        m_pSlots = (SLOTITEMDATA*)::LocalFree(m_pSlots);
    }
 
    ::InterlockedDecrement(&SHDOCVW_refCount);
}

Member Function Documentation

_AddItem()

HRESULT CMruBase::_AddItem ( UINT  iSlot, LPCVOID  pvData, DWORD  cbData  )

protected

Definition at line 274 of file mrulist.cpp.

{
    SLOTITEMDATA *pItem = &m_pSlots[iSlot];
 
    WCHAR szBuff[12];
    _SlotString(iSlot, szBuff, _countof(szBuff));
 
    if (SHSetValueW(m_hKey, NULL, szBuff, REG_BINARY, pvData, cbData) != ERROR_SUCCESS)
        return E_OUTOFMEMORY;
 
    if (cbData >= pItem->cbData || !pItem->pvData)
    {
        ::LocalFree(pItem->pvData);
        pItem->pvData = ::LocalAlloc(LPTR, cbData);
    }
 
    if (!pItem->pvData)
        return E_FAIL;
 
    pItem->cbData = cbData;
    pItem->dwFlags = (SLOT_LOADED | SLOT_SET);
    CopyMemory(pItem->pvData, pvData, cbData);
    return S_OK;
}

Referenced by CMruNode::_AddPidl(), CMruLongList::_ImportShortList(), and AddData().

_CheckUsedSlots()

void CMruBase::_CheckUsedSlots ( )

protected

Definition at line 265 of file mrulist.cpp.

{
    UINT iGotSlot;
    for (UINT iSlot = 0; iSlot < m_cSlots; ++iSlot)
        _GetSlot(iSlot, &iGotSlot);
 
    m_bChecked = TRUE;
}

Referenced by _UseEmptySlot().

_DeleteItem()

void CMruBase::_DeleteItem ( UINT  iSlot )

protected

Definition at line 255 of file mrulist.cpp.

{
    WCHAR szBuff[12];
 
    _SlotString(iSlot, szBuff, _countof(szBuff));
    _DeleteValue(szBuff);
 
    m_pSlots[iSlot].pvData = ::LocalFree(m_pSlots[iSlot].pvData);
}

Referenced by CMruLongList::_ImportShortList(), and Delete().

_DeleteValue()

DWORD CMruBase::_DeleteValue ( LPCWSTR  pszValue )

virtual

Reimplemented in CMruNode.

Definition at line 439 of file mrulist.cpp.

{
    return SHDeleteValueW(m_hKey, NULL, pszValue);
}

Referenced by _DeleteItem(), and CMruNode::_DeleteValue().

_GetItem()

HRESULT CMruBase::_GetItem ( UINT  iSlot, SLOTITEMDATA **  ppItem  )

protected

Definition at line 247 of file mrulist.cpp.

{
    HRESULT hr = _GetSlot(iSlot, &iSlot);
    if (FAILED(hr))
        return hr;
    return _GetSlotItem(iSlot, ppItem);
}

Referenced by FindData(), and GetData().

_GetSlot()

virtual HRESULT CMruBase::_GetSlot ( UINT  iSlot, UINT *  puSlot  )

pure virtual

Implemented in CMruShortList, and CMruLongList.

Referenced by _CheckUsedSlots(), _GetItem(), and QueryInfo().

_GetSlotItem()

HRESULT CMruBase::_GetSlotItem ( UINT  iSlot, SLOTITEMDATA **  ppItem  )

protected

Definition at line 234 of file mrulist.cpp.

{
    if (!(m_pSlots[iSlot].dwFlags & SLOT_LOADED))
        _LoadItem(iSlot);
 
    SLOTITEMDATA *pItem = &m_pSlots[iSlot];
    if (!pItem->pvData)
        return E_OUTOFMEMORY;
 
    *ppItem = pItem;
    return S_OK;
}

Referenced by _GetItem(), CMruLongList::_ImportShortList(), CMruNode::BindToSlot(), and QueryInfo().

_InitSlots()

virtual HRESULT CMruBase::_InitSlots ( )

pure virtual

Implemented in CMruShortList, and CMruLongList.

Referenced by InitData().

_IsEqual()

BOOL CMruBase::_IsEqual ( const SLOTITEMDATA *  pItem, LPCVOID  pvData, UINT  cbData  ) const

virtual

Definition at line 412 of file mrulist.cpp.

{
    if (m_fnCompare)
        return m_fnCompare(pvData, pItem->pvData, cbData) == 0;
 
    switch (m_dwFlags & COMPARE_BY_MASK)
    {
        case COMPARE_BY_MEMCMP:
            if (pItem->cbData != cbData)
                return FALSE;
            return memcmp(pvData, pItem->pvData, cbData) == 0;
 
        case COMPARE_BY_STRCMPIW:
            return StrCmpIW((LPCWSTR)pvData, (LPCWSTR)pItem->pvData) == 0;
 
        case COMPARE_BY_STRCMPW:
            return StrCmpW((LPCWSTR)pvData, (LPCWSTR)pItem->pvData) == 0;
 
        case COMPARE_BY_IEILISEQUAL:
            return IEILIsEqual((LPCITEMIDLIST)pvData, (LPCITEMIDLIST)pItem->pvData, FALSE);
 
        default:
            ERR("0x%08X\n", m_dwFlags);
            return FALSE;
    }
}

Referenced by FindData().

_LoadItem()

HRESULT CMruBase::_LoadItem ( UINT  iSlot )

protected

Definition at line 207 of file mrulist.cpp.

{
    DWORD cbData;
    WCHAR szValue[12];
 
    SLOTITEMDATA *pItem = &m_pSlots[iSlot];
    _SlotString(iSlot, szValue, _countof(szValue));
 
    if (SHGetValueW(m_hKey, NULL, szValue, NULL, NULL, &cbData) == ERROR_SUCCESS &&
        cbData > 0)
    {
        pItem->pvData = ::LocalAlloc(LPTR, cbData);
        if (pItem->pvData)
        {
            pItem->cbData = cbData;
            if (SHGetValueW(m_hKey, NULL, szValue, NULL, pItem->pvData, &cbData) != ERROR_SUCCESS)
                pItem->pvData = ::LocalFree(pItem->pvData);
        }
    }
 
    pItem->dwFlags |= SLOT_LOADED;
    if (!pItem->pvData)
        return E_FAIL;
 
    return S_OK;
}

Referenced by _GetSlotItem().

_RemoveSlot()

virtual HRESULT CMruBase::_RemoveSlot ( UINT  iSlot, UINT *  puSlot  )

pure virtual

Implemented in CMruShortList, and CMruLongList.

Referenced by Delete().

_SaveSlots()

virtual void CMruBase::_SaveSlots ( )

pure virtual

Implemented in CMruShortList, and CMruLongList.

Referenced by STDMETHODIMP_().

_SlotString()

virtual void CMruBase::_SlotString ( UINT  iSlot, LPWSTR  psz, DWORD  cch  )

pure virtual

Implemented in CMruShortList, and CMruLongList.

Referenced by _AddItem(), _DeleteItem(), and _LoadItem().

_UpdateSlots()

virtual UINT CMruBase::_UpdateSlots ( UINT  iSlot )

pure virtual

Implemented in CMruShortList, and CMruLongList.

Referenced by AddData().

_UseEmptySlot()

HRESULT CMruBase::_UseEmptySlot ( UINT *  piSlot )

protected

Definition at line 444 of file mrulist.cpp.

{
    if (!m_bChecked)
        _CheckUsedSlots();
 
    if (!m_cSlotRooms)
        return E_FAIL;
 
    UINT iSlot = 0;
    for (SLOTITEMDATA *pItem = m_pSlots; (pItem->dwFlags & SLOT_SET); ++pItem)
    {
        if (++iSlot >= m_cSlotRooms)
            return E_FAIL;
    }
 
    m_pSlots[iSlot].dwFlags |= SLOT_SET;
    *piSlot = iSlot;
    ++m_cSlots;
 
    return S_OK;
}

Referenced by CMruShortList::_UpdateSlots(), and CMruLongList::_UpdateSlots().

AddData()

STDMETHODIMP CMruBase::AddData ( LPCVOID  pvData, DWORD  cbData, UINT *  piSlot  )

override

Definition at line 326 of file mrulist.cpp.

{
    UINT iSlot;
    HRESULT hr = FindData(pvData, cbData, &iSlot);
    if (FAILED(hr))
    {
        iSlot = _UpdateSlots(m_cSlots);
        hr = _AddItem(iSlot, pvData, cbData);
        if (FAILED(hr))
            return hr;
    }
    else
    {
        iSlot = _UpdateSlots(iSlot);
        hr = S_OK;
    }
 
    if (piSlot)
        *piSlot = iSlot;
 
    return hr;
}

Delete()

STDMETHODIMP CMruBase::Delete ( UINT  iSlot )

override

Definition at line 401 of file mrulist.cpp.

{
    UINT uSlot;
    HRESULT hr = _RemoveSlot(iSlot, &uSlot);
    if (FAILED(hr))
        return hr;
 
    _DeleteItem(uSlot);
    return hr;
}

Referenced by CMruNode::Clear(), and CMruNode::RemoveLeast().

FindData()

STDMETHODIMP CMruBase::FindData ( LPCVOID  pvData, DWORD  cbData, UINT *  piSlot  )

override

Definition at line 349 of file mrulist.cpp.

{
    if (m_cSlots <= 0)
        return E_FAIL;
 
    UINT iSlot = 0;
    SLOTITEMDATA *pItem;
    while (FAILED(_GetItem(iSlot, &pItem)) || !_IsEqual(pItem, pvData, cbData))
    {
        if (++iSlot >= m_cSlots)
            return E_FAIL;
    }
 
    *piSlot = iSlot;
    return S_OK;
}

Referenced by CMruNode::_FindPidl(), and AddData().

GetData()

STDMETHODIMP CMruBase::GetData ( UINT  iSlot, LPVOID  pvData, DWORD  cbData  )

override

Definition at line 366 of file mrulist.cpp.

{
    SLOTITEMDATA *pItem;
    HRESULT hr = _GetItem(iSlot, &pItem);
    if (FAILED(hr))
        return hr;
 
    if (cbData < pItem->cbData)
        return HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER);
 
    CopyMemory(pvData, pItem->pvData, pItem->cbData);
    return hr;
}

InitData()

STDMETHODIMP CMruBase::InitData ( UINT  cCapacity, UINT  flags, HKEY  hKey, LPCWSTR pszSubKey  OPTIONAL, SLOTCOMPARE fnCompare  OPTIONAL  )

override

Definition at line 300 of file mrulist.cpp.

{
    m_dwFlags = flags;
    m_fnCompare = fnCompare;
    m_cSlotRooms = cCapacity;
 
    if (pszSubKey)
        ::RegCreateKeyExWrapW(hKey, pszSubKey, 0, NULL, 0, MAXIMUM_ALLOWED, NULL, &m_hKey, NULL);
    else
        m_hKey = SHRegDuplicateHKey(hKey);
 
    if (!m_hKey)
        return E_FAIL;
 
    m_pSlots = (SLOTITEMDATA*)::LocalAlloc(LPTR, m_cSlotRooms * sizeof(SLOTITEMDATA));
    if (!m_pSlots)
        return E_OUTOFMEMORY;
 
    return _InitSlots();
}

Referenced by CMruNode::_CreateNode(), CMruLongList::_ImportShortList(), and CMruPidlList::InitList().

operator delete()

static void CMruBase::operator delete ( void *  ptr )

inlinestatic

Definition at line 150 of file mrulist.cpp.

    {
        ::LocalFree(ptr);
    }

operator new()

static void * CMruBase::operator new ( size_t  size )

inlinestatic

Definition at line 146 of file mrulist.cpp.

    {
        return ::LocalAlloc(LPTR, size);
    }

QueryInfo()

STDMETHODIMP CMruBase::QueryInfo ( UINT  iSlot, UINT *  piGotSlot, DWORD *  pcbData  )

override

Definition at line 380 of file mrulist.cpp.

{
    UINT iGotSlot;
    HRESULT hr = _GetSlot(iSlot, &iGotSlot);
    if (FAILED(hr))
        return hr;
 
    if (piGotSlot)
        *piGotSlot = iGotSlot;
 
    if (pcbData)
    {
        SLOTITEMDATA *pItem;
        hr = _GetSlotItem(iGotSlot, &pItem);
        if (SUCCEEDED(hr))
            *pcbData = pItem->cbData;
    }
 
    return hr;
}

QueryInterface()

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

override

Definition at line 182 of file mrulist.cpp.

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

STDMETHODIMP_() [1/2]

CMruBase::STDMETHODIMP_ ( ULONG  )

inlineoverride

Definition at line 120 of file mrulist.cpp.

    {
        return ::InterlockedIncrement(&m_cRefs);
    }

STDMETHODIMP_() [2/2]

CMruBase::STDMETHODIMP_ ( ULONG  )

override

Member Data Documentation

m_bChecked

BOOL CMruBase::m_bChecked = FALSE

protected

Definition at line 98 of file mrulist.cpp.

Referenced by _CheckUsedSlots(), and _UseEmptySlot().

m_bNeedSave

BOOL CMruBase::m_bNeedSave = FALSE

protected

Definition at line 97 of file mrulist.cpp.

Referenced by CMruLongList::_ImportShortList(), CMruPidlList::_InitNodeSlots(), CMruShortList::_RemoveSlot(), CMruLongList::_RemoveSlot(), CMruShortList::_SaveSlots(), CMruLongList::_SaveSlots(), CMruShortList::_UpdateSlots(), CMruLongList::_UpdateSlots(), and CMruPidlList::EmptyNodeSlot().

m_cRefs

LONG CMruBase::m_cRefs = 1

protected

Definition at line 95 of file mrulist.cpp.

Referenced by STDMETHODIMP_(), and STDMETHODIMP_().

m_cSlotRooms

DWORD CMruBase::m_cSlotRooms = 0

protected

Definition at line 100 of file mrulist.cpp.

Referenced by CMruNode::_CreateNode(), CMruShortList::_GetSlot(), CMruLongList::_GetSlot(), CMruLongList::_ImportShortList(), CMruPidlList::_InitNodeSlots(), CMruShortList::_InitSlots(), CMruLongList::_InitSlots(), CMruPidlList::_LoadNodeSlots(), _UseEmptySlot(), CMruPidlList::GetEmptySlot(), and InitData().

m_cSlots

DWORD CMruBase::m_cSlots = 0

protected

Definition at line 101 of file mrulist.cpp.

Referenced by _CheckUsedSlots(), CMruNode::_GetPidlSlot(), CMruShortList::_GetSlot(), CMruLongList::_GetSlot(), CMruLongList::_ImportShortList(), CMruShortList::_InitSlots(), CMruLongList::_InitSlots(), CMruShortList::_RemoveSlot(), CMruLongList::_RemoveSlot(), CMruShortList::_SaveSlots(), CMruLongList::_SaveSlots(), CMruShortList::_UpdateSlots(), CMruLongList::_UpdateSlots(), _UseEmptySlot(), AddData(), FindData(), CMruNode::RemoveLeast(), and ~CMruBase().

m_dwFlags

DWORD CMruBase::m_dwFlags = 0

protected

Definition at line 96 of file mrulist.cpp.

Referenced by _IsEqual(), and InitData().

m_fnCompare

SLOTCOMPARE CMruBase::m_fnCompare = NULL

protected

Definition at line 102 of file mrulist.cpp.

Referenced by _IsEqual(), and InitData().

m_hKey

HKEY CMruBase::m_hKey = NULL

protected

Definition at line 99 of file mrulist.cpp.

Referenced by _AddItem(), CMruNode::_CreateNode(), _DeleteValue(), CMruNode::_DeleteValue(), CMruLongList::_ImportShortList(), CMruShortList::_InitSlots(), CMruLongList::_InitSlots(), _LoadItem(), CMruPidlList::_LoadNodeSlots(), CMruPidlList::_SaveNodeSlots(), CMruShortList::_SaveSlots(), CMruLongList::_SaveSlots(), CMruNode::GetNodeSlot(), InitData(), CMruNode::SetNodeSlot(), and ~CMruBase().

m_pSlots

SLOTITEMDATA* CMruBase::m_pSlots = NULL

protected

Definition at line 103 of file mrulist.cpp.

Referenced by _AddItem(), _DeleteItem(), CMruShortList::_GetSlot(), CMruLongList::_GetSlot(), _GetSlotItem(), _LoadItem(), CMruShortList::_RemoveSlot(), CMruLongList::_RemoveSlot(), _UseEmptySlot(), InitData(), and ~CMruBase().

---

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

• dll/win32/shdocvw/mrulist.cpp