ATL::CAtlList< E, ETraits > Class Template Reference

#include <atlcoll.h>

Collaboration diagram for ATL::CAtlList< E, ETraits >:

Classes
class	CNode

Public Member Functions
	CAtlList (_In_ UINT nBlockSize=10)
	~CAtlList ()
size_t	GetCount () const
bool	IsEmpty () const
POSITION	GetHeadPosition () const
POSITION	GetTailPosition () const
E &	GetNext (_Inout_ POSITION &pos)
const E &	GetNext (_Inout_ POSITION &pos) const
E &	GetPrev (_Inout_ POSITION &pos)
const E &	GetPrev (_Inout_ POSITION &pos) const
E &	GetAt (_In_ POSITION pos)
const E &	GetAt (_In_ POSITION pos) const
POSITION	AddHead (INARGTYPE element)
POSITION	AddTail (INARGTYPE element)
E	RemoveHead ()
E	RemoveTail ()
void	RemoveAll ()
void	RemoveAt (_In_ POSITION pos)
POSITION	Find (INARGTYPE element, _In_opt_ POSITION posStartAfter=NULL) const
POSITION	FindIndex (_In_ size_t iElement) const

Private Types
typedef ETraits::INARGTYPE	INARGTYPE

Private Member Functions
	CAtlList (_In_ const CAtlList &)
CAtlList &	operator= (_In_ const CAtlList &)
CNode *	CreateNode (INARGTYPE element, _In_opt_ CNode *pPrev, _In_opt_ CNode *pNext)
void	FreeNode (_Inout_ CNode *pNode)
CNode *	GetFreeNode ()

Private Attributes
CAtlPlex *	m_Blocks
UINT	m_BlockSize
CNode *	m_HeadNode
CNode *	m_TailNode
CNode *	m_FreeNode
size_t	m_NumElements

Detailed Description

template<typename E, class ETraits = CElementTraits<E>>
class ATL::CAtlList< E, ETraits >

Definition at line 140 of file atlcoll.h.

Member Typedef Documentation

INARGTYPE

template<typename E, class ETraits = CElementTraits<E>>

typedef ETraits::INARGTYPE ATL::CAtlList< E, ETraits >::INARGTYPE

private

Definition at line 143 of file atlcoll.h.

Constructor & Destructor Documentation

CAtlList() [1/2]

template<typename E, class ETraits = CElementTraits<E>>

ATL::CAtlList< E, ETraits >::CAtlList ( _In_ const CAtlList< E, ETraits > &  )

private

CAtlList() [2/2]

template<typename E , class ETraits >

ATL::CAtlList< E, ETraits >::CAtlList

(

_In_ UINT

nBlockSize = 10

)

Definition at line 231 of file atlcoll.h.

                                                     :
    m_Blocks(NULL),
    m_BlockSize(nBlockSize),
    m_HeadNode(NULL),
    m_TailNode(NULL),
    m_FreeNode(NULL),
    m_NumElements(0)
{
    ATLASSERT(nBlockSize > 0);
}

~CAtlList()

template<typename E , class ETraits >

ATL::CAtlList< E, ETraits >::~CAtlList

(

void

)

Definition at line 243 of file atlcoll.h.

{
    RemoveAll();
}

Member Function Documentation

AddHead()

template<typename E , class ETraits >

POSITION ATL::CAtlList< E, ETraits >::AddHead

(

INARGTYPE

element

)

Definition at line 319 of file atlcoll.h.

{
    CNode* Node = CreateNode(element, NULL, m_HeadNode);
    if (m_HeadNode)
    {
        m_HeadNode->m_Prev = Node;
    }
    else
    {
        m_TailNode = Node;
    }
    m_HeadNode = Node;

    return (POSITION)Node;
}

AddTail()

template<typename E , class ETraits >

POSITION ATL::CAtlList< E, ETraits >::AddTail

(

INARGTYPE

element

)

Definition at line 336 of file atlcoll.h.

Referenced by CIconWatcher::AddIconToWatcher(), and ValidateItem().

{
    CNode* Node = CreateNode(element, m_TailNode, NULL);
    if (m_TailNode)
    {
        m_TailNode->m_Next = Node;
    }
    else
    {
        m_HeadNode = Node;
    }
    m_TailNode = Node;

    return (POSITION)Node;
}

CreateNode()

template<typename E , class ETraits >

CAtlList< E, ETraits >::CNode * ATL::CAtlList< E, ETraits >::CreateNode ( INARGTYPE  element, _In_opt_ CNode *  pPrev, _In_opt_ CNode *  pNext  )

private

Definition at line 486 of file atlcoll.h.

{
    GetFreeNode();

    CNode* NewNode = m_FreeNode;
    CNode* NextFree = m_FreeNode->m_Next;

    NewNode = new CNode(element);

    m_FreeNode = NextFree;
    NewNode->m_Prev = Prev;
    NewNode->m_Next = Next;
    m_NumElements++;

    return NewNode;
}

Find()

