WebSVN – Kolibri OS – Diff – /contrib/toolchain/binutils/include/hashtab.h


/* An expandable hash tables datatype.  
 
   Copyright (C) 1999-2015 Free Software Foundation, Inc.
   Contributed by Vladimir Makarov (vmakarov@cygnus.com).
 
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 2 of the License, or
(at your option) any later version.
 
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.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */
 
/* This package implements basic hash table functionality.  It is possible
   to search for an entry, create an entry and destroy an entry.
 
   Elements in the table are generic pointers.
 
   The size of the table is not fixed; if the occupancy of the table
   grows too high the hash table will be expanded.
 
   The abstract data implementation is based on generalized Algorithm D
   from Knuth's book "The art of computer programming".  Hash table is
   expanded by creation of new hash table and transferring elements from
   the old table to the new table.  */
 
#ifndef __HASHTAB_H__
#define __HASHTAB_H__
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#include "ansidecl.h"
 
 
 
 
 
/* The type for a hash code.  */
typedef unsigned int hashval_t;
 
/* Callback function pointer types.  */
 
/* Calculate hash of a table entry.  */
typedef hashval_t (*htab_hash) (const void *);
 
/* Compare a table entry with a possible entry.  The entry already in
   the table always comes first, so the second element can be of a
   different type (but in this case htab_find and htab_find_slot
   cannot be used; instead the variants that accept a hash value
   must be used).  */
typedef int (*htab_eq) (const void *, const void *);
 
/* Cleanup function called whenever a live element is removed from
   the hash table.  */
typedef void (*htab_del) (void *);
  
/* Function called by htab_traverse for each live element.  The first
   arg is the slot of the element (which can be passed to htab_clear_slot
   if desired), the second arg is the auxiliary pointer handed to
   htab_traverse.  Return 1 to continue scan, 0 to stop.  */
typedef int (*htab_trav) (void **, void *);
 
/* Memory-allocation function, with the same functionality as calloc().
   Iff it returns NULL, the hash table implementation will pass an error
   code back to the user, so if your code doesn't handle errors,
   best if you use xcalloc instead.  */
typedef void *(*htab_alloc) (size_t, size_t);
 
/* We also need a free() routine.  */
typedef void (*htab_free) (void *);
 
/* Memory allocation and deallocation; variants which take an extra
   argument.  */
typedef void *(*htab_alloc_with_arg) (void *, size_t, size_t);
typedef void (*htab_free_with_arg) (void *, void *);
 
/* This macro defines reserved value for empty table entry.  */
 
#define HTAB_EMPTY_ENTRY    ((PTR) 0)
 
/* This macro defines reserved value for table entry which contained
   a deleted element. */
 
#define HTAB_DELETED_ENTRY  ((PTR) 1)
 
/* Hash tables are of the following type.  The structure
   (implementation) of this type is not needed for using the hash
   tables.  All work with hash table should be executed only through
   functions mentioned below.  The size of this structure is subject to
   change.  */
 
struct htab {
  /* Pointer to hash function.  */
  htab_hash hash_f;
 
  /* Pointer to comparison function.  */
  htab_eq eq_f;
 
  /* Pointer to cleanup function.  */
  htab_del del_f;
 
  /* Table itself.  */
  void **entries;
 
  /* Current size (in entries) of the hash table.  */
  size_t size;
 
  /* Current number of elements including also deleted elements.  */
  size_t n_elements;
 
  /* Current number of deleted elements in the table.  */
  size_t n_deleted;
 
  /* The following member is used for debugging. Its value is number
     of all calls of `htab_find_slot' for the hash table. */
  unsigned int searches;
 
  /* The following member is used for debugging.  Its value is number
     of collisions fixed for time of work with the hash table. */
  unsigned int collisions;
 
  /* Pointers to allocate/free functions.  */
  htab_alloc alloc_f;
  htab_free free_f;
 
  /* Alternate allocate/free functions, which take an extra argument.  */
  void *alloc_arg;
  htab_alloc_with_arg alloc_with_arg_f;
  htab_free_with_arg free_with_arg_f;
 
  /* Current size (in entries) of the hash table, as an index into the
     table of primes.  */
  unsigned int size_prime_index;
};
 
typedef struct htab *htab_t;
 
/* An enum saying whether we insert into the hash table or not.  */
enum insert_option {NO_INSERT, INSERT};
 
/* The prototypes of the package functions. */
 
