* tree-vect-loop-manip.c (vect_do_peeling): Do not use
[official-gcc.git] / gcc / ada / sem_ch7.adb
blob2e035c785757c144e9fcee512e96d7907a0d71aa
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- S E M _ C H 7 --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1992-2017, Free Software Foundation, Inc. --
10 -- --
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. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
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 Contracts; use Contracts;
34 with Debug; use Debug;
35 with Einfo; use Einfo;
36 with Elists; use Elists;
37 with Errout; use Errout;
38 with Exp_Disp; use Exp_Disp;
39 with Exp_Dist; use Exp_Dist;
40 with Exp_Dbug; use Exp_Dbug;
41 with Freeze; use Freeze;
42 with Ghost; use Ghost;
43 with Lib; use Lib;
44 with Lib.Xref; use Lib.Xref;
45 with Namet; use Namet;
46 with Nmake; use Nmake;
47 with Nlists; use Nlists;
48 with Opt; use Opt;
49 with Output; use Output;
50 with Restrict; use Restrict;
51 with Rtsfind; use Rtsfind;
52 with Sem; use Sem;
53 with Sem_Aux; use Sem_Aux;
54 with Sem_Cat; use Sem_Cat;
55 with Sem_Ch3; use Sem_Ch3;
56 with Sem_Ch6; use Sem_Ch6;
57 with Sem_Ch8; use Sem_Ch8;
58 with Sem_Ch10; use Sem_Ch10;
59 with Sem_Ch12; use Sem_Ch12;
60 with Sem_Ch13; use Sem_Ch13;
61 with Sem_Disp; use Sem_Disp;
62 with Sem_Eval; use Sem_Eval;
63 with Sem_Prag; use Sem_Prag;
64 with Sem_Util; use Sem_Util;
65 with Sem_Warn; use Sem_Warn;
66 with Snames; use Snames;
67 with Stand; use Stand;
68 with Sinfo; use Sinfo;
69 with Sinput; use Sinput;
70 with Style;
71 with Uintp; use Uintp;
73 with GNAT.HTable;
75 package body Sem_Ch7 is
77 -----------------------------------
78 -- Handling private declarations --
79 -----------------------------------
81 -- The principle that each entity has a single defining occurrence clashes
82 -- with the presence of two separate definitions for private types: the
83 -- first is the private type declaration, and the second is the full type
84 -- declaration. It is important that all references to the type point to
85 -- the same defining occurrence, namely the first one. To enforce the two
86 -- separate views of the entity, the corresponding information is swapped
87 -- between the two declarations. Outside of the package, the defining
88 -- occurrence only contains the private declaration information, while in
89 -- the private part and the body of the package the defining occurrence
90 -- contains the full declaration. To simplify the swap, the defining
91 -- occurrence that currently holds the private declaration points to the
92 -- full declaration. During semantic processing the defining occurrence
93 -- also points to a list of private dependents, that is to say access types
94 -- or composite types whose designated types or component types are
95 -- subtypes or derived types of the private type in question. After the
96 -- full declaration has been seen, the private dependents are updated to
97 -- indicate that they have full definitions.
99 -----------------------
100 -- Local Subprograms --
101 -----------------------
103 procedure Analyze_Package_Body_Helper (N : Node_Id);
104 -- Does all the real work of Analyze_Package_Body
106 procedure Check_Anonymous_Access_Types
107 (Spec_Id : Entity_Id;
108 P_Body : Node_Id);
109 -- If the spec of a package has a limited_with_clause, it may declare
110 -- anonymous access types whose designated type is a limited view, such an
111 -- anonymous access return type for a function. This access type cannot be
112 -- elaborated in the spec itself, but it may need an itype reference if it
113 -- is used within a nested scope. In that case the itype reference is
114 -- created at the beginning of the corresponding package body and inserted
115 -- before other body declarations.
117 procedure Declare_Inherited_Private_Subprograms (Id : Entity_Id);
118 -- Called upon entering the private part of a public child package and the
119 -- body of a nested package, to potentially declare certain inherited
120 -- subprograms that were inherited by types in the visible part, but whose
121 -- declaration was deferred because the parent operation was private and
122 -- not visible at that point. These subprograms are located by traversing
123 -- the visible part declarations looking for non-private type extensions
124 -- and then examining each of the primitive operations of such types to
125 -- find those that were inherited but declared with a special internal
126 -- name. Each such operation is now declared as an operation with a normal
127 -- name (using the name of the parent operation) and replaces the previous
128 -- implicit operation in the primitive operations list of the type. If the
129 -- inherited private operation has been overridden, then it's replaced by
130 -- the overriding operation.
132 procedure Install_Package_Entity (Id : Entity_Id);
133 -- Supporting procedure for Install_{Visible,Private}_Declarations. Places
134 -- one entity on its visibility chain, and recurses on the visible part if
135 -- the entity is an inner package.
137 function Is_Private_Base_Type (E : Entity_Id) return Boolean;
138 -- True for a private type that is not a subtype
140 function Is_Visible_Dependent (Dep : Entity_Id) return Boolean;
141 -- If the private dependent is a private type whose full view is derived
142 -- from the parent type, its full properties are revealed only if we are in
143 -- the immediate scope of the private dependent. Should this predicate be
144 -- tightened further???
146 function Requires_Completion_In_Body
147 (Id : Entity_Id;
148 Pack_Id : Entity_Id;
149 Do_Abstract_States : Boolean := False) return Boolean;
150 -- Subsidiary to routines Unit_Requires_Body and Unit_Requires_Body_Info.
151 -- Determine whether entity Id declared in package spec Pack_Id requires
152 -- completion in a package body. Flag Do_Abstract_Stats should be set when
153 -- abstract states are to be considered in the completion test.
155 procedure Unit_Requires_Body_Info (Pack_Id : Entity_Id);
156 -- Outputs info messages showing why package Pack_Id requires a body. The
157 -- caller has checked that the switch requesting this information is set,
158 -- and that the package does indeed require a body.
160 --------------------------
161 -- Analyze_Package_Body --
162 --------------------------
164 procedure Analyze_Package_Body (N : Node_Id) is
165 Loc : constant Source_Ptr := Sloc (N);
167 begin
168 if Debug_Flag_C then
169 Write_Str ("==> package body ");
170 Write_Name (Chars (Defining_Entity (N)));
171 Write_Str (" from ");
172 Write_Location (Loc);
173 Write_Eol;
174 Indent;
175 end if;
177 -- The real work is split out into the helper, so it can do "return;"
178 -- without skipping the debug output.
180 Analyze_Package_Body_Helper (N);
182 if Debug_Flag_C then
183 Outdent;
184 Write_Str ("<== package body ");
185 Write_Name (Chars (Defining_Entity (N)));
186 Write_Str (" from ");
187 Write_Location (Loc);
188 Write_Eol;
189 end if;
190 end Analyze_Package_Body;
192 ------------------------------------------------------
193 -- Analyze_Package_Body_Helper Data and Subprograms --
194 ------------------------------------------------------
196 Entity_Table_Size : constant := 4093;
197 -- Number of headers in hash table
199 subtype Entity_Header_Num is Integer range 0 .. Entity_Table_Size - 1;
200 -- Range of headers in hash table
202 function Node_Hash (Id : Entity_Id) return Entity_Header_Num;
203 -- Simple hash function for Entity_Ids
205 package Subprogram_Table is new GNAT.Htable.Simple_HTable
206 (Header_Num => Entity_Header_Num,
207 Element => Boolean,
208 No_Element => False,
209 Key => Entity_Id,
210 Hash => Node_Hash,
211 Equal => "=");
212 -- Hash table to record which subprograms are referenced. It is declared
213 -- at library level to avoid elaborating it for every call to Analyze.
215 package Traversed_Table is new GNAT.Htable.Simple_HTable
216 (Header_Num => Entity_Header_Num,
217 Element => Boolean,
218 No_Element => False,
219 Key => Node_Id,
220 Hash => Node_Hash,
221 Equal => "=");
222 -- Hash table to record which nodes we have traversed, so we can avoid
223 -- traversing the same nodes repeatedly.
225 -----------------
226 -- Node_Hash --
227 -----------------
229 function Node_Hash (Id : Entity_Id) return Entity_Header_Num is
230 begin
231 return Entity_Header_Num (Id mod Entity_Table_Size);
232 end Node_Hash;
234 ---------------------------------
235 -- Analyze_Package_Body_Helper --
236 ---------------------------------
238 -- WARNING: This routine manages Ghost regions. Return statements must be
239 -- replaced by gotos which jump to the end of the routine and restore the
240 -- Ghost mode.
242 procedure Analyze_Package_Body_Helper (N : Node_Id) is
243 procedure Hide_Public_Entities (Decls : List_Id);
244 -- Attempt to hide all public entities found in declarative list Decls
245 -- by resetting their Is_Public flag to False depending on whether the
246 -- entities are not referenced by inlined or generic bodies. This kind
247 -- of processing is a conservative approximation and will still leave
248 -- entities externally visible if the package is not simple enough.
250 procedure Install_Composite_Operations (P : Entity_Id);
251 -- Composite types declared in the current scope may depend on types
252 -- that were private at the point of declaration, and whose full view
253 -- is now in scope. Indicate that the corresponding operations on the
254 -- composite type are available.
256 --------------------------
257 -- Hide_Public_Entities --
258 --------------------------
260 procedure Hide_Public_Entities (Decls : List_Id) is
261 function Has_Referencer
262 (Decls : List_Id;
263 Top_Level : Boolean := False) return Boolean;
264 -- A "referencer" is a construct which may reference a previous
265 -- declaration. Examine all declarations in list Decls in reverse
266 -- and determine whether once such referencer exists. All entities
267 -- in the range Last (Decls) .. Referencer are hidden from external
268 -- visibility.
270 function Scan_Subprogram_Ref (N : Node_Id) return Traverse_Result;
271 -- Determine whether a node denotes a reference to a subprogram
273 procedure Traverse_And_Scan_Subprogram_Refs is
274 new Traverse_Proc (Scan_Subprogram_Ref);
275 -- Subsidiary to routine Has_Referencer. Determine whether a node
276 -- contains references to a subprogram and record them.
277 -- WARNING: this is a very expensive routine as it performs a full
278 -- tree traversal.
280 procedure Scan_Subprogram_Refs (Node : Node_Id);
281 -- If we haven't already traversed Node, then mark it and traverse
282 -- it.
284 --------------------
285 -- Has_Referencer --
286 --------------------
288 function Has_Referencer
289 (Decls : List_Id;
290 Top_Level : Boolean := False) return Boolean
292 Decl : Node_Id;
293 Decl_Id : Entity_Id;
294 Spec : Node_Id;
296 Has_Non_Subprograms_Referencer : Boolean := False;
297 -- Set if an inlined subprogram body was detected as a referencer.
298 -- In this case, we do not return True immediately but keep hiding
299 -- subprograms from external visibility.
301 begin
302 if No (Decls) then
303 return False;
304 end if;
306 -- Examine all declarations in reverse order, hiding all entities
307 -- from external visibility until a referencer has been found. The
308 -- algorithm recurses into nested packages.
310 Decl := Last (Decls);
311 while Present (Decl) loop
313 -- A stub is always considered a referencer
315 if Nkind (Decl) in N_Body_Stub then
316 return True;
318 -- Package declaration
320 elsif Nkind (Decl) = N_Package_Declaration then
321 Spec := Specification (Decl);
323 -- Inspect the declarations of a non-generic package to try
324 -- and hide more entities from external visibility.
326 if not Is_Generic_Unit (Defining_Entity (Spec)) then
327 if Has_Referencer (Private_Declarations (Spec))
328 or else Has_Referencer (Visible_Declarations (Spec))
329 then
330 return True;
331 end if;
332 end if;
334 -- Package body
336 elsif Nkind (Decl) = N_Package_Body
337 and then Present (Corresponding_Spec (Decl))
338 then
339 Decl_Id := Corresponding_Spec (Decl);
341 -- A generic package body is a referencer. It would seem
342 -- that we only have to consider generics that can be
343 -- exported, i.e. where the corresponding spec is the
344 -- spec of the current package, but because of nested
345 -- instantiations, a fully private generic body may export
346 -- other private body entities. Furthermore, regardless of
347 -- whether there was a previous inlined subprogram, (an
348 -- instantiation of) the generic package may reference any
349 -- entity declared before it.
351 if Is_Generic_Unit (Decl_Id) then
352 return True;
354 -- Inspect the declarations of a non-generic package body to
355 -- try and hide more entities from external visibility.
357 elsif Has_Referencer (Declarations (Decl)) then
358 return True;
359 end if;
361 -- Subprogram body
363 elsif Nkind (Decl) = N_Subprogram_Body then
364 if Present (Corresponding_Spec (Decl)) then
365 Decl_Id := Corresponding_Spec (Decl);
367 -- A generic subprogram body acts as a referencer
369 if Is_Generic_Unit (Decl_Id) then
370 return True;
371 end if;
373 -- An inlined subprogram body acts as a referencer
375 -- Note that we test Has_Pragma_Inline here in addition
376 -- to Is_Inlined. We are doing this for a client, since
377 -- we are computing which entities should be public, and
378 -- it is the client who will decide if actual inlining
379 -- should occur, so we need to catch all cases where the
380 -- subprogram may be inlined by the client.
382 if Is_Inlined (Decl_Id)
383 or else Has_Pragma_Inline (Decl_Id)
384 then
385 Has_Non_Subprograms_Referencer := True;
387 -- Inspect the statements of the subprogram body
388 -- to determine whether the body references other
389 -- subprograms.
391 Scan_Subprogram_Refs (Decl);
392 end if;
394 -- Otherwise this is a stand alone subprogram body
396 else
397 Decl_Id := Defining_Entity (Decl);
399 -- An inlined subprogram body acts as a referencer
401 if Is_Inlined (Decl_Id)
402 or else Has_Pragma_Inline (Decl_Id)
403 then
404 Has_Non_Subprograms_Referencer := True;
406 -- Inspect the statements of the subprogram body
407 -- to determine whether the body references other
408 -- subprograms.
410 Scan_Subprogram_Refs (Decl);
412 -- Otherwise we can reset Is_Public right away
414 elsif not Subprogram_Table.Get (Decl_Id) then
415 Set_Is_Public (Decl_Id, False);
416 end if;
417 end if;
419 -- Freeze node
421 elsif Nkind (Decl) = N_Freeze_Entity then
422 declare
423 Discard : Boolean;
424 pragma Unreferenced (Discard);
425 begin
426 -- Inspect the actions to find references to subprograms
428 Discard := Has_Referencer (Actions (Decl));
429 end;
431 -- Exceptions, objects and renamings do not need to be public
432 -- if they are not followed by a construct which can reference
433 -- and export them. The Is_Public flag is reset on top level
434 -- entities only as anything nested is local to its context.
435 -- Likewise for subprograms, but we work harder for them.
437 elsif Nkind_In (Decl, N_Exception_Declaration,
438 N_Object_Declaration,
439 N_Object_Renaming_Declaration,
440 N_Subprogram_Declaration,
441 N_Subprogram_Renaming_Declaration)
442 then
443 Decl_Id := Defining_Entity (Decl);
445 if Top_Level
446 and then not Is_Imported (Decl_Id)
447 and then not Is_Exported (Decl_Id)
448 and then No (Interface_Name (Decl_Id))
449 and then
450 (not Has_Non_Subprograms_Referencer
451 or else (Nkind (Decl) = N_Subprogram_Declaration
452 and then not Subprogram_Table.Get (Decl_Id)))
453 then
454 Set_Is_Public (Decl_Id, False);
455 end if;
457 -- For a subprogram renaming, if the entity is referenced,
458 -- then so is the renamed subprogram. But there is an issue
459 -- with generic bodies because instantiations are not done
460 -- yet and, therefore, cannot be scanned for referencers.
461 -- That's why we use an approximation and test that we have
462 -- at least one subprogram referenced by an inlined body
463 -- instead of precisely the entity of this renaming.
465 if Nkind (Decl) = N_Subprogram_Renaming_Declaration
466 and then Subprogram_Table.Get_First
467 and then Is_Entity_Name (Name (Decl))
468 and then Present (Entity (Name (Decl)))
469 and then Is_Subprogram (Entity (Name (Decl)))
470 then
471 Subprogram_Table.Set (Entity (Name (Decl)), True);
472 end if;
473 end if;
475 Prev (Decl);
476 end loop;
478 return Has_Non_Subprograms_Referencer;
479 end Has_Referencer;
481 -------------------------
482 -- Scan_Subprogram_Ref --
483 -------------------------
485 function Scan_Subprogram_Ref (N : Node_Id) return Traverse_Result is
486 begin
487 -- Detect a reference of the form
488 -- Subp_Call
490 if Nkind (N) in N_Subprogram_Call
491 and then Is_Entity_Name (Name (N))
492 and then Present (Entity (Name (N)))
493 and then Is_Subprogram (Entity (Name (N)))
494 then
495 Subprogram_Table.Set (Entity (Name (N)), True);
497 -- Detect a reference of the form
498 -- Subp'Some_Attribute
500 elsif Nkind (N) = N_Attribute_Reference
501 and then Is_Entity_Name (Prefix (N))
502 and then Present (Entity (Prefix (N)))
503 and then Is_Subprogram (Entity (Prefix (N)))
504 then
505 Subprogram_Table.Set (Entity (Prefix (N)), True);
507 -- Constants can be substituted by their value in gigi, which may
508 -- contain a reference, so scan the value recursively.
510 elsif Is_Entity_Name (N)
511 and then Present (Entity (N))
512 and then Ekind (Entity (N)) = E_Constant
513 then
514 declare
515 Val : constant Node_Id := Constant_Value (Entity (N));
516 begin
517 if Present (Val)
518 and then not Compile_Time_Known_Value (Val)
519 then
520 Scan_Subprogram_Refs (Val);
521 end if;
522 end;
523 end if;
525 return OK;
526 end Scan_Subprogram_Ref;
528 --------------------------
529 -- Scan_Subprogram_Refs --
530 --------------------------
532 procedure Scan_Subprogram_Refs (Node : Node_Id) is
533 begin
534 if not Traversed_Table.Get (Node) then
535 Traversed_Table.Set (Node, True);
536 Traverse_And_Scan_Subprogram_Refs (Node);
537 end if;
538 end Scan_Subprogram_Refs;
540 -- Local variables
542 Discard : Boolean;
543 pragma Unreferenced (Discard);
545 -- Start of processing for Hide_Public_Entities
547 begin
548 -- The algorithm examines the top level declarations of a package
549 -- body in reverse looking for a construct that may export entities
550 -- declared prior to it. If such a scenario is encountered, then all
551 -- entities in the range Last (Decls) .. construct are hidden from
552 -- external visibility. Consider:
554 -- package Pack is
555 -- generic
556 -- package Gen is
557 -- end Gen;
558 -- end Pack;
560 -- package body Pack is
561 -- External_Obj : ...; -- (1)
563 -- package body Gen is -- (2)
564 -- ... External_Obj ... -- (3)
565 -- end Gen;
567 -- Local_Obj : ...; -- (4)
568 -- end Pack;
570 -- In this example Local_Obj (4) must not be externally visible as
571 -- it cannot be exported by anything in Pack. The body of generic
572 -- package Gen (2) on the other hand acts as a "referencer" and may
573 -- export anything declared before it. Since the compiler does not
574 -- perform flow analysis, it is not possible to determine precisely
575 -- which entities will be exported when Gen is instantiated. In the
576 -- example above External_Obj (1) is exported at (3), but this may
577 -- not always be the case. The algorithm takes a conservative stance
578 -- and leaves entity External_Obj public.
580 -- This very conservative algorithm is supplemented by a more precise
581 -- processing for inlined bodies. For them, we traverse the syntactic
582 -- tree and record which subprograms are actually referenced from it.
583 -- This makes it possible to compute a much smaller set of externally
584 -- visible subprograms in the absence of generic bodies, which can
585 -- have a significant impact on the inlining decisions made in the
586 -- back end and the removal of out-of-line bodies from the object
587 -- code. We do it only for inlined bodies because they are supposed
588 -- to be reasonably small and tree traversal is very expensive.
590 -- Note that even this special processing is not optimal for inlined
591 -- bodies, because we treat all inlined subprograms alike. An optimal
592 -- algorithm would require computing the transitive closure of the
593 -- inlined subprograms that can really be referenced from other units
594 -- in the source code.
596 -- We could extend this processing for inlined bodies and record all
597 -- entities, not just subprograms, referenced from them, which would
598 -- make it possible to compute a much smaller set of all externally
599 -- visible entities in the absence of generic bodies. But this would
600 -- mean implementing a more thorough tree traversal of the bodies,
601 -- i.e. not just syntactic, and the gain would very likely be worth
602 -- neither the hassle nor the slowdown of the compiler.
604 -- Finally, an important thing to be aware of is that, at this point,
605 -- instantiations are not done yet so we cannot directly see inlined
606 -- bodies coming from them. That's not catastrophic because only the
607 -- actual parameters of the instantiations matter here, and they are
608 -- present in the declarations list of the instantiated packages.
610 Traversed_Table.Reset;
611 Subprogram_Table.Reset;
612 Discard := Has_Referencer (Decls, Top_Level => True);
613 end Hide_Public_Entities;
615 ----------------------------------
616 -- Install_Composite_Operations --
617 ----------------------------------
619 procedure Install_Composite_Operations (P : Entity_Id) is
620 Id : Entity_Id;
622 begin
623 Id := First_Entity (P);
624 while Present (Id) loop
625 if Is_Type (Id)
626 and then (Is_Limited_Composite (Id)
627 or else Is_Private_Composite (Id))
628 and then No (Private_Component (Id))
629 then
630 Set_Is_Limited_Composite (Id, False);
631 Set_Is_Private_Composite (Id, False);
632 end if;
634 Next_Entity (Id);
635 end loop;
636 end Install_Composite_Operations;
638 -- Local variables
640 Saved_GM : constant Ghost_Mode_Type := Ghost_Mode;
641 Saved_ISMP : constant Boolean :=
642 Ignore_SPARK_Mode_Pragmas_In_Instance;
643 -- Save the Ghost and SPARK mode-related data to restore on exit
645 Body_Id : Entity_Id;
646 HSS : Node_Id;
647 Last_Spec_Entity : Entity_Id;
648 New_N : Node_Id;
649 Pack_Decl : Node_Id;
650 Spec_Id : Entity_Id;
652 -- Start of processing for Analyze_Package_Body_Helper
654 begin
655 -- Find corresponding package specification, and establish the current
656 -- scope. The visible defining entity for the package is the defining
657 -- occurrence in the spec. On exit from the package body, all body
658 -- declarations are attached to the defining entity for the body, but
659 -- the later is never used for name resolution. In this fashion there
660 -- is only one visible entity that denotes the package.
662 -- Set Body_Id. Note that this will be reset to point to the generic
663 -- copy later on in the generic case.
665 Body_Id := Defining_Entity (N);
667 -- Body is body of package instantiation. Corresponding spec has already
668 -- been set.
670 if Present (Corresponding_Spec (N)) then
671 Spec_Id := Corresponding_Spec (N);
672 Pack_Decl := Unit_Declaration_Node (Spec_Id);
674 else
675 Spec_Id := Current_Entity_In_Scope (Defining_Entity (N));
677 if Present (Spec_Id)
678 and then Is_Package_Or_Generic_Package (Spec_Id)
679 then
680 Pack_Decl := Unit_Declaration_Node (Spec_Id);
682 if Nkind (Pack_Decl) = N_Package_Renaming_Declaration then
683 Error_Msg_N ("cannot supply body for package renaming", N);
684 return;
686 elsif Present (Corresponding_Body (Pack_Decl)) then
687 Error_Msg_N ("redefinition of package body", N);
688 return;
689 end if;
691 else
692 Error_Msg_N ("missing specification for package body", N);
693 return;
694 end if;
696 if Is_Package_Or_Generic_Package (Spec_Id)
697 and then (Scope (Spec_Id) = Standard_Standard
698 or else Is_Child_Unit (Spec_Id))
699 and then not Unit_Requires_Body (Spec_Id)
700 then
701 if Ada_Version = Ada_83 then
702 Error_Msg_N
703 ("optional package body (not allowed in Ada 95)??", N);
704 else
705 Error_Msg_N ("spec of this package does not allow a body", N);
706 end if;
707 end if;
708 end if;
710 -- A [generic] package body freezes the contract of the nearest
711 -- enclosing package body and all other contracts encountered in
712 -- the same declarative part up to and excluding the package body:
714 -- package body Nearest_Enclosing_Package
715 -- with Refined_State => (State => Constit)
716 -- is
717 -- Constit : ...;
719 -- package body Freezes_Enclosing_Package_Body
720 -- with Refined_State => (State_2 => Constit_2)
721 -- is
722 -- Constit_2 : ...;
724 -- procedure Proc
725 -- with Refined_Depends => (Input => (Constit, Constit_2)) ...
727 -- This ensures that any annotations referenced by the contract of a
728 -- [generic] subprogram body declared within the current package body
729 -- are available. This form of freezing is decoupled from the usual
730 -- Freeze_xxx mechanism because it must also work in the context of
731 -- generics where normal freezing is disabled.
733 -- Only bodies coming from source should cause this type of freezing.
734 -- Instantiated generic bodies are excluded because their processing is
735 -- performed in a separate compilation pass which lacks enough semantic
736 -- information with respect to contract analysis. It is safe to suppress
737 -- the freezing of contracts in this case because this action already
738 -- took place at the end of the enclosing declarative part.
740 if Comes_From_Source (N)
741 and then not Is_Generic_Instance (Spec_Id)
742 then
743 Freeze_Previous_Contracts (N);
744 end if;
746 -- A package body is Ghost when the corresponding spec is Ghost. Set
747 -- the mode now to ensure that any nodes generated during analysis and
748 -- expansion are properly flagged as ignored Ghost.
750 Mark_And_Set_Ghost_Body (N, Spec_Id);
752 Set_Is_Compilation_Unit (Body_Id, Is_Compilation_Unit (Spec_Id));
753 Style.Check_Identifier (Body_Id, Spec_Id);
755 if Is_Child_Unit (Spec_Id) then
756 if Nkind (Parent (N)) /= N_Compilation_Unit then
757 Error_Msg_NE
758 ("body of child unit& cannot be an inner package", N, Spec_Id);
759 end if;
761 Set_Is_Child_Unit (Body_Id);
762 end if;
764 -- Generic package case
766 if Ekind (Spec_Id) = E_Generic_Package then
768 -- Disable expansion and perform semantic analysis on copy. The
769 -- unannotated body will be used in all instantiations.
771 Body_Id := Defining_Entity (N);
772 Set_Ekind (Body_Id, E_Package_Body);
773 Set_Scope (Body_Id, Scope (Spec_Id));
774 Set_Is_Obsolescent (Body_Id, Is_Obsolescent (Spec_Id));
775 Set_Body_Entity (Spec_Id, Body_Id);
776 Set_Spec_Entity (Body_Id, Spec_Id);
778 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
779 Rewrite (N, New_N);
781 -- Once the contents of the generic copy and the template are
782 -- swapped, do the same for their respective aspect specifications.
784 Exchange_Aspects (N, New_N);
786 -- Collect all contract-related source pragmas found within the
787 -- template and attach them to the contract of the package body.
788 -- This contract is used in the capture of global references within
789 -- annotations.
791 Create_Generic_Contract (N);
793 -- Update Body_Id to point to the copied node for the remainder of
794 -- the processing.
796 Body_Id := Defining_Entity (N);
797 Start_Generic;
798 end if;
800 -- The Body_Id is that of the copied node in the generic case, the
801 -- current node otherwise. Note that N was rewritten above, so we must
802 -- be sure to get the latest Body_Id value.
804 Set_Ekind (Body_Id, E_Package_Body);
805 Set_Body_Entity (Spec_Id, Body_Id);
806 Set_Spec_Entity (Body_Id, Spec_Id);
808 -- Defining name for the package body is not a visible entity: Only the
809 -- defining name for the declaration is visible.
811 Set_Etype (Body_Id, Standard_Void_Type);
812 Set_Scope (Body_Id, Scope (Spec_Id));
813 Set_Corresponding_Spec (N, Spec_Id);
814 Set_Corresponding_Body (Pack_Decl, Body_Id);
816 -- The body entity is not used for semantics or code generation, but
817 -- it is attached to the entity list of the enclosing scope to simplify
818 -- the listing of back-annotations for the types it main contain.
820 if Scope (Spec_Id) /= Standard_Standard then
821 Append_Entity (Body_Id, Scope (Spec_Id));
822 end if;
824 -- Indicate that we are currently compiling the body of the package
826 Set_In_Package_Body (Spec_Id);
827 Set_Has_Completion (Spec_Id);
828 Last_Spec_Entity := Last_Entity (Spec_Id);
830 if Has_Aspects (N) then
831 Analyze_Aspect_Specifications (N, Body_Id);
832 end if;
834 Push_Scope (Spec_Id);
836 -- Set SPARK_Mode only for non-generic package
838 if Ekind (Spec_Id) = E_Package then
839 Set_SPARK_Pragma (Body_Id, SPARK_Mode_Pragma);
840 Set_SPARK_Aux_Pragma (Body_Id, SPARK_Mode_Pragma);
841 Set_SPARK_Pragma_Inherited (Body_Id);
842 Set_SPARK_Aux_Pragma_Inherited (Body_Id);
844 -- A package body may be instantiated or inlined at a later pass.
845 -- Restore the state of Ignore_SPARK_Mode_Pragmas_In_Instance when
846 -- it applied to the package spec.
848 if Ignore_SPARK_Mode_Pragmas (Spec_Id) then
849 Ignore_SPARK_Mode_Pragmas_In_Instance := True;
850 end if;
851 end if;
853 Set_Categorization_From_Pragmas (N);
855 Install_Visible_Declarations (Spec_Id);
856 Install_Private_Declarations (Spec_Id);
857 Install_Private_With_Clauses (Spec_Id);
858 Install_Composite_Operations (Spec_Id);
860 Check_Anonymous_Access_Types (Spec_Id, N);
862 if Ekind (Spec_Id) = E_Generic_Package then
863 Set_Use (Generic_Formal_Declarations (Pack_Decl));
864 end if;
866 Set_Use (Visible_Declarations (Specification (Pack_Decl)));
867 Set_Use (Private_Declarations (Specification (Pack_Decl)));
869 -- This is a nested package, so it may be necessary to declare certain
870 -- inherited subprograms that are not yet visible because the parent
871 -- type's subprograms are now visible.
873 if Ekind (Scope (Spec_Id)) = E_Package
874 and then Scope (Spec_Id) /= Standard_Standard
875 then
876 Declare_Inherited_Private_Subprograms (Spec_Id);
877 end if;
879 if Present (Declarations (N)) then
880 Analyze_Declarations (Declarations (N));
881 Inspect_Deferred_Constant_Completion (Declarations (N));
882 end if;
884 -- Verify that the SPARK_Mode of the body agrees with that of its spec
886 if Present (SPARK_Pragma (Body_Id)) then
887 if Present (SPARK_Aux_Pragma (Spec_Id)) then
888 if Get_SPARK_Mode_From_Annotation (SPARK_Aux_Pragma (Spec_Id)) =
890 and then
891 Get_SPARK_Mode_From_Annotation (SPARK_Pragma (Body_Id)) = On
892 then
893 Error_Msg_Sloc := Sloc (SPARK_Pragma (Body_Id));
894 Error_Msg_N ("incorrect application of SPARK_Mode#", N);
895 Error_Msg_Sloc := Sloc (SPARK_Aux_Pragma (Spec_Id));
896 Error_Msg_NE
897 ("\value Off was set for SPARK_Mode on & #", N, Spec_Id);
898 end if;
900 else
901 Error_Msg_Sloc := Sloc (SPARK_Pragma (Body_Id));
902 Error_Msg_N ("incorrect application of SPARK_Mode#", N);
903 Error_Msg_Sloc := Sloc (Spec_Id);
904 Error_Msg_NE
905 ("\no value was set for SPARK_Mode on & #", N, Spec_Id);
906 end if;
907 end if;
909 -- Analyze_Declarations has caused freezing of all types. Now generate
910 -- bodies for RACW primitives and stream attributes, if any.
912 if Ekind (Spec_Id) = E_Package and then Has_RACW (Spec_Id) then
914 -- Attach subprogram bodies to support RACWs declared in spec
916 Append_RACW_Bodies (Declarations (N), Spec_Id);
917 Analyze_List (Declarations (N));
918 end if;
920 HSS := Handled_Statement_Sequence (N);
922 if Present (HSS) then
923 Process_End_Label (HSS, 't', Spec_Id);
924 Analyze (HSS);
926 -- Check that elaboration code in a preelaborable package body is
927 -- empty other than null statements and labels (RM 10.2.1(6)).
929 Validate_Null_Statement_Sequence (N);
930 end if;
932 Validate_Categorization_Dependency (N, Spec_Id);
933 Check_Completion (Body_Id);
935 -- Generate start of body reference. Note that we do this fairly late,
936 -- because the call will use In_Extended_Main_Source_Unit as a check,
937 -- and we want to make sure that Corresponding_Stub links are set
939 Generate_Reference (Spec_Id, Body_Id, 'b', Set_Ref => False);
941 -- For a generic package, collect global references and mark them on
942 -- the original body so that they are not resolved again at the point
943 -- of instantiation.
945 if Ekind (Spec_Id) /= E_Package then
946 Save_Global_References (Original_Node (N));
947 End_Generic;
948 end if;
950 -- The entities of the package body have so far been chained onto the
951 -- declaration chain for the spec. That's been fine while we were in the
952 -- body, since we wanted them to be visible, but now that we are leaving
953 -- the package body, they are no longer visible, so we remove them from
954 -- the entity chain of the package spec entity, and copy them to the
955 -- entity chain of the package body entity, where they will never again
956 -- be visible.
958 if Present (Last_Spec_Entity) then
959 Set_First_Entity (Body_Id, Next_Entity (Last_Spec_Entity));
960 Set_Next_Entity (Last_Spec_Entity, Empty);
961 Set_Last_Entity (Body_Id, Last_Entity (Spec_Id));
962 Set_Last_Entity (Spec_Id, Last_Spec_Entity);
964 else
965 Set_First_Entity (Body_Id, First_Entity (Spec_Id));
966 Set_Last_Entity (Body_Id, Last_Entity (Spec_Id));
967 Set_First_Entity (Spec_Id, Empty);
968 Set_Last_Entity (Spec_Id, Empty);
969 end if;
971 Update_Use_Clause_Chain;
972 End_Package_Scope (Spec_Id);
974 -- All entities declared in body are not visible
976 declare
977 E : Entity_Id;
979 begin
980 E := First_Entity (Body_Id);
981 while Present (E) loop
982 Set_Is_Immediately_Visible (E, False);
983 Set_Is_Potentially_Use_Visible (E, False);
984 Set_Is_Hidden (E);
986 -- Child units may appear on the entity list (e.g. if they appear
987 -- in the context of a subunit) but they are not body entities.
989 if not Is_Child_Unit (E) then
990 Set_Is_Package_Body_Entity (E);
991 end if;
993 Next_Entity (E);
994 end loop;
995 end;
997 Check_References (Body_Id);
999 -- For a generic unit, check that the formal parameters are referenced,
1000 -- and that local variables are used, as for regular packages.
1002 if Ekind (Spec_Id) = E_Generic_Package then
1003 Check_References (Spec_Id);
1004 end if;
1006 -- At this point all entities of the package body are externally visible
1007 -- to the linker as their Is_Public flag is set to True. This proactive
1008 -- approach is necessary because an inlined or a generic body for which
1009 -- code is generated in other units may need to see these entities. Cut
1010 -- down the number of global symbols that do not neet public visibility
1011 -- as this has two beneficial effects:
1012 -- (1) It makes the compilation process more efficient.
1013 -- (2) It gives the code generator more leeway to optimize within each
1014 -- unit, especially subprograms.
1016 -- This is done only for top-level library packages or child units as
1017 -- the algorithm does a top-down traversal of the package body.
1019 if (Scope (Spec_Id) = Standard_Standard or else Is_Child_Unit (Spec_Id))
1020 and then not Is_Generic_Unit (Spec_Id)
1021 then
1022 Hide_Public_Entities (Declarations (N));
1023 end if;
1025 -- If expander is not active, then here is where we turn off the
1026 -- In_Package_Body flag, otherwise it is turned off at the end of the
1027 -- corresponding expansion routine. If this is an instance body, we need
1028 -- to qualify names of local entities, because the body may have been
1029 -- compiled as a preliminary to another instantiation.
1031 if not Expander_Active then
1032 Set_In_Package_Body (Spec_Id, False);
1034 if Is_Generic_Instance (Spec_Id)
1035 and then Operating_Mode = Generate_Code
1036 then
1037 Qualify_Entity_Names (N);
1038 end if;
1039 end if;
1041 Ignore_SPARK_Mode_Pragmas_In_Instance := Saved_ISMP;
1042 Restore_Ghost_Mode (Saved_GM);
1043 end Analyze_Package_Body_Helper;
1045 ---------------------------------
1046 -- Analyze_Package_Declaration --
1047 ---------------------------------
1049 procedure Analyze_Package_Declaration (N : Node_Id) is
1050 Id : constant Node_Id := Defining_Entity (N);
1052 Is_Comp_Unit : constant Boolean :=
1053 Nkind (Parent (N)) = N_Compilation_Unit;
1055 Body_Required : Boolean;
1056 -- True when this package declaration requires a corresponding body
1058 begin
1059 if Debug_Flag_C then
1060 Write_Str ("==> package spec ");
1061 Write_Name (Chars (Id));
1062 Write_Str (" from ");
1063 Write_Location (Sloc (N));
1064 Write_Eol;
1065 Indent;
1066 end if;
1068 Generate_Definition (Id);
1069 Enter_Name (Id);
1070 Set_Ekind (Id, E_Package);
1071 Set_Etype (Id, Standard_Void_Type);
1073 -- Set SPARK_Mode from context
1075 Set_SPARK_Pragma (Id, SPARK_Mode_Pragma);
1076 Set_SPARK_Aux_Pragma (Id, SPARK_Mode_Pragma);
1077 Set_SPARK_Pragma_Inherited (Id);
1078 Set_SPARK_Aux_Pragma_Inherited (Id);
1080 -- Save the state of flag Ignore_SPARK_Mode_Pragmas_In_Instance in case
1081 -- the body of this package is instantiated or inlined later and out of
1082 -- context. The body uses this attribute to restore the value of the
1083 -- global flag.
1085 if Ignore_SPARK_Mode_Pragmas_In_Instance then
1086 Set_Ignore_SPARK_Mode_Pragmas (Id);
1087 end if;
1089 -- Analyze aspect specifications immediately, since we need to recognize
1090 -- things like Pure early enough to diagnose violations during analysis.
1092 if Has_Aspects (N) then
1093 Analyze_Aspect_Specifications (N, Id);
1094 end if;
1096 -- Ada 2005 (AI-217): Check if the package has been illegally named in
1097 -- a limited-with clause of its own context. In this case the error has
1098 -- been previously notified by Analyze_Context.
1100 -- limited with Pkg; -- ERROR
1101 -- package Pkg is ...
1103 if From_Limited_With (Id) then
1104 return;
1105 end if;
1107 Push_Scope (Id);
1109 Set_Is_Pure (Id, Is_Pure (Enclosing_Lib_Unit_Entity));
1110 Set_Categorization_From_Pragmas (N);
1112 Analyze (Specification (N));
1113 Validate_Categorization_Dependency (N, Id);
1115 -- Determine whether the package requires a body. Abstract states are
1116 -- intentionally ignored because they do require refinement which can
1117 -- only come in a body, but at the same time they do not force the need
1118 -- for a body on their own (SPARK RM 7.1.4(4) and 7.2.2(3)).
1120 Body_Required := Unit_Requires_Body (Id);
1122 if not Body_Required then
1124 -- If the package spec does not require an explicit body, then there
1125 -- are not entities requiring completion in the language sense. Call
1126 -- Check_Completion now to ensure that nested package declarations
1127 -- that require an implicit body get one. (In the case where a body
1128 -- is required, Check_Completion is called at the end of the body's
1129 -- declarative part.)
1131 Check_Completion;
1133 -- If the package spec does not require an explicit body, then all
1134 -- abstract states declared in nested packages cannot possibly get
1135 -- a proper refinement (SPARK RM 7.2.2(3)). This check is performed
1136 -- only when the compilation unit is the main unit to allow for
1137 -- modular SPARK analysis where packages do not necessarily have
1138 -- bodies.
1140 if Is_Comp_Unit then
1141 Check_State_Refinements
1142 (Context => N,
1143 Is_Main_Unit => Parent (N) = Cunit (Main_Unit));
1144 end if;
1145 end if;
1147 -- Set Body_Required indication on the compilation unit node
1149 if Is_Comp_Unit then
1150 Set_Body_Required (Parent (N), Body_Required);
1151 end if;
1153 End_Package_Scope (Id);
1155 -- For the declaration of a library unit that is a remote types package,
1156 -- check legality rules regarding availability of stream attributes for
1157 -- types that contain non-remote access values. This subprogram performs
1158 -- visibility tests that rely on the fact that we have exited the scope
1159 -- of Id.
1161 if Is_Comp_Unit then
1162 Validate_RT_RAT_Component (N);
1163 end if;
1165 if Debug_Flag_C then
1166 Outdent;
1167 Write_Str ("<== package spec ");
1168 Write_Name (Chars (Id));
1169 Write_Str (" from ");
1170 Write_Location (Sloc (N));
1171 Write_Eol;
1172 end if;
1173 end Analyze_Package_Declaration;
1175 -----------------------------------
1176 -- Analyze_Package_Specification --
1177 -----------------------------------
1179 -- Note that this code is shared for the analysis of generic package specs
1180 -- (see Sem_Ch12.Analyze_Generic_Package_Declaration for details).
1182 procedure Analyze_Package_Specification (N : Node_Id) is
1183 Id : constant Entity_Id := Defining_Entity (N);
1184 Orig_Decl : constant Node_Id := Original_Node (Parent (N));
1185 Vis_Decls : constant List_Id := Visible_Declarations (N);
1186 Priv_Decls : constant List_Id := Private_Declarations (N);
1187 E : Entity_Id;
1188 L : Entity_Id;
1189 Public_Child : Boolean;
1191 Private_With_Clauses_Installed : Boolean := False;
1192 -- In Ada 2005, private with_clauses are visible in the private part
1193 -- of a nested package, even if it appears in the public part of the
1194 -- enclosing package. This requires a separate step to install these
1195 -- private_with_clauses, and remove them at the end of the nested
1196 -- package.
1198 procedure Check_One_Tagged_Type_Or_Extension_At_Most;
1199 -- Issue an error in SPARK mode if a package specification contains
1200 -- more than one tagged type or type extension.
1202 procedure Clear_Constants (Id : Entity_Id; FE : Entity_Id);
1203 -- Clears constant indications (Never_Set_In_Source, Constant_Value, and
1204 -- Is_True_Constant) on all variables that are entities of Id, and on
1205 -- the chain whose first element is FE. A recursive call is made for all
1206 -- packages and generic packages.
1208 procedure Generate_Parent_References;
1209 -- For a child unit, generate references to parent units, for
1210 -- GPS navigation purposes.
1212 function Is_Public_Child (Child, Unit : Entity_Id) return Boolean;
1213 -- Child and Unit are entities of compilation units. True if Child
1214 -- is a public child of Parent as defined in 10.1.1
1216 procedure Inspect_Unchecked_Union_Completion (Decls : List_Id);
1217 -- Reject completion of an incomplete or private type declarations
1218 -- having a known discriminant part by an unchecked union.
1220 procedure Install_Parent_Private_Declarations (Inst_Id : Entity_Id);
1221 -- Given the package entity of a generic package instantiation or
1222 -- formal package whose corresponding generic is a child unit, installs
1223 -- the private declarations of each of the child unit's parents.
1224 -- This has to be done at the point of entering the instance package's
1225 -- private part rather than being done in Sem_Ch12.Install_Parent
1226 -- (which is where the parents' visible declarations are installed).
1228 ------------------------------------------------
1229 -- Check_One_Tagged_Type_Or_Extension_At_Most --
1230 ------------------------------------------------
1232 procedure Check_One_Tagged_Type_Or_Extension_At_Most is
1233 Previous : Node_Id;
1235 procedure Check_Decls (Decls : List_Id);
1236 -- Check that either Previous is Empty and Decls does not contain
1237 -- more than one tagged type or type extension, or Previous is
1238 -- already set and Decls contains no tagged type or type extension.
1240 -----------------
1241 -- Check_Decls --
1242 -----------------
1244 procedure Check_Decls (Decls : List_Id) is
1245 Decl : Node_Id;
1247 begin
1248 Decl := First (Decls);
1249 while Present (Decl) loop
1250 if Nkind (Decl) = N_Full_Type_Declaration
1251 and then Is_Tagged_Type (Defining_Identifier (Decl))
1252 then
1253 if No (Previous) then
1254 Previous := Decl;
1256 else
1257 Error_Msg_Sloc := Sloc (Previous);
1258 Check_SPARK_05_Restriction
1259 ("at most one tagged type or type extension allowed",
1260 "\\ previous declaration#",
1261 Decl);
1262 end if;
1263 end if;
1265 Next (Decl);
1266 end loop;
1267 end Check_Decls;
1269 -- Start of processing for Check_One_Tagged_Type_Or_Extension_At_Most
1271 begin
1272 Previous := Empty;
1273 Check_Decls (Vis_Decls);
1275 if Present (Priv_Decls) then
1276 Check_Decls (Priv_Decls);
1277 end if;
1278 end Check_One_Tagged_Type_Or_Extension_At_Most;
1280 ---------------------
1281 -- Clear_Constants --
1282 ---------------------
1284 procedure Clear_Constants (Id : Entity_Id; FE : Entity_Id) is
1285 E : Entity_Id;
1287 begin
1288 -- Ignore package renamings, not interesting and they can cause self
1289 -- referential loops in the code below.
1291 if Nkind (Parent (Id)) = N_Package_Renaming_Declaration then
1292 return;
1293 end if;
1295 -- Note: in the loop below, the check for Next_Entity pointing back
1296 -- to the package entity may seem odd, but it is needed, because a
1297 -- package can contain a renaming declaration to itself, and such
1298 -- renamings are generated automatically within package instances.
1300 E := FE;
1301 while Present (E) and then E /= Id loop
1302 if Is_Assignable (E) then
1303 Set_Never_Set_In_Source (E, False);
1304 Set_Is_True_Constant (E, False);
1305 Set_Current_Value (E, Empty);
1306 Set_Is_Known_Null (E, False);
1307 Set_Last_Assignment (E, Empty);
1309 if not Can_Never_Be_Null (E) then
1310 Set_Is_Known_Non_Null (E, False);
1311 end if;
1313 elsif Is_Package_Or_Generic_Package (E) then
1314 Clear_Constants (E, First_Entity (E));
1315 Clear_Constants (E, First_Private_Entity (E));
1316 end if;
1318 Next_Entity (E);
1319 end loop;
1320 end Clear_Constants;
1322 --------------------------------
1323 -- Generate_Parent_References --
1324 --------------------------------
1326 procedure Generate_Parent_References is
1327 Decl : constant Node_Id := Parent (N);
1329 begin
1330 if Id = Cunit_Entity (Main_Unit)
1331 or else Parent (Decl) = Library_Unit (Cunit (Main_Unit))
1332 then
1333 Generate_Reference (Id, Scope (Id), 'k', False);
1335 elsif not Nkind_In (Unit (Cunit (Main_Unit)), N_Subprogram_Body,
1336 N_Subunit)
1337 then
1338 -- If current unit is an ancestor of main unit, generate a
1339 -- reference to its own parent.
1341 declare
1342 U : Node_Id;
1343 Main_Spec : Node_Id := Unit (Cunit (Main_Unit));
1345 begin
1346 if Nkind (Main_Spec) = N_Package_Body then
1347 Main_Spec := Unit (Library_Unit (Cunit (Main_Unit)));
1348 end if;
1350 U := Parent_Spec (Main_Spec);
1351 while Present (U) loop
1352 if U = Parent (Decl) then
1353 Generate_Reference (Id, Scope (Id), 'k', False);
1354 exit;
1356 elsif Nkind (Unit (U)) = N_Package_Body then
1357 exit;
1359 else
1360 U := Parent_Spec (Unit (U));
1361 end if;
1362 end loop;
1363 end;
1364 end if;
1365 end Generate_Parent_References;
1367 ---------------------
1368 -- Is_Public_Child --
1369 ---------------------
1371 function Is_Public_Child (Child, Unit : Entity_Id) return Boolean is
1372 begin
1373 if not Is_Private_Descendant (Child) then
1374 return True;
1375 else
1376 if Child = Unit then
1377 return not Private_Present (
1378 Parent (Unit_Declaration_Node (Child)));
1379 else
1380 return Is_Public_Child (Scope (Child), Unit);
1381 end if;
1382 end if;
1383 end Is_Public_Child;
1385 ----------------------------------------
1386 -- Inspect_Unchecked_Union_Completion --
1387 ----------------------------------------
1389 procedure Inspect_Unchecked_Union_Completion (Decls : List_Id) is
1390 Decl : Node_Id;
1392 begin
1393 Decl := First (Decls);
1394 while Present (Decl) loop
1396 -- We are looking at an incomplete or private type declaration
1397 -- with a known_discriminant_part whose full view is an
1398 -- Unchecked_Union.
1400 if Nkind_In (Decl, N_Incomplete_Type_Declaration,
1401 N_Private_Type_Declaration)
1402 and then Has_Discriminants (Defining_Identifier (Decl))
1403 and then Present (Full_View (Defining_Identifier (Decl)))
1404 and then
1405 Is_Unchecked_Union (Full_View (Defining_Identifier (Decl)))
1406 then
1407 Error_Msg_N
1408 ("completion of discriminated partial view "
1409 & "cannot be an unchecked union",
1410 Full_View (Defining_Identifier (Decl)));
1411 end if;
1413 Next (Decl);
1414 end loop;
1415 end Inspect_Unchecked_Union_Completion;
1417 -----------------------------------------
1418 -- Install_Parent_Private_Declarations --
1419 -----------------------------------------
1421 procedure Install_Parent_Private_Declarations (Inst_Id : Entity_Id) is
1422 Inst_Par : Entity_Id;
1423 Gen_Par : Entity_Id;
1424 Inst_Node : Node_Id;
1426 begin
1427 Inst_Par := Inst_Id;
1429 Gen_Par :=
1430 Generic_Parent (Specification (Unit_Declaration_Node (Inst_Par)));
1431 while Present (Gen_Par) and then Is_Child_Unit (Gen_Par) loop
1432 Inst_Node := Get_Unit_Instantiation_Node (Inst_Par);
1434 if Nkind_In (Inst_Node, N_Package_Instantiation,
1435 N_Formal_Package_Declaration)
1436 and then Nkind (Name (Inst_Node)) = N_Expanded_Name
1437 then
1438 Inst_Par := Entity (Prefix (Name (Inst_Node)));
1440 if Present (Renamed_Entity (Inst_Par)) then
1441 Inst_Par := Renamed_Entity (Inst_Par);
1442 end if;
1444 Gen_Par :=
1445 Generic_Parent
1446 (Specification (Unit_Declaration_Node (Inst_Par)));
1448 -- Install the private declarations and private use clauses
1449 -- of a parent instance of the child instance, unless the
1450 -- parent instance private declarations have already been
1451 -- installed earlier in Analyze_Package_Specification, which
1452 -- happens when a generic child is instantiated, and the
1453 -- instance is a child of the parent instance.
1455 -- Installing the use clauses of the parent instance twice
1456 -- is both unnecessary and wrong, because it would cause the
1457 -- clauses to be chained to themselves in the use clauses
1458 -- list of the scope stack entry. That in turn would cause
1459 -- an endless loop from End_Use_Clauses upon scope exit.
1461 -- The parent is now fully visible. It may be a hidden open
1462 -- scope if we are currently compiling some child instance
1463 -- declared within it, but while the current instance is being
1464 -- compiled the parent is immediately visible. In particular
1465 -- its entities must remain visible if a stack save/restore
1466 -- takes place through a call to Rtsfind.
1468 if Present (Gen_Par) then
1469 if not In_Private_Part (Inst_Par) then
1470 Install_Private_Declarations (Inst_Par);
1471 Set_Use (Private_Declarations
1472 (Specification
1473 (Unit_Declaration_Node (Inst_Par))));
1474 Set_Is_Hidden_Open_Scope (Inst_Par, False);
1475 end if;
1477 -- If we've reached the end of the generic instance parents,
1478 -- then finish off by looping through the nongeneric parents
1479 -- and installing their private declarations.
1481 -- If one of the non-generic parents is itself on the scope
1482 -- stack, do not install its private declarations: they are
1483 -- installed in due time when the private part of that parent
1484 -- is analyzed.
1486 else
1487 while Present (Inst_Par)
1488 and then Inst_Par /= Standard_Standard
1489 and then (not In_Open_Scopes (Inst_Par)
1490 or else not In_Private_Part (Inst_Par))
1491 loop
1492 if Nkind (Inst_Node) = N_Formal_Package_Declaration
1493 or else
1494 not Is_Ancestor_Package
1495 (Inst_Par, Cunit_Entity (Current_Sem_Unit))
1496 then
1497 Install_Private_Declarations (Inst_Par);
1498 Set_Use
1499 (Private_Declarations
1500 (Specification
1501 (Unit_Declaration_Node (Inst_Par))));
1502 Inst_Par := Scope (Inst_Par);
1503 else
1504 exit;
1505 end if;
1506 end loop;
1508 exit;
1509 end if;
1511 else
1512 exit;
1513 end if;
1514 end loop;
1515 end Install_Parent_Private_Declarations;
1517 -- Start of processing for Analyze_Package_Specification
1519 begin
1520 if Present (Vis_Decls) then
1521 Analyze_Declarations (Vis_Decls);
1522 end if;
1524 -- Inspect the entities defined in the package and ensure that all
1525 -- incomplete types have received full declarations. Build default
1526 -- initial condition and invariant procedures for all qualifying types.
1528 E := First_Entity (Id);
1529 while Present (E) loop
1531 -- Check on incomplete types
1533 -- AI05-0213: A formal incomplete type has no completion, and neither
1534 -- does the corresponding subtype in an instance.
1536 if Is_Incomplete_Type (E)
1537 and then No (Full_View (E))
1538 and then not Is_Generic_Type (E)
1539 and then not From_Limited_With (E)
1540 and then not Is_Generic_Actual_Type (E)
1541 then
1542 Error_Msg_N ("no declaration in visible part for incomplete}", E);
1543 end if;
1545 Next_Entity (E);
1546 end loop;
1548 if Is_Remote_Call_Interface (Id)
1549 and then Nkind (Parent (Parent (N))) = N_Compilation_Unit
1550 then
1551 Validate_RCI_Declarations (Id);
1552 end if;
1554 -- Save global references in the visible declarations, before installing
1555 -- private declarations of parent unit if there is one, because the
1556 -- privacy status of types defined in the parent will change. This is
1557 -- only relevant for generic child units, but is done in all cases for
1558 -- uniformity.
1560 if Ekind (Id) = E_Generic_Package
1561 and then Nkind (Orig_Decl) = N_Generic_Package_Declaration
1562 then
1563 declare
1564 Orig_Spec : constant Node_Id := Specification (Orig_Decl);
1565 Save_Priv : constant List_Id := Private_Declarations (Orig_Spec);
1567 begin
1568 -- Insert the freezing nodes after the visible declarations to
1569 -- ensure that we analyze its aspects; needed to ensure that
1570 -- global entities referenced in the aspects are properly handled.
1572 if Ada_Version >= Ada_2012
1573 and then Is_Non_Empty_List (Vis_Decls)
1574 and then Is_Empty_List (Priv_Decls)
1575 then
1576 Insert_List_After_And_Analyze
1577 (Last (Vis_Decls), Freeze_Entity (Id, Last (Vis_Decls)));
1578 end if;
1580 Set_Private_Declarations (Orig_Spec, Empty_List);
1581 Save_Global_References (Orig_Decl);
1582 Set_Private_Declarations (Orig_Spec, Save_Priv);
1583 end;
1584 end if;
1586 -- If package is a public child unit, then make the private declarations
1587 -- of the parent visible.
1589 Public_Child := False;
1591 declare
1592 Par : Entity_Id;
1593 Pack_Decl : Node_Id;
1594 Par_Spec : Node_Id;
1596 begin
1597 Par := Id;
1598 Par_Spec := Parent_Spec (Parent (N));
1600 -- If the package is formal package of an enclosing generic, it is
1601 -- transformed into a local generic declaration, and compiled to make
1602 -- its spec available. We need to retrieve the original generic to
1603 -- determine whether it is a child unit, and install its parents.
1605 if No (Par_Spec)
1606 and then
1607 Nkind (Original_Node (Parent (N))) = N_Formal_Package_Declaration
1608 then
1609 Par := Entity (Name (Original_Node (Parent (N))));
1610 Par_Spec := Parent_Spec (Unit_Declaration_Node (Par));
1611 end if;
1613 if Present (Par_Spec) then
1614 Generate_Parent_References;
1616 while Scope (Par) /= Standard_Standard
1617 and then Is_Public_Child (Id, Par)
1618 and then In_Open_Scopes (Par)
1619 loop
1620 Public_Child := True;
1621 Par := Scope (Par);
1622 Install_Private_Declarations (Par);
1623 Install_Private_With_Clauses (Par);
1624 Pack_Decl := Unit_Declaration_Node (Par);
1625 Set_Use (Private_Declarations (Specification (Pack_Decl)));
1626 end loop;
1627 end if;
1628 end;
1630 if Is_Compilation_Unit (Id) then
1631 Install_Private_With_Clauses (Id);
1632 else
1633 -- The current compilation unit may include private with_clauses,
1634 -- which are visible in the private part of the current nested
1635 -- package, and have to be installed now. This is not done for
1636 -- nested instantiations, where the private with_clauses of the
1637 -- enclosing unit have no effect once the instantiation info is
1638 -- established and we start analyzing the package declaration.
1640 declare
1641 Comp_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
1642 begin
1643 if Is_Package_Or_Generic_Package (Comp_Unit)
1644 and then not In_Private_Part (Comp_Unit)
1645 and then not In_Instance
1646 then
1647 Install_Private_With_Clauses (Comp_Unit);
1648 Private_With_Clauses_Installed := True;
1649 end if;
1650 end;
1651 end if;
1653 -- If this is a package associated with a generic instance or formal
1654 -- package, then the private declarations of each of the generic's
1655 -- parents must be installed at this point.
1657 if Is_Generic_Instance (Id) then
1658 Install_Parent_Private_Declarations (Id);
1659 end if;
1661 -- Analyze private part if present. The flag In_Private_Part is reset
1662 -- in End_Package_Scope.
1664 L := Last_Entity (Id);
1666 if Present (Priv_Decls) then
1667 Set_In_Private_Part (Id);
1669 -- Upon entering a public child's private part, it may be necessary
1670 -- to declare subprograms that were derived in the package's visible
1671 -- part but not yet made visible.
1673 if Public_Child then
1674 Declare_Inherited_Private_Subprograms (Id);
1675 end if;
1677 Analyze_Declarations (Priv_Decls);
1679 -- Check the private declarations for incomplete deferred constants
1681 Inspect_Deferred_Constant_Completion (Priv_Decls);
1683 -- The first private entity is the immediate follower of the last
1684 -- visible entity, if there was one.
1686 if Present (L) then
1687 Set_First_Private_Entity (Id, Next_Entity (L));
1688 else
1689 Set_First_Private_Entity (Id, First_Entity (Id));
1690 end if;
1692 -- There may be inherited private subprograms that need to be declared,
1693 -- even in the absence of an explicit private part. If there are any
1694 -- public declarations in the package and the package is a public child
1695 -- unit, then an implicit private part is assumed.
1697 elsif Present (L) and then Public_Child then
1698 Set_In_Private_Part (Id);
1699 Declare_Inherited_Private_Subprograms (Id);
1700 Set_First_Private_Entity (Id, Next_Entity (L));
1701 end if;
1703 E := First_Entity (Id);
1704 while Present (E) loop
1706 -- Check rule of 3.6(11), which in general requires waiting till all
1707 -- full types have been seen.
1709 if Ekind (E) = E_Record_Type or else Ekind (E) = E_Array_Type then
1710 Check_Aliased_Component_Types (E);
1711 end if;
1713 -- Check preelaborable initialization for full type completing a
1714 -- private type for which pragma Preelaborable_Initialization given.
1716 if Is_Type (E)
1717 and then Must_Have_Preelab_Init (E)
1718 and then not Has_Preelaborable_Initialization (E)
1719 then
1720 Error_Msg_N
1721 ("full view of & does not have preelaborable initialization", E);
1722 end if;
1724 Next_Entity (E);
1725 end loop;
1727 -- Ada 2005 (AI-216): The completion of an incomplete or private type
1728 -- declaration having a known_discriminant_part shall not be an
1729 -- unchecked union type.
1731 if Present (Vis_Decls) then
1732 Inspect_Unchecked_Union_Completion (Vis_Decls);
1733 end if;
1735 if Present (Priv_Decls) then
1736 Inspect_Unchecked_Union_Completion (Priv_Decls);
1737 end if;
1739 if Ekind (Id) = E_Generic_Package
1740 and then Nkind (Orig_Decl) = N_Generic_Package_Declaration
1741 and then Present (Priv_Decls)
1742 then
1743 -- Save global references in private declarations, ignoring the
1744 -- visible declarations that were processed earlier.
1746 declare
1747 Orig_Spec : constant Node_Id := Specification (Orig_Decl);
1748 Save_Vis : constant List_Id := Visible_Declarations (Orig_Spec);
1749 Save_Form : constant List_Id :=
1750 Generic_Formal_Declarations (Orig_Decl);
1752 begin
1753 -- Insert the freezing nodes after the private declarations to
1754 -- ensure that we analyze its aspects; needed to ensure that
1755 -- global entities referenced in the aspects are properly handled.
1757 if Ada_Version >= Ada_2012
1758 and then Is_Non_Empty_List (Priv_Decls)
1759 then
1760 Insert_List_After_And_Analyze
1761 (Last (Priv_Decls), Freeze_Entity (Id, Last (Priv_Decls)));
1762 end if;
1764 Set_Visible_Declarations (Orig_Spec, Empty_List);
1765 Set_Generic_Formal_Declarations (Orig_Decl, Empty_List);
1766 Save_Global_References (Orig_Decl);
1767 Set_Generic_Formal_Declarations (Orig_Decl, Save_Form);
1768 Set_Visible_Declarations (Orig_Spec, Save_Vis);
1769 end;
1770 end if;
1772 Process_End_Label (N, 'e', Id);
1774 -- Remove private_with_clauses of enclosing compilation unit, if they
1775 -- were installed.
1777 if Private_With_Clauses_Installed then
1778 Remove_Private_With_Clauses (Cunit (Current_Sem_Unit));
1779 end if;
1781 -- For the case of a library level package, we must go through all the
1782 -- entities clearing the indications that the value may be constant and
1783 -- not modified. Why? Because any client of this package may modify
1784 -- these values freely from anywhere. This also applies to any nested
1785 -- packages or generic packages.
1787 -- For now we unconditionally clear constants for packages that are
1788 -- instances of generic packages. The reason is that we do not have the
1789 -- body yet, and we otherwise think things are unreferenced when they
1790 -- are not. This should be fixed sometime (the effect is not terrible,
1791 -- we just lose some warnings, and also some cases of value propagation)
1792 -- ???
1794 if Is_Library_Level_Entity (Id)
1795 or else Is_Generic_Instance (Id)
1796 then
1797 Clear_Constants (Id, First_Entity (Id));
1798 Clear_Constants (Id, First_Private_Entity (Id));
1799 end if;
1801 -- Issue an error in SPARK mode if a package specification contains
1802 -- more than one tagged type or type extension.
1804 Check_One_Tagged_Type_Or_Extension_At_Most;
1806 -- Output relevant information as to why the package requires a body.
1807 -- Do not consider generated packages as this exposes internal symbols
1808 -- and leads to confusing messages.
1810 if List_Body_Required_Info
1811 and then In_Extended_Main_Source_Unit (Id)
1812 and then Unit_Requires_Body (Id)
1813 and then Comes_From_Source (Id)
1814 then
1815 Unit_Requires_Body_Info (Id);
1816 end if;
1818 -- Nested package specs that do not require bodies are not checked for
1819 -- ineffective use clauses due to the possbility of subunits. This is
1820 -- because at this stage it is impossible to tell whether there will be
1821 -- a separate body.
1823 if not Unit_Requires_Body (Id)
1824 and then Is_Compilation_Unit (Id)
1825 and then not Is_Private_Descendant (Id)
1826 then
1827 Update_Use_Clause_Chain;
1828 end if;
1829 end Analyze_Package_Specification;
1831 --------------------------------------
1832 -- Analyze_Private_Type_Declaration --
1833 --------------------------------------
1835 procedure Analyze_Private_Type_Declaration (N : Node_Id) is
1836 Id : constant Entity_Id := Defining_Identifier (N);
1837 PF : constant Boolean := Is_Pure (Enclosing_Lib_Unit_Entity);
1839 begin
1840 Generate_Definition (Id);
1841 Set_Is_Pure (Id, PF);
1842 Init_Size_Align (Id);
1844 if not Is_Package_Or_Generic_Package (Current_Scope)
1845 or else In_Private_Part (Current_Scope)
1846 then
1847 Error_Msg_N ("invalid context for private declaration", N);
1848 end if;
1850 New_Private_Type (N, Id, N);
1851 Set_Depends_On_Private (Id);
1853 -- Set the SPARK mode from the current context
1855 Set_SPARK_Pragma (Id, SPARK_Mode_Pragma);
1856 Set_SPARK_Pragma_Inherited (Id);
1858 if Has_Aspects (N) then
1859 Analyze_Aspect_Specifications (N, Id);
1860 end if;
1861 end Analyze_Private_Type_Declaration;
1863 ----------------------------------
1864 -- Check_Anonymous_Access_Types --
1865 ----------------------------------
1867 procedure Check_Anonymous_Access_Types
1868 (Spec_Id : Entity_Id;
1869 P_Body : Node_Id)
1871 E : Entity_Id;
1872 IR : Node_Id;
1874 begin
1875 -- Itype references are only needed by gigi, to force elaboration of
1876 -- itypes. In the absence of code generation, they are not needed.
1878 if not Expander_Active then
1879 return;
1880 end if;
1882 E := First_Entity (Spec_Id);
1883 while Present (E) loop
1884 if Ekind (E) = E_Anonymous_Access_Type
1885 and then From_Limited_With (E)
1886 then
1887 IR := Make_Itype_Reference (Sloc (P_Body));
1888 Set_Itype (IR, E);
1890 if No (Declarations (P_Body)) then
1891 Set_Declarations (P_Body, New_List (IR));
1892 else
1893 Prepend (IR, Declarations (P_Body));
1894 end if;
1895 end if;
1897 Next_Entity (E);
1898 end loop;
1899 end Check_Anonymous_Access_Types;
1901 -------------------------------------------
1902 -- Declare_Inherited_Private_Subprograms --
1903 -------------------------------------------
1905 procedure Declare_Inherited_Private_Subprograms (Id : Entity_Id) is
1907 function Is_Primitive_Of (T : Entity_Id; S : Entity_Id) return Boolean;
1908 -- Check whether an inherited subprogram S is an operation of an
1909 -- untagged derived type T.
1911 ---------------------
1912 -- Is_Primitive_Of --
1913 ---------------------
1915 function Is_Primitive_Of (T : Entity_Id; S : Entity_Id) return Boolean is
1916 Formal : Entity_Id;
1918 begin
1919 -- If the full view is a scalar type, the type is the anonymous base
1920 -- type, but the operation mentions the first subtype, so check the
1921 -- signature against the base type.
1923 if Base_Type (Etype (S)) = Base_Type (T) then
1924 return True;
1926 else
1927 Formal := First_Formal (S);
1928 while Present (Formal) loop
1929 if Base_Type (Etype (Formal)) = Base_Type (T) then
1930 return True;
1931 end if;
1933 Next_Formal (Formal);
1934 end loop;
1936 return False;
1937 end if;
1938 end Is_Primitive_Of;
1940 -- Local variables
1942 E : Entity_Id;
1943 Op_List : Elist_Id;
1944 Op_Elmt : Elmt_Id;
1945 Op_Elmt_2 : Elmt_Id;
1946 Prim_Op : Entity_Id;
1947 New_Op : Entity_Id := Empty;
1948 Parent_Subp : Entity_Id;
1949 Tag : Entity_Id;
1951 -- Start of processing for Declare_Inherited_Private_Subprograms
1953 begin
1954 E := First_Entity (Id);
1955 while Present (E) loop
1957 -- If the entity is a nonprivate type extension whose parent type
1958 -- is declared in an open scope, then the type may have inherited
1959 -- operations that now need to be made visible. Ditto if the entity
1960 -- is a formal derived type in a child unit.
1962 if ((Is_Derived_Type (E) and then not Is_Private_Type (E))
1963 or else
1964 (Nkind (Parent (E)) = N_Private_Extension_Declaration
1965 and then Is_Generic_Type (E)))
1966 and then In_Open_Scopes (Scope (Etype (E)))
1967 and then Is_Base_Type (E)
1968 then
1969 if Is_Tagged_Type (E) then
1970 Op_List := Primitive_Operations (E);
1971 New_Op := Empty;
1972 Tag := First_Tag_Component (E);
1974 Op_Elmt := First_Elmt (Op_List);
1975 while Present (Op_Elmt) loop
1976 Prim_Op := Node (Op_Elmt);
1978 -- Search primitives that are implicit operations with an
1979 -- internal name whose parent operation has a normal name.
1981 if Present (Alias (Prim_Op))
1982 and then Find_Dispatching_Type (Alias (Prim_Op)) /= E
1983 and then not Comes_From_Source (Prim_Op)
1984 and then Is_Internal_Name (Chars (Prim_Op))
1985 and then not Is_Internal_Name (Chars (Alias (Prim_Op)))
1986 then
1987 Parent_Subp := Alias (Prim_Op);
1989 -- Case 1: Check if the type has also an explicit
1990 -- overriding for this primitive.
1992 Op_Elmt_2 := Next_Elmt (Op_Elmt);
1993 while Present (Op_Elmt_2) loop
1995 -- Skip entities with attribute Interface_Alias since
1996 -- they are not overriding primitives (these entities
1997 -- link an interface primitive with their covering
1998 -- primitive)
2000 if Chars (Node (Op_Elmt_2)) = Chars (Parent_Subp)
2001 and then Type_Conformant (Prim_Op, Node (Op_Elmt_2))
2002 and then No (Interface_Alias (Node (Op_Elmt_2)))
2003 then
2004 -- The private inherited operation has been
2005 -- overridden by an explicit subprogram:
2006 -- replace the former by the latter.
2008 New_Op := Node (Op_Elmt_2);
2009 Replace_Elmt (Op_Elmt, New_Op);
2010 Remove_Elmt (Op_List, Op_Elmt_2);
2011 Set_Overridden_Operation (New_Op, Parent_Subp);
2013 -- We don't need to inherit its dispatching slot.
2014 -- Set_All_DT_Position has previously ensured that
2015 -- the same slot was assigned to the two primitives
2017 if Present (Tag)
2018 and then Present (DTC_Entity (New_Op))
2019 and then Present (DTC_Entity (Prim_Op))
2020 then
2021 pragma Assert
2022 (DT_Position (New_Op) = DT_Position (Prim_Op));
2023 null;
2024 end if;
2026 goto Next_Primitive;
2027 end if;
2029 Next_Elmt (Op_Elmt_2);
2030 end loop;
2032 -- Case 2: We have not found any explicit overriding and
2033 -- hence we need to declare the operation (i.e., make it
2034 -- visible).
2036 Derive_Subprogram (New_Op, Alias (Prim_Op), E, Etype (E));
2038 -- Inherit the dispatching slot if E is already frozen
2040 if Is_Frozen (E)
2041 and then Present (DTC_Entity (Alias (Prim_Op)))
2042 then
2043 Set_DTC_Entity_Value (E, New_Op);
2044 Set_DT_Position_Value (New_Op,
2045 DT_Position (Alias (Prim_Op)));
2046 end if;
2048 pragma Assert
2049 (Is_Dispatching_Operation (New_Op)
2050 and then Node (Last_Elmt (Op_List)) = New_Op);
2052 -- Substitute the new operation for the old one in the
2053 -- type's primitive operations list. Since the new
2054 -- operation was also just added to the end of list,
2055 -- the last element must be removed.
2057 -- (Question: is there a simpler way of declaring the
2058 -- operation, say by just replacing the name of the
2059 -- earlier operation, reentering it in the in the symbol
2060 -- table (how?), and marking it as private???)
2062 Replace_Elmt (Op_Elmt, New_Op);
2063 Remove_Last_Elmt (Op_List);
2064 end if;
2066 <<Next_Primitive>>
2067 Next_Elmt (Op_Elmt);
2068 end loop;
2070 -- Generate listing showing the contents of the dispatch table
2072 if Debug_Flag_ZZ then
2073 Write_DT (E);
2074 end if;
2076 else
2077 -- For untagged type, scan forward to locate inherited hidden
2078 -- operations.
2080 Prim_Op := Next_Entity (E);
2081 while Present (Prim_Op) loop
2082 if Is_Subprogram (Prim_Op)
2083 and then Present (Alias (Prim_Op))
2084 and then not Comes_From_Source (Prim_Op)
2085 and then Is_Internal_Name (Chars (Prim_Op))
2086 and then not Is_Internal_Name (Chars (Alias (Prim_Op)))
2087 and then Is_Primitive_Of (E, Prim_Op)
2088 then
2089 Derive_Subprogram (New_Op, Alias (Prim_Op), E, Etype (E));
2090 end if;
2092 Next_Entity (Prim_Op);
2094 -- Derived operations appear immediately after the type
2095 -- declaration (or the following subtype indication for
2096 -- a derived scalar type). Further declarations cannot
2097 -- include inherited operations of the type.
2099 if Present (Prim_Op) then
2100 exit when Ekind (Prim_Op) not in Overloadable_Kind;
2101 end if;
2102 end loop;
2103 end if;
2104 end if;
2106 Next_Entity (E);
2107 end loop;
2108 end Declare_Inherited_Private_Subprograms;
2110 -----------------------
2111 -- End_Package_Scope --
2112 -----------------------
2114 procedure End_Package_Scope (P : Entity_Id) is
2115 begin
2116 Uninstall_Declarations (P);
2117 Pop_Scope;
2118 end End_Package_Scope;
2120 ---------------------------
2121 -- Exchange_Declarations --
2122 ---------------------------
2124 procedure Exchange_Declarations (Id : Entity_Id) is
2125 Full_Id : constant Entity_Id := Full_View (Id);
2126 H1 : constant Entity_Id := Homonym (Id);
2127 Next1 : constant Entity_Id := Next_Entity (Id);
2128 H2 : Entity_Id;
2129 Next2 : Entity_Id;
2131 begin
2132 -- If missing full declaration for type, nothing to exchange
2134 if No (Full_Id) then
2135 return;
2136 end if;
2138 -- Otherwise complete the exchange, and preserve semantic links
2140 Next2 := Next_Entity (Full_Id);
2141 H2 := Homonym (Full_Id);
2143 -- Reset full declaration pointer to reflect the switched entities and
2144 -- readjust the next entity chains.
2146 Exchange_Entities (Id, Full_Id);
2148 Set_Next_Entity (Id, Next1);
2149 Set_Homonym (Id, H1);
2151 Set_Full_View (Full_Id, Id);
2152 Set_Next_Entity (Full_Id, Next2);
2153 Set_Homonym (Full_Id, H2);
2154 end Exchange_Declarations;
2156 ----------------------------
2157 -- Install_Package_Entity --
2158 ----------------------------
2160 procedure Install_Package_Entity (Id : Entity_Id) is
2161 begin
2162 if not Is_Internal (Id) then
2163 if Debug_Flag_E then
2164 Write_Str ("Install: ");
2165 Write_Name (Chars (Id));
2166 Write_Eol;
2167 end if;
2169 if Is_Child_Unit (Id) then
2170 null;
2172 -- Do not enter implicitly inherited non-overridden subprograms of
2173 -- a tagged type back into visibility if they have non-conformant
2174 -- homographs (Ada RM 8.3 12.3/2).
2176 elsif Is_Hidden_Non_Overridden_Subpgm (Id) then
2177 null;
2179 else
2180 Set_Is_Immediately_Visible (Id);
2181 end if;
2182 end if;
2183 end Install_Package_Entity;
2185 ----------------------------------
2186 -- Install_Private_Declarations --
2187 ----------------------------------
2189 procedure Install_Private_Declarations (P : Entity_Id) is
2190 Id : Entity_Id;
2191 Full : Entity_Id;
2192 Priv_Deps : Elist_Id;
2194 procedure Swap_Private_Dependents (Priv_Deps : Elist_Id);
2195 -- When the full view of a private type is made available, we do the
2196 -- same for its private dependents under proper visibility conditions.
2197 -- When compiling a grand-chid unit this needs to be done recursively.
2199 -----------------------------
2200 -- Swap_Private_Dependents --
2201 -----------------------------
2203 procedure Swap_Private_Dependents (Priv_Deps : Elist_Id) is
2204 Deps : Elist_Id;
2205 Priv : Entity_Id;
2206 Priv_Elmt : Elmt_Id;
2207 Is_Priv : Boolean;
2209 begin
2210 Priv_Elmt := First_Elmt (Priv_Deps);
2211 while Present (Priv_Elmt) loop
2212 Priv := Node (Priv_Elmt);
2214 -- Before the exchange, verify that the presence of the Full_View
2215 -- field. This field will be empty if the entity has already been
2216 -- installed due to a previous call.
2218 if Present (Full_View (Priv)) and then Is_Visible_Dependent (Priv)
2219 then
2220 if Is_Private_Type (Priv) then
2221 Deps := Private_Dependents (Priv);
2222 Is_Priv := True;
2223 else
2224 Is_Priv := False;
2225 end if;
2227 -- For each subtype that is swapped, we also swap the reference
2228 -- to it in Private_Dependents, to allow access to it when we
2229 -- swap them out in End_Package_Scope.
2231 Replace_Elmt (Priv_Elmt, Full_View (Priv));
2233 -- Ensure that both views of the dependent private subtype are
2234 -- immediately visible if within some open scope. Check full
2235 -- view before exchanging views.
2237 if In_Open_Scopes (Scope (Full_View (Priv))) then
2238 Set_Is_Immediately_Visible (Priv);
2239 end if;
2241 Exchange_Declarations (Priv);
2242 Set_Is_Immediately_Visible
2243 (Priv, In_Open_Scopes (Scope (Priv)));
2245 Set_Is_Potentially_Use_Visible
2246 (Priv, Is_Potentially_Use_Visible (Node (Priv_Elmt)));
2248 -- Within a child unit, recurse, except in generic child unit,
2249 -- which (unfortunately) handle private_dependents separately.
2251 if Is_Priv
2252 and then Is_Child_Unit (Cunit_Entity (Current_Sem_Unit))
2253 and then not Is_Empty_Elmt_List (Deps)
2254 and then not Inside_A_Generic
2255 then
2256 Swap_Private_Dependents (Deps);
2257 end if;
2258 end if;
2260 Next_Elmt (Priv_Elmt);
2261 end loop;
2262 end Swap_Private_Dependents;
2264 -- Start of processing for Install_Private_Declarations
2266 begin
2267 -- First exchange declarations for private types, so that the full
2268 -- declaration is visible. For each private type, we check its
2269 -- Private_Dependents list and also exchange any subtypes of or derived
2270 -- types from it. Finally, if this is a Taft amendment type, the
2271 -- incomplete declaration is irrelevant, and we want to link the
2272 -- eventual full declaration with the original private one so we
2273 -- also skip the exchange.
2275 Id := First_Entity (P);
2276 while Present (Id) and then Id /= First_Private_Entity (P) loop
2277 if Is_Private_Base_Type (Id)
2278 and then Present (Full_View (Id))
2279 and then Comes_From_Source (Full_View (Id))
2280 and then Scope (Full_View (Id)) = Scope (Id)
2281 and then Ekind (Full_View (Id)) /= E_Incomplete_Type
2282 then
2283 -- If there is a use-type clause on the private type, set the full
2284 -- view accordingly.
2286 Set_In_Use (Full_View (Id), In_Use (Id));
2287 Full := Full_View (Id);
2289 if Is_Private_Base_Type (Full)
2290 and then Has_Private_Declaration (Full)
2291 and then Nkind (Parent (Full)) = N_Full_Type_Declaration
2292 and then In_Open_Scopes (Scope (Etype (Full)))
2293 and then In_Package_Body (Current_Scope)
2294 and then not Is_Private_Type (Etype (Full))
2295 then
2296 -- This is the completion of a private type by a derivation
2297 -- from another private type which is not private anymore. This
2298 -- can only happen in a package nested within a child package,
2299 -- when the parent type is defined in the parent unit. At this
2300 -- point the current type is not private either, and we have
2301 -- to install the underlying full view, which is now visible.
2302 -- Save the current full view as well, so that all views can be
2303 -- restored on exit. It may seem that after compiling the child
2304 -- body there are not environments to restore, but the back-end
2305 -- expects those links to be valid, and freeze nodes depend on
2306 -- them.
2308 if No (Full_View (Full))
2309 and then Present (Underlying_Full_View (Full))
2310 then
2311 Set_Full_View (Id, Underlying_Full_View (Full));
2312 Set_Underlying_Full_View (Id, Full);
2313 Set_Is_Underlying_Full_View (Full);
2315 Set_Underlying_Full_View (Full, Empty);
2316 Set_Is_Frozen (Full_View (Id));
2317 end if;
2318 end if;
2320 Priv_Deps := Private_Dependents (Id);
2321 Exchange_Declarations (Id);
2322 Set_Is_Immediately_Visible (Id);
2323 Swap_Private_Dependents (Priv_Deps);
2324 end if;
2326 Next_Entity (Id);
2327 end loop;
2329 -- Next make other declarations in the private part visible as well
2331 Id := First_Private_Entity (P);
2332 while Present (Id) loop
2333 Install_Package_Entity (Id);
2334 Set_Is_Hidden (Id, False);
2335 Next_Entity (Id);
2336 end loop;
2338 -- An abstract state is partially refined when it has at least one
2339 -- Part_Of constituent. Since these constituents are being installed
2340 -- into visibility, update the partial refinement status of any state
2341 -- defined in the associated package, subject to at least one Part_Of
2342 -- constituent.
2344 if Ekind_In (P, E_Generic_Package, E_Package) then
2345 declare
2346 States : constant Elist_Id := Abstract_States (P);
2347 State_Elmt : Elmt_Id;
2348 State_Id : Entity_Id;
2350 begin
2351 if Present (States) then
2352 State_Elmt := First_Elmt (States);
2353 while Present (State_Elmt) loop
2354 State_Id := Node (State_Elmt);
2356 if Present (Part_Of_Constituents (State_Id)) then
2357 Set_Has_Partial_Visible_Refinement (State_Id);
2358 end if;
2360 Next_Elmt (State_Elmt);
2361 end loop;
2362 end if;
2363 end;
2364 end if;
2366 -- Indicate that the private part is currently visible, so it can be
2367 -- properly reset on exit.
2369 Set_In_Private_Part (P);
2370 end Install_Private_Declarations;
2372 ----------------------------------
2373 -- Install_Visible_Declarations --
2374 ----------------------------------
2376 procedure Install_Visible_Declarations (P : Entity_Id) is
2377 Id : Entity_Id;
2378 Last_Entity : Entity_Id;
2380 begin
2381 pragma Assert
2382 (Is_Package_Or_Generic_Package (P) or else Is_Record_Type (P));
2384 if Is_Package_Or_Generic_Package (P) then
2385 Last_Entity := First_Private_Entity (P);
2386 else
2387 Last_Entity := Empty;
2388 end if;
2390 Id := First_Entity (P);
2391 while Present (Id) and then Id /= Last_Entity loop
2392 Install_Package_Entity (Id);
2393 Next_Entity (Id);
2394 end loop;
2395 end Install_Visible_Declarations;
2397 --------------------------
2398 -- Is_Private_Base_Type --
2399 --------------------------
2401 function Is_Private_Base_Type (E : Entity_Id) return Boolean is
2402 begin
2403 return Ekind (E) = E_Private_Type
2404 or else Ekind (E) = E_Limited_Private_Type
2405 or else Ekind (E) = E_Record_Type_With_Private;
2406 end Is_Private_Base_Type;
2408 --------------------------
2409 -- Is_Visible_Dependent --
2410 --------------------------
2412 function Is_Visible_Dependent (Dep : Entity_Id) return Boolean
2414 S : constant Entity_Id := Scope (Dep);
2416 begin
2417 -- Renamings created for actual types have the visibility of the actual
2419 if Ekind (S) = E_Package
2420 and then Is_Generic_Instance (S)
2421 and then (Is_Generic_Actual_Type (Dep)
2422 or else Is_Generic_Actual_Type (Full_View (Dep)))
2423 then
2424 return True;
2426 elsif not (Is_Derived_Type (Dep))
2427 and then Is_Derived_Type (Full_View (Dep))
2428 then
2429 -- When instantiating a package body, the scope stack is empty, so
2430 -- check instead whether the dependent type is defined in the same
2431 -- scope as the instance itself.
2433 return In_Open_Scopes (S)
2434 or else (Is_Generic_Instance (Current_Scope)
2435 and then Scope (Dep) = Scope (Current_Scope));
2436 else
2437 return True;
2438 end if;
2439 end Is_Visible_Dependent;
2441 ----------------------------
2442 -- May_Need_Implicit_Body --
2443 ----------------------------
2445 procedure May_Need_Implicit_Body (E : Entity_Id) is
2446 P : constant Node_Id := Unit_Declaration_Node (E);
2447 S : constant Node_Id := Parent (P);
2448 B : Node_Id;
2449 Decls : List_Id;
2451 begin
2452 if not Has_Completion (E)
2453 and then Nkind (P) = N_Package_Declaration
2454 and then (Present (Activation_Chain_Entity (P)) or else Has_RACW (E))
2455 then
2456 B :=
2457 Make_Package_Body (Sloc (E),
2458 Defining_Unit_Name => Make_Defining_Identifier (Sloc (E),
2459 Chars => Chars (E)),
2460 Declarations => New_List);
2462 if Nkind (S) = N_Package_Specification then
2463 if Present (Private_Declarations (S)) then
2464 Decls := Private_Declarations (S);
2465 else
2466 Decls := Visible_Declarations (S);
2467 end if;
2468 else
2469 Decls := Declarations (S);
2470 end if;
2472 Append (B, Decls);
2473 Analyze (B);
2474 end if;
2475 end May_Need_Implicit_Body;
2477 ----------------------
2478 -- New_Private_Type --
2479 ----------------------
2481 procedure New_Private_Type (N : Node_Id; Id : Entity_Id; Def : Node_Id) is
2482 begin
2483 -- For other than Ada 2012, enter the name in the current scope
2485 if Ada_Version < Ada_2012 then
2486 Enter_Name (Id);
2488 -- Ada 2012 (AI05-0162): Enter the name in the current scope. Note that
2489 -- there may be an incomplete previous view.
2491 else
2492 declare
2493 Prev : Entity_Id;
2494 begin
2495 Prev := Find_Type_Name (N);
2496 pragma Assert (Prev = Id
2497 or else (Ekind (Prev) = E_Incomplete_Type
2498 and then Present (Full_View (Prev))
2499 and then Full_View (Prev) = Id));
2500 end;
2501 end if;
2503 if Limited_Present (Def) then
2504 Set_Ekind (Id, E_Limited_Private_Type);
2505 else
2506 Set_Ekind (Id, E_Private_Type);
2507 end if;
2509 Set_Etype (Id, Id);
2510 Set_Has_Delayed_Freeze (Id);
2511 Set_Is_First_Subtype (Id);
2512 Init_Size_Align (Id);
2514 Set_Is_Constrained (Id,
2515 No (Discriminant_Specifications (N))
2516 and then not Unknown_Discriminants_Present (N));
2518 -- Set tagged flag before processing discriminants, to catch illegal
2519 -- usage.
2521 Set_Is_Tagged_Type (Id, Tagged_Present (Def));
2523 Set_Discriminant_Constraint (Id, No_Elist);
2524 Set_Stored_Constraint (Id, No_Elist);
2526 if Present (Discriminant_Specifications (N)) then
2527 Push_Scope (Id);
2528 Process_Discriminants (N);
2529 End_Scope;
2531 elsif Unknown_Discriminants_Present (N) then
2532 Set_Has_Unknown_Discriminants (Id);
2533 end if;
2535 Set_Private_Dependents (Id, New_Elmt_List);
2537 if Tagged_Present (Def) then
2538 Set_Ekind (Id, E_Record_Type_With_Private);
2539 Set_Direct_Primitive_Operations (Id, New_Elmt_List);
2540 Set_Is_Abstract_Type (Id, Abstract_Present (Def));
2541 Set_Is_Limited_Record (Id, Limited_Present (Def));
2542 Set_Has_Delayed_Freeze (Id, True);
2544 -- Recognize Ada.Real_Time.Timing_Events.Timing_Events here
2546 if Is_RTE (Id, RE_Timing_Event) then
2547 Set_Has_Timing_Event (Id);
2548 end if;
2550 -- Create a class-wide type with the same attributes
2552 Make_Class_Wide_Type (Id);
2554 elsif Abstract_Present (Def) then
2555 Error_Msg_N ("only a tagged type can be abstract", N);
2556 end if;
2557 end New_Private_Type;
2559 ---------------------------------
2560 -- Requires_Completion_In_Body --
2561 ---------------------------------
2563 function Requires_Completion_In_Body
2564 (Id : Entity_Id;
2565 Pack_Id : Entity_Id;
2566 Do_Abstract_States : Boolean := False) return Boolean
2568 begin
2569 -- Always ignore child units. Child units get added to the entity list
2570 -- of a parent unit, but are not original entities of the parent, and
2571 -- so do not affect whether the parent needs a body.
2573 if Is_Child_Unit (Id) then
2574 return False;
2576 -- Ignore formal packages and their renamings
2578 elsif Ekind (Id) = E_Package
2579 and then Nkind (Original_Node (Unit_Declaration_Node (Id))) =
2580 N_Formal_Package_Declaration
2581 then
2582 return False;
2584 -- Otherwise test to see if entity requires a completion. Note that
2585 -- subprogram entities whose declaration does not come from source are
2586 -- ignored here on the basis that we assume the expander will provide an
2587 -- implicit completion at some point.
2589 elsif (Is_Overloadable (Id)
2590 and then not Ekind_In (Id, E_Enumeration_Literal, E_Operator)
2591 and then not Is_Abstract_Subprogram (Id)
2592 and then not Has_Completion (Id)
2593 and then Comes_From_Source (Parent (Id)))
2595 or else
2596 (Ekind (Id) = E_Package
2597 and then Id /= Pack_Id
2598 and then not Has_Completion (Id)
2599 and then Unit_Requires_Body (Id, Do_Abstract_States))
2601 or else
2602 (Ekind (Id) = E_Incomplete_Type
2603 and then No (Full_View (Id))
2604 and then not Is_Generic_Type (Id))
2606 or else
2607 (Ekind_In (Id, E_Task_Type, E_Protected_Type)
2608 and then not Has_Completion (Id))
2610 or else
2611 (Ekind (Id) = E_Generic_Package
2612 and then Id /= Pack_Id
2613 and then not Has_Completion (Id)
2614 and then Unit_Requires_Body (Id, Do_Abstract_States))
2616 or else
2617 (Is_Generic_Subprogram (Id)
2618 and then not Has_Completion (Id))
2619 then
2620 return True;
2622 -- Otherwise the entity does not require completion in a package body
2624 else
2625 return False;
2626 end if;
2627 end Requires_Completion_In_Body;
2629 ----------------------------
2630 -- Uninstall_Declarations --
2631 ----------------------------
2633 procedure Uninstall_Declarations (P : Entity_Id) is
2634 Decl : constant Node_Id := Unit_Declaration_Node (P);
2635 Id : Entity_Id;
2636 Full : Entity_Id;
2637 Priv_Elmt : Elmt_Id;
2638 Priv_Sub : Entity_Id;
2640 procedure Preserve_Full_Attributes (Priv : Entity_Id; Full : Entity_Id);
2641 -- Copy to the private declaration the attributes of the full view that
2642 -- need to be available for the partial view also.
2644 function Type_In_Use (T : Entity_Id) return Boolean;
2645 -- Check whether type or base type appear in an active use_type clause
2647 ------------------------------
2648 -- Preserve_Full_Attributes --
2649 ------------------------------
2651 procedure Preserve_Full_Attributes
2652 (Priv : Entity_Id;
2653 Full : Entity_Id)
2655 Full_Base : constant Entity_Id := Base_Type (Full);
2656 Priv_Is_Base_Type : constant Boolean := Is_Base_Type (Priv);
2658 begin
2659 Set_Size_Info (Priv, Full);
2660 Set_RM_Size (Priv, RM_Size (Full));
2661 Set_Size_Known_At_Compile_Time
2662 (Priv, Size_Known_At_Compile_Time (Full));
2663 Set_Is_Volatile (Priv, Is_Volatile (Full));
2664 Set_Treat_As_Volatile (Priv, Treat_As_Volatile (Full));
2665 Set_Is_Ada_2005_Only (Priv, Is_Ada_2005_Only (Full));
2666 Set_Is_Ada_2012_Only (Priv, Is_Ada_2012_Only (Full));
2667 Set_Has_Pragma_Unmodified (Priv, Has_Pragma_Unmodified (Full));
2668 Set_Has_Pragma_Unreferenced (Priv, Has_Pragma_Unreferenced (Full));
2669 Set_Has_Pragma_Unreferenced_Objects
2670 (Priv, Has_Pragma_Unreferenced_Objects
2671 (Full));
2672 if Is_Unchecked_Union (Full) then
2673 Set_Is_Unchecked_Union (Base_Type (Priv));
2674 end if;
2675 -- Why is atomic not copied here ???
2677 if Referenced (Full) then
2678 Set_Referenced (Priv);
2679 end if;
2681 if Priv_Is_Base_Type then
2682 Set_Is_Controlled_Active
2683 (Priv, Is_Controlled_Active (Full_Base));
2684 Set_Finalize_Storage_Only
2685 (Priv, Finalize_Storage_Only (Full_Base));
2686 Set_Has_Controlled_Component
2687 (Priv, Has_Controlled_Component (Full_Base));
2689 Propagate_Concurrent_Flags (Priv, Base_Type (Full));
2690 end if;
2692 Set_Freeze_Node (Priv, Freeze_Node (Full));
2694 -- Propagate Default_Initial_Condition-related attributes from the
2695 -- base type of the full view to the full view and vice versa. This
2696 -- may seem strange, but is necessary depending on which type
2697 -- triggered the generation of the DIC procedure body. As a result,
2698 -- both the full view and its base type carry the same DIC-related
2699 -- information.
2701 Propagate_DIC_Attributes (Full, From_Typ => Full_Base);
2702 Propagate_DIC_Attributes (Full_Base, From_Typ => Full);
2704 -- Propagate Default_Initial_Condition-related attributes from the
2705 -- full view to the private view.
2707 Propagate_DIC_Attributes (Priv, From_Typ => Full);
2709 -- Propagate invariant-related attributes from the base type of the
2710 -- full view to the full view and vice versa. This may seem strange,
2711 -- but is necessary depending on which type triggered the generation
2712 -- of the invariant procedure body. As a result, both the full view
2713 -- and its base type carry the same invariant-related information.
2715 Propagate_Invariant_Attributes (Full, From_Typ => Full_Base);
2716 Propagate_Invariant_Attributes (Full_Base, From_Typ => Full);
2718 -- Propagate invariant-related attributes from the full view to the
2719 -- private view.
2721 Propagate_Invariant_Attributes (Priv, From_Typ => Full);
2723 if Is_Tagged_Type (Priv)
2724 and then Is_Tagged_Type (Full)
2725 and then not Error_Posted (Full)
2726 then
2727 if Is_Tagged_Type (Priv) then
2729 -- If the type is tagged, the tag itself must be available on
2730 -- the partial view, for expansion purposes.
2732 Set_First_Entity (Priv, First_Entity (Full));
2734 -- If there are discriminants in the partial view, these remain
2735 -- visible. Otherwise only the tag itself is visible, and there
2736 -- are no nameable components in the partial view.
2738 if No (Last_Entity (Priv)) then
2739 Set_Last_Entity (Priv, First_Entity (Priv));
2740 end if;
2741 end if;
2743 Set_Has_Discriminants (Priv, Has_Discriminants (Full));
2745 if Has_Discriminants (Full) then
2746 Set_Discriminant_Constraint (Priv,
2747 Discriminant_Constraint (Full));
2748 end if;
2749 end if;
2750 end Preserve_Full_Attributes;
2752 -----------------
2753 -- Type_In_Use --
2754 -----------------
2756 function Type_In_Use (T : Entity_Id) return Boolean is
2757 begin
2758 return Scope (Base_Type (T)) = P
2759 and then (In_Use (T) or else In_Use (Base_Type (T)));
2760 end Type_In_Use;
2762 -- Start of processing for Uninstall_Declarations
2764 begin
2765 Id := First_Entity (P);
2766 while Present (Id) and then Id /= First_Private_Entity (P) loop
2767 if Debug_Flag_E then
2768 Write_Str ("unlinking visible entity ");
2769 Write_Int (Int (Id));
2770 Write_Eol;
2771 end if;
2773 -- On exit from the package scope, we must preserve the visibility
2774 -- established by use clauses in the current scope. Two cases:
2776 -- a) If the entity is an operator, it may be a primitive operator of
2777 -- a type for which there is a visible use-type clause.
2779 -- b) for other entities, their use-visibility is determined by a
2780 -- visible use clause for the package itself. For a generic instance,
2781 -- the instantiation of the formals appears in the visible part,
2782 -- but the formals are private and remain so.
2784 if Ekind (Id) = E_Function
2785 and then Is_Operator_Symbol_Name (Chars (Id))
2786 and then not Is_Hidden (Id)
2787 and then not Error_Posted (Id)
2788 then
2789 Set_Is_Potentially_Use_Visible (Id,
2790 In_Use (P)
2791 or else Type_In_Use (Etype (Id))
2792 or else Type_In_Use (Etype (First_Formal (Id)))
2793 or else (Present (Next_Formal (First_Formal (Id)))
2794 and then
2795 Type_In_Use
2796 (Etype (Next_Formal (First_Formal (Id))))));
2797 else
2798 if In_Use (P) and then not Is_Hidden (Id) then
2800 -- A child unit of a use-visible package remains use-visible
2801 -- only if it is itself a visible child unit. Otherwise it
2802 -- would remain visible in other contexts where P is use-
2803 -- visible, because once compiled it stays in the entity list
2804 -- of its parent unit.
2806 if Is_Child_Unit (Id) then
2807 Set_Is_Potentially_Use_Visible
2808 (Id, Is_Visible_Lib_Unit (Id));
2809 else
2810 Set_Is_Potentially_Use_Visible (Id);
2811 end if;
2813 else
2814 Set_Is_Potentially_Use_Visible (Id, False);
2815 end if;
2816 end if;
2818 -- Local entities are not immediately visible outside of the package
2820 Set_Is_Immediately_Visible (Id, False);
2822 -- If this is a private type with a full view (for example a local
2823 -- subtype of a private type declared elsewhere), ensure that the
2824 -- full view is also removed from visibility: it may be exposed when
2825 -- swapping views in an instantiation. Similarly, ensure that the
2826 -- use-visibility is properly set on both views.
2828 if Is_Type (Id) and then Present (Full_View (Id)) then
2829 Set_Is_Immediately_Visible (Full_View (Id), False);
2830 Set_Is_Potentially_Use_Visible (Full_View (Id),
2831 Is_Potentially_Use_Visible (Id));
2832 end if;
2834 if Is_Tagged_Type (Id) and then Ekind (Id) = E_Record_Type then
2835 Check_Abstract_Overriding (Id);
2836 Check_Conventions (Id);
2837 end if;
2839 if Ekind_In (Id, E_Private_Type, E_Limited_Private_Type)
2840 and then No (Full_View (Id))
2841 and then not Is_Generic_Type (Id)
2842 and then not Is_Derived_Type (Id)
2843 then
2844 Error_Msg_N ("missing full declaration for private type&", Id);
2846 elsif Ekind (Id) = E_Record_Type_With_Private
2847 and then not Is_Generic_Type (Id)
2848 and then No (Full_View (Id))
2849 then
2850 if Nkind (Parent (Id)) = N_Private_Type_Declaration then
2851 Error_Msg_N ("missing full declaration for private type&", Id);
2852 else
2853 Error_Msg_N
2854 ("missing full declaration for private extension", Id);
2855 end if;
2857 -- Case of constant, check for deferred constant declaration with
2858 -- no full view. Likely just a matter of a missing expression, or
2859 -- accidental use of the keyword constant.
2861 elsif Ekind (Id) = E_Constant
2863 -- OK if constant value present
2865 and then No (Constant_Value (Id))
2867 -- OK if full view present
2869 and then No (Full_View (Id))
2871 -- OK if imported, since that provides the completion
2873 and then not Is_Imported (Id)
2875 -- OK if object declaration replaced by renaming declaration as
2876 -- a result of OK_To_Rename processing (e.g. for concatenation)
2878 and then Nkind (Parent (Id)) /= N_Object_Renaming_Declaration
2880 -- OK if object declaration with the No_Initialization flag set
2882 and then not (Nkind (Parent (Id)) = N_Object_Declaration
2883 and then No_Initialization (Parent (Id)))
2884 then
2885 -- If no private declaration is present, we assume the user did
2886 -- not intend a deferred constant declaration and the problem
2887 -- is simply that the initializing expression is missing.
2889 if not Has_Private_Declaration (Etype (Id)) then
2891 -- We assume that the user did not intend a deferred constant
2892 -- declaration, and the expression is just missing.
2894 Error_Msg_N
2895 ("constant declaration requires initialization expression",
2896 Parent (Id));
2898 if Is_Limited_Type (Etype (Id)) then
2899 Error_Msg_N
2900 ("\if variable intended, remove CONSTANT from declaration",
2901 Parent (Id));
2902 end if;
2904 -- Otherwise if a private declaration is present, then we are
2905 -- missing the full declaration for the deferred constant.
2907 else
2908 Error_Msg_N
2909 ("missing full declaration for deferred constant (RM 7.4)",
2910 Id);
2912 if Is_Limited_Type (Etype (Id)) then
2913 Error_Msg_N
2914 ("\if variable intended, remove CONSTANT from declaration",
2915 Parent (Id));
2916 end if;
2917 end if;
2918 end if;
2920 Next_Entity (Id);
2921 end loop;
2923 -- If the specification was installed as the parent of a public child
2924 -- unit, the private declarations were not installed, and there is
2925 -- nothing to do.
2927 if not In_Private_Part (P) then
2928 return;
2929 else
2930 Set_In_Private_Part (P, False);
2931 end if;
2933 -- Make private entities invisible and exchange full and private
2934 -- declarations for private types. Id is now the first private entity
2935 -- in the package.
2937 while Present (Id) loop
2938 if Debug_Flag_E then
2939 Write_Str ("unlinking private entity ");
2940 Write_Int (Int (Id));
2941 Write_Eol;
2942 end if;
2944 if Is_Tagged_Type (Id) and then Ekind (Id) = E_Record_Type then
2945 Check_Abstract_Overriding (Id);
2946 Check_Conventions (Id);
2947 end if;
2949 Set_Is_Immediately_Visible (Id, False);
2951 if Is_Private_Base_Type (Id) and then Present (Full_View (Id)) then
2952 Full := Full_View (Id);
2954 -- If the partial view is not declared in the visible part of the
2955 -- package (as is the case when it is a type derived from some
2956 -- other private type in the private part of the current package),
2957 -- no exchange takes place.
2959 if No (Parent (Id))
2960 or else List_Containing (Parent (Id)) /=
2961 Visible_Declarations (Specification (Decl))
2962 then
2963 goto Next_Id;
2964 end if;
2966 -- The entry in the private part points to the full declaration,
2967 -- which is currently visible. Exchange them so only the private
2968 -- type declaration remains accessible, and link private and full
2969 -- declaration in the opposite direction. Before the actual
2970 -- exchange, we copy back attributes of the full view that must
2971 -- be available to the partial view too.
2973 Preserve_Full_Attributes (Id, Full);
2975 Set_Is_Potentially_Use_Visible (Id, In_Use (P));
2977 -- The following test may be redundant, as this is already
2978 -- diagnosed in sem_ch3. ???
2980 if not Is_Definite_Subtype (Full)
2981 and then Is_Definite_Subtype (Id)
2982 then
2983 Error_Msg_Sloc := Sloc (Parent (Id));
2984 Error_Msg_NE
2985 ("full view of& not compatible with declaration#", Full, Id);
2986 end if;
2988 -- Swap out the subtypes and derived types of Id that
2989 -- were compiled in this scope, or installed previously
2990 -- by Install_Private_Declarations.
2992 -- Before we do the swap, we verify the presence of the Full_View
2993 -- field which may be empty due to a swap by a previous call to
2994 -- End_Package_Scope (e.g. from the freezing mechanism).
2996 Priv_Elmt := First_Elmt (Private_Dependents (Id));
2997 while Present (Priv_Elmt) loop
2998 Priv_Sub := Node (Priv_Elmt);
3000 if Present (Full_View (Priv_Sub)) then
3001 if Scope (Priv_Sub) = P
3002 or else not In_Open_Scopes (Scope (Priv_Sub))
3003 then
3004 Set_Is_Immediately_Visible (Priv_Sub, False);
3005 end if;
3007 if Is_Visible_Dependent (Priv_Sub) then
3008 Preserve_Full_Attributes
3009 (Priv_Sub, Full_View (Priv_Sub));
3010 Replace_Elmt (Priv_Elmt, Full_View (Priv_Sub));
3011 Exchange_Declarations (Priv_Sub);
3012 end if;
3013 end if;
3015 Next_Elmt (Priv_Elmt);
3016 end loop;
3018 -- Now restore the type itself to its private view
3020 Exchange_Declarations (Id);
3022 -- If we have installed an underlying full view for a type derived
3023 -- from a private type in a child unit, restore the proper views
3024 -- of private and full view. See corresponding code in
3025 -- Install_Private_Declarations.
3027 -- After the exchange, Full denotes the private type in the
3028 -- visible part of the package.
3030 if Is_Private_Base_Type (Full)
3031 and then Present (Full_View (Full))
3032 and then Present (Underlying_Full_View (Full))
3033 and then In_Package_Body (Current_Scope)
3034 then
3035 Set_Full_View (Full, Underlying_Full_View (Full));
3036 Set_Underlying_Full_View (Full, Empty);
3037 end if;
3039 elsif Ekind (Id) = E_Incomplete_Type
3040 and then Comes_From_Source (Id)
3041 and then No (Full_View (Id))
3042 then
3043 -- Mark Taft amendment types. Verify that there are no primitive
3044 -- operations declared for the type (3.10.1(9)).
3046 Set_Has_Completion_In_Body (Id);
3048 declare
3049 Elmt : Elmt_Id;
3050 Subp : Entity_Id;
3052 begin
3053 Elmt := First_Elmt (Private_Dependents (Id));
3054 while Present (Elmt) loop
3055 Subp := Node (Elmt);
3057 -- Is_Primitive is tested because there can be cases where
3058 -- nonprimitive subprograms (in nested packages) are added
3059 -- to the Private_Dependents list.
3061 if Is_Overloadable (Subp) and then Is_Primitive (Subp) then
3062 Error_Msg_NE
3063 ("type& must be completed in the private part",
3064 Parent (Subp), Id);
3066 -- The result type of an access-to-function type cannot be a
3067 -- Taft-amendment type, unless the version is Ada 2012 or
3068 -- later (see AI05-151).
3070 elsif Ada_Version < Ada_2012
3071 and then Ekind (Subp) = E_Subprogram_Type
3072 then
3073 if Etype (Subp) = Id
3074 or else
3075 (Is_Class_Wide_Type (Etype (Subp))
3076 and then Etype (Etype (Subp)) = Id)
3077 then
3078 Error_Msg_NE
3079 ("type& must be completed in the private part",
3080 Associated_Node_For_Itype (Subp), Id);
3081 end if;
3082 end if;
3084 Next_Elmt (Elmt);
3085 end loop;
3086 end;
3088 elsif not Is_Child_Unit (Id)
3089 and then (not Is_Private_Type (Id) or else No (Full_View (Id)))
3090 then
3091 Set_Is_Hidden (Id);
3092 Set_Is_Potentially_Use_Visible (Id, False);
3093 end if;
3095 <<Next_Id>>
3096 Next_Entity (Id);
3097 end loop;
3098 end Uninstall_Declarations;
3100 ------------------------
3101 -- Unit_Requires_Body --
3102 ------------------------
3104 function Unit_Requires_Body
3105 (Pack_Id : Entity_Id;
3106 Do_Abstract_States : Boolean := False) return Boolean
3108 E : Entity_Id;
3110 Requires_Body : Boolean := False;
3111 -- Flag set when the unit has at least one construct that requries
3112 -- completion in a body.
3114 begin
3115 -- Imported entity never requires body. Right now, only subprograms can
3116 -- be imported, but perhaps in the future we will allow import of
3117 -- packages.
3119 if Is_Imported (Pack_Id) then
3120 return False;
3122 -- Body required if library package with pragma Elaborate_Body
3124 elsif Has_Pragma_Elaborate_Body (Pack_Id) then
3125 return True;
3127 -- Body required if subprogram
3129 elsif Is_Subprogram_Or_Generic_Subprogram (Pack_Id) then
3130 return True;
3132 -- Treat a block as requiring a body
3134 elsif Ekind (Pack_Id) = E_Block then
3135 return True;
3137 elsif Ekind (Pack_Id) = E_Package
3138 and then Nkind (Parent (Pack_Id)) = N_Package_Specification
3139 and then Present (Generic_Parent (Parent (Pack_Id)))
3140 then
3141 declare
3142 G_P : constant Entity_Id := Generic_Parent (Parent (Pack_Id));
3143 begin
3144 if Has_Pragma_Elaborate_Body (G_P) then
3145 return True;
3146 end if;
3147 end;
3148 end if;
3150 -- Traverse the entity chain of the package and look for constructs that
3151 -- require a completion in a body.
3153 E := First_Entity (Pack_Id);
3154 while Present (E) loop
3156 -- Skip abstract states because their completion depends on several
3157 -- criteria (see below).
3159 if Ekind (E) = E_Abstract_State then
3160 null;
3162 elsif Requires_Completion_In_Body
3163 (E, Pack_Id, Do_Abstract_States)
3164 then
3165 Requires_Body := True;
3166 exit;
3167 end if;
3169 Next_Entity (E);
3170 end loop;
3172 -- A [generic] package that defines at least one non-null abstract state
3173 -- requires a completion only when at least one other construct requires
3174 -- a completion in a body (SPARK RM 7.1.4(4) and (6)). This check is not
3175 -- performed if the caller requests this behavior.
3177 if Do_Abstract_States
3178 and then Ekind_In (Pack_Id, E_Generic_Package, E_Package)
3179 and then Has_Non_Null_Abstract_State (Pack_Id)
3180 and then Requires_Body
3181 then
3182 return True;
3183 end if;
3185 return Requires_Body;
3186 end Unit_Requires_Body;
3188 -----------------------------
3189 -- Unit_Requires_Body_Info --
3190 -----------------------------
3192 procedure Unit_Requires_Body_Info (Pack_Id : Entity_Id) is
3193 E : Entity_Id;
3195 begin
3196 -- An imported entity never requires body. Right now, only subprograms
3197 -- can be imported, but perhaps in the future we will allow import of
3198 -- packages.
3200 if Is_Imported (Pack_Id) then
3201 return;
3203 -- Body required if library package with pragma Elaborate_Body
3205 elsif Has_Pragma_Elaborate_Body (Pack_Id) then
3206 Error_Msg_N ("info: & requires body (Elaborate_Body)?Y?", Pack_Id);
3208 -- Body required if subprogram
3210 elsif Is_Subprogram_Or_Generic_Subprogram (Pack_Id) then
3211 Error_Msg_N ("info: & requires body (subprogram case)?Y?", Pack_Id);
3213 -- Body required if generic parent has Elaborate_Body
3215 elsif Ekind (Pack_Id) = E_Package
3216 and then Nkind (Parent (Pack_Id)) = N_Package_Specification
3217 and then Present (Generic_Parent (Parent (Pack_Id)))
3218 then
3219 declare
3220 G_P : constant Entity_Id := Generic_Parent (Parent (Pack_Id));
3221 begin
3222 if Has_Pragma_Elaborate_Body (G_P) then
3223 Error_Msg_N
3224 ("info: & requires body (generic parent Elaborate_Body)?Y?",
3225 Pack_Id);
3226 end if;
3227 end;
3229 -- A [generic] package that introduces at least one non-null abstract
3230 -- state requires completion. However, there is a separate rule that
3231 -- requires that such a package have a reason other than this for a
3232 -- body being required (if necessary a pragma Elaborate_Body must be
3233 -- provided). If Ignore_Abstract_State is True, we don't do this check
3234 -- (so we can use Unit_Requires_Body to check for some other reason).
3236 elsif Ekind_In (Pack_Id, E_Generic_Package, E_Package)
3237 and then Present (Abstract_States (Pack_Id))
3238 and then not Is_Null_State
3239 (Node (First_Elmt (Abstract_States (Pack_Id))))
3240 then
3241 Error_Msg_N
3242 ("info: & requires body (non-null abstract state aspect)?Y?",
3243 Pack_Id);
3244 end if;
3246 -- Otherwise search entity chain for entity requiring completion
3248 E := First_Entity (Pack_Id);
3249 while Present (E) loop
3250 if Requires_Completion_In_Body (E, Pack_Id) then
3251 Error_Msg_Node_2 := E;
3252 Error_Msg_NE
3253 ("info: & requires body (& requires completion)?Y?", E, Pack_Id);
3254 end if;
3256 Next_Entity (E);
3257 end loop;
3258 end Unit_Requires_Body_Info;
3260 end Sem_Ch7;