1/* hash.h -- header file for gas hash table routines
2   Copyright (C) 1987-2017 Free Software Foundation, Inc.
3
4   This file is part of GAS, the GNU Assembler.
5
6   GAS is free software; you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation; either version 3, or (at your option)
9   any later version.
10
11   GAS is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with GAS; see the file COPYING.  If not, write to the Free
18   Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA
19   02110-1301, USA.  */
20
21#ifndef HASH_H
22#define HASH_H
23
24struct hash_control;
25
26/* Set the size of the hash table used.  */
27
28void set_gas_hash_table_size (unsigned long);
29
30/* Create a hash table.  This return a control block.  */
31
32extern struct hash_control *hash_new (void);
33extern struct hash_control *hash_new_sized (unsigned long);
34
35/* Delete a hash table, freeing all allocated memory.  */
36
37extern void hash_die (struct hash_control *);
38
39/* Insert an entry into a hash table.  This returns NULL on success.
40   On error, it returns a printable string indicating the error.  It
41   is considered to be an error if the entry already exists in the
42   hash table.  */
43
44extern const char *hash_insert (struct hash_control *,
45				const char *key, void *value);
46
47/* Insert or replace an entry in a hash table.  This returns NULL on
48   success.  On error, it returns a printable string indicating the
49   error.  If an entry already exists, its value is replaced.  */
50
51extern const char *hash_jam (struct hash_control *,
52			     const char *key, void *value);
53
54/* Replace an existing entry in a hash table.  This returns the old
55   value stored for the entry.  If the entry is not found in the hash
56   table, this does nothing and returns NULL.  */
57
58extern void *hash_replace (struct hash_control *, const char *key,
59			 void *value);
60
61/* Find an entry in a hash table, returning its value.  Returns NULL
62   if the entry is not found.  */
63
64extern void *hash_find (struct hash_control *, const char *key);
65
66/* As hash_find, but KEY is of length LEN and is not guaranteed to be
67   NUL-terminated.  */
68
69extern void *hash_find_n (struct hash_control *, const char *key, size_t len);
70
71/* Delete an entry from a hash table.  This returns the value stored
72   for that entry, or NULL if there is no such entry.  */
73
74extern void *hash_delete (struct hash_control *, const char *key, int);
75
76/* Traverse a hash table.  Call the function on every entry in the
77   hash table.  */
78
79extern void hash_traverse (struct hash_control *,
80			   void (*pfn) (const char *key, void *value));
81
82/* Print hash table statistics on the specified file.  NAME is the
83   name of the hash table, used for printing a header.  */
84
85extern void hash_print_statistics (FILE *, const char *name,
86				   struct hash_control *);
87
88#endif /* HASH_H */
89