1 /* Parser definitions for GDB.
3 Copyright (C) 1986-2018 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
27 #include "expression.h"
33 extern int parser_debug;
35 #define parse_gdbarch(ps) ((ps)->expout->gdbarch)
36 #define parse_language(ps) ((ps)->expout->language_defn)
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. */
44 parser_state (size_t initial_size, const struct language_defn *lang,
45 struct gdbarch *gdbarch);
47 DISABLE_COPY_AND_ASSIGN (parser_state);
49 /* Resize the allocated expression to the correct size, and return
50 it as an expression_up -- passing ownership to the caller. */
51 expression_up release ();
53 /* The size of the expression above. */
57 /* The expression related to this parser state. */
61 /* The number of elements already in the expression. This is used
62 to know where to put new elements. */
67 /* If this is nonzero, this block is used as the lexical context
70 extern const struct block *expression_context_block;
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. */
76 extern CORE_ADDR expression_context_pc;
78 /* The innermost context required by the stack and register variables
79 we've encountered so far. */
80 extern const struct block *innermost_block;
82 /* Number of arguments seen so far in innermost function call. */
83 extern int arglist_len;
85 /* A string token, either a char-string or bit-string. Char-strings are
86 used, for example, for the names of symbols. */
90 /* Pointer to first byte of char-string or first bit of bit-string. */
92 /* Length of string in bytes for char-string or bits for bit-string. */
98 /* A language-specific type field. */
100 /* Pointer to first byte of char-string or first bit of bit-string. */
102 /* Length of string in bytes for char-string or bits for bit-string. */
109 struct typed_stoken *tokens;
114 struct stoken stoken;
120 struct stoken stoken;
121 struct block_symbol sym;
122 int is_a_field_of_this;
125 struct objc_class_str
127 struct stoken stoken;
132 typedef struct type *type_ptr;
133 DEF_VEC_P (type_ptr);
135 /* For parsing of complicated types.
136 An array should be preceded in the list by the size of the array. */
145 tp_function_with_arguments,
151 /* The stack can contain either an enum type_pieces or an int. */
154 enum type_pieces piece;
156 struct type_stack *stack_val;
157 VEC (type_ptr) *typelist_val;
160 /* The type stack is an instance of this structure. */
164 /* Elements on the stack. */
165 union type_stack_elt *elements;
166 /* Current stack depth. */
168 /* Allocated size of stack. */
172 /* Reverse an expression from suffix form (in which it is constructed)
173 to prefix form (in which we can conveniently print or execute it).
174 Ordinarily this always returns -1. However, if EXPOUT_LAST_STRUCT
175 is not -1 (i.e., we are trying to complete a field name), it will
176 return the index of the subexpression which is the left-hand-side
177 of the struct operation at EXPOUT_LAST_STRUCT. */
179 extern int prefixify_expression (struct expression *expr);
181 extern void write_exp_elt_opcode (struct parser_state *, enum exp_opcode);
183 extern void write_exp_elt_sym (struct parser_state *, struct symbol *);
185 extern void write_exp_elt_longcst (struct parser_state *, LONGEST);
187 extern void write_exp_elt_floatcst (struct parser_state *, const gdb_byte *);
189 extern void write_exp_elt_type (struct parser_state *, struct type *);
191 extern void write_exp_elt_intern (struct parser_state *, struct internalvar *);
193 extern void write_exp_string (struct parser_state *, struct stoken);
195 void write_exp_string_vector (struct parser_state *, int type,
196 struct stoken_vector *vec);
198 extern void write_exp_bitstring (struct parser_state *, struct stoken);
200 extern void write_exp_elt_block (struct parser_state *, const struct block *);
202 extern void write_exp_elt_objfile (struct parser_state *,
203 struct objfile *objfile);
205 extern void write_exp_msymbol (struct parser_state *,
206 struct bound_minimal_symbol);
208 extern void write_dollar_variable (struct parser_state *, struct stoken str);
210 extern void mark_struct_expression (struct parser_state *);
212 extern const char *find_template_name_end (const char *);
214 extern void start_arglist (void);
216 extern int end_arglist (void);
218 extern char *copy_name (struct stoken);
220 extern void insert_type (enum type_pieces);
222 extern void push_type (enum type_pieces);
224 extern void push_type_int (int);
226 extern void insert_type_address_space (struct parser_state *, char *);
228 extern enum type_pieces pop_type (void);
230 extern int pop_type_int (void);
232 extern struct type_stack *get_type_stack (void);
234 extern struct type_stack *append_type_stack (struct type_stack *to,
235 struct type_stack *from);
237 extern void push_type_stack (struct type_stack *stack);
239 extern void type_stack_cleanup (void *arg);
241 extern void push_typelist (VEC (type_ptr) *typelist);
243 extern int dump_subexp (struct expression *, struct ui_file *, int);
245 extern int dump_subexp_body_standard (struct expression *,
246 struct ui_file *, int);
248 extern void operator_length (const struct expression *, int, int *, int *);
250 extern void operator_length_standard (const struct expression *, int, int *,
253 extern int operator_check_standard (struct expression *exp, int pos,
255 (struct objfile *objfile, void *data),
258 extern const char *op_name_standard (enum exp_opcode);
260 extern struct type *follow_types (struct type *);
262 extern type_instance_flags follow_type_instance_flags ();
264 extern void null_post_parser (expression_up *, int);
266 extern bool parse_float (const char *p, int len,
267 const struct type *type, gdb_byte *data);
269 /* During parsing of a C expression, the pointer to the next character
270 is in this variable. */
272 extern const char *lexptr;
274 /* After a token has been recognized, this variable points to it.
275 Currently used only for error reporting. */
276 extern const char *prev_lexptr;
278 /* Current depth in parentheses within the expression. */
280 extern int paren_depth;
282 /* Nonzero means stop parsing on first comma (if not within parentheses). */
284 extern int comma_terminates;
286 /* These codes indicate operator precedences for expression printing,
287 least tightly binding first. */
288 /* Adding 1 to a precedence value is done for binary operators,
289 on the operand which is more tightly bound, so that operators
290 of equal precedence within that operand will get parentheses. */
291 /* PREC_HYPER and PREC_ABOVE_COMMA are not the precedence of any operator;
292 they are used as the "surrounding precedence" to force
293 various kinds of things to be parenthesized. */
296 PREC_NULL, PREC_COMMA, PREC_ABOVE_COMMA, PREC_ASSIGN, PREC_LOGICAL_OR,
297 PREC_LOGICAL_AND, PREC_BITWISE_IOR, PREC_BITWISE_AND, PREC_BITWISE_XOR,
298 PREC_EQUAL, PREC_ORDER, PREC_SHIFT, PREC_ADD, PREC_MUL, PREC_REPEAT,
299 PREC_HYPER, PREC_PREFIX, PREC_SUFFIX, PREC_BUILTIN_FUNCTION
302 /* Table mapping opcodes into strings for printing operators
303 and precedences of the operators. */
308 enum exp_opcode opcode;
309 /* Precedence of operator. These values are used only by comparisons. */
310 enum precedence precedence;
312 /* For a binary operator: 1 iff right associate.
313 For a unary operator: 1 iff postfix. */
317 /* Information needed to print, prefixify, and evaluate expressions for
320 struct exp_descriptor
322 /* Print subexpression. */
323 void (*print_subexp) (struct expression *, int *, struct ui_file *,
326 /* Returns number of exp_elements needed to represent an operator and
327 the number of subexpressions it takes. */
328 void (*operator_length) (const struct expression*, int, int*, int *);
330 /* Call OBJFILE_FUNC for any objfile found being referenced by the
331 single operator of EXP at position POS. Operator parameters are
332 located at positive (POS + number) offsets in EXP. OBJFILE_FUNC
333 should never be called with NULL OBJFILE. OBJFILE_FUNC should
334 get passed an arbitrary caller supplied DATA pointer. If it
335 returns non-zero value then (any other) non-zero value should be
336 immediately returned to the caller. Otherwise zero should be
338 int (*operator_check) (struct expression *exp, int pos,
339 int (*objfile_func) (struct objfile *objfile,
343 /* Name of this operator for dumping purposes.
344 The returned value should never be NULL, even if EXP_OPCODE is
345 an unknown opcode (a string containing an image of the numeric
346 value of the opcode can be returned, for instance). */
347 const char *(*op_name) (enum exp_opcode);
349 /* Dump the rest of this (prefix) expression after the operator
350 itself has been printed. See dump_subexp_body_standard in
352 int (*dump_subexp_body) (struct expression *, struct ui_file *, int);
354 /* Evaluate an expression. */
355 struct value *(*evaluate_exp) (struct type *, struct expression *,
360 /* Default descriptor containing standard definitions of all
362 extern const struct exp_descriptor exp_descriptor_standard;
364 /* Functions used by language-specific extended operators to (recursively)
365 print/dump subexpressions. */
367 extern void print_subexp (struct expression *, int *, struct ui_file *,
370 extern void print_subexp_standard (struct expression *, int *,
371 struct ui_file *, enum precedence);
373 /* Function used to avoid direct calls to fprintf
374 in the code generated by the bison parser. */
376 extern void parser_fprintf (FILE *, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
378 extern int exp_uses_objfile (struct expression *exp, struct objfile *objfile);
380 extern void mark_completion_tag (enum type_code, const char *ptr,
383 /* Reallocate the `expout' pointer inside PS so that it can accommodate
384 at least LENELT expression elements. This function does nothing if
385 there is enough room for the elements. */
387 extern void increase_expout_size (struct parser_state *ps, size_t lenelt);
389 #endif /* PARSER_DEFS_H */