gdb/parser-defs.h

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