Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Parser definitions for GDB. |
96cb11df | 2 | |
42a4f53d | 3 | Copyright (C) 1986-2019 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 | ||
0747795c | 26 | #include "common/vec.h" |
74e5a346 | 27 | #include "expression.h" |
d16aafd8 | 28 | |
fe898f56 | 29 | struct block; |
410a0ff2 SDJ |
30 | struct language_defn; |
31 | struct internalvar; | |
fe898f56 | 32 | |
92981e24 TT |
33 | extern int parser_debug; |
34 | ||
37eedb39 TT |
35 | /* A class that can be used to build a "struct expression". */ |
36 | ||
37 | struct expr_builder | |
410a0ff2 | 38 | { |
1201a264 TT |
39 | /* Constructor. LANG is the language used to parse the expression. |
40 | And GDBARCH is the gdbarch to use during parsing. */ | |
e9d9f57e | 41 | |
37eedb39 | 42 | expr_builder (const struct language_defn *lang, |
e9d9f57e TT |
43 | struct gdbarch *gdbarch); |
44 | ||
37eedb39 | 45 | DISABLE_COPY_AND_ASSIGN (expr_builder); |
410a0ff2 | 46 | |
e9d9f57e TT |
47 | /* Resize the allocated expression to the correct size, and return |
48 | it as an expression_up -- passing ownership to the caller. */ | |
41e3300a | 49 | ATTRIBUTE_UNUSED_RESULT expression_up release (); |
410a0ff2 | 50 | |
fa9f5be6 TT |
51 | /* Return the gdbarch that was passed to the constructor. */ |
52 | ||
53 | struct gdbarch *gdbarch () | |
54 | { | |
55 | return expout->gdbarch; | |
56 | } | |
57 | ||
73923d7e TT |
58 | /* Return the language that was passed to the constructor. */ |
59 | ||
60 | const struct language_defn *language () | |
61 | { | |
62 | return expout->language_defn; | |
63 | } | |
64 | ||
410a0ff2 SDJ |
65 | /* The size of the expression above. */ |
66 | ||
67 | size_t expout_size; | |
68 | ||
e9d9f57e TT |
69 | /* The expression related to this parser state. */ |
70 | ||
71 | expression_up expout; | |
72 | ||
410a0ff2 SDJ |
73 | /* The number of elements already in the expression. This is used |
74 | to know where to put new elements. */ | |
75 | ||
76 | size_t expout_ptr; | |
77 | }; | |
3e79cecf | 78 | |
37eedb39 TT |
79 | /* An instance of this type is instantiated during expression parsing, |
80 | and passed to the appropriate parser. It holds both inputs to the | |
81 | parser, and result. */ | |
82 | ||
83 | struct parser_state : public expr_builder | |
84 | { | |
85 | /* Constructor. LANG is the language used to parse the expression. | |
86 | And GDBARCH is the gdbarch to use during parsing. */ | |
87 | ||
88 | parser_state (const struct language_defn *lang, | |
1e58a4a4 TT |
89 | struct gdbarch *gdbarch, |
90 | const struct block *context_block, | |
8621b685 | 91 | CORE_ADDR context_pc, |
5776fca3 TT |
92 | int comma, |
93 | const char *input) | |
1e58a4a4 TT |
94 | : expr_builder (lang, gdbarch), |
95 | expression_context_block (context_block), | |
8621b685 | 96 | expression_context_pc (context_pc), |
5776fca3 TT |
97 | comma_terminates (comma), |
98 | lexptr (input) | |
37eedb39 TT |
99 | { |
100 | } | |
101 | ||
102 | DISABLE_COPY_AND_ASSIGN (parser_state); | |
37eedb39 | 103 | |
43476f0b TT |
104 | /* Begin counting arguments for a function call, |
105 | saving the data about any containing call. */ | |
106 | ||
107 | void start_arglist () | |
108 | { | |
109 | m_funcall_chain.push_back (arglist_len); | |
110 | arglist_len = 0; | |
111 | } | |
112 | ||
113 | /* Return the number of arguments in a function call just terminated, | |
114 | and restore the data for the containing function call. */ | |
115 | ||
116 | int end_arglist () | |
117 | { | |
118 | int val = arglist_len; | |
119 | arglist_len = m_funcall_chain.back (); | |
120 | m_funcall_chain.pop_back (); | |
121 | return val; | |
122 | } | |
123 | ||
124 | ||
1e58a4a4 TT |
125 | /* If this is nonzero, this block is used as the lexical context for |
126 | symbol names. */ | |
c906108c | 127 | |
1e58a4a4 | 128 | const struct block * const expression_context_block; |
c906108c | 129 | |
1e58a4a4 TT |
130 | /* If expression_context_block is non-zero, then this is the PC |
131 | within the block that we want to evaluate expressions at. When | |
132 | debugging C or C++ code, we use this to find the exact line we're | |
133 | at, and then look up the macro definitions active at that | |
134 | point. */ | |
135 | const CORE_ADDR expression_context_pc; | |
8621b685 TT |
136 | |
137 | /* Nonzero means stop parsing on first comma (if not within parentheses). */ | |
138 | ||
139 | int comma_terminates; | |
5776fca3 TT |
140 | |
141 | /* During parsing of a C expression, the pointer to the next character | |
142 | is in this variable. */ | |
143 | ||
144 | const char *lexptr; | |
145 | ||
146 | /* After a token has been recognized, this variable points to it. | |
147 | Currently used only for error reporting. */ | |
148 | const char *prev_lexptr = nullptr; | |
43476f0b TT |
149 | |
150 | /* Number of arguments seen so far in innermost function call. */ | |
151 | ||
152 | int arglist_len = 0; | |
153 | ||
154 | private: | |
155 | ||
156 | /* Data structure for saving values of arglist_len for function calls whose | |
157 | arguments contain other function calls. */ | |
158 | ||
159 | std::vector<int> m_funcall_chain; | |
1e58a4a4 | 160 | }; |
84f0252a | 161 | |
aee1fcdf AB |
162 | /* When parsing expressions we track the innermost block that was |
163 | referenced. */ | |
164 | ||
165 | class innermost_block_tracker | |
166 | { | |
167 | public: | |
168 | innermost_block_tracker () | |
ae451627 AB |
169 | : m_types (INNERMOST_BLOCK_FOR_SYMBOLS), |
170 | m_innermost_block (NULL) | |
aee1fcdf AB |
171 | { /* Nothing. */ } |
172 | ||
173 | /* Reset the currently stored innermost block. Usually called before | |
ae451627 AB |
174 | parsing a new expression. As the most common case is that we only |
175 | want to gather the innermost block for symbols in an expression, this | |
176 | becomes the default block tracker type. */ | |
177 | void reset (innermost_block_tracker_types t = INNERMOST_BLOCK_FOR_SYMBOLS) | |
aee1fcdf | 178 | { |
ae451627 AB |
179 | m_types = t; |
180 | m_innermost_block = NULL; | |
aee1fcdf AB |
181 | } |
182 | ||
183 | /* Update the stored innermost block if the new block B is more inner | |
ae451627 AB |
184 | than the currently stored block, or if no block is stored yet. The |
185 | type T tells us whether the block B was for a symbol or for a | |
186 | register. The stored innermost block is only updated if the type T is | |
187 | a type we are interested in, the types we are interested in are held | |
188 | in M_TYPES and set during RESET. */ | |
189 | void update (const struct block *b, innermost_block_tracker_types t); | |
aee1fcdf AB |
190 | |
191 | /* Overload of main UPDATE method which extracts the block from BS. */ | |
192 | void update (const struct block_symbol &bs) | |
193 | { | |
ae451627 | 194 | update (bs.block, INNERMOST_BLOCK_FOR_SYMBOLS); |
aee1fcdf AB |
195 | } |
196 | ||
197 | /* Return the stored innermost block. Can be nullptr if no symbols or | |
198 | registers were found during an expression parse, and so no innermost | |
199 | block was defined. */ | |
200 | const struct block *block () const | |
201 | { | |
202 | return m_innermost_block; | |
203 | } | |
204 | ||
205 | private: | |
ae451627 AB |
206 | /* The type of innermost block being looked for. */ |
207 | innermost_block_tracker_types m_types; | |
208 | ||
aee1fcdf AB |
209 | /* The currently stored innermost block found while parsing an |
210 | expression. */ | |
211 | const struct block *m_innermost_block; | |
212 | }; | |
213 | ||
ae451627 | 214 | /* The innermost context required by the stack and register variables |
7ad417dd TT |
215 | we've encountered so far. This is cleared by the expression |
216 | parsing functions before parsing an expression, and can queried | |
217 | once the parse is complete. */ | |
aee1fcdf | 218 | extern innermost_block_tracker innermost_block; |
c906108c | 219 | |
c906108c | 220 | /* A string token, either a char-string or bit-string. Char-strings are |
0df8b418 | 221 | used, for example, for the names of symbols. */ |
c906108c SS |
222 | |
223 | struct stoken | |
224 | { | |
0df8b418 | 225 | /* Pointer to first byte of char-string or first bit of bit-string. */ |
d7561cbb | 226 | const char *ptr; |
0df8b418 | 227 | /* Length of string in bytes for char-string or bits for bit-string. */ |
c906108c SS |
228 | int length; |
229 | }; | |
230 | ||
6c7a06a3 TT |
231 | struct typed_stoken |
232 | { | |
233 | /* A language-specific type field. */ | |
234 | int type; | |
0df8b418 | 235 | /* Pointer to first byte of char-string or first bit of bit-string. */ |
6c7a06a3 | 236 | char *ptr; |
0df8b418 | 237 | /* Length of string in bytes for char-string or bits for bit-string. */ |
6c7a06a3 TT |
238 | int length; |
239 | }; | |
240 | ||
241 | struct stoken_vector | |
242 | { | |
243 | int len; | |
244 | struct typed_stoken *tokens; | |
245 | }; | |
246 | ||
c906108c SS |
247 | struct ttype |
248 | { | |
249 | struct stoken stoken; | |
250 | struct type *type; | |
251 | }; | |
252 | ||
253 | struct symtoken | |
254 | { | |
255 | struct stoken stoken; | |
d12307c1 | 256 | struct block_symbol sym; |
c906108c SS |
257 | int is_a_field_of_this; |
258 | }; | |
259 | ||
379b85df AF |
260 | struct objc_class_str |
261 | { | |
262 | struct stoken stoken; | |
263 | struct type *type; | |
fe978cb0 | 264 | int theclass; |
379b85df AF |
265 | }; |
266 | ||
c906108c SS |
267 | /* For parsing of complicated types. |
268 | An array should be preceded in the list by the size of the array. */ | |
269 | enum type_pieces | |
c5aa993b | 270 | { |
2e2394a0 MS |
271 | tp_end = -1, |
272 | tp_pointer, | |
273 | tp_reference, | |
53cc15f5 | 274 | tp_rvalue_reference, |
2e2394a0 | 275 | tp_array, |
71918a86 TT |
276 | tp_function, |
277 | tp_function_with_arguments, | |
2e2394a0 | 278 | tp_const, |
47663de5 | 279 | tp_volatile, |
fcde5961 | 280 | tp_space_identifier, |
4d00f5d8 AB |
281 | tp_type_stack, |
282 | tp_kind | |
c5aa993b | 283 | }; |
c906108c | 284 | /* The stack can contain either an enum type_pieces or an int. */ |
c5aa993b JM |
285 | union type_stack_elt |
286 | { | |
287 | enum type_pieces piece; | |
288 | int int_val; | |
fcde5961 | 289 | struct type_stack *stack_val; |
02e12e38 | 290 | std::vector<struct type *> *typelist_val; |
c5aa993b | 291 | }; |
1a7d0ce4 TT |
292 | |
293 | /* The type stack is an instance of this structure. */ | |
294 | ||
295 | struct type_stack | |
296 | { | |
297 | /* Elements on the stack. */ | |
858d8004 | 298 | std::vector<union type_stack_elt> elements; |
1a7d0ce4 | 299 | }; |
c906108c | 300 | |
55aa24fb SDJ |
301 | /* Reverse an expression from suffix form (in which it is constructed) |
302 | to prefix form (in which we can conveniently print or execute it). | |
303 | Ordinarily this always returns -1. However, if EXPOUT_LAST_STRUCT | |
304 | is not -1 (i.e., we are trying to complete a field name), it will | |
305 | return the index of the subexpression which is the left-hand-side | |
306 | of the struct operation at EXPOUT_LAST_STRUCT. */ | |
307 | ||
308 | extern int prefixify_expression (struct expression *expr); | |
309 | ||
37eedb39 | 310 | extern void write_exp_elt_opcode (struct expr_builder *, enum exp_opcode); |
c906108c | 311 | |
37eedb39 | 312 | extern void write_exp_elt_sym (struct expr_builder *, struct symbol *); |
c906108c | 313 | |
37eedb39 | 314 | extern void write_exp_elt_longcst (struct expr_builder *, LONGEST); |
c906108c | 315 | |
37eedb39 | 316 | extern void write_exp_elt_floatcst (struct expr_builder *, const gdb_byte *); |
27bc4d80 | 317 | |
37eedb39 | 318 | extern void write_exp_elt_type (struct expr_builder *, struct type *); |
c906108c | 319 | |
37eedb39 | 320 | extern void write_exp_elt_intern (struct expr_builder *, struct internalvar *); |
c906108c | 321 | |
37eedb39 | 322 | extern void write_exp_string (struct expr_builder *, struct stoken); |
c906108c | 323 | |
37eedb39 | 324 | void write_exp_string_vector (struct expr_builder *, int type, |
410a0ff2 | 325 | struct stoken_vector *vec); |
6c7a06a3 | 326 | |
37eedb39 | 327 | extern void write_exp_bitstring (struct expr_builder *, struct stoken); |
c906108c | 328 | |
37eedb39 | 329 | extern void write_exp_elt_block (struct expr_builder *, const struct block *); |
c906108c | 330 | |
37eedb39 | 331 | extern void write_exp_elt_objfile (struct expr_builder *, |
410a0ff2 | 332 | struct objfile *objfile); |
9e35dae4 | 333 | |
37eedb39 | 334 | extern void write_exp_msymbol (struct expr_builder *, |
410a0ff2 | 335 | struct bound_minimal_symbol); |
c906108c | 336 | |
1e58a4a4 | 337 | extern void write_dollar_variable (struct parser_state *, struct stoken str); |
c906108c | 338 | |
37eedb39 | 339 | extern void mark_struct_expression (struct expr_builder *); |
65d12d83 | 340 | |
d7561cbb | 341 | extern const char *find_template_name_end (const char *); |
c906108c | 342 | |
a14ed312 | 343 | extern char *copy_name (struct stoken); |
c906108c | 344 | |
95c391b6 TT |
345 | extern void insert_type (enum type_pieces); |
346 | ||
a14ed312 | 347 | extern void push_type (enum type_pieces); |
c906108c | 348 | |
a14ed312 | 349 | extern void push_type_int (int); |
c906108c | 350 | |
37eedb39 | 351 | extern void insert_type_address_space (struct expr_builder *, char *); |
47663de5 | 352 | |
a14ed312 | 353 | extern enum type_pieces pop_type (void); |
c906108c | 354 | |
a14ed312 | 355 | extern int pop_type_int (void); |
c906108c | 356 | |
fcde5961 TT |
357 | extern struct type_stack *get_type_stack (void); |
358 | ||
359 | extern struct type_stack *append_type_stack (struct type_stack *to, | |
360 | struct type_stack *from); | |
361 | ||
362 | extern void push_type_stack (struct type_stack *stack); | |
363 | ||
02e12e38 | 364 | extern void push_typelist (std::vector<struct type *> *typelist); |
71918a86 | 365 | |
5f9769d1 PH |
366 | extern int dump_subexp (struct expression *, struct ui_file *, int); |
367 | ||
368 | extern int dump_subexp_body_standard (struct expression *, | |
369 | struct ui_file *, int); | |
370 | ||
554794dc | 371 | extern void operator_length (const struct expression *, int, int *, int *); |
24daaebc | 372 | |
554794dc SDJ |
373 | extern void operator_length_standard (const struct expression *, int, int *, |
374 | int *); | |
5f9769d1 | 375 | |
c0201579 JK |
376 | extern int operator_check_standard (struct expression *exp, int pos, |
377 | int (*objfile_func) | |
378 | (struct objfile *objfile, void *data), | |
379 | void *data); | |
380 | ||
a121b7c1 | 381 | extern const char *op_name_standard (enum exp_opcode); |
5f9769d1 | 382 | |
a14ed312 | 383 | extern struct type *follow_types (struct type *); |
c906108c | 384 | |
3693fdb3 PA |
385 | extern type_instance_flags follow_type_instance_flags (); |
386 | ||
e9d9f57e | 387 | extern void null_post_parser (expression_up *, int); |
e85c3284 | 388 | |
edd079d9 UW |
389 | extern bool parse_float (const char *p, int len, |
390 | const struct type *type, gdb_byte *data); | |
c906108c SS |
391 | \f |
392 | /* These codes indicate operator precedences for expression printing, | |
393 | least tightly binding first. */ | |
394 | /* Adding 1 to a precedence value is done for binary operators, | |
395 | on the operand which is more tightly bound, so that operators | |
396 | of equal precedence within that operand will get parentheses. */ | |
397 | /* PREC_HYPER and PREC_ABOVE_COMMA are not the precedence of any operator; | |
398 | they are used as the "surrounding precedence" to force | |
399 | various kinds of things to be parenthesized. */ | |
400 | enum precedence | |
c5aa993b JM |
401 | { |
402 | PREC_NULL, PREC_COMMA, PREC_ABOVE_COMMA, PREC_ASSIGN, PREC_LOGICAL_OR, | |
403 | PREC_LOGICAL_AND, PREC_BITWISE_IOR, PREC_BITWISE_AND, PREC_BITWISE_XOR, | |
404 | PREC_EQUAL, PREC_ORDER, PREC_SHIFT, PREC_ADD, PREC_MUL, PREC_REPEAT, | |
405 | PREC_HYPER, PREC_PREFIX, PREC_SUFFIX, PREC_BUILTIN_FUNCTION | |
406 | }; | |
c906108c SS |
407 | |
408 | /* Table mapping opcodes into strings for printing operators | |
409 | and precedences of the operators. */ | |
410 | ||
411 | struct op_print | |
c5aa993b | 412 | { |
a121b7c1 | 413 | const char *string; |
c5aa993b JM |
414 | enum exp_opcode opcode; |
415 | /* Precedence of operator. These values are used only by comparisons. */ | |
416 | enum precedence precedence; | |
417 | ||
418 | /* For a binary operator: 1 iff right associate. | |
0df8b418 | 419 | For a unary operator: 1 iff postfix. */ |
c5aa993b JM |
420 | int right_assoc; |
421 | }; | |
c906108c | 422 | |
5f9769d1 PH |
423 | /* Information needed to print, prefixify, and evaluate expressions for |
424 | a given language. */ | |
425 | ||
426 | struct exp_descriptor | |
427 | { | |
428 | /* Print subexpression. */ | |
429 | void (*print_subexp) (struct expression *, int *, struct ui_file *, | |
430 | enum precedence); | |
431 | ||
432 | /* Returns number of exp_elements needed to represent an operator and | |
433 | the number of subexpressions it takes. */ | |
554794dc | 434 | void (*operator_length) (const struct expression*, int, int*, int *); |
5f9769d1 | 435 | |
a1c7835a YQ |
436 | /* Call OBJFILE_FUNC for any objfile found being referenced by the |
437 | single operator of EXP at position POS. Operator parameters are | |
438 | located at positive (POS + number) offsets in EXP. OBJFILE_FUNC | |
439 | should never be called with NULL OBJFILE. OBJFILE_FUNC should | |
440 | get passed an arbitrary caller supplied DATA pointer. If it | |
441 | returns non-zero value then (any other) non-zero value should be | |
442 | immediately returned to the caller. Otherwise zero should be | |
443 | returned. */ | |
c0201579 JK |
444 | int (*operator_check) (struct expression *exp, int pos, |
445 | int (*objfile_func) (struct objfile *objfile, | |
446 | void *data), | |
447 | void *data); | |
448 | ||
a5b12627 JB |
449 | /* Name of this operator for dumping purposes. |
450 | The returned value should never be NULL, even if EXP_OPCODE is | |
451 | an unknown opcode (a string containing an image of the numeric | |
452 | value of the opcode can be returned, for instance). */ | |
a121b7c1 | 453 | const char *(*op_name) (enum exp_opcode); |
5f9769d1 PH |
454 | |
455 | /* Dump the rest of this (prefix) expression after the operator | |
456 | itself has been printed. See dump_subexp_body_standard in | |
457 | (expprint.c). */ | |
458 | int (*dump_subexp_body) (struct expression *, struct ui_file *, int); | |
459 | ||
460 | /* Evaluate an expression. */ | |
461 | struct value *(*evaluate_exp) (struct type *, struct expression *, | |
462 | int *, enum noside); | |
463 | }; | |
464 | ||
465 | ||
466 | /* Default descriptor containing standard definitions of all | |
467 | elements. */ | |
468 | extern const struct exp_descriptor exp_descriptor_standard; | |
469 | ||
470 | /* Functions used by language-specific extended operators to (recursively) | |
471 | print/dump subexpressions. */ | |
472 | ||
473 | extern void print_subexp (struct expression *, int *, struct ui_file *, | |
474 | enum precedence); | |
475 | ||
476 | extern void print_subexp_standard (struct expression *, int *, | |
477 | struct ui_file *, enum precedence); | |
478 | ||
f461f5cf PM |
479 | /* Function used to avoid direct calls to fprintf |
480 | in the code generated by the bison parser. */ | |
481 | ||
a0b31db1 | 482 | extern void parser_fprintf (FILE *, const char *, ...) ATTRIBUTE_PRINTF (2, 3); |
f461f5cf | 483 | |
c0201579 JK |
484 | extern int exp_uses_objfile (struct expression *exp, struct objfile *objfile); |
485 | ||
2f68a895 TT |
486 | extern void mark_completion_tag (enum type_code, const char *ptr, |
487 | int length); | |
488 | ||
c5aa993b | 489 | #endif /* PARSER_DEFS_H */ |
2f68a895 | 490 |