gdb: add target_ops::supports_displaced_step
[deliverable/binutils-gdb.git] / gdb / expression.h
index 6a166dbe796ac4dccd35ae225da610ee0d02b95b..f1128c442483a742c1fdcee6772e6018df75adee 100644 (file)
@@ -1,28 +1,44 @@
 /* Definitions for expressions stored in reversed prefix form, for GDB.
-   Copyright 1986, 1989, 1992, 1994 Free Software Foundation, Inc.
 
-This file is part of GDB.
+   Copyright (C) 1986-2020 Free Software Foundation, Inc.
 
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
+   This file is part of GDB.
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
 
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #if !defined (EXPRESSION_H)
 #define EXPRESSION_H 1
 
-#ifdef __STDC__
-struct block;  /* Forward declaration for prototypes */
-#endif
+#include "gdbtypes.h"
+
+/* While parsing expressions we need to track the innermost lexical block
+   that we encounter.  In some situations we need to track the innermost
+   block just for symbols, and in other situations we want to track the
+   innermost block for symbols and registers.  These flags are used by the
+   innermost block tracker to control which blocks we consider for the
+   innermost block.  These flags can be combined together as needed.  */
+
+enum innermost_block_tracker_type
+{
+  /* Track the innermost block for symbols within an expression.  */
+  INNERMOST_BLOCK_FOR_SYMBOLS = (1 << 0),
+
+  /* Track the innermost block for registers within an expression.  */
+  INNERMOST_BLOCK_FOR_REGISTERS = (1 << 1)
+};
+DEF_ENUM_FLAGS_TYPE (enum innermost_block_tracker_type,
+                    innermost_block_tracker_types);
 
 /* Definitions for saved C expressions.  */
 
@@ -39,292 +55,56 @@ struct block;      /* Forward declaration for prototypes */
    and skip that many.  Strings, like numbers, are indicated
    by the preceding opcode.  */
 
