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

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.74    ! misha      11: static const char * const IDENT_ARRAY_Y="$Date: 2009-04-17 23:21:12 $";
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.71      misha      83:                felements=fallocated?static_cast<T*>(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.72      misha      88:                free(felements);
                     89:        }
1.74    ! misha      90: #endif
1.72      misha      91: 
1.59      paf        92:        /// how many items are in Array
1.71      misha      93:        inline size_t count() const { return fused; }
1.59      paf        94:        /// append to array
1.71      misha      95:        inline Array& operator+=(T src) {
1.59      paf        96:                if(is_full())
1.71      misha      97:                        expand(fallocated>0?2:3); // 3 is PAF default, confirmed by tests
1.7       paf        98: 
1.59      paf        99:                felements[fused++]=src;
1.24      paf       100: 
1.59      paf       101:                return *this;
                    102:        }
1.24      paf       103: 
                    104:        /// append other Array portion to this one. starting from offset
1.59      paf       105:        Array& append(const Array& src, 
                    106:                size_t offset=0, 
                    107:                size_t limit=ARRAY_OPTION_LIMIT_ALL, //< negative limit means 'all'. zero limit means 'nothing'
                    108:                bool reverse=false) {
                    109: 
                    110:                size_t src_count=src.count();
                    111:                // skip tivials
                    112:                if(!src_count || !limit || offset>=src_count)
                    113:                        return *this;
                    114:                // max(limit)
                    115:                size_t m=reverse?
                    116:                        1+offset
                    117:                        :src_count-offset;
                    118:                if(!m)
                    119:                        return *this;
                    120:                // fix limit
                    121:                if(limit==ARRAY_OPTION_LIMIT_ALL || limit>m)
                    122:                        limit=m;
                    123: 
                    124:                ssize_t delta=reverse?
                    125:                        (ssize_t)limit
                    126:                        :limit-(fallocated-fused);
                    127:                if(delta>0)
                    128:                        expand(delta);
                    129: 
                    130:                T* from=&src.felements[offset];
                    131:                T* to=&felements[fused];
                    132:                if(reverse) { // reverse
                    133:                        for(T* from_end=from-limit; from>from_end; --from)
                    134:                                *to++=*from;
                    135: 
                    136:                } else { // forward
                    137:                        for(T* from_end=from+limit; from<from_end; from++)
                    138:                                *to++=*from;
                    139:                }
                    140:                
                    141:                fused+=limit;
                    142:                return *this;
                    143:        }
                    144: 
                    145:        /// get index-element
1.71      misha     146:        inline T get(size_t index) const {
1.63      paf       147:                assert(index<count());
1.59      paf       148:                return felements[index];
                    149:        }
                    150: 
                    151:        /// ref version of get
1.71      misha     152:        inline T& get_ref(size_t index) const {
1.63      paf       153:                assert(index<count());
1.59      paf       154:                return felements[index];
                    155:        }
                    156: 
                    157:        /// put index-element
1.71      misha     158:        inline void put(size_t index, T element) {
1.63      paf       159:                assert(index<count());
1.59      paf       160:                felements[index]=element;
                    161:        }
                    162: 
1.71      misha     163:        inline T operator [](size_t index) const { return get(index); }
1.29      paf       164: 
                    165:        /// iterate over all elements
1.59      paf       166:        template<typename I> void for_each(void (*callback)(T, I), I info) const {
1.60      paf       167:                T *last=felements+fused;
                    168:                for(T *current=felements; current<last; current++)
                    169:                        callback(*current, info);
                    170:        }
                    171: 
                    172:        /// iterate over all elements
1.68      paf       173:        template<typename I> void for_each(bool (*callback)(T, I), I info) const {
                    174:                T *last=felements+fused;
                    175:                for(T *current=felements; current<last; current++)
                    176:                        if(callback(*current, info))
                    177:                                return;
                    178:        }
                    179: 
                    180:        /// iterate over all elements
1.60      paf       181:        template<typename I> void for_each_ref(void (*callback)(T&, I), I info) {
1.59      paf       182:                T *last=felements+fused;
                    183:                for(T *current=felements; current<last; current++)
                    184:                        callback(*current, info);
                    185:        }
1.49      paf       186: 
1.59      paf       187:        /// iterate over all elements until condition becomes true, return that element
                    188:        template<typename I> T first_that(bool (*callback)(T, I), I info) const {
                    189:                T *last=felements+fused;
                    190:                for(T *current=felements; current<last; current++)
                    191:                        if(callback(*current, info))
                    192:                                return *current;
1.1       paf       193: 
1.59      paf       194:                return T(0);
                    195:        }
1.1       paf       196: 
1.59      paf       197: protected:
1.1       paf       198: 
1.59      paf       199:        bool is_full() {
                    200:                return fused == fallocated;
                    201:        }
                    202:        void expand(size_t delta) {
1.71      misha     203:                if(fallocated){
                    204:                        size_t new_allocated=fallocated+delta;
                    205:                        felements = (T *)realloc(felements, new_allocated*sizeof(T));
                    206:                        memset(&felements[fallocated], 0, delta*sizeof(T));
                    207:                        fallocated=new_allocated;
                    208:                } else {
                    209:                        fallocated=delta;
                    210:                        felements=static_cast<T*>(malloc(fallocated*sizeof(T)));
                    211:                }
1.1       paf       212:        }
1.2       paf       213: 
1.1       paf       214: private: //disabled
                    215: 
1.59      paf       216:        Array(const Array&) {}
1.12      paf       217:        Array& operator = (const Array&) { return *this; }
1.42      parser    218: };
                    219: 
                    220: 
1.59      paf       221: /** Array iterator, usage:
                    222:        @code
                    223:        // Array<T> a;
                    224:        for(Array_iterator<T> i(a); i.has_next(); ) {
                    225:                T& element=i.next();
                    226:                ...
                    227:        }       
                    228:        @endcode
                    229: */
                    230: template<typename T> class Array_iterator {
                    231: 
                    232:        const Array<T>& farray;
                    233:        T *fcurrent;
                    234:        T *flast;
                    235: 
1.42      parser    236: public:
                    237: 
1.59      paf       238:        Array_iterator(const Array<T>& aarray): farray(aarray) {
                    239:                fcurrent=farray.felements;
                    240:                flast=farray.felements+farray.count();
1.42      parser    241:        }
                    242: 
                    243:        /// there are still elements
                    244:        bool has_next() {
1.59      paf       245:                return fcurrent<flast;
1.42      parser    246:        }
                    247: 
1.59      paf       248:        /// quickly extracts next Array element
1.68      paf       249:        T next() {
1.59      paf       250:                return *(fcurrent++);
                    251:        }
                    252: 
                    253: };
1.1       paf       254: #endif

E-mail: