Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Parser definitions for GDB. |
96cb11df | 2 | |
61baf725 | 3 | Copyright (C) 1986-2017 Free Software Foundation, Inc. |
96cb11df | 4 | |
c906108c SS |
5 | Modified from expread.y by the Department of Computer Science at the |
6 | State University of New York at Buffalo. | |
7 | ||
c5aa993b | 8 | This file is part of GDB. |
c906108c | 9 | |
c5aa993b JM |
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 | |
a9762ec7 | 12 | the Free Software Foundation; either version 3 of the License, or |
c5aa993b | 13 | (at your option) any later version. |
c906108c | 14 | |
c5aa993b JM |
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. | |
c906108c | 19 | |
c5aa993b | 20 | You should have received a copy of the GNU General Public License |
a9762ec7 | 21 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c SS |
22 | |
23 | #if !defined (PARSER_DEFS_H) | |
24 | #define PARSER_DEFS_H 1 | |
25 | ||
d16aafd8 | 26 | #include "doublest.h" |
71918a86 | 27 | #include "vec.h" |
74e5a346 | 28 | #include "expression.h" |
d16aafd8 | 29 | |
fe898f56 | 30 | struct block; |
410a0ff2 SDJ |
31 | struct language_defn; |
32 | struct internalvar; | |
fe898f56 | 33 | |
92981e24 TT |
34 | extern int parser_debug; |
35 | ||
410a0ff2 SDJ |
36 | #define parse_gdbarch(ps) ((ps)->expout->gdbarch) |
37 | #define parse_language(ps) ((ps)->expout->language_defn) | |
c906108c | 38 | |
410a0ff2 SDJ |
39 | struct parser_state |
40 | { | |
41 | /* The expression related to this parser state. */ | |
42 | ||
43 | struct expression *expout; | |
44 | ||
45 | /* The size of the expression above. */ | |
46 | ||
47 | size_t expout_size; | |
48 | ||
49 | /* The number of elements already in the expression. This is used | |
50 | to know where to put new elements. */ | |
51 | ||
52 | size_t expout_ptr; | |
53 | }; | |
3e79cecf | 54 | |
c906108c SS |
55 | /* If this is nonzero, this block is used as the lexical context |
56 | for symbol names. */ | |
57 | ||
270140bd | 58 | extern const struct block *expression_context_block; |
c906108c | 59 | |
84f0252a JB |
60 | /* If expression_context_block is non-zero, then this is the PC within |
61 | the block that we want to evaluate expressions at. When debugging | |
62 | C or C++ code, we use this to find the exact line we're at, and | |
63 | then look up the macro definitions active at that point. */ | |
f7321c06 | 64 | extern CORE_ADDR expression_context_pc; |
84f0252a | 65 | |
c906108c | 66 | /* The innermost context required by the stack and register variables |
0df8b418 | 67 | we've encountered so far. */ |
270140bd | 68 | extern const struct block *innermost_block; |
c906108c | 69 | |
c906108c SS |
70 | /* Number of arguments seen so far in innermost function call. */ |
71 | extern int arglist_len; | |
72 | ||
73 | /* A string token, either a char-string or bit-string. Char-strings are | |
0df8b418 | 74 | used, for example, for the names of symbols. */ |
c906108c SS |
75 | |
76 | struct stoken | |
77 | { | |
0df8b418 | 78 | /* Pointer to first byte of char-string or first bit of bit-string. */ |
d7561cbb | 79 | const char *ptr; |
0df8b418 | 80 | /* Length of string in bytes for char-string or bits for bit-string. */ |
c906108c SS |
81 | int length; |
82 | }; | |
83 | ||
6c7a06a3 TT |
84 | struct typed_stoken |
85 | { | |
86 | /* A language-specific type field. */ | |
87 | int type; | |
0df8b418 | 88 | /* Pointer to first byte of char-string or first bit of bit-string. */ |
6c7a06a3 | 89 | char *ptr; |
0df8b418 | 90 | /* Length of string in bytes for char-string or bits for bit-string. */ |
6c7a06a3 TT |
91 | int length; |
92 | }; | |
93 | ||
94 | struct stoken_vector | |
95 | { | |
96 | int len; | |
97 | struct typed_stoken *tokens; | |
98 | }; | |
99 | ||
c906108c SS |
100 | struct ttype |
101 | { | |
102 | struct stoken stoken; | |
103 | struct type *type; | |
104 | }; | |
105 | ||
106 | struct symtoken | |
107 | { | |
108 | struct stoken stoken; | |
d12307c1 | 109 | struct block_symbol sym; |
c906108c SS |
110 | int is_a_field_of_this; |
111 | }; | |
112 | ||
379b85df AF |
113 | struct objc_class_str |
114 | { | |
115 | struct stoken stoken; | |
116 | struct type *type; | |
fe978cb0 | 117 | int theclass; |
379b85df AF |
118 | }; |
119 | ||
71918a86 TT |
120 | typedef struct type *type_ptr; |
121 | DEF_VEC_P (type_ptr); | |
379b85df | 122 | |
c906108c SS |
123 | /* For parsing of complicated types. |
124 | An array should be preceded in the list by the size of the array. */ | |
125 | enum type_pieces | |
c5aa993b | 126 | { |
2e2394a0 MS |
127 | tp_end = -1, |
128 | tp_pointer, | |
129 | tp_reference, | |
130 | tp_array, | |
71918a86 TT |
131 | tp_function, |
132 | tp_function_with_arguments, | |
2e2394a0 | 133 | tp_const, |
47663de5 | 134 | tp_volatile, |
fcde5961 TT |
135 | tp_space_identifier, |
136 | tp_type_stack | |
c5aa993b | 137 | }; |
c906108c | 138 | /* The stack can contain either an enum type_pieces or an int. */ |
c5aa993b JM |
139 | union type_stack_elt |
140 | { | |
141 | enum type_pieces piece; | |
142 | int int_val; | |
fcde5961 | 143 | struct type_stack *stack_val; |
71918a86 | 144 | VEC (type_ptr) *typelist_val; |
c5aa993b | 145 | }; |
1a7d0ce4 TT |
146 | |
147 | /* The type stack is an instance of this structure. */ | |
148 | ||
149 | struct type_stack | |
150 | { | |
151 | /* Elements on the stack. */ | |
152 | union type_stack_elt *elements; | |
153 | /* Current stack depth. */ | |
154 | int depth; | |
155 | /* Allocated size of stack. */ | |
156 | int size; | |
157 | }; | |
c906108c | 158 | |
55aa24fb | 159 | /* Helper function to initialize the expout, expout_size, expout_ptr |
410a0ff2 SDJ |
160 | trio inside PS before it is used to store expression elements created |
161 | during the parsing of an expression. INITIAL_SIZE is the initial size of | |
55aa24fb SDJ |
162 | the expout array. LANG is the language used to parse the expression. |
163 | And GDBARCH is the gdbarch to use during parsing. */ | |
164 | ||
410a0ff2 SDJ |
165 | extern void initialize_expout (struct parser_state *ps, |
166 | size_t initial_size, | |
167 | const struct language_defn *lang, | |
168 | struct gdbarch *gdbarch); | |
55aa24fb | 169 | |
410a0ff2 SDJ |
170 | /* Helper function that reallocates the EXPOUT inside PS in order to |
171 | eliminate any unused space. It is generally used when the expression | |
172 | has just been parsed and created. */ | |
55aa24fb | 173 | |
410a0ff2 | 174 | extern void reallocate_expout (struct parser_state *ps); |
55aa24fb SDJ |
175 | |
176 | /* Reverse an expression from suffix form (in which it is constructed) | |
177 | to prefix form (in which we can conveniently print or execute it). | |
178 | Ordinarily this always returns -1. However, if EXPOUT_LAST_STRUCT | |
179 | is not -1 (i.e., we are trying to complete a field name), it will | |
180 | return the index of the subexpression which is the left-hand-side | |
181 | of the struct operation at EXPOUT_LAST_STRUCT. */ | |
182 | ||
183 | extern int prefixify_expression (struct expression *expr); | |
184 | ||
410a0ff2 | 185 | extern void write_exp_elt_opcode (struct parser_state *, enum exp_opcode); |
c906108c | 186 | |
410a0ff2 | 187 | extern void write_exp_elt_sym (struct parser_state *, struct symbol *); |
c906108c | 188 | |
410a0ff2 | 189 | extern void write_exp_elt_longcst (struct parser_state *, LONGEST); |
c906108c | 190 | |
410a0ff2 | 191 | extern void write_exp_elt_dblcst (struct parser_state *, DOUBLEST); |
c906108c | 192 | |
410a0ff2 | 193 | extern void write_exp_elt_decfloatcst (struct parser_state *, gdb_byte *); |
27bc4d80 | 194 | |
410a0ff2 | 195 | extern void write_exp_elt_type (struct parser_state *, struct type *); |
c906108c | 196 | |
410a0ff2 | 197 | extern void write_exp_elt_intern (struct parser_state *, struct internalvar *); |
c906108c | 198 | |
410a0ff2 | 199 | extern void write_exp_string (struct parser_state *, struct stoken); |
c906108c | 200 | |
410a0ff2 SDJ |
201 | void write_exp_string_vector (struct parser_state *, int type, |
202 | struct stoken_vector *vec); | |
6c7a06a3 | 203 | |
410a0ff2 | 204 | extern void write_exp_bitstring (struct parser_state *, struct stoken); |
c906108c | 205 | |
410a0ff2 | 206 | extern void write_exp_elt_block (struct parser_state *, const struct block *); |
c906108c | 207 | |
410a0ff2 SDJ |
208 | extern void write_exp_elt_objfile (struct parser_state *, |
209 | struct objfile *objfile); | |
9e35dae4 | 210 | |
410a0ff2 SDJ |
211 | extern void write_exp_msymbol (struct parser_state *, |
212 | struct bound_minimal_symbol); | |
c906108c | 213 | |
410a0ff2 | 214 | extern void write_dollar_variable (struct parser_state *, struct stoken str); |
c906108c | 215 | |
410a0ff2 | 216 | extern void mark_struct_expression (struct parser_state *); |
65d12d83 | 217 | |
d7561cbb | 218 | extern const char *find_template_name_end (const char *); |
c906108c | 219 | |
a14ed312 | 220 | extern void start_arglist (void); |
c906108c | 221 | |
a14ed312 | 222 | extern int end_arglist (void); |
c906108c | 223 | |
a14ed312 | 224 | extern char *copy_name (struct stoken); |
c906108c | 225 | |
95c391b6 TT |
226 | extern void insert_type (enum type_pieces); |
227 | ||
a14ed312 | 228 | extern void push_type (enum type_pieces); |
c906108c | 229 | |
a14ed312 | 230 | extern void push_type_int (int); |
c906108c | 231 | |
410a0ff2 | 232 | extern void insert_type_address_space (struct parser_state *, char *); |
47663de5 | 233 | |
a14ed312 | 234 | extern enum type_pieces pop_type (void); |
c906108c | 235 | |
a14ed312 | 236 | extern int pop_type_int (void); |
c906108c | 237 | |
fcde5961 TT |
238 | extern struct type_stack *get_type_stack (void); |
239 | ||
240 | extern struct type_stack *append_type_stack (struct type_stack *to, | |
241 | struct type_stack *from); | |
242 | ||
243 | extern void push_type_stack (struct type_stack *stack); | |
244 | ||
245 | extern void type_stack_cleanup (void *arg); | |
246 | ||
71918a86 TT |
247 | extern void push_typelist (VEC (type_ptr) *typelist); |
248 | ||
a14ed312 | 249 | extern int length_of_subexp (struct expression *, int); |
c906108c | 250 | |
5f9769d1 PH |
251 | extern int dump_subexp (struct expression *, struct ui_file *, int); |
252 | ||
253 | extern int dump_subexp_body_standard (struct expression *, | |
254 | struct ui_file *, int); | |
255 | ||
554794dc | 256 | extern void operator_length (const struct expression *, int, int *, int *); |
24daaebc | 257 | |
554794dc SDJ |
258 | extern void operator_length_standard (const struct expression *, int, int *, |
259 | int *); | |
5f9769d1 | 260 | |
c0201579 JK |
261 | extern int operator_check_standard (struct expression *exp, int pos, |
262 | int (*objfile_func) | |
263 | (struct objfile *objfile, void *data), | |
264 | void *data); | |
265 | ||
5f9769d1 PH |
266 | extern char *op_name_standard (enum exp_opcode); |
267 | ||
a14ed312 | 268 | extern struct type *follow_types (struct type *); |
c906108c | 269 | |
e85c3284 PH |
270 | extern void null_post_parser (struct expression **, int); |
271 | ||
d30f5e1f DE |
272 | extern int parse_float (const char *p, int len, DOUBLEST *d, |
273 | const char **suffix); | |
274 | ||
275 | extern int parse_c_float (struct gdbarch *gdbarch, const char *p, int len, | |
276 | DOUBLEST *d, struct type **t); | |
277 | ||
c906108c SS |
278 | /* During parsing of a C expression, the pointer to the next character |
279 | is in this variable. */ | |
280 | ||
d7561cbb | 281 | extern const char *lexptr; |
c906108c | 282 | |
0df8b418 | 283 | /* After a token has been recognized, this variable points to it. |
665132f9 | 284 | Currently used only for error reporting. */ |
d7561cbb | 285 | extern const char *prev_lexptr; |
665132f9 | 286 | |
c906108c SS |
287 | /* Current depth in parentheses within the expression. */ |
288 | ||
289 | extern int paren_depth; | |
290 | ||
291 | /* Nonzero means stop parsing on first comma (if not within parentheses). */ | |
292 | ||
293 | extern int comma_terminates; | |
294 | \f | |
295 | /* These codes indicate operator precedences for expression printing, | |
296 | least tightly binding first. */ | |
297 | /* Adding 1 to a precedence value is done for binary operators, | |
298 | on the operand which is more tightly bound, so that operators | |
299 | of equal precedence within that operand will get parentheses. */ | |
300 | /* PREC_HYPER and PREC_ABOVE_COMMA are not the precedence of any operator; | |
301 | they are used as the "surrounding precedence" to force | |
302 | various kinds of things to be parenthesized. */ | |
303 | enum precedence | |
c5aa993b JM |
304 | { |
305 | PREC_NULL, PREC_COMMA, PREC_ABOVE_COMMA, PREC_ASSIGN, PREC_LOGICAL_OR, | |
306 | PREC_LOGICAL_AND, PREC_BITWISE_IOR, PREC_BITWISE_AND, PREC_BITWISE_XOR, | |
307 | PREC_EQUAL, PREC_ORDER, PREC_SHIFT, PREC_ADD, PREC_MUL, PREC_REPEAT, | |
308 | PREC_HYPER, PREC_PREFIX, PREC_SUFFIX, PREC_BUILTIN_FUNCTION | |
309 | }; | |
c906108c SS |
310 | |
311 | /* Table mapping opcodes into strings for printing operators | |
312 | and precedences of the operators. */ | |
313 | ||
314 | struct op_print | |
c5aa993b JM |
315 | { |
316 | char *string; | |
317 | enum exp_opcode opcode; | |
318 | /* Precedence of operator. These values are used only by comparisons. */ | |
319 | enum precedence precedence; | |
320 | ||
321 | /* For a binary operator: 1 iff right associate. | |
0df8b418 | 322 | For a unary operator: 1 iff postfix. */ |
c5aa993b JM |
323 | int right_assoc; |
324 | }; | |
c906108c | 325 | |
5f9769d1 PH |
326 | /* Information needed to print, prefixify, and evaluate expressions for |
327 | a given language. */ | |
328 | ||
329 | struct exp_descriptor | |
330 | { | |
331 | /* Print subexpression. */ | |
332 | void (*print_subexp) (struct expression *, int *, struct ui_file *, | |
333 | enum precedence); | |
334 | ||
335 | /* Returns number of exp_elements needed to represent an operator and | |
336 | the number of subexpressions it takes. */ | |
554794dc | 337 | void (*operator_length) (const struct expression*, int, int*, int *); |
5f9769d1 | 338 | |
a1c7835a YQ |
339 | /* Call OBJFILE_FUNC for any objfile found being referenced by the |
340 | single operator of EXP at position POS. Operator parameters are | |
341 | located at positive (POS + number) offsets in EXP. OBJFILE_FUNC | |
342 | should never be called with NULL OBJFILE. OBJFILE_FUNC should | |
343 | get passed an arbitrary caller supplied DATA pointer. If it | |
344 | returns non-zero value then (any other) non-zero value should be | |
345 | immediately returned to the caller. Otherwise zero should be | |
346 | returned. */ | |
c0201579 JK |
347 | int (*operator_check) (struct expression *exp, int pos, |
348 | int (*objfile_func) (struct objfile *objfile, | |
349 | void *data), | |
350 | void *data); | |
351 | ||
a5b12627 JB |
352 | /* Name of this operator for dumping purposes. |
353 | The returned value should never be NULL, even if EXP_OPCODE is | |
354 | an unknown opcode (a string containing an image of the numeric | |
355 | value of the opcode can be returned, for instance). */ | |
5f9769d1 PH |
356 | char *(*op_name) (enum exp_opcode); |
357 | ||
358 | /* Dump the rest of this (prefix) expression after the operator | |
359 | itself has been printed. See dump_subexp_body_standard in | |
360 | (expprint.c). */ | |
361 | int (*dump_subexp_body) (struct expression *, struct ui_file *, int); | |
362 | ||
363 | /* Evaluate an expression. */ | |
364 | struct value *(*evaluate_exp) (struct type *, struct expression *, | |
365 | int *, enum noside); | |
366 | }; | |
367 | ||
368 | ||
369 | /* Default descriptor containing standard definitions of all | |
370 | elements. */ | |
371 | extern const struct exp_descriptor exp_descriptor_standard; | |
372 | ||
373 | /* Functions used by language-specific extended operators to (recursively) | |
374 | print/dump subexpressions. */ | |
375 | ||
376 | extern void print_subexp (struct expression *, int *, struct ui_file *, | |
377 | enum precedence); | |
378 | ||
379 | extern void print_subexp_standard (struct expression *, int *, | |
380 | struct ui_file *, enum precedence); | |
381 | ||
f461f5cf PM |
382 | /* Function used to avoid direct calls to fprintf |
383 | in the code generated by the bison parser. */ | |
384 | ||
a0b31db1 | 385 | extern void parser_fprintf (FILE *, const char *, ...) ATTRIBUTE_PRINTF (2, 3); |
f461f5cf | 386 | |
c0201579 JK |
387 | extern int exp_uses_objfile (struct expression *exp, struct objfile *objfile); |
388 | ||
2f68a895 TT |
389 | extern void mark_completion_tag (enum type_code, const char *ptr, |
390 | int length); | |
391 | ||
410a0ff2 SDJ |
392 | /* Reallocate the `expout' pointer inside PS so that it can accommodate |
393 | at least LENELT expression elements. This function does nothing if | |
394 | there is enough room for the elements. */ | |
395 | ||
396 | extern void increase_expout_size (struct parser_state *ps, size_t lenelt); | |
397 | ||
c5aa993b | 398 | #endif /* PARSER_DEFS_H */ |
2f68a895 | 399 |