1 /* Parser definitions for GDB.
3 Copyright (C) 1986-2014 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
28 #include "expression.h"
34 extern int parser_debug;
36 #define parse_gdbarch(ps) ((ps)->expout->gdbarch)
37 #define parse_language(ps) ((ps)->expout->language_defn)
41 /* The expression related to this parser state. */
43 struct expression *expout;
45 /* The size of the expression above. */
49 /* The number of elements already in the expression. This is used
50 to know where to put new elements. */
55 /* If this is nonzero, this block is used as the lexical context
58 extern const struct block *expression_context_block;
60 /* If expression_context_block is non-zero, then this is the PC within
61 the block that we want to evaluate expressions at. When debugging
62 C or C++ code, we use this to find the exact line we're at, and
63 then look up the macro definitions active at that point. */
64 extern CORE_ADDR expression_context_pc;
66 /* The innermost context required by the stack and register variables
67 we've encountered so far. */
68 extern const struct block *innermost_block;
70 /* The block in which the most recently discovered symbol was found.
71 FIXME: Should be declared along with lookup_symbol in symtab.h; is not
72 related specifically to parsing. */
73 extern const struct block *block_found;
75 /* Number of arguments seen so far in innermost function call. */
76 extern int arglist_len;
78 /* A string token, either a char-string or bit-string. Char-strings are
79 used, for example, for the names of symbols. */
83 /* Pointer to first byte of char-string or first bit of bit-string. */
85 /* Length of string in bytes for char-string or bits for bit-string. */
91 /* A language-specific type field. */
93 /* Pointer to first byte of char-string or first bit of bit-string. */
95 /* Length of string in bytes for char-string or bits for bit-string. */
102 struct typed_stoken *tokens;
107 struct stoken stoken;
113 struct stoken stoken;
115 int is_a_field_of_this;
118 struct objc_class_str
120 struct stoken stoken;
125 typedef struct type *type_ptr;
126 DEF_VEC_P (type_ptr);
128 /* For parsing of complicated types.
129 An array should be preceded in the list by the size of the array. */
137 tp_function_with_arguments,
143 /* The stack can contain either an enum type_pieces or an int. */
146 enum type_pieces piece;
148 struct type_stack *stack_val;
149 VEC (type_ptr) *typelist_val;
152 /* The type stack is an instance of this structure. */
156 /* Elements on the stack. */
157 union type_stack_elt *elements;
158 /* Current stack depth. */
160 /* Allocated size of stack. */
164 /* Helper function to initialize the expout, expout_size, expout_ptr
165 trio inside PS before it is used to store expression elements created
166 during the parsing of an expression. INITIAL_SIZE is the initial size of
167 the expout array. LANG is the language used to parse the expression.
168 And GDBARCH is the gdbarch to use during parsing. */
170 extern void initialize_expout (struct parser_state *ps,
172 const struct language_defn *lang,
173 struct gdbarch *gdbarch);
175 /* Helper function that reallocates the EXPOUT inside PS in order to
176 eliminate any unused space. It is generally used when the expression
177 has just been parsed and created. */
179 extern void reallocate_expout (struct parser_state *ps);
181 /* Reverse an expression from suffix form (in which it is constructed)
182 to prefix form (in which we can conveniently print or execute it).
183 Ordinarily this always returns -1. However, if EXPOUT_LAST_STRUCT
184 is not -1 (i.e., we are trying to complete a field name), it will
185 return the index of the subexpression which is the left-hand-side
186 of the struct operation at EXPOUT_LAST_STRUCT. */
188 extern int prefixify_expression (struct expression *expr);
190 extern void write_exp_elt_opcode (struct parser_state *, enum exp_opcode);
192 extern void write_exp_elt_sym (struct parser_state *, struct symbol *);
194 extern void write_exp_elt_longcst (struct parser_state *, LONGEST);
196 extern void write_exp_elt_dblcst (struct parser_state *, DOUBLEST);
198 extern void write_exp_elt_decfloatcst (struct parser_state *, gdb_byte *);
200 extern void write_exp_elt_type (struct parser_state *, struct type *);
202 extern void write_exp_elt_intern (struct parser_state *, struct internalvar *);
204 extern void write_exp_string (struct parser_state *, struct stoken);
206 void write_exp_string_vector (struct parser_state *, int type,
207 struct stoken_vector *vec);
209 extern void write_exp_bitstring (struct parser_state *, struct stoken);
211 extern void write_exp_elt_block (struct parser_state *, const struct block *);
213 extern void write_exp_elt_objfile (struct parser_state *,
214 struct objfile *objfile);
216 extern void write_exp_msymbol (struct parser_state *,
217 struct bound_minimal_symbol);
219 extern void write_dollar_variable (struct parser_state *, struct stoken str);
221 extern void mark_struct_expression (struct parser_state *);
223 extern const char *find_template_name_end (const char *);
225 extern void start_arglist (void);
227 extern int end_arglist (void);
229 extern char *copy_name (struct stoken);
231 extern void insert_type (enum type_pieces);
233 extern void push_type (enum type_pieces);
235 extern void push_type_int (int);
237 extern void insert_type_address_space (struct parser_state *, char *);
239 extern enum type_pieces pop_type (void);
241 extern int pop_type_int (void);
243 extern struct type_stack *get_type_stack (void);
245 extern struct type_stack *append_type_stack (struct type_stack *to,
246 struct type_stack *from);
248 extern void push_type_stack (struct type_stack *stack);
250 extern void type_stack_cleanup (void *arg);
252 extern void push_typelist (VEC (type_ptr) *typelist);
254 extern int length_of_subexp (struct expression *, int);
256 extern int dump_subexp (struct expression *, struct ui_file *, int);
258 extern int dump_subexp_body_standard (struct expression *,
259 struct ui_file *, int);
261 extern void operator_length (const struct expression *, int, int *, int *);
263 extern void operator_length_standard (const struct expression *, int, int *,
266 extern int operator_check_standard (struct expression *exp, int pos,
268 (struct objfile *objfile, void *data),
271 extern char *op_name_standard (enum exp_opcode);
273 extern struct type *follow_types (struct type *);
275 extern void null_post_parser (struct expression **, int);
277 extern int parse_float (const char *p, int len, DOUBLEST *d,
278 const char **suffix);
280 extern int parse_c_float (struct gdbarch *gdbarch, const char *p, int len,
281 DOUBLEST *d, struct type **t);
283 /* During parsing of a C expression, the pointer to the next character
284 is in this variable. */
286 extern const char *lexptr;
288 /* After a token has been recognized, this variable points to it.
289 Currently used only for error reporting. */
290 extern const char *prev_lexptr;
292 /* Current depth in parentheses within the expression. */
294 extern int paren_depth;
296 /* Nonzero means stop parsing on first comma (if not within parentheses). */
298 extern int comma_terminates;
300 /* These codes indicate operator precedences for expression printing,
301 least tightly binding first. */
302 /* Adding 1 to a precedence value is done for binary operators,
303 on the operand which is more tightly bound, so that operators
304 of equal precedence within that operand will get parentheses. */
305 /* PREC_HYPER and PREC_ABOVE_COMMA are not the precedence of any operator;
306 they are used as the "surrounding precedence" to force
307 various kinds of things to be parenthesized. */
310 PREC_NULL, PREC_COMMA, PREC_ABOVE_COMMA, PREC_ASSIGN, PREC_LOGICAL_OR,
311 PREC_LOGICAL_AND, PREC_BITWISE_IOR, PREC_BITWISE_AND, PREC_BITWISE_XOR,
312 PREC_EQUAL, PREC_ORDER, PREC_SHIFT, PREC_ADD, PREC_MUL, PREC_REPEAT,
313 PREC_HYPER, PREC_PREFIX, PREC_SUFFIX, PREC_BUILTIN_FUNCTION
316 /* Table mapping opcodes into strings for printing operators
317 and precedences of the operators. */
322 enum exp_opcode opcode;
323 /* Precedence of operator. These values are used only by comparisons. */
324 enum precedence precedence;
326 /* For a binary operator: 1 iff right associate.
327 For a unary operator: 1 iff postfix. */
331 /* Information needed to print, prefixify, and evaluate expressions for
334 struct exp_descriptor
336 /* Print subexpression. */
337 void (*print_subexp) (struct expression *, int *, struct ui_file *,
340 /* Returns number of exp_elements needed to represent an operator and
341 the number of subexpressions it takes. */
342 void (*operator_length) (const struct expression*, int, int*, int *);
344 /* Call TYPE_FUNC and OBJFILE_FUNC for any TYPE and OBJFILE found being
345 referenced by the single operator of EXP at position POS. Operator
346 parameters are located at positive (POS + number) offsets in EXP.
347 The functions should never be called with NULL TYPE or NULL OBJFILE.
348 Functions should get passed an arbitrary caller supplied DATA pointer.
349 If any of the functions returns non-zero value then (any other) non-zero
350 value should be immediately returned to the caller. Otherwise zero
351 should be returned. */
352 int (*operator_check) (struct expression *exp, int pos,
353 int (*objfile_func) (struct objfile *objfile,
357 /* Name of this operator for dumping purposes.
358 The returned value should never be NULL, even if EXP_OPCODE is
359 an unknown opcode (a string containing an image of the numeric
360 value of the opcode can be returned, for instance). */
361 char *(*op_name) (enum exp_opcode);
363 /* Dump the rest of this (prefix) expression after the operator
364 itself has been printed. See dump_subexp_body_standard in
366 int (*dump_subexp_body) (struct expression *, struct ui_file *, int);
368 /* Evaluate an expression. */
369 struct value *(*evaluate_exp) (struct type *, struct expression *,
374 /* Default descriptor containing standard definitions of all
376 extern const struct exp_descriptor exp_descriptor_standard;
378 /* Functions used by language-specific extended operators to (recursively)
379 print/dump subexpressions. */
381 extern void print_subexp (struct expression *, int *, struct ui_file *,
384 extern void print_subexp_standard (struct expression *, int *,
385 struct ui_file *, enum precedence);
387 /* Function used to avoid direct calls to fprintf
388 in the code generated by the bison parser. */
390 extern void parser_fprintf (FILE *, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
392 extern int exp_uses_objfile (struct expression *exp, struct objfile *objfile);
394 extern void mark_completion_tag (enum type_code, const char *ptr,
397 /* Reallocate the `expout' pointer inside PS so that it can accommodate
398 at least LENELT expression elements. This function does nothing if
399 there is enough room for the elements. */
401 extern void increase_expout_size (struct parser_state *ps, size_t lenelt);
403 #endif /* PARSER_DEFS_H */