ListEx.h

Go to the documentation of this file.

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Project: uLib - User mode utility library.
// Module: Double-linked list class with mutually exclusive access.
// Author: Copyright (c) Love Nystrom
// License: NNOSL (BSD descendant, see NNOSL.txt in the base directory).
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#ifndef __ListEx_h_incl__
#define __ListEx_h_incl__

#include <uLib/Common.h>
#include <uLib/ListFunc.h>

//-----------------------------------------------------------------------------
// DLinkListEx - Preliminary
//-----------------------------------------------------------------------------

#define DLX_DEF_SPINCOUNT  3967  


class DLinkListEx : public DLinkList {
protected:
    CRITICAL_SECTION _csect; 
public:
    DLinkListEx( DWORD SpinCount = DLX_DEF_SPINCOUNT ); 
    DLinkListEx( PLIST_ENTRY ListHead, DWORD SpinCount = DLX_DEF_SPINCOUNT ); 
    ~DLinkListEx();


    bool  Lock( bool Wait = false );
    void  Unlock(); 
    DWORD SetLockSpinCount( DWORD SpinCount ); 

    // Add entries to list

    PLIST_ENTRY Append( PLIST_ENTRY Entry );  
    PLIST_ENTRY Prepend( PLIST_ENTRY Entry ); 
    PLIST_ENTRY operator += ( PLIST_ENTRY Entry ) { return Append( Entry ); }
    PLIST_ENTRY operator -= ( PLIST_ENTRY Entry ) { return RemoveEntry( Entry ); }

    // AppendList appends another list to the end of this.

    UINT AppendList( IN PLIST_ENTRY ListToAppend, OPTOUT PLIST_ENTRY* ppFirst ); 
    UINT AppendList( PDLinkList ListToAppend, OPTOUT PLIST_ENTRY* ppFirst );     
    UINT operator += ( PDLinkList ListToAppend ) { return AppendList( ListToAppend, NULL ); } 
    
    // Return Entry if removed, else NULL.

    PLIST_ENTRY RemoveEntry( PLIST_ENTRY Entry ); 
    PLIST_ENTRY RemoveFirst() { return RemoveEntry( Flink ); } 
    PLIST_ENTRY RemoveLast()  { return RemoveEntry( Blink ); } 

    void RemoveAll( PDListFunc ItemAction, void* UserData = NULL ); 

    PLIST_ENTRY FirstThat( PDListFunc Match, void* UserData = NULL ); 
    PLIST_ENTRY LastThat( PDListFunc Match, void* UserData = NULL );  
    bool        ForEach( PDListFunc Action, void* UserData = NULL );  

    void  QuickSort( PDListComp Compare, void* UserData = NULL ); 

    // Transfer this to a standard NT listhead.

    UINT ExportToListHead( PLIST_ENTRY ListHead ); 
    UINT ImportFromListHead( IN PLIST_ENTRY ListHead, OPTOUT PLIST_ENTRY* ppFirst ); 

    // Transfer to a circular list.

    UINT ExportToHeadlessList( PLIST_ENTRY* Target ); 
    UINT ImportHeadlessList( IN PLIST_ENTRY Circular, OPTOUT PLIST_ENTRY* ppFirst ); 
};

#endif//ndef __ListEx_h_incl__
// EOF