CTravelLog Class Reference

Inheritance diagram for CTravelLog:

Collaboration diagram for CTravelLog:

Public Member Functions
	CTravelLog ()
	~CTravelLog ()
HRESULT	Initialize ()
HRESULT	FindRelativeEntry (int offset, CTravelEntry **foundEntry)
void	DeleteChain (CTravelEntry *startHere)
void	AppendEntry (CTravelEntry *afterEntry, CTravelEntry *newEntry)
virtual HRESULT STDMETHODCALLTYPE	AddEntry (IUnknown *punk, BOOL fIsLocalAnchor)
virtual HRESULT STDMETHODCALLTYPE	UpdateEntry (IUnknown *punk, BOOL fIsLocalAnchor)
virtual HRESULT STDMETHODCALLTYPE	UpdateExternal (IUnknown *punk, IUnknown *punkHLBrowseContext)
virtual HRESULT STDMETHODCALLTYPE	Travel (IUnknown *punk, int iOffset)
virtual HRESULT STDMETHODCALLTYPE	GetTravelEntry (IUnknown *punk, int iOffset, ITravelEntry **ppte)
virtual HRESULT STDMETHODCALLTYPE	FindTravelEntry (IUnknown *punk, LPCITEMIDLIST pidl, ITravelEntry **ppte)
virtual HRESULT STDMETHODCALLTYPE	GetToolTipText (IUnknown *punk, int iOffset, int idsTemplate, LPWSTR pwzText, DWORD cchText)
virtual HRESULT STDMETHODCALLTYPE	InsertMenuEntries (IUnknown *punk, HMENU hmenu, int nPos, int idFirst, int idLast, DWORD dwFlags)
virtual HRESULT STDMETHODCALLTYPE	Clone (ITravelLog **pptl)
virtual DWORD STDMETHODCALLTYPE	CountEntries (IUnknown *punk)
virtual HRESULT STDMETHODCALLTYPE	Revert ()
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 ITravelLog
HRESULT	AddEntry ([in] IUnknown *punk, [in] BOOL fIsLocalAnchor)
HRESULT	UpdateEntry ([in] IUnknown *punk, [in] BOOL fIsLocalAnchor)
HRESULT	UpdateExternal ([in] IUnknown *punk, [in] IUnknown *punkHLBrowseContext)
HRESULT	Travel ([in] IUnknown *punk, [in] int iOffset)
HRESULT	GetTravelEntry ([in] IUnknown *punk, [in] int iOffset, [optional, out] ITravelEntry **ppte)
HRESULT	FindTravelEntry ([in] IUnknown *punk, [in] PCIDLIST_ABSOLUTE pidl, [out] ITravelEntry **ppte)
HRESULT	GetToolTipText ([in] IUnknown *punk, [in] int iOffset, [in] int idsTemplate, [out, size_is(cchText)] LPWSTR pwzText, [in] DWORD cchText)
HRESULT	InsertMenuEntries ([in] IUnknown *punk, [in] HMENU hmenu, [in] int nPos, [in] int idFirst, [in] int idLast, [in] DWORD dwFlags)
HRESULT	Clone ([out] ITravelLog **pptl)
DWORD	CountEntries ([in] IUnknown *punk)
HRESULT	Revert ()
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Private Attributes
CTravelEntry *	fListHead
CTravelEntry *	fListTail
CTravelEntry *	fCurrentEntry
long	fMaximumSize
long	fCurrentSize
unsigned long	fEntryCount

Additional Inherited Members
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
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)
Public Attributes inherited from ATL::CComObjectRootBase
LONG	m_dwRef

Detailed Description

Definition at line 72 of file travellog.cpp.

Constructor & Destructor Documentation

CTravelLog()

CTravelLog::CTravelLog

(

)

Definition at line 220 of file travellog.cpp.

{
    fListHead = NULL;
    fListTail = NULL;
    fCurrentEntry = NULL;
    fMaximumSize = 0;
    fCurrentSize = 0;
    fEntryCount = 0;
    TRACE("CTravelLog created\n");
}

~CTravelLog()

CTravelLog::~CTravelLog

(

)

Definition at line 231 of file travellog.cpp.

