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