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