{
    CTravelEntry                            *anEntry;
    CTravelEntry                            *next;
 
    anEntry = fListHead;
    while (anEntry != NULL)
    {
        next = anEntry->fNextEntry;
        anEntry->Release();
        anEntry = next;
    }
    TRACE("CTravelLog destroyed\n");
}

Member Function Documentation

AddEntry()

HRESULT STDMETHODCALLTYPE CTravelLog::AddEntry ( IUnknown *  punk, BOOL  fIsLocalAnchor  )

virtual

Implements ITravelLog.

Definition at line 344 of file travellog.cpp.

{
    CComObject<CTravelEntry>                *newEntry;
    long                                    itemSize;
 
    TRACE("CTravelLog::AddEntry for IUnknown punk=%p, fIsLocalAnchor=%s\n", punk, fIsLocalAnchor ? "TRUE" : "FALSE");
 
    if (punk == NULL)
        return E_INVALIDARG;
    ATLTRY (newEntry = new CComObject<CTravelEntry>);
    if (newEntry == NULL)
        return E_OUTOFMEMORY;
    newEntry->AddRef();
    if (fCurrentEntry != NULL && fCurrentEntry->fNextEntry != NULL)
        DeleteChain(fCurrentEntry->fNextEntry);
    AppendEntry(fCurrentEntry, newEntry);
    itemSize = newEntry->GetSize();
    fCurrentSize += itemSize;
    fCurrentEntry = newEntry;
    return S_OK;
}

AppendEntry()

void CTravelLog::AppendEntry	(	CTravelEntry *	afterEntry,
		CTravelEntry *	newEntry
	)

Definition at line 322 of file travellog.cpp.

{
    if (afterEntry == NULL)
    {
        TRACE("CTravelLog::AppendEntry appending %p after NULL. Resetting head and tail\n", newEntry);
        fListHead = newEntry;
        fListTail = newEntry;
    }
    else
    {
        TRACE("CTravelLog::AppendEntry appending %p after %p\n", newEntry, afterEntry);
        newEntry->fNextEntry = afterEntry->fNextEntry;
        afterEntry->fNextEntry = newEntry;
        newEntry->fPreviousEntry = afterEntry;
        if (newEntry->fNextEntry == NULL)
            fListTail = newEntry;
        else
            newEntry->fNextEntry->fPreviousEntry = newEntry;
    }
    fEntryCount++;
}

Referenced by AddEntry().

Clone()

HRESULT STDMETHODCALLTYPE CTravelLog::Clone ( ITravelLog **  pptl )

virtual

Implements ITravelLog.

Definition at line 602 of file travellog.cpp.

{
    if (pptl == NULL)
        return E_POINTER;
    *pptl = NULL;
    // duplicate the log
    UNIMPLEMENTED;
    return E_NOTIMPL;
}

CountEntries()

DWORD STDMETHODCALLTYPE CTravelLog::CountEntries ( IUnknown *  punk )

virtual

Implements ITravelLog.

Definition at line 612 of file travellog.cpp.

{
    if (punk == NULL)
        return E_INVALIDARG;
    return fEntryCount;
}

DeleteChain()

void CTravelLog::DeleteChain

(

CTravelEntry *

startHere

)

Definition at line 290 of file travellog.cpp.

{
    CTravelEntry                            *saveNext;
    long                                    itemSize;
 
    TRACE("CTravelLog::DeleteChain deleting chain starting at %p\n", startHere);
 
    long startEntryCount = fEntryCount;
 
    if (startHere->fPreviousEntry != NULL)
    {
        startHere->fPreviousEntry->fNextEntry = NULL;
        fListTail = startHere->fPreviousEntry;
    }
    else
    {
        fListHead = NULL;
        fListTail = NULL;
    }
    while (startHere != NULL)
    {
        saveNext = startHere->fNextEntry;
        itemSize = startHere->GetSize();
        fCurrentSize -= itemSize;
        startHere->Release();
        startHere = saveNext;
        fEntryCount--;
    }
 
    TRACE("CTravelLog::DeleteChain chain of %d items deleted\n", startEntryCount - fEntryCount);
}

Referenced by AddEntry().

FindRelativeEntry()

HRESULT CTravelLog::FindRelativeEntry	(	int	offset,
		CTravelEntry **	foundEntry
	)

Definition at line 254 of file travellog.cpp.

