DynArray.h

Go to the documentation of this file.

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Project: uLib - User mode library.
// Module: DynArray -- Dynamic arrays in C++
// Author: Copyright (c) Love Nystrom 1999
// License: NNOSL (BSD descendant, see NNOSL.txt in the base directory).
// Credits: Unknown @ Borland International (concept and original Pascal class).
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#ifndef _DynArray_h_incl_
#define _DynArray_h_incl_

#if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) // 3 idents I've seen
#include <uLib/UtilFunc.h>
#else // Non-Windows compilation
#error "STOP: This version of DynArray requires the HeapAlloc API"
#endif

BEGIN_NAMESPACE( uLib )

//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------


#if USE_DYNARRAY_LIMIT
  #ifndef MAX_DYNITEM
    #define MAX_DYNITEM  262144L // Limit items pointer block to 1 MB (2 MB on x64)
    //#define MAX_DYNITEM  1048576L // Max 4 MB of pointers (8 MB on x64)
  #endif
#endif

typedef class DynArray * PDynArray;
typedef bool (CALLBACK *DYN_ITEMFUNC)( PVOID Item, PVOID UserData );

//++ Class DynArray -----------------------------------------------------------
//-----------------------------------------------------------------------------

class DynArray {
public:
    DWORD const &       Count; 
    DWORD const &       Size;  
    DynArray const &    Items; 

    DynArray( DWORD Size=16, WORD Delta=16 );

    virtual ~DynArray();

    void Init( DWORD Size, WORD Delta ); 
    void Done(); 

    PVOID operator +=( PVOID Item ) { return Insert( Item ); } 
    PVOID operator -=( PVOID Item ) { return Remove( Item ); } 

    PVOID Insert( PVOID Item );

    PVOID InsertAt( DWORD Index, PVOID Item );


    PVOID Push( PVOID Item ); 
    PVOID Pull( void );       
    PVOID Pop( void );        

    virtual void DeleteItem( PVOID & Item );

    virtual void DeleteAll( void ); // AFAIK: Must be virtual to follow DeleteItem

    void Delete( PVOID& Item ); 
    void Delete( DWORD Index );

    PVOID Remove( PVOID Item ); 
    PVOID Remove( DWORD Index );

    LONG IndexOf( PVOID Item ) const;

    PVOID At( DWORD Index ) const;

    PVOID FirstThat( DYN_ITEMFUNC Match, PVOID userData ) const;

    PVOID LastThat( DYN_ITEMFUNC Match, PVOID userData ) const;

    bool ForEach( DYN_ITEMFUNC Action, PVOID userData ) const;

    PVOID operator[]( DWORD Index ) const { return At( Index ); }

protected:
    DWORD   _count, _size;
    WORD    _delta;
    PVOID*  _items; // array of pointers
private:
    // DynArray uses private allocation method for consistency and control.
    // Uses mem_Alloc et alumni.
    static void* __alloc( size_t bytes );
    static void* __realloc( void* blk, size_t bytes );
    static void* __free( void* blk );
};

//-----------------------------------------------------------------------------
// SortDynArray -- Sorted dynamic array.
//-----------------------------------------------------------------------------

typedef class SortDynArray * PSortDynArray;
class SortDynArray : public DynArray {
public:
    bool Duplicates; 

    SortDynArray( DWORD Size=16, WORD Delta=16 );

    PVOID operator +=( PVOID Item ) { return Insert( Item ); }

    virtual PVOID KeyOf( PVOID Item );

    virtual short Compare( PVOID Key1, PVOID Key2 );

    bool Search( PVOID Key, DWORD& Index );

    PVOID Insert( PVOID Item );
};

END_NAMESPACE( uLib )
#endif //ndef _DynArray_h_incl_
// EOF