1 /* Definitions for expressions stored in reversed prefix form, for GDB.
3 Copyright (C) 1986-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #if !defined (EXPRESSION_H)
21 #define EXPRESSION_H 1
25 /* While parsing expressions we need to track the innermost lexical block
26 that we encounter. In some situations we need to track the innermost
27 block just for symbols, and in other situations we want to track the
28 innermost block for symbols and registers. These flags are used by the
29 innermost block tracker to control which blocks we consider for the
30 innermost block. These flags can be combined together as needed. */
32 enum innermost_block_tracker_type
34 /* Track the innermost block for symbols within an expression. */
35 INNERMOST_BLOCK_FOR_SYMBOLS
= (1 << 0),
37 /* Track the innermost block for registers within an expression. */
38 INNERMOST_BLOCK_FOR_REGISTERS
= (1 << 1)
40 DEF_ENUM_FLAGS_TYPE (enum innermost_block_tracker_type
,
41 innermost_block_tracker_types
);
43 /* Definitions for saved C expressions. */
45 /* An expression is represented as a vector of union exp_element's.
46 Each exp_element is an opcode, except that some opcodes cause
47 the following exp_element to be treated as a long or double constant
48 or as a variable. The opcodes are obeyed, using a stack for temporaries.
49 The value is left on the temporary stack at the end. */
51 /* When it is necessary to include a string,
52 it can occupy as many exp_elements as it needs.
53 We find the length of the string using strlen,
54 divide to find out how many exp_elements are used up,
55 and skip that many. Strings, like numbers, are indicated
56 by the preceding opcode. */
58 enum exp_opcode
: uint8_t
60 #define OP(name) name ,
62 #include "std-operator.def"
66 /* Existing only to swallow the last comma (',') from last .inc file. */
72 enum exp_opcode opcode
;
73 struct symbol
*symbol
;
74 struct minimal_symbol
*msymbol
;
76 gdb_byte floatconst
[16];
77 /* Really sizeof (union exp_element) characters (or less for the last
78 element of a string). */
81 struct internalvar
*internalvar
;
82 const struct block
*block
;
83 struct objfile
*objfile
;
88 expression (const struct language_defn
*, struct gdbarch
*, size_t);
90 DISABLE_COPY_AND_ASSIGN (expression
);
94 /* Language it was entered in. */
95 const struct language_defn
*language_defn
;
96 /* Architecture it was parsed in. */
97 struct gdbarch
*gdbarch
;
99 union exp_element
*elts
;
102 typedef std::unique_ptr
<expression
> expression_up
;
104 /* Macros for converting between number of expression elements and bytes
105 to store that many expression elements. */
107 #define EXP_ELEM_TO_BYTES(elements) \
108 ((elements) * sizeof (union exp_element))
109 #define BYTES_TO_EXP_ELEM(bytes) \
110 (((bytes) + sizeof (union exp_element) - 1) / sizeof (union exp_element))
114 class innermost_block_tracker
;
115 extern expression_up
parse_expression (const char *,
116 innermost_block_tracker
* = nullptr);
118 extern expression_up
parse_expression_with_language (const char *string
,
121 extern struct type
*parse_expression_for_completion
122 (const char *, gdb::unique_xmalloc_ptr
<char> *, enum type_code
*);
124 class innermost_block_tracker
;
125 extern expression_up
parse_exp_1 (const char **, CORE_ADDR pc
,
126 const struct block
*, int,
127 innermost_block_tracker
* = nullptr);
131 /* Values of NOSIDE argument to eval_subexp. */
136 EVAL_SKIP
, /* Only effect is to increment pos.
137 Return type information where
139 EVAL_AVOID_SIDE_EFFECTS
/* Don't modify any variables or
140 call any functions. The value
141 returned will have the correct
142 type, and will have an
143 approximately correct lvalue
144 type (inaccuracy: anything that is
145 listed as being in a register in
146 the function in which it was
147 declared will be lval_register).
148 Ideally this would not even read
149 target memory, but currently it
150 does in many situations. */
153 extern struct value
*evaluate_subexp_standard
154 (struct type
*, struct expression
*, int *, enum noside
);
156 /* Evaluate a function call. The function to be called is in ARGVEC[0] and
157 the arguments passed to the function are in ARGVEC[1..NARGS].
158 FUNCTION_NAME is the name of the function, if known.
159 DEFAULT_RETURN_TYPE is used as the function's return type if the return
162 extern struct value
*evaluate_subexp_do_call (expression
*exp
,
164 int nargs
, value
**argvec
,
165 const char *function_name
,
166 type
*default_return_type
);
168 /* From expprint.c */
170 extern void print_expression (struct expression
*, struct ui_file
*);
172 extern const char *op_name (enum exp_opcode opcode
);
174 extern const char *op_string (enum exp_opcode
);
176 extern void dump_raw_expression (struct expression
*,
177 struct ui_file
*, const char *);
178 extern void dump_prefix_expression (struct expression
*, struct ui_file
*);
180 /* In an OP_RANGE expression, either bound could be empty, indicating
181 that its value is by default that of the corresponding bound of the
182 array or string. Also, the upper end of the range can be exclusive
183 or inclusive. So we have six sorts of subrange. This enumeration
184 type is to identify this. */
186 enum range_flag
: unsigned
188 /* This is a standard range. Both the lower and upper bounds are
189 defined, and the bounds are inclusive. */
192 /* The low bound was not given. */
193 RANGE_LOW_BOUND_DEFAULT
= 1 << 0,
195 /* The high bound was not given. */
196 RANGE_HIGH_BOUND_DEFAULT
= 1 << 1,
198 /* The high bound of this range is exclusive. */
199 RANGE_HIGH_BOUND_EXCLUSIVE
= 1 << 2,
201 /* The range has a stride. */
202 RANGE_HAS_STRIDE
= 1 << 3,
205 DEF_ENUM_FLAGS_TYPE (enum range_flag
, range_flags
);
207 #endif /* !defined (EXPRESSION_H) */