contrib/gdb-7/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 extern union type_stack_elt *type_stack;
 131 extern int type_stack_depth, type_stack_size;
 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 (const struct expression *, int, int *, int *);
 189
 190 extern void operator_length_standard (const struct expression *, int, int *,
 191                                       int *);
 192
 193 extern int operator_check_standard (struct expression *exp, int pos,
 194                                     int (*objfile_func)
 195                                       (struct objfile *objfile, void *data),
 196                                     void *data);
 197
 198 extern char *op_name_standard (enum exp_opcode);
 199
 200 extern struct type *follow_types (struct type *);
 201
 202 extern void null_post_parser (struct expression **, int);
 203
 204 extern int parse_float (const char *p, int len, DOUBLEST *d,
 205                         const char **suffix);
 206
 207 extern int parse_c_float (struct gdbarch *gdbarch, const char *p, int len,
 208                           DOUBLEST *d, struct type **t);
 209
 210 /* During parsing of a C expression, the pointer to the next character
 211    is in this variable.  */
 212
 213 extern char *lexptr;
 214
 215 /* After a token has been recognized, this variable points to it.
 216    Currently used only for error reporting.  */
 217 extern char *prev_lexptr;
 218
 219 /* Tokens that refer to names do so with explicit pointer and length,
 220    so they can share the storage that lexptr is parsing.
 221
 222    When it is necessary to pass a name to a function that expects
 223    a null-terminated string, the substring is copied out
 224    into a block of storage that namecopy points to.
 225
 226    namecopy is allocated once, guaranteed big enough, for each parsing.  */
 227
 228 extern char *namecopy;
 229
 230 /* Current depth in parentheses within the expression.  */
 231
 232 extern int paren_depth;
 233
 234 /* Nonzero means stop parsing on first comma (if not within parentheses).  */
 235
 236 extern int comma_terminates;
 237 \f
 238 /* These codes indicate operator precedences for expression printing,
 239    least tightly binding first.  */
 240 /* Adding 1 to a precedence value is done for binary operators,
 241    on the operand which is more tightly bound, so that operators
 242    of equal precedence within that operand will get parentheses.  */
 243 /* PREC_HYPER and PREC_ABOVE_COMMA are not the precedence of any operator;
 244    they are used as the "surrounding precedence" to force
 245    various kinds of things to be parenthesized.  */
 246 enum precedence
 247   {
 248     PREC_NULL, PREC_COMMA, PREC_ABOVE_COMMA, PREC_ASSIGN, PREC_LOGICAL_OR,
 249     PREC_LOGICAL_AND, PREC_BITWISE_IOR, PREC_BITWISE_AND, PREC_BITWISE_XOR,
 250     PREC_EQUAL, PREC_ORDER, PREC_SHIFT, PREC_ADD, PREC_MUL, PREC_REPEAT,
 251     PREC_HYPER, PREC_PREFIX, PREC_SUFFIX, PREC_BUILTIN_FUNCTION
 252   };
 253
 254 /* Table mapping opcodes into strings for printing operators
 255    and precedences of the operators.  */
 256
 257 struct op_print
 258   {
 259     char *string;
 260     enum exp_opcode opcode;
 261     /* Precedence of operator.  These values are used only by comparisons.  */
 262     enum precedence precedence;
 263
 264     /* For a binary operator:  1 iff right associate.
 265        For a unary operator:  1 iff postfix.  */
 266     int right_assoc;
 267   };
 268
 269 /* Information needed to print, prefixify, and evaluate expressions for
 270    a given language.  */
 271
 272 struct exp_descriptor
 273   {
 274     /* Print subexpression.  */
 275     void (*print_subexp) (struct expression *, int *, struct ui_file *,
 276                           enum precedence);
 277
 278     /* Returns number of exp_elements needed to represent an operator and
 279        the number of subexpressions it takes.  */
 280     void (*operator_length) (const struct expression*, int, int*, int *);
 281
 282     /* Call TYPE_FUNC and OBJFILE_FUNC for any TYPE and OBJFILE found being
 283        referenced by the single operator of EXP at position POS.  Operator
 284        parameters are located at positive (POS + number) offsets in EXP.
 285        The functions should never be called with NULL TYPE or NULL OBJFILE.
 286        Functions should get passed an arbitrary caller supplied DATA pointer.
 287        If any of the functions returns non-zero value then (any other) non-zero
 288        value should be immediately returned to the caller.  Otherwise zero
 289        should be returned.  */
 290     int (*operator_check) (struct expression *exp, int pos,
 291                            int (*objfile_func) (struct objfile *objfile,
 292                                                 void *data),
 293                            void *data);
 294
 295     /* Name of this operator for dumping purposes.  */
 296     char *(*op_name) (enum exp_opcode);
 297
 298     /* Dump the rest of this (prefix) expression after the operator
 299        itself has been printed.  See dump_subexp_body_standard in
 300        (expprint.c).  */
 301     int (*dump_subexp_body) (struct expression *, struct ui_file *, int);
 302
 303     /* Evaluate an expression.  */
 304     struct value *(*evaluate_exp) (struct type *, struct expression *,
 305                                    int *, enum noside);
 306   };
 307
 308
 309 /* Default descriptor containing standard definitions of all
 310    elements.  */
 311 extern const struct exp_descriptor exp_descriptor_standard;
 312
 313 /* Functions used by language-specific extended operators to (recursively)
 314    print/dump subexpressions.  */
 315
 316 extern void print_subexp (struct expression *, int *, struct ui_file *,
 317                           enum precedence);
 318
 319 extern void print_subexp_standard (struct expression *, int *,
 320                                    struct ui_file *, enum precedence);
 321
 322 /* Function used to avoid direct calls to fprintf
 323    in the code generated by the bison parser.  */
 324
 325 extern void parser_fprintf (FILE *, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
 326
 327 extern int exp_uses_objfile (struct expression *exp, struct objfile *objfile);
 328
 329 #endif /* PARSER_DEFS_H */