git.cworth.org Git - tar/blob - gnu/hash.h

   1 /* -*- buffer-read-only: t -*- vi: set ro: */
   2 /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
   3 /* hash - hashing table processing.
   4    Copyright (C) 1998-1999, 2001, 2003, 2009-2010 Free Software Foundation,
   5    Inc.
   6    Written by Jim Meyering <meyering@ascend.com>, 1998.
   7
   8    This program is free software: you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 /* A generic hash table package.  */
  22
  23 /* Make sure USE_OBSTACK is defined to 1 if you want the allocator to use
  24    obstacks instead of malloc, and recompile `hash.c' with same setting.  */
  25
  26 #ifndef HASH_H_
  27 # define HASH_H_
  28
  29 # include <stdio.h>
  30 # include <stdbool.h>
  31
  32 /* The warn_unused_result attribute appeared first in gcc-3.4.0 */
  33 # ifndef __attribute__
  34 #  if __GNUC__ < 3 || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
  35 #   define __attribute__(x)
  36 #  endif
  37 # endif
  38
  39 # ifndef ATTRIBUTE_WUR
  40 #  define ATTRIBUTE_WUR __attribute__ ((__warn_unused_result__))
  41 # endif
  42
  43 typedef size_t (*Hash_hasher) (const void *, size_t);
  44 typedef bool (*Hash_comparator) (const void *, const void *);
  45 typedef void (*Hash_data_freer) (void *);
  46 typedef bool (*Hash_processor) (void *, void *);
  47
  48 struct hash_tuning
  49   {
  50     /* This structure is mainly used for `hash_initialize', see the block
  51        documentation of `hash_reset_tuning' for more complete comments.  */
  52
  53     float shrink_threshold;     /* ratio of used buckets to trigger a shrink */
  54     float shrink_factor;        /* ratio of new smaller size to original size */
  55     float growth_threshold;     /* ratio of used buckets to trigger a growth */
  56     float growth_factor;        /* ratio of new bigger size to original size */
  57     bool is_n_buckets;          /* if CANDIDATE really means table size */
  58   };
  59
  60 typedef struct hash_tuning Hash_tuning;
  61
  62 struct hash_table;
  63
  64 typedef struct hash_table Hash_table;
  65
  66 /* Information and lookup.  */
  67 size_t hash_get_n_buckets (const Hash_table *);
  68 size_t hash_get_n_buckets_used (const Hash_table *);
  69 size_t hash_get_n_entries (const Hash_table *);
  70 size_t hash_get_max_bucket_length (const Hash_table *);
  71 bool hash_table_ok (const Hash_table *);
  72 void hash_print_statistics (const Hash_table *, FILE *);
  73 void *hash_lookup (const Hash_table *, const void *);
  74
  75 /* Walking.  */
  76 void *hash_get_first (const Hash_table *);
  77 void *hash_get_next (const Hash_table *, const void *);
  78 size_t hash_get_entries (const Hash_table *, void **, size_t);
  79 size_t hash_do_for_each (const Hash_table *, Hash_processor, void *);
  80
  81 /* Allocation and clean-up.  */
  82 size_t hash_string (const char *, size_t);
  83 void hash_reset_tuning (Hash_tuning *);
  84 Hash_table *hash_initialize (size_t, const Hash_tuning *,
  85                              Hash_hasher, Hash_comparator,
  86                              Hash_data_freer) ATTRIBUTE_WUR;
  87 void hash_clear (Hash_table *);
  88 void hash_free (Hash_table *);
  89
  90 /* Insertion and deletion.  */
  91 bool hash_rehash (Hash_table *, size_t) ATTRIBUTE_WUR;
  92 void *hash_insert (Hash_table *, const void *) ATTRIBUTE_WUR;
  93 int hash_insert0 (Hash_table *table, const void *entry,
  94                   const void **matched_ent);
  95 void *hash_delete (Hash_table *, const void *);
  96
  97 #endif