|
|
| version 1.35, 2001/04/23 15:49:58 | version 1.78, 2009/04/30 04:40:30 |
|---|---|
| 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-2009 ArtLebedev Group (http://www.artlebedev.com) |
| Author: Alexandr Petrosian <paf@design.ru> (http://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> | static const char * const IDENT_ARRAY_Y="$Date$"; |
| #include "pa_pool.h" | // includes |
| #include "pa_types.h" | |
| #include "pa_string.h" | |
| /** | |
| Pooled Array. | |
| Internal structure: | |
| @verbatim | |
| Array Chunk0 | |
| ====== ======== | |
| head--------------->[ptr] | |
| append_here-------->[ptr] | |
| link_row ........ | |
| . . | |
| . [ptr] | |
| ...........>[link to the next chunk] | |
| @endverbatim | |
| */ | |
| class Array : public Pooled { | #include "pa_memory.h" |
| public: | #include "pa_exception.h" |
| /// Array item type | // forwards |
| typedef void Item; | |
| /*/// for_each iterator function type, const info | template<typename T> class Array_iterator; |
| typedef void (*For_each_func_const)(Item *value, const void *info); | |
| */ | |
| /// for_each iterator function type | // defines |
| typedef void (*For_each_func)(Item *value, void *info); | |
| /// first_that iterator function type, const info | #define ARRAY_OPTION_LIMIT_ALL ((size_t)-1) |
| typedef bool (*First_that_func_const)(Item *value, const void *info); | |
| /// first_that iterator function type | /// Simple Array |
| typedef bool (*First_that_func)(Item *value, void *info); | template<typename T> class Array: public PA_Object { |
| enum { | friend class Array_iterator<T>; |
| CR_INITIAL_ROWS_DEFAULT=10, ///< default preallocated row count | |
| CR_GROW_PERCENT=60 ///< each time the Array chunk_is_full() array expanded() | protected: |
| }; | |
| /// elements[growing size] here | |
| T *felements; | |
| // allocated size | |
| size_t fallocated; | |
| // array size | |
| size_t fused; | |
| public: | public: |
| 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==ARRAY_OPTION_LIMIT_ALL || limit>m) | |
| limit=m; | |
| Array(Pool& apool, int initial_rows=CR_INITIAL_ROWS_DEFAULT); | return true; |
| } | |
| /** | |
| size Array. how many items are in it. | }; |
| must be used with quick_get like this: | |
| @code | |
| int size=src.quick_size(); | |
| for(int i=0; i<size; i++) { | |
| z=src.quick_get(i); | |
| } | |
| @endcode | |
| */ | |
| int quick_size() const { | |
| // for quick_get | |
| cache_chunk_base=0; | |
| cache_chunk=head; | |
| return size(); | |
| } | |
| /// size Array. how many items are in it | |
| int size() const { return fused_rows; } | |
| /// append Item to array | |
| Array& operator += (Item *src); | |
| /// dirty hack to allow constant items storage. I long for Array<const Item*> | typedef T element_type; |
| Array& operator += (const Item *src) { return *this+=const_cast<Item*>(src); } | |
| /// append other Array portion to this one. starting from offset | inline Array(size_t initial=0): |
| Array& append_array(const Array& src, int offset=0); | fallocated(initial), |
| fused(0) | |
| { | |
| felements=fallocated?(T *)pa_malloc(fallocated*sizeof(T)):0; | |
| } | |
| #ifdef USE_DESTRUCTORS | |
| inline ~Array(){ | |
| if(felements) | |
| pa_free(felements); | |
| } | |
| #endif | |
| /** | /// how many items are in Array |
| quickly gets some item considering... | inline size_t count() const { return fused; } |
| /// append to array | |
| inline Array& operator+=(T src) { | |
| if(is_full()) | |
| expand(fallocated>0?2:3); // 3 is PAF default, confirmed by tests | |
| these true: | felements[fused++]=src; |
| - index increments from 0 to size()-1 | |
| - index>=0 && index<size() | return *this; |
| - index>=cache_chunk_base | } |
| */ | |
| Item *quick_get(int index) const { | /// append other Array portion to this one. starting from offset |
| // next chunk will be with "index" row | Array& append(const Array& src, |
| if(!(index<cache_chunk_base+cache_chunk->count)) { | size_t offset=0, |
| int count=cache_chunk->count; | size_t limit=ARRAY_OPTION_LIMIT_ALL, //< negative limit means 'all'. zero limit means 'nothing' |
| cache_chunk_base+=count; | bool reverse=false) { |
| cache_chunk=cache_chunk->rows[count].link; | |
| size_t src_count=src.count(); | |
| // skip tivials | |
| if(!src_count || !limit || offset>=src_count) | |
| return *this; | |
| // max(limit) | |
| size_t m=reverse? | |
| 1+offset | |
| :src_count-offset; | |
| if(!m) | |
| return *this; | |
| // fix limit | |
| if(limit==ARRAY_OPTION_LIMIT_ALL || limit>m) | |
| limit=m; | |
| ssize_t delta=reverse? | |
| (ssize_t)limit | |
| :limit-(fallocated-fused); | |
| if(delta>0) | |
| expand(delta); | |
| T* from=&src.felements[offset]; | |
| T* to=&felements[fused]; | |
| if(reverse) { // reverse | |
| for(T* from_end=from-limit; from>from_end; --from) | |
| *to++=*from; | |
| } else { // forward | |
| for(T* from_end=from+limit; from<from_end; from++) | |
| *to++=*from; | |
| } | } |
| return cache_chunk->rows[index-cache_chunk_base].item; | fused+=limit; |
| return *this; | |
| } | } |
| Item *get(int index) const; | /// get index-element |
| void put(int index, Item *item); | inline T get(size_t index) const { |
| /// convinient way to get strings from Array. I long for Array<const String *> | assert(index<count()); |
| const String *get_string(int index) const { | return felements[index]; |
| return const_cast<const String *>(static_cast<String *>(get(index))); | |
| } | } |
| const String *quick_get_string(int index) const { | |
| return const_cast<const String *>(static_cast<String *>(quick_get(index))); | /// ref version of get |
| inline T& get_ref(size_t index) const { | |
| assert(index<count()); | |
| return felements[index]; | |
| } | } |
| /*/// iterate over all elements, const info | /// put index-element |
| void for_each(For_each_func_const func, const void *info=0) const; | inline void put(size_t index, T element) { |
| /*/ | assert(index<count()); |
| felements[index]=element; | |
| } | |
| inline T operator [](size_t index) const { return get(index); } | |
| /// iterate over all elements | /// iterate over all elements |
| void for_each(For_each_func func, void *info=0) const; | template<typename I> void for_each(void (*callback)(T, I), I info) const { |
| T *last=felements+fused; | |
| for(T *current=felements; current<last; current++) | |
| callback(*current, info); | |
| } | |
| /// iterate over all elements until condition, const info | /// iterate over all elements |
| void* first_that(First_that_func_const func, const void *info=0) const; | template<typename I> void for_each(bool (*callback)(T, I), I info) const { |
| T *last=felements+fused; | |
| for(T *current=felements; current<last; current++) | |
| if(callback(*current, info)) | |
| return; | |
| } | |
| /// iterate over all elements until condition | /// iterate over all elements |
| void* first_that(First_that_func func, void *info=0) const; | template<typename I> void for_each_ref(void (*callback)(T&, I), I info) { |
| T *last=felements+fused; | |
| for(T *current=felements; current<last; current++) | |
| callback(*current, info); | |
| } | |
| private: | /// iterate over all elements until condition becomes true, return that element |
| template<typename I> T first_that(bool (*callback)(T, I), I info) const { | |
| struct Chunk { | T *last=felements+fused; |
| // the number of rows in chunk | for(T *current=felements; current<last; current++) |
| int count; | if(callback(*current, info)) |
| union Row { | return *current; |
| 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: | return T(0); |
| } | |
| // array size | inline T* ptr(size_t index){ |
| int fused_rows; | return felements + index; |
| } | |
| mutable int cache_chunk_base; | protected: |
| mutable Chunk *cache_chunk; | |
| private: | |
| bool chunk_is_full() { | bool is_full() { |
| return append_here == link_row; | return fused == fallocated; |
| } | |
| void expand(size_t delta) { | |
| if(fallocated){ | |
| size_t new_allocated=fallocated+delta; | |
| felements=(T *)pa_realloc(felements, new_allocated*sizeof(T)); | |
| fallocated=new_allocated; | |
| } else { | |
| fallocated=delta; | |
| felements=(T *)pa_malloc(fallocated*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; } |
| }; | }; |
| /** Array iterator, usage: | |
| @code | |
| // Array<T> a; | |
| for(Array_iterator<T> i(a); i.has_next(); ) { | |
| 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.count(); | |
| } | |
| /// there are still elements | |
| bool has_next() { | |
| return fcurrent<flast; | |
| } | |
| /// quickly extracts next Array element | |
| T next() { | |
| return *(fcurrent++); | |
| } | |
| }; | |
| #endif | #endif |