FxCollectionInternal Struct Reference

#include <fxcollection.hpp>

Inheritance diagram for FxCollectionInternal:

Collaboration diagram for FxCollectionInternal:

Public Member Functions
	FxCollectionInternal (VOID)
	~FxCollectionInternal (VOID)
_Must_inspect_result_ FxCollectionEntry *	FindEntry (__in ULONG Index)
_Must_inspect_result_ FxCollectionEntry *	FindEntryByObject (__in FxObject *Object)
ULONG	Count (VOID)
BOOLEAN	Add (__in PFX_DRIVER_GLOBALS FxDriverGlobals, __in FxObject *Item)
_Must_inspect_result_ FxObject *	GetItem (__in ULONG Index)
_Must_inspect_result_ FxObject *	GetFirstItem (VOID)
_Must_inspect_result_ FxObject *	GetLastItem (VOID)
NTSTATUS	Remove (__in ULONG Index)
VOID	CleanupEntry (__in FxCollectionEntry *Entry)
VOID	CleanupEntryObject (__in FxObject *Object)
NTSTATUS	RemoveEntry (__in FxCollectionEntry *Entry)
_Must_inspect_result_ NTSTATUS	RemoveItem (__in FxObject *Item)
_Must_inspect_result_ FxCollectionEntry *	Start (VOID)
_Must_inspect_result_ FxCollectionEntry *	End (VOID)
VOID	Clear (VOID)

Protected Member Functions
_Must_inspect_result_ FxCollectionEntry *	AllocateEntry (__in PFX_DRIVER_GLOBALS FxDriverGlobals)
VOID	AddEntry (__in FxCollectionEntry *Node, __in FxObject *Item)

Protected Attributes
ULONG	m_Count
LIST_ENTRY	m_ListHead

Detailed Description

Definition at line 56 of file fxcollection.hpp.

Constructor & Destructor Documentation

FxCollectionInternal()

FxCollectionInternal::FxCollectionInternal

(

VOID

)

Definition at line 28 of file fxcollection.cpp.

{
    m_Count = 0;
    InitializeListHead(&m_ListHead);
}

~FxCollectionInternal()

FxCollectionInternal::~FxCollectionInternal

(

VOID

)

Definition at line 36 of file fxcollection.cpp.

{
    Clear();
}

Member Function Documentation

Add()

BOOLEAN FxCollectionInternal::Add	(	__in PFX_DRIVER_GLOBALS	FxDriverGlobals,
		__in FxObject *	Item
	)

Definition at line 62 of file fxcollection.cpp.

{
    FxCollectionEntry *pNode;
 
    pNode = AllocateEntry(FxDriverGlobals);
 
    if (pNode != NULL) {
        InsertTailList(&m_ListHead, &pNode->m_ListEntry);
 
        AddEntry(pNode, Item);
    }
 
    return pNode != NULL;
}

Referenced by FxCollection::Add().

AddEntry()

VOID FxCollectionInternal::AddEntry ( __in FxCollectionEntry *  Node, __in FxObject *  Item  )

inlineprotected

Definition at line 175 of file fxcollection.hpp.

    {
        Node->m_Object = Item;
 
        //
        // Refcount the item we are adding to the list.
        //
        Item->ADDREF(this);
 
        //
        // Increment the number of items in the collection.
        //
        m_Count++;
    }

Referenced by Add(), and FxResourceCollection::AddAt().

AllocateEntry()

_Must_inspect_result_ FxCollectionEntry * FxCollectionInternal::AllocateEntry ( __in PFX_DRIVER_GLOBALS  FxDriverGlobals )

inlineprotected

Definition at line 167 of file fxcollection.hpp.

    {
        return new(FxDriverGlobals) FxCollectionEntry();
    }

Referenced by Add(), and FxResourceCollection::AddAt().

CleanupEntry()

VOID FxCollectionInternal::CleanupEntry

(

__in FxCollectionEntry *

Entry

)

Definition at line 161 of file fxcollection.cpp.

{
    RemoveEntryList(&Entry->m_ListEntry);
    delete Entry;
 
    m_Count--;
}

Referenced by if(), and RemoveEntry().

CleanupEntryObject()

VOID FxCollectionInternal::CleanupEntryObject ( __in FxObject *  Object )

inline

Definition at line 123 of file fxcollection.hpp.

    {
        Object->RELEASE(this);
    }

Referenced by if(), and RemoveEntry().

Clear()

VOID FxCollectionInternal::Clear

(

VOID

)

Definition at line 44 of file fxcollection.cpp.

{
    while (!IsListEmpty(&m_ListHead)) {
        Remove(0);
    }
}

Count()

ULONG FxCollectionInternal::Count

(

VOID

)

Definition at line 54 of file fxcollection.cpp.

{
    return m_Count;
}

Referenced by FxIoResReqList::CreateWdmList(), FxPkgPnp::FilterResourceRequirements(), if(), FxPkgPdo::PnpQueryResourceRequirements(), FxPkgPdo::PnpQueryResources(), and FxPkgFdo::PnpSendStartDeviceDownTheStackOverload().

End()

_Must_inspect_result_ FxCollectionEntry * FxCollectionInternal::End ( VOID  )

inline

Definition at line 152 of file fxcollection.hpp.

    {
        return CONTAINING_RECORD(&m_ListHead, FxCollectionEntry, m_ListEntry);
    }

Referenced by FxResourceCollection::AddAt(), FxCmResList::CreateWdmList(), FxIoResReqList::CreateWdmList(), FxPkgPnp::PnpMatchResources(), and FxPkgPnp::ValidateCmResource().

FindEntry()

_Must_inspect_result_ FxCollectionEntry * FxCollectionInternal::FindEntry

(

__in ULONG

Index

)

Definition at line 82 of file fxcollection.cpp.

{
    PLIST_ENTRY ple;
    ULONG i;
 
    if (Index >= m_Count) {
        return NULL;
    }
 
    for (i = 0, ple = m_ListHead.Flink;
         ple != &m_ListHead;
         ple = ple->Flink, i++) {
        if (i != Index) {
            continue;
        }
 
        return CONTAINING_RECORD(ple, FxCollectionEntry, m_ListEntry);
    }
 
    return NULL;
}

Referenced by GetItem(), Remove(), and FxResourceCollection::RemoveAndDelete().

FindEntryByObject()

_Must_inspect_result_ FxCollectionEntry * FxCollectionInternal::FindEntryByObject

(

__in FxObject *

Object

)

Definition at line 108 of file fxcollection.cpp.

{
    PLIST_ENTRY ple;
 
    for (ple = m_ListHead.Flink; ple != &m_ListHead; ple = ple->Flink) {
        FxCollectionEntry* pNode;
 
        pNode = CONTAINING_RECORD(ple, FxCollectionEntry, m_ListEntry);
        if (pNode->m_Object == Object) {
            return pNode;
        }
    }
 
    return NULL;
}

Referenced by RemoveItem().

GetFirstItem()

_Must_inspect_result_ FxObject * FxCollectionInternal::GetFirstItem

(

VOID

)

Definition at line 202 of file fxcollection.cpp.

{
    if (IsListEmpty(&m_ListHead)) {
        return NULL;
    }
    else {
        return CONTAINING_RECORD(m_ListHead.Flink,
                                 FxCollectionEntry,
                                 m_ListEntry)->m_Object;
    }
}

GetItem()

_Must_inspect_result_ FxObject * FxCollectionInternal::GetItem

(

__in ULONG

Index

)

Definition at line 184 of file fxcollection.cpp.

{
    FxCollectionEntry* pNode;
 
    pNode = FindEntry(Index);
    if (pNode != NULL) {
        return pNode->m_Object;
    }
    else {
        return NULL;
    }
}

Referenced by FxCmResList::GetDescriptor().

GetLastItem()

_Must_inspect_result_ FxObject * FxCollectionInternal::GetLastItem

(

VOID

)

Definition at line 218 of file fxcollection.cpp.

{
    if (IsListEmpty(&m_ListHead)) {
        return NULL;
    }
    else {
        return CONTAINING_RECORD(m_ListHead.Blink,
                                 FxCollectionEntry,
                                 m_ListEntry)->m_Object;
    }
}

Remove()

NTSTATUS FxCollectionInternal::Remove

(

__in ULONG

Index

)

Definition at line 127 of file fxcollection.cpp.

{
    FxCollectionEntry *pNode;
 
    pNode = FindEntry(Index);
 
    if (pNode != NULL) {
        return RemoveEntry(pNode);
    }
    else {
        return STATUS_NOT_FOUND;
    }
}

RemoveEntry()

NTSTATUS FxCollectionInternal::RemoveEntry

(

__in FxCollectionEntry *

Entry

)

Definition at line 172 of file fxcollection.cpp.

{
    CleanupEntryObject(Entry->m_Object);
    CleanupEntry(Entry);
 
    return STATUS_SUCCESS;
}

Referenced by Remove(), FxResourceCollection::RemoveAndDelete(), RemoveItem(), and while().

RemoveItem()

_Must_inspect_result_ NTSTATUS FxCollectionInternal::RemoveItem

(

__in FxObject *

Item

)

Definition at line 145 of file fxcollection.cpp.

{
    FxCollectionEntry* pNode;
 
    pNode = FindEntryByObject(Item);
 
    if (pNode != NULL) {
        return RemoveEntry(pNode);
    }
 
    return STATUS_NOT_FOUND;
}

Start()

_Must_inspect_result_ FxCollectionEntry * FxCollectionInternal::Start ( VOID  )

inline

Definition at line 143 of file fxcollection.hpp.

    {
        return CONTAINING_RECORD(m_ListHead.Flink, FxCollectionEntry, m_ListEntry);
    }

Referenced by FxIoResReqList::CreateWdmList(), FxPkgPnp::PnpMatchResources(), and FxPkgPnp::ValidateCmResource().

Member Data Documentation

m_Count

ULONG FxCollectionInternal::m_Count

protected

Definition at line 58 of file fxcollection.hpp.

Referenced by AddEntry(), CleanupEntry(), Count(), FindEntry(), FxCollectionInternal(), and FxCollection::StealCollection().

m_ListHead

LIST_ENTRY FxCollectionInternal::m_ListHead

protected

Definition at line 60 of file fxcollection.hpp.

Referenced by Add(), FxResourceCollection::AddAt(), Clear(), End(), FindEntry(), FindEntryByObject(), FxCollectionInternal(), GetFirstItem(), GetLastItem(), Start(), and FxCollection::StealCollection().

---

The documentation for this struct was generated from the following files:

• sdk/lib/drivers/wdf/shared/inc/private/common/fxcollection.hpp
• sdk/lib/drivers/wdf/shared/support/fxcollection.cpp