1 /* Definitions for Ada expressions
3 Copyright (C) 2020-2023 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/>. */
25 extern struct value
*ada_unop_neg (struct type
*expect_type
,
26 struct expression
*exp
,
27 enum noside noside
, enum exp_opcode op
,
29 extern struct value
*ada_atr_tag (struct type
*expect_type
,
30 struct expression
*exp
,
31 enum noside noside
, enum exp_opcode op
,
33 extern struct value
*ada_atr_size (struct type
*expect_type
,
34 struct expression
*exp
,
35 enum noside noside
, enum exp_opcode op
,
37 extern struct value
*ada_abs (struct type
*expect_type
,
38 struct expression
*exp
,
39 enum noside noside
, enum exp_opcode op
,
41 extern struct value
*ada_unop_in_range (struct type
*expect_type
,
42 struct expression
*exp
,
43 enum noside noside
, enum exp_opcode op
,
44 struct value
*arg1
, struct type
*type
);
45 extern struct value
*ada_mult_binop (struct type
*expect_type
,
46 struct expression
*exp
,
47 enum noside noside
, enum exp_opcode op
,
48 struct value
*arg1
, struct value
*arg2
);
49 extern struct value
*ada_equal_binop (struct type
*expect_type
,
50 struct expression
*exp
,
51 enum noside noside
, enum exp_opcode op
,
52 struct value
*arg1
, struct value
*arg2
);
53 extern struct value
*ada_ternop_slice (struct expression
*exp
,
56 struct value
*low_bound_val
,
57 struct value
*high_bound_val
);
58 extern struct value
*ada_binop_in_bounds (struct expression
*exp
,
63 extern struct value
*ada_binop_minmax (struct type
*expect_type
,
64 struct expression
*exp
,
65 enum noside noside
, enum exp_opcode op
,
68 extern struct value
*ada_pos_atr (struct type
*expect_type
,
69 struct expression
*exp
,
70 enum noside noside
, enum exp_opcode op
,
72 extern struct value
*ada_val_atr (enum noside noside
, struct type
*type
,
74 extern struct value
*ada_binop_exp (struct type
*expect_type
,
75 struct expression
*exp
,
76 enum noside noside
, enum exp_opcode op
,
77 struct value
*arg1
, struct value
*arg2
);
82 /* The base class for Ada type resolution. Ada operations that want
83 to participate in resolution implement this interface. */
86 /* Resolve this object. EXP is the expression being resolved.
87 DEPROCEDURE_P is true if a symbol that refers to a zero-argument
88 function may be turned into a function call. PARSE_COMPLETION
89 and TRACKER are passed in from the parser context. CONTEXT_TYPE
90 is the expected type of the expression, or nullptr if none is
91 known. This method should return true if the operation should be
92 replaced by a function call with this object as the callee. */
93 virtual bool resolve (struct expression
*exp
,
95 bool parse_completion
,
96 innermost_block_tracker
*tracker
,
97 struct type
*context_type
) = 0;
99 /* Possibly replace this object with some other expression object.
100 This is like 'resolve', but can return a replacement.
102 The default implementation calls 'resolve' and wraps this object
103 in a function call if that call returns true. OWNER is a
104 reference to the unique pointer that owns the 'this'; it can be
105 'move'd from to construct the replacement.
107 This should either return a new object, or OWNER -- never
110 virtual operation_up
replace (operation_up
&&owner
,
111 struct expression
*exp
,
113 bool parse_completion
,
114 innermost_block_tracker
*tracker
,
115 struct type
*context_type
);
118 /* In Ada, some generic operations must be wrapped with a handler that
119 handles some Ada-specific type conversions. */
120 class ada_wrapped_operation
121 : public tuple_holding_operation
<operation_up
>
125 using tuple_holding_operation::tuple_holding_operation
;
127 value
*evaluate (struct type
*expect_type
,
128 struct expression
*exp
,
129 enum noside noside
) override
;
131 enum exp_opcode
opcode () const override
132 { return std::get
<0> (m_storage
)->opcode (); }
136 void do_generate_ax (struct expression
*exp
,
137 struct agent_expr
*ax
,
138 struct axs_value
*value
,
139 struct type
*cast_type
)
143 /* An Ada string constant. */
144 class ada_string_operation
145 : public string_operation
149 using string_operation::string_operation
;
151 /* Return the underlying string. */
152 const char *get_name () const
154 return std::get
<0> (m_storage
).c_str ();
157 value
*evaluate (struct type
*expect_type
,
158 struct expression
*exp
,
159 enum noside noside
) override
;
162 /* The Ada TYPE'(EXP) construct. */
163 class ada_qual_operation
164 : public tuple_holding_operation
<operation_up
, struct type
*>
168 using tuple_holding_operation::tuple_holding_operation
;
170 value
*evaluate (struct type
*expect_type
,
171 struct expression
*exp
,
172 enum noside noside
) override
;
174 enum exp_opcode
opcode () const override
175 { return UNOP_QUAL
; }
178 /* Ternary in-range operator. */
179 class ada_ternop_range_operation
180 : public tuple_holding_operation
<operation_up
, operation_up
, operation_up
>
184 using tuple_holding_operation::tuple_holding_operation
;
186 value
*evaluate (struct type
*expect_type
,
187 struct expression
*exp
,
188 enum noside noside
) override
;
190 enum exp_opcode
opcode () const override
191 { return TERNOP_IN_RANGE
; }
194 using ada_neg_operation
= unop_operation
<UNOP_NEG
, ada_unop_neg
>;
195 using ada_atr_tag_operation
= unop_operation
<OP_ATR_TAG
, ada_atr_tag
>;
196 using ada_atr_size_operation
= unop_operation
<OP_ATR_SIZE
, ada_atr_size
>;
197 using ada_abs_operation
= unop_operation
<UNOP_ABS
, ada_abs
>;
198 using ada_pos_operation
= unop_operation
<OP_ATR_POS
, ada_pos_atr
>;
200 /* The in-range operation, given a type. */
201 class ada_unop_range_operation
202 : public tuple_holding_operation
<operation_up
, struct type
*>
206 using tuple_holding_operation::tuple_holding_operation
;
208 value
*evaluate (struct type
*expect_type
,
209 struct expression
*exp
,
210 enum noside noside
) override
212 value
*val
= std::get
<0> (m_storage
)->evaluate (nullptr, exp
, noside
);
213 return ada_unop_in_range (expect_type
, exp
, noside
, UNOP_IN_RANGE
,
214 val
, std::get
<1> (m_storage
));
217 enum exp_opcode
opcode () const override
218 { return UNOP_IN_RANGE
; }
221 /* The Ada + and - operators. */
222 class ada_binop_addsub_operation
223 : public tuple_holding_operation
<enum exp_opcode
, operation_up
, operation_up
>
227 using tuple_holding_operation::tuple_holding_operation
;
229 value
*evaluate (struct type
*expect_type
,
230 struct expression
*exp
,
231 enum noside noside
) override
;
233 enum exp_opcode
opcode () const override
234 { return std::get
<0> (m_storage
); }
237 using ada_binop_mul_operation
= binop_operation
<BINOP_MUL
, ada_mult_binop
>;
238 using ada_binop_div_operation
= binop_operation
<BINOP_DIV
, ada_mult_binop
>;
239 using ada_binop_rem_operation
= binop_operation
<BINOP_REM
, ada_mult_binop
>;
240 using ada_binop_mod_operation
= binop_operation
<BINOP_MOD
, ada_mult_binop
>;
242 using ada_binop_min_operation
= binop_operation
<BINOP_MIN
, ada_binop_minmax
>;
243 using ada_binop_max_operation
= binop_operation
<BINOP_MAX
, ada_binop_minmax
>;
245 using ada_binop_exp_operation
= binop_operation
<BINOP_EXP
, ada_binop_exp
>;
247 /* Implement the equal and not-equal operations for Ada. */
248 class ada_binop_equal_operation
249 : public tuple_holding_operation
<enum exp_opcode
, operation_up
, operation_up
>
253 using tuple_holding_operation::tuple_holding_operation
;
255 value
*evaluate (struct type
*expect_type
,
256 struct expression
*exp
,
257 enum noside noside
) override
259 value
*arg1
= std::get
<1> (m_storage
)->evaluate (nullptr, exp
, noside
);
260 value
*arg2
= std::get
<2> (m_storage
)->evaluate (arg1
->type (),
262 return ada_equal_binop (expect_type
, exp
, noside
, std::get
<0> (m_storage
),
266 void do_generate_ax (struct expression
*exp
,
267 struct agent_expr
*ax
,
268 struct axs_value
*value
,
269 struct type
*cast_type
)
272 gen_expr_binop (exp
, opcode (),
273 std::get
<1> (this->m_storage
).get (),
274 std::get
<2> (this->m_storage
).get (),
278 enum exp_opcode
opcode () const override
279 { return std::get
<0> (m_storage
); }
282 /* Bitwise operators for Ada. */
283 template<enum exp_opcode OP
>
284 class ada_bitwise_operation
285 : public maybe_constant_operation
<operation_up
, operation_up
>
289 using maybe_constant_operation::maybe_constant_operation
;
291 value
*evaluate (struct type
*expect_type
,
292 struct expression
*exp
,
293 enum noside noside
) override
295 value
*lhs
= std::get
<0> (m_storage
)->evaluate (nullptr, exp
, noside
);
296 value
*rhs
= std::get
<1> (m_storage
)->evaluate (nullptr, exp
, noside
);
297 value
*result
= eval_op_binary (expect_type
, exp
, noside
, OP
, lhs
, rhs
);
298 return value_cast (lhs
->type (), result
);
301 enum exp_opcode
opcode () const override
305 using ada_bitwise_and_operation
= ada_bitwise_operation
<BINOP_BITWISE_AND
>;
306 using ada_bitwise_ior_operation
= ada_bitwise_operation
<BINOP_BITWISE_IOR
>;
307 using ada_bitwise_xor_operation
= ada_bitwise_operation
<BINOP_BITWISE_XOR
>;
309 /* Ada array- or string-slice operation. */
310 class ada_ternop_slice_operation
311 : public maybe_constant_operation
<operation_up
, operation_up
, operation_up
>,
312 public ada_resolvable
316 using maybe_constant_operation::maybe_constant_operation
;
318 value
*evaluate (struct type
*expect_type
,
319 struct expression
*exp
,
320 enum noside noside
) override
322 value
*array
= std::get
<0> (m_storage
)->evaluate (nullptr, exp
, noside
);
323 value
*low
= std::get
<1> (m_storage
)->evaluate (nullptr, exp
, noside
);
324 value
*high
= std::get
<2> (m_storage
)->evaluate (nullptr, exp
, noside
);
325 return ada_ternop_slice (exp
, noside
, array
, low
, high
);
328 enum exp_opcode
opcode () const override
329 { return TERNOP_SLICE
; }
331 bool resolve (struct expression
*exp
,
333 bool parse_completion
,
334 innermost_block_tracker
*tracker
,
335 struct type
*context_type
) override
;
338 /* Implement BINOP_IN_BOUNDS for Ada. */
339 class ada_binop_in_bounds_operation
340 : public maybe_constant_operation
<operation_up
, operation_up
, int>
344 using maybe_constant_operation::maybe_constant_operation
;
346 value
*evaluate (struct type
*expect_type
,
347 struct expression
*exp
,
348 enum noside noside
) override
350 value
*arg1
= std::get
<0> (m_storage
)->evaluate (nullptr, exp
, noside
);
351 value
*arg2
= std::get
<1> (m_storage
)->evaluate (nullptr, exp
, noside
);
352 return ada_binop_in_bounds (exp
, noside
, arg1
, arg2
,
353 std::get
<2> (m_storage
));
356 enum exp_opcode
opcode () const override
357 { return BINOP_IN_BOUNDS
; }
360 /* Implement several unary Ada OP_ATR_* operations. */
361 class ada_unop_atr_operation
362 : public maybe_constant_operation
<operation_up
, enum exp_opcode
, int>
366 using maybe_constant_operation::maybe_constant_operation
;
368 value
*evaluate (struct type
*expect_type
,
369 struct expression
*exp
,
370 enum noside noside
) override
;
372 enum exp_opcode
opcode () const override
373 { return std::get
<1> (m_storage
); }
376 /* Variant of var_value_operation for Ada. */
377 class ada_var_value_operation
378 : public var_value_operation
, public ada_resolvable
382 using var_value_operation::var_value_operation
;
384 value
*evaluate (struct type
*expect_type
,
385 struct expression
*exp
,
386 enum noside noside
) override
;
388 value
*evaluate_for_cast (struct type
*expect_type
,
389 struct expression
*exp
,
390 enum noside noside
) override
;
392 const block
*get_block () const
393 { return std::get
<0> (m_storage
).block
; }
395 bool resolve (struct expression
*exp
,
397 bool parse_completion
,
398 innermost_block_tracker
*tracker
,
399 struct type
*context_type
) override
;
403 void do_generate_ax (struct expression
*exp
,
404 struct agent_expr
*ax
,
405 struct axs_value
*value
,
406 struct type
*cast_type
)
410 /* Variant of var_msym_value_operation for Ada. */
411 class ada_var_msym_value_operation
412 : public var_msym_value_operation
416 using var_msym_value_operation::var_msym_value_operation
;
418 value
*evaluate_for_cast (struct type
*expect_type
,
419 struct expression
*exp
,
420 enum noside noside
) override
;
424 using operation::do_generate_ax
;
427 /* Implement the Ada 'val attribute. */
428 class ada_atr_val_operation
429 : public tuple_holding_operation
<struct type
*, operation_up
>
433 using tuple_holding_operation::tuple_holding_operation
;
435 value
*evaluate (struct type
*expect_type
,
436 struct expression
*exp
,
437 enum noside noside
) override
;
439 enum exp_opcode
opcode () const override
440 { return OP_ATR_VAL
; }
443 /* The indirection operator for Ada. */
444 class ada_unop_ind_operation
445 : public unop_ind_base_operation
449 using unop_ind_base_operation::unop_ind_base_operation
;
451 value
*evaluate (struct type
*expect_type
,
452 struct expression
*exp
,
453 enum noside noside
) override
;
456 /* Implement STRUCTOP_STRUCT for Ada. */
457 class ada_structop_operation
458 : public structop_base_operation
462 using structop_base_operation::structop_base_operation
;
464 value
*evaluate (struct type
*expect_type
,
465 struct expression
*exp
,
466 enum noside noside
) override
;
468 enum exp_opcode
opcode () const override
469 { return STRUCTOP_STRUCT
; }
471 /* Set the completion prefix. */
472 void set_prefix (std::string
&&prefix
)
474 m_prefix
= std::move (prefix
);
477 bool complete (struct expression
*exp
, completion_tracker
&tracker
) override
479 return structop_base_operation::complete (exp
, tracker
, m_prefix
.c_str ());
482 void dump (struct ui_file
*stream
, int depth
) const override
484 structop_base_operation::dump (stream
, depth
);
485 dump_for_expression (stream
, depth
+ 1, m_prefix
);
490 /* We may need to provide a prefix to field name completion. See
491 ada-exp.y:find_completion_bounds for details. */
492 std::string m_prefix
;
495 /* Function calls for Ada. */
496 class ada_funcall_operation
497 : public tuple_holding_operation
<operation_up
, std::vector
<operation_up
>>,
498 public ada_resolvable
502 using tuple_holding_operation::tuple_holding_operation
;
504 value
*evaluate (struct type
*expect_type
,
505 struct expression
*exp
,
506 enum noside noside
) override
;
508 bool resolve (struct expression
*exp
,
510 bool parse_completion
,
511 innermost_block_tracker
*tracker
,
512 struct type
*context_type
) override
;
514 enum exp_opcode
opcode () const override
515 { return OP_FUNCALL
; }
518 /* An Ada assignment operation. */
519 class ada_assign_operation
520 : public assign_operation
524 using assign_operation::assign_operation
;
526 value
*evaluate (struct type
*expect_type
,
527 struct expression
*exp
,
528 enum noside noside
) override
;
530 enum exp_opcode
opcode () const override
531 { return BINOP_ASSIGN
; }
534 /* This abstract class represents a single component in an Ada
535 aggregate assignment. */
540 /* Assign to LHS, which is part of CONTAINER. EXP is the expression
541 being evaluated. INDICES, LOW, and HIGH indicate which
542 sub-components have already been assigned; INDICES should be
543 updated by this call. */
544 virtual void assign (struct value
*container
,
545 struct value
*lhs
, struct expression
*exp
,
546 std::vector
<LONGEST
> &indices
,
547 LONGEST low
, LONGEST high
) = 0;
549 /* Same as operation::uses_objfile. */
550 virtual bool uses_objfile (struct objfile
*objfile
) = 0;
552 /* Same as operation::dump. */
553 virtual void dump (ui_file
*stream
, int depth
) = 0;
555 virtual ~ada_component () = default;
559 ada_component () = default;
560 DISABLE_COPY_AND_ASSIGN (ada_component
);
563 /* Unique pointer specialization for Ada assignment components. */
564 typedef std::unique_ptr
<ada_component
> ada_component_up
;
566 /* An operation that holds a single component. */
567 class ada_aggregate_operation
568 : public tuple_holding_operation
<ada_component_up
>
572 using tuple_holding_operation::tuple_holding_operation
;
574 /* Assuming that LHS represents an lvalue having a record or array
575 type, evaluate an assignment of this aggregate's value to LHS.
576 CONTAINER is an lvalue containing LHS (possibly LHS itself).
577 Does not modify the inferior's memory, nor does it modify the
578 contents of LHS (unless == CONTAINER). Returns the modified
581 value
*assign_aggregate (struct value
*container
,
583 struct expression
*exp
);
585 value
*evaluate (struct type
*expect_type
,
586 struct expression
*exp
,
587 enum noside noside
) override
589 error (_("Aggregates only allowed on the right of an assignment"));
592 enum exp_opcode
opcode () const override
593 { return OP_AGGREGATE
; }
596 /* A component holding a vector of other components to assign. */
597 class ada_aggregate_component
: public ada_component
601 explicit ada_aggregate_component (std::vector
<ada_component_up
> &&components
)
602 : m_components (std::move (components
))
606 void assign (struct value
*container
,
607 struct value
*lhs
, struct expression
*exp
,
608 std::vector
<LONGEST
> &indices
,
609 LONGEST low
, LONGEST high
) override
;
611 bool uses_objfile (struct objfile
*objfile
) override
;
613 void dump (ui_file
*stream
, int depth
) override
;
617 std::vector
<ada_component_up
> m_components
;
620 /* A component that assigns according to a provided index (which is
621 relative to the "low" value). */
622 class ada_positional_component
: public ada_component
626 ada_positional_component (int index
, operation_up
&&op
)
628 m_op (std::move (op
))
632 void assign (struct value
*container
,
633 struct value
*lhs
, struct expression
*exp
,
634 std::vector
<LONGEST
> &indices
,
635 LONGEST low
, LONGEST high
) override
;
637 bool uses_objfile (struct objfile
*objfile
) override
;
639 void dump (ui_file
*stream
, int depth
) override
;
647 /* A component which handles an "others" clause. */
648 class ada_others_component
: public ada_component
652 explicit ada_others_component (operation_up
&&op
)
653 : m_op (std::move (op
))
657 void assign (struct value
*container
,
658 struct value
*lhs
, struct expression
*exp
,
659 std::vector
<LONGEST
> &indices
,
660 LONGEST low
, LONGEST high
) override
;
662 bool uses_objfile (struct objfile
*objfile
) override
;
664 void dump (ui_file
*stream
, int depth
) override
;
671 /* An interface that represents an association that is used in
672 aggregate assignment. */
673 class ada_association
677 /* Like ada_component::assign, but takes an operation as a
678 parameter. The operation is evaluated and then assigned into LHS
679 according to the rules of the concrete implementation. */
680 virtual void assign (struct value
*container
,
682 struct expression
*exp
,
683 std::vector
<LONGEST
> &indices
,
684 LONGEST low
, LONGEST high
,
685 operation_up
&op
) = 0;
687 /* Same as operation::uses_objfile. */
688 virtual bool uses_objfile (struct objfile
*objfile
) = 0;
690 /* Same as operation::dump. */
691 virtual void dump (ui_file
*stream
, int depth
) = 0;
693 virtual ~ada_association () = default;
697 ada_association () = default;
698 DISABLE_COPY_AND_ASSIGN (ada_association
);
701 /* Unique pointer specialization for Ada assignment associations. */
702 typedef std::unique_ptr
<ada_association
> ada_association_up
;
704 /* A component that holds a vector of associations and an operation.
705 The operation is re-evaluated for each choice. */
706 class ada_choices_component
: public ada_component
710 explicit ada_choices_component (operation_up
&&op
)
711 : m_op (std::move (op
))
715 /* Set the vector of associations. This is done separately from the
716 constructor because it was simpler for the implementation of the
718 void set_associations (std::vector
<ada_association_up
> &&assoc
)
720 m_assocs
= std::move (assoc
);
723 void assign (struct value
*container
,
724 struct value
*lhs
, struct expression
*exp
,
725 std::vector
<LONGEST
> &indices
,
726 LONGEST low
, LONGEST high
) override
;
728 bool uses_objfile (struct objfile
*objfile
) override
;
730 void dump (ui_file
*stream
, int depth
) override
;
734 std::vector
<ada_association_up
> m_assocs
;
738 /* An association that uses a discrete range. */
739 class ada_discrete_range_association
: public ada_association
743 ada_discrete_range_association (operation_up
&&low
, operation_up
&&high
)
744 : m_low (std::move (low
)),
745 m_high (std::move (high
))
749 void assign (struct value
*container
,
750 struct value
*lhs
, struct expression
*exp
,
751 std::vector
<LONGEST
> &indices
,
752 LONGEST low
, LONGEST high
,
753 operation_up
&op
) override
;
755 bool uses_objfile (struct objfile
*objfile
) override
;
757 void dump (ui_file
*stream
, int depth
) override
;
765 /* An association that uses a name. The name may be an expression
766 that evaluates to an integer (for arrays), or an Ada string or
767 variable value operation. */
768 class ada_name_association
: public ada_association
772 explicit ada_name_association (operation_up val
)
773 : m_val (std::move (val
))
777 void assign (struct value
*container
,
778 struct value
*lhs
, struct expression
*exp
,
779 std::vector
<LONGEST
> &indices
,
780 LONGEST low
, LONGEST high
,
781 operation_up
&op
) override
;
783 bool uses_objfile (struct objfile
*objfile
) override
;
785 void dump (ui_file
*stream
, int depth
) override
;
792 /* A character constant expression. This is a separate operation so
793 that it can participate in resolution, so that TYPE'(CST) can
794 work correctly for enums with character enumerators. */
795 class ada_char_operation
: public long_const_operation
,
796 public ada_resolvable
800 using long_const_operation::long_const_operation
;
802 bool resolve (struct expression
*exp
,
804 bool parse_completion
,
805 innermost_block_tracker
*tracker
,
806 struct type
*context_type
) override
808 /* This should never be called, because this class also implements
810 gdb_assert_not_reached ("unexpected call");
813 operation_up
replace (operation_up
&&owner
,
814 struct expression
*exp
,
816 bool parse_completion
,
817 innermost_block_tracker
*tracker
,
818 struct type
*context_type
) override
;
820 value
*evaluate (struct type
*expect_type
,
821 struct expression
*exp
,
822 enum noside noside
) override
;
825 class ada_concat_operation
: public concat_operation
829 using concat_operation::concat_operation
;
831 value
*evaluate (struct type
*expect_type
,
832 struct expression
*exp
,
833 enum noside noside
) override
;
836 } /* namespace expr */
838 #endif /* ADA_EXP_H */