1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
/* Routines for name->symbol lookups in GDB.
Copyright (C) 2003-2019 Free Software Foundation, Inc.
Contributed by David Carlton <carlton@bactrian.org> and by Kealia,
Inc.
This file is part of GDB.
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 3 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, see <http://www.gnu.org/licenses/>. */
#ifndef DICTIONARY_H
#define DICTIONARY_H
#include "symfile.h"
/* An opaque type for multi-language dictionaries; only dictionary.c should
know about its innards. */
struct multidictionary;
/* Other types needed for declarations. */
struct symbol;
struct obstack;
struct pending;
struct language_defn;
/* The creation functions for various implementations of
multi-language dictionaries. */
/* Create a multi-language dictionary of symbols implemented via
a fixed-size hashtable. All memory it uses is allocated on
OBSTACK; the environment is initialized from SYMBOL_LIST. */
extern struct multidictionary *
mdict_create_hashed (struct obstack *obstack,
const struct pending *symbol_list);
/* Create a multi-language dictionary of symbols, implemented
via a hashtable that grows as necessary. The initial dictionary of
LANGUAGE is empty; to add symbols to it, call mdict_add_symbol().
Call mdict_free() when you're done with it. */
extern struct multidictionary *
mdict_create_hashed_expandable (enum language language);
/* Create a multi-language dictionary of symbols, implemented
via a fixed-size array. All memory it uses is allocated on
OBSTACK; the environment is initialized from the SYMBOL_LIST. The
symbols are ordered in the same order that they're found in
SYMBOL_LIST. */
extern struct multidictionary *
mdict_create_linear (struct obstack *obstack,
const struct pending *symbol_list);
/* Create a multi-language dictionary of symbols, implemented
via an array that grows as necessary. The multidictionary initially
contains a single empty dictionary of LANGUAGE; to add symbols to it,
call mdict_add_symbol(). Call mdict_free() when you're done with it. */
extern struct multidictionary *
mdict_create_linear_expandable (enum language language);
/* The functions providing the interface to multi-language dictionaries.
Note that the most common parts of the interface, namely symbol lookup,
are only provided via iterator functions. */
/* Free the memory used by a multidictionary that's not on an obstack. (If
any.) */
extern void mdict_free (struct multidictionary *mdict);
/* Add a symbol to an expandable multidictionary. */
extern void mdict_add_symbol (struct multidictionary *mdict,
struct symbol *sym);
/* Utility to add a list of symbols to a multidictionary. */
extern void mdict_add_pending (struct multidictionary *mdict,
const struct pending *symbol_list);
/* Is the multidictionary empty? */
extern int mdict_empty (struct multidictionary *mdict);
/* A type containing data that is used when iterating over all symbols
in a dictionary. Don't ever look at its innards; this type would
be opaque if we didn't need to be able to allocate it on the
stack. */
struct dict_iterator
{
/* The dictionary that this iterator is associated to. */
const struct dictionary *dict;
/* The next two members are data that is used in a way that depends
on DICT's implementation type. */
int index;
struct symbol *current;
};
/* The multi-language dictionary iterator. Like dict_iterator above,
these contents should be considered private. */
struct mdict_iterator
{
/* The multidictionary with whcih this iterator is associated. */
const struct multidictionary *mdict;
/* The iterator used to iterate through individual dictionaries. */
struct dict_iterator iterator;
/* The current index of the dictionary being iterated over. */
unsigned short current_idx;
};
/* Initialize ITERATOR to point at the first symbol in MDICT, and
return that first symbol, or NULL if MDICT is empty. */
extern struct symbol *
mdict_iterator_first (const struct multidictionary *mdict,
struct mdict_iterator *miterator);
/* Advance MITERATOR, and return the next symbol, or NULL if there are
no more symbols. Don't call this if you've previously received
NULL from mdict_iterator_first or mdict_iterator_next on this
iteration. */
extern struct symbol *mdict_iterator_next (struct mdict_iterator *miterator);
/* Initialize MITERATOR to point at the first symbol in MDICT whose
search_name () is NAME, as tested using COMPARE (which must use
the same conventions as strcmp_iw and be compatible with any
dictionary hashing function), and return that first symbol, or NULL
if there are no such symbols. */
extern struct symbol *
mdict_iter_match_first (const struct multidictionary *mdict,
const lookup_name_info &name,
struct mdict_iterator *miterator);
/* Advance MITERATOR to point at the next symbol in MDICT whose
search_name () is NAME, as tested using COMPARE (see
dict_iter_match_first), or NULL if there are no more such symbols.
Don't call this if you've previously received NULL from
mdict_iterator_match_first or mdict_iterator_match_next on this
iteration. And don't call it unless MITERATOR was created by a
previous call to mdict_iter_match_first with the same NAME and COMPARE. */
extern struct symbol *mdict_iter_match_next (const lookup_name_info &name,
struct mdict_iterator *miterator);
/* Return some notion of the size of the multidictionary: the number of
symbols if we have that, the number of hash buckets otherwise. */
extern int mdict_size (const struct multidictionary *mdict);
/* Macro to loop through all symbols in a dictionary DICT, in no
particular order. ITER is a struct dict_iterator (NOTE: __not__ a
struct dict_iterator *), and SYM points to the current symbol.
It's implemented as a single loop, so you can terminate the loop
early by a break if you desire. */
#define ALL_DICT_SYMBOLS(dict, iter, sym) \
for ((sym) = mdict_iterator_first ((dict), &(iter)); \
(sym); \
(sym) = mdict_iterator_next (&(iter)))
#endif /* DICTIONARY_H */
|