extern htab_t	htab_create_alloc  (size_t, htab_hash,
                                    htab_eq, htab_del,
                                    htab_alloc, htab_free);
 
extern htab_t	htab_create_alloc_ex (size_t, htab_hash,
                                      htab_eq, htab_del,
                                      void *, htab_alloc_with_arg,
                                      htab_free_with_arg);
 
extern htab_t  htab_create_typed_alloc (size_t, htab_hash, htab_eq, htab_del,
					htab_alloc, htab_alloc, htab_free);
 
/* Backward-compatibility functions.  */
extern htab_t htab_create (size_t, htab_hash, htab_eq, htab_del);
extern htab_t htab_try_create (size_t, htab_hash, htab_eq, htab_del);
 
extern void	htab_set_functions_ex (htab_t, htab_hash,
                                       htab_eq, htab_del,
                                       void *, htab_alloc_with_arg,
                                       htab_free_with_arg);
 
extern void	htab_delete (htab_t);
extern void	htab_empty (htab_t);
 
extern void *	htab_find (htab_t, const void *);
extern void **	htab_find_slot (htab_t, const void *, enum insert_option);
extern void *	htab_find_with_hash (htab_t, const void *, hashval_t);
extern void **	htab_find_slot_with_hash (htab_t, const void *,
					  hashval_t, enum insert_option);
extern void	htab_clear_slot	(htab_t, void **);
extern void	htab_remove_elt	(htab_t, void *);
extern void	htab_remove_elt_with_hash (htab_t, void *, hashval_t);
 
extern void	htab_traverse (htab_t, htab_trav, void *);
extern void	htab_traverse_noresize (htab_t, htab_trav, void *);
 
extern size_t	htab_size (htab_t);
extern size_t	htab_elements (htab_t);
extern double	htab_collisions	(htab_t);
 
/* A hash function for pointers.  */
extern htab_hash htab_hash_pointer;
 
/* An equality function for pointers.  */
extern htab_eq htab_eq_pointer;
 
/* A hash function for null-terminated strings.  */
extern hashval_t htab_hash_string (const void *);
 
/* An iterative hash function for arbitrary data.  */
extern hashval_t iterative_hash (const void *, size_t, hashval_t);
/* Shorthand for hashing something with an intrinsic size.  */
#define iterative_hash_object(OB,INIT) iterative_hash (&OB, sizeof (OB), INIT)
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* __HASHTAB_H */

Subversion Repositories Kolibri OS

(root)/contrib/toolchain/binutils/include/hashtab.h – Rev 5191 → 6324

