1 /* Routines for name->symbol lookups in GDB.
3 Copyright (C) 2003-2019 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 multi-language dictionaries; only dictionary.c should
29 know about its innards. */
31 struct multidictionary
;
33 /* Other types needed for declarations. */
40 /* The creation functions for various implementations of
41 multi-language dictionaries. */
43 /* Create a multi-language dictionary of symbols implemented via
44 a fixed-size hashtable. All memory it uses is allocated on
45 OBSTACK; the environment is initialized from SYMBOL_LIST. */
47 extern struct multidictionary
*
48 mdict_create_hashed (struct obstack
*obstack
,
49 const struct pending
*symbol_list
);
51 /* Create a multi-language dictionary of symbols, implemented
52 via a hashtable that grows as necessary. The initial dictionary of
53 LANGUAGE is empty; to add symbols to it, call mdict_add_symbol().
54 Call mdict_free() when you're done with it. */
56 extern struct multidictionary
*
57 mdict_create_hashed_expandable (enum language language
);
59 /* Create a multi-language dictionary of symbols, implemented
60 via a fixed-size array. All memory it uses is allocated on
61 OBSTACK; the environment is initialized from the SYMBOL_LIST. The
62 symbols are ordered in the same order that they're found in
65 extern struct multidictionary
*
66 mdict_create_linear (struct obstack
*obstack
,
67 const struct pending
*symbol_list
);
69 /* Create a multi-language dictionary of symbols, implemented
70 via an array that grows as necessary. The multidictionary initially
71 contains a single empty dictionary of LANGUAGE; to add symbols to it,
72 call mdict_add_symbol(). Call mdict_free() when you're done with it. */
74 extern struct multidictionary
*
75 mdict_create_linear_expandable (enum language language
);
77 /* The functions providing the interface to multi-language dictionaries.
78 Note that the most common parts of the interface, namely symbol lookup,
79 are only provided via iterator functions. */
81 /* Free the memory used by a multidictionary that's not on an obstack. (If
84 extern void mdict_free (struct multidictionary
*mdict
);
86 /* Add a symbol to an expandable multidictionary. */
88 extern void mdict_add_symbol (struct multidictionary
*mdict
,
91 /* Utility to add a list of symbols to a multidictionary. */
93 extern void mdict_add_pending (struct multidictionary
*mdict
,
94 const struct pending
*symbol_list
);
96 /* Is the multidictionary empty? */
98 extern int mdict_empty (struct multidictionary
*mdict
);
100 /* A type containing data that is used when iterating over all symbols
101 in a dictionary. Don't ever look at its innards; this type would
102 be opaque if we didn't need to be able to allocate it on the
107 /* The dictionary that this iterator is associated to. */
108 const struct dictionary
*dict
;
109 /* The next two members are data that is used in a way that depends
110 on DICT's implementation type. */
112 struct symbol
*current
;
115 /* The multi-language dictionary iterator. Like dict_iterator above,
116 these contents should be considered private. */
118 struct mdict_iterator
120 /* The multidictionary with whcih this iterator is associated. */
121 const struct multidictionary
*mdict
;
123 /* The iterator used to iterate through individual dictionaries. */
124 struct dict_iterator iterator
;
126 /* The current index of the dictionary being iterated over. */
127 unsigned short current_idx
;
130 /* Initialize ITERATOR to point at the first symbol in MDICT, and
131 return that first symbol, or NULL if MDICT is empty. */
133 extern struct symbol
*
134 mdict_iterator_first (const struct multidictionary
*mdict
,
135 struct mdict_iterator
*miterator
);
137 /* Advance MITERATOR, and return the next symbol, or NULL if there are
138 no more symbols. Don't call this if you've previously received
139 NULL from mdict_iterator_first or mdict_iterator_next on this
142 extern struct symbol
*mdict_iterator_next (struct mdict_iterator
*miterator
);
144 /* Initialize MITERATOR to point at the first symbol in MDICT whose
145 SYMBOL_SEARCH_NAME is NAME, as tested using COMPARE (which must use
146 the same conventions as strcmp_iw and be compatible with any
147 dictionary hashing function), and return that first symbol, or NULL
148 if there are no such symbols. */
150 extern struct symbol
*
151 mdict_iter_match_first (const struct multidictionary
*mdict
,
152 const lookup_name_info
&name
,
153 struct mdict_iterator
*miterator
);
155 /* Advance MITERATOR to point at the next symbol in MDICT whose
156 SYMBOL_SEARCH_NAME is NAME, as tested using COMPARE (see
157 dict_iter_match_first), or NULL if there are no more such symbols.
158 Don't call this if you've previously received NULL from
159 mdict_iterator_match_first or mdict_iterator_match_next on this
160 iteration. And don't call it unless MITERATOR was created by a
161 previous call to mdict_iter_match_first with the same NAME and COMPARE. */
163 extern struct symbol
*mdict_iter_match_next (const lookup_name_info
&name
,
164 struct mdict_iterator
*miterator
);
166 /* Return some notion of the size of the multidictionary: the number of
167 symbols if we have that, the number of hash buckets otherwise. */
169 extern int mdict_size (const struct multidictionary
*mdict
);
171 /* Macro to loop through all symbols in a dictionary DICT, in no
172 particular order. ITER is a struct dict_iterator (NOTE: __not__ a
173 struct dict_iterator *), and SYM points to the current symbol.
175 It's implemented as a single loop, so you can terminate the loop
176 early by a break if you desire. */
178 #define ALL_DICT_SYMBOLS(dict, iter, sym) \
179 for ((sym) = mdict_iterator_first ((dict), &(iter)); \
181 (sym) = mdict_iterator_next (&(iter)))
183 #endif /* DICTIONARY_H */
This page took 0.037183 seconds and 4 git commands to generate.