* SDCPP synchronized with GCC CPP release version 3.4.6,
[fw/sdcc] / support / cpp2 / hashtable.h
1 /* Hash tables.
2    Copyright (C) 2000, 2001, 2003 Free Software Foundation, Inc.
3
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the
6 Free Software Foundation; either version 2, or (at your option) any
7 later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
17
18 #ifndef GCC_HASHTABLE_H
19 #define GCC_HASHTABLE_H
20
21 #if defined(__APPLE__) && defined(__MACH__)
22 #include "libiberty/obstack.h"
23 #else
24 #include "obstack.h"
25 #endif
26 #define GTY(x) /* nothing */
27
28 /* This is what each hash table entry points to.  It may be embedded
29    deeply within another object.  */
30 typedef struct ht_identifier ht_identifier;
31 struct ht_identifier GTY(())
32 {
33   const unsigned char *str;
34   unsigned int len;
35   unsigned int hash_value;
36 };
37
38 #define HT_LEN(NODE) ((NODE)->len)
39 #define HT_STR(NODE) ((NODE)->str)
40
41 typedef struct ht hash_table;
42 typedef struct ht_identifier *hashnode;
43
44 enum ht_lookup_option {HT_NO_INSERT = 0, HT_ALLOC, HT_ALLOCED};
45
46 /* An identifier hash table for cpplib and the front ends.  */
47 struct ht
48 {
49   /* Identifiers are allocated from here.  */
50   struct obstack stack;
51
52   hashnode *entries;
53   /* Call back.  */
54   hashnode (*alloc_node) (hash_table *);
55
56   unsigned int nslots;          /* Total slots in the entries array.  */
57   unsigned int nelements;       /* Number of live elements.  */
58
59   /* Link to reader, if any.  For the benefit of cpplib.  */
60   struct cpp_reader *pfile;
61
62   /* Table usage statistics.  */
63   unsigned int searches;
64   unsigned int collisions;
65 };
66
67 /* Initialize the hashtable with 2 ^ order entries.  */
68 extern hash_table *ht_create (unsigned int order);
69
70 /* Frees all memory associated with a hash table.  */
71 extern void ht_destroy (hash_table *);
72
73 extern hashnode ht_lookup (hash_table *, const unsigned char *,
74                            size_t, enum ht_lookup_option);
75
76 /* For all nodes in TABLE, make a callback.  The callback takes
77    TABLE->PFILE, the node, and a PTR, and the callback sequence stops
78    if the callback returns zero.  */
79 typedef int (*ht_cb) (struct cpp_reader *, hashnode, const void *);
80 extern void ht_forall (hash_table *, ht_cb, const void *);
81
82 /* Dump allocation statistics to stderr.  */
83 extern void ht_dump_statistics (hash_table *);
84
85 #endif /* GCC_HASHTABLE_H */