gdb/expression.h

   1 /* Definitions for expressions stored in reversed prefix form, for GDB.
   2    Copyright 1986, 1989, 1992, 1994, 2000 Free Software Foundation, Inc.
   3
   4    This file is part of GDB.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place - Suite 330,
  19    Boston, MA 02111-1307, USA.  */
  20
  21 #if !defined (EXPRESSION_H)
  22 #define EXPRESSION_H 1
  23
  24
  25 #include "symtab.h"             /* Needed for "struct block" type. */
  26 #include "doublest.h"           /* Needed for DOUBLEST.  */
  27
  28
  29 /* Definitions for saved C expressions.  */
  30
  31 /* An expression is represented as a vector of union exp_element's.
  32    Each exp_element is an opcode, except that some opcodes cause
  33    the following exp_element to be treated as a long or double constant
  34    or as a variable.  The opcodes are obeyed, using a stack for temporaries.
  35    The value is left on the temporary stack at the end.  */
  36
  37 /* When it is necessary to include a string,
  38    it can occupy as many exp_elements as it needs.
  39    We find the length of the string using strlen,
  40    divide to find out how many exp_elements are used up,
  41    and skip that many.  Strings, like numbers, are indicated
  42    by the preceding opcode.  */
  43
  44 enum exp_opcode
  45   {
  46     /* Used when it's necessary to pass an opcode which will be ignored,
  47        or to catch uninitialized values.  */
  48     OP_NULL,
  49
  50 /* BINOP_... operate on two values computed by following subexpressions,
  51    replacing them by one result value.  They take no immediate arguments.  */
  52
  53     BINOP_ADD,                  /* + */
  54     BINOP_SUB,                  /* - */
  55     BINOP_MUL,                  /* * */
  56     BINOP_DIV,                  /* / */
  57     BINOP_REM,                  /* % */
  58     BINOP_MOD,                  /* mod (Knuth 1.2.4) */
  59     BINOP_LSH,                  /* << */
  60     BINOP_RSH,                  /* >> */
  61     BINOP_LOGICAL_AND,          /* && */
  62     BINOP_LOGICAL_OR,           /* || */
  63     BINOP_BITWISE_AND,          /* & */
  64     BINOP_BITWISE_IOR,          /* | */
  65     BINOP_BITWISE_XOR,          /* ^ */
  66     BINOP_EQUAL,                /* == */
  67     BINOP_NOTEQUAL,             /* != */
  68     BINOP_LESS,                 /* < */
  69     BINOP_GTR,                  /* > */
  70     BINOP_LEQ,                  /* <= */
  71     BINOP_GEQ,                  /* >= */
  72     BINOP_REPEAT,               /* @ */
  73     BINOP_ASSIGN,               /* = */
  74     BINOP_COMMA,                /* , */
  75     BINOP_SUBSCRIPT,            /* x[y] */
  76     BINOP_EXP,                  /* Exponentiation */
  77
  78     /* C++.  */
  79
  80     BINOP_MIN,                  /* <? */
  81     BINOP_MAX,                  /* >? */
  82
  83     /* STRUCTOP_MEMBER is used for pointer-to-member constructs.
  84        X . * Y translates into X STRUCTOP_MEMBER Y.  */
  85     STRUCTOP_MEMBER,
  86
  87     /* STRUCTOP_MPTR is used for pointer-to-member constructs
  88        when X is a pointer instead of an aggregate.  */
  89     STRUCTOP_MPTR,
  90
  91     /* end of C++.  */
  92
  93     /* For Modula-2 integer division DIV */
  94     BINOP_INTDIV,
  95
  96     BINOP_ASSIGN_MODIFY,        /* +=, -=, *=, and so on.
  97                                    The following exp_element is another opcode,
  98                                    a BINOP_, saying how to modify.
  99                                    Then comes another BINOP_ASSIGN_MODIFY,
 100                                    making three exp_elements in total.  */
 101
 102     /* Modula-2 standard (binary) procedures */
 103     BINOP_VAL,
 104     BINOP_INCL,
 105     BINOP_EXCL,
 106
 107     /* Concatenate two operands, such as character strings or bitstrings.
 108        If the first operand is a integer expression, then it means concatenate
 109        the second operand with itself that many times. */
 110     BINOP_CONCAT,
 111
 112     /* For (OBSOLETE) Chill (OBSOLETE) and Pascal. */
 113     BINOP_IN,                   /* Returns 1 iff ARG1 IN ARG2. */
 114
 115     /* This is the "colon operator" used various places in (OBSOLETE)
 116        Chill (OBSOLETE). */
 117     BINOP_RANGE,
 118
 119     /* This must be the highest BINOP_ value, for expprint.c.  */
 120     BINOP_END,
 121
 122     /* Operates on three values computed by following subexpressions.  */
 123     TERNOP_COND,                /* ?: */
 124
 125     /* A sub-string/sub-array.  (OBSOLETE) Chill (OBSOLETE) syntax:
 126        OP1(OP2:OP3).  Return elements OP2 through OP3 of OP1.  */
 127     TERNOP_SLICE,
 128
 129     /* A sub-string/sub-array.  (OBSOLETE) Chill (OBSOLETE) syntax:
 130        OP1(OP2 UP OP3).  Return OP3 elements of OP1, starting with
 131        element OP2. */
 132     TERNOP_SLICE_COUNT,
 133
 134     /* Multidimensional subscript operator, such as Modula-2 x[a,b,...].
 135        The dimensionality is encoded in the operator, like the number of
 136        function arguments in OP_FUNCALL, I.E. <OP><dimension><OP>.
 137        The value of the first following subexpression is subscripted
 138        by each of the next following subexpressions, one per dimension. */
 139     MULTI_SUBSCRIPT,
 140
 141     /* The OP_... series take immediate following arguments.
 142        After the arguments come another OP_... (the same one)
 143        so that the grouping can be recognized from the end.  */
 144
 145     /* OP_LONG is followed by a type pointer in the next exp_element
 146        and the long constant value in the following exp_element.
 147        Then comes another OP_LONG.
 148        Thus, the operation occupies four exp_elements.  */
 149     OP_LONG,
 150
 151     /* OP_DOUBLE is similar but takes a DOUBLEST constant instead of a long.  */
 152     OP_DOUBLE,
 153
 154     /* OP_VAR_VALUE takes one struct block * in the following element,
 155        and one struct symbol * in the following exp_element, followed by
 156        another OP_VAR_VALUE, making four exp_elements.  If the block is
 157        non-NULL, evaluate the symbol relative to the innermost frame
 158        executing in that block; if the block is NULL use the selected frame.  */
 159     OP_VAR_VALUE,
 160
 161     /* OP_LAST is followed by an integer in the next exp_element.
 162        The integer is zero for the last value printed,
 163        or it is the absolute number of a history element.
 164        With another OP_LAST at the end, this makes three exp_elements.  */
 165     OP_LAST,
 166
 167     /* OP_REGISTER is followed by an integer in the next exp_element.
 168        This is the number of a register to fetch (as an int).
 169        With another OP_REGISTER at the end, this makes three exp_elements.  */
 170     OP_REGISTER,
 171
 172     /* OP_INTERNALVAR is followed by an internalvar ptr in the next exp_element.
 173        With another OP_INTERNALVAR at the end, this makes three exp_elements.  */
 174     OP_INTERNALVAR,
 175
 176     /* OP_FUNCALL is followed by an integer in the next exp_element.
 177        The integer is the number of args to the function call.
 178        That many plus one values from following subexpressions
 179        are used, the first one being the function.
 180        The integer is followed by a repeat of OP_FUNCALL,
 181        making three exp_elements.  */
 182     OP_FUNCALL,
 183
 184     /* OP_OBJC_MSGCALL is followed by a string in the next exp_element and then an
 185        integer.  The string is the selector string.  The integer is the number
 186        of arguments to the message call.  That many plus one values are used,
 187        the first one being the object pointer.  This is an Objective C message */
 188     OP_OBJC_MSGCALL,
 189
 190     /* This is EXACTLY like OP_FUNCALL but is semantically different.
 191        In F77, array subscript expressions, substring expressions
 192        and function calls are  all exactly the same syntactically. They may
 193        only be dismabiguated at runtime.  Thus this operator, which
 194        indicates that we have found something of the form <name> ( <stuff> ) */
 195     OP_F77_UNDETERMINED_ARGLIST,
 196
 197     /* The following OP is a special one, it introduces a F77 complex
 198        literal. It is followed by exactly two args that are doubles.  */
 199     OP_COMPLEX,
 200
 201     /* OP_STRING represents a string constant.
 202        Its format is the same as that of a STRUCTOP, but the string
 203        data is just made into a string constant when the operation
 204        is executed.  */
 205     OP_STRING,
 206
 207     /* OP_BITSTRING represents a packed bitstring constant.
 208        Its format is the same as that of a STRUCTOP, but the bitstring
 209        data is just made into a bitstring constant when the operation
 210        is executed.  */
 211     OP_BITSTRING,
 212
 213     /* OP_ARRAY creates an array constant out of the following subexpressions.
 214        It is followed by two exp_elements, the first containing an integer
 215        that is the lower bound of the array and the second containing another
 216        integer that is the upper bound of the array.  The second integer is
 217        followed by a repeat of OP_ARRAY, making four exp_elements total.
 218        The bounds are used to compute the number of following subexpressions
 219        to consume, as well as setting the bounds in the created array constant.
 220        The type of the elements is taken from the type of the first subexp,
 221        and they must all match. */
 222     OP_ARRAY,
 223
 224     /* UNOP_CAST is followed by a type pointer in the next exp_element.
 225        With another UNOP_CAST at the end, this makes three exp_elements.
 226        It casts the value of the following subexpression.  */
 227     UNOP_CAST,
 228
 229     /* UNOP_MEMVAL is followed by a type pointer in the next exp_element
 230        With another UNOP_MEMVAL at the end, this makes three exp_elements.
 231        It casts the contents of the word addressed by the value of the
 232        following subexpression.  */
 233     UNOP_MEMVAL,
 234
 235     /* UNOP_... operate on one value from a following subexpression
 236        and replace it with a result.  They take no immediate arguments.  */
 237
 238     UNOP_NEG,                   /* Unary - */
 239     UNOP_LOGICAL_NOT,           /* Unary ! */
 240     UNOP_COMPLEMENT,            /* Unary ~ */
 241     UNOP_IND,                   /* Unary * */
 242     UNOP_ADDR,                  /* Unary & */
 243     UNOP_PREINCREMENT,          /* ++ before an expression */
 244     UNOP_POSTINCREMENT,         /* ++ after an expression */
 245     UNOP_PREDECREMENT,          /* -- before an expression */
 246     UNOP_POSTDECREMENT,         /* -- after an expression */
 247     UNOP_SIZEOF,                /* Unary sizeof (followed by expression) */
 248
 249     UNOP_PLUS,                  /* Unary plus */
 250
 251     UNOP_CAP,                   /* Modula-2 standard (unary) procedures */
 252     UNOP_CHR,
 253     UNOP_ORD,
 254     UNOP_ABS,
 255     UNOP_FLOAT,
 256     UNOP_HIGH,
 257     UNOP_MAX,
 258     UNOP_MIN,
 259     UNOP_ODD,
 260     UNOP_TRUNC,
 261
 262     /* (OBSOLETE) Chill (OBSOLETE) builtin functions. */
 263     UNOP_LOWER, UNOP_UPPER, UNOP_LENGTH, UNOP_CARD, UNOP_CHMAX, UNOP_CHMIN,
 264
 265     OP_BOOL,                    /* Modula-2 builtin BOOLEAN type */
 266     OP_M2_STRING,               /* Modula-2 string constants */
 267
 268     /* STRUCTOP_... operate on a value from a following subexpression
 269        by extracting a structure component specified by a string
 270        that appears in the following exp_elements (as many as needed).
 271        STRUCTOP_STRUCT is used for "." and STRUCTOP_PTR for "->".
 272        They differ only in the error message given in case the value is
 273        not suitable or the structure component specified is not found.
 274
 275        The length of the string follows the opcode, followed by
 276        BYTES_TO_EXP_ELEM(length) elements containing the data of the
 277        string, followed by the length again and the opcode again.  */
 278
 279     STRUCTOP_STRUCT,
 280     STRUCTOP_PTR,
 281
 282     /* C++: OP_THIS is just a placeholder for the class instance variable.
 283        It just comes in a tight (OP_THIS, OP_THIS) pair.  */
 284     OP_THIS,
 285
 286     /* Objective-C: OP_OBJC_SELF is just a placeholder for the class instance
 287        variable.  It just comes in a tight (OP_OBJC_SELF, OP_OBJC_SELF) pair.  */
 288     OP_OBJC_SELF,
 289
 290     /* Objective C: "@selector" pseudo-operator */
 291     OP_OBJC_SELECTOR,
 292
 293     /* OP_SCOPE surrounds a type name and a field name.  The type
 294        name is encoded as one element, but the field name stays as
 295        a string, which, of course, is variable length.  */
 296     OP_SCOPE,
 297
 298     /* Used to represent named structure field values in brace
 299        initializers (or tuples as they are called in (OBSOLETE) Chill
 300        (OBSOLETE)).
 301
 302        The gcc C syntax is NAME:VALUE or .NAME=VALUE, the (OBSOLETE)
 303        Chill (OBSOLETE) syntax is .NAME:VALUE.  Multiple labels (as in
 304        the (OBSOLETE) Chill (OBSOLETE) syntax .NAME1,.NAME2:VALUE) is
 305        represented as if it were .NAME1:(.NAME2:VALUE) (though that is
 306        not valid (OBSOLETE) Chill (OBSOLETE) syntax).
 307
 308        The NAME is represented as for STRUCTOP_STRUCT;  VALUE follows. */
 309     OP_LABELED,
 310
 311     /* OP_TYPE is for parsing types, and used with the "ptype" command
 312        so we can look up types that are qualified by scope, either with
 313        the GDB "::" operator, or the Modula-2 '.' operator. */
 314     OP_TYPE,
 315
 316     /* An un-looked-up identifier. */
 317     OP_NAME,
 318
 319     /* An unparsed expression.  Used for Scheme (for now at least) */
 320     OP_EXPRSTRING,
 321
 322     /* An Objective C Foundation Class NSString constant */
 323     OP_OBJC_NSSTRING,
 324   };
 325
 326 union exp_element
 327   {
 328     enum exp_opcode opcode;
 329     struct symbol *symbol;
 330     LONGEST longconst;
 331     DOUBLEST doubleconst;
 332     /* Really sizeof (union exp_element) characters (or less for the last
 333        element of a string).  */
 334     char string;
 335     struct type *type;
 336     struct internalvar *internalvar;
 337     struct block *block;
 338   };
 339
 340 struct expression
 341   {
 342     const struct language_defn *language_defn;  /* language it was entered in */
 343     int nelts;
 344     union exp_element elts[1];
 345   };
 346
 347 /* Macros for converting between number of expression elements and bytes
 348    to store that many expression elements. */
 349
 350 #define EXP_ELEM_TO_BYTES(elements) \
 351     ((elements) * sizeof (union exp_element))
 352 #define BYTES_TO_EXP_ELEM(bytes) \
 353     (((bytes) + sizeof (union exp_element) - 1) / sizeof (union exp_element))
 354
 355 /* From parse.c */
 356
 357 extern struct expression *parse_expression (char *);
 358
 359 extern struct expression *parse_exp_1 (char **, struct block *, int);
 360
 361 /* The innermost context required by the stack and register variables
 362    we've encountered so far.  To use this, set it to NULL, then call
 363    parse_<whatever>, then look at it.  */
 364 extern struct block *innermost_block;
 365
 366 /* From eval.c */
 367
 368 /* Values of NOSIDE argument to eval_subexp.  */
 369
 370 enum noside
 371   {
 372     EVAL_NORMAL,
 373     EVAL_SKIP,                  /* Only effect is to increment pos.  */
 374     EVAL_AVOID_SIDE_EFFECTS     /* Don't modify any variables or
 375                                    call any functions.  The value
 376                                    returned will have the correct
 377                                    type, and will have an
 378                                    approximately correct lvalue
 379                                    type (inaccuracy: anything that is
 380                                    listed as being in a register in
 381                                    the function in which it was
 382                                    declared will be lval_register).  */
 383   };
 384
 385 extern struct value *evaluate_subexp_standard
 386   (struct type *, struct expression *, int *, enum noside);
 387
 388 /* From expprint.c */
 389
 390 extern void print_expression (struct expression *, struct ui_file *);
 391
 392 extern char *op_string (enum exp_opcode);
 393
 394 extern void dump_prefix_expression (struct expression *,
 395                                     struct ui_file *,
 396                                     char *);
 397 extern void dump_postfix_expression (struct expression *,
 398                                      struct ui_file *,
 399                                      char *);
 400
 401 #endif /* !defined (EXPRESSION_H) */