template<typename E , class ETraits >

POSITION ATL::CAtlList< E, ETraits >::Find	(	INARGTYPE	element,
		_In_opt_ POSITION	posStartAfter = NULL
	)		const

Definition at line 439 of file atlcoll.h.

Referenced by AddService(), and ValidateItem().

{
    CNode* Node = (CNode*)posStartAfter;
    if (Node == NULL)
    {
        Node = m_HeadNode;
    }
    else
    {
        Node = Node->m_Next;
    }

    for (; Node != NULL; Node = Node->m_Next)
    {
        if (ETraits::CompareElements(Node->m_Element, element))
            return (POSITION)Node;
    }

    return NULL;
}

FindIndex()

template<typename E , class ETraits >

POSITION ATL::CAtlList< E, ETraits >::FindIndex

(

_In_ size_t

iElement

)

const

Definition at line 463 of file atlcoll.h.

Referenced by CIconWatcher::Uninitialize(), and CIconWatcher::WatcherThread().

{
    if (iElement >= m_NumElements)
        return NULL;

    if (m_HeadNode == NULL)
        return NULL;

    CNode* Node = m_HeadNode;
    for (size_t i = 0; i < iElement; i++)
    {
        Node = Node->m_Next;
    }

    return (POSITION)Node;
}

FreeNode()

template<typename E , class ETraits >

void ATL::CAtlList< E, ETraits >::FreeNode ( _Inout_ CNode *  pNode )

private

Definition at line 508 of file atlcoll.h.

{
    pNode->~CNode();
    pNode->m_Next = m_FreeNode;
    m_FreeNode = pNode;

    m_NumElements--;
    if (m_NumElements == 0)
    {
        RemoveAll();
    }
}

GetAt() [1/2]

template<typename E , class ETraits >

E & ATL::CAtlList< E, ETraits >::GetAt ( _In_ POSITION  pos )

inline

Definition at line 305 of file atlcoll.h.

Referenced by ServicesPageWndProc(), CIconWatcher::Uninitialize(), and CIconWatcher::WatcherThread().

{
    CNode* Node = (CNode*)pos;
    return Node->m_Element;
}

GetAt() [2/2]

template<typename E , class ETraits >

const E & ATL::CAtlList< E, ETraits >::GetAt ( _In_ POSITION  pos ) const

inline

Definition at line 312 of file atlcoll.h.

{
    CNode* Node = (CNode*)pos;
    return Node->m_Element;
}

GetCount()

template<typename E , class ETraits >

size_t ATL::CAtlList< E, ETraits >::GetCount ( ) const

inline

Definition at line 249 of file atlcoll.h.

Referenced by CIconWatcher::AddIconToWatcher(), CIconWatcher::Uninitialize(), and CIconWatcher::WatcherThread().

{
    return m_NumElements;
}

GetFreeNode()

template<typename E , class ETraits >

CAtlList< E, ETraits >::CNode * ATL::CAtlList< E, ETraits >::GetFreeNode ( )

private

Definition at line 524 of file atlcoll.h.

{
    if (m_FreeNode)
    {
        return m_FreeNode;
    }

    CAtlPlex* Block = CAtlPlex::Create(m_Blocks, m_BlockSize, sizeof(CNode));
    if (Block == NULL)
    {
        AtlThrowImp(E_OUTOFMEMORY);
    }
    
    CNode* Node = (CNode*)Block->GetData();
    Node += (m_BlockSize - 1);
    for (int i = m_BlockSize - 1; i >= 0; i--)
    {
        Node->m_Next = m_FreeNode;
        m_FreeNode = Node;
        Node--;
    }

    return m_FreeNode;
}

GetHeadPosition()

template<typename E , class ETraits >

POSITION ATL::CAtlList< E, ETraits >::GetHeadPosition ( ) const

inline

Definition at line 261 of file atlcoll.h.

Referenced by CIconWatcher::GetListEntry(), and ServicesPageWndProc().

{
    return (POSITION)m_HeadNode;
}

GetNext() [1/2]

template<typename E , class ETraits >

E & ATL::CAtlList< E, ETraits >::GetNext ( _Inout_ POSITION &  pos )

inline

Definition at line 273 of file atlcoll.h.

Referenced by CIconWatcher::GetListEntry(), and ServicesPageWndProc().

{
    CNode* Node = (CNode*)pos;
    pos = (POSITION)Node->m_Next;
    return Node->m_Element;
}

GetNext() [2/2]

template<typename E , class ETraits >

const E & ATL::CAtlList< E, ETraits >::GetNext ( _Inout_ POSITION &  pos ) const

inline

Definition at line 281 of file atlcoll.h.

{
    CNode* Node = (CNode*)pos;
    pos = (POSITION)Node->m_Next;
    return Node->m_Element;
}

GetPrev() [1/2]

template<typename E , class ETraits >

E & ATL::CAtlList< E, ETraits >::GetPrev ( _Inout_ POSITION &  pos )

inline

Definition at line 289 of file atlcoll.h.

