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