Diff for /parser3/src/include/pa_hash.h between versions 1.45 and 1.83

version 1.45, 2001/10/26 13:48:18 version 1.83, 2010/08/11 16:17:27
Line 1 Line 1
 /** @file  /** @file
         Parser: hash class decl.          Parser: hash class decl.
   
         Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)          Copyright (c) 2001-2009 ArtLebedev Group (http://www.artlebedev.com)
   
         Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)          Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
   */
   
         $Id$  /*
           The prime numbers used from zend_hash.c,
           the part of Zend scripting engine library,
           Copyrighted (C) 1999-2000    Zend Technologies Ltd.
           http://www.zend.com/license/0_92.txt
           For more information about Zend please visit http://www.zend.com/
 */  */
   
 #ifndef PA_HASH_H  #ifndef PA_HASH_H
 #define PA_HASH_H  #define PA_HASH_H
   
 #include "pa_config_includes.h"  static const char * const IDENT_HASH_H="$Date$";
 #include "pa_pool.h"  
   #include "pa_memory.h"
 #include "pa_types.h"  #include "pa_types.h"
 #include "pa_string.h"  #include "pa_string.h"
   
   const int HASH_ALLOCATES_COUNT=29;
   
 /**   /** Zend comment: Generated on an Octa-ALPHA 300MHz CPU & 2.5GB RAM monster 
         Pooled hash.  
   
         Automatically rehashed when almost full.          paf: HPUX ld could not handle static member: unsatisfied symbols
 */  */
 class Hash : public Pooled {  static uint Hash_allocates[HASH_ALLOCATES_COUNT]={
 public:          5, 11, 19, 53, 107, 223, 463, 983, 1979, 3907, 7963, 
           16229, 32531, 65407, 130987, 262237, 524521, 1048793, 
           2097397, 4194103, 8388857, 16777447, 33554201, 67108961, 
           134217487, 268435697, 536870683, 1073741621, 2147483399};
   
   /// useful generic hash function
   inline void generic_hash_code(uint& result, char c) {
           result=(result<<4)+c;
           if(uint g=(result&0xF0000000)) {
                   result=result^(g>>24);
                   result=result^g;
           }
   }
   /// useful generic hash function
   inline void generic_hash_code(uint& result, const char* s) {
           while(char c=*s++) {
                   result=(result<<4)+c;
                   if(uint g=(result&0xF0000000)) {
                           result=result^(g>>24);
                           result=result^g;
                   }
           }
   }
   
         typedef String Key; ///< hash Key type. longing for templates  /// useful generic hash function
         typedef void Val; ///< hash Val type. longing for templates  inline void generic_hash_code(uint& result, const char* buf, size_t size) {
           const char* end=buf+size;
           while(buf<end) {
                   result=(result<<4)+*buf++;
                   if(uint g=(result&0xF0000000)) {
                           result=result^(g>>24);
                           result=result^g;
                   }
           }
   }
   
   /// simple hash code of int. used by EXIF mapping
   inline uint hash_code(int self) {
           uint result=0;
           generic_hash_code(result, (const char*)&self, sizeof(self));
           return result;
   }
   
         /// for_each iterator function type  #endif // PA_HASH_H
         typedef void (*For_each_func)(const Key& key, Val *value, void *info);  
   
         /// for_each iterator function type  #ifndef PA_HASH_CLASS
         typedef void (*For_each_func_refed)(const Key& key, Val *& value, void *info);  #define PA_HASH_CLASS
   /** 
           Simple hash.
   
         /// first_that iterator function type          Automatically rehashed when almost is_full.
         typedef void *(*First_that_func)(const Key& key, Val *value, void *info);          Contains no 0 values. 
                   get returning 0 means there were no such.
                   "put value 0" means "remove"
   */
   #ifdef HASH_ORDER
   
   #undef HASH
   #undef HASH_STRING
   #undef HASH_NEW_PAIR
   #undef HASH_FOR_EACH
   
   #define HASH OrderedHash
   #define HASH_STRING OrderedHashString
   #define HASH_NEW_PAIR(code, key, value) *ref=new Pair(code, key, value, *ref, this->last); this->last=&((*ref)->next)
   
   #define HASH_FOR_EACH \
           for(Pair *pair=this->first; pair; pair=pair->next)
   
   #else
   
   #define HASH Hash
   #define HASH_STRING HashString
   #define HASH_NEW_PAIR(code, key, value) *ref=new Pair(code, key, value, *ref)
   
   #define HASH_FOR_EACH \
           Pair **ref=this->refs; \
           for(int index=0; index<this->allocated; index++) \
                   for(Pair *pair=*ref++; pair; pair=pair->link)
   
   #endif
   
   template<typename K, typename V> class HASH: public PA_Object {
 public:  public:
   
         Hash(Pool& apool) : Pooled(apool) {           typedef K key_type;
                 construct_new();           typedef V value_type;
   
           HASH() { 
                   allocated=Hash_allocates[allocates_index=0];
                   fpairs_count=fused_refs=0;
                   refs=new(UseGC) Pair*[allocated];
   #ifdef HASH_ORDER
                   first=0;
                   last=&first;
   #endif
         }          }
   
         Hash(const Hash& source) : Pooled(source.pool()){          HASH(const HASH& source) {
                 construct_copy(source);                  allocates_index=source.allocates_index;
                   allocated=source.allocated;
                   fused_refs=source.fused_refs;
                   fpairs_count=source.fpairs_count;
                   refs=new(UseGC) Pair*[allocated];
                   // clone & rehash
   #ifdef HASH_ORDER
                   first=0;
                   last=&first;
                   for(Pair *pair=source.first; pair; pair=pair->next)
                   {
                           uint index=pair->code%allocated;
                           Pair **ref=&refs[index];
                           HASH_NEW_PAIR(pair->code, pair->key, pair->value);
                   }
   #else
                   for(int i=0; i<source.allocated; i++)
                           for(Pair *pair=source.refs[i]; pair; pair=pair->link)
                           {
                                   Pair **ref=&refs[i];
                                   HASH_NEW_PAIR(pair->code, pair->key, pair->value);
                           }
   #endif
         }          }
   
         /// useful generic hash function  #ifdef USE_DESTRUCTORS
         static uint generic_code(uint aresult, const char *start, uint allocated);          ~HASH() {
                   Pair **ref=refs;
                   for(int index=0; index<allocated; index++)
                           for(Pair *pair=*ref++; pair;){
                                   Pair *next=pair->link;
                                   delete pair;
                                   pair=next;
                           }
                   delete[] refs;
           }
   #endif
   
         /// put a [value] under the [key], return existed or not          /// put a [value] under the [key] @returns existed or not
         bool put(const Key& key, Val *value);          bool put(K key, V value) {
 /*                  if(!value) {
         /// dirty hack to allow constant items storage. I long for Hash<const Val*>                          remove(key);
         bool put(const Key& key, const Val *value) {                          return false;
                 return put(key, const_cast<Val *>(value));                   }
                   if(is_full()) 
                           expand();
   
                   uint code=hash_code(key);
                   uint index=code%allocated;
                   Pair **ref=&refs[index];
                   for(Pair *pair=*ref; pair; pair=pair->link)
                           if(pair->code==code && pair->key==key) {
                                   // found a pair with the same key
                                   pair->value=value;
                                   return true;
                           }
                   
                   // proper pair not found -- create&link_in new pair
                   if(!*ref) // root cell were fused_refs?
                           fused_refs++; // not, we'll use it and record the fact
                   HASH_NEW_PAIR(code, key, value);
                   fpairs_count++;
                   return false;
         }          }
 */  
           /// remove the [key] @returns existed or not
           bool remove(K key) {
                   uint code=hash_code(key);
                   uint index=code%allocated;
                   for(Pair **ref=&refs[index]; *ref; ref=&(*ref)->link){
                           Pair *pair=*ref;
                           if(pair->code==code && pair->key==key) {
                                   // found a pair with the same key
                                   Pair *next=pair->link;
   #ifdef HASH_ORDER
                                   *(pair->prev)=pair->next;
                                   if(pair->next)
                                           pair->next->prev=pair->prev;
                                   else
                                           last=pair->prev;
   #endif
                                   delete pair;
                                   *ref=next;
                                   --fpairs_count;
                                   return true;
                           }
                   }
   
                   return false;
           }
   
           /// return true if key exists
           bool contains(K key){
                   uint code=hash_code(key);
                   uint index=code%allocated;
                   for(Pair *pair=refs[index]; pair; pair=pair->link){
                           if(pair->code==code && pair->key==key)
                                   return true;
                   }
   
                   return false;
           }
   
         /// get associated [value] by the [key]          /// get associated [value] by the [key]
         Val *get(const Key& key) const;          V get(K key) const {
                   uint code=hash_code(key);
                   uint index=code%allocated;
                   for(Pair *pair=refs[index]; pair; pair=pair->link)
                           if(pair->code==code && pair->key==key)
                                   return pair->value;
                   
                   return V(0);
           }
   
         /// put a [value] under the [key] if that [key] existed, return existed or not  #ifdef HASH_ORDER
         bool put_replace(const Key& key, Val *value);          V first_value() const {
                   return (first) ? first->value : V(0);
           }
   
         /// put a [value] under the [key] if that [key] NOT existed, return existed or not          V last_value() const {
         bool put_dont_replace(const Key& key, Val *value);                  return (fpairs_count) ? ((Pair *)((char *)last - offsetof(Pair, next)))->value : V(0);
           }
   #endif
   
         /// put all 'src' values if NO with same key existed          /// put a [value] under the [key] if that [key] existed @returns existed or not
         void merge_dont_replace(const Hash& src);          bool put_replaced(K key, V value) {
                   if(!value) {
                           remove(key);
                           return false;
                   }
                   uint code=hash_code(key);
                   uint index=code%allocated;
                   for(Pair *pair=refs[index]; pair; pair=pair->link)
                           if(pair->code==code && pair->key==key) {
                                   // found a pair with the same key, replacing
                                   pair->value=value;
                                   return true;
                           }
   
                   // proper pair not found 
                   return false;
           }
   
         void put(const Key& key, int     value) { put(key, reinterpret_cast<Val *>(value)); }          /// put a [value] under the [key] if that [key] NOT existed @returns existed or not
         void put(const Key& key, const String *value) {           bool put_dont_replace(K key, V value) {
                 put(key, static_cast<Val *>(const_cast<String *>(value)));                   if(!value) {
                           remove(key);
                           return false;
                   }
                   if(is_full()) 
                           expand();
   
                   uint code=hash_code(key);
                   uint index=code%allocated;
                   Pair **ref=&refs[index];
                   for(Pair *pair=*ref; pair; pair=pair->link)
                           if(pair->code==code && pair->key==key) {
                                   // found a pair with the same key, NOT replacing
                                   return true;
                           }
   
                   // proper pair not found -- create&link_in new pair
                   if(!*ref) // root cell were fused_refs?
                           fused_refs++; // not, we'll use it and record the fact
                   HASH_NEW_PAIR(code, key, value);
                   fpairs_count++;
                   return false;
         }          }
   
         //@{          /// put all 'src' values if NO with same key existed
         /// handy get, longing for Hash<int>, Hash<String *>          void merge_dont_replace(const HASH& src) {
         int get_int(const Key& key) const { return reinterpret_cast<int>(get(key)); }  #ifdef HASH_ORDER
         const String *get_string(const Key& key) const { return static_cast<String *>(get(key)); }                  for(Pair *pair=src.first; pair; pair=pair->next)
         //@}  #else
                   for(int i=0; i<src.allocated; i++)
                           for(Pair *pair=src.refs[i]; pair; pair=pair->link)
   #endif
                                   put_dont_replace(pair->key, pair->value);
           }
   
         /// number of elements in hash          /// number of elements in hash
         int size() const { return count; }          int count() const { return fpairs_count; }
   
         /// iterate over all not zero elements          /// iterate over all pairs
         void for_each(For_each_func func, void *info=0) const;          template<typename I> void for_each(void callback(K, V, I), I info) const {
                   HASH_FOR_EACH
                           callback(pair->key, pair->value, info);
           }
   
         /// iterate over all not zero elements, passing references          /// iterate over all pairs
         void for_each(For_each_func_refed func, void *info=0) const;          template<typename I> void for_each_ref(void callback(K, V&, I), I info) const {
                   HASH_FOR_EACH
                           callback(pair->key, pair->value, info);
           }
   
         /// iterate over all elements until condition          /// iterate over all pairs until condition becomes true, return that element
         void *first_that(First_that_func func, void *info=0) const;          template<typename I> V first_that(bool callback(K, V, I), I info) const {
                   HASH_FOR_EACH
                           if(callback(pair->key, pair->value, info))
                                   return pair->value;
                   return V(0);
           }
   
         /// remove all elements          /// remove all elements
         void clear();          void clear() {
                   memset(refs, 0, sizeof(*refs)*allocated);
                   fpairs_count=fused_refs=0;      
   #ifdef HASH_ORDER
                   first=0;
                   last=&first;
   #endif
           }
   
 protected:  protected:
   
         void construct_new();          /// the index of [allocated] in [Hash_allocates]
         void construct_copy(const Hash& source);  
   
 private:  
   
         /// expand when these %% of allocated exausted  
         enum {  
                 THRESHOLD_PERCENT=75  
         };  
   
         /// the index of [allocated] in [allocates]  
         int allocates_index;          int allocates_index;
   
         /// possible [allocates]. prime numbers  
         static uint allocates[];  
         static int allocates_count;  
   
         /// number of allocated pairs          /// number of allocated pairs
         int allocated;          int allocated;
   
         /// helper: expanding when used == threshold  
         int threshold;  
   
         /// used pairs          /// used pairs
         int used;          int fused_refs;
   
         /// stored pairs total (including those by links)          /// stored pairs total (including those by links)
         int count;          int fpairs_count;
   
         /// pair storage          /// pair storage
         class Pair {          class Pair: public PA_Allocated {
                 friend Hash;          public:
   
                 uint code;                  uint code;
                 const Key key;                  K key;
                 Val *value;                  V value;
                 Pair *link;                  Pair *link;
                   #ifdef HASH_ORDER
                 void *operator new(size_t allocated, Pool& apool);                  Pair **prev;
                   Pair *next;
                 Pair(uint acode, const Key& akey, Val *avalue, Pair *alink) :  
                         code(acode),                  Pair(uint acode, K akey, V avalue, Pair *alink, Pair **aprev) : code(acode), key(akey), value(avalue), link(alink), 
                         key(akey),                          prev(aprev), next(0) { *aprev=this; }
                         value(avalue),  #else
                         link(alink) {}                  Pair(uint acode, K akey, V avalue, Pair *alink) : code(acode), key(akey), value(avalue), link(alink) {}
   #endif
         } **refs;          } **refs;
   
         /// filled to threshold: needs expanding  #ifdef HASH_ORDER
         bool full() { return used==threshold; }          Pair *first;
           Pair **last;
   #endif
   
           /// filled to threshold (THRESHOLD_PERCENT=75), needs expanding
           bool is_full() { return fused_refs + allocated/4 >= allocated; }
   
         /// allocate larger buffer & rehash          /// allocate larger buffer & rehash
         void expand();          void expand() {
                   int old_allocated=allocated;
                   Pair **old_refs=refs;
   
                   if (allocates_index<HASH_ALLOCATES_COUNT-1) allocates_index++;
                   // allocated bigger refs array
                   allocated=Hash_allocates[allocates_index];
                   refs=new(UseGC) Pair*[allocated];
   
                   // rehash
                   Pair **old_ref=old_refs;
                   for(int old_index=0; old_index<old_allocated; old_index++)
                           for(Pair *pair=*old_ref++; pair; ) {
                                   Pair *next=pair->link;
   
                                   uint new_index=pair->code%allocated;
                                   Pair **new_ref=&refs[new_index];
                                   pair->link=*new_ref;
                                   *new_ref=pair;
   
                                   pair=next;
                           }
   
                   delete[] old_refs;
           }
   
 private: //disabled  private: //disabled
   
         Hash& operator = (const Hash&) { return *this; }          HASH& operator = (const HASH&) { return *this; }
 };  };
   
   /** 
           Simple String::body hash.
           Allows hash code caching
   */
   
   #ifdef HASH_CODE_CACHING
   
   template<typename V> class HASH_STRING: public HASH<const CORD,V> {
   public:
   
           typedef typename HASH<const CORD,V>::Pair Pair; 
           typedef const String::Body &K;
   
           typedef K key_type;
           
           /// put a [value] under the [key] @returns existed or not
           bool put(K str, V value) {
                   if(!value) {
                           remove(str);
                           return false;
                   }
                   if(this->is_full()) 
                           this->expand();
   
                   CORD key=str.get_cord();
   
                   uint code=str.get_hash_code();
                   uint index=code%this->allocated;
                   Pair **ref=&this->refs[index];
                   for(Pair *pair=*ref; pair; pair=pair->link)
                           if(pair->code==code && CORD_cmp(pair->key,key)==0) {
                                   // found a pair with the same key
                                   pair->value=value;
                                   return true;
                           }
   
                   // proper pair not found -- create&link_in new pair
                   if(!*ref) // root cell were fused_refs?
                           this->fused_refs++; // not, we'll use it and record the fact
                   HASH_NEW_PAIR(code, key, value);
                   this->fpairs_count++;
                   return false;
           }
   
           /// remove the [key] @returns existed or not
           bool remove(K str) {
                   CORD key=str.get_cord();
                   uint code=str.get_hash_code();
                   uint index=code%this->allocated;
                   for(Pair **ref=&this->refs[index]; *ref; ref=&(*ref)->link){
                           Pair *pair=*ref;
                           if(pair->code==code && CORD_cmp(pair->key,key)==0) {
                                   // found a pair with the same key
                                   Pair *next=pair->link;
   #ifdef HASH_ORDER
                                   *(pair->prev)=pair->next;
                                   if(pair->next)
                                           pair->next->prev=pair->prev;
                                   else
                                           this->last=pair->prev;
 #endif  #endif
                                   delete pair;
                                   *ref=next;
                                   --this->fpairs_count;
                                   return true;
                           }
                   }
   
                   return false;
           }
   
           /// return true if key exists
           bool contains(K str){
                   CORD key=str.get_cord();
                   uint code=str.get_hash_code();
                   uint index=code%this->allocated;
                   for(Pair *pair=this->refs[index]; pair; pair=pair->link){
                           if(pair->code==code && CORD_cmp(pair->key,key)==0)
                                   return true;
                   }
   
                   return false;
           }
   
           /// get associated [value] by the [key]
           V get(K str) const {
                   CORD key=str.get_cord();
                   uint code=str.get_hash_code();
                   uint index=code%this->allocated;
                   for(Pair *pair=this->refs[index]; pair; pair=pair->link)
                           if(pair->code==code && CORD_cmp(pair->key,key)==0)
                                   return pair->value;
   
                   return V(0);
           }
   
           /// put a [value] under the [key] if that [key] existed @returns existed or not
           bool put_replaced(K str, V value) {
                   if(!value) {
                           remove(str);
                           return false;
                   }
   
                   CORD key=str.get_cord();
                   uint code=str.get_hash_code();
                   uint index=code%this->allocated;
                   for(Pair *pair=this->refs[index]; pair; pair=pair->link)
                           if(pair->code==code && CORD_cmp(pair->key,key)==0) {
                                   // found a pair with the same key, replacing
                                   pair->value=value;
                                   return true;
                           }
   
                   // proper pair not found 
                   return false;
           }
   
           /// put a [value] under the [key] if that [key] NOT existed @returns existed or not
           bool put_dont_replace(K str, V value) {
                   if(!value) {
                           remove(str);
                           return false;
                   }
                   if(this->is_full()) 
                           this->expand();
   
                   CORD key=str.get_cord();
                   uint code=str.get_hash_code();
                   uint index=code%this->allocated;
                   Pair **ref=&this->refs[index];
                   for(Pair *pair=*ref; pair; pair=pair->link)
                           if(pair->code==code && CORD_cmp(pair->key,key)==0) {
                                   // found a pair with the same key, NOT replacing
                                   return true;
                           }
   
                   // proper pair not found -- create&link_in new pair
                   if(!*ref) // root cell were fused_refs?
                           this->fused_refs++; // not, we'll use it and record the fact
                   HASH_NEW_PAIR(code, key, value);
                   this->fpairs_count++;
                   return false;
           }
   
           /// put all 'src' values if NO with same key existed
           void merge_dont_replace(const HASH_STRING& src) {
   #ifdef HASH_ORDER
                   for(Pair *pair=src.first; pair; pair=pair->next)
   #else
                   for(int i=0; i<src.allocated; i++)
                           for(Pair *pair=src.refs[i]; pair; pair=pair->link)
   #endif
                                   put_dont_replace(String::Body(pair->key, pair->code), pair->value);
           }
   
           /// iterate over all pairs
           template<typename I> void for_each(void callback(K, V, I), I info) const {
                   HASH_FOR_EACH
                           callback(String::Body(pair->key, pair->code), pair->value, info);
           }
   
           /// iterate over all pairs
           template<typename I> void for_each_ref(void callback(K, V&, I), I info) const {
                   HASH_FOR_EACH
                           callback(String::Body(pair->key, pair->code), pair->value, info);
           }
   
           /// iterate over all pairs until condition becomes true, return that element
           template<typename I> V first_that(bool callback(K, V, I), I info) const {
                   HASH_FOR_EACH
                           if(callback(String::Body(pair->key, pair->code), pair->value, info))
                                   return pair->value;
                   return V(0);
           }
   
           /// simple hash iterator
           class Iterator {
                   const HASH_STRING<V>& fhash;
                   Pair *fcurrent;
           public:
                   Iterator(const HASH_STRING<V>& ahash): fhash(ahash) {
                           fcurrent=fhash.first;
                   }
   
                   operator bool () {
                           return fcurrent != 0;
                   }
   
                   void next() {
                           fcurrent=fcurrent->next;
                   }
   
                   String::Body key(){
                           return String::Body(fcurrent->key, fcurrent->code);
                   }
   
                   V value(){
                           return fcurrent->value;
                   }
           };
   };
   #else //HASH_CODE_CACHING
   
   template<typename V> class HASH_STRING: public HASH<const String::Body,V>{};
   
   #endif //HASH_CODE_CACHING
   
   #ifndef HASH_ORDER
   ///    Auto-object used to temporarily substituting/removing string hash values
   template <typename K, typename V>
   class Temp_hash_value {
           HashString<V> &fhash;
           K fname;
           V saved_value;
   public:
           Temp_hash_value(HashString<V>& ahash, K aname, V avalue) :
                   fhash(ahash),
                   fname(aname),
                   saved_value(ahash.get(aname)) {
                   fhash.put(aname, avalue);
           }
           ~Temp_hash_value() { 
                   fhash.put(fname, saved_value);
           }
   };
   #endif
   
   #endif //PA_HASH_CLASS

Removed from v.1.45  
changed lines
  Added in v.1.83


E-mail: