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