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;
82 package body Sem_Ch12 is
84 ----------------------------------------------------------
85 -- Implementation of Generic Analysis and Instantiation --
86 ----------------------------------------------------------
88 -- GNAT implements generics by macro expansion. No attempt is made to share
89 -- generic instantiations (for now). Analysis of a generic definition does
90 -- not perform any expansion action, but the expander must be called on the
91 -- tree for each instantiation, because the expansion may of course depend
92 -- on the generic actuals. All of this is best achieved as follows:
94 -- a) Semantic analysis of a generic unit is performed on a copy of the
95 -- tree for the generic unit. All tree modifications that follow analysis
96 -- do not affect the original tree. Links are kept between the original
97 -- tree and the copy, in order to recognize non-local references within
98 -- the generic, and propagate them to each instance (recall that name
99 -- resolution is done on the generic declaration: generics are not really
100 -- macros!). This is summarized in the following diagram:
102 -- .-----------. .----------.
103 -- | semantic |<--------------| generic |
105 -- | |==============>| |
106 -- |___________| global |__________|
117 -- b) Each instantiation copies the original tree, and inserts into it a
118 -- series of declarations that describe the mapping between generic formals
119 -- and actuals. For example, a generic In OUT parameter is an object
120 -- renaming of the corresponding actual, etc. Generic IN parameters are
121 -- constant declarations.
123 -- c) In order to give the right visibility for these renamings, we use
124 -- a different scheme for package and subprogram instantiations. For
125 -- packages, the list of renamings is inserted into the package
126 -- specification, before the visible declarations of the package. The
127 -- renamings are analyzed before any of the text of the instance, and are
128 -- thus visible at the right place. Furthermore, outside of the instance,
129 -- the generic parameters are visible and denote their corresponding
132 -- For subprograms, we create a container package to hold the renamings
133 -- and the subprogram instance itself. Analysis of the package makes the
134 -- renaming declarations visible to the subprogram. After analyzing the
135 -- package, the defining entity for the subprogram is touched-up so that
136 -- it appears declared in the current scope, and not inside the container
139 -- If the instantiation is a compilation unit, the container package is
140 -- given the same name as the subprogram instance. This ensures that
141 -- the elaboration procedure called by the binder, using the compilation
142 -- unit name, calls in fact the elaboration procedure for the package.
144 -- Not surprisingly, private types complicate this approach. By saving in
145 -- the original generic object the non-local references, we guarantee that
146 -- the proper entities are referenced at the point of instantiation.
147 -- However, for private types, this by itself does not insure that the
148 -- proper VIEW of the entity is used (the full type may be visible at the
149 -- point of generic definition, but not at instantiation, or vice-versa).
150 -- In order to reference the proper view, we special-case any reference
151 -- to private types in the generic object, by saving both views, one in
152 -- the generic and one in the semantic copy. At time of instantiation, we
153 -- check whether the two views are consistent, and exchange declarations if
154 -- necessary, in order to restore the correct visibility. Similarly, if
155 -- the instance view is private when the generic view was not, we perform
156 -- the exchange. After completing the instantiation, we restore the
157 -- current visibility. The flag Has_Private_View marks identifiers in the
158 -- the generic unit that require checking.
160 -- Visibility within nested generic units requires special handling.
161 -- Consider the following scheme:
163 -- type Global is ... -- outside of generic unit.
167 -- type Semi_Global is ... -- global to inner.
170 -- procedure inner (X1 : Global; X2 : Semi_Global);
172 -- procedure in2 is new inner (...); -- 4
175 -- package New_Outer is new Outer (...); -- 2
176 -- procedure New_Inner is new New_Outer.Inner (...); -- 3
178 -- The semantic analysis of Outer captures all occurrences of Global.
179 -- The semantic analysis of Inner (at 1) captures both occurrences of
180 -- Global and Semi_Global.
182 -- At point 2 (instantiation of Outer), we also produce a generic copy
183 -- of Inner, even though Inner is, at that point, not being instantiated.
184 -- (This is just part of the semantic analysis of New_Outer).
186 -- Critically, references to Global within Inner must be preserved, while
187 -- references to Semi_Global should not preserved, because they must now
188 -- resolve to an entity within New_Outer. To distinguish between these, we
189 -- use a global variable, Current_Instantiated_Parent, which is set when
190 -- performing a generic copy during instantiation (at 2). This variable is
191 -- used when performing a generic copy that is not an instantiation, but
192 -- that is nested within one, as the occurrence of 1 within 2. The analysis
193 -- of a nested generic only preserves references that are global to the
194 -- enclosing Current_Instantiated_Parent. We use the Scope_Depth value to
195 -- determine whether a reference is external to the given parent.
197 -- The instantiation at point 3 requires no special treatment. The method
198 -- works as well for further nestings of generic units, but of course the
199 -- variable Current_Instantiated_Parent must be stacked because nested
200 -- instantiations can occur, e.g. the occurrence of 4 within 2.
202 -- The instantiation of package and subprogram bodies is handled in a
203 -- similar manner, except that it is delayed until after semantic
204 -- analysis is complete. In this fashion complex cross-dependencies
205 -- between several package declarations and bodies containing generics
206 -- can be compiled which otherwise would diagnose spurious circularities.
208 -- For example, it is possible to compile two packages A and B that
209 -- have the following structure:
211 -- package A is package B is
212 -- generic ... generic ...
213 -- package G_A is package G_B is
216 -- package body A is package body B is
217 -- package N_B is new G_B (..) package N_A is new G_A (..)
219 -- The table Pending_Instantiations in package Inline is used to keep
220 -- track of body instantiations that are delayed in this manner. Inline
221 -- handles the actual calls to do the body instantiations. This activity
222 -- is part of Inline, since the processing occurs at the same point, and
223 -- for essentially the same reason, as the handling of inlined routines.
225 ----------------------------------------------
226 -- Detection of Instantiation Circularities --
227 ----------------------------------------------
229 -- If we have a chain of instantiations that is circular, this is static
230 -- error which must be detected at compile time. The detection of these
231 -- circularities is carried out at the point that we insert a generic
232 -- instance spec or body. If there is a circularity, then the analysis of
233 -- the offending spec or body will eventually result in trying to load the
234 -- same unit again, and we detect this problem as we analyze the package
235 -- instantiation for the second time.
237 -- At least in some cases after we have detected the circularity, we get
238 -- into trouble if we try to keep going. The following flag is set if a
239 -- circularity is detected, and used to abandon compilation after the
240 -- messages have been posted.
242 Circularity_Detected : Boolean := False;
243 -- This should really be reset on encountering a new main unit, but in
244 -- practice we are not using multiple main units so it is not critical.
246 -------------------------------------------------
247 -- Formal packages and partial parametrization --
248 -------------------------------------------------
250 -- When compiling a generic, a formal package is a local instantiation. If
251 -- declared with a box, its generic formals are visible in the enclosing
252 -- generic. If declared with a partial list of actuals, those actuals that
253 -- are defaulted (covered by an Others clause, or given an explicit box
254 -- initialization) are also visible in the enclosing generic, while those
255 -- that have a corresponding actual are not.
257 -- In our source model of instantiation, the same visibility must be
258 -- present in the spec and body of an instance: the names of the formals
259 -- that are defaulted must be made visible within the instance, and made
260 -- invisible (hidden) after the instantiation is complete, so that they
261 -- are not accessible outside of the instance.
263 -- In a generic, a formal package is treated like a special instantiation.
264 -- Our Ada 95 compiler handled formals with and without box in different
265 -- ways. With partial parametrization, we use a single model for both.
266 -- We create a package declaration that consists of the specification of
267 -- the generic package, and a set of declarations that map the actuals
268 -- into local renamings, just as we do for bona fide instantiations. For
269 -- defaulted parameters and formals with a box, we copy directly the
270 -- declarations of the formal into this local package. The result is a
271 -- a package whose visible declarations may include generic formals. This
272 -- package is only used for type checking and visibility analysis, and
273 -- never reaches the back-end, so it can freely violate the placement
274 -- rules for generic formal declarations.
276 -- The list of declarations (renamings and copies of formals) is built
277 -- by Analyze_Associations, just as for regular instantiations.
279 -- At the point of instantiation, conformance checking must be applied only
280 -- to those parameters that were specified in the formal. We perform this
281 -- checking by creating another internal instantiation, this one including
282 -- only the renamings and the formals (the rest of the package spec is not
283 -- relevant to conformance checking). We can then traverse two lists: the
284 -- list of actuals in the instance that corresponds to the formal package,
285 -- and the list of actuals produced for this bogus instantiation. We apply
286 -- the conformance rules to those actuals that are not defaulted (i.e.
287 -- which still appear as generic formals.
289 -- When we compile an instance body we must make the right parameters
290 -- visible again. The predicate Is_Generic_Formal indicates which of the
291 -- formals should have its Is_Hidden flag reset.
293 -----------------------
294 -- Local subprograms --
295 -----------------------
297 procedure Abandon_Instantiation (N : Node_Id);
298 pragma No_Return (Abandon_Instantiation);
299 -- Posts an error message "instantiation abandoned" at the indicated node
300 -- and then raises the exception Instantiation_Error to do it.
302 procedure Analyze_Formal_Array_Type
303 (T : in out Entity_Id;
305 -- A formal array type is treated like an array type declaration, and
306 -- invokes Array_Type_Declaration (sem_ch3) whose first parameter is
307 -- in-out, because in the case of an anonymous type the entity is
308 -- actually created in the procedure.
310 -- The following procedures treat other kinds of formal parameters
312 procedure Analyze_Formal_Derived_Interface_Type
317 procedure Analyze_Formal_Derived_Type
322 procedure Analyze_Formal_Interface_Type
327 -- The following subprograms create abbreviated declarations for formal
328 -- scalar types. We introduce an anonymous base of the proper class for
329 -- each of them, and define the formals as constrained first subtypes of
330 -- their bases. The bounds are expressions that are non-static in the
333 procedure Analyze_Formal_Decimal_Fixed_Point_Type
334 (T : Entity_Id; Def : Node_Id);
335 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id);
336 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id);
337 procedure Analyze_Formal_Signed_Integer_Type (T : Entity_Id; Def : Node_Id);
338 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id);
339 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
340 (T : Entity_Id; Def : Node_Id);
342 procedure Analyze_Formal_Private_Type
346 -- Creates a new private type, which does not require completion
348 procedure Analyze_Formal_Incomplete_Type (T : Entity_Id; Def : Node_Id);
349 -- Ada 2012: Creates a new incomplete type whose actual does not freeze
351 procedure Analyze_Generic_Formal_Part (N : Node_Id);
352 -- Analyze generic formal part
354 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
355 -- Create a new access type with the given designated type
357 function Analyze_Associations
360 F_Copy : List_Id) return List_Id;
361 -- At instantiation time, build the list of associations between formals
362 -- and actuals. Each association becomes a renaming declaration for the
363 -- formal entity. F_Copy is the analyzed list of formals in the generic
364 -- copy. It is used to apply legality checks to the actuals. I_Node is the
365 -- instantiation node itself.
367 procedure Analyze_Subprogram_Instantiation
371 procedure Build_Instance_Compilation_Unit_Nodes
375 -- This procedure is used in the case where the generic instance of a
376 -- subprogram body or package body is a library unit. In this case, the
377 -- original library unit node for the generic instantiation must be
378 -- replaced by the resulting generic body, and a link made to a new
379 -- compilation unit node for the generic declaration. The argument N is
380 -- the original generic instantiation. Act_Body and Act_Decl are the body
381 -- and declaration of the instance (either package body and declaration
382 -- nodes or subprogram body and declaration nodes depending on the case).
383 -- On return, the node N has been rewritten with the actual body.
385 procedure Check_Access_Definition (N : Node_Id);
386 -- Subsidiary routine to null exclusion processing. Perform an assertion
387 -- check on Ada version and the presence of an access definition in N.
389 procedure Check_Formal_Packages (P_Id : Entity_Id);
390 -- Apply the following to all formal packages in generic associations
392 procedure Check_Formal_Package_Instance
393 (Formal_Pack : Entity_Id;
394 Actual_Pack : Entity_Id);
395 -- Verify that the actuals of the actual instance match the actuals of
396 -- the template for a formal package that is not declared with a box.
398 procedure Check_Forward_Instantiation (Decl : Node_Id);
399 -- If the generic is a local entity and the corresponding body has not
400 -- been seen yet, flag enclosing packages to indicate that it will be
401 -- elaborated after the generic body. Subprograms declared in the same
402 -- package cannot be inlined by the front-end because front-end inlining
403 -- requires a strict linear order of elaboration.
405 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id;
406 -- Check if some association between formals and actuals requires to make
407 -- visible primitives of a tagged type, and make those primitives visible.
408 -- Return the list of primitives whose visibility is modified (to restore
409 -- their visibility later through Restore_Hidden_Primitives). If no
410 -- candidate is found then return No_Elist.
412 procedure Check_Hidden_Child_Unit
414 Gen_Unit : Entity_Id;
415 Act_Decl_Id : Entity_Id);
416 -- If the generic unit is an implicit child instance within a parent
417 -- instance, we need to make an explicit test that it is not hidden by
418 -- a child instance of the same name and parent.
420 procedure Check_Generic_Actuals
421 (Instance : Entity_Id;
422 Is_Formal_Box : Boolean);
423 -- Similar to previous one. Check the actuals in the instantiation,
424 -- whose views can change between the point of instantiation and the point
425 -- of instantiation of the body. In addition, mark the generic renamings
426 -- as generic actuals, so that they are not compatible with other actuals.
427 -- Recurse on an actual that is a formal package whose declaration has
430 function Contains_Instance_Of
433 N : Node_Id) return Boolean;
434 -- Inner is instantiated within the generic Outer. Check whether Inner
435 -- directly or indirectly contains an instance of Outer or of one of its
436 -- parents, in the case of a subunit. Each generic unit holds a list of
437 -- the entities instantiated within (at any depth). This procedure
438 -- determines whether the set of such lists contains a cycle, i.e. an
439 -- illegal circular instantiation.
441 function Denotes_Formal_Package
443 On_Exit : Boolean := False;
444 Instance : Entity_Id := Empty) return Boolean;
445 -- Returns True if E is a formal package of an enclosing generic, or
446 -- the actual for such a formal in an enclosing instantiation. If such
447 -- a package is used as a formal in an nested generic, or as an actual
448 -- in a nested instantiation, the visibility of ITS formals should not
449 -- be modified. When called from within Restore_Private_Views, the flag
450 -- On_Exit is true, to indicate that the search for a possible enclosing
451 -- instance should ignore the current one. In that case Instance denotes
452 -- the declaration for which this is an actual. This declaration may be
453 -- an instantiation in the source, or the internal instantiation that
454 -- corresponds to the actual for a formal package.
456 function Earlier (N1, N2 : Node_Id) return Boolean;
457 -- Yields True if N1 and N2 appear in the same compilation unit,
458 -- ignoring subunits, and if N1 is to the left of N2 in a left-to-right
459 -- traversal of the tree for the unit. Used to determine the placement
460 -- of freeze nodes for instance bodies that may depend on other instances.
462 function Find_Actual_Type
464 Gen_Type : Entity_Id) return Entity_Id;
465 -- When validating the actual types of a child instance, check whether
466 -- the formal is a formal type of the parent unit, and retrieve the current
467 -- actual for it. Typ is the entity in the analyzed formal type declaration
468 -- (component or index type of an array type, or designated type of an
469 -- access formal) and Gen_Type is the enclosing analyzed formal array
470 -- or access type. The desired actual may be a formal of a parent, or may
471 -- be declared in a formal package of a parent. In both cases it is a
472 -- generic actual type because it appears within a visible instance.
473 -- Finally, it may be declared in a parent unit without being a formal
474 -- of that unit, in which case it must be retrieved by visibility.
475 -- Ambiguities may still arise if two homonyms are declared in two formal
476 -- packages, and the prefix of the formal type may be needed to resolve
477 -- the ambiguity in the instance ???
479 function In_Same_Declarative_Part
481 Inst : Node_Id) return Boolean;
482 -- True if the instantiation Inst and the given freeze_node F_Node appear
483 -- within the same declarative part, ignoring subunits, but with no inter-
484 -- vening subprograms or concurrent units. Used to find the proper plave
485 -- for the freeze node of an instance, when the generic is declared in a
486 -- previous instance. If predicate is true, the freeze node of the instance
487 -- can be placed after the freeze node of the previous instance, Otherwise
488 -- it has to be placed at the end of the current declarative part.
490 function In_Main_Context (E : Entity_Id) return Boolean;
491 -- Check whether an instantiation is in the context of the main unit.
492 -- Used to determine whether its body should be elaborated to allow
493 -- front-end inlining.
495 procedure Set_Instance_Env
496 (Gen_Unit : Entity_Id;
497 Act_Unit : Entity_Id);
498 -- Save current instance on saved environment, to be used to determine
499 -- the global status of entities in nested instances. Part of Save_Env.
500 -- called after verifying that the generic unit is legal for the instance,
501 -- The procedure also examines whether the generic unit is a predefined
502 -- unit, in order to set configuration switches accordingly. As a result
503 -- the procedure must be called after analyzing and freezing the actuals.
505 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id);
506 -- Associate analyzed generic parameter with corresponding
507 -- instance. Used for semantic checks at instantiation time.
509 function Has_Been_Exchanged (E : Entity_Id) return Boolean;
510 -- Traverse the Exchanged_Views list to see if a type was private
511 -- and has already been flipped during this phase of instantiation.
513 procedure Hide_Current_Scope;
514 -- When instantiating a generic child unit, the parent context must be
515 -- present, but the instance and all entities that may be generated
516 -- must be inserted in the current scope. We leave the current scope
517 -- on the stack, but make its entities invisible to avoid visibility
518 -- problems. This is reversed at the end of the instantiation. This is
519 -- not done for the instantiation of the bodies, which only require the
520 -- instances of the generic parents to be in scope.
522 procedure Install_Body
527 -- If the instantiation happens textually before the body of the generic,
528 -- the instantiation of the body must be analyzed after the generic body,
529 -- and not at the point of instantiation. Such early instantiations can
530 -- happen if the generic and the instance appear in a package declaration
531 -- because the generic body can only appear in the corresponding package
532 -- body. Early instantiations can also appear if generic, instance and
533 -- body are all in the declarative part of a subprogram or entry. Entities
534 -- of packages that are early instantiations are delayed, and their freeze
535 -- node appears after the generic body.
537 procedure Insert_Freeze_Node_For_Instance
540 -- N denotes a package or a subprogram instantiation and F_Node is the
541 -- associated freeze node. Insert the freeze node before the first source
542 -- body which follows immediately after N. If no such body is found, the
543 -- freeze node is inserted at the end of the declarative region which
546 procedure Freeze_Subprogram_Body
547 (Inst_Node : Node_Id;
549 Pack_Id : Entity_Id);
550 -- The generic body may appear textually after the instance, including
551 -- in the proper body of a stub, or within a different package instance.
552 -- Given that the instance can only be elaborated after the generic, we
553 -- place freeze_nodes for the instance and/or for packages that may enclose
554 -- the instance and the generic, so that the back-end can establish the
555 -- proper order of elaboration.
558 -- Establish environment for subsequent instantiation. Separated from
559 -- Save_Env because data-structures for visibility handling must be
560 -- initialized before call to Check_Generic_Child_Unit.
562 procedure Install_Formal_Packages (Par : Entity_Id);
563 -- Install the visible part of any formal of the parent that is a formal
564 -- package. Note that for the case of a formal package with a box, this
565 -- includes the formal part of the formal package (12.7(10/2)).
567 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False);
568 -- When compiling an instance of a child unit the parent (which is
569 -- itself an instance) is an enclosing scope that must be made
570 -- immediately visible. This procedure is also used to install the non-
571 -- generic parent of a generic child unit when compiling its body, so
572 -- that full views of types in the parent are made visible.
574 procedure Remove_Parent (In_Body : Boolean := False);
575 -- Reverse effect after instantiation of child is complete
577 procedure Install_Hidden_Primitives
578 (Prims_List : in out Elist_Id;
581 -- Remove suffix 'P' from hidden primitives of Act_T to match the
582 -- visibility of primitives of Gen_T. The list of primitives to which
583 -- the suffix is removed is added to Prims_List to restore them later.
585 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id);
586 -- Restore suffix 'P' to primitives of Prims_List and leave Prims_List
589 procedure Inline_Instance_Body
591 Gen_Unit : Entity_Id;
593 -- If front-end inlining is requested, instantiate the package body,
594 -- and preserve the visibility of its compilation unit, to insure
595 -- that successive instantiations succeed.
597 -- The functions Instantiate_XXX perform various legality checks and build
598 -- the declarations for instantiated generic parameters. In all of these
599 -- Formal is the entity in the generic unit, Actual is the entity of
600 -- expression in the generic associations, and Analyzed_Formal is the
601 -- formal in the generic copy, which contains the semantic information to
602 -- be used to validate the actual.
604 function Instantiate_Object
607 Analyzed_Formal : Node_Id) return List_Id;
609 function Instantiate_Type
612 Analyzed_Formal : Node_Id;
613 Actual_Decls : List_Id) return List_Id;
615 function Instantiate_Formal_Subprogram
618 Analyzed_Formal : Node_Id) return Node_Id;
620 function Instantiate_Formal_Package
623 Analyzed_Formal : Node_Id) return List_Id;
624 -- If the formal package is declared with a box, special visibility rules
625 -- apply to its formals: they are in the visible part of the package. This
626 -- is true in the declarative region of the formal package, that is to say
627 -- in the enclosing generic or instantiation. For an instantiation, the
628 -- parameters of the formal package are made visible in an explicit step.
629 -- Furthermore, if the actual has a visible USE clause, these formals must
630 -- be made potentially use-visible as well. On exit from the enclosing
631 -- instantiation, the reverse must be done.
633 -- For a formal package declared without a box, there are conformance rules
634 -- that apply to the actuals in the generic declaration and the actuals of
635 -- the actual package in the enclosing instantiation. The simplest way to
636 -- apply these rules is to repeat the instantiation of the formal package
637 -- in the context of the enclosing instance, and compare the generic
638 -- associations of this instantiation with those of the actual package.
639 -- This internal instantiation only needs to contain the renamings of the
640 -- formals: the visible and private declarations themselves need not be
643 -- In Ada 2005, the formal package may be only partially parameterized.
644 -- In that case the visibility step must make visible those actuals whose
645 -- corresponding formals were given with a box. A final complication
646 -- involves inherited operations from formal derived types, which must
647 -- be visible if the type is.
649 function Is_In_Main_Unit (N : Node_Id) return Boolean;
650 -- Test if given node is in the main unit
652 procedure Load_Parent_Of_Generic
655 Body_Optional : Boolean := False);
656 -- If the generic appears in a separate non-generic library unit, load the
657 -- corresponding body to retrieve the body of the generic. N is the node
658 -- for the generic instantiation, Spec is the generic package declaration.
660 -- Body_Optional is a flag that indicates that the body is being loaded to
661 -- ensure that temporaries are generated consistently when there are other
662 -- instances in the current declarative part that precede the one being
663 -- loaded. In that case a missing body is acceptable.
665 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id);
666 -- Add the context clause of the unit containing a generic unit to a
667 -- compilation unit that is, or contains, an instantiation.
669 function Get_Associated_Node (N : Node_Id) return Node_Id;
670 -- In order to propagate semantic information back from the analyzed copy
671 -- to the original generic, we maintain links between selected nodes in the
672 -- generic and their corresponding copies. At the end of generic analysis,
673 -- the routine Save_Global_References traverses the generic tree, examines
674 -- the semantic information, and preserves the links to those nodes that
675 -- contain global information. At instantiation, the information from the
676 -- associated node is placed on the new copy, so that name resolution is
679 -- Three kinds of source nodes have associated nodes:
681 -- a) those that can reference (denote) entities, that is identifiers,
682 -- character literals, expanded_names, operator symbols, operators,
683 -- and attribute reference nodes. These nodes have an Entity field
684 -- and are the set of nodes that are in N_Has_Entity.
686 -- b) aggregates (N_Aggregate and N_Extension_Aggregate)
688 -- c) selected components (N_Selected_Component)
690 -- For the first class, the associated node preserves the entity if it is
691 -- global. If the generic contains nested instantiations, the associated
692 -- node itself has been recopied, and a chain of them must be followed.
694 -- For aggregates, the associated node allows retrieval of the type, which
695 -- may otherwise not appear in the generic. The view of this type may be
696 -- different between generic and instantiation, and the full view can be
697 -- installed before the instantiation is analyzed. For aggregates of type
698 -- extensions, the same view exchange may have to be performed for some of
699 -- the ancestor types, if their view is private at the point of
702 -- Nodes that are selected components in the parse tree may be rewritten
703 -- as expanded names after resolution, and must be treated as potential
704 -- entity holders, which is why they also have an Associated_Node.
706 -- Nodes that do not come from source, such as freeze nodes, do not appear
707 -- in the generic tree, and need not have an associated node.
709 -- The associated node is stored in the Associated_Node field. Note that
710 -- this field overlaps Entity, which is fine, because the whole point is
711 -- that we don't need or want the normal Entity field in this situation.
713 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id);
714 -- Within the generic part, entities in the formal package are
715 -- visible. To validate subsequent type declarations, indicate
716 -- the correspondence between the entities in the analyzed formal,
717 -- and the entities in the actual package. There are three packages
718 -- involved in the instantiation of a formal package: the parent
719 -- generic P1 which appears in the generic declaration, the fake
720 -- instantiation P2 which appears in the analyzed generic, and whose
721 -- visible entities may be used in subsequent formals, and the actual
722 -- P3 in the instance. To validate subsequent formals, me indicate
723 -- that the entities in P2 are mapped into those of P3. The mapping of
724 -- entities has to be done recursively for nested packages.
726 procedure Move_Freeze_Nodes
730 -- Freeze nodes can be generated in the analysis of a generic unit, but
731 -- will not be seen by the back-end. It is necessary to move those nodes
732 -- to the enclosing scope if they freeze an outer entity. We place them
733 -- at the end of the enclosing generic package, which is semantically
736 procedure Preanalyze_Actuals (N : Node_Id);
737 -- Analyze actuals to perform name resolution. Full resolution is done
738 -- later, when the expected types are known, but names have to be captured
739 -- before installing parents of generics, that are not visible for the
740 -- actuals themselves.
742 function True_Parent (N : Node_Id) return Node_Id;
743 -- For a subunit, return parent of corresponding stub, else return
746 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id);
747 -- Verify that an attribute that appears as the default for a formal
748 -- subprogram is a function or procedure with the correct profile.
750 -------------------------------------------
751 -- Data Structures for Generic Renamings --
752 -------------------------------------------
754 -- The map Generic_Renamings associates generic entities with their
755 -- corresponding actuals. Currently used to validate type instances. It
756 -- will eventually be used for all generic parameters to eliminate the
757 -- need for overload resolution in the instance.
759 type Assoc_Ptr is new Int;
761 Assoc_Null : constant Assoc_Ptr := -1;
766 Next_In_HTable : Assoc_Ptr;
769 package Generic_Renamings is new Table.Table
770 (Table_Component_Type => Assoc,
771 Table_Index_Type => Assoc_Ptr,
772 Table_Low_Bound => 0,
774 Table_Increment => 100,
775 Table_Name => "Generic_Renamings");
777 -- Variable to hold enclosing instantiation. When the environment is
778 -- saved for a subprogram inlining, the corresponding Act_Id is empty.
780 Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
782 -- Hash table for associations
784 HTable_Size : constant := 37;
785 type HTable_Range is range 0 .. HTable_Size - 1;
787 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr);
788 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr;
789 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id;
790 function Hash (F : Entity_Id) return HTable_Range;
792 package Generic_Renamings_HTable is new GNAT.HTable.Static_HTable (
793 Header_Num => HTable_Range,
795 Elmt_Ptr => Assoc_Ptr,
796 Null_Ptr => Assoc_Null,
797 Set_Next => Set_Next_Assoc,
800 Get_Key => Get_Gen_Id,
804 Exchanged_Views : Elist_Id;
805 -- This list holds the private views that have been exchanged during
806 -- instantiation to restore the visibility of the generic declaration.
807 -- (see comments above). After instantiation, the current visibility is
808 -- reestablished by means of a traversal of this list.
810 Hidden_Entities : Elist_Id;
811 -- This list holds the entities of the current scope that are removed
812 -- from immediate visibility when instantiating a child unit. Their
813 -- visibility is restored in Remove_Parent.
815 -- Because instantiations can be recursive, the following must be saved
816 -- on entry and restored on exit from an instantiation (spec or body).
817 -- This is done by the two procedures Save_Env and Restore_Env. For
818 -- package and subprogram instantiations (but not for the body instances)
819 -- the action of Save_Env is done in two steps: Init_Env is called before
820 -- Check_Generic_Child_Unit, because setting the parent instances requires
821 -- that the visibility data structures be properly initialized. Once the
822 -- generic is unit is validated, Set_Instance_Env completes Save_Env.
824 Parent_Unit_Visible : Boolean := False;
825 -- Parent_Unit_Visible is used when the generic is a child unit, and
826 -- indicates whether the ultimate parent of the generic is visible in the
827 -- instantiation environment. It is used to reset the visibility of the
828 -- parent at the end of the instantiation (see Remove_Parent).
830 Instance_Parent_Unit : Entity_Id := Empty;
831 -- This records the ultimate parent unit of an instance of a generic
832 -- child unit and is used in conjunction with Parent_Unit_Visible to
833 -- indicate the unit to which the Parent_Unit_Visible flag corresponds.
835 type Instance_Env is record
836 Instantiated_Parent : Assoc;
837 Exchanged_Views : Elist_Id;
838 Hidden_Entities : Elist_Id;
839 Current_Sem_Unit : Unit_Number_Type;
840 Parent_Unit_Visible : Boolean := False;
841 Instance_Parent_Unit : Entity_Id := Empty;
842 Switches : Config_Switches_Type;
845 package Instance_Envs is new Table.Table (
846 Table_Component_Type => Instance_Env,
847 Table_Index_Type => Int,
848 Table_Low_Bound => 0,
850 Table_Increment => 100,
851 Table_Name => "Instance_Envs");
853 procedure Restore_Private_Views
854 (Pack_Id : Entity_Id;
855 Is_Package : Boolean := True);
856 -- Restore the private views of external types, and unmark the generic
857 -- renamings of actuals, so that they become compatible subtypes again.
858 -- For subprograms, Pack_Id is the package constructed to hold the
861 procedure Switch_View (T : Entity_Id);
862 -- Switch the partial and full views of a type and its private
863 -- dependents (i.e. its subtypes and derived types).
865 ------------------------------------
866 -- Structures for Error Reporting --
867 ------------------------------------
869 Instantiation_Node : Node_Id;
870 -- Used by subprograms that validate instantiation of formal parameters
871 -- where there might be no actual on which to place the error message.
872 -- Also used to locate the instantiation node for generic subunits.
874 Instantiation_Error : exception;
875 -- When there is a semantic error in the generic parameter matching,
876 -- there is no point in continuing the instantiation, because the
877 -- number of cascaded errors is unpredictable. This exception aborts
878 -- the instantiation process altogether.
880 S_Adjustment : Sloc_Adjustment;
881 -- Offset created for each node in an instantiation, in order to keep
882 -- track of the source position of the instantiation in each of its nodes.
883 -- A subsequent semantic error or warning on a construct of the instance
884 -- points to both places: the original generic node, and the point of
885 -- instantiation. See Sinput and Sinput.L for additional details.
887 ------------------------------------------------------------
888 -- Data structure for keeping track when inside a Generic --
889 ------------------------------------------------------------
891 -- The following table is used to save values of the Inside_A_Generic
892 -- flag (see spec of Sem) when they are saved by Start_Generic.
894 package Generic_Flags is new Table.Table (
895 Table_Component_Type => Boolean,
896 Table_Index_Type => Int,
897 Table_Low_Bound => 0,
899 Table_Increment => 200,
900 Table_Name => "Generic_Flags");
902 ---------------------------
903 -- Abandon_Instantiation --
904 ---------------------------
906 procedure Abandon_Instantiation (N : Node_Id) is
908 Error_Msg_N ("\instantiation abandoned!", N);
909 raise Instantiation_Error;
910 end Abandon_Instantiation;
912 --------------------------
913 -- Analyze_Associations --
914 --------------------------
916 function Analyze_Associations
919 F_Copy : List_Id) return List_Id
921 Actuals_To_Freeze : constant Elist_Id := New_Elmt_List;
922 Assoc : constant List_Id := New_List;
923 Default_Actuals : constant Elist_Id := New_Elmt_List;
924 Gen_Unit : constant Entity_Id :=
925 Defining_Entity (Parent (F_Copy));
929 Analyzed_Formal : Node_Id;
930 First_Named : Node_Id := Empty;
934 Saved_Formal : Node_Id;
936 Default_Formals : constant List_Id := New_List;
937 -- If an Others_Choice is present, some of the formals may be defaulted.
938 -- To simplify the treatment of visibility in an instance, we introduce
939 -- individual defaults for each such formal. These defaults are
940 -- appended to the list of associations and replace the Others_Choice.
942 Found_Assoc : Node_Id;
943 -- Association for the current formal being match. Empty if there are
944 -- no remaining actuals, or if there is no named association with the
945 -- name of the formal.
947 Is_Named_Assoc : Boolean;
948 Num_Matched : Int := 0;
949 Num_Actuals : Int := 0;
951 Others_Present : Boolean := False;
952 Others_Choice : Node_Id := Empty;
953 -- In Ada 2005, indicates partial parametrization of a formal
954 -- package. As usual an other association must be last in the list.
956 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id);
957 -- Apply RM 12.3 (9): if a formal subprogram is overloaded, the instance
958 -- cannot have a named association for it. AI05-0025 extends this rule
959 -- to formals of formal packages by AI05-0025, and it also applies to
960 -- box-initialized formals.
962 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean;
963 -- Determine whether the parameter types and the return type of Subp
964 -- are fully defined at the point of instantiation.
966 function Matching_Actual
968 A_F : Entity_Id) return Node_Id;
969 -- Find actual that corresponds to a given a formal parameter. If the
970 -- actuals are positional, return the next one, if any. If the actuals
971 -- are named, scan the parameter associations to find the right one.
972 -- A_F is the corresponding entity in the analyzed generic,which is
973 -- placed on the selector name for ASIS use.
975 -- In Ada 2005, a named association may be given with a box, in which
976 -- case Matching_Actual sets Found_Assoc to the generic association,
977 -- but return Empty for the actual itself. In this case the code below
978 -- creates a corresponding declaration for the formal.
980 function Partial_Parametrization return Boolean;
981 -- Ada 2005: if no match is found for a given formal, check if the
982 -- association for it includes a box, or whether the associations
983 -- include an Others clause.
985 procedure Process_Default (F : Entity_Id);
986 -- Add a copy of the declaration of generic formal F to the list of
987 -- associations, and add an explicit box association for F if there
988 -- is none yet, and the default comes from an Others_Choice.
990 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean;
991 -- Determine whether Subp renames one of the subprograms defined in the
992 -- generated package Standard.
994 procedure Set_Analyzed_Formal;
995 -- Find the node in the generic copy that corresponds to a given formal.
996 -- The semantic information on this node is used to perform legality
997 -- checks on the actuals. Because semantic analysis can introduce some
998 -- anonymous entities or modify the declaration node itself, the
999 -- correspondence between the two lists is not one-one. In addition to
1000 -- anonymous types, the presence a formal equality will introduce an
1001 -- implicit declaration for the corresponding inequality.
1003 ----------------------------------------
1004 -- Check_Overloaded_Formal_Subprogram --
1005 ----------------------------------------
1007 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id) is
1008 Temp_Formal : Entity_Id;
1011 Temp_Formal := First (Formals);
1012 while Present (Temp_Formal) loop
1013 if Nkind (Temp_Formal) in N_Formal_Subprogram_Declaration
1014 and then Temp_Formal /= Formal
1016 Chars (Defining_Unit_Name (Specification (Formal))) =
1017 Chars (Defining_Unit_Name (Specification (Temp_Formal)))
1019 if Present (Found_Assoc) then
1021 ("named association not allowed for overloaded formal",
1026 ("named association not allowed for overloaded formal",
1030 Abandon_Instantiation (Instantiation_Node);
1035 end Check_Overloaded_Formal_Subprogram;
1037 -------------------------------
1038 -- Has_Fully_Defined_Profile --
1039 -------------------------------
1041 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean is
1042 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean;
1043 -- Determine whethet type Typ is fully defined
1045 ---------------------------
1046 -- Is_Fully_Defined_Type --
1047 ---------------------------
1049 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean is
1051 -- A private type without a full view is not fully defined
1053 if Is_Private_Type (Typ)
1054 and then No (Full_View (Typ))
1058 -- An incomplete type is never fully defined
1060 elsif Is_Incomplete_Type (Typ) then
1063 -- All other types are fully defined
1068 end Is_Fully_Defined_Type;
1070 -- Local declarations
1074 -- Start of processing for Has_Fully_Defined_Profile
1077 -- Check the parameters
1079 Param := First_Formal (Subp);
1080 while Present (Param) loop
1081 if not Is_Fully_Defined_Type (Etype (Param)) then
1085 Next_Formal (Param);
1088 -- Check the return type
1090 return Is_Fully_Defined_Type (Etype (Subp));
1091 end Has_Fully_Defined_Profile;
1093 ---------------------
1094 -- Matching_Actual --
1095 ---------------------
1097 function Matching_Actual
1099 A_F : Entity_Id) return Node_Id
1105 Is_Named_Assoc := False;
1107 -- End of list of purely positional parameters
1109 if No (Actual) or else Nkind (Actual) = N_Others_Choice then
1110 Found_Assoc := Empty;
1113 -- Case of positional parameter corresponding to current formal
1115 elsif No (Selector_Name (Actual)) then
1116 Found_Assoc := Actual;
1117 Act := Explicit_Generic_Actual_Parameter (Actual);
1118 Num_Matched := Num_Matched + 1;
1121 -- Otherwise scan list of named actuals to find the one with the
1122 -- desired name. All remaining actuals have explicit names.
1125 Is_Named_Assoc := True;
1126 Found_Assoc := Empty;
1130 while Present (Actual) loop
1131 if Chars (Selector_Name (Actual)) = Chars (F) then
1132 Set_Entity (Selector_Name (Actual), A_F);
1133 Set_Etype (Selector_Name (Actual), Etype (A_F));
1134 Generate_Reference (A_F, Selector_Name (Actual));
1135 Found_Assoc := Actual;
1136 Act := Explicit_Generic_Actual_Parameter (Actual);
1137 Num_Matched := Num_Matched + 1;
1145 -- Reset for subsequent searches. In most cases the named
1146 -- associations are in order. If they are not, we reorder them
1147 -- to avoid scanning twice the same actual. This is not just a
1148 -- question of efficiency: there may be multiple defaults with
1149 -- boxes that have the same name. In a nested instantiation we
1150 -- insert actuals for those defaults, and cannot rely on their
1151 -- names to disambiguate them.
1153 if Actual = First_Named then
1156 elsif Present (Actual) then
1157 Insert_Before (First_Named, Remove_Next (Prev));
1160 Actual := First_Named;
1163 if Is_Entity_Name (Act) and then Present (Entity (Act)) then
1164 Set_Used_As_Generic_Actual (Entity (Act));
1168 end Matching_Actual;
1170 -----------------------------
1171 -- Partial_Parametrization --
1172 -----------------------------
1174 function Partial_Parametrization return Boolean is
1176 return Others_Present
1177 or else (Present (Found_Assoc) and then Box_Present (Found_Assoc));
1178 end Partial_Parametrization;
1180 ---------------------
1181 -- Process_Default --
1182 ---------------------
1184 procedure Process_Default (F : Entity_Id) is
1185 Loc : constant Source_Ptr := Sloc (I_Node);
1186 F_Id : constant Entity_Id := Defining_Entity (F);
1192 -- Append copy of formal declaration to associations, and create new
1193 -- defining identifier for it.
1195 Decl := New_Copy_Tree (F);
1196 Id := Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id));
1198 if Nkind (F) in N_Formal_Subprogram_Declaration then
1199 Set_Defining_Unit_Name (Specification (Decl), Id);
1202 Set_Defining_Identifier (Decl, Id);
1205 Append (Decl, Assoc);
1207 if No (Found_Assoc) then
1209 Make_Generic_Association (Loc,
1210 Selector_Name => New_Occurrence_Of (Id, Loc),
1211 Explicit_Generic_Actual_Parameter => Empty);
1212 Set_Box_Present (Default);
1213 Append (Default, Default_Formals);
1215 end Process_Default;
1217 ---------------------------------
1218 -- Renames_Standard_Subprogram --
1219 ---------------------------------
1221 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean is
1226 while Present (Id) loop
1227 if Scope (Id) = Standard_Standard then
1235 end Renames_Standard_Subprogram;
1237 -------------------------
1238 -- Set_Analyzed_Formal --
1239 -------------------------
1241 procedure Set_Analyzed_Formal is
1245 while Present (Analyzed_Formal) loop
1246 Kind := Nkind (Analyzed_Formal);
1248 case Nkind (Formal) is
1250 when N_Formal_Subprogram_Declaration =>
1251 exit when Kind in N_Formal_Subprogram_Declaration
1254 (Defining_Unit_Name (Specification (Formal))) =
1256 (Defining_Unit_Name (Specification (Analyzed_Formal)));
1258 when N_Formal_Package_Declaration =>
1259 exit when Nkind_In (Kind, N_Formal_Package_Declaration,
1260 N_Generic_Package_Declaration,
1261 N_Package_Declaration);
1263 when N_Use_Package_Clause | N_Use_Type_Clause => exit;
1267 -- Skip freeze nodes, and nodes inserted to replace
1268 -- unrecognized pragmas.
1271 Kind not in N_Formal_Subprogram_Declaration
1272 and then not Nkind_In (Kind, N_Subprogram_Declaration,
1276 and then Chars (Defining_Identifier (Formal)) =
1277 Chars (Defining_Identifier (Analyzed_Formal));
1280 Next (Analyzed_Formal);
1282 end Set_Analyzed_Formal;
1284 -- Start of processing for Analyze_Associations
1287 Actuals := Generic_Associations (I_Node);
1289 if Present (Actuals) then
1291 -- Check for an Others choice, indicating a partial parametrization
1292 -- for a formal package.
1294 Actual := First (Actuals);
1295 while Present (Actual) loop
1296 if Nkind (Actual) = N_Others_Choice then
1297 Others_Present := True;
1298 Others_Choice := Actual;
1300 if Present (Next (Actual)) then
1301 Error_Msg_N ("others must be last association", Actual);
1304 -- This subprogram is used both for formal packages and for
1305 -- instantiations. For the latter, associations must all be
1308 if Nkind (I_Node) /= N_Formal_Package_Declaration
1309 and then Comes_From_Source (I_Node)
1312 ("others association not allowed in an instance",
1316 -- In any case, nothing to do after the others association
1320 elsif Box_Present (Actual)
1321 and then Comes_From_Source (I_Node)
1322 and then Nkind (I_Node) /= N_Formal_Package_Declaration
1325 ("box association not allowed in an instance", Actual);
1331 -- If named associations are present, save first named association
1332 -- (it may of course be Empty) to facilitate subsequent name search.
1334 First_Named := First (Actuals);
1335 while Present (First_Named)
1336 and then Nkind (First_Named) /= N_Others_Choice
1337 and then No (Selector_Name (First_Named))
1339 Num_Actuals := Num_Actuals + 1;
1344 Named := First_Named;
1345 while Present (Named) loop
1346 if Nkind (Named) /= N_Others_Choice
1347 and then No (Selector_Name (Named))
1349 Error_Msg_N ("invalid positional actual after named one", Named);
1350 Abandon_Instantiation (Named);
1353 -- A named association may lack an actual parameter, if it was
1354 -- introduced for a default subprogram that turns out to be local
1355 -- to the outer instantiation.
1357 if Nkind (Named) /= N_Others_Choice
1358 and then Present (Explicit_Generic_Actual_Parameter (Named))
1360 Num_Actuals := Num_Actuals + 1;
1366 if Present (Formals) then
1367 Formal := First_Non_Pragma (Formals);
1368 Analyzed_Formal := First_Non_Pragma (F_Copy);
1370 if Present (Actuals) then
1371 Actual := First (Actuals);
1373 -- All formals should have default values
1379 while Present (Formal) loop
1380 Set_Analyzed_Formal;
1381 Saved_Formal := Next_Non_Pragma (Formal);
1383 case Nkind (Formal) is
1384 when N_Formal_Object_Declaration =>
1387 Defining_Identifier (Formal),
1388 Defining_Identifier (Analyzed_Formal));
1390 if No (Match) and then Partial_Parametrization then
1391 Process_Default (Formal);
1394 (Instantiate_Object (Formal, Match, Analyzed_Formal),
1398 when N_Formal_Type_Declaration =>
1401 Defining_Identifier (Formal),
1402 Defining_Identifier (Analyzed_Formal));
1405 if Partial_Parametrization then
1406 Process_Default (Formal);
1409 Error_Msg_Sloc := Sloc (Gen_Unit);
1413 Defining_Identifier (Formal));
1414 Error_Msg_NE ("\in instantiation of & declared#",
1415 Instantiation_Node, Gen_Unit);
1416 Abandon_Instantiation (Instantiation_Node);
1423 (Formal, Match, Analyzed_Formal, Assoc),
1426 -- An instantiation is a freeze point for the actuals,
1427 -- unless this is a rewritten formal package, or the
1428 -- formal is an Ada 2012 formal incomplete type.
1430 if Nkind (I_Node) = N_Formal_Package_Declaration
1432 (Ada_Version >= Ada_2012
1434 Ekind (Defining_Identifier (Analyzed_Formal)) =
1440 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1444 -- A remote access-to-class-wide type is not a legal actual
1445 -- for a generic formal of an access type (E.2.2(17/2)).
1446 -- In GNAT an exception to this rule is introduced when
1447 -- the formal is marked as remote using implementation
1448 -- defined aspect/pragma Remote_Access_Type. In that case
1449 -- the actual must be remote as well.
1451 -- If the current instantiation is the construction of a
1452 -- local copy for a formal package the actuals may be
1453 -- defaulted, and there is no matching actual to check.
1455 if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1457 Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1458 N_Access_To_Object_Definition
1459 and then Present (Match)
1462 Formal_Ent : constant Entity_Id :=
1463 Defining_Identifier (Analyzed_Formal);
1465 if Is_Remote_Access_To_Class_Wide_Type (Entity (Match))
1466 = Is_Remote_Types (Formal_Ent)
1468 -- Remoteness of formal and actual match
1472 elsif Is_Remote_Types (Formal_Ent) then
1474 -- Remote formal, non-remote actual
1477 ("actual for& must be remote", Match, Formal_Ent);
1480 -- Non-remote formal, remote actual
1483 ("actual for& may not be remote",
1489 when N_Formal_Subprogram_Declaration =>
1492 (Defining_Unit_Name (Specification (Formal)),
1493 Defining_Unit_Name (Specification (Analyzed_Formal)));
1495 -- If the formal subprogram has the same name as another
1496 -- formal subprogram of the generic, then a named
1497 -- association is illegal (12.3(9)). Exclude named
1498 -- associations that are generated for a nested instance.
1501 and then Is_Named_Assoc
1502 and then Comes_From_Source (Found_Assoc)
1504 Check_Overloaded_Formal_Subprogram (Formal);
1507 -- If there is no corresponding actual, this may be case of
1508 -- partial parametrization, or else the formal has a default
1511 if No (Match) and then Partial_Parametrization then
1512 Process_Default (Formal);
1514 if Nkind (I_Node) = N_Formal_Package_Declaration then
1515 Check_Overloaded_Formal_Subprogram (Formal);
1520 Instantiate_Formal_Subprogram
1521 (Formal, Match, Analyzed_Formal));
1523 -- An instantiation is a freeze point for the actuals,
1524 -- unless this is a rewritten formal package.
1526 if Nkind (I_Node) /= N_Formal_Package_Declaration
1527 and then Nkind (Match) = N_Identifier
1528 and then Is_Subprogram (Entity (Match))
1530 -- The actual subprogram may rename a routine defined
1531 -- in Standard. Avoid freezing such renamings because
1532 -- subprograms coming from Standard cannot be frozen.
1535 not Renames_Standard_Subprogram (Entity (Match))
1537 -- If the actual subprogram comes from a different
1538 -- unit, it is already frozen, either by a body in
1539 -- that unit or by the end of the declarative part
1540 -- of the unit. This check avoids the freezing of
1541 -- subprograms defined in Standard which are used
1542 -- as generic actuals.
1544 and then In_Same_Code_Unit (Entity (Match), I_Node)
1545 and then Has_Fully_Defined_Profile (Entity (Match))
1547 -- Mark the subprogram as having a delayed freeze
1548 -- since this may be an out-of-order action.
1550 Set_Has_Delayed_Freeze (Entity (Match));
1551 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1555 -- If this is a nested generic, preserve default for later
1559 and then Box_Present (Formal)
1562 (Defining_Unit_Name (Specification (Last (Assoc))),
1566 when N_Formal_Package_Declaration =>
1569 Defining_Identifier (Formal),
1570 Defining_Identifier (Original_Node (Analyzed_Formal)));
1573 if Partial_Parametrization then
1574 Process_Default (Formal);
1577 Error_Msg_Sloc := Sloc (Gen_Unit);
1580 Instantiation_Node, Defining_Identifier (Formal));
1581 Error_Msg_NE ("\in instantiation of & declared#",
1582 Instantiation_Node, Gen_Unit);
1584 Abandon_Instantiation (Instantiation_Node);
1590 (Instantiate_Formal_Package
1591 (Formal, Match, Analyzed_Formal),
1595 -- For use type and use package appearing in the generic part,
1596 -- we have already copied them, so we can just move them where
1597 -- they belong (we mustn't recopy them since this would mess up
1598 -- the Sloc values).
1600 when N_Use_Package_Clause |
1601 N_Use_Type_Clause =>
1602 if Nkind (Original_Node (I_Node)) =
1603 N_Formal_Package_Declaration
1605 Append (New_Copy_Tree (Formal), Assoc);
1608 Append (Formal, Assoc);
1612 raise Program_Error;
1616 Formal := Saved_Formal;
1617 Next_Non_Pragma (Analyzed_Formal);
1620 if Num_Actuals > Num_Matched then
1621 Error_Msg_Sloc := Sloc (Gen_Unit);
1623 if Present (Selector_Name (Actual)) then
1625 ("unmatched actual&",
1626 Actual, Selector_Name (Actual));
1627 Error_Msg_NE ("\in instantiation of& declared#",
1631 ("unmatched actual in instantiation of& declared#",
1636 elsif Present (Actuals) then
1638 ("too many actuals in generic instantiation", Instantiation_Node);
1641 -- An instantiation freezes all generic actuals. The only exceptions
1642 -- to this are incomplete types and subprograms which are not fully
1643 -- defined at the point of instantiation.
1646 Elmt : Elmt_Id := First_Elmt (Actuals_To_Freeze);
1648 while Present (Elmt) loop
1649 Freeze_Before (I_Node, Node (Elmt));
1654 -- If there are default subprograms, normalize the tree by adding
1655 -- explicit associations for them. This is required if the instance
1656 -- appears within a generic.
1664 Elmt := First_Elmt (Default_Actuals);
1665 while Present (Elmt) loop
1666 if No (Actuals) then
1667 Actuals := New_List;
1668 Set_Generic_Associations (I_Node, Actuals);
1671 Subp := Node (Elmt);
1673 Make_Generic_Association (Sloc (Subp),
1674 Selector_Name => New_Occurrence_Of (Subp, Sloc (Subp)),
1675 Explicit_Generic_Actual_Parameter =>
1676 New_Occurrence_Of (Subp, Sloc (Subp)));
1677 Mark_Rewrite_Insertion (New_D);
1678 Append_To (Actuals, New_D);
1683 -- If this is a formal package, normalize the parameter list by adding
1684 -- explicit box associations for the formals that are covered by an
1687 if not Is_Empty_List (Default_Formals) then
1688 Append_List (Default_Formals, Formals);
1692 end Analyze_Associations;
1694 -------------------------------
1695 -- Analyze_Formal_Array_Type --
1696 -------------------------------
1698 procedure Analyze_Formal_Array_Type
1699 (T : in out Entity_Id;
1705 -- Treated like a non-generic array declaration, with additional
1710 if Nkind (Def) = N_Constrained_Array_Definition then
1711 DSS := First (Discrete_Subtype_Definitions (Def));
1712 while Present (DSS) loop
1713 if Nkind_In (DSS, N_Subtype_Indication,
1715 N_Attribute_Reference)
1717 Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
1724 Array_Type_Declaration (T, Def);
1725 Set_Is_Generic_Type (Base_Type (T));
1727 if Ekind (Component_Type (T)) = E_Incomplete_Type
1728 and then No (Full_View (Component_Type (T)))
1730 Error_Msg_N ("premature usage of incomplete type", Def);
1732 -- Check that range constraint is not allowed on the component type
1733 -- of a generic formal array type (AARM 12.5.3(3))
1735 elsif Is_Internal (Component_Type (T))
1736 and then Present (Subtype_Indication (Component_Definition (Def)))
1737 and then Nkind (Original_Node
1738 (Subtype_Indication (Component_Definition (Def)))) =
1739 N_Subtype_Indication
1742 ("in a formal, a subtype indication can only be "
1743 & "a subtype mark (RM 12.5.3(3))",
1744 Subtype_Indication (Component_Definition (Def)));
1747 end Analyze_Formal_Array_Type;
1749 ---------------------------------------------
1750 -- Analyze_Formal_Decimal_Fixed_Point_Type --
1751 ---------------------------------------------
1753 -- As for other generic types, we create a valid type representation with
1754 -- legal but arbitrary attributes, whose values are never considered
1755 -- static. For all scalar types we introduce an anonymous base type, with
1756 -- the same attributes. We choose the corresponding integer type to be
1757 -- Standard_Integer.
1758 -- Here and in other similar routines, the Sloc of the generated internal
1759 -- type must be the same as the sloc of the defining identifier of the
1760 -- formal type declaration, to provide proper source navigation.
1762 procedure Analyze_Formal_Decimal_Fixed_Point_Type
1766 Loc : constant Source_Ptr := Sloc (Def);
1768 Base : constant Entity_Id :=
1770 (E_Decimal_Fixed_Point_Type,
1772 Sloc (Defining_Identifier (Parent (Def))), 'G');
1774 Int_Base : constant Entity_Id := Standard_Integer;
1775 Delta_Val : constant Ureal := Ureal_1;
1776 Digs_Val : constant Uint := Uint_6;
1781 Set_Etype (Base, Base);
1782 Set_Size_Info (Base, Int_Base);
1783 Set_RM_Size (Base, RM_Size (Int_Base));
1784 Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
1785 Set_Digits_Value (Base, Digs_Val);
1786 Set_Delta_Value (Base, Delta_Val);
1787 Set_Small_Value (Base, Delta_Val);
1788 Set_Scalar_Range (Base,
1790 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
1791 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
1793 Set_Is_Generic_Type (Base);
1794 Set_Parent (Base, Parent (Def));
1796 Set_Ekind (T, E_Decimal_Fixed_Point_Subtype);
1797 Set_Etype (T, Base);
1798 Set_Size_Info (T, Int_Base);
1799 Set_RM_Size (T, RM_Size (Int_Base));
1800 Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
1801 Set_Digits_Value (T, Digs_Val);
1802 Set_Delta_Value (T, Delta_Val);
1803 Set_Small_Value (T, Delta_Val);
1804 Set_Scalar_Range (T, Scalar_Range (Base));
1805 Set_Is_Constrained (T);
1807 Check_Restriction (No_Fixed_Point, Def);
1808 end Analyze_Formal_Decimal_Fixed_Point_Type;
1810 -------------------------------------------
1811 -- Analyze_Formal_Derived_Interface_Type --
1812 -------------------------------------------
1814 procedure Analyze_Formal_Derived_Interface_Type
1819 Loc : constant Source_Ptr := Sloc (Def);
1822 -- Rewrite as a type declaration of a derived type. This ensures that
1823 -- the interface list and primitive operations are properly captured.
1826 Make_Full_Type_Declaration (Loc,
1827 Defining_Identifier => T,
1828 Type_Definition => Def));
1830 Set_Is_Generic_Type (T);
1831 end Analyze_Formal_Derived_Interface_Type;
1833 ---------------------------------
1834 -- Analyze_Formal_Derived_Type --
1835 ---------------------------------
1837 procedure Analyze_Formal_Derived_Type
1842 Loc : constant Source_Ptr := Sloc (Def);
1843 Unk_Disc : constant Boolean := Unknown_Discriminants_Present (N);
1847 Set_Is_Generic_Type (T);
1849 if Private_Present (Def) then
1851 Make_Private_Extension_Declaration (Loc,
1852 Defining_Identifier => T,
1853 Discriminant_Specifications => Discriminant_Specifications (N),
1854 Unknown_Discriminants_Present => Unk_Disc,
1855 Subtype_Indication => Subtype_Mark (Def),
1856 Interface_List => Interface_List (Def));
1858 Set_Abstract_Present (New_N, Abstract_Present (Def));
1859 Set_Limited_Present (New_N, Limited_Present (Def));
1860 Set_Synchronized_Present (New_N, Synchronized_Present (Def));
1864 Make_Full_Type_Declaration (Loc,
1865 Defining_Identifier => T,
1866 Discriminant_Specifications =>
1867 Discriminant_Specifications (Parent (T)),
1869 Make_Derived_Type_Definition (Loc,
1870 Subtype_Indication => Subtype_Mark (Def)));
1872 Set_Abstract_Present
1873 (Type_Definition (New_N), Abstract_Present (Def));
1875 (Type_Definition (New_N), Limited_Present (Def));
1882 if not Is_Composite_Type (T) then
1884 ("unknown discriminants not allowed for elementary types", N);
1886 Set_Has_Unknown_Discriminants (T);
1887 Set_Is_Constrained (T, False);
1891 -- If the parent type has a known size, so does the formal, which makes
1892 -- legal representation clauses that involve the formal.
1894 Set_Size_Known_At_Compile_Time
1895 (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
1896 end Analyze_Formal_Derived_Type;
1898 ----------------------------------
1899 -- Analyze_Formal_Discrete_Type --
1900 ----------------------------------
1902 -- The operations defined for a discrete types are those of an enumeration
1903 -- type. The size is set to an arbitrary value, for use in analyzing the
1906 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
1907 Loc : constant Source_Ptr := Sloc (Def);
1911 Base : constant Entity_Id :=
1913 (E_Floating_Point_Type, Current_Scope,
1914 Sloc (Defining_Identifier (Parent (Def))), 'G');
1918 Set_Ekind (T, E_Enumeration_Subtype);
1919 Set_Etype (T, Base);
1922 Set_Is_Generic_Type (T);
1923 Set_Is_Constrained (T);
1925 -- For semantic analysis, the bounds of the type must be set to some
1926 -- non-static value. The simplest is to create attribute nodes for those
1927 -- bounds, that refer to the type itself. These bounds are never
1928 -- analyzed but serve as place-holders.
1931 Make_Attribute_Reference (Loc,
1932 Attribute_Name => Name_First,
1933 Prefix => New_Reference_To (T, Loc));
1937 Make_Attribute_Reference (Loc,
1938 Attribute_Name => Name_Last,
1939 Prefix => New_Reference_To (T, Loc));
1942 Set_Scalar_Range (T,
1947 Set_Ekind (Base, E_Enumeration_Type);
1948 Set_Etype (Base, Base);
1949 Init_Size (Base, 8);
1950 Init_Alignment (Base);
1951 Set_Is_Generic_Type (Base);
1952 Set_Scalar_Range (Base, Scalar_Range (T));
1953 Set_Parent (Base, Parent (Def));
1954 end Analyze_Formal_Discrete_Type;
1956 ----------------------------------
1957 -- Analyze_Formal_Floating_Type --
1958 ---------------------------------
1960 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
1961 Base : constant Entity_Id :=
1963 (E_Floating_Point_Type, Current_Scope,
1964 Sloc (Defining_Identifier (Parent (Def))), 'G');
1967 -- The various semantic attributes are taken from the predefined type
1968 -- Float, just so that all of them are initialized. Their values are
1969 -- never used because no constant folding or expansion takes place in
1970 -- the generic itself.
1973 Set_Ekind (T, E_Floating_Point_Subtype);
1974 Set_Etype (T, Base);
1975 Set_Size_Info (T, (Standard_Float));
1976 Set_RM_Size (T, RM_Size (Standard_Float));
1977 Set_Digits_Value (T, Digits_Value (Standard_Float));
1978 Set_Scalar_Range (T, Scalar_Range (Standard_Float));
1979 Set_Is_Constrained (T);
1981 Set_Is_Generic_Type (Base);
1982 Set_Etype (Base, Base);
1983 Set_Size_Info (Base, (Standard_Float));
1984 Set_RM_Size (Base, RM_Size (Standard_Float));
1985 Set_Digits_Value (Base, Digits_Value (Standard_Float));
1986 Set_Scalar_Range (Base, Scalar_Range (Standard_Float));
1987 Set_Parent (Base, Parent (Def));
1989 Check_Restriction (No_Floating_Point, Def);
1990 end Analyze_Formal_Floating_Type;
1992 -----------------------------------
1993 -- Analyze_Formal_Interface_Type;--
1994 -----------------------------------
1996 procedure Analyze_Formal_Interface_Type
2001 Loc : constant Source_Ptr := Sloc (N);
2006 Make_Full_Type_Declaration (Loc,
2007 Defining_Identifier => T,
2008 Type_Definition => Def);
2012 Set_Is_Generic_Type (T);
2013 end Analyze_Formal_Interface_Type;
2015 ---------------------------------
2016 -- Analyze_Formal_Modular_Type --
2017 ---------------------------------
2019 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
2021 -- Apart from their entity kind, generic modular types are treated like
2022 -- signed integer types, and have the same attributes.
2024 Analyze_Formal_Signed_Integer_Type (T, Def);
2025 Set_Ekind (T, E_Modular_Integer_Subtype);
2026 Set_Ekind (Etype (T), E_Modular_Integer_Type);
2028 end Analyze_Formal_Modular_Type;
2030 ---------------------------------------
2031 -- Analyze_Formal_Object_Declaration --
2032 ---------------------------------------
2034 procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
2035 E : constant Node_Id := Default_Expression (N);
2036 Id : constant Node_Id := Defining_Identifier (N);
2043 -- Determine the mode of the formal object
2045 if Out_Present (N) then
2046 K := E_Generic_In_Out_Parameter;
2048 if not In_Present (N) then
2049 Error_Msg_N ("formal generic objects cannot have mode OUT", N);
2053 K := E_Generic_In_Parameter;
2056 if Present (Subtype_Mark (N)) then
2057 Find_Type (Subtype_Mark (N));
2058 T := Entity (Subtype_Mark (N));
2060 -- Verify that there is no redundant null exclusion
2062 if Null_Exclusion_Present (N) then
2063 if not Is_Access_Type (T) then
2065 ("null exclusion can only apply to an access type", N);
2067 elsif Can_Never_Be_Null (T) then
2069 ("`NOT NULL` not allowed (& already excludes null)",
2074 -- Ada 2005 (AI-423): Formal object with an access definition
2077 Check_Access_Definition (N);
2078 T := Access_Definition
2080 N => Access_Definition (N));
2083 if Ekind (T) = E_Incomplete_Type then
2085 Error_Node : Node_Id;
2088 if Present (Subtype_Mark (N)) then
2089 Error_Node := Subtype_Mark (N);
2091 Check_Access_Definition (N);
2092 Error_Node := Access_Definition (N);
2095 Error_Msg_N ("premature usage of incomplete type", Error_Node);
2099 if K = E_Generic_In_Parameter then
2101 -- Ada 2005 (AI-287): Limited aggregates allowed in generic formals
2103 if Ada_Version < Ada_2005 and then Is_Limited_Type (T) then
2105 ("generic formal of mode IN must not be of limited type", N);
2106 Explain_Limited_Type (T, N);
2109 if Is_Abstract_Type (T) then
2111 ("generic formal of mode IN must not be of abstract type", N);
2115 Preanalyze_Spec_Expression (E, T);
2117 if Is_Limited_Type (T) and then not OK_For_Limited_Init (T, E) then
2119 ("initialization not allowed for limited types", E);
2120 Explain_Limited_Type (T, E);
2127 -- Case of generic IN OUT parameter
2130 -- If the formal has an unconstrained type, construct its actual
2131 -- subtype, as is done for subprogram formals. In this fashion, all
2132 -- its uses can refer to specific bounds.
2137 if (Is_Array_Type (T)
2138 and then not Is_Constrained (T))
2140 (Ekind (T) = E_Record_Type
2141 and then Has_Discriminants (T))
2144 Non_Freezing_Ref : constant Node_Id :=
2145 New_Reference_To (Id, Sloc (Id));
2149 -- Make sure the actual subtype doesn't generate bogus freezing
2151 Set_Must_Not_Freeze (Non_Freezing_Ref);
2152 Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
2153 Insert_Before_And_Analyze (N, Decl);
2154 Set_Actual_Subtype (Id, Defining_Identifier (Decl));
2157 Set_Actual_Subtype (Id, T);
2162 ("initialization not allowed for `IN OUT` formals", N);
2166 if Has_Aspects (N) then
2167 Analyze_Aspect_Specifications (N, Id);
2169 end Analyze_Formal_Object_Declaration;
2171 ----------------------------------------------
2172 -- Analyze_Formal_Ordinary_Fixed_Point_Type --
2173 ----------------------------------------------
2175 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
2179 Loc : constant Source_Ptr := Sloc (Def);
2180 Base : constant Entity_Id :=
2182 (E_Ordinary_Fixed_Point_Type, Current_Scope,
2183 Sloc (Defining_Identifier (Parent (Def))), 'G');
2186 -- The semantic attributes are set for completeness only, their values
2187 -- will never be used, since all properties of the type are non-static.
2190 Set_Ekind (T, E_Ordinary_Fixed_Point_Subtype);
2191 Set_Etype (T, Base);
2192 Set_Size_Info (T, Standard_Integer);
2193 Set_RM_Size (T, RM_Size (Standard_Integer));
2194 Set_Small_Value (T, Ureal_1);
2195 Set_Delta_Value (T, Ureal_1);
2196 Set_Scalar_Range (T,
2198 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
2199 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
2200 Set_Is_Constrained (T);
2202 Set_Is_Generic_Type (Base);
2203 Set_Etype (Base, Base);
2204 Set_Size_Info (Base, Standard_Integer);
2205 Set_RM_Size (Base, RM_Size (Standard_Integer));
2206 Set_Small_Value (Base, Ureal_1);
2207 Set_Delta_Value (Base, Ureal_1);
2208 Set_Scalar_Range (Base, Scalar_Range (T));
2209 Set_Parent (Base, Parent (Def));
2211 Check_Restriction (No_Fixed_Point, Def);
2212 end Analyze_Formal_Ordinary_Fixed_Point_Type;
2214 ----------------------------------------
2215 -- Analyze_Formal_Package_Declaration --
2216 ----------------------------------------
2218 procedure Analyze_Formal_Package_Declaration (N : Node_Id) is
2219 Loc : constant Source_Ptr := Sloc (N);
2220 Pack_Id : constant Entity_Id := Defining_Identifier (N);
2222 Gen_Id : constant Node_Id := Name (N);
2224 Gen_Unit : Entity_Id;
2226 Parent_Installed : Boolean := False;
2228 Parent_Instance : Entity_Id;
2229 Renaming_In_Par : Entity_Id;
2230 Associations : Boolean := True;
2232 Vis_Prims_List : Elist_Id := No_Elist;
2233 -- List of primitives made temporarily visible in the instantiation
2234 -- to match the visibility of the formal type
2236 function Build_Local_Package return Node_Id;
2237 -- The formal package is rewritten so that its parameters are replaced
2238 -- with corresponding declarations. For parameters with bona fide
2239 -- associations these declarations are created by Analyze_Associations
2240 -- as for a regular instantiation. For boxed parameters, we preserve
2241 -- the formal declarations and analyze them, in order to introduce
2242 -- entities of the right kind in the environment of the formal.
2244 -------------------------
2245 -- Build_Local_Package --
2246 -------------------------
2248 function Build_Local_Package return Node_Id is
2250 Pack_Decl : Node_Id;
2253 -- Within the formal, the name of the generic package is a renaming
2254 -- of the formal (as for a regular instantiation).
2257 Make_Package_Declaration (Loc,
2260 (Specification (Original_Node (Gen_Decl)),
2261 Empty, Instantiating => True));
2263 Renaming := Make_Package_Renaming_Declaration (Loc,
2264 Defining_Unit_Name =>
2265 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2266 Name => New_Occurrence_Of (Formal, Loc));
2268 if Nkind (Gen_Id) = N_Identifier
2269 and then Chars (Gen_Id) = Chars (Pack_Id)
2272 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2275 -- If the formal is declared with a box, or with an others choice,
2276 -- create corresponding declarations for all entities in the formal
2277 -- part, so that names with the proper types are available in the
2278 -- specification of the formal package.
2280 -- On the other hand, if there are no associations, then all the
2281 -- formals must have defaults, and this will be checked by the
2282 -- call to Analyze_Associations.
2285 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2288 Formal_Decl : Node_Id;
2291 -- TBA : for a formal package, need to recurse ???
2296 (Generic_Formal_Declarations (Original_Node (Gen_Decl)));
2297 while Present (Formal_Decl) loop
2299 (Decls, Copy_Generic_Node (Formal_Decl, Empty, True));
2304 -- If generic associations are present, use Analyze_Associations to
2305 -- create the proper renaming declarations.
2309 Act_Tree : constant Node_Id :=
2311 (Original_Node (Gen_Decl), Empty,
2312 Instantiating => True);
2315 Generic_Renamings.Set_Last (0);
2316 Generic_Renamings_HTable.Reset;
2317 Instantiation_Node := N;
2320 Analyze_Associations
2321 (I_Node => Original_Node (N),
2322 Formals => Generic_Formal_Declarations (Act_Tree),
2323 F_Copy => Generic_Formal_Declarations (Gen_Decl));
2325 Vis_Prims_List := Check_Hidden_Primitives (Decls);
2329 Append (Renaming, To => Decls);
2331 -- Add generated declarations ahead of local declarations in
2334 if No (Visible_Declarations (Specification (Pack_Decl))) then
2335 Set_Visible_Declarations (Specification (Pack_Decl), Decls);
2338 (First (Visible_Declarations (Specification (Pack_Decl))),
2343 end Build_Local_Package;
2345 -- Start of processing for Analyze_Formal_Package_Declaration
2348 Text_IO_Kludge (Gen_Id);
2351 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2352 Gen_Unit := Entity (Gen_Id);
2354 -- Check for a formal package that is a package renaming
2356 if Present (Renamed_Object (Gen_Unit)) then
2358 -- Indicate that unit is used, before replacing it with renamed
2359 -- entity for use below.
2361 if In_Extended_Main_Source_Unit (N) then
2362 Set_Is_Instantiated (Gen_Unit);
2363 Generate_Reference (Gen_Unit, N);
2366 Gen_Unit := Renamed_Object (Gen_Unit);
2369 if Ekind (Gen_Unit) /= E_Generic_Package then
2370 Error_Msg_N ("expect generic package name", Gen_Id);
2374 elsif Gen_Unit = Current_Scope then
2376 ("generic package cannot be used as a formal package of itself",
2381 elsif In_Open_Scopes (Gen_Unit) then
2382 if Is_Compilation_Unit (Gen_Unit)
2383 and then Is_Child_Unit (Current_Scope)
2385 -- Special-case the error when the formal is a parent, and
2386 -- continue analysis to minimize cascaded errors.
2389 ("generic parent cannot be used as formal package "
2390 & "of a child unit",
2395 ("generic package cannot be used as a formal package "
2403 -- Check that name of formal package does not hide name of generic,
2404 -- or its leading prefix. This check must be done separately because
2405 -- the name of the generic has already been analyzed.
2408 Gen_Name : Entity_Id;
2412 while Nkind (Gen_Name) = N_Expanded_Name loop
2413 Gen_Name := Prefix (Gen_Name);
2416 if Chars (Gen_Name) = Chars (Pack_Id) then
2418 ("& is hidden within declaration of formal package",
2424 or else No (Generic_Associations (N))
2425 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2427 Associations := False;
2430 -- If there are no generic associations, the generic parameters appear
2431 -- as local entities and are instantiated like them. We copy the generic
2432 -- package declaration as if it were an instantiation, and analyze it
2433 -- like a regular package, except that we treat the formals as
2434 -- additional visible components.
2436 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2438 if In_Extended_Main_Source_Unit (N) then
2439 Set_Is_Instantiated (Gen_Unit);
2440 Generate_Reference (Gen_Unit, N);
2443 Formal := New_Copy (Pack_Id);
2444 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2447 -- Make local generic without formals. The formals will be replaced
2448 -- with internal declarations.
2450 New_N := Build_Local_Package;
2452 -- If there are errors in the parameter list, Analyze_Associations
2453 -- raises Instantiation_Error. Patch the declaration to prevent
2454 -- further exception propagation.
2457 when Instantiation_Error =>
2459 Enter_Name (Formal);
2460 Set_Ekind (Formal, E_Variable);
2461 Set_Etype (Formal, Any_Type);
2462 Restore_Hidden_Primitives (Vis_Prims_List);
2464 if Parent_Installed then
2472 Set_Defining_Unit_Name (Specification (New_N), Formal);
2473 Set_Generic_Parent (Specification (N), Gen_Unit);
2474 Set_Instance_Env (Gen_Unit, Formal);
2475 Set_Is_Generic_Instance (Formal);
2477 Enter_Name (Formal);
2478 Set_Ekind (Formal, E_Package);
2479 Set_Etype (Formal, Standard_Void_Type);
2480 Set_Inner_Instances (Formal, New_Elmt_List);
2481 Push_Scope (Formal);
2483 if Is_Child_Unit (Gen_Unit)
2484 and then Parent_Installed
2486 -- Similarly, we have to make the name of the formal visible in the
2487 -- parent instance, to resolve properly fully qualified names that
2488 -- may appear in the generic unit. The parent instance has been
2489 -- placed on the scope stack ahead of the current scope.
2491 Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
2494 Make_Defining_Identifier (Loc, Chars (Gen_Unit));
2495 Set_Ekind (Renaming_In_Par, E_Package);
2496 Set_Etype (Renaming_In_Par, Standard_Void_Type);
2497 Set_Scope (Renaming_In_Par, Parent_Instance);
2498 Set_Parent (Renaming_In_Par, Parent (Formal));
2499 Set_Renamed_Object (Renaming_In_Par, Formal);
2500 Append_Entity (Renaming_In_Par, Parent_Instance);
2503 Analyze (Specification (N));
2505 -- The formals for which associations are provided are not visible
2506 -- outside of the formal package. The others are still declared by a
2507 -- formal parameter declaration.
2509 -- If there are no associations, the only local entity to hide is the
2510 -- generated package renaming itself.
2516 E := First_Entity (Formal);
2517 while Present (E) loop
2519 and then not Is_Generic_Formal (E)
2524 if Ekind (E) = E_Package
2525 and then Renamed_Entity (E) = Formal
2535 End_Package_Scope (Formal);
2536 Restore_Hidden_Primitives (Vis_Prims_List);
2538 if Parent_Installed then
2544 -- Inside the generic unit, the formal package is a regular package, but
2545 -- no body is needed for it. Note that after instantiation, the defining
2546 -- unit name we need is in the new tree and not in the original (see
2547 -- Package_Instantiation). A generic formal package is an instance, and
2548 -- can be used as an actual for an inner instance.
2550 Set_Has_Completion (Formal, True);
2552 -- Add semantic information to the original defining identifier.
2555 Set_Ekind (Pack_Id, E_Package);
2556 Set_Etype (Pack_Id, Standard_Void_Type);
2557 Set_Scope (Pack_Id, Scope (Formal));
2558 Set_Has_Completion (Pack_Id, True);
2561 if Has_Aspects (N) then
2562 Analyze_Aspect_Specifications (N, Pack_Id);
2564 end Analyze_Formal_Package_Declaration;
2566 ---------------------------------
2567 -- Analyze_Formal_Private_Type --
2568 ---------------------------------
2570 procedure Analyze_Formal_Private_Type
2576 New_Private_Type (N, T, Def);
2578 -- Set the size to an arbitrary but legal value
2580 Set_Size_Info (T, Standard_Integer);
2581 Set_RM_Size (T, RM_Size (Standard_Integer));
2582 end Analyze_Formal_Private_Type;
2584 ------------------------------------
2585 -- Analyze_Formal_Incomplete_Type --
2586 ------------------------------------
2588 procedure Analyze_Formal_Incomplete_Type
2594 Set_Ekind (T, E_Incomplete_Type);
2596 Set_Private_Dependents (T, New_Elmt_List);
2598 if Tagged_Present (Def) then
2599 Set_Is_Tagged_Type (T);
2600 Make_Class_Wide_Type (T);
2601 Set_Direct_Primitive_Operations (T, New_Elmt_List);
2603 end Analyze_Formal_Incomplete_Type;
2605 ----------------------------------------
2606 -- Analyze_Formal_Signed_Integer_Type --
2607 ----------------------------------------
2609 procedure Analyze_Formal_Signed_Integer_Type
2613 Base : constant Entity_Id :=
2615 (E_Signed_Integer_Type,
2617 Sloc (Defining_Identifier (Parent (Def))), 'G');
2622 Set_Ekind (T, E_Signed_Integer_Subtype);
2623 Set_Etype (T, Base);
2624 Set_Size_Info (T, Standard_Integer);
2625 Set_RM_Size (T, RM_Size (Standard_Integer));
2626 Set_Scalar_Range (T, Scalar_Range (Standard_Integer));
2627 Set_Is_Constrained (T);
2629 Set_Is_Generic_Type (Base);
2630 Set_Size_Info (Base, Standard_Integer);
2631 Set_RM_Size (Base, RM_Size (Standard_Integer));
2632 Set_Etype (Base, Base);
2633 Set_Scalar_Range (Base, Scalar_Range (Standard_Integer));
2634 Set_Parent (Base, Parent (Def));
2635 end Analyze_Formal_Signed_Integer_Type;
2637 -------------------------------------------
2638 -- Analyze_Formal_Subprogram_Declaration --
2639 -------------------------------------------
2641 procedure Analyze_Formal_Subprogram_Declaration (N : Node_Id) is
2642 Spec : constant Node_Id := Specification (N);
2643 Def : constant Node_Id := Default_Name (N);
2644 Nam : constant Entity_Id := Defining_Unit_Name (Spec);
2652 if Nkind (Nam) = N_Defining_Program_Unit_Name then
2653 Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
2657 Analyze_Subprogram_Declaration (N);
2658 Set_Is_Formal_Subprogram (Nam);
2659 Set_Has_Completion (Nam);
2661 if Nkind (N) = N_Formal_Abstract_Subprogram_Declaration then
2662 Set_Is_Abstract_Subprogram (Nam);
2663 Set_Is_Dispatching_Operation (Nam);
2666 Ctrl_Type : constant Entity_Id := Find_Dispatching_Type (Nam);
2668 if No (Ctrl_Type) then
2670 ("abstract formal subprogram must have a controlling type",
2673 elsif Ada_Version >= Ada_2012
2674 and then Is_Incomplete_Type (Ctrl_Type)
2677 ("controlling type of abstract formal subprogram cannot " &
2678 "be incomplete type", N, Ctrl_Type);
2681 Check_Controlling_Formals (Ctrl_Type, Nam);
2686 -- Default name is resolved at the point of instantiation
2688 if Box_Present (N) then
2691 -- Else default is bound at the point of generic declaration
2693 elsif Present (Def) then
2694 if Nkind (Def) = N_Operator_Symbol then
2695 Find_Direct_Name (Def);
2697 elsif Nkind (Def) /= N_Attribute_Reference then
2701 -- For an attribute reference, analyze the prefix and verify
2702 -- that it has the proper profile for the subprogram.
2704 Analyze (Prefix (Def));
2705 Valid_Default_Attribute (Nam, Def);
2709 -- Default name may be overloaded, in which case the interpretation
2710 -- with the correct profile must be selected, as for a renaming.
2711 -- If the definition is an indexed component, it must denote a
2712 -- member of an entry family. If it is a selected component, it
2713 -- can be a protected operation.
2715 if Etype (Def) = Any_Type then
2718 elsif Nkind (Def) = N_Selected_Component then
2719 if not Is_Overloadable (Entity (Selector_Name (Def))) then
2720 Error_Msg_N ("expect valid subprogram name as default", Def);
2723 elsif Nkind (Def) = N_Indexed_Component then
2724 if Is_Entity_Name (Prefix (Def)) then
2725 if Ekind (Entity (Prefix (Def))) /= E_Entry_Family then
2726 Error_Msg_N ("expect valid subprogram name as default", Def);
2729 elsif Nkind (Prefix (Def)) = N_Selected_Component then
2730 if Ekind (Entity (Selector_Name (Prefix (Def)))) /=
2733 Error_Msg_N ("expect valid subprogram name as default", Def);
2737 Error_Msg_N ("expect valid subprogram name as default", Def);
2741 elsif Nkind (Def) = N_Character_Literal then
2743 -- Needs some type checks: subprogram should be parameterless???
2745 Resolve (Def, (Etype (Nam)));
2747 elsif not Is_Entity_Name (Def)
2748 or else not Is_Overloadable (Entity (Def))
2750 Error_Msg_N ("expect valid subprogram name as default", Def);
2753 elsif not Is_Overloaded (Def) then
2754 Subp := Entity (Def);
2757 Error_Msg_N ("premature usage of formal subprogram", Def);
2759 elsif not Entity_Matches_Spec (Subp, Nam) then
2760 Error_Msg_N ("no visible entity matches specification", Def);
2763 -- More than one interpretation, so disambiguate as for a renaming
2768 I1 : Interp_Index := 0;
2774 Get_First_Interp (Def, I, It);
2775 while Present (It.Nam) loop
2776 if Entity_Matches_Spec (It.Nam, Nam) then
2777 if Subp /= Any_Id then
2778 It1 := Disambiguate (Def, I1, I, Etype (Subp));
2780 if It1 = No_Interp then
2781 Error_Msg_N ("ambiguous default subprogram", Def);
2794 Get_Next_Interp (I, It);
2798 if Subp /= Any_Id then
2800 -- Subprogram found, generate reference to it
2802 Set_Entity (Def, Subp);
2803 Generate_Reference (Subp, Def);
2806 Error_Msg_N ("premature usage of formal subprogram", Def);
2808 elsif Ekind (Subp) /= E_Operator then
2809 Check_Mode_Conformant (Subp, Nam);
2813 Error_Msg_N ("no visible subprogram matches specification", N);
2819 if Has_Aspects (N) then
2820 Analyze_Aspect_Specifications (N, Nam);
2823 end Analyze_Formal_Subprogram_Declaration;
2825 -------------------------------------
2826 -- Analyze_Formal_Type_Declaration --
2827 -------------------------------------
2829 procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
2830 Def : constant Node_Id := Formal_Type_Definition (N);
2834 T := Defining_Identifier (N);
2836 if Present (Discriminant_Specifications (N))
2837 and then Nkind (Def) /= N_Formal_Private_Type_Definition
2840 ("discriminants not allowed for this formal type", T);
2843 -- Enter the new name, and branch to specific routine
2846 when N_Formal_Private_Type_Definition =>
2847 Analyze_Formal_Private_Type (N, T, Def);
2849 when N_Formal_Derived_Type_Definition =>
2850 Analyze_Formal_Derived_Type (N, T, Def);
2852 when N_Formal_Incomplete_Type_Definition =>
2853 Analyze_Formal_Incomplete_Type (T, Def);
2855 when N_Formal_Discrete_Type_Definition =>
2856 Analyze_Formal_Discrete_Type (T, Def);
2858 when N_Formal_Signed_Integer_Type_Definition =>
2859 Analyze_Formal_Signed_Integer_Type (T, Def);
2861 when N_Formal_Modular_Type_Definition =>
2862 Analyze_Formal_Modular_Type (T, Def);
2864 when N_Formal_Floating_Point_Definition =>
2865 Analyze_Formal_Floating_Type (T, Def);
2867 when N_Formal_Ordinary_Fixed_Point_Definition =>
2868 Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
2870 when N_Formal_Decimal_Fixed_Point_Definition =>
2871 Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
2873 when N_Array_Type_Definition =>
2874 Analyze_Formal_Array_Type (T, Def);
2876 when N_Access_To_Object_Definition |
2877 N_Access_Function_Definition |
2878 N_Access_Procedure_Definition =>
2879 Analyze_Generic_Access_Type (T, Def);
2881 -- Ada 2005: a interface declaration is encoded as an abstract
2882 -- record declaration or a abstract type derivation.
2884 when N_Record_Definition =>
2885 Analyze_Formal_Interface_Type (N, T, Def);
2887 when N_Derived_Type_Definition =>
2888 Analyze_Formal_Derived_Interface_Type (N, T, Def);
2894 raise Program_Error;
2898 Set_Is_Generic_Type (T);
2900 if Has_Aspects (N) then
2901 Analyze_Aspect_Specifications (N, T);
2903 end Analyze_Formal_Type_Declaration;
2905 ------------------------------------
2906 -- Analyze_Function_Instantiation --
2907 ------------------------------------
2909 procedure Analyze_Function_Instantiation (N : Node_Id) is
2911 Analyze_Subprogram_Instantiation (N, E_Function);
2912 end Analyze_Function_Instantiation;
2914 ---------------------------------
2915 -- Analyze_Generic_Access_Type --
2916 ---------------------------------
2918 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
2922 if Nkind (Def) = N_Access_To_Object_Definition then
2923 Access_Type_Declaration (T, Def);
2925 if Is_Incomplete_Or_Private_Type (Designated_Type (T))
2926 and then No (Full_View (Designated_Type (T)))
2927 and then not Is_Generic_Type (Designated_Type (T))
2929 Error_Msg_N ("premature usage of incomplete type", Def);
2931 elsif not Is_Entity_Name (Subtype_Indication (Def)) then
2933 ("only a subtype mark is allowed in a formal", Def);
2937 Access_Subprogram_Declaration (T, Def);
2939 end Analyze_Generic_Access_Type;
2941 ---------------------------------
2942 -- Analyze_Generic_Formal_Part --
2943 ---------------------------------
2945 procedure Analyze_Generic_Formal_Part (N : Node_Id) is
2946 Gen_Parm_Decl : Node_Id;
2949 -- The generic formals are processed in the scope of the generic unit,
2950 -- where they are immediately visible. The scope is installed by the
2953 Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
2955 while Present (Gen_Parm_Decl) loop
2956 Analyze (Gen_Parm_Decl);
2957 Next (Gen_Parm_Decl);
2960 Generate_Reference_To_Generic_Formals (Current_Scope);
2961 end Analyze_Generic_Formal_Part;
2963 ------------------------------------------
2964 -- Analyze_Generic_Package_Declaration --
2965 ------------------------------------------
2967 procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
2968 Loc : constant Source_Ptr := Sloc (N);
2971 Save_Parent : Node_Id;
2973 Decls : constant List_Id :=
2974 Visible_Declarations (Specification (N));
2978 Check_SPARK_Restriction ("generic is not allowed", N);
2980 -- We introduce a renaming of the enclosing package, to have a usable
2981 -- entity as the prefix of an expanded name for a local entity of the
2982 -- form Par.P.Q, where P is the generic package. This is because a local
2983 -- entity named P may hide it, so that the usual visibility rules in
2984 -- the instance will not resolve properly.
2987 Make_Package_Renaming_Declaration (Loc,
2988 Defining_Unit_Name =>
2989 Make_Defining_Identifier (Loc,
2990 Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
2991 Name => Make_Identifier (Loc, Chars (Defining_Entity (N))));
2993 if Present (Decls) then
2994 Decl := First (Decls);
2995 while Present (Decl)
2996 and then Nkind (Decl) = N_Pragma
3001 if Present (Decl) then
3002 Insert_Before (Decl, Renaming);
3004 Append (Renaming, Visible_Declarations (Specification (N)));
3008 Set_Visible_Declarations (Specification (N), New_List (Renaming));
3011 -- Create copy of generic unit, and save for instantiation. If the unit
3012 -- is a child unit, do not copy the specifications for the parent, which
3013 -- are not part of the generic tree.
3015 Save_Parent := Parent_Spec (N);
3016 Set_Parent_Spec (N, Empty);
3018 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3019 Set_Parent_Spec (New_N, Save_Parent);
3021 Id := Defining_Entity (N);
3022 Generate_Definition (Id);
3024 -- Expansion is not applied to generic units
3029 Set_Ekind (Id, E_Generic_Package);
3030 Set_Etype (Id, Standard_Void_Type);
3032 Enter_Generic_Scope (Id);
3033 Set_Inner_Instances (Id, New_Elmt_List);
3035 Set_Categorization_From_Pragmas (N);
3036 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3038 -- Link the declaration of the generic homonym in the generic copy to
3039 -- the package it renames, so that it is always resolved properly.
3041 Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
3042 Set_Entity (Associated_Node (Name (Renaming)), Id);
3044 -- For a library unit, we have reconstructed the entity for the unit,
3045 -- and must reset it in the library tables.
3047 if Nkind (Parent (N)) = N_Compilation_Unit then
3048 Set_Cunit_Entity (Current_Sem_Unit, Id);
3051 Analyze_Generic_Formal_Part (N);
3053 -- After processing the generic formals, analysis proceeds as for a
3054 -- non-generic package.
3056 Analyze (Specification (N));
3058 Validate_Categorization_Dependency (N, Id);
3062 End_Package_Scope (Id);
3063 Exit_Generic_Scope (Id);
3065 if Nkind (Parent (N)) /= N_Compilation_Unit then
3066 Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
3067 Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
3068 Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
3071 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3072 Validate_RT_RAT_Component (N);
3074 -- If this is a spec without a body, check that generic parameters
3077 if not Body_Required (Parent (N)) then
3078 Check_References (Id);
3082 if Has_Aspects (N) then
3083 Analyze_Aspect_Specifications (N, Id);
3085 end Analyze_Generic_Package_Declaration;
3087 --------------------------------------------
3088 -- Analyze_Generic_Subprogram_Declaration --
3089 --------------------------------------------
3091 procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
3096 Result_Type : Entity_Id;
3097 Save_Parent : Node_Id;
3101 Check_SPARK_Restriction ("generic is not allowed", N);
3103 -- Create copy of generic unit, and save for instantiation. If the unit
3104 -- is a child unit, do not copy the specifications for the parent, which
3105 -- are not part of the generic tree.
3107 Save_Parent := Parent_Spec (N);
3108 Set_Parent_Spec (N, Empty);
3110 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3111 Set_Parent_Spec (New_N, Save_Parent);
3114 -- The aspect specifications are not attached to the tree, and must
3115 -- be copied and attached to the generic copy explicitly.
3117 if Present (Aspect_Specifications (New_N)) then
3119 Aspects : constant List_Id := Aspect_Specifications (N);
3121 Set_Has_Aspects (N, False);
3122 Move_Aspects (New_N, N);
3123 Set_Has_Aspects (Original_Node (N), False);
3124 Set_Aspect_Specifications (Original_Node (N), Aspects);
3128 Spec := Specification (N);
3129 Id := Defining_Entity (Spec);
3130 Generate_Definition (Id);
3131 Set_Contract (Id, Make_Contract (Sloc (Id)));
3133 if Nkind (Id) = N_Defining_Operator_Symbol then
3135 ("operator symbol not allowed for generic subprogram", Id);
3142 Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
3144 Enter_Generic_Scope (Id);
3145 Set_Inner_Instances (Id, New_Elmt_List);
3146 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3148 Analyze_Generic_Formal_Part (N);
3150 Formals := Parameter_Specifications (Spec);
3152 if Present (Formals) then
3153 Process_Formals (Formals, Spec);
3156 if Nkind (Spec) = N_Function_Specification then
3157 Set_Ekind (Id, E_Generic_Function);
3159 if Nkind (Result_Definition (Spec)) = N_Access_Definition then
3160 Result_Type := Access_Definition (Spec, Result_Definition (Spec));
3161 Set_Etype (Id, Result_Type);
3163 -- Check restriction imposed by AI05-073: a generic function
3164 -- cannot return an abstract type or an access to such.
3166 -- This is a binding interpretation should it apply to earlier
3167 -- versions of Ada as well as Ada 2012???
3169 if Is_Abstract_Type (Designated_Type (Result_Type))
3170 and then Ada_Version >= Ada_2012
3172 Error_Msg_N ("generic function cannot have an access result"
3173 & " that designates an abstract type", Spec);
3177 Find_Type (Result_Definition (Spec));
3178 Typ := Entity (Result_Definition (Spec));
3180 if Is_Abstract_Type (Typ)
3181 and then Ada_Version >= Ada_2012
3184 ("generic function cannot have abstract result type", Spec);
3187 -- If a null exclusion is imposed on the result type, then create
3188 -- a null-excluding itype (an access subtype) and use it as the
3189 -- function's Etype.
3191 if Is_Access_Type (Typ)
3192 and then Null_Exclusion_Present (Spec)
3195 Create_Null_Excluding_Itype
3197 Related_Nod => Spec,
3198 Scope_Id => Defining_Unit_Name (Spec)));
3200 Set_Etype (Id, Typ);
3205 Set_Ekind (Id, E_Generic_Procedure);
3206 Set_Etype (Id, Standard_Void_Type);
3209 -- For a library unit, we have reconstructed the entity for the unit,
3210 -- and must reset it in the library tables. We also make sure that
3211 -- Body_Required is set properly in the original compilation unit node.
3213 if Nkind (Parent (N)) = N_Compilation_Unit then
3214 Set_Cunit_Entity (Current_Sem_Unit, Id);
3215 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3218 Set_Categorization_From_Pragmas (N);
3219 Validate_Categorization_Dependency (N, Id);
3221 Save_Global_References (Original_Node (N));
3223 -- For ASIS purposes, convert any postcondition, precondition pragmas
3224 -- into aspects, if N is not a compilation unit by itself, in order to
3225 -- enable the analysis of expressions inside the corresponding PPC
3228 if ASIS_Mode and then Is_List_Member (N) then
3229 Make_Aspect_For_PPC_In_Gen_Sub_Decl (N);
3232 -- To capture global references, analyze the expressions of aspects,
3233 -- and propagate information to original tree. Note that in this case
3234 -- analysis of attributes is not delayed until the freeze point.
3236 -- It seems very hard to recreate the proper visibility of the generic
3237 -- subprogram at a later point because the analysis of an aspect may
3238 -- create pragmas after the generic copies have been made ???
3240 if Has_Aspects (N) then
3245 Aspect := First (Aspect_Specifications (N));
3246 while Present (Aspect) loop
3247 if Get_Aspect_Id (Aspect) /= Aspect_Warnings then
3248 Analyze (Expression (Aspect));
3253 Aspect := First (Aspect_Specifications (Original_Node (N)));
3254 while Present (Aspect) loop
3255 Save_Global_References (Expression (Aspect));
3263 Exit_Generic_Scope (Id);
3264 Generate_Reference_To_Formals (Id);
3266 List_Inherited_Pre_Post_Aspects (Id);
3267 end Analyze_Generic_Subprogram_Declaration;
3269 -----------------------------------
3270 -- Analyze_Package_Instantiation --
3271 -----------------------------------
3273 procedure Analyze_Package_Instantiation (N : Node_Id) is
3274 Loc : constant Source_Ptr := Sloc (N);
3275 Gen_Id : constant Node_Id := Name (N);
3278 Act_Decl_Name : Node_Id;
3279 Act_Decl_Id : Entity_Id;
3284 Gen_Unit : Entity_Id;
3286 Is_Actual_Pack : constant Boolean :=
3287 Is_Internal (Defining_Entity (N));
3289 Env_Installed : Boolean := False;
3290 Parent_Installed : Boolean := False;
3291 Renaming_List : List_Id;
3292 Unit_Renaming : Node_Id;
3293 Needs_Body : Boolean;
3294 Inline_Now : Boolean := False;
3296 Save_Style_Check : constant Boolean := Style_Check;
3297 -- Save style check mode for restore on exit
3299 procedure Delay_Descriptors (E : Entity_Id);
3300 -- Delay generation of subprogram descriptors for given entity
3302 function Might_Inline_Subp return Boolean;
3303 -- If inlining is active and the generic contains inlined subprograms,
3304 -- we instantiate the body. This may cause superfluous instantiations,
3305 -- but it is simpler than detecting the need for the body at the point
3306 -- of inlining, when the context of the instance is not available.
3308 function Must_Inline_Subp return Boolean;
3309 -- If inlining is active and the generic contains inlined subprograms,
3310 -- return True if some of the inlined subprograms must be inlined by
3313 -----------------------
3314 -- Delay_Descriptors --
3315 -----------------------
3317 procedure Delay_Descriptors (E : Entity_Id) is
3319 if not Delay_Subprogram_Descriptors (E) then
3320 Set_Delay_Subprogram_Descriptors (E);
3321 Pending_Descriptor.Append (E);
3323 end Delay_Descriptors;
3325 -----------------------
3326 -- Might_Inline_Subp --
3327 -----------------------
3329 function Might_Inline_Subp return Boolean is
3333 if not Inline_Processing_Required then
3337 E := First_Entity (Gen_Unit);
3338 while Present (E) loop
3339 if Is_Subprogram (E)
3340 and then Is_Inlined (E)
3350 end Might_Inline_Subp;
3352 ----------------------
3353 -- Must_Inline_Subp --
3354 ----------------------
3356 function Must_Inline_Subp return Boolean is
3360 if not Inline_Processing_Required then
3364 E := First_Entity (Gen_Unit);
3365 while Present (E) loop
3366 if Is_Subprogram (E)
3367 and then Is_Inlined (E)
3368 and then Must_Inline (E)
3378 end Must_Inline_Subp;
3380 -- Local declarations
3382 Vis_Prims_List : Elist_Id := No_Elist;
3383 -- List of primitives made temporarily visible in the instantiation
3384 -- to match the visibility of the formal type
3386 -- Start of processing for Analyze_Package_Instantiation
3389 Check_SPARK_Restriction ("generic is not allowed", N);
3391 -- Very first thing: apply the special kludge for Text_IO processing
3392 -- in case we are instantiating one of the children of [Wide_]Text_IO.
3394 Text_IO_Kludge (Name (N));
3396 -- Make node global for error reporting
3398 Instantiation_Node := N;
3400 -- Turn off style checking in instances. If the check is enabled on the
3401 -- generic unit, a warning in an instance would just be noise. If not
3402 -- enabled on the generic, then a warning in an instance is just wrong.
3404 Style_Check := False;
3406 -- Case of instantiation of a generic package
3408 if Nkind (N) = N_Package_Instantiation then
3409 Act_Decl_Id := New_Copy (Defining_Entity (N));
3410 Set_Comes_From_Source (Act_Decl_Id, True);
3412 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3414 Make_Defining_Program_Unit_Name (Loc,
3415 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
3416 Defining_Identifier => Act_Decl_Id);
3418 Act_Decl_Name := Act_Decl_Id;
3421 -- Case of instantiation of a formal package
3424 Act_Decl_Id := Defining_Identifier (N);
3425 Act_Decl_Name := Act_Decl_Id;
3428 Generate_Definition (Act_Decl_Id);
3429 Preanalyze_Actuals (N);
3432 Env_Installed := True;
3434 -- Reset renaming map for formal types. The mapping is established
3435 -- when analyzing the generic associations, but some mappings are
3436 -- inherited from formal packages of parent units, and these are
3437 -- constructed when the parents are installed.
3439 Generic_Renamings.Set_Last (0);
3440 Generic_Renamings_HTable.Reset;
3442 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3443 Gen_Unit := Entity (Gen_Id);
3445 -- Verify that it is the name of a generic package
3447 -- A visibility glitch: if the instance is a child unit and the generic
3448 -- is the generic unit of a parent instance (i.e. both the parent and
3449 -- the child units are instances of the same package) the name now
3450 -- denotes the renaming within the parent, not the intended generic
3451 -- unit. See if there is a homonym that is the desired generic. The
3452 -- renaming declaration must be visible inside the instance of the
3453 -- child, but not when analyzing the name in the instantiation itself.
3455 if Ekind (Gen_Unit) = E_Package
3456 and then Present (Renamed_Entity (Gen_Unit))
3457 and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3458 and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3459 and then Present (Homonym (Gen_Unit))
3461 Gen_Unit := Homonym (Gen_Unit);
3464 if Etype (Gen_Unit) = Any_Type then
3468 elsif Ekind (Gen_Unit) /= E_Generic_Package then
3470 -- Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3472 if From_With_Type (Gen_Unit) then
3474 ("cannot instantiate a limited withed package", Gen_Id);
3477 ("expect name of generic package in instantiation", Gen_Id);
3484 if In_Extended_Main_Source_Unit (N) then
3485 Set_Is_Instantiated (Gen_Unit);
3486 Generate_Reference (Gen_Unit, N);
3488 if Present (Renamed_Object (Gen_Unit)) then
3489 Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3490 Generate_Reference (Renamed_Object (Gen_Unit), N);
3494 if Nkind (Gen_Id) = N_Identifier
3495 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3498 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3500 elsif Nkind (Gen_Id) = N_Expanded_Name
3501 and then Is_Child_Unit (Gen_Unit)
3502 and then Nkind (Prefix (Gen_Id)) = N_Identifier
3503 and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3506 ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3509 Set_Entity (Gen_Id, Gen_Unit);
3511 -- If generic is a renaming, get original generic unit
3513 if Present (Renamed_Object (Gen_Unit))
3514 and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3516 Gen_Unit := Renamed_Object (Gen_Unit);
3519 -- Verify that there are no circular instantiations
3521 if In_Open_Scopes (Gen_Unit) then
3522 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3526 elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3527 Error_Msg_Node_2 := Current_Scope;
3529 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3530 Circularity_Detected := True;
3535 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3537 -- Initialize renamings map, for error checking, and the list that
3538 -- holds private entities whose views have changed between generic
3539 -- definition and instantiation. If this is the instance created to
3540 -- validate an actual package, the instantiation environment is that
3541 -- of the enclosing instance.
3543 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3545 -- Copy original generic tree, to produce text for instantiation
3549 (Original_Node (Gen_Decl), Empty, Instantiating => True);
3551 Act_Spec := Specification (Act_Tree);
3553 -- If this is the instance created to validate an actual package,
3554 -- only the formals matter, do not examine the package spec itself.
3556 if Is_Actual_Pack then
3557 Set_Visible_Declarations (Act_Spec, New_List);
3558 Set_Private_Declarations (Act_Spec, New_List);
3562 Analyze_Associations
3564 Formals => Generic_Formal_Declarations (Act_Tree),
3565 F_Copy => Generic_Formal_Declarations (Gen_Decl));
3567 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
3569 Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3570 Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3571 Set_Is_Generic_Instance (Act_Decl_Id);
3573 Set_Generic_Parent (Act_Spec, Gen_Unit);
3575 -- References to the generic in its own declaration or its body are
3576 -- references to the instance. Add a renaming declaration for the
3577 -- generic unit itself. This declaration, as well as the renaming
3578 -- declarations for the generic formals, must remain private to the
3579 -- unit: the formals, because this is the language semantics, and
3580 -- the unit because its use is an artifact of the implementation.
3583 Make_Package_Renaming_Declaration (Loc,
3584 Defining_Unit_Name =>
3585 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3586 Name => New_Reference_To (Act_Decl_Id, Loc));
3588 Append (Unit_Renaming, Renaming_List);
3590 -- The renaming declarations are the first local declarations of
3593 if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3595 (First (Visible_Declarations (Act_Spec)), Renaming_List);
3597 Set_Visible_Declarations (Act_Spec, Renaming_List);
3601 Make_Package_Declaration (Loc,
3602 Specification => Act_Spec);
3604 -- Save the instantiation node, for subsequent instantiation of the
3605 -- body, if there is one and we are generating code for the current
3606 -- unit. Mark the unit as having a body, to avoid a premature error
3609 -- We instantiate the body if we are generating code, if we are
3610 -- generating cross-reference information, or if we are building
3611 -- trees for ASIS use.
3614 Enclosing_Body_Present : Boolean := False;
3615 -- If the generic unit is not a compilation unit, then a body may
3616 -- be present in its parent even if none is required. We create a
3617 -- tentative pending instantiation for the body, which will be
3618 -- discarded if none is actually present.
3623 if Scope (Gen_Unit) /= Standard_Standard
3624 and then not Is_Child_Unit (Gen_Unit)
3626 Scop := Scope (Gen_Unit);
3628 while Present (Scop)
3629 and then Scop /= Standard_Standard
3631 if Unit_Requires_Body (Scop) then
3632 Enclosing_Body_Present := True;
3635 elsif In_Open_Scopes (Scop)
3636 and then In_Package_Body (Scop)
3638 Enclosing_Body_Present := True;
3642 exit when Is_Compilation_Unit (Scop);
3643 Scop := Scope (Scop);
3647 -- If front-end inlining is enabled, and this is a unit for which
3648 -- code will be generated, we instantiate the body at once.
3650 -- This is done if the instance is not the main unit, and if the
3651 -- generic is not a child unit of another generic, to avoid scope
3652 -- problems and the reinstallation of parent instances.
3655 and then (not Is_Child_Unit (Gen_Unit)
3656 or else not Is_Generic_Unit (Scope (Gen_Unit)))
3657 and then Might_Inline_Subp
3658 and then not Is_Actual_Pack
3660 if not Debug_Flag_Dot_K
3661 and then Front_End_Inlining
3662 and then (Is_In_Main_Unit (N)
3663 or else In_Main_Context (Current_Scope))
3664 and then Nkind (Parent (N)) /= N_Compilation_Unit
3668 elsif Debug_Flag_Dot_K
3669 and then Must_Inline_Subp
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 -- In configurable_run_time mode we force the inlining of
3677 -- predefined subprograms marked Inline_Always, to minimize
3678 -- the use of the run-time library.
3680 elsif Is_Predefined_File_Name
3681 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
3682 and then Configurable_Run_Time_Mode
3683 and then Nkind (Parent (N)) /= N_Compilation_Unit
3688 -- If the current scope is itself an instance within a child
3689 -- unit, there will be duplications in the scope stack, and the
3690 -- unstacking mechanism in Inline_Instance_Body will fail.
3691 -- This loses some rare cases of optimization, and might be
3692 -- improved some day, if we can find a proper abstraction for
3693 -- "the complete compilation context" that can be saved and
3696 if Is_Generic_Instance (Current_Scope) then
3698 Curr_Unit : constant Entity_Id :=
3699 Cunit_Entity (Current_Sem_Unit);
3701 if Curr_Unit /= Current_Scope
3702 and then Is_Child_Unit (Curr_Unit)
3704 Inline_Now := False;
3711 (Unit_Requires_Body (Gen_Unit)
3712 or else Enclosing_Body_Present
3713 or else Present (Corresponding_Body (Gen_Decl)))
3714 and then (Is_In_Main_Unit (N)
3715 or else Might_Inline_Subp)
3716 and then not Is_Actual_Pack
3717 and then not Inline_Now
3718 and then (Operating_Mode = Generate_Code
3719 or else (Operating_Mode = Check_Semantics
3720 and then ASIS_Mode));
3722 -- If front_end_inlining is enabled, do not instantiate body if
3723 -- within a generic context.
3725 if (Front_End_Inlining
3726 and then not Expander_Active)
3727 or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
3729 Needs_Body := False;
3732 -- If the current context is generic, and the package being
3733 -- instantiated is declared within a formal package, there is no
3734 -- body to instantiate until the enclosing generic is instantiated
3735 -- and there is an actual for the formal package. If the formal
3736 -- package has parameters, we build a regular package instance for
3737 -- it, that precedes the original formal package declaration.
3739 if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
3741 Decl : constant Node_Id :=
3743 (Unit_Declaration_Node (Scope (Gen_Unit)));
3745 if Nkind (Decl) = N_Formal_Package_Declaration
3746 or else (Nkind (Decl) = N_Package_Declaration
3747 and then Is_List_Member (Decl)
3748 and then Present (Next (Decl))
3750 Nkind (Next (Decl)) =
3751 N_Formal_Package_Declaration)
3753 Needs_Body := False;
3759 -- For RCI unit calling stubs, we omit the instance body if the
3760 -- instance is the RCI library unit itself.
3762 -- However there is a special case for nested instances: in this case
3763 -- we do generate the instance body, as it might be required, e.g.
3764 -- because it provides stream attributes for some type used in the
3765 -- profile of a remote subprogram. This is consistent with 12.3(12),
3766 -- which indicates that the instance body occurs at the place of the
3767 -- instantiation, and thus is part of the RCI declaration, which is
3768 -- present on all client partitions (this is E.2.3(18)).
3770 -- Note that AI12-0002 may make it illegal at some point to have
3771 -- stream attributes defined in an RCI unit, in which case this
3772 -- special case will become unnecessary. In the meantime, there
3773 -- is known application code in production that depends on this
3774 -- being possible, so we definitely cannot eliminate the body in
3775 -- the case of nested instances for the time being.
3777 -- When we generate a nested instance body, calling stubs for any
3778 -- relevant subprogram will be be inserted immediately after the
3779 -- subprogram declarations, and will take precedence over the
3780 -- subsequent (original) body. (The stub and original body will be
3781 -- complete homographs, but this is permitted in an instance).
3782 -- (Could we do better and remove the original body???)
3784 if Distribution_Stub_Mode = Generate_Caller_Stub_Body
3785 and then Comes_From_Source (N)
3786 and then Nkind (Parent (N)) = N_Compilation_Unit
3788 Needs_Body := False;
3793 -- Here is a defence against a ludicrous number of instantiations
3794 -- caused by a circular set of instantiation attempts.
3796 if Pending_Instantiations.Last > Maximum_Instantiations then
3797 Error_Msg_Uint_1 := UI_From_Int (Maximum_Instantiations);
3798 Error_Msg_N ("too many instantiations, exceeds max of^", N);
3799 Error_Msg_N ("\limit can be changed using -gnateinn switch", N);
3800 raise Unrecoverable_Error;
3803 -- Indicate that the enclosing scopes contain an instantiation,
3804 -- and that cleanup actions should be delayed until after the
3805 -- instance body is expanded.
3807 Check_Forward_Instantiation (Gen_Decl);
3808 if Nkind (N) = N_Package_Instantiation then
3810 Enclosing_Master : Entity_Id;
3813 -- Loop to search enclosing masters
3815 Enclosing_Master := Current_Scope;
3816 Scope_Loop : while Enclosing_Master /= Standard_Standard loop
3817 if Ekind (Enclosing_Master) = E_Package then
3818 if Is_Compilation_Unit (Enclosing_Master) then
3819 if In_Package_Body (Enclosing_Master) then
3821 (Body_Entity (Enclosing_Master));
3830 Enclosing_Master := Scope (Enclosing_Master);
3833 elsif Is_Generic_Unit (Enclosing_Master)
3834 or else Ekind (Enclosing_Master) = E_Void
3836 -- Cleanup actions will eventually be performed on the
3837 -- enclosing subprogram or package instance, if any.
3838 -- Enclosing scope is void in the formal part of a
3839 -- generic subprogram.
3844 if Ekind (Enclosing_Master) = E_Entry
3846 Ekind (Scope (Enclosing_Master)) = E_Protected_Type
3848 if not Expander_Active then
3852 Protected_Body_Subprogram (Enclosing_Master);
3856 Set_Delay_Cleanups (Enclosing_Master);
3858 while Ekind (Enclosing_Master) = E_Block loop
3859 Enclosing_Master := Scope (Enclosing_Master);
3862 if Is_Subprogram (Enclosing_Master) then
3863 Delay_Descriptors (Enclosing_Master);
3865 elsif Is_Task_Type (Enclosing_Master) then
3867 TBP : constant Node_Id :=
3868 Get_Task_Body_Procedure
3871 if Present (TBP) then
3872 Delay_Descriptors (TBP);
3873 Set_Delay_Cleanups (TBP);
3880 end loop Scope_Loop;
3883 -- Make entry in table
3885 Pending_Instantiations.Append
3887 Act_Decl => Act_Decl,
3888 Expander_Status => Expander_Active,
3889 Current_Sem_Unit => Current_Sem_Unit,
3890 Scope_Suppress => Scope_Suppress,
3891 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
3892 Version => Ada_Version));
3896 Set_Categorization_From_Pragmas (Act_Decl);
3898 if Parent_Installed then
3902 Set_Instance_Spec (N, Act_Decl);
3904 -- If not a compilation unit, insert the package declaration before
3905 -- the original instantiation node.
3907 if Nkind (Parent (N)) /= N_Compilation_Unit then
3908 Mark_Rewrite_Insertion (Act_Decl);
3909 Insert_Before (N, Act_Decl);
3912 -- For an instantiation that is a compilation unit, place
3913 -- declaration on current node so context is complete for analysis
3914 -- (including nested instantiations). If this is the main unit,
3915 -- the declaration eventually replaces the instantiation node.
3916 -- If the instance body is created later, it replaces the
3917 -- instance node, and the declaration is attached to it
3918 -- (see Build_Instance_Compilation_Unit_Nodes).
3921 if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
3923 -- The entity for the current unit is the newly created one,
3924 -- and all semantic information is attached to it.
3926 Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
3928 -- If this is the main unit, replace the main entity as well
3930 if Current_Sem_Unit = Main_Unit then
3931 Main_Unit_Entity := Act_Decl_Id;
3935 Set_Unit (Parent (N), Act_Decl);
3936 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
3937 Set_Package_Instantiation (Act_Decl_Id, N);
3939 Set_Unit (Parent (N), N);
3940 Set_Body_Required (Parent (N), False);
3942 -- We never need elaboration checks on instantiations, since by
3943 -- definition, the body instantiation is elaborated at the same
3944 -- time as the spec instantiation.
3946 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
3947 Set_Kill_Elaboration_Checks (Act_Decl_Id);
3950 Check_Elab_Instantiation (N);
3952 if ABE_Is_Certain (N) and then Needs_Body then
3953 Pending_Instantiations.Decrement_Last;
3956 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
3958 Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
3959 First_Private_Entity (Act_Decl_Id));
3961 -- If the instantiation will receive a body, the unit will be
3962 -- transformed into a package body, and receive its own elaboration
3963 -- entity. Otherwise, the nature of the unit is now a package
3966 if Nkind (Parent (N)) = N_Compilation_Unit
3967 and then not Needs_Body
3969 Rewrite (N, Act_Decl);
3972 if Present (Corresponding_Body (Gen_Decl))
3973 or else Unit_Requires_Body (Gen_Unit)
3975 Set_Has_Completion (Act_Decl_Id);
3978 Check_Formal_Packages (Act_Decl_Id);
3980 Restore_Hidden_Primitives (Vis_Prims_List);
3981 Restore_Private_Views (Act_Decl_Id);
3983 Inherit_Context (Gen_Decl, N);
3985 if Parent_Installed then
3990 Env_Installed := False;
3993 Validate_Categorization_Dependency (N, Act_Decl_Id);
3995 -- There used to be a check here to prevent instantiations in local
3996 -- contexts if the No_Local_Allocators restriction was active. This
3997 -- check was removed by a binding interpretation in AI-95-00130/07,
3998 -- but we retain the code for documentation purposes.
4000 -- if Ekind (Act_Decl_Id) /= E_Void
4001 -- and then not Is_Library_Level_Entity (Act_Decl_Id)
4003 -- Check_Restriction (No_Local_Allocators, N);
4007 Inline_Instance_Body (N, Gen_Unit, Act_Decl);
4010 -- The following is a tree patch for ASIS: ASIS needs separate nodes to
4011 -- be used as defining identifiers for a formal package and for the
4012 -- corresponding expanded package.
4014 if Nkind (N) = N_Formal_Package_Declaration then
4015 Act_Decl_Id := New_Copy (Defining_Entity (N));
4016 Set_Comes_From_Source (Act_Decl_Id, True);
4017 Set_Is_Generic_Instance (Act_Decl_Id, False);
4018 Set_Defining_Identifier (N, Act_Decl_Id);
4021 Style_Check := Save_Style_Check;
4023 -- Check that if N is an instantiation of System.Dim_Float_IO or
4024 -- System.Dim_Integer_IO, the formal type has a dimension system.
4026 if Nkind (N) = N_Package_Instantiation
4027 and then Is_Dim_IO_Package_Instantiation (N)
4030 Assoc : constant Node_Id := First (Generic_Associations (N));
4032 if not Has_Dimension_System
4033 (Etype (Explicit_Generic_Actual_Parameter (Assoc)))
4035 Error_Msg_N ("type with a dimension system expected", Assoc);
4041 if Has_Aspects (N) then
4042 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4046 when Instantiation_Error =>
4047 if Parent_Installed then
4051 if Env_Installed then
4055 Style_Check := Save_Style_Check;
4056 end Analyze_Package_Instantiation;
4058 --------------------------
4059 -- Inline_Instance_Body --
4060 --------------------------
4062 procedure Inline_Instance_Body
4064 Gen_Unit : Entity_Id;
4068 Gen_Comp : constant Entity_Id :=
4069 Cunit_Entity (Get_Source_Unit (Gen_Unit));
4070 Curr_Comp : constant Node_Id := Cunit (Current_Sem_Unit);
4071 Curr_Scope : Entity_Id := Empty;
4072 Curr_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
4073 Removed : Boolean := False;
4074 Num_Scopes : Int := 0;
4076 Scope_Stack_Depth : constant Int :=
4077 Scope_Stack.Last - Scope_Stack.First + 1;
4079 Use_Clauses : array (1 .. Scope_Stack_Depth) of Node_Id;
4080 Instances : array (1 .. Scope_Stack_Depth) of Entity_Id;
4081 Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
4082 Num_Inner : Int := 0;
4083 N_Instances : Int := 0;
4087 -- Case of generic unit defined in another unit. We must remove the
4088 -- complete context of the current unit to install that of the generic.
4090 if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
4092 -- Add some comments for the following two loops ???
4095 while Present (S) and then S /= Standard_Standard loop
4097 Num_Scopes := Num_Scopes + 1;
4099 Use_Clauses (Num_Scopes) :=
4101 (Scope_Stack.Last - Num_Scopes + 1).
4103 End_Use_Clauses (Use_Clauses (Num_Scopes));
4105 exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
4106 or else Scope_Stack.Table
4107 (Scope_Stack.Last - Num_Scopes).Entity
4111 exit when Is_Generic_Instance (S)
4112 and then (In_Package_Body (S)
4113 or else Ekind (S) = E_Procedure
4114 or else Ekind (S) = E_Function);
4118 Vis := Is_Immediately_Visible (Gen_Comp);
4120 -- Find and save all enclosing instances
4125 and then S /= Standard_Standard
4127 if Is_Generic_Instance (S) then
4128 N_Instances := N_Instances + 1;
4129 Instances (N_Instances) := S;
4131 exit when In_Package_Body (S);
4137 -- Remove context of current compilation unit, unless we are within a
4138 -- nested package instantiation, in which case the context has been
4139 -- removed previously.
4141 -- If current scope is the body of a child unit, remove context of
4142 -- spec as well. If an enclosing scope is an instance body, the
4143 -- context has already been removed, but the entities in the body
4144 -- must be made invisible as well.
4149 and then S /= Standard_Standard
4151 if Is_Generic_Instance (S)
4152 and then (In_Package_Body (S)
4153 or else Ekind (S) = E_Procedure
4154 or else Ekind (S) = E_Function)
4156 -- We still have to remove the entities of the enclosing
4157 -- instance from direct visibility.
4162 E := First_Entity (S);
4163 while Present (E) loop
4164 Set_Is_Immediately_Visible (E, False);
4173 or else (Ekind (Curr_Unit) = E_Package_Body
4174 and then S = Spec_Entity (Curr_Unit))
4175 or else (Ekind (Curr_Unit) = E_Subprogram_Body
4178 (Unit_Declaration_Node (Curr_Unit)))
4182 -- Remove entities in current scopes from visibility, so that
4183 -- instance body is compiled in a clean environment.
4185 Save_Scope_Stack (Handle_Use => False);
4187 if Is_Child_Unit (S) then
4189 -- Remove child unit from stack, as well as inner scopes.
4190 -- Removing the context of a child unit removes parent units
4193 while Current_Scope /= S loop
4194 Num_Inner := Num_Inner + 1;
4195 Inner_Scopes (Num_Inner) := Current_Scope;
4200 Remove_Context (Curr_Comp);
4204 Remove_Context (Curr_Comp);
4207 if Ekind (Curr_Unit) = E_Package_Body then
4208 Remove_Context (Library_Unit (Curr_Comp));
4214 pragma Assert (Num_Inner < Num_Scopes);
4216 Push_Scope (Standard_Standard);
4217 Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4218 Instantiate_Package_Body
4221 Act_Decl => Act_Decl,
4222 Expander_Status => Expander_Active,
4223 Current_Sem_Unit => Current_Sem_Unit,
4224 Scope_Suppress => Scope_Suppress,
4225 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4226 Version => Ada_Version)),
4227 Inlined_Body => True);
4233 Set_Is_Immediately_Visible (Gen_Comp, Vis);
4235 -- Reset Generic_Instance flag so that use clauses can be installed
4236 -- in the proper order. (See Use_One_Package for effect of enclosing
4237 -- instances on processing of use clauses).
4239 for J in 1 .. N_Instances loop
4240 Set_Is_Generic_Instance (Instances (J), False);
4244 Install_Context (Curr_Comp);
4246 if Present (Curr_Scope)
4247 and then Is_Child_Unit (Curr_Scope)
4249 Push_Scope (Curr_Scope);
4250 Set_Is_Immediately_Visible (Curr_Scope);
4252 -- Finally, restore inner scopes as well
4254 for J in reverse 1 .. Num_Inner loop
4255 Push_Scope (Inner_Scopes (J));
4259 Restore_Scope_Stack (Handle_Use => False);
4261 if Present (Curr_Scope)
4263 (In_Private_Part (Curr_Scope)
4264 or else In_Package_Body (Curr_Scope))
4266 -- Install private declaration of ancestor units, which are
4267 -- currently available. Restore_Scope_Stack and Install_Context
4268 -- only install the visible part of parents.
4273 Par := Scope (Curr_Scope);
4274 while (Present (Par))
4275 and then Par /= Standard_Standard
4277 Install_Private_Declarations (Par);
4284 -- Restore use clauses. For a child unit, use clauses in the parents
4285 -- are restored when installing the context, so only those in inner
4286 -- scopes (and those local to the child unit itself) need to be
4287 -- installed explicitly.
4289 if Is_Child_Unit (Curr_Unit)
4292 for J in reverse 1 .. Num_Inner + 1 loop
4293 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4295 Install_Use_Clauses (Use_Clauses (J));
4299 for J in reverse 1 .. Num_Scopes loop
4300 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4302 Install_Use_Clauses (Use_Clauses (J));
4306 -- Restore status of instances. If one of them is a body, make
4307 -- its local entities visible again.
4314 for J in 1 .. N_Instances loop
4315 Inst := Instances (J);
4316 Set_Is_Generic_Instance (Inst, True);
4318 if In_Package_Body (Inst)
4319 or else Ekind (S) = E_Procedure
4320 or else Ekind (S) = E_Function
4322 E := First_Entity (Instances (J));
4323 while Present (E) loop
4324 Set_Is_Immediately_Visible (E);
4331 -- If generic unit is in current unit, current context is correct
4334 Instantiate_Package_Body
4337 Act_Decl => Act_Decl,
4338 Expander_Status => Expander_Active,
4339 Current_Sem_Unit => Current_Sem_Unit,
4340 Scope_Suppress => Scope_Suppress,
4341 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4342 Version => Ada_Version)),
4343 Inlined_Body => True);
4345 end Inline_Instance_Body;
4347 -------------------------------------
4348 -- Analyze_Procedure_Instantiation --
4349 -------------------------------------
4351 procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4353 Analyze_Subprogram_Instantiation (N, E_Procedure);
4354 end Analyze_Procedure_Instantiation;
4356 -----------------------------------
4357 -- Need_Subprogram_Instance_Body --
4358 -----------------------------------
4360 function Need_Subprogram_Instance_Body
4362 Subp : Entity_Id) return Boolean
4365 if (Is_In_Main_Unit (N)
4366 or else Is_Inlined (Subp)
4367 or else Is_Inlined (Alias (Subp)))
4368 and then (Operating_Mode = Generate_Code
4369 or else (Operating_Mode = Check_Semantics
4370 and then ASIS_Mode))
4371 and then (Full_Expander_Active or else ASIS_Mode)
4372 and then not ABE_Is_Certain (N)
4373 and then not Is_Eliminated (Subp)
4375 Pending_Instantiations.Append
4377 Act_Decl => Unit_Declaration_Node (Subp),
4378 Expander_Status => Expander_Active,
4379 Current_Sem_Unit => Current_Sem_Unit,
4380 Scope_Suppress => Scope_Suppress,
4381 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4382 Version => Ada_Version));
4388 end Need_Subprogram_Instance_Body;
4390 --------------------------------------
4391 -- Analyze_Subprogram_Instantiation --
4392 --------------------------------------
4394 procedure Analyze_Subprogram_Instantiation
4398 Loc : constant Source_Ptr := Sloc (N);
4399 Gen_Id : constant Node_Id := Name (N);
4401 Anon_Id : constant Entity_Id :=
4402 Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4403 Chars => New_External_Name
4404 (Chars (Defining_Entity (N)), 'R'));
4406 Act_Decl_Id : Entity_Id;
4411 Env_Installed : Boolean := False;
4412 Gen_Unit : Entity_Id;
4414 Pack_Id : Entity_Id;
4415 Parent_Installed : Boolean := False;
4416 Renaming_List : List_Id;
4418 procedure Analyze_Instance_And_Renamings;
4419 -- The instance must be analyzed in a context that includes the mappings
4420 -- of generic parameters into actuals. We create a package declaration
4421 -- for this purpose, and a subprogram with an internal name within the
4422 -- package. The subprogram instance is simply an alias for the internal
4423 -- subprogram, declared in the current scope.
4425 ------------------------------------
4426 -- Analyze_Instance_And_Renamings --
4427 ------------------------------------
4429 procedure Analyze_Instance_And_Renamings is
4430 Def_Ent : constant Entity_Id := Defining_Entity (N);
4431 Pack_Decl : Node_Id;
4434 if Nkind (Parent (N)) = N_Compilation_Unit then
4436 -- For the case of a compilation unit, the container package has
4437 -- the same name as the instantiation, to insure that the binder
4438 -- calls the elaboration procedure with the right name. Copy the
4439 -- entity of the instance, which may have compilation level flags
4440 -- (e.g. Is_Child_Unit) set.
4442 Pack_Id := New_Copy (Def_Ent);
4445 -- Otherwise we use the name of the instantiation concatenated
4446 -- with its source position to ensure uniqueness if there are
4447 -- several instantiations with the same name.
4450 Make_Defining_Identifier (Loc,
4451 Chars => New_External_Name
4452 (Related_Id => Chars (Def_Ent),
4454 Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4457 Pack_Decl := Make_Package_Declaration (Loc,
4458 Specification => Make_Package_Specification (Loc,
4459 Defining_Unit_Name => Pack_Id,
4460 Visible_Declarations => Renaming_List,
4461 End_Label => Empty));
4463 Set_Instance_Spec (N, Pack_Decl);
4464 Set_Is_Generic_Instance (Pack_Id);
4465 Set_Debug_Info_Needed (Pack_Id);
4467 -- Case of not a compilation unit
4469 if Nkind (Parent (N)) /= N_Compilation_Unit then
4470 Mark_Rewrite_Insertion (Pack_Decl);
4471 Insert_Before (N, Pack_Decl);
4472 Set_Has_Completion (Pack_Id);
4474 -- Case of an instantiation that is a compilation unit
4476 -- Place declaration on current node so context is complete for
4477 -- analysis (including nested instantiations), and for use in a
4478 -- context_clause (see Analyze_With_Clause).
4481 Set_Unit (Parent (N), Pack_Decl);
4482 Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4485 Analyze (Pack_Decl);
4486 Check_Formal_Packages (Pack_Id);
4487 Set_Is_Generic_Instance (Pack_Id, False);
4489 -- Why do we clear Is_Generic_Instance??? We set it 20 lines
4492 -- Body of the enclosing package is supplied when instantiating the
4493 -- subprogram body, after semantic analysis is completed.
4495 if Nkind (Parent (N)) = N_Compilation_Unit then
4497 -- Remove package itself from visibility, so it does not
4498 -- conflict with subprogram.
4500 Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4502 -- Set name and scope of internal subprogram so that the proper
4503 -- external name will be generated. The proper scope is the scope
4504 -- of the wrapper package. We need to generate debugging info for
4505 -- the internal subprogram, so set flag accordingly.
4507 Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4508 Set_Scope (Anon_Id, Scope (Pack_Id));
4510 -- Mark wrapper package as referenced, to avoid spurious warnings
4511 -- if the instantiation appears in various with_ clauses of
4512 -- subunits of the main unit.
4514 Set_Referenced (Pack_Id);
4517 Set_Is_Generic_Instance (Anon_Id);
4518 Set_Debug_Info_Needed (Anon_Id);
4519 Act_Decl_Id := New_Copy (Anon_Id);
4521 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4522 Set_Chars (Act_Decl_Id, Chars (Defining_Entity (N)));
4523 Set_Sloc (Act_Decl_Id, Sloc (Defining_Entity (N)));
4524 Set_Comes_From_Source (Act_Decl_Id, True);
4526 -- The signature may involve types that are not frozen yet, but the
4527 -- subprogram will be frozen at the point the wrapper package is
4528 -- frozen, so it does not need its own freeze node. In fact, if one
4529 -- is created, it might conflict with the freezing actions from the
4532 Set_Has_Delayed_Freeze (Anon_Id, False);
4534 -- If the instance is a child unit, mark the Id accordingly. Mark
4535 -- the anonymous entity as well, which is the real subprogram and
4536 -- which is used when the instance appears in a context clause.
4537 -- Similarly, propagate the Is_Eliminated flag to handle properly
4538 -- nested eliminated subprograms.
4540 Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
4541 Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
4542 New_Overloaded_Entity (Act_Decl_Id);
4543 Check_Eliminated (Act_Decl_Id);
4544 Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
4546 -- In compilation unit case, kill elaboration checks on the
4547 -- instantiation, since they are never needed -- the body is
4548 -- instantiated at the same point as the spec.
4550 if Nkind (Parent (N)) = N_Compilation_Unit then
4551 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4552 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4553 Set_Is_Compilation_Unit (Anon_Id);
4555 Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
4558 -- The instance is not a freezing point for the new subprogram
4560 Set_Is_Frozen (Act_Decl_Id, False);
4562 if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
4563 Valid_Operator_Definition (Act_Decl_Id);
4566 Set_Alias (Act_Decl_Id, Anon_Id);
4567 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4568 Set_Has_Completion (Act_Decl_Id);
4569 Set_Related_Instance (Pack_Id, Act_Decl_Id);
4571 if Nkind (Parent (N)) = N_Compilation_Unit then
4572 Set_Body_Required (Parent (N), False);
4574 end Analyze_Instance_And_Renamings;
4578 Vis_Prims_List : Elist_Id := No_Elist;
4579 -- List of primitives made temporarily visible in the instantiation
4580 -- to match the visibility of the formal type
4582 -- Start of processing for Analyze_Subprogram_Instantiation
4585 Check_SPARK_Restriction ("generic is not allowed", N);
4587 -- Very first thing: apply the special kludge for Text_IO processing
4588 -- in case we are instantiating one of the children of [Wide_]Text_IO.
4589 -- Of course such an instantiation is bogus (these are packages, not
4590 -- subprograms), but we get a better error message if we do this.
4592 Text_IO_Kludge (Gen_Id);
4594 -- Make node global for error reporting
4596 Instantiation_Node := N;
4598 -- For package instantiations we turn off style checks, because they
4599 -- will have been emitted in the generic. For subprogram instantiations
4600 -- we want to apply at least the check on overriding indicators so we
4601 -- do not modify the style check status.
4603 -- The renaming declarations for the actuals do not come from source and
4604 -- will not generate spurious warnings.
4606 Preanalyze_Actuals (N);
4609 Env_Installed := True;
4610 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
4611 Gen_Unit := Entity (Gen_Id);
4613 Generate_Reference (Gen_Unit, Gen_Id);
4615 if Nkind (Gen_Id) = N_Identifier
4616 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
4619 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
4622 if Etype (Gen_Unit) = Any_Type then
4627 -- Verify that it is a generic subprogram of the right kind, and that
4628 -- it does not lead to a circular instantiation.
4630 if not Ekind_In (Gen_Unit, E_Generic_Procedure, E_Generic_Function) then
4631 Error_Msg_N ("expect generic subprogram in instantiation", Gen_Id);
4633 elsif In_Open_Scopes (Gen_Unit) then
4634 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
4636 elsif K = E_Procedure
4637 and then Ekind (Gen_Unit) /= E_Generic_Procedure
4639 if Ekind (Gen_Unit) = E_Generic_Function then
4641 ("cannot instantiate generic function as procedure", Gen_Id);
4644 ("expect name of generic procedure in instantiation", Gen_Id);
4647 elsif K = E_Function
4648 and then Ekind (Gen_Unit) /= E_Generic_Function
4650 if Ekind (Gen_Unit) = E_Generic_Procedure then
4652 ("cannot instantiate generic procedure as function", Gen_Id);
4655 ("expect name of generic function in instantiation", Gen_Id);
4659 Set_Entity (Gen_Id, Gen_Unit);
4660 Set_Is_Instantiated (Gen_Unit);
4662 if In_Extended_Main_Source_Unit (N) then
4663 Generate_Reference (Gen_Unit, N);
4666 -- If renaming, get original unit
4668 if Present (Renamed_Object (Gen_Unit))
4669 and then (Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Procedure
4671 Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Function)
4673 Gen_Unit := Renamed_Object (Gen_Unit);
4674 Set_Is_Instantiated (Gen_Unit);
4675 Generate_Reference (Gen_Unit, N);
4678 if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
4679 Error_Msg_Node_2 := Current_Scope;
4681 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
4682 Circularity_Detected := True;
4683 Restore_Hidden_Primitives (Vis_Prims_List);
4687 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
4689 -- Initialize renamings map, for error checking
4691 Generic_Renamings.Set_Last (0);
4692 Generic_Renamings_HTable.Reset;
4694 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
4696 -- Copy original generic tree, to produce text for instantiation
4700 (Original_Node (Gen_Decl), Empty, Instantiating => True);
4702 -- Inherit overriding indicator from instance node
4704 Act_Spec := Specification (Act_Tree);
4705 Set_Must_Override (Act_Spec, Must_Override (N));
4706 Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
4709 Analyze_Associations
4711 Formals => Generic_Formal_Declarations (Act_Tree),
4712 F_Copy => Generic_Formal_Declarations (Gen_Decl));
4714 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
4716 -- The subprogram itself cannot contain a nested instance, so the
4717 -- current parent is left empty.
4719 Set_Instance_Env (Gen_Unit, Empty);
4721 -- Build the subprogram declaration, which does not appear in the
4722 -- generic template, and give it a sloc consistent with that of the
4725 Set_Defining_Unit_Name (Act_Spec, Anon_Id);
4726 Set_Generic_Parent (Act_Spec, Gen_Unit);
4728 Make_Subprogram_Declaration (Sloc (Act_Spec),
4729 Specification => Act_Spec);
4731 -- The aspects have been copied previously, but they have to be
4732 -- linked explicitly to the new subprogram declaration. Explicit
4733 -- pre/postconditions on the instance are analyzed below, in a
4736 Move_Aspects (Act_Tree, Act_Decl);
4737 Set_Categorization_From_Pragmas (Act_Decl);
4739 if Parent_Installed then
4743 Append (Act_Decl, Renaming_List);
4744 Analyze_Instance_And_Renamings;
4746 -- If the generic is marked Import (Intrinsic), then so is the
4747 -- instance. This indicates that there is no body to instantiate. If
4748 -- generic is marked inline, so it the instance, and the anonymous
4749 -- subprogram it renames. If inlined, or else if inlining is enabled
4750 -- for the compilation, we generate the instance body even if it is
4751 -- not within the main unit.
4753 if Is_Intrinsic_Subprogram (Gen_Unit) then
4754 Set_Is_Intrinsic_Subprogram (Anon_Id);
4755 Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
4757 if Chars (Gen_Unit) = Name_Unchecked_Conversion then
4758 Validate_Unchecked_Conversion (N, Act_Decl_Id);
4762 -- Inherit convention from generic unit. Intrinsic convention, as for
4763 -- an instance of unchecked conversion, is not inherited because an
4764 -- explicit Ada instance has been created.
4766 if Has_Convention_Pragma (Gen_Unit)
4767 and then Convention (Gen_Unit) /= Convention_Intrinsic
4769 Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
4770 Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
4773 Generate_Definition (Act_Decl_Id);
4774 -- Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id)));
4776 Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
4778 -- Inherit all inlining-related flags which apply to the generic in
4779 -- the subprogram and its declaration.
4781 Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
4782 Set_Is_Inlined (Anon_Id, Is_Inlined (Gen_Unit));
4784 Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
4785 Set_Has_Pragma_Inline (Anon_Id, Has_Pragma_Inline (Gen_Unit));
4787 Set_Has_Pragma_Inline_Always
4788 (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
4789 Set_Has_Pragma_Inline_Always
4790 (Anon_Id, Has_Pragma_Inline_Always (Gen_Unit));
4792 if not Is_Intrinsic_Subprogram (Gen_Unit) then
4793 Check_Elab_Instantiation (N);
4796 if Is_Dispatching_Operation (Act_Decl_Id)
4797 and then Ada_Version >= Ada_2005
4803 Formal := First_Formal (Act_Decl_Id);
4804 while Present (Formal) loop
4805 if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
4806 and then Is_Controlling_Formal (Formal)
4807 and then not Can_Never_Be_Null (Formal)
4809 Error_Msg_NE ("access parameter& is controlling,",
4812 ("\corresponding parameter of & must be"
4813 & " explicitly null-excluding", N, Gen_Id);
4816 Next_Formal (Formal);
4821 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4823 Validate_Categorization_Dependency (N, Act_Decl_Id);
4825 if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
4826 Inherit_Context (Gen_Decl, N);
4828 Restore_Private_Views (Pack_Id, False);
4830 -- If the context requires a full instantiation, mark node for
4831 -- subsequent construction of the body.
4833 if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
4835 Check_Forward_Instantiation (Gen_Decl);
4837 -- The wrapper package is always delayed, because it does not
4838 -- constitute a freeze point, but to insure that the freeze
4839 -- node is placed properly, it is created directly when
4840 -- instantiating the body (otherwise the freeze node might
4841 -- appear to early for nested instantiations).
4843 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4845 -- For ASIS purposes, indicate that the wrapper package has
4846 -- replaced the instantiation node.
4848 Rewrite (N, Unit (Parent (N)));
4849 Set_Unit (Parent (N), N);
4852 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4854 -- Replace instance node for library-level instantiations of
4855 -- intrinsic subprograms, for ASIS use.
4857 Rewrite (N, Unit (Parent (N)));
4858 Set_Unit (Parent (N), N);
4861 if Parent_Installed then
4865 Restore_Hidden_Primitives (Vis_Prims_List);
4867 Env_Installed := False;
4868 Generic_Renamings.Set_Last (0);
4869 Generic_Renamings_HTable.Reset;
4873 if Has_Aspects (N) then
4874 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4878 when Instantiation_Error =>
4879 if Parent_Installed then
4883 if Env_Installed then
4886 end Analyze_Subprogram_Instantiation;
4888 -------------------------
4889 -- Get_Associated_Node --
4890 -------------------------
4892 function Get_Associated_Node (N : Node_Id) return Node_Id is
4896 Assoc := Associated_Node (N);
4898 if Nkind (Assoc) /= Nkind (N) then
4901 elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
4905 -- If the node is part of an inner generic, it may itself have been
4906 -- remapped into a further generic copy. Associated_Node is otherwise
4907 -- used for the entity of the node, and will be of a different node
4908 -- kind, or else N has been rewritten as a literal or function call.
4910 while Present (Associated_Node (Assoc))
4911 and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
4913 Assoc := Associated_Node (Assoc);
4916 -- Follow and additional link in case the final node was rewritten.
4917 -- This can only happen with nested generic units.
4919 if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
4920 and then Present (Associated_Node (Assoc))
4921 and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
4922 N_Explicit_Dereference,
4927 Assoc := Associated_Node (Assoc);
4930 -- An additional special case: an unconstrained type in an object
4931 -- declaration may have been rewritten as a local subtype constrained
4932 -- by the expression in the declaration. We need to recover the
4933 -- original entity which may be global.
4935 if Present (Original_Node (Assoc))
4936 and then Nkind (Parent (N)) = N_Object_Declaration
4938 Assoc := Original_Node (Assoc);
4943 end Get_Associated_Node;
4945 -------------------------------------------
4946 -- Build_Instance_Compilation_Unit_Nodes --
4947 -------------------------------------------
4949 procedure Build_Instance_Compilation_Unit_Nodes
4954 Decl_Cunit : Node_Id;
4955 Body_Cunit : Node_Id;
4957 New_Main : constant Entity_Id := Defining_Entity (Act_Decl);
4958 Old_Main : constant Entity_Id := Cunit_Entity (Main_Unit);
4961 -- A new compilation unit node is built for the instance declaration
4964 Make_Compilation_Unit (Sloc (N),
4965 Context_Items => Empty_List,
4967 Aux_Decls_Node => Make_Compilation_Unit_Aux (Sloc (N)));
4969 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
4971 -- The new compilation unit is linked to its body, but both share the
4972 -- same file, so we do not set Body_Required on the new unit so as not
4973 -- to create a spurious dependency on a non-existent body in the ali.
4974 -- This simplifies CodePeer unit traversal.
4976 -- We use the original instantiation compilation unit as the resulting
4977 -- compilation unit of the instance, since this is the main unit.
4979 Rewrite (N, Act_Body);
4980 Body_Cunit := Parent (N);
4982 -- The two compilation unit nodes are linked by the Library_Unit field
4984 Set_Library_Unit (Decl_Cunit, Body_Cunit);
4985 Set_Library_Unit (Body_Cunit, Decl_Cunit);
4987 -- Preserve the private nature of the package if needed
4989 Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
4991 -- If the instance is not the main unit, its context, categorization
4992 -- and elaboration entity are not relevant to the compilation.
4994 if Body_Cunit /= Cunit (Main_Unit) then
4995 Make_Instance_Unit (Body_Cunit, In_Main => False);
4999 -- The context clause items on the instantiation, which are now attached
5000 -- to the body compilation unit (since the body overwrote the original
5001 -- instantiation node), semantically belong on the spec, so copy them
5002 -- there. It's harmless to leave them on the body as well. In fact one
5003 -- could argue that they belong in both places.
5005 Citem := First (Context_Items (Body_Cunit));
5006 while Present (Citem) loop
5007 Append (New_Copy (Citem), Context_Items (Decl_Cunit));
5011 -- Propagate categorization flags on packages, so that they appear in
5012 -- the ali file for the spec of the unit.
5014 if Ekind (New_Main) = E_Package then
5015 Set_Is_Pure (Old_Main, Is_Pure (New_Main));
5016 Set_Is_Preelaborated (Old_Main, Is_Preelaborated (New_Main));
5017 Set_Is_Remote_Types (Old_Main, Is_Remote_Types (New_Main));
5018 Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
5019 Set_Is_Remote_Call_Interface
5020 (Old_Main, Is_Remote_Call_Interface (New_Main));
5023 -- Make entry in Units table, so that binder can generate call to
5024 -- elaboration procedure for body, if any.
5026 Make_Instance_Unit (Body_Cunit, In_Main => True);
5027 Main_Unit_Entity := New_Main;
5028 Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
5030 -- Build elaboration entity, since the instance may certainly generate
5031 -- elaboration code requiring a flag for protection.
5033 Build_Elaboration_Entity (Decl_Cunit, New_Main);
5034 end Build_Instance_Compilation_Unit_Nodes;
5036 -----------------------------
5037 -- Check_Access_Definition --
5038 -----------------------------
5040 procedure Check_Access_Definition (N : Node_Id) is
5043 (Ada_Version >= Ada_2005 and then Present (Access_Definition (N)));
5045 end Check_Access_Definition;
5047 -----------------------------------
5048 -- Check_Formal_Package_Instance --
5049 -----------------------------------
5051 -- If the formal has specific parameters, they must match those of the
5052 -- actual. Both of them are instances, and the renaming declarations for
5053 -- their formal parameters appear in the same order in both. The analyzed
5054 -- formal has been analyzed in the context of the current instance.
5056 procedure Check_Formal_Package_Instance
5057 (Formal_Pack : Entity_Id;
5058 Actual_Pack : Entity_Id)
5060 E1 : Entity_Id := First_Entity (Actual_Pack);
5061 E2 : Entity_Id := First_Entity (Formal_Pack);
5066 procedure Check_Mismatch (B : Boolean);
5067 -- Common error routine for mismatch between the parameters of the
5068 -- actual instance and those of the formal package.
5070 function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
5071 -- The formal may come from a nested formal package, and the actual may
5072 -- have been constant-folded. To determine whether the two denote the
5073 -- same entity we may have to traverse several definitions to recover
5074 -- the ultimate entity that they refer to.
5076 function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
5077 -- Similarly, if the formal comes from a nested formal package, the
5078 -- actual may designate the formal through multiple renamings, which
5079 -- have to be followed to determine the original variable in question.
5081 --------------------
5082 -- Check_Mismatch --
5083 --------------------
5085 procedure Check_Mismatch (B : Boolean) is
5086 Kind : constant Node_Kind := Nkind (Parent (E2));
5089 if Kind = N_Formal_Type_Declaration then
5092 elsif Nkind_In (Kind, N_Formal_Object_Declaration,
5093 N_Formal_Package_Declaration)
5094 or else Kind in N_Formal_Subprogram_Declaration
5100 ("actual for & in actual instance does not match formal",
5101 Parent (Actual_Pack), E1);
5105 --------------------------------
5106 -- Same_Instantiated_Constant --
5107 --------------------------------
5109 function Same_Instantiated_Constant
5110 (E1, E2 : Entity_Id) return Boolean
5116 while Present (Ent) loop
5120 elsif Ekind (Ent) /= E_Constant then
5123 elsif Is_Entity_Name (Constant_Value (Ent)) then
5124 if Entity (Constant_Value (Ent)) = E1 then
5127 Ent := Entity (Constant_Value (Ent));
5130 -- The actual may be a constant that has been folded. Recover
5133 elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5134 Ent := Entity (Original_Node (Constant_Value (Ent)));
5141 end Same_Instantiated_Constant;
5143 --------------------------------
5144 -- Same_Instantiated_Variable --
5145 --------------------------------
5147 function Same_Instantiated_Variable
5148 (E1, E2 : Entity_Id) return Boolean
5150 function Original_Entity (E : Entity_Id) return Entity_Id;
5151 -- Follow chain of renamings to the ultimate ancestor
5153 ---------------------
5154 -- Original_Entity --
5155 ---------------------
5157 function Original_Entity (E : Entity_Id) return Entity_Id is
5162 while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5163 and then Present (Renamed_Object (Orig))
5164 and then Is_Entity_Name (Renamed_Object (Orig))
5166 Orig := Entity (Renamed_Object (Orig));
5170 end Original_Entity;
5172 -- Start of processing for Same_Instantiated_Variable
5175 return Ekind (E1) = Ekind (E2)
5176 and then Original_Entity (E1) = Original_Entity (E2);
5177 end Same_Instantiated_Variable;
5179 -- Start of processing for Check_Formal_Package_Instance
5183 and then Present (E2)
5185 exit when Ekind (E1) = E_Package
5186 and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5188 -- If the formal is the renaming of the formal package, this
5189 -- is the end of its formal part, which may occur before the
5190 -- end of the formal part in the actual in the presence of
5191 -- defaulted parameters in the formal package.
5193 exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5194 and then Renamed_Entity (E2) = Scope (E2);
5196 -- The analysis of the actual may generate additional internal
5197 -- entities. If the formal is defaulted, there is no corresponding
5198 -- analysis and the internal entities must be skipped, until we
5199 -- find corresponding entities again.
5201 if Comes_From_Source (E2)
5202 and then not Comes_From_Source (E1)
5203 and then Chars (E1) /= Chars (E2)
5206 and then Chars (E1) /= Chars (E2)
5215 -- If the formal entity comes from a formal declaration, it was
5216 -- defaulted in the formal package, and no check is needed on it.
5218 elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
5221 elsif Is_Type (E1) then
5223 -- Subtypes must statically match. E1, E2 are the local entities
5224 -- that are subtypes of the actuals. Itypes generated for other
5225 -- parameters need not be checked, the check will be performed
5226 -- on the parameters themselves.
5228 -- If E2 is a formal type declaration, it is a defaulted parameter
5229 -- and needs no checking.
5231 if not Is_Itype (E1)
5232 and then not Is_Itype (E2)
5236 or else Etype (E1) /= Etype (E2)
5237 or else not Subtypes_Statically_Match (E1, E2));
5240 elsif Ekind (E1) = E_Constant then
5242 -- IN parameters must denote the same static value, or the same
5243 -- constant, or the literal null.
5245 Expr1 := Expression (Parent (E1));
5247 if Ekind (E2) /= E_Constant then
5248 Check_Mismatch (True);
5251 Expr2 := Expression (Parent (E2));
5254 if Is_Static_Expression (Expr1) then
5256 if not Is_Static_Expression (Expr2) then
5257 Check_Mismatch (True);
5259 elsif Is_Discrete_Type (Etype (E1)) then
5261 V1 : constant Uint := Expr_Value (Expr1);
5262 V2 : constant Uint := Expr_Value (Expr2);
5264 Check_Mismatch (V1 /= V2);
5267 elsif Is_Real_Type (Etype (E1)) then
5269 V1 : constant Ureal := Expr_Value_R (Expr1);
5270 V2 : constant Ureal := Expr_Value_R (Expr2);
5272 Check_Mismatch (V1 /= V2);
5275 elsif Is_String_Type (Etype (E1))
5276 and then Nkind (Expr1) = N_String_Literal
5278 if Nkind (Expr2) /= N_String_Literal then
5279 Check_Mismatch (True);
5282 (not String_Equal (Strval (Expr1), Strval (Expr2)));
5286 elsif Is_Entity_Name (Expr1) then
5287 if Is_Entity_Name (Expr2) then
5288 if Entity (Expr1) = Entity (Expr2) then
5292 (not Same_Instantiated_Constant
5293 (Entity (Expr1), Entity (Expr2)));
5296 Check_Mismatch (True);
5299 elsif Is_Entity_Name (Original_Node (Expr1))
5300 and then Is_Entity_Name (Expr2)
5302 Same_Instantiated_Constant
5303 (Entity (Original_Node (Expr1)), Entity (Expr2))
5307 elsif Nkind (Expr1) = N_Null then
5308 Check_Mismatch (Nkind (Expr1) /= N_Null);
5311 Check_Mismatch (True);
5314 elsif Ekind (E1) = E_Variable then
5315 Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5317 elsif Ekind (E1) = E_Package then
5319 (Ekind (E1) /= Ekind (E2)
5320 or else Renamed_Object (E1) /= Renamed_Object (E2));
5322 elsif Is_Overloadable (E1) then
5324 -- Verify that the actual subprograms match. Note that actuals
5325 -- that are attributes are rewritten as subprograms. If the
5326 -- subprogram in the formal package is defaulted, no check is
5327 -- needed. Note that this can only happen in Ada 2005 when the
5328 -- formal package can be partially parameterized.
5330 if Nkind (Unit_Declaration_Node (E1)) =
5331 N_Subprogram_Renaming_Declaration
5332 and then From_Default (Unit_Declaration_Node (E1))
5336 -- If the formal package has an "others" box association that
5337 -- covers this formal, there is no need for a check either.
5339 elsif Nkind (Unit_Declaration_Node (E2)) in
5340 N_Formal_Subprogram_Declaration
5341 and then Box_Present (Unit_Declaration_Node (E2))
5345 -- No check needed if subprogram is a defaulted null procedure
5347 elsif No (Alias (E2))
5348 and then Ekind (E2) = E_Procedure
5350 Null_Present (Specification (Unit_Declaration_Node (E2)))
5354 -- Otherwise the actual in the formal and the actual in the
5355 -- instantiation of the formal must match, up to renamings.
5359 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5363 raise Program_Error;
5370 end Check_Formal_Package_Instance;
5372 ---------------------------
5373 -- Check_Formal_Packages --
5374 ---------------------------
5376 procedure Check_Formal_Packages (P_Id : Entity_Id) is
5378 Formal_P : Entity_Id;
5381 -- Iterate through the declarations in the instance, looking for package
5382 -- renaming declarations that denote instances of formal packages. Stop
5383 -- when we find the renaming of the current package itself. The
5384 -- declaration for a formal package without a box is followed by an
5385 -- internal entity that repeats the instantiation.
5387 E := First_Entity (P_Id);
5388 while Present (E) loop
5389 if Ekind (E) = E_Package then
5390 if Renamed_Object (E) = P_Id then
5393 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5396 elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5397 Formal_P := Next_Entity (E);
5398 Check_Formal_Package_Instance (Formal_P, E);
5400 -- After checking, remove the internal validating package. It
5401 -- is only needed for semantic checks, and as it may contain
5402 -- generic formal declarations it should not reach gigi.
5404 Remove (Unit_Declaration_Node (Formal_P));
5410 end Check_Formal_Packages;
5412 ---------------------------------
5413 -- Check_Forward_Instantiation --
5414 ---------------------------------
5416 procedure Check_Forward_Instantiation (Decl : Node_Id) is
5418 Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5421 -- The instantiation appears before the generic body if we are in the
5422 -- scope of the unit containing the generic, either in its spec or in
5423 -- the package body, and before the generic body.
5425 if Ekind (Gen_Comp) = E_Package_Body then
5426 Gen_Comp := Spec_Entity (Gen_Comp);
5429 if In_Open_Scopes (Gen_Comp)
5430 and then No (Corresponding_Body (Decl))
5435 and then not Is_Compilation_Unit (S)
5436 and then not Is_Child_Unit (S)
5438 if Ekind (S) = E_Package then
5439 Set_Has_Forward_Instantiation (S);
5445 end Check_Forward_Instantiation;
5447 ---------------------------
5448 -- Check_Generic_Actuals --
5449 ---------------------------
5451 -- The visibility of the actuals may be different between the point of
5452 -- generic instantiation and the instantiation of the body.
5454 procedure Check_Generic_Actuals
5455 (Instance : Entity_Id;
5456 Is_Formal_Box : Boolean)
5461 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5462 -- For a formal that is an array type, the component type is often a
5463 -- previous formal in the same unit. The privacy status of the component
5464 -- type will have been examined earlier in the traversal of the
5465 -- corresponding actuals, and this status should not be modified for the
5466 -- array type itself.
5468 -- To detect this case we have to rescan the list of formals, which
5469 -- is usually short enough to ignore the resulting inefficiency.
5471 -----------------------------
5472 -- Denotes_Previous_Actual --
5473 -----------------------------
5475 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5479 Prev := First_Entity (Instance);
5480 while Present (Prev) loop
5482 and then Nkind (Parent (Prev)) = N_Subtype_Declaration
5483 and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
5484 and then Entity (Subtype_Indication (Parent (Prev))) = Typ
5497 end Denotes_Previous_Actual;
5499 -- Start of processing for Check_Generic_Actuals
5502 E := First_Entity (Instance);
5503 while Present (E) loop
5505 and then Nkind (Parent (E)) = N_Subtype_Declaration
5506 and then Scope (Etype (E)) /= Instance
5507 and then Is_Entity_Name (Subtype_Indication (Parent (E)))
5509 if Is_Array_Type (E)
5510 and then Denotes_Previous_Actual (Component_Type (E))
5514 Check_Private_View (Subtype_Indication (Parent (E)));
5517 Set_Is_Generic_Actual_Type (E, True);
5518 Set_Is_Hidden (E, False);
5519 Set_Is_Potentially_Use_Visible (E,
5522 -- We constructed the generic actual type as a subtype of the
5523 -- supplied type. This means that it normally would not inherit
5524 -- subtype specific attributes of the actual, which is wrong for
5525 -- the generic case.
5527 Astype := Ancestor_Subtype (E);
5531 -- This can happen when E is an itype that is the full view of
5532 -- a private type completed, e.g. with a constrained array. In
5533 -- that case, use the first subtype, which will carry size
5534 -- information. The base type itself is unconstrained and will
5537 Astype := First_Subtype (E);
5540 Set_Size_Info (E, (Astype));
5541 Set_RM_Size (E, RM_Size (Astype));
5542 Set_First_Rep_Item (E, First_Rep_Item (Astype));
5544 if Is_Discrete_Or_Fixed_Point_Type (E) then
5545 Set_RM_Size (E, RM_Size (Astype));
5547 -- In nested instances, the base type of an access actual
5548 -- may itself be private, and need to be exchanged.
5550 elsif Is_Access_Type (E)
5551 and then Is_Private_Type (Etype (E))
5554 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
5557 elsif Ekind (E) = E_Package then
5559 -- If this is the renaming for the current instance, we're done.
5560 -- Otherwise it is a formal package. If the corresponding formal
5561 -- was declared with a box, the (instantiations of the) generic
5562 -- formal part are also visible. Otherwise, ignore the entity
5563 -- created to validate the actuals.
5565 if Renamed_Object (E) = Instance then
5568 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5571 -- The visibility of a formal of an enclosing generic is already
5574 elsif Denotes_Formal_Package (E) then
5577 elsif Present (Associated_Formal_Package (E))
5578 and then not Is_Generic_Formal (E)
5580 if Box_Present (Parent (Associated_Formal_Package (E))) then
5581 Check_Generic_Actuals (Renamed_Object (E), True);
5584 Check_Generic_Actuals (Renamed_Object (E), False);
5587 Set_Is_Hidden (E, False);
5590 -- If this is a subprogram instance (in a wrapper package) the
5591 -- actual is fully visible.
5593 elsif Is_Wrapper_Package (Instance) then
5594 Set_Is_Hidden (E, False);
5596 -- If the formal package is declared with a box, or if the formal
5597 -- parameter is defaulted, it is visible in the body.
5600 or else Is_Visible_Formal (E)
5602 Set_Is_Hidden (E, False);
5605 if Ekind (E) = E_Constant then
5607 -- If the type of the actual is a private type declared in the
5608 -- enclosing scope of the generic unit, the body of the generic
5609 -- sees the full view of the type (because it has to appear in
5610 -- the corresponding package body). If the type is private now,
5611 -- exchange views to restore the proper visiblity in the instance.
5614 Typ : constant Entity_Id := Base_Type (Etype (E));
5615 -- The type of the actual
5620 Parent_Scope : Entity_Id;
5621 -- The enclosing scope of the generic unit
5624 if Is_Wrapper_Package (Instance) then
5628 (Unit_Declaration_Node
5629 (Related_Instance (Instance))));
5633 (Specification (Unit_Declaration_Node (Instance)));
5636 Parent_Scope := Scope (Gen_Id);
5638 -- The exchange is only needed if the generic is defined
5639 -- within a package which is not a common ancestor of the
5640 -- scope of the instance, and is not already in scope.
5642 if Is_Private_Type (Typ)
5643 and then Scope (Typ) = Parent_Scope
5644 and then Scope (Instance) /= Parent_Scope
5645 and then Ekind (Parent_Scope) = E_Package
5646 and then not Is_Child_Unit (Gen_Id)
5650 -- If the type of the entity is a subtype, it may also
5651 -- have to be made visible, together with the base type
5652 -- of its full view, after exchange.
5654 if Is_Private_Type (Etype (E)) then
5655 Switch_View (Etype (E));
5656 Switch_View (Base_Type (Etype (E)));
5664 end Check_Generic_Actuals;
5666 ------------------------------
5667 -- Check_Generic_Child_Unit --
5668 ------------------------------
5670 procedure Check_Generic_Child_Unit
5672 Parent_Installed : in out Boolean)
5674 Loc : constant Source_Ptr := Sloc (Gen_Id);
5675 Gen_Par : Entity_Id := Empty;
5677 Inst_Par : Entity_Id;
5680 function Find_Generic_Child
5682 Id : Node_Id) return Entity_Id;
5683 -- Search generic parent for possible child unit with the given name
5685 function In_Enclosing_Instance return Boolean;
5686 -- Within an instance of the parent, the child unit may be denoted
5687 -- by a simple name, or an abbreviated expanded name. Examine enclosing
5688 -- scopes to locate a possible parent instantiation.
5690 ------------------------
5691 -- Find_Generic_Child --
5692 ------------------------
5694 function Find_Generic_Child
5696 Id : Node_Id) return Entity_Id
5701 -- If entity of name is already set, instance has already been
5702 -- resolved, e.g. in an enclosing instantiation.
5704 if Present (Entity (Id)) then
5705 if Scope (Entity (Id)) = Scop then
5712 E := First_Entity (Scop);
5713 while Present (E) loop
5714 if Chars (E) = Chars (Id)
5715 and then Is_Child_Unit (E)
5717 if Is_Child_Unit (E)
5718 and then not Is_Visible_Lib_Unit (E)
5721 ("generic child unit& is not visible", Gen_Id, E);
5733 end Find_Generic_Child;
5735 ---------------------------
5736 -- In_Enclosing_Instance --
5737 ---------------------------
5739 function In_Enclosing_Instance return Boolean is
5740 Enclosing_Instance : Node_Id;
5741 Instance_Decl : Node_Id;
5744 -- We do not inline any call that contains instantiations, except
5745 -- for instantiations of Unchecked_Conversion, so if we are within
5746 -- an inlined body the current instance does not require parents.
5748 if In_Inlined_Body then
5749 pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
5753 -- Loop to check enclosing scopes
5755 Enclosing_Instance := Current_Scope;
5756 while Present (Enclosing_Instance) loop
5757 Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
5759 if Ekind (Enclosing_Instance) = E_Package
5760 and then Is_Generic_Instance (Enclosing_Instance)
5762 (Generic_Parent (Specification (Instance_Decl)))
5764 -- Check whether the generic we are looking for is a child of
5767 E := Find_Generic_Child
5768 (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
5769 exit when Present (E);
5775 Enclosing_Instance := Scope (Enclosing_Instance);
5787 Make_Expanded_Name (Loc,
5789 Prefix => New_Occurrence_Of (Enclosing_Instance, Loc),
5790 Selector_Name => New_Occurrence_Of (E, Loc)));
5792 Set_Entity (Gen_Id, E);
5793 Set_Etype (Gen_Id, Etype (E));
5794 Parent_Installed := False; -- Already in scope.
5797 end In_Enclosing_Instance;
5799 -- Start of processing for Check_Generic_Child_Unit
5802 -- If the name of the generic is given by a selected component, it may
5803 -- be the name of a generic child unit, and the prefix is the name of an
5804 -- instance of the parent, in which case the child unit must be visible.
5805 -- If this instance is not in scope, it must be placed there and removed
5806 -- after instantiation, because what is being instantiated is not the
5807 -- original child, but the corresponding child present in the instance
5810 -- If the child is instantiated within the parent, it can be given by
5811 -- a simple name. In this case the instance is already in scope, but
5812 -- the child generic must be recovered from the generic parent as well.
5814 if Nkind (Gen_Id) = N_Selected_Component then
5815 S := Selector_Name (Gen_Id);
5816 Analyze (Prefix (Gen_Id));
5817 Inst_Par := Entity (Prefix (Gen_Id));
5819 if Ekind (Inst_Par) = E_Package
5820 and then Present (Renamed_Object (Inst_Par))
5822 Inst_Par := Renamed_Object (Inst_Par);
5825 if Ekind (Inst_Par) = E_Package then
5826 if Nkind (Parent (Inst_Par)) = N_Package_Specification then
5827 Gen_Par := Generic_Parent (Parent (Inst_Par));
5829 elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
5831 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
5833 Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
5836 elsif Ekind (Inst_Par) = E_Generic_Package
5837 and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
5839 -- A formal package may be a real child package, and not the
5840 -- implicit instance within a parent. In this case the child is
5841 -- not visible and has to be retrieved explicitly as well.
5843 Gen_Par := Inst_Par;
5846 if Present (Gen_Par) then
5848 -- The prefix denotes an instantiation. The entity itself may be a
5849 -- nested generic, or a child unit.
5851 E := Find_Generic_Child (Gen_Par, S);
5854 Change_Selected_Component_To_Expanded_Name (Gen_Id);
5855 Set_Entity (Gen_Id, E);
5856 Set_Etype (Gen_Id, Etype (E));
5858 Set_Etype (S, Etype (E));
5860 -- Indicate that this is a reference to the parent
5862 if In_Extended_Main_Source_Unit (Gen_Id) then
5863 Set_Is_Instantiated (Inst_Par);
5866 -- A common mistake is to replicate the naming scheme of a
5867 -- hierarchy by instantiating a generic child directly, rather
5868 -- than the implicit child in a parent instance:
5870 -- generic .. package Gpar is ..
5871 -- generic .. package Gpar.Child is ..
5872 -- package Par is new Gpar ();
5875 -- package Par.Child is new Gpar.Child ();
5876 -- rather than Par.Child
5878 -- In this case the instantiation is within Par, which is an
5879 -- instance, but Gpar does not denote Par because we are not IN
5880 -- the instance of Gpar, so this is illegal. The test below
5881 -- recognizes this particular case.
5883 if Is_Child_Unit (E)
5884 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
5885 and then (not In_Instance
5886 or else Nkind (Parent (Parent (Gen_Id))) =
5890 ("prefix of generic child unit must be instance of parent",
5894 if not In_Open_Scopes (Inst_Par)
5895 and then Nkind (Parent (Gen_Id)) not in
5896 N_Generic_Renaming_Declaration
5898 Install_Parent (Inst_Par);
5899 Parent_Installed := True;
5901 elsif In_Open_Scopes (Inst_Par) then
5903 -- If the parent is already installed, install the actuals
5904 -- for its formal packages. This is necessary when the
5905 -- child instance is a child of the parent instance:
5906 -- in this case, the parent is placed on the scope stack
5907 -- but the formal packages are not made visible.
5909 Install_Formal_Packages (Inst_Par);
5913 -- If the generic parent does not contain an entity that
5914 -- corresponds to the selector, the instance doesn't either.
5915 -- Analyzing the node will yield the appropriate error message.
5916 -- If the entity is not a child unit, then it is an inner
5917 -- generic in the parent.
5925 if Is_Child_Unit (Entity (Gen_Id))
5927 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
5928 and then not In_Open_Scopes (Inst_Par)
5930 Install_Parent (Inst_Par);
5931 Parent_Installed := True;
5933 -- The generic unit may be the renaming of the implicit child
5934 -- present in an instance. In that case the parent instance is
5935 -- obtained from the name of the renamed entity.
5937 elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
5938 and then Present (Renamed_Entity (Entity (Gen_Id)))
5939 and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
5942 Renamed_Package : constant Node_Id :=
5943 Name (Parent (Entity (Gen_Id)));
5945 if Nkind (Renamed_Package) = N_Expanded_Name then
5946 Inst_Par := Entity (Prefix (Renamed_Package));
5947 Install_Parent (Inst_Par);
5948 Parent_Installed := True;
5954 elsif Nkind (Gen_Id) = N_Expanded_Name then
5956 -- Entity already present, analyze prefix, whose meaning may be
5957 -- an instance in the current context. If it is an instance of
5958 -- a relative within another, the proper parent may still have
5959 -- to be installed, if they are not of the same generation.
5961 Analyze (Prefix (Gen_Id));
5963 -- In the unlikely case that a local declaration hides the name
5964 -- of the parent package, locate it on the homonym chain. If the
5965 -- context is an instance of the parent, the renaming entity is
5968 Inst_Par := Entity (Prefix (Gen_Id));
5969 while Present (Inst_Par)
5970 and then not Is_Package_Or_Generic_Package (Inst_Par)
5972 Inst_Par := Homonym (Inst_Par);
5975 pragma Assert (Present (Inst_Par));
5976 Set_Entity (Prefix (Gen_Id), Inst_Par);
5978 if In_Enclosing_Instance then
5981 elsif Present (Entity (Gen_Id))
5982 and then Is_Child_Unit (Entity (Gen_Id))
5983 and then not In_Open_Scopes (Inst_Par)
5985 Install_Parent (Inst_Par);
5986 Parent_Installed := True;
5989 elsif In_Enclosing_Instance then
5991 -- The child unit is found in some enclosing scope
5998 -- If this is the renaming of the implicit child in a parent
5999 -- instance, recover the parent name and install it.
6001 if Is_Entity_Name (Gen_Id) then
6002 E := Entity (Gen_Id);
6004 if Is_Generic_Unit (E)
6005 and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
6006 and then Is_Child_Unit (Renamed_Object (E))
6007 and then Is_Generic_Unit (Scope (Renamed_Object (E)))
6008 and then Nkind (Name (Parent (E))) = N_Expanded_Name
6011 New_Copy_Tree (Name (Parent (E))));
6012 Inst_Par := Entity (Prefix (Gen_Id));
6014 if not In_Open_Scopes (Inst_Par) then
6015 Install_Parent (Inst_Par);
6016 Parent_Installed := True;
6019 -- If it is a child unit of a non-generic parent, it may be
6020 -- use-visible and given by a direct name. Install parent as
6023 elsif Is_Generic_Unit (E)
6024 and then Is_Child_Unit (E)
6026 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6027 and then not Is_Generic_Unit (Scope (E))
6029 if not In_Open_Scopes (Scope (E)) then
6030 Install_Parent (Scope (E));
6031 Parent_Installed := True;
6036 end Check_Generic_Child_Unit;
6038 -----------------------------
6039 -- Check_Hidden_Child_Unit --
6040 -----------------------------
6042 procedure Check_Hidden_Child_Unit
6044 Gen_Unit : Entity_Id;
6045 Act_Decl_Id : Entity_Id)
6047 Gen_Id : constant Node_Id := Name (N);
6050 if Is_Child_Unit (Gen_Unit)
6051 and then Is_Child_Unit (Act_Decl_Id)
6052 and then Nkind (Gen_Id) = N_Expanded_Name
6053 and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
6054 and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
6056 Error_Msg_Node_2 := Scope (Act_Decl_Id);
6058 ("generic unit & is implicitly declared in &",
6059 Defining_Unit_Name (N), Gen_Unit);
6060 Error_Msg_N ("\instance must have different name",
6061 Defining_Unit_Name (N));
6063 end Check_Hidden_Child_Unit;
6065 ------------------------
6066 -- Check_Private_View --
6067 ------------------------
6069 procedure Check_Private_View (N : Node_Id) is
6070 T : constant Entity_Id := Etype (N);
6074 -- Exchange views if the type was not private in the generic but is
6075 -- private at the point of instantiation. Do not exchange views if
6076 -- the scope of the type is in scope. This can happen if both generic
6077 -- and instance are sibling units, or if type is defined in a parent.
6078 -- In this case the visibility of the type will be correct for all
6082 BT := Base_Type (T);
6084 if Is_Private_Type (T)
6085 and then not Has_Private_View (N)
6086 and then Present (Full_View (T))
6087 and then not In_Open_Scopes (Scope (T))
6089 -- In the generic, the full type was visible. Save the private
6090 -- entity, for subsequent exchange.
6094 elsif Has_Private_View (N)
6095 and then not Is_Private_Type (T)
6096 and then not Has_Been_Exchanged (T)
6097 and then Etype (Get_Associated_Node (N)) /= T
6099 -- Only the private declaration was visible in the generic. If
6100 -- the type appears in a subtype declaration, the subtype in the
6101 -- instance must have a view compatible with that of its parent,
6102 -- which must be exchanged (see corresponding code in Restore_
6103 -- Private_Views). Otherwise, if the type is defined in a parent
6104 -- unit, leave full visibility within instance, which is safe.
6106 if In_Open_Scopes (Scope (Base_Type (T)))
6107 and then not Is_Private_Type (Base_Type (T))
6108 and then Comes_From_Source (Base_Type (T))
6112 elsif Nkind (Parent (N)) = N_Subtype_Declaration
6113 or else not In_Private_Part (Scope (Base_Type (T)))
6115 Prepend_Elmt (T, Exchanged_Views);
6116 Exchange_Declarations (Etype (Get_Associated_Node (N)));
6119 -- For composite types with inconsistent representation exchange
6120 -- component types accordingly.
6122 elsif Is_Access_Type (T)
6123 and then Is_Private_Type (Designated_Type (T))
6124 and then not Has_Private_View (N)
6125 and then Present (Full_View (Designated_Type (T)))
6127 Switch_View (Designated_Type (T));
6129 elsif Is_Array_Type (T) then
6130 if Is_Private_Type (Component_Type (T))
6131 and then not Has_Private_View (N)
6132 and then Present (Full_View (Component_Type (T)))
6134 Switch_View (Component_Type (T));
6137 -- The normal exchange mechanism relies on the setting of a
6138 -- flag on the reference in the generic. However, an additional
6139 -- mechanism is needed for types that are not explicitly mentioned
6140 -- in the generic, but may be needed in expanded code in the
6141 -- instance. This includes component types of arrays and
6142 -- designated types of access types. This processing must also
6143 -- include the index types of arrays which we take care of here.
6150 Indx := First_Index (T);
6151 while Present (Indx) loop
6152 Typ := Base_Type (Etype (Indx));
6154 if Is_Private_Type (Typ)
6155 and then Present (Full_View (Typ))
6164 elsif Is_Private_Type (T)
6165 and then Present (Full_View (T))
6166 and then Is_Array_Type (Full_View (T))
6167 and then Is_Private_Type (Component_Type (Full_View (T)))
6171 -- Finally, a non-private subtype may have a private base type, which
6172 -- must be exchanged for consistency. This can happen when a package
6173 -- body is instantiated, when the scope stack is empty but in fact
6174 -- the subtype and the base type are declared in an enclosing scope.
6176 -- Note that in this case we introduce an inconsistency in the view
6177 -- set, because we switch the base type BT, but there could be some
6178 -- private dependent subtypes of BT which remain unswitched. Such
6179 -- subtypes might need to be switched at a later point (see specific
6180 -- provision for that case in Switch_View).
6182 elsif not Is_Private_Type (T)
6183 and then not Has_Private_View (N)
6184 and then Is_Private_Type (BT)
6185 and then Present (Full_View (BT))
6186 and then not Is_Generic_Type (BT)
6187 and then not In_Open_Scopes (BT)
6189 Prepend_Elmt (Full_View (BT), Exchanged_Views);
6190 Exchange_Declarations (BT);
6193 end Check_Private_View;
6195 -----------------------------
6196 -- Check_Hidden_Primitives --
6197 -----------------------------
6199 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6202 Result : Elist_Id := No_Elist;
6205 if No (Assoc_List) then
6209 -- Traverse the list of associations between formals and actuals
6210 -- searching for renamings of tagged types
6212 Actual := First (Assoc_List);
6213 while Present (Actual) loop
6214 if Nkind (Actual) = N_Subtype_Declaration then
6215 Gen_T := Generic_Parent_Type (Actual);
6218 and then Is_Tagged_Type (Gen_T)
6220 -- Traverse the list of primitives of the actual types
6221 -- searching for hidden primitives that are visible in the
6222 -- corresponding generic formal; leave them visible and
6223 -- append them to Result to restore their decoration later.
6225 Install_Hidden_Primitives
6226 (Prims_List => Result,
6228 Act_T => Entity (Subtype_Indication (Actual)));
6236 end Check_Hidden_Primitives;
6238 --------------------------
6239 -- Contains_Instance_Of --
6240 --------------------------
6242 function Contains_Instance_Of
6245 N : Node_Id) return Boolean
6253 -- Verify that there are no circular instantiations. We check whether
6254 -- the unit contains an instance of the current scope or some enclosing
6255 -- scope (in case one of the instances appears in a subunit). Longer
6256 -- circularities involving subunits might seem too pathological to
6257 -- consider, but they were not too pathological for the authors of
6258 -- DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6259 -- enclosing generic scopes as containing an instance.
6262 -- Within a generic subprogram body, the scope is not generic, to
6263 -- allow for recursive subprograms. Use the declaration to determine
6264 -- whether this is a generic unit.
6266 if Ekind (Scop) = E_Generic_Package
6267 or else (Is_Subprogram (Scop)
6268 and then Nkind (Unit_Declaration_Node (Scop)) =
6269 N_Generic_Subprogram_Declaration)
6271 Elmt := First_Elmt (Inner_Instances (Inner));
6273 while Present (Elmt) loop
6274 if Node (Elmt) = Scop then
6275 Error_Msg_Node_2 := Inner;
6277 ("circular Instantiation: & instantiated within &!",
6281 elsif Node (Elmt) = Inner then
6284 elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6285 Error_Msg_Node_2 := Inner;
6287 ("circular Instantiation: & instantiated within &!",
6295 -- Indicate that Inner is being instantiated within Scop
6297 Append_Elmt (Inner, Inner_Instances (Scop));
6300 if Scop = Standard_Standard then
6303 Scop := Scope (Scop);
6308 end Contains_Instance_Of;
6310 -----------------------
6311 -- Copy_Generic_Node --
6312 -----------------------
6314 function Copy_Generic_Node
6316 Parent_Id : Node_Id;
6317 Instantiating : Boolean) return Node_Id
6322 function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6323 -- Check the given value of one of the Fields referenced by the
6324 -- current node to determine whether to copy it recursively. The
6325 -- field may hold a Node_Id, a List_Id, or an Elist_Id, or a plain
6326 -- value (Sloc, Uint, Char) in which case it need not be copied.
6328 procedure Copy_Descendants;
6329 -- Common utility for various nodes
6331 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6332 -- Make copy of element list
6334 function Copy_Generic_List
6336 Parent_Id : Node_Id) return List_Id;
6337 -- Apply Copy_Node recursively to the members of a node list
6339 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6340 -- True if an identifier is part of the defining program unit name
6341 -- of a child unit. The entity of such an identifier must be kept
6342 -- (for ASIS use) even though as the name of an enclosing generic
6343 -- it would otherwise not be preserved in the generic tree.
6345 ----------------------
6346 -- Copy_Descendants --
6347 ----------------------
6349 procedure Copy_Descendants is
6351 use Atree.Unchecked_Access;
6352 -- This code section is part of the implementation of an untyped
6353 -- tree traversal, so it needs direct access to node fields.
6356 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6357 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6358 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6359 Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6360 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6361 end Copy_Descendants;
6363 -----------------------------
6364 -- Copy_Generic_Descendant --
6365 -----------------------------
6367 function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6369 if D = Union_Id (Empty) then
6372 elsif D in Node_Range then
6374 (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6376 elsif D in List_Range then
6377 return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6379 elsif D in Elist_Range then
6380 return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6382 -- Nothing else is copyable (e.g. Uint values), return as is
6387 end Copy_Generic_Descendant;
6389 ------------------------
6390 -- Copy_Generic_Elist --
6391 ------------------------
6393 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6400 M := First_Elmt (E);
6401 while Present (M) loop
6403 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6412 end Copy_Generic_Elist;
6414 -----------------------
6415 -- Copy_Generic_List --
6416 -----------------------
6418 function Copy_Generic_List
6420 Parent_Id : Node_Id) return List_Id
6428 Set_Parent (New_L, Parent_Id);
6431 while Present (N) loop
6432 Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6441 end Copy_Generic_List;
6443 ---------------------------
6444 -- In_Defining_Unit_Name --
6445 ---------------------------
6447 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6449 return Present (Parent (Nam))
6450 and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6452 (Nkind (Parent (Nam)) = N_Expanded_Name
6453 and then In_Defining_Unit_Name (Parent (Nam))));
6454 end In_Defining_Unit_Name;
6456 -- Start of processing for Copy_Generic_Node
6463 New_N := New_Copy (N);
6465 -- Copy aspects if present
6467 if Has_Aspects (N) then
6468 Set_Has_Aspects (New_N, False);
6469 Set_Aspect_Specifications
6470 (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6473 if Instantiating then
6474 Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6477 if not Is_List_Member (N) then
6478 Set_Parent (New_N, Parent_Id);
6481 -- If defining identifier, then all fields have been copied already
6483 if Nkind (New_N) in N_Entity then
6486 -- Special casing for identifiers and other entity names and operators
6488 elsif Nkind_In (New_N, N_Identifier,
6489 N_Character_Literal,
6492 or else Nkind (New_N) in N_Op
6494 if not Instantiating then
6496 -- Link both nodes in order to assign subsequently the entity of
6497 -- the copy to the original node, in case this is a global
6500 Set_Associated_Node (N, New_N);
6502 -- If we are within an instantiation, this is a nested generic
6503 -- that has already been analyzed at the point of definition. We
6504 -- must preserve references that were global to the enclosing
6505 -- parent at that point. Other occurrences, whether global or
6506 -- local to the current generic, must be resolved anew, so we
6507 -- reset the entity in the generic copy. A global reference has a
6508 -- smaller depth than the parent, or else the same depth in case
6509 -- both are distinct compilation units.
6510 -- A child unit is implicitly declared within the enclosing parent
6511 -- but is in fact global to it, and must be preserved.
6513 -- It is also possible for Current_Instantiated_Parent to be
6514 -- defined, and for this not to be a nested generic, namely if the
6515 -- unit is loaded through Rtsfind. In that case, the entity of
6516 -- New_N is only a link to the associated node, and not a defining
6519 -- The entities for parent units in the defining_program_unit of a
6520 -- generic child unit are established when the context of the unit
6521 -- is first analyzed, before the generic copy is made. They are
6522 -- preserved in the copy for use in ASIS queries.
6524 Ent := Entity (New_N);
6526 if No (Current_Instantiated_Parent.Gen_Id) then
6528 or else Nkind (Ent) /= N_Defining_Identifier
6529 or else not In_Defining_Unit_Name (N)
6531 Set_Associated_Node (New_N, Empty);
6536 not Nkind_In (Ent, N_Defining_Identifier,
6537 N_Defining_Character_Literal,
6538 N_Defining_Operator_Symbol)
6539 or else No (Scope (Ent))
6541 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
6542 and then not Is_Child_Unit (Ent))
6544 (Scope_Depth (Scope (Ent)) >
6545 Scope_Depth (Current_Instantiated_Parent.Gen_Id)
6547 Get_Source_Unit (Ent) =
6548 Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
6550 Set_Associated_Node (New_N, Empty);
6553 -- Case of instantiating identifier or some other name or operator
6556 -- If the associated node is still defined, the entity in it is
6557 -- global, and must be copied to the instance. If this copy is
6558 -- being made for a body to inline, it is applied to an
6559 -- instantiated tree, and the entity is already present and must
6560 -- be also preserved.
6563 Assoc : constant Node_Id := Get_Associated_Node (N);
6566 if Present (Assoc) then
6567 if Nkind (Assoc) = Nkind (N) then
6568 Set_Entity (New_N, Entity (Assoc));
6569 Check_Private_View (N);
6571 elsif Nkind (Assoc) = N_Function_Call then
6572 Set_Entity (New_N, Entity (Name (Assoc)));
6574 elsif Nkind_In (Assoc, N_Defining_Identifier,
6575 N_Defining_Character_Literal,
6576 N_Defining_Operator_Symbol)
6577 and then Expander_Active
6579 -- Inlining case: we are copying a tree that contains
6580 -- global entities, which are preserved in the copy to be
6581 -- used for subsequent inlining.
6586 Set_Entity (New_N, Empty);
6592 -- For expanded name, we must copy the Prefix and Selector_Name
6594 if Nkind (N) = N_Expanded_Name then
6596 (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
6598 Set_Selector_Name (New_N,
6599 Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
6601 -- For operators, we must copy the right operand
6603 elsif Nkind (N) in N_Op then
6604 Set_Right_Opnd (New_N,
6605 Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
6607 -- And for binary operators, the left operand as well
6609 if Nkind (N) in N_Binary_Op then
6610 Set_Left_Opnd (New_N,
6611 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
6615 -- Special casing for stubs
6617 elsif Nkind (N) in N_Body_Stub then
6619 -- In any case, we must copy the specification or defining
6620 -- identifier as appropriate.
6622 if Nkind (N) = N_Subprogram_Body_Stub then
6623 Set_Specification (New_N,
6624 Copy_Generic_Node (Specification (N), New_N, Instantiating));
6627 Set_Defining_Identifier (New_N,
6629 (Defining_Identifier (N), New_N, Instantiating));
6632 -- If we are not instantiating, then this is where we load and
6633 -- analyze subunits, i.e. at the point where the stub occurs. A
6634 -- more permissive system might defer this analysis to the point
6635 -- of instantiation, but this seems to complicated for now.
6637 if not Instantiating then
6639 Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
6641 Unum : Unit_Number_Type;
6645 -- Make sure that, if it is a subunit of the main unit that is
6646 -- preprocessed and if -gnateG is specified, the preprocessed
6647 -- file will be written.
6649 Lib.Analysing_Subunit_Of_Main :=
6650 Lib.In_Extended_Main_Source_Unit (N);
6653 (Load_Name => Subunit_Name,
6657 Lib.Analysing_Subunit_Of_Main := False;
6659 -- If the proper body is not found, a warning message will be
6660 -- emitted when analyzing the stub, or later at the point
6661 -- of instantiation. Here we just leave the stub as is.
6663 if Unum = No_Unit then
6664 Subunits_Missing := True;
6665 goto Subunit_Not_Found;
6668 Subunit := Cunit (Unum);
6670 if Nkind (Unit (Subunit)) /= N_Subunit then
6672 ("found child unit instead of expected SEPARATE subunit",
6674 Error_Msg_Sloc := Sloc (N);
6675 Error_Msg_N ("\to complete stub #", Subunit);
6676 goto Subunit_Not_Found;
6679 -- We must create a generic copy of the subunit, in order to
6680 -- perform semantic analysis on it, and we must replace the
6681 -- stub in the original generic unit with the subunit, in order
6682 -- to preserve non-local references within.
6684 -- Only the proper body needs to be copied. Library_Unit and
6685 -- context clause are simply inherited by the generic copy.
6686 -- Note that the copy (which may be recursive if there are
6687 -- nested subunits) must be done first, before attaching it to
6688 -- the enclosing generic.
6692 (Proper_Body (Unit (Subunit)),
6693 Empty, Instantiating => False);
6695 -- Now place the original proper body in the original generic
6696 -- unit. This is a body, not a compilation unit.
6698 Rewrite (N, Proper_Body (Unit (Subunit)));
6699 Set_Is_Compilation_Unit (Defining_Entity (N), False);
6700 Set_Was_Originally_Stub (N);
6702 -- Finally replace the body of the subunit with its copy, and
6703 -- make this new subunit into the library unit of the generic
6704 -- copy, which does not have stubs any longer.
6706 Set_Proper_Body (Unit (Subunit), New_Body);
6707 Set_Library_Unit (New_N, Subunit);
6708 Inherit_Context (Unit (Subunit), N);
6711 -- If we are instantiating, this must be an error case, since
6712 -- otherwise we would have replaced the stub node by the proper body
6713 -- that corresponds. So just ignore it in the copy (i.e. we have
6714 -- copied it, and that is good enough).
6720 <<Subunit_Not_Found>> null;
6722 -- If the node is a compilation unit, it is the subunit of a stub, which
6723 -- has been loaded already (see code below). In this case, the library
6724 -- unit field of N points to the parent unit (which is a compilation
6725 -- unit) and need not (and cannot!) be copied.
6727 -- When the proper body of the stub is analyzed, the library_unit link
6728 -- is used to establish the proper context (see sem_ch10).
6730 -- The other fields of a compilation unit are copied as usual
6732 elsif Nkind (N) = N_Compilation_Unit then
6734 -- This code can only be executed when not instantiating, because in
6735 -- the copy made for an instantiation, the compilation unit node has
6736 -- disappeared at the point that a stub is replaced by its proper
6739 pragma Assert (not Instantiating);
6741 Set_Context_Items (New_N,
6742 Copy_Generic_List (Context_Items (N), New_N));
6745 Copy_Generic_Node (Unit (N), New_N, False));
6747 Set_First_Inlined_Subprogram (New_N,
6749 (First_Inlined_Subprogram (N), New_N, False));
6751 Set_Aux_Decls_Node (New_N,
6752 Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
6754 -- For an assignment node, the assignment is known to be semantically
6755 -- legal if we are instantiating the template. This avoids incorrect
6756 -- diagnostics in generated code.
6758 elsif Nkind (N) = N_Assignment_Statement then
6760 -- Copy name and expression fields in usual manner
6763 Copy_Generic_Node (Name (N), New_N, Instantiating));
6765 Set_Expression (New_N,
6766 Copy_Generic_Node (Expression (N), New_N, Instantiating));
6768 if Instantiating then
6769 Set_Assignment_OK (Name (New_N), True);
6772 elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
6773 if not Instantiating then
6774 Set_Associated_Node (N, New_N);
6777 if Present (Get_Associated_Node (N))
6778 and then Nkind (Get_Associated_Node (N)) = Nkind (N)
6780 -- In the generic the aggregate has some composite type. If at
6781 -- the point of instantiation the type has a private view,
6782 -- install the full view (and that of its ancestors, if any).
6785 T : Entity_Id := (Etype (Get_Associated_Node (New_N)));
6790 and then Is_Private_Type (T)
6796 and then Is_Tagged_Type (T)
6797 and then Is_Derived_Type (T)
6799 Rt := Root_Type (T);
6804 if Is_Private_Type (T) then
6815 -- Do not copy the associated node, which points to the generic copy
6816 -- of the aggregate.
6819 use Atree.Unchecked_Access;
6820 -- This code section is part of the implementation of an untyped
6821 -- tree traversal, so it needs direct access to node fields.
6824 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6825 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6826 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6827 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6830 -- Allocators do not have an identifier denoting the access type, so we
6831 -- must locate it through the expression to check whether the views are
6834 elsif Nkind (N) = N_Allocator
6835 and then Nkind (Expression (N)) = N_Qualified_Expression
6836 and then Is_Entity_Name (Subtype_Mark (Expression (N)))
6837 and then Instantiating
6840 T : constant Node_Id :=
6841 Get_Associated_Node (Subtype_Mark (Expression (N)));
6847 -- Retrieve the allocator node in the generic copy
6849 Acc_T := Etype (Parent (Parent (T)));
6851 and then Is_Private_Type (Acc_T)
6853 Switch_View (Acc_T);
6860 -- For a proper body, we must catch the case of a proper body that
6861 -- replaces a stub. This represents the point at which a separate
6862 -- compilation unit, and hence template file, may be referenced, so we
6863 -- must make a new source instantiation entry for the template of the
6864 -- subunit, and ensure that all nodes in the subunit are adjusted using
6865 -- this new source instantiation entry.
6867 elsif Nkind (N) in N_Proper_Body then
6869 Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
6872 if Instantiating and then Was_Originally_Stub (N) then
6873 Create_Instantiation_Source
6874 (Instantiation_Node,
6875 Defining_Entity (N),
6880 -- Now copy the fields of the proper body, using the new
6881 -- adjustment factor if one was needed as per test above.
6885 -- Restore the original adjustment factor in case changed
6887 S_Adjustment := Save_Adjustment;
6890 -- Don't copy Ident or Comment pragmas, since the comment belongs to the
6891 -- generic unit, not to the instantiating unit.
6893 elsif Nkind (N) = N_Pragma and then Instantiating then
6895 Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
6897 if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
6898 New_N := Make_Null_Statement (Sloc (N));
6905 elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
6907 -- No descendant fields need traversing
6911 elsif Nkind (N) = N_String_Literal
6912 and then Present (Etype (N))
6913 and then Instantiating
6915 -- If the string is declared in an outer scope, the string_literal
6916 -- subtype created for it may have the wrong scope. We force the
6917 -- reanalysis of the constant to generate a new itype in the proper
6920 Set_Etype (New_N, Empty);
6921 Set_Analyzed (New_N, False);
6923 -- For the remaining nodes, copy their descendants recursively
6928 if Instantiating and then Nkind (N) = N_Subprogram_Body then
6929 Set_Generic_Parent (Specification (New_N), N);
6931 -- Should preserve Corresponding_Spec??? (12.3(14))
6936 end Copy_Generic_Node;
6938 ----------------------------
6939 -- Denotes_Formal_Package --
6940 ----------------------------
6942 function Denotes_Formal_Package
6944 On_Exit : Boolean := False;
6945 Instance : Entity_Id := Empty) return Boolean
6948 Scop : constant Entity_Id := Scope (Pack);
6951 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
6952 -- The package in question may be an actual for a previous formal
6953 -- package P of the current instance, so examine its actuals as well.
6954 -- This must be recursive over other formal packages.
6956 ----------------------------------
6957 -- Is_Actual_Of_Previous_Formal --
6958 ----------------------------------
6960 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
6964 E1 := First_Entity (P);
6965 while Present (E1) and then E1 /= Instance loop
6966 if Ekind (E1) = E_Package
6967 and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
6969 if Renamed_Object (E1) = Pack then
6972 elsif E1 = P or else Renamed_Object (E1) = P then
6975 elsif Is_Actual_Of_Previous_Formal (E1) then
6984 end Is_Actual_Of_Previous_Formal;
6986 -- Start of processing for Denotes_Formal_Package
6992 (Instance_Envs.Last).Instantiated_Parent.Act_Id;
6994 Par := Current_Instantiated_Parent.Act_Id;
6997 if Ekind (Scop) = E_Generic_Package
6998 or else Nkind (Unit_Declaration_Node (Scop)) =
6999 N_Generic_Subprogram_Declaration
7003 elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
7004 N_Formal_Package_Declaration
7012 -- Check whether this package is associated with a formal package of
7013 -- the enclosing instantiation. Iterate over the list of renamings.
7015 E := First_Entity (Par);
7016 while Present (E) loop
7017 if Ekind (E) /= E_Package
7018 or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
7022 elsif Renamed_Object (E) = Par then
7025 elsif Renamed_Object (E) = Pack then
7028 elsif Is_Actual_Of_Previous_Formal (E) then
7038 end Denotes_Formal_Package;
7044 procedure End_Generic is
7046 -- ??? More things could be factored out in this routine. Should
7047 -- probably be done at a later stage.
7049 Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
7050 Generic_Flags.Decrement_Last;
7052 Expander_Mode_Restore;
7059 function Earlier (N1, N2 : Node_Id) return Boolean is
7060 procedure Find_Depth (P : in out Node_Id; D : in out Integer);
7061 -- Find distance from given node to enclosing compilation unit
7067 procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
7070 and then Nkind (P) /= N_Compilation_Unit
7072 P := True_Parent (P);
7077 -- Local declarations
7086 -- Start of processing for Earlier
7089 Find_Depth (P1, D1);
7090 Find_Depth (P2, D2);
7100 P1 := True_Parent (P1);
7105 P2 := True_Parent (P2);
7109 -- At this point P1 and P2 are at the same distance from the root.
7110 -- We examine their parents until we find a common declarative list.
7111 -- If we reach the root, N1 and N2 do not descend from the same
7112 -- declarative list (e.g. one is nested in the declarative part and
7113 -- the other is in a block in the statement part) and the earlier
7114 -- one is already frozen.
7116 while not Is_List_Member (P1)
7117 or else not Is_List_Member (P2)
7118 or else List_Containing (P1) /= List_Containing (P2)
7120 P1 := True_Parent (P1);
7121 P2 := True_Parent (P2);
7123 if Nkind (Parent (P1)) = N_Subunit then
7124 P1 := Corresponding_Stub (Parent (P1));
7127 if Nkind (Parent (P2)) = N_Subunit then
7128 P2 := Corresponding_Stub (Parent (P2));
7136 -- Expanded code usually shares the source location of the original
7137 -- construct it was generated for. This however may not necessarely
7138 -- reflect the true location of the code within the tree.
7140 -- Before comparing the slocs of the two nodes, make sure that we are
7141 -- working with correct source locations. Assume that P1 is to the left
7142 -- of P2. If either one does not come from source, traverse the common
7143 -- list heading towards the other node and locate the first source
7147 -- ----+===+===+--------------+===+===+----
7148 -- expanded code expanded code
7150 if not Comes_From_Source (P1) then
7151 while Present (P1) loop
7153 -- Neither P2 nor a source statement were located during the
7154 -- search. If we reach the end of the list, then P1 does not
7155 -- occur earlier than P2.
7158 -- start --- P2 ----- P1 --- end
7160 if No (Next (P1)) then
7163 -- We encounter P2 while going to the right of the list. This
7164 -- means that P1 does indeed appear earlier.
7167 -- start --- P1 ===== P2 --- end
7168 -- expanded code in between
7173 -- No need to look any further since we have located a source
7176 elsif Comes_From_Source (P1) then
7186 if not Comes_From_Source (P2) then
7187 while Present (P2) loop
7189 -- Neither P1 nor a source statement were located during the
7190 -- search. If we reach the start of the list, then P1 does not
7191 -- occur earlier than P2.
7194 -- start --- P2 --- P1 --- end
7196 if No (Prev (P2)) then
7199 -- We encounter P1 while going to the left of the list. This
7200 -- means that P1 does indeed appear earlier.
7203 -- start --- P1 ===== P2 --- end
7204 -- expanded code in between
7209 -- No need to look any further since we have located a source
7212 elsif Comes_From_Source (P2) then
7222 -- At this point either both nodes came from source or we approximated
7223 -- their source locations through neighbouring source statements.
7225 T1 := Top_Level_Location (Sloc (P1));
7226 T2 := Top_Level_Location (Sloc (P2));
7228 -- When two nodes come from the same instance, they have identical top
7229 -- level locations. To determine proper relation within the tree, check
7230 -- their locations within the template.
7233 return Sloc (P1) < Sloc (P2);
7235 -- The two nodes either come from unrelated instances or do not come
7236 -- from instantiated code at all.
7243 ----------------------
7244 -- Find_Actual_Type --
7245 ----------------------
7247 function Find_Actual_Type
7249 Gen_Type : Entity_Id) return Entity_Id
7251 Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7255 -- Special processing only applies to child units
7257 if not Is_Child_Unit (Gen_Scope) then
7258 return Get_Instance_Of (Typ);
7260 -- If designated or component type is itself a formal of the child unit,
7261 -- its instance is available.
7263 elsif Scope (Typ) = Gen_Scope then
7264 return Get_Instance_Of (Typ);
7266 -- If the array or access type is not declared in the parent unit,
7267 -- no special processing needed.
7269 elsif not Is_Generic_Type (Typ)
7270 and then Scope (Gen_Scope) /= Scope (Typ)
7272 return Get_Instance_Of (Typ);
7274 -- Otherwise, retrieve designated or component type by visibility
7277 T := Current_Entity (Typ);
7278 while Present (T) loop
7279 if In_Open_Scopes (Scope (T)) then
7282 elsif Is_Generic_Actual_Type (T) then
7291 end Find_Actual_Type;
7293 ----------------------------
7294 -- Freeze_Subprogram_Body --
7295 ----------------------------
7297 procedure Freeze_Subprogram_Body
7298 (Inst_Node : Node_Id;
7300 Pack_Id : Entity_Id)
7302 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7303 Par : constant Entity_Id := Scope (Gen_Unit);
7309 function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7310 -- Find innermost package body that encloses the given node, and which
7311 -- is not a compilation unit. Freeze nodes for the instance, or for its
7312 -- enclosing body, may be inserted after the enclosing_body of the
7313 -- generic unit. Used to determine proper placement of freeze node for
7314 -- both package and subprogram instances.
7316 function Package_Freeze_Node (B : Node_Id) return Node_Id;
7317 -- Find entity for given package body, and locate or create a freeze
7320 ----------------------------
7321 -- Enclosing_Package_Body --
7322 ----------------------------
7324 function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7330 and then Nkind (Parent (P)) /= N_Compilation_Unit
7332 if Nkind (P) = N_Package_Body then
7333 if Nkind (Parent (P)) = N_Subunit then
7334 return Corresponding_Stub (Parent (P));
7340 P := True_Parent (P);
7344 end Enclosing_Package_Body;
7346 -------------------------
7347 -- Package_Freeze_Node --
7348 -------------------------
7350 function Package_Freeze_Node (B : Node_Id) return Node_Id is
7354 if Nkind (B) = N_Package_Body then
7355 Id := Corresponding_Spec (B);
7356 else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7357 Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7360 Ensure_Freeze_Node (Id);
7361 return Freeze_Node (Id);
7362 end Package_Freeze_Node;
7364 -- Start of processing of Freeze_Subprogram_Body
7367 -- If the instance and the generic body appear within the same unit, and
7368 -- the instance precedes the generic, the freeze node for the instance
7369 -- must appear after that of the generic. If the generic is nested
7370 -- within another instance I2, then current instance must be frozen
7371 -- after I2. In both cases, the freeze nodes are those of enclosing
7372 -- packages. Otherwise, the freeze node is placed at the end of the
7373 -- current declarative part.
7375 Enc_G := Enclosing_Package_Body (Gen_Body);
7376 Enc_I := Enclosing_Package_Body (Inst_Node);
7377 Ensure_Freeze_Node (Pack_Id);
7378 F_Node := Freeze_Node (Pack_Id);
7380 if Is_Generic_Instance (Par)
7381 and then Present (Freeze_Node (Par))
7382 and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7384 -- The parent was a premature instantiation. Insert freeze node at
7385 -- the end the current declarative part.
7387 if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7388 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7390 -- Handle the following case:
7392 -- package Parent_Inst is new ...
7395 -- procedure P ... -- this body freezes Parent_Inst
7397 -- package Inst is new ...
7399 -- In this particular scenario, the freeze node for Inst must be
7400 -- inserted in the same manner as that of Parent_Inst - before the
7401 -- next source body or at the end of the declarative list (body not
7402 -- available). If body P did not exist and Parent_Inst was frozen
7403 -- after Inst, either by a body following Inst or at the end of the
7404 -- declarative region, the freeze node for Inst must be inserted
7405 -- after that of Parent_Inst. This relation is established by
7406 -- comparing the Slocs of Parent_Inst freeze node and Inst.
7408 elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7409 List_Containing (Inst_Node)
7410 and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7412 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7415 Insert_After (Freeze_Node (Par), F_Node);
7418 -- The body enclosing the instance should be frozen after the body that
7419 -- includes the generic, because the body of the instance may make
7420 -- references to entities therein. If the two are not in the same
7421 -- declarative part, or if the one enclosing the instance is frozen
7422 -- already, freeze the instance at the end of the current declarative
7425 elsif Is_Generic_Instance (Par)
7426 and then Present (Freeze_Node (Par))
7427 and then Present (Enc_I)
7429 if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7431 (Nkind (Enc_I) = N_Package_Body
7433 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7435 -- The enclosing package may contain several instances. Rather
7436 -- than computing the earliest point at which to insert its freeze
7437 -- node, we place it at the end of the declarative part of the
7438 -- parent of the generic.
7440 Insert_Freeze_Node_For_Instance
7441 (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7444 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7446 elsif Present (Enc_G)
7447 and then Present (Enc_I)
7448 and then Enc_G /= Enc_I
7449 and then Earlier (Inst_Node, Gen_Body)
7451 if Nkind (Enc_G) = N_Package_Body then
7452 E_G_Id := Corresponding_Spec (Enc_G);
7453 else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7455 Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7458 -- Freeze package that encloses instance, and place node after
7459 -- package that encloses generic. If enclosing package is already
7460 -- frozen we have to assume it is at the proper place. This may be a
7461 -- potential ABE that requires dynamic checking. Do not add a freeze
7462 -- node if the package that encloses the generic is inside the body
7463 -- that encloses the instance, because the freeze node would be in
7464 -- the wrong scope. Additional contortions needed if the bodies are
7465 -- within a subunit.
7468 Enclosing_Body : Node_Id;
7471 if Nkind (Enc_I) = N_Package_Body_Stub then
7472 Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7474 Enclosing_Body := Enc_I;
7477 if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
7478 Insert_Freeze_Node_For_Instance
7479 (Enc_G, Package_Freeze_Node (Enc_I));
7483 -- Freeze enclosing subunit before instance
7485 Ensure_Freeze_Node (E_G_Id);
7487 if not Is_List_Member (Freeze_Node (E_G_Id)) then
7488 Insert_After (Enc_G, Freeze_Node (E_G_Id));
7491 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7494 -- If none of the above, insert freeze node at the end of the current
7495 -- declarative part.
7497 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7499 end Freeze_Subprogram_Body;
7505 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
7507 return Generic_Renamings.Table (E).Gen_Id;
7510 ---------------------
7511 -- Get_Instance_Of --
7512 ---------------------
7514 function Get_Instance_Of (A : Entity_Id) return Entity_Id is
7515 Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
7518 if Res /= Assoc_Null then
7519 return Generic_Renamings.Table (Res).Act_Id;
7521 -- On exit, entity is not instantiated: not a generic parameter, or
7522 -- else parameter of an inner generic unit.
7526 end Get_Instance_Of;
7528 ------------------------------------
7529 -- Get_Package_Instantiation_Node --
7530 ------------------------------------
7532 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
7533 Decl : Node_Id := Unit_Declaration_Node (A);
7537 -- If the Package_Instantiation attribute has been set on the package
7538 -- entity, then use it directly when it (or its Original_Node) refers
7539 -- to an N_Package_Instantiation node. In principle it should be
7540 -- possible to have this field set in all cases, which should be
7541 -- investigated, and would allow this function to be significantly
7544 Inst := Package_Instantiation (A);
7546 if Present (Inst) then
7547 if Nkind (Inst) = N_Package_Instantiation then
7550 elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
7551 return Original_Node (Inst);
7555 -- If the instantiation is a compilation unit that does not need body
7556 -- then the instantiation node has been rewritten as a package
7557 -- declaration for the instance, and we return the original node.
7559 -- If it is a compilation unit and the instance node has not been
7560 -- rewritten, then it is still the unit of the compilation. Finally, if
7561 -- a body is present, this is a parent of the main unit whose body has
7562 -- been compiled for inlining purposes, and the instantiation node has
7563 -- been rewritten with the instance body.
7565 -- Otherwise the instantiation node appears after the declaration. If
7566 -- the entity is a formal package, the declaration may have been
7567 -- rewritten as a generic declaration (in the case of a formal with box)
7568 -- or left as a formal package declaration if it has actuals, and is
7569 -- found with a forward search.
7571 if Nkind (Parent (Decl)) = N_Compilation_Unit then
7572 if Nkind (Decl) = N_Package_Declaration
7573 and then Present (Corresponding_Body (Decl))
7575 Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
7578 if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
7579 return Original_Node (Decl);
7581 return Unit (Parent (Decl));
7584 elsif Nkind (Decl) = N_Package_Declaration
7585 and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
7587 return Original_Node (Decl);
7590 Inst := Next (Decl);
7591 while not Nkind_In (Inst, N_Package_Instantiation,
7592 N_Formal_Package_Declaration)
7599 end Get_Package_Instantiation_Node;
7601 ------------------------
7602 -- Has_Been_Exchanged --
7603 ------------------------
7605 function Has_Been_Exchanged (E : Entity_Id) return Boolean is
7609 Next := First_Elmt (Exchanged_Views);
7610 while Present (Next) loop
7611 if Full_View (Node (Next)) = E then
7619 end Has_Been_Exchanged;
7625 function Hash (F : Entity_Id) return HTable_Range is
7627 return HTable_Range (F mod HTable_Size);
7630 ------------------------
7631 -- Hide_Current_Scope --
7632 ------------------------
7634 procedure Hide_Current_Scope is
7635 C : constant Entity_Id := Current_Scope;
7639 Set_Is_Hidden_Open_Scope (C);
7641 E := First_Entity (C);
7642 while Present (E) loop
7643 if Is_Immediately_Visible (E) then
7644 Set_Is_Immediately_Visible (E, False);
7645 Append_Elmt (E, Hidden_Entities);
7651 -- Make the scope name invisible as well. This is necessary, but might
7652 -- conflict with calls to Rtsfind later on, in case the scope is a
7653 -- predefined one. There is no clean solution to this problem, so for
7654 -- now we depend on the user not redefining Standard itself in one of
7655 -- the parent units.
7657 if Is_Immediately_Visible (C) and then C /= Standard_Standard then
7658 Set_Is_Immediately_Visible (C, False);
7659 Append_Elmt (C, Hidden_Entities);
7662 end Hide_Current_Scope;
7668 procedure Init_Env is
7669 Saved : Instance_Env;
7672 Saved.Instantiated_Parent := Current_Instantiated_Parent;
7673 Saved.Exchanged_Views := Exchanged_Views;
7674 Saved.Hidden_Entities := Hidden_Entities;
7675 Saved.Current_Sem_Unit := Current_Sem_Unit;
7676 Saved.Parent_Unit_Visible := Parent_Unit_Visible;
7677 Saved.Instance_Parent_Unit := Instance_Parent_Unit;
7679 -- Save configuration switches. These may be reset if the unit is a
7680 -- predefined unit, and the current mode is not Ada 2005.
7682 Save_Opt_Config_Switches (Saved.Switches);
7684 Instance_Envs.Append (Saved);
7686 Exchanged_Views := New_Elmt_List;
7687 Hidden_Entities := New_Elmt_List;
7689 -- Make dummy entry for Instantiated parent. If generic unit is legal,
7690 -- this is set properly in Set_Instance_Env.
7692 Current_Instantiated_Parent :=
7693 (Current_Scope, Current_Scope, Assoc_Null);
7696 ------------------------------
7697 -- In_Same_Declarative_Part --
7698 ------------------------------
7700 function In_Same_Declarative_Part
7702 Inst : Node_Id) return Boolean
7704 Decls : constant Node_Id := Parent (F_Node);
7705 Nod : Node_Id := Parent (Inst);
7708 while Present (Nod) loop
7712 elsif Nkind_In (Nod, N_Subprogram_Body,
7714 N_Package_Declaration,
7721 elsif Nkind (Nod) = N_Subunit then
7722 Nod := Corresponding_Stub (Nod);
7724 elsif Nkind (Nod) = N_Compilation_Unit then
7728 Nod := Parent (Nod);
7733 end In_Same_Declarative_Part;
7735 ---------------------
7736 -- In_Main_Context --
7737 ---------------------
7739 function In_Main_Context (E : Entity_Id) return Boolean is
7745 if not Is_Compilation_Unit (E)
7746 or else Ekind (E) /= E_Package
7747 or else In_Private_Part (E)
7752 Context := Context_Items (Cunit (Main_Unit));
7754 Clause := First (Context);
7755 while Present (Clause) loop
7756 if Nkind (Clause) = N_With_Clause then
7757 Nam := Name (Clause);
7759 -- If the current scope is part of the context of the main unit,
7760 -- analysis of the corresponding with_clause is not complete, and
7761 -- the entity is not set. We use the Chars field directly, which
7762 -- might produce false positives in rare cases, but guarantees
7763 -- that we produce all the instance bodies we will need.
7765 if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
7766 or else (Nkind (Nam) = N_Selected_Component
7767 and then Chars (Selector_Name (Nam)) = Chars (E))
7777 end In_Main_Context;
7779 ---------------------
7780 -- Inherit_Context --
7781 ---------------------
7783 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
7784 Current_Context : List_Id;
7785 Current_Unit : Node_Id;
7794 if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
7796 -- The inherited context is attached to the enclosing compilation
7797 -- unit. This is either the main unit, or the declaration for the
7798 -- main unit (in case the instantiation appears within the package
7799 -- declaration and the main unit is its body).
7801 Current_Unit := Parent (Inst);
7802 while Present (Current_Unit)
7803 and then Nkind (Current_Unit) /= N_Compilation_Unit
7805 Current_Unit := Parent (Current_Unit);
7808 Current_Context := Context_Items (Current_Unit);
7810 Item := First (Context_Items (Parent (Gen_Decl)));
7811 while Present (Item) loop
7812 if Nkind (Item) = N_With_Clause then
7813 Lib_Unit := Library_Unit (Item);
7815 -- Take care to prevent direct cyclic with's
7817 if Lib_Unit /= Current_Unit then
7819 -- Do not add a unit if it is already in the context
7821 Clause := First (Current_Context);
7823 while Present (Clause) loop
7824 if Nkind (Clause) = N_With_Clause and then
7825 Library_Unit (Clause) = Lib_Unit
7835 New_I := New_Copy (Item);
7836 Set_Implicit_With (New_I, True);
7837 Set_Implicit_With_From_Instantiation (New_I, True);
7838 Append (New_I, Current_Context);
7846 end Inherit_Context;
7852 procedure Initialize is
7854 Generic_Renamings.Init;
7857 Generic_Renamings_HTable.Reset;
7858 Circularity_Detected := False;
7859 Exchanged_Views := No_Elist;
7860 Hidden_Entities := No_Elist;
7863 -------------------------------------
7864 -- Insert_Freeze_Node_For_Instance --
7865 -------------------------------------
7867 procedure Insert_Freeze_Node_For_Instance
7876 function Enclosing_Body (N : Node_Id) return Node_Id;
7877 -- Find enclosing package or subprogram body, if any. Freeze node
7878 -- may be placed at end of current declarative list if previous
7879 -- instance and current one have different enclosing bodies.
7881 function Previous_Instance (Gen : Entity_Id) return Entity_Id;
7882 -- Find the local instance, if any, that declares the generic that is
7883 -- being instantiated. If present, the freeze node for this instance
7884 -- must follow the freeze node for the previous instance.
7886 --------------------
7887 -- Enclosing_Body --
7888 --------------------
7890 function Enclosing_Body (N : Node_Id) return Node_Id is
7896 and then Nkind (Parent (P)) /= N_Compilation_Unit
7898 if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
7899 if Nkind (Parent (P)) = N_Subunit then
7900 return Corresponding_Stub (Parent (P));
7906 P := True_Parent (P);
7912 -----------------------
7913 -- Previous_Instance --
7914 -----------------------
7916 function Previous_Instance (Gen : Entity_Id) return Entity_Id is
7922 and then S /= Standard_Standard
7924 if Is_Generic_Instance (S)
7925 and then In_Same_Source_Unit (S, N)
7934 end Previous_Instance;
7936 -- Start of processing for Insert_Freeze_Node_For_Instance
7939 if not Is_List_Member (F_Node) then
7941 Decls := List_Containing (N);
7942 Inst := Entity (F_Node);
7943 Par_N := Parent (Decls);
7945 -- When processing a subprogram instantiation, utilize the actual
7946 -- subprogram instantiation rather than its package wrapper as it
7947 -- carries all the context information.
7949 if Is_Wrapper_Package (Inst) then
7950 Inst := Related_Instance (Inst);
7953 -- If this is a package instance, check whether the generic is
7954 -- declared in a previous instance and the current instance is
7955 -- not within the previous one.
7957 if Present (Generic_Parent (Parent (Inst)))
7958 and then Is_In_Main_Unit (N)
7961 Enclosing_N : constant Node_Id := Enclosing_Body (N);
7962 Par_I : constant Entity_Id :=
7964 (Generic_Parent (Parent (Inst)));
7969 and then Earlier (N, Freeze_Node (Par_I))
7971 Scop := Scope (Inst);
7973 -- If the current instance is within the one that contains
7974 -- the generic, the freeze node for the current one must
7975 -- appear in the current declarative part. Ditto, if the
7976 -- current instance is within another package instance or
7977 -- within a body that does not enclose the current instance.
7978 -- In these three cases the freeze node of the previous
7979 -- instance is not relevant.
7981 while Present (Scop)
7982 and then Scop /= Standard_Standard
7984 exit when Scop = Par_I
7986 (Is_Generic_Instance (Scop)
7987 and then Scope_Depth (Scop) > Scope_Depth (Par_I));
7988 Scop := Scope (Scop);
7991 -- Previous instance encloses current instance
7993 if Scop = Par_I then
7996 -- If the next node is a source body we must freeze in
7997 -- the current scope as well.
7999 elsif Present (Next (N))
8000 and then Nkind_In (Next (N),
8001 N_Subprogram_Body, N_Package_Body)
8002 and then Comes_From_Source (Next (N))
8006 -- Current instance is within an unrelated instance
8008 elsif Is_Generic_Instance (Scop) then
8011 -- Current instance is within an unrelated body
8013 elsif Present (Enclosing_N)
8014 and then Enclosing_N /= Enclosing_Body (Par_I)
8019 Insert_After (Freeze_Node (Par_I), F_Node);
8026 -- When the instantiation occurs in a package declaration, append the
8027 -- freeze node to the private declarations (if any).
8029 if Nkind (Par_N) = N_Package_Specification
8030 and then Decls = Visible_Declarations (Par_N)
8031 and then Present (Private_Declarations (Par_N))
8032 and then not Is_Empty_List (Private_Declarations (Par_N))
8034 Decls := Private_Declarations (Par_N);
8035 Decl := First (Decls);
8038 -- Determine the proper freeze point of a package instantiation. We
8039 -- adhere to the general rule of a package or subprogram body causing
8040 -- freezing of anything before it in the same declarative region. In
8041 -- this case, the proper freeze point of a package instantiation is
8042 -- before the first source body which follows, or before a stub. This
8043 -- ensures that entities coming from the instance are already frozen
8044 -- and usable in source bodies.
8046 if Nkind (Par_N) /= N_Package_Declaration
8047 and then Ekind (Inst) = E_Package
8048 and then Is_Generic_Instance (Inst)
8050 not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
8052 while Present (Decl) loop
8053 if (Nkind (Decl) in N_Unit_Body
8055 Nkind (Decl) in N_Body_Stub)
8056 and then Comes_From_Source (Decl)
8058 Insert_Before (Decl, F_Node);
8066 -- In a package declaration, or if no previous body, insert at end
8069 Set_Sloc (F_Node, Sloc (Last (Decls)));
8070 Insert_After (Last (Decls), F_Node);
8072 end Insert_Freeze_Node_For_Instance;
8078 procedure Install_Body
8079 (Act_Body : Node_Id;
8084 Act_Id : constant Entity_Id := Corresponding_Spec (Act_Body);
8085 Act_Unit : constant Node_Id := Unit (Cunit (Get_Source_Unit (N)));
8086 Gen_Id : constant Entity_Id := Corresponding_Spec (Gen_Body);
8087 Par : constant Entity_Id := Scope (Gen_Id);
8088 Gen_Unit : constant Node_Id :=
8089 Unit (Cunit (Get_Source_Unit (Gen_Decl)));
8090 Orig_Body : Node_Id := Gen_Body;
8092 Body_Unit : Node_Id;
8094 Must_Delay : Boolean;
8096 function Enclosing_Subp (Id : Entity_Id) return Entity_Id;
8097 -- Find subprogram (if any) that encloses instance and/or generic body
8099 function True_Sloc (N : Node_Id) return Source_Ptr;
8100 -- If the instance is nested inside a generic unit, the Sloc of the
8101 -- instance indicates the place of the original definition, not the
8102 -- point of the current enclosing instance. Pending a better usage of
8103 -- Slocs to indicate instantiation places, we determine the place of
8104 -- origin of a node by finding the maximum sloc of any ancestor node.
8105 -- Why is this not equivalent to Top_Level_Location ???
8107 --------------------
8108 -- Enclosing_Subp --
8109 --------------------
8111 function Enclosing_Subp (Id : Entity_Id) return Entity_Id is
8116 while Scop /= Standard_Standard
8117 and then not Is_Overloadable (Scop)
8119 Scop := Scope (Scop);
8129 function True_Sloc (N : Node_Id) return Source_Ptr is
8136 while Present (N1) and then N1 /= Act_Unit loop
8137 if Sloc (N1) > Res then
8147 -- Start of processing for Install_Body
8150 -- If the body is a subunit, the freeze point is the corresponding stub
8151 -- in the current compilation, not the subunit itself.
8153 if Nkind (Parent (Gen_Body)) = N_Subunit then
8154 Orig_Body := Corresponding_Stub (Parent (Gen_Body));
8156 Orig_Body := Gen_Body;
8159 Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8161 -- If the instantiation and the generic definition appear in the same
8162 -- package declaration, this is an early instantiation. If they appear
8163 -- in the same declarative part, it is an early instantiation only if
8164 -- the generic body appears textually later, and the generic body is
8165 -- also in the main unit.
8167 -- If instance is nested within a subprogram, and the generic body is
8168 -- not, the instance is delayed because the enclosing body is. If
8169 -- instance and body are within the same scope, or the same sub-
8170 -- program body, indicate explicitly that the instance is delayed.
8173 (Gen_Unit = Act_Unit
8174 and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8175 N_Generic_Package_Declaration)
8176 or else (Gen_Unit = Body_Unit
8177 and then True_Sloc (N) < Sloc (Orig_Body)))
8178 and then Is_In_Main_Unit (Gen_Unit)
8179 and then (Scope (Act_Id) = Scope (Gen_Id)
8181 Enclosing_Subp (Act_Id) = Enclosing_Subp (Gen_Id)));
8183 -- If this is an early instantiation, the freeze node is placed after
8184 -- the generic body. Otherwise, if the generic appears in an instance,
8185 -- we cannot freeze the current instance until the outer one is frozen.
8186 -- This is only relevant if the current instance is nested within some
8187 -- inner scope not itself within the outer instance. If this scope is
8188 -- a package body in the same declarative part as the outer instance,
8189 -- then that body needs to be frozen after the outer instance. Finally,
8190 -- if no delay is needed, we place the freeze node at the end of the
8191 -- current declarative part.
8193 if Expander_Active then
8194 Ensure_Freeze_Node (Act_Id);
8195 F_Node := Freeze_Node (Act_Id);
8198 Insert_After (Orig_Body, F_Node);
8200 elsif Is_Generic_Instance (Par)
8201 and then Present (Freeze_Node (Par))
8202 and then Scope (Act_Id) /= Par
8204 -- Freeze instance of inner generic after instance of enclosing
8207 if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8209 -- Handle the following case:
8211 -- package Parent_Inst is new ...
8214 -- procedure P ... -- this body freezes Parent_Inst
8216 -- package Inst is new ...
8218 -- In this particular scenario, the freeze node for Inst must
8219 -- be inserted in the same manner as that of Parent_Inst -
8220 -- before the next source body or at the end of the declarative
8221 -- list (body not available). If body P did not exist and
8222 -- Parent_Inst was frozen after Inst, either by a body
8223 -- following Inst or at the end of the declarative region, the
8224 -- freeze node for Inst must be inserted after that of
8225 -- Parent_Inst. This relation is established by comparing the
8226 -- Slocs of Parent_Inst freeze node and Inst.
8228 if List_Containing (Get_Package_Instantiation_Node (Par)) =
8230 and then Sloc (Freeze_Node (Par)) < Sloc (N)
8232 Insert_Freeze_Node_For_Instance (N, F_Node);
8234 Insert_After (Freeze_Node (Par), F_Node);
8237 -- Freeze package enclosing instance of inner generic after
8238 -- instance of enclosing generic.
8240 elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8241 and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8244 Enclosing : Entity_Id;
8247 Enclosing := Corresponding_Spec (Parent (N));
8249 if No (Enclosing) then
8250 Enclosing := Defining_Entity (Parent (N));
8253 Insert_Freeze_Node_For_Instance (N, F_Node);
8254 Ensure_Freeze_Node (Enclosing);
8256 if not Is_List_Member (Freeze_Node (Enclosing)) then
8258 -- The enclosing context is a subunit, insert the freeze
8259 -- node after the stub.
8261 if Nkind (Parent (Parent (N))) = N_Subunit then
8262 Insert_Freeze_Node_For_Instance
8263 (Corresponding_Stub (Parent (Parent (N))),
8264 Freeze_Node (Enclosing));
8266 -- The enclosing context is a package with a stub body
8267 -- which has already been replaced by the real body.
8268 -- Insert the freeze node after the actual body.
8270 elsif Ekind (Enclosing) = E_Package
8271 and then Present (Body_Entity (Enclosing))
8272 and then Was_Originally_Stub
8273 (Parent (Body_Entity (Enclosing)))
8275 Insert_Freeze_Node_For_Instance
8276 (Parent (Body_Entity (Enclosing)),
8277 Freeze_Node (Enclosing));
8279 -- The parent instance has been frozen before the body of
8280 -- the enclosing package, insert the freeze node after
8283 elsif List_Containing (Freeze_Node (Par)) =
8284 List_Containing (Parent (N))
8285 and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8287 Insert_Freeze_Node_For_Instance
8288 (Parent (N), Freeze_Node (Enclosing));
8292 (Freeze_Node (Par), Freeze_Node (Enclosing));
8298 Insert_Freeze_Node_For_Instance (N, F_Node);
8302 Insert_Freeze_Node_For_Instance (N, F_Node);
8306 Set_Is_Frozen (Act_Id);
8307 Insert_Before (N, Act_Body);
8308 Mark_Rewrite_Insertion (Act_Body);
8311 -----------------------------
8312 -- Install_Formal_Packages --
8313 -----------------------------
8315 procedure Install_Formal_Packages (Par : Entity_Id) is
8318 Gen_E : Entity_Id := Empty;
8321 E := First_Entity (Par);
8323 -- If we are installing an instance parent, locate the formal packages
8324 -- of its generic parent.
8326 if Is_Generic_Instance (Par) then
8327 Gen := Generic_Parent (Specification (Unit_Declaration_Node (Par)));
8328 Gen_E := First_Entity (Gen);
8331 while Present (E) loop
8332 if Ekind (E) = E_Package
8333 and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8335 -- If this is the renaming for the parent instance, done
8337 if Renamed_Object (E) = Par then
8340 -- The visibility of a formal of an enclosing generic is already
8343 elsif Denotes_Formal_Package (E) then
8346 elsif Present (Associated_Formal_Package (E)) then
8347 Check_Generic_Actuals (Renamed_Object (E), True);
8348 Set_Is_Hidden (E, False);
8350 -- Find formal package in generic unit that corresponds to
8351 -- (instance of) formal package in instance.
8353 while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8354 Next_Entity (Gen_E);
8357 if Present (Gen_E) then
8358 Map_Formal_Package_Entities (Gen_E, E);
8364 if Present (Gen_E) then
8365 Next_Entity (Gen_E);
8368 end Install_Formal_Packages;
8370 --------------------
8371 -- Install_Parent --
8372 --------------------
8374 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8375 Ancestors : constant Elist_Id := New_Elmt_List;
8376 S : constant Entity_Id := Current_Scope;
8377 Inst_Par : Entity_Id;
8378 First_Par : Entity_Id;
8379 Inst_Node : Node_Id;
8380 Gen_Par : Entity_Id;
8381 First_Gen : Entity_Id;
8384 procedure Install_Noninstance_Specs (Par : Entity_Id);
8385 -- Install the scopes of noninstance parent units ending with Par
8387 procedure Install_Spec (Par : Entity_Id);
8388 -- The child unit is within the declarative part of the parent, so
8389 -- the declarations within the parent are immediately visible.
8391 -------------------------------
8392 -- Install_Noninstance_Specs --
8393 -------------------------------
8395 procedure Install_Noninstance_Specs (Par : Entity_Id) is
8398 and then Par /= Standard_Standard
8399 and then not In_Open_Scopes (Par)
8401 Install_Noninstance_Specs (Scope (Par));
8404 end Install_Noninstance_Specs;
8410 procedure Install_Spec (Par : Entity_Id) is
8411 Spec : constant Node_Id :=
8412 Specification (Unit_Declaration_Node (Par));
8415 -- If this parent of the child instance is a top-level unit,
8416 -- then record the unit and its visibility for later resetting
8417 -- in Remove_Parent. We exclude units that are generic instances,
8418 -- as we only want to record this information for the ultimate
8419 -- top-level noninstance parent (is that always correct???).
8421 if Scope (Par) = Standard_Standard
8422 and then not Is_Generic_Instance (Par)
8424 Parent_Unit_Visible := Is_Immediately_Visible (Par);
8425 Instance_Parent_Unit := Par;
8428 -- Open the parent scope and make it and its declarations visible.
8429 -- If this point is not within a body, then only the visible
8430 -- declarations should be made visible, and installation of the
8431 -- private declarations is deferred until the appropriate point
8432 -- within analysis of the spec being instantiated (see the handling
8433 -- of parent visibility in Analyze_Package_Specification). This is
8434 -- relaxed in the case where the parent unit is Ada.Tags, to avoid
8435 -- private view problems that occur when compiling instantiations of
8436 -- a generic child of that package (Generic_Dispatching_Constructor).
8437 -- If the instance freezes a tagged type, inlinings of operations
8438 -- from Ada.Tags may need the full view of type Tag. If inlining took
8439 -- proper account of establishing visibility of inlined subprograms'
8440 -- parents then it should be possible to remove this
8441 -- special check. ???
8444 Set_Is_Immediately_Visible (Par);
8445 Install_Visible_Declarations (Par);
8446 Set_Use (Visible_Declarations (Spec));
8448 if In_Body or else Is_RTU (Par, Ada_Tags) then
8449 Install_Private_Declarations (Par);
8450 Set_Use (Private_Declarations (Spec));
8454 -- Start of processing for Install_Parent
8457 -- We need to install the parent instance to compile the instantiation
8458 -- of the child, but the child instance must appear in the current
8459 -- scope. Given that we cannot place the parent above the current scope
8460 -- in the scope stack, we duplicate the current scope and unstack both
8461 -- after the instantiation is complete.
8463 -- If the parent is itself the instantiation of a child unit, we must
8464 -- also stack the instantiation of its parent, and so on. Each such
8465 -- ancestor is the prefix of the name in a prior instantiation.
8467 -- If this is a nested instance, the parent unit itself resolves to
8468 -- a renaming of the parent instance, whose declaration we need.
8470 -- Finally, the parent may be a generic (not an instance) when the
8471 -- child unit appears as a formal package.
8475 if Present (Renamed_Entity (Inst_Par)) then
8476 Inst_Par := Renamed_Entity (Inst_Par);
8479 First_Par := Inst_Par;
8482 Generic_Parent (Specification (Unit_Declaration_Node (Inst_Par)));
8484 First_Gen := Gen_Par;
8486 while Present (Gen_Par)
8487 and then Is_Child_Unit (Gen_Par)
8489 -- Load grandparent instance as well
8491 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
8493 if Nkind (Name (Inst_Node)) = N_Expanded_Name then
8494 Inst_Par := Entity (Prefix (Name (Inst_Node)));
8496 if Present (Renamed_Entity (Inst_Par)) then
8497 Inst_Par := Renamed_Entity (Inst_Par);
8502 (Specification (Unit_Declaration_Node (Inst_Par)));
8504 if Present (Gen_Par) then
8505 Prepend_Elmt (Inst_Par, Ancestors);
8508 -- Parent is not the name of an instantiation
8510 Install_Noninstance_Specs (Inst_Par);
8521 if Present (First_Gen) then
8522 Append_Elmt (First_Par, Ancestors);
8524 Install_Noninstance_Specs (First_Par);
8527 if not Is_Empty_Elmt_List (Ancestors) then
8528 Elmt := First_Elmt (Ancestors);
8529 while Present (Elmt) loop
8530 Install_Spec (Node (Elmt));
8531 Install_Formal_Packages (Node (Elmt));
8541 -------------------------------
8542 -- Install_Hidden_Primitives --
8543 -------------------------------
8545 procedure Install_Hidden_Primitives
8546 (Prims_List : in out Elist_Id;
8551 List : Elist_Id := No_Elist;
8552 Prim_G_Elmt : Elmt_Id;
8553 Prim_A_Elmt : Elmt_Id;
8558 -- No action needed in case of serious errors because we cannot trust
8559 -- in the order of primitives
8561 if Serious_Errors_Detected > 0 then
8564 -- No action possible if we don't have available the list of primitive
8568 or else not Is_Record_Type (Gen_T)
8569 or else not Is_Tagged_Type (Gen_T)
8570 or else not Is_Record_Type (Act_T)
8571 or else not Is_Tagged_Type (Act_T)
8575 -- There is no need to handle interface types since their primitives
8578 elsif Is_Interface (Gen_T) then
8582 Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
8584 if not Is_Class_Wide_Type (Act_T) then
8585 Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
8587 Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
8591 -- Skip predefined primitives in the generic formal
8593 while Present (Prim_G_Elmt)
8594 and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
8596 Next_Elmt (Prim_G_Elmt);
8599 -- Skip predefined primitives in the generic actual
8601 while Present (Prim_A_Elmt)
8602 and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
8604 Next_Elmt (Prim_A_Elmt);
8607 exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
8609 Prim_G := Node (Prim_G_Elmt);
8610 Prim_A := Node (Prim_A_Elmt);
8612 -- There is no need to handle interface primitives because their
8613 -- primitives are not hidden
8615 exit when Present (Interface_Alias (Prim_G));
8617 -- Here we install one hidden primitive
8619 if Chars (Prim_G) /= Chars (Prim_A)
8620 and then Has_Suffix (Prim_A, 'P')
8621 and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
8623 Set_Chars (Prim_A, Chars (Prim_G));
8625 if List = No_Elist then
8626 List := New_Elmt_List;
8629 Append_Elmt (Prim_A, List);
8632 Next_Elmt (Prim_A_Elmt);
8633 Next_Elmt (Prim_G_Elmt);
8636 -- Append the elements to the list of temporarily visible primitives
8637 -- avoiding duplicates.
8639 if Present (List) then
8640 if No (Prims_List) then
8641 Prims_List := New_Elmt_List;
8644 Elmt := First_Elmt (List);
8645 while Present (Elmt) loop
8646 Append_Unique_Elmt (Node (Elmt), Prims_List);
8650 end Install_Hidden_Primitives;
8652 -------------------------------
8653 -- Restore_Hidden_Primitives --
8654 -------------------------------
8656 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
8657 Prim_Elmt : Elmt_Id;
8661 if Prims_List /= No_Elist then
8662 Prim_Elmt := First_Elmt (Prims_List);
8663 while Present (Prim_Elmt) loop
8664 Prim := Node (Prim_Elmt);
8665 Set_Chars (Prim, Add_Suffix (Prim, 'P'));
8666 Next_Elmt (Prim_Elmt);
8669 Prims_List := No_Elist;
8671 end Restore_Hidden_Primitives;
8673 --------------------------------
8674 -- Instantiate_Formal_Package --
8675 --------------------------------
8677 function Instantiate_Formal_Package
8680 Analyzed_Formal : Node_Id) return List_Id
8682 Loc : constant Source_Ptr := Sloc (Actual);
8683 Actual_Pack : Entity_Id;
8684 Formal_Pack : Entity_Id;
8685 Gen_Parent : Entity_Id;
8688 Parent_Spec : Node_Id;
8690 procedure Find_Matching_Actual
8692 Act : in out Entity_Id);
8693 -- We need to associate each formal entity in the formal package
8694 -- with the corresponding entity in the actual package. The actual
8695 -- package has been analyzed and possibly expanded, and as a result
8696 -- there is no one-to-one correspondence between the two lists (for
8697 -- example, the actual may include subtypes, itypes, and inherited
8698 -- primitive operations, interspersed among the renaming declarations
8699 -- for the actuals) . We retrieve the corresponding actual by name
8700 -- because each actual has the same name as the formal, and they do
8701 -- appear in the same order.
8703 function Get_Formal_Entity (N : Node_Id) return Entity_Id;
8704 -- Retrieve entity of defining entity of generic formal parameter.
8705 -- Only the declarations of formals need to be considered when
8706 -- linking them to actuals, but the declarative list may include
8707 -- internal entities generated during analysis, and those are ignored.
8709 procedure Match_Formal_Entity
8710 (Formal_Node : Node_Id;
8711 Formal_Ent : Entity_Id;
8712 Actual_Ent : Entity_Id);
8713 -- Associates the formal entity with the actual. In the case
8714 -- where Formal_Ent is a formal package, this procedure iterates
8715 -- through all of its formals and enters associations between the
8716 -- actuals occurring in the formal package's corresponding actual
8717 -- package (given by Actual_Ent) and the formal package's formal
8718 -- parameters. This procedure recurses if any of the parameters is
8719 -- itself a package.
8721 function Is_Instance_Of
8722 (Act_Spec : Entity_Id;
8723 Gen_Anc : Entity_Id) return Boolean;
8724 -- The actual can be an instantiation of a generic within another
8725 -- instance, in which case there is no direct link from it to the
8726 -- original generic ancestor. In that case, we recognize that the
8727 -- ultimate ancestor is the same by examining names and scopes.
8729 procedure Process_Nested_Formal (Formal : Entity_Id);
8730 -- If the current formal is declared with a box, its own formals are
8731 -- visible in the instance, as they were in the generic, and their
8732 -- Hidden flag must be reset. If some of these formals are themselves
8733 -- packages declared with a box, the processing must be recursive.
8735 --------------------------
8736 -- Find_Matching_Actual --
8737 --------------------------
8739 procedure Find_Matching_Actual
8741 Act : in out Entity_Id)
8743 Formal_Ent : Entity_Id;
8746 case Nkind (Original_Node (F)) is
8747 when N_Formal_Object_Declaration |
8748 N_Formal_Type_Declaration =>
8749 Formal_Ent := Defining_Identifier (F);
8751 while Chars (Act) /= Chars (Formal_Ent) loop
8755 when N_Formal_Subprogram_Declaration |
8756 N_Formal_Package_Declaration |
8757 N_Package_Declaration |
8758 N_Generic_Package_Declaration =>
8759 Formal_Ent := Defining_Entity (F);
8761 while Chars (Act) /= Chars (Formal_Ent) loop
8766 raise Program_Error;
8768 end Find_Matching_Actual;
8770 -------------------------
8771 -- Match_Formal_Entity --
8772 -------------------------
8774 procedure Match_Formal_Entity
8775 (Formal_Node : Node_Id;
8776 Formal_Ent : Entity_Id;
8777 Actual_Ent : Entity_Id)
8779 Act_Pkg : Entity_Id;
8782 Set_Instance_Of (Formal_Ent, Actual_Ent);
8784 if Ekind (Actual_Ent) = E_Package then
8786 -- Record associations for each parameter
8788 Act_Pkg := Actual_Ent;
8791 A_Ent : Entity_Id := First_Entity (Act_Pkg);
8800 -- Retrieve the actual given in the formal package declaration
8802 Actual := Entity (Name (Original_Node (Formal_Node)));
8804 -- The actual in the formal package declaration may be a
8805 -- renamed generic package, in which case we want to retrieve
8806 -- the original generic in order to traverse its formal part.
8808 if Present (Renamed_Entity (Actual)) then
8809 Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
8811 Gen_Decl := Unit_Declaration_Node (Actual);
8814 Formals := Generic_Formal_Declarations (Gen_Decl);
8816 if Present (Formals) then
8817 F_Node := First_Non_Pragma (Formals);
8822 while Present (A_Ent)
8823 and then Present (F_Node)
8824 and then A_Ent /= First_Private_Entity (Act_Pkg)
8826 F_Ent := Get_Formal_Entity (F_Node);
8828 if Present (F_Ent) then
8830 -- This is a formal of the original package. Record
8831 -- association and recurse.
8833 Find_Matching_Actual (F_Node, A_Ent);
8834 Match_Formal_Entity (F_Node, F_Ent, A_Ent);
8835 Next_Entity (A_Ent);
8838 Next_Non_Pragma (F_Node);
8842 end Match_Formal_Entity;
8844 -----------------------
8845 -- Get_Formal_Entity --
8846 -----------------------
8848 function Get_Formal_Entity (N : Node_Id) return Entity_Id is
8849 Kind : constant Node_Kind := Nkind (Original_Node (N));
8852 when N_Formal_Object_Declaration =>
8853 return Defining_Identifier (N);
8855 when N_Formal_Type_Declaration =>
8856 return Defining_Identifier (N);
8858 when N_Formal_Subprogram_Declaration =>
8859 return Defining_Unit_Name (Specification (N));
8861 when N_Formal_Package_Declaration =>
8862 return Defining_Identifier (Original_Node (N));
8864 when N_Generic_Package_Declaration =>
8865 return Defining_Identifier (Original_Node (N));
8867 -- All other declarations are introduced by semantic analysis and
8868 -- have no match in the actual.
8873 end Get_Formal_Entity;
8875 --------------------
8876 -- Is_Instance_Of --
8877 --------------------
8879 function Is_Instance_Of
8880 (Act_Spec : Entity_Id;
8881 Gen_Anc : Entity_Id) return Boolean
8883 Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
8886 if No (Gen_Par) then
8889 -- Simplest case: the generic parent of the actual is the formal
8891 elsif Gen_Par = Gen_Anc then
8894 elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
8897 -- The actual may be obtained through several instantiations. Its
8898 -- scope must itself be an instance of a generic declared in the
8899 -- same scope as the formal. Any other case is detected above.
8901 elsif not Is_Generic_Instance (Scope (Gen_Par)) then
8905 return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
8909 ---------------------------
8910 -- Process_Nested_Formal --
8911 ---------------------------
8913 procedure Process_Nested_Formal (Formal : Entity_Id) is
8917 if Present (Associated_Formal_Package (Formal))
8918 and then Box_Present (Parent (Associated_Formal_Package (Formal)))
8920 Ent := First_Entity (Formal);
8921 while Present (Ent) loop
8922 Set_Is_Hidden (Ent, False);
8923 Set_Is_Visible_Formal (Ent);
8924 Set_Is_Potentially_Use_Visible
8925 (Ent, Is_Potentially_Use_Visible (Formal));
8927 if Ekind (Ent) = E_Package then
8928 exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
8929 Process_Nested_Formal (Ent);
8935 end Process_Nested_Formal;
8937 -- Start of processing for Instantiate_Formal_Package
8942 if not Is_Entity_Name (Actual)
8943 or else Ekind (Entity (Actual)) /= E_Package
8946 ("expect package instance to instantiate formal", Actual);
8947 Abandon_Instantiation (Actual);
8948 raise Program_Error;
8951 Actual_Pack := Entity (Actual);
8952 Set_Is_Instantiated (Actual_Pack);
8954 -- The actual may be a renamed package, or an outer generic formal
8955 -- package whose instantiation is converted into a renaming.
8957 if Present (Renamed_Object (Actual_Pack)) then
8958 Actual_Pack := Renamed_Object (Actual_Pack);
8961 if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
8962 Gen_Parent := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
8963 Formal_Pack := Defining_Identifier (Analyzed_Formal);
8966 Generic_Parent (Specification (Analyzed_Formal));
8968 Defining_Unit_Name (Specification (Analyzed_Formal));
8971 if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
8972 Parent_Spec := Specification (Unit_Declaration_Node (Actual_Pack));
8974 Parent_Spec := Parent (Actual_Pack);
8977 if Gen_Parent = Any_Id then
8979 ("previous error in declaration of formal package", Actual);
8980 Abandon_Instantiation (Actual);
8983 Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
8989 ("actual parameter must be instance of&", Actual, Gen_Parent);
8990 Abandon_Instantiation (Actual);
8993 Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
8994 Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
8997 Make_Package_Renaming_Declaration (Loc,
8998 Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
8999 Name => New_Reference_To (Actual_Pack, Loc));
9001 Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
9002 Defining_Identifier (Formal));
9003 Decls := New_List (Nod);
9005 -- If the formal F has a box, then the generic declarations are
9006 -- visible in the generic G. In an instance of G, the corresponding
9007 -- entities in the actual for F (which are the actuals for the
9008 -- instantiation of the generic that F denotes) must also be made
9009 -- visible for analysis of the current instance. On exit from the
9010 -- current instance, those entities are made private again. If the
9011 -- actual is currently in use, these entities are also use-visible.
9013 -- The loop through the actual entities also steps through the formal
9014 -- entities and enters associations from formals to actuals into the
9015 -- renaming map. This is necessary to properly handle checking of
9016 -- actual parameter associations for later formals that depend on
9017 -- actuals declared in the formal package.
9019 -- In Ada 2005, partial parametrization requires that we make visible
9020 -- the actuals corresponding to formals that were defaulted in the
9021 -- formal package. There formals are identified because they remain
9022 -- formal generics within the formal package, rather than being
9023 -- renamings of the actuals supplied.
9026 Gen_Decl : constant Node_Id :=
9027 Unit_Declaration_Node (Gen_Parent);
9028 Formals : constant List_Id :=
9029 Generic_Formal_Declarations (Gen_Decl);
9031 Actual_Ent : Entity_Id;
9032 Actual_Of_Formal : Node_Id;
9033 Formal_Node : Node_Id;
9034 Formal_Ent : Entity_Id;
9037 if Present (Formals) then
9038 Formal_Node := First_Non_Pragma (Formals);
9040 Formal_Node := Empty;
9043 Actual_Ent := First_Entity (Actual_Pack);
9045 First (Visible_Declarations (Specification (Analyzed_Formal)));
9046 while Present (Actual_Ent)
9047 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9049 if Present (Formal_Node) then
9050 Formal_Ent := Get_Formal_Entity (Formal_Node);
9052 if Present (Formal_Ent) then
9053 Find_Matching_Actual (Formal_Node, Actual_Ent);
9055 (Formal_Node, Formal_Ent, Actual_Ent);
9057 -- We iterate at the same time over the actuals of the
9058 -- local package created for the formal, to determine
9059 -- which one of the formals of the original generic were
9060 -- defaulted in the formal. The corresponding actual
9061 -- entities are visible in the enclosing instance.
9063 if Box_Present (Formal)
9065 (Present (Actual_Of_Formal)
9068 (Get_Formal_Entity (Actual_Of_Formal)))
9070 Set_Is_Hidden (Actual_Ent, False);
9071 Set_Is_Visible_Formal (Actual_Ent);
9072 Set_Is_Potentially_Use_Visible
9073 (Actual_Ent, In_Use (Actual_Pack));
9075 if Ekind (Actual_Ent) = E_Package then
9076 Process_Nested_Formal (Actual_Ent);
9080 Set_Is_Hidden (Actual_Ent);
9081 Set_Is_Potentially_Use_Visible (Actual_Ent, False);
9085 Next_Non_Pragma (Formal_Node);
9086 Next (Actual_Of_Formal);
9089 -- No further formals to match, but the generic part may
9090 -- contain inherited operation that are not hidden in the
9091 -- enclosing instance.
9093 Next_Entity (Actual_Ent);
9097 -- Inherited subprograms generated by formal derived types are
9098 -- also visible if the types are.
9100 Actual_Ent := First_Entity (Actual_Pack);
9101 while Present (Actual_Ent)
9102 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9104 if Is_Overloadable (Actual_Ent)
9106 Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
9108 not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
9110 Set_Is_Hidden (Actual_Ent, False);
9111 Set_Is_Potentially_Use_Visible
9112 (Actual_Ent, In_Use (Actual_Pack));
9115 Next_Entity (Actual_Ent);
9119 -- If the formal is not declared with a box, reanalyze it as an
9120 -- abbreviated instantiation, to verify the matching rules of 12.7.
9121 -- The actual checks are performed after the generic associations
9122 -- have been analyzed, to guarantee the same visibility for this
9123 -- instantiation and for the actuals.
9125 -- In Ada 2005, the generic associations for the formal can include
9126 -- defaulted parameters. These are ignored during check. This
9127 -- internal instantiation is removed from the tree after conformance
9128 -- checking, because it contains formal declarations for those
9129 -- defaulted parameters, and those should not reach the back-end.
9131 if not Box_Present (Formal) then
9133 I_Pack : constant Entity_Id :=
9134 Make_Temporary (Sloc (Actual), 'P');
9137 Set_Is_Internal (I_Pack);
9140 Make_Package_Instantiation (Sloc (Actual),
9141 Defining_Unit_Name => I_Pack,
9144 (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
9145 Generic_Associations =>
9146 Generic_Associations (Formal)));
9152 end Instantiate_Formal_Package;
9154 -----------------------------------
9155 -- Instantiate_Formal_Subprogram --
9156 -----------------------------------
9158 function Instantiate_Formal_Subprogram
9161 Analyzed_Formal : Node_Id) return Node_Id
9164 Formal_Sub : constant Entity_Id :=
9165 Defining_Unit_Name (Specification (Formal));
9166 Analyzed_S : constant Entity_Id :=
9167 Defining_Unit_Name (Specification (Analyzed_Formal));
9168 Decl_Node : Node_Id;
9172 function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9173 -- If the generic is a child unit, the parent has been installed on the
9174 -- scope stack, but a default subprogram cannot resolve to something on
9175 -- the parent because that parent is not really part of the visible
9176 -- context (it is there to resolve explicit local entities). If the
9177 -- default has resolved in this way, we remove the entity from
9178 -- immediate visibility and analyze the node again to emit an error
9179 -- message or find another visible candidate.
9181 procedure Valid_Actual_Subprogram (Act : Node_Id);
9182 -- Perform legality check and raise exception on failure
9184 -----------------------
9185 -- From_Parent_Scope --
9186 -----------------------
9188 function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9189 Gen_Scope : Node_Id;
9192 Gen_Scope := Scope (Analyzed_S);
9193 while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9194 if Scope (Subp) = Scope (Gen_Scope) then
9198 Gen_Scope := Scope (Gen_Scope);
9202 end From_Parent_Scope;
9204 -----------------------------
9205 -- Valid_Actual_Subprogram --
9206 -----------------------------
9208 procedure Valid_Actual_Subprogram (Act : Node_Id) is
9212 if Is_Entity_Name (Act) then
9213 Act_E := Entity (Act);
9215 elsif Nkind (Act) = N_Selected_Component
9216 and then Is_Entity_Name (Selector_Name (Act))
9218 Act_E := Entity (Selector_Name (Act));
9224 if (Present (Act_E) and then Is_Overloadable (Act_E))
9225 or else Nkind_In (Act, N_Attribute_Reference,
9226 N_Indexed_Component,
9227 N_Character_Literal,
9228 N_Explicit_Dereference)
9234 ("expect subprogram or entry name in instantiation of&",
9235 Instantiation_Node, Formal_Sub);
9236 Abandon_Instantiation (Instantiation_Node);
9238 end Valid_Actual_Subprogram;
9240 -- Start of processing for Instantiate_Formal_Subprogram
9243 New_Spec := New_Copy_Tree (Specification (Formal));
9245 -- The tree copy has created the proper instantiation sloc for the
9246 -- new specification. Use this location for all other constructed
9249 Loc := Sloc (Defining_Unit_Name (New_Spec));
9251 -- Create new entity for the actual (New_Copy_Tree does not)
9253 Set_Defining_Unit_Name
9254 (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9256 -- Create new entities for the each of the formals in the
9257 -- specification of the renaming declaration built for the actual.
9259 if Present (Parameter_Specifications (New_Spec)) then
9263 F := First (Parameter_Specifications (New_Spec));
9264 while Present (F) loop
9265 Set_Defining_Identifier (F,
9266 Make_Defining_Identifier (Sloc (F),
9267 Chars => Chars (Defining_Identifier (F))));
9273 -- Find entity of actual. If the actual is an attribute reference, it
9274 -- cannot be resolved here (its formal is missing) but is handled
9275 -- instead in Attribute_Renaming. If the actual is overloaded, it is
9276 -- fully resolved subsequently, when the renaming declaration for the
9277 -- formal is analyzed. If it is an explicit dereference, resolve the
9278 -- prefix but not the actual itself, to prevent interpretation as call.
9280 if Present (Actual) then
9281 Loc := Sloc (Actual);
9282 Set_Sloc (New_Spec, Loc);
9284 if Nkind (Actual) = N_Operator_Symbol then
9285 Find_Direct_Name (Actual);
9287 elsif Nkind (Actual) = N_Explicit_Dereference then
9288 Analyze (Prefix (Actual));
9290 elsif Nkind (Actual) /= N_Attribute_Reference then
9294 Valid_Actual_Subprogram (Actual);
9297 elsif Present (Default_Name (Formal)) then
9298 if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9299 N_Selected_Component,
9300 N_Indexed_Component,
9301 N_Character_Literal)
9302 and then Present (Entity (Default_Name (Formal)))
9304 Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9306 Nam := New_Copy (Default_Name (Formal));
9307 Set_Sloc (Nam, Loc);
9310 elsif Box_Present (Formal) then
9312 -- Actual is resolved at the point of instantiation. Create an
9313 -- identifier or operator with the same name as the formal.
9315 if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9316 Nam := Make_Operator_Symbol (Loc,
9317 Chars => Chars (Formal_Sub),
9318 Strval => No_String);
9320 Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9323 elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9324 and then Null_Present (Specification (Formal))
9326 -- Generate null body for procedure, for use in the instance
9329 Make_Subprogram_Body (Loc,
9330 Specification => New_Spec,
9331 Declarations => New_List,
9332 Handled_Statement_Sequence =>
9333 Make_Handled_Sequence_Of_Statements (Loc,
9334 Statements => New_List (Make_Null_Statement (Loc))));
9336 Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9340 Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9342 ("missing actual&", Instantiation_Node, Formal_Sub);
9344 ("\in instantiation of & declared#",
9345 Instantiation_Node, Scope (Analyzed_S));
9346 Abandon_Instantiation (Instantiation_Node);
9350 Make_Subprogram_Renaming_Declaration (Loc,
9351 Specification => New_Spec,
9354 -- If we do not have an actual and the formal specified <> then set to
9355 -- get proper default.
9357 if No (Actual) and then Box_Present (Formal) then
9358 Set_From_Default (Decl_Node);
9361 -- Gather possible interpretations for the actual before analyzing the
9362 -- instance. If overloaded, it will be resolved when analyzing the
9363 -- renaming declaration.
9365 if Box_Present (Formal)
9366 and then No (Actual)
9370 if Is_Child_Unit (Scope (Analyzed_S))
9371 and then Present (Entity (Nam))
9373 if not Is_Overloaded (Nam) then
9374 if From_Parent_Scope (Entity (Nam)) then
9375 Set_Is_Immediately_Visible (Entity (Nam), False);
9376 Set_Entity (Nam, Empty);
9377 Set_Etype (Nam, Empty);
9380 Set_Is_Immediately_Visible (Entity (Nam));
9389 Get_First_Interp (Nam, I, It);
9390 while Present (It.Nam) loop
9391 if From_Parent_Scope (It.Nam) then
9395 Get_Next_Interp (I, It);
9402 -- The generic instantiation freezes the actual. This can only be done
9403 -- once the actual is resolved, in the analysis of the renaming
9404 -- declaration. To make the formal subprogram entity available, we set
9405 -- Corresponding_Formal_Spec to point to the formal subprogram entity.
9406 -- This is also needed in Analyze_Subprogram_Renaming for the processing
9407 -- of formal abstract subprograms.
9409 Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9411 -- We cannot analyze the renaming declaration, and thus find the actual,
9412 -- until all the actuals are assembled in the instance. For subsequent
9413 -- checks of other actuals, indicate the node that will hold the
9414 -- instance of this formal.
9416 Set_Instance_Of (Analyzed_S, Nam);
9418 if Nkind (Actual) = N_Selected_Component
9419 and then Is_Task_Type (Etype (Prefix (Actual)))
9420 and then not Is_Frozen (Etype (Prefix (Actual)))
9422 -- The renaming declaration will create a body, which must appear
9423 -- outside of the instantiation, We move the renaming declaration
9424 -- out of the instance, and create an additional renaming inside,
9425 -- to prevent freezing anomalies.
9428 Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9431 Set_Defining_Unit_Name (New_Spec, Anon_Id);
9432 Insert_Before (Instantiation_Node, Decl_Node);
9433 Analyze (Decl_Node);
9435 -- Now create renaming within the instance
9438 Make_Subprogram_Renaming_Declaration (Loc,
9439 Specification => New_Copy_Tree (New_Spec),
9440 Name => New_Occurrence_Of (Anon_Id, Loc));
9442 Set_Defining_Unit_Name (Specification (Decl_Node),
9443 Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9448 end Instantiate_Formal_Subprogram;
9450 ------------------------
9451 -- Instantiate_Object --
9452 ------------------------
9454 function Instantiate_Object
9457 Analyzed_Formal : Node_Id) return List_Id
9459 Gen_Obj : constant Entity_Id := Defining_Identifier (Formal);
9460 A_Gen_Obj : constant Entity_Id :=
9461 Defining_Identifier (Analyzed_Formal);
9462 Acc_Def : Node_Id := Empty;
9463 Act_Assoc : constant Node_Id := Parent (Actual);
9464 Actual_Decl : Node_Id := Empty;
9465 Decl_Node : Node_Id;
9468 List : constant List_Id := New_List;
9469 Loc : constant Source_Ptr := Sloc (Actual);
9470 Orig_Ftyp : constant Entity_Id := Etype (A_Gen_Obj);
9471 Subt_Decl : Node_Id := Empty;
9472 Subt_Mark : Node_Id := Empty;
9475 if Present (Subtype_Mark (Formal)) then
9476 Subt_Mark := Subtype_Mark (Formal);
9478 Check_Access_Definition (Formal);
9479 Acc_Def := Access_Definition (Formal);
9482 -- Sloc for error message on missing actual
9484 Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
9486 if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
9487 Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
9490 Set_Parent (List, Parent (Actual));
9494 if Out_Present (Formal) then
9496 -- An IN OUT generic actual must be a name. The instantiation is a
9497 -- renaming declaration. The actual is the name being renamed. We
9498 -- use the actual directly, rather than a copy, because it is not
9499 -- used further in the list of actuals, and because a copy or a use
9500 -- of relocate_node is incorrect if the instance is nested within a
9501 -- generic. In order to simplify ASIS searches, the Generic_Parent
9502 -- field links the declaration to the generic association.
9507 Instantiation_Node, Gen_Obj);
9509 ("\in instantiation of & declared#",
9510 Instantiation_Node, Scope (A_Gen_Obj));
9511 Abandon_Instantiation (Instantiation_Node);
9514 if Present (Subt_Mark) then
9516 Make_Object_Renaming_Declaration (Loc,
9517 Defining_Identifier => New_Copy (Gen_Obj),
9518 Subtype_Mark => New_Copy_Tree (Subt_Mark),
9521 else pragma Assert (Present (Acc_Def));
9523 Make_Object_Renaming_Declaration (Loc,
9524 Defining_Identifier => New_Copy (Gen_Obj),
9525 Access_Definition => New_Copy_Tree (Acc_Def),
9529 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9531 -- The analysis of the actual may produce Insert_Action nodes, so
9532 -- the declaration must have a context in which to attach them.
9534 Append (Decl_Node, List);
9537 -- Return if the analysis of the actual reported some error
9539 if Etype (Actual) = Any_Type then
9543 -- This check is performed here because Analyze_Object_Renaming will
9544 -- not check it when Comes_From_Source is False. Note though that the
9545 -- check for the actual being the name of an object will be performed
9546 -- in Analyze_Object_Renaming.
9548 if Is_Object_Reference (Actual)
9549 and then Is_Dependent_Component_Of_Mutable_Object (Actual)
9552 ("illegal discriminant-dependent component for in out parameter",
9556 -- The actual has to be resolved in order to check that it is a
9557 -- variable (due to cases such as F (1), where F returns access to an
9558 -- array, and for overloaded prefixes).
9560 Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
9562 -- If the type of the formal is not itself a formal, and the
9563 -- current unit is a child unit, the formal type must be declared
9564 -- in a parent, and must be retrieved by visibility.
9567 and then Is_Generic_Unit (Scope (Ftyp))
9568 and then Is_Child_Unit (Scope (A_Gen_Obj))
9571 Temp : constant Node_Id :=
9572 New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
9574 Set_Entity (Temp, Empty);
9576 Ftyp := Entity (Temp);
9580 if Is_Private_Type (Ftyp)
9581 and then not Is_Private_Type (Etype (Actual))
9582 and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
9583 or else Base_Type (Etype (Actual)) = Ftyp)
9585 -- If the actual has the type of the full view of the formal, or
9586 -- else a non-private subtype of the formal, then the visibility
9587 -- of the formal type has changed. Add to the actuals a subtype
9588 -- declaration that will force the exchange of views in the body
9589 -- of the instance as well.
9592 Make_Subtype_Declaration (Loc,
9593 Defining_Identifier => Make_Temporary (Loc, 'P'),
9594 Subtype_Indication => New_Occurrence_Of (Ftyp, Loc));
9596 Prepend (Subt_Decl, List);
9598 Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
9599 Exchange_Declarations (Ftyp);
9602 Resolve (Actual, Ftyp);
9604 if not Denotes_Variable (Actual) then
9606 ("actual for& must be a variable", Actual, Gen_Obj);
9608 elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
9610 -- Ada 2005 (AI-423): For a generic formal object of mode in out,
9611 -- the type of the actual shall resolve to a specific anonymous
9614 if Ada_Version < Ada_2005
9616 Ekind (Base_Type (Ftyp)) /=
9617 E_Anonymous_Access_Type
9619 Ekind (Base_Type (Etype (Actual))) /=
9620 E_Anonymous_Access_Type
9622 Error_Msg_NE ("type of actual does not match type of&",
9627 Note_Possible_Modification (Actual, Sure => True);
9629 -- Check for instantiation of atomic/volatile actual for
9630 -- non-atomic/volatile formal (RM C.6 (12)).
9632 if Is_Atomic_Object (Actual)
9633 and then not Is_Atomic (Orig_Ftyp)
9636 ("cannot instantiate non-atomic formal object " &
9637 "with atomic actual", Actual);
9639 elsif Is_Volatile_Object (Actual)
9640 and then not Is_Volatile (Orig_Ftyp)
9643 ("cannot instantiate non-volatile formal object " &
9644 "with volatile actual", Actual);
9647 -- Formal in-parameter
9650 -- The instantiation of a generic formal in-parameter is constant
9651 -- declaration. The actual is the expression for that declaration.
9653 if Present (Actual) then
9654 if Present (Subt_Mark) then
9656 else pragma Assert (Present (Acc_Def));
9661 Make_Object_Declaration (Loc,
9662 Defining_Identifier => New_Copy (Gen_Obj),
9663 Constant_Present => True,
9664 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9665 Object_Definition => New_Copy_Tree (Def),
9666 Expression => Actual);
9668 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9670 -- A generic formal object of a tagged type is defined to be
9671 -- aliased so the new constant must also be treated as aliased.
9673 if Is_Tagged_Type (Etype (A_Gen_Obj)) then
9674 Set_Aliased_Present (Decl_Node);
9677 Append (Decl_Node, List);
9679 -- No need to repeat (pre-)analysis of some expression nodes
9680 -- already handled in Preanalyze_Actuals.
9682 if Nkind (Actual) /= N_Allocator then
9685 -- Return if the analysis of the actual reported some error
9687 if Etype (Actual) = Any_Type then
9693 Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
9697 Typ := Get_Instance_Of (Formal_Type);
9699 Freeze_Before (Instantiation_Node, Typ);
9701 -- If the actual is an aggregate, perform name resolution on
9702 -- its components (the analysis of an aggregate does not do it)
9703 -- to capture local names that may be hidden if the generic is
9706 if Nkind (Actual) = N_Aggregate then
9707 Preanalyze_And_Resolve (Actual, Typ);
9710 if Is_Limited_Type (Typ)
9711 and then not OK_For_Limited_Init (Typ, Actual)
9714 ("initialization not allowed for limited types", Actual);
9715 Explain_Limited_Type (Typ, Actual);
9719 elsif Present (Default_Expression (Formal)) then
9721 -- Use default to construct declaration
9723 if Present (Subt_Mark) then
9725 else pragma Assert (Present (Acc_Def));
9730 Make_Object_Declaration (Sloc (Formal),
9731 Defining_Identifier => New_Copy (Gen_Obj),
9732 Constant_Present => True,
9733 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9734 Object_Definition => New_Copy (Def),
9735 Expression => New_Copy_Tree
9736 (Default_Expression (Formal)));
9738 Append (Decl_Node, List);
9739 Set_Analyzed (Expression (Decl_Node), False);
9744 Instantiation_Node, Gen_Obj);
9745 Error_Msg_NE ("\in instantiation of & declared#",
9746 Instantiation_Node, Scope (A_Gen_Obj));
9748 if Is_Scalar_Type (Etype (A_Gen_Obj)) then
9750 -- Create dummy constant declaration so that instance can be
9751 -- analyzed, to minimize cascaded visibility errors.
9753 if Present (Subt_Mark) then
9755 else pragma Assert (Present (Acc_Def));
9760 Make_Object_Declaration (Loc,
9761 Defining_Identifier => New_Copy (Gen_Obj),
9762 Constant_Present => True,
9763 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9764 Object_Definition => New_Copy (Def),
9766 Make_Attribute_Reference (Sloc (Gen_Obj),
9767 Attribute_Name => Name_First,
9768 Prefix => New_Copy (Def)));
9770 Append (Decl_Node, List);
9773 Abandon_Instantiation (Instantiation_Node);
9778 if Nkind (Actual) in N_Has_Entity then
9779 Actual_Decl := Parent (Entity (Actual));
9782 -- Ada 2005 (AI-423): For a formal object declaration with a null
9783 -- exclusion or an access definition that has a null exclusion: If the
9784 -- actual matching the formal object declaration denotes a generic
9785 -- formal object of another generic unit G, and the instantiation
9786 -- containing the actual occurs within the body of G or within the body
9787 -- of a generic unit declared within the declarative region of G, then
9788 -- the declaration of the formal object of G must have a null exclusion.
9789 -- Otherwise, the subtype of the actual matching the formal object
9790 -- declaration shall exclude null.
9792 if Ada_Version >= Ada_2005
9793 and then Present (Actual_Decl)
9795 Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
9796 N_Object_Declaration)
9797 and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
9798 and then not Has_Null_Exclusion (Actual_Decl)
9799 and then Has_Null_Exclusion (Analyzed_Formal)
9801 Error_Msg_Sloc := Sloc (Analyzed_Formal);
9803 ("actual must exclude null to match generic formal#", Actual);
9807 end Instantiate_Object;
9809 ------------------------------
9810 -- Instantiate_Package_Body --
9811 ------------------------------
9813 procedure Instantiate_Package_Body
9814 (Body_Info : Pending_Body_Info;
9815 Inlined_Body : Boolean := False;
9816 Body_Optional : Boolean := False)
9818 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
9819 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
9820 Loc : constant Source_Ptr := Sloc (Inst_Node);
9822 Gen_Id : constant Node_Id := Name (Inst_Node);
9823 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
9824 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
9825 Act_Spec : constant Node_Id := Specification (Act_Decl);
9826 Act_Decl_Id : constant Entity_Id := Defining_Entity (Act_Spec);
9828 Act_Body_Name : Node_Id;
9830 Gen_Body_Id : Node_Id;
9832 Act_Body_Id : Entity_Id;
9834 Parent_Installed : Boolean := False;
9835 Save_Style_Check : constant Boolean := Style_Check;
9837 Par_Ent : Entity_Id := Empty;
9838 Par_Vis : Boolean := False;
9840 Vis_Prims_List : Elist_Id := No_Elist;
9841 -- List of primitives made temporarily visible in the instantiation
9842 -- to match the visibility of the formal type
9845 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9847 -- The instance body may already have been processed, as the parent of
9848 -- another instance that is inlined (Load_Parent_Of_Generic).
9850 if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
9854 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
9856 -- Re-establish the state of information on which checks are suppressed.
9857 -- This information was set in Body_Info at the point of instantiation,
9858 -- and now we restore it so that the instance is compiled using the
9859 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
9861 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
9862 Scope_Suppress := Body_Info.Scope_Suppress;
9863 Opt.Ada_Version := Body_Info.Version;
9865 if No (Gen_Body_Id) then
9866 Load_Parent_Of_Generic
9867 (Inst_Node, Specification (Gen_Decl), Body_Optional);
9868 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9871 -- Establish global variable for sloc adjustment and for error recovery
9873 Instantiation_Node := Inst_Node;
9875 if Present (Gen_Body_Id) then
9876 Save_Env (Gen_Unit, Act_Decl_Id);
9877 Style_Check := False;
9878 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
9880 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
9882 Create_Instantiation_Source
9883 (Inst_Node, Gen_Body_Id, False, S_Adjustment);
9887 (Original_Node (Gen_Body), Empty, Instantiating => True);
9889 -- Build new name (possibly qualified) for body declaration
9891 Act_Body_Id := New_Copy (Act_Decl_Id);
9893 -- Some attributes of spec entity are not inherited by body entity
9895 Set_Handler_Records (Act_Body_Id, No_List);
9897 if Nkind (Defining_Unit_Name (Act_Spec)) =
9898 N_Defining_Program_Unit_Name
9901 Make_Defining_Program_Unit_Name (Loc,
9902 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
9903 Defining_Identifier => Act_Body_Id);
9905 Act_Body_Name := Act_Body_Id;
9908 Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
9910 Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
9911 Check_Generic_Actuals (Act_Decl_Id, False);
9913 -- Install primitives hidden at the point of the instantiation but
9914 -- visible when processing the generic formals
9920 E := First_Entity (Act_Decl_Id);
9921 while Present (E) loop
9923 and then Is_Generic_Actual_Type (E)
9924 and then Is_Tagged_Type (E)
9926 Install_Hidden_Primitives
9927 (Prims_List => Vis_Prims_List,
9928 Gen_T => Generic_Parent_Type (Parent (E)),
9936 -- If it is a child unit, make the parent instance (which is an
9937 -- instance of the parent of the generic) visible. The parent
9938 -- instance is the prefix of the name of the generic unit.
9940 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
9941 and then Nkind (Gen_Id) = N_Expanded_Name
9943 Par_Ent := Entity (Prefix (Gen_Id));
9944 Par_Vis := Is_Immediately_Visible (Par_Ent);
9945 Install_Parent (Par_Ent, In_Body => True);
9946 Parent_Installed := True;
9948 elsif Is_Child_Unit (Gen_Unit) then
9949 Par_Ent := Scope (Gen_Unit);
9950 Par_Vis := Is_Immediately_Visible (Par_Ent);
9951 Install_Parent (Par_Ent, In_Body => True);
9952 Parent_Installed := True;
9955 -- If the instantiation is a library unit, and this is the main unit,
9956 -- then build the resulting compilation unit nodes for the instance.
9957 -- If this is a compilation unit but it is not the main unit, then it
9958 -- is the body of a unit in the context, that is being compiled
9959 -- because it is encloses some inlined unit or another generic unit
9960 -- being instantiated. In that case, this body is not part of the
9961 -- current compilation, and is not attached to the tree, but its
9962 -- parent must be set for analysis.
9964 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
9966 -- Replace instance node with body of instance, and create new
9967 -- node for corresponding instance declaration.
9969 Build_Instance_Compilation_Unit_Nodes
9970 (Inst_Node, Act_Body, Act_Decl);
9971 Analyze (Inst_Node);
9973 if Parent (Inst_Node) = Cunit (Main_Unit) then
9975 -- If the instance is a child unit itself, then set the scope
9976 -- of the expanded body to be the parent of the instantiation
9977 -- (ensuring that the fully qualified name will be generated
9978 -- for the elaboration subprogram).
9980 if Nkind (Defining_Unit_Name (Act_Spec)) =
9981 N_Defining_Program_Unit_Name
9984 (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
9988 -- Case where instantiation is not a library unit
9991 -- If this is an early instantiation, i.e. appears textually
9992 -- before the corresponding body and must be elaborated first,
9993 -- indicate that the body instance is to be delayed.
9995 Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
9997 -- Now analyze the body. We turn off all checks if this is an
9998 -- internal unit, since there is no reason to have checks on for
9999 -- any predefined run-time library code. All such code is designed
10000 -- to be compiled with checks off.
10002 -- Note that we do NOT apply this criterion to children of GNAT
10003 -- (or on VMS, children of DEC). The latter units must suppress
10004 -- checks explicitly if this is needed.
10006 if Is_Predefined_File_Name
10007 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
10009 Analyze (Act_Body, Suppress => All_Checks);
10011 Analyze (Act_Body);
10015 Inherit_Context (Gen_Body, Inst_Node);
10017 -- Remove the parent instances if they have been placed on the scope
10018 -- stack to compile the body.
10020 if Parent_Installed then
10021 Remove_Parent (In_Body => True);
10023 -- Restore the previous visibility of the parent
10025 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10028 Restore_Hidden_Primitives (Vis_Prims_List);
10029 Restore_Private_Views (Act_Decl_Id);
10031 -- Remove the current unit from visibility if this is an instance
10032 -- that is not elaborated on the fly for inlining purposes.
10034 if not Inlined_Body then
10035 Set_Is_Immediately_Visible (Act_Decl_Id, False);
10039 Style_Check := Save_Style_Check;
10041 -- If we have no body, and the unit requires a body, then complain. This
10042 -- complaint is suppressed if we have detected other errors (since a
10043 -- common reason for missing the body is that it had errors).
10044 -- In CodePeer mode, a warning has been emitted already, no need for
10045 -- further messages.
10047 elsif Unit_Requires_Body (Gen_Unit)
10048 and then not Body_Optional
10050 if CodePeer_Mode then
10053 elsif Serious_Errors_Detected = 0 then
10055 ("cannot find body of generic package &", Inst_Node, Gen_Unit);
10057 -- Don't attempt to perform any cleanup actions if some other error
10058 -- was already detected, since this can cause blowups.
10064 -- Case of package that does not need a body
10067 -- If the instantiation of the declaration is a library unit, rewrite
10068 -- the original package instantiation as a package declaration in the
10069 -- compilation unit node.
10071 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10072 Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
10073 Rewrite (Inst_Node, Act_Decl);
10075 -- Generate elaboration entity, in case spec has elaboration code.
10076 -- This cannot be done when the instance is analyzed, because it
10077 -- is not known yet whether the body exists.
10079 Set_Elaboration_Entity_Required (Act_Decl_Id, False);
10080 Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
10082 -- If the instantiation is not a library unit, then append the
10083 -- declaration to the list of implicitly generated entities, unless
10084 -- it is already a list member which means that it was already
10087 elsif not Is_List_Member (Act_Decl) then
10088 Mark_Rewrite_Insertion (Act_Decl);
10089 Insert_Before (Inst_Node, Act_Decl);
10093 Expander_Mode_Restore;
10094 end Instantiate_Package_Body;
10096 ---------------------------------
10097 -- Instantiate_Subprogram_Body --
10098 ---------------------------------
10100 procedure Instantiate_Subprogram_Body
10101 (Body_Info : Pending_Body_Info;
10102 Body_Optional : Boolean := False)
10104 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10105 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10106 Loc : constant Source_Ptr := Sloc (Inst_Node);
10107 Gen_Id : constant Node_Id := Name (Inst_Node);
10108 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10109 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10110 Anon_Id : constant Entity_Id :=
10111 Defining_Unit_Name (Specification (Act_Decl));
10112 Pack_Id : constant Entity_Id :=
10113 Defining_Unit_Name (Parent (Act_Decl));
10115 Gen_Body : Node_Id;
10116 Gen_Body_Id : Node_Id;
10117 Act_Body : Node_Id;
10118 Pack_Body : Node_Id;
10119 Prev_Formal : Entity_Id;
10120 Ret_Expr : Node_Id;
10121 Unit_Renaming : Node_Id;
10123 Parent_Installed : Boolean := False;
10124 Save_Style_Check : constant Boolean := Style_Check;
10126 Par_Ent : Entity_Id := Empty;
10127 Par_Vis : Boolean := False;
10130 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10132 -- Subprogram body may have been created already because of an inline
10133 -- pragma, or because of multiple elaborations of the enclosing package
10134 -- when several instances of the subprogram appear in the main unit.
10136 if Present (Corresponding_Body (Act_Decl)) then
10140 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10142 -- Re-establish the state of information on which checks are suppressed.
10143 -- This information was set in Body_Info at the point of instantiation,
10144 -- and now we restore it so that the instance is compiled using the
10145 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10147 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10148 Scope_Suppress := Body_Info.Scope_Suppress;
10149 Opt.Ada_Version := Body_Info.Version;
10151 if No (Gen_Body_Id) then
10153 -- For imported generic subprogram, no body to compile, complete
10154 -- the spec entity appropriately.
10156 if Is_Imported (Gen_Unit) then
10157 Set_Is_Imported (Anon_Id);
10158 Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10159 Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10160 Set_Convention (Anon_Id, Convention (Gen_Unit));
10161 Set_Has_Completion (Anon_Id);
10164 -- For other cases, compile the body
10167 Load_Parent_Of_Generic
10168 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10169 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10173 Instantiation_Node := Inst_Node;
10175 if Present (Gen_Body_Id) then
10176 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10178 if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10180 -- Either body is not present, or context is non-expanding, as
10181 -- when compiling a subunit. Mark the instance as completed, and
10182 -- diagnose a missing body when needed.
10185 and then Operating_Mode = Generate_Code
10188 ("missing proper body for instantiation", Gen_Body);
10191 Set_Has_Completion (Anon_Id);
10195 Save_Env (Gen_Unit, Anon_Id);
10196 Style_Check := False;
10197 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10198 Create_Instantiation_Source
10206 (Original_Node (Gen_Body), Empty, Instantiating => True);
10208 -- Create proper defining name for the body, to correspond to
10209 -- the one in the spec.
10211 Set_Defining_Unit_Name (Specification (Act_Body),
10212 Make_Defining_Identifier
10213 (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10214 Set_Corresponding_Spec (Act_Body, Anon_Id);
10215 Set_Has_Completion (Anon_Id);
10216 Check_Generic_Actuals (Pack_Id, False);
10218 -- Generate a reference to link the visible subprogram instance to
10219 -- the generic body, which for navigation purposes is the only
10220 -- available source for the instance.
10223 (Related_Instance (Pack_Id),
10224 Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10226 -- If it is a child unit, make the parent instance (which is an
10227 -- instance of the parent of the generic) visible. The parent
10228 -- instance is the prefix of the name of the generic unit.
10230 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10231 and then Nkind (Gen_Id) = N_Expanded_Name
10233 Par_Ent := Entity (Prefix (Gen_Id));
10234 Par_Vis := Is_Immediately_Visible (Par_Ent);
10235 Install_Parent (Par_Ent, In_Body => True);
10236 Parent_Installed := True;
10238 elsif Is_Child_Unit (Gen_Unit) then
10239 Par_Ent := Scope (Gen_Unit);
10240 Par_Vis := Is_Immediately_Visible (Par_Ent);
10241 Install_Parent (Par_Ent, In_Body => True);
10242 Parent_Installed := True;
10245 -- Inside its body, a reference to the generic unit is a reference
10246 -- to the instance. The corresponding renaming is the first
10247 -- declaration in the body.
10250 Make_Subprogram_Renaming_Declaration (Loc,
10252 Copy_Generic_Node (
10253 Specification (Original_Node (Gen_Body)),
10255 Instantiating => True),
10256 Name => New_Occurrence_Of (Anon_Id, Loc));
10258 -- If there is a formal subprogram with the same name as the unit
10259 -- itself, do not add this renaming declaration. This is a temporary
10260 -- fix for one ACVC test. ???
10262 Prev_Formal := First_Entity (Pack_Id);
10263 while Present (Prev_Formal) loop
10264 if Chars (Prev_Formal) = Chars (Gen_Unit)
10265 and then Is_Overloadable (Prev_Formal)
10270 Next_Entity (Prev_Formal);
10273 if Present (Prev_Formal) then
10274 Decls := New_List (Act_Body);
10276 Decls := New_List (Unit_Renaming, Act_Body);
10279 -- The subprogram body is placed in the body of a dummy package body,
10280 -- whose spec contains the subprogram declaration as well as the
10281 -- renaming declarations for the generic parameters.
10283 Pack_Body := Make_Package_Body (Loc,
10284 Defining_Unit_Name => New_Copy (Pack_Id),
10285 Declarations => Decls);
10287 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10289 -- If the instantiation is a library unit, then build resulting
10290 -- compilation unit nodes for the instance. The declaration of
10291 -- the enclosing package is the grandparent of the subprogram
10292 -- declaration. First replace the instantiation node as the unit
10293 -- of the corresponding compilation.
10295 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10296 if Parent (Inst_Node) = Cunit (Main_Unit) then
10297 Set_Unit (Parent (Inst_Node), Inst_Node);
10298 Build_Instance_Compilation_Unit_Nodes
10299 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10300 Analyze (Inst_Node);
10302 Set_Parent (Pack_Body, Parent (Inst_Node));
10303 Analyze (Pack_Body);
10307 Insert_Before (Inst_Node, Pack_Body);
10308 Mark_Rewrite_Insertion (Pack_Body);
10309 Analyze (Pack_Body);
10311 if Expander_Active then
10312 Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10316 Inherit_Context (Gen_Body, Inst_Node);
10318 Restore_Private_Views (Pack_Id, False);
10320 if Parent_Installed then
10321 Remove_Parent (In_Body => True);
10323 -- Restore the previous visibility of the parent
10325 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10329 Style_Check := Save_Style_Check;
10331 -- Body not found. Error was emitted already. If there were no previous
10332 -- errors, this may be an instance whose scope is a premature instance.
10333 -- In that case we must insure that the (legal) program does raise
10334 -- program error if executed. We generate a subprogram body for this
10335 -- purpose. See DEC ac30vso.
10337 -- Should not reference proprietary DEC tests in comments ???
10339 elsif Serious_Errors_Detected = 0
10340 and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
10342 if Body_Optional then
10345 elsif Ekind (Anon_Id) = E_Procedure then
10347 Make_Subprogram_Body (Loc,
10349 Make_Procedure_Specification (Loc,
10350 Defining_Unit_Name =>
10351 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10352 Parameter_Specifications =>
10354 (Parameter_Specifications (Parent (Anon_Id)))),
10356 Declarations => Empty_List,
10357 Handled_Statement_Sequence =>
10358 Make_Handled_Sequence_Of_Statements (Loc,
10361 Make_Raise_Program_Error (Loc,
10363 PE_Access_Before_Elaboration))));
10367 Make_Raise_Program_Error (Loc,
10368 Reason => PE_Access_Before_Elaboration);
10370 Set_Etype (Ret_Expr, (Etype (Anon_Id)));
10371 Set_Analyzed (Ret_Expr);
10374 Make_Subprogram_Body (Loc,
10376 Make_Function_Specification (Loc,
10377 Defining_Unit_Name =>
10378 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10379 Parameter_Specifications =>
10381 (Parameter_Specifications (Parent (Anon_Id))),
10382 Result_Definition =>
10383 New_Occurrence_Of (Etype (Anon_Id), Loc)),
10385 Declarations => Empty_List,
10386 Handled_Statement_Sequence =>
10387 Make_Handled_Sequence_Of_Statements (Loc,
10390 (Make_Simple_Return_Statement (Loc, Ret_Expr))));
10393 Pack_Body := Make_Package_Body (Loc,
10394 Defining_Unit_Name => New_Copy (Pack_Id),
10395 Declarations => New_List (Act_Body));
10397 Insert_After (Inst_Node, Pack_Body);
10398 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10399 Analyze (Pack_Body);
10402 Expander_Mode_Restore;
10403 end Instantiate_Subprogram_Body;
10405 ----------------------
10406 -- Instantiate_Type --
10407 ----------------------
10409 function Instantiate_Type
10412 Analyzed_Formal : Node_Id;
10413 Actual_Decls : List_Id) return List_Id
10415 Gen_T : constant Entity_Id := Defining_Identifier (Formal);
10416 A_Gen_T : constant Entity_Id :=
10417 Defining_Identifier (Analyzed_Formal);
10418 Ancestor : Entity_Id := Empty;
10419 Def : constant Node_Id := Formal_Type_Definition (Formal);
10421 Decl_Node : Node_Id;
10422 Decl_Nodes : List_Id;
10426 procedure Validate_Array_Type_Instance;
10427 procedure Validate_Access_Subprogram_Instance;
10428 procedure Validate_Access_Type_Instance;
10429 procedure Validate_Derived_Type_Instance;
10430 procedure Validate_Derived_Interface_Type_Instance;
10431 procedure Validate_Discriminated_Formal_Type;
10432 procedure Validate_Interface_Type_Instance;
10433 procedure Validate_Private_Type_Instance;
10434 procedure Validate_Incomplete_Type_Instance;
10435 -- These procedures perform validation tests for the named case.
10436 -- Validate_Discriminated_Formal_Type is shared by formal private
10437 -- types and Ada 2012 formal incomplete types.
10439 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
10440 -- Check that base types are the same and that the subtypes match
10441 -- statically. Used in several of the above.
10443 --------------------
10444 -- Subtypes_Match --
10445 --------------------
10447 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
10448 T : constant Entity_Id := Get_Instance_Of (Gen_T);
10451 -- Some detailed comments would be useful here ???
10453 return ((Base_Type (T) = Act_T
10454 or else Base_Type (T) = Base_Type (Act_T))
10455 and then Subtypes_Statically_Match (T, Act_T))
10457 or else (Is_Class_Wide_Type (Gen_T)
10458 and then Is_Class_Wide_Type (Act_T)
10459 and then Subtypes_Match
10460 (Get_Instance_Of (Root_Type (Gen_T)),
10461 Root_Type (Act_T)))
10464 (Ekind_In (Gen_T, E_Anonymous_Access_Subprogram_Type,
10465 E_Anonymous_Access_Type)
10466 and then Ekind (Act_T) = Ekind (Gen_T)
10467 and then Subtypes_Statically_Match
10468 (Designated_Type (Gen_T), Designated_Type (Act_T)));
10469 end Subtypes_Match;
10471 -----------------------------------------
10472 -- Validate_Access_Subprogram_Instance --
10473 -----------------------------------------
10475 procedure Validate_Access_Subprogram_Instance is
10477 if not Is_Access_Type (Act_T)
10478 or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
10481 ("expect access type in instantiation of &", Actual, Gen_T);
10482 Abandon_Instantiation (Actual);
10485 -- According to AI05-288, actuals for access_to_subprograms must be
10486 -- subtype conformant with the generic formal. Previous to AI05-288
10487 -- only mode conformance was required.
10489 -- This is a binding interpretation that applies to previous versions
10490 -- of the language, but for now we retain the milder check in order
10491 -- to preserve ACATS tests. These will be protested eventually ???
10493 if Ada_Version < Ada_2012 then
10494 Check_Mode_Conformant
10495 (Designated_Type (Act_T),
10496 Designated_Type (A_Gen_T),
10501 Check_Subtype_Conformant
10502 (Designated_Type (Act_T),
10503 Designated_Type (A_Gen_T),
10508 if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
10509 if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
10511 ("protected access type not allowed for formal &",
10515 elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
10517 ("expect protected access type for formal &",
10520 end Validate_Access_Subprogram_Instance;
10522 -----------------------------------
10523 -- Validate_Access_Type_Instance --
10524 -----------------------------------
10526 procedure Validate_Access_Type_Instance is
10527 Desig_Type : constant Entity_Id :=
10528 Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
10529 Desig_Act : Entity_Id;
10532 if not Is_Access_Type (Act_T) then
10534 ("expect access type in instantiation of &", Actual, Gen_T);
10535 Abandon_Instantiation (Actual);
10538 if Is_Access_Constant (A_Gen_T) then
10539 if not Is_Access_Constant (Act_T) then
10541 ("actual type must be access-to-constant type", Actual);
10542 Abandon_Instantiation (Actual);
10545 if Is_Access_Constant (Act_T) then
10547 ("actual type must be access-to-variable type", Actual);
10548 Abandon_Instantiation (Actual);
10550 elsif Ekind (A_Gen_T) = E_General_Access_Type
10551 and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
10553 Error_Msg_N -- CODEFIX
10554 ("actual must be general access type!", Actual);
10555 Error_Msg_NE -- CODEFIX
10556 ("add ALL to }!", Actual, Act_T);
10557 Abandon_Instantiation (Actual);
10561 -- The designated subtypes, that is to say the subtypes introduced
10562 -- by an access type declaration (and not by a subtype declaration)
10565 Desig_Act := Designated_Type (Base_Type (Act_T));
10567 -- The designated type may have been introduced through a limited_
10568 -- with clause, in which case retrieve the non-limited view. This
10569 -- applies to incomplete types as well as to class-wide types.
10571 if From_With_Type (Desig_Act) then
10572 Desig_Act := Available_View (Desig_Act);
10575 if not Subtypes_Match
10576 (Desig_Type, Desig_Act) then
10578 ("designated type of actual does not match that of formal &",
10580 Abandon_Instantiation (Actual);
10582 elsif Is_Access_Type (Designated_Type (Act_T))
10583 and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
10585 Is_Constrained (Designated_Type (Desig_Type))
10588 ("designated type of actual does not match that of formal &",
10590 Abandon_Instantiation (Actual);
10593 -- Ada 2005: null-exclusion indicators of the two types must agree
10595 if Can_Never_Be_Null (A_Gen_T) /= Can_Never_Be_Null (Act_T) then
10597 ("non null exclusion of actual and formal & do not match",
10600 end Validate_Access_Type_Instance;
10602 ----------------------------------
10603 -- Validate_Array_Type_Instance --
10604 ----------------------------------
10606 procedure Validate_Array_Type_Instance is
10611 function Formal_Dimensions return Int;
10612 -- Count number of dimensions in array type formal
10614 -----------------------
10615 -- Formal_Dimensions --
10616 -----------------------
10618 function Formal_Dimensions return Int is
10623 if Nkind (Def) = N_Constrained_Array_Definition then
10624 Index := First (Discrete_Subtype_Definitions (Def));
10626 Index := First (Subtype_Marks (Def));
10629 while Present (Index) loop
10631 Next_Index (Index);
10635 end Formal_Dimensions;
10637 -- Start of processing for Validate_Array_Type_Instance
10640 if not Is_Array_Type (Act_T) then
10642 ("expect array type in instantiation of &", Actual, Gen_T);
10643 Abandon_Instantiation (Actual);
10645 elsif Nkind (Def) = N_Constrained_Array_Definition then
10646 if not (Is_Constrained (Act_T)) then
10648 ("expect constrained array in instantiation of &",
10650 Abandon_Instantiation (Actual);
10654 if Is_Constrained (Act_T) then
10656 ("expect unconstrained array in instantiation of &",
10658 Abandon_Instantiation (Actual);
10662 if Formal_Dimensions /= Number_Dimensions (Act_T) then
10664 ("dimensions of actual do not match formal &", Actual, Gen_T);
10665 Abandon_Instantiation (Actual);
10668 I1 := First_Index (A_Gen_T);
10669 I2 := First_Index (Act_T);
10670 for J in 1 .. Formal_Dimensions loop
10672 -- If the indexes of the actual were given by a subtype_mark,
10673 -- the index was transformed into a range attribute. Retrieve
10674 -- the original type mark for checking.
10676 if Is_Entity_Name (Original_Node (I2)) then
10677 T2 := Entity (Original_Node (I2));
10682 if not Subtypes_Match
10683 (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
10686 ("index types of actual do not match those of formal &",
10688 Abandon_Instantiation (Actual);
10695 -- Check matching subtypes. Note that there are complex visibility
10696 -- issues when the generic is a child unit and some aspect of the
10697 -- generic type is declared in a parent unit of the generic. We do
10698 -- the test to handle this special case only after a direct check
10699 -- for static matching has failed. The case where both the component
10700 -- type and the array type are separate formals, and the component
10701 -- type is a private view may also require special checking in
10705 (Component_Type (A_Gen_T), Component_Type (Act_T))
10706 or else Subtypes_Match
10707 (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
10708 Component_Type (Act_T))
10713 ("component subtype of actual does not match that of formal &",
10715 Abandon_Instantiation (Actual);
10718 if Has_Aliased_Components (A_Gen_T)
10719 and then not Has_Aliased_Components (Act_T)
10722 ("actual must have aliased components to match formal type &",
10725 end Validate_Array_Type_Instance;
10727 -----------------------------------------------
10728 -- Validate_Derived_Interface_Type_Instance --
10729 -----------------------------------------------
10731 procedure Validate_Derived_Interface_Type_Instance is
10732 Par : constant Entity_Id := Entity (Subtype_Indication (Def));
10736 -- First apply interface instance checks
10738 Validate_Interface_Type_Instance;
10740 -- Verify that immediate parent interface is an ancestor of
10744 and then not Interface_Present_In_Ancestor (Act_T, Par)
10747 ("interface actual must include progenitor&", Actual, Par);
10750 -- Now verify that the actual includes all other ancestors of
10753 Elmt := First_Elmt (Interfaces (A_Gen_T));
10754 while Present (Elmt) loop
10755 if not Interface_Present_In_Ancestor
10756 (Act_T, Get_Instance_Of (Node (Elmt)))
10759 ("interface actual must include progenitor&",
10760 Actual, Node (Elmt));
10765 end Validate_Derived_Interface_Type_Instance;
10767 ------------------------------------
10768 -- Validate_Derived_Type_Instance --
10769 ------------------------------------
10771 procedure Validate_Derived_Type_Instance is
10772 Actual_Discr : Entity_Id;
10773 Ancestor_Discr : Entity_Id;
10776 -- If the parent type in the generic declaration is itself a previous
10777 -- formal type, then it is local to the generic and absent from the
10778 -- analyzed generic definition. In that case the ancestor is the
10779 -- instance of the formal (which must have been instantiated
10780 -- previously), unless the ancestor is itself a formal derived type.
10781 -- In this latter case (which is the subject of Corrigendum 8652/0038
10782 -- (AI-202) the ancestor of the formals is the ancestor of its
10783 -- parent. Otherwise, the analyzed generic carries the parent type.
10784 -- If the parent type is defined in a previous formal package, then
10785 -- the scope of that formal package is that of the generic type
10786 -- itself, and it has already been mapped into the corresponding type
10787 -- in the actual package.
10789 -- Common case: parent type defined outside of the generic
10791 if Is_Entity_Name (Subtype_Mark (Def))
10792 and then Present (Entity (Subtype_Mark (Def)))
10794 Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
10796 -- Check whether parent is defined in a previous formal package
10799 Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
10802 Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
10804 -- The type may be a local derivation, or a type extension of a
10805 -- previous formal, or of a formal of a parent package.
10807 elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
10809 Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
10811 -- Check whether the parent is another derived formal type in the
10812 -- same generic unit.
10814 if Etype (A_Gen_T) /= A_Gen_T
10815 and then Is_Generic_Type (Etype (A_Gen_T))
10816 and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
10817 and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
10819 -- Locate ancestor of parent from the subtype declaration
10820 -- created for the actual.
10826 Decl := First (Actual_Decls);
10827 while Present (Decl) loop
10828 if Nkind (Decl) = N_Subtype_Declaration
10829 and then Chars (Defining_Identifier (Decl)) =
10830 Chars (Etype (A_Gen_T))
10832 Ancestor := Generic_Parent_Type (Decl);
10840 pragma Assert (Present (Ancestor));
10842 -- The ancestor itself may be a previous formal that has been
10845 Ancestor := Get_Instance_Of (Ancestor);
10849 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
10852 -- An unusual case: the actual is a type declared in a parent unit,
10853 -- but is not a formal type so there is no instance_of for it.
10854 -- Retrieve it by analyzing the record extension.
10856 elsif Is_Child_Unit (Scope (A_Gen_T))
10857 and then In_Open_Scopes (Scope (Act_T))
10858 and then Is_Generic_Instance (Scope (Act_T))
10860 Analyze (Subtype_Mark (Def));
10861 Ancestor := Entity (Subtype_Mark (Def));
10864 Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
10867 -- If the formal derived type has pragma Preelaborable_Initialization
10868 -- then the actual type must have preelaborable initialization.
10870 if Known_To_Have_Preelab_Init (A_Gen_T)
10871 and then not Has_Preelaborable_Initialization (Act_T)
10874 ("actual for & must have preelaborable initialization",
10878 -- Ada 2005 (AI-251)
10880 if Ada_Version >= Ada_2005
10881 and then Is_Interface (Ancestor)
10883 if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
10885 ("(Ada 2005) expected type implementing & in instantiation",
10889 elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
10891 ("expect type derived from & in instantiation",
10892 Actual, First_Subtype (Ancestor));
10893 Abandon_Instantiation (Actual);
10896 -- Ada 2005 (AI-443): Synchronized formal derived type checks. Note
10897 -- that the formal type declaration has been rewritten as a private
10900 if Ada_Version >= Ada_2005
10901 and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
10902 and then Synchronized_Present (Parent (A_Gen_T))
10904 -- The actual must be a synchronized tagged type
10906 if not Is_Tagged_Type (Act_T) then
10908 ("actual of synchronized type must be tagged", Actual);
10909 Abandon_Instantiation (Actual);
10911 elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
10912 and then Nkind (Type_Definition (Parent (Act_T))) =
10913 N_Derived_Type_Definition
10914 and then not Synchronized_Present (Type_Definition
10918 ("actual of synchronized type must be synchronized", Actual);
10919 Abandon_Instantiation (Actual);
10923 -- Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
10924 -- removes the second instance of the phrase "or allow pass by copy".
10926 if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
10928 ("cannot have atomic actual type for non-atomic formal type",
10931 elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
10933 ("cannot have volatile actual type for non-volatile formal type",
10937 -- It should not be necessary to check for unknown discriminants on
10938 -- Formal, but for some reason Has_Unknown_Discriminants is false for
10939 -- A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
10940 -- needs fixing. ???
10942 if not Is_Indefinite_Subtype (A_Gen_T)
10943 and then not Unknown_Discriminants_Present (Formal)
10944 and then Is_Indefinite_Subtype (Act_T)
10947 ("actual subtype must be constrained", Actual);
10948 Abandon_Instantiation (Actual);
10951 if not Unknown_Discriminants_Present (Formal) then
10952 if Is_Constrained (Ancestor) then
10953 if not Is_Constrained (Act_T) then
10955 ("actual subtype must be constrained", Actual);
10956 Abandon_Instantiation (Actual);
10959 -- Ancestor is unconstrained, Check if generic formal and actual
10960 -- agree on constrainedness. The check only applies to array types
10961 -- and discriminated types.
10963 elsif Is_Constrained (Act_T) then
10964 if Ekind (Ancestor) = E_Access_Type
10966 (not Is_Constrained (A_Gen_T)
10967 and then Is_Composite_Type (A_Gen_T))
10970 ("actual subtype must be unconstrained", Actual);
10971 Abandon_Instantiation (Actual);
10974 -- A class-wide type is only allowed if the formal has unknown
10977 elsif Is_Class_Wide_Type (Act_T)
10978 and then not Has_Unknown_Discriminants (Ancestor)
10981 ("actual for & cannot be a class-wide type", Actual, Gen_T);
10982 Abandon_Instantiation (Actual);
10984 -- Otherwise, the formal and actual shall have the same number
10985 -- of discriminants and each discriminant of the actual must
10986 -- correspond to a discriminant of the formal.
10988 elsif Has_Discriminants (Act_T)
10989 and then not Has_Unknown_Discriminants (Act_T)
10990 and then Has_Discriminants (Ancestor)
10992 Actual_Discr := First_Discriminant (Act_T);
10993 Ancestor_Discr := First_Discriminant (Ancestor);
10994 while Present (Actual_Discr)
10995 and then Present (Ancestor_Discr)
10997 if Base_Type (Act_T) /= Base_Type (Ancestor) and then
10998 No (Corresponding_Discriminant (Actual_Discr))
11001 ("discriminant & does not correspond " &
11002 "to ancestor discriminant", Actual, Actual_Discr);
11003 Abandon_Instantiation (Actual);
11006 Next_Discriminant (Actual_Discr);
11007 Next_Discriminant (Ancestor_Discr);
11010 if Present (Actual_Discr) or else Present (Ancestor_Discr) then
11012 ("actual for & must have same number of discriminants",
11014 Abandon_Instantiation (Actual);
11017 -- This case should be caught by the earlier check for
11018 -- constrainedness, but the check here is added for completeness.
11020 elsif Has_Discriminants (Act_T)
11021 and then not Has_Unknown_Discriminants (Act_T)
11024 ("actual for & must not have discriminants", Actual, Gen_T);
11025 Abandon_Instantiation (Actual);
11027 elsif Has_Discriminants (Ancestor) then
11029 ("actual for & must have known discriminants", Actual, Gen_T);
11030 Abandon_Instantiation (Actual);
11033 if not Subtypes_Statically_Compatible (Act_T, Ancestor) then
11035 ("constraint on actual is incompatible with formal", Actual);
11036 Abandon_Instantiation (Actual);
11040 -- If the formal and actual types are abstract, check that there
11041 -- are no abstract primitives of the actual type that correspond to
11042 -- nonabstract primitives of the formal type (second sentence of
11045 if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
11046 Check_Abstract_Primitives : declare
11047 Gen_Prims : constant Elist_Id :=
11048 Primitive_Operations (A_Gen_T);
11049 Gen_Elmt : Elmt_Id;
11050 Gen_Subp : Entity_Id;
11051 Anc_Subp : Entity_Id;
11052 Anc_Formal : Entity_Id;
11053 Anc_F_Type : Entity_Id;
11055 Act_Prims : constant Elist_Id := Primitive_Operations (Act_T);
11056 Act_Elmt : Elmt_Id;
11057 Act_Subp : Entity_Id;
11058 Act_Formal : Entity_Id;
11059 Act_F_Type : Entity_Id;
11061 Subprograms_Correspond : Boolean;
11063 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
11064 -- Returns true if T2 is derived directly or indirectly from
11065 -- T1, including derivations from interfaces. T1 and T2 are
11066 -- required to be specific tagged base types.
11068 ------------------------
11069 -- Is_Tagged_Ancestor --
11070 ------------------------
11072 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
11074 Intfc_Elmt : Elmt_Id;
11077 -- The predicate is satisfied if the types are the same
11082 -- If we've reached the top of the derivation chain then
11083 -- we know that T1 is not an ancestor of T2.
11085 elsif Etype (T2) = T2 then
11088 -- Proceed to check T2's immediate parent
11090 elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
11093 -- Finally, check to see if T1 is an ancestor of any of T2's
11097 Intfc_Elmt := First_Elmt (Interfaces (T2));
11098 while Present (Intfc_Elmt) loop
11099 if Is_Ancestor (T1, Node (Intfc_Elmt)) then
11103 Next_Elmt (Intfc_Elmt);
11108 end Is_Tagged_Ancestor;
11110 -- Start of processing for Check_Abstract_Primitives
11113 -- Loop over all of the formal derived type's primitives
11115 Gen_Elmt := First_Elmt (Gen_Prims);
11116 while Present (Gen_Elmt) loop
11117 Gen_Subp := Node (Gen_Elmt);
11119 -- If the primitive of the formal is not abstract, then
11120 -- determine whether there is a corresponding primitive of
11121 -- the actual type that's abstract.
11123 if not Is_Abstract_Subprogram (Gen_Subp) then
11124 Act_Elmt := First_Elmt (Act_Prims);
11125 while Present (Act_Elmt) loop
11126 Act_Subp := Node (Act_Elmt);
11128 -- If we find an abstract primitive of the actual,
11129 -- then we need to test whether it corresponds to the
11130 -- subprogram from which the generic formal primitive
11133 if Is_Abstract_Subprogram (Act_Subp) then
11134 Anc_Subp := Alias (Gen_Subp);
11136 -- Test whether we have a corresponding primitive
11137 -- by comparing names, kinds, formal types, and
11140 if Chars (Anc_Subp) = Chars (Act_Subp)
11141 and then Ekind (Anc_Subp) = Ekind (Act_Subp)
11143 Anc_Formal := First_Formal (Anc_Subp);
11144 Act_Formal := First_Formal (Act_Subp);
11145 while Present (Anc_Formal)
11146 and then Present (Act_Formal)
11148 Anc_F_Type := Etype (Anc_Formal);
11149 Act_F_Type := Etype (Act_Formal);
11151 if Ekind (Anc_F_Type)
11152 = E_Anonymous_Access_Type
11154 Anc_F_Type := Designated_Type (Anc_F_Type);
11156 if Ekind (Act_F_Type)
11157 = E_Anonymous_Access_Type
11160 Designated_Type (Act_F_Type);
11166 Ekind (Act_F_Type) = E_Anonymous_Access_Type
11171 Anc_F_Type := Base_Type (Anc_F_Type);
11172 Act_F_Type := Base_Type (Act_F_Type);
11174 -- If the formal is controlling, then the
11175 -- the type of the actual primitive's formal
11176 -- must be derived directly or indirectly
11177 -- from the type of the ancestor primitive's
11180 if Is_Controlling_Formal (Anc_Formal) then
11181 if not Is_Tagged_Ancestor
11182 (Anc_F_Type, Act_F_Type)
11187 -- Otherwise the types of the formals must
11190 elsif Anc_F_Type /= Act_F_Type then
11194 Next_Entity (Anc_Formal);
11195 Next_Entity (Act_Formal);
11198 -- If we traversed through all of the formals
11199 -- then so far the subprograms correspond, so
11200 -- now check that any result types correspond.
11202 if No (Anc_Formal) and then No (Act_Formal) then
11203 Subprograms_Correspond := True;
11205 if Ekind (Act_Subp) = E_Function then
11206 Anc_F_Type := Etype (Anc_Subp);
11207 Act_F_Type := Etype (Act_Subp);
11209 if Ekind (Anc_F_Type)
11210 = E_Anonymous_Access_Type
11213 Designated_Type (Anc_F_Type);
11215 if Ekind (Act_F_Type)
11216 = E_Anonymous_Access_Type
11219 Designated_Type (Act_F_Type);
11221 Subprograms_Correspond := False;
11226 = E_Anonymous_Access_Type
11228 Subprograms_Correspond := False;
11231 Anc_F_Type := Base_Type (Anc_F_Type);
11232 Act_F_Type := Base_Type (Act_F_Type);
11234 -- Now either the result types must be
11235 -- the same or, if the result type is
11236 -- controlling, the result type of the
11237 -- actual primitive must descend from the
11238 -- result type of the ancestor primitive.
11240 if Subprograms_Correspond
11241 and then Anc_F_Type /= Act_F_Type
11243 Has_Controlling_Result (Anc_Subp)
11245 not Is_Tagged_Ancestor
11246 (Anc_F_Type, Act_F_Type)
11248 Subprograms_Correspond := False;
11252 -- Found a matching subprogram belonging to
11253 -- formal ancestor type, so actual subprogram
11254 -- corresponds and this violates 3.9.3(9).
11256 if Subprograms_Correspond then
11258 ("abstract subprogram & overrides " &
11259 "nonabstract subprogram of ancestor",
11267 Next_Elmt (Act_Elmt);
11271 Next_Elmt (Gen_Elmt);
11273 end Check_Abstract_Primitives;
11276 -- Verify that limitedness matches. If parent is a limited
11277 -- interface then the generic formal is not unless declared
11278 -- explicitly so. If not declared limited, the actual cannot be
11279 -- limited (see AI05-0087).
11281 -- Even though this AI is a binding interpretation, we enable the
11282 -- check only in Ada 2012 mode, because this improper construct
11283 -- shows up in user code and in existing B-tests.
11285 if Is_Limited_Type (Act_T)
11286 and then not Is_Limited_Type (A_Gen_T)
11287 and then Ada_Version >= Ada_2012
11289 if In_Instance then
11293 ("actual for non-limited & cannot be a limited type", Actual,
11295 Explain_Limited_Type (Act_T, Actual);
11296 Abandon_Instantiation (Actual);
11299 end Validate_Derived_Type_Instance;
11301 ----------------------------------------
11302 -- Validate_Discriminated_Formal_Type --
11303 ----------------------------------------
11305 procedure Validate_Discriminated_Formal_Type is
11306 Formal_Discr : Entity_Id;
11307 Actual_Discr : Entity_Id;
11308 Formal_Subt : Entity_Id;
11311 if Has_Discriminants (A_Gen_T) then
11312 if not Has_Discriminants (Act_T) then
11314 ("actual for & must have discriminants", Actual, Gen_T);
11315 Abandon_Instantiation (Actual);
11317 elsif Is_Constrained (Act_T) then
11319 ("actual for & must be unconstrained", Actual, Gen_T);
11320 Abandon_Instantiation (Actual);
11323 Formal_Discr := First_Discriminant (A_Gen_T);
11324 Actual_Discr := First_Discriminant (Act_T);
11325 while Formal_Discr /= Empty loop
11326 if Actual_Discr = Empty then
11328 ("discriminants on actual do not match formal",
11330 Abandon_Instantiation (Actual);
11333 Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
11335 -- Access discriminants match if designated types do
11337 if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
11338 and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
11339 E_Anonymous_Access_Type
11342 (Designated_Type (Base_Type (Formal_Subt))) =
11343 Designated_Type (Base_Type (Etype (Actual_Discr)))
11347 elsif Base_Type (Formal_Subt) /=
11348 Base_Type (Etype (Actual_Discr))
11351 ("types of actual discriminants must match formal",
11353 Abandon_Instantiation (Actual);
11355 elsif not Subtypes_Statically_Match
11356 (Formal_Subt, Etype (Actual_Discr))
11357 and then Ada_Version >= Ada_95
11360 ("subtypes of actual discriminants must match formal",
11362 Abandon_Instantiation (Actual);
11365 Next_Discriminant (Formal_Discr);
11366 Next_Discriminant (Actual_Discr);
11369 if Actual_Discr /= Empty then
11371 ("discriminants on actual do not match formal",
11373 Abandon_Instantiation (Actual);
11377 end Validate_Discriminated_Formal_Type;
11379 ---------------------------------------
11380 -- Validate_Incomplete_Type_Instance --
11381 ---------------------------------------
11383 procedure Validate_Incomplete_Type_Instance is
11385 if not Is_Tagged_Type (Act_T)
11386 and then Is_Tagged_Type (A_Gen_T)
11389 ("actual for & must be a tagged type", Actual, Gen_T);
11392 Validate_Discriminated_Formal_Type;
11393 end Validate_Incomplete_Type_Instance;
11395 --------------------------------------
11396 -- Validate_Interface_Type_Instance --
11397 --------------------------------------
11399 procedure Validate_Interface_Type_Instance is
11401 if not Is_Interface (Act_T) then
11403 ("actual for formal interface type must be an interface",
11406 elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
11408 Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
11410 Is_Protected_Interface (A_Gen_T) /=
11411 Is_Protected_Interface (Act_T)
11413 Is_Synchronized_Interface (A_Gen_T) /=
11414 Is_Synchronized_Interface (Act_T)
11417 ("actual for interface& does not match (RM 12.5.5(4))",
11420 end Validate_Interface_Type_Instance;
11422 ------------------------------------
11423 -- Validate_Private_Type_Instance --
11424 ------------------------------------
11426 procedure Validate_Private_Type_Instance is
11428 if Is_Limited_Type (Act_T)
11429 and then not Is_Limited_Type (A_Gen_T)
11431 if In_Instance then
11435 ("actual for non-limited & cannot be a limited type", Actual,
11437 Explain_Limited_Type (Act_T, Actual);
11438 Abandon_Instantiation (Actual);
11441 elsif Known_To_Have_Preelab_Init (A_Gen_T)
11442 and then not Has_Preelaborable_Initialization (Act_T)
11445 ("actual for & must have preelaborable initialization", Actual,
11448 elsif Is_Indefinite_Subtype (Act_T)
11449 and then not Is_Indefinite_Subtype (A_Gen_T)
11450 and then Ada_Version >= Ada_95
11453 ("actual for & must be a definite subtype", Actual, Gen_T);
11455 elsif not Is_Tagged_Type (Act_T)
11456 and then Is_Tagged_Type (A_Gen_T)
11459 ("actual for & must be a tagged type", Actual, Gen_T);
11462 Validate_Discriminated_Formal_Type;
11464 end Validate_Private_Type_Instance;
11466 -- Start of processing for Instantiate_Type
11469 if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
11470 Error_Msg_N ("duplicate instantiation of generic type", Actual);
11471 return New_List (Error);
11473 elsif not Is_Entity_Name (Actual)
11474 or else not Is_Type (Entity (Actual))
11477 ("expect valid subtype mark to instantiate &", Actual, Gen_T);
11478 Abandon_Instantiation (Actual);
11481 Act_T := Entity (Actual);
11483 -- Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
11484 -- as a generic actual parameter if the corresponding formal type
11485 -- does not have a known_discriminant_part, or is a formal derived
11486 -- type that is an Unchecked_Union type.
11488 if Is_Unchecked_Union (Base_Type (Act_T)) then
11489 if not Has_Discriminants (A_Gen_T)
11491 (Is_Derived_Type (A_Gen_T)
11493 Is_Unchecked_Union (A_Gen_T))
11497 Error_Msg_N ("unchecked union cannot be the actual for a" &
11498 " discriminated formal type", Act_T);
11503 -- Deal with fixed/floating restrictions
11505 if Is_Floating_Point_Type (Act_T) then
11506 Check_Restriction (No_Floating_Point, Actual);
11507 elsif Is_Fixed_Point_Type (Act_T) then
11508 Check_Restriction (No_Fixed_Point, Actual);
11511 -- Deal with error of using incomplete type as generic actual.
11512 -- This includes limited views of a type, even if the non-limited
11513 -- view may be available.
11515 if Ekind (Act_T) = E_Incomplete_Type
11516 or else (Is_Class_Wide_Type (Act_T)
11518 Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
11520 -- If the formal is an incomplete type, the actual can be
11521 -- incomplete as well.
11523 if Ekind (A_Gen_T) = E_Incomplete_Type then
11526 elsif Is_Class_Wide_Type (Act_T)
11527 or else No (Full_View (Act_T))
11529 Error_Msg_N ("premature use of incomplete type", Actual);
11530 Abandon_Instantiation (Actual);
11532 Act_T := Full_View (Act_T);
11533 Set_Entity (Actual, Act_T);
11535 if Has_Private_Component (Act_T) then
11537 ("premature use of type with private component", Actual);
11541 -- Deal with error of premature use of private type as generic actual
11543 elsif Is_Private_Type (Act_T)
11544 and then Is_Private_Type (Base_Type (Act_T))
11545 and then not Is_Generic_Type (Act_T)
11546 and then not Is_Derived_Type (Act_T)
11547 and then No (Full_View (Root_Type (Act_T)))
11549 -- If the formal is an incomplete type, the actual can be
11550 -- private or incomplete as well.
11552 if Ekind (A_Gen_T) = E_Incomplete_Type then
11555 Error_Msg_N ("premature use of private type", Actual);
11558 elsif Has_Private_Component (Act_T) then
11560 ("premature use of type with private component", Actual);
11563 Set_Instance_Of (A_Gen_T, Act_T);
11565 -- If the type is generic, the class-wide type may also be used
11567 if Is_Tagged_Type (A_Gen_T)
11568 and then Is_Tagged_Type (Act_T)
11569 and then not Is_Class_Wide_Type (A_Gen_T)
11571 Set_Instance_Of (Class_Wide_Type (A_Gen_T),
11572 Class_Wide_Type (Act_T));
11575 if not Is_Abstract_Type (A_Gen_T)
11576 and then Is_Abstract_Type (Act_T)
11579 ("actual of non-abstract formal cannot be abstract", Actual);
11582 -- A generic scalar type is a first subtype for which we generate
11583 -- an anonymous base type. Indicate that the instance of this base
11584 -- is the base type of the actual.
11586 if Is_Scalar_Type (A_Gen_T) then
11587 Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
11591 if Error_Posted (Act_T) then
11594 case Nkind (Def) is
11595 when N_Formal_Private_Type_Definition =>
11596 Validate_Private_Type_Instance;
11598 when N_Formal_Incomplete_Type_Definition =>
11599 Validate_Incomplete_Type_Instance;
11601 when N_Formal_Derived_Type_Definition =>
11602 Validate_Derived_Type_Instance;
11604 when N_Formal_Discrete_Type_Definition =>
11605 if not Is_Discrete_Type (Act_T) then
11607 ("expect discrete type in instantiation of&",
11609 Abandon_Instantiation (Actual);
11612 when N_Formal_Signed_Integer_Type_Definition =>
11613 if not Is_Signed_Integer_Type (Act_T) then
11615 ("expect signed integer type in instantiation of&",
11617 Abandon_Instantiation (Actual);
11620 when N_Formal_Modular_Type_Definition =>
11621 if not Is_Modular_Integer_Type (Act_T) then
11623 ("expect modular type in instantiation of &",
11625 Abandon_Instantiation (Actual);
11628 when N_Formal_Floating_Point_Definition =>
11629 if not Is_Floating_Point_Type (Act_T) then
11631 ("expect float type in instantiation of &", Actual, Gen_T);
11632 Abandon_Instantiation (Actual);
11635 when N_Formal_Ordinary_Fixed_Point_Definition =>
11636 if not Is_Ordinary_Fixed_Point_Type (Act_T) then
11638 ("expect ordinary fixed point type in instantiation of &",
11640 Abandon_Instantiation (Actual);
11643 when N_Formal_Decimal_Fixed_Point_Definition =>
11644 if not Is_Decimal_Fixed_Point_Type (Act_T) then
11646 ("expect decimal type in instantiation of &",
11648 Abandon_Instantiation (Actual);
11651 when N_Array_Type_Definition =>
11652 Validate_Array_Type_Instance;
11654 when N_Access_To_Object_Definition =>
11655 Validate_Access_Type_Instance;
11657 when N_Access_Function_Definition |
11658 N_Access_Procedure_Definition =>
11659 Validate_Access_Subprogram_Instance;
11661 when N_Record_Definition =>
11662 Validate_Interface_Type_Instance;
11664 when N_Derived_Type_Definition =>
11665 Validate_Derived_Interface_Type_Instance;
11668 raise Program_Error;
11673 Subt := New_Copy (Gen_T);
11675 -- Use adjusted sloc of subtype name as the location for other nodes in
11676 -- the subtype declaration.
11678 Loc := Sloc (Subt);
11681 Make_Subtype_Declaration (Loc,
11682 Defining_Identifier => Subt,
11683 Subtype_Indication => New_Reference_To (Act_T, Loc));
11685 if Is_Private_Type (Act_T) then
11686 Set_Has_Private_View (Subtype_Indication (Decl_Node));
11688 elsif Is_Access_Type (Act_T)
11689 and then Is_Private_Type (Designated_Type (Act_T))
11691 Set_Has_Private_View (Subtype_Indication (Decl_Node));
11694 Decl_Nodes := New_List (Decl_Node);
11696 -- Flag actual derived types so their elaboration produces the
11697 -- appropriate renamings for the primitive operations of the ancestor.
11698 -- Flag actual for formal private types as well, to determine whether
11699 -- operations in the private part may override inherited operations.
11700 -- If the formal has an interface list, the ancestor is not the
11701 -- parent, but the analyzed formal that includes the interface
11702 -- operations of all its progenitors.
11704 -- Same treatment for formal private types, so we can check whether the
11705 -- type is tagged limited when validating derivations in the private
11706 -- part. (See AI05-096).
11708 if Nkind (Def) = N_Formal_Derived_Type_Definition then
11709 if Present (Interface_List (Def)) then
11710 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11712 Set_Generic_Parent_Type (Decl_Node, Ancestor);
11715 elsif Nkind_In (Def,
11716 N_Formal_Private_Type_Definition,
11717 N_Formal_Incomplete_Type_Definition)
11719 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11722 -- If the actual is a synchronized type that implements an interface,
11723 -- the primitive operations are attached to the corresponding record,
11724 -- and we have to treat it as an additional generic actual, so that its
11725 -- primitive operations become visible in the instance. The task or
11726 -- protected type itself does not carry primitive operations.
11728 if Is_Concurrent_Type (Act_T)
11729 and then Is_Tagged_Type (Act_T)
11730 and then Present (Corresponding_Record_Type (Act_T))
11731 and then Present (Ancestor)
11732 and then Is_Interface (Ancestor)
11735 Corr_Rec : constant Entity_Id :=
11736 Corresponding_Record_Type (Act_T);
11737 New_Corr : Entity_Id;
11738 Corr_Decl : Node_Id;
11741 New_Corr := Make_Temporary (Loc, 'S');
11743 Make_Subtype_Declaration (Loc,
11744 Defining_Identifier => New_Corr,
11745 Subtype_Indication =>
11746 New_Reference_To (Corr_Rec, Loc));
11747 Append_To (Decl_Nodes, Corr_Decl);
11749 if Ekind (Act_T) = E_Task_Type then
11750 Set_Ekind (Subt, E_Task_Subtype);
11752 Set_Ekind (Subt, E_Protected_Subtype);
11755 Set_Corresponding_Record_Type (Subt, Corr_Rec);
11756 Set_Generic_Parent_Type (Corr_Decl, Ancestor);
11757 Set_Generic_Parent_Type (Decl_Node, Empty);
11762 end Instantiate_Type;
11764 ---------------------
11765 -- Is_In_Main_Unit --
11766 ---------------------
11768 function Is_In_Main_Unit (N : Node_Id) return Boolean is
11769 Unum : constant Unit_Number_Type := Get_Source_Unit (N);
11770 Current_Unit : Node_Id;
11773 if Unum = Main_Unit then
11776 -- If the current unit is a subunit then it is either the main unit or
11777 -- is being compiled as part of the main unit.
11779 elsif Nkind (N) = N_Compilation_Unit then
11780 return Nkind (Unit (N)) = N_Subunit;
11783 Current_Unit := Parent (N);
11784 while Present (Current_Unit)
11785 and then Nkind (Current_Unit) /= N_Compilation_Unit
11787 Current_Unit := Parent (Current_Unit);
11790 -- The instantiation node is in the main unit, or else the current node
11791 -- (perhaps as the result of nested instantiations) is in the main unit,
11792 -- or in the declaration of the main unit, which in this last case must
11795 return Unum = Main_Unit
11796 or else Current_Unit = Cunit (Main_Unit)
11797 or else Current_Unit = Library_Unit (Cunit (Main_Unit))
11798 or else (Present (Library_Unit (Current_Unit))
11799 and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
11800 end Is_In_Main_Unit;
11802 ----------------------------
11803 -- Load_Parent_Of_Generic --
11804 ----------------------------
11806 procedure Load_Parent_Of_Generic
11809 Body_Optional : Boolean := False)
11811 Comp_Unit : constant Node_Id := Cunit (Get_Source_Unit (Spec));
11812 Save_Style_Check : constant Boolean := Style_Check;
11813 True_Parent : Node_Id;
11814 Inst_Node : Node_Id;
11816 Previous_Instances : constant Elist_Id := New_Elmt_List;
11818 procedure Collect_Previous_Instances (Decls : List_Id);
11819 -- Collect all instantiations in the given list of declarations, that
11820 -- precede the generic that we need to load. If the bodies of these
11821 -- instantiations are available, we must analyze them, to ensure that
11822 -- the public symbols generated are the same when the unit is compiled
11823 -- to generate code, and when it is compiled in the context of a unit
11824 -- that needs a particular nested instance. This process is applied to
11825 -- both package and subprogram instances.
11827 --------------------------------
11828 -- Collect_Previous_Instances --
11829 --------------------------------
11831 procedure Collect_Previous_Instances (Decls : List_Id) is
11835 Decl := First (Decls);
11836 while Present (Decl) loop
11837 if Sloc (Decl) >= Sloc (Inst_Node) then
11840 -- If Decl is an instantiation, then record it as requiring
11841 -- instantiation of the corresponding body, except if it is an
11842 -- abbreviated instantiation generated internally for conformance
11843 -- checking purposes only for the case of a formal package
11844 -- declared without a box (see Instantiate_Formal_Package). Such
11845 -- an instantiation does not generate any code (the actual code
11846 -- comes from actual) and thus does not need to be analyzed here.
11847 -- If the instantiation appears with a generic package body it is
11848 -- not analyzed here either.
11850 elsif Nkind (Decl) = N_Package_Instantiation
11851 and then not Is_Internal (Defining_Entity (Decl))
11853 Append_Elmt (Decl, Previous_Instances);
11855 -- For a subprogram instantiation, omit instantiations intrinsic
11856 -- operations (Unchecked_Conversions, etc.) that have no bodies.
11858 elsif Nkind_In (Decl, N_Function_Instantiation,
11859 N_Procedure_Instantiation)
11860 and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
11862 Append_Elmt (Decl, Previous_Instances);
11864 elsif Nkind (Decl) = N_Package_Declaration then
11865 Collect_Previous_Instances
11866 (Visible_Declarations (Specification (Decl)));
11867 Collect_Previous_Instances
11868 (Private_Declarations (Specification (Decl)));
11870 -- Previous non-generic bodies may contain instances as well
11872 elsif Nkind (Decl) = N_Package_Body
11873 and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
11875 Collect_Previous_Instances (Declarations (Decl));
11877 elsif Nkind (Decl) = N_Subprogram_Body
11878 and then not Acts_As_Spec (Decl)
11879 and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
11881 Collect_Previous_Instances (Declarations (Decl));
11886 end Collect_Previous_Instances;
11888 -- Start of processing for Load_Parent_Of_Generic
11891 if not In_Same_Source_Unit (N, Spec)
11892 or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
11893 or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
11894 and then not Is_In_Main_Unit (Spec))
11896 -- Find body of parent of spec, and analyze it. A special case arises
11897 -- when the parent is an instantiation, that is to say when we are
11898 -- currently instantiating a nested generic. In that case, there is
11899 -- no separate file for the body of the enclosing instance. Instead,
11900 -- the enclosing body must be instantiated as if it were a pending
11901 -- instantiation, in order to produce the body for the nested generic
11902 -- we require now. Note that in that case the generic may be defined
11903 -- in a package body, the instance defined in the same package body,
11904 -- and the original enclosing body may not be in the main unit.
11906 Inst_Node := Empty;
11908 True_Parent := Parent (Spec);
11909 while Present (True_Parent)
11910 and then Nkind (True_Parent) /= N_Compilation_Unit
11912 if Nkind (True_Parent) = N_Package_Declaration
11914 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
11916 -- Parent is a compilation unit that is an instantiation.
11917 -- Instantiation node has been replaced with package decl.
11919 Inst_Node := Original_Node (True_Parent);
11922 elsif Nkind (True_Parent) = N_Package_Declaration
11923 and then Present (Generic_Parent (Specification (True_Parent)))
11924 and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
11926 -- Parent is an instantiation within another specification.
11927 -- Declaration for instance has been inserted before original
11928 -- instantiation node. A direct link would be preferable?
11930 Inst_Node := Next (True_Parent);
11931 while Present (Inst_Node)
11932 and then Nkind (Inst_Node) /= N_Package_Instantiation
11937 -- If the instance appears within a generic, and the generic
11938 -- unit is defined within a formal package of the enclosing
11939 -- generic, there is no generic body available, and none
11940 -- needed. A more precise test should be used ???
11942 if No (Inst_Node) then
11949 True_Parent := Parent (True_Parent);
11953 -- Case where we are currently instantiating a nested generic
11955 if Present (Inst_Node) then
11956 if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
11958 -- Instantiation node and declaration of instantiated package
11959 -- were exchanged when only the declaration was needed.
11960 -- Restore instantiation node before proceeding with body.
11962 Set_Unit (Parent (True_Parent), Inst_Node);
11965 -- Now complete instantiation of enclosing body, if it appears in
11966 -- some other unit. If it appears in the current unit, the body
11967 -- will have been instantiated already.
11969 if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
11971 -- We need to determine the expander mode to instantiate the
11972 -- enclosing body. Because the generic body we need may use
11973 -- global entities declared in the enclosing package (including
11974 -- aggregates) it is in general necessary to compile this body
11975 -- with expansion enabled, except if we are within a generic
11976 -- package, in which case the usual generic rule applies.
11979 Exp_Status : Boolean := True;
11983 -- Loop through scopes looking for generic package
11985 Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
11986 while Present (Scop)
11987 and then Scop /= Standard_Standard
11989 if Ekind (Scop) = E_Generic_Package then
11990 Exp_Status := False;
11994 Scop := Scope (Scop);
11997 -- Collect previous instantiations in the unit that contains
11998 -- the desired generic.
12000 if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12001 and then not Body_Optional
12005 Info : Pending_Body_Info;
12009 Par := Parent (Inst_Node);
12010 while Present (Par) loop
12011 exit when Nkind (Parent (Par)) = N_Compilation_Unit;
12012 Par := Parent (Par);
12015 pragma Assert (Present (Par));
12017 if Nkind (Par) = N_Package_Body then
12018 Collect_Previous_Instances (Declarations (Par));
12020 elsif Nkind (Par) = N_Package_Declaration then
12021 Collect_Previous_Instances
12022 (Visible_Declarations (Specification (Par)));
12023 Collect_Previous_Instances
12024 (Private_Declarations (Specification (Par)));
12027 -- Enclosing unit is a subprogram body. In this
12028 -- case all instance bodies are processed in order
12029 -- and there is no need to collect them separately.
12034 Decl := First_Elmt (Previous_Instances);
12035 while Present (Decl) loop
12037 (Inst_Node => Node (Decl),
12039 Instance_Spec (Node (Decl)),
12040 Expander_Status => Exp_Status,
12041 Current_Sem_Unit =>
12042 Get_Code_Unit (Sloc (Node (Decl))),
12043 Scope_Suppress => Scope_Suppress,
12044 Local_Suppress_Stack_Top =>
12045 Local_Suppress_Stack_Top,
12046 Version => Ada_Version);
12048 -- Package instance
12051 Nkind (Node (Decl)) = N_Package_Instantiation
12053 Instantiate_Package_Body
12054 (Info, Body_Optional => True);
12056 -- Subprogram instance
12059 -- The instance_spec is the wrapper package,
12060 -- and the subprogram declaration is the last
12061 -- declaration in the wrapper.
12065 (Visible_Declarations
12066 (Specification (Info.Act_Decl)));
12068 Instantiate_Subprogram_Body
12069 (Info, Body_Optional => True);
12077 Instantiate_Package_Body
12079 ((Inst_Node => Inst_Node,
12080 Act_Decl => True_Parent,
12081 Expander_Status => Exp_Status,
12082 Current_Sem_Unit =>
12083 Get_Code_Unit (Sloc (Inst_Node)),
12084 Scope_Suppress => Scope_Suppress,
12085 Local_Suppress_Stack_Top =>
12086 Local_Suppress_Stack_Top,
12087 Version => Ada_Version)),
12088 Body_Optional => Body_Optional);
12092 -- Case where we are not instantiating a nested generic
12095 Opt.Style_Check := False;
12096 Expander_Mode_Save_And_Set (True);
12097 Load_Needed_Body (Comp_Unit, OK);
12098 Opt.Style_Check := Save_Style_Check;
12099 Expander_Mode_Restore;
12102 and then Unit_Requires_Body (Defining_Entity (Spec))
12103 and then not Body_Optional
12106 Bname : constant Unit_Name_Type :=
12107 Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
12110 -- In CodePeer mode, the missing body may make the analysis
12111 -- incomplete, but we do not treat it as fatal.
12113 if CodePeer_Mode then
12117 Error_Msg_Unit_1 := Bname;
12118 Error_Msg_N ("this instantiation requires$!", N);
12119 Error_Msg_File_1 :=
12120 Get_File_Name (Bname, Subunit => False);
12121 Error_Msg_N ("\but file{ was not found!", N);
12122 raise Unrecoverable_Error;
12129 -- If loading parent of the generic caused an instantiation circularity,
12130 -- we abandon compilation at this point, because otherwise in some cases
12131 -- we get into trouble with infinite recursions after this point.
12133 if Circularity_Detected then
12134 raise Unrecoverable_Error;
12136 end Load_Parent_Of_Generic;
12138 ---------------------------------
12139 -- Map_Formal_Package_Entities --
12140 ---------------------------------
12142 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
12147 Set_Instance_Of (Form, Act);
12149 -- Traverse formal and actual package to map the corresponding entities.
12150 -- We skip over internal entities that may be generated during semantic
12151 -- analysis, and find the matching entities by name, given that they
12152 -- must appear in the same order.
12154 E1 := First_Entity (Form);
12155 E2 := First_Entity (Act);
12156 while Present (E1) and then E1 /= First_Private_Entity (Form) loop
12157 -- Could this test be a single condition??? Seems like it could, and
12158 -- isn't FPE (Form) a constant anyway???
12160 if not Is_Internal (E1)
12161 and then Present (Parent (E1))
12162 and then not Is_Class_Wide_Type (E1)
12163 and then not Is_Internal_Name (Chars (E1))
12165 while Present (E2) and then Chars (E2) /= Chars (E1) loop
12172 Set_Instance_Of (E1, E2);
12174 if Is_Type (E1) and then Is_Tagged_Type (E2) then
12175 Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
12178 if Is_Constrained (E1) then
12179 Set_Instance_Of (Base_Type (E1), Base_Type (E2));
12182 if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
12183 Map_Formal_Package_Entities (E1, E2);
12190 end Map_Formal_Package_Entities;
12192 -----------------------
12193 -- Move_Freeze_Nodes --
12194 -----------------------
12196 procedure Move_Freeze_Nodes
12197 (Out_Of : Entity_Id;
12202 Next_Decl : Node_Id;
12203 Next_Node : Node_Id := After;
12206 function Is_Outer_Type (T : Entity_Id) return Boolean;
12207 -- Check whether entity is declared in a scope external to that of the
12210 -------------------
12211 -- Is_Outer_Type --
12212 -------------------
12214 function Is_Outer_Type (T : Entity_Id) return Boolean is
12215 Scop : Entity_Id := Scope (T);
12218 if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12222 while Scop /= Standard_Standard loop
12223 if Scop = Out_Of then
12226 Scop := Scope (Scop);
12234 -- Start of processing for Move_Freeze_Nodes
12241 -- First remove the freeze nodes that may appear before all other
12245 while Present (Decl)
12246 and then Nkind (Decl) = N_Freeze_Entity
12247 and then Is_Outer_Type (Entity (Decl))
12249 Decl := Remove_Head (L);
12250 Insert_After (Next_Node, Decl);
12251 Set_Analyzed (Decl, False);
12256 -- Next scan the list of declarations and remove each freeze node that
12257 -- appears ahead of the current node.
12259 while Present (Decl) loop
12260 while Present (Next (Decl))
12261 and then Nkind (Next (Decl)) = N_Freeze_Entity
12262 and then Is_Outer_Type (Entity (Next (Decl)))
12264 Next_Decl := Remove_Next (Decl);
12265 Insert_After (Next_Node, Next_Decl);
12266 Set_Analyzed (Next_Decl, False);
12267 Next_Node := Next_Decl;
12270 -- If the declaration is a nested package or concurrent type, then
12271 -- recurse. Nested generic packages will have been processed from the
12274 case Nkind (Decl) is
12275 when N_Package_Declaration =>
12276 Spec := Specification (Decl);
12278 when N_Task_Type_Declaration =>
12279 Spec := Task_Definition (Decl);
12281 when N_Protected_Type_Declaration =>
12282 Spec := Protected_Definition (Decl);
12288 if Present (Spec) then
12289 Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
12290 Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
12295 end Move_Freeze_Nodes;
12301 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
12303 return Generic_Renamings.Table (E).Next_In_HTable;
12306 ------------------------
12307 -- Preanalyze_Actuals --
12308 ------------------------
12310 procedure Preanalyze_Actuals (N : Node_Id) is
12313 Errs : constant Int := Serious_Errors_Detected;
12315 Cur : Entity_Id := Empty;
12316 -- Current homograph of the instance name
12319 -- Saved visibility status of the current homograph
12322 Assoc := First (Generic_Associations (N));
12324 -- If the instance is a child unit, its name may hide an outer homonym,
12325 -- so make it invisible to perform name resolution on the actuals.
12327 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
12329 (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
12331 Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
12333 if Is_Compilation_Unit (Cur) then
12334 Vis := Is_Immediately_Visible (Cur);
12335 Set_Is_Immediately_Visible (Cur, False);
12341 while Present (Assoc) loop
12342 if Nkind (Assoc) /= N_Others_Choice then
12343 Act := Explicit_Generic_Actual_Parameter (Assoc);
12345 -- Within a nested instantiation, a defaulted actual is an empty
12346 -- association, so nothing to analyze. If the subprogram actual
12347 -- is an attribute, analyze prefix only, because actual is not a
12348 -- complete attribute reference.
12350 -- If actual is an allocator, analyze expression only. The full
12351 -- analysis can generate code, and if instance is a compilation
12352 -- unit we have to wait until the package instance is installed
12353 -- to have a proper place to insert this code.
12355 -- String literals may be operators, but at this point we do not
12356 -- know whether the actual is a formal subprogram or a string.
12361 elsif Nkind (Act) = N_Attribute_Reference then
12362 Analyze (Prefix (Act));
12364 elsif Nkind (Act) = N_Explicit_Dereference then
12365 Analyze (Prefix (Act));
12367 elsif Nkind (Act) = N_Allocator then
12369 Expr : constant Node_Id := Expression (Act);
12372 if Nkind (Expr) = N_Subtype_Indication then
12373 Analyze (Subtype_Mark (Expr));
12375 -- Analyze separately each discriminant constraint, when
12376 -- given with a named association.
12382 Constr := First (Constraints (Constraint (Expr)));
12383 while Present (Constr) loop
12384 if Nkind (Constr) = N_Discriminant_Association then
12385 Analyze (Expression (Constr));
12399 elsif Nkind (Act) /= N_Operator_Symbol then
12403 -- Ensure that a ghost function does not act as generic actual
12405 if Is_Entity_Name (Act)
12406 and then Is_Ghost_Function (Entity (Act))
12409 ("ghost function & cannot act as generic actual", Act);
12410 Abandon_Instantiation (Act);
12412 elsif Errs /= Serious_Errors_Detected then
12414 -- Do a minimal analysis of the generic, to prevent spurious
12415 -- warnings complaining about the generic being unreferenced,
12416 -- before abandoning the instantiation.
12418 Analyze (Name (N));
12420 if Is_Entity_Name (Name (N))
12421 and then Etype (Name (N)) /= Any_Type
12423 Generate_Reference (Entity (Name (N)), Name (N));
12424 Set_Is_Instantiated (Entity (Name (N)));
12427 if Present (Cur) then
12429 -- For the case of a child instance hiding an outer homonym,
12430 -- provide additional warning which might explain the error.
12432 Set_Is_Immediately_Visible (Cur, Vis);
12433 Error_Msg_NE ("& hides outer unit with the same name??",
12434 N, Defining_Unit_Name (N));
12437 Abandon_Instantiation (Act);
12444 if Present (Cur) then
12445 Set_Is_Immediately_Visible (Cur, Vis);
12447 end Preanalyze_Actuals;
12449 -------------------
12450 -- Remove_Parent --
12451 -------------------
12453 procedure Remove_Parent (In_Body : Boolean := False) is
12454 S : Entity_Id := Current_Scope;
12455 -- S is the scope containing the instantiation just completed. The scope
12456 -- stack contains the parent instances of the instantiation, followed by
12465 -- After child instantiation is complete, remove from scope stack the
12466 -- extra copy of the current scope, and then remove parent instances.
12468 if not In_Body then
12471 while Current_Scope /= S loop
12472 P := Current_Scope;
12473 End_Package_Scope (Current_Scope);
12475 if In_Open_Scopes (P) then
12476 E := First_Entity (P);
12477 while Present (E) loop
12478 Set_Is_Immediately_Visible (E, True);
12482 -- If instantiation is declared in a block, it is the enclosing
12483 -- scope that might be a parent instance. Note that only one
12484 -- block can be involved, because the parent instances have
12485 -- been installed within it.
12487 if Ekind (P) = E_Block then
12488 Cur_P := Scope (P);
12493 if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
12494 -- We are within an instance of some sibling. Retain
12495 -- visibility of parent, for proper subsequent cleanup, and
12496 -- reinstall private declarations as well.
12498 Set_In_Private_Part (P);
12499 Install_Private_Declarations (P);
12502 -- If the ultimate parent is a top-level unit recorded in
12503 -- Instance_Parent_Unit, then reset its visibility to what it was
12504 -- before instantiation. (It's not clear what the purpose is of
12505 -- testing whether Scope (P) is In_Open_Scopes, but that test was
12506 -- present before the ultimate parent test was added.???)
12508 elsif not In_Open_Scopes (Scope (P))
12509 or else (P = Instance_Parent_Unit
12510 and then not Parent_Unit_Visible)
12512 Set_Is_Immediately_Visible (P, False);
12514 -- If the current scope is itself an instantiation of a generic
12515 -- nested within P, and we are in the private part of body of this
12516 -- instantiation, restore the full views of P, that were removed
12517 -- in End_Package_Scope above. This obscure case can occur when a
12518 -- subunit of a generic contains an instance of a child unit of
12519 -- its generic parent unit.
12521 elsif S = Current_Scope and then Is_Generic_Instance (S) then
12523 Par : constant Entity_Id :=
12525 (Specification (Unit_Declaration_Node (S)));
12528 and then P = Scope (Par)
12529 and then (In_Package_Body (S) or else In_Private_Part (S))
12531 Set_In_Private_Part (P);
12532 Install_Private_Declarations (P);
12538 -- Reset visibility of entities in the enclosing scope
12540 Set_Is_Hidden_Open_Scope (Current_Scope, False);
12542 Hidden := First_Elmt (Hidden_Entities);
12543 while Present (Hidden) loop
12544 Set_Is_Immediately_Visible (Node (Hidden), True);
12545 Next_Elmt (Hidden);
12549 -- Each body is analyzed separately, and there is no context that
12550 -- needs preserving from one body instance to the next, so remove all
12551 -- parent scopes that have been installed.
12553 while Present (S) loop
12554 End_Package_Scope (S);
12555 Set_Is_Immediately_Visible (S, False);
12556 S := Current_Scope;
12557 exit when S = Standard_Standard;
12566 procedure Restore_Env is
12567 Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
12570 if No (Current_Instantiated_Parent.Act_Id) then
12571 -- Restore environment after subprogram inlining
12573 Restore_Private_Views (Empty);
12576 Current_Instantiated_Parent := Saved.Instantiated_Parent;
12577 Exchanged_Views := Saved.Exchanged_Views;
12578 Hidden_Entities := Saved.Hidden_Entities;
12579 Current_Sem_Unit := Saved.Current_Sem_Unit;
12580 Parent_Unit_Visible := Saved.Parent_Unit_Visible;
12581 Instance_Parent_Unit := Saved.Instance_Parent_Unit;
12583 Restore_Opt_Config_Switches (Saved.Switches);
12585 Instance_Envs.Decrement_Last;
12588 ---------------------------
12589 -- Restore_Private_Views --
12590 ---------------------------
12592 procedure Restore_Private_Views
12593 (Pack_Id : Entity_Id;
12594 Is_Package : Boolean := True)
12599 Dep_Elmt : Elmt_Id;
12602 procedure Restore_Nested_Formal (Formal : Entity_Id);
12603 -- Hide the generic formals of formal packages declared with box which
12604 -- were reachable in the current instantiation.
12606 ---------------------------
12607 -- Restore_Nested_Formal --
12608 ---------------------------
12610 procedure Restore_Nested_Formal (Formal : Entity_Id) is
12614 if Present (Renamed_Object (Formal))
12615 and then Denotes_Formal_Package (Renamed_Object (Formal), True)
12619 elsif Present (Associated_Formal_Package (Formal)) then
12620 Ent := First_Entity (Formal);
12621 while Present (Ent) loop
12622 exit when Ekind (Ent) = E_Package
12623 and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
12625 Set_Is_Hidden (Ent);
12626 Set_Is_Potentially_Use_Visible (Ent, False);
12628 -- If package, then recurse
12630 if Ekind (Ent) = E_Package then
12631 Restore_Nested_Formal (Ent);
12637 end Restore_Nested_Formal;
12639 -- Start of processing for Restore_Private_Views
12642 M := First_Elmt (Exchanged_Views);
12643 while Present (M) loop
12646 -- Subtypes of types whose views have been exchanged, and that are
12647 -- defined within the instance, were not on the Private_Dependents
12648 -- list on entry to the instance, so they have to be exchanged
12649 -- explicitly now, in order to remain consistent with the view of the
12652 if Ekind_In (Typ, E_Private_Type,
12653 E_Limited_Private_Type,
12654 E_Record_Type_With_Private)
12656 Dep_Elmt := First_Elmt (Private_Dependents (Typ));
12657 while Present (Dep_Elmt) loop
12658 Dep_Typ := Node (Dep_Elmt);
12660 if Scope (Dep_Typ) = Pack_Id
12661 and then Present (Full_View (Dep_Typ))
12663 Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
12664 Exchange_Declarations (Dep_Typ);
12667 Next_Elmt (Dep_Elmt);
12671 Exchange_Declarations (Node (M));
12675 if No (Pack_Id) then
12679 -- Make the generic formal parameters private, and make the formal types
12680 -- into subtypes of the actuals again.
12682 E := First_Entity (Pack_Id);
12683 while Present (E) loop
12684 Set_Is_Hidden (E, True);
12687 and then Nkind (Parent (E)) = N_Subtype_Declaration
12689 -- If the actual for E is itself a generic actual type from
12690 -- an enclosing instance, E is still a generic actual type
12691 -- outside of the current instance. This matter when resolving
12692 -- an overloaded call that may be ambiguous in the enclosing
12693 -- instance, when two of its actuals coincide.
12695 if Is_Entity_Name (Subtype_Indication (Parent (E)))
12696 and then Is_Generic_Actual_Type
12697 (Entity (Subtype_Indication (Parent (E))))
12701 Set_Is_Generic_Actual_Type (E, False);
12704 -- An unusual case of aliasing: the actual may also be directly
12705 -- visible in the generic, and be private there, while it is fully
12706 -- visible in the context of the instance. The internal subtype
12707 -- is private in the instance but has full visibility like its
12708 -- parent in the enclosing scope. This enforces the invariant that
12709 -- the privacy status of all private dependents of a type coincide
12710 -- with that of the parent type. This can only happen when a
12711 -- generic child unit is instantiated within a sibling.
12713 if Is_Private_Type (E)
12714 and then not Is_Private_Type (Etype (E))
12716 Exchange_Declarations (E);
12719 elsif Ekind (E) = E_Package then
12721 -- The end of the renaming list is the renaming of the generic
12722 -- package itself. If the instance is a subprogram, all entities
12723 -- in the corresponding package are renamings. If this entity is
12724 -- a formal package, make its own formals private as well. The
12725 -- actual in this case is itself the renaming of an instantiation.
12726 -- If the entity is not a package renaming, it is the entity
12727 -- created to validate formal package actuals: ignore it.
12729 -- If the actual is itself a formal package for the enclosing
12730 -- generic, or the actual for such a formal package, it remains
12731 -- visible on exit from the instance, and therefore nothing needs
12732 -- to be done either, except to keep it accessible.
12734 if Is_Package and then Renamed_Object (E) = Pack_Id then
12737 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
12741 Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
12743 Set_Is_Hidden (E, False);
12747 Act_P : constant Entity_Id := Renamed_Object (E);
12751 Id := First_Entity (Act_P);
12753 and then Id /= First_Private_Entity (Act_P)
12755 exit when Ekind (Id) = E_Package
12756 and then Renamed_Object (Id) = Act_P;
12758 Set_Is_Hidden (Id, True);
12759 Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
12761 if Ekind (Id) = E_Package then
12762 Restore_Nested_Formal (Id);
12773 end Restore_Private_Views;
12780 (Gen_Unit : Entity_Id;
12781 Act_Unit : Entity_Id)
12785 Set_Instance_Env (Gen_Unit, Act_Unit);
12788 ----------------------------
12789 -- Save_Global_References --
12790 ----------------------------
12792 procedure Save_Global_References (N : Node_Id) is
12793 Gen_Scope : Entity_Id;
12797 function Is_Global (E : Entity_Id) return Boolean;
12798 -- Check whether entity is defined outside of generic unit. Examine the
12799 -- scope of an entity, and the scope of the scope, etc, until we find
12800 -- either Standard, in which case the entity is global, or the generic
12801 -- unit itself, which indicates that the entity is local. If the entity
12802 -- is the generic unit itself, as in the case of a recursive call, or
12803 -- the enclosing generic unit, if different from the current scope, then
12804 -- it is local as well, because it will be replaced at the point of
12805 -- instantiation. On the other hand, if it is a reference to a child
12806 -- unit of a common ancestor, which appears in an instantiation, it is
12807 -- global because it is used to denote a specific compilation unit at
12808 -- the time the instantiations will be analyzed.
12810 procedure Reset_Entity (N : Node_Id);
12811 -- Save semantic information on global entity so that it is not resolved
12812 -- again at instantiation time.
12814 procedure Save_Entity_Descendants (N : Node_Id);
12815 -- Apply Save_Global_References to the two syntactic descendants of
12816 -- non-terminal nodes that carry an Associated_Node and are processed
12817 -- through Reset_Entity. Once the global entity (if any) has been
12818 -- captured together with its type, only two syntactic descendants need
12819 -- to be traversed to complete the processing of the tree rooted at N.
12820 -- This applies to Selected_Components, Expanded_Names, and to Operator
12821 -- nodes. N can also be a character literal, identifier, or operator
12822 -- symbol node, but the call has no effect in these cases.
12824 procedure Save_Global_Defaults (N1, N2 : Node_Id);
12825 -- Default actuals in nested instances must be handled specially
12826 -- because there is no link to them from the original tree. When an
12827 -- actual subprogram is given by a default, we add an explicit generic
12828 -- association for it in the instantiation node. When we save the
12829 -- global references on the name of the instance, we recover the list
12830 -- of generic associations, and add an explicit one to the original
12831 -- generic tree, through which a global actual can be preserved.
12832 -- Similarly, if a child unit is instantiated within a sibling, in the
12833 -- context of the parent, we must preserve the identifier of the parent
12834 -- so that it can be properly resolved in a subsequent instantiation.
12836 procedure Save_Global_Descendant (D : Union_Id);
12837 -- Apply Save_Global_References recursively to the descendents of the
12840 procedure Save_References (N : Node_Id);
12841 -- This is the recursive procedure that does the work, once the
12842 -- enclosing generic scope has been established.
12848 function Is_Global (E : Entity_Id) return Boolean is
12851 function Is_Instance_Node (Decl : Node_Id) return Boolean;
12852 -- Determine whether the parent node of a reference to a child unit
12853 -- denotes an instantiation or a formal package, in which case the
12854 -- reference to the child unit is global, even if it appears within
12855 -- the current scope (e.g. when the instance appears within the body
12856 -- of an ancestor).
12858 ----------------------
12859 -- Is_Instance_Node --
12860 ----------------------
12862 function Is_Instance_Node (Decl : Node_Id) return Boolean is
12864 return Nkind (Decl) in N_Generic_Instantiation
12866 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
12867 end Is_Instance_Node;
12869 -- Start of processing for Is_Global
12872 if E = Gen_Scope then
12875 elsif E = Standard_Standard then
12878 elsif Is_Child_Unit (E)
12879 and then (Is_Instance_Node (Parent (N2))
12880 or else (Nkind (Parent (N2)) = N_Expanded_Name
12881 and then N2 = Selector_Name (Parent (N2))
12883 Is_Instance_Node (Parent (Parent (N2)))))
12889 while Se /= Gen_Scope loop
12890 if Se = Standard_Standard then
12905 procedure Reset_Entity (N : Node_Id) is
12907 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
12908 -- If the type of N2 is global to the generic unit, save the type in
12909 -- the generic node. Just as we perform name capture for explicit
12910 -- references within the generic, we must capture the global types
12911 -- of local entities because they may participate in resolution in
12914 function Top_Ancestor (E : Entity_Id) return Entity_Id;
12915 -- Find the ultimate ancestor of the current unit. If it is not a
12916 -- generic unit, then the name of the current unit in the prefix of
12917 -- an expanded name must be replaced with its generic homonym to
12918 -- ensure that it will be properly resolved in an instance.
12920 ---------------------
12921 -- Set_Global_Type --
12922 ---------------------
12924 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
12925 Typ : constant Entity_Id := Etype (N2);
12928 Set_Etype (N, Typ);
12930 if Entity (N) /= N2
12931 and then Has_Private_View (Entity (N))
12933 -- If the entity of N is not the associated node, this is a
12934 -- nested generic and it has an associated node as well, whose
12935 -- type is already the full view (see below). Indicate that the
12936 -- original node has a private view.
12938 Set_Has_Private_View (N);
12941 -- If not a private type, nothing else to do
12943 if not Is_Private_Type (Typ) then
12944 if Is_Array_Type (Typ)
12945 and then Is_Private_Type (Component_Type (Typ))
12947 Set_Has_Private_View (N);
12950 -- If it is a derivation of a private type in a context where no
12951 -- full view is needed, nothing to do either.
12953 elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
12956 -- Otherwise mark the type for flipping and use the full view when
12960 Set_Has_Private_View (N);
12962 if Present (Full_View (Typ)) then
12963 Set_Etype (N2, Full_View (Typ));
12966 end Set_Global_Type;
12972 function Top_Ancestor (E : Entity_Id) return Entity_Id is
12977 while Is_Child_Unit (Par) loop
12978 Par := Scope (Par);
12984 -- Start of processing for Reset_Entity
12987 N2 := Get_Associated_Node (N);
12990 if Present (E) then
12992 -- If the node is an entry call to an entry in an enclosing task,
12993 -- it is rewritten as a selected component. No global entity to
12994 -- preserve in this case, since the expansion will be redone in
12997 if not Nkind_In (E, N_Defining_Identifier,
12998 N_Defining_Character_Literal,
12999 N_Defining_Operator_Symbol)
13001 Set_Associated_Node (N, Empty);
13002 Set_Etype (N, Empty);
13006 -- If the entity is an itype created as a subtype of an access
13007 -- type with a null exclusion restore source entity for proper
13008 -- visibility. The itype will be created anew in the instance.
13011 and then Ekind (E) = E_Access_Subtype
13012 and then Is_Entity_Name (N)
13013 and then Chars (Etype (E)) = Chars (N)
13016 Set_Entity (N2, E);
13020 if Is_Global (E) then
13022 -- If the entity is a package renaming that is the prefix of
13023 -- an expanded name, it has been rewritten as the renamed
13024 -- package, which is necessary semantically but complicates
13025 -- ASIS tree traversal, so we recover the original entity to
13026 -- expose the renaming. Take into account that the context may
13027 -- be a nested generic and that the original node may itself
13028 -- have an associated node.
13030 if Ekind (E) = E_Package
13031 and then Nkind (Parent (N)) = N_Expanded_Name
13032 and then Present (Original_Node (N2))
13033 and then Present (Entity (Original_Node (N2)))
13034 and then Is_Entity_Name (Entity (Original_Node (N2)))
13036 if Is_Global (Entity (Original_Node (N2))) then
13037 N2 := Original_Node (N2);
13038 Set_Associated_Node (N, N2);
13039 Set_Global_Type (N, N2);
13042 -- Renaming is local, and will be resolved in instance
13044 Set_Associated_Node (N, Empty);
13045 Set_Etype (N, Empty);
13049 Set_Global_Type (N, N2);
13052 elsif Nkind (N) = N_Op_Concat
13053 and then Is_Generic_Type (Etype (N2))
13054 and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
13056 Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
13057 and then Is_Intrinsic_Subprogram (E)
13062 -- Entity is local. Mark generic node as unresolved.
13063 -- Note that now it does not have an entity.
13065 Set_Associated_Node (N, Empty);
13066 Set_Etype (N, Empty);
13069 if Nkind (Parent (N)) in N_Generic_Instantiation
13070 and then N = Name (Parent (N))
13072 Save_Global_Defaults (Parent (N), Parent (N2));
13075 elsif Nkind (Parent (N)) = N_Selected_Component
13076 and then Nkind (Parent (N2)) = N_Expanded_Name
13078 if Is_Global (Entity (Parent (N2))) then
13079 Change_Selected_Component_To_Expanded_Name (Parent (N));
13080 Set_Associated_Node (Parent (N), Parent (N2));
13081 Set_Global_Type (Parent (N), Parent (N2));
13082 Save_Entity_Descendants (N);
13084 -- If this is a reference to the current generic entity, replace
13085 -- by the name of the generic homonym of the current package. This
13086 -- is because in an instantiation Par.P.Q will not resolve to the
13087 -- name of the instance, whose enclosing scope is not necessarily
13088 -- Par. We use the generic homonym rather that the name of the
13089 -- generic itself because it may be hidden by a local declaration.
13091 elsif In_Open_Scopes (Entity (Parent (N2)))
13093 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
13095 if Ekind (Entity (Parent (N2))) = E_Generic_Package then
13096 Rewrite (Parent (N),
13097 Make_Identifier (Sloc (N),
13099 Chars (Generic_Homonym (Entity (Parent (N2))))));
13101 Rewrite (Parent (N),
13102 Make_Identifier (Sloc (N),
13103 Chars => Chars (Selector_Name (Parent (N2)))));
13107 if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
13108 and then Parent (N) = Name (Parent (Parent (N)))
13110 Save_Global_Defaults
13111 (Parent (Parent (N)), Parent (Parent ((N2))));
13114 -- A selected component may denote a static constant that has been
13115 -- folded. If the static constant is global to the generic, capture
13116 -- its value. Otherwise the folding will happen in any instantiation.
13118 elsif Nkind (Parent (N)) = N_Selected_Component
13119 and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
13121 if Present (Entity (Original_Node (Parent (N2))))
13122 and then Is_Global (Entity (Original_Node (Parent (N2))))
13124 Rewrite (Parent (N), New_Copy (Parent (N2)));
13125 Set_Analyzed (Parent (N), False);
13131 -- A selected component may be transformed into a parameterless
13132 -- function call. If the called entity is global, rewrite the node
13133 -- appropriately, i.e. as an extended name for the global entity.
13135 elsif Nkind (Parent (N)) = N_Selected_Component
13136 and then Nkind (Parent (N2)) = N_Function_Call
13137 and then N = Selector_Name (Parent (N))
13139 if No (Parameter_Associations (Parent (N2))) then
13140 if Is_Global (Entity (Name (Parent (N2)))) then
13141 Change_Selected_Component_To_Expanded_Name (Parent (N));
13142 Set_Associated_Node (Parent (N), Name (Parent (N2)));
13143 Set_Global_Type (Parent (N), Name (Parent (N2)));
13144 Save_Entity_Descendants (N);
13147 Set_Is_Prefixed_Call (Parent (N));
13148 Set_Associated_Node (N, Empty);
13149 Set_Etype (N, Empty);
13152 -- In Ada 2005, X.F may be a call to a primitive operation,
13153 -- rewritten as F (X). This rewriting will be done again in an
13154 -- instance, so keep the original node. Global entities will be
13155 -- captured as for other constructs. Indicate that this must
13156 -- resolve as a call, to prevent accidental overloading in the
13157 -- instance, if both a component and a primitive operation appear
13161 Set_Is_Prefixed_Call (Parent (N));
13164 -- Entity is local. Reset in generic unit, so that node is resolved
13165 -- anew at the point of instantiation.
13168 Set_Associated_Node (N, Empty);
13169 Set_Etype (N, Empty);
13173 -----------------------------
13174 -- Save_Entity_Descendants --
13175 -----------------------------
13177 procedure Save_Entity_Descendants (N : Node_Id) is
13180 when N_Binary_Op =>
13181 Save_Global_Descendant (Union_Id (Left_Opnd (N)));
13182 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13185 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13187 when N_Expanded_Name | N_Selected_Component =>
13188 Save_Global_Descendant (Union_Id (Prefix (N)));
13189 Save_Global_Descendant (Union_Id (Selector_Name (N)));
13191 when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
13195 raise Program_Error;
13197 end Save_Entity_Descendants;
13199 --------------------------
13200 -- Save_Global_Defaults --
13201 --------------------------
13203 procedure Save_Global_Defaults (N1, N2 : Node_Id) is
13204 Loc : constant Source_Ptr := Sloc (N1);
13205 Assoc2 : constant List_Id := Generic_Associations (N2);
13206 Gen_Id : constant Entity_Id := Get_Generic_Entity (N2);
13213 Actual : Entity_Id;
13216 Assoc1 := Generic_Associations (N1);
13218 if Present (Assoc1) then
13219 Act1 := First (Assoc1);
13222 Set_Generic_Associations (N1, New_List);
13223 Assoc1 := Generic_Associations (N1);
13226 if Present (Assoc2) then
13227 Act2 := First (Assoc2);
13232 while Present (Act1) and then Present (Act2) loop
13237 -- Find the associations added for default subprograms
13239 if Present (Act2) then
13240 while Nkind (Act2) /= N_Generic_Association
13241 or else No (Entity (Selector_Name (Act2)))
13242 or else not Is_Overloadable (Entity (Selector_Name (Act2)))
13247 -- Add a similar association if the default is global. The
13248 -- renaming declaration for the actual has been analyzed, and
13249 -- its alias is the program it renames. Link the actual in the
13250 -- original generic tree with the node in the analyzed tree.
13252 while Present (Act2) loop
13253 Subp := Entity (Selector_Name (Act2));
13254 Def := Explicit_Generic_Actual_Parameter (Act2);
13256 -- Following test is defence against rubbish errors
13258 if No (Alias (Subp)) then
13262 -- Retrieve the resolved actual from the renaming declaration
13263 -- created for the instantiated formal.
13265 Actual := Entity (Name (Parent (Parent (Subp))));
13266 Set_Entity (Def, Actual);
13267 Set_Etype (Def, Etype (Actual));
13269 if Is_Global (Actual) then
13271 Make_Generic_Association (Loc,
13272 Selector_Name => New_Occurrence_Of (Subp, Loc),
13273 Explicit_Generic_Actual_Parameter =>
13274 New_Occurrence_Of (Actual, Loc));
13276 Set_Associated_Node
13277 (Explicit_Generic_Actual_Parameter (Ndec), Def);
13279 Append (Ndec, Assoc1);
13281 -- If there are other defaults, add a dummy association in case
13282 -- there are other defaulted formals with the same name.
13284 elsif Present (Next (Act2)) then
13286 Make_Generic_Association (Loc,
13287 Selector_Name => New_Occurrence_Of (Subp, Loc),
13288 Explicit_Generic_Actual_Parameter => Empty);
13290 Append (Ndec, Assoc1);
13297 if Nkind (Name (N1)) = N_Identifier
13298 and then Is_Child_Unit (Gen_Id)
13299 and then Is_Global (Gen_Id)
13300 and then Is_Generic_Unit (Scope (Gen_Id))
13301 and then In_Open_Scopes (Scope (Gen_Id))
13303 -- This is an instantiation of a child unit within a sibling, so
13304 -- that the generic parent is in scope. An eventual instance must
13305 -- occur within the scope of an instance of the parent. Make name
13306 -- in instance into an expanded name, to preserve the identifier
13307 -- of the parent, so it can be resolved subsequently.
13309 Rewrite (Name (N2),
13310 Make_Expanded_Name (Loc,
13311 Chars => Chars (Gen_Id),
13312 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13313 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13314 Set_Entity (Name (N2), Gen_Id);
13316 Rewrite (Name (N1),
13317 Make_Expanded_Name (Loc,
13318 Chars => Chars (Gen_Id),
13319 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13320 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13322 Set_Associated_Node (Name (N1), Name (N2));
13323 Set_Associated_Node (Prefix (Name (N1)), Empty);
13324 Set_Associated_Node
13325 (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
13326 Set_Etype (Name (N1), Etype (Gen_Id));
13329 end Save_Global_Defaults;
13331 ----------------------------
13332 -- Save_Global_Descendant --
13333 ----------------------------
13335 procedure Save_Global_Descendant (D : Union_Id) is
13339 if D in Node_Range then
13340 if D = Union_Id (Empty) then
13343 elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
13344 Save_References (Node_Id (D));
13347 elsif D in List_Range then
13348 if D = Union_Id (No_List)
13349 or else Is_Empty_List (List_Id (D))
13354 N1 := First (List_Id (D));
13355 while Present (N1) loop
13356 Save_References (N1);
13361 -- Element list or other non-node field, nothing to do
13366 end Save_Global_Descendant;
13368 ---------------------
13369 -- Save_References --
13370 ---------------------
13372 -- This is the recursive procedure that does the work once the enclosing
13373 -- generic scope has been established. We have to treat specially a
13374 -- number of node rewritings that are required by semantic processing
13375 -- and which change the kind of nodes in the generic copy: typically
13376 -- constant-folding, replacing an operator node by a string literal, or
13377 -- a selected component by an expanded name. In each of those cases, the
13378 -- transformation is propagated to the generic unit.
13380 procedure Save_References (N : Node_Id) is
13381 Loc : constant Source_Ptr := Sloc (N);
13387 elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
13388 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13391 elsif Nkind (N) = N_Operator_Symbol
13392 and then Nkind (Get_Associated_Node (N)) = N_String_Literal
13394 Change_Operator_Symbol_To_String_Literal (N);
13397 elsif Nkind (N) in N_Op then
13398 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13399 if Nkind (N) = N_Op_Concat then
13400 Set_Is_Component_Left_Opnd (N,
13401 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13403 Set_Is_Component_Right_Opnd (N,
13404 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13410 -- Node may be transformed into call to a user-defined operator
13412 N2 := Get_Associated_Node (N);
13414 if Nkind (N2) = N_Function_Call then
13415 E := Entity (Name (N2));
13418 and then Is_Global (E)
13420 Set_Etype (N, Etype (N2));
13422 Set_Associated_Node (N, Empty);
13423 Set_Etype (N, Empty);
13426 elsif Nkind_In (N2, N_Integer_Literal,
13430 if Present (Original_Node (N2))
13431 and then Nkind (Original_Node (N2)) = Nkind (N)
13434 -- Operation was constant-folded. Whenever possible,
13435 -- recover semantic information from unfolded node,
13438 Set_Associated_Node (N, Original_Node (N2));
13440 if Nkind (N) = N_Op_Concat then
13441 Set_Is_Component_Left_Opnd (N,
13442 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13443 Set_Is_Component_Right_Opnd (N,
13444 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13450 -- If original node is already modified, propagate
13451 -- constant-folding to template.
13453 Rewrite (N, New_Copy (N2));
13454 Set_Analyzed (N, False);
13457 elsif Nkind (N2) = N_Identifier
13458 and then Ekind (Entity (N2)) = E_Enumeration_Literal
13460 -- Same if call was folded into a literal, but in this case
13461 -- retain the entity to avoid spurious ambiguities if it is
13462 -- overloaded at the point of instantiation or inlining.
13464 Rewrite (N, New_Copy (N2));
13465 Set_Analyzed (N, False);
13469 -- Complete operands check if node has not been constant-folded
13471 if Nkind (N) in N_Op then
13472 Save_Entity_Descendants (N);
13475 elsif Nkind (N) = N_Identifier then
13476 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13478 -- If this is a discriminant reference, always save it. It is
13479 -- used in the instance to find the corresponding discriminant
13480 -- positionally rather than by name.
13482 Set_Original_Discriminant
13483 (N, Original_Discriminant (Get_Associated_Node (N)));
13487 N2 := Get_Associated_Node (N);
13489 if Nkind (N2) = N_Function_Call then
13490 E := Entity (Name (N2));
13492 -- Name resolves to a call to parameterless function. If
13493 -- original entity is global, mark node as resolved.
13496 and then Is_Global (E)
13498 Set_Etype (N, Etype (N2));
13500 Set_Associated_Node (N, Empty);
13501 Set_Etype (N, Empty);
13504 elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
13505 and then Is_Entity_Name (Original_Node (N2))
13507 -- Name resolves to named number that is constant-folded,
13508 -- We must preserve the original name for ASIS use, and
13509 -- undo the constant-folding, which will be repeated in
13512 Set_Associated_Node (N, Original_Node (N2));
13515 elsif Nkind (N2) = N_String_Literal then
13517 -- Name resolves to string literal. Perform the same
13518 -- replacement in generic.
13520 Rewrite (N, New_Copy (N2));
13522 elsif Nkind (N2) = N_Explicit_Dereference then
13524 -- An identifier is rewritten as a dereference if it is the
13525 -- prefix in an implicit dereference (call or attribute).
13526 -- The analysis of an instantiation will expand the node
13527 -- again, so we preserve the original tree but link it to
13528 -- the resolved entity in case it is global.
13530 if Is_Entity_Name (Prefix (N2))
13531 and then Present (Entity (Prefix (N2)))
13532 and then Is_Global (Entity (Prefix (N2)))
13534 Set_Associated_Node (N, Prefix (N2));
13536 elsif Nkind (Prefix (N2)) = N_Function_Call
13537 and then Is_Global (Entity (Name (Prefix (N2))))
13540 Make_Explicit_Dereference (Loc,
13541 Prefix => Make_Function_Call (Loc,
13543 New_Occurrence_Of (Entity (Name (Prefix (N2))),
13547 Set_Associated_Node (N, Empty);
13548 Set_Etype (N, Empty);
13551 -- The subtype mark of a nominally unconstrained object is
13552 -- rewritten as a subtype indication using the bounds of the
13553 -- expression. Recover the original subtype mark.
13555 elsif Nkind (N2) = N_Subtype_Indication
13556 and then Is_Entity_Name (Original_Node (N2))
13558 Set_Associated_Node (N, Original_Node (N2));
13566 elsif Nkind (N) in N_Entity then
13571 Qual : Node_Id := Empty;
13572 Typ : Entity_Id := Empty;
13575 use Atree.Unchecked_Access;
13576 -- This code section is part of implementing an untyped tree
13577 -- traversal, so it needs direct access to node fields.
13580 if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
13581 N2 := Get_Associated_Node (N);
13588 -- In an instance within a generic, use the name of the
13589 -- actual and not the original generic parameter. If the
13590 -- actual is global in the current generic it must be
13591 -- preserved for its instantiation.
13593 if Nkind (Parent (Typ)) = N_Subtype_Declaration
13595 Present (Generic_Parent_Type (Parent (Typ)))
13597 Typ := Base_Type (Typ);
13598 Set_Etype (N2, Typ);
13604 or else not Is_Global (Typ)
13606 Set_Associated_Node (N, Empty);
13608 -- If the aggregate is an actual in a call, it has been
13609 -- resolved in the current context, to some local type.
13610 -- The enclosing call may have been disambiguated by the
13611 -- aggregate, and this disambiguation might fail at
13612 -- instantiation time because the type to which the
13613 -- aggregate did resolve is not preserved. In order to
13614 -- preserve some of this information, we wrap the
13615 -- aggregate in a qualified expression, using the id of
13616 -- its type. For further disambiguation we qualify the
13617 -- type name with its scope (if visible) because both
13618 -- id's will have corresponding entities in an instance.
13619 -- This resolves most of the problems with missing type
13620 -- information on aggregates in instances.
13622 if Nkind (N2) = Nkind (N)
13623 and then Nkind (Parent (N2)) in N_Subprogram_Call
13624 and then Comes_From_Source (Typ)
13626 if Is_Immediately_Visible (Scope (Typ)) then
13627 Nam := Make_Selected_Component (Loc,
13629 Make_Identifier (Loc, Chars (Scope (Typ))),
13631 Make_Identifier (Loc, Chars (Typ)));
13633 Nam := Make_Identifier (Loc, Chars (Typ));
13637 Make_Qualified_Expression (Loc,
13638 Subtype_Mark => Nam,
13639 Expression => Relocate_Node (N));
13643 Save_Global_Descendant (Field1 (N));
13644 Save_Global_Descendant (Field2 (N));
13645 Save_Global_Descendant (Field3 (N));
13646 Save_Global_Descendant (Field5 (N));
13648 if Present (Qual) then
13652 -- All other cases than aggregates
13655 Save_Global_Descendant (Field1 (N));
13656 Save_Global_Descendant (Field2 (N));
13657 Save_Global_Descendant (Field3 (N));
13658 Save_Global_Descendant (Field4 (N));
13659 Save_Global_Descendant (Field5 (N));
13664 -- If a node has aspects, references within their expressions must
13665 -- be saved separately, given that they are not directly in the
13668 if Has_Aspects (N) then
13672 Aspect := First (Aspect_Specifications (N));
13673 while Present (Aspect) loop
13674 Save_Global_References (Expression (Aspect));
13679 end Save_References;
13681 -- Start of processing for Save_Global_References
13684 Gen_Scope := Current_Scope;
13686 -- If the generic unit is a child unit, references to entities in the
13687 -- parent are treated as local, because they will be resolved anew in
13688 -- the context of the instance of the parent.
13690 while Is_Child_Unit (Gen_Scope)
13691 and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
13693 Gen_Scope := Scope (Gen_Scope);
13696 Save_References (N);
13697 end Save_Global_References;
13699 --------------------------------------
13700 -- Set_Copied_Sloc_For_Inlined_Body --
13701 --------------------------------------
13703 procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
13705 Create_Instantiation_Source (N, E, True, S_Adjustment);
13706 end Set_Copied_Sloc_For_Inlined_Body;
13708 ---------------------
13709 -- Set_Instance_Of --
13710 ---------------------
13712 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
13714 Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
13715 Generic_Renamings_HTable.Set (Generic_Renamings.Last);
13716 Generic_Renamings.Increment_Last;
13717 end Set_Instance_Of;
13719 --------------------
13720 -- Set_Next_Assoc --
13721 --------------------
13723 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
13725 Generic_Renamings.Table (E).Next_In_HTable := Next;
13726 end Set_Next_Assoc;
13728 -------------------
13729 -- Start_Generic --
13730 -------------------
13732 procedure Start_Generic is
13734 -- ??? More things could be factored out in this routine.
13735 -- Should probably be done at a later stage.
13737 Generic_Flags.Append (Inside_A_Generic);
13738 Inside_A_Generic := True;
13740 Expander_Mode_Save_And_Set (False);
13743 ----------------------
13744 -- Set_Instance_Env --
13745 ----------------------
13747 procedure Set_Instance_Env
13748 (Gen_Unit : Entity_Id;
13749 Act_Unit : Entity_Id)
13752 -- Regardless of the current mode, predefined units are analyzed in the
13753 -- most current Ada mode, and earlier version Ada checks do not apply
13754 -- to predefined units. Nothing needs to be done for non-internal units.
13755 -- These are always analyzed in the current mode.
13757 if Is_Internal_File_Name
13758 (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
13759 Renamings_Included => True)
13761 Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
13764 Current_Instantiated_Parent :=
13765 (Gen_Id => Gen_Unit,
13766 Act_Id => Act_Unit,
13767 Next_In_HTable => Assoc_Null);
13768 end Set_Instance_Env;
13774 procedure Switch_View (T : Entity_Id) is
13775 BT : constant Entity_Id := Base_Type (T);
13776 Priv_Elmt : Elmt_Id := No_Elmt;
13777 Priv_Sub : Entity_Id;
13780 -- T may be private but its base type may have been exchanged through
13781 -- some other occurrence, in which case there is nothing to switch
13782 -- besides T itself. Note that a private dependent subtype of a private
13783 -- type might not have been switched even if the base type has been,
13784 -- because of the last branch of Check_Private_View (see comment there).
13786 if not Is_Private_Type (BT) then
13787 Prepend_Elmt (Full_View (T), Exchanged_Views);
13788 Exchange_Declarations (T);
13792 Priv_Elmt := First_Elmt (Private_Dependents (BT));
13794 if Present (Full_View (BT)) then
13795 Prepend_Elmt (Full_View (BT), Exchanged_Views);
13796 Exchange_Declarations (BT);
13799 while Present (Priv_Elmt) loop
13800 Priv_Sub := (Node (Priv_Elmt));
13802 -- We avoid flipping the subtype if the Etype of its full view is
13803 -- private because this would result in a malformed subtype. This
13804 -- occurs when the Etype of the subtype full view is the full view of
13805 -- the base type (and since the base types were just switched, the
13806 -- subtype is pointing to the wrong view). This is currently the case
13807 -- for tagged record types, access types (maybe more?) and needs to
13808 -- be resolved. ???
13810 if Present (Full_View (Priv_Sub))
13811 and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
13813 Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
13814 Exchange_Declarations (Priv_Sub);
13817 Next_Elmt (Priv_Elmt);
13825 function True_Parent (N : Node_Id) return Node_Id is
13827 if Nkind (Parent (N)) = N_Subunit then
13828 return Parent (Corresponding_Stub (Parent (N)));
13834 -----------------------------
13835 -- Valid_Default_Attribute --
13836 -----------------------------
13838 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
13839 Attr_Id : constant Attribute_Id :=
13840 Get_Attribute_Id (Attribute_Name (Def));
13841 T : constant Entity_Id := Entity (Prefix (Def));
13842 Is_Fun : constant Boolean := (Ekind (Nam) = E_Function);
13855 F := First_Formal (Nam);
13856 while Present (F) loop
13857 Num_F := Num_F + 1;
13862 when Attribute_Adjacent | Attribute_Ceiling | Attribute_Copy_Sign |
13863 Attribute_Floor | Attribute_Fraction | Attribute_Machine |
13864 Attribute_Model | Attribute_Remainder | Attribute_Rounding |
13865 Attribute_Unbiased_Rounding =>
13868 and then Is_Floating_Point_Type (T);
13870 when Attribute_Image | Attribute_Pred | Attribute_Succ |
13871 Attribute_Value | Attribute_Wide_Image |
13872 Attribute_Wide_Value =>
13873 OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
13875 when Attribute_Max | Attribute_Min =>
13876 OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
13878 when Attribute_Input =>
13879 OK := (Is_Fun and then Num_F = 1);
13881 when Attribute_Output | Attribute_Read | Attribute_Write =>
13882 OK := (not Is_Fun and then Num_F = 2);
13889 Error_Msg_N ("attribute reference has wrong profile for subprogram",
13892 end Valid_Default_Attribute;