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
31struct block;
32
33extern struct expression *expout;
34extern int expout_size;
35extern int expout_ptr;
36
37/* If this is nonzero, this block is used as the lexical context
38   for symbol names.  */
39
40extern 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.  */
46extern CORE_ADDR expression_context_pc;
47
48/* The innermost context required by the stack and register variables
49   we've encountered so far. */
50extern 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.  */
55extern struct block *block_found;
56
57/* Number of arguments seen so far in innermost function call.  */
58extern 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
63struct 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
71struct ttype
72  {
73    struct stoken stoken;
74    struct type *type;
75  };
76
77struct symtoken
78  {
79    struct stoken stoken;
80    struct symbol *sym;
81    int is_a_field_of_this;
82  };
83
84struct 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.  */
94enum 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.  */
106union type_stack_elt
107  {
108    enum type_pieces piece;
109    int int_val;
110  };
111extern union type_stack_elt *type_stack;
112extern int type_stack_depth, type_stack_size;
113
114extern void write_exp_elt (union exp_element);
115
116extern void write_exp_elt_opcode (enum exp_opcode);
117
118extern void write_exp_elt_sym (struct symbol *);
119
120extern void write_exp_elt_longcst (LONGEST);
121
122extern void write_exp_elt_dblcst (DOUBLEST);
123
124extern void write_exp_elt_type (struct type *);
125
126extern void write_exp_elt_intern (struct internalvar *);
127
128extern void write_exp_string (struct stoken);
129
130extern void write_exp_bitstring (struct stoken);
131
132extern void write_exp_elt_block (struct block *);
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 struct symbol *parse_nested_classes_for_hpacc (char *, int, char **,
140						      int *, char **);
141
142extern char *find_template_name_end (char *);
143
144extern void start_arglist (void);
145
146extern int end_arglist (void);
147
148extern char *copy_name (struct stoken);
149
150extern void push_type (enum type_pieces);
151
152extern void push_type_int (int);
153
154extern void push_type_address_space (char *);
155
156extern enum type_pieces pop_type (void);
157
158extern int pop_type_int (void);
159
160extern int length_of_subexp (struct expression *, int);
161
162extern int dump_subexp (struct expression *, struct ui_file *, int);
163
164extern int dump_subexp_body_standard (struct expression *,
165				      struct ui_file *, int);
166
167extern void operator_length (struct expression *, int, int *, int *);
168
169extern void operator_length_standard (struct expression *, int, int *, int *);
170
171extern char *op_name_standard (enum exp_opcode);
172
173extern struct type *follow_types (struct type *);
174
175/* During parsing of a C expression, the pointer to the next character
176   is in this variable.  */
177
178extern char *lexptr;
179
180/* After a token has been recognized, this variable points to it.
181   Currently used only for error reporting.  */
182extern char *prev_lexptr;
183
184/* Tokens that refer to names do so with explicit pointer and length,
185   so they can share the storage that lexptr is parsing.
186
187   When it is necessary to pass a name to a function that expects
188   a null-terminated string, the substring is copied out
189   into a block of storage that namecopy points to.
190
191   namecopy is allocated once, guaranteed big enough, for each parsing.  */
192
193extern char *namecopy;
194
195/* Current depth in parentheses within the expression.  */
196
197extern int paren_depth;
198
199/* Nonzero means stop parsing on first comma (if not within parentheses).  */
200
201extern int comma_terminates;
202
203/* These codes indicate operator precedences for expression printing,
204   least tightly binding first.  */
205/* Adding 1 to a precedence value is done for binary operators,
206   on the operand which is more tightly bound, so that operators
207   of equal precedence within that operand will get parentheses.  */
208/* PREC_HYPER and PREC_ABOVE_COMMA are not the precedence of any operator;
209   they are used as the "surrounding precedence" to force
210   various kinds of things to be parenthesized.  */
211enum precedence
212  {
213    PREC_NULL, PREC_COMMA, PREC_ABOVE_COMMA, PREC_ASSIGN, PREC_LOGICAL_OR,
214    PREC_LOGICAL_AND, PREC_BITWISE_IOR, PREC_BITWISE_AND, PREC_BITWISE_XOR,
215    PREC_EQUAL, PREC_ORDER, PREC_SHIFT, PREC_ADD, PREC_MUL, PREC_REPEAT,
216    PREC_HYPER, PREC_PREFIX, PREC_SUFFIX, PREC_BUILTIN_FUNCTION
217  };
218
219/* Table mapping opcodes into strings for printing operators
220   and precedences of the operators.  */
221
222struct op_print
223  {
224    char *string;
225    enum exp_opcode opcode;
226    /* Precedence of operator.  These values are used only by comparisons.  */
227    enum precedence precedence;
228
229    /* For a binary operator:  1 iff right associate.
230       For a unary operator:  1 iff postfix. */
231    int right_assoc;
232  };
233
234/* Information needed to print, prefixify, and evaluate expressions for
235   a given language.  */
236
237struct exp_descriptor
238  {
239    /* Print subexpression.  */
240    void (*print_subexp) (struct expression *, int *, struct ui_file *,
241			  enum precedence);
242
243    /* Returns number of exp_elements needed to represent an operator and
244       the number of subexpressions it takes.  */
245    void (*operator_length) (struct expression*, int, int*, int *);
246
247    /* Name of this operator for dumping purposes.  */
248    char *(*op_name) (enum exp_opcode);
249
250    /* Dump the rest of this (prefix) expression after the operator
251       itself has been printed.  See dump_subexp_body_standard in
252       (expprint.c).  */
253    int (*dump_subexp_body) (struct expression *, struct ui_file *, int);
254
255    /* Evaluate an expression.  */
256    struct value *(*evaluate_exp) (struct type *, struct expression *,
257				   int *, enum noside);
258  };
259
260
261/* Default descriptor containing standard definitions of all
262   elements.  */
263extern const struct exp_descriptor exp_descriptor_standard;
264
265/* Functions used by language-specific extended operators to (recursively)
266   print/dump subexpressions.  */
267
268extern void print_subexp (struct expression *, int *, struct ui_file *,
269			  enum precedence);
270
271extern void print_subexp_standard (struct expression *, int *,
272				   struct ui_file *, enum precedence);
273
274/* Function used to avoid direct calls to fprintf
275   in the code generated by the bison parser.  */
276
277extern void parser_fprintf (FILE *, const char *, ...) ATTR_FORMAT (printf, 2 ,3);
278
279#endif /* PARSER_DEFS_H */
280