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