hash.h

   1 /* hash.h -- decls for hash table
   2 Copyright (C) 1995, 1999, 2002 Free Software Foundation, Inc.
   3 Written by Greg McGary <gkm@gnu.org> <greg@mcgary.org>
   4
   5 GNU Make is free software; you can redistribute it and/or modify it under the
   6 terms of the GNU General Public License as published by the Free Software
   7 Foundation; either version 3 of the License, or (at your option) any later
   8 version.
   9
  10 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
  11 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License along with
  15 this program.  If not, see <http://www.gnu.org/licenses/>.  */
  16
  17 #ifndef _hash_h_
  18 #define _hash_h_
  19
  20 #include <stdio.h>
  21 #include <ctype.h>
  22
  23 #if defined __cplusplus || (defined __STDC__ && __STDC__) || defined WINDOWS32
  24 # if !defined __GLIBC__ || !defined __P
  25 #  undef        __P
  26 #  define __P(protos)   protos
  27 # endif
  28 #else /* Not C++ or ANSI C.  */
  29 # undef __P
  30 # define __P(protos)    ()
  31 /* We can get away without defining `const' here only because in this file
  32    it is used only inside the prototype for `fnmatch', which is elided in
  33    non-ANSI C where `const' is problematical.  */
  34 #endif /* C++ or ANSI C.  */
  35
  36 typedef unsigned long (*hash_func_t) __P((void const *key));
  37 typedef int (*hash_cmp_func_t) __P((void const *x, void const *y));
  38 typedef void (*hash_map_func_t) __P((void const *item));
  39 typedef void (*hash_map_arg_func_t) __P((void const *item, void *arg));
  40
  41 struct hash_table
  42 {
  43   void **ht_vec;
  44   unsigned long ht_size;        /* total number of slots (power of 2) */
  45   unsigned long ht_capacity;    /* usable slots, limited by loading-factor */
  46   unsigned long ht_fill;        /* items in table */
  47   unsigned long ht_empty_slots; /* empty slots not including deleted slots */
  48   unsigned long ht_collisions;  /* # of failed calls to comparison function */
  49   unsigned long ht_lookups;     /* # of queries */
  50   unsigned int ht_rehashes;     /* # of times we've expanded table */
  51   hash_func_t ht_hash_1;        /* primary hash function */
  52   hash_func_t ht_hash_2;        /* secondary hash function */
  53   hash_cmp_func_t ht_compare;   /* comparison function */
  54 };
  55
  56 typedef int (*qsort_cmp_t) __P((void const *, void const *));
  57
  58 void hash_init __P((struct hash_table *ht, unsigned long size,
  59                     hash_func_t hash_1, hash_func_t hash_2, hash_cmp_func_t hash_cmp));
  60 void hash_load __P((struct hash_table *ht, void *item_table,
  61                     unsigned long cardinality, unsigned long size));
  62 void **hash_find_slot __P((struct hash_table *ht, void const *key));
  63 void *hash_find_item __P((struct hash_table *ht, void const *key));
  64 void *hash_insert __P((struct hash_table *ht, const void *item));
  65 void *hash_insert_at __P((struct hash_table *ht, const void *item, void const *slot));
  66 void *hash_delete __P((struct hash_table *ht, void const *item));
  67 void *hash_delete_at __P((struct hash_table *ht, void const *slot));
  68 void hash_delete_items __P((struct hash_table *ht));
  69 void hash_free_items __P((struct hash_table *ht));
  70 void hash_free __P((struct hash_table *ht, int free_items));
  71 void hash_map __P((struct hash_table *ht, hash_map_func_t map));
  72 void hash_map_arg __P((struct hash_table *ht, hash_map_arg_func_t map, void *arg));
  73 void hash_print_stats __P((struct hash_table *ht, FILE *out_FILE));
  74 void **hash_dump __P((struct hash_table *ht, void **vector_0, qsort_cmp_t compare));
  75
  76 extern void *hash_deleted_item;
  77 #define HASH_VACANT(item) ((item) == 0 || (void *) (item) == hash_deleted_item)
  78
  79 \f
  80 /* hash and comparison macros for case-sensitive string keys. */
  81
  82 #define STRING_HASH_1(KEY, RESULT) do { \
  83   unsigned char const *_key_ = (unsigned char const *) (KEY) - 1; \
  84   while (*++_key_) \
  85     (RESULT) += (*_key_ << (_key_[1] & 0xf)); \
  86 } while (0)
  87 #define return_STRING_HASH_1(KEY) do { \
  88   unsigned long _result_ = 0; \
  89   STRING_HASH_1 ((KEY), _result_); \
  90   return _result_; \
  91 } while (0)
  92
  93 #define STRING_HASH_2(KEY, RESULT) do { \
  94   unsigned char const *_key_ = (unsigned char const *) (KEY) - 1; \
  95   while (*++_key_) \
  96     (RESULT) += (*_key_ << (_key_[1] & 0x7)); \
  97 } while (0)
  98 #define return_STRING_HASH_2(KEY) do { \
  99   unsigned long _result_ = 0; \
 100   STRING_HASH_2 ((KEY), _result_); \
 101   return _result_; \
 102 } while (0)
 103
 104 #define STRING_COMPARE(X, Y, RESULT) do { \
 105   RESULT = strcmp ((X), (Y)); \
 106 } while (0)
 107 #define return_STRING_COMPARE(X, Y) do { \
 108   return strcmp ((X), (Y)); \
 109 } while (0)
 110
 111
 112 #define STRING_N_HASH_1(KEY, N, RESULT) do { \
 113   unsigned char const *_key_ = (unsigned char const *) (KEY) - 1; \
 114   int _n_ = (N); \
 115   if (_n_) \
 116     while (--_n_ && *++_key_) \
 117       (RESULT) += (*_key_ << (_key_[1] & 0xf)); \
 118   (RESULT) += *++_key_; \
 119 } while (0)
 120 #define return_STRING_N_HASH_1(KEY, N) do { \
 121   unsigned long _result_ = 0; \
 122   STRING_N_HASH_1 ((KEY), (N), _result_); \
 123   return _result_; \
 124 } while (0)
 125
 126 #define STRING_N_HASH_2(KEY, N, RESULT) do { \
 127   unsigned char const *_key_ = (unsigned char const *) (KEY) - 1; \
 128   int _n_ = (N); \
 129   if (_n_) \
 130     while (--_n_ && *++_key_) \
 131       (RESULT) += (*_key_ << (_key_[1] & 0x7)); \
 132   (RESULT) += *++_key_; \
 133 } while (0)
 134 #define return_STRING_N_HASH_2(KEY, N) do { \
 135   unsigned long _result_ = 0; \
 136   STRING_N_HASH_2 ((KEY), (N), _result_); \
 137   return _result_; \
 138 } while (0)
 139
 140 #define STRING_N_COMPARE(X, Y, N, RESULT) do { \
 141   RESULT = strncmp ((X), (Y), (N)); \
 142 } while (0)
 143 #define return_STRING_N_COMPARE(X, Y, N) do { \
 144   return strncmp ((X), (Y), (N)); \
 145 } while (0)
 146
 147 #ifdef HAVE_CASE_INSENSITIVE_FS
 148
 149 /* hash and comparison macros for case-insensitive string _key_s. */
 150
 151 #define ISTRING_HASH_1(KEY, RESULT) do { \
 152   unsigned char const *_key_ = (unsigned char const *) (KEY) - 1; \
 153   while (*++_key_) \
 154     (RESULT) += ((isupper (*_key_) ? tolower (*_key_) : *_key_) << (_key_[1] & 0xf)); \
 155 } while (0)
 156 #define return_ISTRING_HASH_1(KEY) do { \
 157   unsigned long _result_ = 0; \
 158   ISTRING_HASH_1 ((KEY), _result_); \
 159   return _result_; \
 160 } while (0)
 161
 162 #define ISTRING_HASH_2(KEY, RESULT) do { \
 163   unsigned char const *_key_ = (unsigned char const *) (KEY) - 1; \
 164   while (*++_key_) \
 165     (RESULT) += ((isupper (*_key_) ? tolower (*_key_) : *_key_) << (_key_[1] & 0x7)); \
 166 } while (0)
 167 #define return_ISTRING_HASH_2(KEY) do { \
 168   unsigned long _result_ = 0; \
 169   ISTRING_HASH_2 ((KEY), _result_); \
 170   return _result_; \
 171 } while (0)
 172
 173 #define ISTRING_COMPARE(X, Y, RESULT) do { \
 174   RESULT = strcasecmp ((X), (Y)); \
 175 } while (0)
 176 #define return_ISTRING_COMPARE(X, Y) do { \
 177   return strcasecmp ((X), (Y)); \
 178 } while (0)
 179
 180 #else
 181
 182 #define ISTRING_HASH_1(KEY, RESULT) STRING_HASH_1 ((KEY), (RESULT))
 183 #define return_ISTRING_HASH_1(KEY) return_STRING_HASH_1 (KEY)
 184
 185 #define ISTRING_HASH_2(KEY, RESULT) STRING_HASH_2 ((KEY), (RESULT))
 186 #define return_ISTRING_HASH_2(KEY) return_STRING_HASH_2 (KEY)
 187
 188 #define ISTRING_COMPARE(X, Y, RESULT) STRING_COMPARE ((X), (Y), (RESULT))
 189 #define return_ISTRING_COMPARE(X, Y) return_STRING_COMPARE ((X), (Y))
 190
 191 #endif
 192
 193 /* hash and comparison macros for integer _key_s. */
 194
 195 #define INTEGER_HASH_1(KEY, RESULT) do { \
 196   (RESULT) += ((unsigned long)(KEY)); \
 197 } while (0)
 198 #define return_INTEGER_HASH_1(KEY) do { \
 199   unsigned long _result_ = 0; \
 200   INTEGER_HASH_1 ((KEY), _result_); \
 201   return _result_; \
 202 } while (0)
 203
 204 #define INTEGER_HASH_2(KEY, RESULT) do { \
 205   (RESULT) += ~((unsigned long)(KEY)); \
 206 } while (0)
 207 #define return_INTEGER_HASH_2(KEY) do { \
 208   unsigned long _result_ = 0; \
 209   INTEGER_HASH_2 ((KEY), _result_); \
 210   return _result_; \
 211 } while (0)
 212
 213 #define INTEGER_COMPARE(X, Y, RESULT) do { \
 214   (RESULT) = X - Y; \
 215 } while (0)
 216 #define return_INTEGER_COMPARE(X, Y) do { \
 217   int _result_; \
 218   INTEGER_COMPARE (X, Y, _result_); \
 219   return _result_; \
 220 } while (0)
 221
 222 /* hash and comparison macros for address keys. */
 223
 224 #define ADDRESS_HASH_1(KEY, RESULT) INTEGER_HASH_1 (((unsigned long)(KEY)) >> 3, (RESULT))
 225 #define ADDRESS_HASH_2(KEY, RESULT) INTEGER_HASH_2 (((unsigned long)(KEY)) >> 3, (RESULT))
 226 #define ADDRESS_COMPARE(X, Y, RESULT) INTEGER_COMPARE ((X), (Y), (RESULT))
 227 #define return_ADDRESS_HASH_1(KEY) return_INTEGER_HASH_1 (((unsigned long)(KEY)) >> 3)
 228 #define return_ADDRESS_HASH_2(KEY) return_INTEGER_HASH_2 (((unsigned long)(KEY)) >> 3)
 229 #define return_ADDRESS_COMPARE(X, Y) return_INTEGER_COMPARE ((X), (Y))
 230
 231 #endif /* not _hash_h_ */