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