{
    CTravelEntry                            *curEntry;
    int offset = _offset;
 
    if (foundEntry == NULL)
        return E_INVALIDARG;
 
    *foundEntry = NULL;
    curEntry = fCurrentEntry;
    if (offset < 0)
    {
        while (offset < 0 && curEntry != NULL)
        {
            curEntry = curEntry->fPreviousEntry;
            offset++;
        }
    }
    else
    {
        while (offset > 0 && curEntry != NULL)
        {
            curEntry = curEntry->fNextEntry;
            offset--;
        }
    }
    if (curEntry == NULL)
        return E_INVALIDARG;
 
    *foundEntry = curEntry;
 
    TRACE("CTravelLog::FindRelativeEntry for offset %d, returning %p\n", offset, *foundEntry);
 
    return S_OK;
}

Referenced by GetToolTipText(), GetTravelEntry(), and Travel().

FindTravelEntry()

HRESULT STDMETHODCALLTYPE CTravelLog::FindTravelEntry ( IUnknown *  punk, LPCITEMIDLIST  pidl, ITravelEntry **  ppte  )

virtual

Definition at line 414 of file travellog.cpp.

{
    if (ppte == NULL)
        return E_POINTER;
    if (punk == NULL || pidl == NULL)
        return E_INVALIDARG;
 
    UNIMPLEMENTED;
 
    return E_NOTIMPL;
}

GetToolTipText()

HRESULT STDMETHODCALLTYPE CTravelLog::GetToolTipText ( IUnknown *  punk, int  iOffset, int  idsTemplate, LPWSTR  pwzText, DWORD  cchText  )

virtual

Implements ITravelLog.

Definition at line 426 of file travellog.cpp.

{
    CTravelEntry                            *destinationEntry;
    wchar_t                                 tempString[MAX_PATH];
    wchar_t                                 templateString[200];
    HRESULT                                 hResult;
 
    if (pwzText == NULL)
        return E_POINTER;
    if (punk == NULL || cchText == 0)
        return E_INVALIDARG;
    hResult = FindRelativeEntry(iOffset, &destinationEntry);
    if (FAILED_UNEXPECTEDLY(hResult))
        return hResult;
    hResult = destinationEntry->GetToolTipText(punk, tempString);
    if (FAILED_UNEXPECTEDLY(hResult))
        return hResult;
    if (iOffset < 0)
    {
        if(LoadStringW(_AtlBaseModule.GetResourceInstance(),
                            IDS_BACK, templateString, sizeof(templateString) / sizeof(wchar_t)) == 0)
            return HRESULT_FROM_WIN32(GetLastError());
    }
    else
    {
        if(LoadStringW(_AtlBaseModule.GetResourceInstance(),
                            IDS_FORWARD, templateString, sizeof(templateString) / sizeof(wchar_t)) == 0)
            return HRESULT_FROM_WIN32(GetLastError());
    }
    _snwprintf(pwzText, cchText, templateString, tempString);
 
    TRACE("CTravelLog::GetToolTipText for IUnknown punk=%p at offset=%d returning L\"%S\"\n", punk, iOffset, pwzText);
 
    return S_OK;
}

GetTravelEntry()

HRESULT STDMETHODCALLTYPE CTravelLog::GetTravelEntry ( IUnknown *  punk, int  iOffset, ITravelEntry **  ppte  )

virtual

Implements ITravelLog.

Definition at line 397 of file travellog.cpp.

{
    CTravelEntry                            *destinationEntry;
    HRESULT                                 hResult;
 
    hResult = FindRelativeEntry(iOffset, &destinationEntry);
    if (FAILED(hResult))
        return hResult;
    hResult = destinationEntry->QueryInterface(IID_PPV_ARG(ITravelEntry, ppte));
    if (FAILED_UNEXPECTEDLY(hResult))
        return hResult;
 
    TRACE("CTravelLog::GetTravelEntry for IUnknown punk=%p at offset=%d returning %p\n", punk, iOffset, *ppte);
 
    return hResult;
}

Initialize()

HRESULT CTravelLog::Initialize

(

)

Definition at line 246 of file travellog.cpp.

{
    fMaximumSize = 1024 * 1024;         // TODO: change to read this from registry
    // Software\Microsoft\Windows\CurrentVersion\Explorer\TravelLog
    // MaxSize
    return S_OK;
}

