xref: /openbsd/gnu/usr.bin/binutils/gdb/parser-defs.h (revision 63addd46)
1 /* Parser definitions for GDB.
2 
3    Copyright 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4    1997, 1998, 1999, 2000, 2002 Free Software Foundation, Inc.
5 
6    Modified from expread.y by the Department of Computer Science at the
7    State University of New York at Buffalo.
8 
9    This file is part of GDB.
10 
11    This program is free software; you can redistribute it and/or modify
12    it under the terms of the GNU General Public License as published by
13    the Free Software Foundation; either version 2 of the License, or
14    (at your option) any later version.
15 
16    This program is distributed in the hope that it will be useful,
17    but WITHOUT ANY WARRANTY; without even the implied warranty of
18    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19    GNU General Public License for more details.
20 
21    You should have received a copy of the GNU General Public License
22    along with this program; if not, write to the Free Software
23    Foundation, Inc., 59 Temple Place - Suite 330,
24    Boston, MA 02111-1307, USA.  */
25 
26 #if !defined (PARSER_DEFS_H)
27 #define PARSER_DEFS_H 1
28 
29 #include "doublest.h"
30 
31 struct block;
32 
33 extern struct expression *expout;
34 extern int expout_size;
35 extern int expout_ptr;
36 
37 /* If this is nonzero, this block is used as the lexical context
38    for symbol names.  */
39 
40 extern struct block *expression_context_block;
41 
42 /* If expression_context_block is non-zero, then this is the PC within
43    the block that we want to evaluate expressions at.  When debugging
44    C or C++ code, we use this to find the exact line we're at, and
45    then look up the macro definitions active at that point.  */
46 extern CORE_ADDR expression_context_pc;
47 
48 /* The innermost context required by the stack and register variables
49    we've encountered so far. */
50 extern struct block *innermost_block;
51 
52 /* The block in which the most recently discovered symbol was found.
53    FIXME: Should be declared along with lookup_symbol in symtab.h; is not
54    related specifically to parsing.  */
55 extern struct block *block_found;
56 
57 /* Number of arguments seen so far in innermost function call.  */
58 extern int arglist_len;
59 
60 /* A string token, either a char-string or bit-string.  Char-strings are
61    used, for example, for the names of symbols. */
62 
63 struct stoken
64   {
65     /* Pointer to first byte of char-string or first bit of bit-string */
66     char *ptr;
67     /* Length of string in bytes for char-string or bits for bit-string */
68     int length;
69   };
70 
71 struct ttype
72   {
73     struct stoken stoken;
74     struct type *type;
75   };
76 
77 struct symtoken
78   {
79     struct stoken stoken;
80     struct symbol *sym;
81     int is_a_field_of_this;
82   };
83 
84 struct objc_class_str
85   {
86     struct stoken stoken;
87     struct type *type;
88     int class;
89   };
90 
91 
92 /* For parsing of complicated types.
93    An array should be preceded in the list by the size of the array.  */
94 enum type_pieces
95   {
96     tp_end = -1,
97     tp_pointer,
98     tp_reference,
99     tp_array,
100     tp_function,
101     tp_const,
102     tp_volatile,
103     tp_space_identifier
104   };
105 /* The stack can contain either an enum type_pieces or an int.  */
106 union type_stack_elt
107   {
108     enum type_pieces piece;
109     int int_val;
110   };
111 extern union type_stack_elt *type_stack;
112 extern int type_stack_depth, type_stack_size;
113 
114 extern void write_exp_elt (union exp_element);
115 
116 extern void write_exp_elt_opcode (enum exp_opcode);
117 
118 extern void write_exp_elt_sym (struct symbol *);
119 
120 extern void write_exp_elt_longcst (LONGEST);
121 
122 extern void write_exp_elt_dblcst (DOUBLEST);
123 
124 extern void write_exp_elt_type (struct type *);
125 
126 extern void write_exp_elt_intern (struct internalvar *);
127 
128 extern void write_exp_string (struct stoken);
129 
130 extern void write_exp_bitstring (struct stoken);
131 
132 extern void write_exp_elt_block (struct block *);
133 
134 extern void write_exp_msymbol (struct minimal_symbol *,
135 			       struct type *, struct type *);
136 
137 extern void write_dollar_variable (struct stoken str);
138 
139 extern struct symbol *parse_nested_classes_for_hpacc (char *, int, char **,
140 						      int *, char **);
141 
142 extern char *find_template_name_end (char *);
143 
144 extern void start_arglist (void);
145 
146 extern int end_arglist (void);
147 
148 extern char *copy_name (struct stoken);
149 
150 extern void push_type (enum type_pieces);
151 
152 extern void push_type_int (int);
153 
154 extern void push_type_address_space (char *);
155 
156 extern enum type_pieces pop_type (void);
157 
158 extern int pop_type_int (void);
159 
160 extern int length_of_subexp (struct expression *, int);
161 
162 extern int dump_subexp (struct expression *, struct ui_file *, int);
163 
164 extern int dump_subexp_body_standard (struct expression *,
165 				      struct ui_file *, int);
166 
167 extern void operator_length (struct expression *, int, int *, int *);
168 
169 extern void operator_length_standard (struct expression *, int, int *, int *);
170 
171 extern char *op_name_standard (enum exp_opcode);
172 
173 extern struct type *follow_types (struct type *);
174 
175 extern void null_post_parser (struct expression **, int);
176 
177 /* During parsing of a C expression, the pointer to the next character
178    is in this variable.  */
179 
180 extern char *lexptr;
181 
182 /* After a token has been recognized, this variable points to it.
183    Currently used only for error reporting.  */
184 extern char *prev_lexptr;
185 
186 /* Tokens that refer to names do so with explicit pointer and length,
187    so they can share the storage that lexptr is parsing.
188 
189    When it is necessary to pass a name to a function that expects
190    a null-terminated string, the substring is copied out
191    into a block of storage that namecopy points to.
192 
193    namecopy is allocated once, guaranteed big enough, for each parsing.  */
194 
195 extern char *namecopy;
196 
197 /* Current depth in parentheses within the expression.  */
198 
199 extern int paren_depth;
200 
201 /* Nonzero means stop parsing on first comma (if not within parentheses).  */
202 
203 extern int comma_terminates;
204 
205 /* These codes indicate operator precedences for expression printing,
206    least tightly binding first.  */
207 /* Adding 1 to a precedence value is done for binary operators,
208    on the operand which is more tightly bound, so that operators
209    of equal precedence within that operand will get parentheses.  */
210 /* PREC_HYPER and PREC_ABOVE_COMMA are not the precedence of any operator;
211    they are used as the "surrounding precedence" to force
212    various kinds of things to be parenthesized.  */
213 enum precedence
214   {
215     PREC_NULL, PREC_COMMA, PREC_ABOVE_COMMA, PREC_ASSIGN, PREC_LOGICAL_OR,
216     PREC_LOGICAL_AND, PREC_BITWISE_IOR, PREC_BITWISE_AND, PREC_BITWISE_XOR,
217     PREC_EQUAL, PREC_ORDER, PREC_SHIFT, PREC_ADD, PREC_MUL, PREC_REPEAT,
218     PREC_HYPER, PREC_PREFIX, PREC_SUFFIX, PREC_BUILTIN_FUNCTION
219   };
220 
221 /* Table mapping opcodes into strings for printing operators
222    and precedences of the operators.  */
223 
224 struct op_print
225   {
226     char *string;
227     enum exp_opcode opcode;
228     /* Precedence of operator.  These values are used only by comparisons.  */
229     enum precedence precedence;
230 
231     /* For a binary operator:  1 iff right associate.
232        For a unary operator:  1 iff postfix. */
233     int right_assoc;
234   };
235 
236 /* Information needed to print, prefixify, and evaluate expressions for
237    a given language.  */
238 
239 struct exp_descriptor
240   {
241     /* Print subexpression.  */
242     void (*print_subexp) (struct expression *, int *, struct ui_file *,
243 			  enum precedence);
244 
245     /* Returns number of exp_elements needed to represent an operator and
246        the number of subexpressions it takes.  */
247     void (*operator_length) (struct expression*, int, int*, int *);
248 
249     /* Name of this operator for dumping purposes.  */
250     char *(*op_name) (enum exp_opcode);
251 
252     /* Dump the rest of this (prefix) expression after the operator
253        itself has been printed.  See dump_subexp_body_standard in
254        (expprint.c).  */
255     int (*dump_subexp_body) (struct expression *, struct ui_file *, int);
256 
257     /* Evaluate an expression.  */
258     struct value *(*evaluate_exp) (struct type *, struct expression *,
259 				   int *, enum noside);
260   };
261 
262 
263 /* Default descriptor containing standard definitions of all
264    elements.  */
265 extern const struct exp_descriptor exp_descriptor_standard;
266 
267 /* Functions used by language-specific extended operators to (recursively)
268    print/dump subexpressions.  */
269 
270 extern void print_subexp (struct expression *, int *, struct ui_file *,
271 			  enum precedence);
272 
273 extern void print_subexp_standard (struct expression *, int *,
274 				   struct ui_file *, enum precedence);
275 
276 /* Function used to avoid direct calls to fprintf
277    in the code generated by the bison parser.  */
278 
279 extern void parser_fprintf (FILE *, const char *, ...) ATTR_FORMAT (printf, 2 ,3);
280 
281 #endif /* PARSER_DEFS_H */
282