1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2013, Free Software Foundation, Inc. --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Aspects; use Aspects;
27 with Atree; use Atree;
28 with Debug; use Debug;
29 with Einfo; use Einfo;
30 with Elists; use Elists;
31 with Errout; use Errout;
32 with Expander; use Expander;
33 with Exp_Disp; use Exp_Disp;
34 with Fname; use Fname;
35 with Fname.UF; use Fname.UF;
36 with Freeze; use Freeze;
37 with Itypes; use Itypes;
39 with Lib.Load; use Lib.Load;
40 with Lib.Xref; use Lib.Xref;
41 with Nlists; use Nlists;
42 with Namet; use Namet;
43 with Nmake; use Nmake;
45 with Rident; use Rident;
46 with Restrict; use Restrict;
47 with Rtsfind; use Rtsfind;
49 with Sem_Aux; use Sem_Aux;
50 with Sem_Cat; use Sem_Cat;
51 with Sem_Ch3; use Sem_Ch3;
52 with Sem_Ch6; use Sem_Ch6;
53 with Sem_Ch7; use Sem_Ch7;
54 with Sem_Ch8; use Sem_Ch8;
55 with Sem_Ch10; use Sem_Ch10;
56 with Sem_Ch13; use Sem_Ch13;
57 with Sem_Dim; use Sem_Dim;
58 with Sem_Disp; use Sem_Disp;
59 with Sem_Elab; use Sem_Elab;
60 with Sem_Elim; use Sem_Elim;
61 with Sem_Eval; use Sem_Eval;
62 with Sem_Prag; use Sem_Prag;
63 with Sem_Res; use Sem_Res;
64 with Sem_Type; use Sem_Type;
65 with Sem_Util; use Sem_Util;
66 with Sem_Warn; use Sem_Warn;
67 with Stand; use Stand;
68 with Sinfo; use Sinfo;
69 with Sinfo.CN; use Sinfo.CN;
70 with Sinput; use Sinput;
71 with Sinput.L; use Sinput.L;
72 with Snames; use Snames;
73 with Stringt; use Stringt;
74 with Uname; use Uname;
76 with Tbuild; use Tbuild;
77 with Uintp; use Uintp;
78 with Urealp; use Urealp;
79 with Warnsw; use Warnsw;
83 package body Sem_Ch12 is
85 ----------------------------------------------------------
86 -- Implementation of Generic Analysis and Instantiation --
87 ----------------------------------------------------------
89 -- GNAT implements generics by macro expansion. No attempt is made to share
90 -- generic instantiations (for now). Analysis of a generic definition does
91 -- not perform any expansion action, but the expander must be called on the
92 -- tree for each instantiation, because the expansion may of course depend
93 -- on the generic actuals. All of this is best achieved as follows:
95 -- a) Semantic analysis of a generic unit is performed on a copy of the
96 -- tree for the generic unit. All tree modifications that follow analysis
97 -- do not affect the original tree. Links are kept between the original
98 -- tree and the copy, in order to recognize non-local references within
99 -- the generic, and propagate them to each instance (recall that name
100 -- resolution is done on the generic declaration: generics are not really
101 -- macros!). This is summarized in the following diagram:
103 -- .-----------. .----------.
104 -- | semantic |<--------------| generic |
106 -- | |==============>| |
107 -- |___________| global |__________|
118 -- b) Each instantiation copies the original tree, and inserts into it a
119 -- series of declarations that describe the mapping between generic formals
120 -- and actuals. For example, a generic In OUT parameter is an object
121 -- renaming of the corresponding actual, etc. Generic IN parameters are
122 -- constant declarations.
124 -- c) In order to give the right visibility for these renamings, we use
125 -- a different scheme for package and subprogram instantiations. For
126 -- packages, the list of renamings is inserted into the package
127 -- specification, before the visible declarations of the package. The
128 -- renamings are analyzed before any of the text of the instance, and are
129 -- thus visible at the right place. Furthermore, outside of the instance,
130 -- the generic parameters are visible and denote their corresponding
133 -- For subprograms, we create a container package to hold the renamings
134 -- and the subprogram instance itself. Analysis of the package makes the
135 -- renaming declarations visible to the subprogram. After analyzing the
136 -- package, the defining entity for the subprogram is touched-up so that
137 -- it appears declared in the current scope, and not inside the container
140 -- If the instantiation is a compilation unit, the container package is
141 -- given the same name as the subprogram instance. This ensures that
142 -- the elaboration procedure called by the binder, using the compilation
143 -- unit name, calls in fact the elaboration procedure for the package.
145 -- Not surprisingly, private types complicate this approach. By saving in
146 -- the original generic object the non-local references, we guarantee that
147 -- the proper entities are referenced at the point of instantiation.
148 -- However, for private types, this by itself does not insure that the
149 -- proper VIEW of the entity is used (the full type may be visible at the
150 -- point of generic definition, but not at instantiation, or vice-versa).
151 -- In order to reference the proper view, we special-case any reference
152 -- to private types in the generic object, by saving both views, one in
153 -- the generic and one in the semantic copy. At time of instantiation, we
154 -- check whether the two views are consistent, and exchange declarations if
155 -- necessary, in order to restore the correct visibility. Similarly, if
156 -- the instance view is private when the generic view was not, we perform
157 -- the exchange. After completing the instantiation, we restore the
158 -- current visibility. The flag Has_Private_View marks identifiers in the
159 -- the generic unit that require checking.
161 -- Visibility within nested generic units requires special handling.
162 -- Consider the following scheme:
164 -- type Global is ... -- outside of generic unit.
168 -- type Semi_Global is ... -- global to inner.
171 -- procedure inner (X1 : Global; X2 : Semi_Global);
173 -- procedure in2 is new inner (...); -- 4
176 -- package New_Outer is new Outer (...); -- 2
177 -- procedure New_Inner is new New_Outer.Inner (...); -- 3
179 -- The semantic analysis of Outer captures all occurrences of Global.
180 -- The semantic analysis of Inner (at 1) captures both occurrences of
181 -- Global and Semi_Global.
183 -- At point 2 (instantiation of Outer), we also produce a generic copy
184 -- of Inner, even though Inner is, at that point, not being instantiated.
185 -- (This is just part of the semantic analysis of New_Outer).
187 -- Critically, references to Global within Inner must be preserved, while
188 -- references to Semi_Global should not preserved, because they must now
189 -- resolve to an entity within New_Outer. To distinguish between these, we
190 -- use a global variable, Current_Instantiated_Parent, which is set when
191 -- performing a generic copy during instantiation (at 2). This variable is
192 -- used when performing a generic copy that is not an instantiation, but
193 -- that is nested within one, as the occurrence of 1 within 2. The analysis
194 -- of a nested generic only preserves references that are global to the
195 -- enclosing Current_Instantiated_Parent. We use the Scope_Depth value to
196 -- determine whether a reference is external to the given parent.
198 -- The instantiation at point 3 requires no special treatment. The method
199 -- works as well for further nestings of generic units, but of course the
200 -- variable Current_Instantiated_Parent must be stacked because nested
201 -- instantiations can occur, e.g. the occurrence of 4 within 2.
203 -- The instantiation of package and subprogram bodies is handled in a
204 -- similar manner, except that it is delayed until after semantic
205 -- analysis is complete. In this fashion complex cross-dependencies
206 -- between several package declarations and bodies containing generics
207 -- can be compiled which otherwise would diagnose spurious circularities.
209 -- For example, it is possible to compile two packages A and B that
210 -- have the following structure:
212 -- package A is package B is
213 -- generic ... generic ...
214 -- package G_A is package G_B is
217 -- package body A is package body B is
218 -- package N_B is new G_B (..) package N_A is new G_A (..)
220 -- The table Pending_Instantiations in package Inline is used to keep
221 -- track of body instantiations that are delayed in this manner. Inline
222 -- handles the actual calls to do the body instantiations. This activity
223 -- is part of Inline, since the processing occurs at the same point, and
224 -- for essentially the same reason, as the handling of inlined routines.
226 ----------------------------------------------
227 -- Detection of Instantiation Circularities --
228 ----------------------------------------------
230 -- If we have a chain of instantiations that is circular, this is static
231 -- error which must be detected at compile time. The detection of these
232 -- circularities is carried out at the point that we insert a generic
233 -- instance spec or body. If there is a circularity, then the analysis of
234 -- the offending spec or body will eventually result in trying to load the
235 -- same unit again, and we detect this problem as we analyze the package
236 -- instantiation for the second time.
238 -- At least in some cases after we have detected the circularity, we get
239 -- into trouble if we try to keep going. The following flag is set if a
240 -- circularity is detected, and used to abandon compilation after the
241 -- messages have been posted.
243 Circularity_Detected : Boolean := False;
244 -- This should really be reset on encountering a new main unit, but in
245 -- practice we are not using multiple main units so it is not critical.
247 -------------------------------------------------
248 -- Formal packages and partial parametrization --
249 -------------------------------------------------
251 -- When compiling a generic, a formal package is a local instantiation. If
252 -- declared with a box, its generic formals are visible in the enclosing
253 -- generic. If declared with a partial list of actuals, those actuals that
254 -- are defaulted (covered by an Others clause, or given an explicit box
255 -- initialization) are also visible in the enclosing generic, while those
256 -- that have a corresponding actual are not.
258 -- In our source model of instantiation, the same visibility must be
259 -- present in the spec and body of an instance: the names of the formals
260 -- that are defaulted must be made visible within the instance, and made
261 -- invisible (hidden) after the instantiation is complete, so that they
262 -- are not accessible outside of the instance.
264 -- In a generic, a formal package is treated like a special instantiation.
265 -- Our Ada 95 compiler handled formals with and without box in different
266 -- ways. With partial parametrization, we use a single model for both.
267 -- We create a package declaration that consists of the specification of
268 -- the generic package, and a set of declarations that map the actuals
269 -- into local renamings, just as we do for bona fide instantiations. For
270 -- defaulted parameters and formals with a box, we copy directly the
271 -- declarations of the formal into this local package. The result is a
272 -- a package whose visible declarations may include generic formals. This
273 -- package is only used for type checking and visibility analysis, and
274 -- never reaches the back-end, so it can freely violate the placement
275 -- rules for generic formal declarations.
277 -- The list of declarations (renamings and copies of formals) is built
278 -- by Analyze_Associations, just as for regular instantiations.
280 -- At the point of instantiation, conformance checking must be applied only
281 -- to those parameters that were specified in the formal. We perform this
282 -- checking by creating another internal instantiation, this one including
283 -- only the renamings and the formals (the rest of the package spec is not
284 -- relevant to conformance checking). We can then traverse two lists: the
285 -- list of actuals in the instance that corresponds to the formal package,
286 -- and the list of actuals produced for this bogus instantiation. We apply
287 -- the conformance rules to those actuals that are not defaulted (i.e.
288 -- which still appear as generic formals.
290 -- When we compile an instance body we must make the right parameters
291 -- visible again. The predicate Is_Generic_Formal indicates which of the
292 -- formals should have its Is_Hidden flag reset.
294 -----------------------
295 -- Local subprograms --
296 -----------------------
298 procedure Abandon_Instantiation (N : Node_Id);
299 pragma No_Return (Abandon_Instantiation);
300 -- Posts an error message "instantiation abandoned" at the indicated node
301 -- and then raises the exception Instantiation_Error to do it.
303 procedure Analyze_Formal_Array_Type
304 (T : in out Entity_Id;
306 -- A formal array type is treated like an array type declaration, and
307 -- invokes Array_Type_Declaration (sem_ch3) whose first parameter is
308 -- in-out, because in the case of an anonymous type the entity is
309 -- actually created in the procedure.
311 -- The following procedures treat other kinds of formal parameters
313 procedure Analyze_Formal_Derived_Interface_Type
318 procedure Analyze_Formal_Derived_Type
323 procedure Analyze_Formal_Interface_Type
328 -- The following subprograms create abbreviated declarations for formal
329 -- scalar types. We introduce an anonymous base of the proper class for
330 -- each of them, and define the formals as constrained first subtypes of
331 -- their bases. The bounds are expressions that are non-static in the
334 procedure Analyze_Formal_Decimal_Fixed_Point_Type
335 (T : Entity_Id; Def : Node_Id);
336 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id);
337 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id);
338 procedure Analyze_Formal_Signed_Integer_Type (T : Entity_Id; Def : Node_Id);
339 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id);
340 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
341 (T : Entity_Id; Def : Node_Id);
343 procedure Analyze_Formal_Private_Type
347 -- Creates a new private type, which does not require completion
349 procedure Analyze_Formal_Incomplete_Type (T : Entity_Id; Def : Node_Id);
350 -- Ada 2012: Creates a new incomplete type whose actual does not freeze
352 procedure Analyze_Generic_Formal_Part (N : Node_Id);
353 -- Analyze generic formal part
355 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
356 -- Create a new access type with the given designated type
358 function Analyze_Associations
361 F_Copy : List_Id) return List_Id;
362 -- At instantiation time, build the list of associations between formals
363 -- and actuals. Each association becomes a renaming declaration for the
364 -- formal entity. F_Copy is the analyzed list of formals in the generic
365 -- copy. It is used to apply legality checks to the actuals. I_Node is the
366 -- instantiation node itself.
368 procedure Analyze_Subprogram_Instantiation
372 procedure Build_Instance_Compilation_Unit_Nodes
376 -- This procedure is used in the case where the generic instance of a
377 -- subprogram body or package body is a library unit. In this case, the
378 -- original library unit node for the generic instantiation must be
379 -- replaced by the resulting generic body, and a link made to a new
380 -- compilation unit node for the generic declaration. The argument N is
381 -- the original generic instantiation. Act_Body and Act_Decl are the body
382 -- and declaration of the instance (either package body and declaration
383 -- nodes or subprogram body and declaration nodes depending on the case).
384 -- On return, the node N has been rewritten with the actual body.
386 procedure Check_Access_Definition (N : Node_Id);
387 -- Subsidiary routine to null exclusion processing. Perform an assertion
388 -- check on Ada version and the presence of an access definition in N.
390 procedure Check_Formal_Packages (P_Id : Entity_Id);
391 -- Apply the following to all formal packages in generic associations
393 procedure Check_Formal_Package_Instance
394 (Formal_Pack : Entity_Id;
395 Actual_Pack : Entity_Id);
396 -- Verify that the actuals of the actual instance match the actuals of
397 -- the template for a formal package that is not declared with a box.
399 procedure Check_Forward_Instantiation (Decl : Node_Id);
400 -- If the generic is a local entity and the corresponding body has not
401 -- been seen yet, flag enclosing packages to indicate that it will be
402 -- elaborated after the generic body. Subprograms declared in the same
403 -- package cannot be inlined by the front-end because front-end inlining
404 -- requires a strict linear order of elaboration.
406 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id;
407 -- Check if some association between formals and actuals requires to make
408 -- visible primitives of a tagged type, and make those primitives visible.
409 -- Return the list of primitives whose visibility is modified (to restore
410 -- their visibility later through Restore_Hidden_Primitives). If no
411 -- candidate is found then return No_Elist.
413 procedure Check_Hidden_Child_Unit
415 Gen_Unit : Entity_Id;
416 Act_Decl_Id : Entity_Id);
417 -- If the generic unit is an implicit child instance within a parent
418 -- instance, we need to make an explicit test that it is not hidden by
419 -- a child instance of the same name and parent.
421 procedure Check_Generic_Actuals
422 (Instance : Entity_Id;
423 Is_Formal_Box : Boolean);
424 -- Similar to previous one. Check the actuals in the instantiation,
425 -- whose views can change between the point of instantiation and the point
426 -- of instantiation of the body. In addition, mark the generic renamings
427 -- as generic actuals, so that they are not compatible with other actuals.
428 -- Recurse on an actual that is a formal package whose declaration has
431 function Contains_Instance_Of
434 N : Node_Id) return Boolean;
435 -- Inner is instantiated within the generic Outer. Check whether Inner
436 -- directly or indirectly contains an instance of Outer or of one of its
437 -- parents, in the case of a subunit. Each generic unit holds a list of
438 -- the entities instantiated within (at any depth). This procedure
439 -- determines whether the set of such lists contains a cycle, i.e. an
440 -- illegal circular instantiation.
442 function Denotes_Formal_Package
444 On_Exit : Boolean := False;
445 Instance : Entity_Id := Empty) return Boolean;
446 -- Returns True if E is a formal package of an enclosing generic, or
447 -- the actual for such a formal in an enclosing instantiation. If such
448 -- a package is used as a formal in an nested generic, or as an actual
449 -- in a nested instantiation, the visibility of ITS formals should not
450 -- be modified. When called from within Restore_Private_Views, the flag
451 -- On_Exit is true, to indicate that the search for a possible enclosing
452 -- instance should ignore the current one. In that case Instance denotes
453 -- the declaration for which this is an actual. This declaration may be
454 -- an instantiation in the source, or the internal instantiation that
455 -- corresponds to the actual for a formal package.
457 function Earlier (N1, N2 : Node_Id) return Boolean;
458 -- Yields True if N1 and N2 appear in the same compilation unit,
459 -- ignoring subunits, and if N1 is to the left of N2 in a left-to-right
460 -- traversal of the tree for the unit. Used to determine the placement
461 -- of freeze nodes for instance bodies that may depend on other instances.
463 function Find_Actual_Type
465 Gen_Type : Entity_Id) return Entity_Id;
466 -- When validating the actual types of a child instance, check whether
467 -- the formal is a formal type of the parent unit, and retrieve the current
468 -- actual for it. Typ is the entity in the analyzed formal type declaration
469 -- (component or index type of an array type, or designated type of an
470 -- access formal) and Gen_Type is the enclosing analyzed formal array
471 -- or access type. The desired actual may be a formal of a parent, or may
472 -- be declared in a formal package of a parent. In both cases it is a
473 -- generic actual type because it appears within a visible instance.
474 -- Finally, it may be declared in a parent unit without being a formal
475 -- of that unit, in which case it must be retrieved by visibility.
476 -- Ambiguities may still arise if two homonyms are declared in two formal
477 -- packages, and the prefix of the formal type may be needed to resolve
478 -- the ambiguity in the instance ???
480 function In_Same_Declarative_Part
482 Inst : Node_Id) return Boolean;
483 -- True if the instantiation Inst and the given freeze_node F_Node appear
484 -- within the same declarative part, ignoring subunits, but with no inter-
485 -- vening subprograms or concurrent units. Used to find the proper plave
486 -- for the freeze node of an instance, when the generic is declared in a
487 -- previous instance. If predicate is true, the freeze node of the instance
488 -- can be placed after the freeze node of the previous instance, Otherwise
489 -- it has to be placed at the end of the current declarative part.
491 function In_Main_Context (E : Entity_Id) return Boolean;
492 -- Check whether an instantiation is in the context of the main unit.
493 -- Used to determine whether its body should be elaborated to allow
494 -- front-end inlining.
496 procedure Set_Instance_Env
497 (Gen_Unit : Entity_Id;
498 Act_Unit : Entity_Id);
499 -- Save current instance on saved environment, to be used to determine
500 -- the global status of entities in nested instances. Part of Save_Env.
501 -- called after verifying that the generic unit is legal for the instance,
502 -- The procedure also examines whether the generic unit is a predefined
503 -- unit, in order to set configuration switches accordingly. As a result
504 -- the procedure must be called after analyzing and freezing the actuals.
506 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id);
507 -- Associate analyzed generic parameter with corresponding
508 -- instance. Used for semantic checks at instantiation time.
510 function Has_Been_Exchanged (E : Entity_Id) return Boolean;
511 -- Traverse the Exchanged_Views list to see if a type was private
512 -- and has already been flipped during this phase of instantiation.
514 procedure Hide_Current_Scope;
515 -- When instantiating a generic child unit, the parent context must be
516 -- present, but the instance and all entities that may be generated
517 -- must be inserted in the current scope. We leave the current scope
518 -- on the stack, but make its entities invisible to avoid visibility
519 -- problems. This is reversed at the end of the instantiation. This is
520 -- not done for the instantiation of the bodies, which only require the
521 -- instances of the generic parents to be in scope.
523 procedure Install_Body
528 -- If the instantiation happens textually before the body of the generic,
529 -- the instantiation of the body must be analyzed after the generic body,
530 -- and not at the point of instantiation. Such early instantiations can
531 -- happen if the generic and the instance appear in a package declaration
532 -- because the generic body can only appear in the corresponding package
533 -- body. Early instantiations can also appear if generic, instance and
534 -- body are all in the declarative part of a subprogram or entry. Entities
535 -- of packages that are early instantiations are delayed, and their freeze
536 -- node appears after the generic body.
538 procedure Insert_Freeze_Node_For_Instance
541 -- N denotes a package or a subprogram instantiation and F_Node is the
542 -- associated freeze node. Insert the freeze node before the first source
543 -- body which follows immediately after N. If no such body is found, the
544 -- freeze node is inserted at the end of the declarative region which
547 procedure Freeze_Subprogram_Body
548 (Inst_Node : Node_Id;
550 Pack_Id : Entity_Id);
551 -- The generic body may appear textually after the instance, including
552 -- in the proper body of a stub, or within a different package instance.
553 -- Given that the instance can only be elaborated after the generic, we
554 -- place freeze_nodes for the instance and/or for packages that may enclose
555 -- the instance and the generic, so that the back-end can establish the
556 -- proper order of elaboration.
559 -- Establish environment for subsequent instantiation. Separated from
560 -- Save_Env because data-structures for visibility handling must be
561 -- initialized before call to Check_Generic_Child_Unit.
563 procedure Install_Formal_Packages (Par : Entity_Id);
564 -- Install the visible part of any formal of the parent that is a formal
565 -- package. Note that for the case of a formal package with a box, this
566 -- includes the formal part of the formal package (12.7(10/2)).
568 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False);
569 -- When compiling an instance of a child unit the parent (which is
570 -- itself an instance) is an enclosing scope that must be made
571 -- immediately visible. This procedure is also used to install the non-
572 -- generic parent of a generic child unit when compiling its body, so
573 -- that full views of types in the parent are made visible.
575 procedure Remove_Parent (In_Body : Boolean := False);
576 -- Reverse effect after instantiation of child is complete
578 procedure Install_Hidden_Primitives
579 (Prims_List : in out Elist_Id;
582 -- Remove suffix 'P' from hidden primitives of Act_T to match the
583 -- visibility of primitives of Gen_T. The list of primitives to which
584 -- the suffix is removed is added to Prims_List to restore them later.
586 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id);
587 -- Restore suffix 'P' to primitives of Prims_List and leave Prims_List
590 procedure Inline_Instance_Body
592 Gen_Unit : Entity_Id;
594 -- If front-end inlining is requested, instantiate the package body,
595 -- and preserve the visibility of its compilation unit, to insure
596 -- that successive instantiations succeed.
598 -- The functions Instantiate_XXX perform various legality checks and build
599 -- the declarations for instantiated generic parameters. In all of these
600 -- Formal is the entity in the generic unit, Actual is the entity of
601 -- expression in the generic associations, and Analyzed_Formal is the
602 -- formal in the generic copy, which contains the semantic information to
603 -- be used to validate the actual.
605 function Instantiate_Object
608 Analyzed_Formal : Node_Id) return List_Id;
610 function Instantiate_Type
613 Analyzed_Formal : Node_Id;
614 Actual_Decls : List_Id) return List_Id;
616 function Instantiate_Formal_Subprogram
619 Analyzed_Formal : Node_Id) return Node_Id;
621 function Instantiate_Formal_Package
624 Analyzed_Formal : Node_Id) return List_Id;
625 -- If the formal package is declared with a box, special visibility rules
626 -- apply to its formals: they are in the visible part of the package. This
627 -- is true in the declarative region of the formal package, that is to say
628 -- in the enclosing generic or instantiation. For an instantiation, the
629 -- parameters of the formal package are made visible in an explicit step.
630 -- Furthermore, if the actual has a visible USE clause, these formals must
631 -- be made potentially use-visible as well. On exit from the enclosing
632 -- instantiation, the reverse must be done.
634 -- For a formal package declared without a box, there are conformance rules
635 -- that apply to the actuals in the generic declaration and the actuals of
636 -- the actual package in the enclosing instantiation. The simplest way to
637 -- apply these rules is to repeat the instantiation of the formal package
638 -- in the context of the enclosing instance, and compare the generic
639 -- associations of this instantiation with those of the actual package.
640 -- This internal instantiation only needs to contain the renamings of the
641 -- formals: the visible and private declarations themselves need not be
644 -- In Ada 2005, the formal package may be only partially parameterized.
645 -- In that case the visibility step must make visible those actuals whose
646 -- corresponding formals were given with a box. A final complication
647 -- involves inherited operations from formal derived types, which must
648 -- be visible if the type is.
650 function Is_In_Main_Unit (N : Node_Id) return Boolean;
651 -- Test if given node is in the main unit
653 procedure Load_Parent_Of_Generic
656 Body_Optional : Boolean := False);
657 -- If the generic appears in a separate non-generic library unit, load the
658 -- corresponding body to retrieve the body of the generic. N is the node
659 -- for the generic instantiation, Spec is the generic package declaration.
661 -- Body_Optional is a flag that indicates that the body is being loaded to
662 -- ensure that temporaries are generated consistently when there are other
663 -- instances in the current declarative part that precede the one being
664 -- loaded. In that case a missing body is acceptable.
666 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id);
667 -- Add the context clause of the unit containing a generic unit to a
668 -- compilation unit that is, or contains, an instantiation.
670 function Get_Associated_Node (N : Node_Id) return Node_Id;
671 -- In order to propagate semantic information back from the analyzed copy
672 -- to the original generic, we maintain links between selected nodes in the
673 -- generic and their corresponding copies. At the end of generic analysis,
674 -- the routine Save_Global_References traverses the generic tree, examines
675 -- the semantic information, and preserves the links to those nodes that
676 -- contain global information. At instantiation, the information from the
677 -- associated node is placed on the new copy, so that name resolution is
680 -- Three kinds of source nodes have associated nodes:
682 -- a) those that can reference (denote) entities, that is identifiers,
683 -- character literals, expanded_names, operator symbols, operators,
684 -- and attribute reference nodes. These nodes have an Entity field
685 -- and are the set of nodes that are in N_Has_Entity.
687 -- b) aggregates (N_Aggregate and N_Extension_Aggregate)
689 -- c) selected components (N_Selected_Component)
691 -- For the first class, the associated node preserves the entity if it is
692 -- global. If the generic contains nested instantiations, the associated
693 -- node itself has been recopied, and a chain of them must be followed.
695 -- For aggregates, the associated node allows retrieval of the type, which
696 -- may otherwise not appear in the generic. The view of this type may be
697 -- different between generic and instantiation, and the full view can be
698 -- installed before the instantiation is analyzed. For aggregates of type
699 -- extensions, the same view exchange may have to be performed for some of
700 -- the ancestor types, if their view is private at the point of
703 -- Nodes that are selected components in the parse tree may be rewritten
704 -- as expanded names after resolution, and must be treated as potential
705 -- entity holders, which is why they also have an Associated_Node.
707 -- Nodes that do not come from source, such as freeze nodes, do not appear
708 -- in the generic tree, and need not have an associated node.
710 -- The associated node is stored in the Associated_Node field. Note that
711 -- this field overlaps Entity, which is fine, because the whole point is
712 -- that we don't need or want the normal Entity field in this situation.
714 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id);
715 -- Within the generic part, entities in the formal package are
716 -- visible. To validate subsequent type declarations, indicate
717 -- the correspondence between the entities in the analyzed formal,
718 -- and the entities in the actual package. There are three packages
719 -- involved in the instantiation of a formal package: the parent
720 -- generic P1 which appears in the generic declaration, the fake
721 -- instantiation P2 which appears in the analyzed generic, and whose
722 -- visible entities may be used in subsequent formals, and the actual
723 -- P3 in the instance. To validate subsequent formals, me indicate
724 -- that the entities in P2 are mapped into those of P3. The mapping of
725 -- entities has to be done recursively for nested packages.
727 procedure Move_Freeze_Nodes
731 -- Freeze nodes can be generated in the analysis of a generic unit, but
732 -- will not be seen by the back-end. It is necessary to move those nodes
733 -- to the enclosing scope if they freeze an outer entity. We place them
734 -- at the end of the enclosing generic package, which is semantically
737 procedure Preanalyze_Actuals (N : Node_Id);
738 -- Analyze actuals to perform name resolution. Full resolution is done
739 -- later, when the expected types are known, but names have to be captured
740 -- before installing parents of generics, that are not visible for the
741 -- actuals themselves.
743 function True_Parent (N : Node_Id) return Node_Id;
744 -- For a subunit, return parent of corresponding stub, else return
747 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id);
748 -- Verify that an attribute that appears as the default for a formal
749 -- subprogram is a function or procedure with the correct profile.
751 -------------------------------------------
752 -- Data Structures for Generic Renamings --
753 -------------------------------------------
755 -- The map Generic_Renamings associates generic entities with their
756 -- corresponding actuals. Currently used to validate type instances. It
757 -- will eventually be used for all generic parameters to eliminate the
758 -- need for overload resolution in the instance.
760 type Assoc_Ptr is new Int;
762 Assoc_Null : constant Assoc_Ptr := -1;
767 Next_In_HTable : Assoc_Ptr;
770 package Generic_Renamings is new Table.Table
771 (Table_Component_Type => Assoc,
772 Table_Index_Type => Assoc_Ptr,
773 Table_Low_Bound => 0,
775 Table_Increment => 100,
776 Table_Name => "Generic_Renamings");
778 -- Variable to hold enclosing instantiation. When the environment is
779 -- saved for a subprogram inlining, the corresponding Act_Id is empty.
781 Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
783 -- Hash table for associations
785 HTable_Size : constant := 37;
786 type HTable_Range is range 0 .. HTable_Size - 1;
788 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr);
789 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr;
790 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id;
791 function Hash (F : Entity_Id) return HTable_Range;
793 package Generic_Renamings_HTable is new GNAT.HTable.Static_HTable (
794 Header_Num => HTable_Range,
796 Elmt_Ptr => Assoc_Ptr,
797 Null_Ptr => Assoc_Null,
798 Set_Next => Set_Next_Assoc,
801 Get_Key => Get_Gen_Id,
805 Exchanged_Views : Elist_Id;
806 -- This list holds the private views that have been exchanged during
807 -- instantiation to restore the visibility of the generic declaration.
808 -- (see comments above). After instantiation, the current visibility is
809 -- reestablished by means of a traversal of this list.
811 Hidden_Entities : Elist_Id;
812 -- This list holds the entities of the current scope that are removed
813 -- from immediate visibility when instantiating a child unit. Their
814 -- visibility is restored in Remove_Parent.
816 -- Because instantiations can be recursive, the following must be saved
817 -- on entry and restored on exit from an instantiation (spec or body).
818 -- This is done by the two procedures Save_Env and Restore_Env. For
819 -- package and subprogram instantiations (but not for the body instances)
820 -- the action of Save_Env is done in two steps: Init_Env is called before
821 -- Check_Generic_Child_Unit, because setting the parent instances requires
822 -- that the visibility data structures be properly initialized. Once the
823 -- generic is unit is validated, Set_Instance_Env completes Save_Env.
825 Parent_Unit_Visible : Boolean := False;
826 -- Parent_Unit_Visible is used when the generic is a child unit, and
827 -- indicates whether the ultimate parent of the generic is visible in the
828 -- instantiation environment. It is used to reset the visibility of the
829 -- parent at the end of the instantiation (see Remove_Parent).
831 Instance_Parent_Unit : Entity_Id := Empty;
832 -- This records the ultimate parent unit of an instance of a generic
833 -- child unit and is used in conjunction with Parent_Unit_Visible to
834 -- indicate the unit to which the Parent_Unit_Visible flag corresponds.
836 type Instance_Env is record
837 Instantiated_Parent : Assoc;
838 Exchanged_Views : Elist_Id;
839 Hidden_Entities : Elist_Id;
840 Current_Sem_Unit : Unit_Number_Type;
841 Parent_Unit_Visible : Boolean := False;
842 Instance_Parent_Unit : Entity_Id := Empty;
843 Switches : Config_Switches_Type;
846 package Instance_Envs is new Table.Table (
847 Table_Component_Type => Instance_Env,
848 Table_Index_Type => Int,
849 Table_Low_Bound => 0,
851 Table_Increment => 100,
852 Table_Name => "Instance_Envs");
854 procedure Restore_Private_Views
855 (Pack_Id : Entity_Id;
856 Is_Package : Boolean := True);
857 -- Restore the private views of external types, and unmark the generic
858 -- renamings of actuals, so that they become compatible subtypes again.
859 -- For subprograms, Pack_Id is the package constructed to hold the
862 procedure Switch_View (T : Entity_Id);
863 -- Switch the partial and full views of a type and its private
864 -- dependents (i.e. its subtypes and derived types).
866 ------------------------------------
867 -- Structures for Error Reporting --
868 ------------------------------------
870 Instantiation_Node : Node_Id;
871 -- Used by subprograms that validate instantiation of formal parameters
872 -- where there might be no actual on which to place the error message.
873 -- Also used to locate the instantiation node for generic subunits.
875 Instantiation_Error : exception;
876 -- When there is a semantic error in the generic parameter matching,
877 -- there is no point in continuing the instantiation, because the
878 -- number of cascaded errors is unpredictable. This exception aborts
879 -- the instantiation process altogether.
881 S_Adjustment : Sloc_Adjustment;
882 -- Offset created for each node in an instantiation, in order to keep
883 -- track of the source position of the instantiation in each of its nodes.
884 -- A subsequent semantic error or warning on a construct of the instance
885 -- points to both places: the original generic node, and the point of
886 -- instantiation. See Sinput and Sinput.L for additional details.
888 ------------------------------------------------------------
889 -- Data structure for keeping track when inside a Generic --
890 ------------------------------------------------------------
892 -- The following table is used to save values of the Inside_A_Generic
893 -- flag (see spec of Sem) when they are saved by Start_Generic.
895 package Generic_Flags is new Table.Table (
896 Table_Component_Type => Boolean,
897 Table_Index_Type => Int,
898 Table_Low_Bound => 0,
900 Table_Increment => 200,
901 Table_Name => "Generic_Flags");
903 ---------------------------
904 -- Abandon_Instantiation --
905 ---------------------------
907 procedure Abandon_Instantiation (N : Node_Id) is
909 Error_Msg_N ("\instantiation abandoned!", N);
910 raise Instantiation_Error;
911 end Abandon_Instantiation;
913 --------------------------
914 -- Analyze_Associations --
915 --------------------------
917 function Analyze_Associations
920 F_Copy : List_Id) return List_Id
922 Actuals_To_Freeze : constant Elist_Id := New_Elmt_List;
923 Assoc : constant List_Id := New_List;
924 Default_Actuals : constant Elist_Id := New_Elmt_List;
925 Gen_Unit : constant Entity_Id :=
926 Defining_Entity (Parent (F_Copy));
930 Analyzed_Formal : Node_Id;
931 First_Named : Node_Id := Empty;
935 Saved_Formal : Node_Id;
937 Default_Formals : constant List_Id := New_List;
938 -- If an Others_Choice is present, some of the formals may be defaulted.
939 -- To simplify the treatment of visibility in an instance, we introduce
940 -- individual defaults for each such formal. These defaults are
941 -- appended to the list of associations and replace the Others_Choice.
943 Found_Assoc : Node_Id;
944 -- Association for the current formal being match. Empty if there are
945 -- no remaining actuals, or if there is no named association with the
946 -- name of the formal.
948 Is_Named_Assoc : Boolean;
949 Num_Matched : Int := 0;
950 Num_Actuals : Int := 0;
952 Others_Present : Boolean := False;
953 Others_Choice : Node_Id := Empty;
954 -- In Ada 2005, indicates partial parametrization of a formal
955 -- package. As usual an other association must be last in the list.
957 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id);
958 -- Apply RM 12.3 (9): if a formal subprogram is overloaded, the instance
959 -- cannot have a named association for it. AI05-0025 extends this rule
960 -- to formals of formal packages by AI05-0025, and it also applies to
961 -- box-initialized formals.
963 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean;
964 -- Determine whether the parameter types and the return type of Subp
965 -- are fully defined at the point of instantiation.
967 function Matching_Actual
969 A_F : Entity_Id) return Node_Id;
970 -- Find actual that corresponds to a given a formal parameter. If the
971 -- actuals are positional, return the next one, if any. If the actuals
972 -- are named, scan the parameter associations to find the right one.
973 -- A_F is the corresponding entity in the analyzed generic,which is
974 -- placed on the selector name for ASIS use.
976 -- In Ada 2005, a named association may be given with a box, in which
977 -- case Matching_Actual sets Found_Assoc to the generic association,
978 -- but return Empty for the actual itself. In this case the code below
979 -- creates a corresponding declaration for the formal.
981 function Partial_Parametrization return Boolean;
982 -- Ada 2005: if no match is found for a given formal, check if the
983 -- association for it includes a box, or whether the associations
984 -- include an Others clause.
986 procedure Process_Default (F : Entity_Id);
987 -- Add a copy of the declaration of generic formal F to the list of
988 -- associations, and add an explicit box association for F if there
989 -- is none yet, and the default comes from an Others_Choice.
991 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean;
992 -- Determine whether Subp renames one of the subprograms defined in the
993 -- generated package Standard.
995 procedure Set_Analyzed_Formal;
996 -- Find the node in the generic copy that corresponds to a given formal.
997 -- The semantic information on this node is used to perform legality
998 -- checks on the actuals. Because semantic analysis can introduce some
999 -- anonymous entities or modify the declaration node itself, the
1000 -- correspondence between the two lists is not one-one. In addition to
1001 -- anonymous types, the presence a formal equality will introduce an
1002 -- implicit declaration for the corresponding inequality.
1004 ----------------------------------------
1005 -- Check_Overloaded_Formal_Subprogram --
1006 ----------------------------------------
1008 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id) is
1009 Temp_Formal : Entity_Id;
1012 Temp_Formal := First (Formals);
1013 while Present (Temp_Formal) loop
1014 if Nkind (Temp_Formal) in N_Formal_Subprogram_Declaration
1015 and then Temp_Formal /= Formal
1017 Chars (Defining_Unit_Name (Specification (Formal))) =
1018 Chars (Defining_Unit_Name (Specification (Temp_Formal)))
1020 if Present (Found_Assoc) then
1022 ("named association not allowed for overloaded formal",
1027 ("named association not allowed for overloaded formal",
1031 Abandon_Instantiation (Instantiation_Node);
1036 end Check_Overloaded_Formal_Subprogram;
1038 -------------------------------
1039 -- Has_Fully_Defined_Profile --
1040 -------------------------------
1042 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean is
1043 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean;
1044 -- Determine whethet type Typ is fully defined
1046 ---------------------------
1047 -- Is_Fully_Defined_Type --
1048 ---------------------------
1050 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean is
1052 -- A private type without a full view is not fully defined
1054 if Is_Private_Type (Typ)
1055 and then No (Full_View (Typ))
1059 -- An incomplete type is never fully defined
1061 elsif Is_Incomplete_Type (Typ) then
1064 -- All other types are fully defined
1069 end Is_Fully_Defined_Type;
1071 -- Local declarations
1075 -- Start of processing for Has_Fully_Defined_Profile
1078 -- Check the parameters
1080 Param := First_Formal (Subp);
1081 while Present (Param) loop
1082 if not Is_Fully_Defined_Type (Etype (Param)) then
1086 Next_Formal (Param);
1089 -- Check the return type
1091 return Is_Fully_Defined_Type (Etype (Subp));
1092 end Has_Fully_Defined_Profile;
1094 ---------------------
1095 -- Matching_Actual --
1096 ---------------------
1098 function Matching_Actual
1100 A_F : Entity_Id) return Node_Id
1106 Is_Named_Assoc := False;
1108 -- End of list of purely positional parameters
1110 if No (Actual) or else Nkind (Actual) = N_Others_Choice then
1111 Found_Assoc := Empty;
1114 -- Case of positional parameter corresponding to current formal
1116 elsif No (Selector_Name (Actual)) then
1117 Found_Assoc := Actual;
1118 Act := Explicit_Generic_Actual_Parameter (Actual);
1119 Num_Matched := Num_Matched + 1;
1122 -- Otherwise scan list of named actuals to find the one with the
1123 -- desired name. All remaining actuals have explicit names.
1126 Is_Named_Assoc := True;
1127 Found_Assoc := Empty;
1131 while Present (Actual) loop
1132 if Chars (Selector_Name (Actual)) = Chars (F) then
1133 Set_Entity (Selector_Name (Actual), A_F);
1134 Set_Etype (Selector_Name (Actual), Etype (A_F));
1135 Generate_Reference (A_F, Selector_Name (Actual));
1136 Found_Assoc := Actual;
1137 Act := Explicit_Generic_Actual_Parameter (Actual);
1138 Num_Matched := Num_Matched + 1;
1146 -- Reset for subsequent searches. In most cases the named
1147 -- associations are in order. If they are not, we reorder them
1148 -- to avoid scanning twice the same actual. This is not just a
1149 -- question of efficiency: there may be multiple defaults with
1150 -- boxes that have the same name. In a nested instantiation we
1151 -- insert actuals for those defaults, and cannot rely on their
1152 -- names to disambiguate them.
1154 if Actual = First_Named then
1157 elsif Present (Actual) then
1158 Insert_Before (First_Named, Remove_Next (Prev));
1161 Actual := First_Named;
1164 if Is_Entity_Name (Act) and then Present (Entity (Act)) then
1165 Set_Used_As_Generic_Actual (Entity (Act));
1169 end Matching_Actual;
1171 -----------------------------
1172 -- Partial_Parametrization --
1173 -----------------------------
1175 function Partial_Parametrization return Boolean is
1177 return Others_Present
1178 or else (Present (Found_Assoc) and then Box_Present (Found_Assoc));
1179 end Partial_Parametrization;
1181 ---------------------
1182 -- Process_Default --
1183 ---------------------
1185 procedure Process_Default (F : Entity_Id) is
1186 Loc : constant Source_Ptr := Sloc (I_Node);
1187 F_Id : constant Entity_Id := Defining_Entity (F);
1193 -- Append copy of formal declaration to associations, and create new
1194 -- defining identifier for it.
1196 Decl := New_Copy_Tree (F);
1197 Id := Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id));
1199 if Nkind (F) in N_Formal_Subprogram_Declaration then
1200 Set_Defining_Unit_Name (Specification (Decl), Id);
1203 Set_Defining_Identifier (Decl, Id);
1206 Append (Decl, Assoc);
1208 if No (Found_Assoc) then
1210 Make_Generic_Association (Loc,
1211 Selector_Name => New_Occurrence_Of (Id, Loc),
1212 Explicit_Generic_Actual_Parameter => Empty);
1213 Set_Box_Present (Default);
1214 Append (Default, Default_Formals);
1216 end Process_Default;
1218 ---------------------------------
1219 -- Renames_Standard_Subprogram --
1220 ---------------------------------
1222 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean is
1227 while Present (Id) loop
1228 if Scope (Id) = Standard_Standard then
1236 end Renames_Standard_Subprogram;
1238 -------------------------
1239 -- Set_Analyzed_Formal --
1240 -------------------------
1242 procedure Set_Analyzed_Formal is
1246 while Present (Analyzed_Formal) loop
1247 Kind := Nkind (Analyzed_Formal);
1249 case Nkind (Formal) is
1251 when N_Formal_Subprogram_Declaration =>
1252 exit when Kind in N_Formal_Subprogram_Declaration
1255 (Defining_Unit_Name (Specification (Formal))) =
1257 (Defining_Unit_Name (Specification (Analyzed_Formal)));
1259 when N_Formal_Package_Declaration =>
1260 exit when Nkind_In (Kind, N_Formal_Package_Declaration,
1261 N_Generic_Package_Declaration,
1262 N_Package_Declaration);
1264 when N_Use_Package_Clause | N_Use_Type_Clause => exit;
1268 -- Skip freeze nodes, and nodes inserted to replace
1269 -- unrecognized pragmas.
1272 Kind not in N_Formal_Subprogram_Declaration
1273 and then not Nkind_In (Kind, N_Subprogram_Declaration,
1277 and then Chars (Defining_Identifier (Formal)) =
1278 Chars (Defining_Identifier (Analyzed_Formal));
1281 Next (Analyzed_Formal);
1283 end Set_Analyzed_Formal;
1285 -- Start of processing for Analyze_Associations
1288 Actuals := Generic_Associations (I_Node);
1290 if Present (Actuals) then
1292 -- Check for an Others choice, indicating a partial parametrization
1293 -- for a formal package.
1295 Actual := First (Actuals);
1296 while Present (Actual) loop
1297 if Nkind (Actual) = N_Others_Choice then
1298 Others_Present := True;
1299 Others_Choice := Actual;
1301 if Present (Next (Actual)) then
1302 Error_Msg_N ("others must be last association", Actual);
1305 -- This subprogram is used both for formal packages and for
1306 -- instantiations. For the latter, associations must all be
1309 if Nkind (I_Node) /= N_Formal_Package_Declaration
1310 and then Comes_From_Source (I_Node)
1313 ("others association not allowed in an instance",
1317 -- In any case, nothing to do after the others association
1321 elsif Box_Present (Actual)
1322 and then Comes_From_Source (I_Node)
1323 and then Nkind (I_Node) /= N_Formal_Package_Declaration
1326 ("box association not allowed in an instance", Actual);
1332 -- If named associations are present, save first named association
1333 -- (it may of course be Empty) to facilitate subsequent name search.
1335 First_Named := First (Actuals);
1336 while Present (First_Named)
1337 and then Nkind (First_Named) /= N_Others_Choice
1338 and then No (Selector_Name (First_Named))
1340 Num_Actuals := Num_Actuals + 1;
1345 Named := First_Named;
1346 while Present (Named) loop
1347 if Nkind (Named) /= N_Others_Choice
1348 and then No (Selector_Name (Named))
1350 Error_Msg_N ("invalid positional actual after named one", Named);
1351 Abandon_Instantiation (Named);
1354 -- A named association may lack an actual parameter, if it was
1355 -- introduced for a default subprogram that turns out to be local
1356 -- to the outer instantiation.
1358 if Nkind (Named) /= N_Others_Choice
1359 and then Present (Explicit_Generic_Actual_Parameter (Named))
1361 Num_Actuals := Num_Actuals + 1;
1367 if Present (Formals) then
1368 Formal := First_Non_Pragma (Formals);
1369 Analyzed_Formal := First_Non_Pragma (F_Copy);
1371 if Present (Actuals) then
1372 Actual := First (Actuals);
1374 -- All formals should have default values
1380 while Present (Formal) loop
1381 Set_Analyzed_Formal;
1382 Saved_Formal := Next_Non_Pragma (Formal);
1384 case Nkind (Formal) is
1385 when N_Formal_Object_Declaration =>
1388 Defining_Identifier (Formal),
1389 Defining_Identifier (Analyzed_Formal));
1391 if No (Match) and then Partial_Parametrization then
1392 Process_Default (Formal);
1395 (Instantiate_Object (Formal, Match, Analyzed_Formal),
1399 when N_Formal_Type_Declaration =>
1402 Defining_Identifier (Formal),
1403 Defining_Identifier (Analyzed_Formal));
1406 if Partial_Parametrization then
1407 Process_Default (Formal);
1410 Error_Msg_Sloc := Sloc (Gen_Unit);
1414 Defining_Identifier (Formal));
1415 Error_Msg_NE ("\in instantiation of & declared#",
1416 Instantiation_Node, Gen_Unit);
1417 Abandon_Instantiation (Instantiation_Node);
1424 (Formal, Match, Analyzed_Formal, Assoc),
1427 -- An instantiation is a freeze point for the actuals,
1428 -- unless this is a rewritten formal package, or the
1429 -- formal is an Ada 2012 formal incomplete type.
1431 if Nkind (I_Node) = N_Formal_Package_Declaration
1433 (Ada_Version >= Ada_2012
1435 Ekind (Defining_Identifier (Analyzed_Formal)) =
1441 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1445 -- A remote access-to-class-wide type is not a legal actual
1446 -- for a generic formal of an access type (E.2.2(17/2)).
1447 -- In GNAT an exception to this rule is introduced when
1448 -- the formal is marked as remote using implementation
1449 -- defined aspect/pragma Remote_Access_Type. In that case
1450 -- the actual must be remote as well.
1452 -- If the current instantiation is the construction of a
1453 -- local copy for a formal package the actuals may be
1454 -- defaulted, and there is no matching actual to check.
1456 if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1458 Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1459 N_Access_To_Object_Definition
1460 and then Present (Match)
1463 Formal_Ent : constant Entity_Id :=
1464 Defining_Identifier (Analyzed_Formal);
1466 if Is_Remote_Access_To_Class_Wide_Type (Entity (Match))
1467 = Is_Remote_Types (Formal_Ent)
1469 -- Remoteness of formal and actual match
1473 elsif Is_Remote_Types (Formal_Ent) then
1475 -- Remote formal, non-remote actual
1478 ("actual for& must be remote", Match, Formal_Ent);
1481 -- Non-remote formal, remote actual
1484 ("actual for& may not be remote",
1490 when N_Formal_Subprogram_Declaration =>
1493 (Defining_Unit_Name (Specification (Formal)),
1494 Defining_Unit_Name (Specification (Analyzed_Formal)));
1496 -- If the formal subprogram has the same name as another
1497 -- formal subprogram of the generic, then a named
1498 -- association is illegal (12.3(9)). Exclude named
1499 -- associations that are generated for a nested instance.
1502 and then Is_Named_Assoc
1503 and then Comes_From_Source (Found_Assoc)
1505 Check_Overloaded_Formal_Subprogram (Formal);
1508 -- If there is no corresponding actual, this may be case of
1509 -- partial parametrization, or else the formal has a default
1512 if No (Match) and then Partial_Parametrization then
1513 Process_Default (Formal);
1515 if Nkind (I_Node) = N_Formal_Package_Declaration then
1516 Check_Overloaded_Formal_Subprogram (Formal);
1521 Instantiate_Formal_Subprogram
1522 (Formal, Match, Analyzed_Formal));
1524 -- An instantiation is a freeze point for the actuals,
1525 -- unless this is a rewritten formal package.
1527 if Nkind (I_Node) /= N_Formal_Package_Declaration
1528 and then Nkind (Match) = N_Identifier
1529 and then Is_Subprogram (Entity (Match))
1531 -- The actual subprogram may rename a routine defined
1532 -- in Standard. Avoid freezing such renamings because
1533 -- subprograms coming from Standard cannot be frozen.
1536 not Renames_Standard_Subprogram (Entity (Match))
1538 -- If the actual subprogram comes from a different
1539 -- unit, it is already frozen, either by a body in
1540 -- that unit or by the end of the declarative part
1541 -- of the unit. This check avoids the freezing of
1542 -- subprograms defined in Standard which are used
1543 -- as generic actuals.
1545 and then In_Same_Code_Unit (Entity (Match), I_Node)
1546 and then Has_Fully_Defined_Profile (Entity (Match))
1548 -- Mark the subprogram as having a delayed freeze
1549 -- since this may be an out-of-order action.
1551 Set_Has_Delayed_Freeze (Entity (Match));
1552 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1556 -- If this is a nested generic, preserve default for later
1560 and then Box_Present (Formal)
1563 (Defining_Unit_Name (Specification (Last (Assoc))),
1567 when N_Formal_Package_Declaration =>
1570 Defining_Identifier (Formal),
1571 Defining_Identifier (Original_Node (Analyzed_Formal)));
1574 if Partial_Parametrization then
1575 Process_Default (Formal);
1578 Error_Msg_Sloc := Sloc (Gen_Unit);
1581 Instantiation_Node, Defining_Identifier (Formal));
1582 Error_Msg_NE ("\in instantiation of & declared#",
1583 Instantiation_Node, Gen_Unit);
1585 Abandon_Instantiation (Instantiation_Node);
1591 (Instantiate_Formal_Package
1592 (Formal, Match, Analyzed_Formal),
1596 -- For use type and use package appearing in the generic part,
1597 -- we have already copied them, so we can just move them where
1598 -- they belong (we mustn't recopy them since this would mess up
1599 -- the Sloc values).
1601 when N_Use_Package_Clause |
1602 N_Use_Type_Clause =>
1603 if Nkind (Original_Node (I_Node)) =
1604 N_Formal_Package_Declaration
1606 Append (New_Copy_Tree (Formal), Assoc);
1609 Append (Formal, Assoc);
1613 raise Program_Error;
1617 Formal := Saved_Formal;
1618 Next_Non_Pragma (Analyzed_Formal);
1621 if Num_Actuals > Num_Matched then
1622 Error_Msg_Sloc := Sloc (Gen_Unit);
1624 if Present (Selector_Name (Actual)) then
1626 ("unmatched actual&",
1627 Actual, Selector_Name (Actual));
1628 Error_Msg_NE ("\in instantiation of& declared#",
1632 ("unmatched actual in instantiation of& declared#",
1637 elsif Present (Actuals) then
1639 ("too many actuals in generic instantiation", Instantiation_Node);
1642 -- An instantiation freezes all generic actuals. The only exceptions
1643 -- to this are incomplete types and subprograms which are not fully
1644 -- defined at the point of instantiation.
1647 Elmt : Elmt_Id := First_Elmt (Actuals_To_Freeze);
1649 while Present (Elmt) loop
1650 Freeze_Before (I_Node, Node (Elmt));
1655 -- If there are default subprograms, normalize the tree by adding
1656 -- explicit associations for them. This is required if the instance
1657 -- appears within a generic.
1665 Elmt := First_Elmt (Default_Actuals);
1666 while Present (Elmt) loop
1667 if No (Actuals) then
1668 Actuals := New_List;
1669 Set_Generic_Associations (I_Node, Actuals);
1672 Subp := Node (Elmt);
1674 Make_Generic_Association (Sloc (Subp),
1675 Selector_Name => New_Occurrence_Of (Subp, Sloc (Subp)),
1676 Explicit_Generic_Actual_Parameter =>
1677 New_Occurrence_Of (Subp, Sloc (Subp)));
1678 Mark_Rewrite_Insertion (New_D);
1679 Append_To (Actuals, New_D);
1684 -- If this is a formal package, normalize the parameter list by adding
1685 -- explicit box associations for the formals that are covered by an
1688 if not Is_Empty_List (Default_Formals) then
1689 Append_List (Default_Formals, Formals);
1693 end Analyze_Associations;
1695 -------------------------------
1696 -- Analyze_Formal_Array_Type --
1697 -------------------------------
1699 procedure Analyze_Formal_Array_Type
1700 (T : in out Entity_Id;
1706 -- Treated like a non-generic array declaration, with additional
1711 if Nkind (Def) = N_Constrained_Array_Definition then
1712 DSS := First (Discrete_Subtype_Definitions (Def));
1713 while Present (DSS) loop
1714 if Nkind_In (DSS, N_Subtype_Indication,
1716 N_Attribute_Reference)
1718 Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
1725 Array_Type_Declaration (T, Def);
1726 Set_Is_Generic_Type (Base_Type (T));
1728 if Ekind (Component_Type (T)) = E_Incomplete_Type
1729 and then No (Full_View (Component_Type (T)))
1731 Error_Msg_N ("premature usage of incomplete type", Def);
1733 -- Check that range constraint is not allowed on the component type
1734 -- of a generic formal array type (AARM 12.5.3(3))
1736 elsif Is_Internal (Component_Type (T))
1737 and then Present (Subtype_Indication (Component_Definition (Def)))
1738 and then Nkind (Original_Node
1739 (Subtype_Indication (Component_Definition (Def)))) =
1740 N_Subtype_Indication
1743 ("in a formal, a subtype indication can only be "
1744 & "a subtype mark (RM 12.5.3(3))",
1745 Subtype_Indication (Component_Definition (Def)));
1748 end Analyze_Formal_Array_Type;
1750 ---------------------------------------------
1751 -- Analyze_Formal_Decimal_Fixed_Point_Type --
1752 ---------------------------------------------
1754 -- As for other generic types, we create a valid type representation with
1755 -- legal but arbitrary attributes, whose values are never considered
1756 -- static. For all scalar types we introduce an anonymous base type, with
1757 -- the same attributes. We choose the corresponding integer type to be
1758 -- Standard_Integer.
1759 -- Here and in other similar routines, the Sloc of the generated internal
1760 -- type must be the same as the sloc of the defining identifier of the
1761 -- formal type declaration, to provide proper source navigation.
1763 procedure Analyze_Formal_Decimal_Fixed_Point_Type
1767 Loc : constant Source_Ptr := Sloc (Def);
1769 Base : constant Entity_Id :=
1771 (E_Decimal_Fixed_Point_Type,
1773 Sloc (Defining_Identifier (Parent (Def))), 'G');
1775 Int_Base : constant Entity_Id := Standard_Integer;
1776 Delta_Val : constant Ureal := Ureal_1;
1777 Digs_Val : constant Uint := Uint_6;
1782 Set_Etype (Base, Base);
1783 Set_Size_Info (Base, Int_Base);
1784 Set_RM_Size (Base, RM_Size (Int_Base));
1785 Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
1786 Set_Digits_Value (Base, Digs_Val);
1787 Set_Delta_Value (Base, Delta_Val);
1788 Set_Small_Value (Base, Delta_Val);
1789 Set_Scalar_Range (Base,
1791 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
1792 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
1794 Set_Is_Generic_Type (Base);
1795 Set_Parent (Base, Parent (Def));
1797 Set_Ekind (T, E_Decimal_Fixed_Point_Subtype);
1798 Set_Etype (T, Base);
1799 Set_Size_Info (T, Int_Base);
1800 Set_RM_Size (T, RM_Size (Int_Base));
1801 Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
1802 Set_Digits_Value (T, Digs_Val);
1803 Set_Delta_Value (T, Delta_Val);
1804 Set_Small_Value (T, Delta_Val);
1805 Set_Scalar_Range (T, Scalar_Range (Base));
1806 Set_Is_Constrained (T);
1808 Check_Restriction (No_Fixed_Point, Def);
1809 end Analyze_Formal_Decimal_Fixed_Point_Type;
1811 -------------------------------------------
1812 -- Analyze_Formal_Derived_Interface_Type --
1813 -------------------------------------------
1815 procedure Analyze_Formal_Derived_Interface_Type
1820 Loc : constant Source_Ptr := Sloc (Def);
1823 -- Rewrite as a type declaration of a derived type. This ensures that
1824 -- the interface list and primitive operations are properly captured.
1827 Make_Full_Type_Declaration (Loc,
1828 Defining_Identifier => T,
1829 Type_Definition => Def));
1831 Set_Is_Generic_Type (T);
1832 end Analyze_Formal_Derived_Interface_Type;
1834 ---------------------------------
1835 -- Analyze_Formal_Derived_Type --
1836 ---------------------------------
1838 procedure Analyze_Formal_Derived_Type
1843 Loc : constant Source_Ptr := Sloc (Def);
1844 Unk_Disc : constant Boolean := Unknown_Discriminants_Present (N);
1848 Set_Is_Generic_Type (T);
1850 if Private_Present (Def) then
1852 Make_Private_Extension_Declaration (Loc,
1853 Defining_Identifier => T,
1854 Discriminant_Specifications => Discriminant_Specifications (N),
1855 Unknown_Discriminants_Present => Unk_Disc,
1856 Subtype_Indication => Subtype_Mark (Def),
1857 Interface_List => Interface_List (Def));
1859 Set_Abstract_Present (New_N, Abstract_Present (Def));
1860 Set_Limited_Present (New_N, Limited_Present (Def));
1861 Set_Synchronized_Present (New_N, Synchronized_Present (Def));
1865 Make_Full_Type_Declaration (Loc,
1866 Defining_Identifier => T,
1867 Discriminant_Specifications =>
1868 Discriminant_Specifications (Parent (T)),
1870 Make_Derived_Type_Definition (Loc,
1871 Subtype_Indication => Subtype_Mark (Def)));
1873 Set_Abstract_Present
1874 (Type_Definition (New_N), Abstract_Present (Def));
1876 (Type_Definition (New_N), Limited_Present (Def));
1883 if not Is_Composite_Type (T) then
1885 ("unknown discriminants not allowed for elementary types", N);
1887 Set_Has_Unknown_Discriminants (T);
1888 Set_Is_Constrained (T, False);
1892 -- If the parent type has a known size, so does the formal, which makes
1893 -- legal representation clauses that involve the formal.
1895 Set_Size_Known_At_Compile_Time
1896 (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
1897 end Analyze_Formal_Derived_Type;
1899 ----------------------------------
1900 -- Analyze_Formal_Discrete_Type --
1901 ----------------------------------
1903 -- The operations defined for a discrete types are those of an enumeration
1904 -- type. The size is set to an arbitrary value, for use in analyzing the
1907 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
1908 Loc : constant Source_Ptr := Sloc (Def);
1912 Base : constant Entity_Id :=
1914 (E_Floating_Point_Type, Current_Scope,
1915 Sloc (Defining_Identifier (Parent (Def))), 'G');
1919 Set_Ekind (T, E_Enumeration_Subtype);
1920 Set_Etype (T, Base);
1923 Set_Is_Generic_Type (T);
1924 Set_Is_Constrained (T);
1926 -- For semantic analysis, the bounds of the type must be set to some
1927 -- non-static value. The simplest is to create attribute nodes for those
1928 -- bounds, that refer to the type itself. These bounds are never
1929 -- analyzed but serve as place-holders.
1932 Make_Attribute_Reference (Loc,
1933 Attribute_Name => Name_First,
1934 Prefix => New_Reference_To (T, Loc));
1938 Make_Attribute_Reference (Loc,
1939 Attribute_Name => Name_Last,
1940 Prefix => New_Reference_To (T, Loc));
1943 Set_Scalar_Range (T,
1948 Set_Ekind (Base, E_Enumeration_Type);
1949 Set_Etype (Base, Base);
1950 Init_Size (Base, 8);
1951 Init_Alignment (Base);
1952 Set_Is_Generic_Type (Base);
1953 Set_Scalar_Range (Base, Scalar_Range (T));
1954 Set_Parent (Base, Parent (Def));
1955 end Analyze_Formal_Discrete_Type;
1957 ----------------------------------
1958 -- Analyze_Formal_Floating_Type --
1959 ---------------------------------
1961 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
1962 Base : constant Entity_Id :=
1964 (E_Floating_Point_Type, Current_Scope,
1965 Sloc (Defining_Identifier (Parent (Def))), 'G');
1968 -- The various semantic attributes are taken from the predefined type
1969 -- Float, just so that all of them are initialized. Their values are
1970 -- never used because no constant folding or expansion takes place in
1971 -- the generic itself.
1974 Set_Ekind (T, E_Floating_Point_Subtype);
1975 Set_Etype (T, Base);
1976 Set_Size_Info (T, (Standard_Float));
1977 Set_RM_Size (T, RM_Size (Standard_Float));
1978 Set_Digits_Value (T, Digits_Value (Standard_Float));
1979 Set_Scalar_Range (T, Scalar_Range (Standard_Float));
1980 Set_Is_Constrained (T);
1982 Set_Is_Generic_Type (Base);
1983 Set_Etype (Base, Base);
1984 Set_Size_Info (Base, (Standard_Float));
1985 Set_RM_Size (Base, RM_Size (Standard_Float));
1986 Set_Digits_Value (Base, Digits_Value (Standard_Float));
1987 Set_Scalar_Range (Base, Scalar_Range (Standard_Float));
1988 Set_Parent (Base, Parent (Def));
1990 Check_Restriction (No_Floating_Point, Def);
1991 end Analyze_Formal_Floating_Type;
1993 -----------------------------------
1994 -- Analyze_Formal_Interface_Type;--
1995 -----------------------------------
1997 procedure Analyze_Formal_Interface_Type
2002 Loc : constant Source_Ptr := Sloc (N);
2007 Make_Full_Type_Declaration (Loc,
2008 Defining_Identifier => T,
2009 Type_Definition => Def);
2013 Set_Is_Generic_Type (T);
2014 end Analyze_Formal_Interface_Type;
2016 ---------------------------------
2017 -- Analyze_Formal_Modular_Type --
2018 ---------------------------------
2020 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
2022 -- Apart from their entity kind, generic modular types are treated like
2023 -- signed integer types, and have the same attributes.
2025 Analyze_Formal_Signed_Integer_Type (T, Def);
2026 Set_Ekind (T, E_Modular_Integer_Subtype);
2027 Set_Ekind (Etype (T), E_Modular_Integer_Type);
2029 end Analyze_Formal_Modular_Type;
2031 ---------------------------------------
2032 -- Analyze_Formal_Object_Declaration --
2033 ---------------------------------------
2035 procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
2036 E : constant Node_Id := Default_Expression (N);
2037 Id : constant Node_Id := Defining_Identifier (N);
2044 -- Determine the mode of the formal object
2046 if Out_Present (N) then
2047 K := E_Generic_In_Out_Parameter;
2049 if not In_Present (N) then
2050 Error_Msg_N ("formal generic objects cannot have mode OUT", N);
2054 K := E_Generic_In_Parameter;
2057 if Present (Subtype_Mark (N)) then
2058 Find_Type (Subtype_Mark (N));
2059 T := Entity (Subtype_Mark (N));
2061 -- Verify that there is no redundant null exclusion
2063 if Null_Exclusion_Present (N) then
2064 if not Is_Access_Type (T) then
2066 ("null exclusion can only apply to an access type", N);
2068 elsif Can_Never_Be_Null (T) then
2070 ("`NOT NULL` not allowed (& already excludes null)",
2075 -- Ada 2005 (AI-423): Formal object with an access definition
2078 Check_Access_Definition (N);
2079 T := Access_Definition
2081 N => Access_Definition (N));
2084 if Ekind (T) = E_Incomplete_Type then
2086 Error_Node : Node_Id;
2089 if Present (Subtype_Mark (N)) then
2090 Error_Node := Subtype_Mark (N);
2092 Check_Access_Definition (N);
2093 Error_Node := Access_Definition (N);
2096 Error_Msg_N ("premature usage of incomplete type", Error_Node);
2100 if K = E_Generic_In_Parameter then
2102 -- Ada 2005 (AI-287): Limited aggregates allowed in generic formals
2104 if Ada_Version < Ada_2005 and then Is_Limited_Type (T) then
2106 ("generic formal of mode IN must not be of limited type", N);
2107 Explain_Limited_Type (T, N);
2110 if Is_Abstract_Type (T) then
2112 ("generic formal of mode IN must not be of abstract type", N);
2116 Preanalyze_Spec_Expression (E, T);
2118 if Is_Limited_Type (T) and then not OK_For_Limited_Init (T, E) then
2120 ("initialization not allowed for limited types", E);
2121 Explain_Limited_Type (T, E);
2128 -- Case of generic IN OUT parameter
2131 -- If the formal has an unconstrained type, construct its actual
2132 -- subtype, as is done for subprogram formals. In this fashion, all
2133 -- its uses can refer to specific bounds.
2138 if (Is_Array_Type (T)
2139 and then not Is_Constrained (T))
2141 (Ekind (T) = E_Record_Type
2142 and then Has_Discriminants (T))
2145 Non_Freezing_Ref : constant Node_Id :=
2146 New_Reference_To (Id, Sloc (Id));
2150 -- Make sure the actual subtype doesn't generate bogus freezing
2152 Set_Must_Not_Freeze (Non_Freezing_Ref);
2153 Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
2154 Insert_Before_And_Analyze (N, Decl);
2155 Set_Actual_Subtype (Id, Defining_Identifier (Decl));
2158 Set_Actual_Subtype (Id, T);
2163 ("initialization not allowed for `IN OUT` formals", N);
2167 if Has_Aspects (N) then
2168 Analyze_Aspect_Specifications (N, Id);
2170 end Analyze_Formal_Object_Declaration;
2172 ----------------------------------------------
2173 -- Analyze_Formal_Ordinary_Fixed_Point_Type --
2174 ----------------------------------------------
2176 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
2180 Loc : constant Source_Ptr := Sloc (Def);
2181 Base : constant Entity_Id :=
2183 (E_Ordinary_Fixed_Point_Type, Current_Scope,
2184 Sloc (Defining_Identifier (Parent (Def))), 'G');
2187 -- The semantic attributes are set for completeness only, their values
2188 -- will never be used, since all properties of the type are non-static.
2191 Set_Ekind (T, E_Ordinary_Fixed_Point_Subtype);
2192 Set_Etype (T, Base);
2193 Set_Size_Info (T, Standard_Integer);
2194 Set_RM_Size (T, RM_Size (Standard_Integer));
2195 Set_Small_Value (T, Ureal_1);
2196 Set_Delta_Value (T, Ureal_1);
2197 Set_Scalar_Range (T,
2199 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
2200 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
2201 Set_Is_Constrained (T);
2203 Set_Is_Generic_Type (Base);
2204 Set_Etype (Base, Base);
2205 Set_Size_Info (Base, Standard_Integer);
2206 Set_RM_Size (Base, RM_Size (Standard_Integer));
2207 Set_Small_Value (Base, Ureal_1);
2208 Set_Delta_Value (Base, Ureal_1);
2209 Set_Scalar_Range (Base, Scalar_Range (T));
2210 Set_Parent (Base, Parent (Def));
2212 Check_Restriction (No_Fixed_Point, Def);
2213 end Analyze_Formal_Ordinary_Fixed_Point_Type;
2215 ----------------------------------------
2216 -- Analyze_Formal_Package_Declaration --
2217 ----------------------------------------
2219 procedure Analyze_Formal_Package_Declaration (N : Node_Id) is
2220 Loc : constant Source_Ptr := Sloc (N);
2221 Pack_Id : constant Entity_Id := Defining_Identifier (N);
2223 Gen_Id : constant Node_Id := Name (N);
2225 Gen_Unit : Entity_Id;
2227 Parent_Installed : Boolean := False;
2229 Parent_Instance : Entity_Id;
2230 Renaming_In_Par : Entity_Id;
2231 Associations : Boolean := True;
2233 Vis_Prims_List : Elist_Id := No_Elist;
2234 -- List of primitives made temporarily visible in the instantiation
2235 -- to match the visibility of the formal type
2237 function Build_Local_Package return Node_Id;
2238 -- The formal package is rewritten so that its parameters are replaced
2239 -- with corresponding declarations. For parameters with bona fide
2240 -- associations these declarations are created by Analyze_Associations
2241 -- as for a regular instantiation. For boxed parameters, we preserve
2242 -- the formal declarations and analyze them, in order to introduce
2243 -- entities of the right kind in the environment of the formal.
2245 -------------------------
2246 -- Build_Local_Package --
2247 -------------------------
2249 function Build_Local_Package return Node_Id is
2251 Pack_Decl : Node_Id;
2254 -- Within the formal, the name of the generic package is a renaming
2255 -- of the formal (as for a regular instantiation).
2258 Make_Package_Declaration (Loc,
2261 (Specification (Original_Node (Gen_Decl)),
2262 Empty, Instantiating => True));
2264 Renaming := Make_Package_Renaming_Declaration (Loc,
2265 Defining_Unit_Name =>
2266 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2267 Name => New_Occurrence_Of (Formal, Loc));
2269 if Nkind (Gen_Id) = N_Identifier
2270 and then Chars (Gen_Id) = Chars (Pack_Id)
2273 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2276 -- If the formal is declared with a box, or with an others choice,
2277 -- create corresponding declarations for all entities in the formal
2278 -- part, so that names with the proper types are available in the
2279 -- specification of the formal package.
2281 -- On the other hand, if there are no associations, then all the
2282 -- formals must have defaults, and this will be checked by the
2283 -- call to Analyze_Associations.
2286 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2289 Formal_Decl : Node_Id;
2292 -- TBA : for a formal package, need to recurse ???
2297 (Generic_Formal_Declarations (Original_Node (Gen_Decl)));
2298 while Present (Formal_Decl) loop
2300 (Decls, Copy_Generic_Node (Formal_Decl, Empty, True));
2305 -- If generic associations are present, use Analyze_Associations to
2306 -- create the proper renaming declarations.
2310 Act_Tree : constant Node_Id :=
2312 (Original_Node (Gen_Decl), Empty,
2313 Instantiating => True);
2316 Generic_Renamings.Set_Last (0);
2317 Generic_Renamings_HTable.Reset;
2318 Instantiation_Node := N;
2321 Analyze_Associations
2322 (I_Node => Original_Node (N),
2323 Formals => Generic_Formal_Declarations (Act_Tree),
2324 F_Copy => Generic_Formal_Declarations (Gen_Decl));
2326 Vis_Prims_List := Check_Hidden_Primitives (Decls);
2330 Append (Renaming, To => Decls);
2332 -- Add generated declarations ahead of local declarations in
2335 if No (Visible_Declarations (Specification (Pack_Decl))) then
2336 Set_Visible_Declarations (Specification (Pack_Decl), Decls);
2339 (First (Visible_Declarations (Specification (Pack_Decl))),
2344 end Build_Local_Package;
2346 -- Start of processing for Analyze_Formal_Package_Declaration
2349 Text_IO_Kludge (Gen_Id);
2352 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2353 Gen_Unit := Entity (Gen_Id);
2355 -- Check for a formal package that is a package renaming
2357 if Present (Renamed_Object (Gen_Unit)) then
2359 -- Indicate that unit is used, before replacing it with renamed
2360 -- entity for use below.
2362 if In_Extended_Main_Source_Unit (N) then
2363 Set_Is_Instantiated (Gen_Unit);
2364 Generate_Reference (Gen_Unit, N);
2367 Gen_Unit := Renamed_Object (Gen_Unit);
2370 if Ekind (Gen_Unit) /= E_Generic_Package then
2371 Error_Msg_N ("expect generic package name", Gen_Id);
2375 elsif Gen_Unit = Current_Scope then
2377 ("generic package cannot be used as a formal package of itself",
2382 elsif In_Open_Scopes (Gen_Unit) then
2383 if Is_Compilation_Unit (Gen_Unit)
2384 and then Is_Child_Unit (Current_Scope)
2386 -- Special-case the error when the formal is a parent, and
2387 -- continue analysis to minimize cascaded errors.
2390 ("generic parent cannot be used as formal package "
2391 & "of a child unit",
2396 ("generic package cannot be used as a formal package "
2404 -- Check that name of formal package does not hide name of generic,
2405 -- or its leading prefix. This check must be done separately because
2406 -- the name of the generic has already been analyzed.
2409 Gen_Name : Entity_Id;
2413 while Nkind (Gen_Name) = N_Expanded_Name loop
2414 Gen_Name := Prefix (Gen_Name);
2417 if Chars (Gen_Name) = Chars (Pack_Id) then
2419 ("& is hidden within declaration of formal package",
2425 or else No (Generic_Associations (N))
2426 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2428 Associations := False;
2431 -- If there are no generic associations, the generic parameters appear
2432 -- as local entities and are instantiated like them. We copy the generic
2433 -- package declaration as if it were an instantiation, and analyze it
2434 -- like a regular package, except that we treat the formals as
2435 -- additional visible components.
2437 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2439 if In_Extended_Main_Source_Unit (N) then
2440 Set_Is_Instantiated (Gen_Unit);
2441 Generate_Reference (Gen_Unit, N);
2444 Formal := New_Copy (Pack_Id);
2445 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2448 -- Make local generic without formals. The formals will be replaced
2449 -- with internal declarations.
2451 New_N := Build_Local_Package;
2453 -- If there are errors in the parameter list, Analyze_Associations
2454 -- raises Instantiation_Error. Patch the declaration to prevent
2455 -- further exception propagation.
2458 when Instantiation_Error =>
2460 Enter_Name (Formal);
2461 Set_Ekind (Formal, E_Variable);
2462 Set_Etype (Formal, Any_Type);
2463 Restore_Hidden_Primitives (Vis_Prims_List);
2465 if Parent_Installed then
2473 Set_Defining_Unit_Name (Specification (New_N), Formal);
2474 Set_Generic_Parent (Specification (N), Gen_Unit);
2475 Set_Instance_Env (Gen_Unit, Formal);
2476 Set_Is_Generic_Instance (Formal);
2478 Enter_Name (Formal);
2479 Set_Ekind (Formal, E_Package);
2480 Set_Etype (Formal, Standard_Void_Type);
2481 Set_Inner_Instances (Formal, New_Elmt_List);
2482 Push_Scope (Formal);
2484 if Is_Child_Unit (Gen_Unit)
2485 and then Parent_Installed
2487 -- Similarly, we have to make the name of the formal visible in the
2488 -- parent instance, to resolve properly fully qualified names that
2489 -- may appear in the generic unit. The parent instance has been
2490 -- placed on the scope stack ahead of the current scope.
2492 Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
2495 Make_Defining_Identifier (Loc, Chars (Gen_Unit));
2496 Set_Ekind (Renaming_In_Par, E_Package);
2497 Set_Etype (Renaming_In_Par, Standard_Void_Type);
2498 Set_Scope (Renaming_In_Par, Parent_Instance);
2499 Set_Parent (Renaming_In_Par, Parent (Formal));
2500 Set_Renamed_Object (Renaming_In_Par, Formal);
2501 Append_Entity (Renaming_In_Par, Parent_Instance);
2504 Analyze (Specification (N));
2506 -- The formals for which associations are provided are not visible
2507 -- outside of the formal package. The others are still declared by a
2508 -- formal parameter declaration.
2510 -- If there are no associations, the only local entity to hide is the
2511 -- generated package renaming itself.
2517 E := First_Entity (Formal);
2518 while Present (E) loop
2520 and then not Is_Generic_Formal (E)
2525 if Ekind (E) = E_Package
2526 and then Renamed_Entity (E) = Formal
2536 End_Package_Scope (Formal);
2537 Restore_Hidden_Primitives (Vis_Prims_List);
2539 if Parent_Installed then
2545 -- Inside the generic unit, the formal package is a regular package, but
2546 -- no body is needed for it. Note that after instantiation, the defining
2547 -- unit name we need is in the new tree and not in the original (see
2548 -- Package_Instantiation). A generic formal package is an instance, and
2549 -- can be used as an actual for an inner instance.
2551 Set_Has_Completion (Formal, True);
2553 -- Add semantic information to the original defining identifier.
2556 Set_Ekind (Pack_Id, E_Package);
2557 Set_Etype (Pack_Id, Standard_Void_Type);
2558 Set_Scope (Pack_Id, Scope (Formal));
2559 Set_Has_Completion (Pack_Id, True);
2562 if Has_Aspects (N) then
2563 Analyze_Aspect_Specifications (N, Pack_Id);
2565 end Analyze_Formal_Package_Declaration;
2567 ---------------------------------
2568 -- Analyze_Formal_Private_Type --
2569 ---------------------------------
2571 procedure Analyze_Formal_Private_Type
2577 New_Private_Type (N, T, Def);
2579 -- Set the size to an arbitrary but legal value
2581 Set_Size_Info (T, Standard_Integer);
2582 Set_RM_Size (T, RM_Size (Standard_Integer));
2583 end Analyze_Formal_Private_Type;
2585 ------------------------------------
2586 -- Analyze_Formal_Incomplete_Type --
2587 ------------------------------------
2589 procedure Analyze_Formal_Incomplete_Type
2595 Set_Ekind (T, E_Incomplete_Type);
2597 Set_Private_Dependents (T, New_Elmt_List);
2599 if Tagged_Present (Def) then
2600 Set_Is_Tagged_Type (T);
2601 Make_Class_Wide_Type (T);
2602 Set_Direct_Primitive_Operations (T, New_Elmt_List);
2604 end Analyze_Formal_Incomplete_Type;
2606 ----------------------------------------
2607 -- Analyze_Formal_Signed_Integer_Type --
2608 ----------------------------------------
2610 procedure Analyze_Formal_Signed_Integer_Type
2614 Base : constant Entity_Id :=
2616 (E_Signed_Integer_Type,
2618 Sloc (Defining_Identifier (Parent (Def))), 'G');
2623 Set_Ekind (T, E_Signed_Integer_Subtype);
2624 Set_Etype (T, Base);
2625 Set_Size_Info (T, Standard_Integer);
2626 Set_RM_Size (T, RM_Size (Standard_Integer));
2627 Set_Scalar_Range (T, Scalar_Range (Standard_Integer));
2628 Set_Is_Constrained (T);
2630 Set_Is_Generic_Type (Base);
2631 Set_Size_Info (Base, Standard_Integer);
2632 Set_RM_Size (Base, RM_Size (Standard_Integer));
2633 Set_Etype (Base, Base);
2634 Set_Scalar_Range (Base, Scalar_Range (Standard_Integer));
2635 Set_Parent (Base, Parent (Def));
2636 end Analyze_Formal_Signed_Integer_Type;
2638 -------------------------------------------
2639 -- Analyze_Formal_Subprogram_Declaration --
2640 -------------------------------------------
2642 procedure Analyze_Formal_Subprogram_Declaration (N : Node_Id) is
2643 Spec : constant Node_Id := Specification (N);
2644 Def : constant Node_Id := Default_Name (N);
2645 Nam : constant Entity_Id := Defining_Unit_Name (Spec);
2653 if Nkind (Nam) = N_Defining_Program_Unit_Name then
2654 Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
2658 Analyze_Subprogram_Declaration (N);
2659 Set_Is_Formal_Subprogram (Nam);
2660 Set_Has_Completion (Nam);
2662 if Nkind (N) = N_Formal_Abstract_Subprogram_Declaration then
2663 Set_Is_Abstract_Subprogram (Nam);
2664 Set_Is_Dispatching_Operation (Nam);
2667 Ctrl_Type : constant Entity_Id := Find_Dispatching_Type (Nam);
2669 if No (Ctrl_Type) then
2671 ("abstract formal subprogram must have a controlling type",
2674 elsif Ada_Version >= Ada_2012
2675 and then Is_Incomplete_Type (Ctrl_Type)
2678 ("controlling type of abstract formal subprogram cannot " &
2679 "be incomplete type", N, Ctrl_Type);
2682 Check_Controlling_Formals (Ctrl_Type, Nam);
2687 -- Default name is resolved at the point of instantiation
2689 if Box_Present (N) then
2692 -- Else default is bound at the point of generic declaration
2694 elsif Present (Def) then
2695 if Nkind (Def) = N_Operator_Symbol then
2696 Find_Direct_Name (Def);
2698 elsif Nkind (Def) /= N_Attribute_Reference then
2702 -- For an attribute reference, analyze the prefix and verify
2703 -- that it has the proper profile for the subprogram.
2705 Analyze (Prefix (Def));
2706 Valid_Default_Attribute (Nam, Def);
2710 -- Default name may be overloaded, in which case the interpretation
2711 -- with the correct profile must be selected, as for a renaming.
2712 -- If the definition is an indexed component, it must denote a
2713 -- member of an entry family. If it is a selected component, it
2714 -- can be a protected operation.
2716 if Etype (Def) = Any_Type then
2719 elsif Nkind (Def) = N_Selected_Component then
2720 if not Is_Overloadable (Entity (Selector_Name (Def))) then
2721 Error_Msg_N ("expect valid subprogram name as default", Def);
2724 elsif Nkind (Def) = N_Indexed_Component then
2725 if Is_Entity_Name (Prefix (Def)) then
2726 if Ekind (Entity (Prefix (Def))) /= E_Entry_Family then
2727 Error_Msg_N ("expect valid subprogram name as default", Def);
2730 elsif Nkind (Prefix (Def)) = N_Selected_Component then
2731 if Ekind (Entity (Selector_Name (Prefix (Def)))) /=
2734 Error_Msg_N ("expect valid subprogram name as default", Def);
2738 Error_Msg_N ("expect valid subprogram name as default", Def);
2742 elsif Nkind (Def) = N_Character_Literal then
2744 -- Needs some type checks: subprogram should be parameterless???
2746 Resolve (Def, (Etype (Nam)));
2748 elsif not Is_Entity_Name (Def)
2749 or else not Is_Overloadable (Entity (Def))
2751 Error_Msg_N ("expect valid subprogram name as default", Def);
2754 elsif not Is_Overloaded (Def) then
2755 Subp := Entity (Def);
2758 Error_Msg_N ("premature usage of formal subprogram", Def);
2760 elsif not Entity_Matches_Spec (Subp, Nam) then
2761 Error_Msg_N ("no visible entity matches specification", Def);
2764 -- More than one interpretation, so disambiguate as for a renaming
2769 I1 : Interp_Index := 0;
2775 Get_First_Interp (Def, I, It);
2776 while Present (It.Nam) loop
2777 if Entity_Matches_Spec (It.Nam, Nam) then
2778 if Subp /= Any_Id then
2779 It1 := Disambiguate (Def, I1, I, Etype (Subp));
2781 if It1 = No_Interp then
2782 Error_Msg_N ("ambiguous default subprogram", Def);
2795 Get_Next_Interp (I, It);
2799 if Subp /= Any_Id then
2801 -- Subprogram found, generate reference to it
2803 Set_Entity (Def, Subp);
2804 Generate_Reference (Subp, Def);
2807 Error_Msg_N ("premature usage of formal subprogram", Def);
2809 elsif Ekind (Subp) /= E_Operator then
2810 Check_Mode_Conformant (Subp, Nam);
2814 Error_Msg_N ("no visible subprogram matches specification", N);
2820 if Has_Aspects (N) then
2821 Analyze_Aspect_Specifications (N, Nam);
2824 end Analyze_Formal_Subprogram_Declaration;
2826 -------------------------------------
2827 -- Analyze_Formal_Type_Declaration --
2828 -------------------------------------
2830 procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
2831 Def : constant Node_Id := Formal_Type_Definition (N);
2835 T := Defining_Identifier (N);
2837 if Present (Discriminant_Specifications (N))
2838 and then Nkind (Def) /= N_Formal_Private_Type_Definition
2841 ("discriminants not allowed for this formal type", T);
2844 -- Enter the new name, and branch to specific routine
2847 when N_Formal_Private_Type_Definition =>
2848 Analyze_Formal_Private_Type (N, T, Def);
2850 when N_Formal_Derived_Type_Definition =>
2851 Analyze_Formal_Derived_Type (N, T, Def);
2853 when N_Formal_Incomplete_Type_Definition =>
2854 Analyze_Formal_Incomplete_Type (T, Def);
2856 when N_Formal_Discrete_Type_Definition =>
2857 Analyze_Formal_Discrete_Type (T, Def);
2859 when N_Formal_Signed_Integer_Type_Definition =>
2860 Analyze_Formal_Signed_Integer_Type (T, Def);
2862 when N_Formal_Modular_Type_Definition =>
2863 Analyze_Formal_Modular_Type (T, Def);
2865 when N_Formal_Floating_Point_Definition =>
2866 Analyze_Formal_Floating_Type (T, Def);
2868 when N_Formal_Ordinary_Fixed_Point_Definition =>
2869 Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
2871 when N_Formal_Decimal_Fixed_Point_Definition =>
2872 Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
2874 when N_Array_Type_Definition =>
2875 Analyze_Formal_Array_Type (T, Def);
2877 when N_Access_To_Object_Definition |
2878 N_Access_Function_Definition |
2879 N_Access_Procedure_Definition =>
2880 Analyze_Generic_Access_Type (T, Def);
2882 -- Ada 2005: a interface declaration is encoded as an abstract
2883 -- record declaration or a abstract type derivation.
2885 when N_Record_Definition =>
2886 Analyze_Formal_Interface_Type (N, T, Def);
2888 when N_Derived_Type_Definition =>
2889 Analyze_Formal_Derived_Interface_Type (N, T, Def);
2895 raise Program_Error;
2899 Set_Is_Generic_Type (T);
2901 if Has_Aspects (N) then
2902 Analyze_Aspect_Specifications (N, T);
2904 end Analyze_Formal_Type_Declaration;
2906 ------------------------------------
2907 -- Analyze_Function_Instantiation --
2908 ------------------------------------
2910 procedure Analyze_Function_Instantiation (N : Node_Id) is
2912 Analyze_Subprogram_Instantiation (N, E_Function);
2913 end Analyze_Function_Instantiation;
2915 ---------------------------------
2916 -- Analyze_Generic_Access_Type --
2917 ---------------------------------
2919 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
2923 if Nkind (Def) = N_Access_To_Object_Definition then
2924 Access_Type_Declaration (T, Def);
2926 if Is_Incomplete_Or_Private_Type (Designated_Type (T))
2927 and then No (Full_View (Designated_Type (T)))
2928 and then not Is_Generic_Type (Designated_Type (T))
2930 Error_Msg_N ("premature usage of incomplete type", Def);
2932 elsif not Is_Entity_Name (Subtype_Indication (Def)) then
2934 ("only a subtype mark is allowed in a formal", Def);
2938 Access_Subprogram_Declaration (T, Def);
2940 end Analyze_Generic_Access_Type;
2942 ---------------------------------
2943 -- Analyze_Generic_Formal_Part --
2944 ---------------------------------
2946 procedure Analyze_Generic_Formal_Part (N : Node_Id) is
2947 Gen_Parm_Decl : Node_Id;
2950 -- The generic formals are processed in the scope of the generic unit,
2951 -- where they are immediately visible. The scope is installed by the
2954 Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
2956 while Present (Gen_Parm_Decl) loop
2957 Analyze (Gen_Parm_Decl);
2958 Next (Gen_Parm_Decl);
2961 Generate_Reference_To_Generic_Formals (Current_Scope);
2962 end Analyze_Generic_Formal_Part;
2964 ------------------------------------------
2965 -- Analyze_Generic_Package_Declaration --
2966 ------------------------------------------
2968 procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
2969 Loc : constant Source_Ptr := Sloc (N);
2972 Save_Parent : Node_Id;
2974 Decls : constant List_Id :=
2975 Visible_Declarations (Specification (N));
2979 Check_SPARK_Restriction ("generic is not allowed", N);
2981 -- We introduce a renaming of the enclosing package, to have a usable
2982 -- entity as the prefix of an expanded name for a local entity of the
2983 -- form Par.P.Q, where P is the generic package. This is because a local
2984 -- entity named P may hide it, so that the usual visibility rules in
2985 -- the instance will not resolve properly.
2988 Make_Package_Renaming_Declaration (Loc,
2989 Defining_Unit_Name =>
2990 Make_Defining_Identifier (Loc,
2991 Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
2992 Name => Make_Identifier (Loc, Chars (Defining_Entity (N))));
2994 if Present (Decls) then
2995 Decl := First (Decls);
2996 while Present (Decl)
2997 and then Nkind (Decl) = N_Pragma
3002 if Present (Decl) then
3003 Insert_Before (Decl, Renaming);
3005 Append (Renaming, Visible_Declarations (Specification (N)));
3009 Set_Visible_Declarations (Specification (N), New_List (Renaming));
3012 -- Create copy of generic unit, and save for instantiation. If the unit
3013 -- is a child unit, do not copy the specifications for the parent, which
3014 -- are not part of the generic tree.
3016 Save_Parent := Parent_Spec (N);
3017 Set_Parent_Spec (N, Empty);
3019 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3020 Set_Parent_Spec (New_N, Save_Parent);
3022 Id := Defining_Entity (N);
3023 Generate_Definition (Id);
3025 -- Expansion is not applied to generic units
3030 Set_Ekind (Id, E_Generic_Package);
3031 Set_Etype (Id, Standard_Void_Type);
3032 Set_Contract (Id, Make_Contract (Sloc (Id)));
3034 -- Analyze aspects now, so that generated pragmas appear in the
3035 -- declarations before building and analyzing the generic copy.
3037 if Has_Aspects (N) then
3038 Analyze_Aspect_Specifications (N, Id);
3042 Enter_Generic_Scope (Id);
3043 Set_Inner_Instances (Id, New_Elmt_List);
3045 Set_Categorization_From_Pragmas (N);
3046 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3048 -- Link the declaration of the generic homonym in the generic copy to
3049 -- the package it renames, so that it is always resolved properly.
3051 Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
3052 Set_Entity (Associated_Node (Name (Renaming)), Id);
3054 -- For a library unit, we have reconstructed the entity for the unit,
3055 -- and must reset it in the library tables.
3057 if Nkind (Parent (N)) = N_Compilation_Unit then
3058 Set_Cunit_Entity (Current_Sem_Unit, Id);
3061 Analyze_Generic_Formal_Part (N);
3063 -- After processing the generic formals, analysis proceeds as for a
3064 -- non-generic package.
3066 Analyze (Specification (N));
3068 Validate_Categorization_Dependency (N, Id);
3072 End_Package_Scope (Id);
3073 Exit_Generic_Scope (Id);
3075 if Nkind (Parent (N)) /= N_Compilation_Unit then
3076 Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
3077 Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
3078 Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
3081 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3082 Validate_RT_RAT_Component (N);
3084 -- If this is a spec without a body, check that generic parameters
3087 if not Body_Required (Parent (N)) then
3088 Check_References (Id);
3092 end Analyze_Generic_Package_Declaration;
3094 --------------------------------------------
3095 -- Analyze_Generic_Subprogram_Declaration --
3096 --------------------------------------------
3098 procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
3103 Result_Type : Entity_Id;
3104 Save_Parent : Node_Id;
3108 Check_SPARK_Restriction ("generic is not allowed", N);
3110 -- Create copy of generic unit, and save for instantiation. If the unit
3111 -- is a child unit, do not copy the specifications for the parent, which
3112 -- are not part of the generic tree.
3114 Save_Parent := Parent_Spec (N);
3115 Set_Parent_Spec (N, Empty);
3117 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3118 Set_Parent_Spec (New_N, Save_Parent);
3121 -- The aspect specifications are not attached to the tree, and must
3122 -- be copied and attached to the generic copy explicitly.
3124 if Present (Aspect_Specifications (New_N)) then
3126 Aspects : constant List_Id := Aspect_Specifications (N);
3128 Set_Has_Aspects (N, False);
3129 Move_Aspects (New_N, To => N);
3130 Set_Has_Aspects (Original_Node (N), False);
3131 Set_Aspect_Specifications (Original_Node (N), Aspects);
3135 Spec := Specification (N);
3136 Id := Defining_Entity (Spec);
3137 Generate_Definition (Id);
3138 Set_Contract (Id, Make_Contract (Sloc (Id)));
3140 if Nkind (Id) = N_Defining_Operator_Symbol then
3142 ("operator symbol not allowed for generic subprogram", Id);
3149 Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
3151 Enter_Generic_Scope (Id);
3152 Set_Inner_Instances (Id, New_Elmt_List);
3153 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3155 Analyze_Generic_Formal_Part (N);
3157 Formals := Parameter_Specifications (Spec);
3159 if Present (Formals) then
3160 Process_Formals (Formals, Spec);
3163 if Nkind (Spec) = N_Function_Specification then
3164 Set_Ekind (Id, E_Generic_Function);
3166 if Nkind (Result_Definition (Spec)) = N_Access_Definition then
3167 Result_Type := Access_Definition (Spec, Result_Definition (Spec));
3168 Set_Etype (Id, Result_Type);
3170 -- Check restriction imposed by AI05-073: a generic function
3171 -- cannot return an abstract type or an access to such.
3173 -- This is a binding interpretation should it apply to earlier
3174 -- versions of Ada as well as Ada 2012???
3176 if Is_Abstract_Type (Designated_Type (Result_Type))
3177 and then Ada_Version >= Ada_2012
3179 Error_Msg_N ("generic function cannot have an access result"
3180 & " that designates an abstract type", Spec);
3184 Find_Type (Result_Definition (Spec));
3185 Typ := Entity (Result_Definition (Spec));
3187 if Is_Abstract_Type (Typ)
3188 and then Ada_Version >= Ada_2012
3191 ("generic function cannot have abstract result type", Spec);
3194 -- If a null exclusion is imposed on the result type, then create
3195 -- a null-excluding itype (an access subtype) and use it as the
3196 -- function's Etype.
3198 if Is_Access_Type (Typ)
3199 and then Null_Exclusion_Present (Spec)
3202 Create_Null_Excluding_Itype
3204 Related_Nod => Spec,
3205 Scope_Id => Defining_Unit_Name (Spec)));
3207 Set_Etype (Id, Typ);
3212 Set_Ekind (Id, E_Generic_Procedure);
3213 Set_Etype (Id, Standard_Void_Type);
3216 -- For a library unit, we have reconstructed the entity for the unit,
3217 -- and must reset it in the library tables. We also make sure that
3218 -- Body_Required is set properly in the original compilation unit node.
3220 if Nkind (Parent (N)) = N_Compilation_Unit then
3221 Set_Cunit_Entity (Current_Sem_Unit, Id);
3222 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3225 Set_Categorization_From_Pragmas (N);
3226 Validate_Categorization_Dependency (N, Id);
3228 Save_Global_References (Original_Node (N));
3230 -- For ASIS purposes, convert any postcondition, precondition pragmas
3231 -- into aspects, if N is not a compilation unit by itself, in order to
3232 -- enable the analysis of expressions inside the corresponding PPC
3235 if ASIS_Mode and then Is_List_Member (N) then
3236 Make_Aspect_For_PPC_In_Gen_Sub_Decl (N);
3239 -- To capture global references, analyze the expressions of aspects,
3240 -- and propagate information to original tree. Note that in this case
3241 -- analysis of attributes is not delayed until the freeze point.
3243 -- It seems very hard to recreate the proper visibility of the generic
3244 -- subprogram at a later point because the analysis of an aspect may
3245 -- create pragmas after the generic copies have been made ???
3247 if Has_Aspects (N) then
3252 Aspect := First (Aspect_Specifications (N));
3253 while Present (Aspect) loop
3254 if Get_Aspect_Id (Aspect) /= Aspect_Warnings then
3255 Analyze (Expression (Aspect));
3261 Aspect := First (Aspect_Specifications (Original_Node (N)));
3262 while Present (Aspect) loop
3263 Save_Global_References (Expression (Aspect));
3271 Exit_Generic_Scope (Id);
3272 Generate_Reference_To_Formals (Id);
3274 List_Inherited_Pre_Post_Aspects (Id);
3275 end Analyze_Generic_Subprogram_Declaration;
3277 -----------------------------------
3278 -- Analyze_Package_Instantiation --
3279 -----------------------------------
3281 procedure Analyze_Package_Instantiation (N : Node_Id) is
3282 Loc : constant Source_Ptr := Sloc (N);
3283 Gen_Id : constant Node_Id := Name (N);
3286 Act_Decl_Name : Node_Id;
3287 Act_Decl_Id : Entity_Id;
3292 Gen_Unit : Entity_Id;
3294 Is_Actual_Pack : constant Boolean :=
3295 Is_Internal (Defining_Entity (N));
3297 Env_Installed : Boolean := False;
3298 Parent_Installed : Boolean := False;
3299 Renaming_List : List_Id;
3300 Unit_Renaming : Node_Id;
3301 Needs_Body : Boolean;
3302 Inline_Now : Boolean := False;
3304 Save_Style_Check : constant Boolean := Style_Check;
3305 -- Save style check mode for restore on exit
3307 procedure Delay_Descriptors (E : Entity_Id);
3308 -- Delay generation of subprogram descriptors for given entity
3310 function Might_Inline_Subp return Boolean;
3311 -- If inlining is active and the generic contains inlined subprograms,
3312 -- we instantiate the body. This may cause superfluous instantiations,
3313 -- but it is simpler than detecting the need for the body at the point
3314 -- of inlining, when the context of the instance is not available.
3316 function Must_Inline_Subp return Boolean;
3317 -- If inlining is active and the generic contains inlined subprograms,
3318 -- return True if some of the inlined subprograms must be inlined by
3321 -----------------------
3322 -- Delay_Descriptors --
3323 -----------------------
3325 procedure Delay_Descriptors (E : Entity_Id) is
3327 if not Delay_Subprogram_Descriptors (E) then
3328 Set_Delay_Subprogram_Descriptors (E);
3329 Pending_Descriptor.Append (E);
3331 end Delay_Descriptors;
3333 -----------------------
3334 -- Might_Inline_Subp --
3335 -----------------------
3337 function Might_Inline_Subp return Boolean is
3341 if not Inline_Processing_Required then
3345 E := First_Entity (Gen_Unit);
3346 while Present (E) loop
3347 if Is_Subprogram (E)
3348 and then Is_Inlined (E)
3358 end Might_Inline_Subp;
3360 ----------------------
3361 -- Must_Inline_Subp --
3362 ----------------------
3364 function Must_Inline_Subp return Boolean is
3368 if not Inline_Processing_Required then
3372 E := First_Entity (Gen_Unit);
3373 while Present (E) loop
3374 if Is_Subprogram (E)
3375 and then Is_Inlined (E)
3376 and then Must_Inline (E)
3386 end Must_Inline_Subp;
3388 -- Local declarations
3390 Vis_Prims_List : Elist_Id := No_Elist;
3391 -- List of primitives made temporarily visible in the instantiation
3392 -- to match the visibility of the formal type
3394 -- Start of processing for Analyze_Package_Instantiation
3397 Check_SPARK_Restriction ("generic is not allowed", N);
3399 -- Very first thing: apply the special kludge for Text_IO processing
3400 -- in case we are instantiating one of the children of [Wide_]Text_IO.
3402 Text_IO_Kludge (Name (N));
3404 -- Make node global for error reporting
3406 Instantiation_Node := N;
3408 -- Turn off style checking in instances. If the check is enabled on the
3409 -- generic unit, a warning in an instance would just be noise. If not
3410 -- enabled on the generic, then a warning in an instance is just wrong.
3412 Style_Check := False;
3414 -- Case of instantiation of a generic package
3416 if Nkind (N) = N_Package_Instantiation then
3417 Act_Decl_Id := New_Copy (Defining_Entity (N));
3418 Set_Comes_From_Source (Act_Decl_Id, True);
3420 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3422 Make_Defining_Program_Unit_Name (Loc,
3423 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
3424 Defining_Identifier => Act_Decl_Id);
3426 Act_Decl_Name := Act_Decl_Id;
3429 -- Case of instantiation of a formal package
3432 Act_Decl_Id := Defining_Identifier (N);
3433 Act_Decl_Name := Act_Decl_Id;
3436 Generate_Definition (Act_Decl_Id);
3437 Preanalyze_Actuals (N);
3440 Env_Installed := True;
3442 -- Reset renaming map for formal types. The mapping is established
3443 -- when analyzing the generic associations, but some mappings are
3444 -- inherited from formal packages of parent units, and these are
3445 -- constructed when the parents are installed.
3447 Generic_Renamings.Set_Last (0);
3448 Generic_Renamings_HTable.Reset;
3450 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3451 Gen_Unit := Entity (Gen_Id);
3453 -- Verify that it is the name of a generic package
3455 -- A visibility glitch: if the instance is a child unit and the generic
3456 -- is the generic unit of a parent instance (i.e. both the parent and
3457 -- the child units are instances of the same package) the name now
3458 -- denotes the renaming within the parent, not the intended generic
3459 -- unit. See if there is a homonym that is the desired generic. The
3460 -- renaming declaration must be visible inside the instance of the
3461 -- child, but not when analyzing the name in the instantiation itself.
3463 if Ekind (Gen_Unit) = E_Package
3464 and then Present (Renamed_Entity (Gen_Unit))
3465 and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3466 and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3467 and then Present (Homonym (Gen_Unit))
3469 Gen_Unit := Homonym (Gen_Unit);
3472 if Etype (Gen_Unit) = Any_Type then
3476 elsif Ekind (Gen_Unit) /= E_Generic_Package then
3478 -- Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3480 if From_With_Type (Gen_Unit) then
3482 ("cannot instantiate a limited withed package", Gen_Id);
3485 ("& is not the name of a generic package", Gen_Id, Gen_Unit);
3492 if In_Extended_Main_Source_Unit (N) then
3493 Set_Is_Instantiated (Gen_Unit);
3494 Generate_Reference (Gen_Unit, N);
3496 if Present (Renamed_Object (Gen_Unit)) then
3497 Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3498 Generate_Reference (Renamed_Object (Gen_Unit), N);
3502 if Nkind (Gen_Id) = N_Identifier
3503 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3506 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3508 elsif Nkind (Gen_Id) = N_Expanded_Name
3509 and then Is_Child_Unit (Gen_Unit)
3510 and then Nkind (Prefix (Gen_Id)) = N_Identifier
3511 and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3514 ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3517 Set_Entity (Gen_Id, Gen_Unit);
3519 -- If generic is a renaming, get original generic unit
3521 if Present (Renamed_Object (Gen_Unit))
3522 and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3524 Gen_Unit := Renamed_Object (Gen_Unit);
3527 -- Verify that there are no circular instantiations
3529 if In_Open_Scopes (Gen_Unit) then
3530 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3534 elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3535 Error_Msg_Node_2 := Current_Scope;
3537 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3538 Circularity_Detected := True;
3543 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3545 -- Initialize renamings map, for error checking, and the list that
3546 -- holds private entities whose views have changed between generic
3547 -- definition and instantiation. If this is the instance created to
3548 -- validate an actual package, the instantiation environment is that
3549 -- of the enclosing instance.
3551 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3553 -- Copy original generic tree, to produce text for instantiation
3557 (Original_Node (Gen_Decl), Empty, Instantiating => True);
3559 Act_Spec := Specification (Act_Tree);
3561 -- If this is the instance created to validate an actual package,
3562 -- only the formals matter, do not examine the package spec itself.
3564 if Is_Actual_Pack then
3565 Set_Visible_Declarations (Act_Spec, New_List);
3566 Set_Private_Declarations (Act_Spec, New_List);
3570 Analyze_Associations
3572 Formals => Generic_Formal_Declarations (Act_Tree),
3573 F_Copy => Generic_Formal_Declarations (Gen_Decl));
3575 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
3577 Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3578 Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3579 Set_Is_Generic_Instance (Act_Decl_Id);
3581 Set_Generic_Parent (Act_Spec, Gen_Unit);
3583 -- References to the generic in its own declaration or its body are
3584 -- references to the instance. Add a renaming declaration for the
3585 -- generic unit itself. This declaration, as well as the renaming
3586 -- declarations for the generic formals, must remain private to the
3587 -- unit: the formals, because this is the language semantics, and
3588 -- the unit because its use is an artifact of the implementation.
3591 Make_Package_Renaming_Declaration (Loc,
3592 Defining_Unit_Name =>
3593 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3594 Name => New_Reference_To (Act_Decl_Id, Loc));
3596 Append (Unit_Renaming, Renaming_List);
3598 -- The renaming declarations are the first local declarations of the
3601 if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3603 (First (Visible_Declarations (Act_Spec)), Renaming_List);
3605 Set_Visible_Declarations (Act_Spec, Renaming_List);
3609 Make_Package_Declaration (Loc,
3610 Specification => Act_Spec);
3612 -- Save the instantiation node, for subsequent instantiation of the
3613 -- body, if there is one and we are generating code for the current
3614 -- unit. Mark the unit as having a body, to avoid a premature error
3617 -- We instantiate the body if we are generating code, if we are
3618 -- generating cross-reference information, or if we are building
3619 -- trees for ASIS use.
3622 Enclosing_Body_Present : Boolean := False;
3623 -- If the generic unit is not a compilation unit, then a body may
3624 -- be present in its parent even if none is required. We create a
3625 -- tentative pending instantiation for the body, which will be
3626 -- discarded if none is actually present.
3631 if Scope (Gen_Unit) /= Standard_Standard
3632 and then not Is_Child_Unit (Gen_Unit)
3634 Scop := Scope (Gen_Unit);
3636 while Present (Scop)
3637 and then Scop /= Standard_Standard
3639 if Unit_Requires_Body (Scop) then
3640 Enclosing_Body_Present := True;
3643 elsif In_Open_Scopes (Scop)
3644 and then In_Package_Body (Scop)
3646 Enclosing_Body_Present := True;
3650 exit when Is_Compilation_Unit (Scop);
3651 Scop := Scope (Scop);
3655 -- If front-end inlining is enabled, and this is a unit for which
3656 -- code will be generated, we instantiate the body at once.
3658 -- This is done if the instance is not the main unit, and if the
3659 -- generic is not a child unit of another generic, to avoid scope
3660 -- problems and the reinstallation of parent instances.
3663 and then (not Is_Child_Unit (Gen_Unit)
3664 or else not Is_Generic_Unit (Scope (Gen_Unit)))
3665 and then Might_Inline_Subp
3666 and then not Is_Actual_Pack
3668 if not Debug_Flag_Dot_K
3669 and then Front_End_Inlining
3670 and then (Is_In_Main_Unit (N)
3671 or else In_Main_Context (Current_Scope))
3672 and then Nkind (Parent (N)) /= N_Compilation_Unit
3676 elsif Debug_Flag_Dot_K
3677 and then Must_Inline_Subp
3678 and then (Is_In_Main_Unit (N)
3679 or else In_Main_Context (Current_Scope))
3680 and then Nkind (Parent (N)) /= N_Compilation_Unit
3684 -- In configurable_run_time mode we force the inlining of
3685 -- predefined subprograms marked Inline_Always, to minimize
3686 -- the use of the run-time library.
3688 elsif Is_Predefined_File_Name
3689 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
3690 and then Configurable_Run_Time_Mode
3691 and then Nkind (Parent (N)) /= N_Compilation_Unit
3696 -- If the current scope is itself an instance within a child
3697 -- unit, there will be duplications in the scope stack, and the
3698 -- unstacking mechanism in Inline_Instance_Body will fail.
3699 -- This loses some rare cases of optimization, and might be
3700 -- improved some day, if we can find a proper abstraction for
3701 -- "the complete compilation context" that can be saved and
3704 if Is_Generic_Instance (Current_Scope) then
3706 Curr_Unit : constant Entity_Id :=
3707 Cunit_Entity (Current_Sem_Unit);
3709 if Curr_Unit /= Current_Scope
3710 and then Is_Child_Unit (Curr_Unit)
3712 Inline_Now := False;
3719 (Unit_Requires_Body (Gen_Unit)
3720 or else Enclosing_Body_Present
3721 or else Present (Corresponding_Body (Gen_Decl)))
3722 and then (Is_In_Main_Unit (N) or else Might_Inline_Subp)
3723 and then not Is_Actual_Pack
3724 and then not Inline_Now
3725 and then (Operating_Mode = Generate_Code
3726 or else (Operating_Mode = Check_Semantics
3727 and then ASIS_Mode));
3729 -- If front_end_inlining is enabled, do not instantiate body if
3730 -- within a generic context.
3732 if (Front_End_Inlining and then not Expander_Active)
3733 or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
3735 Needs_Body := False;
3738 -- If the current context is generic, and the package being
3739 -- instantiated is declared within a formal package, there is no
3740 -- body to instantiate until the enclosing generic is instantiated
3741 -- and there is an actual for the formal package. If the formal
3742 -- package has parameters, we build a regular package instance for
3743 -- it, that precedes the original formal package declaration.
3745 if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
3747 Decl : constant Node_Id :=
3749 (Unit_Declaration_Node (Scope (Gen_Unit)));
3751 if Nkind (Decl) = N_Formal_Package_Declaration
3752 or else (Nkind (Decl) = N_Package_Declaration
3753 and then Is_List_Member (Decl)
3754 and then Present (Next (Decl))
3756 Nkind (Next (Decl)) =
3757 N_Formal_Package_Declaration)
3759 Needs_Body := False;
3765 -- For RCI unit calling stubs, we omit the instance body if the
3766 -- instance is the RCI library unit itself.
3768 -- However there is a special case for nested instances: in this case
3769 -- we do generate the instance body, as it might be required, e.g.
3770 -- because it provides stream attributes for some type used in the
3771 -- profile of a remote subprogram. This is consistent with 12.3(12),
3772 -- which indicates that the instance body occurs at the place of the
3773 -- instantiation, and thus is part of the RCI declaration, which is
3774 -- present on all client partitions (this is E.2.3(18)).
3776 -- Note that AI12-0002 may make it illegal at some point to have
3777 -- stream attributes defined in an RCI unit, in which case this
3778 -- special case will become unnecessary. In the meantime, there
3779 -- is known application code in production that depends on this
3780 -- being possible, so we definitely cannot eliminate the body in
3781 -- the case of nested instances for the time being.
3783 -- When we generate a nested instance body, calling stubs for any
3784 -- relevant subprogram will be be inserted immediately after the
3785 -- subprogram declarations, and will take precedence over the
3786 -- subsequent (original) body. (The stub and original body will be
3787 -- complete homographs, but this is permitted in an instance).
3788 -- (Could we do better and remove the original body???)
3790 if Distribution_Stub_Mode = Generate_Caller_Stub_Body
3791 and then Comes_From_Source (N)
3792 and then Nkind (Parent (N)) = N_Compilation_Unit
3794 Needs_Body := False;
3799 -- Here is a defence against a ludicrous number of instantiations
3800 -- caused by a circular set of instantiation attempts.
3802 if Pending_Instantiations.Last > Maximum_Instantiations then
3803 Error_Msg_Uint_1 := UI_From_Int (Maximum_Instantiations);
3804 Error_Msg_N ("too many instantiations, exceeds max of^", N);
3805 Error_Msg_N ("\limit can be changed using -gnateinn switch", N);
3806 raise Unrecoverable_Error;
3809 -- Indicate that the enclosing scopes contain an instantiation,
3810 -- and that cleanup actions should be delayed until after the
3811 -- instance body is expanded.
3813 Check_Forward_Instantiation (Gen_Decl);
3814 if Nkind (N) = N_Package_Instantiation then
3816 Enclosing_Master : Entity_Id;
3819 -- Loop to search enclosing masters
3821 Enclosing_Master := Current_Scope;
3822 Scope_Loop : while Enclosing_Master /= Standard_Standard loop
3823 if Ekind (Enclosing_Master) = E_Package then
3824 if Is_Compilation_Unit (Enclosing_Master) then
3825 if In_Package_Body (Enclosing_Master) then
3827 (Body_Entity (Enclosing_Master));
3836 Enclosing_Master := Scope (Enclosing_Master);
3839 elsif Is_Generic_Unit (Enclosing_Master)
3840 or else Ekind (Enclosing_Master) = E_Void
3842 -- Cleanup actions will eventually be performed on the
3843 -- enclosing subprogram or package instance, if any.
3844 -- Enclosing scope is void in the formal part of a
3845 -- generic subprogram.
3850 if Ekind (Enclosing_Master) = E_Entry
3852 Ekind (Scope (Enclosing_Master)) = E_Protected_Type
3854 if not Expander_Active then
3858 Protected_Body_Subprogram (Enclosing_Master);
3862 Set_Delay_Cleanups (Enclosing_Master);
3864 while Ekind (Enclosing_Master) = E_Block loop
3865 Enclosing_Master := Scope (Enclosing_Master);
3868 if Is_Subprogram (Enclosing_Master) then
3869 Delay_Descriptors (Enclosing_Master);
3871 elsif Is_Task_Type (Enclosing_Master) then
3873 TBP : constant Node_Id :=
3874 Get_Task_Body_Procedure
3877 if Present (TBP) then
3878 Delay_Descriptors (TBP);
3879 Set_Delay_Cleanups (TBP);
3886 end loop Scope_Loop;
3889 -- Make entry in table
3891 Pending_Instantiations.Append
3893 Act_Decl => Act_Decl,
3894 Expander_Status => Expander_Active,
3895 Current_Sem_Unit => Current_Sem_Unit,
3896 Scope_Suppress => Scope_Suppress,
3897 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
3898 Version => Ada_Version,
3899 Version_Pragma => Ada_Version_Pragma,
3900 Warnings => Save_Warnings));
3904 Set_Categorization_From_Pragmas (Act_Decl);
3906 if Parent_Installed then
3910 Set_Instance_Spec (N, Act_Decl);
3912 -- If not a compilation unit, insert the package declaration before
3913 -- the original instantiation node.
3915 if Nkind (Parent (N)) /= N_Compilation_Unit then
3916 Mark_Rewrite_Insertion (Act_Decl);
3917 Insert_Before (N, Act_Decl);
3920 -- For an instantiation that is a compilation unit, place
3921 -- declaration on current node so context is complete for analysis
3922 -- (including nested instantiations). If this is the main unit,
3923 -- the declaration eventually replaces the instantiation node.
3924 -- If the instance body is created later, it replaces the
3925 -- instance node, and the declaration is attached to it
3926 -- (see Build_Instance_Compilation_Unit_Nodes).
3929 if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
3931 -- The entity for the current unit is the newly created one,
3932 -- and all semantic information is attached to it.
3934 Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
3936 -- If this is the main unit, replace the main entity as well
3938 if Current_Sem_Unit = Main_Unit then
3939 Main_Unit_Entity := Act_Decl_Id;
3943 Set_Unit (Parent (N), Act_Decl);
3944 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
3945 Set_Package_Instantiation (Act_Decl_Id, N);
3947 -- Process aspect specifications of the instance node, if any, to
3948 -- take into account categorization pragmas before analyzing the
3951 if Has_Aspects (N) then
3952 Analyze_Aspect_Specifications (N, Act_Decl_Id);
3956 Set_Unit (Parent (N), N);
3957 Set_Body_Required (Parent (N), False);
3959 -- We never need elaboration checks on instantiations, since by
3960 -- definition, the body instantiation is elaborated at the same
3961 -- time as the spec instantiation.
3963 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
3964 Set_Kill_Elaboration_Checks (Act_Decl_Id);
3967 Check_Elab_Instantiation (N);
3969 if ABE_Is_Certain (N) and then Needs_Body then
3970 Pending_Instantiations.Decrement_Last;
3973 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
3975 Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
3976 First_Private_Entity (Act_Decl_Id));
3978 -- If the instantiation will receive a body, the unit will be
3979 -- transformed into a package body, and receive its own elaboration
3980 -- entity. Otherwise, the nature of the unit is now a package
3983 if Nkind (Parent (N)) = N_Compilation_Unit
3984 and then not Needs_Body
3986 Rewrite (N, Act_Decl);
3989 if Present (Corresponding_Body (Gen_Decl))
3990 or else Unit_Requires_Body (Gen_Unit)
3992 Set_Has_Completion (Act_Decl_Id);
3995 Check_Formal_Packages (Act_Decl_Id);
3997 Restore_Hidden_Primitives (Vis_Prims_List);
3998 Restore_Private_Views (Act_Decl_Id);
4000 Inherit_Context (Gen_Decl, N);
4002 if Parent_Installed then
4007 Env_Installed := False;
4010 Validate_Categorization_Dependency (N, Act_Decl_Id);
4012 -- There used to be a check here to prevent instantiations in local
4013 -- contexts if the No_Local_Allocators restriction was active. This
4014 -- check was removed by a binding interpretation in AI-95-00130/07,
4015 -- but we retain the code for documentation purposes.
4017 -- if Ekind (Act_Decl_Id) /= E_Void
4018 -- and then not Is_Library_Level_Entity (Act_Decl_Id)
4020 -- Check_Restriction (No_Local_Allocators, N);
4024 Inline_Instance_Body (N, Gen_Unit, Act_Decl);
4027 -- The following is a tree patch for ASIS: ASIS needs separate nodes to
4028 -- be used as defining identifiers for a formal package and for the
4029 -- corresponding expanded package.
4031 if Nkind (N) = N_Formal_Package_Declaration then
4032 Act_Decl_Id := New_Copy (Defining_Entity (N));
4033 Set_Comes_From_Source (Act_Decl_Id, True);
4034 Set_Is_Generic_Instance (Act_Decl_Id, False);
4035 Set_Defining_Identifier (N, Act_Decl_Id);
4038 Style_Check := Save_Style_Check;
4040 -- Check that if N is an instantiation of System.Dim_Float_IO or
4041 -- System.Dim_Integer_IO, the formal type has a dimension system.
4043 if Nkind (N) = N_Package_Instantiation
4044 and then Is_Dim_IO_Package_Instantiation (N)
4047 Assoc : constant Node_Id := First (Generic_Associations (N));
4049 if not Has_Dimension_System
4050 (Etype (Explicit_Generic_Actual_Parameter (Assoc)))
4052 Error_Msg_N ("type with a dimension system expected", Assoc);
4058 if Has_Aspects (N) and then Nkind (Parent (N)) /= N_Compilation_Unit then
4059 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4063 when Instantiation_Error =>
4064 if Parent_Installed then
4068 if Env_Installed then
4072 Style_Check := Save_Style_Check;
4073 end Analyze_Package_Instantiation;
4075 --------------------------
4076 -- Inline_Instance_Body --
4077 --------------------------
4079 procedure Inline_Instance_Body
4081 Gen_Unit : Entity_Id;
4085 Gen_Comp : constant Entity_Id :=
4086 Cunit_Entity (Get_Source_Unit (Gen_Unit));
4087 Curr_Comp : constant Node_Id := Cunit (Current_Sem_Unit);
4088 Curr_Scope : Entity_Id := Empty;
4089 Curr_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
4090 Removed : Boolean := False;
4091 Num_Scopes : Int := 0;
4093 Scope_Stack_Depth : constant Int :=
4094 Scope_Stack.Last - Scope_Stack.First + 1;
4096 Use_Clauses : array (1 .. Scope_Stack_Depth) of Node_Id;
4097 Instances : array (1 .. Scope_Stack_Depth) of Entity_Id;
4098 Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
4100 Num_Inner : Int := 0;
4101 N_Instances : Int := 0;
4105 -- Case of generic unit defined in another unit. We must remove the
4106 -- complete context of the current unit to install that of the generic.
4108 if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
4110 -- Add some comments for the following two loops ???
4113 while Present (S) and then S /= Standard_Standard loop
4115 Num_Scopes := Num_Scopes + 1;
4117 Use_Clauses (Num_Scopes) :=
4119 (Scope_Stack.Last - Num_Scopes + 1).
4121 End_Use_Clauses (Use_Clauses (Num_Scopes));
4123 exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
4124 or else Scope_Stack.Table
4125 (Scope_Stack.Last - Num_Scopes).Entity
4129 exit when Is_Generic_Instance (S)
4130 and then (In_Package_Body (S)
4131 or else Ekind (S) = E_Procedure
4132 or else Ekind (S) = E_Function);
4136 Vis := Is_Immediately_Visible (Gen_Comp);
4138 -- Find and save all enclosing instances
4143 and then S /= Standard_Standard
4145 if Is_Generic_Instance (S) then
4146 N_Instances := N_Instances + 1;
4147 Instances (N_Instances) := S;
4149 exit when In_Package_Body (S);
4155 -- Remove context of current compilation unit, unless we are within a
4156 -- nested package instantiation, in which case the context has been
4157 -- removed previously.
4159 -- If current scope is the body of a child unit, remove context of
4160 -- spec as well. If an enclosing scope is an instance body, the
4161 -- context has already been removed, but the entities in the body
4162 -- must be made invisible as well.
4167 and then S /= Standard_Standard
4169 if Is_Generic_Instance (S)
4170 and then (In_Package_Body (S)
4171 or else Ekind (S) = E_Procedure
4172 or else Ekind (S) = E_Function)
4174 -- We still have to remove the entities of the enclosing
4175 -- instance from direct visibility.
4180 E := First_Entity (S);
4181 while Present (E) loop
4182 Set_Is_Immediately_Visible (E, False);
4191 or else (Ekind (Curr_Unit) = E_Package_Body
4192 and then S = Spec_Entity (Curr_Unit))
4193 or else (Ekind (Curr_Unit) = E_Subprogram_Body
4196 (Unit_Declaration_Node (Curr_Unit)))
4200 -- Remove entities in current scopes from visibility, so that
4201 -- instance body is compiled in a clean environment.
4203 List := Save_Scope_Stack (Handle_Use => False);
4205 if Is_Child_Unit (S) then
4207 -- Remove child unit from stack, as well as inner scopes.
4208 -- Removing the context of a child unit removes parent units
4211 while Current_Scope /= S loop
4212 Num_Inner := Num_Inner + 1;
4213 Inner_Scopes (Num_Inner) := Current_Scope;
4218 Remove_Context (Curr_Comp);
4222 Remove_Context (Curr_Comp);
4225 if Ekind (Curr_Unit) = E_Package_Body then
4226 Remove_Context (Library_Unit (Curr_Comp));
4232 pragma Assert (Num_Inner < Num_Scopes);
4234 Push_Scope (Standard_Standard);
4235 Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4236 Instantiate_Package_Body
4239 Act_Decl => Act_Decl,
4240 Expander_Status => Expander_Active,
4241 Current_Sem_Unit => Current_Sem_Unit,
4242 Scope_Suppress => Scope_Suppress,
4243 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4244 Version => Ada_Version,
4245 Version_Pragma => Ada_Version_Pragma,
4246 Warnings => Save_Warnings)),
4247 Inlined_Body => True);
4253 Set_Is_Immediately_Visible (Gen_Comp, Vis);
4255 -- Reset Generic_Instance flag so that use clauses can be installed
4256 -- in the proper order. (See Use_One_Package for effect of enclosing
4257 -- instances on processing of use clauses).
4259 for J in 1 .. N_Instances loop
4260 Set_Is_Generic_Instance (Instances (J), False);
4264 Install_Context (Curr_Comp);
4266 if Present (Curr_Scope)
4267 and then Is_Child_Unit (Curr_Scope)
4269 Push_Scope (Curr_Scope);
4270 Set_Is_Immediately_Visible (Curr_Scope);
4272 -- Finally, restore inner scopes as well
4274 for J in reverse 1 .. Num_Inner loop
4275 Push_Scope (Inner_Scopes (J));
4279 Restore_Scope_Stack (List, Handle_Use => False);
4281 if Present (Curr_Scope)
4283 (In_Private_Part (Curr_Scope)
4284 or else In_Package_Body (Curr_Scope))
4286 -- Install private declaration of ancestor units, which are
4287 -- currently available. Restore_Scope_Stack and Install_Context
4288 -- only install the visible part of parents.
4293 Par := Scope (Curr_Scope);
4294 while (Present (Par))
4295 and then Par /= Standard_Standard
4297 Install_Private_Declarations (Par);
4304 -- Restore use clauses. For a child unit, use clauses in the parents
4305 -- are restored when installing the context, so only those in inner
4306 -- scopes (and those local to the child unit itself) need to be
4307 -- installed explicitly.
4309 if Is_Child_Unit (Curr_Unit)
4312 for J in reverse 1 .. Num_Inner + 1 loop
4313 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4315 Install_Use_Clauses (Use_Clauses (J));
4319 for J in reverse 1 .. Num_Scopes loop
4320 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4322 Install_Use_Clauses (Use_Clauses (J));
4326 -- Restore status of instances. If one of them is a body, make its
4327 -- local entities visible again.
4334 for J in 1 .. N_Instances loop
4335 Inst := Instances (J);
4336 Set_Is_Generic_Instance (Inst, True);
4338 if In_Package_Body (Inst)
4339 or else Ekind (S) = E_Procedure
4340 or else Ekind (S) = E_Function
4342 E := First_Entity (Instances (J));
4343 while Present (E) loop
4344 Set_Is_Immediately_Visible (E);
4351 -- If generic unit is in current unit, current context is correct
4354 Instantiate_Package_Body
4357 Act_Decl => Act_Decl,
4358 Expander_Status => Expander_Active,
4359 Current_Sem_Unit => Current_Sem_Unit,
4360 Scope_Suppress => Scope_Suppress,
4361 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4362 Version => Ada_Version,
4363 Version_Pragma => Ada_Version_Pragma,
4364 Warnings => Save_Warnings)),
4365 Inlined_Body => True);
4367 end Inline_Instance_Body;
4369 -------------------------------------
4370 -- Analyze_Procedure_Instantiation --
4371 -------------------------------------
4373 procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4375 Analyze_Subprogram_Instantiation (N, E_Procedure);
4376 end Analyze_Procedure_Instantiation;
4378 -----------------------------------
4379 -- Need_Subprogram_Instance_Body --
4380 -----------------------------------
4382 function Need_Subprogram_Instance_Body
4384 Subp : Entity_Id) return Boolean
4387 -- Must be inlined (or inlined renaming)
4389 if (Is_In_Main_Unit (N)
4390 or else Is_Inlined (Subp)
4391 or else Is_Inlined (Alias (Subp)))
4393 -- Must be generating code or analyzing code in ASIS mode
4395 and then (Operating_Mode = Generate_Code
4396 or else (Operating_Mode = Check_Semantics
4397 and then ASIS_Mode))
4399 -- The body is needed when generating code (full expansion), in ASIS
4400 -- mode for other tools, and in SPARK mode (special expansion) for
4401 -- formal verification of the body itself.
4403 and then (Expander_Active or ASIS_Mode)
4405 -- No point in inlining if ABE is inevitable
4407 and then not ABE_Is_Certain (N)
4409 -- Or if subprogram is eliminated
4411 and then not Is_Eliminated (Subp)
4413 Pending_Instantiations.Append
4415 Act_Decl => Unit_Declaration_Node (Subp),
4416 Expander_Status => Expander_Active,
4417 Current_Sem_Unit => Current_Sem_Unit,
4418 Scope_Suppress => Scope_Suppress,
4419 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4420 Version => Ada_Version,
4421 Version_Pragma => Ada_Version_Pragma,
4422 Warnings => Save_Warnings));
4425 -- Here if not inlined, or we ignore the inlining
4430 end Need_Subprogram_Instance_Body;
4432 --------------------------------------
4433 -- Analyze_Subprogram_Instantiation --
4434 --------------------------------------
4436 procedure Analyze_Subprogram_Instantiation
4440 Loc : constant Source_Ptr := Sloc (N);
4441 Gen_Id : constant Node_Id := Name (N);
4443 Anon_Id : constant Entity_Id :=
4444 Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4445 Chars => New_External_Name
4446 (Chars (Defining_Entity (N)), 'R'));
4448 Act_Decl_Id : Entity_Id;
4453 Env_Installed : Boolean := False;
4454 Gen_Unit : Entity_Id;
4456 Pack_Id : Entity_Id;
4457 Parent_Installed : Boolean := False;
4458 Renaming_List : List_Id;
4460 procedure Analyze_Instance_And_Renamings;
4461 -- The instance must be analyzed in a context that includes the mappings
4462 -- of generic parameters into actuals. We create a package declaration
4463 -- for this purpose, and a subprogram with an internal name within the
4464 -- package. The subprogram instance is simply an alias for the internal
4465 -- subprogram, declared in the current scope.
4467 ------------------------------------
4468 -- Analyze_Instance_And_Renamings --
4469 ------------------------------------
4471 procedure Analyze_Instance_And_Renamings is
4472 Def_Ent : constant Entity_Id := Defining_Entity (N);
4473 Pack_Decl : Node_Id;
4476 if Nkind (Parent (N)) = N_Compilation_Unit then
4478 -- For the case of a compilation unit, the container package has
4479 -- the same name as the instantiation, to insure that the binder
4480 -- calls the elaboration procedure with the right name. Copy the
4481 -- entity of the instance, which may have compilation level flags
4482 -- (e.g. Is_Child_Unit) set.
4484 Pack_Id := New_Copy (Def_Ent);
4487 -- Otherwise we use the name of the instantiation concatenated
4488 -- with its source position to ensure uniqueness if there are
4489 -- several instantiations with the same name.
4492 Make_Defining_Identifier (Loc,
4493 Chars => New_External_Name
4494 (Related_Id => Chars (Def_Ent),
4496 Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4499 Pack_Decl := Make_Package_Declaration (Loc,
4500 Specification => Make_Package_Specification (Loc,
4501 Defining_Unit_Name => Pack_Id,
4502 Visible_Declarations => Renaming_List,
4503 End_Label => Empty));
4505 Set_Instance_Spec (N, Pack_Decl);
4506 Set_Is_Generic_Instance (Pack_Id);
4507 Set_Debug_Info_Needed (Pack_Id);
4509 -- Case of not a compilation unit
4511 if Nkind (Parent (N)) /= N_Compilation_Unit then
4512 Mark_Rewrite_Insertion (Pack_Decl);
4513 Insert_Before (N, Pack_Decl);
4514 Set_Has_Completion (Pack_Id);
4516 -- Case of an instantiation that is a compilation unit
4518 -- Place declaration on current node so context is complete for
4519 -- analysis (including nested instantiations), and for use in a
4520 -- context_clause (see Analyze_With_Clause).
4523 Set_Unit (Parent (N), Pack_Decl);
4524 Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4527 Analyze (Pack_Decl);
4528 Check_Formal_Packages (Pack_Id);
4529 Set_Is_Generic_Instance (Pack_Id, False);
4531 -- Why do we clear Is_Generic_Instance??? We set it 20 lines
4534 -- Body of the enclosing package is supplied when instantiating the
4535 -- subprogram body, after semantic analysis is completed.
4537 if Nkind (Parent (N)) = N_Compilation_Unit then
4539 -- Remove package itself from visibility, so it does not
4540 -- conflict with subprogram.
4542 Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4544 -- Set name and scope of internal subprogram so that the proper
4545 -- external name will be generated. The proper scope is the scope
4546 -- of the wrapper package. We need to generate debugging info for
4547 -- the internal subprogram, so set flag accordingly.
4549 Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4550 Set_Scope (Anon_Id, Scope (Pack_Id));
4552 -- Mark wrapper package as referenced, to avoid spurious warnings
4553 -- if the instantiation appears in various with_ clauses of
4554 -- subunits of the main unit.
4556 Set_Referenced (Pack_Id);
4559 Set_Is_Generic_Instance (Anon_Id);
4560 Set_Debug_Info_Needed (Anon_Id);
4561 Act_Decl_Id := New_Copy (Anon_Id);
4563 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4564 Set_Chars (Act_Decl_Id, Chars (Defining_Entity (N)));
4565 Set_Sloc (Act_Decl_Id, Sloc (Defining_Entity (N)));
4566 Set_Comes_From_Source (Act_Decl_Id, True);
4568 -- The signature may involve types that are not frozen yet, but the
4569 -- subprogram will be frozen at the point the wrapper package is
4570 -- frozen, so it does not need its own freeze node. In fact, if one
4571 -- is created, it might conflict with the freezing actions from the
4574 Set_Has_Delayed_Freeze (Anon_Id, False);
4576 -- If the instance is a child unit, mark the Id accordingly. Mark
4577 -- the anonymous entity as well, which is the real subprogram and
4578 -- which is used when the instance appears in a context clause.
4579 -- Similarly, propagate the Is_Eliminated flag to handle properly
4580 -- nested eliminated subprograms.
4582 Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
4583 Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
4584 New_Overloaded_Entity (Act_Decl_Id);
4585 Check_Eliminated (Act_Decl_Id);
4586 Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
4588 -- In compilation unit case, kill elaboration checks on the
4589 -- instantiation, since they are never needed -- the body is
4590 -- instantiated at the same point as the spec.
4592 if Nkind (Parent (N)) = N_Compilation_Unit then
4593 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4594 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4595 Set_Is_Compilation_Unit (Anon_Id);
4597 Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
4600 -- The instance is not a freezing point for the new subprogram
4602 Set_Is_Frozen (Act_Decl_Id, False);
4604 if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
4605 Valid_Operator_Definition (Act_Decl_Id);
4608 Set_Alias (Act_Decl_Id, Anon_Id);
4609 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4610 Set_Has_Completion (Act_Decl_Id);
4611 Set_Related_Instance (Pack_Id, Act_Decl_Id);
4613 if Nkind (Parent (N)) = N_Compilation_Unit then
4614 Set_Body_Required (Parent (N), False);
4616 end Analyze_Instance_And_Renamings;
4620 Vis_Prims_List : Elist_Id := No_Elist;
4621 -- List of primitives made temporarily visible in the instantiation
4622 -- to match the visibility of the formal type
4624 -- Start of processing for Analyze_Subprogram_Instantiation
4627 Check_SPARK_Restriction ("generic is not allowed", N);
4629 -- Very first thing: apply the special kludge for Text_IO processing
4630 -- in case we are instantiating one of the children of [Wide_]Text_IO.
4631 -- Of course such an instantiation is bogus (these are packages, not
4632 -- subprograms), but we get a better error message if we do this.
4634 Text_IO_Kludge (Gen_Id);
4636 -- Make node global for error reporting
4638 Instantiation_Node := N;
4640 -- For package instantiations we turn off style checks, because they
4641 -- will have been emitted in the generic. For subprogram instantiations
4642 -- we want to apply at least the check on overriding indicators so we
4643 -- do not modify the style check status.
4645 -- The renaming declarations for the actuals do not come from source and
4646 -- will not generate spurious warnings.
4648 Preanalyze_Actuals (N);
4651 Env_Installed := True;
4652 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
4653 Gen_Unit := Entity (Gen_Id);
4655 Generate_Reference (Gen_Unit, Gen_Id);
4657 if Nkind (Gen_Id) = N_Identifier
4658 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
4661 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
4664 if Etype (Gen_Unit) = Any_Type then
4669 -- Verify that it is a generic subprogram of the right kind, and that
4670 -- it does not lead to a circular instantiation.
4672 if K = E_Procedure and then Ekind (Gen_Unit) /= E_Generic_Procedure then
4674 ("& is not the name of a generic procedure", Gen_Id, Gen_Unit);
4676 elsif K = E_Function and then Ekind (Gen_Unit) /= E_Generic_Function then
4678 ("& is not the name of a generic function", Gen_Id, Gen_Unit);
4680 elsif In_Open_Scopes (Gen_Unit) then
4681 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
4684 Set_Entity (Gen_Id, Gen_Unit);
4685 Set_Is_Instantiated (Gen_Unit);
4687 if In_Extended_Main_Source_Unit (N) then
4688 Generate_Reference (Gen_Unit, N);
4691 -- If renaming, get original unit
4693 if Present (Renamed_Object (Gen_Unit))
4694 and then (Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Procedure
4696 Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Function)
4698 Gen_Unit := Renamed_Object (Gen_Unit);
4699 Set_Is_Instantiated (Gen_Unit);
4700 Generate_Reference (Gen_Unit, N);
4703 if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
4704 Error_Msg_Node_2 := Current_Scope;
4706 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
4707 Circularity_Detected := True;
4708 Restore_Hidden_Primitives (Vis_Prims_List);
4712 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
4714 -- Initialize renamings map, for error checking
4716 Generic_Renamings.Set_Last (0);
4717 Generic_Renamings_HTable.Reset;
4719 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
4721 -- Copy original generic tree, to produce text for instantiation
4725 (Original_Node (Gen_Decl), Empty, Instantiating => True);
4727 -- Inherit overriding indicator from instance node
4729 Act_Spec := Specification (Act_Tree);
4730 Set_Must_Override (Act_Spec, Must_Override (N));
4731 Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
4734 Analyze_Associations
4736 Formals => Generic_Formal_Declarations (Act_Tree),
4737 F_Copy => Generic_Formal_Declarations (Gen_Decl));
4739 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
4741 -- The subprogram itself cannot contain a nested instance, so the
4742 -- current parent is left empty.
4744 Set_Instance_Env (Gen_Unit, Empty);
4746 -- Build the subprogram declaration, which does not appear in the
4747 -- generic template, and give it a sloc consistent with that of the
4750 Set_Defining_Unit_Name (Act_Spec, Anon_Id);
4751 Set_Generic_Parent (Act_Spec, Gen_Unit);
4753 Make_Subprogram_Declaration (Sloc (Act_Spec),
4754 Specification => Act_Spec);
4756 -- The aspects have been copied previously, but they have to be
4757 -- linked explicitly to the new subprogram declaration. Explicit
4758 -- pre/postconditions on the instance are analyzed below, in a
4761 Move_Aspects (Act_Tree, To => Act_Decl);
4762 Set_Categorization_From_Pragmas (Act_Decl);
4764 if Parent_Installed then
4768 Append (Act_Decl, Renaming_List);
4769 Analyze_Instance_And_Renamings;
4771 -- If the generic is marked Import (Intrinsic), then so is the
4772 -- instance. This indicates that there is no body to instantiate. If
4773 -- generic is marked inline, so it the instance, and the anonymous
4774 -- subprogram it renames. If inlined, or else if inlining is enabled
4775 -- for the compilation, we generate the instance body even if it is
4776 -- not within the main unit.
4778 if Is_Intrinsic_Subprogram (Gen_Unit) then
4779 Set_Is_Intrinsic_Subprogram (Anon_Id);
4780 Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
4782 if Chars (Gen_Unit) = Name_Unchecked_Conversion then
4783 Validate_Unchecked_Conversion (N, Act_Decl_Id);
4787 -- Inherit convention from generic unit. Intrinsic convention, as for
4788 -- an instance of unchecked conversion, is not inherited because an
4789 -- explicit Ada instance has been created.
4791 if Has_Convention_Pragma (Gen_Unit)
4792 and then Convention (Gen_Unit) /= Convention_Intrinsic
4794 Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
4795 Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
4798 Generate_Definition (Act_Decl_Id);
4799 -- Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id)));
4801 Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
4803 -- Inherit all inlining-related flags which apply to the generic in
4804 -- the subprogram and its declaration.
4806 Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
4807 Set_Is_Inlined (Anon_Id, Is_Inlined (Gen_Unit));
4809 Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
4810 Set_Has_Pragma_Inline (Anon_Id, Has_Pragma_Inline (Gen_Unit));
4812 Set_Has_Pragma_Inline_Always
4813 (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
4814 Set_Has_Pragma_Inline_Always
4815 (Anon_Id, Has_Pragma_Inline_Always (Gen_Unit));
4817 if not Is_Intrinsic_Subprogram (Gen_Unit) then
4818 Check_Elab_Instantiation (N);
4821 if Is_Dispatching_Operation (Act_Decl_Id)
4822 and then Ada_Version >= Ada_2005
4828 Formal := First_Formal (Act_Decl_Id);
4829 while Present (Formal) loop
4830 if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
4831 and then Is_Controlling_Formal (Formal)
4832 and then not Can_Never_Be_Null (Formal)
4834 Error_Msg_NE ("access parameter& is controlling,",
4837 ("\corresponding parameter of & must be"
4838 & " explicitly null-excluding", N, Gen_Id);
4841 Next_Formal (Formal);
4846 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4848 Validate_Categorization_Dependency (N, Act_Decl_Id);
4850 if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
4851 Inherit_Context (Gen_Decl, N);
4853 Restore_Private_Views (Pack_Id, False);
4855 -- If the context requires a full instantiation, mark node for
4856 -- subsequent construction of the body.
4858 if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
4859 Check_Forward_Instantiation (Gen_Decl);
4861 -- The wrapper package is always delayed, because it does not
4862 -- constitute a freeze point, but to insure that the freeze
4863 -- node is placed properly, it is created directly when
4864 -- instantiating the body (otherwise the freeze node might
4865 -- appear to early for nested instantiations).
4867 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4869 -- For ASIS purposes, indicate that the wrapper package has
4870 -- replaced the instantiation node.
4872 Rewrite (N, Unit (Parent (N)));
4873 Set_Unit (Parent (N), N);
4876 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4878 -- Replace instance node for library-level instantiations of
4879 -- intrinsic subprograms, for ASIS use.
4881 Rewrite (N, Unit (Parent (N)));
4882 Set_Unit (Parent (N), N);
4885 if Parent_Installed then
4889 Restore_Hidden_Primitives (Vis_Prims_List);
4891 Env_Installed := False;
4892 Generic_Renamings.Set_Last (0);
4893 Generic_Renamings_HTable.Reset;
4897 if Has_Aspects (N) then
4898 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4902 when Instantiation_Error =>
4903 if Parent_Installed then
4907 if Env_Installed then
4910 end Analyze_Subprogram_Instantiation;
4912 -------------------------
4913 -- Get_Associated_Node --
4914 -------------------------
4916 function Get_Associated_Node (N : Node_Id) return Node_Id is
4920 Assoc := Associated_Node (N);
4922 if Nkind (Assoc) /= Nkind (N) then
4925 elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
4929 -- If the node is part of an inner generic, it may itself have been
4930 -- remapped into a further generic copy. Associated_Node is otherwise
4931 -- used for the entity of the node, and will be of a different node
4932 -- kind, or else N has been rewritten as a literal or function call.
4934 while Present (Associated_Node (Assoc))
4935 and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
4937 Assoc := Associated_Node (Assoc);
4940 -- Follow and additional link in case the final node was rewritten.
4941 -- This can only happen with nested generic units.
4943 if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
4944 and then Present (Associated_Node (Assoc))
4945 and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
4946 N_Explicit_Dereference,
4951 Assoc := Associated_Node (Assoc);
4954 -- An additional special case: an unconstrained type in an object
4955 -- declaration may have been rewritten as a local subtype constrained
4956 -- by the expression in the declaration. We need to recover the
4957 -- original entity which may be global.
4959 if Present (Original_Node (Assoc))
4960 and then Nkind (Parent (N)) = N_Object_Declaration
4962 Assoc := Original_Node (Assoc);
4967 end Get_Associated_Node;
4969 -------------------------------------------
4970 -- Build_Instance_Compilation_Unit_Nodes --
4971 -------------------------------------------
4973 procedure Build_Instance_Compilation_Unit_Nodes
4978 Decl_Cunit : Node_Id;
4979 Body_Cunit : Node_Id;
4981 New_Main : constant Entity_Id := Defining_Entity (Act_Decl);
4982 Old_Main : constant Entity_Id := Cunit_Entity (Main_Unit);
4985 -- A new compilation unit node is built for the instance declaration
4988 Make_Compilation_Unit (Sloc (N),
4989 Context_Items => Empty_List,
4991 Aux_Decls_Node => Make_Compilation_Unit_Aux (Sloc (N)));
4993 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
4995 -- The new compilation unit is linked to its body, but both share the
4996 -- same file, so we do not set Body_Required on the new unit so as not
4997 -- to create a spurious dependency on a non-existent body in the ali.
4998 -- This simplifies CodePeer unit traversal.
5000 -- We use the original instantiation compilation unit as the resulting
5001 -- compilation unit of the instance, since this is the main unit.
5003 Rewrite (N, Act_Body);
5004 Body_Cunit := Parent (N);
5006 -- The two compilation unit nodes are linked by the Library_Unit field
5008 Set_Library_Unit (Decl_Cunit, Body_Cunit);
5009 Set_Library_Unit (Body_Cunit, Decl_Cunit);
5011 -- Preserve the private nature of the package if needed
5013 Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
5015 -- If the instance is not the main unit, its context, categorization
5016 -- and elaboration entity are not relevant to the compilation.
5018 if Body_Cunit /= Cunit (Main_Unit) then
5019 Make_Instance_Unit (Body_Cunit, In_Main => False);
5023 -- The context clause items on the instantiation, which are now attached
5024 -- to the body compilation unit (since the body overwrote the original
5025 -- instantiation node), semantically belong on the spec, so copy them
5026 -- there. It's harmless to leave them on the body as well. In fact one
5027 -- could argue that they belong in both places.
5029 Citem := First (Context_Items (Body_Cunit));
5030 while Present (Citem) loop
5031 Append (New_Copy (Citem), Context_Items (Decl_Cunit));
5035 -- Propagate categorization flags on packages, so that they appear in
5036 -- the ali file for the spec of the unit.
5038 if Ekind (New_Main) = E_Package then
5039 Set_Is_Pure (Old_Main, Is_Pure (New_Main));
5040 Set_Is_Preelaborated (Old_Main, Is_Preelaborated (New_Main));
5041 Set_Is_Remote_Types (Old_Main, Is_Remote_Types (New_Main));
5042 Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
5043 Set_Is_Remote_Call_Interface
5044 (Old_Main, Is_Remote_Call_Interface (New_Main));
5047 -- Make entry in Units table, so that binder can generate call to
5048 -- elaboration procedure for body, if any.
5050 Make_Instance_Unit (Body_Cunit, In_Main => True);
5051 Main_Unit_Entity := New_Main;
5052 Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
5054 -- Build elaboration entity, since the instance may certainly generate
5055 -- elaboration code requiring a flag for protection.
5057 Build_Elaboration_Entity (Decl_Cunit, New_Main);
5058 end Build_Instance_Compilation_Unit_Nodes;
5060 -----------------------------
5061 -- Check_Access_Definition --
5062 -----------------------------
5064 procedure Check_Access_Definition (N : Node_Id) is
5067 (Ada_Version >= Ada_2005 and then Present (Access_Definition (N)));
5069 end Check_Access_Definition;
5071 -----------------------------------
5072 -- Check_Formal_Package_Instance --
5073 -----------------------------------
5075 -- If the formal has specific parameters, they must match those of the
5076 -- actual. Both of them are instances, and the renaming declarations for
5077 -- their formal parameters appear in the same order in both. The analyzed
5078 -- formal has been analyzed in the context of the current instance.
5080 procedure Check_Formal_Package_Instance
5081 (Formal_Pack : Entity_Id;
5082 Actual_Pack : Entity_Id)
5084 E1 : Entity_Id := First_Entity (Actual_Pack);
5085 E2 : Entity_Id := First_Entity (Formal_Pack);
5090 procedure Check_Mismatch (B : Boolean);
5091 -- Common error routine for mismatch between the parameters of the
5092 -- actual instance and those of the formal package.
5094 function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
5095 -- The formal may come from a nested formal package, and the actual may
5096 -- have been constant-folded. To determine whether the two denote the
5097 -- same entity we may have to traverse several definitions to recover
5098 -- the ultimate entity that they refer to.
5100 function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
5101 -- Similarly, if the formal comes from a nested formal package, the
5102 -- actual may designate the formal through multiple renamings, which
5103 -- have to be followed to determine the original variable in question.
5105 --------------------
5106 -- Check_Mismatch --
5107 --------------------
5109 procedure Check_Mismatch (B : Boolean) is
5110 Kind : constant Node_Kind := Nkind (Parent (E2));
5113 if Kind = N_Formal_Type_Declaration then
5116 elsif Nkind_In (Kind, N_Formal_Object_Declaration,
5117 N_Formal_Package_Declaration)
5118 or else Kind in N_Formal_Subprogram_Declaration
5124 ("actual for & in actual instance does not match formal",
5125 Parent (Actual_Pack), E1);
5129 --------------------------------
5130 -- Same_Instantiated_Constant --
5131 --------------------------------
5133 function Same_Instantiated_Constant
5134 (E1, E2 : Entity_Id) return Boolean
5140 while Present (Ent) loop
5144 elsif Ekind (Ent) /= E_Constant then
5147 elsif Is_Entity_Name (Constant_Value (Ent)) then
5148 if Entity (Constant_Value (Ent)) = E1 then
5151 Ent := Entity (Constant_Value (Ent));
5154 -- The actual may be a constant that has been folded. Recover
5157 elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5158 Ent := Entity (Original_Node (Constant_Value (Ent)));
5165 end Same_Instantiated_Constant;
5167 --------------------------------
5168 -- Same_Instantiated_Variable --
5169 --------------------------------
5171 function Same_Instantiated_Variable
5172 (E1, E2 : Entity_Id) return Boolean
5174 function Original_Entity (E : Entity_Id) return Entity_Id;
5175 -- Follow chain of renamings to the ultimate ancestor
5177 ---------------------
5178 -- Original_Entity --
5179 ---------------------
5181 function Original_Entity (E : Entity_Id) return Entity_Id is
5186 while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5187 and then Present (Renamed_Object (Orig))
5188 and then Is_Entity_Name (Renamed_Object (Orig))
5190 Orig := Entity (Renamed_Object (Orig));
5194 end Original_Entity;
5196 -- Start of processing for Same_Instantiated_Variable
5199 return Ekind (E1) = Ekind (E2)
5200 and then Original_Entity (E1) = Original_Entity (E2);
5201 end Same_Instantiated_Variable;
5203 -- Start of processing for Check_Formal_Package_Instance
5207 and then Present (E2)
5209 exit when Ekind (E1) = E_Package
5210 and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5212 -- If the formal is the renaming of the formal package, this
5213 -- is the end of its formal part, which may occur before the
5214 -- end of the formal part in the actual in the presence of
5215 -- defaulted parameters in the formal package.
5217 exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5218 and then Renamed_Entity (E2) = Scope (E2);
5220 -- The analysis of the actual may generate additional internal
5221 -- entities. If the formal is defaulted, there is no corresponding
5222 -- analysis and the internal entities must be skipped, until we
5223 -- find corresponding entities again.
5225 if Comes_From_Source (E2)
5226 and then not Comes_From_Source (E1)
5227 and then Chars (E1) /= Chars (E2)
5230 and then Chars (E1) /= Chars (E2)
5239 -- If the formal entity comes from a formal declaration, it was
5240 -- defaulted in the formal package, and no check is needed on it.
5242 elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
5245 -- Ditto for defaulted formal subprograms.
5247 elsif Is_Overloadable (E1)
5248 and then Nkind (Unit_Declaration_Node (E2)) in
5249 N_Formal_Subprogram_Declaration
5253 elsif Is_Type (E1) then
5255 -- Subtypes must statically match. E1, E2 are the local entities
5256 -- that are subtypes of the actuals. Itypes generated for other
5257 -- parameters need not be checked, the check will be performed
5258 -- on the parameters themselves.
5260 -- If E2 is a formal type declaration, it is a defaulted parameter
5261 -- and needs no checking.
5263 if not Is_Itype (E1)
5264 and then not Is_Itype (E2)
5268 or else Etype (E1) /= Etype (E2)
5269 or else not Subtypes_Statically_Match (E1, E2));
5272 elsif Ekind (E1) = E_Constant then
5274 -- IN parameters must denote the same static value, or the same
5275 -- constant, or the literal null.
5277 Expr1 := Expression (Parent (E1));
5279 if Ekind (E2) /= E_Constant then
5280 Check_Mismatch (True);
5283 Expr2 := Expression (Parent (E2));
5286 if Is_Static_Expression (Expr1) then
5288 if not Is_Static_Expression (Expr2) then
5289 Check_Mismatch (True);
5291 elsif Is_Discrete_Type (Etype (E1)) then
5293 V1 : constant Uint := Expr_Value (Expr1);
5294 V2 : constant Uint := Expr_Value (Expr2);
5296 Check_Mismatch (V1 /= V2);
5299 elsif Is_Real_Type (Etype (E1)) then
5301 V1 : constant Ureal := Expr_Value_R (Expr1);
5302 V2 : constant Ureal := Expr_Value_R (Expr2);
5304 Check_Mismatch (V1 /= V2);
5307 elsif Is_String_Type (Etype (E1))
5308 and then Nkind (Expr1) = N_String_Literal
5310 if Nkind (Expr2) /= N_String_Literal then
5311 Check_Mismatch (True);
5314 (not String_Equal (Strval (Expr1), Strval (Expr2)));
5318 elsif Is_Entity_Name (Expr1) then
5319 if Is_Entity_Name (Expr2) then
5320 if Entity (Expr1) = Entity (Expr2) then
5324 (not Same_Instantiated_Constant
5325 (Entity (Expr1), Entity (Expr2)));
5328 Check_Mismatch (True);
5331 elsif Is_Entity_Name (Original_Node (Expr1))
5332 and then Is_Entity_Name (Expr2)
5334 Same_Instantiated_Constant
5335 (Entity (Original_Node (Expr1)), Entity (Expr2))
5339 elsif Nkind (Expr1) = N_Null then
5340 Check_Mismatch (Nkind (Expr1) /= N_Null);
5343 Check_Mismatch (True);
5346 elsif Ekind (E1) = E_Variable then
5347 Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5349 elsif Ekind (E1) = E_Package then
5351 (Ekind (E1) /= Ekind (E2)
5352 or else Renamed_Object (E1) /= Renamed_Object (E2));
5354 elsif Is_Overloadable (E1) then
5356 -- Verify that the actual subprograms match. Note that actuals
5357 -- that are attributes are rewritten as subprograms. If the
5358 -- subprogram in the formal package is defaulted, no check is
5359 -- needed. Note that this can only happen in Ada 2005 when the
5360 -- formal package can be partially parameterized.
5362 if Nkind (Unit_Declaration_Node (E1)) =
5363 N_Subprogram_Renaming_Declaration
5364 and then From_Default (Unit_Declaration_Node (E1))
5368 -- If the formal package has an "others" box association that
5369 -- covers this formal, there is no need for a check either.
5371 elsif Nkind (Unit_Declaration_Node (E2)) in
5372 N_Formal_Subprogram_Declaration
5373 and then Box_Present (Unit_Declaration_Node (E2))
5377 -- No check needed if subprogram is a defaulted null procedure
5379 elsif No (Alias (E2))
5380 and then Ekind (E2) = E_Procedure
5382 Null_Present (Specification (Unit_Declaration_Node (E2)))
5386 -- Otherwise the actual in the formal and the actual in the
5387 -- instantiation of the formal must match, up to renamings.
5391 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5395 raise Program_Error;
5402 end Check_Formal_Package_Instance;
5404 ---------------------------
5405 -- Check_Formal_Packages --
5406 ---------------------------
5408 procedure Check_Formal_Packages (P_Id : Entity_Id) is
5410 Formal_P : Entity_Id;
5413 -- Iterate through the declarations in the instance, looking for package
5414 -- renaming declarations that denote instances of formal packages. Stop
5415 -- when we find the renaming of the current package itself. The
5416 -- declaration for a formal package without a box is followed by an
5417 -- internal entity that repeats the instantiation.
5419 E := First_Entity (P_Id);
5420 while Present (E) loop
5421 if Ekind (E) = E_Package then
5422 if Renamed_Object (E) = P_Id then
5425 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5428 elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5429 Formal_P := Next_Entity (E);
5430 Check_Formal_Package_Instance (Formal_P, E);
5432 -- After checking, remove the internal validating package. It
5433 -- is only needed for semantic checks, and as it may contain
5434 -- generic formal declarations it should not reach gigi.
5436 Remove (Unit_Declaration_Node (Formal_P));
5442 end Check_Formal_Packages;
5444 ---------------------------------
5445 -- Check_Forward_Instantiation --
5446 ---------------------------------
5448 procedure Check_Forward_Instantiation (Decl : Node_Id) is
5450 Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5453 -- The instantiation appears before the generic body if we are in the
5454 -- scope of the unit containing the generic, either in its spec or in
5455 -- the package body, and before the generic body.
5457 if Ekind (Gen_Comp) = E_Package_Body then
5458 Gen_Comp := Spec_Entity (Gen_Comp);
5461 if In_Open_Scopes (Gen_Comp)
5462 and then No (Corresponding_Body (Decl))
5467 and then not Is_Compilation_Unit (S)
5468 and then not Is_Child_Unit (S)
5470 if Ekind (S) = E_Package then
5471 Set_Has_Forward_Instantiation (S);
5477 end Check_Forward_Instantiation;
5479 ---------------------------
5480 -- Check_Generic_Actuals --
5481 ---------------------------
5483 -- The visibility of the actuals may be different between the point of
5484 -- generic instantiation and the instantiation of the body.
5486 procedure Check_Generic_Actuals
5487 (Instance : Entity_Id;
5488 Is_Formal_Box : Boolean)
5493 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5494 -- For a formal that is an array type, the component type is often a
5495 -- previous formal in the same unit. The privacy status of the component
5496 -- type will have been examined earlier in the traversal of the
5497 -- corresponding actuals, and this status should not be modified for
5498 -- the array (sub)type itself. However, if the base type of the array
5499 -- (sub)type is private, its full view must be restored in the body to
5500 -- be consistent with subsequent index subtypes, etc.
5502 -- To detect this case we have to rescan the list of formals, which is
5503 -- usually short enough to ignore the resulting inefficiency.
5505 -----------------------------
5506 -- Denotes_Previous_Actual --
5507 -----------------------------
5509 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5513 Prev := First_Entity (Instance);
5514 while Present (Prev) loop
5516 and then Nkind (Parent (Prev)) = N_Subtype_Declaration
5517 and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
5518 and then Entity (Subtype_Indication (Parent (Prev))) = Typ
5531 end Denotes_Previous_Actual;
5533 -- Start of processing for Check_Generic_Actuals
5536 E := First_Entity (Instance);
5537 while Present (E) loop
5539 and then Nkind (Parent (E)) = N_Subtype_Declaration
5540 and then Scope (Etype (E)) /= Instance
5541 and then Is_Entity_Name (Subtype_Indication (Parent (E)))
5543 if Is_Array_Type (E)
5544 and then not Is_Private_Type (Etype (E))
5545 and then Denotes_Previous_Actual (Component_Type (E))
5549 Check_Private_View (Subtype_Indication (Parent (E)));
5552 Set_Is_Generic_Actual_Type (E, True);
5553 Set_Is_Hidden (E, False);
5554 Set_Is_Potentially_Use_Visible (E,
5557 -- We constructed the generic actual type as a subtype of the
5558 -- supplied type. This means that it normally would not inherit
5559 -- subtype specific attributes of the actual, which is wrong for
5560 -- the generic case.
5562 Astype := Ancestor_Subtype (E);
5566 -- This can happen when E is an itype that is the full view of
5567 -- a private type completed, e.g. with a constrained array. In
5568 -- that case, use the first subtype, which will carry size
5569 -- information. The base type itself is unconstrained and will
5572 Astype := First_Subtype (E);
5575 Set_Size_Info (E, (Astype));
5576 Set_RM_Size (E, RM_Size (Astype));
5577 Set_First_Rep_Item (E, First_Rep_Item (Astype));
5579 if Is_Discrete_Or_Fixed_Point_Type (E) then
5580 Set_RM_Size (E, RM_Size (Astype));
5582 -- In nested instances, the base type of an access actual may
5583 -- itself be private, and need to be exchanged.
5585 elsif Is_Access_Type (E)
5586 and then Is_Private_Type (Etype (E))
5589 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
5592 elsif Ekind (E) = E_Package then
5594 -- If this is the renaming for the current instance, we're done.
5595 -- Otherwise it is a formal package. If the corresponding formal
5596 -- was declared with a box, the (instantiations of the) generic
5597 -- formal part are also visible. Otherwise, ignore the entity
5598 -- created to validate the actuals.
5600 if Renamed_Object (E) = Instance then
5603 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5606 -- The visibility of a formal of an enclosing generic is already
5609 elsif Denotes_Formal_Package (E) then
5612 elsif Present (Associated_Formal_Package (E))
5613 and then not Is_Generic_Formal (E)
5615 if Box_Present (Parent (Associated_Formal_Package (E))) then
5616 Check_Generic_Actuals (Renamed_Object (E), True);
5619 Check_Generic_Actuals (Renamed_Object (E), False);
5622 Set_Is_Hidden (E, False);
5625 -- If this is a subprogram instance (in a wrapper package) the
5626 -- actual is fully visible.
5628 elsif Is_Wrapper_Package (Instance) then
5629 Set_Is_Hidden (E, False);
5631 -- If the formal package is declared with a box, or if the formal
5632 -- parameter is defaulted, it is visible in the body.
5635 or else Is_Visible_Formal (E)
5637 Set_Is_Hidden (E, False);
5640 if Ekind (E) = E_Constant then
5642 -- If the type of the actual is a private type declared in the
5643 -- enclosing scope of the generic unit, the body of the generic
5644 -- sees the full view of the type (because it has to appear in
5645 -- the corresponding package body). If the type is private now,
5646 -- exchange views to restore the proper visiblity in the instance.
5649 Typ : constant Entity_Id := Base_Type (Etype (E));
5650 -- The type of the actual
5655 Parent_Scope : Entity_Id;
5656 -- The enclosing scope of the generic unit
5659 if Is_Wrapper_Package (Instance) then
5663 (Unit_Declaration_Node
5664 (Related_Instance (Instance))));
5668 (Specification (Unit_Declaration_Node (Instance)));
5671 Parent_Scope := Scope (Gen_Id);
5673 -- The exchange is only needed if the generic is defined
5674 -- within a package which is not a common ancestor of the
5675 -- scope of the instance, and is not already in scope.
5677 if Is_Private_Type (Typ)
5678 and then Scope (Typ) = Parent_Scope
5679 and then Scope (Instance) /= Parent_Scope
5680 and then Ekind (Parent_Scope) = E_Package
5681 and then not Is_Child_Unit (Gen_Id)
5685 -- If the type of the entity is a subtype, it may also have
5686 -- to be made visible, together with the base type of its
5687 -- full view, after exchange.
5689 if Is_Private_Type (Etype (E)) then
5690 Switch_View (Etype (E));
5691 Switch_View (Base_Type (Etype (E)));
5699 end Check_Generic_Actuals;
5701 ------------------------------
5702 -- Check_Generic_Child_Unit --
5703 ------------------------------
5705 procedure Check_Generic_Child_Unit
5707 Parent_Installed : in out Boolean)
5709 Loc : constant Source_Ptr := Sloc (Gen_Id);
5710 Gen_Par : Entity_Id := Empty;
5712 Inst_Par : Entity_Id;
5715 function Find_Generic_Child
5717 Id : Node_Id) return Entity_Id;
5718 -- Search generic parent for possible child unit with the given name
5720 function In_Enclosing_Instance return Boolean;
5721 -- Within an instance of the parent, the child unit may be denoted by
5722 -- a simple name, or an abbreviated expanded name. Examine enclosing
5723 -- scopes to locate a possible parent instantiation.
5725 ------------------------
5726 -- Find_Generic_Child --
5727 ------------------------
5729 function Find_Generic_Child
5731 Id : Node_Id) return Entity_Id
5736 -- If entity of name is already set, instance has already been
5737 -- resolved, e.g. in an enclosing instantiation.
5739 if Present (Entity (Id)) then
5740 if Scope (Entity (Id)) = Scop then
5747 E := First_Entity (Scop);
5748 while Present (E) loop
5749 if Chars (E) = Chars (Id)
5750 and then Is_Child_Unit (E)
5752 if Is_Child_Unit (E)
5753 and then not Is_Visible_Lib_Unit (E)
5756 ("generic child unit& is not visible", Gen_Id, E);
5768 end Find_Generic_Child;
5770 ---------------------------
5771 -- In_Enclosing_Instance --
5772 ---------------------------
5774 function In_Enclosing_Instance return Boolean is
5775 Enclosing_Instance : Node_Id;
5776 Instance_Decl : Node_Id;
5779 -- We do not inline any call that contains instantiations, except
5780 -- for instantiations of Unchecked_Conversion, so if we are within
5781 -- an inlined body the current instance does not require parents.
5783 if In_Inlined_Body then
5784 pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
5788 -- Loop to check enclosing scopes
5790 Enclosing_Instance := Current_Scope;
5791 while Present (Enclosing_Instance) loop
5792 Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
5794 if Ekind (Enclosing_Instance) = E_Package
5795 and then Is_Generic_Instance (Enclosing_Instance)
5797 (Generic_Parent (Specification (Instance_Decl)))
5799 -- Check whether the generic we are looking for is a child of
5802 E := Find_Generic_Child
5803 (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
5804 exit when Present (E);
5810 Enclosing_Instance := Scope (Enclosing_Instance);
5822 Make_Expanded_Name (Loc,
5824 Prefix => New_Occurrence_Of (Enclosing_Instance, Loc),
5825 Selector_Name => New_Occurrence_Of (E, Loc)));
5827 Set_Entity (Gen_Id, E);
5828 Set_Etype (Gen_Id, Etype (E));
5829 Parent_Installed := False; -- Already in scope.
5832 end In_Enclosing_Instance;
5834 -- Start of processing for Check_Generic_Child_Unit
5837 -- If the name of the generic is given by a selected component, it may
5838 -- be the name of a generic child unit, and the prefix is the name of an
5839 -- instance of the parent, in which case the child unit must be visible.
5840 -- If this instance is not in scope, it must be placed there and removed
5841 -- after instantiation, because what is being instantiated is not the
5842 -- original child, but the corresponding child present in the instance
5845 -- If the child is instantiated within the parent, it can be given by
5846 -- a simple name. In this case the instance is already in scope, but
5847 -- the child generic must be recovered from the generic parent as well.
5849 if Nkind (Gen_Id) = N_Selected_Component then
5850 S := Selector_Name (Gen_Id);
5851 Analyze (Prefix (Gen_Id));
5852 Inst_Par := Entity (Prefix (Gen_Id));
5854 if Ekind (Inst_Par) = E_Package
5855 and then Present (Renamed_Object (Inst_Par))
5857 Inst_Par := Renamed_Object (Inst_Par);
5860 if Ekind (Inst_Par) = E_Package then
5861 if Nkind (Parent (Inst_Par)) = N_Package_Specification then
5862 Gen_Par := Generic_Parent (Parent (Inst_Par));
5864 elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
5866 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
5868 Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
5871 elsif Ekind (Inst_Par) = E_Generic_Package
5872 and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
5874 -- A formal package may be a real child package, and not the
5875 -- implicit instance within a parent. In this case the child is
5876 -- not visible and has to be retrieved explicitly as well.
5878 Gen_Par := Inst_Par;
5881 if Present (Gen_Par) then
5883 -- The prefix denotes an instantiation. The entity itself may be a
5884 -- nested generic, or a child unit.
5886 E := Find_Generic_Child (Gen_Par, S);
5889 Change_Selected_Component_To_Expanded_Name (Gen_Id);
5890 Set_Entity (Gen_Id, E);
5891 Set_Etype (Gen_Id, Etype (E));
5893 Set_Etype (S, Etype (E));
5895 -- Indicate that this is a reference to the parent
5897 if In_Extended_Main_Source_Unit (Gen_Id) then
5898 Set_Is_Instantiated (Inst_Par);
5901 -- A common mistake is to replicate the naming scheme of a
5902 -- hierarchy by instantiating a generic child directly, rather
5903 -- than the implicit child in a parent instance:
5905 -- generic .. package Gpar is ..
5906 -- generic .. package Gpar.Child is ..
5907 -- package Par is new Gpar ();
5910 -- package Par.Child is new Gpar.Child ();
5911 -- rather than Par.Child
5913 -- In this case the instantiation is within Par, which is an
5914 -- instance, but Gpar does not denote Par because we are not IN
5915 -- the instance of Gpar, so this is illegal. The test below
5916 -- recognizes this particular case.
5918 if Is_Child_Unit (E)
5919 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
5920 and then (not In_Instance
5921 or else Nkind (Parent (Parent (Gen_Id))) =
5925 ("prefix of generic child unit must be instance of parent",
5929 if not In_Open_Scopes (Inst_Par)
5930 and then Nkind (Parent (Gen_Id)) not in
5931 N_Generic_Renaming_Declaration
5933 Install_Parent (Inst_Par);
5934 Parent_Installed := True;
5936 elsif In_Open_Scopes (Inst_Par) then
5938 -- If the parent is already installed, install the actuals
5939 -- for its formal packages. This is necessary when the child
5940 -- instance is a child of the parent instance: in this case,
5941 -- the parent is placed on the scope stack but the formal
5942 -- packages are not made visible.
5944 Install_Formal_Packages (Inst_Par);
5948 -- If the generic parent does not contain an entity that
5949 -- corresponds to the selector, the instance doesn't either.
5950 -- Analyzing the node will yield the appropriate error message.
5951 -- If the entity is not a child unit, then it is an inner
5952 -- generic in the parent.
5960 if Is_Child_Unit (Entity (Gen_Id))
5962 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
5963 and then not In_Open_Scopes (Inst_Par)
5965 Install_Parent (Inst_Par);
5966 Parent_Installed := True;
5968 -- The generic unit may be the renaming of the implicit child
5969 -- present in an instance. In that case the parent instance is
5970 -- obtained from the name of the renamed entity.
5972 elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
5973 and then Present (Renamed_Entity (Entity (Gen_Id)))
5974 and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
5977 Renamed_Package : constant Node_Id :=
5978 Name (Parent (Entity (Gen_Id)));
5980 if Nkind (Renamed_Package) = N_Expanded_Name then
5981 Inst_Par := Entity (Prefix (Renamed_Package));
5982 Install_Parent (Inst_Par);
5983 Parent_Installed := True;
5989 elsif Nkind (Gen_Id) = N_Expanded_Name then
5991 -- Entity already present, analyze prefix, whose meaning may be
5992 -- an instance in the current context. If it is an instance of
5993 -- a relative within another, the proper parent may still have
5994 -- to be installed, if they are not of the same generation.
5996 Analyze (Prefix (Gen_Id));
5998 -- In the unlikely case that a local declaration hides the name
5999 -- of the parent package, locate it on the homonym chain. If the
6000 -- context is an instance of the parent, the renaming entity is
6003 Inst_Par := Entity (Prefix (Gen_Id));
6004 while Present (Inst_Par)
6005 and then not Is_Package_Or_Generic_Package (Inst_Par)
6007 Inst_Par := Homonym (Inst_Par);
6010 pragma Assert (Present (Inst_Par));
6011 Set_Entity (Prefix (Gen_Id), Inst_Par);
6013 if In_Enclosing_Instance then
6016 elsif Present (Entity (Gen_Id))
6017 and then Is_Child_Unit (Entity (Gen_Id))
6018 and then not In_Open_Scopes (Inst_Par)
6020 Install_Parent (Inst_Par);
6021 Parent_Installed := True;
6024 elsif In_Enclosing_Instance then
6026 -- The child unit is found in some enclosing scope
6033 -- If this is the renaming of the implicit child in a parent
6034 -- instance, recover the parent name and install it.
6036 if Is_Entity_Name (Gen_Id) then
6037 E := Entity (Gen_Id);
6039 if Is_Generic_Unit (E)
6040 and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
6041 and then Is_Child_Unit (Renamed_Object (E))
6042 and then Is_Generic_Unit (Scope (Renamed_Object (E)))
6043 and then Nkind (Name (Parent (E))) = N_Expanded_Name
6046 New_Copy_Tree (Name (Parent (E))));
6047 Inst_Par := Entity (Prefix (Gen_Id));
6049 if not In_Open_Scopes (Inst_Par) then
6050 Install_Parent (Inst_Par);
6051 Parent_Installed := True;
6054 -- If it is a child unit of a non-generic parent, it may be
6055 -- use-visible and given by a direct name. Install parent as
6058 elsif Is_Generic_Unit (E)
6059 and then Is_Child_Unit (E)
6061 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6062 and then not Is_Generic_Unit (Scope (E))
6064 if not In_Open_Scopes (Scope (E)) then
6065 Install_Parent (Scope (E));
6066 Parent_Installed := True;
6071 end Check_Generic_Child_Unit;
6073 -----------------------------
6074 -- Check_Hidden_Child_Unit --
6075 -----------------------------
6077 procedure Check_Hidden_Child_Unit
6079 Gen_Unit : Entity_Id;
6080 Act_Decl_Id : Entity_Id)
6082 Gen_Id : constant Node_Id := Name (N);
6085 if Is_Child_Unit (Gen_Unit)
6086 and then Is_Child_Unit (Act_Decl_Id)
6087 and then Nkind (Gen_Id) = N_Expanded_Name
6088 and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
6089 and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
6091 Error_Msg_Node_2 := Scope (Act_Decl_Id);
6093 ("generic unit & is implicitly declared in &",
6094 Defining_Unit_Name (N), Gen_Unit);
6095 Error_Msg_N ("\instance must have different name",
6096 Defining_Unit_Name (N));
6098 end Check_Hidden_Child_Unit;
6100 ------------------------
6101 -- Check_Private_View --
6102 ------------------------
6104 procedure Check_Private_View (N : Node_Id) is
6105 T : constant Entity_Id := Etype (N);
6109 -- Exchange views if the type was not private in the generic but is
6110 -- private at the point of instantiation. Do not exchange views if
6111 -- the scope of the type is in scope. This can happen if both generic
6112 -- and instance are sibling units, or if type is defined in a parent.
6113 -- In this case the visibility of the type will be correct for all
6117 BT := Base_Type (T);
6119 if Is_Private_Type (T)
6120 and then not Has_Private_View (N)
6121 and then Present (Full_View (T))
6122 and then not In_Open_Scopes (Scope (T))
6124 -- In the generic, the full type was visible. Save the private
6125 -- entity, for subsequent exchange.
6129 elsif Has_Private_View (N)
6130 and then not Is_Private_Type (T)
6131 and then not Has_Been_Exchanged (T)
6132 and then Etype (Get_Associated_Node (N)) /= T
6134 -- Only the private declaration was visible in the generic. If
6135 -- the type appears in a subtype declaration, the subtype in the
6136 -- instance must have a view compatible with that of its parent,
6137 -- which must be exchanged (see corresponding code in Restore_
6138 -- Private_Views). Otherwise, if the type is defined in a parent
6139 -- unit, leave full visibility within instance, which is safe.
6141 if In_Open_Scopes (Scope (Base_Type (T)))
6142 and then not Is_Private_Type (Base_Type (T))
6143 and then Comes_From_Source (Base_Type (T))
6147 elsif Nkind (Parent (N)) = N_Subtype_Declaration
6148 or else not In_Private_Part (Scope (Base_Type (T)))
6150 Prepend_Elmt (T, Exchanged_Views);
6151 Exchange_Declarations (Etype (Get_Associated_Node (N)));
6154 -- For composite types with inconsistent representation exchange
6155 -- component types accordingly.
6157 elsif Is_Access_Type (T)
6158 and then Is_Private_Type (Designated_Type (T))
6159 and then not Has_Private_View (N)
6160 and then Present (Full_View (Designated_Type (T)))
6162 Switch_View (Designated_Type (T));
6164 elsif Is_Array_Type (T) then
6165 if Is_Private_Type (Component_Type (T))
6166 and then not Has_Private_View (N)
6167 and then Present (Full_View (Component_Type (T)))
6169 Switch_View (Component_Type (T));
6172 -- The normal exchange mechanism relies on the setting of a
6173 -- flag on the reference in the generic. However, an additional
6174 -- mechanism is needed for types that are not explicitly
6175 -- mentioned in the generic, but may be needed in expanded code
6176 -- in the instance. This includes component types of arrays and
6177 -- designated types of access types. This processing must also
6178 -- include the index types of arrays which we take care of here.
6185 Indx := First_Index (T);
6186 while Present (Indx) loop
6187 Typ := Base_Type (Etype (Indx));
6189 if Is_Private_Type (Typ)
6190 and then Present (Full_View (Typ))
6199 elsif Is_Private_Type (T)
6200 and then Present (Full_View (T))
6201 and then Is_Array_Type (Full_View (T))
6202 and then Is_Private_Type (Component_Type (Full_View (T)))
6206 -- Finally, a non-private subtype may have a private base type, which
6207 -- must be exchanged for consistency. This can happen when a package
6208 -- body is instantiated, when the scope stack is empty but in fact
6209 -- the subtype and the base type are declared in an enclosing scope.
6211 -- Note that in this case we introduce an inconsistency in the view
6212 -- set, because we switch the base type BT, but there could be some
6213 -- private dependent subtypes of BT which remain unswitched. Such
6214 -- subtypes might need to be switched at a later point (see specific
6215 -- provision for that case in Switch_View).
6217 elsif not Is_Private_Type (T)
6218 and then not Has_Private_View (N)
6219 and then Is_Private_Type (BT)
6220 and then Present (Full_View (BT))
6221 and then not Is_Generic_Type (BT)
6222 and then not In_Open_Scopes (BT)
6224 Prepend_Elmt (Full_View (BT), Exchanged_Views);
6225 Exchange_Declarations (BT);
6228 end Check_Private_View;
6230 -----------------------------
6231 -- Check_Hidden_Primitives --
6232 -----------------------------
6234 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6237 Result : Elist_Id := No_Elist;
6240 if No (Assoc_List) then
6244 -- Traverse the list of associations between formals and actuals
6245 -- searching for renamings of tagged types
6247 Actual := First (Assoc_List);
6248 while Present (Actual) loop
6249 if Nkind (Actual) = N_Subtype_Declaration then
6250 Gen_T := Generic_Parent_Type (Actual);
6253 and then Is_Tagged_Type (Gen_T)
6255 -- Traverse the list of primitives of the actual types
6256 -- searching for hidden primitives that are visible in the
6257 -- corresponding generic formal; leave them visible and
6258 -- append them to Result to restore their decoration later.
6260 Install_Hidden_Primitives
6261 (Prims_List => Result,
6263 Act_T => Entity (Subtype_Indication (Actual)));
6271 end Check_Hidden_Primitives;
6273 --------------------------
6274 -- Contains_Instance_Of --
6275 --------------------------
6277 function Contains_Instance_Of
6280 N : Node_Id) return Boolean
6288 -- Verify that there are no circular instantiations. We check whether
6289 -- the unit contains an instance of the current scope or some enclosing
6290 -- scope (in case one of the instances appears in a subunit). Longer
6291 -- circularities involving subunits might seem too pathological to
6292 -- consider, but they were not too pathological for the authors of
6293 -- DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6294 -- enclosing generic scopes as containing an instance.
6297 -- Within a generic subprogram body, the scope is not generic, to
6298 -- allow for recursive subprograms. Use the declaration to determine
6299 -- whether this is a generic unit.
6301 if Ekind (Scop) = E_Generic_Package
6302 or else (Is_Subprogram (Scop)
6303 and then Nkind (Unit_Declaration_Node (Scop)) =
6304 N_Generic_Subprogram_Declaration)
6306 Elmt := First_Elmt (Inner_Instances (Inner));
6308 while Present (Elmt) loop
6309 if Node (Elmt) = Scop then
6310 Error_Msg_Node_2 := Inner;
6312 ("circular Instantiation: & instantiated within &!",
6316 elsif Node (Elmt) = Inner then
6319 elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6320 Error_Msg_Node_2 := Inner;
6322 ("circular Instantiation: & instantiated within &!",
6330 -- Indicate that Inner is being instantiated within Scop
6332 Append_Elmt (Inner, Inner_Instances (Scop));
6335 if Scop = Standard_Standard then
6338 Scop := Scope (Scop);
6343 end Contains_Instance_Of;
6345 -----------------------
6346 -- Copy_Generic_Node --
6347 -----------------------
6349 function Copy_Generic_Node
6351 Parent_Id : Node_Id;
6352 Instantiating : Boolean) return Node_Id
6357 function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6358 -- Check the given value of one of the Fields referenced by the current
6359 -- node to determine whether to copy it recursively. The field may hold
6360 -- a Node_Id, a List_Id, or an Elist_Id, or a plain value (Sloc, Uint,
6361 -- Char) in which case it need not be copied.
6363 procedure Copy_Descendants;
6364 -- Common utility for various nodes
6366 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6367 -- Make copy of element list
6369 function Copy_Generic_List
6371 Parent_Id : Node_Id) return List_Id;
6372 -- Apply Copy_Node recursively to the members of a node list
6374 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6375 -- True if an identifier is part of the defining program unit name of
6376 -- a child unit. The entity of such an identifier must be kept (for
6377 -- ASIS use) even though as the name of an enclosing generic it would
6378 -- otherwise not be preserved in the generic tree.
6380 ----------------------
6381 -- Copy_Descendants --
6382 ----------------------
6384 procedure Copy_Descendants is
6386 use Atree.Unchecked_Access;
6387 -- This code section is part of the implementation of an untyped
6388 -- tree traversal, so it needs direct access to node fields.
6391 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6392 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6393 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6394 Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6395 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6396 end Copy_Descendants;
6398 -----------------------------
6399 -- Copy_Generic_Descendant --
6400 -----------------------------
6402 function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6404 if D = Union_Id (Empty) then
6407 elsif D in Node_Range then
6409 (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6411 elsif D in List_Range then
6412 return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6414 elsif D in Elist_Range then
6415 return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6417 -- Nothing else is copyable (e.g. Uint values), return as is
6422 end Copy_Generic_Descendant;
6424 ------------------------
6425 -- Copy_Generic_Elist --
6426 ------------------------
6428 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6435 M := First_Elmt (E);
6436 while Present (M) loop
6438 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6447 end Copy_Generic_Elist;
6449 -----------------------
6450 -- Copy_Generic_List --
6451 -----------------------
6453 function Copy_Generic_List
6455 Parent_Id : Node_Id) return List_Id
6463 Set_Parent (New_L, Parent_Id);
6466 while Present (N) loop
6467 Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6476 end Copy_Generic_List;
6478 ---------------------------
6479 -- In_Defining_Unit_Name --
6480 ---------------------------
6482 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6484 return Present (Parent (Nam))
6485 and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6487 (Nkind (Parent (Nam)) = N_Expanded_Name
6488 and then In_Defining_Unit_Name (Parent (Nam))));
6489 end In_Defining_Unit_Name;
6491 -- Start of processing for Copy_Generic_Node
6498 New_N := New_Copy (N);
6500 -- Copy aspects if present
6502 if Has_Aspects (N) then
6503 Set_Has_Aspects (New_N, False);
6504 Set_Aspect_Specifications
6505 (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6508 if Instantiating then
6509 Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6512 if not Is_List_Member (N) then
6513 Set_Parent (New_N, Parent_Id);
6516 -- If defining identifier, then all fields have been copied already
6518 if Nkind (New_N) in N_Entity then
6521 -- Special casing for identifiers and other entity names and operators
6523 elsif Nkind_In (New_N, N_Identifier,
6524 N_Character_Literal,
6527 or else Nkind (New_N) in N_Op
6529 if not Instantiating then
6531 -- Link both nodes in order to assign subsequently the entity of
6532 -- the copy to the original node, in case this is a global
6535 Set_Associated_Node (N, New_N);
6537 -- If we are within an instantiation, this is a nested generic
6538 -- that has already been analyzed at the point of definition.
6539 -- We must preserve references that were global to the enclosing
6540 -- parent at that point. Other occurrences, whether global or
6541 -- local to the current generic, must be resolved anew, so we
6542 -- reset the entity in the generic copy. A global reference has a
6543 -- smaller depth than the parent, or else the same depth in case
6544 -- both are distinct compilation units.
6546 -- A child unit is implicitly declared within the enclosing parent
6547 -- but is in fact global to it, and must be preserved.
6549 -- It is also possible for Current_Instantiated_Parent to be
6550 -- defined, and for this not to be a nested generic, namely if
6551 -- the unit is loaded through Rtsfind. In that case, the entity of
6552 -- New_N is only a link to the associated node, and not a defining
6555 -- The entities for parent units in the defining_program_unit of a
6556 -- generic child unit are established when the context of the unit
6557 -- is first analyzed, before the generic copy is made. They are
6558 -- preserved in the copy for use in ASIS queries.
6560 Ent := Entity (New_N);
6562 if No (Current_Instantiated_Parent.Gen_Id) then
6564 or else Nkind (Ent) /= N_Defining_Identifier
6565 or else not In_Defining_Unit_Name (N)
6567 Set_Associated_Node (New_N, Empty);
6572 not Nkind_In (Ent, N_Defining_Identifier,
6573 N_Defining_Character_Literal,
6574 N_Defining_Operator_Symbol)
6575 or else No (Scope (Ent))
6577 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
6578 and then not Is_Child_Unit (Ent))
6580 (Scope_Depth (Scope (Ent)) >
6581 Scope_Depth (Current_Instantiated_Parent.Gen_Id)
6583 Get_Source_Unit (Ent) =
6584 Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
6586 Set_Associated_Node (New_N, Empty);
6589 -- Case of instantiating identifier or some other name or operator
6592 -- If the associated node is still defined, the entity in it
6593 -- is global, and must be copied to the instance. If this copy
6594 -- is being made for a body to inline, it is applied to an
6595 -- instantiated tree, and the entity is already present and
6596 -- must be also preserved.
6599 Assoc : constant Node_Id := Get_Associated_Node (N);
6602 if Present (Assoc) then
6603 if Nkind (Assoc) = Nkind (N) then
6604 Set_Entity (New_N, Entity (Assoc));
6605 Check_Private_View (N);
6607 -- The name in the call may be a selected component if the
6608 -- call has not been analyzed yet, as may be the case for
6609 -- pre/post conditions in a generic unit.
6611 elsif Nkind (Assoc) = N_Function_Call
6612 and then Is_Entity_Name (Name (Assoc))
6614 Set_Entity (New_N, Entity (Name (Assoc)));
6616 elsif Nkind_In (Assoc, N_Defining_Identifier,
6617 N_Defining_Character_Literal,
6618 N_Defining_Operator_Symbol)
6619 and then Expander_Active
6621 -- Inlining case: we are copying a tree that contains
6622 -- global entities, which are preserved in the copy to be
6623 -- used for subsequent inlining.
6628 Set_Entity (New_N, Empty);
6634 -- For expanded name, we must copy the Prefix and Selector_Name
6636 if Nkind (N) = N_Expanded_Name then
6638 (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
6640 Set_Selector_Name (New_N,
6641 Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
6643 -- For operators, we must copy the right operand
6645 elsif Nkind (N) in N_Op then
6646 Set_Right_Opnd (New_N,
6647 Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
6649 -- And for binary operators, the left operand as well
6651 if Nkind (N) in N_Binary_Op then
6652 Set_Left_Opnd (New_N,
6653 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
6657 -- Special casing for stubs
6659 elsif Nkind (N) in N_Body_Stub then
6661 -- In any case, we must copy the specification or defining
6662 -- identifier as appropriate.
6664 if Nkind (N) = N_Subprogram_Body_Stub then
6665 Set_Specification (New_N,
6666 Copy_Generic_Node (Specification (N), New_N, Instantiating));
6669 Set_Defining_Identifier (New_N,
6671 (Defining_Identifier (N), New_N, Instantiating));
6674 -- If we are not instantiating, then this is where we load and
6675 -- analyze subunits, i.e. at the point where the stub occurs. A
6676 -- more permissive system might defer this analysis to the point
6677 -- of instantiation, but this seems too complicated for now.
6679 if not Instantiating then
6681 Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
6683 Unum : Unit_Number_Type;
6687 -- Make sure that, if it is a subunit of the main unit that is
6688 -- preprocessed and if -gnateG is specified, the preprocessed
6689 -- file will be written.
6691 Lib.Analysing_Subunit_Of_Main :=
6692 Lib.In_Extended_Main_Source_Unit (N);
6695 (Load_Name => Subunit_Name,
6699 Lib.Analysing_Subunit_Of_Main := False;
6701 -- If the proper body is not found, a warning message will be
6702 -- emitted when analyzing the stub, or later at the point of
6703 -- instantiation. Here we just leave the stub as is.
6705 if Unum = No_Unit then
6706 Subunits_Missing := True;
6707 goto Subunit_Not_Found;
6710 Subunit := Cunit (Unum);
6712 if Nkind (Unit (Subunit)) /= N_Subunit then
6714 ("found child unit instead of expected SEPARATE subunit",
6716 Error_Msg_Sloc := Sloc (N);
6717 Error_Msg_N ("\to complete stub #", Subunit);
6718 goto Subunit_Not_Found;
6721 -- We must create a generic copy of the subunit, in order to
6722 -- perform semantic analysis on it, and we must replace the
6723 -- stub in the original generic unit with the subunit, in order
6724 -- to preserve non-local references within.
6726 -- Only the proper body needs to be copied. Library_Unit and
6727 -- context clause are simply inherited by the generic copy.
6728 -- Note that the copy (which may be recursive if there are
6729 -- nested subunits) must be done first, before attaching it to
6730 -- the enclosing generic.
6734 (Proper_Body (Unit (Subunit)),
6735 Empty, Instantiating => False);
6737 -- Now place the original proper body in the original generic
6738 -- unit. This is a body, not a compilation unit.
6740 Rewrite (N, Proper_Body (Unit (Subunit)));
6741 Set_Is_Compilation_Unit (Defining_Entity (N), False);
6742 Set_Was_Originally_Stub (N);
6744 -- Finally replace the body of the subunit with its copy, and
6745 -- make this new subunit into the library unit of the generic
6746 -- copy, which does not have stubs any longer.
6748 Set_Proper_Body (Unit (Subunit), New_Body);
6749 Set_Library_Unit (New_N, Subunit);
6750 Inherit_Context (Unit (Subunit), N);
6753 -- If we are instantiating, this must be an error case, since
6754 -- otherwise we would have replaced the stub node by the proper body
6755 -- that corresponds. So just ignore it in the copy (i.e. we have
6756 -- copied it, and that is good enough).
6762 <<Subunit_Not_Found>> null;
6764 -- If the node is a compilation unit, it is the subunit of a stub, which
6765 -- has been loaded already (see code below). In this case, the library
6766 -- unit field of N points to the parent unit (which is a compilation
6767 -- unit) and need not (and cannot!) be copied.
6769 -- When the proper body of the stub is analyzed, the library_unit link
6770 -- is used to establish the proper context (see sem_ch10).
6772 -- The other fields of a compilation unit are copied as usual
6774 elsif Nkind (N) = N_Compilation_Unit then
6776 -- This code can only be executed when not instantiating, because in
6777 -- the copy made for an instantiation, the compilation unit node has
6778 -- disappeared at the point that a stub is replaced by its proper
6781 pragma Assert (not Instantiating);
6783 Set_Context_Items (New_N,
6784 Copy_Generic_List (Context_Items (N), New_N));
6787 Copy_Generic_Node (Unit (N), New_N, False));
6789 Set_First_Inlined_Subprogram (New_N,
6791 (First_Inlined_Subprogram (N), New_N, False));
6793 Set_Aux_Decls_Node (New_N,
6794 Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
6796 -- For an assignment node, the assignment is known to be semantically
6797 -- legal if we are instantiating the template. This avoids incorrect
6798 -- diagnostics in generated code.
6800 elsif Nkind (N) = N_Assignment_Statement then
6802 -- Copy name and expression fields in usual manner
6805 Copy_Generic_Node (Name (N), New_N, Instantiating));
6807 Set_Expression (New_N,
6808 Copy_Generic_Node (Expression (N), New_N, Instantiating));
6810 if Instantiating then
6811 Set_Assignment_OK (Name (New_N), True);
6814 elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
6815 if not Instantiating then
6816 Set_Associated_Node (N, New_N);
6819 if Present (Get_Associated_Node (N))
6820 and then Nkind (Get_Associated_Node (N)) = Nkind (N)
6822 -- In the generic the aggregate has some composite type. If at
6823 -- the point of instantiation the type has a private view,
6824 -- install the full view (and that of its ancestors, if any).
6827 T : Entity_Id := (Etype (Get_Associated_Node (New_N)));
6832 and then Is_Private_Type (T)
6838 and then Is_Tagged_Type (T)
6839 and then Is_Derived_Type (T)
6841 Rt := Root_Type (T);
6846 if Is_Private_Type (T) then
6857 -- Do not copy the associated node, which points to the generic copy
6858 -- of the aggregate.
6861 use Atree.Unchecked_Access;
6862 -- This code section is part of the implementation of an untyped
6863 -- tree traversal, so it needs direct access to node fields.
6866 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6867 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6868 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6869 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6872 -- Allocators do not have an identifier denoting the access type, so we
6873 -- must locate it through the expression to check whether the views are
6876 elsif Nkind (N) = N_Allocator
6877 and then Nkind (Expression (N)) = N_Qualified_Expression
6878 and then Is_Entity_Name (Subtype_Mark (Expression (N)))
6879 and then Instantiating
6882 T : constant Node_Id :=
6883 Get_Associated_Node (Subtype_Mark (Expression (N)));
6889 -- Retrieve the allocator node in the generic copy
6891 Acc_T := Etype (Parent (Parent (T)));
6893 and then Is_Private_Type (Acc_T)
6895 Switch_View (Acc_T);
6902 -- For a proper body, we must catch the case of a proper body that
6903 -- replaces a stub. This represents the point at which a separate
6904 -- compilation unit, and hence template file, may be referenced, so we
6905 -- must make a new source instantiation entry for the template of the
6906 -- subunit, and ensure that all nodes in the subunit are adjusted using
6907 -- this new source instantiation entry.
6909 elsif Nkind (N) in N_Proper_Body then
6911 Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
6914 if Instantiating and then Was_Originally_Stub (N) then
6915 Create_Instantiation_Source
6916 (Instantiation_Node,
6917 Defining_Entity (N),
6922 -- Now copy the fields of the proper body, using the new
6923 -- adjustment factor if one was needed as per test above.
6927 -- Restore the original adjustment factor in case changed
6929 S_Adjustment := Save_Adjustment;
6932 -- Don't copy Ident or Comment pragmas, since the comment belongs to the
6933 -- generic unit, not to the instantiating unit.
6935 elsif Nkind (N) = N_Pragma and then Instantiating then
6937 Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
6939 if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
6940 New_N := Make_Null_Statement (Sloc (N));
6946 elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
6948 -- No descendant fields need traversing
6952 elsif Nkind (N) = N_String_Literal
6953 and then Present (Etype (N))
6954 and then Instantiating
6956 -- If the string is declared in an outer scope, the string_literal
6957 -- subtype created for it may have the wrong scope. We force the
6958 -- reanalysis of the constant to generate a new itype in the proper
6961 Set_Etype (New_N, Empty);
6962 Set_Analyzed (New_N, False);
6964 -- For the remaining nodes, copy their descendants recursively
6969 if Instantiating and then Nkind (N) = N_Subprogram_Body then
6970 Set_Generic_Parent (Specification (New_N), N);
6972 -- Should preserve Corresponding_Spec??? (12.3(14))
6977 end Copy_Generic_Node;
6979 ----------------------------
6980 -- Denotes_Formal_Package --
6981 ----------------------------
6983 function Denotes_Formal_Package
6985 On_Exit : Boolean := False;
6986 Instance : Entity_Id := Empty) return Boolean
6989 Scop : constant Entity_Id := Scope (Pack);
6992 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
6993 -- The package in question may be an actual for a previous formal
6994 -- package P of the current instance, so examine its actuals as well.
6995 -- This must be recursive over other formal packages.
6997 ----------------------------------
6998 -- Is_Actual_Of_Previous_Formal --
6999 ----------------------------------
7001 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
7005 E1 := First_Entity (P);
7006 while Present (E1) and then E1 /= Instance loop
7007 if Ekind (E1) = E_Package
7008 and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
7010 if Renamed_Object (E1) = Pack then
7013 elsif E1 = P or else Renamed_Object (E1) = P then
7016 elsif Is_Actual_Of_Previous_Formal (E1) then
7025 end Is_Actual_Of_Previous_Formal;
7027 -- Start of processing for Denotes_Formal_Package
7033 (Instance_Envs.Last).Instantiated_Parent.Act_Id;
7035 Par := Current_Instantiated_Parent.Act_Id;
7038 if Ekind (Scop) = E_Generic_Package
7039 or else Nkind (Unit_Declaration_Node (Scop)) =
7040 N_Generic_Subprogram_Declaration
7044 elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
7045 N_Formal_Package_Declaration
7053 -- Check whether this package is associated with a formal package of
7054 -- the enclosing instantiation. Iterate over the list of renamings.
7056 E := First_Entity (Par);
7057 while Present (E) loop
7058 if Ekind (E) /= E_Package
7059 or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
7063 elsif Renamed_Object (E) = Par then
7066 elsif Renamed_Object (E) = Pack then
7069 elsif Is_Actual_Of_Previous_Formal (E) then
7079 end Denotes_Formal_Package;
7085 procedure End_Generic is
7087 -- ??? More things could be factored out in this routine. Should
7088 -- probably be done at a later stage.
7090 Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
7091 Generic_Flags.Decrement_Last;
7093 Expander_Mode_Restore;
7100 function Earlier (N1, N2 : Node_Id) return Boolean is
7101 procedure Find_Depth (P : in out Node_Id; D : in out Integer);
7102 -- Find distance from given node to enclosing compilation unit
7108 procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
7111 and then Nkind (P) /= N_Compilation_Unit
7113 P := True_Parent (P);
7118 -- Local declarations
7127 -- Start of processing for Earlier
7130 Find_Depth (P1, D1);
7131 Find_Depth (P2, D2);
7141 P1 := True_Parent (P1);
7146 P2 := True_Parent (P2);
7150 -- At this point P1 and P2 are at the same distance from the root.
7151 -- We examine their parents until we find a common declarative list.
7152 -- If we reach the root, N1 and N2 do not descend from the same
7153 -- declarative list (e.g. one is nested in the declarative part and
7154 -- the other is in a block in the statement part) and the earlier
7155 -- one is already frozen.
7157 while not Is_List_Member (P1)
7158 or else not Is_List_Member (P2)
7159 or else List_Containing (P1) /= List_Containing (P2)
7161 P1 := True_Parent (P1);
7162 P2 := True_Parent (P2);
7164 if Nkind (Parent (P1)) = N_Subunit then
7165 P1 := Corresponding_Stub (Parent (P1));
7168 if Nkind (Parent (P2)) = N_Subunit then
7169 P2 := Corresponding_Stub (Parent (P2));
7177 -- Expanded code usually shares the source location of the original
7178 -- construct it was generated for. This however may not necessarely
7179 -- reflect the true location of the code within the tree.
7181 -- Before comparing the slocs of the two nodes, make sure that we are
7182 -- working with correct source locations. Assume that P1 is to the left
7183 -- of P2. If either one does not come from source, traverse the common
7184 -- list heading towards the other node and locate the first source
7188 -- ----+===+===+--------------+===+===+----
7189 -- expanded code expanded code
7191 if not Comes_From_Source (P1) then
7192 while Present (P1) loop
7194 -- Neither P2 nor a source statement were located during the
7195 -- search. If we reach the end of the list, then P1 does not
7196 -- occur earlier than P2.
7199 -- start --- P2 ----- P1 --- end
7201 if No (Next (P1)) then
7204 -- We encounter P2 while going to the right of the list. This
7205 -- means that P1 does indeed appear earlier.
7208 -- start --- P1 ===== P2 --- end
7209 -- expanded code in between
7214 -- No need to look any further since we have located a source
7217 elsif Comes_From_Source (P1) then
7227 if not Comes_From_Source (P2) then
7228 while Present (P2) loop
7230 -- Neither P1 nor a source statement were located during the
7231 -- search. If we reach the start of the list, then P1 does not
7232 -- occur earlier than P2.
7235 -- start --- P2 --- P1 --- end
7237 if No (Prev (P2)) then
7240 -- We encounter P1 while going to the left of the list. This
7241 -- means that P1 does indeed appear earlier.
7244 -- start --- P1 ===== P2 --- end
7245 -- expanded code in between
7250 -- No need to look any further since we have located a source
7253 elsif Comes_From_Source (P2) then
7263 -- At this point either both nodes came from source or we approximated
7264 -- their source locations through neighbouring source statements.
7266 T1 := Top_Level_Location (Sloc (P1));
7267 T2 := Top_Level_Location (Sloc (P2));
7269 -- When two nodes come from the same instance, they have identical top
7270 -- level locations. To determine proper relation within the tree, check
7271 -- their locations within the template.
7274 return Sloc (P1) < Sloc (P2);
7276 -- The two nodes either come from unrelated instances or do not come
7277 -- from instantiated code at all.
7284 ----------------------
7285 -- Find_Actual_Type --
7286 ----------------------
7288 function Find_Actual_Type
7290 Gen_Type : Entity_Id) return Entity_Id
7292 Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7296 -- Special processing only applies to child units
7298 if not Is_Child_Unit (Gen_Scope) then
7299 return Get_Instance_Of (Typ);
7301 -- If designated or component type is itself a formal of the child unit,
7302 -- its instance is available.
7304 elsif Scope (Typ) = Gen_Scope then
7305 return Get_Instance_Of (Typ);
7307 -- If the array or access type is not declared in the parent unit,
7308 -- no special processing needed.
7310 elsif not Is_Generic_Type (Typ)
7311 and then Scope (Gen_Scope) /= Scope (Typ)
7313 return Get_Instance_Of (Typ);
7315 -- Otherwise, retrieve designated or component type by visibility
7318 T := Current_Entity (Typ);
7319 while Present (T) loop
7320 if In_Open_Scopes (Scope (T)) then
7323 elsif Is_Generic_Actual_Type (T) then
7332 end Find_Actual_Type;
7334 ----------------------------
7335 -- Freeze_Subprogram_Body --
7336 ----------------------------
7338 procedure Freeze_Subprogram_Body
7339 (Inst_Node : Node_Id;
7341 Pack_Id : Entity_Id)
7343 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7344 Par : constant Entity_Id := Scope (Gen_Unit);
7350 function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7351 -- Find innermost package body that encloses the given node, and which
7352 -- is not a compilation unit. Freeze nodes for the instance, or for its
7353 -- enclosing body, may be inserted after the enclosing_body of the
7354 -- generic unit. Used to determine proper placement of freeze node for
7355 -- both package and subprogram instances.
7357 function Package_Freeze_Node (B : Node_Id) return Node_Id;
7358 -- Find entity for given package body, and locate or create a freeze
7361 ----------------------------
7362 -- Enclosing_Package_Body --
7363 ----------------------------
7365 function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7371 and then Nkind (Parent (P)) /= N_Compilation_Unit
7373 if Nkind (P) = N_Package_Body then
7374 if Nkind (Parent (P)) = N_Subunit then
7375 return Corresponding_Stub (Parent (P));
7381 P := True_Parent (P);
7385 end Enclosing_Package_Body;
7387 -------------------------
7388 -- Package_Freeze_Node --
7389 -------------------------
7391 function Package_Freeze_Node (B : Node_Id) return Node_Id is
7395 if Nkind (B) = N_Package_Body then
7396 Id := Corresponding_Spec (B);
7397 else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7398 Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7401 Ensure_Freeze_Node (Id);
7402 return Freeze_Node (Id);
7403 end Package_Freeze_Node;
7405 -- Start of processing of Freeze_Subprogram_Body
7408 -- If the instance and the generic body appear within the same unit, and
7409 -- the instance precedes the generic, the freeze node for the instance
7410 -- must appear after that of the generic. If the generic is nested
7411 -- within another instance I2, then current instance must be frozen
7412 -- after I2. In both cases, the freeze nodes are those of enclosing
7413 -- packages. Otherwise, the freeze node is placed at the end of the
7414 -- current declarative part.
7416 Enc_G := Enclosing_Package_Body (Gen_Body);
7417 Enc_I := Enclosing_Package_Body (Inst_Node);
7418 Ensure_Freeze_Node (Pack_Id);
7419 F_Node := Freeze_Node (Pack_Id);
7421 if Is_Generic_Instance (Par)
7422 and then Present (Freeze_Node (Par))
7423 and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7425 -- The parent was a premature instantiation. Insert freeze node at
7426 -- the end the current declarative part.
7428 if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7429 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7431 -- Handle the following case:
7433 -- package Parent_Inst is new ...
7436 -- procedure P ... -- this body freezes Parent_Inst
7438 -- package Inst is new ...
7440 -- In this particular scenario, the freeze node for Inst must be
7441 -- inserted in the same manner as that of Parent_Inst - before the
7442 -- next source body or at the end of the declarative list (body not
7443 -- available). If body P did not exist and Parent_Inst was frozen
7444 -- after Inst, either by a body following Inst or at the end of the
7445 -- declarative region, the freeze node for Inst must be inserted
7446 -- after that of Parent_Inst. This relation is established by
7447 -- comparing the Slocs of Parent_Inst freeze node and Inst.
7449 elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7450 List_Containing (Inst_Node)
7451 and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7453 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7456 Insert_After (Freeze_Node (Par), F_Node);
7459 -- The body enclosing the instance should be frozen after the body that
7460 -- includes the generic, because the body of the instance may make
7461 -- references to entities therein. If the two are not in the same
7462 -- declarative part, or if the one enclosing the instance is frozen
7463 -- already, freeze the instance at the end of the current declarative
7466 elsif Is_Generic_Instance (Par)
7467 and then Present (Freeze_Node (Par))
7468 and then Present (Enc_I)
7470 if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7472 (Nkind (Enc_I) = N_Package_Body
7474 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7476 -- The enclosing package may contain several instances. Rather
7477 -- than computing the earliest point at which to insert its freeze
7478 -- node, we place it at the end of the declarative part of the
7479 -- parent of the generic.
7481 Insert_Freeze_Node_For_Instance
7482 (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7485 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7487 elsif Present (Enc_G)
7488 and then Present (Enc_I)
7489 and then Enc_G /= Enc_I
7490 and then Earlier (Inst_Node, Gen_Body)
7492 if Nkind (Enc_G) = N_Package_Body then
7493 E_G_Id := Corresponding_Spec (Enc_G);
7494 else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7496 Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7499 -- Freeze package that encloses instance, and place node after the
7500 -- package that encloses generic. If enclosing package is already
7501 -- frozen we have to assume it is at the proper place. This may be a
7502 -- potential ABE that requires dynamic checking. Do not add a freeze
7503 -- node if the package that encloses the generic is inside the body
7504 -- that encloses the instance, because the freeze node would be in
7505 -- the wrong scope. Additional contortions needed if the bodies are
7506 -- within a subunit.
7509 Enclosing_Body : Node_Id;
7512 if Nkind (Enc_I) = N_Package_Body_Stub then
7513 Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7515 Enclosing_Body := Enc_I;
7518 if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
7519 Insert_Freeze_Node_For_Instance
7520 (Enc_G, Package_Freeze_Node (Enc_I));
7524 -- Freeze enclosing subunit before instance
7526 Ensure_Freeze_Node (E_G_Id);
7528 if not Is_List_Member (Freeze_Node (E_G_Id)) then
7529 Insert_After (Enc_G, Freeze_Node (E_G_Id));
7532 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7535 -- If none of the above, insert freeze node at the end of the current
7536 -- declarative part.
7538 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7540 end Freeze_Subprogram_Body;
7546 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
7548 return Generic_Renamings.Table (E).Gen_Id;
7551 ---------------------
7552 -- Get_Instance_Of --
7553 ---------------------
7555 function Get_Instance_Of (A : Entity_Id) return Entity_Id is
7556 Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
7559 if Res /= Assoc_Null then
7560 return Generic_Renamings.Table (Res).Act_Id;
7562 -- On exit, entity is not instantiated: not a generic parameter, or
7563 -- else parameter of an inner generic unit.
7567 end Get_Instance_Of;
7569 ------------------------------------
7570 -- Get_Package_Instantiation_Node --
7571 ------------------------------------
7573 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
7574 Decl : Node_Id := Unit_Declaration_Node (A);
7578 -- If the Package_Instantiation attribute has been set on the package
7579 -- entity, then use it directly when it (or its Original_Node) refers
7580 -- to an N_Package_Instantiation node. In principle it should be
7581 -- possible to have this field set in all cases, which should be
7582 -- investigated, and would allow this function to be significantly
7585 Inst := Package_Instantiation (A);
7587 if Present (Inst) then
7588 if Nkind (Inst) = N_Package_Instantiation then
7591 elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
7592 return Original_Node (Inst);
7596 -- If the instantiation is a compilation unit that does not need body
7597 -- then the instantiation node has been rewritten as a package
7598 -- declaration for the instance, and we return the original node.
7600 -- If it is a compilation unit and the instance node has not been
7601 -- rewritten, then it is still the unit of the compilation. Finally, if
7602 -- a body is present, this is a parent of the main unit whose body has
7603 -- been compiled for inlining purposes, and the instantiation node has
7604 -- been rewritten with the instance body.
7606 -- Otherwise the instantiation node appears after the declaration. If
7607 -- the entity is a formal package, the declaration may have been
7608 -- rewritten as a generic declaration (in the case of a formal with box)
7609 -- or left as a formal package declaration if it has actuals, and is
7610 -- found with a forward search.
7612 if Nkind (Parent (Decl)) = N_Compilation_Unit then
7613 if Nkind (Decl) = N_Package_Declaration
7614 and then Present (Corresponding_Body (Decl))
7616 Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
7619 if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
7620 return Original_Node (Decl);
7622 return Unit (Parent (Decl));
7625 elsif Nkind (Decl) = N_Package_Declaration
7626 and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
7628 return Original_Node (Decl);
7631 Inst := Next (Decl);
7632 while not Nkind_In (Inst, N_Package_Instantiation,
7633 N_Formal_Package_Declaration)
7640 end Get_Package_Instantiation_Node;
7642 ------------------------
7643 -- Has_Been_Exchanged --
7644 ------------------------
7646 function Has_Been_Exchanged (E : Entity_Id) return Boolean is
7650 Next := First_Elmt (Exchanged_Views);
7651 while Present (Next) loop
7652 if Full_View (Node (Next)) = E then
7660 end Has_Been_Exchanged;
7666 function Hash (F : Entity_Id) return HTable_Range is
7668 return HTable_Range (F mod HTable_Size);
7671 ------------------------
7672 -- Hide_Current_Scope --
7673 ------------------------
7675 procedure Hide_Current_Scope is
7676 C : constant Entity_Id := Current_Scope;
7680 Set_Is_Hidden_Open_Scope (C);
7682 E := First_Entity (C);
7683 while Present (E) loop
7684 if Is_Immediately_Visible (E) then
7685 Set_Is_Immediately_Visible (E, False);
7686 Append_Elmt (E, Hidden_Entities);
7692 -- Make the scope name invisible as well. This is necessary, but might
7693 -- conflict with calls to Rtsfind later on, in case the scope is a
7694 -- predefined one. There is no clean solution to this problem, so for
7695 -- now we depend on the user not redefining Standard itself in one of
7696 -- the parent units.
7698 if Is_Immediately_Visible (C) and then C /= Standard_Standard then
7699 Set_Is_Immediately_Visible (C, False);
7700 Append_Elmt (C, Hidden_Entities);
7703 end Hide_Current_Scope;
7709 procedure Init_Env is
7710 Saved : Instance_Env;
7713 Saved.Instantiated_Parent := Current_Instantiated_Parent;
7714 Saved.Exchanged_Views := Exchanged_Views;
7715 Saved.Hidden_Entities := Hidden_Entities;
7716 Saved.Current_Sem_Unit := Current_Sem_Unit;
7717 Saved.Parent_Unit_Visible := Parent_Unit_Visible;
7718 Saved.Instance_Parent_Unit := Instance_Parent_Unit;
7720 -- Save configuration switches. These may be reset if the unit is a
7721 -- predefined unit, and the current mode is not Ada 2005.
7723 Save_Opt_Config_Switches (Saved.Switches);
7725 Instance_Envs.Append (Saved);
7727 Exchanged_Views := New_Elmt_List;
7728 Hidden_Entities := New_Elmt_List;
7730 -- Make dummy entry for Instantiated parent. If generic unit is legal,
7731 -- this is set properly in Set_Instance_Env.
7733 Current_Instantiated_Parent :=
7734 (Current_Scope, Current_Scope, Assoc_Null);
7737 ------------------------------
7738 -- In_Same_Declarative_Part --
7739 ------------------------------
7741 function In_Same_Declarative_Part
7743 Inst : Node_Id) return Boolean
7745 Decls : constant Node_Id := Parent (F_Node);
7746 Nod : Node_Id := Parent (Inst);
7749 while Present (Nod) loop
7753 elsif Nkind_In (Nod, N_Subprogram_Body,
7755 N_Package_Declaration,
7762 elsif Nkind (Nod) = N_Subunit then
7763 Nod := Corresponding_Stub (Nod);
7765 elsif Nkind (Nod) = N_Compilation_Unit then
7769 Nod := Parent (Nod);
7774 end In_Same_Declarative_Part;
7776 ---------------------
7777 -- In_Main_Context --
7778 ---------------------
7780 function In_Main_Context (E : Entity_Id) return Boolean is
7786 if not Is_Compilation_Unit (E)
7787 or else Ekind (E) /= E_Package
7788 or else In_Private_Part (E)
7793 Context := Context_Items (Cunit (Main_Unit));
7795 Clause := First (Context);
7796 while Present (Clause) loop
7797 if Nkind (Clause) = N_With_Clause then
7798 Nam := Name (Clause);
7800 -- If the current scope is part of the context of the main unit,
7801 -- analysis of the corresponding with_clause is not complete, and
7802 -- the entity is not set. We use the Chars field directly, which
7803 -- might produce false positives in rare cases, but guarantees
7804 -- that we produce all the instance bodies we will need.
7806 if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
7807 or else (Nkind (Nam) = N_Selected_Component
7808 and then Chars (Selector_Name (Nam)) = Chars (E))
7818 end In_Main_Context;
7820 ---------------------
7821 -- Inherit_Context --
7822 ---------------------
7824 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
7825 Current_Context : List_Id;
7826 Current_Unit : Node_Id;
7835 if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
7837 -- The inherited context is attached to the enclosing compilation
7838 -- unit. This is either the main unit, or the declaration for the
7839 -- main unit (in case the instantiation appears within the package
7840 -- declaration and the main unit is its body).
7842 Current_Unit := Parent (Inst);
7843 while Present (Current_Unit)
7844 and then Nkind (Current_Unit) /= N_Compilation_Unit
7846 Current_Unit := Parent (Current_Unit);
7849 Current_Context := Context_Items (Current_Unit);
7851 Item := First (Context_Items (Parent (Gen_Decl)));
7852 while Present (Item) loop
7853 if Nkind (Item) = N_With_Clause then
7854 Lib_Unit := Library_Unit (Item);
7856 -- Take care to prevent direct cyclic with's
7858 if Lib_Unit /= Current_Unit then
7860 -- Do not add a unit if it is already in the context
7862 Clause := First (Current_Context);
7864 while Present (Clause) loop
7865 if Nkind (Clause) = N_With_Clause and then
7866 Library_Unit (Clause) = Lib_Unit
7876 New_I := New_Copy (Item);
7877 Set_Implicit_With (New_I, True);
7878 Set_Implicit_With_From_Instantiation (New_I, True);
7879 Append (New_I, Current_Context);
7887 end Inherit_Context;
7893 procedure Initialize is
7895 Generic_Renamings.Init;
7898 Generic_Renamings_HTable.Reset;
7899 Circularity_Detected := False;
7900 Exchanged_Views := No_Elist;
7901 Hidden_Entities := No_Elist;
7904 -------------------------------------
7905 -- Insert_Freeze_Node_For_Instance --
7906 -------------------------------------
7908 procedure Insert_Freeze_Node_For_Instance
7917 function Enclosing_Body (N : Node_Id) return Node_Id;
7918 -- Find enclosing package or subprogram body, if any. Freeze node may
7919 -- be placed at end of current declarative list if previous instance
7920 -- and current one have different enclosing bodies.
7922 function Previous_Instance (Gen : Entity_Id) return Entity_Id;
7923 -- Find the local instance, if any, that declares the generic that is
7924 -- being instantiated. If present, the freeze node for this instance
7925 -- must follow the freeze node for the previous instance.
7927 --------------------
7928 -- Enclosing_Body --
7929 --------------------
7931 function Enclosing_Body (N : Node_Id) return Node_Id is
7937 and then Nkind (Parent (P)) /= N_Compilation_Unit
7939 if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
7940 if Nkind (Parent (P)) = N_Subunit then
7941 return Corresponding_Stub (Parent (P));
7947 P := True_Parent (P);
7953 -----------------------
7954 -- Previous_Instance --
7955 -----------------------
7957 function Previous_Instance (Gen : Entity_Id) return Entity_Id is
7963 and then S /= Standard_Standard
7965 if Is_Generic_Instance (S)
7966 and then In_Same_Source_Unit (S, N)
7975 end Previous_Instance;
7977 -- Start of processing for Insert_Freeze_Node_For_Instance
7980 if not Is_List_Member (F_Node) then
7982 Decls := List_Containing (N);
7983 Inst := Entity (F_Node);
7984 Par_N := Parent (Decls);
7986 -- When processing a subprogram instantiation, utilize the actual
7987 -- subprogram instantiation rather than its package wrapper as it
7988 -- carries all the context information.
7990 if Is_Wrapper_Package (Inst) then
7991 Inst := Related_Instance (Inst);
7994 -- If this is a package instance, check whether the generic is
7995 -- declared in a previous instance and the current instance is
7996 -- not within the previous one.
7998 if Present (Generic_Parent (Parent (Inst)))
7999 and then Is_In_Main_Unit (N)
8002 Enclosing_N : constant Node_Id := Enclosing_Body (N);
8003 Par_I : constant Entity_Id :=
8005 (Generic_Parent (Parent (Inst)));
8010 and then Earlier (N, Freeze_Node (Par_I))
8012 Scop := Scope (Inst);
8014 -- If the current instance is within the one that contains
8015 -- the generic, the freeze node for the current one must
8016 -- appear in the current declarative part. Ditto, if the
8017 -- current instance is within another package instance or
8018 -- within a body that does not enclose the current instance.
8019 -- In these three cases the freeze node of the previous
8020 -- instance is not relevant.
8022 while Present (Scop)
8023 and then Scop /= Standard_Standard
8025 exit when Scop = Par_I
8027 (Is_Generic_Instance (Scop)
8028 and then Scope_Depth (Scop) > Scope_Depth (Par_I));
8029 Scop := Scope (Scop);
8032 -- Previous instance encloses current instance
8034 if Scop = Par_I then
8037 -- If the next node is a source body we must freeze in
8038 -- the current scope as well.
8040 elsif Present (Next (N))
8041 and then Nkind_In (Next (N),
8042 N_Subprogram_Body, N_Package_Body)
8043 and then Comes_From_Source (Next (N))
8047 -- Current instance is within an unrelated instance
8049 elsif Is_Generic_Instance (Scop) then
8052 -- Current instance is within an unrelated body
8054 elsif Present (Enclosing_N)
8055 and then Enclosing_N /= Enclosing_Body (Par_I)
8060 Insert_After (Freeze_Node (Par_I), F_Node);
8067 -- When the instantiation occurs in a package declaration, append the
8068 -- freeze node to the private declarations (if any).
8070 if Nkind (Par_N) = N_Package_Specification
8071 and then Decls = Visible_Declarations (Par_N)
8072 and then Present (Private_Declarations (Par_N))
8073 and then not Is_Empty_List (Private_Declarations (Par_N))
8075 Decls := Private_Declarations (Par_N);
8076 Decl := First (Decls);
8079 -- Determine the proper freeze point of a package instantiation. We
8080 -- adhere to the general rule of a package or subprogram body causing
8081 -- freezing of anything before it in the same declarative region. In
8082 -- this case, the proper freeze point of a package instantiation is
8083 -- before the first source body which follows, or before a stub. This
8084 -- ensures that entities coming from the instance are already frozen
8085 -- and usable in source bodies.
8087 if Nkind (Par_N) /= N_Package_Declaration
8088 and then Ekind (Inst) = E_Package
8089 and then Is_Generic_Instance (Inst)
8091 not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
8093 while Present (Decl) loop
8094 if (Nkind (Decl) in N_Unit_Body
8096 Nkind (Decl) in N_Body_Stub)
8097 and then Comes_From_Source (Decl)
8099 Insert_Before (Decl, F_Node);
8107 -- In a package declaration, or if no previous body, insert at end
8110 Set_Sloc (F_Node, Sloc (Last (Decls)));
8111 Insert_After (Last (Decls), F_Node);
8113 end Insert_Freeze_Node_For_Instance;
8119 procedure Install_Body
8120 (Act_Body : Node_Id;
8125 Act_Id : constant Entity_Id := Corresponding_Spec (Act_Body);
8126 Act_Unit : constant Node_Id := Unit (Cunit (Get_Source_Unit (N)));
8127 Gen_Id : constant Entity_Id := Corresponding_Spec (Gen_Body);
8128 Par : constant Entity_Id := Scope (Gen_Id);
8129 Gen_Unit : constant Node_Id :=
8130 Unit (Cunit (Get_Source_Unit (Gen_Decl)));
8131 Orig_Body : Node_Id := Gen_Body;
8133 Body_Unit : Node_Id;
8135 Must_Delay : Boolean;
8137 function Enclosing_Subp (Id : Entity_Id) return Entity_Id;
8138 -- Find subprogram (if any) that encloses instance and/or generic body
8140 function True_Sloc (N : Node_Id) return Source_Ptr;
8141 -- If the instance is nested inside a generic unit, the Sloc of the
8142 -- instance indicates the place of the original definition, not the
8143 -- point of the current enclosing instance. Pending a better usage of
8144 -- Slocs to indicate instantiation places, we determine the place of
8145 -- origin of a node by finding the maximum sloc of any ancestor node.
8146 -- Why is this not equivalent to Top_Level_Location ???
8148 --------------------
8149 -- Enclosing_Subp --
8150 --------------------
8152 function Enclosing_Subp (Id : Entity_Id) return Entity_Id is
8157 while Scop /= Standard_Standard
8158 and then not Is_Overloadable (Scop)
8160 Scop := Scope (Scop);
8170 function True_Sloc (N : Node_Id) return Source_Ptr is
8177 while Present (N1) and then N1 /= Act_Unit loop
8178 if Sloc (N1) > Res then
8188 -- Start of processing for Install_Body
8191 -- If the body is a subunit, the freeze point is the corresponding stub
8192 -- in the current compilation, not the subunit itself.
8194 if Nkind (Parent (Gen_Body)) = N_Subunit then
8195 Orig_Body := Corresponding_Stub (Parent (Gen_Body));
8197 Orig_Body := Gen_Body;
8200 Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8202 -- If the instantiation and the generic definition appear in the same
8203 -- package declaration, this is an early instantiation. If they appear
8204 -- in the same declarative part, it is an early instantiation only if
8205 -- the generic body appears textually later, and the generic body is
8206 -- also in the main unit.
8208 -- If instance is nested within a subprogram, and the generic body is
8209 -- not, the instance is delayed because the enclosing body is. If
8210 -- instance and body are within the same scope, or the same sub-
8211 -- program body, indicate explicitly that the instance is delayed.
8214 (Gen_Unit = Act_Unit
8215 and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8216 N_Generic_Package_Declaration)
8217 or else (Gen_Unit = Body_Unit
8218 and then True_Sloc (N) < Sloc (Orig_Body)))
8219 and then Is_In_Main_Unit (Gen_Unit)
8220 and then (Scope (Act_Id) = Scope (Gen_Id)
8222 Enclosing_Subp (Act_Id) = Enclosing_Subp (Gen_Id)));
8224 -- If this is an early instantiation, the freeze node is placed after
8225 -- the generic body. Otherwise, if the generic appears in an instance,
8226 -- we cannot freeze the current instance until the outer one is frozen.
8227 -- This is only relevant if the current instance is nested within some
8228 -- inner scope not itself within the outer instance. If this scope is
8229 -- a package body in the same declarative part as the outer instance,
8230 -- then that body needs to be frozen after the outer instance. Finally,
8231 -- if no delay is needed, we place the freeze node at the end of the
8232 -- current declarative part.
8234 if Expander_Active then
8235 Ensure_Freeze_Node (Act_Id);
8236 F_Node := Freeze_Node (Act_Id);
8239 Insert_After (Orig_Body, F_Node);
8241 elsif Is_Generic_Instance (Par)
8242 and then Present (Freeze_Node (Par))
8243 and then Scope (Act_Id) /= Par
8245 -- Freeze instance of inner generic after instance of enclosing
8248 if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8250 -- Handle the following case:
8252 -- package Parent_Inst is new ...
8255 -- procedure P ... -- this body freezes Parent_Inst
8257 -- package Inst is new ...
8259 -- In this particular scenario, the freeze node for Inst must
8260 -- be inserted in the same manner as that of Parent_Inst -
8261 -- before the next source body or at the end of the declarative
8262 -- list (body not available). If body P did not exist and
8263 -- Parent_Inst was frozen after Inst, either by a body
8264 -- following Inst or at the end of the declarative region, the
8265 -- freeze node for Inst must be inserted after that of
8266 -- Parent_Inst. This relation is established by comparing the
8267 -- Slocs of Parent_Inst freeze node and Inst.
8269 if List_Containing (Get_Package_Instantiation_Node (Par)) =
8271 and then Sloc (Freeze_Node (Par)) < Sloc (N)
8273 Insert_Freeze_Node_For_Instance (N, F_Node);
8275 Insert_After (Freeze_Node (Par), F_Node);
8278 -- Freeze package enclosing instance of inner generic after
8279 -- instance of enclosing generic.
8281 elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8282 and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8285 Enclosing : Entity_Id;
8288 Enclosing := Corresponding_Spec (Parent (N));
8290 if No (Enclosing) then
8291 Enclosing := Defining_Entity (Parent (N));
8294 Insert_Freeze_Node_For_Instance (N, F_Node);
8295 Ensure_Freeze_Node (Enclosing);
8297 if not Is_List_Member (Freeze_Node (Enclosing)) then
8299 -- The enclosing context is a subunit, insert the freeze
8300 -- node after the stub.
8302 if Nkind (Parent (Parent (N))) = N_Subunit then
8303 Insert_Freeze_Node_For_Instance
8304 (Corresponding_Stub (Parent (Parent (N))),
8305 Freeze_Node (Enclosing));
8307 -- The enclosing context is a package with a stub body
8308 -- which has already been replaced by the real body.
8309 -- Insert the freeze node after the actual body.
8311 elsif Ekind (Enclosing) = E_Package
8312 and then Present (Body_Entity (Enclosing))
8313 and then Was_Originally_Stub
8314 (Parent (Body_Entity (Enclosing)))
8316 Insert_Freeze_Node_For_Instance
8317 (Parent (Body_Entity (Enclosing)),
8318 Freeze_Node (Enclosing));
8320 -- The parent instance has been frozen before the body of
8321 -- the enclosing package, insert the freeze node after
8324 elsif List_Containing (Freeze_Node (Par)) =
8325 List_Containing (Parent (N))
8326 and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8328 Insert_Freeze_Node_For_Instance
8329 (Parent (N), Freeze_Node (Enclosing));
8333 (Freeze_Node (Par), Freeze_Node (Enclosing));
8339 Insert_Freeze_Node_For_Instance (N, F_Node);
8343 Insert_Freeze_Node_For_Instance (N, F_Node);
8347 Set_Is_Frozen (Act_Id);
8348 Insert_Before (N, Act_Body);
8349 Mark_Rewrite_Insertion (Act_Body);
8352 -----------------------------
8353 -- Install_Formal_Packages --
8354 -----------------------------
8356 procedure Install_Formal_Packages (Par : Entity_Id) is
8359 Gen_E : Entity_Id := Empty;
8362 E := First_Entity (Par);
8364 -- If we are installing an instance parent, locate the formal packages
8365 -- of its generic parent.
8367 if Is_Generic_Instance (Par) then
8368 Gen := Generic_Parent (Specification (Unit_Declaration_Node (Par)));
8369 Gen_E := First_Entity (Gen);
8372 while Present (E) loop
8373 if Ekind (E) = E_Package
8374 and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8376 -- If this is the renaming for the parent instance, done
8378 if Renamed_Object (E) = Par then
8381 -- The visibility of a formal of an enclosing generic is already
8384 elsif Denotes_Formal_Package (E) then
8387 elsif Present (Associated_Formal_Package (E)) then
8388 Check_Generic_Actuals (Renamed_Object (E), True);
8389 Set_Is_Hidden (E, False);
8391 -- Find formal package in generic unit that corresponds to
8392 -- (instance of) formal package in instance.
8394 while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8395 Next_Entity (Gen_E);
8398 if Present (Gen_E) then
8399 Map_Formal_Package_Entities (Gen_E, E);
8405 if Present (Gen_E) then
8406 Next_Entity (Gen_E);
8409 end Install_Formal_Packages;
8411 --------------------
8412 -- Install_Parent --
8413 --------------------
8415 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8416 Ancestors : constant Elist_Id := New_Elmt_List;
8417 S : constant Entity_Id := Current_Scope;
8418 Inst_Par : Entity_Id;
8419 First_Par : Entity_Id;
8420 Inst_Node : Node_Id;
8421 Gen_Par : Entity_Id;
8422 First_Gen : Entity_Id;
8425 procedure Install_Noninstance_Specs (Par : Entity_Id);
8426 -- Install the scopes of noninstance parent units ending with Par
8428 procedure Install_Spec (Par : Entity_Id);
8429 -- The child unit is within the declarative part of the parent, so the
8430 -- declarations within the parent are immediately visible.
8432 -------------------------------
8433 -- Install_Noninstance_Specs --
8434 -------------------------------
8436 procedure Install_Noninstance_Specs (Par : Entity_Id) is
8439 and then Par /= Standard_Standard
8440 and then not In_Open_Scopes (Par)
8442 Install_Noninstance_Specs (Scope (Par));
8445 end Install_Noninstance_Specs;
8451 procedure Install_Spec (Par : Entity_Id) is
8452 Spec : constant Node_Id :=
8453 Specification (Unit_Declaration_Node (Par));
8456 -- If this parent of the child instance is a top-level unit,
8457 -- then record the unit and its visibility for later resetting in
8458 -- Remove_Parent. We exclude units that are generic instances, as we
8459 -- only want to record this information for the ultimate top-level
8460 -- noninstance parent (is that always correct???).
8462 if Scope (Par) = Standard_Standard
8463 and then not Is_Generic_Instance (Par)
8465 Parent_Unit_Visible := Is_Immediately_Visible (Par);
8466 Instance_Parent_Unit := Par;
8469 -- Open the parent scope and make it and its declarations visible.
8470 -- If this point is not within a body, then only the visible
8471 -- declarations should be made visible, and installation of the
8472 -- private declarations is deferred until the appropriate point
8473 -- within analysis of the spec being instantiated (see the handling
8474 -- of parent visibility in Analyze_Package_Specification). This is
8475 -- relaxed in the case where the parent unit is Ada.Tags, to avoid
8476 -- private view problems that occur when compiling instantiations of
8477 -- a generic child of that package (Generic_Dispatching_Constructor).
8478 -- If the instance freezes a tagged type, inlinings of operations
8479 -- from Ada.Tags may need the full view of type Tag. If inlining took
8480 -- proper account of establishing visibility of inlined subprograms'
8481 -- parents then it should be possible to remove this
8482 -- special check. ???
8485 Set_Is_Immediately_Visible (Par);
8486 Install_Visible_Declarations (Par);
8487 Set_Use (Visible_Declarations (Spec));
8489 if In_Body or else Is_RTU (Par, Ada_Tags) then
8490 Install_Private_Declarations (Par);
8491 Set_Use (Private_Declarations (Spec));
8495 -- Start of processing for Install_Parent
8498 -- We need to install the parent instance to compile the instantiation
8499 -- of the child, but the child instance must appear in the current
8500 -- scope. Given that we cannot place the parent above the current scope
8501 -- in the scope stack, we duplicate the current scope and unstack both
8502 -- after the instantiation is complete.
8504 -- If the parent is itself the instantiation of a child unit, we must
8505 -- also stack the instantiation of its parent, and so on. Each such
8506 -- ancestor is the prefix of the name in a prior instantiation.
8508 -- If this is a nested instance, the parent unit itself resolves to
8509 -- a renaming of the parent instance, whose declaration we need.
8511 -- Finally, the parent may be a generic (not an instance) when the
8512 -- child unit appears as a formal package.
8516 if Present (Renamed_Entity (Inst_Par)) then
8517 Inst_Par := Renamed_Entity (Inst_Par);
8520 First_Par := Inst_Par;
8523 Generic_Parent (Specification (Unit_Declaration_Node (Inst_Par)));
8525 First_Gen := Gen_Par;
8527 while Present (Gen_Par)
8528 and then Is_Child_Unit (Gen_Par)
8530 -- Load grandparent instance as well
8532 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
8534 if Nkind (Name (Inst_Node)) = N_Expanded_Name then
8535 Inst_Par := Entity (Prefix (Name (Inst_Node)));
8537 if Present (Renamed_Entity (Inst_Par)) then
8538 Inst_Par := Renamed_Entity (Inst_Par);
8543 (Specification (Unit_Declaration_Node (Inst_Par)));
8545 if Present (Gen_Par) then
8546 Prepend_Elmt (Inst_Par, Ancestors);
8549 -- Parent is not the name of an instantiation
8551 Install_Noninstance_Specs (Inst_Par);
8562 if Present (First_Gen) then
8563 Append_Elmt (First_Par, Ancestors);
8565 Install_Noninstance_Specs (First_Par);
8568 if not Is_Empty_Elmt_List (Ancestors) then
8569 Elmt := First_Elmt (Ancestors);
8570 while Present (Elmt) loop
8571 Install_Spec (Node (Elmt));
8572 Install_Formal_Packages (Node (Elmt));
8582 -------------------------------
8583 -- Install_Hidden_Primitives --
8584 -------------------------------
8586 procedure Install_Hidden_Primitives
8587 (Prims_List : in out Elist_Id;
8592 List : Elist_Id := No_Elist;
8593 Prim_G_Elmt : Elmt_Id;
8594 Prim_A_Elmt : Elmt_Id;
8599 -- No action needed in case of serious errors because we cannot trust
8600 -- in the order of primitives
8602 if Serious_Errors_Detected > 0 then
8605 -- No action possible if we don't have available the list of primitive
8609 or else not Is_Record_Type (Gen_T)
8610 or else not Is_Tagged_Type (Gen_T)
8611 or else not Is_Record_Type (Act_T)
8612 or else not Is_Tagged_Type (Act_T)
8616 -- There is no need to handle interface types since their primitives
8619 elsif Is_Interface (Gen_T) then
8623 Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
8625 if not Is_Class_Wide_Type (Act_T) then
8626 Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
8628 Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
8632 -- Skip predefined primitives in the generic formal
8634 while Present (Prim_G_Elmt)
8635 and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
8637 Next_Elmt (Prim_G_Elmt);
8640 -- Skip predefined primitives in the generic actual
8642 while Present (Prim_A_Elmt)
8643 and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
8645 Next_Elmt (Prim_A_Elmt);
8648 exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
8650 Prim_G := Node (Prim_G_Elmt);
8651 Prim_A := Node (Prim_A_Elmt);
8653 -- There is no need to handle interface primitives because their
8654 -- primitives are not hidden
8656 exit when Present (Interface_Alias (Prim_G));
8658 -- Here we install one hidden primitive
8660 if Chars (Prim_G) /= Chars (Prim_A)
8661 and then Has_Suffix (Prim_A, 'P')
8662 and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
8664 Set_Chars (Prim_A, Chars (Prim_G));
8666 if List = No_Elist then
8667 List := New_Elmt_List;
8670 Append_Elmt (Prim_A, List);
8673 Next_Elmt (Prim_A_Elmt);
8674 Next_Elmt (Prim_G_Elmt);
8677 -- Append the elements to the list of temporarily visible primitives
8678 -- avoiding duplicates.
8680 if Present (List) then
8681 if No (Prims_List) then
8682 Prims_List := New_Elmt_List;
8685 Elmt := First_Elmt (List);
8686 while Present (Elmt) loop
8687 Append_Unique_Elmt (Node (Elmt), Prims_List);
8691 end Install_Hidden_Primitives;
8693 -------------------------------
8694 -- Restore_Hidden_Primitives --
8695 -------------------------------
8697 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
8698 Prim_Elmt : Elmt_Id;
8702 if Prims_List /= No_Elist then
8703 Prim_Elmt := First_Elmt (Prims_List);
8704 while Present (Prim_Elmt) loop
8705 Prim := Node (Prim_Elmt);
8706 Set_Chars (Prim, Add_Suffix (Prim, 'P'));
8707 Next_Elmt (Prim_Elmt);
8710 Prims_List := No_Elist;
8712 end Restore_Hidden_Primitives;
8714 --------------------------------
8715 -- Instantiate_Formal_Package --
8716 --------------------------------
8718 function Instantiate_Formal_Package
8721 Analyzed_Formal : Node_Id) return List_Id
8723 Loc : constant Source_Ptr := Sloc (Actual);
8724 Actual_Pack : Entity_Id;
8725 Formal_Pack : Entity_Id;
8726 Gen_Parent : Entity_Id;
8729 Parent_Spec : Node_Id;
8731 procedure Find_Matching_Actual
8733 Act : in out Entity_Id);
8734 -- We need to associate each formal entity in the formal package with
8735 -- the corresponding entity in the actual package. The actual package
8736 -- has been analyzed and possibly expanded, and as a result there is
8737 -- no one-to-one correspondence between the two lists (for example,
8738 -- the actual may include subtypes, itypes, and inherited primitive
8739 -- operations, interspersed among the renaming declarations for the
8740 -- actuals) . We retrieve the corresponding actual by name because each
8741 -- actual has the same name as the formal, and they do appear in the
8744 function Get_Formal_Entity (N : Node_Id) return Entity_Id;
8745 -- Retrieve entity of defining entity of generic formal parameter.
8746 -- Only the declarations of formals need to be considered when
8747 -- linking them to actuals, but the declarative list may include
8748 -- internal entities generated during analysis, and those are ignored.
8750 procedure Match_Formal_Entity
8751 (Formal_Node : Node_Id;
8752 Formal_Ent : Entity_Id;
8753 Actual_Ent : Entity_Id);
8754 -- Associates the formal entity with the actual. In the case where
8755 -- Formal_Ent is a formal package, this procedure iterates through all
8756 -- of its formals and enters associations between the actuals occurring
8757 -- in the formal package's corresponding actual package (given by
8758 -- Actual_Ent) and the formal package's formal parameters. This
8759 -- procedure recurses if any of the parameters is itself a package.
8761 function Is_Instance_Of
8762 (Act_Spec : Entity_Id;
8763 Gen_Anc : Entity_Id) return Boolean;
8764 -- The actual can be an instantiation of a generic within another
8765 -- instance, in which case there is no direct link from it to the
8766 -- original generic ancestor. In that case, we recognize that the
8767 -- ultimate ancestor is the same by examining names and scopes.
8769 procedure Process_Nested_Formal (Formal : Entity_Id);
8770 -- If the current formal is declared with a box, its own formals are
8771 -- visible in the instance, as they were in the generic, and their
8772 -- Hidden flag must be reset. If some of these formals are themselves
8773 -- packages declared with a box, the processing must be recursive.
8775 --------------------------
8776 -- Find_Matching_Actual --
8777 --------------------------
8779 procedure Find_Matching_Actual
8781 Act : in out Entity_Id)
8783 Formal_Ent : Entity_Id;
8786 case Nkind (Original_Node (F)) is
8787 when N_Formal_Object_Declaration |
8788 N_Formal_Type_Declaration =>
8789 Formal_Ent := Defining_Identifier (F);
8791 while Chars (Act) /= Chars (Formal_Ent) loop
8795 when N_Formal_Subprogram_Declaration |
8796 N_Formal_Package_Declaration |
8797 N_Package_Declaration |
8798 N_Generic_Package_Declaration =>
8799 Formal_Ent := Defining_Entity (F);
8801 while Chars (Act) /= Chars (Formal_Ent) loop
8806 raise Program_Error;
8808 end Find_Matching_Actual;
8810 -------------------------
8811 -- Match_Formal_Entity --
8812 -------------------------
8814 procedure Match_Formal_Entity
8815 (Formal_Node : Node_Id;
8816 Formal_Ent : Entity_Id;
8817 Actual_Ent : Entity_Id)
8819 Act_Pkg : Entity_Id;
8822 Set_Instance_Of (Formal_Ent, Actual_Ent);
8824 if Ekind (Actual_Ent) = E_Package then
8826 -- Record associations for each parameter
8828 Act_Pkg := Actual_Ent;
8831 A_Ent : Entity_Id := First_Entity (Act_Pkg);
8840 -- Retrieve the actual given in the formal package declaration
8842 Actual := Entity (Name (Original_Node (Formal_Node)));
8844 -- The actual in the formal package declaration may be a
8845 -- renamed generic package, in which case we want to retrieve
8846 -- the original generic in order to traverse its formal part.
8848 if Present (Renamed_Entity (Actual)) then
8849 Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
8851 Gen_Decl := Unit_Declaration_Node (Actual);
8854 Formals := Generic_Formal_Declarations (Gen_Decl);
8856 if Present (Formals) then
8857 F_Node := First_Non_Pragma (Formals);
8862 while Present (A_Ent)
8863 and then Present (F_Node)
8864 and then A_Ent /= First_Private_Entity (Act_Pkg)
8866 F_Ent := Get_Formal_Entity (F_Node);
8868 if Present (F_Ent) then
8870 -- This is a formal of the original package. Record
8871 -- association and recurse.
8873 Find_Matching_Actual (F_Node, A_Ent);
8874 Match_Formal_Entity (F_Node, F_Ent, A_Ent);
8875 Next_Entity (A_Ent);
8878 Next_Non_Pragma (F_Node);
8882 end Match_Formal_Entity;
8884 -----------------------
8885 -- Get_Formal_Entity --
8886 -----------------------
8888 function Get_Formal_Entity (N : Node_Id) return Entity_Id is
8889 Kind : constant Node_Kind := Nkind (Original_Node (N));
8892 when N_Formal_Object_Declaration =>
8893 return Defining_Identifier (N);
8895 when N_Formal_Type_Declaration =>
8896 return Defining_Identifier (N);
8898 when N_Formal_Subprogram_Declaration =>
8899 return Defining_Unit_Name (Specification (N));
8901 when N_Formal_Package_Declaration =>
8902 return Defining_Identifier (Original_Node (N));
8904 when N_Generic_Package_Declaration =>
8905 return Defining_Identifier (Original_Node (N));
8907 -- All other declarations are introduced by semantic analysis and
8908 -- have no match in the actual.
8913 end Get_Formal_Entity;
8915 --------------------
8916 -- Is_Instance_Of --
8917 --------------------
8919 function Is_Instance_Of
8920 (Act_Spec : Entity_Id;
8921 Gen_Anc : Entity_Id) return Boolean
8923 Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
8926 if No (Gen_Par) then
8929 -- Simplest case: the generic parent of the actual is the formal
8931 elsif Gen_Par = Gen_Anc then
8934 elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
8937 -- The actual may be obtained through several instantiations. Its
8938 -- scope must itself be an instance of a generic declared in the
8939 -- same scope as the formal. Any other case is detected above.
8941 elsif not Is_Generic_Instance (Scope (Gen_Par)) then
8945 return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
8949 ---------------------------
8950 -- Process_Nested_Formal --
8951 ---------------------------
8953 procedure Process_Nested_Formal (Formal : Entity_Id) is
8957 if Present (Associated_Formal_Package (Formal))
8958 and then Box_Present (Parent (Associated_Formal_Package (Formal)))
8960 Ent := First_Entity (Formal);
8961 while Present (Ent) loop
8962 Set_Is_Hidden (Ent, False);
8963 Set_Is_Visible_Formal (Ent);
8964 Set_Is_Potentially_Use_Visible
8965 (Ent, Is_Potentially_Use_Visible (Formal));
8967 if Ekind (Ent) = E_Package then
8968 exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
8969 Process_Nested_Formal (Ent);
8975 end Process_Nested_Formal;
8977 -- Start of processing for Instantiate_Formal_Package
8982 if not Is_Entity_Name (Actual)
8983 or else Ekind (Entity (Actual)) /= E_Package
8986 ("expect package instance to instantiate formal", Actual);
8987 Abandon_Instantiation (Actual);
8988 raise Program_Error;
8991 Actual_Pack := Entity (Actual);
8992 Set_Is_Instantiated (Actual_Pack);
8994 -- The actual may be a renamed package, or an outer generic formal
8995 -- package whose instantiation is converted into a renaming.
8997 if Present (Renamed_Object (Actual_Pack)) then
8998 Actual_Pack := Renamed_Object (Actual_Pack);
9001 if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
9002 Gen_Parent := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
9003 Formal_Pack := Defining_Identifier (Analyzed_Formal);
9006 Generic_Parent (Specification (Analyzed_Formal));
9008 Defining_Unit_Name (Specification (Analyzed_Formal));
9011 if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
9012 Parent_Spec := Specification (Unit_Declaration_Node (Actual_Pack));
9014 Parent_Spec := Parent (Actual_Pack);
9017 if Gen_Parent = Any_Id then
9019 ("previous error in declaration of formal package", Actual);
9020 Abandon_Instantiation (Actual);
9023 Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
9029 ("actual parameter must be instance of&", Actual, Gen_Parent);
9030 Abandon_Instantiation (Actual);
9033 Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
9034 Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
9037 Make_Package_Renaming_Declaration (Loc,
9038 Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
9039 Name => New_Reference_To (Actual_Pack, Loc));
9041 Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
9042 Defining_Identifier (Formal));
9043 Decls := New_List (Nod);
9045 -- If the formal F has a box, then the generic declarations are
9046 -- visible in the generic G. In an instance of G, the corresponding
9047 -- entities in the actual for F (which are the actuals for the
9048 -- instantiation of the generic that F denotes) must also be made
9049 -- visible for analysis of the current instance. On exit from the
9050 -- current instance, those entities are made private again. If the
9051 -- actual is currently in use, these entities are also use-visible.
9053 -- The loop through the actual entities also steps through the formal
9054 -- entities and enters associations from formals to actuals into the
9055 -- renaming map. This is necessary to properly handle checking of
9056 -- actual parameter associations for later formals that depend on
9057 -- actuals declared in the formal package.
9059 -- In Ada 2005, partial parametrization requires that we make visible
9060 -- the actuals corresponding to formals that were defaulted in the
9061 -- formal package. There formals are identified because they remain
9062 -- formal generics within the formal package, rather than being
9063 -- renamings of the actuals supplied.
9066 Gen_Decl : constant Node_Id :=
9067 Unit_Declaration_Node (Gen_Parent);
9068 Formals : constant List_Id :=
9069 Generic_Formal_Declarations (Gen_Decl);
9071 Actual_Ent : Entity_Id;
9072 Actual_Of_Formal : Node_Id;
9073 Formal_Node : Node_Id;
9074 Formal_Ent : Entity_Id;
9077 if Present (Formals) then
9078 Formal_Node := First_Non_Pragma (Formals);
9080 Formal_Node := Empty;
9083 Actual_Ent := First_Entity (Actual_Pack);
9085 First (Visible_Declarations (Specification (Analyzed_Formal)));
9086 while Present (Actual_Ent)
9087 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9089 if Present (Formal_Node) then
9090 Formal_Ent := Get_Formal_Entity (Formal_Node);
9092 if Present (Formal_Ent) then
9093 Find_Matching_Actual (Formal_Node, Actual_Ent);
9095 (Formal_Node, Formal_Ent, Actual_Ent);
9097 -- We iterate at the same time over the actuals of the
9098 -- local package created for the formal, to determine
9099 -- which one of the formals of the original generic were
9100 -- defaulted in the formal. The corresponding actual
9101 -- entities are visible in the enclosing instance.
9103 if Box_Present (Formal)
9105 (Present (Actual_Of_Formal)
9108 (Get_Formal_Entity (Actual_Of_Formal)))
9110 Set_Is_Hidden (Actual_Ent, False);
9111 Set_Is_Visible_Formal (Actual_Ent);
9112 Set_Is_Potentially_Use_Visible
9113 (Actual_Ent, In_Use (Actual_Pack));
9115 if Ekind (Actual_Ent) = E_Package then
9116 Process_Nested_Formal (Actual_Ent);
9120 Set_Is_Hidden (Actual_Ent);
9121 Set_Is_Potentially_Use_Visible (Actual_Ent, False);
9125 Next_Non_Pragma (Formal_Node);
9126 Next (Actual_Of_Formal);
9129 -- No further formals to match, but the generic part may
9130 -- contain inherited operation that are not hidden in the
9131 -- enclosing instance.
9133 Next_Entity (Actual_Ent);
9137 -- Inherited subprograms generated by formal derived types are
9138 -- also visible if the types are.
9140 Actual_Ent := First_Entity (Actual_Pack);
9141 while Present (Actual_Ent)
9142 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9144 if Is_Overloadable (Actual_Ent)
9146 Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
9148 not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
9150 Set_Is_Hidden (Actual_Ent, False);
9151 Set_Is_Potentially_Use_Visible
9152 (Actual_Ent, In_Use (Actual_Pack));
9155 Next_Entity (Actual_Ent);
9159 -- If the formal is not declared with a box, reanalyze it as an
9160 -- abbreviated instantiation, to verify the matching rules of 12.7.
9161 -- The actual checks are performed after the generic associations
9162 -- have been analyzed, to guarantee the same visibility for this
9163 -- instantiation and for the actuals.
9165 -- In Ada 2005, the generic associations for the formal can include
9166 -- defaulted parameters. These are ignored during check. This
9167 -- internal instantiation is removed from the tree after conformance
9168 -- checking, because it contains formal declarations for those
9169 -- defaulted parameters, and those should not reach the back-end.
9171 if not Box_Present (Formal) then
9173 I_Pack : constant Entity_Id :=
9174 Make_Temporary (Sloc (Actual), 'P');
9177 Set_Is_Internal (I_Pack);
9180 Make_Package_Instantiation (Sloc (Actual),
9181 Defining_Unit_Name => I_Pack,
9184 (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
9185 Generic_Associations =>
9186 Generic_Associations (Formal)));
9192 end Instantiate_Formal_Package;
9194 -----------------------------------
9195 -- Instantiate_Formal_Subprogram --
9196 -----------------------------------
9198 function Instantiate_Formal_Subprogram
9201 Analyzed_Formal : Node_Id) return Node_Id
9204 Formal_Sub : constant Entity_Id :=
9205 Defining_Unit_Name (Specification (Formal));
9206 Analyzed_S : constant Entity_Id :=
9207 Defining_Unit_Name (Specification (Analyzed_Formal));
9208 Decl_Node : Node_Id;
9212 function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9213 -- If the generic is a child unit, the parent has been installed on the
9214 -- scope stack, but a default subprogram cannot resolve to something
9215 -- on the parent because that parent is not really part of the visible
9216 -- context (it is there to resolve explicit local entities). If the
9217 -- default has resolved in this way, we remove the entity from immediate
9218 -- visibility and analyze the node again to emit an error message or
9219 -- find another visible candidate.
9221 procedure Valid_Actual_Subprogram (Act : Node_Id);
9222 -- Perform legality check and raise exception on failure
9224 -----------------------
9225 -- From_Parent_Scope --
9226 -----------------------
9228 function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9229 Gen_Scope : Node_Id;
9232 Gen_Scope := Scope (Analyzed_S);
9233 while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9234 if Scope (Subp) = Scope (Gen_Scope) then
9238 Gen_Scope := Scope (Gen_Scope);
9242 end From_Parent_Scope;
9244 -----------------------------
9245 -- Valid_Actual_Subprogram --
9246 -----------------------------
9248 procedure Valid_Actual_Subprogram (Act : Node_Id) is
9252 if Is_Entity_Name (Act) then
9253 Act_E := Entity (Act);
9255 elsif Nkind (Act) = N_Selected_Component
9256 and then Is_Entity_Name (Selector_Name (Act))
9258 Act_E := Entity (Selector_Name (Act));
9264 if (Present (Act_E) and then Is_Overloadable (Act_E))
9265 or else Nkind_In (Act, N_Attribute_Reference,
9266 N_Indexed_Component,
9267 N_Character_Literal,
9268 N_Explicit_Dereference)
9274 ("expect subprogram or entry name in instantiation of&",
9275 Instantiation_Node, Formal_Sub);
9276 Abandon_Instantiation (Instantiation_Node);
9278 end Valid_Actual_Subprogram;
9280 -- Start of processing for Instantiate_Formal_Subprogram
9283 New_Spec := New_Copy_Tree (Specification (Formal));
9285 -- The tree copy has created the proper instantiation sloc for the
9286 -- new specification. Use this location for all other constructed
9289 Loc := Sloc (Defining_Unit_Name (New_Spec));
9291 -- Create new entity for the actual (New_Copy_Tree does not)
9293 Set_Defining_Unit_Name
9294 (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9296 -- Create new entities for the each of the formals in the
9297 -- specification of the renaming declaration built for the actual.
9299 if Present (Parameter_Specifications (New_Spec)) then
9303 F := First (Parameter_Specifications (New_Spec));
9304 while Present (F) loop
9305 Set_Defining_Identifier (F,
9306 Make_Defining_Identifier (Sloc (F),
9307 Chars => Chars (Defining_Identifier (F))));
9313 -- Find entity of actual. If the actual is an attribute reference, it
9314 -- cannot be resolved here (its formal is missing) but is handled
9315 -- instead in Attribute_Renaming. If the actual is overloaded, it is
9316 -- fully resolved subsequently, when the renaming declaration for the
9317 -- formal is analyzed. If it is an explicit dereference, resolve the
9318 -- prefix but not the actual itself, to prevent interpretation as call.
9320 if Present (Actual) then
9321 Loc := Sloc (Actual);
9322 Set_Sloc (New_Spec, Loc);
9324 if Nkind (Actual) = N_Operator_Symbol then
9325 Find_Direct_Name (Actual);
9327 elsif Nkind (Actual) = N_Explicit_Dereference then
9328 Analyze (Prefix (Actual));
9330 elsif Nkind (Actual) /= N_Attribute_Reference then
9334 Valid_Actual_Subprogram (Actual);
9337 elsif Present (Default_Name (Formal)) then
9338 if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9339 N_Selected_Component,
9340 N_Indexed_Component,
9341 N_Character_Literal)
9342 and then Present (Entity (Default_Name (Formal)))
9344 Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9346 Nam := New_Copy (Default_Name (Formal));
9347 Set_Sloc (Nam, Loc);
9350 elsif Box_Present (Formal) then
9352 -- Actual is resolved at the point of instantiation. Create an
9353 -- identifier or operator with the same name as the formal.
9355 if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9356 Nam := Make_Operator_Symbol (Loc,
9357 Chars => Chars (Formal_Sub),
9358 Strval => No_String);
9360 Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9363 elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9364 and then Null_Present (Specification (Formal))
9366 -- Generate null body for procedure, for use in the instance
9369 Make_Subprogram_Body (Loc,
9370 Specification => New_Spec,
9371 Declarations => New_List,
9372 Handled_Statement_Sequence =>
9373 Make_Handled_Sequence_Of_Statements (Loc,
9374 Statements => New_List (Make_Null_Statement (Loc))));
9376 Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9380 Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9382 ("missing actual&", Instantiation_Node, Formal_Sub);
9384 ("\in instantiation of & declared#",
9385 Instantiation_Node, Scope (Analyzed_S));
9386 Abandon_Instantiation (Instantiation_Node);
9390 Make_Subprogram_Renaming_Declaration (Loc,
9391 Specification => New_Spec,
9394 -- If we do not have an actual and the formal specified <> then set to
9395 -- get proper default.
9397 if No (Actual) and then Box_Present (Formal) then
9398 Set_From_Default (Decl_Node);
9401 -- Gather possible interpretations for the actual before analyzing the
9402 -- instance. If overloaded, it will be resolved when analyzing the
9403 -- renaming declaration.
9405 if Box_Present (Formal)
9406 and then No (Actual)
9410 if Is_Child_Unit (Scope (Analyzed_S))
9411 and then Present (Entity (Nam))
9413 if not Is_Overloaded (Nam) then
9414 if From_Parent_Scope (Entity (Nam)) then
9415 Set_Is_Immediately_Visible (Entity (Nam), False);
9416 Set_Entity (Nam, Empty);
9417 Set_Etype (Nam, Empty);
9420 Set_Is_Immediately_Visible (Entity (Nam));
9429 Get_First_Interp (Nam, I, It);
9430 while Present (It.Nam) loop
9431 if From_Parent_Scope (It.Nam) then
9435 Get_Next_Interp (I, It);
9442 -- The generic instantiation freezes the actual. This can only be done
9443 -- once the actual is resolved, in the analysis of the renaming
9444 -- declaration. To make the formal subprogram entity available, we set
9445 -- Corresponding_Formal_Spec to point to the formal subprogram entity.
9446 -- This is also needed in Analyze_Subprogram_Renaming for the processing
9447 -- of formal abstract subprograms.
9449 Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9451 -- We cannot analyze the renaming declaration, and thus find the actual,
9452 -- until all the actuals are assembled in the instance. For subsequent
9453 -- checks of other actuals, indicate the node that will hold the
9454 -- instance of this formal.
9456 Set_Instance_Of (Analyzed_S, Nam);
9458 if Nkind (Actual) = N_Selected_Component
9459 and then Is_Task_Type (Etype (Prefix (Actual)))
9460 and then not Is_Frozen (Etype (Prefix (Actual)))
9462 -- The renaming declaration will create a body, which must appear
9463 -- outside of the instantiation, We move the renaming declaration
9464 -- out of the instance, and create an additional renaming inside,
9465 -- to prevent freezing anomalies.
9468 Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9471 Set_Defining_Unit_Name (New_Spec, Anon_Id);
9472 Insert_Before (Instantiation_Node, Decl_Node);
9473 Analyze (Decl_Node);
9475 -- Now create renaming within the instance
9478 Make_Subprogram_Renaming_Declaration (Loc,
9479 Specification => New_Copy_Tree (New_Spec),
9480 Name => New_Occurrence_Of (Anon_Id, Loc));
9482 Set_Defining_Unit_Name (Specification (Decl_Node),
9483 Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9488 end Instantiate_Formal_Subprogram;
9490 ------------------------
9491 -- Instantiate_Object --
9492 ------------------------
9494 function Instantiate_Object
9497 Analyzed_Formal : Node_Id) return List_Id
9499 Gen_Obj : constant Entity_Id := Defining_Identifier (Formal);
9500 A_Gen_Obj : constant Entity_Id :=
9501 Defining_Identifier (Analyzed_Formal);
9502 Acc_Def : Node_Id := Empty;
9503 Act_Assoc : constant Node_Id := Parent (Actual);
9504 Actual_Decl : Node_Id := Empty;
9505 Decl_Node : Node_Id;
9508 List : constant List_Id := New_List;
9509 Loc : constant Source_Ptr := Sloc (Actual);
9510 Orig_Ftyp : constant Entity_Id := Etype (A_Gen_Obj);
9511 Subt_Decl : Node_Id := Empty;
9512 Subt_Mark : Node_Id := Empty;
9515 if Present (Subtype_Mark (Formal)) then
9516 Subt_Mark := Subtype_Mark (Formal);
9518 Check_Access_Definition (Formal);
9519 Acc_Def := Access_Definition (Formal);
9522 -- Sloc for error message on missing actual
9524 Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
9526 if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
9527 Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
9530 Set_Parent (List, Parent (Actual));
9534 if Out_Present (Formal) then
9536 -- An IN OUT generic actual must be a name. The instantiation is a
9537 -- renaming declaration. The actual is the name being renamed. We
9538 -- use the actual directly, rather than a copy, because it is not
9539 -- used further in the list of actuals, and because a copy or a use
9540 -- of relocate_node is incorrect if the instance is nested within a
9541 -- generic. In order to simplify ASIS searches, the Generic_Parent
9542 -- field links the declaration to the generic association.
9547 Instantiation_Node, Gen_Obj);
9549 ("\in instantiation of & declared#",
9550 Instantiation_Node, Scope (A_Gen_Obj));
9551 Abandon_Instantiation (Instantiation_Node);
9554 if Present (Subt_Mark) then
9556 Make_Object_Renaming_Declaration (Loc,
9557 Defining_Identifier => New_Copy (Gen_Obj),
9558 Subtype_Mark => New_Copy_Tree (Subt_Mark),
9561 else pragma Assert (Present (Acc_Def));
9563 Make_Object_Renaming_Declaration (Loc,
9564 Defining_Identifier => New_Copy (Gen_Obj),
9565 Access_Definition => New_Copy_Tree (Acc_Def),
9569 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9571 -- The analysis of the actual may produce Insert_Action nodes, so
9572 -- the declaration must have a context in which to attach them.
9574 Append (Decl_Node, List);
9577 -- Return if the analysis of the actual reported some error
9579 if Etype (Actual) = Any_Type then
9583 -- This check is performed here because Analyze_Object_Renaming will
9584 -- not check it when Comes_From_Source is False. Note though that the
9585 -- check for the actual being the name of an object will be performed
9586 -- in Analyze_Object_Renaming.
9588 if Is_Object_Reference (Actual)
9589 and then Is_Dependent_Component_Of_Mutable_Object (Actual)
9592 ("illegal discriminant-dependent component for in out parameter",
9596 -- The actual has to be resolved in order to check that it is a
9597 -- variable (due to cases such as F (1), where F returns access to
9598 -- an array, and for overloaded prefixes).
9600 Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
9602 -- If the type of the formal is not itself a formal, and the current
9603 -- unit is a child unit, the formal type must be declared in a
9604 -- parent, and must be retrieved by visibility.
9607 and then Is_Generic_Unit (Scope (Ftyp))
9608 and then Is_Child_Unit (Scope (A_Gen_Obj))
9611 Temp : constant Node_Id :=
9612 New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
9614 Set_Entity (Temp, Empty);
9616 Ftyp := Entity (Temp);
9620 if Is_Private_Type (Ftyp)
9621 and then not Is_Private_Type (Etype (Actual))
9622 and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
9623 or else Base_Type (Etype (Actual)) = Ftyp)
9625 -- If the actual has the type of the full view of the formal, or
9626 -- else a non-private subtype of the formal, then the visibility
9627 -- of the formal type has changed. Add to the actuals a subtype
9628 -- declaration that will force the exchange of views in the body
9629 -- of the instance as well.
9632 Make_Subtype_Declaration (Loc,
9633 Defining_Identifier => Make_Temporary (Loc, 'P'),
9634 Subtype_Indication => New_Occurrence_Of (Ftyp, Loc));
9636 Prepend (Subt_Decl, List);
9638 Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
9639 Exchange_Declarations (Ftyp);
9642 Resolve (Actual, Ftyp);
9644 if not Denotes_Variable (Actual) then
9646 ("actual for& must be a variable", Actual, Gen_Obj);
9648 elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
9650 -- Ada 2005 (AI-423): For a generic formal object of mode in out,
9651 -- the type of the actual shall resolve to a specific anonymous
9654 if Ada_Version < Ada_2005
9656 Ekind (Base_Type (Ftyp)) /=
9657 E_Anonymous_Access_Type
9659 Ekind (Base_Type (Etype (Actual))) /=
9660 E_Anonymous_Access_Type
9662 Error_Msg_NE ("type of actual does not match type of&",
9667 Note_Possible_Modification (Actual, Sure => True);
9669 -- Check for instantiation of atomic/volatile actual for
9670 -- non-atomic/volatile formal (RM C.6 (12)).
9672 if Is_Atomic_Object (Actual)
9673 and then not Is_Atomic (Orig_Ftyp)
9676 ("cannot instantiate non-atomic formal object " &
9677 "with atomic actual", Actual);
9679 elsif Is_Volatile_Object (Actual)
9680 and then not Is_Volatile (Orig_Ftyp)
9683 ("cannot instantiate non-volatile formal object " &
9684 "with volatile actual", Actual);
9687 -- Formal in-parameter
9690 -- The instantiation of a generic formal in-parameter is constant
9691 -- declaration. The actual is the expression for that declaration.
9693 if Present (Actual) then
9694 if Present (Subt_Mark) then
9696 else pragma Assert (Present (Acc_Def));
9701 Make_Object_Declaration (Loc,
9702 Defining_Identifier => New_Copy (Gen_Obj),
9703 Constant_Present => True,
9704 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9705 Object_Definition => New_Copy_Tree (Def),
9706 Expression => Actual);
9708 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9710 -- A generic formal object of a tagged type is defined to be
9711 -- aliased so the new constant must also be treated as aliased.
9713 if Is_Tagged_Type (Etype (A_Gen_Obj)) then
9714 Set_Aliased_Present (Decl_Node);
9717 Append (Decl_Node, List);
9719 -- No need to repeat (pre-)analysis of some expression nodes
9720 -- already handled in Preanalyze_Actuals.
9722 if Nkind (Actual) /= N_Allocator then
9725 -- Return if the analysis of the actual reported some error
9727 if Etype (Actual) = Any_Type then
9733 Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
9737 Typ := Get_Instance_Of (Formal_Type);
9739 Freeze_Before (Instantiation_Node, Typ);
9741 -- If the actual is an aggregate, perform name resolution on
9742 -- its components (the analysis of an aggregate does not do it)
9743 -- to capture local names that may be hidden if the generic is
9746 if Nkind (Actual) = N_Aggregate then
9747 Preanalyze_And_Resolve (Actual, Typ);
9750 if Is_Limited_Type (Typ)
9751 and then not OK_For_Limited_Init (Typ, Actual)
9754 ("initialization not allowed for limited types", Actual);
9755 Explain_Limited_Type (Typ, Actual);
9759 elsif Present (Default_Expression (Formal)) then
9761 -- Use default to construct declaration
9763 if Present (Subt_Mark) then
9765 else pragma Assert (Present (Acc_Def));
9770 Make_Object_Declaration (Sloc (Formal),
9771 Defining_Identifier => New_Copy (Gen_Obj),
9772 Constant_Present => True,
9773 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9774 Object_Definition => New_Copy (Def),
9775 Expression => New_Copy_Tree
9776 (Default_Expression (Formal)));
9778 Append (Decl_Node, List);
9779 Set_Analyzed (Expression (Decl_Node), False);
9784 Instantiation_Node, Gen_Obj);
9785 Error_Msg_NE ("\in instantiation of & declared#",
9786 Instantiation_Node, Scope (A_Gen_Obj));
9788 if Is_Scalar_Type (Etype (A_Gen_Obj)) then
9790 -- Create dummy constant declaration so that instance can be
9791 -- analyzed, to minimize cascaded visibility errors.
9793 if Present (Subt_Mark) then
9795 else pragma Assert (Present (Acc_Def));
9800 Make_Object_Declaration (Loc,
9801 Defining_Identifier => New_Copy (Gen_Obj),
9802 Constant_Present => True,
9803 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9804 Object_Definition => New_Copy (Def),
9806 Make_Attribute_Reference (Sloc (Gen_Obj),
9807 Attribute_Name => Name_First,
9808 Prefix => New_Copy (Def)));
9810 Append (Decl_Node, List);
9813 Abandon_Instantiation (Instantiation_Node);
9818 if Nkind (Actual) in N_Has_Entity then
9819 Actual_Decl := Parent (Entity (Actual));
9822 -- Ada 2005 (AI-423): For a formal object declaration with a null
9823 -- exclusion or an access definition that has a null exclusion: If the
9824 -- actual matching the formal object declaration denotes a generic
9825 -- formal object of another generic unit G, and the instantiation
9826 -- containing the actual occurs within the body of G or within the body
9827 -- of a generic unit declared within the declarative region of G, then
9828 -- the declaration of the formal object of G must have a null exclusion.
9829 -- Otherwise, the subtype of the actual matching the formal object
9830 -- declaration shall exclude null.
9832 if Ada_Version >= Ada_2005
9833 and then Present (Actual_Decl)
9835 Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
9836 N_Object_Declaration)
9837 and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
9838 and then not Has_Null_Exclusion (Actual_Decl)
9839 and then Has_Null_Exclusion (Analyzed_Formal)
9841 Error_Msg_Sloc := Sloc (Analyzed_Formal);
9843 ("actual must exclude null to match generic formal#", Actual);
9847 end Instantiate_Object;
9849 ------------------------------
9850 -- Instantiate_Package_Body --
9851 ------------------------------
9853 procedure Instantiate_Package_Body
9854 (Body_Info : Pending_Body_Info;
9855 Inlined_Body : Boolean := False;
9856 Body_Optional : Boolean := False)
9858 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
9859 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
9860 Loc : constant Source_Ptr := Sloc (Inst_Node);
9862 Gen_Id : constant Node_Id := Name (Inst_Node);
9863 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
9864 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
9865 Act_Spec : constant Node_Id := Specification (Act_Decl);
9866 Act_Decl_Id : constant Entity_Id := Defining_Entity (Act_Spec);
9868 Act_Body_Name : Node_Id;
9870 Gen_Body_Id : Node_Id;
9872 Act_Body_Id : Entity_Id;
9874 Parent_Installed : Boolean := False;
9875 Save_Style_Check : constant Boolean := Style_Check;
9877 Par_Ent : Entity_Id := Empty;
9878 Par_Vis : Boolean := False;
9880 Vis_Prims_List : Elist_Id := No_Elist;
9881 -- List of primitives made temporarily visible in the instantiation
9882 -- to match the visibility of the formal type
9885 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9887 -- The instance body may already have been processed, as the parent of
9888 -- another instance that is inlined (Load_Parent_Of_Generic).
9890 if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
9894 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
9896 -- Re-establish the state of information on which checks are suppressed.
9897 -- This information was set in Body_Info at the point of instantiation,
9898 -- and now we restore it so that the instance is compiled using the
9899 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
9901 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
9902 Scope_Suppress := Body_Info.Scope_Suppress;
9903 Opt.Ada_Version := Body_Info.Version;
9904 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
9905 Restore_Warnings (Body_Info.Warnings);
9907 if No (Gen_Body_Id) then
9908 Load_Parent_Of_Generic
9909 (Inst_Node, Specification (Gen_Decl), Body_Optional);
9910 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9913 -- Establish global variable for sloc adjustment and for error recovery
9915 Instantiation_Node := Inst_Node;
9917 if Present (Gen_Body_Id) then
9918 Save_Env (Gen_Unit, Act_Decl_Id);
9919 Style_Check := False;
9920 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
9922 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
9924 Create_Instantiation_Source
9925 (Inst_Node, Gen_Body_Id, False, S_Adjustment);
9929 (Original_Node (Gen_Body), Empty, Instantiating => True);
9931 -- Build new name (possibly qualified) for body declaration
9933 Act_Body_Id := New_Copy (Act_Decl_Id);
9935 -- Some attributes of spec entity are not inherited by body entity
9937 Set_Handler_Records (Act_Body_Id, No_List);
9939 if Nkind (Defining_Unit_Name (Act_Spec)) =
9940 N_Defining_Program_Unit_Name
9943 Make_Defining_Program_Unit_Name (Loc,
9944 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
9945 Defining_Identifier => Act_Body_Id);
9947 Act_Body_Name := Act_Body_Id;
9950 Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
9952 Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
9953 Check_Generic_Actuals (Act_Decl_Id, False);
9955 -- Install primitives hidden at the point of the instantiation but
9956 -- visible when processing the generic formals
9962 E := First_Entity (Act_Decl_Id);
9963 while Present (E) loop
9965 and then Is_Generic_Actual_Type (E)
9966 and then Is_Tagged_Type (E)
9968 Install_Hidden_Primitives
9969 (Prims_List => Vis_Prims_List,
9970 Gen_T => Generic_Parent_Type (Parent (E)),
9978 -- If it is a child unit, make the parent instance (which is an
9979 -- instance of the parent of the generic) visible. The parent
9980 -- instance is the prefix of the name of the generic unit.
9982 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
9983 and then Nkind (Gen_Id) = N_Expanded_Name
9985 Par_Ent := Entity (Prefix (Gen_Id));
9986 Par_Vis := Is_Immediately_Visible (Par_Ent);
9987 Install_Parent (Par_Ent, In_Body => True);
9988 Parent_Installed := True;
9990 elsif Is_Child_Unit (Gen_Unit) then
9991 Par_Ent := Scope (Gen_Unit);
9992 Par_Vis := Is_Immediately_Visible (Par_Ent);
9993 Install_Parent (Par_Ent, In_Body => True);
9994 Parent_Installed := True;
9997 -- If the instantiation is a library unit, and this is the main unit,
9998 -- then build the resulting compilation unit nodes for the instance.
9999 -- If this is a compilation unit but it is not the main unit, then it
10000 -- is the body of a unit in the context, that is being compiled
10001 -- because it is encloses some inlined unit or another generic unit
10002 -- being instantiated. In that case, this body is not part of the
10003 -- current compilation, and is not attached to the tree, but its
10004 -- parent must be set for analysis.
10006 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10008 -- Replace instance node with body of instance, and create new
10009 -- node for corresponding instance declaration.
10011 Build_Instance_Compilation_Unit_Nodes
10012 (Inst_Node, Act_Body, Act_Decl);
10013 Analyze (Inst_Node);
10015 if Parent (Inst_Node) = Cunit (Main_Unit) then
10017 -- If the instance is a child unit itself, then set the scope
10018 -- of the expanded body to be the parent of the instantiation
10019 -- (ensuring that the fully qualified name will be generated
10020 -- for the elaboration subprogram).
10022 if Nkind (Defining_Unit_Name (Act_Spec)) =
10023 N_Defining_Program_Unit_Name
10026 (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
10030 -- Case where instantiation is not a library unit
10033 -- If this is an early instantiation, i.e. appears textually
10034 -- before the corresponding body and must be elaborated first,
10035 -- indicate that the body instance is to be delayed.
10037 Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
10039 -- Now analyze the body. We turn off all checks if this is an
10040 -- internal unit, since there is no reason to have checks on for
10041 -- any predefined run-time library code. All such code is designed
10042 -- to be compiled with checks off.
10044 -- Note that we do NOT apply this criterion to children of GNAT
10045 -- (or on VMS, children of DEC). The latter units must suppress
10046 -- checks explicitly if this is needed.
10048 if Is_Predefined_File_Name
10049 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
10051 Analyze (Act_Body, Suppress => All_Checks);
10053 Analyze (Act_Body);
10057 Inherit_Context (Gen_Body, Inst_Node);
10059 -- Remove the parent instances if they have been placed on the scope
10060 -- stack to compile the body.
10062 if Parent_Installed then
10063 Remove_Parent (In_Body => True);
10065 -- Restore the previous visibility of the parent
10067 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10070 Restore_Hidden_Primitives (Vis_Prims_List);
10071 Restore_Private_Views (Act_Decl_Id);
10073 -- Remove the current unit from visibility if this is an instance
10074 -- that is not elaborated on the fly for inlining purposes.
10076 if not Inlined_Body then
10077 Set_Is_Immediately_Visible (Act_Decl_Id, False);
10081 Style_Check := Save_Style_Check;
10083 -- If we have no body, and the unit requires a body, then complain. This
10084 -- complaint is suppressed if we have detected other errors (since a
10085 -- common reason for missing the body is that it had errors).
10086 -- In CodePeer mode, a warning has been emitted already, no need for
10087 -- further messages.
10089 elsif Unit_Requires_Body (Gen_Unit)
10090 and then not Body_Optional
10092 if CodePeer_Mode then
10095 elsif Serious_Errors_Detected = 0 then
10097 ("cannot find body of generic package &", Inst_Node, Gen_Unit);
10099 -- Don't attempt to perform any cleanup actions if some other error
10100 -- was already detected, since this can cause blowups.
10106 -- Case of package that does not need a body
10109 -- If the instantiation of the declaration is a library unit, rewrite
10110 -- the original package instantiation as a package declaration in the
10111 -- compilation unit node.
10113 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10114 Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
10115 Rewrite (Inst_Node, Act_Decl);
10117 -- Generate elaboration entity, in case spec has elaboration code.
10118 -- This cannot be done when the instance is analyzed, because it
10119 -- is not known yet whether the body exists.
10121 Set_Elaboration_Entity_Required (Act_Decl_Id, False);
10122 Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
10124 -- If the instantiation is not a library unit, then append the
10125 -- declaration to the list of implicitly generated entities, unless
10126 -- it is already a list member which means that it was already
10129 elsif not Is_List_Member (Act_Decl) then
10130 Mark_Rewrite_Insertion (Act_Decl);
10131 Insert_Before (Inst_Node, Act_Decl);
10135 Expander_Mode_Restore;
10136 end Instantiate_Package_Body;
10138 ---------------------------------
10139 -- Instantiate_Subprogram_Body --
10140 ---------------------------------
10142 procedure Instantiate_Subprogram_Body
10143 (Body_Info : Pending_Body_Info;
10144 Body_Optional : Boolean := False)
10146 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10147 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10148 Loc : constant Source_Ptr := Sloc (Inst_Node);
10149 Gen_Id : constant Node_Id := Name (Inst_Node);
10150 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10151 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10152 Anon_Id : constant Entity_Id :=
10153 Defining_Unit_Name (Specification (Act_Decl));
10154 Pack_Id : constant Entity_Id :=
10155 Defining_Unit_Name (Parent (Act_Decl));
10157 Gen_Body : Node_Id;
10158 Gen_Body_Id : Node_Id;
10159 Act_Body : Node_Id;
10160 Pack_Body : Node_Id;
10161 Prev_Formal : Entity_Id;
10162 Ret_Expr : Node_Id;
10163 Unit_Renaming : Node_Id;
10165 Parent_Installed : Boolean := False;
10167 Saved_Style_Check : constant Boolean := Style_Check;
10168 Saved_Warnings : constant Warning_Record := Save_Warnings;
10170 Par_Ent : Entity_Id := Empty;
10171 Par_Vis : Boolean := False;
10174 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10176 -- Subprogram body may have been created already because of an inline
10177 -- pragma, or because of multiple elaborations of the enclosing package
10178 -- when several instances of the subprogram appear in the main unit.
10180 if Present (Corresponding_Body (Act_Decl)) then
10184 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10186 -- Re-establish the state of information on which checks are suppressed.
10187 -- This information was set in Body_Info at the point of instantiation,
10188 -- and now we restore it so that the instance is compiled using the
10189 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10191 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10192 Scope_Suppress := Body_Info.Scope_Suppress;
10193 Opt.Ada_Version := Body_Info.Version;
10194 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10195 Restore_Warnings (Body_Info.Warnings);
10197 if No (Gen_Body_Id) then
10199 -- For imported generic subprogram, no body to compile, complete
10200 -- the spec entity appropriately.
10202 if Is_Imported (Gen_Unit) then
10203 Set_Is_Imported (Anon_Id);
10204 Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10205 Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10206 Set_Convention (Anon_Id, Convention (Gen_Unit));
10207 Set_Has_Completion (Anon_Id);
10210 -- For other cases, compile the body
10213 Load_Parent_Of_Generic
10214 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10215 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10219 Instantiation_Node := Inst_Node;
10221 if Present (Gen_Body_Id) then
10222 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10224 if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10226 -- Either body is not present, or context is non-expanding, as
10227 -- when compiling a subunit. Mark the instance as completed, and
10228 -- diagnose a missing body when needed.
10231 and then Operating_Mode = Generate_Code
10234 ("missing proper body for instantiation", Gen_Body);
10237 Set_Has_Completion (Anon_Id);
10241 Save_Env (Gen_Unit, Anon_Id);
10242 Style_Check := False;
10243 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10244 Create_Instantiation_Source
10252 (Original_Node (Gen_Body), Empty, Instantiating => True);
10254 -- Create proper defining name for the body, to correspond to
10255 -- the one in the spec.
10257 Set_Defining_Unit_Name (Specification (Act_Body),
10258 Make_Defining_Identifier
10259 (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10260 Set_Corresponding_Spec (Act_Body, Anon_Id);
10261 Set_Has_Completion (Anon_Id);
10262 Check_Generic_Actuals (Pack_Id, False);
10264 -- Generate a reference to link the visible subprogram instance to
10265 -- the generic body, which for navigation purposes is the only
10266 -- available source for the instance.
10269 (Related_Instance (Pack_Id),
10270 Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10272 -- If it is a child unit, make the parent instance (which is an
10273 -- instance of the parent of the generic) visible. The parent
10274 -- instance is the prefix of the name of the generic unit.
10276 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10277 and then Nkind (Gen_Id) = N_Expanded_Name
10279 Par_Ent := Entity (Prefix (Gen_Id));
10280 Par_Vis := Is_Immediately_Visible (Par_Ent);
10281 Install_Parent (Par_Ent, In_Body => True);
10282 Parent_Installed := True;
10284 elsif Is_Child_Unit (Gen_Unit) then
10285 Par_Ent := Scope (Gen_Unit);
10286 Par_Vis := Is_Immediately_Visible (Par_Ent);
10287 Install_Parent (Par_Ent, In_Body => True);
10288 Parent_Installed := True;
10291 -- Inside its body, a reference to the generic unit is a reference
10292 -- to the instance. The corresponding renaming is the first
10293 -- declaration in the body.
10296 Make_Subprogram_Renaming_Declaration (Loc,
10298 Copy_Generic_Node (
10299 Specification (Original_Node (Gen_Body)),
10301 Instantiating => True),
10302 Name => New_Occurrence_Of (Anon_Id, Loc));
10304 -- If there is a formal subprogram with the same name as the unit
10305 -- itself, do not add this renaming declaration. This is a temporary
10306 -- fix for one ACVC test. ???
10308 Prev_Formal := First_Entity (Pack_Id);
10309 while Present (Prev_Formal) loop
10310 if Chars (Prev_Formal) = Chars (Gen_Unit)
10311 and then Is_Overloadable (Prev_Formal)
10316 Next_Entity (Prev_Formal);
10319 if Present (Prev_Formal) then
10320 Decls := New_List (Act_Body);
10322 Decls := New_List (Unit_Renaming, Act_Body);
10325 -- The subprogram body is placed in the body of a dummy package body,
10326 -- whose spec contains the subprogram declaration as well as the
10327 -- renaming declarations for the generic parameters.
10329 Pack_Body := Make_Package_Body (Loc,
10330 Defining_Unit_Name => New_Copy (Pack_Id),
10331 Declarations => Decls);
10333 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10335 -- If the instantiation is a library unit, then build resulting
10336 -- compilation unit nodes for the instance. The declaration of
10337 -- the enclosing package is the grandparent of the subprogram
10338 -- declaration. First replace the instantiation node as the unit
10339 -- of the corresponding compilation.
10341 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10342 if Parent (Inst_Node) = Cunit (Main_Unit) then
10343 Set_Unit (Parent (Inst_Node), Inst_Node);
10344 Build_Instance_Compilation_Unit_Nodes
10345 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10346 Analyze (Inst_Node);
10348 Set_Parent (Pack_Body, Parent (Inst_Node));
10349 Analyze (Pack_Body);
10353 Insert_Before (Inst_Node, Pack_Body);
10354 Mark_Rewrite_Insertion (Pack_Body);
10355 Analyze (Pack_Body);
10357 if Expander_Active then
10358 Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10362 Inherit_Context (Gen_Body, Inst_Node);
10364 Restore_Private_Views (Pack_Id, False);
10366 if Parent_Installed then
10367 Remove_Parent (In_Body => True);
10369 -- Restore the previous visibility of the parent
10371 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10375 Style_Check := Saved_Style_Check;
10376 Restore_Warnings (Saved_Warnings);
10378 -- Body not found. Error was emitted already. If there were no previous
10379 -- errors, this may be an instance whose scope is a premature instance.
10380 -- In that case we must insure that the (legal) program does raise
10381 -- program error if executed. We generate a subprogram body for this
10382 -- purpose. See DEC ac30vso.
10384 -- Should not reference proprietary DEC tests in comments ???
10386 elsif Serious_Errors_Detected = 0
10387 and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
10389 if Body_Optional then
10392 elsif Ekind (Anon_Id) = E_Procedure then
10394 Make_Subprogram_Body (Loc,
10396 Make_Procedure_Specification (Loc,
10397 Defining_Unit_Name =>
10398 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10399 Parameter_Specifications =>
10401 (Parameter_Specifications (Parent (Anon_Id)))),
10403 Declarations => Empty_List,
10404 Handled_Statement_Sequence =>
10405 Make_Handled_Sequence_Of_Statements (Loc,
10408 Make_Raise_Program_Error (Loc,
10410 PE_Access_Before_Elaboration))));
10414 Make_Raise_Program_Error (Loc,
10415 Reason => PE_Access_Before_Elaboration);
10417 Set_Etype (Ret_Expr, (Etype (Anon_Id)));
10418 Set_Analyzed (Ret_Expr);
10421 Make_Subprogram_Body (Loc,
10423 Make_Function_Specification (Loc,
10424 Defining_Unit_Name =>
10425 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10426 Parameter_Specifications =>
10428 (Parameter_Specifications (Parent (Anon_Id))),
10429 Result_Definition =>
10430 New_Occurrence_Of (Etype (Anon_Id), Loc)),
10432 Declarations => Empty_List,
10433 Handled_Statement_Sequence =>
10434 Make_Handled_Sequence_Of_Statements (Loc,
10437 (Make_Simple_Return_Statement (Loc, Ret_Expr))));
10440 Pack_Body := Make_Package_Body (Loc,
10441 Defining_Unit_Name => New_Copy (Pack_Id),
10442 Declarations => New_List (Act_Body));
10444 Insert_After (Inst_Node, Pack_Body);
10445 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10446 Analyze (Pack_Body);
10449 Expander_Mode_Restore;
10450 end Instantiate_Subprogram_Body;
10452 ----------------------
10453 -- Instantiate_Type --
10454 ----------------------
10456 function Instantiate_Type
10459 Analyzed_Formal : Node_Id;
10460 Actual_Decls : List_Id) return List_Id
10462 Gen_T : constant Entity_Id := Defining_Identifier (Formal);
10463 A_Gen_T : constant Entity_Id :=
10464 Defining_Identifier (Analyzed_Formal);
10465 Ancestor : Entity_Id := Empty;
10466 Def : constant Node_Id := Formal_Type_Definition (Formal);
10468 Decl_Node : Node_Id;
10469 Decl_Nodes : List_Id;
10473 procedure Validate_Array_Type_Instance;
10474 procedure Validate_Access_Subprogram_Instance;
10475 procedure Validate_Access_Type_Instance;
10476 procedure Validate_Derived_Type_Instance;
10477 procedure Validate_Derived_Interface_Type_Instance;
10478 procedure Validate_Discriminated_Formal_Type;
10479 procedure Validate_Interface_Type_Instance;
10480 procedure Validate_Private_Type_Instance;
10481 procedure Validate_Incomplete_Type_Instance;
10482 -- These procedures perform validation tests for the named case.
10483 -- Validate_Discriminated_Formal_Type is shared by formal private
10484 -- types and Ada 2012 formal incomplete types.
10486 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
10487 -- Check that base types are the same and that the subtypes match
10488 -- statically. Used in several of the above.
10490 --------------------
10491 -- Subtypes_Match --
10492 --------------------
10494 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
10495 T : constant Entity_Id := Get_Instance_Of (Gen_T);
10498 -- Some detailed comments would be useful here ???
10500 return ((Base_Type (T) = Act_T
10501 or else Base_Type (T) = Base_Type (Act_T))
10502 and then Subtypes_Statically_Match (T, Act_T))
10504 or else (Is_Class_Wide_Type (Gen_T)
10505 and then Is_Class_Wide_Type (Act_T)
10506 and then Subtypes_Match
10507 (Get_Instance_Of (Root_Type (Gen_T)),
10508 Root_Type (Act_T)))
10511 (Ekind_In (Gen_T, E_Anonymous_Access_Subprogram_Type,
10512 E_Anonymous_Access_Type)
10513 and then Ekind (Act_T) = Ekind (Gen_T)
10514 and then Subtypes_Statically_Match
10515 (Designated_Type (Gen_T), Designated_Type (Act_T)));
10516 end Subtypes_Match;
10518 -----------------------------------------
10519 -- Validate_Access_Subprogram_Instance --
10520 -----------------------------------------
10522 procedure Validate_Access_Subprogram_Instance is
10524 if not Is_Access_Type (Act_T)
10525 or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
10528 ("expect access type in instantiation of &", Actual, Gen_T);
10529 Abandon_Instantiation (Actual);
10532 -- According to AI05-288, actuals for access_to_subprograms must be
10533 -- subtype conformant with the generic formal. Previous to AI05-288
10534 -- only mode conformance was required.
10536 -- This is a binding interpretation that applies to previous versions
10537 -- of the language, but for now we retain the milder check in order
10538 -- to preserve ACATS tests. These will be protested eventually ???
10540 if Ada_Version < Ada_2012 then
10541 Check_Mode_Conformant
10542 (Designated_Type (Act_T),
10543 Designated_Type (A_Gen_T),
10548 Check_Subtype_Conformant
10549 (Designated_Type (Act_T),
10550 Designated_Type (A_Gen_T),
10555 if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
10556 if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
10558 ("protected access type not allowed for formal &",
10562 elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
10564 ("expect protected access type for formal &",
10567 end Validate_Access_Subprogram_Instance;
10569 -----------------------------------
10570 -- Validate_Access_Type_Instance --
10571 -----------------------------------
10573 procedure Validate_Access_Type_Instance is
10574 Desig_Type : constant Entity_Id :=
10575 Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
10576 Desig_Act : Entity_Id;
10579 if not Is_Access_Type (Act_T) then
10581 ("expect access type in instantiation of &", Actual, Gen_T);
10582 Abandon_Instantiation (Actual);
10585 if Is_Access_Constant (A_Gen_T) then
10586 if not Is_Access_Constant (Act_T) then
10588 ("actual type must be access-to-constant type", Actual);
10589 Abandon_Instantiation (Actual);
10592 if Is_Access_Constant (Act_T) then
10594 ("actual type must be access-to-variable type", Actual);
10595 Abandon_Instantiation (Actual);
10597 elsif Ekind (A_Gen_T) = E_General_Access_Type
10598 and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
10600 Error_Msg_N -- CODEFIX
10601 ("actual must be general access type!", Actual);
10602 Error_Msg_NE -- CODEFIX
10603 ("add ALL to }!", Actual, Act_T);
10604 Abandon_Instantiation (Actual);
10608 -- The designated subtypes, that is to say the subtypes introduced
10609 -- by an access type declaration (and not by a subtype declaration)
10612 Desig_Act := Designated_Type (Base_Type (Act_T));
10614 -- The designated type may have been introduced through a limited_
10615 -- with clause, in which case retrieve the non-limited view. This
10616 -- applies to incomplete types as well as to class-wide types.
10618 if From_With_Type (Desig_Act) then
10619 Desig_Act := Available_View (Desig_Act);
10622 if not Subtypes_Match
10623 (Desig_Type, Desig_Act) then
10625 ("designated type of actual does not match that of formal &",
10627 Abandon_Instantiation (Actual);
10629 elsif Is_Access_Type (Designated_Type (Act_T))
10630 and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
10632 Is_Constrained (Designated_Type (Desig_Type))
10635 ("designated type of actual does not match that of formal &",
10637 Abandon_Instantiation (Actual);
10640 -- Ada 2005: null-exclusion indicators of the two types must agree
10642 if Can_Never_Be_Null (A_Gen_T) /= Can_Never_Be_Null (Act_T) then
10644 ("non null exclusion of actual and formal & do not match",
10647 end Validate_Access_Type_Instance;
10649 ----------------------------------
10650 -- Validate_Array_Type_Instance --
10651 ----------------------------------
10653 procedure Validate_Array_Type_Instance is
10658 function Formal_Dimensions return Int;
10659 -- Count number of dimensions in array type formal
10661 -----------------------
10662 -- Formal_Dimensions --
10663 -----------------------
10665 function Formal_Dimensions return Int is
10670 if Nkind (Def) = N_Constrained_Array_Definition then
10671 Index := First (Discrete_Subtype_Definitions (Def));
10673 Index := First (Subtype_Marks (Def));
10676 while Present (Index) loop
10678 Next_Index (Index);
10682 end Formal_Dimensions;
10684 -- Start of processing for Validate_Array_Type_Instance
10687 if not Is_Array_Type (Act_T) then
10689 ("expect array type in instantiation of &", Actual, Gen_T);
10690 Abandon_Instantiation (Actual);
10692 elsif Nkind (Def) = N_Constrained_Array_Definition then
10693 if not (Is_Constrained (Act_T)) then
10695 ("expect constrained array in instantiation of &",
10697 Abandon_Instantiation (Actual);
10701 if Is_Constrained (Act_T) then
10703 ("expect unconstrained array in instantiation of &",
10705 Abandon_Instantiation (Actual);
10709 if Formal_Dimensions /= Number_Dimensions (Act_T) then
10711 ("dimensions of actual do not match formal &", Actual, Gen_T);
10712 Abandon_Instantiation (Actual);
10715 I1 := First_Index (A_Gen_T);
10716 I2 := First_Index (Act_T);
10717 for J in 1 .. Formal_Dimensions loop
10719 -- If the indexes of the actual were given by a subtype_mark,
10720 -- the index was transformed into a range attribute. Retrieve
10721 -- the original type mark for checking.
10723 if Is_Entity_Name (Original_Node (I2)) then
10724 T2 := Entity (Original_Node (I2));
10729 if not Subtypes_Match
10730 (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
10733 ("index types of actual do not match those of formal &",
10735 Abandon_Instantiation (Actual);
10742 -- Check matching subtypes. Note that there are complex visibility
10743 -- issues when the generic is a child unit and some aspect of the
10744 -- generic type is declared in a parent unit of the generic. We do
10745 -- the test to handle this special case only after a direct check
10746 -- for static matching has failed. The case where both the component
10747 -- type and the array type are separate formals, and the component
10748 -- type is a private view may also require special checking in
10752 (Component_Type (A_Gen_T), Component_Type (Act_T))
10753 or else Subtypes_Match
10754 (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
10755 Component_Type (Act_T))
10760 ("component subtype of actual does not match that of formal &",
10762 Abandon_Instantiation (Actual);
10765 if Has_Aliased_Components (A_Gen_T)
10766 and then not Has_Aliased_Components (Act_T)
10769 ("actual must have aliased components to match formal type &",
10772 end Validate_Array_Type_Instance;
10774 -----------------------------------------------
10775 -- Validate_Derived_Interface_Type_Instance --
10776 -----------------------------------------------
10778 procedure Validate_Derived_Interface_Type_Instance is
10779 Par : constant Entity_Id := Entity (Subtype_Indication (Def));
10783 -- First apply interface instance checks
10785 Validate_Interface_Type_Instance;
10787 -- Verify that immediate parent interface is an ancestor of
10791 and then not Interface_Present_In_Ancestor (Act_T, Par)
10794 ("interface actual must include progenitor&", Actual, Par);
10797 -- Now verify that the actual includes all other ancestors of
10800 Elmt := First_Elmt (Interfaces (A_Gen_T));
10801 while Present (Elmt) loop
10802 if not Interface_Present_In_Ancestor
10803 (Act_T, Get_Instance_Of (Node (Elmt)))
10806 ("interface actual must include progenitor&",
10807 Actual, Node (Elmt));
10812 end Validate_Derived_Interface_Type_Instance;
10814 ------------------------------------
10815 -- Validate_Derived_Type_Instance --
10816 ------------------------------------
10818 procedure Validate_Derived_Type_Instance is
10819 Actual_Discr : Entity_Id;
10820 Ancestor_Discr : Entity_Id;
10823 -- If the parent type in the generic declaration is itself a previous
10824 -- formal type, then it is local to the generic and absent from the
10825 -- analyzed generic definition. In that case the ancestor is the
10826 -- instance of the formal (which must have been instantiated
10827 -- previously), unless the ancestor is itself a formal derived type.
10828 -- In this latter case (which is the subject of Corrigendum 8652/0038
10829 -- (AI-202) the ancestor of the formals is the ancestor of its
10830 -- parent. Otherwise, the analyzed generic carries the parent type.
10831 -- If the parent type is defined in a previous formal package, then
10832 -- the scope of that formal package is that of the generic type
10833 -- itself, and it has already been mapped into the corresponding type
10834 -- in the actual package.
10836 -- Common case: parent type defined outside of the generic
10838 if Is_Entity_Name (Subtype_Mark (Def))
10839 and then Present (Entity (Subtype_Mark (Def)))
10841 Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
10843 -- Check whether parent is defined in a previous formal package
10846 Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
10849 Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
10851 -- The type may be a local derivation, or a type extension of a
10852 -- previous formal, or of a formal of a parent package.
10854 elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
10856 Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
10858 -- Check whether the parent is another derived formal type in the
10859 -- same generic unit.
10861 if Etype (A_Gen_T) /= A_Gen_T
10862 and then Is_Generic_Type (Etype (A_Gen_T))
10863 and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
10864 and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
10866 -- Locate ancestor of parent from the subtype declaration
10867 -- created for the actual.
10873 Decl := First (Actual_Decls);
10874 while Present (Decl) loop
10875 if Nkind (Decl) = N_Subtype_Declaration
10876 and then Chars (Defining_Identifier (Decl)) =
10877 Chars (Etype (A_Gen_T))
10879 Ancestor := Generic_Parent_Type (Decl);
10887 pragma Assert (Present (Ancestor));
10889 -- The ancestor itself may be a previous formal that has been
10892 Ancestor := Get_Instance_Of (Ancestor);
10896 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
10899 -- An unusual case: the actual is a type declared in a parent unit,
10900 -- but is not a formal type so there is no instance_of for it.
10901 -- Retrieve it by analyzing the record extension.
10903 elsif Is_Child_Unit (Scope (A_Gen_T))
10904 and then In_Open_Scopes (Scope (Act_T))
10905 and then Is_Generic_Instance (Scope (Act_T))
10907 Analyze (Subtype_Mark (Def));
10908 Ancestor := Entity (Subtype_Mark (Def));
10911 Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
10914 -- If the formal derived type has pragma Preelaborable_Initialization
10915 -- then the actual type must have preelaborable initialization.
10917 if Known_To_Have_Preelab_Init (A_Gen_T)
10918 and then not Has_Preelaborable_Initialization (Act_T)
10921 ("actual for & must have preelaborable initialization",
10925 -- Ada 2005 (AI-251)
10927 if Ada_Version >= Ada_2005 and then Is_Interface (Ancestor) then
10928 if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
10930 ("(Ada 2005) expected type implementing & in instantiation",
10934 elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
10936 ("expect type derived from & in instantiation",
10937 Actual, First_Subtype (Ancestor));
10938 Abandon_Instantiation (Actual);
10941 -- Ada 2005 (AI-443): Synchronized formal derived type checks. Note
10942 -- that the formal type declaration has been rewritten as a private
10945 if Ada_Version >= Ada_2005
10946 and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
10947 and then Synchronized_Present (Parent (A_Gen_T))
10949 -- The actual must be a synchronized tagged type
10951 if not Is_Tagged_Type (Act_T) then
10953 ("actual of synchronized type must be tagged", Actual);
10954 Abandon_Instantiation (Actual);
10956 elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
10957 and then Nkind (Type_Definition (Parent (Act_T))) =
10958 N_Derived_Type_Definition
10959 and then not Synchronized_Present (Type_Definition
10963 ("actual of synchronized type must be synchronized", Actual);
10964 Abandon_Instantiation (Actual);
10968 -- Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
10969 -- removes the second instance of the phrase "or allow pass by copy".
10971 if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
10973 ("cannot have atomic actual type for non-atomic formal type",
10976 elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
10978 ("cannot have volatile actual type for non-volatile formal type",
10982 -- It should not be necessary to check for unknown discriminants on
10983 -- Formal, but for some reason Has_Unknown_Discriminants is false for
10984 -- A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
10985 -- needs fixing. ???
10987 if not Is_Indefinite_Subtype (A_Gen_T)
10988 and then not Unknown_Discriminants_Present (Formal)
10989 and then Is_Indefinite_Subtype (Act_T)
10992 ("actual subtype must be constrained", Actual);
10993 Abandon_Instantiation (Actual);
10996 if not Unknown_Discriminants_Present (Formal) then
10997 if Is_Constrained (Ancestor) then
10998 if not Is_Constrained (Act_T) then
11000 ("actual subtype must be constrained", Actual);
11001 Abandon_Instantiation (Actual);
11004 -- Ancestor is unconstrained, Check if generic formal and actual
11005 -- agree on constrainedness. The check only applies to array types
11006 -- and discriminated types.
11008 elsif Is_Constrained (Act_T) then
11009 if Ekind (Ancestor) = E_Access_Type
11011 (not Is_Constrained (A_Gen_T)
11012 and then Is_Composite_Type (A_Gen_T))
11015 ("actual subtype must be unconstrained", Actual);
11016 Abandon_Instantiation (Actual);
11019 -- A class-wide type is only allowed if the formal has unknown
11022 elsif Is_Class_Wide_Type (Act_T)
11023 and then not Has_Unknown_Discriminants (Ancestor)
11026 ("actual for & cannot be a class-wide type", Actual, Gen_T);
11027 Abandon_Instantiation (Actual);
11029 -- Otherwise, the formal and actual shall have the same number
11030 -- of discriminants and each discriminant of the actual must
11031 -- correspond to a discriminant of the formal.
11033 elsif Has_Discriminants (Act_T)
11034 and then not Has_Unknown_Discriminants (Act_T)
11035 and then Has_Discriminants (Ancestor)
11037 Actual_Discr := First_Discriminant (Act_T);
11038 Ancestor_Discr := First_Discriminant (Ancestor);
11039 while Present (Actual_Discr)
11040 and then Present (Ancestor_Discr)
11042 if Base_Type (Act_T) /= Base_Type (Ancestor) and then
11043 No (Corresponding_Discriminant (Actual_Discr))
11046 ("discriminant & does not correspond " &
11047 "to ancestor discriminant", Actual, Actual_Discr);
11048 Abandon_Instantiation (Actual);
11051 Next_Discriminant (Actual_Discr);
11052 Next_Discriminant (Ancestor_Discr);
11055 if Present (Actual_Discr) or else Present (Ancestor_Discr) then
11057 ("actual for & must have same number of discriminants",
11059 Abandon_Instantiation (Actual);
11062 -- This case should be caught by the earlier check for
11063 -- constrainedness, but the check here is added for completeness.
11065 elsif Has_Discriminants (Act_T)
11066 and then not Has_Unknown_Discriminants (Act_T)
11069 ("actual for & must not have discriminants", Actual, Gen_T);
11070 Abandon_Instantiation (Actual);
11072 elsif Has_Discriminants (Ancestor) then
11074 ("actual for & must have known discriminants", Actual, Gen_T);
11075 Abandon_Instantiation (Actual);
11078 if not Subtypes_Statically_Compatible (Act_T, Ancestor) then
11080 ("constraint on actual is incompatible with formal", Actual);
11081 Abandon_Instantiation (Actual);
11085 -- If the formal and actual types are abstract, check that there
11086 -- are no abstract primitives of the actual type that correspond to
11087 -- nonabstract primitives of the formal type (second sentence of
11090 if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
11091 Check_Abstract_Primitives : declare
11092 Gen_Prims : constant Elist_Id :=
11093 Primitive_Operations (A_Gen_T);
11094 Gen_Elmt : Elmt_Id;
11095 Gen_Subp : Entity_Id;
11096 Anc_Subp : Entity_Id;
11097 Anc_Formal : Entity_Id;
11098 Anc_F_Type : Entity_Id;
11100 Act_Prims : constant Elist_Id := Primitive_Operations (Act_T);
11101 Act_Elmt : Elmt_Id;
11102 Act_Subp : Entity_Id;
11103 Act_Formal : Entity_Id;
11104 Act_F_Type : Entity_Id;
11106 Subprograms_Correspond : Boolean;
11108 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
11109 -- Returns true if T2 is derived directly or indirectly from
11110 -- T1, including derivations from interfaces. T1 and T2 are
11111 -- required to be specific tagged base types.
11113 ------------------------
11114 -- Is_Tagged_Ancestor --
11115 ------------------------
11117 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
11119 Intfc_Elmt : Elmt_Id;
11122 -- The predicate is satisfied if the types are the same
11127 -- If we've reached the top of the derivation chain then
11128 -- we know that T1 is not an ancestor of T2.
11130 elsif Etype (T2) = T2 then
11133 -- Proceed to check T2's immediate parent
11135 elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
11138 -- Finally, check to see if T1 is an ancestor of any of T2's
11142 Intfc_Elmt := First_Elmt (Interfaces (T2));
11143 while Present (Intfc_Elmt) loop
11144 if Is_Ancestor (T1, Node (Intfc_Elmt)) then
11148 Next_Elmt (Intfc_Elmt);
11153 end Is_Tagged_Ancestor;
11155 -- Start of processing for Check_Abstract_Primitives
11158 -- Loop over all of the formal derived type's primitives
11160 Gen_Elmt := First_Elmt (Gen_Prims);
11161 while Present (Gen_Elmt) loop
11162 Gen_Subp := Node (Gen_Elmt);
11164 -- If the primitive of the formal is not abstract, then
11165 -- determine whether there is a corresponding primitive of
11166 -- the actual type that's abstract.
11168 if not Is_Abstract_Subprogram (Gen_Subp) then
11169 Act_Elmt := First_Elmt (Act_Prims);
11170 while Present (Act_Elmt) loop
11171 Act_Subp := Node (Act_Elmt);
11173 -- If we find an abstract primitive of the actual,
11174 -- then we need to test whether it corresponds to the
11175 -- subprogram from which the generic formal primitive
11178 if Is_Abstract_Subprogram (Act_Subp) then
11179 Anc_Subp := Alias (Gen_Subp);
11181 -- Test whether we have a corresponding primitive
11182 -- by comparing names, kinds, formal types, and
11185 if Chars (Anc_Subp) = Chars (Act_Subp)
11186 and then Ekind (Anc_Subp) = Ekind (Act_Subp)
11188 Anc_Formal := First_Formal (Anc_Subp);
11189 Act_Formal := First_Formal (Act_Subp);
11190 while Present (Anc_Formal)
11191 and then Present (Act_Formal)
11193 Anc_F_Type := Etype (Anc_Formal);
11194 Act_F_Type := Etype (Act_Formal);
11196 if Ekind (Anc_F_Type)
11197 = E_Anonymous_Access_Type
11199 Anc_F_Type := Designated_Type (Anc_F_Type);
11201 if Ekind (Act_F_Type)
11202 = E_Anonymous_Access_Type
11205 Designated_Type (Act_F_Type);
11211 Ekind (Act_F_Type) = E_Anonymous_Access_Type
11216 Anc_F_Type := Base_Type (Anc_F_Type);
11217 Act_F_Type := Base_Type (Act_F_Type);
11219 -- If the formal is controlling, then the
11220 -- the type of the actual primitive's formal
11221 -- must be derived directly or indirectly
11222 -- from the type of the ancestor primitive's
11225 if Is_Controlling_Formal (Anc_Formal) then
11226 if not Is_Tagged_Ancestor
11227 (Anc_F_Type, Act_F_Type)
11232 -- Otherwise the types of the formals must
11235 elsif Anc_F_Type /= Act_F_Type then
11239 Next_Entity (Anc_Formal);
11240 Next_Entity (Act_Formal);
11243 -- If we traversed through all of the formals
11244 -- then so far the subprograms correspond, so
11245 -- now check that any result types correspond.
11247 if No (Anc_Formal) and then No (Act_Formal) then
11248 Subprograms_Correspond := True;
11250 if Ekind (Act_Subp) = E_Function then
11251 Anc_F_Type := Etype (Anc_Subp);
11252 Act_F_Type := Etype (Act_Subp);
11254 if Ekind (Anc_F_Type)
11255 = E_Anonymous_Access_Type
11258 Designated_Type (Anc_F_Type);
11260 if Ekind (Act_F_Type)
11261 = E_Anonymous_Access_Type
11264 Designated_Type (Act_F_Type);
11266 Subprograms_Correspond := False;
11271 = E_Anonymous_Access_Type
11273 Subprograms_Correspond := False;
11276 Anc_F_Type := Base_Type (Anc_F_Type);
11277 Act_F_Type := Base_Type (Act_F_Type);
11279 -- Now either the result types must be
11280 -- the same or, if the result type is
11281 -- controlling, the result type of the
11282 -- actual primitive must descend from the
11283 -- result type of the ancestor primitive.
11285 if Subprograms_Correspond
11286 and then Anc_F_Type /= Act_F_Type
11288 Has_Controlling_Result (Anc_Subp)
11290 not Is_Tagged_Ancestor
11291 (Anc_F_Type, Act_F_Type)
11293 Subprograms_Correspond := False;
11297 -- Found a matching subprogram belonging to
11298 -- formal ancestor type, so actual subprogram
11299 -- corresponds and this violates 3.9.3(9).
11301 if Subprograms_Correspond then
11303 ("abstract subprogram & overrides " &
11304 "nonabstract subprogram of ancestor",
11312 Next_Elmt (Act_Elmt);
11316 Next_Elmt (Gen_Elmt);
11318 end Check_Abstract_Primitives;
11321 -- Verify that limitedness matches. If parent is a limited
11322 -- interface then the generic formal is not unless declared
11323 -- explicitly so. If not declared limited, the actual cannot be
11324 -- limited (see AI05-0087).
11326 -- Even though this AI is a binding interpretation, we enable the
11327 -- check only in Ada 2012 mode, because this improper construct
11328 -- shows up in user code and in existing B-tests.
11330 if Is_Limited_Type (Act_T)
11331 and then not Is_Limited_Type (A_Gen_T)
11332 and then Ada_Version >= Ada_2012
11334 if In_Instance then
11338 ("actual for non-limited & cannot be a limited type", Actual,
11340 Explain_Limited_Type (Act_T, Actual);
11341 Abandon_Instantiation (Actual);
11344 end Validate_Derived_Type_Instance;
11346 ----------------------------------------
11347 -- Validate_Discriminated_Formal_Type --
11348 ----------------------------------------
11350 procedure Validate_Discriminated_Formal_Type is
11351 Formal_Discr : Entity_Id;
11352 Actual_Discr : Entity_Id;
11353 Formal_Subt : Entity_Id;
11356 if Has_Discriminants (A_Gen_T) then
11357 if not Has_Discriminants (Act_T) then
11359 ("actual for & must have discriminants", Actual, Gen_T);
11360 Abandon_Instantiation (Actual);
11362 elsif Is_Constrained (Act_T) then
11364 ("actual for & must be unconstrained", Actual, Gen_T);
11365 Abandon_Instantiation (Actual);
11368 Formal_Discr := First_Discriminant (A_Gen_T);
11369 Actual_Discr := First_Discriminant (Act_T);
11370 while Formal_Discr /= Empty loop
11371 if Actual_Discr = Empty then
11373 ("discriminants on actual do not match formal",
11375 Abandon_Instantiation (Actual);
11378 Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
11380 -- Access discriminants match if designated types do
11382 if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
11383 and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
11384 E_Anonymous_Access_Type
11387 (Designated_Type (Base_Type (Formal_Subt))) =
11388 Designated_Type (Base_Type (Etype (Actual_Discr)))
11392 elsif Base_Type (Formal_Subt) /=
11393 Base_Type (Etype (Actual_Discr))
11396 ("types of actual discriminants must match formal",
11398 Abandon_Instantiation (Actual);
11400 elsif not Subtypes_Statically_Match
11401 (Formal_Subt, Etype (Actual_Discr))
11402 and then Ada_Version >= Ada_95
11405 ("subtypes of actual discriminants must match formal",
11407 Abandon_Instantiation (Actual);
11410 Next_Discriminant (Formal_Discr);
11411 Next_Discriminant (Actual_Discr);
11414 if Actual_Discr /= Empty then
11416 ("discriminants on actual do not match formal",
11418 Abandon_Instantiation (Actual);
11422 end Validate_Discriminated_Formal_Type;
11424 ---------------------------------------
11425 -- Validate_Incomplete_Type_Instance --
11426 ---------------------------------------
11428 procedure Validate_Incomplete_Type_Instance is
11430 if not Is_Tagged_Type (Act_T)
11431 and then Is_Tagged_Type (A_Gen_T)
11434 ("actual for & must be a tagged type", Actual, Gen_T);
11437 Validate_Discriminated_Formal_Type;
11438 end Validate_Incomplete_Type_Instance;
11440 --------------------------------------
11441 -- Validate_Interface_Type_Instance --
11442 --------------------------------------
11444 procedure Validate_Interface_Type_Instance is
11446 if not Is_Interface (Act_T) then
11448 ("actual for formal interface type must be an interface",
11451 elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
11453 Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
11455 Is_Protected_Interface (A_Gen_T) /=
11456 Is_Protected_Interface (Act_T)
11458 Is_Synchronized_Interface (A_Gen_T) /=
11459 Is_Synchronized_Interface (Act_T)
11462 ("actual for interface& does not match (RM 12.5.5(4))",
11465 end Validate_Interface_Type_Instance;
11467 ------------------------------------
11468 -- Validate_Private_Type_Instance --
11469 ------------------------------------
11471 procedure Validate_Private_Type_Instance is
11473 if Is_Limited_Type (Act_T)
11474 and then not Is_Limited_Type (A_Gen_T)
11476 if In_Instance then
11480 ("actual for non-limited & cannot be a limited type", Actual,
11482 Explain_Limited_Type (Act_T, Actual);
11483 Abandon_Instantiation (Actual);
11486 elsif Known_To_Have_Preelab_Init (A_Gen_T)
11487 and then not Has_Preelaborable_Initialization (Act_T)
11490 ("actual for & must have preelaborable initialization", Actual,
11493 elsif Is_Indefinite_Subtype (Act_T)
11494 and then not Is_Indefinite_Subtype (A_Gen_T)
11495 and then Ada_Version >= Ada_95
11498 ("actual for & must be a definite subtype", Actual, Gen_T);
11500 elsif not Is_Tagged_Type (Act_T)
11501 and then Is_Tagged_Type (A_Gen_T)
11504 ("actual for & must be a tagged type", Actual, Gen_T);
11507 Validate_Discriminated_Formal_Type;
11509 end Validate_Private_Type_Instance;
11511 -- Start of processing for Instantiate_Type
11514 if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
11515 Error_Msg_N ("duplicate instantiation of generic type", Actual);
11516 return New_List (Error);
11518 elsif not Is_Entity_Name (Actual)
11519 or else not Is_Type (Entity (Actual))
11522 ("expect valid subtype mark to instantiate &", Actual, Gen_T);
11523 Abandon_Instantiation (Actual);
11526 Act_T := Entity (Actual);
11528 -- Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
11529 -- as a generic actual parameter if the corresponding formal type
11530 -- does not have a known_discriminant_part, or is a formal derived
11531 -- type that is an Unchecked_Union type.
11533 if Is_Unchecked_Union (Base_Type (Act_T)) then
11534 if not Has_Discriminants (A_Gen_T)
11536 (Is_Derived_Type (A_Gen_T)
11538 Is_Unchecked_Union (A_Gen_T))
11542 Error_Msg_N ("unchecked union cannot be the actual for a" &
11543 " discriminated formal type", Act_T);
11548 -- Deal with fixed/floating restrictions
11550 if Is_Floating_Point_Type (Act_T) then
11551 Check_Restriction (No_Floating_Point, Actual);
11552 elsif Is_Fixed_Point_Type (Act_T) then
11553 Check_Restriction (No_Fixed_Point, Actual);
11556 -- Deal with error of using incomplete type as generic actual.
11557 -- This includes limited views of a type, even if the non-limited
11558 -- view may be available.
11560 if Ekind (Act_T) = E_Incomplete_Type
11561 or else (Is_Class_Wide_Type (Act_T)
11563 Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
11565 -- If the formal is an incomplete type, the actual can be
11566 -- incomplete as well.
11568 if Ekind (A_Gen_T) = E_Incomplete_Type then
11571 elsif Is_Class_Wide_Type (Act_T)
11572 or else No (Full_View (Act_T))
11574 Error_Msg_N ("premature use of incomplete type", Actual);
11575 Abandon_Instantiation (Actual);
11577 Act_T := Full_View (Act_T);
11578 Set_Entity (Actual, Act_T);
11580 if Has_Private_Component (Act_T) then
11582 ("premature use of type with private component", Actual);
11586 -- Deal with error of premature use of private type as generic actual
11588 elsif Is_Private_Type (Act_T)
11589 and then Is_Private_Type (Base_Type (Act_T))
11590 and then not Is_Generic_Type (Act_T)
11591 and then not Is_Derived_Type (Act_T)
11592 and then No (Full_View (Root_Type (Act_T)))
11594 -- If the formal is an incomplete type, the actual can be
11595 -- private or incomplete as well.
11597 if Ekind (A_Gen_T) = E_Incomplete_Type then
11600 Error_Msg_N ("premature use of private type", Actual);
11603 elsif Has_Private_Component (Act_T) then
11605 ("premature use of type with private component", Actual);
11608 Set_Instance_Of (A_Gen_T, Act_T);
11610 -- If the type is generic, the class-wide type may also be used
11612 if Is_Tagged_Type (A_Gen_T)
11613 and then Is_Tagged_Type (Act_T)
11614 and then not Is_Class_Wide_Type (A_Gen_T)
11616 Set_Instance_Of (Class_Wide_Type (A_Gen_T),
11617 Class_Wide_Type (Act_T));
11620 if not Is_Abstract_Type (A_Gen_T)
11621 and then Is_Abstract_Type (Act_T)
11624 ("actual of non-abstract formal cannot be abstract", Actual);
11627 -- A generic scalar type is a first subtype for which we generate
11628 -- an anonymous base type. Indicate that the instance of this base
11629 -- is the base type of the actual.
11631 if Is_Scalar_Type (A_Gen_T) then
11632 Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
11636 if Error_Posted (Act_T) then
11639 case Nkind (Def) is
11640 when N_Formal_Private_Type_Definition =>
11641 Validate_Private_Type_Instance;
11643 when N_Formal_Incomplete_Type_Definition =>
11644 Validate_Incomplete_Type_Instance;
11646 when N_Formal_Derived_Type_Definition =>
11647 Validate_Derived_Type_Instance;
11649 when N_Formal_Discrete_Type_Definition =>
11650 if not Is_Discrete_Type (Act_T) then
11652 ("expect discrete type in instantiation of&",
11654 Abandon_Instantiation (Actual);
11657 when N_Formal_Signed_Integer_Type_Definition =>
11658 if not Is_Signed_Integer_Type (Act_T) then
11660 ("expect signed integer type in instantiation of&",
11662 Abandon_Instantiation (Actual);
11665 when N_Formal_Modular_Type_Definition =>
11666 if not Is_Modular_Integer_Type (Act_T) then
11668 ("expect modular type in instantiation of &",
11670 Abandon_Instantiation (Actual);
11673 when N_Formal_Floating_Point_Definition =>
11674 if not Is_Floating_Point_Type (Act_T) then
11676 ("expect float type in instantiation of &", Actual, Gen_T);
11677 Abandon_Instantiation (Actual);
11680 when N_Formal_Ordinary_Fixed_Point_Definition =>
11681 if not Is_Ordinary_Fixed_Point_Type (Act_T) then
11683 ("expect ordinary fixed point type in instantiation of &",
11685 Abandon_Instantiation (Actual);
11688 when N_Formal_Decimal_Fixed_Point_Definition =>
11689 if not Is_Decimal_Fixed_Point_Type (Act_T) then
11691 ("expect decimal type in instantiation of &",
11693 Abandon_Instantiation (Actual);
11696 when N_Array_Type_Definition =>
11697 Validate_Array_Type_Instance;
11699 when N_Access_To_Object_Definition =>
11700 Validate_Access_Type_Instance;
11702 when N_Access_Function_Definition |
11703 N_Access_Procedure_Definition =>
11704 Validate_Access_Subprogram_Instance;
11706 when N_Record_Definition =>
11707 Validate_Interface_Type_Instance;
11709 when N_Derived_Type_Definition =>
11710 Validate_Derived_Interface_Type_Instance;
11713 raise Program_Error;
11718 Subt := New_Copy (Gen_T);
11720 -- Use adjusted sloc of subtype name as the location for other nodes in
11721 -- the subtype declaration.
11723 Loc := Sloc (Subt);
11726 Make_Subtype_Declaration (Loc,
11727 Defining_Identifier => Subt,
11728 Subtype_Indication => New_Reference_To (Act_T, Loc));
11730 if Is_Private_Type (Act_T) then
11731 Set_Has_Private_View (Subtype_Indication (Decl_Node));
11733 elsif Is_Access_Type (Act_T)
11734 and then Is_Private_Type (Designated_Type (Act_T))
11736 Set_Has_Private_View (Subtype_Indication (Decl_Node));
11739 Decl_Nodes := New_List (Decl_Node);
11741 -- Flag actual derived types so their elaboration produces the
11742 -- appropriate renamings for the primitive operations of the ancestor.
11743 -- Flag actual for formal private types as well, to determine whether
11744 -- operations in the private part may override inherited operations.
11745 -- If the formal has an interface list, the ancestor is not the
11746 -- parent, but the analyzed formal that includes the interface
11747 -- operations of all its progenitors.
11749 -- Same treatment for formal private types, so we can check whether the
11750 -- type is tagged limited when validating derivations in the private
11751 -- part. (See AI05-096).
11753 if Nkind (Def) = N_Formal_Derived_Type_Definition then
11754 if Present (Interface_List (Def)) then
11755 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11757 Set_Generic_Parent_Type (Decl_Node, Ancestor);
11760 elsif Nkind_In (Def,
11761 N_Formal_Private_Type_Definition,
11762 N_Formal_Incomplete_Type_Definition)
11764 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11767 -- If the actual is a synchronized type that implements an interface,
11768 -- the primitive operations are attached to the corresponding record,
11769 -- and we have to treat it as an additional generic actual, so that its
11770 -- primitive operations become visible in the instance. The task or
11771 -- protected type itself does not carry primitive operations.
11773 if Is_Concurrent_Type (Act_T)
11774 and then Is_Tagged_Type (Act_T)
11775 and then Present (Corresponding_Record_Type (Act_T))
11776 and then Present (Ancestor)
11777 and then Is_Interface (Ancestor)
11780 Corr_Rec : constant Entity_Id :=
11781 Corresponding_Record_Type (Act_T);
11782 New_Corr : Entity_Id;
11783 Corr_Decl : Node_Id;
11786 New_Corr := Make_Temporary (Loc, 'S');
11788 Make_Subtype_Declaration (Loc,
11789 Defining_Identifier => New_Corr,
11790 Subtype_Indication =>
11791 New_Reference_To (Corr_Rec, Loc));
11792 Append_To (Decl_Nodes, Corr_Decl);
11794 if Ekind (Act_T) = E_Task_Type then
11795 Set_Ekind (Subt, E_Task_Subtype);
11797 Set_Ekind (Subt, E_Protected_Subtype);
11800 Set_Corresponding_Record_Type (Subt, Corr_Rec);
11801 Set_Generic_Parent_Type (Corr_Decl, Ancestor);
11802 Set_Generic_Parent_Type (Decl_Node, Empty);
11807 end Instantiate_Type;
11809 ---------------------
11810 -- Is_In_Main_Unit --
11811 ---------------------
11813 function Is_In_Main_Unit (N : Node_Id) return Boolean is
11814 Unum : constant Unit_Number_Type := Get_Source_Unit (N);
11815 Current_Unit : Node_Id;
11818 if Unum = Main_Unit then
11821 -- If the current unit is a subunit then it is either the main unit or
11822 -- is being compiled as part of the main unit.
11824 elsif Nkind (N) = N_Compilation_Unit then
11825 return Nkind (Unit (N)) = N_Subunit;
11828 Current_Unit := Parent (N);
11829 while Present (Current_Unit)
11830 and then Nkind (Current_Unit) /= N_Compilation_Unit
11832 Current_Unit := Parent (Current_Unit);
11835 -- The instantiation node is in the main unit, or else the current node
11836 -- (perhaps as the result of nested instantiations) is in the main unit,
11837 -- or in the declaration of the main unit, which in this last case must
11840 return Unum = Main_Unit
11841 or else Current_Unit = Cunit (Main_Unit)
11842 or else Current_Unit = Library_Unit (Cunit (Main_Unit))
11843 or else (Present (Library_Unit (Current_Unit))
11844 and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
11845 end Is_In_Main_Unit;
11847 ----------------------------
11848 -- Load_Parent_Of_Generic --
11849 ----------------------------
11851 procedure Load_Parent_Of_Generic
11854 Body_Optional : Boolean := False)
11856 Comp_Unit : constant Node_Id := Cunit (Get_Source_Unit (Spec));
11857 Saved_Style_Check : constant Boolean := Style_Check;
11858 Saved_Warnings : constant Warning_Record := Save_Warnings;
11859 True_Parent : Node_Id;
11860 Inst_Node : Node_Id;
11862 Previous_Instances : constant Elist_Id := New_Elmt_List;
11864 procedure Collect_Previous_Instances (Decls : List_Id);
11865 -- Collect all instantiations in the given list of declarations, that
11866 -- precede the generic that we need to load. If the bodies of these
11867 -- instantiations are available, we must analyze them, to ensure that
11868 -- the public symbols generated are the same when the unit is compiled
11869 -- to generate code, and when it is compiled in the context of a unit
11870 -- that needs a particular nested instance. This process is applied to
11871 -- both package and subprogram instances.
11873 --------------------------------
11874 -- Collect_Previous_Instances --
11875 --------------------------------
11877 procedure Collect_Previous_Instances (Decls : List_Id) is
11881 Decl := First (Decls);
11882 while Present (Decl) loop
11883 if Sloc (Decl) >= Sloc (Inst_Node) then
11886 -- If Decl is an instantiation, then record it as requiring
11887 -- instantiation of the corresponding body, except if it is an
11888 -- abbreviated instantiation generated internally for conformance
11889 -- checking purposes only for the case of a formal package
11890 -- declared without a box (see Instantiate_Formal_Package). Such
11891 -- an instantiation does not generate any code (the actual code
11892 -- comes from actual) and thus does not need to be analyzed here.
11893 -- If the instantiation appears with a generic package body it is
11894 -- not analyzed here either.
11896 elsif Nkind (Decl) = N_Package_Instantiation
11897 and then not Is_Internal (Defining_Entity (Decl))
11899 Append_Elmt (Decl, Previous_Instances);
11901 -- For a subprogram instantiation, omit instantiations intrinsic
11902 -- operations (Unchecked_Conversions, etc.) that have no bodies.
11904 elsif Nkind_In (Decl, N_Function_Instantiation,
11905 N_Procedure_Instantiation)
11906 and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
11908 Append_Elmt (Decl, Previous_Instances);
11910 elsif Nkind (Decl) = N_Package_Declaration then
11911 Collect_Previous_Instances
11912 (Visible_Declarations (Specification (Decl)));
11913 Collect_Previous_Instances
11914 (Private_Declarations (Specification (Decl)));
11916 -- Previous non-generic bodies may contain instances as well
11918 elsif Nkind (Decl) = N_Package_Body
11919 and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
11921 Collect_Previous_Instances (Declarations (Decl));
11923 elsif Nkind (Decl) = N_Subprogram_Body
11924 and then not Acts_As_Spec (Decl)
11925 and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
11927 Collect_Previous_Instances (Declarations (Decl));
11932 end Collect_Previous_Instances;
11934 -- Start of processing for Load_Parent_Of_Generic
11937 if not In_Same_Source_Unit (N, Spec)
11938 or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
11939 or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
11940 and then not Is_In_Main_Unit (Spec))
11942 -- Find body of parent of spec, and analyze it. A special case arises
11943 -- when the parent is an instantiation, that is to say when we are
11944 -- currently instantiating a nested generic. In that case, there is
11945 -- no separate file for the body of the enclosing instance. Instead,
11946 -- the enclosing body must be instantiated as if it were a pending
11947 -- instantiation, in order to produce the body for the nested generic
11948 -- we require now. Note that in that case the generic may be defined
11949 -- in a package body, the instance defined in the same package body,
11950 -- and the original enclosing body may not be in the main unit.
11952 Inst_Node := Empty;
11954 True_Parent := Parent (Spec);
11955 while Present (True_Parent)
11956 and then Nkind (True_Parent) /= N_Compilation_Unit
11958 if Nkind (True_Parent) = N_Package_Declaration
11960 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
11962 -- Parent is a compilation unit that is an instantiation.
11963 -- Instantiation node has been replaced with package decl.
11965 Inst_Node := Original_Node (True_Parent);
11968 elsif Nkind (True_Parent) = N_Package_Declaration
11969 and then Present (Generic_Parent (Specification (True_Parent)))
11970 and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
11972 -- Parent is an instantiation within another specification.
11973 -- Declaration for instance has been inserted before original
11974 -- instantiation node. A direct link would be preferable?
11976 Inst_Node := Next (True_Parent);
11977 while Present (Inst_Node)
11978 and then Nkind (Inst_Node) /= N_Package_Instantiation
11983 -- If the instance appears within a generic, and the generic
11984 -- unit is defined within a formal package of the enclosing
11985 -- generic, there is no generic body available, and none
11986 -- needed. A more precise test should be used ???
11988 if No (Inst_Node) then
11995 True_Parent := Parent (True_Parent);
11999 -- Case where we are currently instantiating a nested generic
12001 if Present (Inst_Node) then
12002 if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
12004 -- Instantiation node and declaration of instantiated package
12005 -- were exchanged when only the declaration was needed.
12006 -- Restore instantiation node before proceeding with body.
12008 Set_Unit (Parent (True_Parent), Inst_Node);
12011 -- Now complete instantiation of enclosing body, if it appears in
12012 -- some other unit. If it appears in the current unit, the body
12013 -- will have been instantiated already.
12015 if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
12017 -- We need to determine the expander mode to instantiate the
12018 -- enclosing body. Because the generic body we need may use
12019 -- global entities declared in the enclosing package (including
12020 -- aggregates) it is in general necessary to compile this body
12021 -- with expansion enabled, except if we are within a generic
12022 -- package, in which case the usual generic rule applies.
12025 Exp_Status : Boolean := True;
12029 -- Loop through scopes looking for generic package
12031 Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
12032 while Present (Scop)
12033 and then Scop /= Standard_Standard
12035 if Ekind (Scop) = E_Generic_Package then
12036 Exp_Status := False;
12040 Scop := Scope (Scop);
12043 -- Collect previous instantiations in the unit that contains
12044 -- the desired generic.
12046 if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12047 and then not Body_Optional
12051 Info : Pending_Body_Info;
12055 Par := Parent (Inst_Node);
12056 while Present (Par) loop
12057 exit when Nkind (Parent (Par)) = N_Compilation_Unit;
12058 Par := Parent (Par);
12061 pragma Assert (Present (Par));
12063 if Nkind (Par) = N_Package_Body then
12064 Collect_Previous_Instances (Declarations (Par));
12066 elsif Nkind (Par) = N_Package_Declaration then
12067 Collect_Previous_Instances
12068 (Visible_Declarations (Specification (Par)));
12069 Collect_Previous_Instances
12070 (Private_Declarations (Specification (Par)));
12073 -- Enclosing unit is a subprogram body. In this
12074 -- case all instance bodies are processed in order
12075 -- and there is no need to collect them separately.
12080 Decl := First_Elmt (Previous_Instances);
12081 while Present (Decl) loop
12083 (Inst_Node => Node (Decl),
12085 Instance_Spec (Node (Decl)),
12086 Expander_Status => Exp_Status,
12087 Current_Sem_Unit =>
12088 Get_Code_Unit (Sloc (Node (Decl))),
12089 Scope_Suppress => Scope_Suppress,
12090 Local_Suppress_Stack_Top =>
12091 Local_Suppress_Stack_Top,
12092 Version => Ada_Version,
12093 Version_Pragma => Ada_Version_Pragma,
12094 Warnings => Save_Warnings);
12096 -- Package instance
12099 Nkind (Node (Decl)) = N_Package_Instantiation
12101 Instantiate_Package_Body
12102 (Info, Body_Optional => True);
12104 -- Subprogram instance
12107 -- The instance_spec is the wrapper package,
12108 -- and the subprogram declaration is the last
12109 -- declaration in the wrapper.
12113 (Visible_Declarations
12114 (Specification (Info.Act_Decl)));
12116 Instantiate_Subprogram_Body
12117 (Info, Body_Optional => True);
12125 Instantiate_Package_Body
12127 ((Inst_Node => Inst_Node,
12128 Act_Decl => True_Parent,
12129 Expander_Status => Exp_Status,
12130 Current_Sem_Unit => Get_Code_Unit
12131 (Sloc (Inst_Node)),
12132 Scope_Suppress => Scope_Suppress,
12133 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
12134 Version => Ada_Version,
12135 Version_Pragma => Ada_Version_Pragma,
12136 Warnings => Save_Warnings)),
12137 Body_Optional => Body_Optional);
12141 -- Case where we are not instantiating a nested generic
12144 Opt.Style_Check := False;
12145 Expander_Mode_Save_And_Set (True);
12146 Load_Needed_Body (Comp_Unit, OK);
12147 Opt.Style_Check := Saved_Style_Check;
12148 Restore_Warnings (Saved_Warnings);
12149 Expander_Mode_Restore;
12152 and then Unit_Requires_Body (Defining_Entity (Spec))
12153 and then not Body_Optional
12156 Bname : constant Unit_Name_Type :=
12157 Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
12160 -- In CodePeer mode, the missing body may make the analysis
12161 -- incomplete, but we do not treat it as fatal.
12163 if CodePeer_Mode then
12167 Error_Msg_Unit_1 := Bname;
12168 Error_Msg_N ("this instantiation requires$!", N);
12169 Error_Msg_File_1 :=
12170 Get_File_Name (Bname, Subunit => False);
12171 Error_Msg_N ("\but file{ was not found!", N);
12172 raise Unrecoverable_Error;
12179 -- If loading parent of the generic caused an instantiation circularity,
12180 -- we abandon compilation at this point, because otherwise in some cases
12181 -- we get into trouble with infinite recursions after this point.
12183 if Circularity_Detected then
12184 raise Unrecoverable_Error;
12186 end Load_Parent_Of_Generic;
12188 ---------------------------------
12189 -- Map_Formal_Package_Entities --
12190 ---------------------------------
12192 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
12197 Set_Instance_Of (Form, Act);
12199 -- Traverse formal and actual package to map the corresponding entities.
12200 -- We skip over internal entities that may be generated during semantic
12201 -- analysis, and find the matching entities by name, given that they
12202 -- must appear in the same order.
12204 E1 := First_Entity (Form);
12205 E2 := First_Entity (Act);
12206 while Present (E1) and then E1 /= First_Private_Entity (Form) loop
12207 -- Could this test be a single condition??? Seems like it could, and
12208 -- isn't FPE (Form) a constant anyway???
12210 if not Is_Internal (E1)
12211 and then Present (Parent (E1))
12212 and then not Is_Class_Wide_Type (E1)
12213 and then not Is_Internal_Name (Chars (E1))
12215 while Present (E2) and then Chars (E2) /= Chars (E1) loop
12222 Set_Instance_Of (E1, E2);
12224 if Is_Type (E1) and then Is_Tagged_Type (E2) then
12225 Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
12228 if Is_Constrained (E1) then
12229 Set_Instance_Of (Base_Type (E1), Base_Type (E2));
12232 if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
12233 Map_Formal_Package_Entities (E1, E2);
12240 end Map_Formal_Package_Entities;
12242 -----------------------
12243 -- Move_Freeze_Nodes --
12244 -----------------------
12246 procedure Move_Freeze_Nodes
12247 (Out_Of : Entity_Id;
12252 Next_Decl : Node_Id;
12253 Next_Node : Node_Id := After;
12256 function Is_Outer_Type (T : Entity_Id) return Boolean;
12257 -- Check whether entity is declared in a scope external to that of the
12260 -------------------
12261 -- Is_Outer_Type --
12262 -------------------
12264 function Is_Outer_Type (T : Entity_Id) return Boolean is
12265 Scop : Entity_Id := Scope (T);
12268 if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12272 while Scop /= Standard_Standard loop
12273 if Scop = Out_Of then
12276 Scop := Scope (Scop);
12284 -- Start of processing for Move_Freeze_Nodes
12291 -- First remove the freeze nodes that may appear before all other
12295 while Present (Decl)
12296 and then Nkind (Decl) = N_Freeze_Entity
12297 and then Is_Outer_Type (Entity (Decl))
12299 Decl := Remove_Head (L);
12300 Insert_After (Next_Node, Decl);
12301 Set_Analyzed (Decl, False);
12306 -- Next scan the list of declarations and remove each freeze node that
12307 -- appears ahead of the current node.
12309 while Present (Decl) loop
12310 while Present (Next (Decl))
12311 and then Nkind (Next (Decl)) = N_Freeze_Entity
12312 and then Is_Outer_Type (Entity (Next (Decl)))
12314 Next_Decl := Remove_Next (Decl);
12315 Insert_After (Next_Node, Next_Decl);
12316 Set_Analyzed (Next_Decl, False);
12317 Next_Node := Next_Decl;
12320 -- If the declaration is a nested package or concurrent type, then
12321 -- recurse. Nested generic packages will have been processed from the
12324 case Nkind (Decl) is
12325 when N_Package_Declaration =>
12326 Spec := Specification (Decl);
12328 when N_Task_Type_Declaration =>
12329 Spec := Task_Definition (Decl);
12331 when N_Protected_Type_Declaration =>
12332 Spec := Protected_Definition (Decl);
12338 if Present (Spec) then
12339 Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
12340 Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
12345 end Move_Freeze_Nodes;
12351 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
12353 return Generic_Renamings.Table (E).Next_In_HTable;
12356 ------------------------
12357 -- Preanalyze_Actuals --
12358 ------------------------
12360 procedure Preanalyze_Actuals (N : Node_Id) is
12363 Errs : constant Int := Serious_Errors_Detected;
12365 Cur : Entity_Id := Empty;
12366 -- Current homograph of the instance name
12369 -- Saved visibility status of the current homograph
12372 Assoc := First (Generic_Associations (N));
12374 -- If the instance is a child unit, its name may hide an outer homonym,
12375 -- so make it invisible to perform name resolution on the actuals.
12377 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
12379 (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
12381 Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
12383 if Is_Compilation_Unit (Cur) then
12384 Vis := Is_Immediately_Visible (Cur);
12385 Set_Is_Immediately_Visible (Cur, False);
12391 while Present (Assoc) loop
12392 if Nkind (Assoc) /= N_Others_Choice then
12393 Act := Explicit_Generic_Actual_Parameter (Assoc);
12395 -- Within a nested instantiation, a defaulted actual is an empty
12396 -- association, so nothing to analyze. If the subprogram actual
12397 -- is an attribute, analyze prefix only, because actual is not a
12398 -- complete attribute reference.
12400 -- If actual is an allocator, analyze expression only. The full
12401 -- analysis can generate code, and if instance is a compilation
12402 -- unit we have to wait until the package instance is installed
12403 -- to have a proper place to insert this code.
12405 -- String literals may be operators, but at this point we do not
12406 -- know whether the actual is a formal subprogram or a string.
12411 elsif Nkind (Act) = N_Attribute_Reference then
12412 Analyze (Prefix (Act));
12414 elsif Nkind (Act) = N_Explicit_Dereference then
12415 Analyze (Prefix (Act));
12417 elsif Nkind (Act) = N_Allocator then
12419 Expr : constant Node_Id := Expression (Act);
12422 if Nkind (Expr) = N_Subtype_Indication then
12423 Analyze (Subtype_Mark (Expr));
12425 -- Analyze separately each discriminant constraint, when
12426 -- given with a named association.
12432 Constr := First (Constraints (Constraint (Expr)));
12433 while Present (Constr) loop
12434 if Nkind (Constr) = N_Discriminant_Association then
12435 Analyze (Expression (Constr));
12449 elsif Nkind (Act) /= N_Operator_Symbol then
12453 -- Ensure that a ghost subprogram does not act as generic actual
12455 if Is_Entity_Name (Act)
12456 and then Is_Ghost_Subprogram (Entity (Act))
12459 ("ghost subprogram & cannot act as generic actual", Act);
12460 Abandon_Instantiation (Act);
12462 elsif Errs /= Serious_Errors_Detected then
12464 -- Do a minimal analysis of the generic, to prevent spurious
12465 -- warnings complaining about the generic being unreferenced,
12466 -- before abandoning the instantiation.
12468 Analyze (Name (N));
12470 if Is_Entity_Name (Name (N))
12471 and then Etype (Name (N)) /= Any_Type
12473 Generate_Reference (Entity (Name (N)), Name (N));
12474 Set_Is_Instantiated (Entity (Name (N)));
12477 if Present (Cur) then
12479 -- For the case of a child instance hiding an outer homonym,
12480 -- provide additional warning which might explain the error.
12482 Set_Is_Immediately_Visible (Cur, Vis);
12483 Error_Msg_NE ("& hides outer unit with the same name??",
12484 N, Defining_Unit_Name (N));
12487 Abandon_Instantiation (Act);
12494 if Present (Cur) then
12495 Set_Is_Immediately_Visible (Cur, Vis);
12497 end Preanalyze_Actuals;
12499 -------------------
12500 -- Remove_Parent --
12501 -------------------
12503 procedure Remove_Parent (In_Body : Boolean := False) is
12504 S : Entity_Id := Current_Scope;
12505 -- S is the scope containing the instantiation just completed. The scope
12506 -- stack contains the parent instances of the instantiation, followed by
12515 -- After child instantiation is complete, remove from scope stack the
12516 -- extra copy of the current scope, and then remove parent instances.
12518 if not In_Body then
12521 while Current_Scope /= S loop
12522 P := Current_Scope;
12523 End_Package_Scope (Current_Scope);
12525 if In_Open_Scopes (P) then
12526 E := First_Entity (P);
12527 while Present (E) loop
12528 Set_Is_Immediately_Visible (E, True);
12532 -- If instantiation is declared in a block, it is the enclosing
12533 -- scope that might be a parent instance. Note that only one
12534 -- block can be involved, because the parent instances have
12535 -- been installed within it.
12537 if Ekind (P) = E_Block then
12538 Cur_P := Scope (P);
12543 if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
12544 -- We are within an instance of some sibling. Retain
12545 -- visibility of parent, for proper subsequent cleanup, and
12546 -- reinstall private declarations as well.
12548 Set_In_Private_Part (P);
12549 Install_Private_Declarations (P);
12552 -- If the ultimate parent is a top-level unit recorded in
12553 -- Instance_Parent_Unit, then reset its visibility to what it was
12554 -- before instantiation. (It's not clear what the purpose is of
12555 -- testing whether Scope (P) is In_Open_Scopes, but that test was
12556 -- present before the ultimate parent test was added.???)
12558 elsif not In_Open_Scopes (Scope (P))
12559 or else (P = Instance_Parent_Unit
12560 and then not Parent_Unit_Visible)
12562 Set_Is_Immediately_Visible (P, False);
12564 -- If the current scope is itself an instantiation of a generic
12565 -- nested within P, and we are in the private part of body of this
12566 -- instantiation, restore the full views of P, that were removed
12567 -- in End_Package_Scope above. This obscure case can occur when a
12568 -- subunit of a generic contains an instance of a child unit of
12569 -- its generic parent unit.
12571 elsif S = Current_Scope and then Is_Generic_Instance (S) then
12573 Par : constant Entity_Id :=
12575 (Specification (Unit_Declaration_Node (S)));
12578 and then P = Scope (Par)
12579 and then (In_Package_Body (S) or else In_Private_Part (S))
12581 Set_In_Private_Part (P);
12582 Install_Private_Declarations (P);
12588 -- Reset visibility of entities in the enclosing scope
12590 Set_Is_Hidden_Open_Scope (Current_Scope, False);
12592 Hidden := First_Elmt (Hidden_Entities);
12593 while Present (Hidden) loop
12594 Set_Is_Immediately_Visible (Node (Hidden), True);
12595 Next_Elmt (Hidden);
12599 -- Each body is analyzed separately, and there is no context that
12600 -- needs preserving from one body instance to the next, so remove all
12601 -- parent scopes that have been installed.
12603 while Present (S) loop
12604 End_Package_Scope (S);
12605 Set_Is_Immediately_Visible (S, False);
12606 S := Current_Scope;
12607 exit when S = Standard_Standard;
12616 procedure Restore_Env is
12617 Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
12620 if No (Current_Instantiated_Parent.Act_Id) then
12621 -- Restore environment after subprogram inlining
12623 Restore_Private_Views (Empty);
12626 Current_Instantiated_Parent := Saved.Instantiated_Parent;
12627 Exchanged_Views := Saved.Exchanged_Views;
12628 Hidden_Entities := Saved.Hidden_Entities;
12629 Current_Sem_Unit := Saved.Current_Sem_Unit;
12630 Parent_Unit_Visible := Saved.Parent_Unit_Visible;
12631 Instance_Parent_Unit := Saved.Instance_Parent_Unit;
12633 Restore_Opt_Config_Switches (Saved.Switches);
12635 Instance_Envs.Decrement_Last;
12638 ---------------------------
12639 -- Restore_Private_Views --
12640 ---------------------------
12642 procedure Restore_Private_Views
12643 (Pack_Id : Entity_Id;
12644 Is_Package : Boolean := True)
12649 Dep_Elmt : Elmt_Id;
12652 procedure Restore_Nested_Formal (Formal : Entity_Id);
12653 -- Hide the generic formals of formal packages declared with box which
12654 -- were reachable in the current instantiation.
12656 ---------------------------
12657 -- Restore_Nested_Formal --
12658 ---------------------------
12660 procedure Restore_Nested_Formal (Formal : Entity_Id) is
12664 if Present (Renamed_Object (Formal))
12665 and then Denotes_Formal_Package (Renamed_Object (Formal), True)
12669 elsif Present (Associated_Formal_Package (Formal)) then
12670 Ent := First_Entity (Formal);
12671 while Present (Ent) loop
12672 exit when Ekind (Ent) = E_Package
12673 and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
12675 Set_Is_Hidden (Ent);
12676 Set_Is_Potentially_Use_Visible (Ent, False);
12678 -- If package, then recurse
12680 if Ekind (Ent) = E_Package then
12681 Restore_Nested_Formal (Ent);
12687 end Restore_Nested_Formal;
12689 -- Start of processing for Restore_Private_Views
12692 M := First_Elmt (Exchanged_Views);
12693 while Present (M) loop
12696 -- Subtypes of types whose views have been exchanged, and that are
12697 -- defined within the instance, were not on the Private_Dependents
12698 -- list on entry to the instance, so they have to be exchanged
12699 -- explicitly now, in order to remain consistent with the view of the
12702 if Ekind_In (Typ, E_Private_Type,
12703 E_Limited_Private_Type,
12704 E_Record_Type_With_Private)
12706 Dep_Elmt := First_Elmt (Private_Dependents (Typ));
12707 while Present (Dep_Elmt) loop
12708 Dep_Typ := Node (Dep_Elmt);
12710 if Scope (Dep_Typ) = Pack_Id
12711 and then Present (Full_View (Dep_Typ))
12713 Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
12714 Exchange_Declarations (Dep_Typ);
12717 Next_Elmt (Dep_Elmt);
12721 Exchange_Declarations (Node (M));
12725 if No (Pack_Id) then
12729 -- Make the generic formal parameters private, and make the formal types
12730 -- into subtypes of the actuals again.
12732 E := First_Entity (Pack_Id);
12733 while Present (E) loop
12734 Set_Is_Hidden (E, True);
12737 and then Nkind (Parent (E)) = N_Subtype_Declaration
12739 -- If the actual for E is itself a generic actual type from
12740 -- an enclosing instance, E is still a generic actual type
12741 -- outside of the current instance. This matter when resolving
12742 -- an overloaded call that may be ambiguous in the enclosing
12743 -- instance, when two of its actuals coincide.
12745 if Is_Entity_Name (Subtype_Indication (Parent (E)))
12746 and then Is_Generic_Actual_Type
12747 (Entity (Subtype_Indication (Parent (E))))
12751 Set_Is_Generic_Actual_Type (E, False);
12754 -- An unusual case of aliasing: the actual may also be directly
12755 -- visible in the generic, and be private there, while it is fully
12756 -- visible in the context of the instance. The internal subtype
12757 -- is private in the instance but has full visibility like its
12758 -- parent in the enclosing scope. This enforces the invariant that
12759 -- the privacy status of all private dependents of a type coincide
12760 -- with that of the parent type. This can only happen when a
12761 -- generic child unit is instantiated within a sibling.
12763 if Is_Private_Type (E)
12764 and then not Is_Private_Type (Etype (E))
12766 Exchange_Declarations (E);
12769 elsif Ekind (E) = E_Package then
12771 -- The end of the renaming list is the renaming of the generic
12772 -- package itself. If the instance is a subprogram, all entities
12773 -- in the corresponding package are renamings. If this entity is
12774 -- a formal package, make its own formals private as well. The
12775 -- actual in this case is itself the renaming of an instantiation.
12776 -- If the entity is not a package renaming, it is the entity
12777 -- created to validate formal package actuals: ignore it.
12779 -- If the actual is itself a formal package for the enclosing
12780 -- generic, or the actual for such a formal package, it remains
12781 -- visible on exit from the instance, and therefore nothing needs
12782 -- to be done either, except to keep it accessible.
12784 if Is_Package and then Renamed_Object (E) = Pack_Id then
12787 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
12791 Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
12793 Set_Is_Hidden (E, False);
12797 Act_P : constant Entity_Id := Renamed_Object (E);
12801 Id := First_Entity (Act_P);
12803 and then Id /= First_Private_Entity (Act_P)
12805 exit when Ekind (Id) = E_Package
12806 and then Renamed_Object (Id) = Act_P;
12808 Set_Is_Hidden (Id, True);
12809 Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
12811 if Ekind (Id) = E_Package then
12812 Restore_Nested_Formal (Id);
12823 end Restore_Private_Views;
12830 (Gen_Unit : Entity_Id;
12831 Act_Unit : Entity_Id)
12835 Set_Instance_Env (Gen_Unit, Act_Unit);
12838 ----------------------------
12839 -- Save_Global_References --
12840 ----------------------------
12842 procedure Save_Global_References (N : Node_Id) is
12843 Gen_Scope : Entity_Id;
12847 function Is_Global (E : Entity_Id) return Boolean;
12848 -- Check whether entity is defined outside of generic unit. Examine the
12849 -- scope of an entity, and the scope of the scope, etc, until we find
12850 -- either Standard, in which case the entity is global, or the generic
12851 -- unit itself, which indicates that the entity is local. If the entity
12852 -- is the generic unit itself, as in the case of a recursive call, or
12853 -- the enclosing generic unit, if different from the current scope, then
12854 -- it is local as well, because it will be replaced at the point of
12855 -- instantiation. On the other hand, if it is a reference to a child
12856 -- unit of a common ancestor, which appears in an instantiation, it is
12857 -- global because it is used to denote a specific compilation unit at
12858 -- the time the instantiations will be analyzed.
12860 procedure Reset_Entity (N : Node_Id);
12861 -- Save semantic information on global entity so that it is not resolved
12862 -- again at instantiation time.
12864 procedure Save_Entity_Descendants (N : Node_Id);
12865 -- Apply Save_Global_References to the two syntactic descendants of
12866 -- non-terminal nodes that carry an Associated_Node and are processed
12867 -- through Reset_Entity. Once the global entity (if any) has been
12868 -- captured together with its type, only two syntactic descendants need
12869 -- to be traversed to complete the processing of the tree rooted at N.
12870 -- This applies to Selected_Components, Expanded_Names, and to Operator
12871 -- nodes. N can also be a character literal, identifier, or operator
12872 -- symbol node, but the call has no effect in these cases.
12874 procedure Save_Global_Defaults (N1, N2 : Node_Id);
12875 -- Default actuals in nested instances must be handled specially
12876 -- because there is no link to them from the original tree. When an
12877 -- actual subprogram is given by a default, we add an explicit generic
12878 -- association for it in the instantiation node. When we save the
12879 -- global references on the name of the instance, we recover the list
12880 -- of generic associations, and add an explicit one to the original
12881 -- generic tree, through which a global actual can be preserved.
12882 -- Similarly, if a child unit is instantiated within a sibling, in the
12883 -- context of the parent, we must preserve the identifier of the parent
12884 -- so that it can be properly resolved in a subsequent instantiation.
12886 procedure Save_Global_Descendant (D : Union_Id);
12887 -- Apply Save_Global_References recursively to the descendents of the
12890 procedure Save_References (N : Node_Id);
12891 -- This is the recursive procedure that does the work, once the
12892 -- enclosing generic scope has been established.
12898 function Is_Global (E : Entity_Id) return Boolean is
12901 function Is_Instance_Node (Decl : Node_Id) return Boolean;
12902 -- Determine whether the parent node of a reference to a child unit
12903 -- denotes an instantiation or a formal package, in which case the
12904 -- reference to the child unit is global, even if it appears within
12905 -- the current scope (e.g. when the instance appears within the body
12906 -- of an ancestor).
12908 ----------------------
12909 -- Is_Instance_Node --
12910 ----------------------
12912 function Is_Instance_Node (Decl : Node_Id) return Boolean is
12914 return Nkind (Decl) in N_Generic_Instantiation
12916 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
12917 end Is_Instance_Node;
12919 -- Start of processing for Is_Global
12922 if E = Gen_Scope then
12925 elsif E = Standard_Standard then
12928 elsif Is_Child_Unit (E)
12929 and then (Is_Instance_Node (Parent (N2))
12930 or else (Nkind (Parent (N2)) = N_Expanded_Name
12931 and then N2 = Selector_Name (Parent (N2))
12933 Is_Instance_Node (Parent (Parent (N2)))))
12939 while Se /= Gen_Scope loop
12940 if Se = Standard_Standard then
12955 procedure Reset_Entity (N : Node_Id) is
12957 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
12958 -- If the type of N2 is global to the generic unit, save the type in
12959 -- the generic node. Just as we perform name capture for explicit
12960 -- references within the generic, we must capture the global types
12961 -- of local entities because they may participate in resolution in
12964 function Top_Ancestor (E : Entity_Id) return Entity_Id;
12965 -- Find the ultimate ancestor of the current unit. If it is not a
12966 -- generic unit, then the name of the current unit in the prefix of
12967 -- an expanded name must be replaced with its generic homonym to
12968 -- ensure that it will be properly resolved in an instance.
12970 ---------------------
12971 -- Set_Global_Type --
12972 ---------------------
12974 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
12975 Typ : constant Entity_Id := Etype (N2);
12978 Set_Etype (N, Typ);
12980 if Entity (N) /= N2
12981 and then Has_Private_View (Entity (N))
12983 -- If the entity of N is not the associated node, this is a
12984 -- nested generic and it has an associated node as well, whose
12985 -- type is already the full view (see below). Indicate that the
12986 -- original node has a private view.
12988 Set_Has_Private_View (N);
12991 -- If not a private type, nothing else to do
12993 if not Is_Private_Type (Typ) then
12994 if Is_Array_Type (Typ)
12995 and then Is_Private_Type (Component_Type (Typ))
12997 Set_Has_Private_View (N);
13000 -- If it is a derivation of a private type in a context where no
13001 -- full view is needed, nothing to do either.
13003 elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
13006 -- Otherwise mark the type for flipping and use the full view when
13010 Set_Has_Private_View (N);
13012 if Present (Full_View (Typ)) then
13013 Set_Etype (N2, Full_View (Typ));
13016 end Set_Global_Type;
13022 function Top_Ancestor (E : Entity_Id) return Entity_Id is
13027 while Is_Child_Unit (Par) loop
13028 Par := Scope (Par);
13034 -- Start of processing for Reset_Entity
13037 N2 := Get_Associated_Node (N);
13040 if Present (E) then
13042 -- If the node is an entry call to an entry in an enclosing task,
13043 -- it is rewritten as a selected component. No global entity to
13044 -- preserve in this case, since the expansion will be redone in
13047 if not Nkind_In (E, N_Defining_Identifier,
13048 N_Defining_Character_Literal,
13049 N_Defining_Operator_Symbol)
13051 Set_Associated_Node (N, Empty);
13052 Set_Etype (N, Empty);
13056 -- If the entity is an itype created as a subtype of an access
13057 -- type with a null exclusion restore source entity for proper
13058 -- visibility. The itype will be created anew in the instance.
13061 and then Ekind (E) = E_Access_Subtype
13062 and then Is_Entity_Name (N)
13063 and then Chars (Etype (E)) = Chars (N)
13066 Set_Entity (N2, E);
13070 if Is_Global (E) then
13072 -- If the entity is a package renaming that is the prefix of
13073 -- an expanded name, it has been rewritten as the renamed
13074 -- package, which is necessary semantically but complicates
13075 -- ASIS tree traversal, so we recover the original entity to
13076 -- expose the renaming. Take into account that the context may
13077 -- be a nested generic and that the original node may itself
13078 -- have an associated node.
13080 if Ekind (E) = E_Package
13081 and then Nkind (Parent (N)) = N_Expanded_Name
13082 and then Present (Original_Node (N2))
13083 and then Present (Entity (Original_Node (N2)))
13084 and then Is_Entity_Name (Entity (Original_Node (N2)))
13086 if Is_Global (Entity (Original_Node (N2))) then
13087 N2 := Original_Node (N2);
13088 Set_Associated_Node (N, N2);
13089 Set_Global_Type (N, N2);
13092 -- Renaming is local, and will be resolved in instance
13094 Set_Associated_Node (N, Empty);
13095 Set_Etype (N, Empty);
13099 Set_Global_Type (N, N2);
13102 elsif Nkind (N) = N_Op_Concat
13103 and then Is_Generic_Type (Etype (N2))
13104 and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
13106 Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
13107 and then Is_Intrinsic_Subprogram (E)
13112 -- Entity is local. Mark generic node as unresolved.
13113 -- Note that now it does not have an entity.
13115 Set_Associated_Node (N, Empty);
13116 Set_Etype (N, Empty);
13119 if Nkind (Parent (N)) in N_Generic_Instantiation
13120 and then N = Name (Parent (N))
13122 Save_Global_Defaults (Parent (N), Parent (N2));
13125 elsif Nkind (Parent (N)) = N_Selected_Component
13126 and then Nkind (Parent (N2)) = N_Expanded_Name
13128 if Is_Global (Entity (Parent (N2))) then
13129 Change_Selected_Component_To_Expanded_Name (Parent (N));
13130 Set_Associated_Node (Parent (N), Parent (N2));
13131 Set_Global_Type (Parent (N), Parent (N2));
13132 Save_Entity_Descendants (N);
13134 -- If this is a reference to the current generic entity, replace
13135 -- by the name of the generic homonym of the current package. This
13136 -- is because in an instantiation Par.P.Q will not resolve to the
13137 -- name of the instance, whose enclosing scope is not necessarily
13138 -- Par. We use the generic homonym rather that the name of the
13139 -- generic itself because it may be hidden by a local declaration.
13141 elsif In_Open_Scopes (Entity (Parent (N2)))
13143 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
13145 if Ekind (Entity (Parent (N2))) = E_Generic_Package then
13146 Rewrite (Parent (N),
13147 Make_Identifier (Sloc (N),
13149 Chars (Generic_Homonym (Entity (Parent (N2))))));
13151 Rewrite (Parent (N),
13152 Make_Identifier (Sloc (N),
13153 Chars => Chars (Selector_Name (Parent (N2)))));
13157 if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
13158 and then Parent (N) = Name (Parent (Parent (N)))
13160 Save_Global_Defaults
13161 (Parent (Parent (N)), Parent (Parent ((N2))));
13164 -- A selected component may denote a static constant that has been
13165 -- folded. If the static constant is global to the generic, capture
13166 -- its value. Otherwise the folding will happen in any instantiation.
13168 elsif Nkind (Parent (N)) = N_Selected_Component
13169 and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
13171 if Present (Entity (Original_Node (Parent (N2))))
13172 and then Is_Global (Entity (Original_Node (Parent (N2))))
13174 Rewrite (Parent (N), New_Copy (Parent (N2)));
13175 Set_Analyzed (Parent (N), False);
13181 -- A selected component may be transformed into a parameterless
13182 -- function call. If the called entity is global, rewrite the node
13183 -- appropriately, i.e. as an extended name for the global entity.
13185 elsif Nkind (Parent (N)) = N_Selected_Component
13186 and then Nkind (Parent (N2)) = N_Function_Call
13187 and then N = Selector_Name (Parent (N))
13189 if No (Parameter_Associations (Parent (N2))) then
13190 if Is_Global (Entity (Name (Parent (N2)))) then
13191 Change_Selected_Component_To_Expanded_Name (Parent (N));
13192 Set_Associated_Node (Parent (N), Name (Parent (N2)));
13193 Set_Global_Type (Parent (N), Name (Parent (N2)));
13194 Save_Entity_Descendants (N);
13197 Set_Is_Prefixed_Call (Parent (N));
13198 Set_Associated_Node (N, Empty);
13199 Set_Etype (N, Empty);
13202 -- In Ada 2005, X.F may be a call to a primitive operation,
13203 -- rewritten as F (X). This rewriting will be done again in an
13204 -- instance, so keep the original node. Global entities will be
13205 -- captured as for other constructs. Indicate that this must
13206 -- resolve as a call, to prevent accidental overloading in the
13207 -- instance, if both a component and a primitive operation appear
13211 Set_Is_Prefixed_Call (Parent (N));
13214 -- Entity is local. Reset in generic unit, so that node is resolved
13215 -- anew at the point of instantiation.
13218 Set_Associated_Node (N, Empty);
13219 Set_Etype (N, Empty);
13223 -----------------------------
13224 -- Save_Entity_Descendants --
13225 -----------------------------
13227 procedure Save_Entity_Descendants (N : Node_Id) is
13230 when N_Binary_Op =>
13231 Save_Global_Descendant (Union_Id (Left_Opnd (N)));
13232 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13235 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13237 when N_Expanded_Name | N_Selected_Component =>
13238 Save_Global_Descendant (Union_Id (Prefix (N)));
13239 Save_Global_Descendant (Union_Id (Selector_Name (N)));
13241 when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
13245 raise Program_Error;
13247 end Save_Entity_Descendants;
13249 --------------------------
13250 -- Save_Global_Defaults --
13251 --------------------------
13253 procedure Save_Global_Defaults (N1, N2 : Node_Id) is
13254 Loc : constant Source_Ptr := Sloc (N1);
13255 Assoc2 : constant List_Id := Generic_Associations (N2);
13256 Gen_Id : constant Entity_Id := Get_Generic_Entity (N2);
13263 Actual : Entity_Id;
13266 Assoc1 := Generic_Associations (N1);
13268 if Present (Assoc1) then
13269 Act1 := First (Assoc1);
13272 Set_Generic_Associations (N1, New_List);
13273 Assoc1 := Generic_Associations (N1);
13276 if Present (Assoc2) then
13277 Act2 := First (Assoc2);
13282 while Present (Act1) and then Present (Act2) loop
13287 -- Find the associations added for default subprograms
13289 if Present (Act2) then
13290 while Nkind (Act2) /= N_Generic_Association
13291 or else No (Entity (Selector_Name (Act2)))
13292 or else not Is_Overloadable (Entity (Selector_Name (Act2)))
13297 -- Add a similar association if the default is global. The
13298 -- renaming declaration for the actual has been analyzed, and
13299 -- its alias is the program it renames. Link the actual in the
13300 -- original generic tree with the node in the analyzed tree.
13302 while Present (Act2) loop
13303 Subp := Entity (Selector_Name (Act2));
13304 Def := Explicit_Generic_Actual_Parameter (Act2);
13306 -- Following test is defence against rubbish errors
13308 if No (Alias (Subp)) then
13312 -- Retrieve the resolved actual from the renaming declaration
13313 -- created for the instantiated formal.
13315 Actual := Entity (Name (Parent (Parent (Subp))));
13316 Set_Entity (Def, Actual);
13317 Set_Etype (Def, Etype (Actual));
13319 if Is_Global (Actual) then
13321 Make_Generic_Association (Loc,
13322 Selector_Name => New_Occurrence_Of (Subp, Loc),
13323 Explicit_Generic_Actual_Parameter =>
13324 New_Occurrence_Of (Actual, Loc));
13326 Set_Associated_Node
13327 (Explicit_Generic_Actual_Parameter (Ndec), Def);
13329 Append (Ndec, Assoc1);
13331 -- If there are other defaults, add a dummy association in case
13332 -- there are other defaulted formals with the same name.
13334 elsif Present (Next (Act2)) then
13336 Make_Generic_Association (Loc,
13337 Selector_Name => New_Occurrence_Of (Subp, Loc),
13338 Explicit_Generic_Actual_Parameter => Empty);
13340 Append (Ndec, Assoc1);
13347 if Nkind (Name (N1)) = N_Identifier
13348 and then Is_Child_Unit (Gen_Id)
13349 and then Is_Global (Gen_Id)
13350 and then Is_Generic_Unit (Scope (Gen_Id))
13351 and then In_Open_Scopes (Scope (Gen_Id))
13353 -- This is an instantiation of a child unit within a sibling, so
13354 -- that the generic parent is in scope. An eventual instance must
13355 -- occur within the scope of an instance of the parent. Make name
13356 -- in instance into an expanded name, to preserve the identifier
13357 -- of the parent, so it can be resolved subsequently.
13359 Rewrite (Name (N2),
13360 Make_Expanded_Name (Loc,
13361 Chars => Chars (Gen_Id),
13362 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13363 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13364 Set_Entity (Name (N2), Gen_Id);
13366 Rewrite (Name (N1),
13367 Make_Expanded_Name (Loc,
13368 Chars => Chars (Gen_Id),
13369 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13370 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13372 Set_Associated_Node (Name (N1), Name (N2));
13373 Set_Associated_Node (Prefix (Name (N1)), Empty);
13374 Set_Associated_Node
13375 (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
13376 Set_Etype (Name (N1), Etype (Gen_Id));
13379 end Save_Global_Defaults;
13381 ----------------------------
13382 -- Save_Global_Descendant --
13383 ----------------------------
13385 procedure Save_Global_Descendant (D : Union_Id) is
13389 if D in Node_Range then
13390 if D = Union_Id (Empty) then
13393 elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
13394 Save_References (Node_Id (D));
13397 elsif D in List_Range then
13398 if D = Union_Id (No_List)
13399 or else Is_Empty_List (List_Id (D))
13404 N1 := First (List_Id (D));
13405 while Present (N1) loop
13406 Save_References (N1);
13411 -- Element list or other non-node field, nothing to do
13416 end Save_Global_Descendant;
13418 ---------------------
13419 -- Save_References --
13420 ---------------------
13422 -- This is the recursive procedure that does the work once the enclosing
13423 -- generic scope has been established. We have to treat specially a
13424 -- number of node rewritings that are required by semantic processing
13425 -- and which change the kind of nodes in the generic copy: typically
13426 -- constant-folding, replacing an operator node by a string literal, or
13427 -- a selected component by an expanded name. In each of those cases, the
13428 -- transformation is propagated to the generic unit.
13430 procedure Save_References (N : Node_Id) is
13431 Loc : constant Source_Ptr := Sloc (N);
13437 elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
13438 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13441 elsif Nkind (N) = N_Operator_Symbol
13442 and then Nkind (Get_Associated_Node (N)) = N_String_Literal
13444 Change_Operator_Symbol_To_String_Literal (N);
13447 elsif Nkind (N) in N_Op then
13448 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13449 if Nkind (N) = N_Op_Concat then
13450 Set_Is_Component_Left_Opnd (N,
13451 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13453 Set_Is_Component_Right_Opnd (N,
13454 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13460 -- Node may be transformed into call to a user-defined operator
13462 N2 := Get_Associated_Node (N);
13464 if Nkind (N2) = N_Function_Call then
13465 E := Entity (Name (N2));
13468 and then Is_Global (E)
13470 Set_Etype (N, Etype (N2));
13472 Set_Associated_Node (N, Empty);
13473 Set_Etype (N, Empty);
13476 elsif Nkind_In (N2, N_Integer_Literal,
13480 if Present (Original_Node (N2))
13481 and then Nkind (Original_Node (N2)) = Nkind (N)
13484 -- Operation was constant-folded. Whenever possible,
13485 -- recover semantic information from unfolded node,
13488 Set_Associated_Node (N, Original_Node (N2));
13490 if Nkind (N) = N_Op_Concat then
13491 Set_Is_Component_Left_Opnd (N,
13492 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13493 Set_Is_Component_Right_Opnd (N,
13494 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13500 -- If original node is already modified, propagate
13501 -- constant-folding to template.
13503 Rewrite (N, New_Copy (N2));
13504 Set_Analyzed (N, False);
13507 elsif Nkind (N2) = N_Identifier
13508 and then Ekind (Entity (N2)) = E_Enumeration_Literal
13510 -- Same if call was folded into a literal, but in this case
13511 -- retain the entity to avoid spurious ambiguities if it is
13512 -- overloaded at the point of instantiation or inlining.
13514 Rewrite (N, New_Copy (N2));
13515 Set_Analyzed (N, False);
13519 -- Complete operands check if node has not been constant-folded
13521 if Nkind (N) in N_Op then
13522 Save_Entity_Descendants (N);
13525 elsif Nkind (N) = N_Identifier then
13526 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13528 -- If this is a discriminant reference, always save it. It is
13529 -- used in the instance to find the corresponding discriminant
13530 -- positionally rather than by name.
13532 Set_Original_Discriminant
13533 (N, Original_Discriminant (Get_Associated_Node (N)));
13537 N2 := Get_Associated_Node (N);
13539 if Nkind (N2) = N_Function_Call then
13540 E := Entity (Name (N2));
13542 -- Name resolves to a call to parameterless function. If
13543 -- original entity is global, mark node as resolved.
13546 and then Is_Global (E)
13548 Set_Etype (N, Etype (N2));
13550 Set_Associated_Node (N, Empty);
13551 Set_Etype (N, Empty);
13554 elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
13555 and then Is_Entity_Name (Original_Node (N2))
13557 -- Name resolves to named number that is constant-folded,
13558 -- We must preserve the original name for ASIS use, and
13559 -- undo the constant-folding, which will be repeated in
13562 Set_Associated_Node (N, Original_Node (N2));
13565 elsif Nkind (N2) = N_String_Literal then
13567 -- Name resolves to string literal. Perform the same
13568 -- replacement in generic.
13570 Rewrite (N, New_Copy (N2));
13572 elsif Nkind (N2) = N_Explicit_Dereference then
13574 -- An identifier is rewritten as a dereference if it is the
13575 -- prefix in an implicit dereference (call or attribute).
13576 -- The analysis of an instantiation will expand the node
13577 -- again, so we preserve the original tree but link it to
13578 -- the resolved entity in case it is global.
13580 if Is_Entity_Name (Prefix (N2))
13581 and then Present (Entity (Prefix (N2)))
13582 and then Is_Global (Entity (Prefix (N2)))
13584 Set_Associated_Node (N, Prefix (N2));
13586 elsif Nkind (Prefix (N2)) = N_Function_Call
13587 and then Is_Global (Entity (Name (Prefix (N2))))
13590 Make_Explicit_Dereference (Loc,
13591 Prefix => Make_Function_Call (Loc,
13593 New_Occurrence_Of (Entity (Name (Prefix (N2))),
13597 Set_Associated_Node (N, Empty);
13598 Set_Etype (N, Empty);
13601 -- The subtype mark of a nominally unconstrained object is
13602 -- rewritten as a subtype indication using the bounds of the
13603 -- expression. Recover the original subtype mark.
13605 elsif Nkind (N2) = N_Subtype_Indication
13606 and then Is_Entity_Name (Original_Node (N2))
13608 Set_Associated_Node (N, Original_Node (N2));
13616 elsif Nkind (N) in N_Entity then
13621 Qual : Node_Id := Empty;
13622 Typ : Entity_Id := Empty;
13625 use Atree.Unchecked_Access;
13626 -- This code section is part of implementing an untyped tree
13627 -- traversal, so it needs direct access to node fields.
13630 if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
13631 N2 := Get_Associated_Node (N);
13638 -- In an instance within a generic, use the name of the
13639 -- actual and not the original generic parameter. If the
13640 -- actual is global in the current generic it must be
13641 -- preserved for its instantiation.
13643 if Nkind (Parent (Typ)) = N_Subtype_Declaration
13645 Present (Generic_Parent_Type (Parent (Typ)))
13647 Typ := Base_Type (Typ);
13648 Set_Etype (N2, Typ);
13654 or else not Is_Global (Typ)
13656 Set_Associated_Node (N, Empty);
13658 -- If the aggregate is an actual in a call, it has been
13659 -- resolved in the current context, to some local type.
13660 -- The enclosing call may have been disambiguated by the
13661 -- aggregate, and this disambiguation might fail at
13662 -- instantiation time because the type to which the
13663 -- aggregate did resolve is not preserved. In order to
13664 -- preserve some of this information, we wrap the
13665 -- aggregate in a qualified expression, using the id of
13666 -- its type. For further disambiguation we qualify the
13667 -- type name with its scope (if visible) because both
13668 -- id's will have corresponding entities in an instance.
13669 -- This resolves most of the problems with missing type
13670 -- information on aggregates in instances.
13672 if Nkind (N2) = Nkind (N)
13673 and then Nkind (Parent (N2)) in N_Subprogram_Call
13674 and then Comes_From_Source (Typ)
13676 if Is_Immediately_Visible (Scope (Typ)) then
13677 Nam := Make_Selected_Component (Loc,
13679 Make_Identifier (Loc, Chars (Scope (Typ))),
13681 Make_Identifier (Loc, Chars (Typ)));
13683 Nam := Make_Identifier (Loc, Chars (Typ));
13687 Make_Qualified_Expression (Loc,
13688 Subtype_Mark => Nam,
13689 Expression => Relocate_Node (N));
13693 Save_Global_Descendant (Field1 (N));
13694 Save_Global_Descendant (Field2 (N));
13695 Save_Global_Descendant (Field3 (N));
13696 Save_Global_Descendant (Field5 (N));
13698 if Present (Qual) then
13702 -- All other cases than aggregates
13705 Save_Global_Descendant (Field1 (N));
13706 Save_Global_Descendant (Field2 (N));
13707 Save_Global_Descendant (Field3 (N));
13708 Save_Global_Descendant (Field4 (N));
13709 Save_Global_Descendant (Field5 (N));
13714 -- If a node has aspects, references within their expressions must
13715 -- be saved separately, given that they are not directly in the
13718 if Has_Aspects (N) then
13722 Aspect := First (Aspect_Specifications (N));
13723 while Present (Aspect) loop
13724 Save_Global_References (Expression (Aspect));
13729 end Save_References;
13731 -- Start of processing for Save_Global_References
13734 Gen_Scope := Current_Scope;
13736 -- If the generic unit is a child unit, references to entities in the
13737 -- parent are treated as local, because they will be resolved anew in
13738 -- the context of the instance of the parent.
13740 while Is_Child_Unit (Gen_Scope)
13741 and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
13743 Gen_Scope := Scope (Gen_Scope);
13746 Save_References (N);
13747 end Save_Global_References;
13749 --------------------------------------
13750 -- Set_Copied_Sloc_For_Inlined_Body --
13751 --------------------------------------
13753 procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
13755 Create_Instantiation_Source (N, E, True, S_Adjustment);
13756 end Set_Copied_Sloc_For_Inlined_Body;
13758 ---------------------
13759 -- Set_Instance_Of --
13760 ---------------------
13762 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
13764 Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
13765 Generic_Renamings_HTable.Set (Generic_Renamings.Last);
13766 Generic_Renamings.Increment_Last;
13767 end Set_Instance_Of;
13769 --------------------
13770 -- Set_Next_Assoc --
13771 --------------------
13773 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
13775 Generic_Renamings.Table (E).Next_In_HTable := Next;
13776 end Set_Next_Assoc;
13778 -------------------
13779 -- Start_Generic --
13780 -------------------
13782 procedure Start_Generic is
13784 -- ??? More things could be factored out in this routine.
13785 -- Should probably be done at a later stage.
13787 Generic_Flags.Append (Inside_A_Generic);
13788 Inside_A_Generic := True;
13790 Expander_Mode_Save_And_Set (False);
13793 ----------------------
13794 -- Set_Instance_Env --
13795 ----------------------
13797 procedure Set_Instance_Env
13798 (Gen_Unit : Entity_Id;
13799 Act_Unit : Entity_Id)
13802 -- Regardless of the current mode, predefined units are analyzed in the
13803 -- most current Ada mode, and earlier version Ada checks do not apply
13804 -- to predefined units. Nothing needs to be done for non-internal units.
13805 -- These are always analyzed in the current mode.
13807 if Is_Internal_File_Name
13808 (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
13809 Renamings_Included => True)
13811 Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
13814 Current_Instantiated_Parent :=
13815 (Gen_Id => Gen_Unit,
13816 Act_Id => Act_Unit,
13817 Next_In_HTable => Assoc_Null);
13818 end Set_Instance_Env;
13824 procedure Switch_View (T : Entity_Id) is
13825 BT : constant Entity_Id := Base_Type (T);
13826 Priv_Elmt : Elmt_Id := No_Elmt;
13827 Priv_Sub : Entity_Id;
13830 -- T may be private but its base type may have been exchanged through
13831 -- some other occurrence, in which case there is nothing to switch
13832 -- besides T itself. Note that a private dependent subtype of a private
13833 -- type might not have been switched even if the base type has been,
13834 -- because of the last branch of Check_Private_View (see comment there).
13836 if not Is_Private_Type (BT) then
13837 Prepend_Elmt (Full_View (T), Exchanged_Views);
13838 Exchange_Declarations (T);
13842 Priv_Elmt := First_Elmt (Private_Dependents (BT));
13844 if Present (Full_View (BT)) then
13845 Prepend_Elmt (Full_View (BT), Exchanged_Views);
13846 Exchange_Declarations (BT);
13849 while Present (Priv_Elmt) loop
13850 Priv_Sub := (Node (Priv_Elmt));
13852 -- We avoid flipping the subtype if the Etype of its full view is
13853 -- private because this would result in a malformed subtype. This
13854 -- occurs when the Etype of the subtype full view is the full view of
13855 -- the base type (and since the base types were just switched, the
13856 -- subtype is pointing to the wrong view). This is currently the case
13857 -- for tagged record types, access types (maybe more?) and needs to
13858 -- be resolved. ???
13860 if Present (Full_View (Priv_Sub))
13861 and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
13863 Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
13864 Exchange_Declarations (Priv_Sub);
13867 Next_Elmt (Priv_Elmt);
13875 function True_Parent (N : Node_Id) return Node_Id is
13877 if Nkind (Parent (N)) = N_Subunit then
13878 return Parent (Corresponding_Stub (Parent (N)));
13884 -----------------------------
13885 -- Valid_Default_Attribute --
13886 -----------------------------
13888 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
13889 Attr_Id : constant Attribute_Id :=
13890 Get_Attribute_Id (Attribute_Name (Def));
13891 T : constant Entity_Id := Entity (Prefix (Def));
13892 Is_Fun : constant Boolean := (Ekind (Nam) = E_Function);
13905 F := First_Formal (Nam);
13906 while Present (F) loop
13907 Num_F := Num_F + 1;
13912 when Attribute_Adjacent | Attribute_Ceiling | Attribute_Copy_Sign |
13913 Attribute_Floor | Attribute_Fraction | Attribute_Machine |
13914 Attribute_Model | Attribute_Remainder | Attribute_Rounding |
13915 Attribute_Unbiased_Rounding =>
13918 and then Is_Floating_Point_Type (T);
13920 when Attribute_Image | Attribute_Pred | Attribute_Succ |
13921 Attribute_Value | Attribute_Wide_Image |
13922 Attribute_Wide_Value =>
13923 OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
13925 when Attribute_Max | Attribute_Min =>
13926 OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
13928 when Attribute_Input =>
13929 OK := (Is_Fun and then Num_F = 1);
13931 when Attribute_Output | Attribute_Read | Attribute_Write =>
13932 OK := (not Is_Fun and then Num_F = 2);
13939 Error_Msg_N ("attribute reference has wrong profile for subprogram",
13942 end Valid_Default_Attribute;