Annotation of parser3/src/include/pa_array.h, revision 1.33

1.24      paf         1: /** @file
1.26      paf         2:        Parser: array class decl.
                      3: 
1.21      paf         4:        Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
1.26      paf         5: 
1.22      paf         6:        Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
1.21      paf         7: 
1.33    ! paf         8:        $Id: pa_array.h,v 1.32 2001/03/28 08:01:41 paf Exp $
1.1       paf         9: */
                     10: 
1.24      paf        11: #ifndef PA_ARRAY_H
                     12: #define PA_ARRAY_H
                     13: 
                     14: #include <stddef.h>
                     15: 
                     16: #include "pa_pool.h"
                     17: #include "pa_types.h"
                     18: #include "pa_string.h"
                     19: 
1.25      paf        20: /**    
1.24      paf        21:        Pooled Array.
                     22: 
1.27      paf        23:        Internal structure:
                     24:        @verbatim
                     25:                Array               Chunk0
                     26:                ======              ========
                     27:                head--------------->[ptr]
                     28:                append_here-------->[ptr]
                     29:                link_row            ........
                     30:                                .                       .
                     31:                                .                       [ptr]
                     32:                                ...........>[link to the next chunk]
1.24      paf        33:        @endverbatim
1.1       paf        34: */
                     35: 
1.13      paf        36: class Array : public Pooled {
1.1       paf        37: public:
1.7       paf        38: 
1.29      paf        39:        /// Array item type
                     40:        typedef void Item;
                     41: 
                     42:        /// for_each iterator function type
                     43:        typedef void (*For_each_func)(Item *value, void *info);
                     44: 
1.32      paf        45:        /// first_that iterator function type, const info
                     46:        typedef bool (*First_that_func_const)(Item *value, const void *info);
                     47: 
1.29      paf        48:        /// first_that iterator function type
1.32      paf        49:        typedef bool (*First_that_func)(Item *value, void *info);
1.10      paf        50: 
1.1       paf        51:        enum {
1.24      paf        52:                CR_INITIAL_ROWS_DEFAULT=10, ///< default preallocated row count
                     53:                CR_GROW_PERCENT=60 ///< each time the Array chunk_is_full() array expanded()
1.1       paf        54:        };
                     55: 
1.6       paf        56: public:
                     57: 
1.11      paf        58:        Array(Pool& apool, int initial_rows=CR_INITIAL_ROWS_DEFAULT);
1.7       paf        59: 
1.33    ! paf        60:        /**
        !            61:                size Array. how many items are in it. 
        !            62:                must be used with quick_get like this:
        !            63:                @code
        !            64:                        int size=src.quick_size();
        !            65:                        for(int i=0; i<size; i++) {
        !            66:                                z=src.quick_get(i);
        !            67:                        }
        !            68:                @endcode
        !            69:        */
        !            70:        int quick_size() const { 
        !            71:                // for quick_get
1.18      paf        72:                cache_chunk_base=0;
                     73:                cache_chunk=head;
1.33    ! paf        74:                return size(); 
1.18      paf        75:        }
1.33    ! paf        76:        /// size Array. how many items are in it
        !            77:        int size() const { return fused_rows; }
1.24      paf        78:        /// append Item to array
1.15      paf        79:        Array& operator += (Item *src);
1.24      paf        80: 
                     81:        /// dirty hack to allow constant items storage. I long for Array<const Item*>
1.20      paf        82:        Array& operator += (const Item *src) { return *this+=const_cast<Item*>(src); }
1.24      paf        83: 
                     84:        /// append other Array portion to this one. starting from offset
1.19      paf        85:        Array& append_array(const Array& src, int offset=0);
1.24      paf        86: 
1.25      paf        87:        /** 
                     88:                quickly gets some item considering...
1.24      paf        89: 
                     90:                these true:
                     91:                        - index increments from 0 to size()-1
                     92:                        - index>=0 && index<size()
                     93:                        - index>=cache_chunk_base
                     94:        */
1.16      paf        95:        Item *quick_get(int index) const {
1.14      paf        96:                // next chunk will be with "index" row
                     97:                if(!(index<cache_chunk_base+cache_chunk->count)) {
                     98:                        int count=cache_chunk->count;
                     99:                        cache_chunk_base+=count;
                    100:                        cache_chunk=cache_chunk->rows[count].link;
                    101:                }
                    102:                
                    103:                return cache_chunk->rows[index-cache_chunk_base].item;
                    104:        }
                    105: 
1.15      paf       106:        Item *get(int index) const;
1.17      paf       107:        void put(int index, Item *item);
1.24      paf       108:        /// convinient way to get strings from Array. I long for Array<const String *>
1.12      paf       109:        const String *get_string(int index) const { 
1.28      paf       110:                return const_cast<const String *>(static_cast<String *>(get(index))); 
1.12      paf       111:        }
1.29      paf       112: 
                    113:        /// iterate over all elements
1.31      paf       114:        void for_each(For_each_func func, void *info=0) const;
1.29      paf       115: 
1.32      paf       116:        /// iterate over all elements until condition, const info
                    117:        void* first_that(First_that_func_const func, const void *info=0) const;
                    118: 
1.29      paf       119:        /// iterate over all elements until condition
1.32      paf       120:        void* first_that(First_that_func func, void *info=0) const;
1.1       paf       121: 
1.7       paf       122: private:
                    123: 
1.1       paf       124:        struct Chunk {
                    125:                // the number of rows in chunk
                    126:                int count;
                    127:                union Row {
1.15      paf       128:                        Item *item;
1.1       paf       129:                        Chunk *link;  // link to the next chunk in chain
                    130:                } rows[1];
                    131:                // next rows are here
                    132:        }
                    133:                *head;  // the head chunk of the chunk chain
                    134: 
1.5       paf       135:        // last allocated chunk
                    136:        // helps appending Arrays
                    137:        Chunk *tail;
                    138: 
1.1       paf       139:        // next append would write to this record
                    140:        Chunk::Row *append_here;
                    141:        
                    142:        // the address of place where lies address 
                    143:        // of the link to the next chunk to allocate
                    144:        Chunk::Row *link_row;
                    145: 
                    146: private:
1.7       paf       147: 
1.1       paf       148:        // array size
                    149:        int fused_rows;
                    150: 
1.12      paf       151:        mutable int cache_chunk_base;
                    152:        mutable Chunk *cache_chunk;
1.2       paf       153:        
1.1       paf       154: private:
                    155: 
                    156:        bool chunk_is_full() {
                    157:                return append_here == link_row;
                    158:        }
1.5       paf       159:        void expand(int chunk_rows);
1.2       paf       160: 
1.1       paf       161: private: //disabled
                    162: 
1.11      paf       163:        //Array(Array&) { }
1.12      paf       164:        Array& operator = (const Array&) { return *this; }
1.1       paf       165: };
                    166: 
                    167: #endif

E-mail: