1 /* Routines for name->symbol lookups in GDB.
3 Copyright (C) 2003, 2007-2012 Free Software Foundation, Inc.
5 Contributed by David Carlton <carlton@bactrian.org> and by Kealia,
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
28 /* An opaque type for dictionaries; only dictionary.c should know
33 /* Other types needed for declarations. */
40 /* The creation functions for various implementations of
43 /* Create a dictionary implemented via a fixed-size hashtable. All
44 memory it uses is allocated on OBSTACK; the environment is
45 initialized from SYMBOL_LIST. */
47 extern struct dictionary
*dict_create_hashed (struct obstack
*obstack
,
51 /* Create a dictionary implemented via a hashtable that grows as
52 necessary. The dictionary is initially empty; to add symbols to
53 it, call dict_add_symbol(). Call dict_free() when you're done with
56 extern struct dictionary
*dict_create_hashed_expandable (void);
58 /* Create a dictionary implemented via a fixed-size array. All memory
59 it uses is allocated on OBSTACK; the environment is initialized
60 from the SYMBOL_LIST. The symbols are ordered in the same order
61 that they're found in SYMBOL_LIST. */
63 extern struct dictionary
*dict_create_linear (struct obstack
*obstack
,
67 /* Create a dictionary implemented via an array that grows as
68 necessary. The dictionary is initially empty; to add symbols to
69 it, call dict_add_symbol(). Call dict_free() when you're done with
72 extern struct dictionary
*dict_create_linear_expandable (void);
75 /* The functions providing the interface to dictionaries. Note that
76 the most common parts of the interface, namely symbol lookup, are
77 only provided via iterator functions. */
79 /* Free the memory used by a dictionary that's not on an obstack. (If
82 extern void dict_free (struct dictionary
*dict
);
84 /* Add a symbol to an expandable dictionary. */
86 extern void dict_add_symbol (struct dictionary
*dict
, struct symbol
*sym
);
88 /* Is the dictionary empty? */
90 extern int dict_empty (struct dictionary
*dict
);
92 /* A type containing data that is used when iterating over all symbols
93 in a dictionary. Don't ever look at its innards; this type would
94 be opaque if we didn't need to be able to allocate it on the
99 /* The dictionary that this iterator is associated to. */
100 const struct dictionary
*dict
;
101 /* The next two members are data that is used in a way that depends
102 on DICT's implementation type. */
104 struct symbol
*current
;
107 /* Initialize ITERATOR to point at the first symbol in DICT, and
108 return that first symbol, or NULL if DICT is empty. */
110 extern struct symbol
*dict_iterator_first (const struct dictionary
*dict
,
111 struct dict_iterator
*iterator
);
113 /* Advance ITERATOR, and return the next symbol, or NULL if there are
114 no more symbols. Don't call this if you've previously received
115 NULL from dict_iterator_first or dict_iterator_next on this
118 extern struct symbol
*dict_iterator_next (struct dict_iterator
*iterator
);
120 /* Initialize ITERATOR to point at the first symbol in DICT whose
121 SYMBOL_SEARCH_NAME is NAME (as tested using strcmp_iw), and return
122 that first symbol, or NULL if there are no such symbols. */
124 extern struct symbol
*dict_iter_name_first (const struct dictionary
*dict
,
126 struct dict_iterator
*iterator
);
128 /* Advance ITERATOR to point at the next symbol in DICT whose
129 SYMBOL_SEARCH_NAME is NAME (as tested using strcmp_iw), or NULL if
130 there are no more such symbols. Don't call this if you've
131 previously received NULL from dict_iterator_first or
132 dict_iterator_next on this iteration. And don't call it unless
133 ITERATOR was created by a previous call to dict_iter_name_first
134 with the same NAME. */
136 extern struct symbol
*dict_iter_name_next (const char *name
,
137 struct dict_iterator
*iterator
);
139 /* Initialize ITERATOR to point at the first symbol in DICT whose
140 SYMBOL_SEARCH_NAME is NAME, as tested using COMPARE (which must use
141 the same conventions as strcmp_iw and be compatible with any
142 dictionary hashing function), and return that first symbol, or NULL
143 if there are no such symbols. */
145 extern struct symbol
*dict_iter_match_first (const struct dictionary
*dict
,
147 symbol_compare_ftype
*compare
,
148 struct dict_iterator
*iterator
);
150 /* Advance ITERATOR to point at the next symbol in DICT whose
151 SYMBOL_SEARCH_NAME is NAME, as tested using COMPARE (see
152 dict_iter_match_first), or NULL if there are no more such symbols.
153 Don't call this if you've previously received NULL from
154 dict_iterator_match_first or dict_iterator_match_next on this
155 iteration. And don't call it unless ITERATOR was created by a
156 previous call to dict_iter_match_first with the same NAME and COMPARE. */
158 extern struct symbol
*dict_iter_match_next (const char *name
,
159 symbol_compare_ftype
*compare
,
160 struct dict_iterator
*iterator
);
162 /* Return some notion of the size of the dictionary: the number of
163 symbols if we have that, the number of hash buckets otherwise. */
165 extern int dict_size (const struct dictionary
*dict
);
167 /* Macro to loop through all symbols in a dictionary DICT, in no
168 particular order. ITER is a struct dict_iterator (NOTE: __not__ a
169 struct dict_iterator *), and SYM points to the current symbol.
171 It's implemented as a single loop, so you can terminate the loop
172 early by a break if you desire. */
174 #define ALL_DICT_SYMBOLS(dict, iter, sym) \
175 for ((sym) = dict_iterator_first ((dict), &(iter)); \
177 (sym) = dict_iterator_next (&(iter)))
179 #endif /* DICTIONARY_H */
This page took 0.032185 seconds and 4 git commands to generate.