1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2021, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Aspects; use Aspects;
27 with Atree; use Atree;
28 with Checks; use Checks;
29 with Contracts; use Contracts;
30 with Debug; use Debug;
31 with Einfo; use Einfo;
32 with Einfo.Entities; use Einfo.Entities;
33 with Einfo.Utils; use Einfo.Utils;
34 with Elists; use Elists;
35 with Errout; use Errout;
36 with Expander; use Expander;
37 with Exp_Ch3; use Exp_Ch3;
38 with Exp_Ch6; use Exp_Ch6;
39 with Exp_Ch9; use Exp_Ch9;
40 with Exp_Dbug; use Exp_Dbug;
41 with Exp_Tss; use Exp_Tss;
42 with Exp_Util; use Exp_Util;
43 with Freeze; use Freeze;
44 with Ghost; use Ghost;
45 with Inline; use Inline;
46 with Itypes; use Itypes;
47 with Lib.Xref; use Lib.Xref;
48 with Layout; use Layout;
49 with Namet; use Namet;
51 with Nlists; use Nlists;
52 with Nmake; use Nmake;
54 with Output; use Output;
55 with Restrict; use Restrict;
56 with Rtsfind; use Rtsfind;
58 with Sem_Aux; use Sem_Aux;
59 with Sem_Cat; use Sem_Cat;
60 with Sem_Ch3; use Sem_Ch3;
61 with Sem_Ch4; use Sem_Ch4;
62 with Sem_Ch5; use Sem_Ch5;
63 with Sem_Ch8; use Sem_Ch8;
64 with Sem_Ch9; use Sem_Ch9;
65 with Sem_Ch10; use Sem_Ch10;
66 with Sem_Ch12; use Sem_Ch12;
67 with Sem_Ch13; use Sem_Ch13;
68 with Sem_Dim; use Sem_Dim;
69 with Sem_Disp; use Sem_Disp;
70 with Sem_Dist; use Sem_Dist;
71 with Sem_Elim; use Sem_Elim;
72 with Sem_Eval; use Sem_Eval;
73 with Sem_Mech; use Sem_Mech;
74 with Sem_Prag; use Sem_Prag;
75 with Sem_Res; use Sem_Res;
76 with Sem_Util; use Sem_Util;
77 with Sem_Type; use Sem_Type;
78 with Sem_Warn; use Sem_Warn;
79 with Sinput; use Sinput;
80 with Stand; use Stand;
81 with Sinfo; use Sinfo;
82 with Sinfo.Nodes; use Sinfo.Nodes;
83 with Sinfo.Utils; use Sinfo.Utils;
84 with Sinfo.CN; use Sinfo.CN;
85 with Snames; use Snames;
86 with Stringt; use Stringt;
88 with Stylesw; use Stylesw;
89 with Tbuild; use Tbuild;
90 with Uintp; use Uintp;
91 with Urealp; use Urealp;
92 with Validsw; use Validsw;
94 package body Sem_Ch6 is
96 May_Hide_Profile : Boolean := False;
97 -- This flag is used to indicate that two formals in two subprograms being
98 -- checked for conformance differ only in that one is an access parameter
99 -- while the other is of a general access type with the same designated
100 -- type. In this case, if the rest of the signatures match, a call to
101 -- either subprogram may be ambiguous, which is worth a warning. The flag
102 -- is set in Compatible_Types, and the warning emitted in
103 -- New_Overloaded_Entity.
105 -----------------------
106 -- Local Subprograms --
107 -----------------------
109 procedure Analyze_Function_Return (N : Node_Id);
110 -- Subsidiary to Analyze_Return_Statement. Called when the return statement
111 -- applies to a [generic] function.
113 procedure Analyze_Generic_Subprogram_Body (N : Node_Id; Gen_Id : Entity_Id);
114 -- Analyze a generic subprogram body. N is the body to be analyzed, and
115 -- Gen_Id is the defining entity Id for the corresponding spec.
117 procedure Analyze_Null_Procedure
119 Is_Completion : out Boolean);
120 -- A null procedure can be a declaration or (Ada 2012) a completion
122 procedure Analyze_Return_Statement (N : Node_Id);
123 -- Common processing for simple and extended return statements
125 procedure Analyze_Return_Type (N : Node_Id);
126 -- Subsidiary to Process_Formals: analyze subtype mark in function
127 -- specification in a context where the formals are visible and hide
130 procedure Analyze_Subprogram_Body_Helper (N : Node_Id);
131 -- Does all the real work of Analyze_Subprogram_Body. This is split out so
132 -- that we can use RETURN but not skip the debug output at the end.
134 procedure Check_Conformance
137 Ctype : Conformance_Type;
139 Conforms : out Boolean;
140 Err_Loc : Node_Id := Empty;
141 Get_Inst : Boolean := False;
142 Skip_Controlling_Formals : Boolean := False);
143 -- Given two entities, this procedure checks that the profiles associated
144 -- with these entities meet the conformance criterion given by the third
145 -- parameter. If they conform, Conforms is set True and control returns
146 -- to the caller. If they do not conform, Conforms is set to False, and
147 -- in addition, if Errmsg is True on the call, proper messages are output
148 -- to complain about the conformance failure. If Err_Loc is non_Empty
149 -- the error messages are placed on Err_Loc, if Err_Loc is empty, then
150 -- error messages are placed on the appropriate part of the construct
151 -- denoted by New_Id. If Get_Inst is true, then this is a mode conformance
152 -- against a formal access-to-subprogram type so Get_Instance_Of must
155 procedure Check_Formal_Subprogram_Conformance
160 Conforms : out Boolean);
161 -- Core implementation of Check_Formal_Subprogram_Conformance from spec.
162 -- Errmsg can be set to False to not emit error messages.
163 -- Conforms is set to True if there is conformance, False otherwise.
165 procedure Check_Limited_Return
169 -- Check the appropriate (Ada 95 or Ada 2005) rules for returning limited
170 -- types. Used only for simple return statements. Expr is the expression
173 procedure Check_Subprogram_Order (N : Node_Id);
174 -- N is the N_Subprogram_Body node for a subprogram. This routine applies
175 -- the alpha ordering rule for N if this ordering requirement applicable.
177 procedure Check_Returns
181 Proc : Entity_Id := Empty);
182 -- Called to check for missing return statements in a function body, or for
183 -- returns present in a procedure body which has No_Return set. HSS is the
184 -- handled statement sequence for the subprogram body. This procedure
185 -- checks all flow paths to make sure they either have return (Mode = 'F',
186 -- used for functions) or do not have a return (Mode = 'P', used for
187 -- No_Return procedures). The flag Err is set if there are any control
188 -- paths not explicitly terminated by a return in the function case, and is
189 -- True otherwise. Proc is the entity for the procedure case and is used
190 -- in posting the warning message.
192 procedure Check_Untagged_Equality (Eq_Op : Entity_Id);
193 -- In Ada 2012, a primitive equality operator on an untagged record type
194 -- must appear before the type is frozen, and have the same visibility as
195 -- that of the type. This procedure checks that this rule is met, and
196 -- otherwise emits an error on the subprogram declaration and a warning
197 -- on the earlier freeze point if it is easy to locate. In Ada 2012 mode,
198 -- this routine outputs errors (or warnings if -gnatd.E is set). In earlier
199 -- versions of Ada, warnings are output if Warn_On_Ada_2012_Incompatibility
200 -- is set, otherwise the call has no effect.
202 procedure Enter_Overloaded_Entity (S : Entity_Id);
203 -- This procedure makes S, a new overloaded entity, into the first visible
204 -- entity with that name.
206 function Is_Non_Overriding_Operation
208 New_E : Entity_Id) return Boolean;
209 -- Enforce the rule given in 12.3(18): a private operation in an instance
210 -- overrides an inherited operation only if the corresponding operation
211 -- was overriding in the generic. This needs to be checked for primitive
212 -- operations of types derived (in the generic unit) from formal private
213 -- or formal derived types.
215 procedure Make_Inequality_Operator (S : Entity_Id);
216 -- Create the declaration for an inequality operator that is implicitly
217 -- created by a user-defined equality operator that yields a boolean.
219 procedure Preanalyze_Formal_Expression (N : Node_Id; T : Entity_Id);
220 -- Preanalysis of default expressions of subprogram formals. N is the
221 -- expression to be analyzed and T is the expected type.
223 procedure Set_Formal_Validity (Formal_Id : Entity_Id);
224 -- Formal_Id is an formal parameter entity. This procedure deals with
225 -- setting the proper validity status for this entity, which depends on
226 -- the kind of parameter and the validity checking mode.
228 ---------------------------------------------
229 -- Analyze_Abstract_Subprogram_Declaration --
230 ---------------------------------------------
232 procedure Analyze_Abstract_Subprogram_Declaration (N : Node_Id) is
233 Scop : constant Entity_Id := Current_Scope;
234 Subp_Id : constant Entity_Id :=
235 Analyze_Subprogram_Specification (Specification (N));
238 Generate_Definition (Subp_Id);
240 -- Set the SPARK mode from the current context (may be overwritten later
241 -- with explicit pragma).
243 Set_SPARK_Pragma (Subp_Id, SPARK_Mode_Pragma);
244 Set_SPARK_Pragma_Inherited (Subp_Id);
246 -- Preserve relevant elaboration-related attributes of the context which
247 -- are no longer available or very expensive to recompute once analysis,
248 -- resolution, and expansion are over.
250 Mark_Elaboration_Attributes
255 Set_Is_Abstract_Subprogram (Subp_Id);
256 New_Overloaded_Entity (Subp_Id);
257 Check_Delayed_Subprogram (Subp_Id);
259 Set_Categorization_From_Scope (Subp_Id, Scop);
261 if Ekind (Scope (Subp_Id)) = E_Protected_Type then
262 Error_Msg_N ("abstract subprogram not allowed in protected type", N);
264 -- Issue a warning if the abstract subprogram is neither a dispatching
265 -- operation nor an operation that overrides an inherited subprogram or
266 -- predefined operator, since this most likely indicates a mistake.
268 elsif Warn_On_Redundant_Constructs
269 and then not Is_Dispatching_Operation (Subp_Id)
270 and then not Present (Overridden_Operation (Subp_Id))
271 and then (not Is_Operator_Symbol_Name (Chars (Subp_Id))
272 or else Scop /= Scope (Etype (First_Formal (Subp_Id))))
275 ("abstract subprogram is not dispatching or overriding?r?", N);
278 Generate_Reference_To_Formals (Subp_Id);
279 Check_Eliminated (Subp_Id);
281 if Has_Aspects (N) then
282 Analyze_Aspect_Specifications (N, Subp_Id);
284 end Analyze_Abstract_Subprogram_Declaration;
286 ---------------------------------
287 -- Analyze_Expression_Function --
288 ---------------------------------
290 procedure Analyze_Expression_Function (N : Node_Id) is
291 Expr : constant Node_Id := Expression (N);
292 Loc : constant Source_Ptr := Sloc (N);
293 LocX : constant Source_Ptr := Sloc (Expr);
294 Spec : constant Node_Id := Specification (N);
301 Orig_N : Node_Id := Empty;
303 Typ : Entity_Id := Empty;
305 Def_Id : Entity_Id := Empty;
307 -- If the expression is a completion, Prev is the entity whose
308 -- declaration is completed. Def_Id is needed to analyze the spec.
311 -- This is one of the occasions on which we transform the tree during
312 -- semantic analysis. If this is a completion, transform the expression
313 -- function into an equivalent subprogram body, and analyze it.
315 -- Expression functions are inlined unconditionally. The back-end will
316 -- determine whether this is possible.
318 Inline_Processing_Required := True;
320 -- Create a specification for the generated body. This must be done
321 -- prior to the analysis of the initial declaration.
323 New_Spec := Copy_Subprogram_Spec (Spec);
324 Prev := Current_Entity_In_Scope (Defining_Entity (Spec));
326 -- If there are previous overloadable entities with the same name,
327 -- check whether any of them is completed by the expression function.
328 -- In a generic context a formal subprogram has no completion.
331 and then Is_Overloadable (Prev)
332 and then not Is_Formal_Subprogram (Prev)
334 Def_Id := Analyze_Subprogram_Specification (Spec);
335 Prev := Find_Corresponding_Spec (N);
337 Typ := Etype (Def_Id);
339 -- The previous entity may be an expression function as well, in
340 -- which case the redeclaration is illegal.
343 and then Nkind (Original_Node (Unit_Declaration_Node (Prev))) =
344 N_Expression_Function
346 Error_Msg_Sloc := Sloc (Prev);
347 Error_Msg_N ("& conflicts with declaration#", Def_Id);
352 Ret := Make_Simple_Return_Statement (LocX, Expr);
355 Make_Subprogram_Body (Loc,
356 Specification => New_Spec,
357 Declarations => Empty_List,
358 Handled_Statement_Sequence =>
359 Make_Handled_Sequence_Of_Statements (LocX,
360 Statements => New_List (Ret)));
361 Set_Was_Expression_Function (New_Body);
363 -- If the expression completes a generic subprogram, we must create a
364 -- separate node for the body, because at instantiation the original
365 -- node of the generic copy must be a generic subprogram body, and
366 -- cannot be a expression function. Otherwise we just rewrite the
367 -- expression with the non-generic body.
369 if Present (Prev) and then Ekind (Prev) = E_Generic_Function then
370 Insert_After (N, New_Body);
372 -- Propagate any aspects or pragmas that apply to the expression
373 -- function to the proper body when the expression function acts
376 if Has_Aspects (N) then
377 Move_Aspects (N, To => New_Body);
380 Relocate_Pragmas_To_Body (New_Body);
382 Rewrite (N, Make_Null_Statement (Loc));
383 Set_Has_Completion (Prev, False);
386 Set_Is_Inlined (Prev);
388 -- If the expression function is a completion, the previous declaration
389 -- must come from source. We know already that it appears in the current
390 -- scope. The entity itself may be internally created if within a body
394 and then Is_Overloadable (Prev)
395 and then not Is_Formal_Subprogram (Prev)
396 and then Comes_From_Source (Parent (Prev))
398 Set_Has_Completion (Prev, False);
399 Set_Is_Inlined (Prev);
401 -- AI12-0103: Expression functions that are a completion freeze their
402 -- expression but don't freeze anything else (unlike regular bodies).
404 -- Note that we cannot defer this freezing to the analysis of the
405 -- expression itself, because a freeze node might appear in a nested
406 -- scope, leading to an elaboration order issue in gigi.
407 -- As elsewhere, we do not emit freeze nodes within a generic unit.
409 if not Inside_A_Generic then
417 -- For navigation purposes, indicate that the function is a body
419 Generate_Reference (Prev, Defining_Entity (N), 'b', Force => True);
420 Rewrite (N, New_Body);
422 -- Remove any existing aspects from the original node because the act
423 -- of rewriting causes the list to be shared between the two nodes.
425 Orig_N := Original_Node (N);
426 Remove_Aspects (Orig_N);
428 -- Propagate any pragmas that apply to expression function to the
429 -- proper body when the expression function acts as a completion.
430 -- Aspects are automatically transfered because of node rewriting.
432 Relocate_Pragmas_To_Body (N);
435 -- Prev is the previous entity with the same name, but it is can
436 -- be an unrelated spec that is not completed by the expression
437 -- function. In that case the relevant entity is the one in the body.
438 -- Not clear that the backend can inline it in this case ???
440 if Has_Completion (Prev) then
442 -- The formals of the expression function are body formals,
443 -- and do not appear in the ali file, which will only contain
444 -- references to the formals of the original subprogram spec.
451 F1 := First_Formal (Def_Id);
452 F2 := First_Formal (Prev);
454 while Present (F1) loop
455 Set_Spec_Entity (F1, F2);
462 Set_Is_Inlined (Defining_Entity (New_Body));
465 -- If this is not a completion, create both a declaration and a body, so
466 -- that the expression can be inlined whenever possible.
469 -- An expression function that is not a completion is not a
470 -- subprogram declaration, and thus cannot appear in a protected
473 if Nkind (Parent (N)) = N_Protected_Definition then
475 ("an expression function is not a legal protected operation", N);
478 Rewrite (N, Make_Subprogram_Declaration (Loc, Specification => Spec));
480 -- Remove any existing aspects from the original node because the act
481 -- of rewriting causes the list to be shared between the two nodes.
483 Orig_N := Original_Node (N);
484 Remove_Aspects (Orig_N);
488 -- If aspect SPARK_Mode was specified on the body, it needs to be
489 -- repeated both on the generated spec and the body.
491 Asp := Find_Aspect (Defining_Unit_Name (Spec), Aspect_SPARK_Mode);
493 if Present (Asp) then
494 Asp := New_Copy_Tree (Asp);
495 Set_Analyzed (Asp, False);
496 Set_Aspect_Specifications (New_Body, New_List (Asp));
499 Def_Id := Defining_Entity (N);
500 Set_Is_Inlined (Def_Id);
502 Typ := Etype (Def_Id);
504 -- Establish the linkages between the spec and the body. These are
505 -- used when the expression function acts as the prefix of attribute
506 -- 'Access in order to freeze the original expression which has been
507 -- moved to the generated body.
509 Set_Corresponding_Body (N, Defining_Entity (New_Body));
510 Set_Corresponding_Spec (New_Body, Def_Id);
512 -- Within a generic preanalyze the original expression for name
513 -- capture. The body is also generated but plays no role in
514 -- this because it is not part of the original source.
515 -- If this is an ignored Ghost entity, analysis of the generated
516 -- body is needed to hide external references (as is done in
517 -- Analyze_Subprogram_Body) after which the the subprogram profile
518 -- can be frozen, which is needed to expand calls to such an ignored
521 if Inside_A_Generic then
522 Set_Has_Completion (Def_Id, not Is_Ignored_Ghost_Entity (Def_Id));
524 Install_Formals (Def_Id);
525 Preanalyze_Spec_Expression (Expr, Typ);
529 Install_Formals (Def_Id);
530 Preanalyze_Formal_Expression (Expr, Typ);
531 Check_Limited_Return (Orig_N, Expr, Typ);
535 -- If this is a wrapper created in an instance for a formal
536 -- subprogram, insert body after declaration, to be analyzed when the
537 -- enclosing instance is analyzed.
540 and then Is_Generic_Actual_Subprogram (Def_Id)
542 Insert_After (N, New_Body);
544 -- To prevent premature freeze action, insert the new body at the end
545 -- of the current declarations, or at the end of the package spec.
546 -- However, resolve usage names now, to prevent spurious visibility
547 -- on later entities. Note that the function can now be called in
548 -- the current declarative part, which will appear to be prior to the
549 -- presence of the body in the code. There are nevertheless no order
550 -- of elaboration issues because all name resolution has taken place
551 -- at the point of declaration.
555 Decls : List_Id := List_Containing (N);
556 Par : constant Node_Id := Parent (Decls);
559 if Nkind (Par) = N_Package_Specification
560 and then Decls = Visible_Declarations (Par)
561 and then not Is_Empty_List (Private_Declarations (Par))
563 Decls := Private_Declarations (Par);
566 Insert_After (Last (Decls), New_Body);
570 -- In the case of an expression function marked with the aspect
571 -- Static, we need to check the requirement that the function's
572 -- expression is a potentially static expression. This is done
573 -- by making a full copy of the expression tree and performing
574 -- a special preanalysis on that tree with the global flag
575 -- Checking_Potentially_Static_Expression enabled. If the
576 -- resulting expression is static, then it's OK, but if not, that
577 -- means the expression violates the requirements of the Ada 2022
578 -- RM in 4.9(3.2/5-3.4/5) and we flag an error.
580 if Is_Static_Function (Def_Id) then
581 if not Is_Static_Expression (Expr) then
583 Exp_Copy : constant Node_Id := New_Copy_Tree (Expr);
585 Set_Checking_Potentially_Static_Expression (True);
587 Preanalyze_Formal_Expression (Exp_Copy, Typ);
589 if not Is_Static_Expression (Exp_Copy) then
591 ("static expression function requires "
592 & "potentially static expression", Expr);
595 Set_Checking_Potentially_Static_Expression (False);
599 -- We also make an additional copy of the expression and
600 -- replace the expression of the expression function with
601 -- this copy, because the currently present expression is
602 -- now associated with the body created for the static
603 -- expression function, which will later be analyzed and
604 -- possibly rewritten, and we need to have the separate
605 -- unanalyzed copy available for use with later static
609 (Original_Node (Subprogram_Spec (Def_Id)),
610 New_Copy_Tree (Expr));
612 -- Mark static expression functions as inlined, to ensure
613 -- that even calls with nonstatic actuals will be inlined.
615 Set_Has_Pragma_Inline (Def_Id);
616 Set_Is_Inlined (Def_Id);
620 -- Check incorrect use of dynamically tagged expression. This doesn't
621 -- fall out automatically when analyzing the generated function body,
622 -- because Check_Dynamically_Tagged_Expression deliberately ignores
623 -- nodes that don't come from source.
626 and then Is_Tagged_Type (Typ)
628 Check_Dynamically_Tagged_Expression
631 Related_Nod => Orig_N);
634 -- We must enforce checks for unreferenced formals in our newly
635 -- generated function, so we propagate the referenced flag from the
636 -- original spec to the new spec as well as setting Comes_From_Source.
638 if Present (Parameter_Specifications (New_Spec)) then
640 Form_New_Def : Entity_Id;
641 Form_New_Spec : Node_Id;
642 Form_Old_Def : Entity_Id;
643 Form_Old_Spec : Node_Id;
646 Form_New_Spec := First (Parameter_Specifications (New_Spec));
647 Form_Old_Spec := First (Parameter_Specifications (Spec));
649 while Present (Form_New_Spec) and then Present (Form_Old_Spec) loop
650 Form_New_Def := Defining_Identifier (Form_New_Spec);
651 Form_Old_Def := Defining_Identifier (Form_Old_Spec);
653 Set_Comes_From_Source (Form_New_Def, True);
655 -- Because of the usefulness of unreferenced controlling
656 -- formals we exempt them from unreferenced warnings by marking
657 -- them as always referenced.
659 Set_Referenced (Form_Old_Def,
660 (Is_Formal (Form_Old_Def)
661 and then Is_Controlling_Formal (Form_Old_Def))
662 or else Referenced (Form_Old_Def));
664 Next (Form_New_Spec);
665 Next (Form_Old_Spec);
669 end Analyze_Expression_Function;
671 ---------------------------------------
672 -- Analyze_Extended_Return_Statement --
673 ---------------------------------------
675 procedure Analyze_Extended_Return_Statement (N : Node_Id) is
677 Check_Compiler_Unit ("extended return statement", N);
678 Analyze_Return_Statement (N);
679 end Analyze_Extended_Return_Statement;
681 ----------------------------
682 -- Analyze_Function_Call --
683 ----------------------------
685 procedure Analyze_Function_Call (N : Node_Id) is
686 Actuals : constant List_Id := Parameter_Associations (N);
687 Func_Nam : constant Node_Id := Name (N);
693 -- A call of the form A.B (X) may be an Ada 2005 call, which is
694 -- rewritten as B (A, X). If the rewriting is successful, the call
695 -- has been analyzed and we just return.
697 if Nkind (Func_Nam) = N_Selected_Component
698 and then Name (N) /= Func_Nam
699 and then Is_Rewrite_Substitution (N)
700 and then Present (Etype (N))
705 -- If error analyzing name, then set Any_Type as result type and return
707 if Etype (Func_Nam) = Any_Type then
708 Set_Etype (N, Any_Type);
712 -- Otherwise analyze the parameters
714 if Present (Actuals) then
715 Actual := First (Actuals);
716 while Present (Actual) loop
718 Check_Parameterless_Call (Actual);
724 end Analyze_Function_Call;
726 -----------------------------
727 -- Analyze_Function_Return --
728 -----------------------------
730 procedure Analyze_Function_Return (N : Node_Id) is
731 Loc : constant Source_Ptr := Sloc (N);
732 Stm_Entity : constant Entity_Id := Return_Statement_Entity (N);
733 Scope_Id : constant Entity_Id := Return_Applies_To (Stm_Entity);
735 R_Type : constant Entity_Id := Etype (Scope_Id);
736 -- Function result subtype
738 procedure Check_No_Return_Expression (Return_Expr : Node_Id);
739 -- Ada 2022: Check that the return expression in a No_Return function
740 -- meets the conditions specified by RM 6.5.1(5.1/5).
742 procedure Check_Return_Construct_Accessibility (Return_Stmt : Node_Id);
743 -- Apply legality rule of 6.5 (5.9) to the access discriminants of an
744 -- aggregate in a return statement.
746 procedure Check_Return_Subtype_Indication (Obj_Decl : Node_Id);
747 -- Check that the return_subtype_indication properly matches the result
748 -- subtype of the function, as required by RM-6.5(5.1/2-5.3/2).
750 --------------------------------
751 -- Check_No_Return_Expression --
752 --------------------------------
754 procedure Check_No_Return_Expression (Return_Expr : Node_Id) is
755 Kind : constant Node_Kind := Nkind (Return_Expr);
758 if Kind = N_Raise_Expression then
761 elsif Kind = N_Function_Call
762 and then Is_Entity_Name (Name (Return_Expr))
763 and then Ekind (Entity (Name (Return_Expr))) in
764 E_Function | E_Generic_Function
765 and then No_Return (Entity (Name (Return_Expr)))
771 ("illegal expression in RETURN statement of No_Return function",
774 ("\must be raise expression or call to No_Return (RM 6.5.1(5.1/5))",
776 end Check_No_Return_Expression;
778 ------------------------------------------
779 -- Check_Return_Construct_Accessibility --
780 ------------------------------------------
782 procedure Check_Return_Construct_Accessibility (Return_Stmt : Node_Id) is
784 function First_Selector (Assoc : Node_Id) return Node_Id;
785 -- Obtain the first selector or choice from a given association
791 function First_Selector (Assoc : Node_Id) return Node_Id is
793 if Nkind (Assoc) = N_Component_Association then
794 return First (Choices (Assoc));
796 elsif Nkind (Assoc) = N_Discriminant_Association then
797 return (First (Selector_Names (Assoc)));
804 -- Local declarations
806 Assoc : Node_Id := Empty;
807 -- Assoc should perhaps be renamed and declared as a
808 -- Node_Or_Entity_Id since it encompasses not only component and
809 -- discriminant associations, but also discriminant components within
810 -- a type declaration or subtype indication ???
812 Assoc_Expr : Node_Id;
813 Assoc_Present : Boolean := False;
815 Unseen_Disc_Count : Nat := 0;
816 Seen_Discs : Elist_Id;
818 First_Disc : Entity_Id;
821 Return_Con : Node_Id;
824 -- Start of processing for Check_Return_Construct_Accessibility
827 -- Only perform checks on record types with access discriminants and
828 -- non-internally generated functions.
830 if not Is_Record_Type (R_Type)
831 or else not Has_Anonymous_Access_Discriminant (R_Type)
832 or else not Comes_From_Source (Return_Stmt)
837 -- We are only interested in return statements
839 if Nkind (Return_Stmt) not in
840 N_Extended_Return_Statement | N_Simple_Return_Statement
845 -- Fetch the object from the return statement, in the case of a
846 -- simple return statement the expression is part of the node.
848 if Nkind (Return_Stmt) = N_Extended_Return_Statement then
849 -- Obtain the object definition from the expanded extended return
851 Return_Con := First (Return_Object_Declarations (Return_Stmt));
852 while Present (Return_Con) loop
853 -- Inspect the original node to avoid object declarations
854 -- expanded into renamings.
856 if Nkind (Original_Node (Return_Con)) = N_Object_Declaration
857 and then Comes_From_Source (Original_Node (Return_Con))
862 Nlists.Next (Return_Con);
865 pragma Assert (Present (Return_Con));
867 -- Could be dealing with a renaming
869 Return_Con := Original_Node (Return_Con);
871 Return_Con := Expression (Return_Stmt);
874 -- Obtain the accessibility levels of the expressions associated
875 -- with all anonymous access discriminants, then generate a
876 -- dynamic check or static error when relevant.
878 Unqual := Unqualify (Original_Node (Return_Con));
880 -- Get the corresponding declaration based on the return object's
883 if Nkind (Unqual) = N_Identifier
884 and then Nkind (Parent (Entity (Unqual)))
885 in N_Object_Declaration
886 | N_Object_Renaming_Declaration
888 Obj_Decl := Original_Node (Parent (Entity (Unqual)));
890 -- We were passed the object declaration directly, so use it
892 elsif Nkind (Unqual) in N_Object_Declaration
893 | N_Object_Renaming_Declaration
897 -- Otherwise, we are looking at something else
904 -- Hop up object renamings when present
906 if Present (Obj_Decl)
907 and then Nkind (Obj_Decl) = N_Object_Renaming_Declaration
909 while Nkind (Obj_Decl) = N_Object_Renaming_Declaration loop
911 if Nkind (Name (Obj_Decl)) not in N_Entity then
912 -- We may be looking at the expansion of iterators or
913 -- some other internally generated construct, so it is safe
914 -- to ignore checks ???
916 if not Comes_From_Source (Obj_Decl) then
920 Obj_Decl := Original_Node
922 (Ultimate_Prefix (Name (Obj_Decl))));
924 -- Move up to the next declaration based on the object's name
927 Obj_Decl := Original_Node
928 (Declaration_Node (Name (Obj_Decl)));
933 -- Obtain the discriminant values from the return aggregate
935 -- Do we cover extension aggregates correctly ???
937 if Nkind (Unqual) = N_Aggregate then
938 if Present (Expressions (Unqual)) then
939 Assoc := First (Expressions (Unqual));
941 Assoc := First (Component_Associations (Unqual));
944 -- There is an object declaration for the return object
946 elsif Present (Obj_Decl) then
947 -- When a subtype indication is present in an object declaration
948 -- it must contain the object's discriminants.
950 if Nkind (Object_Definition (Obj_Decl)) = N_Subtype_Indication then
954 (Object_Definition (Obj_Decl))));
956 -- The object declaration contains an aggregate
958 elsif Present (Expression (Obj_Decl)) then
960 if Nkind (Unqualify (Expression (Obj_Decl))) = N_Aggregate then
961 -- Grab the first associated discriminant expresion
964 (Expressions (Unqualify (Expression (Obj_Decl))))
968 (Unqualify (Expression (Obj_Decl))));
971 (Component_Associations
972 (Unqualify (Expression (Obj_Decl))));
975 -- Otherwise, this is something else
981 -- There are no supplied discriminants in the object declaration,
982 -- so get them from the type definition since they must be default
985 -- Do we handle constrained subtypes correctly ???
987 elsif Nkind (Unqual) = N_Object_Declaration then
988 Assoc := First_Discriminant
989 (Etype (Object_Definition (Obj_Decl)));
992 Assoc := First_Discriminant (Etype (Unqual));
995 -- When we are not looking at an aggregate or an identifier, return
996 -- since any other construct (like a function call) is not
997 -- applicable since checks will be performed on the side of the
1004 -- Obtain the discriminants so we know the actual type in case the
1005 -- value of their associated expression gets implicitly converted.
1007 if No (Obj_Decl) then
1008 pragma Assert (Nkind (Unqual) = N_Aggregate);
1010 Disc := First_Discriminant (Etype (Unqual));
1013 Disc := First_Discriminant
1014 (Etype (Defining_Identifier (Obj_Decl)));
1017 -- Preserve the first discriminant for checking named associations
1021 -- Count the number of discriminants for processing an aggregate
1022 -- which includes an others.
1025 while Present (Disc) loop
1026 Unseen_Disc_Count := Unseen_Disc_Count + 1;
1028 Next_Discriminant (Disc);
1031 Seen_Discs := New_Elmt_List;
1033 -- Loop through each of the discriminants and check each expression
1034 -- associated with an anonymous access discriminant.
1036 -- When named associations occur in the return aggregate then
1037 -- discriminants can be in any order, so we need to ensure we do
1038 -- not continue to loop when all discriminants have been seen.
1041 while Present (Assoc)
1042 and then (Present (Disc) or else Assoc_Present)
1043 and then Unseen_Disc_Count > 0
1045 -- Handle named associations by searching through the names of
1046 -- the relevant discriminant components.
1049 in N_Component_Association | N_Discriminant_Association
1051 Assoc_Expr := Expression (Assoc);
1052 Assoc_Present := True;
1054 -- We currently don't handle box initialized discriminants,
1055 -- however, since default initialized anonymous access
1056 -- discriminants are a corner case, this is ok for now ???
1058 if Nkind (Assoc) = N_Component_Association
1059 and then Box_Present (Assoc)
1061 Assoc_Present := False;
1063 if Nkind (First_Selector (Assoc)) = N_Others_Choice then
1064 Unseen_Disc_Count := 0;
1067 -- When others is present we must identify a discriminant we
1068 -- haven't already seen so as to get the appropriate type for
1069 -- the static accessibility check.
1071 -- This works because all components within an others clause
1072 -- must have the same type.
1074 elsif Nkind (First_Selector (Assoc)) = N_Others_Choice then
1077 Outer : while Present (Disc) loop
1079 Current_Seen_Disc : Elmt_Id;
1081 -- Move through the list of identified discriminants
1083 Current_Seen_Disc := First_Elmt (Seen_Discs);
1084 while Present (Current_Seen_Disc) loop
1085 -- Exit the loop when we found a match
1088 Chars (Node (Current_Seen_Disc)) = Chars (Disc);
1090 Next_Elmt (Current_Seen_Disc);
1093 -- When we have exited the above loop without finding
1094 -- a match then we know that Disc has not been seen.
1096 exit Outer when No (Current_Seen_Disc);
1099 Next_Discriminant (Disc);
1102 -- If we got to an others clause with a non-zero
1103 -- discriminant count there must be a discriminant left to
1106 pragma Assert (Present (Disc));
1108 -- Set the unseen discriminant count to zero because we know
1109 -- an others clause sets all remaining components of an
1112 Unseen_Disc_Count := 0;
1114 -- Move through each of the selectors in the named association
1115 -- and obtain a discriminant for accessibility checking if one
1116 -- is referenced in the list. Also track which discriminants
1117 -- are referenced for the purpose of handling an others clause.
1121 Assoc_Choice : Node_Id;
1122 Curr_Disc : Node_Id;
1126 Curr_Disc := First_Disc;
1127 while Present (Curr_Disc) loop
1128 -- Check each of the choices in the associations for a
1129 -- match to the name of the current discriminant.
1131 Assoc_Choice := First_Selector (Assoc);
1132 while Present (Assoc_Choice) loop
1133 -- When the name matches we track that we have seen
1134 -- the discriminant, but instead of exiting the
1135 -- loop we continue iterating to make sure all the
1136 -- discriminants within the named association get
1139 if Chars (Assoc_Choice) = Chars (Curr_Disc) then
1140 Append_Elmt (Curr_Disc, Seen_Discs);
1143 Unseen_Disc_Count := Unseen_Disc_Count - 1;
1146 Next (Assoc_Choice);
1149 Next_Discriminant (Curr_Disc);
1154 -- Unwrap the associated expression if we are looking at a default
1155 -- initialized type declaration. In this case Assoc is not really
1156 -- an association, but a component declaration. Should Assoc be
1157 -- renamed in some way to be more clear ???
1159 -- This occurs when the return object does not initialize
1160 -- discriminant and instead relies on the type declaration for
1161 -- their supplied values.
1163 elsif Nkind (Assoc) in N_Entity
1164 and then Ekind (Assoc) = E_Discriminant
1166 Append_Elmt (Disc, Seen_Discs);
1168 Assoc_Expr := Discriminant_Default_Value (Assoc);
1169 Unseen_Disc_Count := Unseen_Disc_Count - 1;
1171 -- Otherwise, there is nothing to do because Assoc is an
1172 -- expression within the return aggregate itself.
1175 Append_Elmt (Disc, Seen_Discs);
1177 Assoc_Expr := Assoc;
1178 Unseen_Disc_Count := Unseen_Disc_Count - 1;
1181 -- Check the accessibility level of the expression when the
1182 -- discriminant is of an anonymous access type.
1184 if Present (Assoc_Expr)
1185 and then Present (Disc)
1186 and then Ekind (Etype (Disc)) = E_Anonymous_Access_Type
1188 -- Perform a static check first, if possible
1190 if Static_Accessibility_Level
1191 (Expr => Assoc_Expr,
1192 Level => Zero_On_Dynamic_Level,
1193 In_Return_Context => True)
1194 > Scope_Depth (Scope (Scope_Id))
1197 ("access discriminant in return object would be a dangling"
1198 & " reference", Return_Stmt);
1203 -- Otherwise, generate a dynamic check based on the extra
1204 -- accessibility of the result.
1206 if Present (Extra_Accessibility_Of_Result (Scope_Id)) then
1207 Insert_Before_And_Analyze (Return_Stmt,
1208 Make_Raise_Program_Error (Loc,
1211 Left_Opnd => Accessibility_Level
1212 (Expr => Assoc_Expr,
1213 Level => Dynamic_Level,
1214 In_Return_Context => True),
1215 Right_Opnd => Extra_Accessibility_Of_Result
1217 Reason => PE_Accessibility_Check_Failed));
1221 -- Iterate over the discriminants, except when we have encountered
1222 -- a named association since the discriminant order becomes
1223 -- irrelevant in that case.
1225 if not Assoc_Present then
1226 Next_Discriminant (Disc);
1229 -- Iterate over associations
1231 if not Is_List_Member (Assoc) then
1234 Nlists.Next (Assoc);
1237 end Check_Return_Construct_Accessibility;
1239 -------------------------------------
1240 -- Check_Return_Subtype_Indication --
1241 -------------------------------------
1243 procedure Check_Return_Subtype_Indication (Obj_Decl : Node_Id) is
1244 Return_Obj : constant Node_Id := Defining_Identifier (Obj_Decl);
1246 R_Stm_Type : constant Entity_Id := Etype (Return_Obj);
1247 -- Subtype given in the extended return statement (must match R_Type)
1249 Subtype_Ind : constant Node_Id :=
1250 Object_Definition (Original_Node (Obj_Decl));
1252 procedure Error_No_Match (N : Node_Id);
1253 -- Output error messages for case where types do not statically
1254 -- match. N is the location for the messages.
1256 --------------------
1257 -- Error_No_Match --
1258 --------------------
1260 procedure Error_No_Match (N : Node_Id) is
1263 ("subtype must statically match function result subtype", N);
1265 if not Predicates_Match (R_Stm_Type, R_Type) then
1266 Error_Msg_Node_2 := R_Type;
1268 ("\predicate of& does not match predicate of&",
1273 -- Start of processing for Check_Return_Subtype_Indication
1276 -- First, avoid cascaded errors
1278 if Error_Posted (Obj_Decl) or else Error_Posted (Subtype_Ind) then
1282 -- "return access T" case; check that the return statement also has
1283 -- "access T", and that the subtypes statically match:
1284 -- if this is an access to subprogram the signatures must match.
1286 if Is_Anonymous_Access_Type (R_Type) then
1287 if Is_Anonymous_Access_Type (R_Stm_Type) then
1288 if Ekind (Designated_Type (R_Stm_Type)) /= E_Subprogram_Type
1290 if Base_Type (Designated_Type (R_Stm_Type)) /=
1291 Base_Type (Designated_Type (R_Type))
1292 or else not Subtypes_Statically_Match (R_Stm_Type, R_Type)
1294 Error_No_Match (Subtype_Mark (Subtype_Ind));
1298 -- For two anonymous access to subprogram types, the types
1299 -- themselves must be type conformant.
1301 if not Conforming_Types
1302 (R_Stm_Type, R_Type, Fully_Conformant)
1304 Error_No_Match (Subtype_Ind);
1309 Error_Msg_N ("must use anonymous access type", Subtype_Ind);
1312 -- If the return object is of an anonymous access type, then report
1313 -- an error if the function's result type is not also anonymous.
1315 elsif Is_Anonymous_Access_Type (R_Stm_Type) then
1316 pragma Assert (not Is_Anonymous_Access_Type (R_Type));
1318 ("anonymous access not allowed for function with named access "
1319 & "result", Subtype_Ind);
1321 -- Subtype indication case: check that the return object's type is
1322 -- covered by the result type, and that the subtypes statically match
1323 -- when the result subtype is constrained. Also handle record types
1324 -- with unknown discriminants for which we have built the underlying
1325 -- record view. Coverage is needed to allow specific-type return
1326 -- objects when the result type is class-wide (see AI05-32).
1328 elsif Covers (Base_Type (R_Type), Base_Type (R_Stm_Type))
1329 or else (Is_Underlying_Record_View (Base_Type (R_Stm_Type))
1332 (Base_Type (R_Type),
1333 Underlying_Record_View (Base_Type (R_Stm_Type))))
1335 -- A null exclusion may be present on the return type, on the
1336 -- function specification, on the object declaration or on the
1339 if Is_Access_Type (R_Type)
1341 (Can_Never_Be_Null (R_Type)
1342 or else Null_Exclusion_Present (Parent (Scope_Id))) /=
1343 Can_Never_Be_Null (R_Stm_Type)
1345 Error_No_Match (Subtype_Ind);
1348 -- AI05-103: for elementary types, subtypes must statically match
1350 if Is_Constrained (R_Type) or else Is_Access_Type (R_Type) then
1351 if not Subtypes_Statically_Match (R_Stm_Type, R_Type) then
1352 Error_No_Match (Subtype_Ind);
1356 -- All remaining cases are illegal
1358 -- Note: previous versions of this subprogram allowed the return
1359 -- value to be the ancestor of the return type if the return type
1360 -- was a null extension. This was plainly incorrect.
1364 ("wrong type for return_subtype_indication", Subtype_Ind);
1366 end Check_Return_Subtype_Indication;
1368 ---------------------
1369 -- Local Variables --
1370 ---------------------
1373 Obj_Decl : Node_Id := Empty;
1375 -- Start of processing for Analyze_Function_Return
1378 Set_Return_Present (Scope_Id);
1380 if Nkind (N) = N_Simple_Return_Statement then
1381 Expr := Expression (N);
1383 -- Guard against a malformed expression. The parser may have tried to
1384 -- recover but the node is not analyzable.
1386 if Nkind (Expr) = N_Error then
1387 Set_Etype (Expr, Any_Type);
1388 Expander_Mode_Save_And_Set (False);
1392 -- The resolution of a controlled [extension] aggregate associated
1393 -- with a return statement creates a temporary which needs to be
1394 -- finalized on function exit. Wrap the return statement inside a
1395 -- block so that the finalization machinery can detect this case.
1396 -- This early expansion is done only when the return statement is
1397 -- not part of a handled sequence of statements.
1399 if Nkind (Expr) in N_Aggregate | N_Extension_Aggregate
1400 and then Needs_Finalization (R_Type)
1401 and then Nkind (Parent (N)) /= N_Handled_Sequence_Of_Statements
1404 Make_Block_Statement (Loc,
1405 Handled_Statement_Sequence =>
1406 Make_Handled_Sequence_Of_Statements (Loc,
1407 Statements => New_List (Relocate_Node (N)))));
1415 -- Ada 2005 (AI-251): If the type of the returned object is
1416 -- an access to an interface type then we add an implicit type
1417 -- conversion to force the displacement of the "this" pointer to
1418 -- reference the secondary dispatch table. We cannot delay the
1419 -- generation of this implicit conversion until the expansion
1420 -- because in this case the type resolution changes the decoration
1421 -- of the expression node to match R_Type; by contrast, if the
1422 -- returned object is a class-wide interface type then it is too
1423 -- early to generate here the implicit conversion since the return
1424 -- statement may be rewritten by the expander into an extended
1425 -- return statement whose expansion takes care of adding the
1426 -- implicit type conversion to displace the pointer to the object.
1429 and then Serious_Errors_Detected = 0
1430 and then Is_Access_Type (R_Type)
1431 and then Nkind (Expr) not in N_Null | N_Raise_Expression
1432 and then Is_Interface (Designated_Type (R_Type))
1433 and then Is_Progenitor (Designated_Type (R_Type),
1434 Designated_Type (Etype (Expr)))
1436 Rewrite (Expr, Convert_To (R_Type, Relocate_Node (Expr)));
1440 Resolve (Expr, R_Type);
1441 Check_Limited_Return (N, Expr, R_Type);
1443 Check_Return_Construct_Accessibility (N);
1445 -- Ada 2022 (AI12-0269): Any return statement that applies to a
1446 -- nonreturning function shall be a simple_return_statement with
1447 -- an expression that is a raise_expression, or else a call on a
1448 -- nonreturning function, or else a parenthesized expression of
1451 if Ada_Version >= Ada_2022
1452 and then No_Return (Scope_Id)
1453 and then Comes_From_Source (N)
1455 Check_No_Return_Expression (Original_Node (Expr));
1459 Obj_Decl := Last (Return_Object_Declarations (N));
1461 -- Analyze parts specific to extended_return_statement:
1464 Has_Aliased : constant Boolean := Aliased_Present (Obj_Decl);
1465 HSS : constant Node_Id := Handled_Statement_Sequence (N);
1468 Expr := Expression (Obj_Decl);
1470 -- Note: The check for OK_For_Limited_Init will happen in
1471 -- Analyze_Object_Declaration; we treat it as a normal
1472 -- object declaration.
1474 Set_Is_Return_Object (Defining_Identifier (Obj_Decl));
1476 -- Returning a build-in-place unconstrained array type we defer
1477 -- the full analysis of the returned object to avoid generating
1478 -- the corresponding constrained subtype; otherwise the bounds
1479 -- would be created in the stack and a dangling reference would
1480 -- be returned pointing to the bounds. We perform its preanalysis
1481 -- to report errors on the initializing aggregate now (if any);
1482 -- we also ensure its activation chain and Master variable are
1483 -- defined (if tasks are being declared) since they are generated
1484 -- as part of the analysis and expansion of the object declaration
1487 if Is_Array_Type (R_Type)
1488 and then not Is_Constrained (R_Type)
1489 and then Is_Build_In_Place_Function (Scope_Id)
1490 and then Needs_BIP_Alloc_Form (Scope_Id)
1491 and then Nkind (Expr) in N_Aggregate | N_Extension_Aggregate
1493 Preanalyze (Obj_Decl);
1495 if Expander_Active then
1496 Ensure_Activation_Chain_And_Master (Obj_Decl);
1503 Check_Return_Subtype_Indication (Obj_Decl);
1505 if Present (HSS) then
1508 if Present (Exception_Handlers (HSS)) then
1510 -- ???Has_Nested_Block_With_Handler needs to be set.
1511 -- Probably by creating an actual N_Block_Statement.
1512 -- Probably in Expand.
1518 -- Mark the return object as referenced, since the return is an
1519 -- implicit reference of the object.
1521 Set_Referenced (Defining_Identifier (Obj_Decl));
1523 Check_References (Stm_Entity);
1525 Check_Return_Construct_Accessibility (N);
1527 -- Check RM 6.5 (5.9/3)
1530 if Ada_Version < Ada_2012
1531 and then Warn_On_Ada_2012_Compatibility
1534 ("ALIASED only allowed for limited return objects "
1535 & "in Ada 2012?y?", N);
1537 elsif not Is_Limited_View (R_Type) then
1539 ("ALIASED only allowed for limited return objects", N);
1543 -- Ada 2022 (AI12-0269): Any return statement that applies to a
1544 -- nonreturning function shall be a simple_return_statement.
1546 if Ada_Version >= Ada_2022
1547 and then No_Return (Scope_Id)
1548 and then Comes_From_Source (N)
1551 ("extended RETURN statement not allowed in No_Return "
1557 -- Case of Expr present
1559 if Present (Expr) then
1561 -- Defend against previous errors
1563 if Nkind (Expr) = N_Empty
1564 or else No (Etype (Expr))
1569 -- Apply constraint check. Note that this is done before the implicit
1570 -- conversion of the expression done for anonymous access types to
1571 -- ensure correct generation of the null-excluding check associated
1572 -- with null-excluding expressions found in return statements. We
1573 -- don't need a check if the subtype of the return object is the
1574 -- same as the result subtype of the function.
1576 if Nkind (N) /= N_Extended_Return_Statement
1577 or else Nkind (Obj_Decl) /= N_Object_Declaration
1578 or else Nkind (Object_Definition (Obj_Decl)) not in N_Has_Entity
1579 or else Entity (Object_Definition (Obj_Decl)) /= R_Type
1581 Apply_Constraint_Check (Expr, R_Type);
1584 -- The return value is converted to the return type of the function,
1585 -- which implies a predicate check if the return type is predicated.
1586 -- We do not apply the check for an extended return statement because
1587 -- Analyze_Object_Declaration has already done it on Obj_Decl above.
1588 -- We do not apply the check to a case expression because it will
1589 -- be expanded into a series of return statements, each of which
1590 -- will receive a predicate check.
1592 if Nkind (N) /= N_Extended_Return_Statement
1593 and then Nkind (Expr) /= N_Case_Expression
1595 Apply_Predicate_Check (Expr, R_Type);
1598 -- Ada 2005 (AI-318-02): When the result type is an anonymous access
1599 -- type, apply an implicit conversion of the expression to that type
1600 -- to force appropriate static and run-time accessibility checks.
1601 -- But we want to apply the checks to an extended return statement
1602 -- only once, i.e. not to the simple return statement generated at
1603 -- the end of its expansion because, prior to leaving the function,
1604 -- the accessibility level of the return object changes to be a level
1605 -- determined by the point of call (RM 3.10.2(10.8/3)).
1607 if Ada_Version >= Ada_2005
1608 and then Ekind (R_Type) = E_Anonymous_Access_Type
1609 and then (Nkind (N) = N_Extended_Return_Statement
1610 or else not Comes_From_Extended_Return_Statement (N))
1612 Rewrite (Expr, Convert_To (R_Type, Relocate_Node (Expr)));
1613 Analyze_And_Resolve (Expr, R_Type);
1615 -- If this is a local anonymous access to subprogram, the
1616 -- accessibility check can be applied statically. The return is
1617 -- illegal if the access type of the return expression is declared
1618 -- inside of the subprogram (except if it is the subtype indication
1619 -- of an extended return statement).
1621 elsif Ekind (R_Type) = E_Anonymous_Access_Subprogram_Type then
1622 if not Comes_From_Source (Current_Scope)
1623 or else Ekind (Current_Scope) = E_Return_Statement
1628 Scope_Depth (Scope (Etype (Expr))) >= Scope_Depth (Scope_Id)
1630 Error_Msg_N ("cannot return local access to subprogram", N);
1633 -- The expression cannot be of a formal incomplete type
1635 elsif Ekind (Etype (Expr)) = E_Incomplete_Type
1636 and then Is_Generic_Type (Etype (Expr))
1639 ("cannot return expression of a formal incomplete type", N);
1642 -- If the result type is class-wide, then check that the return
1643 -- expression's type is not declared at a deeper level than the
1644 -- function (RM05-6.5(5.6/2)).
1646 if Ada_Version >= Ada_2005
1647 and then Is_Class_Wide_Type (R_Type)
1649 if Type_Access_Level (Etype (Expr)) >
1650 Subprogram_Access_Level (Scope_Id)
1653 ("level of return expression type is deeper than "
1654 & "class-wide function!", Expr);
1658 -- Check incorrect use of dynamically tagged expression
1660 if Is_Tagged_Type (R_Type) then
1661 Check_Dynamically_Tagged_Expression
1667 -- Perform static accessibility checks for cases involving
1668 -- dereferences of access parameters. Runtime accessibility checks
1669 -- get generated elsewhere.
1671 if (Ada_Version < Ada_2005 or else Debug_Flag_Dot_L)
1672 and then Is_Limited_View (Etype (Scope_Id))
1673 and then Static_Accessibility_Level (Expr, Zero_On_Dynamic_Level)
1674 > Subprogram_Access_Level (Scope_Id)
1676 -- Suppress the message in a generic, where the rewriting
1679 if Inside_A_Generic then
1684 Make_Raise_Program_Error (Loc,
1685 Reason => PE_Accessibility_Check_Failed));
1688 Error_Msg_Warn := SPARK_Mode /= On;
1689 Error_Msg_N ("cannot return a local value by reference<<", N);
1690 Error_Msg_NE ("\& [<<", N, Standard_Program_Error);
1694 if Known_Null (Expr)
1695 and then Nkind (Parent (Scope_Id)) = N_Function_Specification
1696 and then Null_Exclusion_Present (Parent (Scope_Id))
1698 Apply_Compile_Time_Constraint_Error
1700 Msg => "(Ada 2005) null not allowed for "
1701 & "null-excluding return??",
1702 Reason => CE_Null_Not_Allowed);
1705 -- RM 6.5 (5.4/3): accessibility checks also apply if the return object
1706 -- has no initializing expression.
1708 elsif Ada_Version > Ada_2005 and then Is_Class_Wide_Type (R_Type) then
1709 if Type_Access_Level (Etype (Defining_Identifier (Obj_Decl))) >
1710 Subprogram_Access_Level (Scope_Id)
1713 ("level of return expression type is deeper than "
1714 & "class-wide function!", Obj_Decl);
1717 end Analyze_Function_Return;
1719 -------------------------------------
1720 -- Analyze_Generic_Subprogram_Body --
1721 -------------------------------------
1723 procedure Analyze_Generic_Subprogram_Body
1727 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Id);
1728 Kind : constant Entity_Kind := Ekind (Gen_Id);
1729 Body_Id : Entity_Id;
1734 -- Copy body and disable expansion while analyzing the generic For a
1735 -- stub, do not copy the stub (which would load the proper body), this
1736 -- will be done when the proper body is analyzed.
1738 if Nkind (N) /= N_Subprogram_Body_Stub then
1739 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
1742 -- Once the contents of the generic copy and the template are
1743 -- swapped, do the same for their respective aspect specifications.
1745 Exchange_Aspects (N, New_N);
1747 -- Collect all contract-related source pragmas found within the
1748 -- template and attach them to the contract of the subprogram body.
1749 -- This contract is used in the capture of global references within
1752 Create_Generic_Contract (N);
1757 Spec := Specification (N);
1759 -- Within the body of the generic, the subprogram is callable, and
1760 -- behaves like the corresponding non-generic unit.
1762 Body_Id := Defining_Entity (Spec);
1764 if Kind = E_Generic_Procedure
1765 and then Nkind (Spec) /= N_Procedure_Specification
1767 Error_Msg_N ("invalid body for generic procedure", Body_Id);
1770 elsif Kind = E_Generic_Function
1771 and then Nkind (Spec) /= N_Function_Specification
1773 Error_Msg_N ("invalid body for generic function", Body_Id);
1777 Set_Corresponding_Body (Gen_Decl, Body_Id);
1779 if Has_Completion (Gen_Id)
1780 and then Nkind (Parent (N)) /= N_Subunit
1782 Error_Msg_N ("duplicate generic body", N);
1785 Set_Has_Completion (Gen_Id);
1788 if Nkind (N) = N_Subprogram_Body_Stub then
1789 Mutate_Ekind (Defining_Entity (Specification (N)), Kind);
1791 Set_Corresponding_Spec (N, Gen_Id);
1794 if Nkind (Parent (N)) = N_Compilation_Unit then
1795 Set_Cunit_Entity (Current_Sem_Unit, Defining_Entity (N));
1798 -- Make generic parameters immediately visible in the body. They are
1799 -- needed to process the formals declarations. Then make the formals
1800 -- visible in a separate step.
1802 Push_Scope (Gen_Id);
1806 First_Ent : Entity_Id;
1809 First_Ent := First_Entity (Gen_Id);
1812 while Present (E) and then not Is_Formal (E) loop
1817 Set_Use (Generic_Formal_Declarations (Gen_Decl));
1819 -- Now generic formals are visible, and the specification can be
1820 -- analyzed, for subsequent conformance check.
1822 Body_Id := Analyze_Subprogram_Specification (Spec);
1824 -- Make formal parameters visible
1828 -- E is the first formal parameter, we loop through the formals
1829 -- installing them so that they will be visible.
1831 Set_First_Entity (Gen_Id, E);
1832 while Present (E) loop
1838 -- Visible generic entity is callable within its own body
1840 Mutate_Ekind (Gen_Id, Ekind (Body_Id));
1841 Reinit_Field_To_Zero (Body_Id, F_Has_Out_Or_In_Out_Parameter,
1843 (E_Function | E_Procedure |
1844 E_Generic_Function | E_Generic_Procedure => True,
1846 Mutate_Ekind (Body_Id, E_Subprogram_Body);
1847 Set_Convention (Body_Id, Convention (Gen_Id));
1848 Set_Is_Obsolescent (Body_Id, Is_Obsolescent (Gen_Id));
1849 Set_Scope (Body_Id, Scope (Gen_Id));
1851 Check_Fully_Conformant (Body_Id, Gen_Id, Body_Id);
1853 if Nkind (N) = N_Subprogram_Body_Stub then
1855 -- No body to analyze, so restore state of generic unit
1857 Mutate_Ekind (Gen_Id, Kind);
1858 Mutate_Ekind (Body_Id, Kind);
1860 if Present (First_Ent) then
1861 Set_First_Entity (Gen_Id, First_Ent);
1868 -- If this is a compilation unit, it must be made visible explicitly,
1869 -- because the compilation of the declaration, unlike other library
1870 -- unit declarations, does not. If it is not a unit, the following
1871 -- is redundant but harmless.
1873 Set_Is_Immediately_Visible (Gen_Id);
1874 Reference_Body_Formals (Gen_Id, Body_Id);
1876 if Is_Child_Unit (Gen_Id) then
1877 Generate_Reference (Gen_Id, Scope (Gen_Id), 'k', False);
1880 Set_Actual_Subtypes (N, Current_Scope);
1882 Set_SPARK_Pragma (Body_Id, SPARK_Mode_Pragma);
1883 Set_SPARK_Pragma_Inherited (Body_Id);
1885 -- Analyze any aspect specifications that appear on the generic
1888 if Has_Aspects (N) then
1889 Analyze_Aspects_On_Subprogram_Body_Or_Stub (N);
1892 Analyze_Declarations (Declarations (N));
1895 -- Process the contract of the subprogram body after all declarations
1896 -- have been analyzed. This ensures that any contract-related pragmas
1897 -- are available through the N_Contract node of the body.
1899 Analyze_Entry_Or_Subprogram_Body_Contract (Body_Id);
1901 Analyze (Handled_Statement_Sequence (N));
1902 Save_Global_References (Original_Node (N));
1904 -- Prior to exiting the scope, include generic formals again (if any
1905 -- are present) in the set of local entities.
1907 if Present (First_Ent) then
1908 Set_First_Entity (Gen_Id, First_Ent);
1911 Check_References (Gen_Id);
1914 Process_End_Label (Handled_Statement_Sequence (N), 't', Current_Scope);
1915 Update_Use_Clause_Chain;
1916 Validate_Categorization_Dependency (N, Gen_Id);
1918 Check_Subprogram_Order (N);
1920 -- Outside of its body, unit is generic again
1922 Reinit_Field_To_Zero (Gen_Id, F_Has_Nested_Subprogram,
1923 Old_Ekind => (E_Function | E_Procedure => True, others => False));
1924 Mutate_Ekind (Gen_Id, Kind);
1925 Generate_Reference (Gen_Id, Body_Id, 'b', Set_Ref => False);
1928 Style.Check_Identifier (Body_Id, Gen_Id);
1932 end Analyze_Generic_Subprogram_Body;
1934 ----------------------------
1935 -- Analyze_Null_Procedure --
1936 ----------------------------
1938 -- WARNING: This routine manages Ghost regions. Return statements must be
1939 -- replaced by gotos that jump to the end of the routine and restore the
1942 procedure Analyze_Null_Procedure
1944 Is_Completion : out Boolean)
1946 Loc : constant Source_Ptr := Sloc (N);
1947 Spec : constant Node_Id := Specification (N);
1949 Saved_GM : constant Ghost_Mode_Type := Ghost_Mode;
1950 Saved_IGR : constant Node_Id := Ignored_Ghost_Region;
1951 Saved_ISMP : constant Boolean :=
1952 Ignore_SPARK_Mode_Pragmas_In_Instance;
1953 -- Save the Ghost and SPARK mode-related data to restore on exit
1955 Designator : Entity_Id;
1957 Null_Body : Node_Id := Empty;
1958 Null_Stmt : Node_Id := Null_Statement (Spec);
1962 Prev := Current_Entity_In_Scope (Defining_Entity (Spec));
1964 -- A null procedure is Ghost when it is stand-alone and is subject to
1965 -- pragma Ghost, or when the corresponding spec is Ghost. Set the mode
1966 -- now, to ensure that any nodes generated during analysis and expansion
1967 -- are properly marked as Ghost.
1969 if Present (Prev) then
1970 Mark_And_Set_Ghost_Body (N, Prev);
1973 -- Capture the profile of the null procedure before analysis, for
1974 -- expansion at the freeze point and at each point of call. The body is
1975 -- used if the procedure has preconditions, or if it is a completion. In
1976 -- the first case the body is analyzed at the freeze point, in the other
1977 -- it replaces the null procedure declaration.
1979 -- For a null procedure that comes from source, a NULL statement is
1980 -- provided by the parser, which carries the source location of the
1981 -- NULL keyword, and has Comes_From_Source set. For a null procedure
1982 -- from expansion, create one now.
1984 if No (Null_Stmt) then
1985 Null_Stmt := Make_Null_Statement (Loc);
1989 Make_Subprogram_Body (Loc,
1990 Specification => New_Copy_Tree (Spec),
1991 Declarations => New_List,
1992 Handled_Statement_Sequence =>
1993 Make_Handled_Sequence_Of_Statements (Loc,
1994 Statements => New_List (Null_Stmt)));
1996 -- Create new entities for body and formals
1998 Set_Defining_Unit_Name (Specification (Null_Body),
1999 Make_Defining_Identifier
2000 (Sloc (Defining_Entity (N)),
2001 Chars (Defining_Entity (N))));
2003 Form := First (Parameter_Specifications (Specification (Null_Body)));
2004 while Present (Form) loop
2005 Set_Defining_Identifier (Form,
2006 Make_Defining_Identifier
2007 (Sloc (Defining_Identifier (Form)),
2008 Chars (Defining_Identifier (Form))));
2012 -- Determine whether the null procedure may be a completion of a generic
2013 -- suprogram, in which case we use the new null body as the completion
2014 -- and set minimal semantic information on the original declaration,
2015 -- which is rewritten as a null statement.
2017 if Present (Prev) and then Is_Generic_Subprogram (Prev) then
2018 Insert_Before (N, Null_Body);
2019 Mutate_Ekind (Defining_Entity (N), Ekind (Prev));
2021 Rewrite (N, Make_Null_Statement (Loc));
2022 Analyze_Generic_Subprogram_Body (Null_Body, Prev);
2023 Is_Completion := True;
2028 -- Resolve the types of the formals now, because the freeze point may
2029 -- appear in a different context, e.g. an instantiation.
2031 Form := First (Parameter_Specifications (Specification (Null_Body)));
2032 while Present (Form) loop
2033 if Nkind (Parameter_Type (Form)) /= N_Access_Definition then
2034 Find_Type (Parameter_Type (Form));
2036 elsif No (Access_To_Subprogram_Definition
2037 (Parameter_Type (Form)))
2039 Find_Type (Subtype_Mark (Parameter_Type (Form)));
2041 -- The case of a null procedure with a formal that is an
2042 -- access-to-subprogram type, and that is used as an actual
2043 -- in an instantiation is left to the enthusiastic reader.
2053 -- If there are previous overloadable entities with the same name, check
2054 -- whether any of them is completed by the null procedure.
2056 if Present (Prev) and then Is_Overloadable (Prev) then
2057 Designator := Analyze_Subprogram_Specification (Spec);
2058 Prev := Find_Corresponding_Spec (N);
2061 if No (Prev) or else not Comes_From_Source (Prev) then
2062 Designator := Analyze_Subprogram_Specification (Spec);
2063 Set_Has_Completion (Designator);
2065 -- Signal to caller that this is a procedure declaration
2067 Is_Completion := False;
2069 -- Null procedures are always inlined, but generic formal subprograms
2070 -- which appear as such in the internal instance of formal packages,
2071 -- need no completion and are not marked Inline.
2074 and then Nkind (N) /= N_Formal_Concrete_Subprogram_Declaration
2076 Set_Corresponding_Body (N, Defining_Entity (Null_Body));
2077 Set_Body_To_Inline (N, Null_Body);
2078 Set_Is_Inlined (Designator);
2082 -- The null procedure is a completion. We unconditionally rewrite
2083 -- this as a null body (even if expansion is not active), because
2084 -- there are various error checks that are applied on this body
2085 -- when it is analyzed (e.g. correct aspect placement).
2087 if Has_Completion (Prev) then
2088 Error_Msg_Sloc := Sloc (Prev);
2089 Error_Msg_NE ("duplicate body for & declared#", N, Prev);
2092 Check_Previous_Null_Procedure (N, Prev);
2094 Is_Completion := True;
2095 Rewrite (N, Null_Body);
2100 Ignore_SPARK_Mode_Pragmas_In_Instance := Saved_ISMP;
2101 Restore_Ghost_Region (Saved_GM, Saved_IGR);
2102 end Analyze_Null_Procedure;
2104 -----------------------------
2105 -- Analyze_Operator_Symbol --
2106 -----------------------------
2108 -- An operator symbol such as "+" or "and" may appear in context where the
2109 -- literal denotes an entity name, such as "+"(x, y) or in context when it
2110 -- is just a string, as in (conjunction = "or"). In these cases the parser
2111 -- generates this node, and the semantics does the disambiguation. Other
2112 -- such case are actuals in an instantiation, the generic unit in an
2113 -- instantiation, pragma arguments, and aspect specifications.
2115 procedure Analyze_Operator_Symbol (N : Node_Id) is
2116 Par : constant Node_Id := Parent (N);
2118 Maybe_Aspect_Spec : Node_Id := Par;
2120 if Nkind (Maybe_Aspect_Spec) /= N_Aspect_Specification then
2121 -- deal with N_Aggregate nodes
2122 Maybe_Aspect_Spec := Parent (Maybe_Aspect_Spec);
2125 if (Nkind (Par) = N_Function_Call and then N = Name (Par))
2126 or else Nkind (Par) = N_Function_Instantiation
2127 or else (Nkind (Par) = N_Indexed_Component and then N = Prefix (Par))
2128 or else (Nkind (Par) = N_Pragma_Argument_Association
2129 and then not Is_Pragma_String_Literal (Par))
2130 or else Nkind (Par) = N_Subprogram_Renaming_Declaration
2131 or else (Nkind (Par) = N_Attribute_Reference
2132 and then Attribute_Name (Par) /= Name_Value)
2133 or else (Nkind (Maybe_Aspect_Spec) = N_Aspect_Specification
2134 and then Get_Aspect_Id (Maybe_Aspect_Spec)
2135 -- include other aspects here ???
2136 in Aspect_Stable_Properties | Aspect_Aggregate)
2138 Find_Direct_Name (N);
2141 Change_Operator_Symbol_To_String_Literal (N);
2144 end Analyze_Operator_Symbol;
2146 -----------------------------------
2147 -- Analyze_Parameter_Association --
2148 -----------------------------------
2150 procedure Analyze_Parameter_Association (N : Node_Id) is
2152 Analyze (Explicit_Actual_Parameter (N));
2153 end Analyze_Parameter_Association;
2155 ----------------------------
2156 -- Analyze_Procedure_Call --
2157 ----------------------------
2159 -- WARNING: This routine manages Ghost regions. Return statements must be
2160 -- replaced by gotos that jump to the end of the routine and restore the
2163 procedure Analyze_Procedure_Call (N : Node_Id) is
2164 procedure Analyze_Call_And_Resolve;
2165 -- Do Analyze and Resolve calls for procedure call. At the end, check
2166 -- for illegal order dependence.
2167 -- ??? where is the check for illegal order dependencies?
2169 ------------------------------
2170 -- Analyze_Call_And_Resolve --
2171 ------------------------------
2173 procedure Analyze_Call_And_Resolve is
2175 if Nkind (N) = N_Procedure_Call_Statement then
2177 Resolve (N, Standard_Void_Type);
2181 end Analyze_Call_And_Resolve;
2185 Actuals : constant List_Id := Parameter_Associations (N);
2186 Loc : constant Source_Ptr := Sloc (N);
2187 P : constant Node_Id := Name (N);
2189 Saved_GM : constant Ghost_Mode_Type := Ghost_Mode;
2190 Saved_IGR : constant Node_Id := Ignored_Ghost_Region;
2191 -- Save the Ghost-related attributes to restore on exit
2196 -- Start of processing for Analyze_Procedure_Call
2199 -- The syntactic construct: PREFIX ACTUAL_PARAMETER_PART can denote
2200 -- a procedure call or an entry call. The prefix may denote an access
2201 -- to subprogram type, in which case an implicit dereference applies.
2202 -- If the prefix is an indexed component (without implicit dereference)
2203 -- then the construct denotes a call to a member of an entire family.
2204 -- If the prefix is a simple name, it may still denote a call to a
2205 -- parameterless member of an entry family. Resolution of these various
2206 -- interpretations is delicate.
2208 -- Do not analyze machine code statements to avoid rejecting them in
2211 if CodePeer_Mode and then Nkind (P) = N_Qualified_Expression then
2212 Set_Etype (P, Standard_Void_Type);
2217 -- If this is a call of the form Obj.Op, the call may have been analyzed
2218 -- and possibly rewritten into a block, in which case we are done.
2220 if Analyzed (N) then
2223 -- If there is an error analyzing the name (which may have been
2224 -- rewritten if the original call was in prefix notation) then error
2225 -- has been emitted already, mark node and return.
2227 elsif Error_Posted (N) or else Etype (Name (N)) = Any_Type then
2228 Set_Etype (N, Any_Type);
2232 -- A procedure call is Ghost when its name denotes a Ghost procedure.
2233 -- Set the mode now to ensure that any nodes generated during analysis
2234 -- and expansion are properly marked as Ghost.
2236 Mark_And_Set_Ghost_Procedure_Call (N);
2238 -- Otherwise analyze the parameters
2240 if Present (Actuals) then
2241 Actual := First (Actuals);
2243 while Present (Actual) loop
2245 Check_Parameterless_Call (Actual);
2250 -- Special processing for Elab_Spec, Elab_Body and Elab_Subp_Body calls
2252 if Nkind (P) = N_Attribute_Reference
2253 and then Attribute_Name (P) in Name_Elab_Spec
2255 | Name_Elab_Subp_Body
2257 if Present (Actuals) then
2259 ("no parameters allowed for this call", First (Actuals));
2263 Set_Etype (N, Standard_Void_Type);
2266 elsif Is_Entity_Name (P)
2267 and then Is_Record_Type (Etype (Entity (P)))
2268 and then Remote_AST_I_Dereference (P)
2272 elsif Is_Entity_Name (P)
2273 and then Ekind (Entity (P)) /= E_Entry_Family
2275 if Is_Access_Type (Etype (P))
2276 and then Ekind (Designated_Type (Etype (P))) = E_Subprogram_Type
2277 and then No (Actuals)
2278 and then Comes_From_Source (N)
2280 Error_Msg_N ("missing explicit dereference in call", N);
2282 elsif Ekind (Entity (P)) = E_Operator then
2283 Error_Msg_Name_1 := Chars (P);
2284 Error_Msg_N ("operator % cannot be used as a procedure", N);
2287 Analyze_Call_And_Resolve;
2289 -- If the prefix is the simple name of an entry family, this is a
2290 -- parameterless call from within the task body itself.
2292 elsif Is_Entity_Name (P)
2293 and then Nkind (P) = N_Identifier
2294 and then Ekind (Entity (P)) = E_Entry_Family
2295 and then Present (Actuals)
2296 and then No (Next (First (Actuals)))
2298 -- Can be call to parameterless entry family. What appears to be the
2299 -- sole argument is in fact the entry index. Rewrite prefix of node
2300 -- accordingly. Source representation is unchanged by this
2304 Make_Indexed_Component (Loc,
2306 Make_Selected_Component (Loc,
2307 Prefix => New_Occurrence_Of (Scope (Entity (P)), Loc),
2308 Selector_Name => New_Occurrence_Of (Entity (P), Loc)),
2309 Expressions => Actuals);
2310 Set_Name (N, New_N);
2311 Set_Etype (New_N, Standard_Void_Type);
2312 Set_Parameter_Associations (N, No_List);
2313 Analyze_Call_And_Resolve;
2315 elsif Nkind (P) = N_Explicit_Dereference then
2316 if Ekind (Etype (P)) = E_Subprogram_Type then
2317 Analyze_Call_And_Resolve;
2319 Error_Msg_N ("expect access to procedure in call", P);
2322 -- The name can be a selected component or an indexed component that
2323 -- yields an access to subprogram. Such a prefix is legal if the call
2324 -- has parameter associations.
2326 elsif Is_Access_Type (Etype (P))
2327 and then Ekind (Designated_Type (Etype (P))) = E_Subprogram_Type
2329 if Present (Actuals) then
2330 Analyze_Call_And_Resolve;
2332 Error_Msg_N ("missing explicit dereference in call", N);
2335 -- If not an access to subprogram, then the prefix must resolve to the
2336 -- name of an entry, entry family, or protected operation.
2338 -- For the case of a simple entry call, P is a selected component where
2339 -- the prefix is the task and the selector name is the entry. A call to
2340 -- a protected procedure will have the same syntax. If the protected
2341 -- object contains overloaded operations, the entity may appear as a
2342 -- function, the context will select the operation whose type is Void.
2344 elsif Nkind (P) = N_Selected_Component
2345 and then Ekind (Entity (Selector_Name (P)))
2346 in E_Entry | E_Function | E_Procedure
2348 -- When front-end inlining is enabled, as with SPARK_Mode, a call
2349 -- in prefix notation may still be missing its controlling argument,
2350 -- so perform the transformation now.
2352 if SPARK_Mode = On and then In_Inlined_Body then
2354 Subp : constant Entity_Id := Entity (Selector_Name (P));
2355 Typ : constant Entity_Id := Etype (Prefix (P));
2358 if Is_Tagged_Type (Typ)
2359 and then Present (First_Formal (Subp))
2360 and then (Etype (First_Formal (Subp)) = Typ
2362 Class_Wide_Type (Etype (First_Formal (Subp))) = Typ)
2363 and then Try_Object_Operation (P)
2368 Analyze_Call_And_Resolve;
2373 Analyze_Call_And_Resolve;
2376 elsif Nkind (P) = N_Selected_Component
2377 and then Ekind (Entity (Selector_Name (P))) = E_Entry_Family
2378 and then Present (Actuals)
2379 and then No (Next (First (Actuals)))
2381 -- Can be call to parameterless entry family. What appears to be the
2382 -- sole argument is in fact the entry index. Rewrite prefix of node
2383 -- accordingly. Source representation is unchanged by this
2387 Make_Indexed_Component (Loc,
2388 Prefix => New_Copy (P),
2389 Expressions => Actuals);
2390 Set_Name (N, New_N);
2391 Set_Etype (New_N, Standard_Void_Type);
2392 Set_Parameter_Associations (N, No_List);
2393 Analyze_Call_And_Resolve;
2395 -- For the case of a reference to an element of an entry family, P is
2396 -- an indexed component whose prefix is a selected component (task and
2397 -- entry family), and whose index is the entry family index.
2399 elsif Nkind (P) = N_Indexed_Component
2400 and then Nkind (Prefix (P)) = N_Selected_Component
2401 and then Ekind (Entity (Selector_Name (Prefix (P)))) = E_Entry_Family
2403 Analyze_Call_And_Resolve;
2405 -- If the prefix is the name of an entry family, it is a call from
2406 -- within the task body itself.
2408 elsif Nkind (P) = N_Indexed_Component
2409 and then Nkind (Prefix (P)) = N_Identifier
2410 and then Ekind (Entity (Prefix (P))) = E_Entry_Family
2413 Make_Selected_Component (Loc,
2415 New_Occurrence_Of (Scope (Entity (Prefix (P))), Loc),
2416 Selector_Name => New_Occurrence_Of (Entity (Prefix (P)), Loc));
2417 Rewrite (Prefix (P), New_N);
2419 Analyze_Call_And_Resolve;
2421 -- In Ada 2012. a qualified expression is a name, but it cannot be a
2422 -- procedure name, so the construct can only be a qualified expression.
2424 elsif Nkind (P) = N_Qualified_Expression
2425 and then Ada_Version >= Ada_2012
2427 Rewrite (N, Make_Code_Statement (Loc, Expression => P));
2430 -- Anything else is an error
2433 Error_Msg_N ("invalid procedure or entry call", N);
2435 -- Specialize the error message in the case where both a primitive
2436 -- operation and a record component are visible at the same time.
2438 if Nkind (P) = N_Selected_Component
2439 and then Is_Entity_Name (Selector_Name (P))
2442 Sel : constant Entity_Id := Entity (Selector_Name (P));
2444 if Ekind (Sel) = E_Component
2445 and then Present (Homonym (Sel))
2446 and then Ekind (Homonym (Sel)) = E_Procedure
2448 Error_Msg_NE ("\component & conflicts with"
2449 & " homonym procedure (RM 4.1.3 (9.2/3))",
2450 Selector_Name (P), Sel);
2457 Restore_Ghost_Region (Saved_GM, Saved_IGR);
2458 end Analyze_Procedure_Call;
2460 ------------------------------
2461 -- Analyze_Return_Statement --
2462 ------------------------------
2464 procedure Analyze_Return_Statement (N : Node_Id) is
2466 (Nkind (N) in N_Extended_Return_Statement | N_Simple_Return_Statement);
2468 Returns_Object : constant Boolean :=
2469 Nkind (N) = N_Extended_Return_Statement
2471 (Nkind (N) = N_Simple_Return_Statement
2472 and then Present (Expression (N)));
2473 -- True if we're returning something; that is, "return <expression>;"
2474 -- or "return Result : T [:= ...]". False for "return;". Used for error
2475 -- checking: If Returns_Object is True, N should apply to a function
2476 -- body; otherwise N should apply to a procedure body, entry body,
2477 -- accept statement, or extended return statement.
2479 function Find_What_It_Applies_To return Entity_Id;
2480 -- Find the entity representing the innermost enclosing body, accept
2481 -- statement, or extended return statement. If the result is a callable
2482 -- construct or extended return statement, then this will be the value
2483 -- of the Return_Applies_To attribute. Otherwise, the program is
2484 -- illegal. See RM-6.5(4/2).
2486 -----------------------------
2487 -- Find_What_It_Applies_To --
2488 -----------------------------
2490 function Find_What_It_Applies_To return Entity_Id is
2491 Result : Entity_Id := Empty;
2494 -- Loop outward through the Scope_Stack, skipping blocks, and loops
2496 for J in reverse 0 .. Scope_Stack.Last loop
2497 Result := Scope_Stack.Table (J).Entity;
2498 exit when Ekind (Result) not in E_Block | E_Loop;
2501 pragma Assert (Present (Result));
2503 end Find_What_It_Applies_To;
2505 -- Local declarations
2507 Scope_Id : constant Entity_Id := Find_What_It_Applies_To;
2508 Kind : constant Entity_Kind := Ekind (Scope_Id);
2509 Loc : constant Source_Ptr := Sloc (N);
2510 Stm_Entity : constant Entity_Id :=
2512 (E_Return_Statement, Current_Scope, Loc, 'R');
2514 -- Start of processing for Analyze_Return_Statement
2517 Set_Return_Statement_Entity (N, Stm_Entity);
2519 Set_Etype (Stm_Entity, Standard_Void_Type);
2520 Set_Return_Applies_To (Stm_Entity, Scope_Id);
2522 -- Place Return entity on scope stack, to simplify enforcement of 6.5
2523 -- (4/2): an inner return statement will apply to this extended return.
2525 if Nkind (N) = N_Extended_Return_Statement then
2526 Push_Scope (Stm_Entity);
2529 -- Check that pragma No_Return is obeyed. Don't complain about the
2530 -- implicitly-generated return that is placed at the end.
2532 if No_Return (Scope_Id)
2533 and then Kind in E_Procedure | E_Generic_Procedure
2534 and then Comes_From_Source (N)
2537 ("RETURN statement not allowed in No_Return procedure", N);
2540 -- Warn on any unassigned OUT parameters if in procedure
2542 if Ekind (Scope_Id) = E_Procedure then
2543 Warn_On_Unassigned_Out_Parameter (N, Scope_Id);
2546 -- Check that functions return objects, and other things do not
2548 if Kind in E_Function | E_Generic_Function then
2549 if not Returns_Object then
2550 Error_Msg_N ("missing expression in return from function", N);
2553 elsif Kind in E_Procedure | E_Generic_Procedure then
2554 if Returns_Object then
2555 Error_Msg_N ("procedure cannot return value (use function)", N);
2558 elsif Kind in E_Entry | E_Entry_Family then
2559 if Returns_Object then
2560 if Is_Protected_Type (Scope (Scope_Id)) then
2561 Error_Msg_N ("entry body cannot return value", N);
2563 Error_Msg_N ("accept statement cannot return value", N);
2567 elsif Kind = E_Return_Statement then
2569 -- We are nested within another return statement, which must be an
2570 -- extended_return_statement.
2572 if Returns_Object then
2573 if Nkind (N) = N_Extended_Return_Statement then
2575 ("extended return statement cannot be nested (use `RETURN;`)",
2578 -- Case of a simple return statement with a value inside extended
2579 -- return statement.
2583 ("return nested in extended return statement cannot return "
2584 & "value (use `RETURN;`)", N);
2589 Error_Msg_N ("illegal context for return statement", N);
2592 if Kind in E_Function | E_Generic_Function then
2593 Analyze_Function_Return (N);
2595 elsif Kind in E_Procedure | E_Generic_Procedure then
2596 Set_Return_Present (Scope_Id);
2599 if Nkind (N) = N_Extended_Return_Statement then
2603 Kill_Current_Values (Last_Assignment_Only => True);
2604 Check_Unreachable_Code (N);
2606 Analyze_Dimension (N);
2607 end Analyze_Return_Statement;
2609 -----------------------------------
2610 -- Analyze_Return_When_Statement --
2611 -----------------------------------
2613 procedure Analyze_Return_When_Statement (N : Node_Id) is
2615 -- Verify the condition is a Boolean expression
2617 Analyze_And_Resolve (Condition (N), Any_Boolean);
2618 Check_Unset_Reference (Condition (N));
2619 end Analyze_Return_When_Statement;
2621 -------------------------------------
2622 -- Analyze_Simple_Return_Statement --
2623 -------------------------------------
2625 procedure Analyze_Simple_Return_Statement (N : Node_Id) is
2627 if Present (Expression (N)) then
2628 Mark_Coextensions (N, Expression (N));
2631 Analyze_Return_Statement (N);
2632 end Analyze_Simple_Return_Statement;
2634 -------------------------
2635 -- Analyze_Return_Type --
2636 -------------------------
2638 procedure Analyze_Return_Type (N : Node_Id) is
2639 Designator : constant Entity_Id := Defining_Entity (N);
2640 Typ : Entity_Id := Empty;
2643 -- Normal case where result definition does not indicate an error
2645 if Result_Definition (N) /= Error then
2646 if Nkind (Result_Definition (N)) = N_Access_Definition then
2648 -- Ada 2005 (AI-254): Handle anonymous access to subprograms
2651 AD : constant Node_Id :=
2652 Access_To_Subprogram_Definition (Result_Definition (N));
2654 if Present (AD) and then Protected_Present (AD) then
2655 Typ := Replace_Anonymous_Access_To_Protected_Subprogram (N);
2657 Typ := Access_Definition (N, Result_Definition (N));
2661 Set_Parent (Typ, Result_Definition (N));
2662 Set_Is_Local_Anonymous_Access (Typ);
2663 Set_Etype (Designator, Typ);
2665 -- Ada 2005 (AI-231): Ensure proper usage of null exclusion
2667 Null_Exclusion_Static_Checks (N);
2669 -- Subtype_Mark case
2672 Find_Type (Result_Definition (N));
2673 Typ := Entity (Result_Definition (N));
2674 Set_Etype (Designator, Typ);
2676 -- Ada 2005 (AI-231): Ensure proper usage of null exclusion
2678 Null_Exclusion_Static_Checks (N);
2680 -- If a null exclusion is imposed on the result type, then create
2681 -- a null-excluding itype (an access subtype) and use it as the
2682 -- function's Etype. Note that the null exclusion checks are done
2683 -- right before this, because they don't get applied to types that
2684 -- do not come from source.
2686 if Is_Access_Type (Typ) and then Null_Exclusion_Present (N) then
2687 Set_Etype (Designator,
2688 Create_Null_Excluding_Itype
2691 Scope_Id => Scope (Current_Scope)));
2693 -- The new subtype must be elaborated before use because
2694 -- it is visible outside of the function. However its base
2695 -- type may not be frozen yet, so the reference that will
2696 -- force elaboration must be attached to the freezing of
2699 -- If the return specification appears on a proper body,
2700 -- the subtype will have been created already on the spec.
2702 if Is_Frozen (Typ) then
2703 if Nkind (Parent (N)) = N_Subprogram_Body
2704 and then Nkind (Parent (Parent (N))) = N_Subunit
2708 Build_Itype_Reference (Etype (Designator), Parent (N));
2712 Ensure_Freeze_Node (Typ);
2715 IR : constant Node_Id := Make_Itype_Reference (Sloc (N));
2717 Set_Itype (IR, Etype (Designator));
2718 Append_Freeze_Actions (Typ, New_List (IR));
2723 Set_Etype (Designator, Typ);
2726 if Ekind (Typ) = E_Incomplete_Type
2727 or else (Is_Class_Wide_Type (Typ)
2728 and then Ekind (Root_Type (Typ)) = E_Incomplete_Type)
2730 -- AI05-0151: Tagged incomplete types are allowed in all formal
2731 -- parts. Untagged incomplete types are not allowed in bodies.
2732 -- As a consequence, limited views cannot appear in a basic
2733 -- declaration that is itself within a body, because there is
2734 -- no point at which the non-limited view will become visible.
2736 if Ada_Version >= Ada_2012 then
2737 if From_Limited_With (Typ) and then In_Package_Body then
2739 ("invalid use of incomplete type&",
2740 Result_Definition (N), Typ);
2742 -- The return type of a subprogram body cannot be of a
2743 -- formal incomplete type.
2745 elsif Is_Generic_Type (Typ)
2746 and then Nkind (Parent (N)) = N_Subprogram_Body
2749 ("return type cannot be a formal incomplete type",
2750 Result_Definition (N));
2752 elsif Is_Class_Wide_Type (Typ)
2753 and then Is_Generic_Type (Root_Type (Typ))
2754 and then Nkind (Parent (N)) = N_Subprogram_Body
2757 ("return type cannot be a formal incomplete type",
2758 Result_Definition (N));
2760 elsif Is_Tagged_Type (Typ) then
2763 -- Use is legal in a thunk generated for an operation
2764 -- inherited from a progenitor.
2766 elsif Is_Thunk (Designator)
2767 and then Present (Non_Limited_View (Typ))
2771 elsif Nkind (Parent (N)) = N_Subprogram_Body
2772 or else Nkind (Parent (Parent (N))) in
2773 N_Accept_Statement | N_Entry_Body
2776 ("invalid use of untagged incomplete type&",
2780 -- The type must be completed in the current package. This
2781 -- is checked at the end of the package declaration when
2782 -- Taft-amendment types are identified. If the return type
2783 -- is class-wide, there is no required check, the type can
2784 -- be a bona fide TAT.
2786 if Ekind (Scope (Current_Scope)) = E_Package
2787 and then In_Private_Part (Scope (Current_Scope))
2788 and then not Is_Class_Wide_Type (Typ)
2790 Append_Elmt (Designator, Private_Dependents (Typ));
2795 ("invalid use of incomplete type&", Designator, Typ);
2800 -- Case where result definition does indicate an error
2803 Set_Etype (Designator, Any_Type);
2805 end Analyze_Return_Type;
2807 -----------------------------
2808 -- Analyze_Subprogram_Body --
2809 -----------------------------
2811 procedure Analyze_Subprogram_Body (N : Node_Id) is
2812 Loc : constant Source_Ptr := Sloc (N);
2813 Body_Spec : constant Node_Id := Specification (N);
2814 Body_Id : constant Entity_Id := Defining_Entity (Body_Spec);
2817 if Debug_Flag_C then
2818 Write_Str ("==> subprogram body ");
2819 Write_Name (Chars (Body_Id));
2820 Write_Str (" from ");
2821 Write_Location (Loc);
2826 Trace_Scope (N, Body_Id, " Analyze subprogram: ");
2828 -- The real work is split out into the helper, so it can do "return;"
2829 -- without skipping the debug output:
2831 Analyze_Subprogram_Body_Helper (N);
2833 if Debug_Flag_C then
2835 Write_Str ("<== subprogram body ");
2836 Write_Name (Chars (Body_Id));
2837 Write_Str (" from ");
2838 Write_Location (Loc);
2841 end Analyze_Subprogram_Body;
2843 ------------------------------------
2844 -- Analyze_Subprogram_Body_Helper --
2845 ------------------------------------
2847 -- This procedure is called for regular subprogram bodies, generic bodies,
2848 -- and for subprogram stubs of both kinds. In the case of stubs, only the
2849 -- specification matters, and is used to create a proper declaration for
2850 -- the subprogram, or to perform conformance checks.
2852 -- WARNING: This routine manages Ghost regions. Return statements must be
2853 -- replaced by gotos that jump to the end of the routine and restore the
2856 procedure Analyze_Subprogram_Body_Helper (N : Node_Id) is
2857 Body_Spec : Node_Id := Specification (N);
2858 Body_Id : Entity_Id := Defining_Entity (Body_Spec);
2859 Loc : constant Source_Ptr := Sloc (N);
2860 Prev_Id : constant Entity_Id := Current_Entity_In_Scope (Body_Id);
2862 Body_Nod : Node_Id := Empty;
2863 Minimum_Acc_Objs : List_Id := No_List;
2865 Conformant : Boolean;
2866 Desig_View : Entity_Id := Empty;
2867 Exch_Views : Elist_Id := No_Elist;
2869 Mask_Types : Elist_Id := No_Elist;
2870 Prot_Typ : Entity_Id := Empty;
2871 Spec_Decl : Node_Id := Empty;
2872 Spec_Id : Entity_Id;
2874 Last_Real_Spec_Entity : Entity_Id := Empty;
2875 -- When we analyze a separate spec, the entity chain ends up containing
2876 -- the formals, as well as any itypes generated during analysis of the
2877 -- default expressions for parameters, or the arguments of associated
2878 -- precondition/postcondition pragmas (which are analyzed in the context
2879 -- of the spec since they have visibility on formals).
2881 -- These entities belong with the spec and not the body. However we do
2882 -- the analysis of the body in the context of the spec (again to obtain
2883 -- visibility to the formals), and all the entities generated during
2884 -- this analysis end up also chained to the entity chain of the spec.
2885 -- But they really belong to the body, and there is circuitry to move
2886 -- them from the spec to the body.
2888 -- However, when we do this move, we don't want to move the real spec
2889 -- entities (first para above) to the body. The Last_Real_Spec_Entity
2890 -- variable points to the last real spec entity, so we only move those
2891 -- chained beyond that point. It is initialized to Empty to deal with
2892 -- the case where there is no separate spec.
2894 function Body_Has_Contract return Boolean;
2895 -- Check whether unanalyzed body has an aspect or pragma that may
2896 -- generate a SPARK contract.
2898 function Body_Has_SPARK_Mode_On return Boolean;
2899 -- Check whether SPARK_Mode On applies to the subprogram body, either
2900 -- because it is specified directly on the body, or because it is
2901 -- inherited from the enclosing subprogram or package.
2903 function Build_Internal_Protected_Declaration
2904 (N : Node_Id) return Entity_Id;
2905 -- A subprogram body without a previous spec that appears in a protected
2906 -- body must be expanded separately to create a subprogram declaration
2907 -- for it, in order to resolve internal calls to it from other protected
2910 -- Possibly factor this with Exp_Dist.Copy_Specification ???
2912 procedure Build_Subprogram_Declaration;
2913 -- Create a matching subprogram declaration for subprogram body N
2915 procedure Check_Anonymous_Return;
2916 -- Ada 2005: if a function returns an access type that denotes a task,
2917 -- or a type that contains tasks, we must create a master entity for
2918 -- the anonymous type, which typically will be used in an allocator
2919 -- in the body of the function.
2921 procedure Check_Inline_Pragma (Spec : in out Node_Id);
2922 -- Look ahead to recognize a pragma that may appear after the body.
2923 -- If there is a previous spec, check that it appears in the same
2924 -- declarative part. If the pragma is Inline_Always, perform inlining
2925 -- unconditionally, otherwise only if Front_End_Inlining is requested.
2926 -- If the body acts as a spec, and inlining is required, we create a
2927 -- subprogram declaration for it, in order to attach the body to inline.
2928 -- If pragma does not appear after the body, check whether there is
2929 -- an inline pragma before any local declarations.
2931 procedure Check_Missing_Return;
2932 -- Checks for a function with a no return statements, and also performs
2933 -- the warning checks implemented by Check_Returns. In formal mode, also
2934 -- verify that a function ends with a RETURN and that a procedure does
2935 -- not contain any RETURN.
2937 function Disambiguate_Spec return Entity_Id;
2938 -- When a primitive is declared between the private view and the full
2939 -- view of a concurrent type which implements an interface, a special
2940 -- mechanism is used to find the corresponding spec of the primitive
2943 function Exchange_Limited_Views (Subp_Id : Entity_Id) return Elist_Id;
2944 -- Ada 2012 (AI05-0151): Detect whether the profile of Subp_Id contains
2945 -- incomplete types coming from a limited context and replace their
2946 -- limited views with the non-limited ones. Return the list of changes
2947 -- to be used to undo the transformation.
2949 procedure Generate_Minimum_Accessibility
2950 (Extra_Access : Entity_Id;
2951 Related_Form : Entity_Id := Empty);
2952 -- Generate a minimum accessibility object for a given extra
2953 -- accessibility formal (Extra_Access) and its related formal if it
2956 function Is_Private_Concurrent_Primitive
2957 (Subp_Id : Entity_Id) return Boolean;
2958 -- Determine whether subprogram Subp_Id is a primitive of a concurrent
2959 -- type that implements an interface and has a private view.
2961 function Mask_Unfrozen_Types (Spec_Id : Entity_Id) return Elist_Id;
2962 -- N is the body generated for an expression function that is not a
2963 -- completion and Spec_Id the defining entity of its spec. Mark all
2964 -- the not-yet-frozen types referenced by the simple return statement
2965 -- of the function as formally frozen.
2967 procedure Move_Pragmas (From : Node_Id; To : Node_Id);
2968 -- Find all suitable source pragmas at the top of subprogram body
2969 -- From's declarations and move them after arbitrary node To.
2970 -- One exception is pragma SPARK_Mode which is copied rather than moved,
2971 -- as it applies to the body too.
2973 procedure Restore_Limited_Views (Restore_List : Elist_Id);
2974 -- Undo the transformation done by Exchange_Limited_Views.
2976 procedure Set_Trivial_Subprogram (N : Node_Id);
2977 -- Sets the Is_Trivial_Subprogram flag in both spec and body of the
2978 -- subprogram whose body is being analyzed. N is the statement node
2979 -- causing the flag to be set, if the following statement is a return
2980 -- of an entity, we mark the entity as set in source to suppress any
2981 -- warning on the stylized use of function stubs with a dummy return.
2983 procedure Unmask_Unfrozen_Types (Unmask_List : Elist_Id);
2984 -- Undo the transformation done by Mask_Unfrozen_Types
2986 procedure Verify_Overriding_Indicator;
2987 -- If there was a previous spec, the entity has been entered in the
2988 -- current scope previously. If the body itself carries an overriding
2989 -- indicator, check that it is consistent with the known status of the
2992 -----------------------
2993 -- Body_Has_Contract --
2994 -----------------------
2996 function Body_Has_Contract return Boolean is
2997 Decls : constant List_Id := Declarations (N);
3001 -- Check for aspects that may generate a contract
3003 if Present (Aspect_Specifications (N)) then
3004 Item := First (Aspect_Specifications (N));
3005 while Present (Item) loop
3006 if Is_Subprogram_Contract_Annotation (Item) then
3014 -- Check for pragmas that may generate a contract
3016 if Present (Decls) then
3017 Item := First (Decls);
3018 while Present (Item) loop
3019 if Nkind (Item) = N_Pragma
3020 and then Is_Subprogram_Contract_Annotation (Item)
3030 end Body_Has_Contract;
3032 ----------------------------
3033 -- Body_Has_SPARK_Mode_On --
3034 ----------------------------
3036 function Body_Has_SPARK_Mode_On return Boolean is
3037 Decls : constant List_Id := Declarations (N);
3041 -- Check for SPARK_Mode aspect
3043 if Present (Aspect_Specifications (N)) then
3044 Item := First (Aspect_Specifications (N));
3045 while Present (Item) loop
3046 if Get_Aspect_Id (Item) = Aspect_SPARK_Mode then
3047 return Get_SPARK_Mode_From_Annotation (Item) = On;
3054 -- Check for SPARK_Mode pragma
3056 if Present (Decls) then
3057 Item := First (Decls);
3058 while Present (Item) loop
3060 -- Pragmas that apply to a subprogram body are usually grouped
3061 -- together. Look for a potential pragma SPARK_Mode among them.
3063 if Nkind (Item) = N_Pragma then
3064 if Get_Pragma_Id (Item) = Pragma_SPARK_Mode then
3065 return Get_SPARK_Mode_From_Annotation (Item) = On;
3068 -- Otherwise the first non-pragma declarative item terminates
3069 -- the region where pragma SPARK_Mode may appear.
3079 -- Otherwise, the applicable SPARK_Mode is inherited from the
3080 -- enclosing subprogram or package.
3082 return SPARK_Mode = On;
3083 end Body_Has_SPARK_Mode_On;
3085 ------------------------------------------
3086 -- Build_Internal_Protected_Declaration --
3087 ------------------------------------------
3089 function Build_Internal_Protected_Declaration
3090 (N : Node_Id) return Entity_Id
3092 procedure Analyze_Pragmas (From : Node_Id);
3093 -- Analyze all pragmas which follow arbitrary node From
3095 ---------------------
3096 -- Analyze_Pragmas --
3097 ---------------------
3099 procedure Analyze_Pragmas (From : Node_Id) is
3103 Decl := Next (From);
3104 while Present (Decl) loop
3105 if Nkind (Decl) = N_Pragma then
3106 Analyze_Pragma (Decl);
3108 -- No candidate pragmas are available for analysis
3116 end Analyze_Pragmas;
3120 Body_Id : constant Entity_Id := Defining_Entity (N);
3121 Loc : constant Source_Ptr := Sloc (N);
3126 Spec_Id : Entity_Id;
3128 -- Start of processing for Build_Internal_Protected_Declaration
3131 Formal := First_Formal (Body_Id);
3133 -- The protected operation always has at least one formal, namely the
3134 -- object itself, but it is only placed in the parameter list if
3135 -- expansion is enabled.
3137 if Present (Formal) or else Expander_Active then
3138 Formals := Copy_Parameter_List (Body_Id);
3144 Make_Defining_Identifier (Sloc (Body_Id),
3145 Chars => Chars (Body_Id));
3147 -- Indicate that the entity comes from source, to ensure that cross-
3148 -- reference information is properly generated. The body itself is
3149 -- rewritten during expansion, and the body entity will not appear in
3150 -- calls to the operation.
3152 Set_Comes_From_Source (Spec_Id, True);
3154 if Nkind (Specification (N)) = N_Procedure_Specification then
3156 Make_Procedure_Specification (Loc,
3157 Defining_Unit_Name => Spec_Id,
3158 Parameter_Specifications => Formals);
3161 Make_Function_Specification (Loc,
3162 Defining_Unit_Name => Spec_Id,
3163 Parameter_Specifications => Formals,
3164 Result_Definition =>
3165 New_Occurrence_Of (Etype (Body_Id), Loc));
3168 Decl := Make_Subprogram_Declaration (Loc, Specification => Spec);
3169 Set_Corresponding_Body (Decl, Body_Id);
3170 Set_Corresponding_Spec (N, Spec_Id);
3172 Insert_Before (N, Decl);
3174 -- Associate all aspects and pragmas of the body with the spec. This
3175 -- ensures that these annotations apply to the initial declaration of
3176 -- the subprogram body.
3178 Move_Aspects (From => N, To => Decl);
3179 Move_Pragmas (From => N, To => Decl);
3183 -- The analysis of the spec may generate pragmas which require manual
3184 -- analysis. Since the generation of the spec and the relocation of
3185 -- the annotations is driven by the expansion of the stand-alone
3186 -- body, the pragmas will not be analyzed in a timely manner. Do this
3189 Analyze_Pragmas (Decl);
3191 -- This subprogram has convention Intrinsic as per RM 6.3.1(10/2)
3192 -- ensuring in particular that 'Access is illegal.
3194 Set_Convention (Spec_Id, Convention_Intrinsic);
3195 Set_Has_Completion (Spec_Id);
3198 end Build_Internal_Protected_Declaration;
3200 ----------------------------------
3201 -- Build_Subprogram_Declaration --
3202 ----------------------------------
3204 procedure Build_Subprogram_Declaration is
3206 Subp_Decl : Node_Id;
3209 -- Create a matching subprogram spec using the profile of the body.
3210 -- The structure of the tree is identical, but has new entities for
3211 -- the defining unit name and formal parameters.
3214 Make_Subprogram_Declaration (Loc,
3215 Specification => Copy_Subprogram_Spec (Body_Spec));
3216 Set_Comes_From_Source (Subp_Decl, True);
3218 -- Also mark parameters as coming from source
3220 if Present (Parameter_Specifications (Specification (Subp_Decl))) then
3225 First (Parameter_Specifications (Specification (Subp_Decl)));
3227 while Present (Form) loop
3228 Set_Comes_From_Source (Defining_Identifier (Form), True);
3234 -- Relocate the aspects and relevant pragmas from the subprogram body
3235 -- to the generated spec because it acts as the initial declaration.
3237 Insert_Before (N, Subp_Decl);
3238 Move_Aspects (N, To => Subp_Decl);
3239 Move_Pragmas (N, To => Subp_Decl);
3241 -- Ensure that the generated corresponding spec and original body
3242 -- share the same SPARK_Mode pragma or aspect. As a result, both have
3243 -- the same SPARK_Mode attributes, and the global SPARK_Mode value is
3244 -- correctly set for local subprograms.
3246 Copy_SPARK_Mode_Aspect (Subp_Decl, To => N);
3248 Analyze (Subp_Decl);
3250 -- Propagate the attributes Rewritten_For_C and Corresponding_Proc to
3251 -- the body since the expander may generate calls using that entity.
3252 -- Required to ensure that Expand_Call rewrites calls to this
3253 -- function by calls to the built procedure.
3255 if Transform_Function_Array
3256 and then Nkind (Body_Spec) = N_Function_Specification
3258 Rewritten_For_C (Defining_Entity (Specification (Subp_Decl)))
3260 Set_Rewritten_For_C (Defining_Entity (Body_Spec));
3261 Set_Corresponding_Procedure (Defining_Entity (Body_Spec),
3262 Corresponding_Procedure
3263 (Defining_Entity (Specification (Subp_Decl))));
3266 -- Analyze any relocated source pragmas or pragmas created for aspect
3269 Decl := Next (Subp_Decl);
3270 while Present (Decl) loop
3272 -- Stop the search for pragmas once the body has been reached as
3273 -- this terminates the region where pragmas may appear.
3278 elsif Nkind (Decl) = N_Pragma then
3285 Spec_Id := Defining_Entity (Subp_Decl);
3286 Set_Corresponding_Spec (N, Spec_Id);
3288 -- Mark the generated spec as a source construct to ensure that all
3289 -- calls to it are properly registered in ALI files for GNATprove.
3291 Set_Comes_From_Source (Spec_Id, True);
3293 -- Ensure that the specs of the subprogram declaration and its body
3294 -- are identical, otherwise they will appear non-conformant due to
3295 -- rewritings in the default values of formal parameters.
3297 Body_Spec := Copy_Subprogram_Spec (Body_Spec);
3298 Set_Specification (N, Body_Spec);
3299 Body_Id := Analyze_Subprogram_Specification (Body_Spec);
3300 end Build_Subprogram_Declaration;
3302 ----------------------------
3303 -- Check_Anonymous_Return --
3304 ----------------------------
3306 procedure Check_Anonymous_Return is
3312 if Present (Spec_Id) then
3318 if Ekind (Scop) = E_Function
3319 and then Ekind (Etype (Scop)) = E_Anonymous_Access_Type
3320 and then not Is_Thunk (Scop)
3322 -- Skip internally built functions which handle the case of
3323 -- a null access (see Expand_Interface_Conversion)
3325 and then not (Is_Interface (Designated_Type (Etype (Scop)))
3326 and then not Comes_From_Source (Parent (Scop)))
3328 and then (Has_Task (Designated_Type (Etype (Scop)))
3330 (Is_Class_Wide_Type (Designated_Type (Etype (Scop)))
3332 Is_Limited_Record (Designated_Type (Etype (Scop)))))
3333 and then Expander_Active
3335 Decl := Build_Master_Declaration (Loc);
3337 if Present (Declarations (N)) then
3338 Prepend (Decl, Declarations (N));
3340 Set_Declarations (N, New_List (Decl));
3343 Set_Master_Id (Etype (Scop), Defining_Identifier (Decl));
3344 Set_Has_Master_Entity (Scop);
3346 -- Now mark the containing scope as a task master
3349 while Nkind (Par) /= N_Compilation_Unit loop
3350 Par := Parent (Par);
3351 pragma Assert (Present (Par));
3353 -- If we fall off the top, we are at the outer level, and
3354 -- the environment task is our effective master, so nothing
3358 in N_Task_Body | N_Block_Statement | N_Subprogram_Body
3360 Set_Is_Task_Master (Par, True);
3365 end Check_Anonymous_Return;
3367 -------------------------
3368 -- Check_Inline_Pragma --
3369 -------------------------
3371 procedure Check_Inline_Pragma (Spec : in out Node_Id) is
3375 function Is_Inline_Pragma (N : Node_Id) return Boolean;
3376 -- True when N is a pragma Inline or Inline_Always that applies
3377 -- to this subprogram.
3379 -----------------------
3380 -- Is_Inline_Pragma --
3381 -----------------------
3383 function Is_Inline_Pragma (N : Node_Id) return Boolean is
3385 if Nkind (N) = N_Pragma
3387 (Pragma_Name_Unmapped (N) = Name_Inline_Always
3388 or else (Pragma_Name_Unmapped (N) = Name_Inline
3390 (Front_End_Inlining or else Optimization_Level > 0)))
3391 and then Present (Pragma_Argument_Associations (N))
3394 Pragma_Arg : Node_Id :=
3395 Expression (First (Pragma_Argument_Associations (N)));
3397 if Nkind (Pragma_Arg) = N_Selected_Component then
3398 Pragma_Arg := Selector_Name (Pragma_Arg);
3401 return Chars (Pragma_Arg) = Chars (Body_Id);
3407 end Is_Inline_Pragma;
3409 -- Start of processing for Check_Inline_Pragma
3412 if not Expander_Active then
3416 if Is_List_Member (N)
3417 and then Present (Next (N))
3418 and then Is_Inline_Pragma (Next (N))
3422 elsif Nkind (N) /= N_Subprogram_Body_Stub
3423 and then Present (Declarations (N))
3424 and then Is_Inline_Pragma (First (Declarations (N)))
3426 Prag := First (Declarations (N));
3432 if Present (Prag) and then Is_List_Member (N) then
3433 if Present (Spec_Id) then
3434 if Is_List_Member (Unit_Declaration_Node (Spec_Id))
3435 and then In_Same_List (N, Unit_Declaration_Node (Spec_Id))
3440 -- Create a subprogram declaration, to make treatment uniform.
3441 -- Make the sloc of the subprogram name that of the entity in
3442 -- the body, so that style checks find identical strings.
3445 Subp : constant Entity_Id :=
3446 Make_Defining_Identifier
3447 (Sloc (Body_Id), Chars (Body_Id));
3448 Decl : constant Node_Id :=
3449 Make_Subprogram_Declaration (Loc,
3451 New_Copy_Tree (Specification (N)));
3454 -- Link the body and the generated spec
3456 Set_Corresponding_Body (Decl, Body_Id);
3458 if Nkind (N) = N_Subprogram_Body_Stub then
3459 Set_Corresponding_Spec_Of_Stub (N, Subp);
3461 Set_Corresponding_Spec (N, Subp);
3464 Set_Defining_Unit_Name (Specification (Decl), Subp);
3466 -- To ensure proper coverage when body is inlined, indicate
3467 -- whether the subprogram comes from source.
3469 Preserve_Comes_From_Source (Subp, N);
3471 if Present (First_Formal (Body_Id)) then
3472 Plist := Copy_Parameter_List (Body_Id);
3473 Set_Parameter_Specifications
3474 (Specification (Decl), Plist);
3477 -- Move aspects to the new spec
3479 if Has_Aspects (N) then
3480 Move_Aspects (N, To => Decl);
3483 Insert_Before (N, Decl);
3486 Set_Has_Pragma_Inline (Subp);
3488 if Pragma_Name (Prag) = Name_Inline_Always then
3489 Set_Is_Inlined (Subp);
3490 Set_Has_Pragma_Inline_Always (Subp);
3493 -- Prior to copying the subprogram body to create a template
3494 -- for it for subsequent inlining, remove the pragma from
3495 -- the current body so that the copy that will produce the
3496 -- new body will start from a completely unanalyzed tree.
3498 if Nkind (Parent (Prag)) = N_Subprogram_Body then
3499 Rewrite (Prag, Make_Null_Statement (Sloc (Prag)));
3506 end Check_Inline_Pragma;
3508 --------------------------
3509 -- Check_Missing_Return --
3510 --------------------------
3512 procedure Check_Missing_Return is
3514 Missing_Ret : Boolean;
3517 if Nkind (Body_Spec) = N_Function_Specification then
3518 if Present (Spec_Id) then
3524 if Return_Present (Id) then
3525 Check_Returns (HSS, 'F', Missing_Ret);
3528 Set_Has_Missing_Return (Id);
3531 -- Within a premature instantiation of a package with no body, we
3532 -- build completions of the functions therein, with a Raise
3533 -- statement. No point in complaining about a missing return in
3536 elsif Ekind (Id) = E_Function
3537 and then In_Instance
3538 and then Present (Statements (HSS))
3539 and then Nkind (First (Statements (HSS))) = N_Raise_Program_Error
3543 elsif Is_Generic_Subprogram (Id)
3544 or else not Is_Machine_Code_Subprogram (Id)
3546 Error_Msg_N ("missing RETURN statement in function body", N);
3549 -- If procedure with No_Return, check returns
3551 elsif Nkind (Body_Spec) = N_Procedure_Specification then
3552 if Present (Spec_Id) then
3558 if No_Return (Id) then
3559 Check_Returns (HSS, 'P', Missing_Ret, Id);
3562 end Check_Missing_Return;
3564 -----------------------
3565 -- Disambiguate_Spec --
3566 -----------------------
3568 function Disambiguate_Spec return Entity_Id is
3569 Priv_Spec : Entity_Id;
3572 procedure Replace_Types (To_Corresponding : Boolean);
3573 -- Depending on the flag, replace the type of formal parameters of
3574 -- Body_Id if it is a concurrent type implementing interfaces with
3575 -- the corresponding record type or the other way around.
3577 procedure Replace_Types (To_Corresponding : Boolean) is
3579 Formal_Typ : Entity_Id;
3582 Formal := First_Formal (Body_Id);
3583 while Present (Formal) loop
3584 Formal_Typ := Etype (Formal);
3586 if Is_Class_Wide_Type (Formal_Typ) then
3587 Formal_Typ := Root_Type (Formal_Typ);
3590 -- From concurrent type to corresponding record
3592 if To_Corresponding then
3593 if Is_Concurrent_Type (Formal_Typ)
3594 and then Present (Corresponding_Record_Type (Formal_Typ))
3597 (Corresponding_Record_Type (Formal_Typ)))
3600 Corresponding_Record_Type (Formal_Typ));
3603 -- From corresponding record to concurrent type
3606 if Is_Concurrent_Record_Type (Formal_Typ)
3607 and then Present (Interfaces (Formal_Typ))
3610 Corresponding_Concurrent_Type (Formal_Typ));
3614 Next_Formal (Formal);
3618 -- Start of processing for Disambiguate_Spec
3621 -- Try to retrieve the specification of the body as is. All error
3622 -- messages are suppressed because the body may not have a spec in
3623 -- its current state.
3625 Spec_N := Find_Corresponding_Spec (N, False);
3627 -- It is possible that this is the body of a primitive declared
3628 -- between a private and a full view of a concurrent type. The
3629 -- controlling parameter of the spec carries the concurrent type,
3630 -- not the corresponding record type as transformed by Analyze_
3631 -- Subprogram_Specification. In such cases, we undo the change
3632 -- made by the analysis of the specification and try to find the
3635 -- Note that wrappers already have their corresponding specs and
3636 -- bodies set during their creation, so if the candidate spec is
3637 -- a wrapper, then we definitely need to swap all types to their
3638 -- original concurrent status.
3641 or else Is_Primitive_Wrapper (Spec_N)
3643 -- Restore all references of corresponding record types to the
3644 -- original concurrent types.
3646 Replace_Types (To_Corresponding => False);
3647 Priv_Spec := Find_Corresponding_Spec (N, False);
3649 -- The current body truly belongs to a primitive declared between
3650 -- a private and a full view. We leave the modified body as is,
3651 -- and return the true spec.
3653 if Present (Priv_Spec)
3654 and then Is_Private_Primitive (Priv_Spec)
3659 -- In case that this is some sort of error, restore the original
3660 -- state of the body.
3662 Replace_Types (To_Corresponding => True);
3666 end Disambiguate_Spec;
3668 ----------------------------
3669 -- Exchange_Limited_Views --
3670 ----------------------------
3672 function Exchange_Limited_Views (Subp_Id : Entity_Id) return Elist_Id is
3673 Result : Elist_Id := No_Elist;
3675 procedure Detect_And_Exchange (Id : Entity_Id);
3676 -- Determine whether Id's type denotes an incomplete type associated
3677 -- with a limited with clause and exchange the limited view with the
3678 -- non-limited one when available. Note that the non-limited view
3679 -- may exist because of a with_clause in another unit in the context,
3680 -- but cannot be used because the current view of the enclosing unit
3681 -- is still a limited view.
3683 -------------------------
3684 -- Detect_And_Exchange --
3685 -------------------------
3687 procedure Detect_And_Exchange (Id : Entity_Id) is
3688 Typ : constant Entity_Id := Etype (Id);
3690 if From_Limited_With (Typ)
3691 and then Has_Non_Limited_View (Typ)
3692 and then not From_Limited_With (Scope (Typ))
3695 Result := New_Elmt_List;
3698 Prepend_Elmt (Typ, Result);
3699 Prepend_Elmt (Id, Result);
3700 Set_Etype (Id, Non_Limited_View (Typ));
3702 end Detect_And_Exchange;
3708 -- Start of processing for Exchange_Limited_Views
3711 -- Do not process subprogram bodies as they already use the non-
3712 -- limited view of types.
3714 if Ekind (Subp_Id) not in E_Function | E_Procedure then
3718 -- Examine all formals and swap views when applicable
3720 Formal := First_Formal (Subp_Id);
3721 while Present (Formal) loop
3722 Detect_And_Exchange (Formal);
3724 Next_Formal (Formal);
3727 -- Process the return type of a function
3729 if Ekind (Subp_Id) = E_Function then
3730 Detect_And_Exchange (Subp_Id);
3734 end Exchange_Limited_Views;
3736 ------------------------------------
3737 -- Generate_Minimum_Accessibility --
3738 ------------------------------------
3740 procedure Generate_Minimum_Accessibility
3741 (Extra_Access : Entity_Id;
3742 Related_Form : Entity_Id := Empty)
3744 Loc : constant Source_Ptr := Sloc (Body_Nod);
3748 -- When no related formal exists then we are dealing with an
3749 -- extra accessibility formal for a function result.
3751 if No (Related_Form) then
3752 Form := Extra_Access;
3754 Form := Related_Form;
3757 -- Create the minimum accessibility object
3760 Make_Object_Declaration (Loc,
3761 Defining_Identifier =>
3763 (Loc, 'A', Extra_Access),
3764 Object_Definition => New_Occurrence_Of
3765 (Standard_Natural, Loc),
3767 Make_Attribute_Reference (Loc,
3768 Prefix => New_Occurrence_Of
3769 (Standard_Natural, Loc),
3770 Attribute_Name => Name_Min,
3771 Expressions => New_List (
3772 Make_Integer_Literal (Loc,
3773 Scope_Depth (Body_Id)),
3775 (Extra_Access, Loc))));
3777 -- Add the new local object to the Minimum_Acc_Obj to
3778 -- be later prepended to the subprogram's list of
3779 -- declarations after we are sure all expansion is
3782 if Present (Minimum_Acc_Objs) then
3783 Prepend (Obj_Node, Minimum_Acc_Objs);
3785 Minimum_Acc_Objs := New_List (Obj_Node);
3788 -- Register the object and analyze it
3790 Set_Minimum_Accessibility
3791 (Form, Defining_Identifier (Obj_Node));
3794 end Generate_Minimum_Accessibility;
3796 -------------------------------------
3797 -- Is_Private_Concurrent_Primitive --
3798 -------------------------------------
3800 function Is_Private_Concurrent_Primitive
3801 (Subp_Id : Entity_Id) return Boolean
3803 Formal_Typ : Entity_Id;
3806 if Present (First_Formal (Subp_Id)) then
3807 Formal_Typ := Etype (First_Formal (Subp_Id));
3809 if Is_Concurrent_Record_Type (Formal_Typ) then
3810 if Is_Class_Wide_Type (Formal_Typ) then
3811 Formal_Typ := Root_Type (Formal_Typ);
3814 Formal_Typ := Corresponding_Concurrent_Type (Formal_Typ);
3817 -- The type of the first formal is a concurrent tagged type with
3821 Is_Concurrent_Type (Formal_Typ)
3822 and then Is_Tagged_Type (Formal_Typ)
3823 and then Has_Private_Declaration (Formal_Typ);
3827 end Is_Private_Concurrent_Primitive;
3829 -------------------------
3830 -- Mask_Unfrozen_Types --
3831 -------------------------
3833 function Mask_Unfrozen_Types (Spec_Id : Entity_Id) return Elist_Id is
3834 Result : Elist_Id := No_Elist;
3836 function Mask_Type_Refs (Node : Node_Id) return Traverse_Result;
3837 -- Mask all types referenced in the subtree rooted at Node as
3840 --------------------
3841 -- Mask_Type_Refs --
3842 --------------------
3844 function Mask_Type_Refs (Node : Node_Id) return Traverse_Result is
3845 procedure Mask_Type (Typ : Entity_Id);
3846 -- Mask a given type as formally frozen when outside the current
3847 -- scope, or else freeze the type.
3853 procedure Mask_Type (Typ : Entity_Id) is
3855 -- Skip Itypes created by the preanalysis
3858 and then Scope_Within_Or_Same (Scope (Typ), Spec_Id)
3863 if not Is_Frozen (Typ) then
3864 if Scope (Typ) /= Current_Scope then
3865 Set_Is_Frozen (Typ);
3866 Append_New_Elmt (Typ, Result);
3868 Freeze_Before (N, Typ);
3873 -- Start of processing for Mask_Type_Refs
3876 if Is_Entity_Name (Node) and then Present (Entity (Node)) then
3877 Mask_Type (Etype (Entity (Node)));
3879 if Ekind (Entity (Node)) in E_Component | E_Discriminant then
3880 Mask_Type (Scope (Entity (Node)));
3883 elsif Nkind (Node) in N_Aggregate | N_Null | N_Type_Conversion
3884 and then Present (Etype (Node))
3886 Mask_Type (Etype (Node));
3892 procedure Mask_References is new Traverse_Proc (Mask_Type_Refs);
3896 Return_Stmt : constant Node_Id :=
3897 First (Statements (Handled_Statement_Sequence (N)));
3899 -- Start of processing for Mask_Unfrozen_Types
3902 pragma Assert (Nkind (Return_Stmt) = N_Simple_Return_Statement);
3904 Mask_References (Expression (Return_Stmt));
3907 end Mask_Unfrozen_Types;
3913 procedure Move_Pragmas (From : Node_Id; To : Node_Id) is
3915 Insert_Nod : Node_Id;
3916 Next_Decl : Node_Id;
3919 pragma Assert (Nkind (From) = N_Subprogram_Body);
3921 -- The pragmas are moved in an order-preserving fashion
3925 -- Inspect the declarations of the subprogram body and relocate all
3926 -- candidate pragmas.
3928 Decl := First (Declarations (From));
3929 while Present (Decl) loop
3931 -- Preserve the following declaration for iteration purposes, due
3932 -- to possible relocation of a pragma.
3934 Next_Decl := Next (Decl);
3936 if Nkind (Decl) = N_Pragma then
3937 -- Copy pragma SPARK_Mode if present in the declarative list
3938 -- of subprogram body From and insert it after node To. This
3939 -- pragma should not be moved, as it applies to the body too.
3941 if Pragma_Name_Unmapped (Decl) = Name_SPARK_Mode then
3942 Insert_After (Insert_Nod, New_Copy_Tree (Decl));
3944 -- Move relevant pragmas to the spec
3946 elsif Pragma_Name_Unmapped (Decl) in Name_Depends
3952 | Name_Refined_Depends
3953 | Name_Refined_Global
3956 | Name_Pure_Function
3957 | Name_Volatile_Function
3960 Insert_After (Insert_Nod, Decl);
3964 -- Skip internally generated code
3966 elsif not Comes_From_Source (Decl) then
3969 -- No candidate pragmas are available for relocation
3979 ---------------------------
3980 -- Restore_Limited_Views --
3981 ---------------------------
3983 procedure Restore_Limited_Views (Restore_List : Elist_Id) is
3984 Elmt : Elmt_Id := First_Elmt (Restore_List);
3988 while Present (Elmt) loop
3991 Set_Etype (Id, Node (Elmt));
3994 end Restore_Limited_Views;
3996 ----------------------------
3997 -- Set_Trivial_Subprogram --
3998 ----------------------------
4000 procedure Set_Trivial_Subprogram (N : Node_Id) is
4001 Nxt : constant Node_Id := Next (N);
4004 Set_Is_Trivial_Subprogram (Body_Id);
4006 if Present (Spec_Id) then
4007 Set_Is_Trivial_Subprogram (Spec_Id);
4011 and then Nkind (Nxt) = N_Simple_Return_Statement
4012 and then No (Next (Nxt))
4013 and then Present (Expression (Nxt))
4014 and then Is_Entity_Name (Expression (Nxt))
4016 Set_Never_Set_In_Source (Entity (Expression (Nxt)), False);
4018 end Set_Trivial_Subprogram;
4020 ---------------------------
4021 -- Unmask_Unfrozen_Types --
4022 ---------------------------
4024 procedure Unmask_Unfrozen_Types (Unmask_List : Elist_Id) is
4025 Elmt : Elmt_Id := First_Elmt (Unmask_List);
4028 while Present (Elmt) loop
4029 Set_Is_Frozen (Node (Elmt), False);
4032 end Unmask_Unfrozen_Types;
4034 ---------------------------------
4035 -- Verify_Overriding_Indicator --
4036 ---------------------------------
4038 procedure Verify_Overriding_Indicator is
4040 if Must_Override (Body_Spec) then
4041 if Nkind (Spec_Id) = N_Defining_Operator_Symbol
4042 and then Operator_Matches_Spec (Spec_Id, Spec_Id)
4046 -- Overridden controlled primitives may have had their
4047 -- Overridden_Operation field cleared according to the setting of
4048 -- the Is_Hidden flag. An issue arises, however, when analyzing
4049 -- an instance that may have manipulated the flag during
4050 -- expansion. As a result, we add an exception for this case.
4052 elsif not Present (Overridden_Operation (Spec_Id))
4053 and then not (Chars (Spec_Id) in Name_Adjust
4056 and then In_Instance)
4059 ("subprogram& is not overriding", Body_Spec, Spec_Id);
4061 -- Overriding indicators aren't allowed for protected subprogram
4062 -- bodies (see the Confirmation in Ada Comment AC95-00213). Change
4063 -- this to a warning if -gnatd.E is enabled.
4065 elsif Ekind (Scope (Spec_Id)) = E_Protected_Type then
4066 Error_Msg_Warn := Error_To_Warning;
4068 ("<<overriding indicator not allowed for protected "
4069 & "subprogram body", Body_Spec);
4072 elsif Must_Not_Override (Body_Spec) then
4073 if Present (Overridden_Operation (Spec_Id)) then
4075 ("subprogram& overrides inherited operation",
4076 Body_Spec, Spec_Id);
4078 elsif Nkind (Spec_Id) = N_Defining_Operator_Symbol
4079 and then Operator_Matches_Spec (Spec_Id, Spec_Id)
4082 ("subprogram& overrides predefined operator",
4083 Body_Spec, Spec_Id);
4085 -- Overriding indicators aren't allowed for protected subprogram
4086 -- bodies (see the Confirmation in Ada Comment AC95-00213). Change
4087 -- this to a warning if -gnatd.E is enabled.
4089 elsif Ekind (Scope (Spec_Id)) = E_Protected_Type then
4090 Error_Msg_Warn := Error_To_Warning;
4093 ("<<overriding indicator not allowed "
4094 & "for protected subprogram body", Body_Spec);
4096 -- If this is not a primitive operation, then the overriding
4097 -- indicator is altogether illegal.
4099 elsif not Is_Primitive (Spec_Id) then
4101 ("overriding indicator only allowed "
4102 & "if subprogram is primitive", Body_Spec);
4105 -- If checking the style rule and the operation overrides, then
4106 -- issue a warning about a missing overriding_indicator. Protected
4107 -- subprogram bodies are excluded from this style checking, since
4108 -- they aren't primitives (even though their declarations can
4109 -- override) and aren't allowed to have an overriding_indicator.
4112 and then Present (Overridden_Operation (Spec_Id))
4113 and then Ekind (Scope (Spec_Id)) /= E_Protected_Type
4115 pragma Assert (Unit_Declaration_Node (Body_Id) = N);
4116 Style.Missing_Overriding (N, Body_Id);
4119 and then Can_Override_Operator (Spec_Id)
4120 and then not In_Predefined_Unit (Spec_Id)
4122 pragma Assert (Unit_Declaration_Node (Body_Id) = N);
4123 Style.Missing_Overriding (N, Body_Id);
4125 end Verify_Overriding_Indicator;
4129 Saved_GM : constant Ghost_Mode_Type := Ghost_Mode;
4130 Saved_IGR : constant Node_Id := Ignored_Ghost_Region;
4131 Saved_EA : constant Boolean := Expander_Active;
4132 Saved_ISMP : constant Boolean :=
4133 Ignore_SPARK_Mode_Pragmas_In_Instance;
4134 -- Save the Ghost and SPARK mode-related data to restore on exit
4136 -- Start of processing for Analyze_Subprogram_Body_Helper
4139 -- A [generic] subprogram body freezes the contract of the nearest
4140 -- enclosing package body and all other contracts encountered in the
4141 -- same declarative part up to and excluding the subprogram body:
4143 -- package body Nearest_Enclosing_Package
4144 -- with Refined_State => (State => Constit)
4148 -- procedure Freezes_Enclosing_Package_Body
4149 -- with Refined_Depends => (Input => Constit) ...
4151 -- This ensures that any annotations referenced by the contract of the
4152 -- [generic] subprogram body are available. This form of freezing is
4153 -- decoupled from the usual Freeze_xxx mechanism because it must also
4154 -- work in the context of generics where normal freezing is disabled.
4156 -- Only bodies coming from source should cause this type of freezing.
4157 -- Expression functions that act as bodies and complete an initial
4158 -- declaration must be included in this category, hence the use of
4161 if Comes_From_Source (Original_Node (N)) then
4162 Freeze_Previous_Contracts (N);
4165 -- Generic subprograms are handled separately. They always have a
4166 -- generic specification. Determine whether current scope has a
4167 -- previous declaration.
4169 -- If the subprogram body is defined within an instance of the same
4170 -- name, the instance appears as a package renaming, and will be hidden
4171 -- within the subprogram.
4173 if Present (Prev_Id)
4174 and then not Is_Overloadable (Prev_Id)
4175 and then (Nkind (Parent (Prev_Id)) /= N_Package_Renaming_Declaration
4176 or else Comes_From_Source (Prev_Id))
4178 if Is_Generic_Subprogram (Prev_Id) then
4181 -- A subprogram body is Ghost when it is stand-alone and subject
4182 -- to pragma Ghost or when the corresponding spec is Ghost. Set
4183 -- the mode now to ensure that any nodes generated during analysis
4184 -- and expansion are properly marked as Ghost.
4186 Mark_And_Set_Ghost_Body (N, Spec_Id);
4188 -- If the body completes the initial declaration of a compilation
4189 -- unit which is subject to pragma Elaboration_Checks, set the
4190 -- model specified by the pragma because it applies to all parts
4193 Install_Elaboration_Model (Spec_Id);
4195 Set_Is_Compilation_Unit (Body_Id, Is_Compilation_Unit (Spec_Id));
4196 Set_Is_Child_Unit (Body_Id, Is_Child_Unit (Spec_Id));
4198 Analyze_Generic_Subprogram_Body (N, Spec_Id);
4200 if Nkind (N) = N_Subprogram_Body then
4201 HSS := Handled_Statement_Sequence (N);
4202 Check_Missing_Return;
4207 -- Otherwise a previous entity conflicts with the subprogram name.
4208 -- Attempting to enter name will post error.
4211 Enter_Name (Body_Id);
4215 -- Non-generic case, find the subprogram declaration, if one was seen,
4216 -- or enter new overloaded entity in the current scope. If the
4217 -- Current_Entity is the Body_Id itself, the unit is being analyzed as
4218 -- part of the context of one of its subunits. No need to redo the
4221 elsif Prev_Id = Body_Id and then Has_Completion (Body_Id) then
4225 Body_Id := Analyze_Subprogram_Specification (Body_Spec);
4227 if Nkind (N) = N_Subprogram_Body_Stub
4228 or else No (Corresponding_Spec (N))
4230 if Is_Private_Concurrent_Primitive (Body_Id) then
4231 Spec_Id := Disambiguate_Spec;
4233 -- A subprogram body is Ghost when it is stand-alone and
4234 -- subject to pragma Ghost or when the corresponding spec is
4235 -- Ghost. Set the mode now to ensure that any nodes generated
4236 -- during analysis and expansion are properly marked as Ghost.
4238 Mark_And_Set_Ghost_Body (N, Spec_Id);
4240 -- If the body completes a compilation unit which is subject
4241 -- to pragma Elaboration_Checks, set the model specified by
4242 -- the pragma because it applies to all parts of the unit.
4244 Install_Elaboration_Model (Spec_Id);
4247 Spec_Id := Find_Corresponding_Spec (N);
4249 -- A subprogram body is Ghost when it is stand-alone and
4250 -- subject to pragma Ghost or when the corresponding spec is
4251 -- Ghost. Set the mode now to ensure that any nodes generated
4252 -- during analysis and expansion are properly marked as Ghost.
4254 Mark_And_Set_Ghost_Body (N, Spec_Id);
4256 -- If the body completes a compilation unit which is subject
4257 -- to pragma Elaboration_Checks, set the model specified by
4258 -- the pragma because it applies to all parts of the unit.
4260 Install_Elaboration_Model (Spec_Id);
4262 -- In GNATprove mode, if the body has no previous spec, create
4263 -- one so that the inlining machinery can operate properly.
4264 -- Transfer aspects, if any, to the new spec, so that they
4265 -- are legal and can be processed ahead of the body.
4266 -- We make two copies of the given spec, one for the new
4267 -- declaration, and one for the body.
4268 -- ??? This should be conditioned on front-end inlining rather
4269 -- than GNATprove_Mode.
4271 if No (Spec_Id) and then GNATprove_Mode
4273 -- Inlining does not apply during preanalysis of code
4275 and then Full_Analysis
4277 -- Inlining only applies to full bodies, not stubs
4279 and then Nkind (N) /= N_Subprogram_Body_Stub
4281 -- Inlining only applies to bodies in the source code, not to
4282 -- those generated by the compiler. In particular, expression
4283 -- functions, whose body is generated by the compiler, are
4284 -- treated specially by GNATprove.
4286 and then Comes_From_Source (Body_Id)
4288 -- This cannot be done for a compilation unit, which is not
4289 -- in a context where we can insert a new spec.
4291 and then Is_List_Member (N)
4293 -- Inlining only applies to subprograms without contracts,
4294 -- as a contract is a sign that GNATprove should perform a
4295 -- modular analysis of the subprogram instead of a contextual
4296 -- analysis at each call site. The same test is performed in
4297 -- Inline.Can_Be_Inlined_In_GNATprove_Mode. It is repeated
4298 -- here in another form (because the contract has not been
4299 -- attached to the body) to avoid front-end errors in case
4300 -- pragmas are used instead of aspects, because the
4301 -- corresponding pragmas in the body would not be transferred
4302 -- to the spec, leading to legality errors.
4304 and then not Body_Has_Contract
4305 and then not Inside_A_Generic
4307 Build_Subprogram_Declaration;
4309 -- If this is a function that returns a constrained array, and
4310 -- Transform_Function_Array is set, create subprogram
4311 -- declaration to simplify e.g. subsequent C generation.
4314 and then Transform_Function_Array
4315 and then Nkind (Body_Spec) = N_Function_Specification
4316 and then Is_Array_Type (Etype (Body_Id))
4317 and then Is_Constrained (Etype (Body_Id))
4319 Build_Subprogram_Declaration;
4323 -- If this is a duplicate body, no point in analyzing it
4325 if Error_Posted (N) then
4329 -- A subprogram body should cause freezing of its own declaration,
4330 -- but if there was no previous explicit declaration, then the
4331 -- subprogram will get frozen too late (there may be code within
4332 -- the body that depends on the subprogram having been frozen,
4333 -- such as uses of extra formals), so we force it to be frozen
4334 -- here. Same holds if the body and spec are compilation units.
4335 -- Finally, if the return type is an anonymous access to protected
4336 -- subprogram, it must be frozen before the body because its
4337 -- expansion has generated an equivalent type that is used when
4338 -- elaborating the body.
4340 -- An exception in the case of Ada 2012, AI05-177: The bodies
4341 -- created for expression functions do not freeze.
4344 and then Nkind (Original_Node (N)) /= N_Expression_Function
4346 Freeze_Before (N, Body_Id);
4348 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4349 Freeze_Before (N, Spec_Id);
4351 elsif Is_Access_Subprogram_Type (Etype (Body_Id)) then
4352 Freeze_Before (N, Etype (Body_Id));
4356 Spec_Id := Corresponding_Spec (N);
4358 -- A subprogram body is Ghost when it is stand-alone and subject
4359 -- to pragma Ghost or when the corresponding spec is Ghost. Set
4360 -- the mode now to ensure that any nodes generated during analysis
4361 -- and expansion are properly marked as Ghost.
4363 Mark_And_Set_Ghost_Body (N, Spec_Id);
4365 -- If the body completes the initial declaration of a compilation
4366 -- unit which is subject to pragma Elaboration_Checks, set the
4367 -- model specified by the pragma because it applies to all parts
4370 Install_Elaboration_Model (Spec_Id);
4374 -- Deactivate expansion inside the body of ignored Ghost entities,
4375 -- as this code will ultimately be ignored. This avoids requiring the
4376 -- presence of run-time units which are not needed. Only do this for
4377 -- user entities, as internally generated entitities might still need
4378 -- to be expanded (e.g. those generated for types).
4380 if Present (Ignored_Ghost_Region)
4381 and then Comes_From_Source (Body_Id)
4383 Expander_Active := False;
4386 -- Previously we scanned the body to look for nested subprograms, and
4387 -- rejected an inline directive if nested subprograms were present,
4388 -- because the back-end would generate conflicting symbols for the
4389 -- nested bodies. This is now unnecessary.
4391 -- Look ahead to recognize a pragma Inline that appears after the body
4393 Check_Inline_Pragma (Spec_Id);
4395 -- Deal with special case of a fully private operation in the body of
4396 -- the protected type. We must create a declaration for the subprogram,
4397 -- in order to attach the subprogram that will be used in internal
4398 -- calls. We exclude compiler generated bodies from the expander since
4399 -- the issue does not arise for those cases.
4402 and then Comes_From_Source (N)
4403 and then Is_Protected_Type (Current_Scope)
4405 Spec_Id := Build_Internal_Protected_Declaration (N);
4408 -- If Transform_Function_Array is set and this is a function returning a
4409 -- constrained array type for which we must create a procedure with an
4410 -- extra out parameter, build and analyze the body now. The procedure
4411 -- declaration has already been created. We reuse the source body of the
4412 -- function, because in an instance it may contain global references
4413 -- that cannot be reanalyzed. The source function itself is not used any
4414 -- further, so we mark it as having a completion. If the subprogram is a
4415 -- stub the transformation is done later, when the proper body is
4419 and then Transform_Function_Array
4420 and then Nkind (N) /= N_Subprogram_Body_Stub
4423 S : constant Entity_Id :=
4424 (if Present (Spec_Id)
4426 else Defining_Unit_Name (Specification (N)));
4427 Proc_Body : Node_Id;
4430 if Ekind (S) = E_Function and then Rewritten_For_C (S) then
4431 Set_Has_Completion (S);
4432 Proc_Body := Build_Procedure_Body_Form (S, N);
4434 if Present (Spec_Id) then
4435 Rewrite (N, Proc_Body);
4438 -- The entity for the created procedure must remain
4439 -- invisible, so it does not participate in resolution of
4440 -- subsequent references to the function.
4442 Set_Is_Immediately_Visible (Corresponding_Spec (N), False);
4444 -- If we do not have a separate spec for N, build one and
4445 -- insert the new body right after.
4449 Make_Subprogram_Declaration (Loc,
4450 Specification => Relocate_Node (Specification (N))));
4452 Insert_After_And_Analyze (N, Proc_Body);
4453 Set_Is_Immediately_Visible
4454 (Corresponding_Spec (Proc_Body), False);
4462 -- If a separate spec is present, then deal with freezing issues
4464 if Present (Spec_Id) then
4465 Spec_Decl := Unit_Declaration_Node (Spec_Id);
4466 Verify_Overriding_Indicator;
4468 -- In general, the spec will be frozen when we start analyzing the
4469 -- body. However, for internally generated operations, such as
4470 -- wrapper functions for inherited operations with controlling
4471 -- results, the spec may not have been frozen by the time we expand
4472 -- the freeze actions that include the bodies. In particular, extra
4473 -- formals for accessibility or for return-in-place may need to be
4474 -- generated. Freeze nodes, if any, are inserted before the current
4475 -- body. These freeze actions are also needed in Compile_Only mode to
4476 -- enable the proper back-end type annotations.
4477 -- They are necessary in any case to ensure proper elaboration order
4480 if Nkind (N) = N_Subprogram_Body
4481 and then Was_Expression_Function (N)
4482 and then not Has_Completion (Spec_Id)
4483 and then Serious_Errors_Detected = 0
4484 and then (Expander_Active
4485 or else Operating_Mode = Check_Semantics
4486 or else Is_Ignored_Ghost_Entity (Spec_Id))
4488 -- The body generated for an expression function that is not a
4489 -- completion is a freeze point neither for the profile nor for
4490 -- anything else. That's why, in order to prevent any freezing
4491 -- during analysis, we need to mask types declared outside the
4492 -- expression (and in an outer scope) that are not yet frozen.
4493 -- This also needs to be done in the case of an ignored Ghost
4494 -- expression function, where the expander isn't active.
4496 Set_Is_Frozen (Spec_Id);
4497 Mask_Types := Mask_Unfrozen_Types (Spec_Id);
4499 elsif not Is_Frozen (Spec_Id)
4500 and then Serious_Errors_Detected = 0
4502 Set_Has_Delayed_Freeze (Spec_Id);
4503 Freeze_Before (N, Spec_Id);
4507 -- If the subprogram has a class-wide clone, build its body as a copy
4508 -- of the original body, and rewrite body of original subprogram as a
4509 -- wrapper that calls the clone. If N is a stub, this construction will
4510 -- take place when the proper body is analyzed. No action needed if this
4511 -- subprogram has been eliminated.
4513 if Present (Spec_Id)
4514 and then Present (Class_Wide_Clone (Spec_Id))
4515 and then (Comes_From_Source (N) or else Was_Expression_Function (N))
4516 and then Nkind (N) /= N_Subprogram_Body_Stub
4517 and then not (Expander_Active and then Is_Eliminated (Spec_Id))
4519 Build_Class_Wide_Clone_Body (Spec_Id, N);
4521 -- This is the new body for the existing primitive operation
4523 Rewrite (N, Build_Class_Wide_Clone_Call
4524 (Sloc (N), New_List, Spec_Id, Parent (Spec_Id)));
4525 Set_Has_Completion (Spec_Id, False);
4530 -- Place subprogram on scope stack, and make formals visible. If there
4531 -- is a spec, the visible entity remains that of the spec.
4533 if Present (Spec_Id) then
4534 Generate_Reference (Spec_Id, Body_Id, 'b', Set_Ref => False);
4536 if Is_Child_Unit (Spec_Id) then
4537 Generate_Reference (Spec_Id, Scope (Spec_Id), 'k', False);
4541 Style.Check_Identifier (Body_Id, Spec_Id);
4544 Set_Is_Compilation_Unit (Body_Id, Is_Compilation_Unit (Spec_Id));
4545 Set_Is_Child_Unit (Body_Id, Is_Child_Unit (Spec_Id));
4547 if Is_Abstract_Subprogram (Spec_Id) then
4548 Error_Msg_N ("an abstract subprogram cannot have a body", N);
4552 Set_Convention (Body_Id, Convention (Spec_Id));
4553 Set_Has_Completion (Spec_Id);
4555 if Is_Protected_Type (Scope (Spec_Id)) then
4556 Prot_Typ := Scope (Spec_Id);
4559 -- If this is a body generated for a renaming, do not check for
4560 -- full conformance. The check is redundant, because the spec of
4561 -- the body is a copy of the spec in the renaming declaration,
4562 -- and the test can lead to spurious errors on nested defaults.
4564 if Present (Spec_Decl)
4565 and then not Comes_From_Source (N)
4567 (Nkind (Original_Node (Spec_Decl)) =
4568 N_Subprogram_Renaming_Declaration
4569 or else (Present (Corresponding_Body (Spec_Decl))
4571 Nkind (Unit_Declaration_Node
4572 (Corresponding_Body (Spec_Decl))) =
4573 N_Subprogram_Renaming_Declaration))
4577 -- Conversely, the spec may have been generated for specless body
4578 -- with an inline pragma. The entity comes from source, which is
4579 -- both semantically correct and necessary for proper inlining.
4580 -- The subprogram declaration itself is not in the source.
4582 elsif Comes_From_Source (N)
4583 and then Present (Spec_Decl)
4584 and then not Comes_From_Source (Spec_Decl)
4585 and then Has_Pragma_Inline (Spec_Id)
4589 -- Finally, a body generated for an expression function copies
4590 -- the profile of the function and no check is needed either.
4591 -- If the body is the completion of a previous function
4592 -- declared elsewhere, the conformance check is required.
4594 elsif Nkind (N) = N_Subprogram_Body
4595 and then Was_Expression_Function (N)
4596 and then Sloc (Spec_Id) = Sloc (Body_Id)
4603 Fully_Conformant, True, Conformant, Body_Id);
4606 -- If the body is not fully conformant, we have to decide if we
4607 -- should analyze it or not. If it has a really messed up profile
4608 -- then we probably should not analyze it, since we will get too
4609 -- many bogus messages.
4611 -- Our decision is to go ahead in the non-fully conformant case
4612 -- only if it is at least mode conformant with the spec. Note
4613 -- that the call to Check_Fully_Conformant has issued the proper
4614 -- error messages to complain about the lack of conformance.
4617 and then not Mode_Conformant (Body_Id, Spec_Id)
4623 -- In the case we are dealing with an expression function we check
4624 -- the formals attached to the spec instead of the body - so we don't
4625 -- reference body formals.
4627 if Spec_Id /= Body_Id
4628 and then not Is_Expression_Function (Spec_Id)
4630 Reference_Body_Formals (Spec_Id, Body_Id);
4633 Reinit_Field_To_Zero (Body_Id, F_Has_Out_Or_In_Out_Parameter);
4634 Reinit_Field_To_Zero (Body_Id, F_Needs_No_Actuals,
4635 Old_Ekind => (E_Function | E_Procedure => True, others => False));
4636 Reinit_Field_To_Zero (Body_Id, F_Is_Predicate_Function,
4637 Old_Ekind => (E_Function | E_Procedure => True, others => False));
4638 Reinit_Field_To_Zero (Body_Id, F_Protected_Subprogram,
4639 Old_Ekind => (E_Function | E_Procedure => True, others => False));
4641 if Ekind (Body_Id) = E_Procedure then
4642 Reinit_Field_To_Zero (Body_Id, F_Receiving_Entry);
4645 Mutate_Ekind (Body_Id, E_Subprogram_Body);
4647 if Nkind (N) = N_Subprogram_Body_Stub then
4648 Set_Corresponding_Spec_Of_Stub (N, Spec_Id);
4653 Set_Corresponding_Spec (N, Spec_Id);
4655 -- Ada 2005 (AI-345): If the operation is a primitive operation
4656 -- of a concurrent type, the type of the first parameter has been
4657 -- replaced with the corresponding record, which is the proper
4658 -- run-time structure to use. However, within the body there may
4659 -- be uses of the formals that depend on primitive operations
4660 -- of the type (in particular calls in prefixed form) for which
4661 -- we need the original concurrent type. The operation may have
4662 -- several controlling formals, so the replacement must be done
4665 if Comes_From_Source (Spec_Id)
4666 and then Present (First_Entity (Spec_Id))
4667 and then Ekind (Etype (First_Entity (Spec_Id))) = E_Record_Type
4668 and then Is_Tagged_Type (Etype (First_Entity (Spec_Id)))
4669 and then Present (Interfaces (Etype (First_Entity (Spec_Id))))
4670 and then Present (Corresponding_Concurrent_Type
4671 (Etype (First_Entity (Spec_Id))))
4674 Typ : constant Entity_Id := Etype (First_Entity (Spec_Id));
4678 Form := First_Formal (Spec_Id);
4679 while Present (Form) loop
4680 if Etype (Form) = Typ then
4681 Set_Etype (Form, Corresponding_Concurrent_Type (Typ));
4689 -- Make the formals visible, and place subprogram on scope stack.
4690 -- This is also the point at which we set Last_Real_Spec_Entity
4691 -- to mark the entities which will not be moved to the body.
4693 Install_Formals (Spec_Id);
4694 Last_Real_Spec_Entity := Last_Entity (Spec_Id);
4696 -- Within an instance, add local renaming declarations so that
4697 -- gdb can retrieve the values of actuals more easily. This is
4698 -- only relevant if generating code.
4700 if Is_Generic_Instance (Spec_Id)
4701 and then Is_Wrapper_Package (Current_Scope)
4702 and then Expander_Active
4704 Build_Subprogram_Instance_Renamings (N, Current_Scope);
4707 Push_Scope (Spec_Id);
4709 -- Make sure that the subprogram is immediately visible. For
4710 -- child units that have no separate spec this is indispensable.
4711 -- Otherwise it is safe albeit redundant.
4713 Set_Is_Immediately_Visible (Spec_Id);
4716 Set_Corresponding_Body (Unit_Declaration_Node (Spec_Id), Body_Id);
4717 Set_Is_Obsolescent (Body_Id, Is_Obsolescent (Spec_Id));
4718 Set_Scope (Body_Id, Scope (Spec_Id));
4720 -- Case of subprogram body with no previous spec
4723 -- Check for style warning required
4727 -- Only apply check for source level subprograms for which checks
4728 -- have not been suppressed.
4730 and then Comes_From_Source (Body_Id)
4731 and then not Suppress_Style_Checks (Body_Id)
4733 -- No warnings within an instance
4735 and then not In_Instance
4737 -- No warnings for expression functions
4739 and then Nkind (Original_Node (N)) /= N_Expression_Function
4741 Style.Body_With_No_Spec (N);
4744 New_Overloaded_Entity (Body_Id);
4746 if Nkind (N) /= N_Subprogram_Body_Stub then
4747 Set_Acts_As_Spec (N);
4748 Generate_Definition (Body_Id);
4750 (Body_Id, Body_Id, 'b', Set_Ref => False, Force => True);
4752 -- If the body is an entry wrapper created for an entry with
4753 -- preconditions, it must be compiled in the context of the
4754 -- enclosing synchronized object, because it may mention other
4755 -- operations of the type.
4757 if Is_Entry_Wrapper (Body_Id) then
4759 Prot : constant Entity_Id := Etype (First_Entity (Body_Id));
4762 Install_Declarations (Prot);
4766 Install_Formals (Body_Id);
4768 Push_Scope (Body_Id);
4771 -- For stubs and bodies with no previous spec, generate references to
4774 Generate_Reference_To_Formals (Body_Id);
4777 -- Entry barrier functions are generated outside the protected type and
4778 -- should not carry the SPARK_Mode of the enclosing context.
4780 if Nkind (N) = N_Subprogram_Body
4781 and then Is_Entry_Barrier_Function (N)
4785 -- The body is generated as part of expression function expansion. When
4786 -- the expression function appears in the visible declarations of a
4787 -- package, the body is added to the private declarations. Since both
4788 -- declarative lists may be subject to a different SPARK_Mode, inherit
4789 -- the mode of the spec.
4791 -- package P with SPARK_Mode is
4792 -- function Expr_Func ... is (...); -- original
4793 -- [function Expr_Func ...;] -- generated spec
4796 -- pragma SPARK_Mode (Off);
4797 -- [function Expr_Func ... is return ...;] -- generated body
4798 -- end P; -- mode is ON
4800 elsif not Comes_From_Source (N)
4801 and then Present (Spec_Id)
4802 and then Is_Expression_Function (Spec_Id)
4804 Set_SPARK_Pragma (Body_Id, SPARK_Pragma (Spec_Id));
4805 Set_SPARK_Pragma_Inherited
4806 (Body_Id, SPARK_Pragma_Inherited (Spec_Id));
4808 -- Set the SPARK_Mode from the current context (may be overwritten later
4809 -- with explicit pragma). Exclude the case where the SPARK_Mode appears
4810 -- initially on a stand-alone subprogram body, but is then relocated to
4811 -- a generated corresponding spec. In this scenario the mode is shared
4812 -- between the spec and body.
4814 elsif No (SPARK_Pragma (Body_Id)) then
4815 Set_SPARK_Pragma (Body_Id, SPARK_Mode_Pragma);
4816 Set_SPARK_Pragma_Inherited (Body_Id);
4819 -- A subprogram body may be instantiated or inlined at a later pass.
4820 -- Restore the state of Ignore_SPARK_Mode_Pragmas_In_Instance when it
4821 -- applied to the initial declaration of the body.
4823 if Present (Spec_Id) then
4824 if Ignore_SPARK_Mode_Pragmas (Spec_Id) then
4825 Ignore_SPARK_Mode_Pragmas_In_Instance := True;
4829 -- Save the state of flag Ignore_SPARK_Mode_Pragmas_In_Instance in
4830 -- case the body is instantiated or inlined later and out of context.
4831 -- The body uses this attribute to restore the value of the global
4834 if Ignore_SPARK_Mode_Pragmas_In_Instance then
4835 Set_Ignore_SPARK_Mode_Pragmas (Body_Id);
4837 elsif Ignore_SPARK_Mode_Pragmas (Body_Id) then
4838 Ignore_SPARK_Mode_Pragmas_In_Instance := True;
4842 -- Preserve relevant elaboration-related attributes of the context which
4843 -- are no longer available or very expensive to recompute once analysis,
4844 -- resolution, and expansion are over.
4846 if No (Spec_Id) then
4847 Mark_Elaboration_Attributes
4853 -- If this is the proper body of a stub, we must verify that the stub
4854 -- conforms to the body, and to the previous spec if one was present.
4855 -- We know already that the body conforms to that spec. This test is
4856 -- only required for subprograms that come from source.
4858 if Nkind (Parent (N)) = N_Subunit
4859 and then Comes_From_Source (N)
4860 and then not Error_Posted (Body_Id)
4861 and then Nkind (Corresponding_Stub (Parent (N))) =
4862 N_Subprogram_Body_Stub
4865 Old_Id : constant Entity_Id :=
4867 (Specification (Corresponding_Stub (Parent (N))));
4869 Conformant : Boolean := False;
4872 if No (Spec_Id) then
4873 Check_Fully_Conformant (Body_Id, Old_Id);
4877 (Body_Id, Old_Id, Fully_Conformant, False, Conformant);
4879 if not Conformant then
4881 -- The stub was taken to be a new declaration. Indicate that
4884 Set_Has_Completion (Old_Id, False);
4890 Set_Has_Completion (Body_Id);
4891 Check_Eliminated (Body_Id);
4893 -- Analyze any aspect specifications that appear on the subprogram body
4894 -- stub. Stop the analysis now as the stub does not have a declarative
4895 -- or a statement part, and it cannot be inlined.
4897 if Nkind (N) = N_Subprogram_Body_Stub then
4898 if Has_Aspects (N) then
4899 Analyze_Aspects_On_Subprogram_Body_Or_Stub (N);
4908 and then Serious_Errors_Detected = 0
4909 and then Present (Spec_Id)
4910 and then Has_Pragma_Inline (Spec_Id)
4912 -- Legacy implementation (relying on front-end inlining)
4914 if not Back_End_Inlining then
4915 if Has_Pragma_Inline_Always (Spec_Id)
4916 or else (Front_End_Inlining
4917 and then not Opt.Disable_FE_Inline)
4919 Build_Body_To_Inline (N, Spec_Id);
4922 -- New implementation (relying on back-end inlining)
4925 if Has_Pragma_Inline_Always (Spec_Id)
4926 or else Optimization_Level > 0
4928 -- Handle function returning an unconstrained type
4930 if Comes_From_Source (Body_Id)
4931 and then Ekind (Spec_Id) = E_Function
4932 and then Returns_Unconstrained_Type (Spec_Id)
4934 -- If function builds in place, i.e. returns a limited type,
4935 -- inlining cannot be done.
4937 and then not Is_Limited_Type (Etype (Spec_Id))
4939 Check_And_Split_Unconstrained_Function (N, Spec_Id, Body_Id);
4943 Subp_Body : constant Node_Id :=
4944 Unit_Declaration_Node (Body_Id);
4945 Subp_Decl : constant List_Id := Declarations (Subp_Body);
4948 -- Do not pass inlining to the backend if the subprogram
4949 -- has declarations or statements which cannot be inlined
4950 -- by the backend. This check is done here to emit an
4951 -- error instead of the generic warning message reported
4952 -- by the GCC backend (ie. "function might not be
4955 if Present (Subp_Decl)
4956 and then Has_Excluded_Declaration (Spec_Id, Subp_Decl)
4960 elsif Has_Excluded_Statement
4963 (Handled_Statement_Sequence (Subp_Body)))
4967 -- If the backend inlining is available then at this
4968 -- stage we only have to mark the subprogram as inlined.
4969 -- The expander will take care of registering it in the
4970 -- table of subprograms inlined by the backend a part of
4971 -- processing calls to it (cf. Expand_Call)
4974 Set_Is_Inlined (Spec_Id);
4981 -- In GNATprove mode, inline only when there is a separate subprogram
4982 -- declaration for now, as inlining of subprogram bodies acting as
4983 -- declarations, or subprogram stubs, are not supported by front-end
4984 -- inlining. This inlining should occur after analysis of the body, so
4985 -- that it is known whether the value of SPARK_Mode, which can be
4986 -- defined by a pragma inside the body, is applicable to the body.
4987 -- Inlining can be disabled with switch -gnatdm
4989 elsif GNATprove_Mode
4990 and then Full_Analysis
4991 and then not Inside_A_Generic
4992 and then Present (Spec_Id)
4994 Nkind (Unit_Declaration_Node (Spec_Id)) = N_Subprogram_Declaration
4995 and then Body_Has_SPARK_Mode_On
4996 and then Can_Be_Inlined_In_GNATprove_Mode (Spec_Id, Body_Id)
4997 and then not Body_Has_Contract
4998 and then not Debug_Flag_M
5000 Build_Body_To_Inline (N, Spec_Id);
5003 -- When generating code, inherited pre/postconditions are handled when
5004 -- expanding the corresponding contract.
5006 -- Ada 2005 (AI-262): In library subprogram bodies, after the analysis
5007 -- of the specification we have to install the private withed units.
5008 -- This holds for child units as well.
5010 if Is_Compilation_Unit (Body_Id)
5011 or else Nkind (Parent (N)) = N_Compilation_Unit
5013 Install_Private_With_Clauses (Body_Id);
5016 Check_Anonymous_Return;
5018 -- Set the Protected_Formal field of each extra formal of the protected
5019 -- subprogram to reference the corresponding extra formal of the
5020 -- subprogram that implements it. For regular formals this occurs when
5021 -- the protected subprogram's declaration is expanded, but the extra
5022 -- formals don't get created until the subprogram is frozen. We need to
5023 -- do this before analyzing the protected subprogram's body so that any
5024 -- references to the original subprogram's extra formals will be changed
5025 -- refer to the implementing subprogram's formals (see Expand_Formal).
5027 if Present (Spec_Id)
5028 and then Is_Protected_Type (Scope (Spec_Id))
5029 and then Present (Protected_Body_Subprogram (Spec_Id))
5032 Impl_Subp : constant Entity_Id :=
5033 Protected_Body_Subprogram (Spec_Id);
5034 Prot_Ext_Formal : Entity_Id := Extra_Formals (Spec_Id);
5035 Impl_Ext_Formal : Entity_Id := Extra_Formals (Impl_Subp);
5038 while Present (Prot_Ext_Formal) loop
5039 pragma Assert (Present (Impl_Ext_Formal));
5040 Set_Protected_Formal (Prot_Ext_Formal, Impl_Ext_Formal);
5041 Next_Formal_With_Extras (Prot_Ext_Formal);
5042 Next_Formal_With_Extras (Impl_Ext_Formal);
5047 -- Generate minimum accessibility local objects to correspond with
5048 -- any extra formal added for anonymous access types. This new local
5049 -- object can then be used instead of the formal in case it is used
5050 -- in an actual to a call to a nested subprogram.
5052 -- This method is used to supplement our "small integer model" for
5053 -- accessibility-check generation (for more information see
5054 -- Accessibility_Level).
5056 -- Because we allow accessibility values greater than our expected value
5057 -- passing along the same extra accessibility formal as an actual
5058 -- to a nested subprogram becomes a problem because high values mean
5059 -- different things to the callee even though they are the same to the
5060 -- caller. So, as described in the first section, we create a local
5061 -- object representing the minimum of the accessibility level value that
5062 -- is passed in and the accessibility level of the callee's parameter
5063 -- and locals and use it in the case of a call to a nested subprogram.
5064 -- This generated object is refered to as a "minimum accessiblity
5067 if Present (Spec_Id) or else Present (Body_Id) then
5068 Body_Nod := Unit_Declaration_Node (Body_Id);
5073 -- Grab the appropriate formal depending on whether there exists
5074 -- an actual spec for the subprogram or whether we are dealing
5075 -- with a protected subprogram.
5077 if Present (Spec_Id) then
5078 if Present (Protected_Body_Subprogram (Spec_Id)) then
5079 Form := First_Formal (Protected_Body_Subprogram (Spec_Id));
5081 Form := First_Formal (Spec_Id);
5084 Form := First_Formal (Body_Id);
5087 -- Loop through formals if the subprogram is capable of accepting
5088 -- a generated local object. If it is not then it is also not
5089 -- capable of having local subprograms meaning it would not need
5090 -- a minimum accessibility level object anyway.
5092 if Present (Body_Nod)
5093 and then Has_Declarations (Body_Nod)
5094 and then Nkind (Body_Nod) /= N_Package_Specification
5096 while Present (Form) loop
5098 if Present (Extra_Accessibility (Form))
5099 and then No (Minimum_Accessibility (Form))
5101 -- Generate the minimum accessibility level object
5103 -- A60b : constant natural := natural'min(1, paramL);
5105 Generate_Minimum_Accessibility
5106 (Extra_Accessibility (Form), Form);
5112 -- Generate the minimum accessibility level object for the
5113 -- function's Extra_Accessibility_Of_Result.
5115 -- A31b : constant natural := natural'min (2, funcL);
5117 if Ekind (Body_Id) = E_Function
5118 and then Present (Extra_Accessibility_Of_Result (Body_Id))
5120 Generate_Minimum_Accessibility
5121 (Extra_Accessibility_Of_Result (Body_Id));
5123 -- Replace the Extra_Accessibility_Of_Result with the new
5124 -- minimum accessibility object.
5126 Set_Extra_Accessibility_Of_Result
5127 (Body_Id, Minimum_Accessibility
5128 (Extra_Accessibility_Of_Result (Body_Id)));
5134 -- Now we can go on to analyze the body
5136 HSS := Handled_Statement_Sequence (N);
5137 Set_Actual_Subtypes (N, Current_Scope);
5139 -- Add a declaration for the Protection object, renaming declarations
5140 -- for discriminals and privals and finally a declaration for the entry
5141 -- family index (if applicable). This form of early expansion is done
5142 -- when the Expander is active because Install_Private_Data_Declarations
5143 -- references entities which were created during regular expansion. The
5144 -- subprogram entity must come from source, and not be an internally
5145 -- generated subprogram.
5148 and then Present (Prot_Typ)
5149 and then Present (Spec_Id)
5150 and then Comes_From_Source (Spec_Id)
5151 and then not Is_Eliminated (Spec_Id)
5153 Install_Private_Data_Declarations
5154 (Sloc (N), Spec_Id, Prot_Typ, N, Declarations (N));
5157 -- Ada 2012 (AI05-0151): Incomplete types coming from a limited context
5158 -- may now appear in parameter and result profiles. Since the analysis
5159 -- of a subprogram body may use the parameter and result profile of the
5160 -- spec, swap any limited views with their non-limited counterpart.
5162 if Ada_Version >= Ada_2012 and then Present (Spec_Id) then
5163 Exch_Views := Exchange_Limited_Views (Spec_Id);
5166 -- If the return type is an anonymous access type whose designated type
5167 -- is the limited view of a class-wide type and the non-limited view is
5168 -- available, update the return type accordingly.
5170 if Ada_Version >= Ada_2005 and then Present (Spec_Id) then
5176 Rtyp := Etype (Spec_Id);
5178 if Ekind (Rtyp) = E_Anonymous_Access_Type then
5179 Etyp := Directly_Designated_Type (Rtyp);
5181 if Is_Class_Wide_Type (Etyp)
5182 and then From_Limited_With (Etyp)
5185 Set_Directly_Designated_Type (Rtyp, Available_View (Etyp));
5191 -- Analyze any aspect specifications that appear on the subprogram body
5193 if Has_Aspects (N) then
5194 Analyze_Aspects_On_Subprogram_Body_Or_Stub (N);
5197 Analyze_Declarations (Declarations (N));
5199 -- Verify that the SPARK_Mode of the body agrees with that of its spec
5201 if Present (Spec_Id) and then Present (SPARK_Pragma (Body_Id)) then
5202 if Present (SPARK_Pragma (Spec_Id)) then
5203 if Get_SPARK_Mode_From_Annotation (SPARK_Pragma (Spec_Id)) = Off
5205 Get_SPARK_Mode_From_Annotation (SPARK_Pragma (Body_Id)) = On
5207 Error_Msg_Sloc := Sloc (SPARK_Pragma (Body_Id));
5208 Error_Msg_N ("incorrect application of SPARK_Mode#", N);
5209 Error_Msg_Sloc := Sloc (SPARK_Pragma (Spec_Id));
5211 ("\value Off was set for SPARK_Mode on & #", N, Spec_Id);
5214 elsif Nkind (Parent (Parent (Spec_Id))) = N_Subprogram_Body_Stub then
5217 -- SPARK_Mode Off could complete no SPARK_Mode in a generic, either
5218 -- as specified in source code, or because SPARK_Mode On is ignored
5219 -- in an instance where the context is SPARK_Mode Off/Auto.
5221 elsif Get_SPARK_Mode_From_Annotation (SPARK_Pragma (Body_Id)) = Off
5222 and then (Is_Generic_Unit (Spec_Id) or else In_Instance)
5227 Error_Msg_Sloc := Sloc (SPARK_Pragma (Body_Id));
5228 Error_Msg_N ("incorrect application of SPARK_Mode #", N);
5229 Error_Msg_Sloc := Sloc (Spec_Id);
5231 ("\no value was set for SPARK_Mode on & #", N, Spec_Id);
5235 -- A subprogram body freezes its own contract. Analyze the contract
5236 -- after the declarations of the body have been processed as pragmas
5237 -- are now chained on the contract of the subprogram body.
5239 Analyze_Entry_Or_Subprogram_Body_Contract (Body_Id);
5241 -- Check completion, and analyze the statements
5244 Inspect_Deferred_Constant_Completion (Declarations (N));
5247 -- Add the generated minimum accessibility objects to the subprogram
5248 -- body's list of declarations after analysis of the statements and
5251 while Is_Non_Empty_List (Minimum_Acc_Objs) loop
5252 if Present (Declarations (Body_Nod)) then
5253 Prepend (Remove_Head (Minimum_Acc_Objs), Declarations (Body_Nod));
5256 (Body_Nod, New_List (Remove_Head (Minimum_Acc_Objs)));
5260 -- Deal with end of scope processing for the body
5262 Process_End_Label (HSS, 't', Current_Scope);
5263 Update_Use_Clause_Chain;
5266 -- If we are compiling an entry wrapper, remove the enclosing
5267 -- synchronized object from the stack.
5269 if Is_Entry_Wrapper (Body_Id) then
5273 Check_Subprogram_Order (N);
5274 Set_Analyzed (Body_Id);
5276 -- If we have a separate spec, then the analysis of the declarations
5277 -- caused the entities in the body to be chained to the spec id, but
5278 -- we want them chained to the body id. Only the formal parameters
5279 -- end up chained to the spec id in this case.
5281 if Present (Spec_Id) then
5283 -- We must conform to the categorization of our spec
5285 Validate_Categorization_Dependency (N, Spec_Id);
5287 -- And if this is a child unit, the parent units must conform
5289 if Is_Child_Unit (Spec_Id) then
5290 Validate_Categorization_Dependency
5291 (Unit_Declaration_Node (Spec_Id), Spec_Id);
5294 -- Here is where we move entities from the spec to the body
5296 -- Case where there are entities that stay with the spec
5298 if Present (Last_Real_Spec_Entity) then
5300 -- No body entities (happens when the only real spec entities come
5301 -- from precondition and postcondition pragmas).
5303 if No (Last_Entity (Body_Id)) then
5304 Set_First_Entity (Body_Id, Next_Entity (Last_Real_Spec_Entity));
5306 -- Body entities present (formals), so chain stuff past them
5310 (Last_Entity (Body_Id), Next_Entity (Last_Real_Spec_Entity));
5313 Set_Next_Entity (Last_Real_Spec_Entity, Empty);
5314 Set_Last_Entity (Body_Id, Last_Entity (Spec_Id));
5315 Set_Last_Entity (Spec_Id, Last_Real_Spec_Entity);
5317 -- Case where there are no spec entities, in this case there can be
5318 -- no body entities either, so just move everything.
5320 -- If the body is generated for an expression function, it may have
5321 -- been preanalyzed already, if 'access was applied to it.
5324 if Nkind (Original_Node (Unit_Declaration_Node (Spec_Id))) /=
5325 N_Expression_Function
5327 pragma Assert (No (Last_Entity (Body_Id)));
5331 Set_First_Entity (Body_Id, First_Entity (Spec_Id));
5332 Set_Last_Entity (Body_Id, Last_Entity (Spec_Id));
5333 Set_First_Entity (Spec_Id, Empty);
5334 Set_Last_Entity (Spec_Id, Empty);
5337 -- Otherwise the body does not complete a previous declaration. Check
5338 -- the categorization of the body against the units it withs.
5341 Validate_Categorization_Dependency (N, Body_Id);
5344 Check_Missing_Return;
5346 -- Now we are going to check for variables that are never modified in
5347 -- the body of the procedure. But first we deal with a special case
5348 -- where we want to modify this check. If the body of the subprogram
5349 -- starts with a raise statement or its equivalent, or if the body
5350 -- consists entirely of a null statement, then it is pretty obvious that
5351 -- it is OK to not reference the parameters. For example, this might be
5352 -- the following common idiom for a stubbed function: statement of the
5353 -- procedure raises an exception. In particular this deals with the
5354 -- common idiom of a stubbed function, which appears something like:
5356 -- function F (A : Integer) return Some_Type;
5359 -- raise Program_Error;
5363 -- Here the purpose of X is simply to satisfy the annoying requirement
5364 -- in Ada that there be at least one return, and we certainly do not
5365 -- want to go posting warnings on X that it is not initialized. On
5366 -- the other hand, if X is entirely unreferenced that should still
5369 -- What we do is to detect these cases, and if we find them, flag the
5370 -- subprogram as being Is_Trivial_Subprogram and then use that flag to
5371 -- suppress unwanted warnings. For the case of the function stub above
5372 -- we have a special test to set X as apparently assigned to suppress
5379 -- Skip call markers installed by the ABE mechanism, labels, and
5380 -- Push_xxx_Error_Label to find the first real statement.
5382 Stm := First (Statements (HSS));
5383 while Nkind (Stm) in N_Call_Marker | N_Label | N_Push_xxx_Label loop
5387 -- Do the test on the original statement before expansion
5390 Ostm : constant Node_Id := Original_Node (Stm);
5393 -- If explicit raise statement, turn on flag
5395 if Nkind (Ostm) = N_Raise_Statement then
5396 Set_Trivial_Subprogram (Stm);
5398 -- If null statement, and no following statements, turn on flag
5400 elsif Nkind (Stm) = N_Null_Statement
5401 and then Comes_From_Source (Stm)
5402 and then No (Next (Stm))
5404 Set_Trivial_Subprogram (Stm);
5406 -- Check for explicit call cases which likely raise an exception
5408 elsif Nkind (Ostm) = N_Procedure_Call_Statement then
5409 if Is_Entity_Name (Name (Ostm)) then
5411 Ent : constant Entity_Id := Entity (Name (Ostm));
5414 -- If the procedure is marked No_Return, then likely it
5415 -- raises an exception, but in any case it is not coming
5416 -- back here, so turn on the flag.
5419 and then Ekind (Ent) = E_Procedure
5420 and then No_Return (Ent)
5422 Set_Trivial_Subprogram (Stm);
5430 -- Check for variables that are never modified
5437 -- If there is a separate spec, then transfer Never_Set_In_Source
5438 -- flags from out parameters to the corresponding entities in the
5439 -- body. The reason we do that is we want to post error flags on
5440 -- the body entities, not the spec entities.
5442 if Present (Spec_Id) then
5443 E1 := First_Entity (Spec_Id);
5444 while Present (E1) loop
5445 if Ekind (E1) = E_Out_Parameter then
5446 E2 := First_Entity (Body_Id);
5447 while Present (E2) loop
5448 exit when Chars (E1) = Chars (E2);
5452 if Present (E2) then
5453 Set_Never_Set_In_Source (E2, Never_Set_In_Source (E1));
5461 -- Check references of the subprogram spec when we are dealing with
5462 -- an expression function due to it having a generated body.
5463 -- Otherwise, we simply check the formals of the subprogram body.
5465 if Present (Spec_Id)
5466 and then Is_Expression_Function (Spec_Id)
5468 Check_References (Spec_Id);
5470 Check_References (Body_Id);
5474 -- Check for nested subprogram, and mark outer level subprogram if so
5480 if Present (Spec_Id) then
5487 Ent := Enclosing_Subprogram (Ent);
5488 exit when No (Ent) or else Is_Subprogram (Ent);
5491 if Present (Ent) then
5492 Set_Has_Nested_Subprogram (Ent);
5496 -- Restore the limited views in the spec, if any, to let the back end
5497 -- process it without running into circularities.
5499 if Exch_Views /= No_Elist then
5500 Restore_Limited_Views (Exch_Views);
5503 if Mask_Types /= No_Elist then
5504 Unmask_Unfrozen_Types (Mask_Types);
5507 if Present (Desig_View) then
5508 Set_Directly_Designated_Type (Etype (Spec_Id), Desig_View);
5512 if Present (Ignored_Ghost_Region) then
5513 Expander_Active := Saved_EA;
5516 Ignore_SPARK_Mode_Pragmas_In_Instance := Saved_ISMP;
5517 Restore_Ghost_Region (Saved_GM, Saved_IGR);
5518 end Analyze_Subprogram_Body_Helper;
5520 ------------------------------------
5521 -- Analyze_Subprogram_Declaration --
5522 ------------------------------------
5524 procedure Analyze_Subprogram_Declaration (N : Node_Id) is
5525 Scop : constant Entity_Id := Current_Scope;
5526 Designator : Entity_Id;
5528 Is_Completion : Boolean;
5529 -- Indicates whether a null procedure declaration is a completion
5532 -- Null procedures are not allowed in SPARK
5534 if Nkind (Specification (N)) = N_Procedure_Specification
5535 and then Null_Present (Specification (N))
5537 -- Null procedures are allowed in protected types, following the
5538 -- recent AI12-0147.
5540 if Is_Protected_Type (Current_Scope)
5541 and then Ada_Version < Ada_2012
5543 Error_Msg_N ("protected operation cannot be a null procedure", N);
5546 Analyze_Null_Procedure (N, Is_Completion);
5548 -- The null procedure acts as a body, nothing further is needed
5550 if Is_Completion then
5555 Designator := Analyze_Subprogram_Specification (Specification (N));
5557 -- A reference may already have been generated for the unit name, in
5558 -- which case the following call is redundant. However it is needed for
5559 -- declarations that are the rewriting of an expression function.
5561 Generate_Definition (Designator);
5563 -- Set the SPARK mode from the current context (may be overwritten later
5564 -- with explicit pragma). This is not done for entry barrier functions
5565 -- because they are generated outside the protected type and should not
5566 -- carry the mode of the enclosing context.
5568 if Nkind (N) = N_Subprogram_Declaration
5569 and then Is_Entry_Barrier_Function (N)
5574 Set_SPARK_Pragma (Designator, SPARK_Mode_Pragma);
5575 Set_SPARK_Pragma_Inherited (Designator);
5578 -- Save the state of flag Ignore_SPARK_Mode_Pragmas_In_Instance in case
5579 -- the body of this subprogram is instantiated or inlined later and out
5580 -- of context. The body uses this attribute to restore the value of the
5583 if Ignore_SPARK_Mode_Pragmas_In_Instance then
5584 Set_Ignore_SPARK_Mode_Pragmas (Designator);
5587 -- Preserve relevant elaboration-related attributes of the context which
5588 -- are no longer available or very expensive to recompute once analysis,
5589 -- resolution, and expansion are over.
5591 Mark_Elaboration_Attributes
5592 (N_Id => Designator,
5596 if Debug_Flag_C then
5597 Write_Str ("==> subprogram spec ");
5598 Write_Name (Chars (Designator));
5599 Write_Str (" from ");
5600 Write_Location (Sloc (N));
5605 Validate_RCI_Subprogram_Declaration (N);
5606 New_Overloaded_Entity (Designator);
5607 Check_Delayed_Subprogram (Designator);
5609 -- If the type of the first formal of the current subprogram is a non-
5610 -- generic tagged private type, mark the subprogram as being a private
5611 -- primitive. Ditto if this is a function with controlling result, and
5612 -- the return type is currently private. In both cases, the type of the
5613 -- controlling argument or result must be in the current scope for the
5614 -- operation to be primitive.
5616 if Has_Controlling_Result (Designator)
5617 and then Is_Private_Type (Etype (Designator))
5618 and then Scope (Etype (Designator)) = Current_Scope
5619 and then not Is_Generic_Actual_Type (Etype (Designator))
5621 Set_Is_Private_Primitive (Designator);
5623 elsif Present (First_Formal (Designator)) then
5625 Formal_Typ : constant Entity_Id :=
5626 Etype (First_Formal (Designator));
5628 Set_Is_Private_Primitive (Designator,
5629 Is_Tagged_Type (Formal_Typ)
5630 and then Scope (Formal_Typ) = Current_Scope
5631 and then Is_Private_Type (Formal_Typ)
5632 and then not Is_Generic_Actual_Type (Formal_Typ));
5636 -- Ada 2005 (AI-251): Abstract interface primitives must be abstract
5639 if Ada_Version >= Ada_2005
5640 and then Comes_From_Source (N)
5641 and then Is_Dispatching_Operation (Designator)
5648 if Has_Controlling_Result (Designator) then
5649 Etyp := Etype (Designator);
5652 E := First_Entity (Designator);
5654 and then Is_Formal (E)
5655 and then not Is_Controlling_Formal (E)
5663 if Is_Access_Type (Etyp) then
5664 Etyp := Directly_Designated_Type (Etyp);
5667 if Is_Interface (Etyp)
5668 and then not Is_Abstract_Subprogram (Designator)
5669 and then not (Ekind (Designator) = E_Procedure
5670 and then Null_Present (Specification (N)))
5672 Error_Msg_Name_1 := Chars (Defining_Entity (N));
5674 -- Specialize error message based on procedures vs. functions,
5675 -- since functions can't be null subprograms.
5677 if Ekind (Designator) = E_Procedure then
5679 ("interface procedure % must be abstract or null", N);
5682 ("interface function % must be abstract", N);
5688 -- For a compilation unit, set body required. This flag will only be
5689 -- reset if a valid Import or Interface pragma is processed later on.
5691 if Nkind (Parent (N)) = N_Compilation_Unit then
5692 Set_Body_Required (Parent (N), True);
5694 if Ada_Version >= Ada_2005
5695 and then Nkind (Specification (N)) = N_Procedure_Specification
5696 and then Null_Present (Specification (N))
5699 ("null procedure cannot be declared at library level", N);
5703 Generate_Reference_To_Formals (Designator);
5704 Check_Eliminated (Designator);
5706 if Debug_Flag_C then
5708 Write_Str ("<== subprogram spec ");
5709 Write_Name (Chars (Designator));
5710 Write_Str (" from ");
5711 Write_Location (Sloc (N));
5715 -- Indicate that this is a protected operation, because it may be used
5716 -- in subsequent declarations within the protected type.
5718 if Is_Protected_Type (Current_Scope) then
5719 Set_Convention (Designator, Convention_Protected);
5722 List_Inherited_Pre_Post_Aspects (Designator);
5724 -- Process the aspects before establishing the proper categorization in
5725 -- case the subprogram is a compilation unit and one of its aspects is
5726 -- converted into a categorization pragma.
5728 if Has_Aspects (N) then
5729 Analyze_Aspect_Specifications (N, Designator);
5732 if Scop /= Standard_Standard and then not Is_Child_Unit (Designator) then
5733 Set_Categorization_From_Scope (Designator, Scop);
5735 -- Otherwise the unit is a compilation unit and/or a child unit. Set the
5736 -- proper categorization of the unit based on its pragmas.
5739 Push_Scope (Designator);
5740 Set_Categorization_From_Pragmas (N);
5741 Validate_Categorization_Dependency (N, Designator);
5744 end Analyze_Subprogram_Declaration;
5746 --------------------------------------
5747 -- Analyze_Subprogram_Specification --
5748 --------------------------------------
5750 -- Reminder: N here really is a subprogram specification (not a subprogram
5751 -- declaration). This procedure is called to analyze the specification in
5752 -- both subprogram bodies and subprogram declarations (specs).
5754 function Analyze_Subprogram_Specification (N : Node_Id) return Entity_Id is
5755 function Is_Invariant_Procedure_Or_Body (E : Entity_Id) return Boolean;
5756 -- Determine whether entity E denotes the spec or body of an invariant
5759 ------------------------------------
5760 -- Is_Invariant_Procedure_Or_Body --
5761 ------------------------------------
5763 function Is_Invariant_Procedure_Or_Body (E : Entity_Id) return Boolean is
5764 Decl : constant Node_Id := Unit_Declaration_Node (E);
5768 if Nkind (Decl) = N_Subprogram_Body then
5769 Spec := Corresponding_Spec (Decl);
5776 and then Ekind (Spec) = E_Procedure
5777 and then (Is_Partial_Invariant_Procedure (Spec)
5778 or else Is_Invariant_Procedure (Spec));
5779 end Is_Invariant_Procedure_Or_Body;
5783 Designator : constant Entity_Id := Defining_Entity (N);
5784 Formals : constant List_Id := Parameter_Specifications (N);
5786 -- Start of processing for Analyze_Subprogram_Specification
5789 -- Proceed with analysis. Do not emit a cross-reference entry if the
5790 -- specification comes from an expression function, because it may be
5791 -- the completion of a previous declaration. If it is not, the cross-
5792 -- reference entry will be emitted for the new subprogram declaration.
5794 if Nkind (Parent (N)) /= N_Expression_Function then
5795 Generate_Definition (Designator);
5798 if Nkind (N) = N_Function_Specification then
5799 Mutate_Ekind (Designator, E_Function);
5800 Set_Mechanism (Designator, Default_Mechanism);
5802 Mutate_Ekind (Designator, E_Procedure);
5803 Set_Etype (Designator, Standard_Void_Type);
5806 -- Flag Is_Inlined_Always is True by default, and reversed to False for
5807 -- those subprograms which could be inlined in GNATprove mode (because
5808 -- Body_To_Inline is non-Empty) but should not be inlined.
5810 if GNATprove_Mode then
5811 Set_Is_Inlined_Always (Designator);
5814 -- Introduce new scope for analysis of the formals and the return type
5816 Set_Scope (Designator, Current_Scope);
5818 if Present (Formals) then
5819 Push_Scope (Designator);
5820 Process_Formals (Formals, N);
5822 -- Check dimensions in N for formals with default expression
5824 Analyze_Dimension_Formals (N, Formals);
5826 -- Ada 2005 (AI-345): If this is an overriding operation of an
5827 -- inherited interface operation, and the controlling type is
5828 -- a synchronized type, replace the type with its corresponding
5829 -- record, to match the proper signature of an overriding operation.
5830 -- Same processing for an access parameter whose designated type is
5831 -- derived from a synchronized interface.
5833 -- This modification is not done for invariant procedures because
5834 -- the corresponding record may not necessarely be visible when the
5835 -- concurrent type acts as the full view of a private type.
5838 -- type Prot is private with Type_Invariant => ...;
5839 -- procedure ConcInvariant (Obj : Prot);
5841 -- protected type Prot is ...;
5842 -- type Concurrent_Record_Prot is record ...;
5843 -- procedure ConcInvariant (Obj : Prot) is
5845 -- end ConcInvariant;
5848 -- In the example above, both the spec and body of the invariant
5849 -- procedure must utilize the private type as the controlling type.
5851 if Ada_Version >= Ada_2005
5852 and then not Is_Invariant_Procedure_Or_Body (Designator)
5856 Formal_Typ : Entity_Id;
5857 Rec_Typ : Entity_Id;
5858 Desig_Typ : Entity_Id;
5861 Formal := First_Formal (Designator);
5862 while Present (Formal) loop
5863 Formal_Typ := Etype (Formal);
5865 if Is_Concurrent_Type (Formal_Typ)
5866 and then Present (Corresponding_Record_Type (Formal_Typ))
5868 Rec_Typ := Corresponding_Record_Type (Formal_Typ);
5870 if Present (Interfaces (Rec_Typ)) then
5871 Set_Etype (Formal, Rec_Typ);
5874 elsif Ekind (Formal_Typ) = E_Anonymous_Access_Type then
5875 Desig_Typ := Designated_Type (Formal_Typ);
5877 if Is_Concurrent_Type (Desig_Typ)
5878 and then Present (Corresponding_Record_Type (Desig_Typ))
5880 Rec_Typ := Corresponding_Record_Type (Desig_Typ);
5882 if Present (Interfaces (Rec_Typ)) then
5883 Set_Directly_Designated_Type (Formal_Typ, Rec_Typ);
5888 Next_Formal (Formal);
5895 -- The subprogram scope is pushed and popped around the processing of
5896 -- the return type for consistency with call above to Process_Formals
5897 -- (which itself can call Analyze_Return_Type), and to ensure that any
5898 -- itype created for the return type will be associated with the proper
5901 elsif Nkind (N) = N_Function_Specification then
5902 Push_Scope (Designator);
5903 Analyze_Return_Type (N);
5909 if Nkind (N) = N_Function_Specification then
5911 -- Deal with operator symbol case
5913 if Nkind (Designator) = N_Defining_Operator_Symbol then
5914 Valid_Operator_Definition (Designator);
5917 May_Need_Actuals (Designator);
5919 -- Ada 2005 (AI-251): If the return type is abstract, verify that
5920 -- the subprogram is abstract also. This does not apply to renaming
5921 -- declarations, where abstractness is inherited, and to subprogram
5922 -- bodies generated for stream operations, which become renamings as
5925 -- In case of primitives associated with abstract interface types
5926 -- the check is applied later (see Analyze_Subprogram_Declaration).
5928 if Nkind (Original_Node (Parent (N))) not in
5929 N_Abstract_Subprogram_Declaration |
5930 N_Formal_Abstract_Subprogram_Declaration |
5931 N_Subprogram_Renaming_Declaration
5933 if Is_Abstract_Type (Etype (Designator)) then
5935 ("function that returns abstract type must be abstract", N);
5937 -- Ada 2012 (AI-0073): Extend this test to subprograms with an
5938 -- access result whose designated type is abstract.
5940 elsif Ada_Version >= Ada_2012
5941 and then Nkind (Result_Definition (N)) = N_Access_Definition
5943 not Is_Class_Wide_Type (Designated_Type (Etype (Designator)))
5944 and then Is_Abstract_Type (Designated_Type (Etype (Designator)))
5947 ("function whose access result designates abstract type "
5948 & "must be abstract", N);
5954 end Analyze_Subprogram_Specification;
5956 -----------------------
5957 -- Check_Conformance --
5958 -----------------------
5960 procedure Check_Conformance
5961 (New_Id : Entity_Id;
5963 Ctype : Conformance_Type;
5965 Conforms : out Boolean;
5966 Err_Loc : Node_Id := Empty;
5967 Get_Inst : Boolean := False;
5968 Skip_Controlling_Formals : Boolean := False)
5970 procedure Conformance_Error (Msg : String; N : Node_Id := New_Id);
5971 -- Sets Conforms to False. If Errmsg is False, then that's all it does.
5972 -- If Errmsg is True, then processing continues to post an error message
5973 -- for conformance error on given node. Two messages are output. The
5974 -- first message points to the previous declaration with a general "no
5975 -- conformance" message. The second is the detailed reason, supplied as
5976 -- Msg. The parameter N provide information for a possible & insertion
5977 -- in the message, and also provides the location for posting the
5978 -- message in the absence of a specified Err_Loc location.
5980 function Conventions_Match (Id1, Id2 : Entity_Id) return Boolean;
5981 -- True if the conventions of entities Id1 and Id2 match.
5983 function Null_Exclusions_Match (F1, F2 : Entity_Id) return Boolean;
5984 -- True if the null exclusions of two formals of anonymous access type
5987 -----------------------
5988 -- Conformance_Error --
5989 -----------------------
5991 procedure Conformance_Error (Msg : String; N : Node_Id := New_Id) is
5998 if No (Err_Loc) then
6004 Error_Msg_Sloc := Sloc (Old_Id);
6007 when Type_Conformant =>
6008 Error_Msg_N -- CODEFIX
6009 ("not type conformant with declaration#!", Enode);
6011 when Mode_Conformant =>
6012 if Nkind (Parent (Old_Id)) = N_Full_Type_Declaration then
6014 ("not mode conformant with operation inherited#!",
6018 ("not mode conformant with declaration#!", Enode);
6021 when Subtype_Conformant =>
6022 if Nkind (Parent (Old_Id)) = N_Full_Type_Declaration then
6024 ("not subtype conformant with operation inherited#!",
6028 ("not subtype conformant with declaration#!", Enode);
6031 when Fully_Conformant =>
6032 if Nkind (Parent (Old_Id)) = N_Full_Type_Declaration then
6033 Error_Msg_N -- CODEFIX
6034 ("not fully conformant with operation inherited#!",
6037 Error_Msg_N -- CODEFIX
6038 ("not fully conformant with declaration#!", Enode);
6042 Error_Msg_NE (Msg, Enode, N);
6044 end Conformance_Error;
6046 -----------------------
6047 -- Conventions_Match --
6048 -----------------------
6050 function Conventions_Match
6052 Id2 : Entity_Id) return Boolean
6055 -- Ignore the conventions of anonymous access-to-subprogram types
6056 -- and subprogram types because these are internally generated and
6057 -- the only way these may receive a convention is if they inherit
6058 -- the convention of a related subprogram.
6060 if Ekind (Id1) in E_Anonymous_Access_Subprogram_Type
6063 Ekind (Id2) in E_Anonymous_Access_Subprogram_Type
6068 -- Otherwise compare the conventions directly
6071 return Convention (Id1) = Convention (Id2);
6073 end Conventions_Match;
6075 ---------------------------
6076 -- Null_Exclusions_Match --
6077 ---------------------------
6079 function Null_Exclusions_Match (F1, F2 : Entity_Id) return Boolean is
6081 if not Is_Anonymous_Access_Type (Etype (F1))
6082 or else not Is_Anonymous_Access_Type (Etype (F2))
6087 -- AI12-0289-1: Case of controlling access parameter; False if the
6088 -- partial view is untagged, the full view is tagged, and no explicit
6089 -- "not null". Note that at this point, we're processing the package
6090 -- body, so private/full types have been swapped. The Sloc test below
6091 -- is to detect the (legal) case where F1 comes after the full type
6092 -- declaration. This part is disabled pre-2005, because "not null" is
6093 -- not allowed on those language versions.
6095 if Ada_Version >= Ada_2005
6096 and then Is_Controlling_Formal (F1)
6097 and then not Null_Exclusion_Present (Parent (F1))
6098 and then not Null_Exclusion_Present (Parent (F2))
6101 D : constant Entity_Id := Directly_Designated_Type (Etype (F1));
6102 Partial_View_Of_Desig : constant Entity_Id :=
6103 Incomplete_Or_Partial_View (D);
6105 return No (Partial_View_Of_Desig)
6106 or else Is_Tagged_Type (Partial_View_Of_Desig)
6107 or else Sloc (D) < Sloc (F1);
6110 -- Not a controlling parameter, or one or both views have an explicit
6114 return Null_Exclusion_Present (Parent (F1)) =
6115 Null_Exclusion_Present (Parent (F2));
6117 end Null_Exclusions_Match;
6121 Old_Type : constant Entity_Id := Etype (Old_Id);
6122 New_Type : constant Entity_Id := Etype (New_Id);
6123 Old_Formal : Entity_Id;
6124 New_Formal : Entity_Id;
6125 Old_Formal_Base : Entity_Id;
6126 New_Formal_Base : Entity_Id;
6128 -- Start of processing for Check_Conformance
6133 -- We need a special case for operators, since they don't appear
6136 if Ctype = Type_Conformant then
6137 if Ekind (New_Id) = E_Operator
6138 and then Operator_Matches_Spec (New_Id, Old_Id)
6144 -- If both are functions/operators, check return types conform
6146 if Old_Type /= Standard_Void_Type
6148 New_Type /= Standard_Void_Type
6150 -- If we are checking interface conformance we omit controlling
6151 -- arguments and result, because we are only checking the conformance
6152 -- of the remaining parameters.
6154 if Has_Controlling_Result (Old_Id)
6155 and then Has_Controlling_Result (New_Id)
6156 and then Skip_Controlling_Formals
6160 elsif not Conforming_Types (Old_Type, New_Type, Ctype, Get_Inst) then
6161 if Ctype >= Subtype_Conformant
6162 and then not Predicates_Match (Old_Type, New_Type)
6165 ("\predicate of return type does not match!", New_Id);
6168 ("\return type does not match!", New_Id);
6174 -- Ada 2005 (AI-231): In case of anonymous access types check the
6175 -- null-exclusion and access-to-constant attributes match.
6177 if Ada_Version >= Ada_2005
6178 and then Ekind (Etype (Old_Type)) = E_Anonymous_Access_Type
6180 (Can_Never_Be_Null (Old_Type) /= Can_Never_Be_Null (New_Type)
6181 or else Is_Access_Constant (Etype (Old_Type)) /=
6182 Is_Access_Constant (Etype (New_Type)))
6184 Conformance_Error ("\return type does not match!", New_Id);
6188 -- If either is a function/operator and the other isn't, error
6190 elsif Old_Type /= Standard_Void_Type
6191 or else New_Type /= Standard_Void_Type
6193 Conformance_Error ("\functions can only match functions!", New_Id);
6197 -- In subtype conformant case, conventions must match (RM 6.3.1(16)).
6198 -- If this is a renaming as body, refine error message to indicate that
6199 -- the conflict is with the original declaration. If the entity is not
6200 -- frozen, the conventions don't have to match, the one of the renamed
6201 -- entity is inherited.
6203 if Ctype >= Subtype_Conformant then
6204 if not Conventions_Match (Old_Id, New_Id) then
6205 if not Is_Frozen (New_Id) then
6208 elsif Present (Err_Loc)
6209 and then Nkind (Err_Loc) = N_Subprogram_Renaming_Declaration
6210 and then Present (Corresponding_Spec (Err_Loc))
6212 Error_Msg_Name_1 := Chars (New_Id);
6214 Name_Ada + Convention_Id'Pos (Convention (New_Id));
6215 Conformance_Error ("\prior declaration for% has convention %!");
6219 Conformance_Error ("\calling conventions do not match!");
6223 Check_Formal_Subprogram_Conformance
6224 (New_Id, Old_Id, Err_Loc, Errmsg, Conforms);
6226 if not Conforms then
6232 -- Deal with parameters
6234 -- Note: we use the entity information, rather than going directly
6235 -- to the specification in the tree. This is not only simpler, but
6236 -- absolutely necessary for some cases of conformance tests between
6237 -- operators, where the declaration tree simply does not exist.
6239 Old_Formal := First_Formal (Old_Id);
6240 New_Formal := First_Formal (New_Id);
6241 while Present (Old_Formal) and then Present (New_Formal) loop
6242 if Is_Controlling_Formal (Old_Formal)
6243 and then Is_Controlling_Formal (New_Formal)
6244 and then Skip_Controlling_Formals
6246 -- The controlling formals will have different types when
6247 -- comparing an interface operation with its match, but both
6248 -- or neither must be access parameters.
6250 if Is_Access_Type (Etype (Old_Formal))
6252 Is_Access_Type (Etype (New_Formal))
6254 goto Skip_Controlling_Formal;
6257 ("\access parameter does not match!", New_Formal);
6261 -- Ada 2012: Mode conformance also requires that formal parameters
6262 -- be both aliased, or neither.
6264 if Ctype >= Mode_Conformant and then Ada_Version >= Ada_2012 then
6265 if Is_Aliased (Old_Formal) /= Is_Aliased (New_Formal) then
6267 ("\aliased parameter mismatch!", New_Formal);
6271 if Ctype = Fully_Conformant then
6273 -- Names must match. Error message is more accurate if we do
6274 -- this before checking that the types of the formals match.
6276 if Chars (Old_Formal) /= Chars (New_Formal) then
6277 Conformance_Error ("\name& does not match!", New_Formal);
6279 -- Set error posted flag on new formal as well to stop
6280 -- junk cascaded messages in some cases.
6282 Set_Error_Posted (New_Formal);
6286 -- Null exclusion must match
6288 if not Relaxed_RM_Semantics
6289 and then not Null_Exclusions_Match (Old_Formal, New_Formal)
6292 ("\null exclusion for& does not match", New_Formal);
6294 -- Mark error posted on the new formal to avoid duplicated
6295 -- complaint about types not matching.
6297 Set_Error_Posted (New_Formal);
6301 -- Ada 2005 (AI-423): Possible access [sub]type and itype match. This
6302 -- case occurs whenever a subprogram is being renamed and one of its
6303 -- parameters imposes a null exclusion. For example:
6305 -- type T is null record;
6306 -- type Acc_T is access T;
6307 -- subtype Acc_T_Sub is Acc_T;
6309 -- procedure P (Obj : not null Acc_T_Sub); -- itype
6310 -- procedure Ren_P (Obj : Acc_T_Sub) -- subtype
6313 Old_Formal_Base := Etype (Old_Formal);
6314 New_Formal_Base := Etype (New_Formal);
6317 Old_Formal_Base := Get_Instance_Of (Old_Formal_Base);
6318 New_Formal_Base := Get_Instance_Of (New_Formal_Base);
6321 -- Types must always match. In the visible part of an instance,
6322 -- usual overloading rules for dispatching operations apply, and
6323 -- we check base types (not the actual subtypes).
6325 if In_Instance_Visible_Part
6326 and then Is_Dispatching_Operation (New_Id)
6328 if not Conforming_Types
6329 (T1 => Base_Type (Etype (Old_Formal)),
6330 T2 => Base_Type (Etype (New_Formal)),
6332 Get_Inst => Get_Inst)
6334 Conformance_Error ("\type of & does not match!", New_Formal);
6338 elsif not Conforming_Types
6339 (T1 => Old_Formal_Base,
6340 T2 => New_Formal_Base,
6342 Get_Inst => Get_Inst)
6344 -- Don't give error message if old type is Any_Type. This test
6345 -- avoids some cascaded errors, e.g. in case of a bad spec.
6347 if Errmsg and then Old_Formal_Base = Any_Type then
6350 if Ctype >= Subtype_Conformant
6352 not Predicates_Match (Old_Formal_Base, New_Formal_Base)
6355 ("\predicate of & does not match!", New_Formal);
6358 ("\type of & does not match!", New_Formal);
6360 if not Dimensions_Match (Old_Formal_Base, New_Formal_Base)
6362 Error_Msg_N ("\dimensions mismatch!", New_Formal);
6370 -- For mode conformance, mode must match
6372 if Ctype >= Mode_Conformant then
6373 if Parameter_Mode (Old_Formal) /= Parameter_Mode (New_Formal) then
6374 if Ekind (New_Id) not in E_Function | E_Procedure
6375 or else not Is_Primitive_Wrapper (New_Id)
6377 Conformance_Error ("\mode of & does not match!", New_Formal);
6381 T : constant Entity_Id := Find_Dispatching_Type (New_Id);
6383 if Is_Protected_Type (Corresponding_Concurrent_Type (T))
6388 Error_Msg_PT (New_Id, Ultimate_Alias (Old_Id));
6392 ("\mode of & does not match!", New_Formal);
6399 elsif Is_Access_Type (Old_Formal_Base)
6400 and then Is_Access_Type (New_Formal_Base)
6401 and then Is_Access_Constant (Old_Formal_Base) /=
6402 Is_Access_Constant (New_Formal_Base)
6405 ("\constant modifier does not match!", New_Formal);
6410 if Ctype >= Subtype_Conformant then
6412 -- Ada 2005 (AI-231): In case of anonymous access types check
6413 -- the null-exclusion and access-to-constant attributes must
6414 -- match. For null exclusion, we test the types rather than the
6415 -- formals themselves, since the attribute is only set reliably
6416 -- on the formals in the Ada 95 case, and we exclude the case
6417 -- where Old_Formal is marked as controlling, to avoid errors
6418 -- when matching completing bodies with dispatching declarations
6419 -- (access formals in the bodies aren't marked Can_Never_Be_Null).
6421 if Ada_Version >= Ada_2005
6422 and then Is_Anonymous_Access_Type (Etype (Old_Formal))
6423 and then Is_Anonymous_Access_Type (Etype (New_Formal))
6425 ((Can_Never_Be_Null (Etype (Old_Formal)) /=
6426 Can_Never_Be_Null (Etype (New_Formal))
6428 not Is_Controlling_Formal (Old_Formal))
6430 Is_Access_Constant (Etype (Old_Formal)) /=
6431 Is_Access_Constant (Etype (New_Formal)))
6433 -- Do not complain if error already posted on New_Formal. This
6434 -- avoids some redundant error messages.
6436 and then not Error_Posted (New_Formal)
6438 -- It is allowed to omit the null-exclusion in case of stream
6439 -- attribute subprograms. We recognize stream subprograms
6440 -- through their TSS-generated suffix.
6443 TSS_Name : constant TSS_Name_Type := Get_TSS_Name (New_Id);
6446 if TSS_Name /= TSS_Stream_Read
6447 and then TSS_Name /= TSS_Stream_Write
6448 and then TSS_Name /= TSS_Stream_Input
6449 and then TSS_Name /= TSS_Stream_Output
6451 -- Here we have a definite conformance error. It is worth
6452 -- special casing the error message for the case of a
6453 -- controlling formal (which excludes null).
6455 if Is_Controlling_Formal (New_Formal) then
6456 Error_Msg_Node_2 := Scope (New_Formal);
6458 ("\controlling formal & of & excludes null, "
6459 & "declaration must exclude null as well",
6462 -- Normal case (couldn't we give more detail here???)
6466 ("\type of & does not match!", New_Formal);
6475 -- Full conformance checks
6477 if Ctype = Fully_Conformant then
6479 -- We have checked already that names match
6481 if Parameter_Mode (Old_Formal) = E_In_Parameter then
6483 -- Check default expressions for in parameters
6486 NewD : constant Boolean :=
6487 Present (Default_Value (New_Formal));
6488 OldD : constant Boolean :=
6489 Present (Default_Value (Old_Formal));
6491 if NewD or OldD then
6493 -- The old default value has been analyzed because the
6494 -- current full declaration will have frozen everything
6495 -- before. The new default value has not been analyzed,
6496 -- so analyze it now before we check for conformance.
6499 Push_Scope (New_Id);
6500 Preanalyze_Spec_Expression
6501 (Default_Value (New_Formal), Etype (New_Formal));
6505 if not (NewD and OldD)
6506 or else not Fully_Conformant_Expressions
6507 (Default_Value (Old_Formal),
6508 Default_Value (New_Formal))
6511 ("\default expression for & does not match!",
6520 -- A couple of special checks for Ada 83 mode. These checks are
6521 -- skipped if either entity is an operator in package Standard,
6522 -- or if either old or new instance is not from the source program.
6524 if Ada_Version = Ada_83
6525 and then Sloc (Old_Id) > Standard_Location
6526 and then Sloc (New_Id) > Standard_Location
6527 and then Comes_From_Source (Old_Id)
6528 and then Comes_From_Source (New_Id)
6531 Old_Param : constant Node_Id := Declaration_Node (Old_Formal);
6532 New_Param : constant Node_Id := Declaration_Node (New_Formal);
6535 -- Explicit IN must be present or absent in both cases. This
6536 -- test is required only in the full conformance case.
6538 if In_Present (Old_Param) /= In_Present (New_Param)
6539 and then Ctype = Fully_Conformant
6542 ("\(Ada 83) IN must appear in both declarations",
6547 -- Grouping (use of comma in param lists) must be the same
6548 -- This is where we catch a misconformance like:
6551 -- A : Integer; B : Integer
6553 -- which are represented identically in the tree except
6554 -- for the setting of the flags More_Ids and Prev_Ids.
6556 if More_Ids (Old_Param) /= More_Ids (New_Param)
6557 or else Prev_Ids (Old_Param) /= Prev_Ids (New_Param)
6560 ("\grouping of & does not match!", New_Formal);
6566 -- This label is required when skipping controlling formals
6568 <<Skip_Controlling_Formal>>
6570 Next_Formal (Old_Formal);
6571 Next_Formal (New_Formal);
6574 if Present (Old_Formal) then
6575 Conformance_Error ("\too few parameters!");
6578 elsif Present (New_Formal) then
6579 Conformance_Error ("\too many parameters!", New_Formal);
6582 end Check_Conformance;
6584 -----------------------
6585 -- Check_Conventions --
6586 -----------------------
6588 procedure Check_Conventions (Typ : Entity_Id) is
6589 Ifaces_List : Elist_Id;
6591 procedure Check_Convention (Op : Entity_Id);
6592 -- Verify that the convention of inherited dispatching operation Op is
6593 -- consistent among all subprograms it overrides. In order to minimize
6594 -- the search, Search_From is utilized to designate a specific point in
6595 -- the list rather than iterating over the whole list once more.
6597 ----------------------
6598 -- Check_Convention --
6599 ----------------------
6601 procedure Check_Convention (Op : Entity_Id) is
6602 Op_Conv : constant Convention_Id := Convention (Op);
6603 Iface_Conv : Convention_Id;
6604 Iface_Elmt : Elmt_Id;
6605 Iface_Prim_Elmt : Elmt_Id;
6606 Iface_Prim : Entity_Id;
6609 Iface_Elmt := First_Elmt (Ifaces_List);
6610 while Present (Iface_Elmt) loop
6612 First_Elmt (Primitive_Operations (Node (Iface_Elmt)));
6613 while Present (Iface_Prim_Elmt) loop
6614 Iface_Prim := Node (Iface_Prim_Elmt);
6615 Iface_Conv := Convention (Iface_Prim);
6617 if Is_Interface_Conformant (Typ, Iface_Prim, Op)
6618 and then Iface_Conv /= Op_Conv
6621 ("inconsistent conventions in primitive operations", Typ);
6623 Error_Msg_Name_1 := Chars (Op);
6624 Error_Msg_Name_2 := Get_Convention_Name (Op_Conv);
6625 Error_Msg_Sloc := Sloc (Op);
6627 if Comes_From_Source (Op) or else No (Alias (Op)) then
6628 if not Present (Overridden_Operation (Op)) then
6629 Error_Msg_N ("\\primitive % defined #", Typ);
6632 ("\\overriding operation % with "
6633 & "convention % defined #", Typ);
6636 else pragma Assert (Present (Alias (Op)));
6637 Error_Msg_Sloc := Sloc (Alias (Op));
6638 Error_Msg_N ("\\inherited operation % with "
6639 & "convention % defined #", Typ);
6642 Error_Msg_Name_1 := Chars (Op);
6643 Error_Msg_Name_2 := Get_Convention_Name (Iface_Conv);
6644 Error_Msg_Sloc := Sloc (Iface_Prim);
6645 Error_Msg_N ("\\overridden operation % with "
6646 & "convention % defined #", Typ);
6648 -- Avoid cascading errors
6653 Next_Elmt (Iface_Prim_Elmt);
6656 Next_Elmt (Iface_Elmt);
6658 end Check_Convention;
6662 Prim_Op : Entity_Id;
6663 Prim_Op_Elmt : Elmt_Id;
6665 -- Start of processing for Check_Conventions
6668 if not Has_Interfaces (Typ) then
6672 Collect_Interfaces (Typ, Ifaces_List);
6674 -- The algorithm checks every overriding dispatching operation against
6675 -- all the corresponding overridden dispatching operations, detecting
6676 -- differences in conventions.
6678 Prim_Op_Elmt := First_Elmt (Primitive_Operations (Typ));
6679 while Present (Prim_Op_Elmt) loop
6680 Prim_Op := Node (Prim_Op_Elmt);
6682 -- A small optimization: skip the predefined dispatching operations
6683 -- since they always have the same convention.
6685 if not Is_Predefined_Dispatching_Operation (Prim_Op) then
6686 Check_Convention (Prim_Op);
6689 Next_Elmt (Prim_Op_Elmt);
6691 end Check_Conventions;
6693 ------------------------------
6694 -- Check_Delayed_Subprogram --
6695 ------------------------------
6697 procedure Check_Delayed_Subprogram (Designator : Entity_Id) is
6698 procedure Possible_Freeze (T : Entity_Id);
6699 -- T is the type of either a formal parameter or of the return type. If
6700 -- T is not yet frozen and needs a delayed freeze, then the subprogram
6701 -- itself must be delayed.
6703 ---------------------
6704 -- Possible_Freeze --
6705 ---------------------
6707 procedure Possible_Freeze (T : Entity_Id) is
6708 Scop : constant Entity_Id := Scope (Designator);
6711 -- If the subprogram appears within a package instance (which may be
6712 -- the wrapper package of a subprogram instance) the freeze node for
6713 -- that package will freeze the subprogram at the proper place, so
6714 -- do not emit a freeze node for the subprogram, given that it may
6715 -- appear in the wrong scope.
6717 if Ekind (Scop) = E_Package
6718 and then not Comes_From_Source (Scop)
6719 and then Is_Generic_Instance (Scop)
6723 elsif Has_Delayed_Freeze (T) and then not Is_Frozen (T) then
6724 Set_Has_Delayed_Freeze (Designator);
6726 elsif Is_Access_Type (T)
6727 and then Has_Delayed_Freeze (Designated_Type (T))
6728 and then not Is_Frozen (Designated_Type (T))
6730 Set_Has_Delayed_Freeze (Designator);
6732 end Possible_Freeze;
6738 -- Start of processing for Check_Delayed_Subprogram
6741 -- All subprograms, including abstract subprograms, may need a freeze
6742 -- node if some formal type or the return type needs one.
6744 Possible_Freeze (Etype (Designator));
6745 Possible_Freeze (Base_Type (Etype (Designator))); -- needed ???
6747 -- Need delayed freeze if any of the formal types themselves need a
6748 -- delayed freeze and are not yet frozen.
6750 F := First_Formal (Designator);
6751 while Present (F) loop
6752 Possible_Freeze (Etype (F));
6753 Possible_Freeze (Base_Type (Etype (F))); -- needed ???
6757 -- Mark functions that return by reference. Note that it cannot be done
6758 -- for delayed_freeze subprograms because the underlying returned type
6759 -- may not be known yet (for private types).
6761 if not Has_Delayed_Freeze (Designator) and then Expander_Active then
6762 Compute_Returns_By_Ref (Designator);
6764 end Check_Delayed_Subprogram;
6766 ------------------------------------
6767 -- Check_Discriminant_Conformance --
6768 ------------------------------------
6770 procedure Check_Discriminant_Conformance
6775 Old_Discr : Entity_Id := First_Discriminant (Prev);
6776 New_Discr : Node_Id := First (Discriminant_Specifications (N));
6777 New_Discr_Id : Entity_Id;
6778 New_Discr_Type : Entity_Id;
6780 procedure Conformance_Error (Msg : String; N : Node_Id);
6781 -- Post error message for conformance error on given node. Two messages
6782 -- are output. The first points to the previous declaration with a
6783 -- general "no conformance" message. The second is the detailed reason,
6784 -- supplied as Msg. The parameter N provide information for a possible
6785 -- & insertion in the message.
6787 -----------------------
6788 -- Conformance_Error --
6789 -----------------------
6791 procedure Conformance_Error (Msg : String; N : Node_Id) is
6793 Error_Msg_Sloc := Sloc (Prev_Loc);
6794 Error_Msg_N -- CODEFIX
6795 ("not fully conformant with declaration#!", N);
6796 Error_Msg_NE (Msg, N, N);
6797 end Conformance_Error;
6799 -- Start of processing for Check_Discriminant_Conformance
6802 while Present (Old_Discr) and then Present (New_Discr) loop
6803 New_Discr_Id := Defining_Identifier (New_Discr);
6805 -- The subtype mark of the discriminant on the full type has not
6806 -- been analyzed so we do it here. For an access discriminant a new
6809 if Nkind (Discriminant_Type (New_Discr)) = N_Access_Definition then
6811 Access_Definition (N, Discriminant_Type (New_Discr));
6814 Find_Type (Discriminant_Type (New_Discr));
6815 New_Discr_Type := Etype (Discriminant_Type (New_Discr));
6817 -- Ada 2005: if the discriminant definition carries a null
6818 -- exclusion, create an itype to check properly for consistency
6819 -- with partial declaration.
6821 if Is_Access_Type (New_Discr_Type)
6822 and then Null_Exclusion_Present (New_Discr)
6825 Create_Null_Excluding_Itype
6826 (T => New_Discr_Type,
6827 Related_Nod => New_Discr,
6828 Scope_Id => Current_Scope);
6832 if not Conforming_Types
6833 (Etype (Old_Discr), New_Discr_Type, Fully_Conformant)
6835 Conformance_Error ("type of & does not match!", New_Discr_Id);
6838 -- Treat the new discriminant as an occurrence of the old one,
6839 -- for navigation purposes, and fill in some semantic
6840 -- information, for completeness.
6842 Generate_Reference (Old_Discr, New_Discr_Id, 'r');
6843 Set_Etype (New_Discr_Id, Etype (Old_Discr));
6844 Set_Scope (New_Discr_Id, Scope (Old_Discr));
6849 if Chars (Old_Discr) /= Chars (Defining_Identifier (New_Discr)) then
6850 Conformance_Error ("name & does not match!", New_Discr_Id);
6854 -- Default expressions must match
6857 NewD : constant Boolean :=
6858 Present (Expression (New_Discr));
6859 OldD : constant Boolean :=
6860 Present (Expression (Parent (Old_Discr)));
6863 if NewD or OldD then
6865 -- The old default value has been analyzed and expanded,
6866 -- because the current full declaration will have frozen
6867 -- everything before. The new default values have not been
6868 -- expanded, so expand now to check conformance.
6871 Preanalyze_Spec_Expression
6872 (Expression (New_Discr), New_Discr_Type);
6875 if not (NewD and OldD)
6876 or else not Fully_Conformant_Expressions
6877 (Expression (Parent (Old_Discr)),
6878 Expression (New_Discr))
6882 ("default expression for & does not match!",
6889 -- In Ada 83 case, grouping must match: (A,B : X) /= (A : X; B : X)
6891 if Ada_Version = Ada_83 then
6893 Old_Disc : constant Node_Id := Declaration_Node (Old_Discr);
6896 -- Grouping (use of comma in param lists) must be the same
6897 -- This is where we catch a misconformance like:
6900 -- A : Integer; B : Integer
6902 -- which are represented identically in the tree except
6903 -- for the setting of the flags More_Ids and Prev_Ids.
6905 if More_Ids (Old_Disc) /= More_Ids (New_Discr)
6906 or else Prev_Ids (Old_Disc) /= Prev_Ids (New_Discr)
6909 ("grouping of & does not match!", New_Discr_Id);
6915 Next_Discriminant (Old_Discr);
6919 if Present (Old_Discr) then
6920 Conformance_Error ("too few discriminants!", Defining_Identifier (N));
6923 elsif Present (New_Discr) then
6925 ("too many discriminants!", Defining_Identifier (New_Discr));
6928 end Check_Discriminant_Conformance;
6930 -----------------------------------------
6931 -- Check_Formal_Subprogram_Conformance --
6932 -----------------------------------------
6934 procedure Check_Formal_Subprogram_Conformance
6935 (New_Id : Entity_Id;
6939 Conforms : out Boolean)
6945 if Is_Formal_Subprogram (Old_Id)
6946 or else Is_Formal_Subprogram (New_Id)
6947 or else (Is_Subprogram (New_Id)
6948 and then Present (Alias (New_Id))
6949 and then Is_Formal_Subprogram (Alias (New_Id)))
6951 if Present (Err_Loc) then
6960 Error_Msg_Sloc := Sloc (Old_Id);
6961 Error_Msg_N ("not subtype conformant with declaration#!", N);
6963 ("\formal subprograms are not subtype conformant "
6964 & "(RM 6.3.1 (17/3))", N, New_Id);
6967 end Check_Formal_Subprogram_Conformance;
6969 procedure Check_Formal_Subprogram_Conformance
6970 (New_Id : Entity_Id;
6972 Err_Loc : Node_Id := Empty)
6976 Check_Formal_Subprogram_Conformance
6977 (New_Id, Old_Id, Err_Loc, True, Ignore);
6978 end Check_Formal_Subprogram_Conformance;
6980 ----------------------------
6981 -- Check_Fully_Conformant --
6982 ----------------------------
6984 procedure Check_Fully_Conformant
6985 (New_Id : Entity_Id;
6987 Err_Loc : Node_Id := Empty)
6990 pragma Warnings (Off, Result);
6993 (New_Id, Old_Id, Fully_Conformant, True, Result, Err_Loc);
6994 end Check_Fully_Conformant;
6996 --------------------------
6997 -- Check_Limited_Return --
6998 --------------------------
7000 procedure Check_Limited_Return
7006 -- Ada 2005 (AI-318-02): Return-by-reference types have been removed and
7007 -- replaced by anonymous access results. This is an incompatibility with
7008 -- Ada 95. Not clear whether this should be enforced yet or perhaps
7009 -- controllable with special switch. ???
7011 -- A limited interface that is not immutably limited is OK
7013 if Is_Limited_Interface (R_Type)
7014 and then not Is_Concurrent_Interface (R_Type)
7018 elsif Is_Limited_Type (R_Type)
7019 and then not Is_Interface (R_Type)
7020 and then not (Nkind (N) = N_Simple_Return_Statement
7021 and then Comes_From_Extended_Return_Statement (N))
7022 and then not In_Instance_Body
7023 and then not OK_For_Limited_Init_In_05 (R_Type, Expr)
7025 -- Error in Ada 2005
7027 if Ada_Version >= Ada_2005
7028 and then not Debug_Flag_Dot_L
7029 and then not GNAT_Mode
7032 ("(Ada 2005) cannot copy object of a limited type "
7033 & "(RM-2005 6.5(5.5/2))", Expr);
7035 if Is_Limited_View (R_Type) then
7037 ("\return by reference not permitted in Ada 2005", Expr);
7040 -- Warn in Ada 95 mode, to give folks a heads up about this
7043 -- In GNAT mode, this is just a warning, to allow it to be evilly
7044 -- turned off. Otherwise it is a real error.
7046 -- In a generic context, simplify the warning because it makes no
7047 -- sense to discuss pass-by-reference or copy.
7049 elsif Warn_On_Ada_2005_Compatibility or GNAT_Mode then
7050 if Inside_A_Generic then
7052 ("return of limited object not permitted in Ada 2005 "
7053 & "(RM-2005 6.5(5.5/2))?y?", Expr);
7055 elsif Is_Limited_View (R_Type) then
7057 ("return by reference not permitted in Ada 2005 "
7058 & "(RM-2005 6.5(5.5/2))?y?", Expr);
7061 ("cannot copy object of a limited type in Ada 2005 "
7062 & "(RM-2005 6.5(5.5/2))?y?", Expr);
7065 -- Ada 95 mode, and compatibility warnings disabled
7068 pragma Assert (Ada_Version <= Ada_95);
7069 pragma Assert (not (Warn_On_Ada_2005_Compatibility or GNAT_Mode));
7070 return; -- skip continuation messages below
7073 if not Inside_A_Generic then
7075 ("\consider switching to return of access type", Expr);
7076 Explain_Limited_Type (R_Type, Expr);
7079 end Check_Limited_Return;
7081 ---------------------------
7082 -- Check_Mode_Conformant --
7083 ---------------------------
7085 procedure Check_Mode_Conformant
7086 (New_Id : Entity_Id;
7088 Err_Loc : Node_Id := Empty;
7089 Get_Inst : Boolean := False)
7092 pragma Warnings (Off, Result);
7095 (New_Id, Old_Id, Mode_Conformant, True, Result, Err_Loc, Get_Inst);
7096 end Check_Mode_Conformant;
7098 --------------------------------
7099 -- Check_Overriding_Indicator --
7100 --------------------------------
7102 procedure Check_Overriding_Indicator
7104 Overridden_Subp : Entity_Id;
7105 Is_Primitive : Boolean)
7111 -- No overriding indicator for literals
7113 if Ekind (Subp) = E_Enumeration_Literal then
7116 elsif Ekind (Subp) = E_Entry then
7117 Decl := Parent (Subp);
7119 -- No point in analyzing a malformed operator
7121 elsif Nkind (Subp) = N_Defining_Operator_Symbol
7122 and then Error_Posted (Subp)
7127 Decl := Unit_Declaration_Node (Subp);
7130 if Nkind (Decl) in N_Subprogram_Body
7131 | N_Subprogram_Body_Stub
7132 | N_Subprogram_Declaration
7133 | N_Abstract_Subprogram_Declaration
7134 | N_Subprogram_Renaming_Declaration
7136 Spec := Specification (Decl);
7138 elsif Nkind (Decl) = N_Entry_Declaration then
7145 -- An overriding indication is illegal on a subprogram declared
7146 -- in a protected body, where there is no operation to override.
7148 if (Must_Override (Spec) or else Must_Not_Override (Spec))
7149 and then Is_List_Member (Decl)
7150 and then Present (Parent (List_Containing (Decl)))
7151 and then Nkind (Parent (List_Containing (Decl))) = N_Protected_Body
7154 ("illegal overriding indication in protected body", Decl);
7158 -- The overriding operation is type conformant with the overridden one,
7159 -- but the names of the formals are not required to match. If the names
7160 -- appear permuted in the overriding operation, this is a possible
7161 -- source of confusion that is worth diagnosing. Controlling formals
7162 -- often carry names that reflect the type, and it is not worthwhile
7163 -- requiring that their names match.
7165 if Present (Overridden_Subp)
7166 and then Nkind (Subp) /= N_Defining_Operator_Symbol
7173 Form1 := First_Formal (Subp);
7174 Form2 := First_Formal (Overridden_Subp);
7176 -- If the overriding operation is a synchronized operation, skip
7177 -- the first parameter of the overridden operation, which is
7178 -- implicit in the new one. If the operation is declared in the
7179 -- body it is not primitive and all formals must match.
7181 if Is_Concurrent_Type (Scope (Subp))
7182 and then Is_Tagged_Type (Scope (Subp))
7183 and then not Has_Completion (Scope (Subp))
7185 Form2 := Next_Formal (Form2);
7188 if Present (Form1) then
7189 Form1 := Next_Formal (Form1);
7190 Form2 := Next_Formal (Form2);
7193 while Present (Form1) loop
7194 if not Is_Controlling_Formal (Form1)
7195 and then Present (Next_Formal (Form2))
7196 and then Chars (Form1) = Chars (Next_Formal (Form2))
7198 Error_Msg_Node_2 := Alias (Overridden_Subp);
7199 Error_Msg_Sloc := Sloc (Error_Msg_Node_2);
7201 ("& does not match corresponding formal of&#",
7206 Next_Formal (Form1);
7207 Next_Formal (Form2);
7212 -- If there is an overridden subprogram, then check that there is no
7213 -- "not overriding" indicator, and mark the subprogram as overriding.
7215 -- This is not done if the overridden subprogram is marked as hidden,
7216 -- which can occur for the case of inherited controlled operations
7217 -- (see Derive_Subprogram), unless the inherited subprogram's parent
7218 -- subprogram is not itself hidden or we are within a generic instance,
7219 -- in which case the hidden flag may have been modified for the
7220 -- expansion of the instance.
7222 -- (Note: This condition could probably be simplified, leaving out the
7223 -- testing for the specific controlled cases, but it seems safer and
7224 -- clearer this way, and echoes similar special-case tests of this
7225 -- kind in other places.)
7227 if Present (Overridden_Subp)
7228 and then (not Is_Hidden (Overridden_Subp)
7230 (Chars (Overridden_Subp) in Name_Initialize
7233 and then Present (Alias (Overridden_Subp))
7234 and then (not Is_Hidden (Alias (Overridden_Subp))
7235 or else In_Instance)))
7237 if Must_Not_Override (Spec) then
7238 Error_Msg_Sloc := Sloc (Overridden_Subp);
7240 if Ekind (Subp) = E_Entry then
7242 ("entry & overrides inherited operation #", Spec, Subp);
7245 ("subprogram & overrides inherited operation #", Spec, Subp);
7248 -- Special-case to fix a GNAT oddity: Limited_Controlled is declared
7249 -- as an extension of Root_Controlled, and thus has a useless Adjust
7250 -- operation. This operation should not be inherited by other limited
7251 -- controlled types. An explicit Adjust for them is not overriding.
7253 elsif Must_Override (Spec)
7254 and then Chars (Overridden_Subp) = Name_Adjust
7255 and then Is_Limited_Type (Etype (First_Formal (Subp)))
7256 and then Present (Alias (Overridden_Subp))
7257 and then In_Predefined_Unit (Alias (Overridden_Subp))
7260 (Unit_File_Name (Get_Source_Unit (Alias (Overridden_Subp))));
7261 Error_Msg_NE ("subprogram & is not overriding", Spec, Subp);
7263 elsif Is_Subprogram (Subp) then
7264 if Is_Init_Proc (Subp) then
7267 elsif No (Overridden_Operation (Subp)) then
7269 -- For entities generated by Derive_Subprograms the overridden
7270 -- operation is the inherited primitive (which is available
7271 -- through the attribute alias)
7273 if (Is_Dispatching_Operation (Subp)
7274 or else Is_Dispatching_Operation (Overridden_Subp))
7275 and then not Comes_From_Source (Overridden_Subp)
7276 and then Find_Dispatching_Type (Overridden_Subp) =
7277 Find_Dispatching_Type (Subp)
7278 and then Present (Alias (Overridden_Subp))
7279 and then Comes_From_Source (Alias (Overridden_Subp))
7281 Set_Overridden_Operation (Subp, Alias (Overridden_Subp));
7282 Inherit_Subprogram_Contract (Subp, Alias (Overridden_Subp));
7283 Set_Is_Ada_2022_Only (Subp,
7284 Is_Ada_2022_Only (Alias (Overridden_Subp)));
7287 Set_Overridden_Operation (Subp, Overridden_Subp);
7288 Inherit_Subprogram_Contract (Subp, Overridden_Subp);
7289 Set_Is_Ada_2022_Only (Subp,
7290 Is_Ada_2022_Only (Overridden_Subp));
7295 -- If primitive flag is set or this is a protected operation, then
7296 -- the operation is overriding at the point of its declaration, so
7297 -- warn if necessary. Otherwise it may have been declared before the
7298 -- operation it overrides and no check is required.
7301 and then not Must_Override (Spec)
7302 and then (Is_Primitive
7303 or else Ekind (Scope (Subp)) = E_Protected_Type)
7305 Style.Missing_Overriding (Decl, Subp);
7308 -- If Subp is an operator, it may override a predefined operation, if
7309 -- it is defined in the same scope as the type to which it applies.
7310 -- In that case Overridden_Subp is empty because of our implicit
7311 -- representation for predefined operators. We have to check whether the
7312 -- signature of Subp matches that of a predefined operator. Note that
7313 -- first argument provides the name of the operator, and the second
7314 -- argument the signature that may match that of a standard operation.
7315 -- If the indicator is overriding, then the operator must match a
7316 -- predefined signature, because we know already that there is no
7317 -- explicit overridden operation.
7319 elsif Chars (Subp) in Any_Operator_Name then
7320 if Must_Not_Override (Spec) then
7322 -- If this is not a primitive or a protected subprogram, then
7323 -- "not overriding" is illegal.
7326 and then Ekind (Scope (Subp)) /= E_Protected_Type
7328 Error_Msg_N ("overriding indicator only allowed "
7329 & "if subprogram is primitive", Subp);
7331 elsif Can_Override_Operator (Subp) then
7333 ("subprogram& overrides predefined operator", Spec, Subp);
7336 elsif Must_Override (Spec) then
7337 if No (Overridden_Operation (Subp))
7338 and then not Can_Override_Operator (Subp)
7340 Error_Msg_NE ("subprogram & is not overriding", Spec, Subp);
7343 elsif not Error_Posted (Subp)
7344 and then Style_Check
7345 and then Can_Override_Operator (Subp)
7346 and then not In_Predefined_Unit (Subp)
7348 -- If style checks are enabled, indicate that the indicator is
7349 -- missing. However, at the point of declaration, the type of
7350 -- which this is a primitive operation may be private, in which
7351 -- case the indicator would be premature.
7353 if Has_Private_Declaration (Etype (Subp))
7354 or else Has_Private_Declaration (Etype (First_Formal (Subp)))
7358 Style.Missing_Overriding (Decl, Subp);
7362 elsif Must_Override (Spec) then
7363 if Ekind (Subp) = E_Entry then
7364 Error_Msg_NE ("entry & is not overriding", Spec, Subp);
7366 Error_Msg_NE ("subprogram & is not overriding", Spec, Subp);
7369 -- If the operation is marked "not overriding" and it's not primitive
7370 -- then an error is issued, unless this is an operation of a task or
7371 -- protected type (RM05-8.3.1(3/2-4/2)). Error cases where "overriding"
7372 -- has been specified have already been checked above.
7374 elsif Must_Not_Override (Spec)
7375 and then not Is_Primitive
7376 and then Ekind (Subp) /= E_Entry
7377 and then Ekind (Scope (Subp)) /= E_Protected_Type
7380 ("overriding indicator only allowed if subprogram is primitive",
7384 end Check_Overriding_Indicator;
7390 -- Note: this procedure needs to know far too much about how the expander
7391 -- messes with exceptions. The use of the flag Exception_Junk and the
7392 -- incorporation of knowledge of Exp_Ch11.Expand_Local_Exception_Handlers
7393 -- works, but is not very clean. It would be better if the expansion
7394 -- routines would leave Original_Node working nicely, and we could use
7395 -- Original_Node here to ignore all the peculiar expander messing ???
7397 procedure Check_Returns
7401 Proc : Entity_Id := Empty)
7405 procedure Check_Statement_Sequence (L : List_Id);
7406 -- Internal recursive procedure to check a list of statements for proper
7407 -- termination by a return statement (or a transfer of control or a
7408 -- compound statement that is itself internally properly terminated).
7410 ------------------------------
7411 -- Check_Statement_Sequence --
7412 ------------------------------
7414 procedure Check_Statement_Sequence (L : List_Id) is
7419 function Assert_False return Boolean;
7420 -- Returns True if Last_Stm is a pragma Assert (False) that has been
7421 -- rewritten as a null statement when assertions are off. The assert
7422 -- is not active, but it is still enough to kill the warning.
7428 function Assert_False return Boolean is
7429 Orig : constant Node_Id := Original_Node (Last_Stm);
7432 if Nkind (Orig) = N_Pragma
7433 and then Pragma_Name (Orig) = Name_Assert
7434 and then not Error_Posted (Orig)
7437 Arg : constant Node_Id :=
7438 First (Pragma_Argument_Associations (Orig));
7439 Exp : constant Node_Id := Expression (Arg);
7441 return Nkind (Exp) = N_Identifier
7442 and then Chars (Exp) = Name_False;
7452 Raise_Exception_Call : Boolean;
7453 -- Set True if statement sequence terminated by Raise_Exception call
7454 -- or a Reraise_Occurrence call.
7456 -- Start of processing for Check_Statement_Sequence
7459 Raise_Exception_Call := False;
7461 -- Get last real statement
7463 Last_Stm := Last (L);
7465 -- Deal with digging out exception handler statement sequences that
7466 -- have been transformed by the local raise to goto optimization.
7467 -- See Exp_Ch11.Expand_Local_Exception_Handlers for details. If this
7468 -- optimization has occurred, we are looking at something like:
7471 -- original stmts in block
7475 -- goto L1; | omitted if No_Exception_Propagation
7480 -- goto L3; -- skip handler when exception not raised
7482 -- <<L1>> -- target label for local exception
7496 -- and what we have to do is to dig out the estmts1 and estmts2
7497 -- sequences (which were the original sequences of statements in
7498 -- the exception handlers) and check them.
7500 if Nkind (Last_Stm) = N_Label and then Exception_Junk (Last_Stm) then
7505 exit when Nkind (Stm) /= N_Block_Statement;
7506 exit when not Exception_Junk (Stm);
7509 exit when Nkind (Stm) /= N_Label;
7510 exit when not Exception_Junk (Stm);
7511 Check_Statement_Sequence
7512 (Statements (Handled_Statement_Sequence (Next (Stm))));
7517 exit when Nkind (Stm) /= N_Goto_Statement;
7518 exit when not Exception_Junk (Stm);
7522 -- Don't count pragmas
7524 while Nkind (Last_Stm) = N_Pragma
7526 -- Don't count call to SS_Release (can happen after Raise_Exception)
7529 (Nkind (Last_Stm) = N_Procedure_Call_Statement
7531 Nkind (Name (Last_Stm)) = N_Identifier
7533 Is_RTE (Entity (Name (Last_Stm)), RE_SS_Release))
7535 -- Don't count exception junk
7538 (Nkind (Last_Stm) in
7539 N_Goto_Statement | N_Label | N_Object_Declaration
7540 and then Exception_Junk (Last_Stm))
7541 or else Nkind (Last_Stm) in N_Push_xxx_Label | N_Pop_xxx_Label
7543 -- Inserted code, such as finalization calls, is irrelevant: we only
7544 -- need to check original source.
7546 or else Is_Rewrite_Insertion (Last_Stm)
7551 -- Here we have the "real" last statement
7553 Kind := Nkind (Last_Stm);
7555 -- Transfer of control, OK. Note that in the No_Return procedure
7556 -- case, we already diagnosed any explicit return statements, so
7557 -- we can treat them as OK in this context.
7559 if Is_Transfer (Last_Stm) then
7562 -- Check cases of explicit non-indirect procedure calls
7564 elsif Kind = N_Procedure_Call_Statement
7565 and then Is_Entity_Name (Name (Last_Stm))
7567 -- Check call to Raise_Exception procedure which is treated
7568 -- specially, as is a call to Reraise_Occurrence.
7570 -- We suppress the warning in these cases since it is likely that
7571 -- the programmer really does not expect to deal with the case
7572 -- of Null_Occurrence, and thus would find a warning about a
7573 -- missing return curious, and raising Program_Error does not
7574 -- seem such a bad behavior if this does occur.
7576 -- Note that in the Ada 2005 case for Raise_Exception, the actual
7577 -- behavior will be to raise Constraint_Error (see AI-329).
7579 if Is_RTE (Entity (Name (Last_Stm)), RE_Raise_Exception)
7581 Is_RTE (Entity (Name (Last_Stm)), RE_Reraise_Occurrence)
7583 Raise_Exception_Call := True;
7585 -- For Raise_Exception call, test first argument, if it is
7586 -- an attribute reference for a 'Identity call, then we know
7587 -- that the call cannot possibly return.
7590 Arg : constant Node_Id :=
7591 Original_Node (First_Actual (Last_Stm));
7593 if Nkind (Arg) = N_Attribute_Reference
7594 and then Attribute_Name (Arg) = Name_Identity
7601 -- If statement, need to look inside if there is an else and check
7602 -- each constituent statement sequence for proper termination.
7604 elsif Kind = N_If_Statement
7605 and then Present (Else_Statements (Last_Stm))
7607 Check_Statement_Sequence (Then_Statements (Last_Stm));
7608 Check_Statement_Sequence (Else_Statements (Last_Stm));
7610 if Present (Elsif_Parts (Last_Stm)) then
7612 Elsif_Part : Node_Id := First (Elsif_Parts (Last_Stm));
7615 while Present (Elsif_Part) loop
7616 Check_Statement_Sequence (Then_Statements (Elsif_Part));
7624 -- Case statement, check each case for proper termination
7626 elsif Kind = N_Case_Statement then
7630 Case_Alt := First_Non_Pragma (Alternatives (Last_Stm));
7631 while Present (Case_Alt) loop
7632 Check_Statement_Sequence (Statements (Case_Alt));
7633 Next_Non_Pragma (Case_Alt);
7639 -- Block statement, check its handled sequence of statements
7641 elsif Kind = N_Block_Statement then
7647 (Handled_Statement_Sequence (Last_Stm), Mode, Err1);
7656 -- Loop statement. If there is an iteration scheme, we can definitely
7657 -- fall out of the loop. Similarly if there is an exit statement, we
7658 -- can fall out. In either case we need a following return.
7660 elsif Kind = N_Loop_Statement then
7661 if Present (Iteration_Scheme (Last_Stm))
7662 or else Has_Exit (Entity (Identifier (Last_Stm)))
7666 -- A loop with no exit statement or iteration scheme is either
7667 -- an infinite loop, or it has some other exit (raise/return).
7668 -- In either case, no warning is required.
7674 -- Timed entry call, check entry call and delay alternatives
7676 -- Note: in expanded code, the timed entry call has been converted
7677 -- to a set of expanded statements on which the check will work
7678 -- correctly in any case.
7680 elsif Kind = N_Timed_Entry_Call then
7682 ECA : constant Node_Id := Entry_Call_Alternative (Last_Stm);
7683 DCA : constant Node_Id := Delay_Alternative (Last_Stm);
7686 -- If statement sequence of entry call alternative is missing,
7687 -- then we can definitely fall through, and we post the error
7688 -- message on the entry call alternative itself.
7690 if No (Statements (ECA)) then
7693 -- If statement sequence of delay alternative is missing, then
7694 -- we can definitely fall through, and we post the error
7695 -- message on the delay alternative itself.
7697 -- Note: if both ECA and DCA are missing the return, then we
7698 -- post only one message, should be enough to fix the bugs.
7699 -- If not we will get a message next time on the DCA when the
7702 elsif No (Statements (DCA)) then
7705 -- Else check both statement sequences
7708 Check_Statement_Sequence (Statements (ECA));
7709 Check_Statement_Sequence (Statements (DCA));
7714 -- Conditional entry call, check entry call and else part
7716 -- Note: in expanded code, the conditional entry call has been
7717 -- converted to a set of expanded statements on which the check
7718 -- will work correctly in any case.
7720 elsif Kind = N_Conditional_Entry_Call then
7722 ECA : constant Node_Id := Entry_Call_Alternative (Last_Stm);
7725 -- If statement sequence of entry call alternative is missing,
7726 -- then we can definitely fall through, and we post the error
7727 -- message on the entry call alternative itself.
7729 if No (Statements (ECA)) then
7732 -- Else check statement sequence and else part
7735 Check_Statement_Sequence (Statements (ECA));
7736 Check_Statement_Sequence (Else_Statements (Last_Stm));
7742 -- If we fall through, issue appropriate message
7746 -- Kill warning if last statement is a raise exception call,
7747 -- or a pragma Assert (False). Note that with assertions enabled,
7748 -- such a pragma has been converted into a raise exception call
7749 -- already, so the Assert_False is for the assertions off case.
7751 if not Raise_Exception_Call and then not Assert_False then
7753 -- In GNATprove mode, it is an error to have a missing return
7755 Error_Msg_Warn := SPARK_Mode /= On;
7757 -- Issue error message or warning
7760 ("RETURN statement missing following this statement<<!",
7763 ("\Program_Error [<<!", Last_Stm);
7766 -- Note: we set Err even though we have not issued a warning
7767 -- because we still have a case of a missing return. This is
7768 -- an extremely marginal case, probably will never be noticed
7769 -- but we might as well get it right.
7773 -- Otherwise we have the case of a procedure marked No_Return
7776 if not Raise_Exception_Call then
7777 if GNATprove_Mode then
7779 ("implied return after this statement would have raised "
7780 & "Program_Error", Last_Stm);
7782 -- In normal compilation mode, do not warn on a generated call
7783 -- (e.g. in the body of a renaming as completion).
7785 elsif Comes_From_Source (Last_Stm) then
7787 ("implied return after this statement will raise "
7788 & "Program_Error??", Last_Stm);
7791 Error_Msg_Warn := SPARK_Mode /= On;
7793 ("\procedure & is marked as No_Return<<!", Last_Stm, Proc);
7797 RE : constant Node_Id :=
7798 Make_Raise_Program_Error (Sloc (Last_Stm),
7799 Reason => PE_Implicit_Return);
7801 Insert_After (Last_Stm, RE);
7805 end Check_Statement_Sequence;
7807 -- Start of processing for Check_Returns
7811 Check_Statement_Sequence (Statements (HSS));
7813 if Present (Exception_Handlers (HSS)) then
7814 Handler := First_Non_Pragma (Exception_Handlers (HSS));
7815 while Present (Handler) loop
7816 Check_Statement_Sequence (Statements (Handler));
7817 Next_Non_Pragma (Handler);
7822 ----------------------------
7823 -- Check_Subprogram_Order --
7824 ----------------------------
7826 procedure Check_Subprogram_Order (N : Node_Id) is
7828 function Subprogram_Name_Greater (S1, S2 : String) return Boolean;
7829 -- This is used to check if S1 > S2 in the sense required by this test,
7830 -- for example nameab < namec, but name2 < name10.
7832 -----------------------------
7833 -- Subprogram_Name_Greater --
7834 -----------------------------
7836 function Subprogram_Name_Greater (S1, S2 : String) return Boolean is
7841 -- Deal with special case where names are identical except for a
7842 -- numerical suffix. These are handled specially, taking the numeric
7843 -- ordering from the suffix into account.
7846 while S1 (L1) in '0' .. '9' loop
7851 while S2 (L2) in '0' .. '9' loop
7855 -- If non-numeric parts non-equal, do straight compare
7857 if S1 (S1'First .. L1) /= S2 (S2'First .. L2) then
7860 -- If non-numeric parts equal, compare suffixed numeric parts. Note
7861 -- that a missing suffix is treated as numeric zero in this test.
7865 while L1 < S1'Last loop
7867 N1 := N1 * 10 + Character'Pos (S1 (L1)) - Character'Pos ('0');
7871 while L2 < S2'Last loop
7873 N2 := N2 * 10 + Character'Pos (S2 (L2)) - Character'Pos ('0');
7878 end Subprogram_Name_Greater;
7880 -- Start of processing for Check_Subprogram_Order
7883 -- Check body in alpha order if this is option
7886 and then Style_Check_Order_Subprograms
7887 and then Nkind (N) = N_Subprogram_Body
7888 and then Comes_From_Source (N)
7889 and then In_Extended_Main_Source_Unit (N)
7893 renames Scope_Stack.Table
7894 (Scope_Stack.Last).Last_Subprogram_Name;
7896 Body_Id : constant Entity_Id :=
7897 Defining_Entity (Specification (N));
7900 Get_Decoded_Name_String (Chars (Body_Id));
7903 if Subprogram_Name_Greater
7904 (LSN.all, Name_Buffer (1 .. Name_Len))
7906 Style.Subprogram_Not_In_Alpha_Order (Body_Id);
7912 LSN := new String'(Name_Buffer (1 .. Name_Len));
7915 end Check_Subprogram_Order;
7917 ------------------------------
7918 -- Check_Subtype_Conformant --
7919 ------------------------------
7921 procedure Check_Subtype_Conformant
7922 (New_Id : Entity_Id;
7924 Err_Loc : Node_Id := Empty;
7925 Skip_Controlling_Formals : Boolean := False;
7926 Get_Inst : Boolean := False)
7929 pragma Warnings (Off, Result);
7932 (New_Id, Old_Id, Subtype_Conformant, True, Result, Err_Loc,
7933 Skip_Controlling_Formals => Skip_Controlling_Formals,
7934 Get_Inst => Get_Inst);
7935 end Check_Subtype_Conformant;
7937 -----------------------------------
7938 -- Check_Synchronized_Overriding --
7939 -----------------------------------
7941 procedure Check_Synchronized_Overriding
7942 (Def_Id : Entity_Id;
7943 Overridden_Subp : out Entity_Id)
7945 Ifaces_List : Elist_Id;
7949 function Is_Valid_Formal (F : Entity_Id) return Boolean;
7950 -- Predicate for legality rule in 9.4 (11.9/2): If an inherited
7951 -- subprogram is implemented by a protected procedure or entry,
7952 -- its first parameter must be out, in out, or access-to-variable.
7954 function Matches_Prefixed_View_Profile
7955 (Prim_Params : List_Id;
7956 Iface_Params : List_Id) return Boolean;
7957 -- Determine whether a subprogram's parameter profile Prim_Params
7958 -- matches that of a potentially overridden interface subprogram
7959 -- Iface_Params. Also determine if the type of first parameter of
7960 -- Iface_Params is an implemented interface.
7962 ----------------------
7963 -- Is_Valid_Formal --
7964 ----------------------
7966 function Is_Valid_Formal (F : Entity_Id) return Boolean is
7969 Ekind (F) in E_In_Out_Parameter | E_Out_Parameter
7971 (Nkind (Parameter_Type (Parent (F))) = N_Access_Definition
7972 and then not Constant_Present (Parameter_Type (Parent (F))));
7973 end Is_Valid_Formal;
7975 -----------------------------------
7976 -- Matches_Prefixed_View_Profile --
7977 -----------------------------------
7979 function Matches_Prefixed_View_Profile
7980 (Prim_Params : List_Id;
7981 Iface_Params : List_Id) return Boolean
7983 function Is_Implemented
7984 (Ifaces_List : Elist_Id;
7985 Iface : Entity_Id) return Boolean;
7986 -- Determine if Iface is implemented by the current task or
7989 --------------------
7990 -- Is_Implemented --
7991 --------------------
7993 function Is_Implemented
7994 (Ifaces_List : Elist_Id;
7995 Iface : Entity_Id) return Boolean
7997 Iface_Elmt : Elmt_Id;
8000 Iface_Elmt := First_Elmt (Ifaces_List);
8001 while Present (Iface_Elmt) loop
8002 if Node (Iface_Elmt) = Iface then
8006 Next_Elmt (Iface_Elmt);
8014 Iface_Id : Entity_Id;
8015 Iface_Param : Node_Id;
8016 Iface_Typ : Entity_Id;
8017 Prim_Id : Entity_Id;
8018 Prim_Param : Node_Id;
8019 Prim_Typ : Entity_Id;
8021 -- Start of processing for Matches_Prefixed_View_Profile
8024 Iface_Param := First (Iface_Params);
8025 Iface_Typ := Etype (Defining_Identifier (Iface_Param));
8027 if Is_Access_Type (Iface_Typ) then
8028 Iface_Typ := Designated_Type (Iface_Typ);
8031 Prim_Param := First (Prim_Params);
8033 -- The first parameter of the potentially overridden subprogram must
8034 -- be an interface implemented by Prim.
8036 if not Is_Interface (Iface_Typ)
8037 or else not Is_Implemented (Ifaces_List, Iface_Typ)
8042 -- The checks on the object parameters are done, so move on to the
8043 -- rest of the parameters.
8045 if not In_Scope then
8050 while Present (Iface_Param) and then Present (Prim_Param) loop
8051 Iface_Id := Defining_Identifier (Iface_Param);
8052 Iface_Typ := Find_Parameter_Type (Iface_Param);
8054 Prim_Id := Defining_Identifier (Prim_Param);
8055 Prim_Typ := Find_Parameter_Type (Prim_Param);
8057 if Ekind (Iface_Typ) = E_Anonymous_Access_Type
8058 and then Ekind (Prim_Typ) = E_Anonymous_Access_Type
8059 and then Is_Concurrent_Type (Designated_Type (Prim_Typ))
8061 Iface_Typ := Designated_Type (Iface_Typ);
8062 Prim_Typ := Designated_Type (Prim_Typ);
8065 -- Case of multiple interface types inside a parameter profile
8067 -- (Obj_Param : in out Iface; ...; Param : Iface)
8069 -- If the interface type is implemented, then the matching type in
8070 -- the primitive should be the implementing record type.
8072 if Ekind (Iface_Typ) = E_Record_Type
8073 and then Is_Interface (Iface_Typ)
8074 and then Is_Implemented (Ifaces_List, Iface_Typ)
8076 if Prim_Typ /= Typ then
8080 -- The two parameters must be both mode and subtype conformant
8082 elsif Ekind (Iface_Id) /= Ekind (Prim_Id)
8084 Conforming_Types (Iface_Typ, Prim_Typ, Subtype_Conformant)
8093 -- One of the two lists contains more parameters than the other
8095 if Present (Iface_Param) or else Present (Prim_Param) then
8100 end Matches_Prefixed_View_Profile;
8102 -- Start of processing for Check_Synchronized_Overriding
8105 Overridden_Subp := Empty;
8107 -- Def_Id must be an entry or a subprogram. We should skip predefined
8108 -- primitives internally generated by the front end; however at this
8109 -- stage predefined primitives are still not fully decorated. As a
8110 -- minor optimization we skip here internally generated subprograms.
8112 if (Ekind (Def_Id) /= E_Entry
8113 and then Ekind (Def_Id) /= E_Function
8114 and then Ekind (Def_Id) /= E_Procedure)
8115 or else not Comes_From_Source (Def_Id)
8120 -- Search for the concurrent declaration since it contains the list of
8121 -- all implemented interfaces. In this case, the subprogram is declared
8122 -- within the scope of a protected or a task type.
8124 if Present (Scope (Def_Id))
8125 and then Is_Concurrent_Type (Scope (Def_Id))
8126 and then not Is_Generic_Actual_Type (Scope (Def_Id))
8128 Typ := Scope (Def_Id);
8131 -- The enclosing scope is not a synchronized type and the subprogram
8134 elsif No (First_Formal (Def_Id)) then
8137 -- The subprogram has formals and hence it may be a primitive of a
8141 Typ := Etype (First_Formal (Def_Id));
8143 if Is_Access_Type (Typ) then
8144 Typ := Directly_Designated_Type (Typ);
8147 if Is_Concurrent_Type (Typ)
8148 and then not Is_Generic_Actual_Type (Typ)
8152 -- This case occurs when the concurrent type is declared within a
8153 -- generic unit. As a result the corresponding record has been built
8154 -- and used as the type of the first formal, we just have to retrieve
8155 -- the corresponding concurrent type.
8157 elsif Is_Concurrent_Record_Type (Typ)
8158 and then not Is_Class_Wide_Type (Typ)
8159 and then Present (Corresponding_Concurrent_Type (Typ))
8161 Typ := Corresponding_Concurrent_Type (Typ);
8169 -- There is no overriding to check if this is an inherited operation in
8170 -- a type derivation for a generic actual.
8172 Collect_Interfaces (Typ, Ifaces_List);
8174 if Is_Empty_Elmt_List (Ifaces_List) then
8178 -- Determine whether entry or subprogram Def_Id overrides a primitive
8179 -- operation that belongs to one of the interfaces in Ifaces_List.
8182 Candidate : Entity_Id := Empty;
8183 Hom : Entity_Id := Empty;
8184 Subp : Entity_Id := Empty;
8187 -- Traverse the homonym chain, looking for a potentially overridden
8188 -- subprogram that belongs to an implemented interface.
8190 Hom := Current_Entity_In_Scope (Def_Id);
8191 while Present (Hom) loop
8195 or else not Is_Overloadable (Subp)
8196 or else not Is_Primitive (Subp)
8197 or else not Is_Dispatching_Operation (Subp)
8198 or else not Present (Find_Dispatching_Type (Subp))
8199 or else not Is_Interface (Find_Dispatching_Type (Subp))
8203 -- Entries and procedures can override abstract or null interface
8206 elsif Ekind (Def_Id) in E_Entry | E_Procedure
8207 and then Ekind (Subp) = E_Procedure
8208 and then Matches_Prefixed_View_Profile
8209 (Parameter_Specifications (Parent (Def_Id)),
8210 Parameter_Specifications (Parent (Subp)))
8214 -- For an overridden subprogram Subp, check whether the mode
8215 -- of its first parameter is correct depending on the kind of
8216 -- synchronized type.
8219 Formal : constant Node_Id := First_Formal (Candidate);
8222 -- In order for an entry or a protected procedure to
8223 -- override, the first parameter of the overridden routine
8224 -- must be of mode "out", "in out", or access-to-variable.
8226 if Ekind (Candidate) in E_Entry | E_Procedure
8227 and then Is_Protected_Type (Typ)
8228 and then not Is_Valid_Formal (Formal)
8232 -- All other cases are OK since a task entry or routine does
8233 -- not have a restriction on the mode of the first parameter
8234 -- of the overridden interface routine.
8237 Overridden_Subp := Candidate;
8242 -- Functions can override abstract interface functions. Return
8243 -- types must be subtype conformant.
8245 elsif Ekind (Def_Id) = E_Function
8246 and then Ekind (Subp) = E_Function
8247 and then Matches_Prefixed_View_Profile
8248 (Parameter_Specifications (Parent (Def_Id)),
8249 Parameter_Specifications (Parent (Subp)))
8250 and then Conforming_Types
8251 (Etype (Def_Id), Etype (Subp), Subtype_Conformant)
8255 -- If an inherited subprogram is implemented by a protected
8256 -- function, then the first parameter of the inherited
8257 -- subprogram shall be of mode in, but not an access-to-
8258 -- variable parameter (RM 9.4(11/9)).
8260 if Present (First_Formal (Subp))
8261 and then Ekind (First_Formal (Subp)) = E_In_Parameter
8263 (not Is_Access_Type (Etype (First_Formal (Subp)))
8265 Is_Access_Constant (Etype (First_Formal (Subp))))
8267 Overridden_Subp := Subp;
8272 Hom := Homonym (Hom);
8275 -- After examining all candidates for overriding, we are left with
8276 -- the best match, which is a mode-incompatible interface routine.
8278 if In_Scope and then Present (Candidate) then
8279 Error_Msg_PT (Def_Id, Candidate);
8282 Overridden_Subp := Candidate;
8285 end Check_Synchronized_Overriding;
8287 ---------------------------
8288 -- Check_Type_Conformant --
8289 ---------------------------
8291 procedure Check_Type_Conformant
8292 (New_Id : Entity_Id;
8294 Err_Loc : Node_Id := Empty)
8297 pragma Warnings (Off, Result);
8300 (New_Id, Old_Id, Type_Conformant, True, Result, Err_Loc);
8301 end Check_Type_Conformant;
8303 ---------------------------
8304 -- Can_Override_Operator --
8305 ---------------------------
8307 function Can_Override_Operator (Subp : Entity_Id) return Boolean is
8311 -- Return False if not an operator. We test the name rather than testing
8312 -- that the Nkind is N_Defining_Operator_Symbol, because there are cases
8313 -- where an operator entity can be an N_Defining_Identifier (such as for
8314 -- function instantiations).
8316 if Chars (Subp) not in Any_Operator_Name then
8320 Typ := Base_Type (Etype (First_Formal (Subp)));
8322 -- Check explicitly that the operation is a primitive of the type
8324 return Operator_Matches_Spec (Subp, Subp)
8325 and then not Is_Generic_Type (Typ)
8326 and then Scope (Subp) = Scope (Typ)
8327 and then not Is_Class_Wide_Type (Typ);
8329 end Can_Override_Operator;
8331 ----------------------
8332 -- Conforming_Types --
8333 ----------------------
8335 function Conforming_Types
8338 Ctype : Conformance_Type;
8339 Get_Inst : Boolean := False) return Boolean
8341 function Base_Types_Match
8343 Typ_2 : Entity_Id) return Boolean;
8344 -- If neither Typ_1 nor Typ_2 are generic actual types, or if they are
8345 -- in different scopes (e.g. parent and child instances), then verify
8346 -- that the base types are equal. Otherwise Typ_1 and Typ_2 must be on
8347 -- the same subtype chain. The whole purpose of this procedure is to
8348 -- prevent spurious ambiguities in an instantiation that may arise if
8349 -- two distinct generic types are instantiated with the same actual.
8351 function Find_Designated_Type (Typ : Entity_Id) return Entity_Id;
8352 -- An access parameter can designate an incomplete type. If the
8353 -- incomplete type is the limited view of a type from a limited_
8354 -- with_clause, check whether the non-limited view is available.
8355 -- If it is a (non-limited) incomplete type, get the full view.
8357 function Matches_Limited_With_View
8359 Typ_2 : Entity_Id) return Boolean;
8360 -- Returns True if and only if either Typ_1 denotes a limited view of
8361 -- Typ_2 or Typ_2 denotes a limited view of Typ_1. This can arise when
8362 -- the limited with view of a type is used in a subprogram declaration
8363 -- and the subprogram body is in the scope of a regular with clause for
8364 -- the same unit. In such a case, the two type entities are considered
8365 -- identical for purposes of conformance checking.
8367 ----------------------
8368 -- Base_Types_Match --
8369 ----------------------
8371 function Base_Types_Match
8373 Typ_2 : Entity_Id) return Boolean
8375 Base_1 : constant Entity_Id := Base_Type (Typ_1);
8376 Base_2 : constant Entity_Id := Base_Type (Typ_2);
8379 if Typ_1 = Typ_2 then
8382 elsif Base_1 = Base_2 then
8384 -- The following is too permissive. A more precise test should
8385 -- check that the generic actual is an ancestor subtype of the
8388 -- See code in Find_Corresponding_Spec that applies an additional
8389 -- filter to handle accidental amiguities in instances.
8392 not Is_Generic_Actual_Type (Typ_1)
8393 or else not Is_Generic_Actual_Type (Typ_2)
8394 or else Scope (Typ_1) /= Scope (Typ_2);
8396 -- If Typ_2 is a generic actual type it is declared as the subtype of
8397 -- the actual. If that actual is itself a subtype we need to use its
8398 -- own base type to check for compatibility.
8400 elsif Ekind (Base_2) = Ekind (Typ_2)
8401 and then Base_1 = Base_Type (Base_2)
8405 elsif Ekind (Base_1) = Ekind (Typ_1)
8406 and then Base_2 = Base_Type (Base_1)
8413 end Base_Types_Match;
8415 --------------------------
8416 -- Find_Designated_Type --
8417 --------------------------
8419 function Find_Designated_Type (Typ : Entity_Id) return Entity_Id is
8423 Desig := Directly_Designated_Type (Typ);
8425 if Ekind (Desig) = E_Incomplete_Type then
8427 -- If regular incomplete type, get full view if available
8429 if Present (Full_View (Desig)) then
8430 Desig := Full_View (Desig);
8432 -- If limited view of a type, get non-limited view if available,
8433 -- and check again for a regular incomplete type.
8435 elsif Present (Non_Limited_View (Desig)) then
8436 Desig := Get_Full_View (Non_Limited_View (Desig));
8441 end Find_Designated_Type;
8443 -------------------------------
8444 -- Matches_Limited_With_View --
8445 -------------------------------
8447 function Matches_Limited_With_View
8449 Typ_2 : Entity_Id) return Boolean
8451 function Is_Matching_Limited_View
8453 View : Entity_Id) return Boolean;
8454 -- Determine whether non-limited view View denotes type Typ in some
8455 -- conformant fashion.
8457 ------------------------------
8458 -- Is_Matching_Limited_View --
8459 ------------------------------
8461 function Is_Matching_Limited_View
8463 View : Entity_Id) return Boolean
8465 Root_Typ : Entity_Id;
8466 Root_View : Entity_Id;
8469 -- The non-limited view directly denotes the type
8474 -- The type is a subtype of the non-limited view
8476 elsif Is_Subtype_Of (Typ, View) then
8479 -- Both the non-limited view and the type denote class-wide types
8481 elsif Is_Class_Wide_Type (Typ)
8482 and then Is_Class_Wide_Type (View)
8484 Root_Typ := Root_Type (Typ);
8485 Root_View := Root_Type (View);
8487 if Root_Typ = Root_View then
8490 -- An incomplete tagged type and its full view may receive two
8491 -- distinct class-wide types when the related package has not
8492 -- been analyzed yet.
8495 -- type T is tagged; -- CW_1
8496 -- type T is tagged null record; -- CW_2
8499 -- This is because the package lacks any semantic information
8500 -- that may eventually link both views of T. As a consequence,
8501 -- a client of the limited view of Pack will see CW_2 while a
8502 -- client of the non-limited view of Pack will see CW_1.
8504 elsif Is_Incomplete_Type (Root_Typ)
8505 and then Present (Full_View (Root_Typ))
8506 and then Full_View (Root_Typ) = Root_View
8510 elsif Is_Incomplete_Type (Root_View)
8511 and then Present (Full_View (Root_View))
8512 and then Full_View (Root_View) = Root_Typ
8519 end Is_Matching_Limited_View;
8521 -- Start of processing for Matches_Limited_With_View
8524 -- In some cases a type imported through a limited_with clause, and
8525 -- its non-limited view are both visible, for example in an anonymous
8526 -- access-to-class-wide type in a formal, or when building the body
8527 -- for a subprogram renaming after the subprogram has been frozen.
8528 -- In these cases both entities designate the same type. In addition,
8529 -- if one of them is an actual in an instance, it may be a subtype of
8530 -- the non-limited view of the other.
8532 if From_Limited_With (Typ_1)
8533 and then From_Limited_With (Typ_2)
8534 and then Available_View (Typ_1) = Available_View (Typ_2)
8538 elsif From_Limited_With (Typ_1) then
8539 return Is_Matching_Limited_View (Typ_2, Available_View (Typ_1));
8541 elsif From_Limited_With (Typ_2) then
8542 return Is_Matching_Limited_View (Typ_1, Available_View (Typ_2));
8547 end Matches_Limited_With_View;
8551 Are_Anonymous_Access_To_Subprogram_Types : Boolean := False;
8553 Type_1 : Entity_Id := T1;
8554 Type_2 : Entity_Id := T2;
8556 -- Start of processing for Conforming_Types
8559 -- The context is an instance association for a formal access-to-
8560 -- subprogram type; the formal parameter types require mapping because
8561 -- they may denote other formal parameters of the generic unit.
8564 Type_1 := Get_Instance_Of (T1);
8565 Type_2 := Get_Instance_Of (T2);
8568 -- If one of the types is a view of the other introduced by a limited
8569 -- with clause, treat these as conforming for all purposes.
8571 if Matches_Limited_With_View (T1, T2) then
8574 elsif Base_Types_Match (Type_1, Type_2) then
8575 if Ctype <= Mode_Conformant then
8580 Subtypes_Statically_Match (Type_1, Type_2)
8581 and then Dimensions_Match (Type_1, Type_2);
8584 elsif Is_Incomplete_Or_Private_Type (Type_1)
8585 and then Present (Full_View (Type_1))
8586 and then Base_Types_Match (Full_View (Type_1), Type_2)
8589 Ctype <= Mode_Conformant
8590 or else Subtypes_Statically_Match (Full_View (Type_1), Type_2);
8592 elsif Ekind (Type_2) = E_Incomplete_Type
8593 and then Present (Full_View (Type_2))
8594 and then Base_Types_Match (Type_1, Full_View (Type_2))
8597 Ctype <= Mode_Conformant
8598 or else Subtypes_Statically_Match (Type_1, Full_View (Type_2));
8600 elsif Is_Private_Type (Type_2)
8601 and then In_Instance
8602 and then Present (Full_View (Type_2))
8603 and then Base_Types_Match (Type_1, Full_View (Type_2))
8606 Ctype <= Mode_Conformant
8607 or else Subtypes_Statically_Match (Type_1, Full_View (Type_2));
8609 -- Another confusion between views in a nested instance with an
8610 -- actual private type whose full view is not in scope.
8612 elsif Ekind (Type_2) = E_Private_Subtype
8613 and then In_Instance
8614 and then Etype (Type_2) = Type_1
8618 -- In Ada 2012, incomplete types (including limited views) can appear
8619 -- as actuals in instantiations, where they are conformant to the
8620 -- corresponding incomplete formal.
8622 elsif Is_Incomplete_Type (Type_1)
8623 and then Is_Incomplete_Type (Type_2)
8624 and then In_Instance
8625 and then (Used_As_Generic_Actual (Type_1)
8626 or else Used_As_Generic_Actual (Type_2))
8631 -- Ada 2005 (AI-254): Anonymous access-to-subprogram types must be
8632 -- treated recursively because they carry a signature. As far as
8633 -- conformance is concerned, convention plays no role, and either
8634 -- or both could be access to protected subprograms.
8636 Are_Anonymous_Access_To_Subprogram_Types :=
8637 Ekind (Type_1) in E_Anonymous_Access_Subprogram_Type
8638 | E_Anonymous_Access_Protected_Subprogram_Type
8640 Ekind (Type_2) in E_Anonymous_Access_Subprogram_Type
8641 | E_Anonymous_Access_Protected_Subprogram_Type;
8643 -- Test anonymous access type case. For this case, static subtype
8644 -- matching is required for mode conformance (RM 6.3.1(15)). We check
8645 -- the base types because we may have built internal subtype entities
8646 -- to handle null-excluding types (see Process_Formals).
8648 if (Ekind (Base_Type (Type_1)) = E_Anonymous_Access_Type
8650 Ekind (Base_Type (Type_2)) = E_Anonymous_Access_Type)
8652 -- Ada 2005 (AI-254)
8654 or else Are_Anonymous_Access_To_Subprogram_Types
8657 Desig_1 : Entity_Id;
8658 Desig_2 : Entity_Id;
8661 -- In Ada 2005, access constant indicators must match for
8662 -- subtype conformance.
8664 if Ada_Version >= Ada_2005
8665 and then Ctype >= Subtype_Conformant
8667 Is_Access_Constant (Type_1) /= Is_Access_Constant (Type_2)
8672 Desig_1 := Find_Designated_Type (Type_1);
8673 Desig_2 := Find_Designated_Type (Type_2);
8675 -- If the context is an instance association for a formal
8676 -- access-to-subprogram type; formal access parameter designated
8677 -- types require mapping because they may denote other formal
8678 -- parameters of the generic unit.
8681 Desig_1 := Get_Instance_Of (Desig_1);
8682 Desig_2 := Get_Instance_Of (Desig_2);
8685 -- It is possible for a Class_Wide_Type to be introduced for an
8686 -- incomplete type, in which case there is a separate class_ wide
8687 -- type for the full view. The types conform if their Etypes
8688 -- conform, i.e. one may be the full view of the other. This can
8689 -- only happen in the context of an access parameter, other uses
8690 -- of an incomplete Class_Wide_Type are illegal.
8692 if Is_Class_Wide_Type (Desig_1)
8694 Is_Class_Wide_Type (Desig_2)
8698 (Etype (Base_Type (Desig_1)),
8699 Etype (Base_Type (Desig_2)), Ctype);
8701 elsif Are_Anonymous_Access_To_Subprogram_Types then
8702 if Ada_Version < Ada_2005 then
8704 Ctype = Type_Conformant
8705 or else Subtypes_Statically_Match (Desig_1, Desig_2);
8707 -- We must check the conformance of the signatures themselves
8711 Conformant : Boolean;
8714 (Desig_1, Desig_2, Ctype, False, Conformant);
8719 -- A limited view of an actual matches the corresponding
8720 -- incomplete formal.
8722 elsif Ekind (Desig_2) = E_Incomplete_Subtype
8723 and then From_Limited_With (Desig_2)
8724 and then Used_As_Generic_Actual (Etype (Desig_2))
8729 return Base_Type (Desig_1) = Base_Type (Desig_2)
8730 and then (Ctype = Type_Conformant
8732 Subtypes_Statically_Match (Desig_1, Desig_2));
8736 -- Otherwise definitely no match
8739 if ((Ekind (Type_1) = E_Anonymous_Access_Type
8740 and then Is_Access_Type (Type_2))
8741 or else (Ekind (Type_2) = E_Anonymous_Access_Type
8742 and then Is_Access_Type (Type_1)))
8745 (Designated_Type (Type_1), Designated_Type (Type_2), Ctype)
8747 May_Hide_Profile := True;
8752 end Conforming_Types;
8754 --------------------------
8755 -- Create_Extra_Formals --
8756 --------------------------
8758 procedure Create_Extra_Formals (E : Entity_Id) is
8759 First_Extra : Entity_Id := Empty;
8761 Last_Extra : Entity_Id := Empty;
8763 function Add_Extra_Formal
8764 (Assoc_Entity : Entity_Id;
8767 Suffix : String) return Entity_Id;
8768 -- Add an extra formal to the current list of formals and extra formals.
8769 -- The extra formal is added to the end of the list of extra formals,
8770 -- and also returned as the result. These formals are always of mode IN.
8771 -- The new formal has the type Typ, is declared in Scope, and its name
8772 -- is given by a concatenation of the name of Assoc_Entity and Suffix.
8773 -- The following suffixes are currently used. They should not be changed
8774 -- without coordinating with CodePeer, which makes use of these to
8775 -- provide better messages.
8777 -- O denotes the Constrained bit.
8778 -- L denotes the accessibility level.
8779 -- BIP_xxx denotes an extra formal for a build-in-place function. See
8780 -- the full list in exp_ch6.BIP_Formal_Kind.
8782 ----------------------
8783 -- Add_Extra_Formal --
8784 ----------------------
8786 function Add_Extra_Formal
8787 (Assoc_Entity : Entity_Id;
8790 Suffix : String) return Entity_Id
8792 EF : constant Entity_Id :=
8793 Make_Defining_Identifier (Sloc (Assoc_Entity),
8794 Chars => New_External_Name (Chars (Assoc_Entity),
8798 -- A little optimization. Never generate an extra formal for the
8799 -- _init operand of an initialization procedure, since it could
8802 if Chars (Formal) = Name_uInit then
8806 Mutate_Ekind (EF, E_In_Parameter);
8807 Set_Actual_Subtype (EF, Typ);
8808 Set_Etype (EF, Typ);
8809 Set_Scope (EF, Scope);
8810 Set_Mechanism (EF, Default_Mechanism);
8811 Set_Formal_Validity (EF);
8813 if No (First_Extra) then
8815 Set_Extra_Formals (Scope, EF);
8818 if Present (Last_Extra) then
8819 Set_Extra_Formal (Last_Extra, EF);
8825 end Add_Extra_Formal;
8829 Formal_Type : Entity_Id;
8830 P_Formal : Entity_Id := Empty;
8832 -- Start of processing for Create_Extra_Formals
8835 -- We never generate extra formals if expansion is not active because we
8836 -- don't need them unless we are generating code.
8838 if not Expander_Active then
8842 -- No need to generate extra formals in interface thunks whose target
8843 -- primitive has no extra formals.
8845 if Is_Thunk (E) and then No (Extra_Formals (Thunk_Entity (E))) then
8849 -- If this is a derived subprogram then the subtypes of the parent
8850 -- subprogram's formal parameters will be used to determine the need
8851 -- for extra formals.
8853 if Is_Overloadable (E) and then Present (Alias (E)) then
8854 P_Formal := First_Formal (Alias (E));
8857 Formal := First_Formal (E);
8858 while Present (Formal) loop
8859 Last_Extra := Formal;
8860 Next_Formal (Formal);
8863 -- If Extra_Formals were already created, don't do it again. This
8864 -- situation may arise for subprogram types created as part of
8865 -- dispatching calls (see Expand_Dispatching_Call).
8867 if Present (Last_Extra) and then Present (Extra_Formal (Last_Extra)) then
8871 -- If the subprogram is a predefined dispatching subprogram then don't
8872 -- generate any extra constrained or accessibility level formals. In
8873 -- general we suppress these for internal subprograms (by not calling
8874 -- Freeze_Subprogram and Create_Extra_Formals at all), but internally
8875 -- generated stream attributes do get passed through because extra
8876 -- build-in-place formals are needed in some cases (limited 'Input).
8878 if Is_Predefined_Internal_Operation (E) then
8879 goto Test_For_Func_Result_Extras;
8882 Formal := First_Formal (E);
8883 while Present (Formal) loop
8885 -- Create extra formal for supporting the attribute 'Constrained.
8886 -- The case of a private type view without discriminants also
8887 -- requires the extra formal if the underlying type has defaulted
8890 if Ekind (Formal) /= E_In_Parameter then
8891 if Present (P_Formal) then
8892 Formal_Type := Etype (P_Formal);
8894 Formal_Type := Etype (Formal);
8897 -- Do not produce extra formals for Unchecked_Union parameters.
8898 -- Jump directly to the end of the loop.
8900 if Is_Unchecked_Union (Base_Type (Formal_Type)) then
8901 goto Skip_Extra_Formal_Generation;
8904 if not Has_Discriminants (Formal_Type)
8905 and then Is_Private_Type (Formal_Type)
8906 and then Present (Underlying_Type (Formal_Type))
8908 Formal_Type := Underlying_Type (Formal_Type);
8911 -- Suppress the extra formal if formal's subtype is constrained or
8912 -- indefinite, or we're compiling for Ada 2012 and the underlying
8913 -- type is tagged and limited. In Ada 2012, a limited tagged type
8914 -- can have defaulted discriminants, but 'Constrained is required
8915 -- to return True, so the formal is never needed (see AI05-0214).
8916 -- Note that this ensures consistency of calling sequences for
8917 -- dispatching operations when some types in a class have defaults
8918 -- on discriminants and others do not (and requiring the extra
8919 -- formal would introduce distributed overhead).
8921 -- If the type does not have a completion yet, treat as prior to
8922 -- Ada 2012 for consistency.
8924 if Has_Discriminants (Formal_Type)
8925 and then not Is_Constrained (Formal_Type)
8926 and then Is_Definite_Subtype (Formal_Type)
8927 and then (Ada_Version < Ada_2012
8928 or else No (Underlying_Type (Formal_Type))
8930 (Is_Limited_Type (Formal_Type)
8933 (Underlying_Type (Formal_Type)))))
8935 Set_Extra_Constrained
8936 (Formal, Add_Extra_Formal (Formal, Standard_Boolean, E, "O"));
8940 -- Create extra formal for supporting accessibility checking. This
8941 -- is done for both anonymous access formals and formals of named
8942 -- access types that are marked as controlling formals. The latter
8943 -- case can occur when Expand_Dispatching_Call creates a subprogram
8944 -- type and substitutes the types of access-to-class-wide actuals
8945 -- for the anonymous access-to-specific-type of controlling formals.
8946 -- Base_Type is applied because in cases where there is a null
8947 -- exclusion the formal may have an access subtype.
8949 -- This is suppressed if we specifically suppress accessibility
8950 -- checks at the package level for either the subprogram, or the
8951 -- package in which it resides. However, we do not suppress it
8952 -- simply if the scope has accessibility checks suppressed, since
8953 -- this could cause trouble when clients are compiled with a
8954 -- different suppression setting. The explicit checks at the
8955 -- package level are safe from this point of view.
8957 if (Ekind (Base_Type (Etype (Formal))) = E_Anonymous_Access_Type
8958 or else (Is_Controlling_Formal (Formal)
8959 and then Is_Access_Type (Base_Type (Etype (Formal)))))
8961 (Explicit_Suppress (E, Accessibility_Check)
8963 Explicit_Suppress (Scope (E), Accessibility_Check))
8966 or else Present (Extra_Accessibility (P_Formal)))
8968 Set_Extra_Accessibility
8969 (Formal, Add_Extra_Formal (Formal, Standard_Natural, E, "L"));
8972 -- This label is required when skipping extra formal generation for
8973 -- Unchecked_Union parameters.
8975 <<Skip_Extra_Formal_Generation>>
8977 if Present (P_Formal) then
8978 Next_Formal (P_Formal);
8981 Next_Formal (Formal);
8984 <<Test_For_Func_Result_Extras>>
8986 -- Ada 2012 (AI05-234): "the accessibility level of the result of a
8987 -- function call is ... determined by the point of call ...".
8989 if Needs_Result_Accessibility_Level (E) then
8990 Set_Extra_Accessibility_Of_Result
8991 (E, Add_Extra_Formal (E, Standard_Natural, E, "L"));
8994 -- Ada 2005 (AI-318-02): In the case of build-in-place functions, add
8995 -- appropriate extra formals. See type Exp_Ch6.BIP_Formal_Kind.
8997 if Is_Build_In_Place_Function (E) then
8999 Result_Subt : constant Entity_Id := Etype (E);
9000 Formal_Typ : Entity_Id;
9001 Subp_Decl : Node_Id;
9002 Discard : Entity_Id;
9005 -- In the case of functions with unconstrained result subtypes,
9006 -- add a 4-state formal indicating whether the return object is
9007 -- allocated by the caller (1), or should be allocated by the
9008 -- callee on the secondary stack (2), in the global heap (3), or
9009 -- in a user-defined storage pool (4). For the moment we just use
9010 -- Natural for the type of this formal. Note that this formal
9011 -- isn't usually needed in the case where the result subtype is
9012 -- constrained, but it is needed when the function has a tagged
9013 -- result, because generally such functions can be called in a
9014 -- dispatching context and such calls must be handled like calls
9015 -- to a class-wide function.
9017 if Needs_BIP_Alloc_Form (E) then
9020 (E, Standard_Natural,
9021 E, BIP_Formal_Suffix (BIP_Alloc_Form));
9023 -- Add BIP_Storage_Pool, in case BIP_Alloc_Form indicates to
9024 -- use a user-defined pool. This formal is not added on
9025 -- ZFP as those targets do not support pools.
9027 if RTE_Available (RE_Root_Storage_Pool_Ptr) then
9030 (E, RTE (RE_Root_Storage_Pool_Ptr),
9031 E, BIP_Formal_Suffix (BIP_Storage_Pool));
9035 -- In the case of functions whose result type needs finalization,
9036 -- add an extra formal which represents the finalization master.
9038 if Needs_BIP_Finalization_Master (E) then
9041 (E, RTE (RE_Finalization_Master_Ptr),
9042 E, BIP_Formal_Suffix (BIP_Finalization_Master));
9045 -- When the result type contains tasks, add two extra formals: the
9046 -- master of the tasks to be created, and the caller's activation
9049 if Needs_BIP_Task_Actuals (E) then
9052 (E, Standard_Integer,
9053 E, BIP_Formal_Suffix (BIP_Task_Master));
9055 Set_Has_Master_Entity (E);
9059 (E, RTE (RE_Activation_Chain_Access),
9060 E, BIP_Formal_Suffix (BIP_Activation_Chain));
9063 -- All build-in-place functions get an extra formal that will be
9064 -- passed the address of the return object within the caller.
9067 Create_Itype (E_Anonymous_Access_Type, E, Scope_Id => Scope (E));
9069 -- Incomplete_View_From_Limited_With is needed here because
9070 -- gigi gets confused if the designated type is the full view
9071 -- coming from a limited-with'ed package. In the normal case,
9072 -- (no limited with) Incomplete_View_From_Limited_With
9073 -- returns Result_Subt.
9075 Set_Directly_Designated_Type
9076 (Formal_Typ, Incomplete_View_From_Limited_With (Result_Subt));
9077 Set_Etype (Formal_Typ, Formal_Typ);
9078 Set_Depends_On_Private
9079 (Formal_Typ, Has_Private_Component (Formal_Typ));
9080 Set_Is_Public (Formal_Typ, Is_Public (Scope (Formal_Typ)));
9081 Set_Is_Access_Constant (Formal_Typ, False);
9083 -- Ada 2005 (AI-50217): Propagate the attribute that indicates
9084 -- the designated type comes from the limited view (for back-end
9087 Set_From_Limited_With
9088 (Formal_Typ, From_Limited_With (Result_Subt));
9090 Layout_Type (Formal_Typ);
9092 -- Force the definition of the Itype in case of internal function
9093 -- calls within the same or nested scope.
9095 if Is_Subprogram_Or_Generic_Subprogram (E) then
9096 Subp_Decl := Parent (E);
9098 -- The insertion point for an Itype reference should be after
9099 -- the unit declaration node of the subprogram. An exception
9100 -- to this are inherited operations from a parent type in which
9101 -- case the derived type acts as their parent.
9103 if Nkind (Subp_Decl) in N_Function_Specification
9104 | N_Procedure_Specification
9106 Subp_Decl := Parent (Subp_Decl);
9109 Build_Itype_Reference (Formal_Typ, Subp_Decl);
9114 (E, Formal_Typ, E, BIP_Formal_Suffix (BIP_Object_Access));
9118 -- If this is an instance of a generic, we need to have extra formals
9121 if Is_Generic_Instance (E) and then Present (Alias (E)) then
9122 Set_Extra_Formals (Alias (E), Extra_Formals (E));
9124 end Create_Extra_Formals;
9126 -----------------------------
9127 -- Enter_Overloaded_Entity --
9128 -----------------------------
9130 procedure Enter_Overloaded_Entity (S : Entity_Id) is
9131 function Matches_Predefined_Op return Boolean;
9132 -- This returns an approximation of whether S matches a predefined
9133 -- operator, based on the operator symbol, and the parameter and result
9134 -- types. The rules are scattered throughout chapter 4 of the Ada RM.
9136 ---------------------------
9137 -- Matches_Predefined_Op --
9138 ---------------------------
9140 function Matches_Predefined_Op return Boolean is
9141 Formal_1 : constant Entity_Id := First_Formal (S);
9142 Formal_2 : constant Entity_Id := Next_Formal (Formal_1);
9143 Op : constant Name_Id := Chars (S);
9144 Result_Type : constant Entity_Id := Base_Type (Etype (S));
9145 Type_1 : constant Entity_Id := Base_Type (Etype (Formal_1));
9150 if Present (Formal_2) then
9152 Type_2 : constant Entity_Id := Base_Type (Etype (Formal_2));
9155 -- All but "&" and "**" have same-types parameters
9164 if Type_1 /= Type_2 then
9169 -- Check parameter and result types
9177 Is_Boolean_Type (Result_Type)
9178 and then Result_Type = Type_1;
9184 Is_Integer_Type (Result_Type)
9185 and then Result_Type = Type_1;
9193 Is_Numeric_Type (Result_Type)
9194 and then Result_Type = Type_1;
9200 Is_Boolean_Type (Result_Type)
9201 and then not Is_Limited_Type (Type_1);
9209 Is_Boolean_Type (Result_Type)
9210 and then (Is_Array_Type (Type_1)
9211 or else Is_Scalar_Type (Type_1));
9213 when Name_Op_Concat =>
9214 return Is_Array_Type (Result_Type);
9216 when Name_Op_Expon =>
9218 (Is_Integer_Type (Result_Type)
9219 or else Is_Floating_Point_Type (Result_Type))
9220 and then Result_Type = Type_1
9221 and then Type_2 = Standard_Integer;
9224 raise Program_Error;
9237 Is_Numeric_Type (Result_Type)
9238 and then Result_Type = Type_1;
9242 Is_Boolean_Type (Result_Type)
9243 and then Result_Type = Type_1;
9246 raise Program_Error;
9249 end Matches_Predefined_Op;
9253 E : Entity_Id := Current_Entity_In_Scope (S);
9254 C_E : Entity_Id := Current_Entity (S);
9256 -- Start of processing for Enter_Overloaded_Entity
9260 Set_Has_Homonym (E);
9261 Set_Has_Homonym (S);
9264 Set_Is_Immediately_Visible (S);
9265 Set_Scope (S, Current_Scope);
9267 -- Chain new entity if front of homonym in current scope, so that
9268 -- homonyms are contiguous.
9270 if Present (E) and then E /= C_E then
9271 while Homonym (C_E) /= E loop
9272 C_E := Homonym (C_E);
9275 Set_Homonym (C_E, S);
9279 Set_Current_Entity (S);
9284 if Is_Inherited_Operation (S) then
9285 Append_Inherited_Subprogram (S);
9287 Append_Entity (S, Current_Scope);
9290 Set_Public_Status (S);
9292 if Debug_Flag_E then
9293 Write_Str ("New overloaded entity chain: ");
9294 Write_Name (Chars (S));
9297 while Present (E) loop
9298 Write_Str (" "); Write_Int (Int (E));
9305 -- Generate warning for hiding
9308 and then Comes_From_Source (S)
9309 and then In_Extended_Main_Source_Unit (S)
9316 -- Warn unless genuine overloading. Do not emit warning on
9317 -- hiding predefined operators in Standard (these are either an
9318 -- artifact of our implicit declarations, or simple noise) but
9319 -- keep warning on a operator defined on a local subtype, because
9320 -- of the real danger that different operators may be applied in
9321 -- various parts of the program.
9323 -- Note that if E and S have the same scope, there is never any
9324 -- hiding. Either the two conflict, and the program is illegal,
9325 -- or S is overriding an implicit inherited subprogram.
9327 if Scope (E) /= Scope (S)
9328 and then (not Is_Overloadable (E)
9329 or else Subtype_Conformant (E, S))
9330 and then (Is_Immediately_Visible (E)
9331 or else Is_Potentially_Use_Visible (S))
9333 if Scope (E) = Standard_Standard then
9334 if Nkind (S) = N_Defining_Operator_Symbol
9335 and then Scope (Base_Type (Etype (First_Formal (S)))) /=
9337 and then Matches_Predefined_Op
9340 ("declaration of & hides predefined operator?h?", S);
9343 -- E not immediately within Standard
9346 Error_Msg_Sloc := Sloc (E);
9347 Error_Msg_N ("declaration of & hides one #?h?", S);
9352 end Enter_Overloaded_Entity;
9354 -----------------------------
9355 -- Check_Untagged_Equality --
9356 -----------------------------
9358 procedure Check_Untagged_Equality (Eq_Op : Entity_Id) is
9359 Typ : constant Entity_Id := Etype (First_Formal (Eq_Op));
9360 Decl : constant Node_Id := Unit_Declaration_Node (Eq_Op);
9364 -- This check applies only if we have a subprogram declaration with an
9365 -- untagged record type that is conformant to the predefined op.
9367 if Nkind (Decl) /= N_Subprogram_Declaration
9368 or else not Is_Record_Type (Typ)
9369 or else Is_Tagged_Type (Typ)
9370 or else Etype (Next_Formal (First_Formal (Eq_Op))) /= Typ
9375 -- In Ada 2012 case, we will output errors or warnings depending on
9376 -- the setting of debug flag -gnatd.E.
9378 if Ada_Version >= Ada_2012 then
9379 Error_Msg_Warn := Debug_Flag_Dot_EE;
9381 -- In earlier versions of Ada, nothing to do unless we are warning on
9382 -- Ada 2012 incompatibilities (Warn_On_Ada_2012_Incompatibility set).
9385 if not Warn_On_Ada_2012_Compatibility then
9390 -- Cases where the type has already been frozen
9392 if Is_Frozen (Typ) then
9394 -- The check applies to a primitive operation, so check that type
9395 -- and equality operation are in the same scope.
9397 if Scope (Typ) /= Current_Scope then
9400 -- If the type is a generic actual (sub)type, the operation is not
9401 -- primitive either because the base type is declared elsewhere.
9403 elsif Is_Generic_Actual_Type (Typ) then
9406 -- Here we have a definite error of declaration after freezing
9409 if Ada_Version >= Ada_2012 then
9411 ("equality operator must be declared before type & is "
9412 & "frozen (RM 4.5.2 (9.8)) (Ada 2012)<<", Eq_Op, Typ);
9414 -- In Ada 2012 mode with error turned to warning, output one
9415 -- more warning to warn that the equality operation may not
9416 -- compose. This is the consequence of ignoring the error.
9418 if Error_Msg_Warn then
9419 Error_Msg_N ("\equality operation may not compose??", Eq_Op);
9424 ("equality operator must be declared before type& is "
9425 & "frozen (RM 4.5.2 (9.8)) (Ada 2012)?y?", Eq_Op, Typ);
9428 -- If we are in the package body, we could just move the
9429 -- declaration to the package spec, so add a message saying that.
9431 if In_Package_Body (Scope (Typ)) then
9432 if Ada_Version >= Ada_2012 then
9434 ("\move declaration to package spec<<", Eq_Op);
9437 ("\move declaration to package spec (Ada 2012)?y?", Eq_Op);
9440 -- Otherwise try to find the freezing point for better message.
9443 Obj_Decl := Next (Parent (Typ));
9444 while Present (Obj_Decl) and then Obj_Decl /= Decl loop
9445 if Nkind (Obj_Decl) = N_Object_Declaration
9446 and then Etype (Defining_Identifier (Obj_Decl)) = Typ
9448 -- Freezing point, output warnings
9450 if Ada_Version >= Ada_2012 then
9452 ("type& is frozen by declaration??", Obj_Decl, Typ);
9454 ("\an equality operator cannot be declared after "
9459 ("type& is frozen by declaration (Ada 2012)?y?",
9462 ("\an equality operator cannot be declared after "
9463 & "this point (Ada 2012)?y?",
9469 -- If we reach generated code for subprogram declaration
9470 -- or body, it is the body that froze the type and the
9471 -- declaration is legal.
9473 elsif Sloc (Obj_Decl) = Sloc (Decl) then
9482 -- Here if type is not frozen yet. It is illegal to have a primitive
9483 -- equality declared in the private part if the type is visible
9486 elsif not In_Same_List (Parent (Typ), Decl)
9487 and then not Is_Limited_Type (Typ)
9489 if Ada_Version >= Ada_2012 then
9491 ("equality operator appears too late<<", Eq_Op);
9494 ("equality operator appears too late (Ada 2012)?y?", Eq_Op);
9497 -- Finally check for AI12-0352: declaration of a user-defined primitive
9498 -- equality operation for a record type T is illegal if it occurs after
9499 -- a type has been derived from T.
9502 Obj_Decl := Next (Parent (Typ));
9504 while Present (Obj_Decl) and then Obj_Decl /= Decl loop
9505 if Nkind (Obj_Decl) = N_Full_Type_Declaration
9506 and then Etype (Defining_Identifier (Obj_Decl)) = Typ
9509 ("equality operator cannot appear after derivation", Eq_Op);
9511 ("an equality operator for& cannot be declared after "
9519 end Check_Untagged_Equality;
9521 -----------------------------
9522 -- Find_Corresponding_Spec --
9523 -----------------------------
9525 function Find_Corresponding_Spec
9527 Post_Error : Boolean := True) return Entity_Id
9529 Spec : constant Node_Id := Specification (N);
9530 Designator : constant Entity_Id := Defining_Entity (Spec);
9534 function Different_Generic_Profile (E : Entity_Id) return Boolean;
9535 -- Even if fully conformant, a body may depend on a generic actual when
9536 -- the spec does not, or vice versa, in which case they were distinct
9537 -- entities in the generic.
9539 -------------------------------
9540 -- Different_Generic_Profile --
9541 -------------------------------
9543 function Different_Generic_Profile (E : Entity_Id) return Boolean is
9546 function Same_Generic_Actual (T1, T2 : Entity_Id) return Boolean;
9547 -- Check that the types of corresponding formals have the same
9548 -- generic actual if any. We have to account for subtypes of a
9549 -- generic formal, declared between a spec and a body, which may
9550 -- appear distinct in an instance but matched in the generic, and
9551 -- the subtype may be used either in the spec or the body of the
9552 -- subprogram being checked.
9554 -------------------------
9555 -- Same_Generic_Actual --
9556 -------------------------
9558 function Same_Generic_Actual (T1, T2 : Entity_Id) return Boolean is
9560 function Is_Declared_Subtype (S1, S2 : Entity_Id) return Boolean;
9561 -- Predicate to check whether S1 is a subtype of S2 in the source
9564 -------------------------
9565 -- Is_Declared_Subtype --
9566 -------------------------
9568 function Is_Declared_Subtype (S1, S2 : Entity_Id) return Boolean is
9570 return Comes_From_Source (Parent (S1))
9571 and then Nkind (Parent (S1)) = N_Subtype_Declaration
9572 and then Is_Entity_Name (Subtype_Indication (Parent (S1)))
9573 and then Entity (Subtype_Indication (Parent (S1))) = S2;
9574 end Is_Declared_Subtype;
9576 -- Start of processing for Same_Generic_Actual
9579 return Is_Generic_Actual_Type (T1) = Is_Generic_Actual_Type (T2)
9580 or else Is_Declared_Subtype (T1, T2)
9581 or else Is_Declared_Subtype (T2, T1);
9582 end Same_Generic_Actual;
9584 -- Start of processing for Different_Generic_Profile
9587 if not In_Instance then
9590 elsif Ekind (E) = E_Function
9591 and then not Same_Generic_Actual (Etype (E), Etype (Designator))
9596 F1 := First_Formal (Designator);
9597 F2 := First_Formal (E);
9598 while Present (F1) loop
9599 if not Same_Generic_Actual (Etype (F1), Etype (F2)) then
9608 end Different_Generic_Profile;
9610 -- Start of processing for Find_Corresponding_Spec
9613 E := Current_Entity (Designator);
9614 while Present (E) loop
9616 -- We are looking for a matching spec. It must have the same scope,
9617 -- and the same name, and either be type conformant, or be the case
9618 -- of a library procedure spec and its body (which belong to one
9619 -- another regardless of whether they are type conformant or not).
9621 if Scope (E) = Current_Scope then
9622 if Current_Scope = Standard_Standard
9623 or else (Ekind (E) = Ekind (Designator)
9624 and then Type_Conformant (E, Designator))
9626 -- Within an instantiation, we know that spec and body are
9627 -- subtype conformant, because they were subtype conformant in
9628 -- the generic. We choose the subtype-conformant entity here as
9629 -- well, to resolve spurious ambiguities in the instance that
9630 -- were not present in the generic (i.e. when two different
9631 -- types are given the same actual). If we are looking for a
9632 -- spec to match a body, full conformance is expected.
9636 -- Inherit the convention and "ghostness" of the matching
9637 -- spec to ensure proper full and subtype conformance.
9639 Set_Convention (Designator, Convention (E));
9641 -- Skip past subprogram bodies and subprogram renamings that
9642 -- may appear to have a matching spec, but that aren't fully
9643 -- conformant with it. That can occur in cases where an
9644 -- actual type causes unrelated homographs in the instance.
9646 if Nkind (N) in N_Subprogram_Body
9647 | N_Subprogram_Renaming_Declaration
9648 and then Present (Homonym (E))
9649 and then not Fully_Conformant (Designator, E)
9653 elsif not Subtype_Conformant (Designator, E) then
9656 elsif Different_Generic_Profile (E) then
9661 -- Ada 2012 (AI05-0165): For internally generated bodies of
9662 -- null procedures locate the internally generated spec. We
9663 -- enforce mode conformance since a tagged type may inherit
9664 -- from interfaces several null primitives which differ only
9665 -- in the mode of the formals.
9667 if not (Comes_From_Source (E))
9668 and then Is_Null_Procedure (E)
9669 and then not Mode_Conformant (Designator, E)
9673 -- For null procedures coming from source that are completions,
9674 -- analysis of the generated body will establish the link.
9676 elsif Comes_From_Source (E)
9677 and then Nkind (Spec) = N_Procedure_Specification
9678 and then Null_Present (Spec)
9682 -- Expression functions can be completions, but cannot be
9683 -- completed by an explicit body.
9685 elsif Comes_From_Source (E)
9686 and then Comes_From_Source (N)
9687 and then Nkind (N) = N_Subprogram_Body
9688 and then Nkind (Original_Node (Unit_Declaration_Node (E))) =
9689 N_Expression_Function
9691 Error_Msg_Sloc := Sloc (E);
9692 Error_Msg_N ("body conflicts with expression function#", N);
9695 elsif not Has_Completion (E) then
9696 if Nkind (N) /= N_Subprogram_Body_Stub then
9697 Set_Corresponding_Spec (N, E);
9700 Set_Has_Completion (E);
9703 elsif Nkind (Parent (N)) = N_Subunit then
9705 -- If this is the proper body of a subunit, the completion
9706 -- flag is set when analyzing the stub.
9710 -- If E is an internal function with a controlling result that
9711 -- was created for an operation inherited by a null extension,
9712 -- it may be overridden by a body without a previous spec (one
9713 -- more reason why these should be shunned). In that case we
9714 -- remove the generated body if present, because the current
9715 -- one is the explicit overriding.
9717 elsif Ekind (E) = E_Function
9718 and then Ada_Version >= Ada_2005
9719 and then not Comes_From_Source (E)
9720 and then Has_Controlling_Result (E)
9721 and then Is_Null_Extension (Etype (E))
9722 and then Comes_From_Source (Spec)
9724 Set_Has_Completion (E, False);
9727 and then Nkind (Parent (E)) = N_Function_Specification
9730 (Unit_Declaration_Node
9731 (Corresponding_Body (Unit_Declaration_Node (E))));
9735 -- If expansion is disabled, or if the wrapper function has
9736 -- not been generated yet, this a late body overriding an
9737 -- inherited operation, or it is an overriding by some other
9738 -- declaration before the controlling result is frozen. In
9739 -- either case this is a declaration of a new entity.
9745 -- If the body already exists, then this is an error unless
9746 -- the previous declaration is the implicit declaration of a
9747 -- derived subprogram. It is also legal for an instance to
9748 -- contain type conformant overloadable declarations (but the
9749 -- generic declaration may not), per 8.3(26/2).
9751 elsif No (Alias (E))
9752 and then not Is_Intrinsic_Subprogram (E)
9753 and then not In_Instance
9756 Error_Msg_Sloc := Sloc (E);
9758 if Is_Imported (E) then
9760 ("body not allowed for imported subprogram & declared#",
9763 Error_Msg_NE ("duplicate body for & declared#", N, E);
9767 -- Child units cannot be overloaded, so a conformance mismatch
9768 -- between body and a previous spec is an error.
9770 elsif Is_Child_Unit (E)
9772 Nkind (Unit_Declaration_Node (Designator)) = N_Subprogram_Body
9774 Nkind (Parent (Unit_Declaration_Node (Designator))) =
9779 ("body of child unit does not match previous declaration", N);
9787 -- On exit, we know that no previous declaration of subprogram exists
9790 end Find_Corresponding_Spec;
9792 ----------------------
9793 -- Fully_Conformant --
9794 ----------------------
9796 function Fully_Conformant (New_Id, Old_Id : Entity_Id) return Boolean is
9799 Check_Conformance (New_Id, Old_Id, Fully_Conformant, False, Result);
9801 end Fully_Conformant;
9803 ----------------------------------
9804 -- Fully_Conformant_Expressions --
9805 ----------------------------------
9807 function Fully_Conformant_Expressions
9808 (Given_E1 : Node_Id;
9810 Report : Boolean := False) return Boolean
9812 E1 : constant Node_Id := Original_Node (Given_E1);
9813 E2 : constant Node_Id := Original_Node (Given_E2);
9814 -- We always test conformance on original nodes, since it is possible
9815 -- for analysis and/or expansion to make things look as though they
9816 -- conform when they do not, e.g. by converting 1+2 into 3.
9818 function FCE (Given_E1 : Node_Id; Given_E2 : Node_Id) return Boolean;
9819 -- Convenience function to abbreviate recursive calls to
9820 -- Fully_Conformant_Expressions without having to pass Report.
9822 function FCL (L1 : List_Id; L2 : List_Id) return Boolean;
9823 -- Compare elements of two lists for conformance. Elements have to be
9824 -- conformant, and actuals inserted as default parameters do not match
9825 -- explicit actuals with the same value.
9827 function FCO (Op_Node : Node_Id; Call_Node : Node_Id) return Boolean;
9828 -- Compare an operator node with a function call
9834 function FCE (Given_E1 : Node_Id; Given_E2 : Node_Id) return Boolean is
9836 return Fully_Conformant_Expressions (Given_E1, Given_E2, Report);
9843 function FCL (L1 : List_Id; L2 : List_Id) return Boolean is
9848 if L1 = No_List then
9854 if L2 = No_List then
9860 -- Compare two lists, skipping rewrite insertions (we want to compare
9861 -- the original trees, not the expanded versions).
9864 if Is_Rewrite_Insertion (N1) then
9866 elsif Is_Rewrite_Insertion (N2) then
9872 elsif not FCE (N1, N2) then
9885 function FCO (Op_Node : Node_Id; Call_Node : Node_Id) return Boolean is
9886 Actuals : constant List_Id := Parameter_Associations (Call_Node);
9891 or else Entity (Op_Node) /= Entity (Name (Call_Node))
9896 Act := First (Actuals);
9898 if Nkind (Op_Node) in N_Binary_Op then
9899 if not FCE (Left_Opnd (Op_Node), Act) then
9906 return Present (Act)
9907 and then FCE (Right_Opnd (Op_Node), Act)
9908 and then No (Next (Act));
9912 function User_Defined_Numeric_Literal_Mismatch return Boolean;
9913 -- Usually literals with the same value like 12345 and 12_345
9914 -- or 123.0 and 123.00 conform, but not if they are
9915 -- user-defined literals.
9917 -------------------------------------------
9918 -- User_Defined_Numeric_Literal_Mismatch --
9919 -------------------------------------------
9921 function User_Defined_Numeric_Literal_Mismatch return Boolean is
9922 E1_Is_User_Defined : constant Boolean :=
9923 Nkind (Given_E1) not in N_Integer_Literal | N_Real_Literal;
9924 E2_Is_User_Defined : constant Boolean :=
9925 Nkind (Given_E2) not in N_Integer_Literal | N_Real_Literal;
9928 pragma Assert (E1_Is_User_Defined = E2_Is_User_Defined);
9930 return E1_Is_User_Defined and then
9931 not String_Equal (String_From_Numeric_Literal (E1),
9932 String_From_Numeric_Literal (E2));
9933 end User_Defined_Numeric_Literal_Mismatch;
9939 -- Start of processing for Fully_Conformant_Expressions
9944 -- Nonconformant if paren count does not match. Note: if some idiot
9945 -- complains that we don't do this right for more than 3 levels of
9946 -- parentheses, they will be treated with the respect they deserve.
9948 if Paren_Count (E1) /= Paren_Count (E2) then
9951 -- If same entities are referenced, then they are conformant even if
9952 -- they have different forms (RM 8.3.1(19-20)).
9954 elsif Is_Entity_Name (E1) and then Is_Entity_Name (E2) then
9955 if Present (Entity (E1)) then
9956 Result := Entity (E1) = Entity (E2)
9958 -- One may be a discriminant that has been replaced by the
9959 -- corresponding discriminal.
9962 (Chars (Entity (E1)) = Chars (Entity (E2))
9963 and then Ekind (Entity (E1)) = E_Discriminant
9964 and then Ekind (Entity (E2)) = E_In_Parameter)
9966 -- The discriminant of a protected type is transformed into
9967 -- a local constant and then into a parameter of a protected
9971 (Ekind (Entity (E1)) = E_Constant
9972 and then Ekind (Entity (E2)) = E_In_Parameter
9973 and then Present (Discriminal_Link (Entity (E1)))
9974 and then Discriminal_Link (Entity (E1)) =
9975 Discriminal_Link (Entity (E2)))
9977 -- AI12-050: The loop variables of quantified expressions match
9978 -- if they have the same identifier, even though they may have
9979 -- different entities.
9982 (Chars (Entity (E1)) = Chars (Entity (E2))
9983 and then Ekind (Entity (E1)) = E_Loop_Parameter
9984 and then Ekind (Entity (E2)) = E_Loop_Parameter)
9986 -- A call to an instantiation of Unchecked_Conversion is
9987 -- rewritten with the name of the generated function created for
9988 -- the instance, and this must be special-cased.
9991 (Ekind (Entity (E1)) = E_Function
9992 and then Is_Intrinsic_Subprogram (Entity (E1))
9993 and then Is_Generic_Instance (Entity (E1))
9994 and then Entity (E2) = Alias (Entity (E1)));
9995 if Report and not Result then
9997 Text_Ptr'Max (Sloc (Entity (E1)), Sloc (Entity (E2)));
9999 ("meaning of& differs because of declaration#", E1, E2);
10004 elsif Nkind (E1) = N_Expanded_Name
10005 and then Nkind (E2) = N_Expanded_Name
10006 and then Nkind (Selector_Name (E1)) = N_Character_Literal
10007 and then Nkind (Selector_Name (E2)) = N_Character_Literal
10009 return Chars (Selector_Name (E1)) = Chars (Selector_Name (E2));
10012 -- Identifiers in component associations don't always have
10013 -- entities, but their names must conform.
10015 return Nkind (E1) = N_Identifier
10016 and then Nkind (E2) = N_Identifier
10017 and then Chars (E1) = Chars (E2);
10020 elsif Nkind (E1) = N_Character_Literal
10021 and then Nkind (E2) = N_Expanded_Name
10023 return Nkind (Selector_Name (E2)) = N_Character_Literal
10024 and then Chars (E1) = Chars (Selector_Name (E2));
10026 elsif Nkind (E2) = N_Character_Literal
10027 and then Nkind (E1) = N_Expanded_Name
10029 return Nkind (Selector_Name (E1)) = N_Character_Literal
10030 and then Chars (E2) = Chars (Selector_Name (E1));
10032 elsif Nkind (E1) in N_Op and then Nkind (E2) = N_Function_Call then
10033 return FCO (E1, E2);
10035 elsif Nkind (E2) in N_Op and then Nkind (E1) = N_Function_Call then
10036 return FCO (E2, E1);
10038 -- Otherwise we must have the same syntactic entity
10040 elsif Nkind (E1) /= Nkind (E2) then
10043 -- At this point, we specialize by node type
10047 when N_Aggregate =>
10049 FCL (Expressions (E1), Expressions (E2))
10051 FCL (Component_Associations (E1),
10052 Component_Associations (E2));
10054 when N_Allocator =>
10055 if Nkind (Expression (E1)) = N_Qualified_Expression
10057 Nkind (Expression (E2)) = N_Qualified_Expression
10059 return FCE (Expression (E1), Expression (E2));
10061 -- Check that the subtype marks and any constraints
10066 Indic1 : constant Node_Id := Expression (E1);
10067 Indic2 : constant Node_Id := Expression (E2);
10072 if Nkind (Indic1) /= N_Subtype_Indication then
10074 Nkind (Indic2) /= N_Subtype_Indication
10075 and then Entity (Indic1) = Entity (Indic2);
10077 elsif Nkind (Indic2) /= N_Subtype_Indication then
10079 Nkind (Indic1) /= N_Subtype_Indication
10080 and then Entity (Indic1) = Entity (Indic2);
10083 if Entity (Subtype_Mark (Indic1)) /=
10084 Entity (Subtype_Mark (Indic2))
10089 Elt1 := First (Constraints (Constraint (Indic1)));
10090 Elt2 := First (Constraints (Constraint (Indic2)));
10091 while Present (Elt1) and then Present (Elt2) loop
10092 if not FCE (Elt1, Elt2) then
10105 when N_Attribute_Reference =>
10107 Attribute_Name (E1) = Attribute_Name (E2)
10108 and then FCL (Expressions (E1), Expressions (E2));
10110 when N_Binary_Op =>
10112 Entity (E1) = Entity (E2)
10113 and then FCE (Left_Opnd (E1), Left_Opnd (E2))
10114 and then FCE (Right_Opnd (E1), Right_Opnd (E2));
10116 when N_Membership_Test
10120 FCE (Left_Opnd (E1), Left_Opnd (E2))
10122 FCE (Right_Opnd (E1), Right_Opnd (E2));
10124 when N_Case_Expression =>
10130 if not FCE (Expression (E1), Expression (E2)) then
10134 Alt1 := First (Alternatives (E1));
10135 Alt2 := First (Alternatives (E2));
10137 if Present (Alt1) /= Present (Alt2) then
10139 elsif No (Alt1) then
10143 if not FCE (Expression (Alt1), Expression (Alt2))
10144 or else not FCL (Discrete_Choices (Alt1),
10145 Discrete_Choices (Alt2))
10156 when N_Character_Literal =>
10158 Char_Literal_Value (E1) = Char_Literal_Value (E2);
10160 when N_Component_Association =>
10162 FCL (Choices (E1), Choices (E2))
10164 FCE (Expression (E1), Expression (E2));
10166 when N_Explicit_Dereference =>
10168 FCE (Prefix (E1), Prefix (E2));
10170 when N_Extension_Aggregate =>
10172 FCL (Expressions (E1), Expressions (E2))
10173 and then Null_Record_Present (E1) =
10174 Null_Record_Present (E2)
10175 and then FCL (Component_Associations (E1),
10176 Component_Associations (E2));
10178 when N_Function_Call =>
10180 FCE (Name (E1), Name (E2))
10182 FCL (Parameter_Associations (E1),
10183 Parameter_Associations (E2));
10185 when N_If_Expression =>
10187 FCL (Expressions (E1), Expressions (E2));
10189 when N_Indexed_Component =>
10191 FCE (Prefix (E1), Prefix (E2))
10193 FCL (Expressions (E1), Expressions (E2));
10195 when N_Integer_Literal =>
10196 return (Intval (E1) = Intval (E2))
10197 and then not User_Defined_Numeric_Literal_Mismatch;
10202 when N_Operator_Symbol =>
10204 Chars (E1) = Chars (E2);
10206 when N_Others_Choice =>
10209 when N_Parameter_Association =>
10211 Chars (Selector_Name (E1)) = Chars (Selector_Name (E2))
10212 and then FCE (Explicit_Actual_Parameter (E1),
10213 Explicit_Actual_Parameter (E2));
10215 when N_Qualified_Expression
10216 | N_Type_Conversion
10217 | N_Unchecked_Type_Conversion
10220 FCE (Subtype_Mark (E1), Subtype_Mark (E2))
10222 FCE (Expression (E1), Expression (E2));
10224 when N_Quantified_Expression =>
10225 if not FCE (Condition (E1), Condition (E2)) then
10229 if Present (Loop_Parameter_Specification (E1))
10230 and then Present (Loop_Parameter_Specification (E2))
10233 L1 : constant Node_Id :=
10234 Loop_Parameter_Specification (E1);
10235 L2 : constant Node_Id :=
10236 Loop_Parameter_Specification (E2);
10240 Reverse_Present (L1) = Reverse_Present (L2)
10242 FCE (Defining_Identifier (L1),
10243 Defining_Identifier (L2))
10245 FCE (Discrete_Subtype_Definition (L1),
10246 Discrete_Subtype_Definition (L2));
10249 elsif Present (Iterator_Specification (E1))
10250 and then Present (Iterator_Specification (E2))
10253 I1 : constant Node_Id := Iterator_Specification (E1);
10254 I2 : constant Node_Id := Iterator_Specification (E2);
10258 FCE (Defining_Identifier (I1),
10259 Defining_Identifier (I2))
10261 Of_Present (I1) = Of_Present (I2)
10263 Reverse_Present (I1) = Reverse_Present (I2)
10264 and then FCE (Name (I1), Name (I2))
10265 and then FCE (Subtype_Indication (I1),
10266 Subtype_Indication (I2));
10269 -- The quantified expressions used different specifications to
10270 -- walk their respective ranges.
10278 FCE (Low_Bound (E1), Low_Bound (E2))
10280 FCE (High_Bound (E1), High_Bound (E2));
10282 when N_Real_Literal =>
10283 return (Realval (E1) = Realval (E2))
10284 and then not User_Defined_Numeric_Literal_Mismatch;
10286 when N_Selected_Component =>
10288 FCE (Prefix (E1), Prefix (E2))
10290 FCE (Selector_Name (E1), Selector_Name (E2));
10294 FCE (Prefix (E1), Prefix (E2))
10296 FCE (Discrete_Range (E1), Discrete_Range (E2));
10298 when N_String_Literal =>
10300 S1 : constant String_Id := Strval (E1);
10301 S2 : constant String_Id := Strval (E2);
10302 L1 : constant Nat := String_Length (S1);
10303 L2 : constant Nat := String_Length (S2);
10310 for J in 1 .. L1 loop
10311 if Get_String_Char (S1, J) /=
10312 Get_String_Char (S2, J)
10324 Entity (E1) = Entity (E2)
10326 FCE (Right_Opnd (E1), Right_Opnd (E2));
10328 -- All other node types cannot appear in this context. Strictly
10329 -- we should raise a fatal internal error. Instead we just ignore
10330 -- the nodes. This means that if anyone makes a mistake in the
10331 -- expander and mucks an expression tree irretrievably, the result
10332 -- will be a failure to detect a (probably very obscure) case
10333 -- of non-conformance, which is better than bombing on some
10334 -- case where two expressions do in fact conform.
10340 end Fully_Conformant_Expressions;
10342 ----------------------------------------
10343 -- Fully_Conformant_Discrete_Subtypes --
10344 ----------------------------------------
10346 function Fully_Conformant_Discrete_Subtypes
10347 (Given_S1 : Node_Id;
10348 Given_S2 : Node_Id) return Boolean
10350 S1 : constant Node_Id := Original_Node (Given_S1);
10351 S2 : constant Node_Id := Original_Node (Given_S2);
10353 function Conforming_Bounds (B1, B2 : Node_Id) return Boolean;
10354 -- Special-case for a bound given by a discriminant, which in the body
10355 -- is replaced with the discriminal of the enclosing type.
10357 function Conforming_Ranges (R1, R2 : Node_Id) return Boolean;
10358 -- Check both bounds
10360 -----------------------
10361 -- Conforming_Bounds --
10362 -----------------------
10364 function Conforming_Bounds (B1, B2 : Node_Id) return Boolean is
10366 if Is_Entity_Name (B1)
10367 and then Is_Entity_Name (B2)
10368 and then Ekind (Entity (B1)) = E_Discriminant
10370 return Chars (B1) = Chars (B2);
10373 return Fully_Conformant_Expressions (B1, B2);
10375 end Conforming_Bounds;
10377 -----------------------
10378 -- Conforming_Ranges --
10379 -----------------------
10381 function Conforming_Ranges (R1, R2 : Node_Id) return Boolean is
10384 Conforming_Bounds (Low_Bound (R1), Low_Bound (R2))
10386 Conforming_Bounds (High_Bound (R1), High_Bound (R2));
10387 end Conforming_Ranges;
10389 -- Start of processing for Fully_Conformant_Discrete_Subtypes
10392 if Nkind (S1) /= Nkind (S2) then
10395 elsif Is_Entity_Name (S1) then
10396 return Entity (S1) = Entity (S2);
10398 elsif Nkind (S1) = N_Range then
10399 return Conforming_Ranges (S1, S2);
10401 elsif Nkind (S1) = N_Subtype_Indication then
10403 Entity (Subtype_Mark (S1)) = Entity (Subtype_Mark (S2))
10406 (Range_Expression (Constraint (S1)),
10407 Range_Expression (Constraint (S2)));
10411 end Fully_Conformant_Discrete_Subtypes;
10413 --------------------
10414 -- Install_Entity --
10415 --------------------
10417 procedure Install_Entity (E : Entity_Id) is
10418 Prev : constant Entity_Id := Current_Entity (E);
10420 Set_Is_Immediately_Visible (E);
10421 Set_Current_Entity (E);
10422 Set_Homonym (E, Prev);
10423 end Install_Entity;
10425 ---------------------
10426 -- Install_Formals --
10427 ---------------------
10429 procedure Install_Formals (Id : Entity_Id) is
10432 F := First_Formal (Id);
10433 while Present (F) loop
10434 Install_Entity (F);
10437 end Install_Formals;
10439 -----------------------------
10440 -- Is_Interface_Conformant --
10441 -----------------------------
10443 function Is_Interface_Conformant
10444 (Tagged_Type : Entity_Id;
10445 Iface_Prim : Entity_Id;
10446 Prim : Entity_Id) return Boolean
10448 -- The operation may in fact be an inherited (implicit) operation
10449 -- rather than the original interface primitive, so retrieve the
10450 -- ultimate ancestor.
10452 Iface : constant Entity_Id :=
10453 Find_Dispatching_Type (Ultimate_Alias (Iface_Prim));
10454 Typ : constant Entity_Id := Find_Dispatching_Type (Prim);
10456 function Controlling_Formal (Prim : Entity_Id) return Entity_Id;
10457 -- Return the controlling formal of Prim
10459 ------------------------
10460 -- Controlling_Formal --
10461 ------------------------
10463 function Controlling_Formal (Prim : Entity_Id) return Entity_Id is
10467 E := First_Entity (Prim);
10468 while Present (E) loop
10469 if Is_Formal (E) and then Is_Controlling_Formal (E) then
10477 end Controlling_Formal;
10481 Iface_Ctrl_F : constant Entity_Id := Controlling_Formal (Iface_Prim);
10482 Prim_Ctrl_F : constant Entity_Id := Controlling_Formal (Prim);
10484 -- Start of processing for Is_Interface_Conformant
10487 pragma Assert (Is_Subprogram (Iface_Prim)
10488 and then Is_Subprogram (Prim)
10489 and then Is_Dispatching_Operation (Iface_Prim)
10490 and then Is_Dispatching_Operation (Prim));
10492 pragma Assert (Is_Interface (Iface)
10493 or else (Present (Alias (Iface_Prim))
10496 (Find_Dispatching_Type (Ultimate_Alias (Iface_Prim)))));
10498 if Prim = Iface_Prim
10499 or else not Is_Subprogram (Prim)
10500 or else Ekind (Prim) /= Ekind (Iface_Prim)
10501 or else not Is_Dispatching_Operation (Prim)
10502 or else Scope (Prim) /= Scope (Tagged_Type)
10504 or else Base_Type (Typ) /= Base_Type (Tagged_Type)
10505 or else not Primitive_Names_Match (Iface_Prim, Prim)
10509 -- The mode of the controlling formals must match
10511 elsif Present (Iface_Ctrl_F)
10512 and then Present (Prim_Ctrl_F)
10513 and then Ekind (Iface_Ctrl_F) /= Ekind (Prim_Ctrl_F)
10517 -- Case of a procedure, or a function whose result type matches the
10518 -- result type of the interface primitive, or a function that has no
10519 -- controlling result (I or access I).
10521 elsif Ekind (Iface_Prim) = E_Procedure
10522 or else Etype (Prim) = Etype (Iface_Prim)
10523 or else not Has_Controlling_Result (Prim)
10525 return Type_Conformant
10526 (Iface_Prim, Prim, Skip_Controlling_Formals => True);
10528 -- Case of a function returning an interface, or an access to one. Check
10529 -- that the return types correspond.
10531 elsif Implements_Interface (Typ, Iface) then
10532 if (Ekind (Etype (Prim)) = E_Anonymous_Access_Type)
10534 (Ekind (Etype (Iface_Prim)) = E_Anonymous_Access_Type)
10539 Type_Conformant (Prim, Ultimate_Alias (Iface_Prim),
10540 Skip_Controlling_Formals => True);
10546 end Is_Interface_Conformant;
10548 ---------------------------------
10549 -- Is_Non_Overriding_Operation --
10550 ---------------------------------
10552 function Is_Non_Overriding_Operation
10553 (Prev_E : Entity_Id;
10554 New_E : Entity_Id) return Boolean
10556 Formal : Entity_Id;
10558 G_Typ : Entity_Id := Empty;
10560 function Get_Generic_Parent_Type (F_Typ : Entity_Id) return Entity_Id;
10561 -- If F_Type is a derived type associated with a generic actual subtype,
10562 -- then return its Generic_Parent_Type attribute, else return Empty.
10564 function Types_Correspond
10565 (P_Type : Entity_Id;
10566 N_Type : Entity_Id) return Boolean;
10567 -- Returns true if and only if the types (or designated types in the
10568 -- case of anonymous access types) are the same or N_Type is derived
10569 -- directly or indirectly from P_Type.
10571 -----------------------------
10572 -- Get_Generic_Parent_Type --
10573 -----------------------------
10575 function Get_Generic_Parent_Type (F_Typ : Entity_Id) return Entity_Id is
10581 if Is_Derived_Type (F_Typ)
10582 and then Nkind (Parent (F_Typ)) = N_Full_Type_Declaration
10584 -- The tree must be traversed to determine the parent subtype in
10585 -- the generic unit, which unfortunately isn't always available
10586 -- via semantic attributes. ??? (Note: The use of Original_Node
10587 -- is needed for cases where a full derived type has been
10590 -- If the parent type is a scalar type, the derivation creates
10591 -- an anonymous base type for it, and the source type is its
10594 if Is_Scalar_Type (F_Typ)
10595 and then not Comes_From_Source (F_Typ)
10599 (Original_Node (Parent (First_Subtype (F_Typ))));
10601 Defn := Type_Definition (Original_Node (Parent (F_Typ)));
10603 if Nkind (Defn) = N_Derived_Type_Definition then
10604 Indic := Subtype_Indication (Defn);
10606 if Nkind (Indic) = N_Subtype_Indication then
10607 G_Typ := Entity (Subtype_Mark (Indic));
10609 G_Typ := Entity (Indic);
10612 if Nkind (Parent (G_Typ)) = N_Subtype_Declaration
10613 and then Present (Generic_Parent_Type (Parent (G_Typ)))
10615 return Generic_Parent_Type (Parent (G_Typ));
10621 end Get_Generic_Parent_Type;
10623 ----------------------
10624 -- Types_Correspond --
10625 ----------------------
10627 function Types_Correspond
10628 (P_Type : Entity_Id;
10629 N_Type : Entity_Id) return Boolean
10631 Prev_Type : Entity_Id := Base_Type (P_Type);
10632 New_Type : Entity_Id := Base_Type (N_Type);
10635 if Ekind (Prev_Type) = E_Anonymous_Access_Type then
10636 Prev_Type := Designated_Type (Prev_Type);
10639 if Ekind (New_Type) = E_Anonymous_Access_Type then
10640 New_Type := Designated_Type (New_Type);
10643 if Prev_Type = New_Type then
10646 elsif not Is_Class_Wide_Type (New_Type) then
10647 while Etype (New_Type) /= New_Type loop
10648 New_Type := Etype (New_Type);
10650 if New_Type = Prev_Type then
10656 end Types_Correspond;
10658 -- Start of processing for Is_Non_Overriding_Operation
10661 -- In the case where both operations are implicit derived subprograms
10662 -- then neither overrides the other. This can only occur in certain
10663 -- obscure cases (e.g., derivation from homographs created in a generic
10666 if Present (Alias (Prev_E)) and then Present (Alias (New_E)) then
10669 elsif Ekind (Current_Scope) = E_Package
10670 and then Is_Generic_Instance (Current_Scope)
10671 and then In_Private_Part (Current_Scope)
10672 and then Comes_From_Source (New_E)
10674 -- We examine the formals and result type of the inherited operation,
10675 -- to determine whether their type is derived from (the instance of)
10676 -- a generic type. The first such formal or result type is the one
10679 Formal := First_Formal (Prev_E);
10681 while Present (Formal) loop
10682 F_Typ := Base_Type (Etype (Formal));
10684 if Ekind (F_Typ) = E_Anonymous_Access_Type then
10685 F_Typ := Designated_Type (F_Typ);
10688 G_Typ := Get_Generic_Parent_Type (F_Typ);
10689 exit when Present (G_Typ);
10691 Next_Formal (Formal);
10694 -- If the function dispatches on result check the result type
10696 if No (G_Typ) and then Ekind (Prev_E) = E_Function then
10697 G_Typ := Get_Generic_Parent_Type (Base_Type (Etype (Prev_E)));
10704 -- If the generic type is a private type, then the original operation
10705 -- was not overriding in the generic, because there was no primitive
10706 -- operation to override.
10708 if Nkind (Parent (G_Typ)) = N_Formal_Type_Declaration
10709 and then Nkind (Formal_Type_Definition (Parent (G_Typ))) =
10710 N_Formal_Private_Type_Definition
10714 -- The generic parent type is the ancestor of a formal derived
10715 -- type declaration. We need to check whether it has a primitive
10716 -- operation that should be overridden by New_E in the generic.
10720 P_Formal : Entity_Id;
10721 N_Formal : Entity_Id;
10724 P_Prim : Entity_Id;
10725 Prim_Elt : Elmt_Id := First_Elmt (Primitive_Operations (G_Typ));
10728 while Present (Prim_Elt) loop
10729 P_Prim := Node (Prim_Elt);
10731 if Chars (P_Prim) = Chars (New_E)
10732 and then Ekind (P_Prim) = Ekind (New_E)
10734 P_Formal := First_Formal (P_Prim);
10735 N_Formal := First_Formal (New_E);
10736 while Present (P_Formal) and then Present (N_Formal) loop
10737 P_Typ := Etype (P_Formal);
10738 N_Typ := Etype (N_Formal);
10740 if not Types_Correspond (P_Typ, N_Typ) then
10744 Next_Formal (P_Formal);
10745 Next_Formal (N_Formal);
10748 -- Found a matching primitive operation belonging to the
10749 -- formal ancestor type, so the new subprogram is
10753 and then No (N_Formal)
10754 and then (Ekind (New_E) /= E_Function
10757 (Etype (P_Prim), Etype (New_E)))
10763 Next_Elmt (Prim_Elt);
10766 -- If no match found, then the new subprogram does not override
10767 -- in the generic (nor in the instance).
10769 -- If the type in question is not abstract, and the subprogram
10770 -- is, this will be an error if the new operation is in the
10771 -- private part of the instance. Emit a warning now, which will
10772 -- make the subsequent error message easier to understand.
10774 if Present (F_Typ) and then not Is_Abstract_Type (F_Typ)
10775 and then Is_Abstract_Subprogram (Prev_E)
10776 and then In_Private_Part (Current_Scope)
10778 Error_Msg_Node_2 := F_Typ;
10780 ("private operation& in generic unit does not override "
10781 & "any primitive operation of& (RM 12.3(18))??",
10791 end Is_Non_Overriding_Operation;
10793 -------------------------------------
10794 -- List_Inherited_Pre_Post_Aspects --
10795 -------------------------------------
10797 procedure List_Inherited_Pre_Post_Aspects (E : Entity_Id) is
10799 if Opt.List_Inherited_Aspects
10800 and then Is_Subprogram_Or_Generic_Subprogram (E)
10803 Subps : constant Subprogram_List := Inherited_Subprograms (E);
10808 for Index in Subps'Range loop
10809 Items := Contract (Subps (Index));
10811 if Present (Items) then
10812 Prag := Pre_Post_Conditions (Items);
10813 while Present (Prag) loop
10814 Error_Msg_Sloc := Sloc (Prag);
10816 if Class_Present (Prag)
10817 and then not Split_PPC (Prag)
10819 if Pragma_Name (Prag) = Name_Precondition then
10821 ("info: & inherits `Pre''Class` aspect from "
10825 ("info: & inherits `Post''Class` aspect from "
10830 Prag := Next_Pragma (Prag);
10836 end List_Inherited_Pre_Post_Aspects;
10838 ------------------------------
10839 -- Make_Inequality_Operator --
10840 ------------------------------
10842 -- S is the defining identifier of an equality operator. We build a
10843 -- subprogram declaration with the right signature. This operation is
10844 -- intrinsic, because it is always expanded as the negation of the
10845 -- call to the equality function.
10847 procedure Make_Inequality_Operator (S : Entity_Id) is
10848 Loc : constant Source_Ptr := Sloc (S);
10851 Op_Name : Entity_Id;
10853 FF : constant Entity_Id := First_Formal (S);
10854 NF : constant Entity_Id := Next_Formal (FF);
10857 -- Check that equality was properly defined, ignore call if not
10864 A : constant Entity_Id :=
10865 Make_Defining_Identifier (Sloc (FF),
10866 Chars => Chars (FF));
10868 B : constant Entity_Id :=
10869 Make_Defining_Identifier (Sloc (NF),
10870 Chars => Chars (NF));
10873 Op_Name := Make_Defining_Operator_Symbol (Loc, Name_Op_Ne);
10875 Formals := New_List (
10876 Make_Parameter_Specification (Loc,
10877 Defining_Identifier => A,
10879 New_Occurrence_Of (Etype (First_Formal (S)),
10880 Sloc (Etype (First_Formal (S))))),
10882 Make_Parameter_Specification (Loc,
10883 Defining_Identifier => B,
10885 New_Occurrence_Of (Etype (Next_Formal (First_Formal (S))),
10886 Sloc (Etype (Next_Formal (First_Formal (S)))))));
10889 Make_Subprogram_Declaration (Loc,
10891 Make_Function_Specification (Loc,
10892 Defining_Unit_Name => Op_Name,
10893 Parameter_Specifications => Formals,
10894 Result_Definition =>
10895 New_Occurrence_Of (Standard_Boolean, Loc)));
10897 -- Insert inequality right after equality if it is explicit or after
10898 -- the derived type when implicit. These entities are created only
10899 -- for visibility purposes, and eventually replaced in the course
10900 -- of expansion, so they do not need to be attached to the tree and
10901 -- seen by the back-end. Keeping them internal also avoids spurious
10902 -- freezing problems. The declaration is inserted in the tree for
10903 -- analysis, and removed afterwards. If the equality operator comes
10904 -- from an explicit declaration, attach the inequality immediately
10905 -- after. Else the equality is inherited from a derived type
10906 -- declaration, so insert inequality after that declaration.
10908 if No (Alias (S)) then
10909 Insert_After (Unit_Declaration_Node (S), Decl);
10910 elsif Is_List_Member (Parent (S)) then
10911 Insert_After (Parent (S), Decl);
10913 Insert_After (Parent (Etype (First_Formal (S))), Decl);
10916 Mark_Rewrite_Insertion (Decl);
10917 Set_Is_Intrinsic_Subprogram (Op_Name);
10920 Set_Has_Completion (Op_Name);
10921 Set_Corresponding_Equality (Op_Name, S);
10922 Set_Is_Abstract_Subprogram (Op_Name, Is_Abstract_Subprogram (S));
10924 end Make_Inequality_Operator;
10926 ----------------------
10927 -- May_Need_Actuals --
10928 ----------------------
10930 procedure May_Need_Actuals (Fun : Entity_Id) is
10935 F := First_Formal (Fun);
10937 while Present (F) loop
10938 if No (Default_Value (F)) then
10946 Set_Needs_No_Actuals (Fun, B);
10947 end May_Need_Actuals;
10949 ---------------------
10950 -- Mode_Conformant --
10951 ---------------------
10953 function Mode_Conformant (New_Id, Old_Id : Entity_Id) return Boolean is
10956 Check_Conformance (New_Id, Old_Id, Mode_Conformant, False, Result);
10958 end Mode_Conformant;
10960 ---------------------------
10961 -- New_Overloaded_Entity --
10962 ---------------------------
10964 procedure New_Overloaded_Entity
10966 Derived_Type : Entity_Id := Empty)
10968 Overridden_Subp : Entity_Id := Empty;
10969 -- Set if the current scope has an operation that is type-conformant
10970 -- with S, and becomes hidden by S.
10972 Is_Primitive_Subp : Boolean;
10973 -- Set to True if the new subprogram is primitive
10976 -- Entity that S overrides
10978 procedure Check_For_Primitive_Subprogram
10979 (Is_Primitive : out Boolean;
10980 Is_Overriding : Boolean := False);
10981 -- If the subprogram being analyzed is a primitive operation of the type
10982 -- of a formal or result, set the Has_Primitive_Operations flag on the
10983 -- type, and set Is_Primitive to True (otherwise set to False). Set the
10984 -- corresponding flag on the entity itself for later use.
10986 function Has_Matching_Entry_Or_Subprogram (E : Entity_Id) return Boolean;
10987 -- True if a) E is a subprogram whose first formal is a concurrent type
10988 -- defined in the scope of E that has some entry or subprogram whose
10989 -- profile matches E, or b) E is an internally built dispatching
10990 -- subprogram of a protected type and there is a matching subprogram
10991 -- defined in the enclosing scope of the protected type, or c) E is
10992 -- an entry of a synchronized type and a matching procedure has been
10993 -- previously defined in the enclosing scope of the synchronized type.
10995 function Is_Private_Declaration (E : Entity_Id) return Boolean;
10996 -- Check that E is declared in the private part of the current package,
10997 -- or in the package body, where it may hide a previous declaration.
10998 -- We can't use In_Private_Part by itself because this flag is also
10999 -- set when freezing entities, so we must examine the place of the
11000 -- declaration in the tree, and recognize wrapper packages as well.
11002 function Is_Overriding_Alias
11003 (Old_E : Entity_Id;
11004 New_E : Entity_Id) return Boolean;
11005 -- Check whether new subprogram and old subprogram are both inherited
11006 -- from subprograms that have distinct dispatch table entries. This can
11007 -- occur with derivations from instances with accidental homonyms. The
11008 -- function is conservative given that the converse is only true within
11009 -- instances that contain accidental overloadings.
11011 procedure Report_Conflict (S : Entity_Id; E : Entity_Id);
11012 -- Report conflict between entities S and E
11014 ------------------------------------
11015 -- Check_For_Primitive_Subprogram --
11016 ------------------------------------
11018 procedure Check_For_Primitive_Subprogram
11019 (Is_Primitive : out Boolean;
11020 Is_Overriding : Boolean := False)
11022 procedure Add_Or_Replace_Untagged_Primitive (Typ : Entity_Id);
11023 -- Either add the new subprogram to the list of primitives for
11024 -- untagged type Typ, or if it overrides a primitive of Typ, then
11025 -- replace the overridden primitive in Typ's primitives list with
11026 -- the new subprogram.
11028 function Visible_Part_Type (T : Entity_Id) return Boolean;
11029 -- Returns true if T is declared in the visible part of the current
11030 -- package scope; otherwise returns false. Assumes that T is declared
11033 procedure Check_Private_Overriding (T : Entity_Id);
11034 -- Checks that if a primitive abstract subprogram of a visible
11035 -- abstract type is declared in a private part, then it must override
11036 -- an abstract subprogram declared in the visible part. Also checks
11037 -- that if a primitive function with a controlling result is declared
11038 -- in a private part, then it must override a function declared in
11039 -- the visible part.
11041 ---------------------------------------
11042 -- Add_Or_Replace_Untagged_Primitive --
11043 ---------------------------------------
11045 procedure Add_Or_Replace_Untagged_Primitive (Typ : Entity_Id) is
11046 Replaced_Overridden_Subp : Boolean := False;
11049 pragma Assert (not Is_Tagged_Type (Typ));
11051 -- Anonymous access types don't have a primitives list. Normally
11052 -- such types wouldn't make it here, but the case of anonymous
11053 -- access-to-subprogram types can.
11055 if not Is_Anonymous_Access_Type (Typ) then
11057 -- If S overrides a subprogram that's a primitive of
11058 -- the formal's type, then replace the overridden
11059 -- subprogram with the new subprogram in the type's
11060 -- list of primitives.
11062 if Is_Overriding then
11063 pragma Assert (Present (Overridden_Subp)
11064 and then Overridden_Subp = E); -- Added for now
11067 Prim_Ops : constant Elist_Id :=
11068 Primitive_Operations (Typ);
11071 if Present (Prim_Ops) then
11072 Elmt := First_Elmt (Prim_Ops);
11074 while Present (Elmt)
11075 and then Node (Elmt) /= Overridden_Subp
11080 if Present (Elmt) then
11081 Replace_Elmt (Elmt, S);
11082 Replaced_Overridden_Subp := True;
11088 -- If the new subprogram did not override an operation
11089 -- of the formal's type, then add it to the primitives
11090 -- list of the type.
11092 if not Replaced_Overridden_Subp then
11093 Append_Unique_Elmt (S, Primitive_Operations (Typ));
11096 end Add_Or_Replace_Untagged_Primitive;
11098 ------------------------------
11099 -- Check_Private_Overriding --
11100 ------------------------------
11102 procedure Check_Private_Overriding (T : Entity_Id) is
11103 function Overrides_Private_Part_Op return Boolean;
11104 -- This detects the special case where the overriding subprogram
11105 -- is overriding a subprogram that was declared in the same
11106 -- private part. That case is illegal by 3.9.3(10).
11108 function Overrides_Visible_Function
11109 (Partial_View : Entity_Id) return Boolean;
11110 -- True if S overrides a function in the visible part. The
11111 -- overridden function could be explicitly or implicitly declared.
11113 -------------------------------
11114 -- Overrides_Private_Part_Op --
11115 -------------------------------
11117 function Overrides_Private_Part_Op return Boolean is
11118 Over_Decl : constant Node_Id :=
11119 Unit_Declaration_Node (Overridden_Operation (S));
11120 Subp_Decl : constant Node_Id := Unit_Declaration_Node (S);
11123 pragma Assert (Is_Overriding);
11125 (Nkind (Over_Decl) = N_Abstract_Subprogram_Declaration);
11127 (Nkind (Subp_Decl) = N_Abstract_Subprogram_Declaration);
11129 return In_Same_List (Over_Decl, Subp_Decl);
11130 end Overrides_Private_Part_Op;
11132 --------------------------------
11133 -- Overrides_Visible_Function --
11134 --------------------------------
11136 function Overrides_Visible_Function
11137 (Partial_View : Entity_Id) return Boolean
11140 if not Is_Overriding or else not Has_Homonym (S) then
11144 if not Present (Partial_View) then
11148 -- Search through all the homonyms H of S in the current
11149 -- package spec, and return True if we find one that matches.
11150 -- Note that Parent (H) will be the declaration of the
11151 -- partial view of T for a match.
11154 H : Entity_Id := S;
11158 exit when not Present (H) or else Scope (H) /= Scope (S);
11160 if Nkind (Parent (H)) in
11161 N_Private_Extension_Declaration |
11162 N_Private_Type_Declaration
11163 and then Defining_Identifier (Parent (H)) = Partial_View
11171 end Overrides_Visible_Function;
11173 -- Start of processing for Check_Private_Overriding
11176 if Is_Package_Or_Generic_Package (Current_Scope)
11177 and then In_Private_Part (Current_Scope)
11178 and then Visible_Part_Type (T)
11179 and then not In_Instance
11181 if Is_Abstract_Type (T)
11182 and then Is_Abstract_Subprogram (S)
11183 and then (not Is_Overriding
11184 or else not Is_Abstract_Subprogram (E)
11185 or else Overrides_Private_Part_Op)
11188 ("abstract subprograms must be visible (RM 3.9.3(10))!",
11191 elsif Ekind (S) = E_Function then
11193 Partial_View : constant Entity_Id :=
11194 Incomplete_Or_Partial_View (T);
11197 if not Overrides_Visible_Function (Partial_View) then
11199 -- Here, S is "function ... return T;" declared in
11200 -- the private part, not overriding some visible
11201 -- operation. That's illegal in the tagged case
11202 -- (but not if the private type is untagged).
11204 if ((Present (Partial_View)
11205 and then Is_Tagged_Type (Partial_View))
11206 or else (not Present (Partial_View)
11207 and then Is_Tagged_Type (T)))
11208 and then T = Base_Type (Etype (S))
11211 ("private function with tagged result must"
11212 & " override visible-part function", S);
11214 ("\move subprogram to the visible part"
11215 & " (RM 3.9.3(10))", S);
11217 -- Ada 2012 (AI05-0073): Extend this check to the case
11218 -- of a function whose result subtype is defined by an
11219 -- access_definition designating specific tagged type.
11221 elsif Ekind (Etype (S)) = E_Anonymous_Access_Type
11222 and then Is_Tagged_Type (Designated_Type (Etype (S)))
11224 not Is_Class_Wide_Type
11225 (Designated_Type (Etype (S)))
11226 and then Ada_Version >= Ada_2012
11229 ("private function with controlling access "
11230 & "result must override visible-part function",
11233 ("\move subprogram to the visible part"
11234 & " (RM 3.9.3(10))", S);
11240 end Check_Private_Overriding;
11242 -----------------------
11243 -- Visible_Part_Type --
11244 -----------------------
11246 function Visible_Part_Type (T : Entity_Id) return Boolean is
11247 P : constant Node_Id := Unit_Declaration_Node (Scope (T));
11250 -- If the entity is a private type, then it must be declared in a
11253 if Is_Private_Type (T) then
11256 elsif Is_Type (T) and then Has_Private_Declaration (T) then
11259 elsif Is_List_Member (Declaration_Node (T))
11260 and then List_Containing (Declaration_Node (T)) =
11261 Visible_Declarations (Specification (P))
11268 end Visible_Part_Type;
11272 Formal : Entity_Id;
11276 -- Start of processing for Check_For_Primitive_Subprogram
11279 Is_Primitive := False;
11281 if not Comes_From_Source (S) then
11283 -- Add an inherited primitive for an untagged derived type to
11284 -- Derived_Type's list of primitives. Tagged primitives are dealt
11285 -- with in Check_Dispatching_Operation.
11287 if Present (Derived_Type)
11288 and then Extensions_Allowed
11289 and then not Is_Tagged_Type (Derived_Type)
11291 Append_Unique_Elmt (S, Primitive_Operations (Derived_Type));
11294 -- If subprogram is at library level, it is not primitive operation
11296 elsif Current_Scope = Standard_Standard then
11299 elsif (Is_Package_Or_Generic_Package (Current_Scope)
11300 and then not In_Package_Body (Current_Scope))
11301 or else Is_Overriding
11303 -- For function, check return type
11305 if Ekind (S) = E_Function then
11306 if Ekind (Etype (S)) = E_Anonymous_Access_Type then
11307 F_Typ := Designated_Type (Etype (S));
11309 F_Typ := Etype (S);
11312 B_Typ := Base_Type (F_Typ);
11314 if Scope (B_Typ) = Current_Scope
11315 and then not Is_Class_Wide_Type (B_Typ)
11316 and then not Is_Generic_Type (B_Typ)
11318 Is_Primitive := True;
11319 Set_Has_Primitive_Operations (B_Typ);
11320 Set_Is_Primitive (S);
11322 -- Add a primitive for an untagged type to B_Typ's list
11323 -- of primitives. Tagged primitives are dealt with in
11324 -- Check_Dispatching_Operation.
11326 if Extensions_Allowed
11327 and then not Is_Tagged_Type (B_Typ)
11329 Add_Or_Replace_Untagged_Primitive (B_Typ);
11332 Check_Private_Overriding (B_Typ);
11333 -- The Ghost policy in effect at the point of declaration
11334 -- or a tagged type and a primitive operation must match
11335 -- (SPARK RM 6.9(16)).
11337 Check_Ghost_Primitive (S, B_Typ);
11341 -- For all subprograms, check formals
11343 Formal := First_Formal (S);
11344 while Present (Formal) loop
11345 if Ekind (Etype (Formal)) = E_Anonymous_Access_Type then
11346 F_Typ := Designated_Type (Etype (Formal));
11348 F_Typ := Etype (Formal);
11351 B_Typ := Base_Type (F_Typ);
11353 if Ekind (B_Typ) = E_Access_Subtype then
11354 B_Typ := Base_Type (B_Typ);
11357 if Scope (B_Typ) = Current_Scope
11358 and then not Is_Class_Wide_Type (B_Typ)
11359 and then not Is_Generic_Type (B_Typ)
11361 Is_Primitive := True;
11362 Set_Is_Primitive (S);
11363 Set_Has_Primitive_Operations (B_Typ);
11365 -- Add a primitive for an untagged type to B_Typ's list
11366 -- of primitives. Tagged primitives are dealt with in
11367 -- Check_Dispatching_Operation.
11369 if Extensions_Allowed
11370 and then not Is_Tagged_Type (B_Typ)
11372 Add_Or_Replace_Untagged_Primitive (B_Typ);
11375 Check_Private_Overriding (B_Typ);
11377 -- The Ghost policy in effect at the point of declaration
11378 -- of a tagged type and a primitive operation must match
11379 -- (SPARK RM 6.9(16)).
11381 Check_Ghost_Primitive (S, B_Typ);
11384 Next_Formal (Formal);
11387 -- Special case: An equality function can be redefined for a type
11388 -- occurring in a declarative part, and won't otherwise be treated as
11389 -- a primitive because it doesn't occur in a package spec and doesn't
11390 -- override an inherited subprogram. It's important that we mark it
11391 -- primitive so it can be returned by Collect_Primitive_Operations
11392 -- and be used in composing the equality operation of later types
11393 -- that have a component of the type.
11395 elsif Chars (S) = Name_Op_Eq
11396 and then Etype (S) = Standard_Boolean
11398 B_Typ := Base_Type (Etype (First_Formal (S)));
11400 if Scope (B_Typ) = Current_Scope
11402 Base_Type (Etype (Next_Formal (First_Formal (S)))) = B_Typ
11403 and then not Is_Limited_Type (B_Typ)
11405 Is_Primitive := True;
11406 Set_Is_Primitive (S);
11407 Set_Has_Primitive_Operations (B_Typ);
11408 Check_Private_Overriding (B_Typ);
11410 -- The Ghost policy in effect at the point of declaration of a
11411 -- tagged type and a primitive operation must match
11412 -- (SPARK RM 6.9(16)).
11414 Check_Ghost_Primitive (S, B_Typ);
11417 end Check_For_Primitive_Subprogram;
11419 --------------------------------------
11420 -- Has_Matching_Entry_Or_Subprogram --
11421 --------------------------------------
11423 function Has_Matching_Entry_Or_Subprogram
11424 (E : Entity_Id) return Boolean
11426 function Check_Conforming_Parameters
11427 (E1_Param : Node_Id;
11428 E2_Param : Node_Id;
11429 Ctype : Conformance_Type) return Boolean;
11430 -- Starting from the given parameters, check that all the parameters
11431 -- of two entries or subprograms are conformant. Used to skip
11432 -- the check on the controlling argument.
11434 function Matching_Entry_Or_Subprogram
11435 (Conc_Typ : Entity_Id;
11436 Subp : Entity_Id) return Entity_Id;
11437 -- Return the first entry or subprogram of the given concurrent type
11438 -- whose name matches the name of Subp and has a profile conformant
11439 -- with Subp; return Empty if not found.
11441 function Matching_Dispatching_Subprogram
11442 (Conc_Typ : Entity_Id;
11443 Ent : Entity_Id) return Entity_Id;
11444 -- Return the first dispatching primitive of Conc_Type defined in the
11445 -- enclosing scope of Conc_Type (i.e. before the full definition of
11446 -- this concurrent type) whose name matches the entry Ent and has a
11447 -- profile conformant with the profile of the corresponding (not yet
11448 -- built) dispatching primitive of Ent; return Empty if not found.
11450 function Matching_Original_Protected_Subprogram
11451 (Prot_Typ : Entity_Id;
11452 Subp : Entity_Id) return Entity_Id;
11453 -- Return the first subprogram defined in the enclosing scope of
11454 -- Prot_Typ (before the full definition of this protected type)
11455 -- whose name matches the original name of Subp and has a profile
11456 -- conformant with the profile of Subp; return Empty if not found.
11458 function Normalized_First_Parameter_Type
11459 (E : Entity_Id) return Entity_Id;
11460 -- Return the type of the first parameter unless that type
11461 -- is an anonymous access type, in which case return the
11462 -- designated type. Used to treat anonymous-access-to-synchronized
11463 -- the same as synchronized for purposes of checking for
11464 -- prefixed view profile conflicts.
11466 ---------------------------------
11467 -- Check_Conforming_Parameters --
11468 ---------------------------------
11470 function Check_Conforming_Parameters
11471 (E1_Param : Node_Id;
11472 E2_Param : Node_Id;
11473 Ctype : Conformance_Type) return Boolean
11475 Param_E1 : Node_Id := E1_Param;
11476 Param_E2 : Node_Id := E2_Param;
11479 while Present (Param_E1) and then Present (Param_E2) loop
11480 if (Ctype >= Mode_Conformant) and then
11481 Ekind (Defining_Identifier (Param_E1)) /=
11482 Ekind (Defining_Identifier (Param_E2))
11487 (Find_Parameter_Type (Param_E1),
11488 Find_Parameter_Type (Param_E2),
11498 -- The candidate is not valid if one of the two lists contains
11499 -- more parameters than the other
11501 return No (Param_E1) and then No (Param_E2);
11502 end Check_Conforming_Parameters;
11504 ----------------------------------
11505 -- Matching_Entry_Or_Subprogram --
11506 ----------------------------------
11508 function Matching_Entry_Or_Subprogram
11509 (Conc_Typ : Entity_Id;
11510 Subp : Entity_Id) return Entity_Id
11515 E := First_Entity (Conc_Typ);
11516 while Present (E) loop
11517 if Chars (Subp) = Chars (E)
11518 and then (Ekind (E) = E_Entry or else Is_Subprogram (E))
11520 Check_Conforming_Parameters
11521 (First (Parameter_Specifications (Parent (E))),
11522 Next (First (Parameter_Specifications (Parent (Subp)))),
11532 end Matching_Entry_Or_Subprogram;
11534 -------------------------------------
11535 -- Matching_Dispatching_Subprogram --
11536 -------------------------------------
11538 function Matching_Dispatching_Subprogram
11539 (Conc_Typ : Entity_Id;
11540 Ent : Entity_Id) return Entity_Id
11545 -- Search for entities in the enclosing scope of this synchonized
11548 pragma Assert (Is_Concurrent_Type (Conc_Typ));
11549 Push_Scope (Scope (Conc_Typ));
11550 E := Current_Entity_In_Scope (Ent);
11553 while Present (E) loop
11554 if Scope (E) = Scope (Conc_Typ)
11555 and then Comes_From_Source (E)
11556 and then Ekind (E) = E_Procedure
11557 and then Present (First_Entity (E))
11558 and then Is_Controlling_Formal (First_Entity (E))
11559 and then Etype (First_Entity (E)) = Conc_Typ
11561 Check_Conforming_Parameters
11562 (First (Parameter_Specifications (Parent (Ent))),
11563 Next (First (Parameter_Specifications (Parent (E)))),
11564 Subtype_Conformant)
11573 end Matching_Dispatching_Subprogram;
11575 --------------------------------------------
11576 -- Matching_Original_Protected_Subprogram --
11577 --------------------------------------------
11579 function Matching_Original_Protected_Subprogram
11580 (Prot_Typ : Entity_Id;
11581 Subp : Entity_Id) return Entity_Id
11583 ICF : constant Boolean :=
11584 Is_Controlling_Formal (First_Entity (Subp));
11588 -- Temporarily decorate the first parameter of Subp as controlling
11589 -- formal, required to invoke Subtype_Conformant.
11591 Set_Is_Controlling_Formal (First_Entity (Subp));
11594 Current_Entity_In_Scope (Original_Protected_Subprogram (Subp));
11596 while Present (E) loop
11597 if Scope (E) = Scope (Prot_Typ)
11598 and then Comes_From_Source (E)
11599 and then Ekind (Subp) = Ekind (E)
11600 and then Present (First_Entity (E))
11601 and then Is_Controlling_Formal (First_Entity (E))
11602 and then Etype (First_Entity (E)) = Prot_Typ
11603 and then Subtype_Conformant (Subp, E,
11604 Skip_Controlling_Formals => True)
11606 Set_Is_Controlling_Formal (First_Entity (Subp), ICF);
11613 Set_Is_Controlling_Formal (First_Entity (Subp), ICF);
11616 end Matching_Original_Protected_Subprogram;
11618 -------------------------------------
11619 -- Normalized_First_Parameter_Type --
11620 -------------------------------------
11622 function Normalized_First_Parameter_Type
11623 (E : Entity_Id) return Entity_Id
11625 Result : Entity_Id := Etype (First_Entity (E));
11627 if Ekind (Result) = E_Anonymous_Access_Type then
11628 Result := Designated_Type (Result);
11631 end Normalized_First_Parameter_Type;
11633 -- Start of processing for Has_Matching_Entry_Or_Subprogram
11636 -- Case 1: E is a subprogram whose first formal is a concurrent type
11637 -- defined in the scope of E that has an entry or subprogram whose
11638 -- profile matches E.
11640 if Comes_From_Source (E)
11641 and then Is_Subprogram (E)
11642 and then Present (First_Entity (E))
11643 and then Is_Concurrent_Record_Type
11644 (Normalized_First_Parameter_Type (E))
11647 Scope (Corresponding_Concurrent_Type
11648 (Normalized_First_Parameter_Type (E)))
11651 (Matching_Entry_Or_Subprogram
11652 (Corresponding_Concurrent_Type
11653 (Normalized_First_Parameter_Type (E)),
11656 Report_Conflict (E,
11657 Matching_Entry_Or_Subprogram
11658 (Corresponding_Concurrent_Type
11659 (Normalized_First_Parameter_Type (E)),
11664 -- Case 2: E is an internally built dispatching subprogram of a
11665 -- protected type and there is a subprogram defined in the enclosing
11666 -- scope of the protected type that has the original name of E and
11667 -- its profile is conformant with the profile of E. We check the
11668 -- name of the original protected subprogram associated with E since
11669 -- the expander builds dispatching primitives of protected functions
11670 -- and procedures with other names (see Exp_Ch9.Build_Selected_Name).
11672 elsif not Comes_From_Source (E)
11673 and then Is_Subprogram (E)
11674 and then Present (First_Entity (E))
11675 and then Is_Concurrent_Record_Type (Etype (First_Entity (E)))
11676 and then Present (Original_Protected_Subprogram (E))
11679 (Matching_Original_Protected_Subprogram
11680 (Corresponding_Concurrent_Type (Etype (First_Entity (E))),
11683 Report_Conflict (E,
11684 Matching_Original_Protected_Subprogram
11685 (Corresponding_Concurrent_Type (Etype (First_Entity (E))),
11689 -- Case 3: E is an entry of a synchronized type and a matching
11690 -- procedure has been previously defined in the enclosing scope
11691 -- of the synchronized type.
11693 elsif Comes_From_Source (E)
11694 and then Ekind (E) = E_Entry
11696 Present (Matching_Dispatching_Subprogram (Current_Scope, E))
11698 Report_Conflict (E,
11699 Matching_Dispatching_Subprogram (Current_Scope, E));
11704 end Has_Matching_Entry_Or_Subprogram;
11706 ----------------------------
11707 -- Is_Private_Declaration --
11708 ----------------------------
11710 function Is_Private_Declaration (E : Entity_Id) return Boolean is
11711 Decl : constant Node_Id := Unit_Declaration_Node (E);
11712 Priv_Decls : List_Id;
11715 if Is_Package_Or_Generic_Package (Current_Scope)
11716 and then In_Private_Part (Current_Scope)
11719 Private_Declarations (Package_Specification (Current_Scope));
11721 return In_Package_Body (Current_Scope)
11723 (Is_List_Member (Decl)
11724 and then List_Containing (Decl) = Priv_Decls)
11725 or else (Nkind (Parent (Decl)) = N_Package_Specification
11727 Is_Compilation_Unit
11728 (Defining_Entity (Parent (Decl)))
11729 and then List_Containing (Parent (Parent (Decl))) =
11734 end Is_Private_Declaration;
11736 --------------------------
11737 -- Is_Overriding_Alias --
11738 --------------------------
11740 function Is_Overriding_Alias
11741 (Old_E : Entity_Id;
11742 New_E : Entity_Id) return Boolean
11744 AO : constant Entity_Id := Alias (Old_E);
11745 AN : constant Entity_Id := Alias (New_E);
11748 return Scope (AO) /= Scope (AN)
11749 or else No (DTC_Entity (AO))
11750 or else No (DTC_Entity (AN))
11751 or else DT_Position (AO) = DT_Position (AN);
11752 end Is_Overriding_Alias;
11754 ---------------------
11755 -- Report_Conflict --
11756 ---------------------
11758 procedure Report_Conflict (S : Entity_Id; E : Entity_Id) is
11760 Error_Msg_Sloc := Sloc (E);
11762 -- Generate message, with useful additional warning if in generic
11764 if Is_Generic_Unit (E) then
11765 Error_Msg_N ("previous generic unit cannot be overloaded", S);
11766 Error_Msg_N ("\& conflicts with declaration#", S);
11768 Error_Msg_N ("& conflicts with declaration#", S);
11770 end Report_Conflict;
11772 -- Start of processing for New_Overloaded_Entity
11775 -- We need to look for an entity that S may override. This must be a
11776 -- homonym in the current scope, so we look for the first homonym of
11777 -- S in the current scope as the starting point for the search.
11779 E := Current_Entity_In_Scope (S);
11781 -- Ada 2005 (AI-251): Derivation of abstract interface primitives.
11782 -- They are directly added to the list of primitive operations of
11783 -- Derived_Type, unless this is a rederivation in the private part
11784 -- of an operation that was already derived in the visible part of
11785 -- the current package.
11787 if Ada_Version >= Ada_2005
11788 and then Present (Derived_Type)
11789 and then Present (Alias (S))
11790 and then Is_Dispatching_Operation (Alias (S))
11791 and then Present (Find_Dispatching_Type (Alias (S)))
11792 and then Is_Interface (Find_Dispatching_Type (Alias (S)))
11794 -- For private types, when the full-view is processed we propagate to
11795 -- the full view the non-overridden entities whose attribute "alias"
11796 -- references an interface primitive. These entities were added by
11797 -- Derive_Subprograms to ensure that interface primitives are
11800 -- Inside_Freeze_Actions is non zero when S corresponds with an
11801 -- internal entity that links an interface primitive with its
11802 -- covering primitive through attribute Interface_Alias (see
11803 -- Add_Internal_Interface_Entities).
11805 if Inside_Freezing_Actions = 0
11806 and then Is_Package_Or_Generic_Package (Current_Scope)
11807 and then In_Private_Part (Current_Scope)
11808 and then Parent_Kind (E) = N_Private_Extension_Declaration
11809 and then Nkind (Parent (S)) = N_Full_Type_Declaration
11810 and then Full_View (Defining_Identifier (Parent (E)))
11811 = Defining_Identifier (Parent (S))
11812 and then Alias (E) = Alias (S)
11814 Check_Operation_From_Private_View (S, E);
11815 Set_Is_Dispatching_Operation (S);
11820 Enter_Overloaded_Entity (S);
11821 Check_Dispatching_Operation (S, Empty);
11822 Check_For_Primitive_Subprogram (Is_Primitive_Subp);
11828 -- For synchronized types check conflicts of this entity with previously
11829 -- defined entities.
11831 if Ada_Version >= Ada_2005
11832 and then Has_Matching_Entry_Or_Subprogram (S)
11837 -- If there is no homonym then this is definitely not overriding
11840 Enter_Overloaded_Entity (S);
11841 Check_Dispatching_Operation (S, Empty);
11842 Check_For_Primitive_Subprogram (Is_Primitive_Subp);
11844 -- If subprogram has an explicit declaration, check whether it has an
11845 -- overriding indicator.
11847 if Comes_From_Source (S) then
11848 Check_Synchronized_Overriding (S, Overridden_Subp);
11850 -- (Ada 2012: AI05-0125-1): If S is a dispatching operation then
11851 -- it may have overridden some hidden inherited primitive. Update
11852 -- Overridden_Subp to avoid spurious errors when checking the
11853 -- overriding indicator.
11855 if Ada_Version >= Ada_2012
11856 and then No (Overridden_Subp)
11857 and then Is_Dispatching_Operation (S)
11858 and then Present (Overridden_Operation (S))
11860 Overridden_Subp := Overridden_Operation (S);
11863 Check_Overriding_Indicator
11864 (S, Overridden_Subp, Is_Primitive => Is_Primitive_Subp);
11866 -- The Ghost policy in effect at the point of declaration of a
11867 -- parent subprogram and an overriding subprogram must match
11868 -- (SPARK RM 6.9(17)).
11870 Check_Ghost_Overriding (S, Overridden_Subp);
11873 -- If there is a homonym that is not overloadable, then we have an
11874 -- error, except for the special cases checked explicitly below.
11876 elsif not Is_Overloadable (E) then
11878 -- Check for spurious conflict produced by a subprogram that has the
11879 -- same name as that of the enclosing generic package. The conflict
11880 -- occurs within an instance, between the subprogram and the renaming
11881 -- declaration for the package. After the subprogram, the package
11882 -- renaming declaration becomes hidden.
11884 if Ekind (E) = E_Package
11885 and then Present (Renamed_Object (E))
11886 and then Renamed_Object (E) = Current_Scope
11887 and then Nkind (Parent (Renamed_Object (E))) =
11888 N_Package_Specification
11889 and then Present (Generic_Parent (Parent (Renamed_Object (E))))
11892 Set_Is_Immediately_Visible (E, False);
11893 Enter_Overloaded_Entity (S);
11894 Set_Homonym (S, Homonym (E));
11895 Check_Dispatching_Operation (S, Empty);
11896 Check_Overriding_Indicator (S, Empty, Is_Primitive => False);
11898 -- If the subprogram is implicit it is hidden by the previous
11899 -- declaration. However if it is dispatching, it must appear in the
11900 -- dispatch table anyway, because it can be dispatched to even if it
11901 -- cannot be called directly.
11903 elsif Present (Alias (S)) and then not Comes_From_Source (S) then
11904 Set_Scope (S, Current_Scope);
11906 if Is_Dispatching_Operation (Alias (S)) then
11907 Check_Dispatching_Operation (S, Empty);
11913 Report_Conflict (S, E);
11917 -- E exists and is overloadable
11920 Check_Synchronized_Overriding (S, Overridden_Subp);
11922 -- Loop through E and its homonyms to determine if any of them is
11923 -- the candidate for overriding by S.
11925 while Present (E) loop
11927 -- Definitely not interesting if not in the current scope
11929 if Scope (E) /= Current_Scope then
11932 -- A function can overload the name of an abstract state. The
11933 -- state can be viewed as a function with a profile that cannot
11934 -- be matched by anything.
11936 elsif Ekind (S) = E_Function
11937 and then Ekind (E) = E_Abstract_State
11939 Enter_Overloaded_Entity (S);
11942 -- Ada 2012 (AI05-0165): For internally generated bodies of null
11943 -- procedures locate the internally generated spec. We enforce
11944 -- mode conformance since a tagged type may inherit from
11945 -- interfaces several null primitives which differ only in
11946 -- the mode of the formals.
11948 elsif not Comes_From_Source (S)
11949 and then Is_Null_Procedure (S)
11950 and then not Mode_Conformant (E, S)
11954 -- Check if we have type conformance
11956 elsif Type_Conformant (E, S) then
11958 -- If the old and new entities have the same profile and one
11959 -- is not the body of the other, then this is an error, unless
11960 -- one of them is implicitly declared.
11962 -- There are some cases when both can be implicit, for example
11963 -- when both a literal and a function that overrides it are
11964 -- inherited in a derivation, or when an inherited operation
11965 -- of a tagged full type overrides the inherited operation of
11966 -- a private extension. Ada 83 had a special rule for the
11967 -- literal case. In Ada 95, the later implicit operation hides
11968 -- the former, and the literal is always the former. In the
11969 -- odd case where both are derived operations declared at the
11970 -- same point, both operations should be declared, and in that
11971 -- case we bypass the following test and proceed to the next
11972 -- part. This can only occur for certain obscure cases in
11973 -- instances, when an operation on a type derived from a formal
11974 -- private type does not override a homograph inherited from
11975 -- the actual. In subsequent derivations of such a type, the
11976 -- DT positions of these operations remain distinct, if they
11979 if Present (Alias (S))
11980 and then (No (Alias (E))
11981 or else Comes_From_Source (E)
11982 or else Is_Abstract_Subprogram (S)
11984 (Is_Dispatching_Operation (E)
11985 and then Is_Overriding_Alias (E, S)))
11986 and then Ekind (E) /= E_Enumeration_Literal
11988 -- When an derived operation is overloaded it may be due to
11989 -- the fact that the full view of a private extension
11990 -- re-inherits. It has to be dealt with.
11992 if Is_Package_Or_Generic_Package (Current_Scope)
11993 and then In_Private_Part (Current_Scope)
11995 Check_Operation_From_Private_View (S, E);
11998 -- In any case the implicit operation remains hidden by the
11999 -- existing declaration, which is overriding. Indicate that
12000 -- E overrides the operation from which S is inherited.
12002 if Present (Alias (S)) then
12003 Set_Overridden_Operation (E, Alias (S));
12004 Inherit_Subprogram_Contract (E, Alias (S));
12005 Set_Is_Ada_2022_Only (E,
12006 Is_Ada_2022_Only (Alias (S)));
12009 Set_Overridden_Operation (E, S);
12010 Inherit_Subprogram_Contract (E, S);
12011 Set_Is_Ada_2022_Only (E, Is_Ada_2022_Only (S));
12014 -- When a dispatching operation overrides an inherited
12015 -- subprogram, it shall be subtype conformant with the
12016 -- inherited subprogram (RM 3.9.2 (10.2)).
12018 if Comes_From_Source (E)
12019 and then Is_Dispatching_Operation (E)
12020 and then Find_Dispatching_Type (S)
12021 = Find_Dispatching_Type (E)
12023 Check_Subtype_Conformant (E, S);
12026 if Comes_From_Source (E) then
12027 Check_Overriding_Indicator (E, S, Is_Primitive => False);
12029 -- The Ghost policy in effect at the point of declaration
12030 -- of a parent subprogram and an overriding subprogram
12031 -- must match (SPARK RM 6.9(17)).
12033 Check_Ghost_Overriding (E, S);
12038 -- Within an instance, the renaming declarations for actual
12039 -- subprograms may become ambiguous, but they do not hide each
12042 elsif Ekind (E) /= E_Entry
12043 and then not Comes_From_Source (E)
12044 and then not Is_Generic_Instance (E)
12045 and then (Present (Alias (E))
12046 or else Is_Intrinsic_Subprogram (E))
12047 and then (not In_Instance
12048 or else No (Parent (E))
12049 or else Nkind (Unit_Declaration_Node (E)) /=
12050 N_Subprogram_Renaming_Declaration)
12052 -- A subprogram child unit is not allowed to override an
12053 -- inherited subprogram (10.1.1(20)).
12055 if Is_Child_Unit (S) then
12057 ("child unit overrides inherited subprogram in parent",
12062 if Is_Non_Overriding_Operation (E, S) then
12063 Enter_Overloaded_Entity (S);
12065 if No (Derived_Type)
12066 or else Is_Tagged_Type (Derived_Type)
12068 Check_Dispatching_Operation (S, Empty);
12074 -- E is a derived operation or an internal operator which
12075 -- is being overridden. Remove E from further visibility.
12076 -- Furthermore, if E is a dispatching operation, it must be
12077 -- replaced in the list of primitive operations of its type
12078 -- (see Override_Dispatching_Operation).
12080 Overridden_Subp := E;
12082 -- It is possible for E to be in the current scope and
12083 -- yet not in the entity chain. This can only occur in a
12084 -- generic context where E is an implicit concatenation
12085 -- in the formal part, because in a generic body the
12086 -- entity chain starts with the formals.
12088 -- In GNATprove mode, a wrapper for an operation with
12089 -- axiomatization may be a homonym of another declaration
12090 -- for an actual subprogram (needs refinement ???).
12092 if No (Prev_Entity (E)) then
12094 and then GNATprove_Mode
12096 Nkind (Original_Node (Unit_Declaration_Node (S))) =
12097 N_Subprogram_Renaming_Declaration
12101 pragma Assert (Chars (E) = Name_Op_Concat);
12106 -- E must be removed both from the entity_list of the
12107 -- current scope, and from the visibility chain.
12109 if Debug_Flag_E then
12110 Write_Str ("Override implicit operation ");
12111 Write_Int (Int (E));
12115 -- If E is a predefined concatenation, it stands for four
12116 -- different operations. As a result, a single explicit
12117 -- declaration does not hide it. In a possible ambiguous
12118 -- situation, Disambiguate chooses the user-defined op,
12119 -- so it is correct to retain the previous internal one.
12121 if Chars (E) /= Name_Op_Concat
12122 or else Ekind (E) /= E_Operator
12124 -- For nondispatching derived operations that are
12125 -- overridden by a subprogram declared in the private
12126 -- part of a package, we retain the derived subprogram
12127 -- but mark it as not immediately visible. If the
12128 -- derived operation was declared in the visible part
12129 -- then this ensures that it will still be visible
12130 -- outside the package with the proper signature
12131 -- (calls from outside must also be directed to this
12132 -- version rather than the overriding one, unlike the
12133 -- dispatching case). Calls from inside the package
12134 -- will still resolve to the overriding subprogram
12135 -- since the derived one is marked as not visible
12136 -- within the package.
12138 -- If the private operation is dispatching, we achieve
12139 -- the overriding by keeping the implicit operation
12140 -- but setting its alias to be the overriding one. In
12141 -- this fashion the proper body is executed in all
12142 -- cases, but the original signature is used outside
12145 -- If the overriding is not in the private part, we
12146 -- remove the implicit operation altogether.
12148 if Is_Private_Declaration (S) then
12149 if not Is_Dispatching_Operation (E) then
12150 Set_Is_Immediately_Visible (E, False);
12152 -- Work done in Override_Dispatching_Operation, so
12153 -- nothing else needs to be done here.
12159 Remove_Entity_And_Homonym (E);
12163 Enter_Overloaded_Entity (S);
12165 -- For entities generated by Derive_Subprograms the
12166 -- overridden operation is the inherited primitive
12167 -- (which is available through the attribute alias).
12169 if not (Comes_From_Source (E))
12170 and then Is_Dispatching_Operation (E)
12171 and then Find_Dispatching_Type (E) =
12172 Find_Dispatching_Type (S)
12173 and then Present (Alias (E))
12174 and then Comes_From_Source (Alias (E))
12176 Set_Overridden_Operation (S, Alias (E));
12177 Inherit_Subprogram_Contract (S, Alias (E));
12178 Set_Is_Ada_2022_Only (S,
12179 Is_Ada_2022_Only (Alias (E)));
12181 -- Normal case of setting entity as overridden
12183 -- Note: Static_Initialization and Overridden_Operation
12184 -- attributes use the same field in subprogram entities.
12185 -- Static_Initialization is only defined for internal
12186 -- initialization procedures, where Overridden_Operation
12187 -- is irrelevant. Therefore the setting of this attribute
12188 -- must check whether the target is an init_proc.
12190 elsif not Is_Init_Proc (S) then
12192 -- LSP wrappers must override the ultimate alias of their
12193 -- wrapped dispatching primitive E; required to traverse
12194 -- the chain of ancestor primitives (c.f. Map_Primitives)
12195 -- They don't inherit contracts.
12198 and then Present (LSP_Subprogram (S))
12200 Set_Overridden_Operation (S, Ultimate_Alias (E));
12202 Set_Overridden_Operation (S, E);
12203 Inherit_Subprogram_Contract (S, E);
12206 Set_Is_Ada_2022_Only (S, Is_Ada_2022_Only (E));
12209 Check_Overriding_Indicator (S, E, Is_Primitive => True);
12211 -- The Ghost policy in effect at the point of declaration
12212 -- of a parent subprogram and an overriding subprogram
12213 -- must match (SPARK RM 6.9(17)).
12215 Check_Ghost_Overriding (S, E);
12217 -- If S is a user-defined subprogram or a null procedure
12218 -- expanded to override an inherited null procedure, or a
12219 -- predefined dispatching primitive then indicate that E
12220 -- overrides the operation from which S is inherited.
12222 if Comes_From_Source (S)
12224 (Present (Parent (S))
12225 and then Nkind (Parent (S)) = N_Procedure_Specification
12226 and then Null_Present (Parent (S)))
12228 (Present (Alias (E))
12230 Is_Predefined_Dispatching_Operation (Alias (E)))
12232 if Present (Alias (E)) then
12234 -- LSP wrappers must override the ultimate alias of
12235 -- their wrapped dispatching primitive E; required to
12236 -- traverse the chain of ancestor primitives (see
12237 -- Map_Primitives). They don't inherit contracts.
12240 and then Present (LSP_Subprogram (S))
12242 Set_Overridden_Operation (S, Ultimate_Alias (E));
12244 Set_Overridden_Operation (S, Alias (E));
12245 Inherit_Subprogram_Contract (S, Alias (E));
12248 Set_Is_Ada_2022_Only (S, Is_Ada_2022_Only (Alias (E)));
12252 if Is_Dispatching_Operation (E) then
12254 -- An overriding dispatching subprogram inherits the
12255 -- convention of the overridden subprogram (AI-117).
12257 Set_Convention (S, Convention (E));
12258 Check_Dispatching_Operation (S, E);
12261 Check_Dispatching_Operation (S, Empty);
12264 Check_For_Primitive_Subprogram
12265 (Is_Primitive_Subp, Is_Overriding => True);
12266 goto Check_Inequality;
12268 -- Apparent redeclarations in instances can occur when two
12269 -- formal types get the same actual type. The subprograms in
12270 -- in the instance are legal, even if not callable from the
12271 -- outside. Calls from within are disambiguated elsewhere.
12272 -- For dispatching operations in the visible part, the usual
12273 -- rules apply, and operations with the same profile are not
12274 -- legal (B830001).
12276 elsif (In_Instance_Visible_Part
12277 and then not Is_Dispatching_Operation (E))
12278 or else In_Instance_Not_Visible
12282 -- Here we have a real error (identical profile)
12285 Error_Msg_Sloc := Sloc (E);
12287 -- Avoid cascaded errors if the entity appears in
12288 -- subsequent calls.
12290 Set_Scope (S, Current_Scope);
12292 -- Generate error, with extra useful warning for the case
12293 -- of a generic instance with no completion.
12295 if Is_Generic_Instance (S)
12296 and then not Has_Completion (E)
12299 ("instantiation cannot provide body for&", S);
12300 Error_Msg_N ("\& conflicts with declaration#", S);
12302 Error_Msg_N ("& conflicts with declaration#", S);
12309 -- If one subprogram has an access parameter and the other
12310 -- a parameter of an access type, calls to either might be
12311 -- ambiguous. Verify that parameters match except for the
12312 -- access parameter.
12314 if May_Hide_Profile then
12320 F1 := First_Formal (S);
12321 F2 := First_Formal (E);
12322 while Present (F1) and then Present (F2) loop
12323 if Is_Access_Type (Etype (F1)) then
12324 if not Is_Access_Type (Etype (F2))
12325 or else not Conforming_Types
12326 (Designated_Type (Etype (F1)),
12327 Designated_Type (Etype (F2)),
12330 May_Hide_Profile := False;
12334 not Conforming_Types
12335 (Etype (F1), Etype (F2), Type_Conformant)
12337 May_Hide_Profile := False;
12344 if May_Hide_Profile
12348 Error_Msg_NE ("calls to& may be ambiguous??", S, S);
12357 -- On exit, we know that S is a new entity
12359 Enter_Overloaded_Entity (S);
12360 Check_For_Primitive_Subprogram (Is_Primitive_Subp);
12361 Check_Overriding_Indicator
12362 (S, Overridden_Subp, Is_Primitive => Is_Primitive_Subp);
12364 -- The Ghost policy in effect at the point of declaration of a parent
12365 -- subprogram and an overriding subprogram must match
12366 -- (SPARK RM 6.9(17)).
12368 Check_Ghost_Overriding (S, Overridden_Subp);
12370 -- If S is a derived operation for an untagged type then by
12371 -- definition it's not a dispatching operation (even if the parent
12372 -- operation was dispatching), so Check_Dispatching_Operation is not
12373 -- called in that case.
12375 if No (Derived_Type)
12376 or else Is_Tagged_Type (Derived_Type)
12378 Check_Dispatching_Operation (S, Empty);
12382 -- If this is a user-defined equality operator that is not a derived
12383 -- subprogram, create the corresponding inequality. If the operation is
12384 -- dispatching, the expansion is done elsewhere, and we do not create
12385 -- an explicit inequality operation.
12387 <<Check_Inequality>>
12388 if Chars (S) = Name_Op_Eq
12389 and then Etype (S) = Standard_Boolean
12390 and then Present (Parent (S))
12391 and then not Is_Dispatching_Operation (S)
12393 Make_Inequality_Operator (S);
12394 Check_Untagged_Equality (S);
12396 end New_Overloaded_Entity;
12398 ----------------------------------
12399 -- Preanalyze_Formal_Expression --
12400 ----------------------------------
12402 procedure Preanalyze_Formal_Expression (N : Node_Id; T : Entity_Id) is
12403 Save_In_Spec_Expression : constant Boolean := In_Spec_Expression;
12405 In_Spec_Expression := True;
12406 Preanalyze_With_Freezing_And_Resolve (N, T);
12407 In_Spec_Expression := Save_In_Spec_Expression;
12408 end Preanalyze_Formal_Expression;
12410 ---------------------
12411 -- Process_Formals --
12412 ---------------------
12414 procedure Process_Formals
12416 Related_Nod : Node_Id)
12418 function Designates_From_Limited_With (Typ : Entity_Id) return Boolean;
12419 -- Determine whether an access type designates a type coming from a
12422 function Is_Class_Wide_Default (D : Node_Id) return Boolean;
12423 -- Check whether the default has a class-wide type. After analysis the
12424 -- default has the type of the formal, so we must also check explicitly
12425 -- for an access attribute.
12427 ----------------------------------
12428 -- Designates_From_Limited_With --
12429 ----------------------------------
12431 function Designates_From_Limited_With (Typ : Entity_Id) return Boolean is
12432 Desig : Entity_Id := Typ;
12435 if Is_Access_Type (Desig) then
12436 Desig := Directly_Designated_Type (Desig);
12439 if Is_Class_Wide_Type (Desig) then
12440 Desig := Root_Type (Desig);
12444 Ekind (Desig) = E_Incomplete_Type
12445 and then From_Limited_With (Desig);
12446 end Designates_From_Limited_With;
12448 ---------------------------
12449 -- Is_Class_Wide_Default --
12450 ---------------------------
12452 function Is_Class_Wide_Default (D : Node_Id) return Boolean is
12454 return Is_Class_Wide_Type (Designated_Type (Etype (D)))
12455 or else (Nkind (D) = N_Attribute_Reference
12456 and then Attribute_Name (D) = Name_Access
12457 and then Is_Class_Wide_Type (Etype (Prefix (D))));
12458 end Is_Class_Wide_Default;
12462 Context : constant Node_Id := Parent (Parent (T));
12464 Formal : Entity_Id;
12465 Formal_Type : Entity_Id;
12466 Param_Spec : Node_Id;
12469 Num_Out_Params : Nat := 0;
12470 First_Out_Param : Entity_Id := Empty;
12471 -- Used for setting Is_Only_Out_Parameter
12473 -- Start of processing for Process_Formals
12476 -- In order to prevent premature use of the formals in the same formal
12477 -- part, the Ekind is left undefined until all default expressions are
12478 -- analyzed. The Ekind is established in a separate loop at the end.
12480 Param_Spec := First (T);
12481 while Present (Param_Spec) loop
12482 Formal := Defining_Identifier (Param_Spec);
12483 Set_Never_Set_In_Source (Formal, True);
12484 Enter_Name (Formal);
12486 -- Case of ordinary parameters
12488 if Nkind (Parameter_Type (Param_Spec)) /= N_Access_Definition then
12489 Find_Type (Parameter_Type (Param_Spec));
12490 Ptype := Parameter_Type (Param_Spec);
12492 if Ptype = Error then
12496 -- Protect against malformed parameter types
12498 if Nkind (Ptype) not in N_Has_Entity then
12499 Formal_Type := Any_Type;
12501 Formal_Type := Entity (Ptype);
12504 if Is_Incomplete_Type (Formal_Type)
12506 (Is_Class_Wide_Type (Formal_Type)
12507 and then Is_Incomplete_Type (Root_Type (Formal_Type)))
12509 -- Ada 2005 (AI-326): Tagged incomplete types allowed in
12510 -- primitive operations, as long as their completion is
12511 -- in the same declarative part. If in the private part
12512 -- this means that the type cannot be a Taft-amendment type.
12513 -- Check is done on package exit. For access to subprograms,
12514 -- the use is legal for Taft-amendment types.
12516 -- Ada 2012: tagged incomplete types are allowed as generic
12517 -- formal types. They do not introduce dependencies and the
12518 -- corresponding generic subprogram does not have a delayed
12519 -- freeze, because it does not need a freeze node. However,
12520 -- it is still the case that untagged incomplete types cannot
12521 -- be Taft-amendment types and must be completed in private
12522 -- part, so the subprogram must appear in the list of private
12523 -- dependents of the type.
12525 if Is_Tagged_Type (Formal_Type)
12526 or else (Ada_Version >= Ada_2012
12527 and then not From_Limited_With (Formal_Type)
12528 and then not Is_Generic_Type (Formal_Type))
12530 if Ekind (Scope (Current_Scope)) = E_Package
12531 and then not Is_Generic_Type (Formal_Type)
12532 and then not Is_Class_Wide_Type (Formal_Type)
12534 if Nkind (Parent (T)) not in
12535 N_Access_Function_Definition |
12536 N_Access_Procedure_Definition
12538 Append_Elmt (Current_Scope,
12539 Private_Dependents (Base_Type (Formal_Type)));
12541 -- Freezing is delayed to ensure that Register_Prim
12542 -- will get called for this operation, which is needed
12543 -- in cases where static dispatch tables aren't built.
12544 -- (Note that the same is done for controlling access
12545 -- parameter cases in function Access_Definition.)
12547 if not Is_Thunk (Current_Scope) then
12548 Set_Has_Delayed_Freeze (Current_Scope);
12553 elsif Nkind (Parent (T)) not in N_Access_Function_Definition
12554 | N_Access_Procedure_Definition
12556 -- AI05-0151: Tagged incomplete types are allowed in all
12557 -- formal parts. Untagged incomplete types are not allowed
12558 -- in bodies. Limited views of either kind are not allowed
12559 -- if there is no place at which the non-limited view can
12560 -- become available.
12562 -- Incomplete formal untagged types are not allowed in
12563 -- subprogram bodies (but are legal in their declarations).
12564 -- This excludes bodies created for null procedures, which
12565 -- are basic declarations.
12567 if Is_Generic_Type (Formal_Type)
12568 and then not Is_Tagged_Type (Formal_Type)
12569 and then Nkind (Parent (Related_Nod)) = N_Subprogram_Body
12572 ("invalid use of formal incomplete type", Param_Spec);
12574 elsif Ada_Version >= Ada_2012 then
12575 if Is_Tagged_Type (Formal_Type)
12576 and then (not From_Limited_With (Formal_Type)
12577 or else not In_Package_Body)
12581 elsif Nkind (Context) in N_Accept_Statement
12582 | N_Accept_Alternative
12584 or else (Nkind (Context) = N_Subprogram_Body
12585 and then Comes_From_Source (Context))
12588 ("invalid use of untagged incomplete type &",
12589 Ptype, Formal_Type);
12594 ("invalid use of incomplete type&",
12595 Param_Spec, Formal_Type);
12597 -- Further checks on the legality of incomplete types
12598 -- in formal parts are delayed until the freeze point
12599 -- of the enclosing subprogram or access to subprogram.
12603 elsif Ekind (Formal_Type) = E_Void then
12605 ("premature use of&",
12606 Parameter_Type (Param_Spec), Formal_Type);
12609 -- Ada 2012 (AI-142): Handle aliased parameters
12611 if Ada_Version >= Ada_2012
12612 and then Aliased_Present (Param_Spec)
12614 Set_Is_Aliased (Formal);
12616 -- AI12-001: All aliased objects are considered to be specified
12617 -- as independently addressable (RM C.6(8.1/4)).
12619 Set_Is_Independent (Formal);
12622 -- Ada 2005 (AI-231): Create and decorate an internal subtype
12623 -- declaration corresponding to the null-excluding type of the
12624 -- formal in the enclosing scope. Finally, replace the parameter
12625 -- type of the formal with the internal subtype.
12627 if Ada_Version >= Ada_2005
12628 and then Null_Exclusion_Present (Param_Spec)
12630 if not Is_Access_Type (Formal_Type) then
12632 ("`NOT NULL` allowed only for an access type", Param_Spec);
12635 if Can_Never_Be_Null (Formal_Type)
12636 and then Comes_From_Source (Related_Nod)
12639 ("`NOT NULL` not allowed (& already excludes null)",
12640 Param_Spec, Formal_Type);
12644 Create_Null_Excluding_Itype
12646 Related_Nod => Related_Nod,
12647 Scope_Id => Scope (Current_Scope));
12649 -- If the designated type of the itype is an itype that is
12650 -- not frozen yet, we set the Has_Delayed_Freeze attribute
12651 -- on the access subtype, to prevent order-of-elaboration
12652 -- issues in the backend.
12655 -- type T is access procedure;
12656 -- procedure Op (O : not null T);
12658 if Is_Itype (Directly_Designated_Type (Formal_Type))
12660 not Is_Frozen (Directly_Designated_Type (Formal_Type))
12662 Set_Has_Delayed_Freeze (Formal_Type);
12667 -- An access formal type
12671 Access_Definition (Related_Nod, Parameter_Type (Param_Spec));
12673 -- No need to continue if we already notified errors
12675 if not Present (Formal_Type) then
12679 -- Ada 2005 (AI-254)
12682 AD : constant Node_Id :=
12683 Access_To_Subprogram_Definition
12684 (Parameter_Type (Param_Spec));
12686 if Present (AD) and then Protected_Present (AD) then
12688 Replace_Anonymous_Access_To_Protected_Subprogram
12694 Set_Etype (Formal, Formal_Type);
12696 -- Deal with default expression if present
12698 Default := Expression (Param_Spec);
12700 if Present (Default) then
12701 if Out_Present (Param_Spec) then
12703 ("default initialization only allowed for IN parameters",
12707 -- Do the special preanalysis of the expression (see section on
12708 -- "Handling of Default Expressions" in the spec of package Sem).
12710 Preanalyze_Formal_Expression (Default, Formal_Type);
12712 -- An access to constant cannot be the default for
12713 -- an access parameter that is an access to variable.
12715 if Ekind (Formal_Type) = E_Anonymous_Access_Type
12716 and then not Is_Access_Constant (Formal_Type)
12717 and then Is_Access_Type (Etype (Default))
12718 and then Is_Access_Constant (Etype (Default))
12721 ("formal that is access to variable cannot be initialized "
12722 & "with an access-to-constant expression", Default);
12725 -- Check that the designated type of an access parameter's default
12726 -- is not a class-wide type unless the parameter's designated type
12727 -- is also class-wide.
12729 if Ekind (Formal_Type) = E_Anonymous_Access_Type
12730 and then not Designates_From_Limited_With (Formal_Type)
12731 and then Is_Class_Wide_Default (Default)
12732 and then not Is_Class_Wide_Type (Designated_Type (Formal_Type))
12735 ("access to class-wide expression not allowed here", Default);
12738 -- Check incorrect use of dynamically tagged expressions
12740 if Is_Tagged_Type (Formal_Type) then
12741 Check_Dynamically_Tagged_Expression
12743 Typ => Formal_Type,
12744 Related_Nod => Default);
12748 -- Ada 2005 (AI-231): Static checks
12750 if Ada_Version >= Ada_2005
12751 and then Is_Access_Type (Etype (Formal))
12752 and then Can_Never_Be_Null (Etype (Formal))
12754 Null_Exclusion_Static_Checks (Param_Spec);
12757 -- The following checks are relevant only when SPARK_Mode is on as
12758 -- these are not standard Ada legality rules.
12760 if SPARK_Mode = On then
12761 if Ekind (Scope (Formal)) in E_Function | E_Generic_Function then
12763 -- A function cannot have a parameter of mode IN OUT or OUT
12766 if Ekind (Formal) in E_In_Out_Parameter | E_Out_Parameter then
12768 ("function cannot have parameter of mode `OUT` or "
12769 & "`IN OUT`", Formal);
12772 -- A procedure cannot have an effectively volatile formal
12773 -- parameter of mode IN because it behaves as a constant
12774 -- (SPARK RM 7.1.3(4)).
12776 elsif Ekind (Scope (Formal)) = E_Procedure
12777 and then Ekind (Formal) = E_In_Parameter
12778 and then Is_Effectively_Volatile (Formal)
12781 ("formal parameter of mode `IN` cannot be volatile", Formal);
12785 -- Deal with aspects on formal parameters. Only Unreferenced is
12786 -- supported for the time being.
12788 if Has_Aspects (Param_Spec) then
12790 Aspect : Node_Id := First (Aspect_Specifications (Param_Spec));
12792 while Present (Aspect) loop
12793 if Chars (Identifier (Aspect)) = Name_Unreferenced then
12794 Set_Has_Pragma_Unreferenced (Formal);
12797 ("unsupported aspect& on parameter",
12798 Aspect, Identifier (Aspect));
12810 -- If this is the formal part of a function specification, analyze the
12811 -- subtype mark in the context where the formals are visible but not
12812 -- yet usable, and may hide outer homographs.
12814 if Nkind (Related_Nod) = N_Function_Specification then
12815 Analyze_Return_Type (Related_Nod);
12818 -- Now set the kind (mode) of each formal
12820 Param_Spec := First (T);
12821 while Present (Param_Spec) loop
12822 Formal := Defining_Identifier (Param_Spec);
12823 Set_Formal_Mode (Formal);
12825 if Ekind (Formal) = E_In_Parameter then
12826 Set_Default_Value (Formal, Expression (Param_Spec));
12828 if Present (Expression (Param_Spec)) then
12829 Default := Expression (Param_Spec);
12831 if Is_Scalar_Type (Etype (Default)) then
12832 if Nkind (Parameter_Type (Param_Spec)) /=
12833 N_Access_Definition
12835 Formal_Type := Entity (Parameter_Type (Param_Spec));
12839 (Related_Nod, Parameter_Type (Param_Spec));
12842 Apply_Scalar_Range_Check (Default, Formal_Type);
12846 elsif Ekind (Formal) = E_Out_Parameter then
12847 Num_Out_Params := Num_Out_Params + 1;
12849 if Num_Out_Params = 1 then
12850 First_Out_Param := Formal;
12853 elsif Ekind (Formal) = E_In_Out_Parameter then
12854 Num_Out_Params := Num_Out_Params + 1;
12857 -- Skip remaining processing if formal type was in error
12859 if Etype (Formal) = Any_Type or else Error_Posted (Formal) then
12860 goto Next_Parameter;
12863 -- Force call by reference if aliased
12866 Conv : constant Convention_Id := Convention (Etype (Formal));
12868 if Is_Aliased (Formal) then
12869 Set_Mechanism (Formal, By_Reference);
12871 -- Warn if user asked this to be passed by copy
12873 if Conv = Convention_Ada_Pass_By_Copy then
12875 ("cannot pass aliased parameter & by copy??", Formal);
12878 -- Force mechanism if type has Convention Ada_Pass_By_Ref/Copy
12880 elsif Conv = Convention_Ada_Pass_By_Copy then
12881 Set_Mechanism (Formal, By_Copy);
12883 elsif Conv = Convention_Ada_Pass_By_Reference then
12884 Set_Mechanism (Formal, By_Reference);
12892 if Present (First_Out_Param) and then Num_Out_Params = 1 then
12893 Set_Is_Only_Out_Parameter (First_Out_Param);
12895 end Process_Formals;
12897 ----------------------------
12898 -- Reference_Body_Formals --
12899 ----------------------------
12901 procedure Reference_Body_Formals (Spec : Entity_Id; Bod : Entity_Id) is
12906 if Error_Posted (Spec) then
12910 -- Iterate over both lists. They may be of different lengths if the two
12911 -- specs are not conformant.
12913 Fs := First_Formal (Spec);
12914 Fb := First_Formal (Bod);
12915 while Present (Fs) and then Present (Fb) loop
12916 Generate_Reference (Fs, Fb, 'b');
12918 if Style_Check then
12919 Style.Check_Identifier (Fb, Fs);
12922 Set_Spec_Entity (Fb, Fs);
12923 Set_Referenced (Fs, False);
12927 end Reference_Body_Formals;
12929 -------------------------
12930 -- Set_Actual_Subtypes --
12931 -------------------------
12933 procedure Set_Actual_Subtypes (N : Node_Id; Subp : Entity_Id) is
12935 Formal : Entity_Id;
12937 First_Stmt : Node_Id := Empty;
12938 AS_Needed : Boolean;
12941 -- If this is an empty initialization procedure, no need to create
12942 -- actual subtypes (small optimization).
12944 if Ekind (Subp) = E_Procedure and then Is_Null_Init_Proc (Subp) then
12947 -- Within a predicate function we do not want to generate local
12948 -- subtypes that may generate nested predicate functions.
12950 elsif Is_Subprogram (Subp) and then Is_Predicate_Function (Subp) then
12954 -- The subtype declarations may freeze the formals. The body generated
12955 -- for an expression function is not a freeze point, so do not emit
12956 -- these declarations (small loss of efficiency in rare cases).
12958 if Nkind (N) = N_Subprogram_Body
12959 and then Was_Expression_Function (N)
12964 Formal := First_Formal (Subp);
12965 while Present (Formal) loop
12966 T := Etype (Formal);
12968 -- We never need an actual subtype for a constrained formal
12970 if Is_Constrained (T) then
12971 AS_Needed := False;
12973 -- If we have unknown discriminants, then we do not need an actual
12974 -- subtype, or more accurately we cannot figure it out. Note that
12975 -- all class-wide types have unknown discriminants.
12977 elsif Has_Unknown_Discriminants (T) then
12978 AS_Needed := False;
12980 -- At this stage we have an unconstrained type that may need an
12981 -- actual subtype. For sure the actual subtype is needed if we have
12982 -- an unconstrained array type. However, in an instance, the type
12983 -- may appear as a subtype of the full view, while the actual is
12984 -- in fact private (in which case no actual subtype is needed) so
12985 -- check the kind of the base type.
12987 elsif Is_Array_Type (Base_Type (T)) then
12990 -- The only other case needing an actual subtype is an unconstrained
12991 -- record type which is an IN parameter (we cannot generate actual
12992 -- subtypes for the OUT or IN OUT case, since an assignment can
12993 -- change the discriminant values. However we exclude the case of
12994 -- initialization procedures, since discriminants are handled very
12995 -- specially in this context, see the section entitled "Handling of
12996 -- Discriminants" in Einfo.
12998 -- We also exclude the case of Discrim_SO_Functions (functions used
12999 -- in front-end layout mode for size/offset values), since in such
13000 -- functions only discriminants are referenced, and not only are such
13001 -- subtypes not needed, but they cannot always be generated, because
13002 -- of order of elaboration issues.
13004 elsif Is_Record_Type (T)
13005 and then Ekind (Formal) = E_In_Parameter
13006 and then Chars (Formal) /= Name_uInit
13007 and then not Is_Unchecked_Union (T)
13008 and then not Is_Discrim_SO_Function (Subp)
13012 -- All other cases do not need an actual subtype
13015 AS_Needed := False;
13018 -- Generate actual subtypes for unconstrained arrays and
13019 -- unconstrained discriminated records.
13022 if Nkind (N) = N_Accept_Statement then
13024 -- If expansion is active, the formal is replaced by a local
13025 -- variable that renames the corresponding entry of the
13026 -- parameter block, and it is this local variable that may
13027 -- require an actual subtype.
13029 if Expander_Active then
13030 Decl := Build_Actual_Subtype (T, Renamed_Object (Formal));
13032 Decl := Build_Actual_Subtype (T, Formal);
13035 if Present (Handled_Statement_Sequence (N)) then
13037 First (Statements (Handled_Statement_Sequence (N)));
13038 Prepend (Decl, Statements (Handled_Statement_Sequence (N)));
13039 Mark_Rewrite_Insertion (Decl);
13041 -- If the accept statement has no body, there will be no
13042 -- reference to the actuals, so no need to compute actual
13049 Decl := Build_Actual_Subtype (T, Formal);
13050 Prepend (Decl, Declarations (N));
13051 Mark_Rewrite_Insertion (Decl);
13054 -- The declaration uses the bounds of an existing object, and
13055 -- therefore needs no constraint checks.
13057 Analyze (Decl, Suppress => All_Checks);
13058 Set_Is_Actual_Subtype (Defining_Identifier (Decl));
13060 -- We need to freeze manually the generated type when it is
13061 -- inserted anywhere else than in a declarative part.
13063 if Present (First_Stmt) then
13064 Insert_List_Before_And_Analyze (First_Stmt,
13065 Freeze_Entity (Defining_Identifier (Decl), N));
13067 -- Ditto if the type has a dynamic predicate, because the
13068 -- generated function will mention the actual subtype. The
13069 -- predicate may come from an explicit aspect of be inherited.
13071 elsif Has_Predicates (T) then
13072 Insert_List_After_And_Analyze (Decl,
13073 Freeze_Entity (Defining_Identifier (Decl), N));
13076 if Nkind (N) = N_Accept_Statement
13077 and then Expander_Active
13079 Set_Actual_Subtype (Renamed_Object (Formal),
13080 Defining_Identifier (Decl));
13082 Set_Actual_Subtype (Formal, Defining_Identifier (Decl));
13086 Next_Formal (Formal);
13088 end Set_Actual_Subtypes;
13090 ---------------------
13091 -- Set_Formal_Mode --
13092 ---------------------
13094 procedure Set_Formal_Mode (Formal_Id : Entity_Id) is
13095 Spec : constant Node_Id := Parent (Formal_Id);
13096 Id : constant Entity_Id := Scope (Formal_Id);
13099 -- Note: we set Is_Known_Valid for IN parameters and IN OUT parameters
13100 -- since we ensure that corresponding actuals are always valid at the
13101 -- point of the call.
13103 if Out_Present (Spec) then
13105 or else Is_Subprogram_Or_Generic_Subprogram (Id)
13107 Set_Has_Out_Or_In_Out_Parameter (Id, True);
13110 if Ekind (Id) in E_Function | E_Generic_Function then
13112 -- [IN] OUT parameters allowed for functions in Ada 2012
13114 if Ada_Version >= Ada_2012 then
13116 -- Even in Ada 2012 operators can only have IN parameters
13118 if Is_Operator_Symbol_Name (Chars (Scope (Formal_Id))) then
13119 Error_Msg_N ("operators can only have IN parameters", Spec);
13122 if In_Present (Spec) then
13123 Mutate_Ekind (Formal_Id, E_In_Out_Parameter);
13125 Mutate_Ekind (Formal_Id, E_Out_Parameter);
13128 -- But not in earlier versions of Ada
13131 Error_Msg_N ("functions can only have IN parameters", Spec);
13132 Mutate_Ekind (Formal_Id, E_In_Parameter);
13135 elsif In_Present (Spec) then
13136 Mutate_Ekind (Formal_Id, E_In_Out_Parameter);
13139 Mutate_Ekind (Formal_Id, E_Out_Parameter);
13140 Set_Never_Set_In_Source (Formal_Id, True);
13141 Set_Is_True_Constant (Formal_Id, False);
13142 Set_Current_Value (Formal_Id, Empty);
13146 Mutate_Ekind (Formal_Id, E_In_Parameter);
13149 -- Set Is_Known_Non_Null for access parameters since the language
13150 -- guarantees that access parameters are always non-null. We also set
13151 -- Can_Never_Be_Null, since there is no way to change the value.
13153 if Nkind (Parameter_Type (Spec)) = N_Access_Definition then
13155 -- Ada 2005 (AI-231): In Ada 95, access parameters are always non-
13156 -- null; In Ada 2005, only if then null_exclusion is explicit.
13158 if Ada_Version < Ada_2005
13159 or else Can_Never_Be_Null (Etype (Formal_Id))
13161 Set_Is_Known_Non_Null (Formal_Id);
13162 Set_Can_Never_Be_Null (Formal_Id);
13165 -- Ada 2005 (AI-231): Null-exclusion access subtype
13167 elsif Is_Access_Type (Etype (Formal_Id))
13168 and then Can_Never_Be_Null (Etype (Formal_Id))
13170 Set_Is_Known_Non_Null (Formal_Id);
13172 -- We can also set Can_Never_Be_Null (thus preventing some junk
13173 -- access checks) for the case of an IN parameter, which cannot
13174 -- be changed, or for an IN OUT parameter, which can be changed but
13175 -- not to a null value. But for an OUT parameter, the initial value
13176 -- passed in can be null, so we can't set this flag in that case.
13178 if Ekind (Formal_Id) /= E_Out_Parameter then
13179 Set_Can_Never_Be_Null (Formal_Id);
13183 Set_Mechanism (Formal_Id, Default_Mechanism);
13184 Set_Formal_Validity (Formal_Id);
13185 end Set_Formal_Mode;
13187 -------------------------
13188 -- Set_Formal_Validity --
13189 -------------------------
13191 procedure Set_Formal_Validity (Formal_Id : Entity_Id) is
13193 -- If no validity checking, then we cannot assume anything about the
13194 -- validity of parameters, since we do not know there is any checking
13195 -- of the validity on the call side.
13197 if not Validity_Checks_On then
13200 -- If validity checking for parameters is enabled, this means we are
13201 -- not supposed to make any assumptions about argument values.
13203 elsif Validity_Check_Parameters then
13206 -- If we are checking in parameters, we will assume that the caller is
13207 -- also checking parameters, so we can assume the parameter is valid.
13209 elsif Ekind (Formal_Id) = E_In_Parameter
13210 and then Validity_Check_In_Params
13212 Set_Is_Known_Valid (Formal_Id, True);
13214 -- Similar treatment for IN OUT parameters
13216 elsif Ekind (Formal_Id) = E_In_Out_Parameter
13217 and then Validity_Check_In_Out_Params
13219 Set_Is_Known_Valid (Formal_Id, True);
13221 end Set_Formal_Validity;
13223 ------------------------
13224 -- Subtype_Conformant --
13225 ------------------------
13227 function Subtype_Conformant
13228 (New_Id : Entity_Id;
13229 Old_Id : Entity_Id;
13230 Skip_Controlling_Formals : Boolean := False) return Boolean
13234 Check_Conformance (New_Id, Old_Id, Subtype_Conformant, False, Result,
13235 Skip_Controlling_Formals => Skip_Controlling_Formals);
13237 end Subtype_Conformant;
13239 ---------------------
13240 -- Type_Conformant --
13241 ---------------------
13243 function Type_Conformant
13244 (New_Id : Entity_Id;
13245 Old_Id : Entity_Id;
13246 Skip_Controlling_Formals : Boolean := False) return Boolean
13250 May_Hide_Profile := False;
13252 (New_Id, Old_Id, Type_Conformant, False, Result,
13253 Skip_Controlling_Formals => Skip_Controlling_Formals);
13255 end Type_Conformant;
13257 -------------------------------
13258 -- Valid_Operator_Definition --
13259 -------------------------------
13261 procedure Valid_Operator_Definition (Designator : Entity_Id) is
13264 Id : constant Name_Id := Chars (Designator);
13268 F := First_Formal (Designator);
13269 while Present (F) loop
13272 if Present (Default_Value (F)) then
13274 ("default values not allowed for operator parameters",
13277 -- For function instantiations that are operators, we must check
13278 -- separately that the corresponding generic only has in-parameters.
13279 -- For subprogram declarations this is done in Set_Formal_Mode. Such
13280 -- an error could not arise in earlier versions of the language.
13282 elsif Ekind (F) /= E_In_Parameter then
13283 Error_Msg_N ("operators can only have IN parameters", F);
13289 -- Verify that user-defined operators have proper number of arguments
13290 -- First case of operators which can only be unary
13292 if Id in Name_Op_Not | Name_Op_Abs then
13295 -- Case of operators which can be unary or binary
13297 elsif Id in Name_Op_Add | Name_Op_Subtract then
13298 N_OK := (N in 1 .. 2);
13300 -- All other operators can only be binary
13308 ("incorrect number of arguments for operator", Designator);
13312 and then Base_Type (Etype (Designator)) = Standard_Boolean
13313 and then not Is_Intrinsic_Subprogram (Designator)
13316 ("explicit definition of inequality not allowed", Designator);
13318 end Valid_Operator_Definition;