-#ifndef HASH_H
-# define HASH_H 1
+/* hash - hashing table processing.
+ Copyright (C) 1998-1999, 2001, 2003, 2009-2013 Free Software Foundation,
+ Inc.
+ Written by Jim Meyering <meyering@ascend.com>, 1998.
-# if HAVE_CONFIG_H
-# include <config.h>
-# endif
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
-# include <stdio.h>
-# include <assert.h>
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
-# ifdef STDC_HEADERS
-# include <stdlib.h>
-# else
-void free ();
-char *malloc ();
-# endif
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
-# define USE_OBSTACK
-# ifdef USE_OBSTACK
-# include "obstack.h"
-# endif
+/* A generic hash table package. */
-# define obstack_chunk_alloc malloc
-# define obstack_chunk_free free
+/* Make sure USE_OBSTACK is defined to 1 if you want the allocator to use
+ obstacks instead of malloc, and recompile 'hash.c' with same setting. */
-struct hash_ent
- {
- void *key;
- struct hash_ent *next;
- };
-typedef struct hash_ent HASH_ENT;
+#ifndef HASH_H_
+# define HASH_H_
-/* This is particularly useful to cast uses in hash_initialize of the
- system free function. */
-typedef void (*Hash_key_freer_type) (void *key);
+# include <stdio.h>
+# include <stdbool.h>
-struct HT
- {
- /* User-supplied function for freeing keys. It is specified in
- hash_initialize. If non-null, it is used by hash_free and
- hash_clear. You should specify `free' here only if you want
- these functions to free all of your `key' data. This is typically
- the case when your key is simply an auxilliary struct that you
- have malloc'd to aggregate several values. */
- Hash_key_freer_type hash_key_freer;
-
- /* User-supplied hash function that hashes entry E to an integer
- in the range 0..TABLE_SIZE-1. */
- unsigned int (*hash_hash) (const void *e, unsigned int table_size);
-
- /* User-supplied function that determines whether a new entry is
- unique by comparing the new entry to entries that hashed to the
- same bucket index. It should return zero for a pair of entries
- that compare equal, non-zero otherwise. */
-
- int (*hash_key_comparator) (const void *, const void *);
-
- HASH_ENT **hash_table;
- unsigned int hash_table_size;
- unsigned int hash_n_slots_used;
- unsigned int hash_max_chain_length;
-
- /* Gets set when an entry is deleted from a chain of length
- hash_max_chain_length. Indicates that hash_max_chain_length
- may no longer be valid. */
- unsigned int hash_dirty_max_chain_length;
-
- /* Sum of lengths of all chains (not counting any dummy
- header entries). */
- unsigned int hash_n_keys;
-
- /* A linked list of freed HASH_ENT structs.
- FIXME: Perhaps this is unnecessary and we should simply free
- and reallocate such structs. */
- HASH_ENT *hash_free_entry_list;
-
- /* FIXME: comment. */
-# ifdef USE_OBSTACK
- struct obstack ht_obstack;
+/* The __attribute__ feature is available in gcc versions 2.5 and later.
+ The warn_unused_result attribute appeared first in gcc-3.4.0. */
+# if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
+# define _GL_ATTRIBUTE_WUR __attribute__ ((__warn_unused_result__))
+# else
+# define _GL_ATTRIBUTE_WUR /* empty */
# endif
- };
-
-typedef struct HT HT;
-
-unsigned int
- hash_get_n_slots_used (const HT *ht);
-
-unsigned int
- hash_get_max_chain_length (HT *ht);
-
-int
- hash_rehash (HT *ht, unsigned int new_table_size);
-
-unsigned int
- hash_get_table_size (const HT *ht);
-
-HT *
- hash_initialize (unsigned int table_size,
- void (*key_freer) (void *key),
- unsigned int (*hash) (const void *, unsigned int),
- int (*equality_tester) (const void *, const void *));
-
-unsigned int
- hash_get_n_keys (const HT *ht);
-int
- hash_query_in_table (const HT *ht, const void *e);
-
-void *
- hash_lookup (const HT *ht, const void *e);
-
-void *
- hash_insert_if_absent (HT *ht, const void *e, int *failed);
-
-void *
- hash_delete_if_present (HT *ht, const void *e);
-
-void
- hash_print_statistics (const HT *ht, FILE *stream);
-
-int
- hash_get_statistics (const HT *ht, unsigned int *n_slots_used,
- unsigned int *n_keys,
- unsigned int *max_chain_length);
-
-int
- hash_table_ok (HT *ht);
-
-void
- hash_do_for_each (HT *ht, void (*f) (void *e, void *aux), void *aux);
-
-int
- hash_do_for_each_2 (HT *ht, int (*f) (void *e, void *aux), void *aux);
-
-int
- hash_do_for_each_in_selected_bucket (HT *ht, const void *key,
- int (*f) (const void *bucket_key,
- void *e, void *aux),
- void *aux);
-
-void
- hash_clear (HT *ht);
-
-void
- hash_free (HT *ht);
-
-void
- hash_get_key_list (const HT *ht, unsigned int bufsize, void **buf);
-
-void *
- hash_get_first (const HT *ht);
-
-void *
- hash_get_next (const HT *ht, const void *e);
+# ifndef _GL_ATTRIBUTE_DEPRECATED
+/* The __attribute__((__deprecated__)) feature
+ is available in gcc versions 3.1 and newer. */
+# if __GNUC__ < 3 || (__GNUC__ == 3 && __GNUC_MINOR__ < 1)
+# define _GL_ATTRIBUTE_DEPRECATED /* empty */
+# else
+# define _GL_ATTRIBUTE_DEPRECATED __attribute__ ((__deprecated__))
+# endif
+# endif
-/* This interface to hash_insert_if_absent is used frequently enough to
- merit a macro here. */
+typedef size_t (*Hash_hasher) (const void *, size_t);
+typedef bool (*Hash_comparator) (const void *, const void *);
+typedef void (*Hash_data_freer) (void *);
+typedef bool (*Hash_processor) (void *, void *);
-# define HASH_INSERT_NEW_ITEM(Ht, Item, Failp) \
- do \
- { \
- void *_already; \
- _already = hash_insert_if_absent ((Ht), (Item), Failp); \
- assert (_already == NULL); \
- } \
- while (0)
+struct hash_tuning
+ {
+ /* This structure is mainly used for 'hash_initialize', see the block
+ documentation of 'hash_reset_tuning' for more complete comments. */
+
+ float shrink_threshold; /* ratio of used buckets to trigger a shrink */
+ float shrink_factor; /* ratio of new smaller size to original size */
+ float growth_threshold; /* ratio of used buckets to trigger a growth */
+ float growth_factor; /* ratio of new bigger size to original size */
+ bool is_n_buckets; /* if CANDIDATE really means table size */
+ };
-#endif /* HASH_H */
+typedef struct hash_tuning Hash_tuning;
+
+struct hash_table;
+
+typedef struct hash_table Hash_table;
+
+/* Information and lookup. */
+size_t hash_get_n_buckets (const Hash_table *) _GL_ATTRIBUTE_PURE;
+size_t hash_get_n_buckets_used (const Hash_table *) _GL_ATTRIBUTE_PURE;
+size_t hash_get_n_entries (const Hash_table *) _GL_ATTRIBUTE_PURE;
+size_t hash_get_max_bucket_length (const Hash_table *) _GL_ATTRIBUTE_PURE;
+bool hash_table_ok (const Hash_table *) _GL_ATTRIBUTE_PURE;
+void hash_print_statistics (const Hash_table *, FILE *);
+void *hash_lookup (const Hash_table *, const void *);
+
+/* Walking. */
+void *hash_get_first (const Hash_table *) _GL_ATTRIBUTE_PURE;
+void *hash_get_next (const Hash_table *, const void *);
+size_t hash_get_entries (const Hash_table *, void **, size_t);
+size_t hash_do_for_each (const Hash_table *, Hash_processor, void *);
+
+/* Allocation and clean-up. */
+size_t hash_string (const char *, size_t) _GL_ATTRIBUTE_PURE;
+void hash_reset_tuning (Hash_tuning *);
+Hash_table *hash_initialize (size_t, const Hash_tuning *,
+ Hash_hasher, Hash_comparator,
+ Hash_data_freer) _GL_ATTRIBUTE_WUR;
+void hash_clear (Hash_table *);
+void hash_free (Hash_table *);
+
+/* Insertion and deletion. */
+bool hash_rehash (Hash_table *, size_t) _GL_ATTRIBUTE_WUR;
+void *hash_insert (Hash_table *, const void *) _GL_ATTRIBUTE_WUR;
+
+/* Deprecate this interface. It has been renamed to hash_insert_if_absent. */
+int hash_insert0 (Hash_table *table, /* FIXME: remove in 2013 */
+ const void *entry,
+ const void **matched_ent) _GL_ATTRIBUTE_DEPRECATED;
+int hash_insert_if_absent (Hash_table *table, const void *entry,
+ const void **matched_ent);
+void *hash_delete (Hash_table *, const void *);
+
+#endif
projects / gnulib.git / blobdiff