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

1.24      paf         1: /** @file
1.59      paf         2:        Parser: Array & Array_iterator classes decls.
1.26      paf         3: 
1.71      misha       4:        Copyright (c) 2001-2009 ArtLebedev Group (http://www.artlebedev.com)
1.53      paf         5:        Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.1       paf         6: */
                      7: 
1.24      paf         8: #ifndef PA_ARRAY_H
                      9: #define PA_ARRAY_H
1.54      paf        10: 
1.78    ! misha      11: static const char * const IDENT_ARRAY_Y="$Date: 2009-04-30 04:39:06 $";
1.24      paf        12: 
1.59      paf        13: // includes
                     14: 
                     15: #include "pa_memory.h"
                     16: #include "pa_exception.h"
                     17: 
                     18: // forwards
                     19: 
                     20: template<typename T> class Array_iterator;
                     21: 
                     22: // defines
                     23: 
                     24: #define ARRAY_OPTION_LIMIT_ALL ((size_t)-1)
                     25: 
                     26: /// Simple Array
                     27: template<typename T> class Array: public PA_Object {
                     28: 
                     29:        friend class Array_iterator<T>;
                     30: 
                     31: protected:
                     32: 
                     33:        /// elements[growing size] here
                     34:        T *felements;
                     35: 
                     36:        // allocated size
                     37:        size_t fallocated;
                     38: 
                     39:        // array size
                     40:        size_t fused;
1.1       paf        41: 
                     42: public:
1.59      paf        43:        struct Action_options {
                     44:                size_t offset;
                     45:                size_t limit; //< ARRAY_OPTION_LIMIT_ALL means 'all'. zero limit means 'nothing'
                     46:                bool reverse;
                     47:                bool defined;
                     48:                
                     49:                Action_options(
                     50:                        size_t aoffset=0, 
                     51:                        size_t alimit=ARRAY_OPTION_LIMIT_ALL, 
                     52:                        bool areverse=false): 
                     53:                        offset(aoffset), limit(alimit), reverse(areverse), 
                     54:                        defined(false) {}
                     55: 
                     56:                bool adjust(size_t count) {
                     57:                        if(!count || !limit)
                     58:                                return false;
1.70      misha      59:                        if(offset>=count)
1.59      paf        60:                                return false;
                     61:                        // max(limit)
                     62:                        size_t m=reverse?
1.69      misha      63:                                offset+1
1.59      paf        64:                                :count-offset;
                     65:                        if(!m)
                     66:                                return false;
                     67:                        // fix limit
                     68:                        if(limit==ARRAY_OPTION_LIMIT_ALL || limit>m)
                     69:                                limit=m;
1.7       paf        70: 
1.59      paf        71:                        return true;
                     72:                }
1.29      paf        73: 
1.59      paf        74:                
1.1       paf        75:        };
                     76: 
1.59      paf        77:        typedef T element_type;
                     78: 
1.71      misha      79:        inline Array(size_t initial=0):
                     80:                fallocated(initial),
1.59      paf        81:                fused(0)
                     82:        {
1.77      misha      83:                felements=fallocated?(T *)pa_malloc(fallocated*sizeof(T)):0;
1.59      paf        84:        }
1.6       paf        85: 
1.74      misha      86: #ifdef USE_DESTRUCTORS 
1.73      misha      87:        inline ~Array(){
1.75      misha      88:                if(felements)
1.77      misha      89:                        pa_free(felements);
1.72      misha      90:        }
1.74      misha      91: #endif
1.72      misha      92: 
1.59      paf        93:        /// how many items are in Array
1.71      misha      94:        inline size_t count() const { return fused; }
1.59      paf        95:        /// append to array
1.71      misha      96:        inline Array& operator+=(T src) {
1.59      paf        97:                if(is_full())
1.71      misha      98:                        expand(fallocated>0?2:3); // 3 is PAF default, confirmed by tests
1.7       paf        99: 
1.59      paf       100:                felements[fused++]=src;
1.24      paf       101: 
1.59      paf       102:                return *this;
                    103:        }
1.24      paf       104: 
                    105:        /// append other Array portion to this one. starting from offset
1.59      paf       106:        Array& append(const Array& src, 
                    107:                size_t offset=0, 
                    108:                size_t limit=ARRAY_OPTION_LIMIT_ALL, //< negative limit means 'all'. zero limit means 'nothing'
                    109:                bool reverse=false) {
                    110: 
                    111:                size_t src_count=src.count();
                    112:                // skip tivials
                    113:                if(!src_count || !limit || offset>=src_count)
                    114:                        return *this;
                    115:                // max(limit)
                    116:                size_t m=reverse?
                    117:                        1+offset
                    118:                        :src_count-offset;
                    119:                if(!m)
                    120:                        return *this;
                    121:                // fix limit
                    122:                if(limit==ARRAY_OPTION_LIMIT_ALL || limit>m)
                    123:                        limit=m;
                    124: 
                    125:                ssize_t delta=reverse?
                    126:                        (ssize_t)limit
                    127:                        :limit-(fallocated-fused);
                    128:                if(delta>0)
                    129:                        expand(delta);
                    130: 
                    131:                T* from=&src.felements[offset];
                    132:                T* to=&felements[fused];
                    133:                if(reverse) { // reverse
                    134:                        for(T* from_end=from-limit; from>from_end; --from)
                    135:                                *to++=*from;
                    136: 
                    137:                } else { // forward
                    138:                        for(T* from_end=from+limit; from<from_end; from++)
                    139:                                *to++=*from;
                    140:                }
                    141:                
                    142:                fused+=limit;
                    143:                return *this;
                    144:        }
                    145: 
                    146:        /// get index-element
1.71      misha     147:        inline T get(size_t index) const {
1.63      paf       148:                assert(index<count());
1.59      paf       149:                return felements[index];
                    150:        }
                    151: 
                    152:        /// ref version of get
1.71      misha     153:        inline T& get_ref(size_t index) const {
1.63      paf       154:                assert(index<count());
1.59      paf       155:                return felements[index];
                    156:        }
                    157: 
                    158:        /// put index-element
1.71      misha     159:        inline void put(size_t index, T element) {
1.63      paf       160:                assert(index<count());
1.59      paf       161:                felements[index]=element;
                    162:        }
                    163: 
1.71      misha     164:        inline T operator [](size_t index) const { return get(index); }
1.29      paf       165: 
                    166:        /// iterate over all elements
1.59      paf       167:        template<typename I> void for_each(void (*callback)(T, I), I info) const {
1.60      paf       168:                T *last=felements+fused;
                    169:                for(T *current=felements; current<last; current++)
                    170:                        callback(*current, info);
                    171:        }
                    172: 
                    173:        /// iterate over all elements
1.68      paf       174:        template<typename I> void for_each(bool (*callback)(T, I), I info) const {
                    175:                T *last=felements+fused;
                    176:                for(T *current=felements; current<last; current++)
                    177:                        if(callback(*current, info))
                    178:                                return;
                    179:        }
                    180: 
                    181:        /// iterate over all elements
1.60      paf       182:        template<typename I> void for_each_ref(void (*callback)(T&, I), I info) {
1.59      paf       183:                T *last=felements+fused;
                    184:                for(T *current=felements; current<last; current++)
                    185:                        callback(*current, info);
                    186:        }
1.49      paf       187: 
1.59      paf       188:        /// iterate over all elements until condition becomes true, return that element
                    189:        template<typename I> T first_that(bool (*callback)(T, I), I info) const {
                    190:                T *last=felements+fused;
                    191:                for(T *current=felements; current<last; current++)
                    192:                        if(callback(*current, info))
                    193:                                return *current;
1.1       paf       194: 
1.59      paf       195:                return T(0);
                    196:        }
1.1       paf       197: 
1.76      misha     198:        inline T* ptr(size_t index){
                    199:                return felements + index;
                    200:        }
                    201: 
1.59      paf       202: protected:
1.1       paf       203: 
1.59      paf       204:        bool is_full() {
                    205:                return fused == fallocated;
                    206:        }
                    207:        void expand(size_t delta) {
1.71      misha     208:                if(fallocated){
                    209:                        size_t new_allocated=fallocated+delta;
1.77      misha     210:                        felements=(T *)pa_realloc(felements, new_allocated*sizeof(T));
1.71      misha     211:                        fallocated=new_allocated;
                    212:                } else {
                    213:                        fallocated=delta;
1.77      misha     214:                        felements=(T *)pa_malloc(fallocated*sizeof(T));
1.71      misha     215:                }
1.1       paf       216:        }
1.2       paf       217: 
1.1       paf       218: private: //disabled
                    219: 
1.59      paf       220:        Array(const Array&) {}
1.12      paf       221:        Array& operator = (const Array&) { return *this; }
1.42      parser    222: };
                    223: 
                    224: 
1.59      paf       225: /** Array iterator, usage:
                    226:        @code
                    227:        // Array<T> a;
                    228:        for(Array_iterator<T> i(a); i.has_next(); ) {
                    229:                T& element=i.next();
                    230:                ...
                    231:        }       
                    232:        @endcode
                    233: */
                    234: template<typename T> class Array_iterator {
                    235: 
                    236:        const Array<T>& farray;
                    237:        T *fcurrent;
                    238:        T *flast;
                    239: 
1.42      parser    240: public:
                    241: 
1.59      paf       242:        Array_iterator(const Array<T>& aarray): farray(aarray) {
                    243:                fcurrent=farray.felements;
                    244:                flast=farray.felements+farray.count();
1.42      parser    245:        }
                    246: 
                    247:        /// there are still elements
                    248:        bool has_next() {
1.59      paf       249:                return fcurrent<flast;
1.42      parser    250:        }
                    251: 
1.59      paf       252:        /// quickly extracts next Array element
1.68      paf       253:        T next() {
1.59      paf       254:                return *(fcurrent++);
                    255:        }
                    256: 
                    257: };
1.1       paf       258: #endif

E-mail: