gdb/parser-defs.h

   1 /* Parser definitions for GDB.
   2
   3    Copyright (C) 1986, 1989-2000, 2002, 2007-2012 Free Software
   4    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 int parser_debug;
  32
  33 extern struct expression *expout;
  34 extern int expout_size;
  35 extern int expout_ptr;
  36
  37 #define parse_gdbarch (expout->gdbarch)
  38 #define parse_language (expout->language_defn)
  39
  40 /* If this is nonzero, this block is used as the lexical context
  41    for symbol names.  */
  42
  43 extern struct block *expression_context_block;
  44
  45 /* If expression_context_block is non-zero, then this is the PC within
  46    the block that we want to evaluate expressions at.  When debugging
  47    C or C++ code, we use this to find the exact line we're at, and
  48    then look up the macro definitions active at that point.  */
  49 extern CORE_ADDR expression_context_pc;
  50
  51 /* The innermost context required by the stack and register variables
  52    we've encountered so far.  */
  53 extern struct block *innermost_block;
  54
  55 /* The block in which the most recently discovered symbol was found.
  56    FIXME: Should be declared along with lookup_symbol in symtab.h; is not
  57    related specifically to parsing.  */
  58 extern struct block *block_found;
  59
  60 /* Number of arguments seen so far in innermost function call.  */
  61 extern int arglist_len;
  62
  63 /* A string token, either a char-string or bit-string.  Char-strings are
  64    used, for example, for the names of symbols.  */
  65
  66 struct stoken
  67   {
  68     /* Pointer to first byte of char-string or first bit of bit-string.  */
  69     char *ptr;
  70     /* Length of string in bytes for char-string or bits for bit-string.  */
  71     int length;
  72   };
  73
  74 struct typed_stoken
  75   {
  76     /* A language-specific type field.  */
  77     int type;
  78     /* Pointer to first byte of char-string or first bit of bit-string.  */
  79     char *ptr;
  80     /* Length of string in bytes for char-string or bits for bit-string.  */
  81     int length;
  82   };
  83
  84 struct stoken_vector
  85   {
  86     int len;
  87     struct typed_stoken *tokens;
  88   };
  89
  90 struct ttype
  91   {
  92     struct stoken stoken;
  93     struct type *type;
  94   };
  95
  96 struct symtoken
  97   {
  98     struct stoken stoken;
  99     struct symbol *sym;
 100     int is_a_field_of_this;
 101   };
 102
 103 struct objc_class_str
 104   {
 105     struct stoken stoken;
 106     struct type *type;
 107     int class;
 108   };
 109
 110
 111 /* For parsing of complicated types.
 112    An array should be preceded in the list by the size of the array.  */
 113 enum type_pieces
 114   {
 115     tp_end = -1,
 116     tp_pointer,
 117     tp_reference,
 118     tp_array,
 119     tp_function,
 120     tp_const,
 121     tp_volatile,
 122     tp_space_identifier
 123   };
 124 /* The stack can contain either an enum type_pieces or an int.  */
 125 union type_stack_elt
 126   {
 127     enum type_pieces piece;
 128     int int_val;
 129   };
 130
 131 /* The type stack is an instance of this structure.  */
 132
 133 struct type_stack
 134 {
 135   /* Elements on the stack.  */
 136   union type_stack_elt *elements;
 137   /* Current stack depth.  */
 138   int depth;
 139   /* Allocated size of stack.  */
 140   int size;
 141 };
 142
 143 /* Helper function to initialize the expout, expout_size, expout_ptr
 144    trio before it is used to store expression elements created during
 145    the parsing of an expression.  INITIAL_SIZE is the initial size of
 146    the expout array.  LANG is the language used to parse the expression.
 147    And GDBARCH is the gdbarch to use during parsing.  */
 148
 149 extern void initialize_expout (int, const struct language_defn *,
 150                                struct gdbarch *);
 151
 152 /* Helper function that frees any unsed space in the expout array.
 153    It is generally used when the parser has just been parsed and
 154    created.  */
 155
 156 extern void reallocate_expout (void);
 157
 158 /* Reverse an expression from suffix form (in which it is constructed)
 159    to prefix form (in which we can conveniently print or execute it).
 160    Ordinarily this always returns -1.  However, if EXPOUT_LAST_STRUCT
 161    is not -1 (i.e., we are trying to complete a field name), it will
 162    return the index of the subexpression which is the left-hand-side
 163    of the struct operation at EXPOUT_LAST_STRUCT.  */
 164
 165 extern int prefixify_expression (struct expression *expr);
 166
 167 extern void write_exp_elt_opcode (enum exp_opcode);
 168
 169 extern void write_exp_elt_sym (struct symbol *);
 170
 171 extern void write_exp_elt_longcst (LONGEST);
 172
 173 extern void write_exp_elt_dblcst (DOUBLEST);
 174
 175 extern void write_exp_elt_decfloatcst (gdb_byte *);
 176
 177 extern void write_exp_elt_type (struct type *);
 178
 179 extern void write_exp_elt_intern (struct internalvar *);
 180
 181 extern void write_exp_string (struct stoken);
 182
 183 void write_exp_string_vector (int type, struct stoken_vector *vec);
 184
 185 extern void write_exp_bitstring (struct stoken);
 186
 187 extern void write_exp_elt_block (struct block *);
 188
 189 extern void write_exp_elt_objfile (struct objfile *objfile);
 190
 191 extern void write_exp_msymbol (struct minimal_symbol *);
 192
 193 extern void write_dollar_variable (struct stoken str);
 194
 195 extern void mark_struct_expression (void);
 196
 197 extern char *find_template_name_end (char *);
 198
 199 extern void start_arglist (void);
 200
 201 extern int end_arglist (void);
 202
 203 extern char *copy_name (struct stoken);
 204
 205 extern void insert_type (enum type_pieces);
 206
 207 extern void push_type (enum type_pieces);
 208
 209 extern void push_type_int (int);
 210
 211 extern void insert_type_address_space (char *);
 212
 213 extern enum type_pieces pop_type (void);
 214
 215 extern int pop_type_int (void);
 216
 217 extern int length_of_subexp (struct expression *, int);
 218
 219 extern int dump_subexp (struct expression *, struct ui_file *, int);
 220
 221 extern int dump_subexp_body_standard (struct expression *,
 222                                       struct ui_file *, int);
 223
 224 extern void operator_length (const struct expression *, int, int *, int *);
 225
 226 extern void operator_length_standard (const struct expression *, int, int *,
 227                                       int *);
 228
 229 extern int operator_check_standard (struct expression *exp, int pos,
 230                                     int (*objfile_func)
 231                                       (struct objfile *objfile, void *data),
 232                                     void *data);
 233
 234 extern char *op_name_standard (enum exp_opcode);
 235
 236 extern struct type *follow_types (struct type *);
 237
 238 extern void null_post_parser (struct expression **, int);
 239
 240 extern int parse_float (const char *p, int len, DOUBLEST *d,
 241                         const char **suffix);
 242
 243 extern int parse_c_float (struct gdbarch *gdbarch, const char *p, int len,
 244                           DOUBLEST *d, struct type **t);
 245
 246 /* During parsing of a C expression, the pointer to the next character
 247    is in this variable.  */
 248
 249 extern char *lexptr;
 250
 251 /* After a token has been recognized, this variable points to it.
 252    Currently used only for error reporting.  */
 253 extern char *prev_lexptr;
 254
 255 /* Current depth in parentheses within the expression.  */
 256
 257 extern int paren_depth;
 258
 259 /* Nonzero means stop parsing on first comma (if not within parentheses).  */
 260
 261 extern int comma_terminates;
 262 \f
 263 /* These codes indicate operator precedences for expression printing,
 264    least tightly binding first.  */
 265 /* Adding 1 to a precedence value is done for binary operators,
 266    on the operand which is more tightly bound, so that operators
 267    of equal precedence within that operand will get parentheses.  */
 268 /* PREC_HYPER and PREC_ABOVE_COMMA are not the precedence of any operator;
 269    they are used as the "surrounding precedence" to force
 270    various kinds of things to be parenthesized.  */
 271 enum precedence
 272   {
 273     PREC_NULL, PREC_COMMA, PREC_ABOVE_COMMA, PREC_ASSIGN, PREC_LOGICAL_OR,
 274     PREC_LOGICAL_AND, PREC_BITWISE_IOR, PREC_BITWISE_AND, PREC_BITWISE_XOR,
 275     PREC_EQUAL, PREC_ORDER, PREC_SHIFT, PREC_ADD, PREC_MUL, PREC_REPEAT,
 276     PREC_HYPER, PREC_PREFIX, PREC_SUFFIX, PREC_BUILTIN_FUNCTION
 277   };
 278
 279 /* Table mapping opcodes into strings for printing operators
 280    and precedences of the operators.  */
 281
 282 struct op_print
 283   {
 284     char *string;
 285     enum exp_opcode opcode;
 286     /* Precedence of operator.  These values are used only by comparisons.  */
 287     enum precedence precedence;
 288
 289     /* For a binary operator:  1 iff right associate.
 290        For a unary operator:  1 iff postfix.  */
 291     int right_assoc;
 292   };
 293
 294 /* Information needed to print, prefixify, and evaluate expressions for
 295    a given language.  */
 296
 297 struct exp_descriptor
 298   {
 299     /* Print subexpression.  */
 300     void (*print_subexp) (struct expression *, int *, struct ui_file *,
 301                           enum precedence);
 302
 303     /* Returns number of exp_elements needed to represent an operator and
 304        the number of subexpressions it takes.  */
 305     void (*operator_length) (const struct expression*, int, int*, int *);
 306
 307     /* Call TYPE_FUNC and OBJFILE_FUNC for any TYPE and OBJFILE found being
 308        referenced by the single operator of EXP at position POS.  Operator
 309        parameters are located at positive (POS + number) offsets in EXP.
 310        The functions should never be called with NULL TYPE or NULL OBJFILE.
 311        Functions should get passed an arbitrary caller supplied DATA pointer.
 312        If any of the functions returns non-zero value then (any other) non-zero
 313        value should be immediately returned to the caller.  Otherwise zero
 314        should be returned.  */
 315     int (*operator_check) (struct expression *exp, int pos,
 316                            int (*objfile_func) (struct objfile *objfile,
 317                                                 void *data),
 318                            void *data);
 319
 320     /* Name of this operator for dumping purposes.  */
 321     char *(*op_name) (enum exp_opcode);
 322
 323     /* Dump the rest of this (prefix) expression after the operator
 324        itself has been printed.  See dump_subexp_body_standard in
 325        (expprint.c).  */
 326     int (*dump_subexp_body) (struct expression *, struct ui_file *, int);
 327
 328     /* Evaluate an expression.  */
 329     struct value *(*evaluate_exp) (struct type *, struct expression *,
 330                                    int *, enum noside);
 331   };
 332
 333
 334 /* Default descriptor containing standard definitions of all
 335    elements.  */
 336 extern const struct exp_descriptor exp_descriptor_standard;
 337
 338 /* Functions used by language-specific extended operators to (recursively)
 339    print/dump subexpressions.  */
 340
 341 extern void print_subexp (struct expression *, int *, struct ui_file *,
 342                           enum precedence);
 343
 344 extern void print_subexp_standard (struct expression *, int *,
 345                                    struct ui_file *, enum precedence);
 346
 347 /* Function used to avoid direct calls to fprintf
 348    in the code generated by the bison parser.  */
 349
 350 extern void parser_fprintf (FILE *, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 351
 352 extern int exp_uses_objfile (struct expression *exp, struct objfile *objfile);
 353
 354 #endif /* PARSER_DEFS_H */