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