-enum exp_opcode
-{
-  /* Used when it's necessary to pass an opcode which will be ignored,
-     or to catch uninitialized values.  */
-  OP_NULL,
-
-/* BINOP_... operate on two values computed by following subexpressions,
-   replacing them by one result value.  They take no immediate arguments.  */
-
-  BINOP_ADD,           /* + */
-  BINOP_SUB,           /* - */
-  BINOP_MUL,           /* * */
-  BINOP_DIV,           /* / */
-  BINOP_REM,           /* % */
-  BINOP_MOD,           /* mod (Knuth 1.2.4) */
-  BINOP_LSH,           /* << */
-  BINOP_RSH,           /* >> */
-  BINOP_LOGICAL_AND,   /* && */
-  BINOP_LOGICAL_OR,    /* || */
-  BINOP_BITWISE_AND,   /* & */
-  BINOP_BITWISE_IOR,   /* | */
-  BINOP_BITWISE_XOR,   /* ^ */
-  BINOP_EQUAL,         /* == */
-  BINOP_NOTEQUAL,      /* != */
-  BINOP_LESS,          /* < */
-  BINOP_GTR,           /* > */
-  BINOP_LEQ,           /* <= */
-  BINOP_GEQ,           /* >= */
-  BINOP_REPEAT,                /* @ */
-  BINOP_ASSIGN,                /* = */
-  BINOP_COMMA,         /* , */
-  BINOP_SUBSCRIPT,     /* x[y] */
-  BINOP_EXP,           /* Exponentiation */
-
-  /* C++.  */
-
-  BINOP_MIN,           /* <? */
-  BINOP_MAX,           /* >? */
-  BINOP_SCOPE,         /* :: */
-
-  /* STRUCTOP_MEMBER is used for pointer-to-member constructs.
-     X . * Y translates into X STRUCTOP_MEMBER Y.  */
-  STRUCTOP_MEMBER,
-
-  /* STRUCTOP_MPTR is used for pointer-to-member constructs
-     when X is a pointer instead of an aggregate.  */
-  STRUCTOP_MPTR,
-
-  /* end of C++.  */
-
-  /* For Modula-2 integer division DIV */
-  BINOP_INTDIV,
-
-  BINOP_ASSIGN_MODIFY, /* +=, -=, *=, and so on.
-                          The following exp_element is another opcode,
-                          a BINOP_, saying how to modify.
-                          Then comes another BINOP_ASSIGN_MODIFY,
-                          making three exp_elements in total.  */
-
-  /* Modula-2 standard (binary) procedures */
-  BINOP_VAL,
-  BINOP_INCL,
-  BINOP_EXCL,
-
-  /* Concatenate two operands, such as character strings or bitstrings.
-     If the first operand is a integer expression, then it means concatenate
-     the second operand with itself that many times. */
-  BINOP_CONCAT,
-
-  /* For Chill and Pascal. */
-  BINOP_IN, /* Returns 1 iff ARG1 IN ARG2. */
-
-  /* This must be the highest BINOP_ value, for expprint.c.  */
-  BINOP_END,
-
-  /* Operates on three values computed by following subexpressions.  */
-  TERNOP_COND,         /* ?: */
-
-  /* A sub-string/sub-array.  Chill syntax:  OP1(OP2:OP3).
-     Return elements OP2 through OP3 of OP1.  */
-  TERNOP_SLICE,
-
-  /* A sub-string/sub-array.  Chill syntax:  OP1(OP2 UP OP3).
-     Return OP3 elements of OP1, starting with element OP2. */
-  TERNOP_SLICE_COUNT,
-
-  /* Multidimensional subscript operator, such as Modula-2 x[a,b,...].
-     The dimensionality is encoded in the operator, like the number of
-     function arguments in OP_FUNCALL, I.E. <OP><dimension><OP>.
-     The value of the first following subexpression is subscripted
-     by each of the next following subexpressions, one per dimension. */
-   MULTI_SUBSCRIPT,
-
-  /* For Fortran array subscripting (column major style). Like the 
-     Modula operator, we find that the dimensionality is 
-     encoded in the operator.  This operator is distinct 
-     from the above one because it uses column-major array 
-     ordering not row-major.  */ 
-  MULTI_F77_SUBSCRIPT,
-
-  /* The OP_... series take immediate following arguments.
-     After the arguments come another OP_... (the same one)
-     so that the grouping can be recognized from the end.  */
-
-  /* OP_LONG is followed by a type pointer in the next exp_element
-     and the long constant value in the following exp_element.
-     Then comes another OP_LONG.
-     Thus, the operation occupies four exp_elements.  */
-  OP_LONG,
-
-  /* OP_DOUBLE is similar but takes a double constant instead of a long.  */
-  OP_DOUBLE,
-
-  /* OP_VAR_VALUE takes one struct block * in the following element,
-     and one struct symbol * in the following exp_element, followed by
-     another OP_VAR_VALUE, making four exp_elements.  If the block is
-     non-NULL, evaluate the symbol relative to the innermost frame
-     executing in that block; if the block is NULL use the selected frame.  */
-  OP_VAR_VALUE,
-
-  /* OP_LAST is followed by an integer in the next exp_element.
-     The integer is zero for the last value printed,
-     or it is the absolute number of a history element.
-     With another OP_LAST at the end, this makes three exp_elements.  */
-  OP_LAST,
-
-  /* OP_REGISTER is followed by an integer in the next exp_element.
-     This is the number of a register to fetch (as an int).
-     With another OP_REGISTER at the end, this makes three exp_elements.  */
-  OP_REGISTER,
-
-  /* OP_INTERNALVAR is followed by an internalvar ptr in the next exp_element.
-     With another OP_INTERNALVAR at the end, this makes three exp_elements.  */
-  OP_INTERNALVAR,
-
-  /* OP_FUNCALL is followed by an integer in the next exp_element.
-     The integer is the number of args to the function call.
-     That many plus one values from following subexpressions
-     are used, the first one being the function.
-     The integer is followed by a repeat of OP_FUNCALL,
-     making three exp_elements.  */
-  OP_FUNCALL,
-
-  /* This is EXACTLY like OP_FUNCALL but is semantically different.  
-     In F77, array subscript expressions, substring expressions
-     and function calls are  all exactly the same syntactically. They may 
-     only be dismabiguated at runtime.  Thus this operator, which 
-     indicates that we have found something of the form <name> ( <stuff> ) */ 
-  OP_F77_UNDETERMINED_ARGLIST,
-  
-  /* The following OP is a special one, it introduces a F77 complex
-     literal. It is followed by exactly two args that are doubles.  */ 
-  OP_COMPLEX,
-
-  /* The following OP introduces a F77 substring operator.
-     It should have a string type and two integer types that follow 
-     indicating the "from" and "to" for the substring. */ 
-  OP_F77_SUBSTR,
-
-  /* OP_STRING represents a string constant.
-     Its format is the same as that of a STRUCTOP, but the string
-     data is just made into a string constant when the operation
-     is executed.  */
-  OP_STRING,
-
-  /* OP_BITSTRING represents a packed bitstring constant.
-     Its format is the same as that of a STRUCTOP, but the bitstring
-     data is just made into a bitstring constant when the operation
-     is executed.  */
-  OP_BITSTRING,
-
-  /* OP_ARRAY creates an array constant out of the following subexpressions.
-     It is followed by two exp_elements, the first containing an integer
-     that is the lower bound of the array and the second containing another
-     integer that is the upper bound of the array.  The second integer is
-     followed by a repeat of OP_ARRAY, making four exp_elements total.
-     The bounds are used to compute the number of following subexpressions
-     to consume, as well as setting the bounds in the created array constant.
-     The type of the elements is taken from the type of the first subexp,
-     and they must all match. */
-  OP_ARRAY,
-
-  /* UNOP_CAST is followed by a type pointer in the next exp_element.
-     With another UNOP_CAST at the end, this makes three exp_elements.
-     It casts the value of the following subexpression.  */
-  UNOP_CAST,
-
-  /* UNOP_MEMVAL is followed by a type pointer in the next exp_element
-     With another UNOP_MEMVAL at the end, this makes three exp_elements.
-     It casts the contents of the word addressed by the value of the
-     following subexpression.  */
-  UNOP_MEMVAL,
-
-  /* UNOP_... operate on one value from a following subexpression
-     and replace it with a result.  They take no immediate arguments.  */
-
-  UNOP_NEG,            /* Unary - */
-  UNOP_LOGICAL_NOT,    /* Unary ! */
-  UNOP_COMPLEMENT,     /* Unary ~ */
-  UNOP_IND,            /* Unary * */
-  UNOP_ADDR,           /* Unary & */
-  UNOP_PREINCREMENT,   /* ++ before an expression */
-  UNOP_POSTINCREMENT,  /* ++ after an expression */
-  UNOP_PREDECREMENT,   /* -- before an expression */
-  UNOP_POSTDECREMENT,  /* -- after an expression */
-  UNOP_SIZEOF,         /* Unary sizeof (followed by expression) */
-
-  UNOP_PLUS,           /* Unary plus */
-
-  UNOP_CAP,            /* Modula-2 standard (unary) procedures */
-  UNOP_CHR,
-  UNOP_ORD,
-  UNOP_ABS,
-  UNOP_FLOAT,
-  UNOP_HIGH,
-  UNOP_MAX,
-  UNOP_MIN,
-  UNOP_ODD,
-  UNOP_TRUNC,
-
-  OP_BOOL,             /* Modula-2 builtin BOOLEAN type */
-  OP_M2_STRING,                /* Modula-2 string constants */
-
-  /* STRUCTOP_... operate on a value from a following subexpression
-     by extracting a structure component specified by a string
-     that appears in the following exp_elements (as many as needed).
-     STRUCTOP_STRUCT is used for "." and STRUCTOP_PTR for "->".
-     They differ only in the error message given in case the value is
-     not suitable or the structure component specified is not found.
-
-     The length of the string follows the opcode, followed by
-     BYTES_TO_EXP_ELEM(length) elements containing the data of the
-     string, followed by the length again and the opcode again.  */
-
-  STRUCTOP_STRUCT,
-  STRUCTOP_PTR,
-
-  /* C++ */
-  /* OP_THIS is just a placeholder for the class instance variable.
-     It just comes in a tight (OP_THIS, OP_THIS) pair.  */
-  OP_THIS,
-
-  /* OP_SCOPE surrounds a type name and a field name.  The type
-     name is encoded as one element, but the field name stays as
-     a string, which, of course, is variable length.  */
-  OP_SCOPE,
-
-  /* Used to represent named structure field values in brace initializers
-     (or tuples as they are called in Chill).
-     The gcc C syntax is NAME:VALUE or .NAME=VALUE, the Chill syntax is
-     .NAME:VALUE.  Multiple labels (as in the Chill syntax
-     .NAME1,.NAME2:VALUE) is represented as if it were
-     .NAME1:(.NAME2:VALUE) (though that is not valid Chill syntax).
-
-     The NAME is represented as for STRUCTOP_STRUCT;  VALUE follows. */
-  OP_LABELED,
-
-  /* OP_TYPE is for parsing types, and used with the "ptype" command
-     so we can look up types that are qualified by scope, either with
-     the GDB "::" operator, or the Modula-2 '.' operator. */
-  OP_TYPE
-};
+enum exp_opcode : uint8_t
+  {
+#define OP(name) name ,
+
+#include "std-operator.def"
+
+    /* First extension operator.  Individual language modules define extra
+       operators in *.def include files below with numbers higher than
+       OP_EXTENDED0.  */
+    OP (OP_EXTENDED0)
+
+/* Language specific operators.  */
+#include "ada-operator.def"
+#include "fortran-operator.def"
+
+#undef OP
+
+    /* Existing only to swallow the last comma (',') from last .inc file.  */
+    OP_UNUSED_LAST
+  };
 
 union exp_element
