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, 2011
   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 int parser_debug;
  33
  34 extern struct expression *expout;
  35 extern int expout_size;
  36 extern int expout_ptr;
  37
  38 #define parse_gdbarch (expout->gdbarch)
  39 #define parse_language (expout->language_defn)
  40
  41 /* If this is nonzero, this block is used as the lexical context
  42    for symbol names.  */
  43
  44 extern struct block *expression_context_block;
  45
  46 /* If expression_context_block is non-zero, then this is the PC within
  47    the block that we want to evaluate expressions at.  When debugging
  48    C or C++ code, we use this to find the exact line we're at, and
  49    then look up the macro definitions active at that point.  */
  50 extern CORE_ADDR expression_context_pc;
  51
  52 /* The innermost context required by the stack and register variables
  53    we've encountered so far.  */
  54 extern struct block *innermost_block;
  55
  56 /* The block in which the most recently discovered symbol was found.
  57    FIXME: Should be declared along with lookup_symbol in symtab.h; is not
  58    related specifically to parsing.  */
  59 extern struct block *block_found;
  60
  61 /* Number of arguments seen so far in innermost function call.  */
  62 extern int arglist_len;
  63
  64 /* A string token, either a char-string or bit-string.  Char-strings are
  65    used, for example, for the names of symbols.  */
  66
  67 struct stoken
  68   {
  69     /* Pointer to first byte of char-string or first bit of bit-string.  */
  70     char *ptr;
  71     /* Length of string in bytes for char-string or bits for bit-string.  */
  72     int length;
  73   };
  74
  75 struct typed_stoken
  76   {
  77     /* A language-specific type field.  */
  78     int type;
  79     /* Pointer to first byte of char-string or first bit of bit-string.  */
  80     char *ptr;
  81     /* Length of string in bytes for char-string or bits for bit-string.  */
  82     int length;
  83   };
  84
  85 struct stoken_vector
  86   {
  87     int len;
  88     struct typed_stoken *tokens;
  89   };
  90
  91 struct ttype
  92   {
  93     struct stoken stoken;
  94     struct type *type;
  95   };
  96
  97 struct symtoken
  98   {
  99     struct stoken stoken;
 100     struct symbol *sym;
 101     int is_a_field_of_this;
 102   };
 103
 104 struct objc_class_str
 105   {
 106     struct stoken stoken;
 107     struct type *type;
 108     int class;
 109   };
 110
 111
 112 /* For parsing of complicated types.
 113    An array should be preceded in the list by the size of the array.  */
 114 enum type_pieces
 115   {
 116     tp_end = -1,
 117     tp_pointer,
 118     tp_reference,
 119     tp_array,
 120     tp_function,
 121     tp_const,
 122     tp_volatile,
 123     tp_space_identifier
 124   };
 125 /* The stack can contain either an enum type_pieces or an int.  */
 126 union type_stack_elt
 127   {
 128     enum type_pieces piece;
 129     int int_val;
 130   };
 131 extern union type_stack_elt *type_stack;
 132 extern int type_stack_depth, type_stack_size;
 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 (const struct expression *, int, int *, int *);
 190
 191 extern void operator_length_standard (const struct expression *, int, int *,
 192                                       int *);
 193
 194 extern int operator_check_standard (struct expression *exp, int pos,
 195                                     int (*objfile_func)
 196                                       (struct objfile *objfile, void *data),
 197                                     void *data);
 198
 199 extern char *op_name_standard (enum exp_opcode);
 200
 201 extern struct type *follow_types (struct type *);
 202
 203 extern void null_post_parser (struct expression **, int);
 204
 205 extern int parse_float (const char *p, int len, DOUBLEST *d,
 206                         const char **suffix);
 207
 208 extern int parse_c_float (struct gdbarch *gdbarch, const char *p, int len,
 209                           DOUBLEST *d, struct type **t);
 210
 211 /* During parsing of a C expression, the pointer to the next character
 212    is in this variable.  */
 213
 214 extern char *lexptr;
 215
 216 /* After a token has been recognized, this variable points to it.
 217    Currently used only for error reporting.  */
 218 extern char *prev_lexptr;
 219
 220 /* Tokens that refer to names do so with explicit pointer and length,
 221    so they can share the storage that lexptr is parsing.
 222
 223    When it is necessary to pass a name to a function that expects
 224    a null-terminated string, the substring is copied out
 225    into a block of storage that namecopy points to.
 226
 227    namecopy is allocated once, guaranteed big enough, for each parsing.  */
 228
 229 extern char *namecopy;
 230
 231 /* Current depth in parentheses within the expression.  */
 232
 233 extern int paren_depth;
 234
 235 /* Nonzero means stop parsing on first comma (if not within parentheses).  */
 236
 237 extern int comma_terminates;
 238 \f
 239 /* These codes indicate operator precedences for expression printing,
 240    least tightly binding first.  */
 241 /* Adding 1 to a precedence value is done for binary operators,
 242    on the operand which is more tightly bound, so that operators
 243    of equal precedence within that operand will get parentheses.  */
 244 /* PREC_HYPER and PREC_ABOVE_COMMA are not the precedence of any operator;
 245    they are used as the "surrounding precedence" to force
 246    various kinds of things to be parenthesized.  */
 247 enum precedence
 248   {
 249     PREC_NULL, PREC_COMMA, PREC_ABOVE_COMMA, PREC_ASSIGN, PREC_LOGICAL_OR,
 250     PREC_LOGICAL_AND, PREC_BITWISE_IOR, PREC_BITWISE_AND, PREC_BITWISE_XOR,
 251     PREC_EQUAL, PREC_ORDER, PREC_SHIFT, PREC_ADD, PREC_MUL, PREC_REPEAT,
 252     PREC_HYPER, PREC_PREFIX, PREC_SUFFIX, PREC_BUILTIN_FUNCTION
 253   };
 254
 255 /* Table mapping opcodes into strings for printing operators
 256    and precedences of the operators.  */
 257
 258 struct op_print
 259   {
 260     char *string;
 261     enum exp_opcode opcode;
 262     /* Precedence of operator.  These values are used only by comparisons.  */
 263     enum precedence precedence;
 264
 265     /* For a binary operator:  1 iff right associate.
 266        For a unary operator:  1 iff postfix.  */
 267     int right_assoc;
 268   };
 269
 270 /* Information needed to print, prefixify, and evaluate expressions for
 271    a given language.  */
 272
 273 struct exp_descriptor
 274   {
 275     /* Print subexpression.  */
 276     void (*print_subexp) (struct expression *, int *, struct ui_file *,
 277                           enum precedence);
 278
 279     /* Returns number of exp_elements needed to represent an operator and
 280        the number of subexpressions it takes.  */
 281     void (*operator_length) (const struct expression*, int, int*, int *);
 282
 283     /* Call TYPE_FUNC and OBJFILE_FUNC for any TYPE and OBJFILE found being
 284        referenced by the single operator of EXP at position POS.  Operator
 285        parameters are located at positive (POS + number) offsets in EXP.
 286        The functions should never be called with NULL TYPE or NULL OBJFILE.
 287        Functions should get passed an arbitrary caller supplied DATA pointer.
 288        If any of the functions returns non-zero value then (any other) non-zero
 289        value should be immediately returned to the caller.  Otherwise zero
 290        should be returned.  */
 291     int (*operator_check) (struct expression *exp, int pos,
 292                            int (*objfile_func) (struct objfile *objfile,
 293                                                 void *data),
 294                            void *data);
 295
 296     /* Name of this operator for dumping purposes.  */
 297     char *(*op_name) (enum exp_opcode);
 298
 299     /* Dump the rest of this (prefix) expression after the operator
 300        itself has been printed.  See dump_subexp_body_standard in
 301        (expprint.c).  */
 302     int (*dump_subexp_body) (struct expression *, struct ui_file *, int);
 303
 304     /* Evaluate an expression.  */
 305     struct value *(*evaluate_exp) (struct type *, struct expression *,
 306                                    int *, enum noside);
 307   };
 308
 309
 310 /* Default descriptor containing standard definitions of all
 311    elements.  */
 312 extern const struct exp_descriptor exp_descriptor_standard;
 313
 314 /* Functions used by language-specific extended operators to (recursively)
 315    print/dump subexpressions.  */
 316
 317 extern void print_subexp (struct expression *, int *, struct ui_file *,
 318                           enum precedence);
 319
 320 extern void print_subexp_standard (struct expression *, int *,
 321                                    struct ui_file *, enum precedence);
 322
 323 /* Function used to avoid direct calls to fprintf
 324    in the code generated by the bison parser.  */
 325
 326 extern void parser_fprintf (FILE *, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 327
 328 extern int exp_uses_objfile (struct expression *exp, struct objfile *objfile);
 329
 330 #endif /* PARSER_DEFS_H */