merge from gcc
[binutils.git] / gas / hash.h
blob08f41e6c9de5b974b2fb8bb2e4108a07587615ae
1 /* hash.h -- header file for gas hash table routines
2 Copyright 1987, 1992, 1993, 1995, 1999 Free Software Foundation, Inc.
4 This file is part of GAS, the GNU Assembler.
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 2, or (at your option)
9 any later version.
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.
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, 59 Temple Place - Suite 330, Boston, MA
19 02111-1307, USA. */
21 #ifndef HASH_H
22 #define HASH_H
24 struct hash_control;
26 /* Create a hash table. This return a control block. */
28 extern struct hash_control *hash_new (void);
30 /* Delete a hash table, freeing all allocated memory. */
32 extern void hash_die (struct hash_control *);
34 /* Insert an entry into a hash table. This returns NULL on success.
35 On error, it returns a printable string indicating the error. It
36 is considered to be an error if the entry already exists in the
37 hash table. */
39 extern const char *hash_insert (struct hash_control *,
40 const char *key, PTR value);
42 /* Insert or replace an entry in a hash table. This returns NULL on
43 success. On error, it returns a printable string indicating the
44 error. If an entry already exists, its value is replaced. */
46 extern const char *hash_jam (struct hash_control *,
47 const char *key, PTR value);
49 /* Replace an existing entry in a hash table. This returns the old
50 value stored for the entry. If the entry is not found in the hash
51 table, this does nothing and returns NULL. */
53 extern PTR hash_replace (struct hash_control *, const char *key,
54 PTR value);
56 /* Find an entry in a hash table, returning its value. Returns NULL
57 if the entry is not found. */
59 extern PTR hash_find (struct hash_control *, const char *key);
61 /* Delete an entry from a hash table. This returns the value stored
62 for that entry, or NULL if there is no such entry. */
64 extern PTR hash_delete (struct hash_control *, const char *key);
66 /* Traverse a hash table. Call the function on every entry in the
67 hash table. */
69 extern void hash_traverse (struct hash_control *,
70 void (*pfn) (const char *key, PTR value));
72 /* Print hash table statistics on the specified file. NAME is the
73 name of the hash table, used for printing a header. */
75 extern void hash_print_statistics (FILE *, const char *name,
76 struct hash_control *);
78 #endif /* HASH_H */