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