-{
-  enum exp_opcode opcode;
-  struct symbol *symbol;
-  LONGEST longconst;
-  double doubleconst;
-  /* Really sizeof (union exp_element) characters (or less for the last
-     element of a string).  */
-  char string;
-  struct type *type;
-  struct internalvar *internalvar;
-  struct block *block;
-};
+  {
+    enum exp_opcode opcode;
+    struct symbol *symbol;
+    struct minimal_symbol *msymbol;
+    LONGEST longconst;
+    gdb_byte floatconst[16];
+    /* Really sizeof (union exp_element) characters (or less for the last
+       element of a string).  */
+    char string;
+    struct type *type;
+    struct internalvar *internalvar;
+    const struct block *block;
+    struct objfile *objfile;
+  };
 
 struct expression
-{
-  const struct language_defn *language_defn;  /* language it was entered in */
-  int nelts;
-  union exp_element elts[1];
-};
+  {
+    const struct language_defn *language_defn; /* language it was
+                                                  entered in.  */
+    struct gdbarch *gdbarch;  /* architecture it was parsed in.  */
+    int nelts;
+    union exp_element elts[1];
+  };
+
+typedef gdb::unique_xmalloc_ptr<expression> expression_up;
 
 /* Macros for converting between number of expression elements and bytes
-   to store that many expression elements. */
+   to store that many expression elements.  */
 
 #define EXP_ELEM_TO_BYTES(elements) \
     ((elements) * sizeof (union exp_element))
