lib/gl_linkedhash_list.c

   1 /* Sequential list data type implemented by a hash table with a linked list.
   2    Copyright (C) 2006, 2008 Free Software Foundation, Inc.
   3    Written by Bruno Haible <bruno@clisp.org>, 2006.
   4
   5    This program is free software: you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 3 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  17
  18 #include <config.h>
  19
  20 /* Specification.  */
  21 #include "gl_linkedhash_list.h"
  22
  23 #include <stdint.h> /* for SIZE_MAX */
  24 #include <stdlib.h>
  25
  26 #include "xalloc.h"
  27 #include "xsize.h"
  28
  29 #ifndef uintptr_t
  30 # define uintptr_t unsigned long
  31 #endif
  32
  33 #define WITH_HASHTABLE 1
  34
  35 /* -------------------------- gl_list_t Data Type -------------------------- */
  36
  37 /* Generic hash-table code.  */
  38 #include "gl_anyhash_list1.h"
  39
  40 /* Generic linked list code.  */
  41 #include "gl_anylinked_list1.h"
  42
  43 /* Generic hash-table code.  */
  44 #include "gl_anyhash_list2.h"
  45
  46 /* Resize the hash table if needed, after list->count was incremented.  */
  47 static inline void
  48 hash_resize_after_add (gl_list_t list)
  49 {
  50   size_t count = list->count;
  51   size_t estimate = xsum (count, count / 2); /* 1.5 * count */
  52   if (estimate > list->table_size)
  53     hash_resize (list, estimate);
  54 }
  55
  56 /* Add a node to the hash table structure.  */
  57 static inline void
  58 add_to_bucket (gl_list_t list, gl_list_node_t node)
  59 {
  60   size_t bucket = node->h.hashcode % list->table_size;
  61
  62   node->h.hash_next = list->table[bucket];
  63   list->table[bucket] = &node->h;
  64 }
  65
  66 /* Remove a node from the hash table structure.  */
  67 static inline void
  68 remove_from_bucket (gl_list_t list, gl_list_node_t node)
  69 {
  70   size_t bucket = node->h.hashcode % list->table_size;
  71   gl_hash_entry_t *p;
  72
  73   for (p = &list->table[bucket]; ; p = &(*p)->hash_next)
  74     {
  75       if (*p == &node->h)
  76         {
  77           *p = node->h.hash_next;
  78           break;
  79         }
  80       if (*p == NULL)
  81         /* node is not in the right bucket.  Did the hash codes
  82            change inadvertently?  */
  83         abort ();
  84     }
  85 }
  86
  87 /* Generic linked list code.  */
  88 #include "gl_anylinked_list2.h"
  89
  90
  91 const struct gl_list_implementation gl_linkedhash_list_implementation =
  92   {
  93     gl_linked_create_empty,
  94     gl_linked_create,
  95     gl_linked_size,
  96     gl_linked_node_value,
  97     gl_linked_node_set_value,
  98     gl_linked_next_node,
  99     gl_linked_previous_node,
 100     gl_linked_get_at,
 101     gl_linked_set_at,
 102     gl_linked_search_from_to,
 103     gl_linked_indexof_from_to,
 104     gl_linked_add_first,
 105     gl_linked_add_last,
 106     gl_linked_add_before,
 107     gl_linked_add_after,
 108     gl_linked_add_at,
 109     gl_linked_remove_node,
 110     gl_linked_remove_at,
 111     gl_linked_remove,
 112     gl_linked_list_free,
 113     gl_linked_iterator,
 114     gl_linked_iterator_from_to,
 115     gl_linked_iterator_next,
 116     gl_linked_iterator_free,
 117     gl_linked_sortedlist_search,
 118     gl_linked_sortedlist_search_from_to,
 119     gl_linked_sortedlist_indexof,
 120     gl_linked_sortedlist_indexof_from_to,
 121     gl_linked_sortedlist_add,
 122     gl_linked_sortedlist_remove
 123   };