Expand preprocessor macros in C expressions.
[platform/upstream/binutils.git] / gdb / parser-defs.h
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 extern struct expression *expout;
32 extern int expout_size;
33 extern int expout_ptr;
34
35 /* If this is nonzero, this block is used as the lexical context
36    for symbol names.  */
37
38 extern 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.  */
44 CORE_ADDR expression_context_pc;
45
46 /* The innermost context required by the stack and register variables
47    we've encountered so far. */
48 extern 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.  */
53 extern struct block *block_found;
54
55 /* Number of arguments seen so far in innermost function call.  */
56 extern 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
61 struct 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
69 struct ttype
70   {
71     struct stoken stoken;
72     struct type *type;
73   };
74
75 struct symtoken
76   {
77     struct stoken stoken;
78     struct symbol *sym;
79     int is_a_field_of_this;
80   };
81
82 /* For parsing of complicated types.
83    An array should be preceded in the list by the size of the array.  */
84 enum type_pieces
85   {
86     tp_end = -1, 
87     tp_pointer, 
88     tp_reference, 
89     tp_array, 
90     tp_function, 
91     tp_const, 
92     tp_volatile, 
93     tp_space_identifier
94   };
95 /* The stack can contain either an enum type_pieces or an int.  */
96 union type_stack_elt
97   {
98     enum type_pieces piece;
99     int int_val;
100   };
101 extern union type_stack_elt *type_stack;
102 extern int type_stack_depth, type_stack_size;
103
104 extern void write_exp_elt (union exp_element);
105
106 extern void write_exp_elt_opcode (enum exp_opcode);
107
108 extern void write_exp_elt_sym (struct symbol *);
109
110 extern void write_exp_elt_longcst (LONGEST);
111
112 extern void write_exp_elt_dblcst (DOUBLEST);
113
114 extern void write_exp_elt_type (struct type *);
115
116 extern void write_exp_elt_intern (struct internalvar *);
117
118 extern void write_exp_string (struct stoken);
119
120 extern void write_exp_bitstring (struct stoken);
121
122 extern void write_exp_elt_block (struct block *);
123
124 extern void write_exp_msymbol (struct minimal_symbol *,
125                                struct type *, struct type *);
126
127 extern void write_dollar_variable (struct stoken str);
128
129 extern struct symbol *parse_nested_classes_for_hpacc (char *, int, char **,
130                                                       int *, char **);
131
132 extern char *find_template_name_end (char *);
133
134 extern void start_arglist (void);
135
136 extern int end_arglist (void);
137
138 extern char *copy_name (struct stoken);
139
140 extern void push_type (enum type_pieces);
141
142 extern void push_type_int (int);
143
144 extern void push_type_address_space (char *);
145
146 extern enum type_pieces pop_type (void);
147
148 extern int pop_type_int (void);
149
150 extern int length_of_subexp (struct expression *, int);
151
152 extern struct type *follow_types (struct type *);
153
154 /* During parsing of a C expression, the pointer to the next character
155    is in this variable.  */
156
157 extern char *lexptr;
158
159 /* After a token has been recognized, this variable points to it.  
160    Currently used only for error reporting.  */
161 extern char *prev_lexptr;
162
163 /* Tokens that refer to names do so with explicit pointer and length,
164    so they can share the storage that lexptr is parsing.
165
166    When it is necessary to pass a name to a function that expects
167    a null-terminated string, the substring is copied out
168    into a block of storage that namecopy points to.
169
170    namecopy is allocated once, guaranteed big enough, for each parsing.  */
171
172 extern char *namecopy;
173
174 /* Current depth in parentheses within the expression.  */
175
176 extern int paren_depth;
177
178 /* Nonzero means stop parsing on first comma (if not within parentheses).  */
179
180 extern int comma_terminates;
181 \f
182 /* These codes indicate operator precedences for expression printing,
183    least tightly binding first.  */
184 /* Adding 1 to a precedence value is done for binary operators,
185    on the operand which is more tightly bound, so that operators
186    of equal precedence within that operand will get parentheses.  */
187 /* PREC_HYPER and PREC_ABOVE_COMMA are not the precedence of any operator;
188    they are used as the "surrounding precedence" to force
189    various kinds of things to be parenthesized.  */
190 enum precedence
191   {
192     PREC_NULL, PREC_COMMA, PREC_ABOVE_COMMA, PREC_ASSIGN, PREC_LOGICAL_OR,
193     PREC_LOGICAL_AND, PREC_BITWISE_IOR, PREC_BITWISE_AND, PREC_BITWISE_XOR,
194     PREC_EQUAL, PREC_ORDER, PREC_SHIFT, PREC_ADD, PREC_MUL, PREC_REPEAT,
195     PREC_HYPER, PREC_PREFIX, PREC_SUFFIX, PREC_BUILTIN_FUNCTION
196   };
197
198 /* Table mapping opcodes into strings for printing operators
199    and precedences of the operators.  */
200
201 struct op_print
202   {
203     char *string;
204     enum exp_opcode opcode;
205     /* Precedence of operator.  These values are used only by comparisons.  */
206     enum precedence precedence;
207
208     /* For a binary operator:  1 iff right associate.
209        For a unary operator:  1 iff postfix. */
210     int right_assoc;
211   };
212
213 /* The generic method for targets to specify how their registers are
214    named.  The mapping can be derived from two sources: REGISTER_NAME;
215    and builtin regs. */
216
217 extern int target_map_name_to_register (char *, int);
218
219 #endif /* PARSER_DEFS_H */