lib/dynamicsizehash.h

   1 /* Copyright (C) 2000-2010 Red Hat, Inc.
   2    This file is part of Red Hat elfutils.
   3    Written by Ulrich Drepper <drepper@redhat.com>, 2000.
   4
   5    Red Hat elfutils is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by the
   7    Free Software Foundation; version 2 of the License.
   8
   9    Red Hat elfutils is distributed in the hope that it will be useful, but
  10    WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12    General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License along
  15    with Red Hat elfutils; if not, write to the Free Software Foundation,
  16    Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA.
  17
  18    In addition, as a special exception, Red Hat, Inc. gives You the
  19    additional right to link the code of Red Hat elfutils with code licensed
  20    under any Open Source Initiative certified open source license
  21    (http://www.opensource.org/licenses/index.php) which requires the
  22    distribution of source code with any binary distribution and to
  23    distribute linked combinations of the two.  Non-GPL Code permitted under
  24    this exception must only link to the code of Red Hat elfutils through
  25    those well defined interfaces identified in the file named EXCEPTION
  26    found in the source code files (the "Approved Interfaces").  The files
  27    of Non-GPL Code may instantiate templates or use macros or inline
  28    functions from the Approved Interfaces without causing the resulting
  29    work to be covered by the GNU General Public License.  Only Red Hat,
  30    Inc. may make changes or additions to the list of Approved Interfaces.
  31    Red Hat's grant of this exception is conditioned upon your not adding
  32    any new exceptions.  If you wish to add a new Approved Interface or
  33    exception, please contact Red Hat.  You must obey the GNU General Public
  34    License in all respects for all of the Red Hat elfutils code and other
  35    code used in conjunction with Red Hat elfutils except the Non-GPL Code
  36    covered by this exception.  If you modify this file, you may extend this
  37    exception to your version of the file, but you are not obligated to do
  38    so.  If you do not wish to provide this exception without modification,
  39    you must delete this exception statement from your version and license
  40    this file solely under the GPL without exception.
  41
  42    Red Hat elfutils is an included package of the Open Invention Network.
  43    An included package of the Open Invention Network is a package for which
  44    Open Invention Network licensees cross-license their patents.  No patent
  45    license is granted, either expressly or impliedly, by designation as an
  46    included package.  Should you wish to participate in the Open Invention
  47    Network licensing program, please visit www.openinventionnetwork.com
  48    <http://www.openinventionnetwork.com>.  */
  49
  50 #include <stddef.h>
  51
  52 /* Before including this file the following macros must be defined:
  53
  54    NAME      name of the hash table structure.
  55    TYPE      data type of the hash table entries
  56
  57    The following macros if present select features:
  58
  59    ITERATE   iterating over the table entries is possible
  60    HASHTYPE  integer type for hash values, default unsigned long int
  61  */
  62
  63
  64 /* Optionally include an entry pointing to the first used entry.  */
  65 #ifdef ITERATE
  66 # define FIRST(name)    name##_ent *first;
  67 # define NEXT(name)     struct name##_ent *next;
  68 #else
  69 # define FIRST(name)
  70 # define NEXT(name)
  71 #endif
  72
  73 #ifndef HASHTYPE
  74 # define HASHTYPE unsigned long int
  75 #endif
  76
  77
  78 /* Defined separately.  */
  79 extern size_t next_prime (size_t seed);
  80
  81
  82 /* Table entry type.  */
  83 #define _DYNHASHENTTYPE(name) \
  84   typedef struct name##_ent                                                   \
  85   {                                                                           \
  86     HASHTYPE hashval;                                                         \
  87     TYPE data;                                                                \
  88     NEXT (name)                                                               \
  89   } name##_ent
  90 #define DYNHASHENTTYPE(name) _DYNHASHENTTYPE (name)
  91 DYNHASHENTTYPE (NAME);
  92
  93
  94 /* Type of the dynamic hash table data structure.  */
  95 #define _DYNHASHTYPE(name) \
  96 typedef struct                                                                \
  97 {                                                                             \
  98   size_t size;                                                                \
  99   size_t filled;                                                              \
 100   name##_ent *table;                                                          \
 101   FIRST (name)                                                                \
 102 } name
 103 #define DYNHASHTYPE(name) _DYNHASHTYPE (name)
 104 DYNHASHTYPE (NAME);
 105
 106
 107
 108 #define _FUNCTIONS(name) \
 109 /* Initialize the hash table.  */                                             \
 110 extern int name##_init (name *htab, size_t init_size);                        \
 111                                                                               \
 112 /* Free resources allocated for hash table.  */                               \
 113 extern int name##_free (name *htab);                                          \
 114                                                                               \
 115 /* Insert new entry.  */                                                      \
 116 extern int name##_insert (name *htab, HASHTYPE hval, TYPE data);              \
 117                                                                               \
 118 /* Insert new entry, possibly overwrite old entry.  */                        \
 119 extern int name##_overwrite (name *htab, HASHTYPE hval, TYPE data);           \
 120                                                                               \
 121 /* Find entry in hash table.  */                                              \
 122 extern TYPE name##_find (name *htab, HASHTYPE hval, TYPE val);
 123 #define FUNCTIONS(name) _FUNCTIONS (name)
 124 FUNCTIONS (NAME)
 125
 126
 127 #ifdef ITERATE
 128 # define _XFUNCTIONS(name) \
 129 /* Get next element in table.  */                                             \
 130 extern TYPE name##_iterate (name *htab, void **ptr);
 131 # define XFUNCTIONS(name) _XFUNCTIONS (name)
 132 XFUNCTIONS (NAME)
 133 #endif
 134
 135 #ifndef NO_UNDEF
 136 # undef DYNHASHENTTYPE
 137 # undef DYNHASHTYPE
 138 # undef FUNCTIONS
 139 # undef _FUNCTIONS
 140 # undef XFUNCTIONS
 141 # undef _XFUNCTIONS
 142 # undef NAME
 143 # undef TYPE
 144 # undef ITERATE
 145 # undef COMPARE
 146 # undef FIRST
 147 # undef NEXT
 148 #endif