@@ -333,31 +113,82 @@ struct expression
 
 /* From parse.c */
 
-extern struct expression *parse_expression PARAMS ((char *));
+class innermost_block_tracker;
+extern expression_up parse_expression (const char *,
+                                      innermost_block_tracker * = nullptr);
+
+extern expression_up parse_expression_with_language (const char *string,
+                                                    enum language lang);
+
+extern struct type *parse_expression_for_completion
+    (const char *, gdb::unique_xmalloc_ptr<char> *, enum type_code *);
+
+class innermost_block_tracker;
+extern expression_up parse_exp_1 (const char **, CORE_ADDR pc,
+                                 const struct block *, int,
+                                 innermost_block_tracker * = nullptr);
+
+/* From eval.c */
+
+/* Values of NOSIDE argument to eval_subexp.  */
+
+enum noside
+  {
+    EVAL_NORMAL,
+    EVAL_SKIP,                 /* Only effect is to increment pos.
+                                  Return type information where
+                                  possible.  */
+    EVAL_AVOID_SIDE_EFFECTS    /* Don't modify any variables or
+                                  call any functions.  The value
+                                  returned will have the correct
+                                  type, and will have an
+                                  approximately correct lvalue
+                                  type (inaccuracy: anything that is
+                                  listed as being in a register in
+                                  the function in which it was
+                                  declared will be lval_register).
+                                  Ideally this would not even read
+                                  target memory, but currently it
+                                  does in many situations.  */
+  };
+
+extern struct value *evaluate_subexp_standard
+  (struct type *, struct expression *, int *, enum noside);
 
