// Copyright (C) 2007 Id Software, Inc. // #ifndef __LIST_H__ #define __LIST_H__ #if defined( _DEBUG ) && !defined( ID_REDIRECT_NEWDELETE ) #define new DEBUG_NEW #endif /* =============================================================================== List template Does not allocate memory until the first item is added. =============================================================================== */ /* ================ idListSortCompare ================ */ template< class type > ID_INLINE int idListSortCompare( const type *a, const type *b ) { return *a - *b; } /* ================ idSwap ================ */ template< class type > ID_INLINE void idSwap( type &a, type &b ) { type c = a; a = b; b = c; } /* ============ idList ============ */ template< class type> class idList { public: typedef const type ConstType; typedef type Type; typedef Type* Iterator; typedef ConstType* ConstIterator; typedef int cmp_t( const type *, const type * ); static const int DEFAULT_GRANULARITY = 16; explicit idList( int newgranularity = DEFAULT_GRANULARITY ); idList( const idList &other ); template< class Iter > explicit idList( Iter begin, Iter end ) : list( NULL ), granularity( DEFAULT_GRANULARITY ) { Clear(); CopyFromRange( begin, end ); } ~idList( void ); void Clear( void ); // clear the list int Num( void ) const; // returns number of elements in list bool Empty( void ) const; // returns true if number elements in list is 0 void SetGranularity( int newgranularity ); // set new granularity int GetGranularity( void ) const; // get the current granularity size_t Allocated( void ) const; // returns total size of allocated memory size_t Size( void ) const; // returns total size of allocated memory including size of list type size_t MemoryUsed( void ) const; // returns size of the used elements in the list idList& operator=( const idList &other ); type & operator[]( int index ); const type & operator[]( int index ) const; void Condense( void ); // resizes list to exactly the number of elements it contains void Resize( int newsize ); // resizes list to the given number of elements void Resize( int newsize, int newgranularity ); // resizes list and sets new granularity void SetNum( int newnum, bool resize = true ); // set number of elements in list and resize to exactly this number if necessary void AssureSize( int newSize ); // assure list has given number of elements, but leave them uninitialized void AssureSize( int newSize, const type &initValue ); // assure list has given number of elements and initialize any new elements void PreAllocate( int newSize ); type & Alloc( void ); // returns reference to a new data element at the end of the list int Append( const type & obj ); // append element int Append( const idList &other ); // append list int AddUnique( const type & obj ); // add unique element int Insert( const type & obj, int index = 0 ); // insert the element at the given index int FindIndex( const type & obj ) const; // find the index for the given element int FindIndexBinary ( const type & key, cmp_t *compare = ( cmp_t * )&idListSortCompare ) const; type * FindElement( const type & obj ) const; // find pointer to the given element int FindNull( void ) const; // find the index for the first NULL pointer in the list void Fill( int num, const type & obj ); // resize the list, if neccessary and set all items to obj int IndexOf( const type *obj ) const; // returns the index for the pointer to an element in the list bool RemoveIndex( int index ); // remove the element at the given index bool RemoveIndexFast( int index ); // remove the element at the given index and put the last element into its spot bool Remove( const type & obj ); // remove the element bool RemoveFast( const type & obj ); // remove the element, move the last element into its spot void Sort( cmp_t *compare = idListSortCompare ); // sort the list void Swap( idList &other ); // swap the contents of the lists void DeleteContents( bool clear ); // delete the contents of the list // members for compatibility with STL algorithms Iterator Begin( void ); // return list[ 0 ] Iterator End( void ); // return list[ num ] (one past end) ConstIterator Begin( void ) const; // return list[ 0 ] ConstIterator End( void ) const; // return list[ num ] (one past end) type& Front(); // return *list[ 0 ] const type& Front() const; // return *list[ 0 ] type& Back(); // return *list[ num - 1 ] const type& Back() const; // return *list[ num - 1 ] bool Remove( Iterator iter ); // Comparison functions // find an object that passes the predicate // IMPORTANT: unlike Find, this returns End() if the element is not found, NOT NULL template< class Cmp > Iterator FindIteratorIf( Cmp predicate ) { Iterator begin = Begin(); Iterator end = End(); while( begin != end ) { if( predicate( *begin ) ) { break; } ++begin; } return begin; } // find an object that passes the predicate // IMPORTANT: unlike Find, this returns End() if the element is not found, NOT NULL template< class Cmp > ConstIterator FindIteratorIf( Cmp predicate ) const { ConstIterator begin = Begin(); ConstIterator end = End(); while( begin != end ) { if( predicate( *begin ) ) { break; } ++begin; } return begin; } // Comparison functions // find an object that passes the predicate // IMPORTANT: unlike Find, this returns End() if the element is not found, NOT NULL template< class Cmp > Iterator FindIteratorIf( const type& element, const Cmp predicate ) { Iterator begin = Begin(); Iterator end = End(); while( begin != end ) { if( predicate( element, *begin ) ) { break; } ++begin; } return begin; } // find an object that passes the predicate // IMPORTANT: unlike Find, this returns End() if the element is not found, NOT NULL template< class Cmp > ConstIterator FindIteratorIf( const type& element, Cmp predicate ) const { ConstIterator begin = Begin(); ConstIterator end = End(); while( begin != end ) { if( predicate( element, *begin ) ) { break; } ++begin; } return begin; } Iterator FindIterator( type const & obj ) { Iterator begin = Begin(); Iterator end = End(); while( begin != end ) { if( *begin == obj ) { break; } ++begin; } return begin; } ConstIterator FindIterator( type const & obj ) const { ConstIterator begin = Begin(); ConstIterator end = End(); while( begin != end ) { if( *begin == obj ) { break; } ++begin; } return begin; } // Sorting functions template< class Cmp > void Sort( Cmp compare ) { sdQuickSort( Begin(), End(), compare ); } // Searching functions // IMPORTANT: unlike FindElement, this returns End() if the element is not found, NOT NULL template< class Cmp > Iterator FindIteratorBinary( const type& searchElement, Cmp compare ) { return sdBinarySearch( searchElement, Begin(), End(), compare ); } // IMPORTANT: unlike FindElement, this returns End() if the element is not found, NOT NULL template< class Cmp > ConstIterator FindIteratorBinary( const type& searchElement, Cmp compare ) const { return sdBinarySearch( searchElement, Begin(), End(), compare ); } template< class Iter > void CopyFromRange( Iter begin, Iter end ) { AssureSize( end - begin ); for( int i = 0; i < num; i++, ++begin ) { list[ i ] = *begin; } } protected: int num; int size; int granularity; type * list; }; /* ================ idList::idList( int ) ================ */ template ID_INLINE idList::idList( int newgranularity ) : granularity( newgranularity ), list( NULL ) { assert( granularity > 0 ); Clear(); } /* ================ idList::idList( const idList &other ) ================ */ template< class type > ID_INLINE idList::idList( const idList &other ) : list( NULL ) { *this = other; } /* ================ idList::~idList ================ */ template< class type > ID_INLINE idList::~idList( void ) { Clear(); } /* ================ idList::Clear Frees up the memory allocated by the list. Assumes that type automatically handles freeing up memory. ================ */ template< class type > ID_INLINE void idList::Clear( void ) { delete[] list; list = NULL; num = 0; size = 0; } /* ================ idList::DeleteContents Calls the destructor of all elements in the list. Conditionally frees up memory used by the list. Note that this only works on lists containing pointers to objects and will cause a compiler error if called with non-pointers. Since the list was not responsible for allocating the object, it has no information on whether the object still exists or not, so care must be taken to ensure that the pointers are still valid when this function is called. Function will set all pointers in the list to NULL. ================ */ template< class type > ID_INLINE void idList::DeleteContents( bool clear ) { for( int i = 0; i < num; i++ ) { delete list[ i ]; list[ i ] = NULL; } if ( clear ) { Clear(); } else { memset( list, 0, size * sizeof( type ) ); } } /* ================ idList::Allocated return total memory allocated for the list in bytes, but doesn't take into account additional memory allocated by type ================ */ template< class type > ID_INLINE size_t idList::Allocated( void ) const { return size * sizeof( type ); } /* ================ idList::Size return total size of list in bytes, but doesn't take into account additional memory allocated by type ================ */ template< class type > ID_INLINE size_t idList::Size( void ) const { return sizeof( idList ) + Allocated(); } /* ================ idList::MemoryUsed ================ */ template< class type > ID_INLINE size_t idList::MemoryUsed( void ) const { return num * sizeof( *list ); } /* ================ idList::Num Returns the number of elements currently contained in the list. Note that this is NOT an indication of the memory allocated. ================ */ template< class type > ID_INLINE int idList::Num( void ) const { return num; } /* ================ idList::SetNum Resize to the exact size specified irregardless of granularity ================ */ template< class type > ID_INLINE void idList::SetNum( int newnum, bool resize ) { assert( newnum >= 0 ); if ( resize || newnum > size ) { Resize( newnum ); } num = newnum; } /* ================ idList::SetGranularity Sets the base size of the array and resizes the array to match. ================ */ template< class type > ID_INLINE void idList::SetGranularity( int newgranularity ) { int newsize; assert( newgranularity > 0 ); granularity = newgranularity; if ( list ) { // resize it to the closest level of granularity newsize = num + granularity - 1; newsize -= newsize % granularity; if ( newsize != size ) { Resize( newsize ); } } } /* ================ idList::GetGranularity Get the current granularity. ================ */ template< class type > ID_INLINE int idList::GetGranularity( void ) const { return granularity; } /* ================ idList::Condense Resizes the array to exactly the number of elements it contains or frees up memory if empty. ================ */ template< class type > ID_INLINE void idList::Condense( void ) { if ( list ) { if ( num ) { Resize( num ); } else { Clear(); } } } /* ================ idList::Resize Allocates memory for the amount of elements requested while keeping the contents intact. Contents are copied using their = operator so that data is correctly instantiated. ================ */ template< class type > ID_INLINE void idList::Resize( int newsize ) { assert( newsize >= 0 ); // free up the list if no data is being reserved if ( newsize <= 0 ) { Clear(); return; } if ( newsize == size ) { // not changing the size, so just exit return; } type* temp = list; size = newsize; if ( size < num ) { num = size; } list = new type[ size ]; if ( temp ) { // copy the old list into our new one for( int i = 0; i < num; i++ ) { list[ i ] = temp[ i ]; } // delete the old list if it exists delete[] temp; } } /* ================ idList::Resize Allocates memory for the amount of elements requested while keeping the contents intact. Contents are copied using their = operator so that data is correctly instantiated. ================ */ template< class type > ID_INLINE void idList::Resize( int newsize, int newgranularity ) { assert( newsize >= 0 ); assert( newgranularity > 0 ); granularity = newgranularity; // free up the list if no data is being reserved if ( newsize <= 0 ) { Clear(); return; } if ( newsize == size ) { // not changing the size, so just exit return; } type* temp = list; size = newsize; if ( size < num ) { num = size; } // copy the old list into our new one list = new type[ size ]; if ( temp ) { // copy the old list into our new one for( int i = 0; i < num; i++ ) { list[ i ] = temp[ i ]; } // delete the old list if it exists delete[] temp; } } /* ================ idList::AssureSize Makes sure the list has at least the given number of elements. ================ */ template< class type > ID_INLINE void idList::AssureSize( int newSize ) { int newNum = newSize; if ( newSize > size ) { if ( granularity == 0 ) { // this is a hack to fix our memset classes assert( 0 ); granularity = 16; } newSize += granularity - 1; newSize -= newSize % granularity; Resize( newSize ); } num = newNum; } /* ================ idList::AssureSize Makes sure the list has at least the given number of elements and initialize any elements not yet initialized. ================ */ template< class type > ID_INLINE void idList::AssureSize( int newSize, const type &initValue ) { int newNum = newSize; if ( newSize > size ) { if ( granularity == 0 ) { // this is a hack to fix our memset classes assert( 0 ); granularity = 16; } newSize += granularity - 1; newSize -= newSize % granularity; num = size; Resize( newSize ); for ( int i = num; i < newSize; i++ ) { list[i] = initValue; } } num = newNum; } /* ================ idList< class type >::PreAllocate Makes sure the list has at least the given number of elements allocated but don't actually change the number of items. ================ */ template< class type > ID_INLINE void idList< type >::PreAllocate( int newSize ) { int newNum = newSize; if ( newSize > size ) { if ( granularity == 0 ) { // this is a hack to fix our memset classes granularity = 16; } newSize += granularity - 1; newSize -= newSize % granularity; Resize( newSize ); } } /* ================ idList::operator= Copies the contents and size attributes of another list. ================ */ template< class type > ID_INLINE idList &idList::operator=( const idList &other ) { if( &other == this ) { return *this; } int i; Clear(); num = other.num; size = other.size; granularity = other.granularity; if ( size ) { list = new type[ size ]; for( i = 0; i < num; i++ ) { list[ i ] = other.list[ i ]; } } return *this; } /* ================ idList::operator[] const Access operator. Index must be within range or an assert will be issued in debug builds. Release builds do no range checking. ================ */ template< class type > ID_INLINE const type &idList::operator[]( int index ) const { assert( index >= 0 ); assert( index < num ); return list[ index ]; } /* ================ idList::operator[] Access operator. Index must be within range or an assert will be issued in debug builds. Release builds do no range checking. ================ */ template< class type > ID_INLINE type &idList::operator[]( int index ) { assert( index >= 0 ); assert( index < num ); return list[ index ]; } /* ================ idList::Alloc Returns a reference to a new data element at the end of the list. ================ */ template< class type > ID_INLINE type &idList::Alloc( void ) { if ( !list ) { Resize( granularity ); } if ( num == size ) { Resize( size + granularity ); } return list[ num++ ]; } /* ================ idList::Append Increases the size of the list by one element and copies the supplied data into it. Returns the index of the new element. ================ */ template< class type > ID_INLINE int idList::Append( type const & obj ) { // appending one of the list items does not work because the list may be reallocated assert( &obj < list || &obj >= list + num ); if ( !list ) { Resize( granularity ); } if ( num == size ) { int newsize; if ( granularity == 0 ) { // this is a hack to fix our memset classes assert( 0 ); granularity = 16; } newsize = size + granularity; Resize( newsize - newsize % granularity ); } list[ num ] = obj; num++; return num - 1; } /* ================ idList::Insert Increases the size of the list by at least one element if necessary and inserts the supplied data into it. Returns the index of the new element. ================ */ template< class type > ID_INLINE int idList::Insert( type const & obj, int index ) { // inserting one of the list items does not work because the list may be reallocated assert( &obj < list || &obj >= list + num ); if ( !list ) { Resize( granularity ); } if ( num == size ) { int newsize; if ( granularity == 0 ) { // this is a hack to fix our memset classes assert( 0 ); granularity = 16; } newsize = size + granularity; Resize( newsize - newsize % granularity ); } if ( index < 0 ) { index = 0; } else if ( index > num ) { index = num; } for ( int i = num; i > index; --i ) { list[i] = list[i-1]; } num++; list[index] = obj; return index; } /* ================ idList::Append adds the other list to this one correctly handles this->Append( *this ); Returns the size of the new combined list ================ */ template< class type > ID_INLINE int idList::Append( const idList &other ) { // appending the list itself does not work because the list may be reallocated assert( &other != this ); int n = other.Num(); if ( !list ) { if ( granularity == 0 ) { // this is a hack to fix our memset classes assert( 0 ); granularity = 16; } Resize( granularity + n ); } else { Resize( num + n ); } for ( int i = 0; i < n; i++ ) { Append( other[i] ); } return Num(); } /* ================ idList::AddUnique Adds the data to the list if it doesn't already exist. Returns the index of the data in the list. ================ */ template< class type > ID_INLINE int idList::AddUnique( type const & obj ) { // inserting one of the list items does not work because the list may be reallocated assert( &obj < list || &obj >= list + num ); int index = FindIndex( obj ); if ( index < 0 ) { index = Append( obj ); } return index; } /* ================ idList::FindIndexBinary Assumes the list is sorted and does a binary search for the given key ================ */ template< class type > ID_INLINE int idList::FindIndexBinary ( const type & key, cmp_t *compare ) const { typedef int cmp_c(const void *, const void *); cmp_c *vCompare = (cmp_c *)compare; type* found = (type*) bsearch( ( void * )( &key ), ( void * )list, ( size_t )num, sizeof( type ), vCompare ); if (found) { return IndexOf(found); } return -1; } /* ================ idList::FindIndex Searches for the specified data in the list and returns it's index. Returns -1 if the data is not found. ================ */ template< class type > ID_INLINE int idList::FindIndex( type const & obj ) const { int i; for( i = 0; i < num; i++ ) { if ( list[ i ] == obj ) { return i; } } // Not found return -1; } /* ================ idList::Find Searches for the specified data in the list and returns its address. Returns NULL if the data is not found. ================ */ template< class type > ID_INLINE type *idList::FindElement( type const & obj ) const { int i; i = FindIndex( obj ); if ( i >= 0 ) { return &list[ i ]; } return NULL; } /* ================ idList::FindNull Searches for a NULL pointer in the list. Returns -1 if NULL is not found. NOTE: This function can only be called on lists containing pointers. Calling it on non-pointer lists will cause a compiler error. ================ */ template< class type > ID_INLINE int idList::FindNull( void ) const { int i; for( i = 0; i < num; i++ ) { if ( list[ i ] == NULL ) { return i; } } // Not found return -1; } /* ================ idList::IndexOf Takes a pointer to an element in the list and returns the index of the element. This is NOT a guarantee that the object is really in the list. Function will assert in debug builds if pointer is outside the bounds of the list, but remains silent in release builds. ================ */ template< class type > ID_INLINE int idList::IndexOf( type const *objptr ) const { int index; index = objptr - list; assert( index >= 0 ); assert( index < num ); return index; } /* ================ idList::RemoveIndex Removes the element at the specified index and moves all data following the element down to fill in the gap. The number of elements in the list is reduced by one. Returns false if the index is outside the bounds of the list. Note that the element is not destroyed, so any memory used by it may not be freed until the destruction of the list. ================ */ template< class type > ID_INLINE bool idList::RemoveIndex( int index ) { int i; assert( list != NULL ); assert( index >= 0 ); assert( index < num ); if ( ( index < 0 ) || ( index >= num ) ) { return false; } num--; for( i = index; i < num; i++ ) { list[ i ] = list[ i + 1 ]; } return true; } /* =============== idList::RemoveIndexFast Removes the element at the specified index and moves the last element into it's spot, rather than moving the whole array down by one. Of course, this doesn't maintain the order of elements! The number of elements in the list is reduced by one. Returns false if the index is outside the bounds of the list. Note that the element is not destroyed, so any memory used by it may not be freed until the destruction of the list. =============== */ template< class type > ID_INLINE bool idList< type >::RemoveIndexFast( int index ) { assert( list != NULL ); assert( index >= 0 ); assert( index < num ); if ( ( index < 0 ) || ( index >= num ) ) { return false; } num--; // nothing to do if( index == num ) { return true; } list[ index ] = list[ num ]; return true; } /* ================ idList::Remove Removes the element if it is found within the list and moves all data following the element down to fill in the gap. The number of elements in the list is reduced by one. Returns false if the data is not found in the list. Note that the element is not destroyed, so any memory used by it may not be freed until the destruction of the list. ================ */ template< class type > ID_INLINE bool idList::Remove( type const & obj ) { int index; index = FindIndex( obj ); if ( index >= 0 ) { return RemoveIndex( index ); } return false; } /* ================ idList::RemoveFast Removes the element if it is found within the list and moves the last element into the gap. The number of elements in the list is reduced by one. Returns false if the data is not found in the list. Note that the element is not destroyed, so any memory used by it may not be freed until the destruction of the list. ================ */ template< class type > ID_INLINE bool idList::RemoveFast( type const & obj ) { int index; index = FindIndex( obj ); if ( index >= 0 ) { return RemoveIndexFast( index ); } return false; } /* ================ idList::Sort Performs a qsort on the list using the supplied comparison function. Note that the data is merely moved around the list, so any pointers to data within the list may no longer be valid. FIXME: These don't obey the element destruction policy ================ */ template< class type > ID_INLINE void idList::Sort( cmp_t *compare ) { if ( !list ) { return; } typedef int cmp_c(const void *, const void *); cmp_c *vCompare = (cmp_c *)compare; qsort( ( void * )list, ( size_t )num, sizeof( type ), vCompare ); } /* ================ idList::Swap Swaps the contents of two lists ================ */ template< class type > ID_INLINE void idList::Swap( idList &other ) { idSwap( num, other.num ); idSwap( size, other.size ); idSwap( granularity, other.granularity ); idSwap( list, other.list ); } /* ================ idList::Begin Returns the first element of the list ================ */ template< class type > ID_INLINE typename idList::Iterator idList::Begin( void ) { if( num == 0 ) { return End(); } return list; } /* ================ idList::End Returns one past the end of the list ================ */ template< class type > ID_INLINE typename idList::Iterator idList::End( void ) { return list + num; } /* ================ idList::Begin Returns the first element of the list ================ */ template< class type > ID_INLINE typename idList::ConstIterator idList::Begin( void ) const { if( num == 0 ) { return End(); } return list; } /* ================ idList::End Returns one past the end of the list ================ */ template< class type > ID_INLINE typename idList::ConstIterator idList::End( void ) const { return list + num; } /* ================ idList::Back returns the last element ================ */ template< class type > ID_INLINE type& idList::Back() { assert( num != 0 ); return list[ num - 1 ]; } /* ================ idList::Back returns the last element ================ */ template< class type > ID_INLINE const type& idList::Back() const { assert( num != 0 ); return list[ num - 1 ]; } /* ================ idList::Front returns the first element ================ */ template< class type > ID_INLINE type& idList::Front() { assert( num != 0 ); return list[ 0 ]; } /* ================ idList::Front returns the first element ================ */ template< class type > ID_INLINE const type& idList::Front() const { assert( num != 0 ); return list[ 0 ]; } /* ================ idList::Remove ================ */ template< class type > ID_INLINE bool idList::Remove( Iterator iter ) { int index = iter - list; return RemoveIndex( index ); } /* ================ idList::Empty ================ */ template< class type > ID_INLINE bool idList::Empty() const { return num == 0 || list == NULL; } /* ============ idList::Fill ============ */ template< class type > ID_INLINE void idList::Fill( int num, const type & obj ) { // inserting one of the list items does not work because the list may be reallocated assert( &obj < list || &obj >= list + num ); AssureSize( num ); for( int i = 0; i < num; i++ ) { list[ i ] = obj; } } template< class type > class idListGranularityOne : public idList { public: idListGranularityOne( int gran = 1 ) : idList( gran ) { } }; #endif /* !__LIST_H__ */