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