include/hashtab.h

   1 /* An expandable hash tables datatype.
   2    Copyright (C) 1999 Free Software Foundation, Inc.
   3    Contributed by Vladimir Makarov (vmakarov@cygnus.com).
   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 2 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, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  18
  19 /* This package implements basic hash table functionality.  It is possible
  20    to search for an entry, create an entry and destroy an entry.
  21
  22    Elements in the table are generic pointers.
  23
  24    The size of the table is not fixed; if the occupancy of the table
  25    grows too high the hash table will be expanded.
  26
  27    The abstract data implementation is based on generalized Algorithm D
  28    from Knuth's book "The art of computer programming".  Hash table is
  29    expanded by creation of new hash table and transferring elements from
  30    the old table to the new table.  */
  31
  32 #ifndef __HASHTAB_H__
  33 #define __HASHTAB_H__
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif /* __cplusplus */
  38
  39 #include <ansidecl.h>
  40
  41 /* Callback function pointer types.  */
  42
  43 /* Calculate hash of a table entry.  */
  44 typedef unsigned int (*htab_hash) PARAMS ((const void *));
  45
  46 /* Compare a table entry with a possible entry.  The entry already in
  47    the table always comes first.  */
  48 typedef int (*htab_eq) PARAMS ((const void *, const void *));
  49
  50 /* Cleanup function called whenever a live element is removed from
  51    the hash table.  */
  52 typedef void (*htab_del) PARAMS ((void *));
  53
  54 /* Function called by htab_traverse for each live element.  The first
  55    arg is the element, the second arg is the auxiliary pointer handed
  56    to htab_traverse.  Return 1 to continue scan, 0 to stop.  */
  57 typedef int (*htab_trav) PARAMS ((void *, void *));
  58
  59 /* Hash tables are of the following type.  The structure
  60    (implementation) of this type is not needed for using the hash
  61    tables.  All work with hash table should be executed only through
  62    functions mentioned below. */
  63
  64 struct htab
  65 {
  66   /* Pointer to hash function.  */
  67   htab_hash hash_f;
  68
  69   /* Pointer to comparison function.  */
  70   htab_eq eq_f;
  71
  72   /* Pointer to cleanup function.  */
  73   htab_del del_f;
  74
  75   /* Table itself.  */
  76   void **entries;
  77
  78   /* Current size (in entries) of the hash table */
  79   size_t size;
  80
  81   /* Current number of elements including also deleted elements */
  82   size_t n_elements;
  83
  84   /* Current number of deleted elements in the table */
  85   size_t n_deleted;
  86
  87   /* The following member is used for debugging. Its value is number
  88      of all calls of `htab_find_slot' for the hash table. */
  89   unsigned int searches;
  90
  91   /* The following member is used for debugging.  Its value is number
  92      of collisions fixed for time of work with the hash table. */
  93   unsigned int collisions;
  94 };
  95
  96 typedef struct htab *htab_t;
  97
  98 /* The prototypes of the package functions. */
  99
 100 extern htab_t   htab_create     PARAMS ((size_t, htab_hash,
 101                                          htab_eq, htab_del));
 102 extern void     htab_delete     PARAMS ((htab_t));
 103 extern void     htab_empty      PARAMS ((htab_t));
 104
 105 extern void    *htab_find       PARAMS ((htab_t, const void *));
 106 extern void   **htab_find_slot  PARAMS ((htab_t, const void *, int));
 107 extern void     htab_clear_slot PARAMS ((htab_t, void **));
 108 extern void     htab_remove_elt PARAMS ((htab_t, void *));
 109
 110 extern void     htab_traverse   PARAMS ((htab_t, htab_trav, void *));
 111
 112 extern size_t   htab_size       PARAMS ((htab_t));
 113 extern size_t   htab_elements   PARAMS ((htab_t));
 114 extern double   htab_collisions PARAMS ((htab_t));
 115
 116 #ifdef __cplusplus
 117 }
 118 #endif /* __cplusplus */
 119
 120 #endif /* __HASHTAB_H */