-extern struct expression *parse_exp_1 PARAMS ((char **, struct block *, int));
+/* From expprint.c */
 
-/* The innermost context required by the stack and register variables
-   we've encountered so far.  To use this, set it to NULL, then call
-   parse_<whatever>, then look at it.  */
-extern struct block *innermost_block;
+extern void print_expression (struct expression *, struct ui_file *);
 
-/* From expprint.c */
+extern const char *op_name (struct expression *exp, enum exp_opcode opcode);
 
-extern void print_expression PARAMS ((struct expression *, GDB_FILE *));
+extern const char *op_string (enum exp_opcode);
 
-extern char *op_string PARAMS ((enum exp_opcode));
+extern void dump_raw_expression (struct expression *,
+                                struct ui_file *, const char *);
+extern void dump_prefix_expression (struct expression *, struct ui_file *);
 
-/* To enable dumping of all parsed expressions in a human readable
-   form, define DEBUG_EXPRESSIONS.  This is a compile time constant
-   at the moment, since it's not clear that this feature is important
-   enough to include by default. */
+/* In an OP_RANGE expression, either bound could be empty, indicating
+   that its value is by default that of the corresponding bound of the
+   array or string.  Also, the upper end of the range can be exclusive
+   or inclusive.  So we have six sorts of subrange.  This enumeration
+   type is to identify this.  */
 
-#ifdef DEBUG_EXPRESSIONS
-extern void dump_expression PARAMS ((struct expression *, GDB_FILE *, char *));
-#define DUMP_EXPRESSION(exp,file,note) dump_expression ((exp), (file), (note))
-#else
-#define DUMP_EXPRESSION(exp,file,note) /* Null expansion */
-#endif /* DEBUG_EXPRESSIONS */
+enum range_type
+{
+  /* Neither the low nor the high bound was given -- so this refers to
+     the entire available range.  */
+  BOTH_BOUND_DEFAULT,
+  /* The low bound was not given and the high bound is inclusive.  */
+  LOW_BOUND_DEFAULT,
+  /* The high bound was not given and the low bound in inclusive.  */
+  HIGH_BOUND_DEFAULT,
+  /* Both bounds were given and both are inclusive.  */
+  NONE_BOUND_DEFAULT,
+  /* The low bound was not given and the high bound is exclusive.  */
+  NONE_BOUND_DEFAULT_EXCLUSIVE,
+  /* Both bounds were given.  The low bound is inclusive and the high
+     bound is exclusive.  */
+  LOW_BOUND_DEFAULT_EXCLUSIVE,
+};
 
-#endif /* !defined (EXPRESSION_H) */
+#endif /* !defined (EXPRESSION_H) */
This page took 0.030656 seconds and 4 git commands to generate.