{
    CNode* Node = (CNode*)pos;
    pos = (POSITION)Node->m_Prev;
    return Node->m_Element;
}

GetPrev() [2/2]

template<typename E , class ETraits >

const E & ATL::CAtlList< E, ETraits >::GetPrev ( _Inout_ POSITION &  pos ) const

inline

Definition at line 297 of file atlcoll.h.

{
    CNode* Node = (CNode*)pos;
    pos = (POSITION)Node->m_Prev;
    return Node->m_Element;
}

GetTailPosition()

template<typename E , class ETraits >

POSITION ATL::CAtlList< E, ETraits >::GetTailPosition ( ) const

inline

Definition at line 267 of file atlcoll.h.

{
    return (POSITION)m_TailNode;
}

IsEmpty()

template<typename E , class ETraits >

bool ATL::CAtlList< E, ETraits >::IsEmpty ( ) const

inline

Definition at line 255 of file atlcoll.h.

{
    return (m_NumElements == 0);
}

operator=()

template<typename E, class ETraits = CElementTraits<E>>

CAtlList& ATL::CAtlList< E, ETraits >::operator= ( _In_ const CAtlList< E, ETraits > &  )

private

RemoveAll()

template<typename E , class ETraits >

void ATL::CAtlList< E, ETraits >::RemoveAll

(

)

Definition at line 393 of file atlcoll.h.

Referenced by ServicesPageWndProc(), and CIconWatcher::Uninitialize().

{
    while (m_NumElements > 0)
    {
        CNode* Node = m_HeadNode;
        m_HeadNode = m_HeadNode->m_Next;
        FreeNode(Node);
    }

    m_HeadNode = NULL;
    m_TailNode = NULL;
    m_FreeNode = NULL;

    if (m_Blocks)
    {
        m_Blocks->Destroy();
        m_Blocks = NULL;
    }
}

RemoveAt()

template<typename E , class ETraits >

void ATL::CAtlList< E, ETraits >::RemoveAt

(

_In_ POSITION

pos

)

Definition at line 414 of file atlcoll.h.

Referenced by CIconWatcher::GetListEntry(), and ValidateItem().

{
    ATLASSERT(pos != NULL);

    CNode* OldNode = (CNode*)pos;
    if (OldNode == m_HeadNode)
    {
        m_HeadNode = OldNode->m_Next;
    }
    else
    {
        OldNode->m_Prev->m_Next = OldNode->m_Next;
    }
    if (OldNode == m_TailNode)
    {
        m_TailNode = OldNode->m_Prev;
    }
    else
    {
        OldNode->m_Next->m_Prev = OldNode->m_Prev;
    }
    FreeNode(OldNode);
}

RemoveHead()

template<typename E , class ETraits >

E ATL::CAtlList< E, ETraits >::RemoveHead

(

)

Definition at line 353 of file atlcoll.h.

{
    CNode* Node = m_HeadNode;
    E Element(Node->m_Element);

    m_HeadNode = Node->m_Next;
    if (m_HeadNode)
    {
        m_HeadNode->m_Prev = NULL;
    }
    else
    {
        m_TailNode = NULL;
    }
    FreeNode(Node);

    return Element;
}

RemoveTail()

template<typename E , class ETraits >

E ATL::CAtlList< E, ETraits >::RemoveTail

(

)

Definition at line 373 of file atlcoll.h.

{
    CNode* Node = m_TailNode;
    E Element(Node->m_Element);

    m_TailNode = Node->m_Prev;
    if (m_TailNode)
    {
        m_TailNode->m_Next = NULL;
    }
    else
    {
        m_HeadNode = NULL;
    }
    FreeNode(Node);

    return Element;
}

Member Data Documentation

m_Blocks

template<typename E, class ETraits = CElementTraits<E>>

CAtlPlex* ATL::CAtlList< E, ETraits >::m_Blocks

private

Definition at line 166 of file atlcoll.h.

m_BlockSize

template<typename E, class ETraits = CElementTraits<E>>

UINT ATL::CAtlList< E, ETraits >::m_BlockSize

private

Definition at line 167 of file atlcoll.h.

m_FreeNode

template<typename E, class ETraits = CElementTraits<E>>

CNode* ATL::CAtlList< E, ETraits >::m_FreeNode

private

Definition at line 170 of file atlcoll.h.

m_HeadNode

template<typename E, class ETraits = CElementTraits<E>>

CNode* ATL::CAtlList< E, ETraits >::m_HeadNode

private

Definition at line 168 of file atlcoll.h.

m_NumElements

template<typename E, class ETraits = CElementTraits<E>>

size_t ATL::CAtlList< E, ETraits >::m_NumElements

private

Definition at line 171 of file atlcoll.h.

m_TailNode

template<typename E, class ETraits = CElementTraits<E>>

CNode* ATL::CAtlList< E, ETraits >::m_TailNode

private

Definition at line 169 of file atlcoll.h.

---

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

• sdk/lib/atl/atlcoll.h