Rev 5191		Rev 6324
1	/* An expandable hash tables datatype.	1	/* An expandable hash tables datatype.
2	Copyright (C) 1999, 2000, 2002, 2003, 2004, 2005, 2009, 2010	-
3	Free Software Foundation, Inc.	2	Copyright (C) 1999-2015 Free Software Foundation, Inc.
4	Contributed by Vladimir Makarov (vmakarov@cygnus.com).	3	Contributed by Vladimir Makarov (vmakarov@cygnus.com).
5		4
6	This program is free software; you can redistribute it and/or modify	5	This program is free software; you can redistribute it and/or modify
7	it under the terms of the GNU General Public License as published by	6	it under the terms of the GNU General Public License as published by
8	the Free Software Foundation; either version 2 of the License, or	7	the Free Software Foundation; either version 2 of the License, or
9	(at your option) any later version.	8	(at your option) any later version.
10		9
11	This program is distributed in the hope that it will be useful,	10	This program is distributed in the hope that it will be useful,
12	but WITHOUT ANY WARRANTY; without even the implied warranty of	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14	GNU General Public License for more details.	13	GNU General Public License for more details.
15		14
16	You should have received a copy of the GNU General Public License	15	You should have received a copy of the GNU General Public License
17	along with this program; if not, write to the Free Software	16	along with this program; if not, write to the Free Software
18	Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */	17	Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */
19		18
20	/* This package implements basic hash table functionality. It is possible	19	/* This package implements basic hash table functionality. It is possible
21	to search for an entry, create an entry and destroy an entry.	20	to search for an entry, create an entry and destroy an entry.
22		21
23	Elements in the table are generic pointers.	22	Elements in the table are generic pointers.
24		23
25	The size of the table is not fixed; if the occupancy of the table	24	The size of the table is not fixed; if the occupancy of the table
26	grows too high the hash table will be expanded.	25	grows too high the hash table will be expanded.
27		26
28	The abstract data implementation is based on generalized Algorithm D	27	The abstract data implementation is based on generalized Algorithm D
29	from Knuth's book "The art of computer programming". Hash table is	28	from Knuth's book "The art of computer programming". Hash table is
30	expanded by creation of new hash table and transferring elements from	29	expanded by creation of new hash table and transferring elements from
31	the old table to the new table. */	30	the old table to the new table. */
32		31
33	#ifndef __HASHTAB_H__	32	#ifndef __HASHTAB_H__
34	#define __HASHTAB_H__	33	#define __HASHTAB_H__
35		34
36	#ifdef __cplusplus	35	#ifdef __cplusplus
37	extern "C" {	36	extern "C" {
38	#endif /* __cplusplus */	37	#endif /* __cplusplus */
39		38
40	#include "ansidecl.h"	39	#include "ansidecl.h"
41		-
42	#ifndef GTY	-
43	#define GTY(X)	-
44	#endif	-
45		40
46	/* The type for a hash code. */	41	/* The type for a hash code. */
47	typedef unsigned int hashval_t;	42	typedef unsigned int hashval_t;
48		43
49	/* Callback function pointer types. */	44	/* Callback function pointer types. */
50		45
51	/* Calculate hash of a table entry. */	46	/* Calculate hash of a table entry. */
52	typedef hashval_t (htab_hash) (const void );	47	typedef hashval_t (htab_hash) (const void );
53		48
54	/* Compare a table entry with a possible entry. The entry already in	49	/* Compare a table entry with a possible entry. The entry already in
55	the table always comes first, so the second element can be of a	50	the table always comes first, so the second element can be of a
56	different type (but in this case htab_find and htab_find_slot	51	different type (but in this case htab_find and htab_find_slot
57	cannot be used; instead the variants that accept a hash value	52	cannot be used; instead the variants that accept a hash value
58	must be used). */	53	must be used). */
59	typedef int (htab_eq) (const void , const void *);	54	typedef int (htab_eq) (const void , const void *);
60		55
61	/* Cleanup function called whenever a live element is removed from	56	/* Cleanup function called whenever a live element is removed from
62	the hash table. */	57	the hash table. */
63	typedef void (htab_del) (void );	58	typedef void (htab_del) (void );
64		59
65	/* Function called by htab_traverse for each live element. The first	60	/* Function called by htab_traverse for each live element. The first
66	arg is the slot of the element (which can be passed to htab_clear_slot	61	arg is the slot of the element (which can be passed to htab_clear_slot
67	if desired), the second arg is the auxiliary pointer handed to	62	if desired), the second arg is the auxiliary pointer handed to
68	htab_traverse. Return 1 to continue scan, 0 to stop. */	63	htab_traverse. Return 1 to continue scan, 0 to stop. */
69	typedef int (htab_trav) (void , void );	64	typedef int (htab_trav) (void , void );
70		65
71	/* Memory-allocation function, with the same functionality as calloc().	66	/* Memory-allocation function, with the same functionality as calloc().
72	Iff it returns NULL, the hash table implementation will pass an error	67	Iff it returns NULL, the hash table implementation will pass an error
73	code back to the user, so if your code doesn't handle errors,	68	code back to the user, so if your code doesn't handle errors,
74	best if you use xcalloc instead. */	69	best if you use xcalloc instead. */
75	typedef void (htab_alloc) (size_t, size_t);	70	typedef void (htab_alloc) (size_t, size_t);
76		71
77	/* We also need a free() routine. */	72	/* We also need a free() routine. */
78	typedef void (htab_free) (void );	73	typedef void (htab_free) (void );
79		74
80	/* Memory allocation and deallocation; variants which take an extra	75	/* Memory allocation and deallocation; variants which take an extra
81	argument. */	76	argument. */
82	typedef void (htab_alloc_with_arg) (void *, size_t, size_t);	77	typedef void (htab_alloc_with_arg) (void *, size_t, size_t);
83	typedef void (htab_free_with_arg) (void , void *);	78	typedef void (htab_free_with_arg) (void , void *);
84		79
85	/* This macro defines reserved value for empty table entry. */	80	/* This macro defines reserved value for empty table entry. */
86		81
87	#define HTAB_EMPTY_ENTRY ((PTR) 0)	82	#define HTAB_EMPTY_ENTRY ((PTR) 0)
88		83
89	/* This macro defines reserved value for table entry which contained	84	/* This macro defines reserved value for table entry which contained
90	a deleted element. */	85	a deleted element. */
91		86
92	#define HTAB_DELETED_ENTRY ((PTR) 1)	87	#define HTAB_DELETED_ENTRY ((PTR) 1)
93		88
94	/* Hash tables are of the following type. The structure	89	/* Hash tables are of the following type. The structure
95	(implementation) of this type is not needed for using the hash	90	(implementation) of this type is not needed for using the hash
96	tables. All work with hash table should be executed only through	91	tables. All work with hash table should be executed only through
97	functions mentioned below. The size of this structure is subject to	92	functions mentioned below. The size of this structure is subject to
98	change. */	93	change. */
99		94
100	struct GTY(()) htab {	95	struct htab {
101	/* Pointer to hash function. */	96	/* Pointer to hash function. */
102	htab_hash hash_f;	97	htab_hash hash_f;
103		98
104	/* Pointer to comparison function. */	99	/* Pointer to comparison function. */
105	htab_eq eq_f;	100	htab_eq eq_f;
106		101
107	/* Pointer to cleanup function. */	102	/* Pointer to cleanup function. */
108	htab_del del_f;	103	htab_del del_f;
109		104
110	/* Table itself. */	105	/* Table itself. */
111	void ** GTY ((use_param, length ("%h.size"))) entries;	106	void **entries;
112		107
113	/* Current size (in entries) of the hash table. */	108	/* Current size (in entries) of the hash table. */
114	size_t size;	109	size_t size;
115		110
116	/* Current number of elements including also deleted elements. */	111	/* Current number of elements including also deleted elements. */
117	size_t n_elements;	112	size_t n_elements;
118		113
119	/* Current number of deleted elements in the table. */	114	/* Current number of deleted elements in the table. */
120	size_t n_deleted;	115	size_t n_deleted;
121		116
122	/* The following member is used for debugging. Its value is number	117	/* The following member is used for debugging. Its value is number
123	of all calls of `htab_find_slot' for the hash table. */	118	of all calls of `htab_find_slot' for the hash table. */
124	unsigned int searches;	119	unsigned int searches;
125		120
126	/* The following member is used for debugging. Its value is number	121	/* The following member is used for debugging. Its value is number
127	of collisions fixed for time of work with the hash table. */	122	of collisions fixed for time of work with the hash table. */
128	unsigned int collisions;	123	unsigned int collisions;
129		124
130	/* Pointers to allocate/free functions. */	125	/* Pointers to allocate/free functions. */
131	htab_alloc alloc_f;	126	htab_alloc alloc_f;
132	htab_free free_f;	127	htab_free free_f;
133		128
134	/* Alternate allocate/free functions, which take an extra argument. */	129	/* Alternate allocate/free functions, which take an extra argument. */
135	void * GTY((skip)) alloc_arg;	130	void *alloc_arg;
136	htab_alloc_with_arg alloc_with_arg_f;	131	htab_alloc_with_arg alloc_with_arg_f;
137	htab_free_with_arg free_with_arg_f;	132	htab_free_with_arg free_with_arg_f;
138		133
139	/* Current size (in entries) of the hash table, as an index into the	134	/* Current size (in entries) of the hash table, as an index into the
140	table of primes. */	135	table of primes. */
141	unsigned int size_prime_index;	136	unsigned int size_prime_index;
142	};	137	};
143		138
144	typedef struct htab *htab_t;	139	typedef struct htab *htab_t;
145		140
146	/* An enum saying whether we insert into the hash table or not. */	141	/* An enum saying whether we insert into the hash table or not. */
147	enum insert_option {NO_INSERT, INSERT};	142	enum insert_option {NO_INSERT, INSERT};
148		143
149	/* The prototypes of the package functions. */	144	/* The prototypes of the package functions. */
150		145
151	extern htab_t htab_create_alloc (size_t, htab_hash,	146	extern htab_t htab_create_alloc (size_t, htab_hash,
152	htab_eq, htab_del,	147	htab_eq, htab_del,
153	htab_alloc, htab_free);	148	htab_alloc, htab_free);
154		149
155	extern htab_t htab_create_alloc_ex (size_t, htab_hash,	150	extern htab_t htab_create_alloc_ex (size_t, htab_hash,
156	htab_eq, htab_del,	151	htab_eq, htab_del,
157	void *, htab_alloc_with_arg,	152	void *, htab_alloc_with_arg,
158	htab_free_with_arg);	153	htab_free_with_arg);
159		154
160	extern htab_t htab_create_typed_alloc (size_t, htab_hash, htab_eq, htab_del,	155	extern htab_t htab_create_typed_alloc (size_t, htab_hash, htab_eq, htab_del,
161	htab_alloc, htab_alloc, htab_free);	156	htab_alloc, htab_alloc, htab_free);
162		157
163	/* Backward-compatibility functions. */	158	/* Backward-compatibility functions. */
164	extern htab_t htab_create (size_t, htab_hash, htab_eq, htab_del);	159	extern htab_t htab_create (size_t, htab_hash, htab_eq, htab_del);
165	extern htab_t htab_try_create (size_t, htab_hash, htab_eq, htab_del);	160	extern htab_t htab_try_create (size_t, htab_hash, htab_eq, htab_del);
166		161
167	extern void htab_set_functions_ex (htab_t, htab_hash,	162	extern void htab_set_functions_ex (htab_t, htab_hash,
168	htab_eq, htab_del,	163	htab_eq, htab_del,
169	void *, htab_alloc_with_arg,	164	void *, htab_alloc_with_arg,
170	htab_free_with_arg);	165	htab_free_with_arg);
171		166
172	extern void htab_delete (htab_t);	167	extern void htab_delete (htab_t);
173	extern void htab_empty (htab_t);	168	extern void htab_empty (htab_t);
174		169
175	extern void * htab_find (htab_t, const void *);	170	extern void * htab_find (htab_t, const void *);
176	extern void ** htab_find_slot (htab_t, const void *, enum insert_option);	171	extern void ** htab_find_slot (htab_t, const void *, enum insert_option);
177	extern void * htab_find_with_hash (htab_t, const void *, hashval_t);	172	extern void * htab_find_with_hash (htab_t, const void *, hashval_t);
178	extern void ** htab_find_slot_with_hash (htab_t, const void *,	173	extern void ** htab_find_slot_with_hash (htab_t, const void *,
179	hashval_t, enum insert_option);	174	hashval_t, enum insert_option);
180	extern void htab_clear_slot (htab_t, void **);	175	extern void htab_clear_slot (htab_t, void **);
181	extern void htab_remove_elt (htab_t, void *);	176	extern void htab_remove_elt (htab_t, void *);
182	extern void htab_remove_elt_with_hash (htab_t, void *, hashval_t);	177	extern void htab_remove_elt_with_hash (htab_t, void *, hashval_t);
183		178
184	extern void htab_traverse (htab_t, htab_trav, void *);	179	extern void htab_traverse (htab_t, htab_trav, void *);
185	extern void htab_traverse_noresize (htab_t, htab_trav, void *);	180	extern void htab_traverse_noresize (htab_t, htab_trav, void *);
186		181
187	extern size_t htab_size (htab_t);	182	extern size_t htab_size (htab_t);
188	extern size_t htab_elements (htab_t);	183	extern size_t htab_elements (htab_t);
189	extern double htab_collisions (htab_t);	184	extern double htab_collisions (htab_t);
190		185
191	/* A hash function for pointers. */	186	/* A hash function for pointers. */
192	extern htab_hash htab_hash_pointer;	187	extern htab_hash htab_hash_pointer;
193		188
194	/* An equality function for pointers. */	189	/* An equality function for pointers. */
195	extern htab_eq htab_eq_pointer;	190	extern htab_eq htab_eq_pointer;
196		191
197	/* A hash function for null-terminated strings. */	192	/* A hash function for null-terminated strings. */
198	extern hashval_t htab_hash_string (const void *);	193	extern hashval_t htab_hash_string (const void *);
199		194
200	/* An iterative hash function for arbitrary data. */	195	/* An iterative hash function for arbitrary data. */
201	extern hashval_t iterative_hash (const void *, size_t, hashval_t);	196	extern hashval_t iterative_hash (const void *, size_t, hashval_t);
202	/* Shorthand for hashing something with an intrinsic size. */	197	/* Shorthand for hashing something with an intrinsic size. */
203	#define iterative_hash_object(OB,INIT) iterative_hash (&OB, sizeof (OB), INIT)	198	#define iterative_hash_object(OB,INIT) iterative_hash (&OB, sizeof (OB), INIT)
204		199
205	#ifdef __cplusplus	200	#ifdef __cplusplus
206	}	201	}
207	#endif /* __cplusplus */	202	#endif /* __cplusplus */
208		203
209	#endif /* __HASHTAB_H */	204	#endif /* __HASHTAB_H */