1 /* Parser definitions for GDB.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
5 Modified from expread.y by the Department of Computer Science at the
6 State University of New York at Buffalo.
8 This file is part of GDB.
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
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
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.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #if !defined (PARSER_DEFS_H)
24 #define PARSER_DEFS_H 1
26 #include "common/vec.h"
27 #include "expression.h"
33 extern int parser_debug
;
35 /* A class that can be used to build a "struct expression". */
39 /* Constructor. LANG is the language used to parse the expression.
40 And GDBARCH is the gdbarch to use during parsing. */
42 expr_builder (const struct language_defn
*lang
,
43 struct gdbarch
*gdbarch
);
45 DISABLE_COPY_AND_ASSIGN (expr_builder
);
47 /* Resize the allocated expression to the correct size, and return
48 it as an expression_up -- passing ownership to the caller. */
49 ATTRIBUTE_UNUSED_RESULT expression_up
release ();
51 /* Return the gdbarch that was passed to the constructor. */
53 struct gdbarch
*gdbarch ()
55 return expout
->gdbarch
;
58 /* Return the language that was passed to the constructor. */
60 const struct language_defn
*language ()
62 return expout
->language_defn
;
65 /* The size of the expression above. */
69 /* The expression related to this parser state. */
73 /* The number of elements already in the expression. This is used
74 to know where to put new elements. */
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. */
83 struct parser_state
: public expr_builder
85 /* Constructor. LANG is the language used to parse the expression.
86 And GDBARCH is the gdbarch to use during parsing. */
88 parser_state (const struct language_defn
*lang
,
89 struct gdbarch
*gdbarch
,
90 const struct block
*context_block
,
94 : expr_builder (lang
, gdbarch
),
95 expression_context_block (context_block
),
96 expression_context_pc (context_pc
),
97 comma_terminates (comma
),
102 DISABLE_COPY_AND_ASSIGN (parser_state
);
104 /* Begin counting arguments for a function call,
105 saving the data about any containing call. */
107 void start_arglist ()
109 m_funcall_chain
.push_back (arglist_len
);
113 /* Return the number of arguments in a function call just terminated,
114 and restore the data for the containing function call. */
118 int val
= arglist_len
;
119 arglist_len
= m_funcall_chain
.back ();
120 m_funcall_chain
.pop_back ();
125 /* If this is nonzero, this block is used as the lexical context for
128 const struct block
* const expression_context_block
;
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
135 const CORE_ADDR expression_context_pc
;
137 /* Nonzero means stop parsing on first comma (if not within parentheses). */
139 int comma_terminates
;
141 /* During parsing of a C expression, the pointer to the next character
142 is in this variable. */
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;
150 /* Number of arguments seen so far in innermost function call. */
156 /* Data structure for saving values of arglist_len for function calls whose
157 arguments contain other function calls. */
159 std::vector
<int> m_funcall_chain
;
162 /* When parsing expressions we track the innermost block that was
165 class innermost_block_tracker
168 innermost_block_tracker ()
169 : m_types (INNERMOST_BLOCK_FOR_SYMBOLS
),
170 m_innermost_block (NULL
)
173 /* Reset the currently stored innermost block. Usually called before
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
)
180 m_innermost_block
= NULL
;
183 /* Update the stored innermost block if the new block B is more inner
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
);
191 /* Overload of main UPDATE method which extracts the block from BS. */
192 void update (const struct block_symbol
&bs
)
194 update (bs
.block
, INNERMOST_BLOCK_FOR_SYMBOLS
);
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
202 return m_innermost_block
;
206 /* The type of innermost block being looked for. */
207 innermost_block_tracker_types m_types
;
209 /* The currently stored innermost block found while parsing an
211 const struct block
*m_innermost_block
;
214 /* The innermost context required by the stack and register variables
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. */
218 extern innermost_block_tracker innermost_block
;
220 /* A string token, either a char-string or bit-string. Char-strings are
221 used, for example, for the names of symbols. */
225 /* Pointer to first byte of char-string or first bit of bit-string. */
227 /* Length of string in bytes for char-string or bits for bit-string. */
233 /* A language-specific type field. */
235 /* Pointer to first byte of char-string or first bit of bit-string. */
237 /* Length of string in bytes for char-string or bits for bit-string. */
244 struct typed_stoken
*tokens
;
249 struct stoken stoken
;
255 struct stoken stoken
;
256 struct block_symbol sym
;
257 int is_a_field_of_this
;
260 struct objc_class_str
262 struct stoken stoken
;
267 /* For parsing of complicated types.
268 An array should be preceded in the list by the size of the array. */
277 tp_function_with_arguments
,
284 /* The stack can contain either an enum type_pieces or an int. */
287 enum type_pieces piece
;
289 struct type_stack
*stack_val
;
290 std::vector
<struct type
*> *typelist_val
;
293 /* The type stack is an instance of this structure. */
297 /* Elements on the stack. */
298 std::vector
<union type_stack_elt
> elements
;
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. */
308 extern int prefixify_expression (struct expression
*expr
);
310 extern void write_exp_elt_opcode (struct expr_builder
*, enum exp_opcode
);
312 extern void write_exp_elt_sym (struct expr_builder
*, struct symbol
*);
314 extern void write_exp_elt_longcst (struct expr_builder
*, LONGEST
);
316 extern void write_exp_elt_floatcst (struct expr_builder
*, const gdb_byte
*);
318 extern void write_exp_elt_type (struct expr_builder
*, struct type
*);
320 extern void write_exp_elt_intern (struct expr_builder
*, struct internalvar
*);
322 extern void write_exp_string (struct expr_builder
*, struct stoken
);
324 void write_exp_string_vector (struct expr_builder
*, int type
,
325 struct stoken_vector
*vec
);
327 extern void write_exp_bitstring (struct expr_builder
*, struct stoken
);
329 extern void write_exp_elt_block (struct expr_builder
*, const struct block
*);
331 extern void write_exp_elt_objfile (struct expr_builder
*,
332 struct objfile
*objfile
);
334 extern void write_exp_msymbol (struct expr_builder
*,
335 struct bound_minimal_symbol
);
337 extern void write_dollar_variable (struct parser_state
*, struct stoken str
);
339 extern void mark_struct_expression (struct expr_builder
*);
341 extern const char *find_template_name_end (const char *);
343 extern char *copy_name (struct stoken
);
345 extern void insert_type (enum type_pieces
);
347 extern void push_type (enum type_pieces
);
349 extern void push_type_int (int);
351 extern void insert_type_address_space (struct expr_builder
*, char *);
353 extern enum type_pieces
pop_type (void);
355 extern int pop_type_int (void);
357 extern struct type_stack
*get_type_stack (void);
359 extern struct type_stack
*append_type_stack (struct type_stack
*to
,
360 struct type_stack
*from
);
362 extern void push_type_stack (struct type_stack
*stack
);
364 extern void push_typelist (std::vector
<struct type
*> *typelist
);
366 extern int dump_subexp (struct expression
*, struct ui_file
*, int);
368 extern int dump_subexp_body_standard (struct expression
*,
369 struct ui_file
*, int);
371 extern void operator_length (const struct expression
*, int, int *, int *);
373 extern void operator_length_standard (const struct expression
*, int, int *,
376 extern int operator_check_standard (struct expression
*exp
, int pos
,
378 (struct objfile
*objfile
, void *data
),
381 extern const char *op_name_standard (enum exp_opcode
);
383 extern struct type
*follow_types (struct type
*);
385 extern type_instance_flags
follow_type_instance_flags ();
387 extern void null_post_parser (expression_up
*, int);
389 extern bool parse_float (const char *p
, int len
,
390 const struct type
*type
, gdb_byte
*data
);
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. */
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
408 /* Table mapping opcodes into strings for printing operators
409 and precedences of the operators. */
414 enum exp_opcode opcode
;
415 /* Precedence of operator. These values are used only by comparisons. */
416 enum precedence precedence
;
418 /* For a binary operator: 1 iff right associate.
419 For a unary operator: 1 iff postfix. */
423 /* Information needed to print, prefixify, and evaluate expressions for
426 struct exp_descriptor
428 /* Print subexpression. */
429 void (*print_subexp
) (struct expression
*, int *, struct ui_file
*,
432 /* Returns number of exp_elements needed to represent an operator and
433 the number of subexpressions it takes. */
434 void (*operator_length
) (const struct expression
*, int, int*, int *);
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
444 int (*operator_check
) (struct expression
*exp
, int pos
,
445 int (*objfile_func
) (struct objfile
*objfile
,
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). */
453 const char *(*op_name
) (enum exp_opcode
);
455 /* Dump the rest of this (prefix) expression after the operator
456 itself has been printed. See dump_subexp_body_standard in
458 int (*dump_subexp_body
) (struct expression
*, struct ui_file
*, int);
460 /* Evaluate an expression. */
461 struct value
*(*evaluate_exp
) (struct type
*, struct expression
*,
466 /* Default descriptor containing standard definitions of all
468 extern const struct exp_descriptor exp_descriptor_standard
;
470 /* Functions used by language-specific extended operators to (recursively)
471 print/dump subexpressions. */
473 extern void print_subexp (struct expression
*, int *, struct ui_file
*,
476 extern void print_subexp_standard (struct expression
*, int *,
477 struct ui_file
*, enum precedence
);
479 /* Function used to avoid direct calls to fprintf
480 in the code generated by the bison parser. */
482 extern void parser_fprintf (FILE *, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
484 extern int exp_uses_objfile (struct expression
*exp
, struct objfile
*objfile
);
486 extern void mark_completion_tag (enum type_code
, const char *ptr
,
489 #endif /* PARSER_DEFS_H */