[BACK]Return to pa_array.h CVS log [TXT] [DIR] Up to [parser3project] / parser3 / src / include

Diff for /parser3/src/include/pa_array.h between versions 1.29 and 1.104

version 1.29, 2001/03/24 10:54:44 version 1.104, 2025/05/28 00:58:02
Line 1 Line 1
 /** @file  /** @file
         Parser: array class decl.          Parser: Array & Array_iterator classes decls.
   
         Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)          Copyright (c) 2001-2024 Art. Lebedev Studio (http://www.artlebedev.com)
           Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
         Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)  
   
         $Id$  
 */  */
   
 #ifndef PA_ARRAY_H  #ifndef PA_ARRAY_H
 #define PA_ARRAY_H  #define PA_ARRAY_H
   
 #include <stddef.h>  #define IDENT_PA_ARRAY_H "$Id$"
   
   // includes
   
 #include "pa_pool.h"  #include "pa_memory.h"
 #include "pa_types.h"  #include "pa_types.h"
 #include "pa_string.h"  #include "pa_exception.h"
   
 /**       // forwards
         Pooled Array.  
   
         Internal structure:  template<typename T> class Array_iterator;
         @verbatim  template<typename T> class Array_robust_iterator;
                 Array               Chunk0  template<typename T> class Array_reverse_iterator;
                 ======              ========  
                 head--------------->[ptr]  
                 append_here-------->[ptr]  
                 link_row            ........  
                                 .                       .  
                                 .                       [ptr]  
                                 ...........>[link to the next chunk]  
         @endverbatim  
 */  
   
 class Array : public Pooled {  // defines
 public:  
   
         /// Array item type  #define ARRAY_OPTION_LIMIT_ALL ((size_t)-1)
         typedef void Item;  
   
         /// for_each iterator function type  /// Simple Array
         typedef void (*For_each_func)(Item *value, void *info);  template<typename T> class Array: public PA_Object {
   
         /// first_that iterator function type          friend class Array_iterator<T>;
         typedef Item *(*First_that_func)(Item *value, const void *info);          friend class Array_robust_iterator<T>;
           friend class Array_reverse_iterator<T>;
   
         enum {  protected:
                 CR_INITIAL_ROWS_DEFAULT=10, ///< default preallocated row count  
                 CR_GROW_PERCENT=60 ///< each time the Array chunk_is_full() array expanded()          /// elements[growing size] here
         };          T *felements;
   
           // allocated size
           size_t fallocated;
   
           // array size
           size_t fsize;
   
 public:  public:
           typedef Array_iterator<T> Iterator;
           typedef Array_robust_iterator<T> RobustIterator;
           typedef Array_reverse_iterator<T> ReverseIterator;
   
           struct Action_options {
                   size_t offset;
                   size_t limit; //< ARRAY_OPTION_LIMIT_ALL means 'all'. zero limit means 'nothing'
                   bool reverse;
                   bool defined;
                   
                   Action_options(
                           size_t aoffset=0,
                           size_t alimit=ARRAY_OPTION_LIMIT_ALL,
                           bool areverse=false):
                           offset(aoffset), limit(alimit), reverse(areverse), 
                           defined(false) {}
   
                   bool adjust(size_t count) {
                           if(!count || !limit)
                                   return false;
                           if(offset>=count)
                                   return false;
                           // max(limit)
                           size_t m=reverse?
                                   offset+1
                                   :count-offset;
                           if(!m)
                                   return false;
                           // fix limit
                           if(limit>m)
                                   limit=m;
   
                           return true;
                   }
           };
   
           typedef T element_type;
   
         Array(Pool& apool, int initial_rows=CR_INITIAL_ROWS_DEFAULT);          inline Array(size_t initial=0):
                   fallocated(initial),
                   fsize(0)
           {
                   felements=fallocated?(T *)pa_malloc(fallocated*sizeof(T)):0;
           }
   
         /// size Array. how many items are in it  #ifdef USE_DESTRUCTORS
         int size() const {           inline ~Array(){
                 // for get and quick_get                  if(felements)
                 cache_chunk_base=0;                          pa_free(felements);
                 cache_chunk=head;  
                 return fused_rows;   
         }          }
         /// append Item to array  #endif
         Array& operator += (Item *src);  
           /// how many items are in Array
           inline size_t count() const { return fsize; }
   
         /// dirty hack to allow constant items storage. I long for Array<const Item*>          /// append to array
         Array& operator += (const Item *src) { return *this+=const_cast<Item*>(src); }          inline Array& operator+=(T src) {
                   if(is_full())
                           expand();
   
                   felements[fsize++]=src;
   
                   return *this;
           }
   
         /// append other Array portion to this one. starting from offset          /// append other Array portion to this one. starting from offset
         Array& append_array(const Array& src, int offset=0);          void append(const Array& src, size_t offset=0, size_t limit=ARRAY_OPTION_LIMIT_ALL) { //< zero limit means 'nothing'
                   size_t src_count=src.count();
                   // skip tivials
                   if(!src_count || !limit || offset>=src_count)
                           return;
                   // max(limit)
                   size_t m=src_count-offset;
                   // fix limit
                   if(limit>m)
                           limit=m;
   
                   fit(fsize-1+limit);
                   memcpy(felements+fsize, src.felements+offset, limit * sizeof(T));
                   fsize+=limit;
           }
   
         /**           /// get index-element
                 quickly gets some item considering...          inline T get(size_t index) const {
                   assert(index<count());
                   return felements[index];
           }
   
                 these true:          /// ref version of get
                         - index increments from 0 to size()-1          inline T& get_ref(size_t index) const {
                         - index>=0 && index<size()                  assert(index<count());
                         - index>=cache_chunk_base                  return felements[index];
         */          }
         Item *quick_get(int index) const {  
                 // next chunk will be with "index" row          /// put index-element
                 if(!(index<cache_chunk_base+cache_chunk->count)) {          inline void put(size_t index, T element) {
                         int count=cache_chunk->count;                  assert(index<count());
                         cache_chunk_base+=count;                  felements[index]=element;
                         cache_chunk=cache_chunk->rows[count].link;          }
                 }  
                           /// insert index-element
                 return cache_chunk->rows[index-cache_chunk_base].item;          inline void insert(size_t index, T element) {
                   assert(index<=count());
   
                   if(is_full())
                           expand();
   
                   memmove(felements+index+1, felements+index, (fsize-index) * sizeof(T));
   
                   felements[index]=element;
                   fsize++;
           }
   
           /// remove index-element
           inline void remove(size_t index) {
                   assert(index<count());
                   if (index<--fsize)
                           memmove(felements+index, felements+index+1, (fsize-index) * sizeof(T));
           }
   
           inline T operator [](size_t index) const { return get(index); }
   
           inline void clear() {
                   if(fsize)
                           memset((void *)felements, 0, fsize * sizeof(T));
                   fsize=0;
           }
   
           /// iterate over all elements
           template<typename I> void for_each(void (*callback)(T, I), I info) const {
                   T *last=felements+fsize;
                   for(T *current=felements; current<last; current++)
                           callback(*current, info);
         }          }
   
         Item *get(int index) const;          /// iterate over all elements
         void put(int index, Item *item);          template<typename I> void for_each(bool (*callback)(T, I), I info) const {
         /// convinient way to get strings from Array. I long for Array<const String *>                  T *last=felements+fsize;
         const String *get_string(int index) const {                   for(T *current=felements; current<last; current++)
                 return const_cast<const String *>(static_cast<String *>(get(index)));                           if(callback(*current, info))
                                   return;
         }          }
   
         /// iterate over all elements          /// iterate over all elements
         void for_each(For_each_func func, void *info=0);          template<typename I> void for_each_ref(void (*callback)(T&, I), I info) {
                   T *last=felements+fsize;
                   for(T *current=felements; current<last; current++)
                           callback(*current, info);
           }
   
         /// iterate over all elements until condition          /// iterate over all elements until condition becomes true, return that element
         void* first_that(First_that_func func, const void *info=0);          template<typename I> T first_that(bool (*callback)(T, I), I info) const {
                   T *last=felements+fsize;
                   for(T *current=felements; current<last; current++)
                           if(callback(*current, info))
                                   return *current;
   
 private:                  return T(0);
           }
   
         struct Chunk {          inline T* ptr(size_t index){
                 // the number of rows in chunk                  return felements + index;
                 int count;          }
                 union Row {  
                         Item *item;  
                         Chunk *link;  // link to the next chunk in chain  
                 } rows[1];  
                 // next rows are here  
         }  
                 *head;  // the head chunk of the chunk chain  
   
         // last allocated chunk  
         // helps appending Arrays  
         Chunk *tail;  
   
         // next append would write to this record  
         Chunk::Row *append_here;  
           
         // the address of place where lies address   
         // of the link to the next chunk to allocate  
         Chunk::Row *link_row;  
   
 private:  protected:
   
         // array size          inline bool is_full() {
         int fused_rows;                  return fsize == fallocated;
           }
   
         mutable int cache_chunk_base;          inline void expand() {
         mutable Chunk *cache_chunk;                  resize(fallocated>0 ? fallocated+fallocated/2+2 : 3); // 3 is PAF default, confirmed by tests
                   }
 private:  
   
         bool chunk_is_full() {          inline void fit(size_t index){
                 return append_here == link_row;                  if(index >= fallocated)
                           resize(max(fallocated+fallocated/4, index+1));
           }
   
           void resize(size_t asize) {
                   if(fallocated){
                           felements=(T *)pa_realloc(felements, asize*sizeof(T));
                           fallocated=asize;
                   } else {
                           fallocated=asize;
                           felements=(T *)pa_malloc(asize*sizeof(T));
                   }
         }          }
         void expand(int chunk_rows);  
   
 private: //disabled  private: //disabled
   
         //Array(Array&) { }          Array(const Array&) {}
         Array& operator = (const Array&) { return *this; }          Array& operator = (const Array&) { return *this; }
 };  };
   
   
   /// Commonly used, templated to work with any integer type
   
   template<typename T> char* pa_itoa(T n, T base=10){
           char buf[MAX_NUMBER + 1];
           char* pos=buf + MAX_NUMBER;
           *pos='\0';
   
           bool negative=n < 0;
           if (n < 0){
                   n=-n;
           }
   
           do {
                   *(--pos)=(char)(n % base) + '0';
                   n/=base;
           } while (n > 0);
   
           if (negative) {
                   *(--pos) = '-';
           }
           return pa_strdup(pos, buf + MAX_NUMBER - pos);
   }
   
   template<typename T> char* pa_uitoa(T n, T base=10){
           char buf[MAX_NUMBER + 1];
           char* pos=buf + MAX_NUMBER;
           *pos='\0';
   
           do {
                   *(--pos)=(char)(n % base) + '0';
                   n/=base;
           } while (n > 0);
   
           return pa_strdup(pos, buf + MAX_NUMBER - pos);
   }
   
   
   /** Array iterator, usage:
           @code
           // Array<T> a;
           for(Array_iterator<T> i(a); i; ) {
                   T& element=i.next();
                   ...
           }       
           @endcode
   */
   template<typename T> class Array_iterator {
   
           const Array<T>& farray;
           T *fcurrent;
           T *flast;
   
   public:
           Array_iterator(const Array<T>& aarray): farray(aarray) {
                   fcurrent=farray.felements;
                   flast=farray.felements + farray.fsize;
           }
   
           /// there are still elements
           inline operator bool () {
                   return fcurrent < flast;
           }
   
           /// returns the current element and advances the iterator
           inline T next() {
                   return *(fcurrent++);
           }
   
           /// returns the current element
           inline T value() {
                   return *(fcurrent);
           }
   
           // returns the current index of the iterator
           inline size_t index() {
                   return fcurrent - farray.felements;
           }
   };
   
   // Slower array iterator for arrays that can be modified during iteration
   template<typename T> class Array_robust_iterator {
   
           const Array<T>& farray;
           size_t findex;
   
   public:
           Array_robust_iterator(const Array<T>& aarray) : farray(aarray), findex(0) {}
   
           inline operator bool() {
                   return findex < farray.fsize;
           }
   
           inline void next() {
                   findex++;
           }
   
           inline T value() {
                   return farray.felements[findex];
           }
   
           inline size_t index() {
                   return findex;
           }
   };
   
   // Robust as used for arrays that can be modified during iteration
   template<typename T> class Array_reverse_iterator {
   
           const Array<T>& farray;
           size_t findex;
   
   public:
           Array_reverse_iterator(const Array<T>& aarray): farray(aarray), findex(aarray.fsize) {}
   
           inline operator bool () {
                   return (findex > 0) && (findex <= farray.fsize);
           }
   
           inline T prev() {
                   return farray.felements[--findex];
           }
   
           inline size_t index() {
                   return findex;
           }
   };
 #endif  #endif
Removed from v.1.29  
changed lines
  Added in v.1.104

E-mail: