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