Pileus Git - ~andy/gtk/blob - glib/ghash.c

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19 #include "glib.h"
  20
  21
  22 #define HASH_TABLE_MIN_SIZE 11
  23 #define HASH_TABLE_MAX_SIZE 13845163
  24
  25
  26 typedef struct _GHashNode      GHashNode;
  27 typedef struct _GRealHashTable GRealHashTable;
  28
  29 struct _GHashNode
  30 {
  31   gpointer key;
  32   gpointer value;
  33   GHashNode *next;
  34 };
  35
  36 struct _GRealHashTable
  37 {
  38   gint size;
  39   gint nnodes;
  40   gint frozen;
  41   GHashNode **nodes;
  42   GHashFunc hash_func;
  43   GCompareFunc key_compare_func;
  44 };
  45
  46
  47 static void       g_hash_table_resize  (GHashTable *hash_table);
  48 static gint       g_hash_closest_prime (gint        num);
  49 static GHashNode* g_hash_node_new      (gpointer    key,
  50                                         gpointer    value);
  51 static void       g_hash_node_destroy  (GHashNode  *hash_node);
  52 static void       g_hash_nodes_destroy (GHashNode  *hash_node);
  53
  54
  55 extern gint g_primes[];
  56 extern gint g_nprimes;
  57
  58 static GMemChunk *node_mem_chunk = NULL;
  59 static GHashNode *node_free_list = NULL;
  60
  61
  62 GHashTable*
  63 g_hash_table_new (GHashFunc    hash_func,
  64                   GCompareFunc key_compare_func)
  65 {
  66   GRealHashTable *hash_table;
  67
  68   g_return_val_if_fail (hash_func != NULL, NULL);
  69
  70   hash_table = g_new (GRealHashTable, 1);
  71   hash_table->size = 0;
  72   hash_table->nnodes = 0;
  73   hash_table->frozen = FALSE;
  74   hash_table->nodes = NULL;
  75   hash_table->hash_func = hash_func;
  76   hash_table->key_compare_func = key_compare_func;
  77
  78   return ((GHashTable*) hash_table);
  79 }
  80
  81 void
  82 g_hash_table_destroy (GHashTable *hash_table)
  83 {
  84   GRealHashTable *rhash_table;
  85   gint i;
  86
  87   if (hash_table)
  88     {
  89       rhash_table = (GRealHashTable*) hash_table;
  90
  91       for (i = 0; i < rhash_table->size; i++)
  92         g_hash_nodes_destroy (rhash_table->nodes[i]);
  93
  94       if (rhash_table->nodes)
  95         g_free (rhash_table->nodes);
  96       g_free (rhash_table);
  97     }
  98 }
  99
 100 void
 101 g_hash_table_insert (GHashTable *hash_table,
 102                      gpointer    key,
 103                      gpointer    value)
 104 {
 105   GRealHashTable *rhash_table;
 106   GHashNode *node;
 107   guint hash_val;
 108
 109   if (hash_table)
 110     {
 111       rhash_table = (GRealHashTable*) hash_table;
 112
 113       if (rhash_table->size == 0)
 114         g_hash_table_resize (hash_table);
 115
 116       hash_val = (* rhash_table->hash_func) (key) % rhash_table->size;
 117
 118       node = rhash_table->nodes[hash_val];
 119       while (node)
 120         {
 121           if ((rhash_table->key_compare_func &&
 122                (* rhash_table->key_compare_func) (node->key, key)) ||
 123               (node->key == key))
 124             {
 125               /* do not reset node->key in this place, keeping
 126                * the old key might be intended.
 127                * a g_hash_table_remove/g_hash_table_insert pair
 128                * can be used otherwise.
 129                *
 130                * node->key = key;
 131                */
 132               node->value = value;
 133               return;
 134             }
 135           node = node->next;
 136         }
 137
 138       node = g_hash_node_new (key, value);
 139       node->next = rhash_table->nodes[hash_val];
 140       rhash_table->nodes[hash_val] = node;
 141
 142       rhash_table->nnodes += 1;
 143       g_hash_table_resize (hash_table);
 144     }
 145 }
 146
 147 void
 148 g_hash_table_remove (GHashTable      *hash_table,
 149                      gconstpointer    key)
 150 {
 151   GRealHashTable *rhash_table;
 152   GHashNode *node;
 153   GHashNode *prev;
 154   guint hash_val;
 155
 156   rhash_table = (GRealHashTable*) hash_table;
 157   if (hash_table && rhash_table->size)
 158     {
 159       hash_val = (* rhash_table->hash_func) (key) % rhash_table->size;
 160
 161       prev = NULL;
 162       node = rhash_table->nodes[hash_val];
 163
 164       while (node)
 165         {
 166           if ((rhash_table->key_compare_func &&
 167                (* rhash_table->key_compare_func) (node->key, key)) ||
 168               (node->key == key))
 169             {
 170               if (prev)
 171                 prev->next = node->next;
 172               if (node == rhash_table->nodes[hash_val])
 173                 rhash_table->nodes[hash_val] = node->next;
 174
 175               g_hash_node_destroy (node);
 176
 177               rhash_table->nnodes -= 1;
 178               g_hash_table_resize (hash_table);
 179               break;
 180             }
 181
 182           prev = node;
 183           node = node->next;
 184         }
 185     }
 186 }
 187
 188 gpointer
 189 g_hash_table_lookup (GHashTable   *hash_table,
 190                      gconstpointer key)
 191 {
 192   GRealHashTable *rhash_table;
 193   GHashNode *node;
 194   guint hash_val;
 195
 196   rhash_table = (GRealHashTable*) hash_table;
 197   if (hash_table && rhash_table->size)
 198     {
 199       hash_val = (* rhash_table->hash_func) (key) % rhash_table->size;
 200
 201       node = rhash_table->nodes[hash_val];
 202
 203       /* Hash table lookup needs to be fast.
 204        *  We therefore remove the extra conditional of testing
 205        *  whether to call the key_compare_func or not from
 206        *  the inner loop.
 207        */
 208       if (rhash_table->key_compare_func)
 209         {
 210           while (node)
 211             {
 212               if ((* rhash_table->key_compare_func) (node->key, key))
 213                 return node->value;
 214               node = node->next;
 215             }
 216         }
 217       else
 218         {
 219           while (node)
 220             {
 221               if (node->key == key)
 222                 return node->value;
 223               node = node->next;
 224             }
 225         }
 226     }
 227
 228   return NULL;
 229 }
 230
 231 void
 232 g_hash_table_freeze (GHashTable *hash_table)
 233 {
 234   GRealHashTable *rhash_table;
 235
 236   if (hash_table)
 237     {
 238       rhash_table = (GRealHashTable*) hash_table;
 239       rhash_table->frozen = TRUE;
 240     }
 241 }
 242
 243 void
 244 g_hash_table_thaw (GHashTable *hash_table)
 245 {
 246   GRealHashTable *rhash_table;
 247
 248   if (hash_table)
 249     {
 250       rhash_table = (GRealHashTable*) hash_table;
 251       rhash_table->frozen = FALSE;
 252
 253       g_hash_table_resize (hash_table);
 254     }
 255 }
 256
 257 void
 258 g_hash_table_foreach (GHashTable *hash_table,
 259                       GHFunc      func,
 260                       gpointer    user_data)
 261 {
 262   GRealHashTable *rhash_table;
 263   GHashNode *node;
 264   gint i;
 265
 266   if (hash_table)
 267     {
 268       rhash_table = (GRealHashTable*) hash_table;
 269
 270       for (i = 0; i < rhash_table->size; i++)
 271         {
 272           node = rhash_table->nodes[i];
 273
 274           while (node)
 275             {
 276               (* func) (node->key, node->value, user_data);
 277               node = node->next;
 278             }
 279         }
 280     }
 281 }
 282
 283
 284 static void
 285 g_hash_table_resize (GHashTable *hash_table)
 286 {
 287   GRealHashTable *rhash_table;
 288   GHashNode **new_nodes;
 289   GHashNode *node;
 290   GHashNode *next;
 291   gfloat nodes_per_list;
 292   guint hash_val;
 293   gint new_size;
 294   gint need_resize;
 295   gint i;
 296
 297   if (hash_table)
 298     {
 299       rhash_table = (GRealHashTable*) hash_table;
 300
 301       if (rhash_table->size == 0)
 302         {
 303           rhash_table->size = HASH_TABLE_MIN_SIZE;
 304           rhash_table->nodes = g_new (GHashNode*, rhash_table->size);
 305
 306           for (i = 0; i < rhash_table->size; i++)
 307             rhash_table->nodes[i] = NULL;
 308         }
 309       else if (!rhash_table->frozen)
 310         {
 311           need_resize = FALSE;
 312           nodes_per_list = (gfloat) rhash_table->nnodes / (gfloat) rhash_table->size;
 313
 314           if (nodes_per_list < 0.3)
 315             {
 316               if (rhash_table->size > HASH_TABLE_MIN_SIZE)
 317                 need_resize = TRUE;
 318             }
 319           else if (nodes_per_list > 3.0)
 320             {
 321               if (rhash_table->size < HASH_TABLE_MAX_SIZE)
 322                 need_resize = TRUE;
 323             }
 324
 325           if (need_resize)
 326             {
 327               new_size = g_hash_closest_prime (rhash_table->nnodes);
 328               if (new_size < HASH_TABLE_MIN_SIZE)
 329                 new_size = HASH_TABLE_MIN_SIZE;
 330               else if (new_size > HASH_TABLE_MAX_SIZE)
 331                 new_size = HASH_TABLE_MAX_SIZE;
 332
 333               new_nodes = g_new (GHashNode*, new_size);
 334
 335               for (i = 0; i < new_size; i++)
 336                 new_nodes[i] = NULL;
 337
 338               for (i = 0; i < rhash_table->size; i++)
 339                 {
 340                   node = rhash_table->nodes[i];
 341
 342                   while (node)
 343                     {
 344                       next = node->next;
 345
 346                       hash_val = (* rhash_table->hash_func) (node->key) % new_size;
 347                       node->next = new_nodes[hash_val];
 348                       new_nodes[hash_val] = node;
 349
 350                       node = next;
 351                     }
 352                 }
 353
 354               g_free (rhash_table->nodes);
 355
 356               rhash_table->nodes = new_nodes;
 357               rhash_table->size = new_size;
 358             }
 359         }
 360     }
 361 }
 362
 363 static gint
 364 g_hash_closest_prime (gint num)
 365 {
 366   gint i;
 367
 368   for (i = 0; i < g_nprimes; i++)
 369     if ((g_primes[i] - num) > 0)
 370       return g_primes[i];
 371
 372   return g_primes[g_nprimes - 1];
 373 }
 374
 375 static GHashNode*
 376 g_hash_node_new (gpointer key,
 377                  gpointer value)
 378 {
 379   GHashNode *hash_node;
 380
 381   if (node_free_list)
 382     {
 383       hash_node = node_free_list;
 384       node_free_list = node_free_list->next;
 385     }
 386   else
 387     {
 388       if (!node_mem_chunk)
 389         node_mem_chunk = g_mem_chunk_new ("hash node mem chunk",
 390                                           sizeof (GHashNode),
 391                                           1024, G_ALLOC_ONLY);
 392
 393       hash_node = g_chunk_new (GHashNode, node_mem_chunk);
 394     }
 395
 396   hash_node->key = key;
 397   hash_node->value = value;
 398   hash_node->next = NULL;
 399
 400   return hash_node;
 401 }
 402
 403 static void
 404 g_hash_node_destroy (GHashNode *hash_node)
 405 {
 406   if (hash_node)
 407     {
 408       hash_node->next = node_free_list;
 409       node_free_list = hash_node;
 410     }
 411 }
 412
 413 static void
 414 g_hash_nodes_destroy (GHashNode *hash_node)
 415 {
 416   GHashNode *node;
 417
 418   if (hash_node)
 419     {
 420       node = hash_node;
 421       while (node->next)
 422         node = node->next;
 423       node->next = node_free_list;
 424       node_free_list = hash_node;
 425     }
 426 }