InsertMenuEntries()

HRESULT STDMETHODCALLTYPE CTravelLog::InsertMenuEntries ( IUnknown *  punk, HMENU  hmenu, int  nPos, int  idFirst, int  idLast, DWORD  dwFlags  )

virtual

Implements ITravelLog.

Definition at line 482 of file travellog.cpp.

{
    CTravelEntry                            *currentItem;
    MENUITEMINFO                            menuItemInfo;
    wchar_t                                 itemTextBuffer[MAX_PATH * 2];
    HRESULT                                 hResult;
 
    TRACE("CTravelLog::InsertMenuEntries for IUnknown punk=%p, nPos=%d, idFirst=%d, idLast=%d\n", punk);
 
    // TLMENUF_BACK - include back entries
    // TLMENUF_INCLUDECURRENT - include current entry, if TLMENUF_CHECKCURRENT then check the entry
    // TLMENUF_FORE - include next entries
    // if fore+back, list from oldest to newest
    // if back, list from newest to oldest
    // if fore, list from newest to oldest
 
    // don't forget to patch ampersands before adding to menu
    if (punk == NULL)
        return E_INVALIDARG;
    if (idLast <= idFirst)
        return E_INVALIDARG;
    menuItemInfo.cbSize = sizeof(menuItemInfo);
    menuItemInfo.fMask = MIIM_FTYPE | MIIM_ID | MIIM_STATE | MIIM_STRING;
    menuItemInfo.fType = MFT_STRING;
    menuItemInfo.wID = idFirst;
    menuItemInfo.fState = MFS_ENABLED;
    menuItemInfo.dwTypeData = itemTextBuffer;
    if ((dwFlags & TLMENUF_BACK) != 0)
    {
        if ((dwFlags & TLMENUF_FORE) != 0)
        {
            currentItem = fCurrentEntry;
            if (currentItem != NULL)
            {
                while (currentItem->fPreviousEntry != NULL)
                    currentItem = currentItem->fPreviousEntry;
            }
            while (currentItem != fCurrentEntry)
            {
                hResult = currentItem->GetToolTipText(punk, itemTextBuffer);
                if (SUCCEEDED(hResult))
                {
                    FixAmpersands(itemTextBuffer);
                    TRACE("CTravelLog::InsertMenuEntries adding entry L\"%S\"/L\"%S\" with id %d\n", itemTextBuffer, menuItemInfo.dwTypeData, menuItemInfo.wID);
                    if (InsertMenuItem(hmenu, nPos, TRUE, &menuItemInfo))
                    {
                        nPos++;
                        menuItemInfo.wID++;
                    }
                }
                currentItem = currentItem->fNextEntry;
            }
        }
        else
        {
            currentItem = fCurrentEntry;
            if (currentItem != NULL)
                currentItem = currentItem->fPreviousEntry;
            while (currentItem != NULL)
            {
                hResult = currentItem->GetToolTipText(punk, itemTextBuffer);
                if (SUCCEEDED(hResult))
                {
                    FixAmpersands(itemTextBuffer);
                    TRACE("CTravelLog::InsertMenuEntries adding entry L\"%S\"/L\"%S\" with id %d\n", itemTextBuffer, menuItemInfo.dwTypeData, menuItemInfo.wID);
                    if (InsertMenuItem(hmenu, nPos, TRUE, &menuItemInfo))
                    {
                        nPos++;
                        menuItemInfo.wID++;
                    }
                }
                currentItem = currentItem->fPreviousEntry;
            }
        }
    }
    if ((dwFlags & TLMENUF_INCLUDECURRENT) != 0)
    {
        if (fCurrentEntry != NULL)
        {
            hResult = fCurrentEntry->GetToolTipText(punk, itemTextBuffer);
            if (SUCCEEDED(hResult))
            {
                FixAmpersands(itemTextBuffer);
                if ((dwFlags & TLMENUF_CHECKCURRENT) != 0)
                    menuItemInfo.fState |= MFS_CHECKED;
                TRACE("CTravelLog::InsertMenuEntries adding entry L\"%S\"/L\"%S\" with id %d\n", itemTextBuffer, menuItemInfo.dwTypeData, menuItemInfo.wID);
                if (InsertMenuItem(hmenu, nPos, TRUE, &menuItemInfo))
                {
                    nPos++;
                    menuItemInfo.wID++;
                }
                menuItemInfo.fState &= ~MFS_CHECKED;
            }
        }
    }
    if ((dwFlags & TLMENUF_FORE) != 0)
    {
        currentItem = fCurrentEntry;
        if (currentItem != NULL)
            currentItem = currentItem->fNextEntry;
        while (currentItem != NULL)
        {
            hResult = currentItem->GetToolTipText(punk, itemTextBuffer);
            if (SUCCEEDED(hResult))
            {
                FixAmpersands(itemTextBuffer);
                TRACE("CTravelLog::InsertMenuEntries adding entry L\"%S\"/L\"%S\" with id %d\n", itemTextBuffer, menuItemInfo.dwTypeData, menuItemInfo.wID);
                if (InsertMenuItem(hmenu, nPos, TRUE, &menuItemInfo))
                {
                    nPos++;
                    menuItemInfo.wID++;
                }
            }
            currentItem = currentItem->fNextEntry;
        }
    }
    return S_OK;
}

Revert()

HRESULT STDMETHODCALLTYPE CTravelLog::Revert ( )

virtual

Implements ITravelLog.

Definition at line 619 of file travellog.cpp.

{
    // remove the current entry?
    UNIMPLEMENTED;
    return E_NOTIMPL;
}

Travel()

HRESULT STDMETHODCALLTYPE CTravelLog::Travel ( IUnknown *  punk, int  iOffset  )

virtual

Implements ITravelLog.

Definition at line 380 of file travellog.cpp.

{
    CTravelEntry                            *destinationEntry;
    HRESULT                                 hResult;
 
    TRACE("CTravelLog::Travel for IUnknown punk=%p at offset=%d\n", punk, iOffset);
 
    hResult = FindRelativeEntry(iOffset, &destinationEntry);
    if (FAILED_UNEXPECTEDLY(hResult))
        return hResult;
    fCurrentEntry = destinationEntry;
    hResult = destinationEntry->Invoke(punk);
    if (FAILED_UNEXPECTEDLY(hResult))
        return hResult;
    return S_OK;
}

UpdateEntry()

HRESULT STDMETHODCALLTYPE CTravelLog::UpdateEntry ( IUnknown *  punk, BOOL  fIsLocalAnchor  )

virtual

Implements ITravelLog.

Definition at line 366 of file travellog.cpp.

{
    if (punk == NULL)
        return E_INVALIDARG;
    if (fCurrentEntry == NULL)
        return E_UNEXPECTED;
    return fCurrentEntry->Update(punk, fIsLocalAnchor);
}

UpdateExternal()

HRESULT STDMETHODCALLTYPE CTravelLog::UpdateExternal ( IUnknown *  punk, IUnknown *  punkHLBrowseContext  )

virtual

Implements ITravelLog.

Definition at line 375 of file travellog.cpp.

{
    return E_NOTIMPL;
}

Member Data Documentation

fCurrentEntry

CTravelEntry* CTravelLog::fCurrentEntry

private

Definition at line 79 of file travellog.cpp.

Referenced by AddEntry(), CTravelLog(), FindRelativeEntry(), InsertMenuEntries(), Travel(), and UpdateEntry().

fCurrentSize

long CTravelLog::fCurrentSize

private

Definition at line 81 of file travellog.cpp.

Referenced by AddEntry(), CTravelLog(), and DeleteChain().

fEntryCount

unsigned long CTravelLog::fEntryCount

private

Definition at line 82 of file travellog.cpp.

Referenced by AppendEntry(), CountEntries(), CTravelLog(), and DeleteChain().

fListHead

CTravelEntry* CTravelLog::fListHead

private

Definition at line 77 of file travellog.cpp.

Referenced by AppendEntry(), CTravelLog(), DeleteChain(), and ~CTravelLog().

fListTail

CTravelEntry* CTravelLog::fListTail

private

Definition at line 78 of file travellog.cpp.

Referenced by AppendEntry(), CTravelLog(), and DeleteChain().

fMaximumSize

long CTravelLog::fMaximumSize

private

Definition at line 80 of file travellog.cpp.

Referenced by CTravelLog(), and Initialize().

---

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

• dll/win32/browseui/travellog.cpp