1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2015, 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 -- This package contains the routines to process package specifications and
27 -- bodies. The most important semantic aspects of package processing are the
28 -- handling of private and full declarations, and the construction of dispatch
29 -- tables for tagged types.
31 with Aspects; use Aspects;
32 with Atree; use Atree;
33 with Debug; use Debug;
34 with Einfo; use Einfo;
35 with Elists; use Elists;
36 with Errout; use Errout;
37 with Exp_Disp; use Exp_Disp;
38 with Exp_Dist; use Exp_Dist;
39 with Exp_Dbug; use Exp_Dbug;
40 with Ghost; use Ghost;
42 with Lib.Xref; use Lib.Xref;
43 with Namet; use Namet;
44 with Nmake; use Nmake;
45 with Nlists; use Nlists;
47 with Output; use Output;
48 with Restrict; use Restrict;
50 with Sem_Aux; use Sem_Aux;
51 with Sem_Cat; use Sem_Cat;
52 with Sem_Ch3; use Sem_Ch3;
53 with Sem_Ch6; use Sem_Ch6;
54 with Sem_Ch8; use Sem_Ch8;
55 with Sem_Ch10; use Sem_Ch10;
56 with Sem_Ch12; use Sem_Ch12;
57 with Sem_Ch13; use Sem_Ch13;
58 with Sem_Disp; use Sem_Disp;
59 with Sem_Eval; use Sem_Eval;
60 with Sem_Prag; use Sem_Prag;
61 with Sem_Util; use Sem_Util;
62 with Sem_Warn; use Sem_Warn;
63 with Snames; use Snames;
64 with Stand; use Stand;
65 with Sinfo; use Sinfo;
66 with Sinput; use Sinput;
68 with Uintp; use Uintp;
70 package body Sem_Ch7 is
72 -----------------------------------
73 -- Handling private declarations --
74 -----------------------------------
76 -- The principle that each entity has a single defining occurrence clashes
77 -- with the presence of two separate definitions for private types: the
78 -- first is the private type declaration, and the second is the full type
79 -- declaration. It is important that all references to the type point to
80 -- the same defining occurrence, namely the first one. To enforce the two
81 -- separate views of the entity, the corresponding information is swapped
82 -- between the two declarations. Outside of the package, the defining
83 -- occurrence only contains the private declaration information, while in
84 -- the private part and the body of the package the defining occurrence
85 -- contains the full declaration. To simplify the swap, the defining
86 -- occurrence that currently holds the private declaration points to the
87 -- full declaration. During semantic processing the defining occurrence
88 -- also points to a list of private dependents, that is to say access types
89 -- or composite types whose designated types or component types are
90 -- subtypes or derived types of the private type in question. After the
91 -- full declaration has been seen, the private dependents are updated to
92 -- indicate that they have full definitions.
94 -----------------------
95 -- Local Subprograms --
96 -----------------------
98 procedure Analyze_Package_Body_Helper (N : Node_Id);
99 -- Does all the real work of Analyze_Package_Body
101 procedure Check_Anonymous_Access_Types
102 (Spec_Id : Entity_Id;
104 -- If the spec of a package has a limited_with_clause, it may declare
105 -- anonymous access types whose designated type is a limited view, such an
106 -- anonymous access return type for a function. This access type cannot be
107 -- elaborated in the spec itself, but it may need an itype reference if it
108 -- is used within a nested scope. In that case the itype reference is
109 -- created at the beginning of the corresponding package body and inserted
110 -- before other body declarations.
112 procedure Declare_Inherited_Private_Subprograms (Id : Entity_Id);
113 -- Called upon entering the private part of a public child package and the
114 -- body of a nested package, to potentially declare certain inherited
115 -- subprograms that were inherited by types in the visible part, but whose
116 -- declaration was deferred because the parent operation was private and
117 -- not visible at that point. These subprograms are located by traversing
118 -- the visible part declarations looking for non-private type extensions
119 -- and then examining each of the primitive operations of such types to
120 -- find those that were inherited but declared with a special internal
121 -- name. Each such operation is now declared as an operation with a normal
122 -- name (using the name of the parent operation) and replaces the previous
123 -- implicit operation in the primitive operations list of the type. If the
124 -- inherited private operation has been overridden, then it's replaced by
125 -- the overriding operation.
127 procedure Install_Package_Entity (Id : Entity_Id);
128 -- Supporting procedure for Install_{Visible,Private}_Declarations. Places
129 -- one entity on its visibility chain, and recurses on the visible part if
130 -- the entity is an inner package.
132 function Is_Private_Base_Type (E : Entity_Id) return Boolean;
133 -- True for a private type that is not a subtype
135 function Is_Visible_Dependent (Dep : Entity_Id) return Boolean;
136 -- If the private dependent is a private type whose full view is derived
137 -- from the parent type, its full properties are revealed only if we are in
138 -- the immediate scope of the private dependent. Should this predicate be
139 -- tightened further???
141 function Requires_Completion_In_Body
143 Pack_Id : Entity_Id) return Boolean;
144 -- Subsidiary to routines Unit_Requires_Body and Unit_Requires_Body_Info.
145 -- Determine whether entity Id declared in package spec Pack_Id requires
146 -- completion in a package body.
148 procedure Unit_Requires_Body_Info (Pack_Id : Entity_Id);
149 -- Outputs info messages showing why package Pack_Id requires a body. The
150 -- caller has checked that the switch requesting this information is set,
151 -- and that the package does indeed require a body.
153 --------------------------
154 -- Analyze_Package_Body --
155 --------------------------
157 procedure Analyze_Package_Body (N : Node_Id) is
158 Loc : constant Source_Ptr := Sloc (N);
162 Write_Str ("==> package body ");
163 Write_Name (Chars (Defining_Entity (N)));
164 Write_Str (" from ");
165 Write_Location (Loc);
170 -- The real work is split out into the helper, so it can do "return;"
171 -- without skipping the debug output.
173 Analyze_Package_Body_Helper (N);
177 Write_Str ("<== package body ");
178 Write_Name (Chars (Defining_Entity (N)));
179 Write_Str (" from ");
180 Write_Location (Loc);
183 end Analyze_Package_Body;
185 -----------------------------------
186 -- Analyze_Package_Body_Contract --
187 -----------------------------------
189 procedure Analyze_Package_Body_Contract (Body_Id : Entity_Id) is
190 Spec_Id : constant Entity_Id := Spec_Entity (Body_Id);
191 Mode : SPARK_Mode_Type;
195 -- Due to the timing of contract analysis, delayed pragmas may be
196 -- subject to the wrong SPARK_Mode, usually that of the enclosing
197 -- context. To remedy this, restore the original SPARK_Mode of the
198 -- related package body.
200 Save_SPARK_Mode_And_Set (Body_Id, Mode);
202 Prag := Get_Pragma (Body_Id, Pragma_Refined_State);
204 -- The analysis of pragma Refined_State detects whether the spec has
205 -- abstract states available for refinement.
207 if Present (Prag) then
208 Analyze_Refined_State_In_Decl_Part (Prag);
210 -- State refinement is required when the package declaration defines at
211 -- least one abstract state. Null states are not considered. Refinement
212 -- is not envorced when SPARK checks are turned off.
214 elsif SPARK_Mode /= Off
215 and then Requires_State_Refinement (Spec_Id, Body_Id)
217 Error_Msg_N ("package & requires state refinement", Spec_Id);
220 -- Restore the SPARK_Mode of the enclosing context after all delayed
221 -- pragmas have been analyzed.
223 Restore_SPARK_Mode (Mode);
224 end Analyze_Package_Body_Contract;
226 ---------------------------------
227 -- Analyze_Package_Body_Helper --
228 ---------------------------------
230 procedure Analyze_Package_Body_Helper (N : Node_Id) is
231 procedure Hide_Public_Entities (Decls : List_Id);
232 -- Attempt to hide all public entities found in declarative list Decls
233 -- by resetting their Is_Public flag to False depending on whether the
234 -- entities are not referenced by inlined or generic bodies. This kind
235 -- of processing is a conservative approximation and may still leave
236 -- certain entities externally visible.
238 procedure Install_Composite_Operations (P : Entity_Id);
239 -- Composite types declared in the current scope may depend on types
240 -- that were private at the point of declaration, and whose full view
241 -- is now in scope. Indicate that the corresponding operations on the
242 -- composite type are available.
244 --------------------------
245 -- Hide_Public_Entities --
246 --------------------------
248 procedure Hide_Public_Entities (Decls : List_Id) is
249 function Contains_Subp_Or_Const_Refs (N : Node_Id) return Boolean;
250 -- Subsidiary to routine Has_Referencer. Determine whether a node
251 -- contains a reference to a subprogram or a non-static constant.
252 -- WARNING: this is a very expensive routine as it performs a full
255 function Has_Referencer
257 Top_Level : Boolean := False) return Boolean;
258 -- A "referencer" is a construct which may reference a previous
259 -- declaration. Examine all declarations in list Decls in reverse
260 -- and determine whether once such referencer exists. All entities
261 -- in the range Last (Decls) .. Referencer are hidden from external
264 ---------------------------------
265 -- Contains_Subp_Or_Const_Refs --
266 ---------------------------------
268 function Contains_Subp_Or_Const_Refs (N : Node_Id) return Boolean is
269 Reference_Seen : Boolean := False;
271 function Is_Subp_Or_Const_Ref
272 (N : Node_Id) return Traverse_Result;
273 -- Determine whether a node denotes a reference to a subprogram or
274 -- a non-static constant.
276 --------------------------
277 -- Is_Subp_Or_Const_Ref --
278 --------------------------
280 function Is_Subp_Or_Const_Ref
281 (N : Node_Id) return Traverse_Result
286 -- Detect a reference of the form
289 if Nkind (N) in N_Subprogram_Call
290 and then Is_Entity_Name (Name (N))
292 Reference_Seen := True;
295 -- Detect a reference of the form
296 -- Subp'Some_Attribute
298 elsif Nkind (N) = N_Attribute_Reference
299 and then Is_Entity_Name (Prefix (N))
300 and then Present (Entity (Prefix (N)))
301 and then Is_Subprogram (Entity (Prefix (N)))
303 Reference_Seen := True;
306 -- Detect the use of a non-static constant
308 elsif Is_Entity_Name (N)
309 and then Present (Entity (N))
310 and then Ekind (Entity (N)) = E_Constant
312 Val := Constant_Value (Entity (N));
315 and then not Compile_Time_Known_Value (Val)
317 Reference_Seen := True;
323 end Is_Subp_Or_Const_Ref;
325 procedure Find_Subp_Or_Const_Ref is
326 new Traverse_Proc (Is_Subp_Or_Const_Ref);
328 -- Start of processing for Contains_Subp_Or_Const_Refs
331 Find_Subp_Or_Const_Ref (N);
333 return Reference_Seen;
334 end Contains_Subp_Or_Const_Refs;
340 function Has_Referencer
342 Top_Level : Boolean := False) return Boolean
348 Has_Non_Subp_Const_Referencer : Boolean := False;
349 -- Flag set for inlined subprogram bodies that do not contain
350 -- references to other subprograms or non-static constants.
357 -- Examine all declarations in reverse order, hiding all entities
358 -- from external visibility until a referencer has been found. The
359 -- algorithm recurses into nested packages.
361 Decl := Last (Decls);
362 while Present (Decl) loop
364 -- A stub is always considered a referencer
366 if Nkind (Decl) in N_Body_Stub then
369 -- Package declaration
371 elsif Nkind (Decl) = N_Package_Declaration
372 and then not Has_Non_Subp_Const_Referencer
374 Spec := Specification (Decl);
376 -- Inspect the declarations of a non-generic package to try
377 -- and hide more entities from external visibility.
379 if not Is_Generic_Unit (Defining_Entity (Spec)) then
380 if Has_Referencer (Private_Declarations (Spec))
381 or else Has_Referencer (Visible_Declarations (Spec))
389 elsif Nkind (Decl) = N_Package_Body
390 and then Present (Corresponding_Spec (Decl))
392 Decl_Id := Corresponding_Spec (Decl);
394 -- A generic package body is a referencer. It would seem
395 -- that we only have to consider generics that can be
396 -- exported, i.e. where the corresponding spec is the
397 -- spec of the current package, but because of nested
398 -- instantiations, a fully private generic body may export
399 -- other private body entities. Furthermore, regardless of
400 -- whether there was a previous inlined subprogram, (an
401 -- instantiation of) the generic package may reference any
402 -- entity declared before it.
404 if Is_Generic_Unit (Decl_Id) then
407 -- Inspect the declarations of a non-generic package body to
408 -- try and hide more entities from external visibility.
410 elsif not Has_Non_Subp_Const_Referencer
411 and then Has_Referencer (Declarations (Decl))
418 elsif Nkind (Decl) = N_Subprogram_Body then
419 if Present (Corresponding_Spec (Decl)) then
420 Decl_Id := Corresponding_Spec (Decl);
422 -- A generic subprogram body acts as a referencer
424 if Is_Generic_Unit (Decl_Id) then
428 -- An inlined subprogram body acts as a referencer
430 if Is_Inlined (Decl_Id)
431 or else Has_Pragma_Inline (Decl_Id)
433 -- Inspect the statements of the subprogram body
434 -- to determine whether the body references other
435 -- subprograms and/or non-static constants.
438 and then not Contains_Subp_Or_Const_Refs (Decl)
440 Has_Non_Subp_Const_Referencer := True;
446 -- Otherwise this is a stand alone subprogram body
449 Decl_Id := Defining_Entity (Decl);
451 -- An inlined body acts as a referencer. Note that an
452 -- inlined subprogram remains Is_Public as gigi requires
453 -- the flag to be set.
455 -- Note that we test Has_Pragma_Inline here rather than
456 -- Is_Inlined. We are compiling this for a client, and
457 -- it is the client who will decide if actual inlining
458 -- should occur, so we need to assume that the procedure
459 -- could be inlined for the purpose of accessing global
462 if Has_Pragma_Inline (Decl_Id) then
464 and then not Contains_Subp_Or_Const_Refs (Decl)
466 Has_Non_Subp_Const_Referencer := True;
471 Set_Is_Public (Decl_Id, False);
475 -- Exceptions, objects and renamings do not need to be public
476 -- if they are not followed by a construct which can reference
477 -- and export them. The Is_Public flag is reset on top level
478 -- entities only as anything nested is local to its context.
480 elsif Nkind_In (Decl, N_Exception_Declaration,
481 N_Object_Declaration,
482 N_Object_Renaming_Declaration,
483 N_Subprogram_Declaration,
484 N_Subprogram_Renaming_Declaration)
486 Decl_Id := Defining_Entity (Decl);
489 and then not Is_Imported (Decl_Id)
490 and then not Is_Exported (Decl_Id)
491 and then No (Interface_Name (Decl_Id))
493 (not Has_Non_Subp_Const_Referencer
494 or else Nkind (Decl) = N_Subprogram_Declaration)
496 Set_Is_Public (Decl_Id, False);
503 return Has_Non_Subp_Const_Referencer;
508 Discard : Boolean := True;
509 pragma Unreferenced (Discard);
511 -- Start of processing for Hide_Public_Entities
514 -- The algorithm examines the top level declarations of a package
515 -- body in reverse looking for a construct that may export entities
516 -- declared prior to it. If such a scenario is encountered, then all
517 -- entities in the range Last (Decls) .. construct are hidden from
518 -- external visibility. Consider:
526 -- package body Pack is
527 -- External_Obj : ...; -- (1)
529 -- package body Gen is -- (2)
530 -- ... External_Obj ... -- (3)
533 -- Local_Obj : ...; -- (4)
536 -- In this example Local_Obj (4) must not be externally visible as
537 -- it cannot be exported by anything in Pack. The body of generic
538 -- package Gen (2) on the other hand acts as a "referencer" and may
539 -- export anything declared before it. Since the compiler does not
540 -- perform flow analysis, it is not possible to determine precisely
541 -- which entities will be exported when Gen is instantiated. In the
542 -- example above External_Obj (1) is exported at (3), but this may
543 -- not always be the case. The algorithm takes a conservative stance
544 -- and leaves entity External_Obj public.
546 Discard := Has_Referencer (Decls, Top_Level => True);
547 end Hide_Public_Entities;
549 ----------------------------------
550 -- Install_Composite_Operations --
551 ----------------------------------
553 procedure Install_Composite_Operations (P : Entity_Id) is
557 Id := First_Entity (P);
558 while Present (Id) loop
560 and then (Is_Limited_Composite (Id)
561 or else Is_Private_Composite (Id))
562 and then No (Private_Component (Id))
564 Set_Is_Limited_Composite (Id, False);
565 Set_Is_Private_Composite (Id, False);
570 end Install_Composite_Operations;
576 Last_Spec_Entity : Entity_Id;
581 -- Start of processing for Analyze_Package_Body_Helper
584 -- Find corresponding package specification, and establish the current
585 -- scope. The visible defining entity for the package is the defining
586 -- occurrence in the spec. On exit from the package body, all body
587 -- declarations are attached to the defining entity for the body, but
588 -- the later is never used for name resolution. In this fashion there
589 -- is only one visible entity that denotes the package.
591 -- Set Body_Id. Note that this will be reset to point to the generic
592 -- copy later on in the generic case.
594 Body_Id := Defining_Entity (N);
596 -- Body is body of package instantiation. Corresponding spec has already
599 if Present (Corresponding_Spec (N)) then
600 Spec_Id := Corresponding_Spec (N);
601 Pack_Decl := Unit_Declaration_Node (Spec_Id);
604 Spec_Id := Current_Entity_In_Scope (Defining_Entity (N));
607 and then Is_Package_Or_Generic_Package (Spec_Id)
609 Pack_Decl := Unit_Declaration_Node (Spec_Id);
611 if Nkind (Pack_Decl) = N_Package_Renaming_Declaration then
612 Error_Msg_N ("cannot supply body for package renaming", N);
615 elsif Present (Corresponding_Body (Pack_Decl)) then
616 Error_Msg_N ("redefinition of package body", N);
621 Error_Msg_N ("missing specification for package body", N);
625 if Is_Package_Or_Generic_Package (Spec_Id)
626 and then (Scope (Spec_Id) = Standard_Standard
627 or else Is_Child_Unit (Spec_Id))
628 and then not Unit_Requires_Body (Spec_Id)
630 if Ada_Version = Ada_83 then
632 ("optional package body (not allowed in Ada 95)??", N);
634 Error_Msg_N ("spec of this package does not allow a body", N);
639 -- The corresponding spec of the package body may be subject to pragma
640 -- Ghost with policy Ignore. Set the mode now to ensure that any nodes
641 -- generated during analysis and expansion are properly flagged as
644 Set_Ghost_Mode (N, Spec_Id);
646 Set_Is_Compilation_Unit (Body_Id, Is_Compilation_Unit (Spec_Id));
647 Style.Check_Identifier (Body_Id, Spec_Id);
649 if Is_Child_Unit (Spec_Id) then
650 if Nkind (Parent (N)) /= N_Compilation_Unit then
652 ("body of child unit& cannot be an inner package", N, Spec_Id);
655 Set_Is_Child_Unit (Body_Id);
658 -- Generic package case
660 if Ekind (Spec_Id) = E_Generic_Package then
662 -- Disable expansion and perform semantic analysis on copy. The
663 -- unannotated body will be used in all instantiations.
665 Body_Id := Defining_Entity (N);
666 Set_Ekind (Body_Id, E_Package_Body);
667 Set_Scope (Body_Id, Scope (Spec_Id));
668 Set_Is_Obsolescent (Body_Id, Is_Obsolescent (Spec_Id));
669 Set_Body_Entity (Spec_Id, Body_Id);
670 Set_Spec_Entity (Body_Id, Spec_Id);
672 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
675 -- Once the contents of the generic copy and the template are
676 -- swapped, do the same for their respective aspect specifications.
678 Exchange_Aspects (N, New_N);
680 -- Update Body_Id to point to the copied node for the remainder of
683 Body_Id := Defining_Entity (N);
687 -- The Body_Id is that of the copied node in the generic case, the
688 -- current node otherwise. Note that N was rewritten above, so we must
689 -- be sure to get the latest Body_Id value.
691 Set_Ekind (Body_Id, E_Package_Body);
692 Set_Body_Entity (Spec_Id, Body_Id);
693 Set_Spec_Entity (Body_Id, Spec_Id);
695 -- Defining name for the package body is not a visible entity: Only the
696 -- defining name for the declaration is visible.
698 Set_Etype (Body_Id, Standard_Void_Type);
699 Set_Scope (Body_Id, Scope (Spec_Id));
700 Set_Corresponding_Spec (N, Spec_Id);
701 Set_Corresponding_Body (Pack_Decl, Body_Id);
703 -- The body entity is not used for semantics or code generation, but
704 -- it is attached to the entity list of the enclosing scope to simplify
705 -- the listing of back-annotations for the types it main contain.
707 if Scope (Spec_Id) /= Standard_Standard then
708 Append_Entity (Body_Id, Scope (Spec_Id));
711 -- Indicate that we are currently compiling the body of the package
713 Set_In_Package_Body (Spec_Id);
714 Set_Has_Completion (Spec_Id);
715 Last_Spec_Entity := Last_Entity (Spec_Id);
717 if Has_Aspects (N) then
718 Analyze_Aspect_Specifications (N, Body_Id);
721 Push_Scope (Spec_Id);
723 -- Set SPARK_Mode only for non-generic package
725 if Ekind (Spec_Id) = E_Package then
727 -- Set SPARK_Mode from context
729 Set_SPARK_Pragma (Body_Id, SPARK_Mode_Pragma);
730 Set_SPARK_Pragma_Inherited (Body_Id, True);
732 -- Set elaboration code SPARK mode the same for now
734 Set_SPARK_Aux_Pragma (Body_Id, SPARK_Pragma (Body_Id));
735 Set_SPARK_Aux_Pragma_Inherited (Body_Id, True);
738 -- Inherit the "ghostness" of the subprogram spec. Note that this
739 -- property is not directly inherited as the body may be subject to a
740 -- different Ghost assertion policy.
742 if Is_Ghost_Entity (Spec_Id) or else Ghost_Mode > None then
743 Set_Is_Ghost_Entity (Body_Id);
745 -- The Ghost policy in effect at the point of declaration and at the
746 -- point of completion must match (SPARK RM 6.9(15)).
748 Check_Ghost_Completion (Spec_Id, Body_Id);
751 Set_Categorization_From_Pragmas (N);
753 Install_Visible_Declarations (Spec_Id);
754 Install_Private_Declarations (Spec_Id);
755 Install_Private_With_Clauses (Spec_Id);
756 Install_Composite_Operations (Spec_Id);
758 Check_Anonymous_Access_Types (Spec_Id, N);
760 if Ekind (Spec_Id) = E_Generic_Package then
761 Set_Use (Generic_Formal_Declarations (Pack_Decl));
764 Set_Use (Visible_Declarations (Specification (Pack_Decl)));
765 Set_Use (Private_Declarations (Specification (Pack_Decl)));
767 -- This is a nested package, so it may be necessary to declare certain
768 -- inherited subprograms that are not yet visible because the parent
769 -- type's subprograms are now visible.
771 if Ekind (Scope (Spec_Id)) = E_Package
772 and then Scope (Spec_Id) /= Standard_Standard
774 Declare_Inherited_Private_Subprograms (Spec_Id);
777 if Present (Declarations (N)) then
778 Analyze_Declarations (Declarations (N));
779 Inspect_Deferred_Constant_Completion (Declarations (N));
782 -- Verify that the SPARK_Mode of the body agrees with that of its spec
784 if Present (SPARK_Pragma (Body_Id)) then
785 if Present (SPARK_Aux_Pragma (Spec_Id)) then
786 if Get_SPARK_Mode_From_Pragma (SPARK_Aux_Pragma (Spec_Id)) = Off
788 Get_SPARK_Mode_From_Pragma (SPARK_Pragma (Body_Id)) = On
790 Error_Msg_Sloc := Sloc (SPARK_Pragma (Body_Id));
791 Error_Msg_N ("incorrect application of SPARK_Mode#", N);
792 Error_Msg_Sloc := Sloc (SPARK_Aux_Pragma (Spec_Id));
794 ("\value Off was set for SPARK_Mode on & #", N, Spec_Id);
798 Error_Msg_Sloc := Sloc (SPARK_Pragma (Body_Id));
799 Error_Msg_N ("incorrect application of SPARK_Mode#", N);
800 Error_Msg_Sloc := Sloc (Spec_Id);
802 ("\no value was set for SPARK_Mode on & #", N, Spec_Id);
806 -- Analyze_Declarations has caused freezing of all types. Now generate
807 -- bodies for RACW primitives and stream attributes, if any.
809 if Ekind (Spec_Id) = E_Package and then Has_RACW (Spec_Id) then
811 -- Attach subprogram bodies to support RACWs declared in spec
813 Append_RACW_Bodies (Declarations (N), Spec_Id);
814 Analyze_List (Declarations (N));
817 HSS := Handled_Statement_Sequence (N);
819 if Present (HSS) then
820 Process_End_Label (HSS, 't', Spec_Id);
823 -- Check that elaboration code in a preelaborable package body is
824 -- empty other than null statements and labels (RM 10.2.1(6)).
826 Validate_Null_Statement_Sequence (N);
829 Validate_Categorization_Dependency (N, Spec_Id);
830 Check_Completion (Body_Id);
832 -- Generate start of body reference. Note that we do this fairly late,
833 -- because the call will use In_Extended_Main_Source_Unit as a check,
834 -- and we want to make sure that Corresponding_Stub links are set
836 Generate_Reference (Spec_Id, Body_Id, 'b', Set_Ref => False);
838 -- For a generic package, collect global references and mark them on
839 -- the original body so that they are not resolved again at the point
842 if Ekind (Spec_Id) /= E_Package then
843 Save_Global_References (Original_Node (N));
847 -- The entities of the package body have so far been chained onto the
848 -- declaration chain for the spec. That's been fine while we were in the
849 -- body, since we wanted them to be visible, but now that we are leaving
850 -- the package body, they are no longer visible, so we remove them from
851 -- the entity chain of the package spec entity, and copy them to the
852 -- entity chain of the package body entity, where they will never again
855 if Present (Last_Spec_Entity) then
856 Set_First_Entity (Body_Id, Next_Entity (Last_Spec_Entity));
857 Set_Next_Entity (Last_Spec_Entity, Empty);
858 Set_Last_Entity (Body_Id, Last_Entity (Spec_Id));
859 Set_Last_Entity (Spec_Id, Last_Spec_Entity);
862 Set_First_Entity (Body_Id, First_Entity (Spec_Id));
863 Set_Last_Entity (Body_Id, Last_Entity (Spec_Id));
864 Set_First_Entity (Spec_Id, Empty);
865 Set_Last_Entity (Spec_Id, Empty);
868 End_Package_Scope (Spec_Id);
870 -- All entities declared in body are not visible
876 E := First_Entity (Body_Id);
877 while Present (E) loop
878 Set_Is_Immediately_Visible (E, False);
879 Set_Is_Potentially_Use_Visible (E, False);
882 -- Child units may appear on the entity list (e.g. if they appear
883 -- in the context of a subunit) but they are not body entities.
885 if not Is_Child_Unit (E) then
886 Set_Is_Package_Body_Entity (E);
893 Check_References (Body_Id);
895 -- For a generic unit, check that the formal parameters are referenced,
896 -- and that local variables are used, as for regular packages.
898 if Ekind (Spec_Id) = E_Generic_Package then
899 Check_References (Spec_Id);
902 -- At this point all entities of the package body are externally visible
903 -- to the linker as their Is_Public flag is set to True. This proactive
904 -- approach is necessary because an inlined or a generic body for which
905 -- code is generated in other units may need to see these entities. Cut
906 -- down the number of global symbols that do not neet public visibility
907 -- as this has two beneficial effects:
908 -- (1) It makes the compilation process more efficient.
909 -- (2) It gives the code generatormore freedom to optimize within each
910 -- unit, especially subprograms.
912 -- This is done only for top level library packages or child units as
913 -- the algorithm does a top down traversal of the package body.
915 if (Scope (Spec_Id) = Standard_Standard or else Is_Child_Unit (Spec_Id))
916 and then not Is_Generic_Unit (Spec_Id)
918 Hide_Public_Entities (Declarations (N));
921 -- If expander is not active, then here is where we turn off the
922 -- In_Package_Body flag, otherwise it is turned off at the end of the
923 -- corresponding expansion routine. If this is an instance body, we need
924 -- to qualify names of local entities, because the body may have been
925 -- compiled as a preliminary to another instantiation.
927 if not Expander_Active then
928 Set_In_Package_Body (Spec_Id, False);
930 if Is_Generic_Instance (Spec_Id)
931 and then Operating_Mode = Generate_Code
933 Qualify_Entity_Names (N);
936 end Analyze_Package_Body_Helper;
938 ------------------------------
939 -- Analyze_Package_Contract --
940 ------------------------------
942 procedure Analyze_Package_Contract (Pack_Id : Entity_Id) is
943 Mode : SPARK_Mode_Type;
947 -- Due to the timing of contract analysis, delayed pragmas may be
948 -- subject to the wrong SPARK_Mode, usually that of the enclosing
949 -- context. To remedy this, restore the original SPARK_Mode of the
952 Save_SPARK_Mode_And_Set (Pack_Id, Mode);
954 -- Analyze the initialization related pragmas. Initializes must come
955 -- before Initial_Condition due to item dependencies.
957 Prag := Get_Pragma (Pack_Id, Pragma_Initializes);
959 if Present (Prag) then
960 Analyze_Initializes_In_Decl_Part (Prag);
963 Prag := Get_Pragma (Pack_Id, Pragma_Initial_Condition);
965 if Present (Prag) then
966 Analyze_Initial_Condition_In_Decl_Part (Prag);
969 -- Check whether the lack of indicator Part_Of agrees with the placement
970 -- of the package instantiation with respect to the state space.
972 if Is_Generic_Instance (Pack_Id) then
973 Prag := Get_Pragma (Pack_Id, Pragma_Part_Of);
976 Check_Missing_Part_Of (Pack_Id);
980 -- Restore the SPARK_Mode of the enclosing context after all delayed
981 -- pragmas have been analyzed.
983 Restore_SPARK_Mode (Mode);
984 end Analyze_Package_Contract;
986 ---------------------------------
987 -- Analyze_Package_Declaration --
988 ---------------------------------
990 procedure Analyze_Package_Declaration (N : Node_Id) is
991 Id : constant Node_Id := Defining_Entity (N);
994 -- True when in the context of a declared pure library unit
996 Body_Required : Boolean;
997 -- True when this package declaration requires a corresponding body
1000 -- True when this package declaration is not a nested declaration
1003 if Debug_Flag_C then
1004 Write_Str ("==> package spec ");
1005 Write_Name (Chars (Id));
1006 Write_Str (" from ");
1007 Write_Location (Sloc (N));
1012 -- The package declaration may be subject to pragma Ghost with policy
1013 -- Ignore. Set the mode now to ensure that any nodes generated during
1014 -- analysis and expansion are properly flagged as ignored Ghost.
1018 Generate_Definition (Id);
1020 Set_Ekind (Id, E_Package);
1021 Set_Etype (Id, Standard_Void_Type);
1023 -- Set SPARK_Mode from context only for non-generic package
1025 if Ekind (Id) = E_Package then
1026 Set_SPARK_Pragma (Id, SPARK_Mode_Pragma);
1027 Set_SPARK_Aux_Pragma (Id, SPARK_Mode_Pragma);
1028 Set_SPARK_Pragma_Inherited (Id, True);
1029 Set_SPARK_Aux_Pragma_Inherited (Id, True);
1032 -- Analyze aspect specifications immediately, since we need to recognize
1033 -- things like Pure early enough to diagnose violations during analysis.
1035 if Has_Aspects (N) then
1036 Analyze_Aspect_Specifications (N, Id);
1039 -- Ada 2005 (AI-217): Check if the package has been illegally named
1040 -- in a limited-with clause of its own context. In this case the error
1041 -- has been previously notified by Analyze_Context.
1043 -- limited with Pkg; -- ERROR
1044 -- package Pkg is ...
1046 if From_Limited_With (Id) then
1052 PF := Is_Pure (Enclosing_Lib_Unit_Entity);
1053 Set_Is_Pure (Id, PF);
1055 Set_Categorization_From_Pragmas (N);
1057 Analyze (Specification (N));
1058 Validate_Categorization_Dependency (N, Id);
1060 Body_Required := Unit_Requires_Body (Id);
1062 -- When this spec does not require an explicit body, we know that there
1063 -- are no entities requiring completion in the language sense; we call
1064 -- Check_Completion here only to ensure that any nested package
1065 -- declaration that requires an implicit body gets one. (In the case
1066 -- where a body is required, Check_Completion is called at the end of
1067 -- the body's declarative part.)
1069 if not Body_Required then
1073 Comp_Unit := Nkind (Parent (N)) = N_Compilation_Unit;
1076 -- Set Body_Required indication on the compilation unit node, and
1077 -- determine whether elaboration warnings may be meaningful on it.
1079 Set_Body_Required (Parent (N), Body_Required);
1081 if not Body_Required then
1082 Set_Suppress_Elaboration_Warnings (Id);
1087 End_Package_Scope (Id);
1089 -- For the declaration of a library unit that is a remote types package,
1090 -- check legality rules regarding availability of stream attributes for
1091 -- types that contain non-remote access values. This subprogram performs
1092 -- visibility tests that rely on the fact that we have exited the scope
1096 Validate_RT_RAT_Component (N);
1099 if Debug_Flag_C then
1101 Write_Str ("<== package spec ");
1102 Write_Name (Chars (Id));
1103 Write_Str (" from ");
1104 Write_Location (Sloc (N));
1107 end Analyze_Package_Declaration;
1109 -----------------------------------
1110 -- Analyze_Package_Specification --
1111 -----------------------------------
1113 -- Note that this code is shared for the analysis of generic package specs
1114 -- (see Sem_Ch12.Analyze_Generic_Package_Declaration for details).
1116 procedure Analyze_Package_Specification (N : Node_Id) is
1117 Id : constant Entity_Id := Defining_Entity (N);
1118 Orig_Decl : constant Node_Id := Original_Node (Parent (N));
1119 Vis_Decls : constant List_Id := Visible_Declarations (N);
1120 Priv_Decls : constant List_Id := Private_Declarations (N);
1123 Public_Child : Boolean;
1125 Private_With_Clauses_Installed : Boolean := False;
1126 -- In Ada 2005, private with_clauses are visible in the private part
1127 -- of a nested package, even if it appears in the public part of the
1128 -- enclosing package. This requires a separate step to install these
1129 -- private_with_clauses, and remove them at the end of the nested
1132 procedure Check_One_Tagged_Type_Or_Extension_At_Most;
1133 -- Issue an error in SPARK mode if a package specification contains
1134 -- more than one tagged type or type extension.
1136 procedure Clear_Constants (Id : Entity_Id; FE : Entity_Id);
1137 -- Clears constant indications (Never_Set_In_Source, Constant_Value, and
1138 -- Is_True_Constant) on all variables that are entities of Id, and on
1139 -- the chain whose first element is FE. A recursive call is made for all
1140 -- packages and generic packages.
1142 procedure Generate_Parent_References;
1143 -- For a child unit, generate references to parent units, for
1144 -- GPS navigation purposes.
1146 function Is_Public_Child (Child, Unit : Entity_Id) return Boolean;
1147 -- Child and Unit are entities of compilation units. True if Child
1148 -- is a public child of Parent as defined in 10.1.1
1150 procedure Inspect_Unchecked_Union_Completion (Decls : List_Id);
1151 -- Reject completion of an incomplete or private type declarations
1152 -- having a known discriminant part by an unchecked union.
1154 procedure Install_Parent_Private_Declarations (Inst_Id : Entity_Id);
1155 -- Given the package entity of a generic package instantiation or
1156 -- formal package whose corresponding generic is a child unit, installs
1157 -- the private declarations of each of the child unit's parents.
1158 -- This has to be done at the point of entering the instance package's
1159 -- private part rather than being done in Sem_Ch12.Install_Parent
1160 -- (which is where the parents' visible declarations are installed).
1162 ------------------------------------------------
1163 -- Check_One_Tagged_Type_Or_Extension_At_Most --
1164 ------------------------------------------------
1166 procedure Check_One_Tagged_Type_Or_Extension_At_Most is
1169 procedure Check_Decls (Decls : List_Id);
1170 -- Check that either Previous is Empty and Decls does not contain
1171 -- more than one tagged type or type extension, or Previous is
1172 -- already set and Decls contains no tagged type or type extension.
1178 procedure Check_Decls (Decls : List_Id) is
1182 Decl := First (Decls);
1183 while Present (Decl) loop
1184 if Nkind (Decl) = N_Full_Type_Declaration
1185 and then Is_Tagged_Type (Defining_Identifier (Decl))
1187 if No (Previous) then
1191 Error_Msg_Sloc := Sloc (Previous);
1192 Check_SPARK_05_Restriction
1193 ("at most one tagged type or type extension allowed",
1194 "\\ previous declaration#",
1203 -- Start of processing for Check_One_Tagged_Type_Or_Extension_At_Most
1207 Check_Decls (Vis_Decls);
1209 if Present (Priv_Decls) then
1210 Check_Decls (Priv_Decls);
1212 end Check_One_Tagged_Type_Or_Extension_At_Most;
1214 ---------------------
1215 -- Clear_Constants --
1216 ---------------------
1218 procedure Clear_Constants (Id : Entity_Id; FE : Entity_Id) is
1222 -- Ignore package renamings, not interesting and they can cause self
1223 -- referential loops in the code below.
1225 if Nkind (Parent (Id)) = N_Package_Renaming_Declaration then
1229 -- Note: in the loop below, the check for Next_Entity pointing back
1230 -- to the package entity may seem odd, but it is needed, because a
1231 -- package can contain a renaming declaration to itself, and such
1232 -- renamings are generated automatically within package instances.
1235 while Present (E) and then E /= Id loop
1236 if Is_Assignable (E) then
1237 Set_Never_Set_In_Source (E, False);
1238 Set_Is_True_Constant (E, False);
1239 Set_Current_Value (E, Empty);
1240 Set_Is_Known_Null (E, False);
1241 Set_Last_Assignment (E, Empty);
1243 if not Can_Never_Be_Null (E) then
1244 Set_Is_Known_Non_Null (E, False);
1247 elsif Is_Package_Or_Generic_Package (E) then
1248 Clear_Constants (E, First_Entity (E));
1249 Clear_Constants (E, First_Private_Entity (E));
1254 end Clear_Constants;
1256 --------------------------------
1257 -- Generate_Parent_References --
1258 --------------------------------
1260 procedure Generate_Parent_References is
1261 Decl : constant Node_Id := Parent (N);
1264 if Id = Cunit_Entity (Main_Unit)
1265 or else Parent (Decl) = Library_Unit (Cunit (Main_Unit))
1267 Generate_Reference (Id, Scope (Id), 'k', False);
1269 elsif not Nkind_In (Unit (Cunit (Main_Unit)), N_Subprogram_Body,
1272 -- If current unit is an ancestor of main unit, generate a
1273 -- reference to its own parent.
1277 Main_Spec : Node_Id := Unit (Cunit (Main_Unit));
1280 if Nkind (Main_Spec) = N_Package_Body then
1281 Main_Spec := Unit (Library_Unit (Cunit (Main_Unit)));
1284 U := Parent_Spec (Main_Spec);
1285 while Present (U) loop
1286 if U = Parent (Decl) then
1287 Generate_Reference (Id, Scope (Id), 'k', False);
1290 elsif Nkind (Unit (U)) = N_Package_Body then
1294 U := Parent_Spec (Unit (U));
1299 end Generate_Parent_References;
1301 ---------------------
1302 -- Is_Public_Child --
1303 ---------------------
1305 function Is_Public_Child (Child, Unit : Entity_Id) return Boolean is
1307 if not Is_Private_Descendant (Child) then
1310 if Child = Unit then
1311 return not Private_Present (
1312 Parent (Unit_Declaration_Node (Child)));
1314 return Is_Public_Child (Scope (Child), Unit);
1317 end Is_Public_Child;
1319 ----------------------------------------
1320 -- Inspect_Unchecked_Union_Completion --
1321 ----------------------------------------
1323 procedure Inspect_Unchecked_Union_Completion (Decls : List_Id) is
1327 Decl := First (Decls);
1328 while Present (Decl) loop
1330 -- We are looking at an incomplete or private type declaration
1331 -- with a known_discriminant_part whose full view is an
1334 if Nkind_In (Decl, N_Incomplete_Type_Declaration,
1335 N_Private_Type_Declaration)
1336 and then Has_Discriminants (Defining_Identifier (Decl))
1337 and then Present (Full_View (Defining_Identifier (Decl)))
1339 Is_Unchecked_Union (Full_View (Defining_Identifier (Decl)))
1342 ("completion of discriminated partial view "
1343 & "cannot be an unchecked union",
1344 Full_View (Defining_Identifier (Decl)));
1349 end Inspect_Unchecked_Union_Completion;
1351 -----------------------------------------
1352 -- Install_Parent_Private_Declarations --
1353 -----------------------------------------
1355 procedure Install_Parent_Private_Declarations (Inst_Id : Entity_Id) is
1356 Inst_Par : Entity_Id;
1357 Gen_Par : Entity_Id;
1358 Inst_Node : Node_Id;
1361 Inst_Par := Inst_Id;
1364 Generic_Parent (Specification (Unit_Declaration_Node (Inst_Par)));
1365 while Present (Gen_Par) and then Is_Child_Unit (Gen_Par) loop
1366 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
1368 if Nkind_In (Inst_Node, N_Package_Instantiation,
1369 N_Formal_Package_Declaration)
1370 and then Nkind (Name (Inst_Node)) = N_Expanded_Name
1372 Inst_Par := Entity (Prefix (Name (Inst_Node)));
1374 if Present (Renamed_Entity (Inst_Par)) then
1375 Inst_Par := Renamed_Entity (Inst_Par);
1380 (Specification (Unit_Declaration_Node (Inst_Par)));
1382 -- Install the private declarations and private use clauses
1383 -- of a parent instance of the child instance, unless the
1384 -- parent instance private declarations have already been
1385 -- installed earlier in Analyze_Package_Specification, which
1386 -- happens when a generic child is instantiated, and the
1387 -- instance is a child of the parent instance.
1389 -- Installing the use clauses of the parent instance twice
1390 -- is both unnecessary and wrong, because it would cause the
1391 -- clauses to be chained to themselves in the use clauses
1392 -- list of the scope stack entry. That in turn would cause
1393 -- an endless loop from End_Use_Clauses upon scope exit.
1395 -- The parent is now fully visible. It may be a hidden open
1396 -- scope if we are currently compiling some child instance
1397 -- declared within it, but while the current instance is being
1398 -- compiled the parent is immediately visible. In particular
1399 -- its entities must remain visible if a stack save/restore
1400 -- takes place through a call to Rtsfind.
1402 if Present (Gen_Par) then
1403 if not In_Private_Part (Inst_Par) then
1404 Install_Private_Declarations (Inst_Par);
1405 Set_Use (Private_Declarations
1407 (Unit_Declaration_Node (Inst_Par))));
1408 Set_Is_Hidden_Open_Scope (Inst_Par, False);
1411 -- If we've reached the end of the generic instance parents,
1412 -- then finish off by looping through the nongeneric parents
1413 -- and installing their private declarations.
1415 -- If one of the non-generic parents is itself on the scope
1416 -- stack, do not install its private declarations: they are
1417 -- installed in due time when the private part of that parent
1418 -- is analyzed. This is delicate ???
1421 while Present (Inst_Par)
1422 and then Inst_Par /= Standard_Standard
1423 and then (not In_Open_Scopes (Inst_Par)
1424 or else not In_Private_Part (Inst_Par))
1426 Install_Private_Declarations (Inst_Par);
1427 Set_Use (Private_Declarations
1429 (Unit_Declaration_Node (Inst_Par))));
1430 Inst_Par := Scope (Inst_Par);
1440 end Install_Parent_Private_Declarations;
1442 -- Start of processing for Analyze_Package_Specification
1445 if Present (Vis_Decls) then
1446 Analyze_Declarations (Vis_Decls);
1449 -- Inspect the entities defined in the package and ensure that all
1450 -- incomplete types have received full declarations. Build default
1451 -- initial condition and invariant procedures for all qualifying types.
1453 E := First_Entity (Id);
1454 while Present (E) loop
1456 -- Check on incomplete types
1458 -- AI05-0213: A formal incomplete type has no completion
1460 if Ekind (E) = E_Incomplete_Type
1461 and then No (Full_View (E))
1462 and then not Is_Generic_Type (E)
1464 Error_Msg_N ("no declaration in visible part for incomplete}", E);
1469 -- Each private type subject to pragma Default_Initial_Condition
1470 -- declares a specialized procedure which verifies the assumption
1471 -- of the pragma. The declaration appears in the visible part of
1472 -- the package to allow for being called from the outside.
1474 if Has_Default_Init_Cond (E) then
1475 Build_Default_Init_Cond_Procedure_Declaration (E);
1477 -- A private extension inherits the default initial condition
1478 -- procedure from its parent type.
1480 elsif Has_Inherited_Default_Init_Cond (E) then
1481 Inherit_Default_Init_Cond_Procedure (E);
1484 -- If invariants are present, build the invariant procedure for a
1485 -- private type, but not any of its subtypes.
1487 if Has_Invariants (E) then
1488 if Ekind (E) = E_Private_Subtype then
1491 Build_Invariant_Procedure (E, N);
1499 if Is_Remote_Call_Interface (Id)
1500 and then Nkind (Parent (Parent (N))) = N_Compilation_Unit
1502 Validate_RCI_Declarations (Id);
1505 -- Save global references in the visible declarations, before installing
1506 -- private declarations of parent unit if there is one, because the
1507 -- privacy status of types defined in the parent will change. This is
1508 -- only relevant for generic child units, but is done in all cases for
1511 if Ekind (Id) = E_Generic_Package
1512 and then Nkind (Orig_Decl) = N_Generic_Package_Declaration
1515 Orig_Spec : constant Node_Id := Specification (Orig_Decl);
1516 Save_Priv : constant List_Id := Private_Declarations (Orig_Spec);
1518 Set_Private_Declarations (Orig_Spec, Empty_List);
1519 Save_Global_References (Orig_Decl);
1520 Set_Private_Declarations (Orig_Spec, Save_Priv);
1524 -- If package is a public child unit, then make the private declarations
1525 -- of the parent visible.
1527 Public_Child := False;
1531 Pack_Decl : Node_Id;
1536 Par_Spec := Parent_Spec (Parent (N));
1538 -- If the package is formal package of an enclosing generic, it is
1539 -- transformed into a local generic declaration, and compiled to make
1540 -- its spec available. We need to retrieve the original generic to
1541 -- determine whether it is a child unit, and install its parents.
1545 Nkind (Original_Node (Parent (N))) = N_Formal_Package_Declaration
1547 Par := Entity (Name (Original_Node (Parent (N))));
1548 Par_Spec := Parent_Spec (Unit_Declaration_Node (Par));
1551 if Present (Par_Spec) then
1552 Generate_Parent_References;
1554 while Scope (Par) /= Standard_Standard
1555 and then Is_Public_Child (Id, Par)
1556 and then In_Open_Scopes (Par)
1558 Public_Child := True;
1560 Install_Private_Declarations (Par);
1561 Install_Private_With_Clauses (Par);
1562 Pack_Decl := Unit_Declaration_Node (Par);
1563 Set_Use (Private_Declarations (Specification (Pack_Decl)));
1568 if Is_Compilation_Unit (Id) then
1569 Install_Private_With_Clauses (Id);
1572 -- The current compilation unit may include private with_clauses,
1573 -- which are visible in the private part of the current nested
1574 -- package, and have to be installed now. This is not done for
1575 -- nested instantiations, where the private with_clauses of the
1576 -- enclosing unit have no effect once the instantiation info is
1577 -- established and we start analyzing the package declaration.
1580 Comp_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
1582 if Is_Package_Or_Generic_Package (Comp_Unit)
1583 and then not In_Private_Part (Comp_Unit)
1584 and then not In_Instance
1586 Install_Private_With_Clauses (Comp_Unit);
1587 Private_With_Clauses_Installed := True;
1592 -- If this is a package associated with a generic instance or formal
1593 -- package, then the private declarations of each of the generic's
1594 -- parents must be installed at this point.
1596 if Is_Generic_Instance (Id) then
1597 Install_Parent_Private_Declarations (Id);
1600 -- Analyze private part if present. The flag In_Private_Part is reset
1601 -- in End_Package_Scope.
1603 L := Last_Entity (Id);
1605 if Present (Priv_Decls) then
1606 Set_In_Private_Part (Id);
1608 -- Upon entering a public child's private part, it may be necessary
1609 -- to declare subprograms that were derived in the package's visible
1610 -- part but not yet made visible.
1612 if Public_Child then
1613 Declare_Inherited_Private_Subprograms (Id);
1616 Analyze_Declarations (Priv_Decls);
1618 -- Check the private declarations for incomplete deferred constants
1620 Inspect_Deferred_Constant_Completion (Priv_Decls);
1622 -- The first private entity is the immediate follower of the last
1623 -- visible entity, if there was one.
1626 Set_First_Private_Entity (Id, Next_Entity (L));
1628 Set_First_Private_Entity (Id, First_Entity (Id));
1631 -- There may be inherited private subprograms that need to be declared,
1632 -- even in the absence of an explicit private part. If there are any
1633 -- public declarations in the package and the package is a public child
1634 -- unit, then an implicit private part is assumed.
1636 elsif Present (L) and then Public_Child then
1637 Set_In_Private_Part (Id);
1638 Declare_Inherited_Private_Subprograms (Id);
1639 Set_First_Private_Entity (Id, Next_Entity (L));
1642 E := First_Entity (Id);
1643 while Present (E) loop
1645 -- Check rule of 3.6(11), which in general requires waiting till all
1646 -- full types have been seen.
1648 if Ekind (E) = E_Record_Type or else Ekind (E) = E_Array_Type then
1649 Check_Aliased_Component_Types (E);
1652 -- Check preelaborable initialization for full type completing a
1653 -- private type for which pragma Preelaborable_Initialization given.
1656 and then Must_Have_Preelab_Init (E)
1657 and then not Has_Preelaborable_Initialization (E)
1660 ("full view of & does not have preelaborable initialization", E);
1663 -- An invariant may appear on a full view of a type
1666 and then Has_Private_Declaration (E)
1667 and then Nkind (Parent (E)) = N_Full_Type_Declaration
1668 and then Has_Aspects (Parent (E))
1674 ASN := First (Aspect_Specifications (Parent (E)));
1675 while Present (ASN) loop
1676 if Nam_In (Chars (Identifier (ASN)), Name_Invariant,
1677 Name_Type_Invariant)
1679 Build_Invariant_Procedure (E, N);
1691 -- Ada 2005 (AI-216): The completion of an incomplete or private type
1692 -- declaration having a known_discriminant_part shall not be an
1693 -- unchecked union type.
1695 if Present (Vis_Decls) then
1696 Inspect_Unchecked_Union_Completion (Vis_Decls);
1699 if Present (Priv_Decls) then
1700 Inspect_Unchecked_Union_Completion (Priv_Decls);
1703 if Ekind (Id) = E_Generic_Package
1704 and then Nkind (Orig_Decl) = N_Generic_Package_Declaration
1705 and then Present (Priv_Decls)
1707 -- Save global references in private declarations, ignoring the
1708 -- visible declarations that were processed earlier.
1711 Orig_Spec : constant Node_Id := Specification (Orig_Decl);
1712 Save_Vis : constant List_Id := Visible_Declarations (Orig_Spec);
1713 Save_Form : constant List_Id :=
1714 Generic_Formal_Declarations (Orig_Decl);
1717 Set_Visible_Declarations (Orig_Spec, Empty_List);
1718 Set_Generic_Formal_Declarations (Orig_Decl, Empty_List);
1719 Save_Global_References (Orig_Decl);
1720 Set_Generic_Formal_Declarations (Orig_Decl, Save_Form);
1721 Set_Visible_Declarations (Orig_Spec, Save_Vis);
1725 Process_End_Label (N, 'e', Id);
1727 -- Remove private_with_clauses of enclosing compilation unit, if they
1730 if Private_With_Clauses_Installed then
1731 Remove_Private_With_Clauses (Cunit (Current_Sem_Unit));
1734 -- For the case of a library level package, we must go through all the
1735 -- entities clearing the indications that the value may be constant and
1736 -- not modified. Why? Because any client of this package may modify
1737 -- these values freely from anywhere. This also applies to any nested
1738 -- packages or generic packages.
1740 -- For now we unconditionally clear constants for packages that are
1741 -- instances of generic packages. The reason is that we do not have the
1742 -- body yet, and we otherwise think things are unreferenced when they
1743 -- are not. This should be fixed sometime (the effect is not terrible,
1744 -- we just lose some warnings, and also some cases of value propagation)
1747 if Is_Library_Level_Entity (Id)
1748 or else Is_Generic_Instance (Id)
1750 Clear_Constants (Id, First_Entity (Id));
1751 Clear_Constants (Id, First_Private_Entity (Id));
1754 -- Issue an error in SPARK mode if a package specification contains
1755 -- more than one tagged type or type extension.
1757 Check_One_Tagged_Type_Or_Extension_At_Most;
1759 -- If switch set, output information on why body required
1761 if List_Body_Required_Info
1762 and then In_Extended_Main_Source_Unit (Id)
1763 and then Unit_Requires_Body (Id)
1765 Unit_Requires_Body_Info (Id);
1767 end Analyze_Package_Specification;
1769 --------------------------------------
1770 -- Analyze_Private_Type_Declaration --
1771 --------------------------------------
1773 procedure Analyze_Private_Type_Declaration (N : Node_Id) is
1774 PF : constant Boolean := Is_Pure (Enclosing_Lib_Unit_Entity);
1775 Id : constant Entity_Id := Defining_Identifier (N);
1778 -- The private type declaration may be subject to pragma Ghost with
1779 -- policy Ignore. Set the mode now to ensure that any nodes generated
1780 -- during analysis and expansion are properly flagged as ignored Ghost.
1784 Generate_Definition (Id);
1785 Set_Is_Pure (Id, PF);
1786 Init_Size_Align (Id);
1788 if not Is_Package_Or_Generic_Package (Current_Scope)
1789 or else In_Private_Part (Current_Scope)
1791 Error_Msg_N ("invalid context for private declaration", N);
1794 New_Private_Type (N, Id, N);
1795 Set_Depends_On_Private (Id);
1797 -- A type declared within a Ghost region is automatically Ghost
1798 -- (SPARK RM 6.9(2)).
1800 if Ghost_Mode > None then
1801 Set_Is_Ghost_Entity (Id);
1804 if Has_Aspects (N) then
1805 Analyze_Aspect_Specifications (N, Id);
1807 end Analyze_Private_Type_Declaration;
1809 ----------------------------------
1810 -- Check_Anonymous_Access_Types --
1811 ----------------------------------
1813 procedure Check_Anonymous_Access_Types
1814 (Spec_Id : Entity_Id;
1821 -- Itype references are only needed by gigi, to force elaboration of
1822 -- itypes. In the absence of code generation, they are not needed.
1824 if not Expander_Active then
1828 E := First_Entity (Spec_Id);
1829 while Present (E) loop
1830 if Ekind (E) = E_Anonymous_Access_Type
1831 and then From_Limited_With (E)
1833 IR := Make_Itype_Reference (Sloc (P_Body));
1836 if No (Declarations (P_Body)) then
1837 Set_Declarations (P_Body, New_List (IR));
1839 Prepend (IR, Declarations (P_Body));
1845 end Check_Anonymous_Access_Types;
1847 -------------------------------------------
1848 -- Declare_Inherited_Private_Subprograms --
1849 -------------------------------------------
1851 procedure Declare_Inherited_Private_Subprograms (Id : Entity_Id) is
1853 function Is_Primitive_Of (T : Entity_Id; S : Entity_Id) return Boolean;
1854 -- Check whether an inherited subprogram S is an operation of an
1855 -- untagged derived type T.
1857 ---------------------
1858 -- Is_Primitive_Of --
1859 ---------------------
1861 function Is_Primitive_Of (T : Entity_Id; S : Entity_Id) return Boolean is
1865 -- If the full view is a scalar type, the type is the anonymous base
1866 -- type, but the operation mentions the first subtype, so check the
1867 -- signature against the base type.
1869 if Base_Type (Etype (S)) = Base_Type (T) then
1873 Formal := First_Formal (S);
1874 while Present (Formal) loop
1875 if Base_Type (Etype (Formal)) = Base_Type (T) then
1879 Next_Formal (Formal);
1884 end Is_Primitive_Of;
1891 Op_Elmt_2 : Elmt_Id;
1892 Prim_Op : Entity_Id;
1893 New_Op : Entity_Id := Empty;
1894 Parent_Subp : Entity_Id;
1897 -- Start of processing for Declare_Inherited_Private_Subprograms
1900 E := First_Entity (Id);
1901 while Present (E) loop
1903 -- If the entity is a nonprivate type extension whose parent type
1904 -- is declared in an open scope, then the type may have inherited
1905 -- operations that now need to be made visible. Ditto if the entity
1906 -- is a formal derived type in a child unit.
1908 if ((Is_Derived_Type (E) and then not Is_Private_Type (E))
1910 (Nkind (Parent (E)) = N_Private_Extension_Declaration
1911 and then Is_Generic_Type (E)))
1912 and then In_Open_Scopes (Scope (Etype (E)))
1913 and then Is_Base_Type (E)
1915 if Is_Tagged_Type (E) then
1916 Op_List := Primitive_Operations (E);
1918 Tag := First_Tag_Component (E);
1920 Op_Elmt := First_Elmt (Op_List);
1921 while Present (Op_Elmt) loop
1922 Prim_Op := Node (Op_Elmt);
1924 -- Search primitives that are implicit operations with an
1925 -- internal name whose parent operation has a normal name.
1927 if Present (Alias (Prim_Op))
1928 and then Find_Dispatching_Type (Alias (Prim_Op)) /= E
1929 and then not Comes_From_Source (Prim_Op)
1930 and then Is_Internal_Name (Chars (Prim_Op))
1931 and then not Is_Internal_Name (Chars (Alias (Prim_Op)))
1933 Parent_Subp := Alias (Prim_Op);
1935 -- Case 1: Check if the type has also an explicit
1936 -- overriding for this primitive.
1938 Op_Elmt_2 := Next_Elmt (Op_Elmt);
1939 while Present (Op_Elmt_2) loop
1941 -- Skip entities with attribute Interface_Alias since
1942 -- they are not overriding primitives (these entities
1943 -- link an interface primitive with their covering
1946 if Chars (Node (Op_Elmt_2)) = Chars (Parent_Subp)
1947 and then Type_Conformant (Prim_Op, Node (Op_Elmt_2))
1948 and then No (Interface_Alias (Node (Op_Elmt_2)))
1950 -- The private inherited operation has been
1951 -- overridden by an explicit subprogram:
1952 -- replace the former by the latter.
1954 New_Op := Node (Op_Elmt_2);
1955 Replace_Elmt (Op_Elmt, New_Op);
1956 Remove_Elmt (Op_List, Op_Elmt_2);
1957 Set_Overridden_Operation (New_Op, Parent_Subp);
1959 -- We don't need to inherit its dispatching slot.
1960 -- Set_All_DT_Position has previously ensured that
1961 -- the same slot was assigned to the two primitives
1964 and then Present (DTC_Entity (New_Op))
1965 and then Present (DTC_Entity (Prim_Op))
1968 (DT_Position (New_Op) = DT_Position (Prim_Op));
1972 goto Next_Primitive;
1975 Next_Elmt (Op_Elmt_2);
1978 -- Case 2: We have not found any explicit overriding and
1979 -- hence we need to declare the operation (i.e., make it
1982 Derive_Subprogram (New_Op, Alias (Prim_Op), E, Etype (E));
1984 -- Inherit the dispatching slot if E is already frozen
1987 and then Present (DTC_Entity (Alias (Prim_Op)))
1989 Set_DTC_Entity_Value (E, New_Op);
1990 Set_DT_Position (New_Op,
1991 DT_Position (Alias (Prim_Op)));
1995 (Is_Dispatching_Operation (New_Op)
1996 and then Node (Last_Elmt (Op_List)) = New_Op);
1998 -- Substitute the new operation for the old one in the
1999 -- type's primitive operations list. Since the new
2000 -- operation was also just added to the end of list,
2001 -- the last element must be removed.
2003 -- (Question: is there a simpler way of declaring the
2004 -- operation, say by just replacing the name of the
2005 -- earlier operation, reentering it in the in the symbol
2006 -- table (how?), and marking it as private???)
2008 Replace_Elmt (Op_Elmt, New_Op);
2009 Remove_Last_Elmt (Op_List);
2013 Next_Elmt (Op_Elmt);
2016 -- Generate listing showing the contents of the dispatch table
2018 if Debug_Flag_ZZ then
2023 -- For untagged type, scan forward to locate inherited hidden
2026 Prim_Op := Next_Entity (E);
2027 while Present (Prim_Op) loop
2028 if Is_Subprogram (Prim_Op)
2029 and then Present (Alias (Prim_Op))
2030 and then not Comes_From_Source (Prim_Op)
2031 and then Is_Internal_Name (Chars (Prim_Op))
2032 and then not Is_Internal_Name (Chars (Alias (Prim_Op)))
2033 and then Is_Primitive_Of (E, Prim_Op)
2035 Derive_Subprogram (New_Op, Alias (Prim_Op), E, Etype (E));
2038 Next_Entity (Prim_Op);
2040 -- Derived operations appear immediately after the type
2041 -- declaration (or the following subtype indication for
2042 -- a derived scalar type). Further declarations cannot
2043 -- include inherited operations of the type.
2045 if Present (Prim_Op) then
2046 exit when Ekind (Prim_Op) not in Overloadable_Kind;
2054 end Declare_Inherited_Private_Subprograms;
2056 -----------------------
2057 -- End_Package_Scope --
2058 -----------------------
2060 procedure End_Package_Scope (P : Entity_Id) is
2062 Uninstall_Declarations (P);
2064 end End_Package_Scope;
2066 ---------------------------
2067 -- Exchange_Declarations --
2068 ---------------------------
2070 procedure Exchange_Declarations (Id : Entity_Id) is
2071 Full_Id : constant Entity_Id := Full_View (Id);
2072 H1 : constant Entity_Id := Homonym (Id);
2073 Next1 : constant Entity_Id := Next_Entity (Id);
2078 -- If missing full declaration for type, nothing to exchange
2080 if No (Full_Id) then
2084 -- Otherwise complete the exchange, and preserve semantic links
2086 Next2 := Next_Entity (Full_Id);
2087 H2 := Homonym (Full_Id);
2089 -- Reset full declaration pointer to reflect the switched entities and
2090 -- readjust the next entity chains.
2092 Exchange_Entities (Id, Full_Id);
2094 Set_Next_Entity (Id, Next1);
2095 Set_Homonym (Id, H1);
2097 Set_Full_View (Full_Id, Id);
2098 Set_Next_Entity (Full_Id, Next2);
2099 Set_Homonym (Full_Id, H2);
2100 end Exchange_Declarations;
2102 ----------------------------
2103 -- Install_Package_Entity --
2104 ----------------------------
2106 procedure Install_Package_Entity (Id : Entity_Id) is
2108 if not Is_Internal (Id) then
2109 if Debug_Flag_E then
2110 Write_Str ("Install: ");
2111 Write_Name (Chars (Id));
2115 if Is_Child_Unit (Id) then
2118 -- Do not enter implicitly inherited non-overridden subprograms of
2119 -- a tagged type back into visibility if they have non-conformant
2120 -- homographs (Ada RM 8.3 12.3/2).
2122 elsif Is_Hidden_Non_Overridden_Subpgm (Id) then
2126 Set_Is_Immediately_Visible (Id);
2129 end Install_Package_Entity;
2131 ----------------------------------
2132 -- Install_Private_Declarations --
2133 ----------------------------------
2135 procedure Install_Private_Declarations (P : Entity_Id) is
2138 Priv_Deps : Elist_Id;
2140 procedure Swap_Private_Dependents (Priv_Deps : Elist_Id);
2141 -- When the full view of a private type is made available, we do the
2142 -- same for its private dependents under proper visibility conditions.
2143 -- When compiling a grand-chid unit this needs to be done recursively.
2145 -----------------------------
2146 -- Swap_Private_Dependents --
2147 -----------------------------
2149 procedure Swap_Private_Dependents (Priv_Deps : Elist_Id) is
2152 Priv_Elmt : Elmt_Id;
2156 Priv_Elmt := First_Elmt (Priv_Deps);
2157 while Present (Priv_Elmt) loop
2158 Priv := Node (Priv_Elmt);
2160 -- Before the exchange, verify that the presence of the Full_View
2161 -- field. This field will be empty if the entity has already been
2162 -- installed due to a previous call.
2164 if Present (Full_View (Priv)) and then Is_Visible_Dependent (Priv)
2166 if Is_Private_Type (Priv) then
2167 Deps := Private_Dependents (Priv);
2173 -- For each subtype that is swapped, we also swap the reference
2174 -- to it in Private_Dependents, to allow access to it when we
2175 -- swap them out in End_Package_Scope.
2177 Replace_Elmt (Priv_Elmt, Full_View (Priv));
2178 Exchange_Declarations (Priv);
2179 Set_Is_Immediately_Visible
2180 (Priv, In_Open_Scopes (Scope (Priv)));
2181 Set_Is_Potentially_Use_Visible
2182 (Priv, Is_Potentially_Use_Visible (Node (Priv_Elmt)));
2184 -- Within a child unit, recurse, except in generic child unit,
2185 -- which (unfortunately) handle private_dependents separately.
2188 and then Is_Child_Unit (Cunit_Entity (Current_Sem_Unit))
2189 and then not Is_Empty_Elmt_List (Deps)
2190 and then not Inside_A_Generic
2192 Swap_Private_Dependents (Deps);
2196 Next_Elmt (Priv_Elmt);
2198 end Swap_Private_Dependents;
2200 -- Start of processing for Install_Private_Declarations
2203 -- First exchange declarations for private types, so that the full
2204 -- declaration is visible. For each private type, we check its
2205 -- Private_Dependents list and also exchange any subtypes of or derived
2206 -- types from it. Finally, if this is a Taft amendment type, the
2207 -- incomplete declaration is irrelevant, and we want to link the
2208 -- eventual full declaration with the original private one so we
2209 -- also skip the exchange.
2211 Id := First_Entity (P);
2212 while Present (Id) and then Id /= First_Private_Entity (P) loop
2213 if Is_Private_Base_Type (Id)
2214 and then Present (Full_View (Id))
2215 and then Comes_From_Source (Full_View (Id))
2216 and then Scope (Full_View (Id)) = Scope (Id)
2217 and then Ekind (Full_View (Id)) /= E_Incomplete_Type
2219 -- If there is a use-type clause on the private type, set the full
2220 -- view accordingly.
2222 Set_In_Use (Full_View (Id), In_Use (Id));
2223 Full := Full_View (Id);
2225 if Is_Private_Base_Type (Full)
2226 and then Has_Private_Declaration (Full)
2227 and then Nkind (Parent (Full)) = N_Full_Type_Declaration
2228 and then In_Open_Scopes (Scope (Etype (Full)))
2229 and then In_Package_Body (Current_Scope)
2230 and then not Is_Private_Type (Etype (Full))
2232 -- This is the completion of a private type by a derivation
2233 -- from another private type which is not private anymore. This
2234 -- can only happen in a package nested within a child package,
2235 -- when the parent type is defined in the parent unit. At this
2236 -- point the current type is not private either, and we have
2237 -- to install the underlying full view, which is now visible.
2238 -- Save the current full view as well, so that all views can be
2239 -- restored on exit. It may seem that after compiling the child
2240 -- body there are not environments to restore, but the back-end
2241 -- expects those links to be valid, and freeze nodes depend on
2244 if No (Full_View (Full))
2245 and then Present (Underlying_Full_View (Full))
2247 Set_Full_View (Id, Underlying_Full_View (Full));
2248 Set_Underlying_Full_View (Id, Full);
2250 Set_Underlying_Full_View (Full, Empty);
2251 Set_Is_Frozen (Full_View (Id));
2255 Priv_Deps := Private_Dependents (Id);
2256 Exchange_Declarations (Id);
2257 Set_Is_Immediately_Visible (Id);
2258 Swap_Private_Dependents (Priv_Deps);
2264 -- Next make other declarations in the private part visible as well
2266 Id := First_Private_Entity (P);
2267 while Present (Id) loop
2268 Install_Package_Entity (Id);
2269 Set_Is_Hidden (Id, False);
2273 -- Indicate that the private part is currently visible, so it can be
2274 -- properly reset on exit.
2276 Set_In_Private_Part (P);
2277 end Install_Private_Declarations;
2279 ----------------------------------
2280 -- Install_Visible_Declarations --
2281 ----------------------------------
2283 procedure Install_Visible_Declarations (P : Entity_Id) is
2285 Last_Entity : Entity_Id;
2289 (Is_Package_Or_Generic_Package (P) or else Is_Record_Type (P));
2291 if Is_Package_Or_Generic_Package (P) then
2292 Last_Entity := First_Private_Entity (P);
2294 Last_Entity := Empty;
2297 Id := First_Entity (P);
2298 while Present (Id) and then Id /= Last_Entity loop
2299 Install_Package_Entity (Id);
2302 end Install_Visible_Declarations;
2304 --------------------------
2305 -- Is_Private_Base_Type --
2306 --------------------------
2308 function Is_Private_Base_Type (E : Entity_Id) return Boolean is
2310 return Ekind (E) = E_Private_Type
2311 or else Ekind (E) = E_Limited_Private_Type
2312 or else Ekind (E) = E_Record_Type_With_Private;
2313 end Is_Private_Base_Type;
2315 --------------------------
2316 -- Is_Visible_Dependent --
2317 --------------------------
2319 function Is_Visible_Dependent (Dep : Entity_Id) return Boolean
2321 S : constant Entity_Id := Scope (Dep);
2324 -- Renamings created for actual types have the visibility of the actual
2326 if Ekind (S) = E_Package
2327 and then Is_Generic_Instance (S)
2328 and then (Is_Generic_Actual_Type (Dep)
2329 or else Is_Generic_Actual_Type (Full_View (Dep)))
2333 elsif not (Is_Derived_Type (Dep))
2334 and then Is_Derived_Type (Full_View (Dep))
2336 -- When instantiating a package body, the scope stack is empty, so
2337 -- check instead whether the dependent type is defined in the same
2338 -- scope as the instance itself.
2340 return In_Open_Scopes (S)
2341 or else (Is_Generic_Instance (Current_Scope)
2342 and then Scope (Dep) = Scope (Current_Scope));
2346 end Is_Visible_Dependent;
2348 ----------------------------
2349 -- May_Need_Implicit_Body --
2350 ----------------------------
2352 procedure May_Need_Implicit_Body (E : Entity_Id) is
2353 P : constant Node_Id := Unit_Declaration_Node (E);
2354 S : constant Node_Id := Parent (P);
2359 if not Has_Completion (E)
2360 and then Nkind (P) = N_Package_Declaration
2361 and then (Present (Activation_Chain_Entity (P)) or else Has_RACW (E))
2364 Make_Package_Body (Sloc (E),
2365 Defining_Unit_Name => Make_Defining_Identifier (Sloc (E),
2366 Chars => Chars (E)),
2367 Declarations => New_List);
2369 if Nkind (S) = N_Package_Specification then
2370 if Present (Private_Declarations (S)) then
2371 Decls := Private_Declarations (S);
2373 Decls := Visible_Declarations (S);
2376 Decls := Declarations (S);
2382 end May_Need_Implicit_Body;
2384 ----------------------
2385 -- New_Private_Type --
2386 ----------------------
2388 procedure New_Private_Type (N : Node_Id; Id : Entity_Id; Def : Node_Id) is
2390 -- For other than Ada 2012, enter the name in the current scope
2392 if Ada_Version < Ada_2012 then
2395 -- Ada 2012 (AI05-0162): Enter the name in the current scope. Note that
2396 -- there may be an incomplete previous view.
2402 Prev := Find_Type_Name (N);
2403 pragma Assert (Prev = Id
2404 or else (Ekind (Prev) = E_Incomplete_Type
2405 and then Present (Full_View (Prev))
2406 and then Full_View (Prev) = Id));
2410 if Limited_Present (Def) then
2411 Set_Ekind (Id, E_Limited_Private_Type);
2413 Set_Ekind (Id, E_Private_Type);
2417 Set_Has_Delayed_Freeze (Id);
2418 Set_Is_First_Subtype (Id);
2419 Init_Size_Align (Id);
2421 Set_Is_Constrained (Id,
2422 No (Discriminant_Specifications (N))
2423 and then not Unknown_Discriminants_Present (N));
2425 -- Set tagged flag before processing discriminants, to catch illegal
2428 Set_Is_Tagged_Type (Id, Tagged_Present (Def));
2430 Set_Discriminant_Constraint (Id, No_Elist);
2431 Set_Stored_Constraint (Id, No_Elist);
2433 if Present (Discriminant_Specifications (N)) then
2435 Process_Discriminants (N);
2438 elsif Unknown_Discriminants_Present (N) then
2439 Set_Has_Unknown_Discriminants (Id);
2442 Set_Private_Dependents (Id, New_Elmt_List);
2444 if Tagged_Present (Def) then
2445 Set_Ekind (Id, E_Record_Type_With_Private);
2446 Set_Direct_Primitive_Operations (Id, New_Elmt_List);
2447 Set_Is_Abstract_Type (Id, Abstract_Present (Def));
2448 Set_Is_Limited_Record (Id, Limited_Present (Def));
2449 Set_Has_Delayed_Freeze (Id, True);
2451 -- Create a class-wide type with the same attributes
2453 Make_Class_Wide_Type (Id);
2455 elsif Abstract_Present (Def) then
2456 Error_Msg_N ("only a tagged type can be abstract", N);
2458 end New_Private_Type;
2460 ---------------------------------
2461 -- Requires_Completion_In_Body --
2462 ---------------------------------
2464 function Requires_Completion_In_Body
2466 Pack_Id : Entity_Id) return Boolean
2469 -- Always ignore child units. Child units get added to the entity list
2470 -- of a parent unit, but are not original entities of the parent, and
2471 -- so do not affect whether the parent needs a body.
2473 if Is_Child_Unit (Id) then
2476 -- Ignore formal packages and their renamings
2478 elsif Ekind (Id) = E_Package
2479 and then Nkind (Original_Node (Unit_Declaration_Node (Id))) =
2480 N_Formal_Package_Declaration
2484 -- A Ghost entity declared in a non-Ghost package does not force the
2485 -- need for a body (SPARK RM 6.9(11)).
2487 elsif not Is_Ghost_Entity (Pack_Id) and then Is_Ghost_Entity (Id) then
2490 -- Otherwise test to see if entity requires a completion. Note that
2491 -- subprogram entities whose declaration does not come from source are
2492 -- ignored here on the basis that we assume the expander will provide an
2493 -- implicit completion at some point.
2495 elsif (Is_Overloadable (Id)
2496 and then Ekind (Id) /= E_Enumeration_Literal
2497 and then Ekind (Id) /= E_Operator
2498 and then not Is_Abstract_Subprogram (Id)
2499 and then not Has_Completion (Id)
2500 and then Comes_From_Source (Parent (Id)))
2503 (Ekind (Id) = E_Package
2504 and then Id /= Pack_Id
2505 and then not Has_Completion (Id)
2506 and then Unit_Requires_Body (Id))
2509 (Ekind (Id) = E_Incomplete_Type
2510 and then No (Full_View (Id))
2511 and then not Is_Generic_Type (Id))
2514 (Ekind_In (Id, E_Task_Type, E_Protected_Type)
2515 and then not Has_Completion (Id))
2518 (Ekind (Id) = E_Generic_Package
2519 and then Id /= Pack_Id
2520 and then not Has_Completion (Id)
2521 and then Unit_Requires_Body (Id))
2524 (Is_Generic_Subprogram (Id)
2525 and then not Has_Completion (Id))
2530 -- Otherwise the entity does not require completion in a package body
2535 end Requires_Completion_In_Body;
2537 ----------------------------
2538 -- Uninstall_Declarations --
2539 ----------------------------
2541 procedure Uninstall_Declarations (P : Entity_Id) is
2542 Decl : constant Node_Id := Unit_Declaration_Node (P);
2545 Priv_Elmt : Elmt_Id;
2546 Priv_Sub : Entity_Id;
2548 procedure Preserve_Full_Attributes (Priv, Full : Entity_Id);
2549 -- Copy to the private declaration the attributes of the full view that
2550 -- need to be available for the partial view also.
2552 function Type_In_Use (T : Entity_Id) return Boolean;
2553 -- Check whether type or base type appear in an active use_type clause
2555 ------------------------------
2556 -- Preserve_Full_Attributes --
2557 ------------------------------
2559 procedure Preserve_Full_Attributes (Priv, Full : Entity_Id) is
2560 Priv_Is_Base_Type : constant Boolean := Is_Base_Type (Priv);
2563 Set_Size_Info (Priv, (Full));
2564 Set_RM_Size (Priv, RM_Size (Full));
2565 Set_Size_Known_At_Compile_Time
2566 (Priv, Size_Known_At_Compile_Time (Full));
2567 Set_Is_Volatile (Priv, Is_Volatile (Full));
2568 Set_Treat_As_Volatile (Priv, Treat_As_Volatile (Full));
2569 Set_Is_Ada_2005_Only (Priv, Is_Ada_2005_Only (Full));
2570 Set_Is_Ada_2012_Only (Priv, Is_Ada_2012_Only (Full));
2571 Set_Has_Pragma_Unmodified (Priv, Has_Pragma_Unmodified (Full));
2572 Set_Has_Pragma_Unreferenced (Priv, Has_Pragma_Unreferenced (Full));
2573 Set_Has_Pragma_Unreferenced_Objects
2574 (Priv, Has_Pragma_Unreferenced_Objects
2576 if Is_Unchecked_Union (Full) then
2577 Set_Is_Unchecked_Union (Base_Type (Priv));
2579 -- Why is atomic not copied here ???
2581 if Referenced (Full) then
2582 Set_Referenced (Priv);
2585 if Priv_Is_Base_Type then
2586 Set_Is_Controlled (Priv, Is_Controlled (Base_Type (Full)));
2587 Set_Finalize_Storage_Only
2588 (Priv, Finalize_Storage_Only
2589 (Base_Type (Full)));
2590 Set_Has_Task (Priv, Has_Task (Base_Type (Full)));
2591 Set_Has_Protected (Priv, Has_Protected (Base_Type (Full)));
2592 Set_Has_Controlled_Component
2593 (Priv, Has_Controlled_Component
2594 (Base_Type (Full)));
2597 Set_Freeze_Node (Priv, Freeze_Node (Full));
2599 -- Propagate information of type invariants, which may be specified
2600 -- for the full view.
2602 if Has_Invariants (Full) and not Has_Invariants (Priv) then
2603 Set_Has_Invariants (Priv);
2604 Set_Subprograms_For_Type (Priv, Subprograms_For_Type (Full));
2607 if Is_Tagged_Type (Priv)
2608 and then Is_Tagged_Type (Full)
2609 and then not Error_Posted (Full)
2611 if Is_Tagged_Type (Priv) then
2613 -- If the type is tagged, the tag itself must be available on
2614 -- the partial view, for expansion purposes.
2616 Set_First_Entity (Priv, First_Entity (Full));
2618 -- If there are discriminants in the partial view, these remain
2619 -- visible. Otherwise only the tag itself is visible, and there
2620 -- are no nameable components in the partial view.
2622 if No (Last_Entity (Priv)) then
2623 Set_Last_Entity (Priv, First_Entity (Priv));
2627 Set_Has_Discriminants (Priv, Has_Discriminants (Full));
2629 if Has_Discriminants (Full) then
2630 Set_Discriminant_Constraint (Priv,
2631 Discriminant_Constraint (Full));
2634 end Preserve_Full_Attributes;
2640 function Type_In_Use (T : Entity_Id) return Boolean is
2642 return Scope (Base_Type (T)) = P
2643 and then (In_Use (T) or else In_Use (Base_Type (T)));
2646 -- Start of processing for Uninstall_Declarations
2649 Id := First_Entity (P);
2650 while Present (Id) and then Id /= First_Private_Entity (P) loop
2651 if Debug_Flag_E then
2652 Write_Str ("unlinking visible entity ");
2653 Write_Int (Int (Id));
2657 -- On exit from the package scope, we must preserve the visibility
2658 -- established by use clauses in the current scope. Two cases:
2660 -- a) If the entity is an operator, it may be a primitive operator of
2661 -- a type for which there is a visible use-type clause.
2663 -- b) for other entities, their use-visibility is determined by a
2664 -- visible use clause for the package itself. For a generic instance,
2665 -- the instantiation of the formals appears in the visible part,
2666 -- but the formals are private and remain so.
2668 if Ekind (Id) = E_Function
2669 and then Is_Operator_Symbol_Name (Chars (Id))
2670 and then not Is_Hidden (Id)
2671 and then not Error_Posted (Id)
2673 Set_Is_Potentially_Use_Visible (Id,
2675 or else Type_In_Use (Etype (Id))
2676 or else Type_In_Use (Etype (First_Formal (Id)))
2677 or else (Present (Next_Formal (First_Formal (Id)))
2680 (Etype (Next_Formal (First_Formal (Id))))));
2682 if In_Use (P) and then not Is_Hidden (Id) then
2684 -- A child unit of a use-visible package remains use-visible
2685 -- only if it is itself a visible child unit. Otherwise it
2686 -- would remain visible in other contexts where P is use-
2687 -- visible, because once compiled it stays in the entity list
2688 -- of its parent unit.
2690 if Is_Child_Unit (Id) then
2691 Set_Is_Potentially_Use_Visible
2692 (Id, Is_Visible_Lib_Unit (Id));
2694 Set_Is_Potentially_Use_Visible (Id);
2698 Set_Is_Potentially_Use_Visible (Id, False);
2702 -- Local entities are not immediately visible outside of the package
2704 Set_Is_Immediately_Visible (Id, False);
2706 -- If this is a private type with a full view (for example a local
2707 -- subtype of a private type declared elsewhere), ensure that the
2708 -- full view is also removed from visibility: it may be exposed when
2709 -- swapping views in an instantiation.
2711 if Is_Type (Id) and then Present (Full_View (Id)) then
2712 Set_Is_Immediately_Visible (Full_View (Id), False);
2715 if Is_Tagged_Type (Id) and then Ekind (Id) = E_Record_Type then
2716 Check_Abstract_Overriding (Id);
2717 Check_Conventions (Id);
2720 if Ekind_In (Id, E_Private_Type, E_Limited_Private_Type)
2721 and then No (Full_View (Id))
2722 and then not Is_Generic_Type (Id)
2723 and then not Is_Derived_Type (Id)
2725 Error_Msg_N ("missing full declaration for private type&", Id);
2727 elsif Ekind (Id) = E_Record_Type_With_Private
2728 and then not Is_Generic_Type (Id)
2729 and then No (Full_View (Id))
2731 if Nkind (Parent (Id)) = N_Private_Type_Declaration then
2732 Error_Msg_N ("missing full declaration for private type&", Id);
2735 ("missing full declaration for private extension", Id);
2738 -- Case of constant, check for deferred constant declaration with
2739 -- no full view. Likely just a matter of a missing expression, or
2740 -- accidental use of the keyword constant.
2742 elsif Ekind (Id) = E_Constant
2744 -- OK if constant value present
2746 and then No (Constant_Value (Id))
2748 -- OK if full view present
2750 and then No (Full_View (Id))
2752 -- OK if imported, since that provides the completion
2754 and then not Is_Imported (Id)
2756 -- OK if object declaration replaced by renaming declaration as
2757 -- a result of OK_To_Rename processing (e.g. for concatenation)
2759 and then Nkind (Parent (Id)) /= N_Object_Renaming_Declaration
2761 -- OK if object declaration with the No_Initialization flag set
2763 and then not (Nkind (Parent (Id)) = N_Object_Declaration
2764 and then No_Initialization (Parent (Id)))
2766 -- If no private declaration is present, we assume the user did
2767 -- not intend a deferred constant declaration and the problem
2768 -- is simply that the initializing expression is missing.
2770 if not Has_Private_Declaration (Etype (Id)) then
2772 -- We assume that the user did not intend a deferred constant
2773 -- declaration, and the expression is just missing.
2776 ("constant declaration requires initialization expression",
2779 if Is_Limited_Type (Etype (Id)) then
2781 ("\if variable intended, remove CONSTANT from declaration",
2785 -- Otherwise if a private declaration is present, then we are
2786 -- missing the full declaration for the deferred constant.
2790 ("missing full declaration for deferred constant (RM 7.4)",
2793 if Is_Limited_Type (Etype (Id)) then
2795 ("\if variable intended, remove CONSTANT from declaration",
2804 -- If the specification was installed as the parent of a public child
2805 -- unit, the private declarations were not installed, and there is
2808 if not In_Private_Part (P) then
2811 Set_In_Private_Part (P, False);
2814 -- Make private entities invisible and exchange full and private
2815 -- declarations for private types. Id is now the first private entity
2818 while Present (Id) loop
2819 if Debug_Flag_E then
2820 Write_Str ("unlinking private entity ");
2821 Write_Int (Int (Id));
2825 if Is_Tagged_Type (Id) and then Ekind (Id) = E_Record_Type then
2826 Check_Abstract_Overriding (Id);
2827 Check_Conventions (Id);
2830 Set_Is_Immediately_Visible (Id, False);
2832 if Is_Private_Base_Type (Id) and then Present (Full_View (Id)) then
2833 Full := Full_View (Id);
2835 -- If the partial view is not declared in the visible part of the
2836 -- package (as is the case when it is a type derived from some
2837 -- other private type in the private part of the current package),
2838 -- no exchange takes place.
2841 or else List_Containing (Parent (Id)) /=
2842 Visible_Declarations (Specification (Decl))
2847 -- The entry in the private part points to the full declaration,
2848 -- which is currently visible. Exchange them so only the private
2849 -- type declaration remains accessible, and link private and full
2850 -- declaration in the opposite direction. Before the actual
2851 -- exchange, we copy back attributes of the full view that must
2852 -- be available to the partial view too.
2854 Preserve_Full_Attributes (Id, Full);
2856 Set_Is_Potentially_Use_Visible (Id, In_Use (P));
2858 -- The following test may be redundant, as this is already
2859 -- diagnosed in sem_ch3. ???
2861 if Is_Indefinite_Subtype (Full)
2862 and then not Is_Indefinite_Subtype (Id)
2864 Error_Msg_Sloc := Sloc (Parent (Id));
2866 ("full view of& not compatible with declaration#", Full, Id);
2869 -- Swap out the subtypes and derived types of Id that
2870 -- were compiled in this scope, or installed previously
2871 -- by Install_Private_Declarations.
2873 -- Before we do the swap, we verify the presence of the Full_View
2874 -- field which may be empty due to a swap by a previous call to
2875 -- End_Package_Scope (e.g. from the freezing mechanism).
2877 Priv_Elmt := First_Elmt (Private_Dependents (Id));
2878 while Present (Priv_Elmt) loop
2879 Priv_Sub := Node (Priv_Elmt);
2881 if Present (Full_View (Priv_Sub)) then
2882 if Scope (Priv_Sub) = P
2883 or else not In_Open_Scopes (Scope (Priv_Sub))
2885 Set_Is_Immediately_Visible (Priv_Sub, False);
2888 if Is_Visible_Dependent (Priv_Sub) then
2889 Preserve_Full_Attributes
2890 (Priv_Sub, Full_View (Priv_Sub));
2891 Replace_Elmt (Priv_Elmt, Full_View (Priv_Sub));
2892 Exchange_Declarations (Priv_Sub);
2896 Next_Elmt (Priv_Elmt);
2899 -- Now restore the type itself to its private view
2901 Exchange_Declarations (Id);
2903 -- If we have installed an underlying full view for a type derived
2904 -- from a private type in a child unit, restore the proper views
2905 -- of private and full view. See corresponding code in
2906 -- Install_Private_Declarations.
2908 -- After the exchange, Full denotes the private type in the
2909 -- visible part of the package.
2911 if Is_Private_Base_Type (Full)
2912 and then Present (Full_View (Full))
2913 and then Present (Underlying_Full_View (Full))
2914 and then In_Package_Body (Current_Scope)
2916 Set_Full_View (Full, Underlying_Full_View (Full));
2917 Set_Underlying_Full_View (Full, Empty);
2920 elsif Ekind (Id) = E_Incomplete_Type
2921 and then Comes_From_Source (Id)
2922 and then No (Full_View (Id))
2924 -- Mark Taft amendment types. Verify that there are no primitive
2925 -- operations declared for the type (3.10.1(9)).
2927 Set_Has_Completion_In_Body (Id);
2934 Elmt := First_Elmt (Private_Dependents (Id));
2935 while Present (Elmt) loop
2936 Subp := Node (Elmt);
2938 -- Is_Primitive is tested because there can be cases where
2939 -- nonprimitive subprograms (in nested packages) are added
2940 -- to the Private_Dependents list.
2942 if Is_Overloadable (Subp) and then Is_Primitive (Subp) then
2944 ("type& must be completed in the private part",
2947 -- The result type of an access-to-function type cannot be a
2948 -- Taft-amendment type, unless the version is Ada 2012 or
2949 -- later (see AI05-151).
2951 elsif Ada_Version < Ada_2012
2952 and then Ekind (Subp) = E_Subprogram_Type
2954 if Etype (Subp) = Id
2956 (Is_Class_Wide_Type (Etype (Subp))
2957 and then Etype (Etype (Subp)) = Id)
2960 ("type& must be completed in the private part",
2961 Associated_Node_For_Itype (Subp), Id);
2969 elsif not Is_Child_Unit (Id)
2970 and then (not Is_Private_Type (Id) or else No (Full_View (Id)))
2973 Set_Is_Potentially_Use_Visible (Id, False);
2979 end Uninstall_Declarations;
2981 ------------------------
2982 -- Unit_Requires_Body --
2983 ------------------------
2985 function Unit_Requires_Body
2986 (Pack_Id : Entity_Id;
2987 Ignore_Abstract_State : Boolean := False) return Boolean
2992 -- Imported entity never requires body. Right now, only subprograms can
2993 -- be imported, but perhaps in the future we will allow import of
2996 if Is_Imported (Pack_Id) then
2999 -- Body required if library package with pragma Elaborate_Body
3001 elsif Has_Pragma_Elaborate_Body (Pack_Id) then
3004 -- Body required if subprogram
3006 elsif Is_Subprogram_Or_Generic_Subprogram (Pack_Id) then
3009 -- Treat a block as requiring a body
3011 elsif Ekind (Pack_Id) = E_Block then
3014 elsif Ekind (Pack_Id) = E_Package
3015 and then Nkind (Parent (Pack_Id)) = N_Package_Specification
3016 and then Present (Generic_Parent (Parent (Pack_Id)))
3019 G_P : constant Entity_Id := Generic_Parent (Parent (Pack_Id));
3021 if Has_Pragma_Elaborate_Body (G_P) then
3026 -- A [generic] package that introduces at least one non-null abstract
3027 -- state requires completion. However, there is a separate rule that
3028 -- requires that such a package have a reason other than this for a
3029 -- body being required (if necessary a pragma Elaborate_Body must be
3030 -- provided). If Ignore_Abstract_State is True, we don't do this check
3031 -- (so we can use Unit_Requires_Body to check for some other reason).
3033 elsif Ekind_In (Pack_Id, E_Generic_Package, E_Package)
3034 and then not Ignore_Abstract_State
3035 and then Present (Abstract_States (Pack_Id))
3036 and then not Is_Null_State
3037 (Node (First_Elmt (Abstract_States (Pack_Id))))
3042 -- Otherwise search entity chain for entity requiring completion
3044 E := First_Entity (Pack_Id);
3045 while Present (E) loop
3046 if Requires_Completion_In_Body (E, Pack_Id) then
3054 end Unit_Requires_Body;
3056 -----------------------------
3057 -- Unit_Requires_Body_Info --
3058 -----------------------------
3060 procedure Unit_Requires_Body_Info (Pack_Id : Entity_Id) is
3064 -- An imported entity never requires body. Right now, only subprograms
3065 -- can be imported, but perhaps in the future we will allow import of
3068 if Is_Imported (Pack_Id) then
3071 -- Body required if library package with pragma Elaborate_Body
3073 elsif Has_Pragma_Elaborate_Body (Pack_Id) then
3074 Error_Msg_N ("info: & requires body (Elaborate_Body)?Y?", Pack_Id);
3076 -- Body required if subprogram
3078 elsif Is_Subprogram_Or_Generic_Subprogram (Pack_Id) then
3079 Error_Msg_N ("info: & requires body (subprogram case)?Y?", Pack_Id);
3081 -- Body required if generic parent has Elaborate_Body
3083 elsif Ekind (Pack_Id) = E_Package
3084 and then Nkind (Parent (Pack_Id)) = N_Package_Specification
3085 and then Present (Generic_Parent (Parent (Pack_Id)))
3088 G_P : constant Entity_Id := Generic_Parent (Parent (Pack_Id));
3090 if Has_Pragma_Elaborate_Body (G_P) then
3092 ("info: & requires body (generic parent Elaborate_Body)?Y?",
3097 -- A [generic] package that introduces at least one non-null abstract
3098 -- state requires completion. However, there is a separate rule that
3099 -- requires that such a package have a reason other than this for a
3100 -- body being required (if necessary a pragma Elaborate_Body must be
3101 -- provided). If Ignore_Abstract_State is True, we don't do this check
3102 -- (so we can use Unit_Requires_Body to check for some other reason).
3104 elsif Ekind_In (Pack_Id, E_Generic_Package, E_Package)
3105 and then Present (Abstract_States (Pack_Id))
3106 and then not Is_Null_State
3107 (Node (First_Elmt (Abstract_States (Pack_Id))))
3110 ("info: & requires body (non-null abstract state aspect)?Y?",
3114 -- Otherwise search entity chain for entity requiring completion
3116 E := First_Entity (Pack_Id);
3117 while Present (E) loop
3118 if Requires_Completion_In_Body (E, Pack_Id) then
3119 Error_Msg_Node_2 := E;
3121 ("info: & requires body (& requires completion)?Y?", E, Pack_Id);
3126 end Unit_Requires_Body_Info;