1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2014, 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 Einfo; use Einfo;
29 with Elists; use Elists;
30 with Errout; use Errout;
31 with Expander; use Expander;
32 with Exp_Disp; use Exp_Disp;
33 with Exp_Util; use Exp_Util;
34 with Fname; use Fname;
35 with Fname.UF; use Fname.UF;
36 with Freeze; use Freeze;
37 with Itypes; use Itypes;
39 with Lib.Load; use Lib.Load;
40 with Lib.Xref; use Lib.Xref;
41 with Nlists; use Nlists;
42 with Namet; use Namet;
43 with Nmake; use Nmake;
45 with Rident; use Rident;
46 with Restrict; use Restrict;
47 with Rtsfind; use Rtsfind;
49 with Sem_Aux; use Sem_Aux;
50 with Sem_Cat; use Sem_Cat;
51 with Sem_Ch3; use Sem_Ch3;
52 with Sem_Ch6; use Sem_Ch6;
53 with Sem_Ch7; use Sem_Ch7;
54 with Sem_Ch8; use Sem_Ch8;
55 with Sem_Ch10; use Sem_Ch10;
56 with Sem_Ch13; use Sem_Ch13;
57 with Sem_Dim; use Sem_Dim;
58 with Sem_Disp; use Sem_Disp;
59 with Sem_Elab; use Sem_Elab;
60 with Sem_Elim; use Sem_Elim;
61 with Sem_Eval; use Sem_Eval;
62 with Sem_Prag; use Sem_Prag;
63 with Sem_Res; use Sem_Res;
64 with Sem_Type; use Sem_Type;
65 with Sem_Util; use Sem_Util;
66 with Sem_Warn; use Sem_Warn;
67 with Stand; use Stand;
68 with Sinfo; use Sinfo;
69 with Sinfo.CN; use Sinfo.CN;
70 with Sinput; use Sinput;
71 with Sinput.L; use Sinput.L;
72 with Snames; use Snames;
73 with Stringt; use Stringt;
74 with Uname; use Uname;
76 with Tbuild; use Tbuild;
77 with Uintp; use Uintp;
78 with Urealp; use Urealp;
79 with Warnsw; use Warnsw;
83 package body Sem_Ch12 is
85 ----------------------------------------------------------
86 -- Implementation of Generic Analysis and Instantiation --
87 ----------------------------------------------------------
89 -- GNAT implements generics by macro expansion. No attempt is made to share
90 -- generic instantiations (for now). Analysis of a generic definition does
91 -- not perform any expansion action, but the expander must be called on the
92 -- tree for each instantiation, because the expansion may of course depend
93 -- on the generic actuals. All of this is best achieved as follows:
95 -- a) Semantic analysis of a generic unit is performed on a copy of the
96 -- tree for the generic unit. All tree modifications that follow analysis
97 -- do not affect the original tree. Links are kept between the original
98 -- tree and the copy, in order to recognize non-local references within
99 -- the generic, and propagate them to each instance (recall that name
100 -- resolution is done on the generic declaration: generics are not really
101 -- macros). This is summarized in the following diagram:
103 -- .-----------. .----------.
104 -- | semantic |<--------------| generic |
106 -- | |==============>| |
107 -- |___________| global |__________|
118 -- b) Each instantiation copies the original tree, and inserts into it a
119 -- series of declarations that describe the mapping between generic formals
120 -- and actuals. For example, a generic In OUT parameter is an object
121 -- renaming of the corresponding actual, etc. Generic IN parameters are
122 -- constant declarations.
124 -- c) In order to give the right visibility for these renamings, we use
125 -- a different scheme for package and subprogram instantiations. For
126 -- packages, the list of renamings is inserted into the package
127 -- specification, before the visible declarations of the package. The
128 -- renamings are analyzed before any of the text of the instance, and are
129 -- thus visible at the right place. Furthermore, outside of the instance,
130 -- the generic parameters are visible and denote their corresponding
133 -- For subprograms, we create a container package to hold the renamings
134 -- and the subprogram instance itself. Analysis of the package makes the
135 -- renaming declarations visible to the subprogram. After analyzing the
136 -- package, the defining entity for the subprogram is touched-up so that
137 -- it appears declared in the current scope, and not inside the container
140 -- If the instantiation is a compilation unit, the container package is
141 -- given the same name as the subprogram instance. This ensures that
142 -- the elaboration procedure called by the binder, using the compilation
143 -- unit name, calls in fact the elaboration procedure for the package.
145 -- Not surprisingly, private types complicate this approach. By saving in
146 -- the original generic object the non-local references, we guarantee that
147 -- the proper entities are referenced at the point of instantiation.
148 -- However, for private types, this by itself does not insure that the
149 -- proper VIEW of the entity is used (the full type may be visible at the
150 -- point of generic definition, but not at instantiation, or vice-versa).
151 -- In order to reference the proper view, we special-case any reference
152 -- to private types in the generic object, by saving both views, one in
153 -- the generic and one in the semantic copy. At time of instantiation, we
154 -- check whether the two views are consistent, and exchange declarations if
155 -- necessary, in order to restore the correct visibility. Similarly, if
156 -- the instance view is private when the generic view was not, we perform
157 -- the exchange. After completing the instantiation, we restore the
158 -- current visibility. The flag Has_Private_View marks identifiers in the
159 -- the generic unit that require checking.
161 -- Visibility within nested generic units requires special handling.
162 -- Consider the following scheme:
164 -- type Global is ... -- outside of generic unit.
168 -- type Semi_Global is ... -- global to inner.
171 -- procedure inner (X1 : Global; X2 : Semi_Global);
173 -- procedure in2 is new inner (...); -- 4
176 -- package New_Outer is new Outer (...); -- 2
177 -- procedure New_Inner is new New_Outer.Inner (...); -- 3
179 -- The semantic analysis of Outer captures all occurrences of Global.
180 -- The semantic analysis of Inner (at 1) captures both occurrences of
181 -- Global and Semi_Global.
183 -- At point 2 (instantiation of Outer), we also produce a generic copy
184 -- of Inner, even though Inner is, at that point, not being instantiated.
185 -- (This is just part of the semantic analysis of New_Outer).
187 -- Critically, references to Global within Inner must be preserved, while
188 -- references to Semi_Global should not preserved, because they must now
189 -- resolve to an entity within New_Outer. To distinguish between these, we
190 -- use a global variable, Current_Instantiated_Parent, which is set when
191 -- performing a generic copy during instantiation (at 2). This variable is
192 -- used when performing a generic copy that is not an instantiation, but
193 -- that is nested within one, as the occurrence of 1 within 2. The analysis
194 -- of a nested generic only preserves references that are global to the
195 -- enclosing Current_Instantiated_Parent. We use the Scope_Depth value to
196 -- determine whether a reference is external to the given parent.
198 -- The instantiation at point 3 requires no special treatment. The method
199 -- works as well for further nestings of generic units, but of course the
200 -- variable Current_Instantiated_Parent must be stacked because nested
201 -- instantiations can occur, e.g. the occurrence of 4 within 2.
203 -- The instantiation of package and subprogram bodies is handled in a
204 -- similar manner, except that it is delayed until after semantic
205 -- analysis is complete. In this fashion complex cross-dependencies
206 -- between several package declarations and bodies containing generics
207 -- can be compiled which otherwise would diagnose spurious circularities.
209 -- For example, it is possible to compile two packages A and B that
210 -- have the following structure:
212 -- package A is package B is
213 -- generic ... generic ...
214 -- package G_A is package G_B is
217 -- package body A is package body B is
218 -- package N_B is new G_B (..) package N_A is new G_A (..)
220 -- The table Pending_Instantiations in package Inline is used to keep
221 -- track of body instantiations that are delayed in this manner. Inline
222 -- handles the actual calls to do the body instantiations. This activity
223 -- is part of Inline, since the processing occurs at the same point, and
224 -- for essentially the same reason, as the handling of inlined routines.
226 ----------------------------------------------
227 -- Detection of Instantiation Circularities --
228 ----------------------------------------------
230 -- If we have a chain of instantiations that is circular, this is static
231 -- error which must be detected at compile time. The detection of these
232 -- circularities is carried out at the point that we insert a generic
233 -- instance spec or body. If there is a circularity, then the analysis of
234 -- the offending spec or body will eventually result in trying to load the
235 -- same unit again, and we detect this problem as we analyze the package
236 -- instantiation for the second time.
238 -- At least in some cases after we have detected the circularity, we get
239 -- into trouble if we try to keep going. The following flag is set if a
240 -- circularity is detected, and used to abandon compilation after the
241 -- messages have been posted.
243 Circularity_Detected : Boolean := False;
244 -- This should really be reset on encountering a new main unit, but in
245 -- practice we are not using multiple main units so it is not critical.
247 --------------------------------------------------
248 -- Formal packages and partial parameterization --
249 --------------------------------------------------
251 -- When compiling a generic, a formal package is a local instantiation. If
252 -- declared with a box, its generic formals are visible in the enclosing
253 -- generic. If declared with a partial list of actuals, those actuals that
254 -- are defaulted (covered by an Others clause, or given an explicit box
255 -- initialization) are also visible in the enclosing generic, while those
256 -- that have a corresponding actual are not.
258 -- In our source model of instantiation, the same visibility must be
259 -- present in the spec and body of an instance: the names of the formals
260 -- that are defaulted must be made visible within the instance, and made
261 -- invisible (hidden) after the instantiation is complete, so that they
262 -- are not accessible outside of the instance.
264 -- In a generic, a formal package is treated like a special instantiation.
265 -- Our Ada 95 compiler handled formals with and without box in different
266 -- ways. With partial parameterization, we use a single model for both.
267 -- We create a package declaration that consists of the specification of
268 -- the generic package, and a set of declarations that map the actuals
269 -- into local renamings, just as we do for bona fide instantiations. For
270 -- defaulted parameters and formals with a box, we copy directly the
271 -- declarations of the formal into this local package. The result is a
272 -- a package whose visible declarations may include generic formals. This
273 -- package is only used for type checking and visibility analysis, and
274 -- never reaches the back-end, so it can freely violate the placement
275 -- rules for generic formal declarations.
277 -- The list of declarations (renamings and copies of formals) is built
278 -- by Analyze_Associations, just as for regular instantiations.
280 -- At the point of instantiation, conformance checking must be applied only
281 -- to those parameters that were specified in the formal. We perform this
282 -- checking by creating another internal instantiation, this one including
283 -- only the renamings and the formals (the rest of the package spec is not
284 -- relevant to conformance checking). We can then traverse two lists: the
285 -- list of actuals in the instance that corresponds to the formal package,
286 -- and the list of actuals produced for this bogus instantiation. We apply
287 -- the conformance rules to those actuals that are not defaulted (i.e.
288 -- which still appear as generic formals.
290 -- When we compile an instance body we must make the right parameters
291 -- visible again. The predicate Is_Generic_Formal indicates which of the
292 -- formals should have its Is_Hidden flag reset.
294 -----------------------
295 -- Local subprograms --
296 -----------------------
298 procedure Abandon_Instantiation (N : Node_Id);
299 pragma No_Return (Abandon_Instantiation);
300 -- Posts an error message "instantiation abandoned" at the indicated node
301 -- and then raises the exception Instantiation_Error to do it.
303 procedure Analyze_Formal_Array_Type
304 (T : in out Entity_Id;
306 -- A formal array type is treated like an array type declaration, and
307 -- invokes Array_Type_Declaration (sem_ch3) whose first parameter is
308 -- in-out, because in the case of an anonymous type the entity is
309 -- actually created in the procedure.
311 -- The following procedures treat other kinds of formal parameters
313 procedure Analyze_Formal_Derived_Interface_Type
318 procedure Analyze_Formal_Derived_Type
323 procedure Analyze_Formal_Interface_Type
328 -- The following subprograms create abbreviated declarations for formal
329 -- scalar types. We introduce an anonymous base of the proper class for
330 -- each of them, and define the formals as constrained first subtypes of
331 -- their bases. The bounds are expressions that are non-static in the
334 procedure Analyze_Formal_Decimal_Fixed_Point_Type
335 (T : Entity_Id; Def : Node_Id);
336 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id);
337 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id);
338 procedure Analyze_Formal_Signed_Integer_Type (T : Entity_Id; Def : Node_Id);
339 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id);
340 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
341 (T : Entity_Id; Def : Node_Id);
343 procedure Analyze_Formal_Private_Type
347 -- Creates a new private type, which does not require completion
349 procedure Analyze_Formal_Incomplete_Type (T : Entity_Id; Def : Node_Id);
350 -- Ada 2012: Creates a new incomplete type whose actual does not freeze
352 procedure Analyze_Generic_Formal_Part (N : Node_Id);
353 -- Analyze generic formal part
355 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
356 -- Create a new access type with the given designated type
358 function Analyze_Associations
361 F_Copy : List_Id) return List_Id;
362 -- At instantiation time, build the list of associations between formals
363 -- and actuals. Each association becomes a renaming declaration for the
364 -- formal entity. F_Copy is the analyzed list of formals in the generic
365 -- copy. It is used to apply legality checks to the actuals. I_Node is the
366 -- instantiation node itself.
368 procedure Analyze_Subprogram_Instantiation
372 procedure Build_Instance_Compilation_Unit_Nodes
376 -- This procedure is used in the case where the generic instance of a
377 -- subprogram body or package body is a library unit. In this case, the
378 -- original library unit node for the generic instantiation must be
379 -- replaced by the resulting generic body, and a link made to a new
380 -- compilation unit node for the generic declaration. The argument N is
381 -- the original generic instantiation. Act_Body and Act_Decl are the body
382 -- and declaration of the instance (either package body and declaration
383 -- nodes or subprogram body and declaration nodes depending on the case).
384 -- On return, the node N has been rewritten with the actual body.
386 procedure Check_Access_Definition (N : Node_Id);
387 -- Subsidiary routine to null exclusion processing. Perform an assertion
388 -- check on Ada version and the presence of an access definition in N.
390 procedure Check_Formal_Packages (P_Id : Entity_Id);
391 -- Apply the following to all formal packages in generic associations
393 procedure Check_Formal_Package_Instance
394 (Formal_Pack : Entity_Id;
395 Actual_Pack : Entity_Id);
396 -- Verify that the actuals of the actual instance match the actuals of
397 -- the template for a formal package that is not declared with a box.
399 procedure Check_Forward_Instantiation (Decl : Node_Id);
400 -- If the generic is a local entity and the corresponding body has not
401 -- been seen yet, flag enclosing packages to indicate that it will be
402 -- elaborated after the generic body. Subprograms declared in the same
403 -- package cannot be inlined by the front-end because front-end inlining
404 -- requires a strict linear order of elaboration.
406 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id;
407 -- Check if some association between formals and actuals requires to make
408 -- visible primitives of a tagged type, and make those primitives visible.
409 -- Return the list of primitives whose visibility is modified (to restore
410 -- their visibility later through Restore_Hidden_Primitives). If no
411 -- candidate is found then return No_Elist.
413 procedure Check_Hidden_Child_Unit
415 Gen_Unit : Entity_Id;
416 Act_Decl_Id : Entity_Id);
417 -- If the generic unit is an implicit child instance within a parent
418 -- instance, we need to make an explicit test that it is not hidden by
419 -- a child instance of the same name and parent.
421 procedure Check_Generic_Actuals
422 (Instance : Entity_Id;
423 Is_Formal_Box : Boolean);
424 -- Similar to previous one. Check the actuals in the instantiation,
425 -- whose views can change between the point of instantiation and the point
426 -- of instantiation of the body. In addition, mark the generic renamings
427 -- as generic actuals, so that they are not compatible with other actuals.
428 -- Recurse on an actual that is a formal package whose declaration has
431 function Contains_Instance_Of
434 N : Node_Id) return Boolean;
435 -- Inner is instantiated within the generic Outer. Check whether Inner
436 -- directly or indirectly contains an instance of Outer or of one of its
437 -- parents, in the case of a subunit. Each generic unit holds a list of
438 -- the entities instantiated within (at any depth). This procedure
439 -- determines whether the set of such lists contains a cycle, i.e. an
440 -- illegal circular instantiation.
442 function Denotes_Formal_Package
444 On_Exit : Boolean := False;
445 Instance : Entity_Id := Empty) return Boolean;
446 -- Returns True if E is a formal package of an enclosing generic, or
447 -- the actual for such a formal in an enclosing instantiation. If such
448 -- a package is used as a formal in an nested generic, or as an actual
449 -- in a nested instantiation, the visibility of ITS formals should not
450 -- be modified. When called from within Restore_Private_Views, the flag
451 -- On_Exit is true, to indicate that the search for a possible enclosing
452 -- instance should ignore the current one. In that case Instance denotes
453 -- the declaration for which this is an actual. This declaration may be
454 -- an instantiation in the source, or the internal instantiation that
455 -- corresponds to the actual for a formal package.
457 function Earlier (N1, N2 : Node_Id) return Boolean;
458 -- Yields True if N1 and N2 appear in the same compilation unit,
459 -- ignoring subunits, and if N1 is to the left of N2 in a left-to-right
460 -- traversal of the tree for the unit. Used to determine the placement
461 -- of freeze nodes for instance bodies that may depend on other instances.
463 function Find_Actual_Type
465 Gen_Type : Entity_Id) return Entity_Id;
466 -- When validating the actual types of a child instance, check whether
467 -- the formal is a formal type of the parent unit, and retrieve the current
468 -- actual for it. Typ is the entity in the analyzed formal type declaration
469 -- (component or index type of an array type, or designated type of an
470 -- access formal) and Gen_Type is the enclosing analyzed formal array
471 -- or access type. The desired actual may be a formal of a parent, or may
472 -- be declared in a formal package of a parent. In both cases it is a
473 -- generic actual type because it appears within a visible instance.
474 -- Finally, it may be declared in a parent unit without being a formal
475 -- of that unit, in which case it must be retrieved by visibility.
476 -- Ambiguities may still arise if two homonyms are declared in two formal
477 -- packages, and the prefix of the formal type may be needed to resolve
478 -- the ambiguity in the instance ???
480 function In_Same_Declarative_Part
482 Inst : Node_Id) return Boolean;
483 -- True if the instantiation Inst and the given freeze_node F_Node appear
484 -- within the same declarative part, ignoring subunits, but with no inter-
485 -- vening subprograms or concurrent units. Used to find the proper plave
486 -- for the freeze node of an instance, when the generic is declared in a
487 -- previous instance. If predicate is true, the freeze node of the instance
488 -- can be placed after the freeze node of the previous instance, Otherwise
489 -- it has to be placed at the end of the current declarative part.
491 function In_Main_Context (E : Entity_Id) return Boolean;
492 -- Check whether an instantiation is in the context of the main unit.
493 -- Used to determine whether its body should be elaborated to allow
494 -- front-end inlining.
496 procedure Set_Instance_Env
497 (Gen_Unit : Entity_Id;
498 Act_Unit : Entity_Id);
499 -- Save current instance on saved environment, to be used to determine
500 -- the global status of entities in nested instances. Part of Save_Env.
501 -- called after verifying that the generic unit is legal for the instance,
502 -- The procedure also examines whether the generic unit is a predefined
503 -- unit, in order to set configuration switches accordingly. As a result
504 -- the procedure must be called after analyzing and freezing the actuals.
506 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id);
507 -- Associate analyzed generic parameter with corresponding
508 -- instance. Used for semantic checks at instantiation time.
510 function Has_Been_Exchanged (E : Entity_Id) return Boolean;
511 -- Traverse the Exchanged_Views list to see if a type was private
512 -- and has already been flipped during this phase of instantiation.
514 procedure Hide_Current_Scope;
515 -- When instantiating a generic child unit, the parent context must be
516 -- present, but the instance and all entities that may be generated
517 -- must be inserted in the current scope. We leave the current scope
518 -- on the stack, but make its entities invisible to avoid visibility
519 -- problems. This is reversed at the end of the instantiation. This is
520 -- not done for the instantiation of the bodies, which only require the
521 -- instances of the generic parents to be in scope.
523 procedure Install_Body
528 -- If the instantiation happens textually before the body of the generic,
529 -- the instantiation of the body must be analyzed after the generic body,
530 -- and not at the point of instantiation. Such early instantiations can
531 -- happen if the generic and the instance appear in a package declaration
532 -- because the generic body can only appear in the corresponding package
533 -- body. Early instantiations can also appear if generic, instance and
534 -- body are all in the declarative part of a subprogram or entry. Entities
535 -- of packages that are early instantiations are delayed, and their freeze
536 -- node appears after the generic body.
538 procedure Insert_Freeze_Node_For_Instance
541 -- N denotes a package or a subprogram instantiation and F_Node is the
542 -- associated freeze node. Insert the freeze node before the first source
543 -- body which follows immediately after N. If no such body is found, the
544 -- freeze node is inserted at the end of the declarative region which
547 procedure Freeze_Subprogram_Body
548 (Inst_Node : Node_Id;
550 Pack_Id : Entity_Id);
551 -- The generic body may appear textually after the instance, including
552 -- in the proper body of a stub, or within a different package instance.
553 -- Given that the instance can only be elaborated after the generic, we
554 -- place freeze_nodes for the instance and/or for packages that may enclose
555 -- the instance and the generic, so that the back-end can establish the
556 -- proper order of elaboration.
559 -- Establish environment for subsequent instantiation. Separated from
560 -- Save_Env because data-structures for visibility handling must be
561 -- initialized before call to Check_Generic_Child_Unit.
563 procedure Install_Formal_Packages (Par : Entity_Id);
564 -- Install the visible part of any formal of the parent that is a formal
565 -- package. Note that for the case of a formal package with a box, this
566 -- includes the formal part of the formal package (12.7(10/2)).
568 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False);
569 -- When compiling an instance of a child unit the parent (which is
570 -- itself an instance) is an enclosing scope that must be made
571 -- immediately visible. This procedure is also used to install the non-
572 -- generic parent of a generic child unit when compiling its body, so
573 -- that full views of types in the parent are made visible.
575 procedure Remove_Parent (In_Body : Boolean := False);
576 -- Reverse effect after instantiation of child is complete
578 procedure Install_Hidden_Primitives
579 (Prims_List : in out Elist_Id;
582 -- Remove suffix 'P' from hidden primitives of Act_T to match the
583 -- visibility of primitives of Gen_T. The list of primitives to which
584 -- the suffix is removed is added to Prims_List to restore them later.
586 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id);
587 -- Restore suffix 'P' to primitives of Prims_List and leave Prims_List
590 procedure Inline_Instance_Body
592 Gen_Unit : Entity_Id;
594 -- If front-end inlining is requested, instantiate the package body,
595 -- and preserve the visibility of its compilation unit, to insure
596 -- that successive instantiations succeed.
598 -- The functions Instantiate_XXX perform various legality checks and build
599 -- the declarations for instantiated generic parameters. In all of these
600 -- Formal is the entity in the generic unit, Actual is the entity of
601 -- expression in the generic associations, and Analyzed_Formal is the
602 -- formal in the generic copy, which contains the semantic information to
603 -- be used to validate the actual.
605 function Instantiate_Object
608 Analyzed_Formal : Node_Id) return List_Id;
610 function Instantiate_Type
613 Analyzed_Formal : Node_Id;
614 Actual_Decls : List_Id) return List_Id;
616 function Instantiate_Formal_Subprogram
619 Analyzed_Formal : Node_Id) return Node_Id;
621 function Instantiate_Formal_Package
624 Analyzed_Formal : Node_Id) return List_Id;
625 -- If the formal package is declared with a box, special visibility rules
626 -- apply to its formals: they are in the visible part of the package. This
627 -- is true in the declarative region of the formal package, that is to say
628 -- in the enclosing generic or instantiation. For an instantiation, the
629 -- parameters of the formal package are made visible in an explicit step.
630 -- Furthermore, if the actual has a visible USE clause, these formals must
631 -- be made potentially use-visible as well. On exit from the enclosing
632 -- instantiation, the reverse must be done.
634 -- For a formal package declared without a box, there are conformance rules
635 -- that apply to the actuals in the generic declaration and the actuals of
636 -- the actual package in the enclosing instantiation. The simplest way to
637 -- apply these rules is to repeat the instantiation of the formal package
638 -- in the context of the enclosing instance, and compare the generic
639 -- associations of this instantiation with those of the actual package.
640 -- This internal instantiation only needs to contain the renamings of the
641 -- formals: the visible and private declarations themselves need not be
644 -- In Ada 2005, the formal package may be only partially parameterized.
645 -- In that case the visibility step must make visible those actuals whose
646 -- corresponding formals were given with a box. A final complication
647 -- involves inherited operations from formal derived types, which must
648 -- be visible if the type is.
650 function Is_In_Main_Unit (N : Node_Id) return Boolean;
651 -- Test if given node is in the main unit
653 procedure Load_Parent_Of_Generic
656 Body_Optional : Boolean := False);
657 -- If the generic appears in a separate non-generic library unit, load the
658 -- corresponding body to retrieve the body of the generic. N is the node
659 -- for the generic instantiation, Spec is the generic package declaration.
661 -- Body_Optional is a flag that indicates that the body is being loaded to
662 -- ensure that temporaries are generated consistently when there are other
663 -- instances in the current declarative part that precede the one being
664 -- loaded. In that case a missing body is acceptable.
666 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id);
667 -- Add the context clause of the unit containing a generic unit to a
668 -- compilation unit that is, or contains, an instantiation.
670 function Get_Associated_Node (N : Node_Id) return Node_Id;
671 -- In order to propagate semantic information back from the analyzed copy
672 -- to the original generic, we maintain links between selected nodes in the
673 -- generic and their corresponding copies. At the end of generic analysis,
674 -- the routine Save_Global_References traverses the generic tree, examines
675 -- the semantic information, and preserves the links to those nodes that
676 -- contain global information. At instantiation, the information from the
677 -- associated node is placed on the new copy, so that name resolution is
680 -- Three kinds of source nodes have associated nodes:
682 -- a) those that can reference (denote) entities, that is identifiers,
683 -- character literals, expanded_names, operator symbols, operators,
684 -- and attribute reference nodes. These nodes have an Entity field
685 -- and are the set of nodes that are in N_Has_Entity.
687 -- b) aggregates (N_Aggregate and N_Extension_Aggregate)
689 -- c) selected components (N_Selected_Component)
691 -- For the first class, the associated node preserves the entity if it is
692 -- global. If the generic contains nested instantiations, the associated
693 -- node itself has been recopied, and a chain of them must be followed.
695 -- For aggregates, the associated node allows retrieval of the type, which
696 -- may otherwise not appear in the generic. The view of this type may be
697 -- different between generic and instantiation, and the full view can be
698 -- installed before the instantiation is analyzed. For aggregates of type
699 -- extensions, the same view exchange may have to be performed for some of
700 -- the ancestor types, if their view is private at the point of
703 -- Nodes that are selected components in the parse tree may be rewritten
704 -- as expanded names after resolution, and must be treated as potential
705 -- entity holders, which is why they also have an Associated_Node.
707 -- Nodes that do not come from source, such as freeze nodes, do not appear
708 -- in the generic tree, and need not have an associated node.
710 -- The associated node is stored in the Associated_Node field. Note that
711 -- this field overlaps Entity, which is fine, because the whole point is
712 -- that we don't need or want the normal Entity field in this situation.
714 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id);
715 -- Within the generic part, entities in the formal package are
716 -- visible. To validate subsequent type declarations, indicate
717 -- the correspondence between the entities in the analyzed formal,
718 -- and the entities in the actual package. There are three packages
719 -- involved in the instantiation of a formal package: the parent
720 -- generic P1 which appears in the generic declaration, the fake
721 -- instantiation P2 which appears in the analyzed generic, and whose
722 -- visible entities may be used in subsequent formals, and the actual
723 -- P3 in the instance. To validate subsequent formals, me indicate
724 -- that the entities in P2 are mapped into those of P3. The mapping of
725 -- entities has to be done recursively for nested packages.
727 procedure Move_Freeze_Nodes
731 -- Freeze nodes can be generated in the analysis of a generic unit, but
732 -- will not be seen by the back-end. It is necessary to move those nodes
733 -- to the enclosing scope if they freeze an outer entity. We place them
734 -- at the end of the enclosing generic package, which is semantically
737 procedure Preanalyze_Actuals (N : Node_Id);
738 -- Analyze actuals to perform name resolution. Full resolution is done
739 -- later, when the expected types are known, but names have to be captured
740 -- before installing parents of generics, that are not visible for the
741 -- actuals themselves.
743 function True_Parent (N : Node_Id) return Node_Id;
744 -- For a subunit, return parent of corresponding stub, else return
747 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id);
748 -- Verify that an attribute that appears as the default for a formal
749 -- subprogram is a function or procedure with the correct profile.
751 -------------------------------------------
752 -- Data Structures for Generic Renamings --
753 -------------------------------------------
755 -- The map Generic_Renamings associates generic entities with their
756 -- corresponding actuals. Currently used to validate type instances. It
757 -- will eventually be used for all generic parameters to eliminate the
758 -- need for overload resolution in the instance.
760 type Assoc_Ptr is new Int;
762 Assoc_Null : constant Assoc_Ptr := -1;
767 Next_In_HTable : Assoc_Ptr;
770 package Generic_Renamings is new Table.Table
771 (Table_Component_Type => Assoc,
772 Table_Index_Type => Assoc_Ptr,
773 Table_Low_Bound => 0,
775 Table_Increment => 100,
776 Table_Name => "Generic_Renamings");
778 -- Variable to hold enclosing instantiation. When the environment is
779 -- saved for a subprogram inlining, the corresponding Act_Id is empty.
781 Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
783 -- Hash table for associations
785 HTable_Size : constant := 37;
786 type HTable_Range is range 0 .. HTable_Size - 1;
788 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr);
789 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr;
790 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id;
791 function Hash (F : Entity_Id) return HTable_Range;
793 package Generic_Renamings_HTable is new GNAT.HTable.Static_HTable (
794 Header_Num => HTable_Range,
796 Elmt_Ptr => Assoc_Ptr,
797 Null_Ptr => Assoc_Null,
798 Set_Next => Set_Next_Assoc,
801 Get_Key => Get_Gen_Id,
805 Exchanged_Views : Elist_Id;
806 -- This list holds the private views that have been exchanged during
807 -- instantiation to restore the visibility of the generic declaration.
808 -- (see comments above). After instantiation, the current visibility is
809 -- reestablished by means of a traversal of this list.
811 Hidden_Entities : Elist_Id;
812 -- This list holds the entities of the current scope that are removed
813 -- from immediate visibility when instantiating a child unit. Their
814 -- visibility is restored in Remove_Parent.
816 -- Because instantiations can be recursive, the following must be saved
817 -- on entry and restored on exit from an instantiation (spec or body).
818 -- This is done by the two procedures Save_Env and Restore_Env. For
819 -- package and subprogram instantiations (but not for the body instances)
820 -- the action of Save_Env is done in two steps: Init_Env is called before
821 -- Check_Generic_Child_Unit, because setting the parent instances requires
822 -- that the visibility data structures be properly initialized. Once the
823 -- generic is unit is validated, Set_Instance_Env completes Save_Env.
825 Parent_Unit_Visible : Boolean := False;
826 -- Parent_Unit_Visible is used when the generic is a child unit, and
827 -- indicates whether the ultimate parent of the generic is visible in the
828 -- instantiation environment. It is used to reset the visibility of the
829 -- parent at the end of the instantiation (see Remove_Parent).
831 Instance_Parent_Unit : Entity_Id := Empty;
832 -- This records the ultimate parent unit of an instance of a generic
833 -- child unit and is used in conjunction with Parent_Unit_Visible to
834 -- indicate the unit to which the Parent_Unit_Visible flag corresponds.
836 type Instance_Env is record
837 Instantiated_Parent : Assoc;
838 Exchanged_Views : Elist_Id;
839 Hidden_Entities : Elist_Id;
840 Current_Sem_Unit : Unit_Number_Type;
841 Parent_Unit_Visible : Boolean := False;
842 Instance_Parent_Unit : Entity_Id := Empty;
843 Switches : Config_Switches_Type;
846 package Instance_Envs is new Table.Table (
847 Table_Component_Type => Instance_Env,
848 Table_Index_Type => Int,
849 Table_Low_Bound => 0,
851 Table_Increment => 100,
852 Table_Name => "Instance_Envs");
854 procedure Restore_Private_Views
855 (Pack_Id : Entity_Id;
856 Is_Package : Boolean := True);
857 -- Restore the private views of external types, and unmark the generic
858 -- renamings of actuals, so that they become compatible subtypes again.
859 -- For subprograms, Pack_Id is the package constructed to hold the
862 procedure Switch_View (T : Entity_Id);
863 -- Switch the partial and full views of a type and its private
864 -- dependents (i.e. its subtypes and derived types).
866 ------------------------------------
867 -- Structures for Error Reporting --
868 ------------------------------------
870 Instantiation_Node : Node_Id;
871 -- Used by subprograms that validate instantiation of formal parameters
872 -- where there might be no actual on which to place the error message.
873 -- Also used to locate the instantiation node for generic subunits.
875 Instantiation_Error : exception;
876 -- When there is a semantic error in the generic parameter matching,
877 -- there is no point in continuing the instantiation, because the
878 -- number of cascaded errors is unpredictable. This exception aborts
879 -- the instantiation process altogether.
881 S_Adjustment : Sloc_Adjustment;
882 -- Offset created for each node in an instantiation, in order to keep
883 -- track of the source position of the instantiation in each of its nodes.
884 -- A subsequent semantic error or warning on a construct of the instance
885 -- points to both places: the original generic node, and the point of
886 -- instantiation. See Sinput and Sinput.L for additional details.
888 ------------------------------------------------------------
889 -- Data structure for keeping track when inside a Generic --
890 ------------------------------------------------------------
892 -- The following table is used to save values of the Inside_A_Generic
893 -- flag (see spec of Sem) when they are saved by Start_Generic.
895 package Generic_Flags is new Table.Table (
896 Table_Component_Type => Boolean,
897 Table_Index_Type => Int,
898 Table_Low_Bound => 0,
900 Table_Increment => 200,
901 Table_Name => "Generic_Flags");
903 ---------------------------
904 -- Abandon_Instantiation --
905 ---------------------------
907 procedure Abandon_Instantiation (N : Node_Id) is
909 Error_Msg_N ("\instantiation abandoned!", N);
910 raise Instantiation_Error;
911 end Abandon_Instantiation;
913 --------------------------
914 -- Analyze_Associations --
915 --------------------------
917 function Analyze_Associations
920 F_Copy : List_Id) return List_Id
922 Actuals_To_Freeze : constant Elist_Id := New_Elmt_List;
923 Assoc : constant List_Id := New_List;
924 Default_Actuals : constant Elist_Id := New_Elmt_List;
925 Gen_Unit : constant Entity_Id :=
926 Defining_Entity (Parent (F_Copy));
930 Analyzed_Formal : Node_Id;
931 First_Named : Node_Id := Empty;
935 Saved_Formal : Node_Id;
937 Default_Formals : constant List_Id := New_List;
938 -- If an Others_Choice is present, some of the formals may be defaulted.
939 -- To simplify the treatment of visibility in an instance, we introduce
940 -- individual defaults for each such formal. These defaults are
941 -- appended to the list of associations and replace the Others_Choice.
943 Found_Assoc : Node_Id;
944 -- Association for the current formal being match. Empty if there are
945 -- no remaining actuals, or if there is no named association with the
946 -- name of the formal.
948 Is_Named_Assoc : Boolean;
949 Num_Matched : Int := 0;
950 Num_Actuals : Int := 0;
952 Others_Present : Boolean := False;
953 Others_Choice : Node_Id := Empty;
954 -- In Ada 2005, indicates partial parameterization of a formal
955 -- package. As usual an other association must be last in the list.
957 function Build_Function_Wrapper
959 Actual : Entity_Id := Empty) return Node_Id;
960 -- In GNATprove mode, create a wrapper function for actuals that are
961 -- functions with any number of formal parameters, in order to propagate
962 -- their contract to the renaming declarations generated for them.
963 -- If the actual is absent, the formal has a default, and the name of
964 -- the function is that of the formal.
966 function Build_Operator_Wrapper
968 Actual : Entity_Id := Empty) return Node_Id;
969 -- In GNATprove mode, create a wrapper function for actuals that are
970 -- operators, in order to propagate their contract to the renaming
971 -- declarations generated for them. If the actual is absent, this is
972 -- a formal with a default, and the name of the operator is that of the
975 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id);
976 -- Apply RM 12.3 (9): if a formal subprogram is overloaded, the instance
977 -- cannot have a named association for it. AI05-0025 extends this rule
978 -- to formals of formal packages by AI05-0025, and it also applies to
979 -- box-initialized formals.
981 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean;
982 -- Determine whether the parameter types and the return type of Subp
983 -- are fully defined at the point of instantiation.
985 function Matching_Actual
987 A_F : Entity_Id) return Node_Id;
988 -- Find actual that corresponds to a given a formal parameter. If the
989 -- actuals are positional, return the next one, if any. If the actuals
990 -- are named, scan the parameter associations to find the right one.
991 -- A_F is the corresponding entity in the analyzed generic,which is
992 -- placed on the selector name for ASIS use.
994 -- In Ada 2005, a named association may be given with a box, in which
995 -- case Matching_Actual sets Found_Assoc to the generic association,
996 -- but return Empty for the actual itself. In this case the code below
997 -- creates a corresponding declaration for the formal.
999 function Partial_Parameterization return Boolean;
1000 -- Ada 2005: if no match is found for a given formal, check if the
1001 -- association for it includes a box, or whether the associations
1002 -- include an Others clause.
1004 procedure Process_Default (F : Entity_Id);
1005 -- Add a copy of the declaration of generic formal F to the list of
1006 -- associations, and add an explicit box association for F if there
1007 -- is none yet, and the default comes from an Others_Choice.
1009 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean;
1010 -- Determine whether Subp renames one of the subprograms defined in the
1011 -- generated package Standard.
1013 procedure Set_Analyzed_Formal;
1014 -- Find the node in the generic copy that corresponds to a given formal.
1015 -- The semantic information on this node is used to perform legality
1016 -- checks on the actuals. Because semantic analysis can introduce some
1017 -- anonymous entities or modify the declaration node itself, the
1018 -- correspondence between the two lists is not one-one. In addition to
1019 -- anonymous types, the presence a formal equality will introduce an
1020 -- implicit declaration for the corresponding inequality.
1022 ----------------------------
1023 -- Build_Function_Wrapper --
1024 ----------------------------
1026 function Build_Function_Wrapper
1027 (Formal : Entity_Id;
1028 Actual : Entity_Id := Empty) return Node_Id
1030 Loc : constant Source_Ptr := Sloc (I_Node);
1033 Func_Name : Node_Id;
1035 Parm_Type : Node_Id;
1036 Profile : List_Id := New_List;
1043 -- If there is no actual, the formal has a default and is retrieved
1044 -- by name. Otherwise the wrapper encloses a call to the actual.
1047 Func_Name := Make_Identifier (Loc, Chars (Formal));
1049 Func_Name := New_Occurrence_Of (Entity (Actual), Loc);
1052 Func := Make_Defining_Identifier (Loc, Chars (Formal));
1053 Set_Ekind (Func, E_Function);
1054 Set_Is_Generic_Actual_Subprogram (Func);
1056 Actuals := New_List;
1057 Profile := New_List;
1059 if Present (Actual) then
1060 Act_F := First_Formal (Entity (Actual));
1065 Form_F := First_Formal (Formal);
1066 while Present (Form_F) loop
1068 -- Create new formal for profile of wrapper, and add a reference
1069 -- to it in the list of actuals for the enclosing call. The name
1070 -- must be that of the formal in the formal subprogram, because
1071 -- calls to it in the generic body may use named associations.
1073 New_F := Make_Defining_Identifier (Loc, Chars (Form_F));
1077 -- If formal has a class-wide type rewrite as the corresponding
1078 -- attribute, because the class-wide type is not retrievable by
1081 if Is_Class_Wide_Type (Etype (Form_F)) then
1083 Make_Attribute_Reference (Loc,
1084 Attribute_Name => Name_Class,
1086 Make_Identifier (Loc, Chars (Etype (Etype (Form_F)))));
1090 Make_Identifier (Loc, Chars (Etype (Etype (Form_F))));
1093 -- If actual is present, use the type of its own formal
1096 Parm_Type := New_Occurrence_Of (Etype (Act_F), Loc);
1100 Make_Parameter_Specification (Loc,
1101 Defining_Identifier => New_F,
1102 Parameter_Type => Parm_Type));
1104 Append_To (Actuals, New_Occurrence_Of (New_F, Loc));
1105 Next_Formal (Form_F);
1107 if Present (Act_F) then
1108 Next_Formal (Act_F);
1113 Make_Function_Specification (Loc,
1114 Defining_Unit_Name => Func,
1115 Parameter_Specifications => Profile,
1116 Result_Definition =>
1117 Make_Identifier (Loc, Chars (Etype (Formal))));
1120 Make_Expression_Function (Loc,
1121 Specification => Spec,
1123 Make_Function_Call (Loc,
1125 Parameter_Associations => Actuals));
1128 end Build_Function_Wrapper;
1130 ----------------------------
1131 -- Build_Operator_Wrapper --
1132 ----------------------------
1134 function Build_Operator_Wrapper
1135 (Formal : Entity_Id;
1136 Actual : Entity_Id := Empty) return Node_Id
1138 Loc : constant Source_Ptr := Sloc (I_Node);
1139 Typ : constant Entity_Id := Etype (Formal);
1140 Is_Binary : constant Boolean :=
1141 Present (Next_Formal (First_Formal (Formal)));
1153 Op_Name := Chars (Formal);
1155 Op_Name := Chars (Actual);
1158 -- Create entities for wrapper function and its formals
1160 F1 := Make_Temporary (Loc, 'A');
1161 F2 := Make_Temporary (Loc, 'B');
1162 L := New_Occurrence_Of (F1, Loc);
1163 R := New_Occurrence_Of (F2, Loc);
1165 Func := Make_Defining_Identifier (Loc, Chars (Formal));
1166 Set_Ekind (Func, E_Function);
1167 Set_Is_Generic_Actual_Subprogram (Func);
1170 Make_Function_Specification (Loc,
1171 Defining_Unit_Name => Func,
1172 Parameter_Specifications => New_List (
1173 Make_Parameter_Specification (Loc,
1174 Defining_Identifier => F1,
1176 Make_Identifier (Loc,
1177 Chars => Chars (Etype (First_Formal (Formal)))))),
1178 Result_Definition => Make_Identifier (Loc, Chars (Typ)));
1181 Append_To (Parameter_Specifications (Spec),
1182 Make_Parameter_Specification (Loc,
1183 Defining_Identifier => F2,
1185 Make_Identifier (Loc,
1186 Chars (Etype (Next_Formal (First_Formal (Formal)))))));
1189 -- Build expression as a function call, or as an operator node
1190 -- that corresponds to the name of the actual, starting with binary
1193 if Present (Actual) and then Op_Name not in Any_Operator_Name then
1195 Make_Function_Call (Loc,
1197 New_Occurrence_Of (Entity (Actual), Loc),
1198 Parameter_Associations => New_List (L));
1201 Append_To (Parameter_Associations (Expr), R);
1206 elsif Is_Binary then
1207 if Op_Name = Name_Op_And then
1208 Expr := Make_Op_And (Loc, Left_Opnd => L, Right_Opnd => R);
1209 elsif Op_Name = Name_Op_Or then
1210 Expr := Make_Op_Or (Loc, Left_Opnd => L, Right_Opnd => R);
1211 elsif Op_Name = Name_Op_Xor then
1212 Expr := Make_Op_Xor (Loc, Left_Opnd => L, Right_Opnd => R);
1213 elsif Op_Name = Name_Op_Eq then
1214 Expr := Make_Op_Eq (Loc, Left_Opnd => L, Right_Opnd => R);
1215 elsif Op_Name = Name_Op_Ne then
1216 Expr := Make_Op_Ne (Loc, Left_Opnd => L, Right_Opnd => R);
1217 elsif Op_Name = Name_Op_Le then
1218 Expr := Make_Op_Le (Loc, Left_Opnd => L, Right_Opnd => R);
1219 elsif Op_Name = Name_Op_Gt then
1220 Expr := Make_Op_Gt (Loc, Left_Opnd => L, Right_Opnd => R);
1221 elsif Op_Name = Name_Op_Ge then
1222 Expr := Make_Op_Ge (Loc, Left_Opnd => L, Right_Opnd => R);
1223 elsif Op_Name = Name_Op_Lt then
1224 Expr := Make_Op_Lt (Loc, Left_Opnd => L, Right_Opnd => R);
1225 elsif Op_Name = Name_Op_Add then
1226 Expr := Make_Op_Add (Loc, Left_Opnd => L, Right_Opnd => R);
1227 elsif Op_Name = Name_Op_Subtract then
1228 Expr := Make_Op_Subtract (Loc, Left_Opnd => L, Right_Opnd => R);
1229 elsif Op_Name = Name_Op_Concat then
1230 Expr := Make_Op_Concat (Loc, Left_Opnd => L, Right_Opnd => R);
1231 elsif Op_Name = Name_Op_Multiply then
1232 Expr := Make_Op_Multiply (Loc, Left_Opnd => L, Right_Opnd => R);
1233 elsif Op_Name = Name_Op_Divide then
1234 Expr := Make_Op_Divide (Loc, Left_Opnd => L, Right_Opnd => R);
1235 elsif Op_Name = Name_Op_Mod then
1236 Expr := Make_Op_Mod (Loc, Left_Opnd => L, Right_Opnd => R);
1237 elsif Op_Name = Name_Op_Rem then
1238 Expr := Make_Op_Rem (Loc, Left_Opnd => L, Right_Opnd => R);
1239 elsif Op_Name = Name_Op_Expon then
1240 Expr := Make_Op_Expon (Loc, Left_Opnd => L, Right_Opnd => R);
1246 if Op_Name = Name_Op_Add then
1247 Expr := Make_Op_Plus (Loc, Right_Opnd => L);
1248 elsif Op_Name = Name_Op_Subtract then
1249 Expr := Make_Op_Minus (Loc, Right_Opnd => L);
1250 elsif Op_Name = Name_Op_Abs then
1251 Expr := Make_Op_Abs (Loc, Right_Opnd => L);
1252 elsif Op_Name = Name_Op_Not then
1253 Expr := Make_Op_Not (Loc, Right_Opnd => L);
1257 -- Propagate visible entity to operator node, either from a
1258 -- given actual or from a default.
1260 if Is_Entity_Name (Actual) and then Nkind (Expr) in N_Op then
1261 Set_Entity (Expr, Entity (Actual));
1265 Make_Expression_Function (Loc,
1266 Specification => Spec,
1267 Expression => Expr);
1270 end Build_Operator_Wrapper;
1272 ----------------------------------------
1273 -- Check_Overloaded_Formal_Subprogram --
1274 ----------------------------------------
1276 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id) is
1277 Temp_Formal : Entity_Id;
1280 Temp_Formal := First (Formals);
1281 while Present (Temp_Formal) loop
1282 if Nkind (Temp_Formal) in N_Formal_Subprogram_Declaration
1283 and then Temp_Formal /= Formal
1285 Chars (Defining_Unit_Name (Specification (Formal))) =
1286 Chars (Defining_Unit_Name (Specification (Temp_Formal)))
1288 if Present (Found_Assoc) then
1290 ("named association not allowed for overloaded formal",
1295 ("named association not allowed for overloaded formal",
1299 Abandon_Instantiation (Instantiation_Node);
1304 end Check_Overloaded_Formal_Subprogram;
1306 -------------------------------
1307 -- Has_Fully_Defined_Profile --
1308 -------------------------------
1310 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean is
1311 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean;
1312 -- Determine whethet type Typ is fully defined
1314 ---------------------------
1315 -- Is_Fully_Defined_Type --
1316 ---------------------------
1318 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean is
1320 -- A private type without a full view is not fully defined
1322 if Is_Private_Type (Typ)
1323 and then No (Full_View (Typ))
1327 -- An incomplete type is never fully defined
1329 elsif Is_Incomplete_Type (Typ) then
1332 -- All other types are fully defined
1337 end Is_Fully_Defined_Type;
1339 -- Local declarations
1343 -- Start of processing for Has_Fully_Defined_Profile
1346 -- Check the parameters
1348 Param := First_Formal (Subp);
1349 while Present (Param) loop
1350 if not Is_Fully_Defined_Type (Etype (Param)) then
1354 Next_Formal (Param);
1357 -- Check the return type
1359 return Is_Fully_Defined_Type (Etype (Subp));
1360 end Has_Fully_Defined_Profile;
1362 ---------------------
1363 -- Matching_Actual --
1364 ---------------------
1366 function Matching_Actual
1368 A_F : Entity_Id) return Node_Id
1374 Is_Named_Assoc := False;
1376 -- End of list of purely positional parameters
1378 if No (Actual) or else Nkind (Actual) = N_Others_Choice then
1379 Found_Assoc := Empty;
1382 -- Case of positional parameter corresponding to current formal
1384 elsif No (Selector_Name (Actual)) then
1385 Found_Assoc := Actual;
1386 Act := Explicit_Generic_Actual_Parameter (Actual);
1387 Num_Matched := Num_Matched + 1;
1390 -- Otherwise scan list of named actuals to find the one with the
1391 -- desired name. All remaining actuals have explicit names.
1394 Is_Named_Assoc := True;
1395 Found_Assoc := Empty;
1399 while Present (Actual) loop
1400 if Chars (Selector_Name (Actual)) = Chars (F) then
1401 Set_Entity (Selector_Name (Actual), A_F);
1402 Set_Etype (Selector_Name (Actual), Etype (A_F));
1403 Generate_Reference (A_F, Selector_Name (Actual));
1404 Found_Assoc := Actual;
1405 Act := Explicit_Generic_Actual_Parameter (Actual);
1406 Num_Matched := Num_Matched + 1;
1414 -- Reset for subsequent searches. In most cases the named
1415 -- associations are in order. If they are not, we reorder them
1416 -- to avoid scanning twice the same actual. This is not just a
1417 -- question of efficiency: there may be multiple defaults with
1418 -- boxes that have the same name. In a nested instantiation we
1419 -- insert actuals for those defaults, and cannot rely on their
1420 -- names to disambiguate them.
1422 if Actual = First_Named then
1425 elsif Present (Actual) then
1426 Insert_Before (First_Named, Remove_Next (Prev));
1429 Actual := First_Named;
1432 if Is_Entity_Name (Act) and then Present (Entity (Act)) then
1433 Set_Used_As_Generic_Actual (Entity (Act));
1437 end Matching_Actual;
1439 ------------------------------
1440 -- Partial_Parameterization --
1441 ------------------------------
1443 function Partial_Parameterization return Boolean is
1445 return Others_Present
1446 or else (Present (Found_Assoc) and then Box_Present (Found_Assoc));
1447 end Partial_Parameterization;
1449 ---------------------
1450 -- Process_Default --
1451 ---------------------
1453 procedure Process_Default (F : Entity_Id) is
1454 Loc : constant Source_Ptr := Sloc (I_Node);
1455 F_Id : constant Entity_Id := Defining_Entity (F);
1461 -- Append copy of formal declaration to associations, and create new
1462 -- defining identifier for it.
1464 Decl := New_Copy_Tree (F);
1465 Id := Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id));
1467 if Nkind (F) in N_Formal_Subprogram_Declaration then
1468 Set_Defining_Unit_Name (Specification (Decl), Id);
1471 Set_Defining_Identifier (Decl, Id);
1474 Append (Decl, Assoc);
1476 if No (Found_Assoc) then
1478 Make_Generic_Association (Loc,
1479 Selector_Name => New_Occurrence_Of (Id, Loc),
1480 Explicit_Generic_Actual_Parameter => Empty);
1481 Set_Box_Present (Default);
1482 Append (Default, Default_Formals);
1484 end Process_Default;
1486 ---------------------------------
1487 -- Renames_Standard_Subprogram --
1488 ---------------------------------
1490 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean is
1495 while Present (Id) loop
1496 if Scope (Id) = Standard_Standard then
1504 end Renames_Standard_Subprogram;
1506 -------------------------
1507 -- Set_Analyzed_Formal --
1508 -------------------------
1510 procedure Set_Analyzed_Formal is
1514 while Present (Analyzed_Formal) loop
1515 Kind := Nkind (Analyzed_Formal);
1517 case Nkind (Formal) is
1519 when N_Formal_Subprogram_Declaration =>
1520 exit when Kind in N_Formal_Subprogram_Declaration
1523 (Defining_Unit_Name (Specification (Formal))) =
1525 (Defining_Unit_Name (Specification (Analyzed_Formal)));
1527 when N_Formal_Package_Declaration =>
1528 exit when Nkind_In (Kind, N_Formal_Package_Declaration,
1529 N_Generic_Package_Declaration,
1530 N_Package_Declaration);
1532 when N_Use_Package_Clause | N_Use_Type_Clause => exit;
1536 -- Skip freeze nodes, and nodes inserted to replace
1537 -- unrecognized pragmas.
1540 Kind not in N_Formal_Subprogram_Declaration
1541 and then not Nkind_In (Kind, N_Subprogram_Declaration,
1545 and then Chars (Defining_Identifier (Formal)) =
1546 Chars (Defining_Identifier (Analyzed_Formal));
1549 Next (Analyzed_Formal);
1551 end Set_Analyzed_Formal;
1553 -- Start of processing for Analyze_Associations
1556 Actuals := Generic_Associations (I_Node);
1558 if Present (Actuals) then
1560 -- Check for an Others choice, indicating a partial parameterization
1561 -- for a formal package.
1563 Actual := First (Actuals);
1564 while Present (Actual) loop
1565 if Nkind (Actual) = N_Others_Choice then
1566 Others_Present := True;
1567 Others_Choice := Actual;
1569 if Present (Next (Actual)) then
1570 Error_Msg_N ("others must be last association", Actual);
1573 -- This subprogram is used both for formal packages and for
1574 -- instantiations. For the latter, associations must all be
1577 if Nkind (I_Node) /= N_Formal_Package_Declaration
1578 and then Comes_From_Source (I_Node)
1581 ("others association not allowed in an instance",
1585 -- In any case, nothing to do after the others association
1589 elsif Box_Present (Actual)
1590 and then Comes_From_Source (I_Node)
1591 and then Nkind (I_Node) /= N_Formal_Package_Declaration
1594 ("box association not allowed in an instance", Actual);
1600 -- If named associations are present, save first named association
1601 -- (it may of course be Empty) to facilitate subsequent name search.
1603 First_Named := First (Actuals);
1604 while Present (First_Named)
1605 and then Nkind (First_Named) /= N_Others_Choice
1606 and then No (Selector_Name (First_Named))
1608 Num_Actuals := Num_Actuals + 1;
1613 Named := First_Named;
1614 while Present (Named) loop
1615 if Nkind (Named) /= N_Others_Choice
1616 and then No (Selector_Name (Named))
1618 Error_Msg_N ("invalid positional actual after named one", Named);
1619 Abandon_Instantiation (Named);
1622 -- A named association may lack an actual parameter, if it was
1623 -- introduced for a default subprogram that turns out to be local
1624 -- to the outer instantiation.
1626 if Nkind (Named) /= N_Others_Choice
1627 and then Present (Explicit_Generic_Actual_Parameter (Named))
1629 Num_Actuals := Num_Actuals + 1;
1635 if Present (Formals) then
1636 Formal := First_Non_Pragma (Formals);
1637 Analyzed_Formal := First_Non_Pragma (F_Copy);
1639 if Present (Actuals) then
1640 Actual := First (Actuals);
1642 -- All formals should have default values
1648 while Present (Formal) loop
1649 Set_Analyzed_Formal;
1650 Saved_Formal := Next_Non_Pragma (Formal);
1652 case Nkind (Formal) is
1653 when N_Formal_Object_Declaration =>
1656 Defining_Identifier (Formal),
1657 Defining_Identifier (Analyzed_Formal));
1659 if No (Match) and then Partial_Parameterization then
1660 Process_Default (Formal);
1663 (Instantiate_Object (Formal, Match, Analyzed_Formal),
1667 -- If the object is a call to an expression function, this
1668 -- is a freezing point for it.
1670 if Is_Entity_Name (Match)
1671 and then Present (Entity (Match))
1673 (Original_Node (Unit_Declaration_Node (Entity (Match))))
1674 = N_Expression_Function
1676 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1679 when N_Formal_Type_Declaration =>
1682 Defining_Identifier (Formal),
1683 Defining_Identifier (Analyzed_Formal));
1686 if Partial_Parameterization then
1687 Process_Default (Formal);
1690 Error_Msg_Sloc := Sloc (Gen_Unit);
1694 Defining_Identifier (Formal));
1695 Error_Msg_NE ("\in instantiation of & declared#",
1696 Instantiation_Node, Gen_Unit);
1697 Abandon_Instantiation (Instantiation_Node);
1704 (Formal, Match, Analyzed_Formal, Assoc),
1707 -- An instantiation is a freeze point for the actuals,
1708 -- unless this is a rewritten formal package, or the
1709 -- formal is an Ada 2012 formal incomplete type.
1711 if Nkind (I_Node) = N_Formal_Package_Declaration
1713 (Ada_Version >= Ada_2012
1715 Ekind (Defining_Identifier (Analyzed_Formal)) =
1721 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1725 -- A remote access-to-class-wide type is not a legal actual
1726 -- for a generic formal of an access type (E.2.2(17/2)).
1727 -- In GNAT an exception to this rule is introduced when
1728 -- the formal is marked as remote using implementation
1729 -- defined aspect/pragma Remote_Access_Type. In that case
1730 -- the actual must be remote as well.
1732 -- If the current instantiation is the construction of a
1733 -- local copy for a formal package the actuals may be
1734 -- defaulted, and there is no matching actual to check.
1736 if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1738 Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1739 N_Access_To_Object_Definition
1740 and then Present (Match)
1743 Formal_Ent : constant Entity_Id :=
1744 Defining_Identifier (Analyzed_Formal);
1746 if Is_Remote_Access_To_Class_Wide_Type (Entity (Match))
1747 = Is_Remote_Types (Formal_Ent)
1749 -- Remoteness of formal and actual match
1753 elsif Is_Remote_Types (Formal_Ent) then
1755 -- Remote formal, non-remote actual
1758 ("actual for& must be remote", Match, Formal_Ent);
1761 -- Non-remote formal, remote actual
1764 ("actual for& may not be remote",
1770 when N_Formal_Subprogram_Declaration =>
1773 (Defining_Unit_Name (Specification (Formal)),
1774 Defining_Unit_Name (Specification (Analyzed_Formal)));
1776 -- If the formal subprogram has the same name as another
1777 -- formal subprogram of the generic, then a named
1778 -- association is illegal (12.3(9)). Exclude named
1779 -- associations that are generated for a nested instance.
1782 and then Is_Named_Assoc
1783 and then Comes_From_Source (Found_Assoc)
1785 Check_Overloaded_Formal_Subprogram (Formal);
1788 -- If there is no corresponding actual, this may be case
1789 -- of partial parameterization, or else the formal has a
1790 -- default or a box.
1792 if No (Match) and then Partial_Parameterization then
1793 Process_Default (Formal);
1795 if Nkind (I_Node) = N_Formal_Package_Declaration then
1796 Check_Overloaded_Formal_Subprogram (Formal);
1802 (Containing_Package_With_Ext_Axioms
1803 (Defining_Entity (Analyzed_Formal)))
1804 and then Ekind (Defining_Entity (Analyzed_Formal)) =
1807 -- If actual is an entity (function or operator),
1808 -- build wrapper for it.
1810 if Present (Match) then
1811 if Nkind (Match) = N_Operator_Symbol then
1813 -- If the name is a default, find its visible
1814 -- entity at the point of instantiation.
1816 if Is_Entity_Name (Match)
1817 and then No (Entity (Match))
1819 Find_Direct_Name (Match);
1824 Build_Operator_Wrapper
1825 (Defining_Entity (Analyzed_Formal), Match));
1829 Build_Function_Wrapper
1830 (Defining_Entity (Analyzed_Formal), Match));
1833 -- Ditto if formal is an operator with a default.
1835 elsif Box_Present (Formal)
1836 and then Nkind (Defining_Entity (Analyzed_Formal)) =
1837 N_Defining_Operator_Symbol
1840 Build_Operator_Wrapper
1841 (Defining_Entity (Analyzed_Formal)));
1843 -- Otherwise create renaming declaration.
1847 Build_Function_Wrapper
1848 (Defining_Entity (Analyzed_Formal)));
1853 Instantiate_Formal_Subprogram
1854 (Formal, Match, Analyzed_Formal));
1857 -- An instantiation is a freeze point for the actuals,
1858 -- unless this is a rewritten formal package.
1860 if Nkind (I_Node) /= N_Formal_Package_Declaration
1861 and then Nkind (Match) = N_Identifier
1862 and then Is_Subprogram (Entity (Match))
1864 -- The actual subprogram may rename a routine defined
1865 -- in Standard. Avoid freezing such renamings because
1866 -- subprograms coming from Standard cannot be frozen.
1869 not Renames_Standard_Subprogram (Entity (Match))
1871 -- If the actual subprogram comes from a different
1872 -- unit, it is already frozen, either by a body in
1873 -- that unit or by the end of the declarative part
1874 -- of the unit. This check avoids the freezing of
1875 -- subprograms defined in Standard which are used
1876 -- as generic actuals.
1878 and then In_Same_Code_Unit (Entity (Match), I_Node)
1879 and then Has_Fully_Defined_Profile (Entity (Match))
1881 -- Mark the subprogram as having a delayed freeze
1882 -- since this may be an out-of-order action.
1884 Set_Has_Delayed_Freeze (Entity (Match));
1885 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1889 -- If this is a nested generic, preserve default for later
1892 if No (Match) and then Box_Present (Formal) then
1894 (Defining_Unit_Name (Specification (Last (Assoc))),
1898 when N_Formal_Package_Declaration =>
1901 Defining_Identifier (Formal),
1902 Defining_Identifier (Original_Node (Analyzed_Formal)));
1905 if Partial_Parameterization then
1906 Process_Default (Formal);
1909 Error_Msg_Sloc := Sloc (Gen_Unit);
1912 Instantiation_Node, Defining_Identifier (Formal));
1913 Error_Msg_NE ("\in instantiation of & declared#",
1914 Instantiation_Node, Gen_Unit);
1916 Abandon_Instantiation (Instantiation_Node);
1922 (Instantiate_Formal_Package
1923 (Formal, Match, Analyzed_Formal),
1927 -- For use type and use package appearing in the generic part,
1928 -- we have already copied them, so we can just move them where
1929 -- they belong (we mustn't recopy them since this would mess up
1930 -- the Sloc values).
1932 when N_Use_Package_Clause |
1933 N_Use_Type_Clause =>
1934 if Nkind (Original_Node (I_Node)) =
1935 N_Formal_Package_Declaration
1937 Append (New_Copy_Tree (Formal), Assoc);
1940 Append (Formal, Assoc);
1944 raise Program_Error;
1948 Formal := Saved_Formal;
1949 Next_Non_Pragma (Analyzed_Formal);
1952 if Num_Actuals > Num_Matched then
1953 Error_Msg_Sloc := Sloc (Gen_Unit);
1955 if Present (Selector_Name (Actual)) then
1957 ("unmatched actual&",
1958 Actual, Selector_Name (Actual));
1959 Error_Msg_NE ("\in instantiation of& declared#",
1963 ("unmatched actual in instantiation of& declared#",
1968 elsif Present (Actuals) then
1970 ("too many actuals in generic instantiation", Instantiation_Node);
1973 -- An instantiation freezes all generic actuals. The only exceptions
1974 -- to this are incomplete types and subprograms which are not fully
1975 -- defined at the point of instantiation.
1978 Elmt : Elmt_Id := First_Elmt (Actuals_To_Freeze);
1980 while Present (Elmt) loop
1981 Freeze_Before (I_Node, Node (Elmt));
1986 -- If there are default subprograms, normalize the tree by adding
1987 -- explicit associations for them. This is required if the instance
1988 -- appears within a generic.
1996 Elmt := First_Elmt (Default_Actuals);
1997 while Present (Elmt) loop
1998 if No (Actuals) then
1999 Actuals := New_List;
2000 Set_Generic_Associations (I_Node, Actuals);
2003 Subp := Node (Elmt);
2005 Make_Generic_Association (Sloc (Subp),
2006 Selector_Name => New_Occurrence_Of (Subp, Sloc (Subp)),
2007 Explicit_Generic_Actual_Parameter =>
2008 New_Occurrence_Of (Subp, Sloc (Subp)));
2009 Mark_Rewrite_Insertion (New_D);
2010 Append_To (Actuals, New_D);
2015 -- If this is a formal package, normalize the parameter list by adding
2016 -- explicit box associations for the formals that are covered by an
2019 if not Is_Empty_List (Default_Formals) then
2020 Append_List (Default_Formals, Formals);
2024 end Analyze_Associations;
2026 -------------------------------
2027 -- Analyze_Formal_Array_Type --
2028 -------------------------------
2030 procedure Analyze_Formal_Array_Type
2031 (T : in out Entity_Id;
2037 -- Treated like a non-generic array declaration, with additional
2042 if Nkind (Def) = N_Constrained_Array_Definition then
2043 DSS := First (Discrete_Subtype_Definitions (Def));
2044 while Present (DSS) loop
2045 if Nkind_In (DSS, N_Subtype_Indication,
2047 N_Attribute_Reference)
2049 Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
2056 Array_Type_Declaration (T, Def);
2057 Set_Is_Generic_Type (Base_Type (T));
2059 if Ekind (Component_Type (T)) = E_Incomplete_Type
2060 and then No (Full_View (Component_Type (T)))
2062 Error_Msg_N ("premature usage of incomplete type", Def);
2064 -- Check that range constraint is not allowed on the component type
2065 -- of a generic formal array type (AARM 12.5.3(3))
2067 elsif Is_Internal (Component_Type (T))
2068 and then Present (Subtype_Indication (Component_Definition (Def)))
2069 and then Nkind (Original_Node
2070 (Subtype_Indication (Component_Definition (Def)))) =
2071 N_Subtype_Indication
2074 ("in a formal, a subtype indication can only be "
2075 & "a subtype mark (RM 12.5.3(3))",
2076 Subtype_Indication (Component_Definition (Def)));
2079 end Analyze_Formal_Array_Type;
2081 ---------------------------------------------
2082 -- Analyze_Formal_Decimal_Fixed_Point_Type --
2083 ---------------------------------------------
2085 -- As for other generic types, we create a valid type representation with
2086 -- legal but arbitrary attributes, whose values are never considered
2087 -- static. For all scalar types we introduce an anonymous base type, with
2088 -- the same attributes. We choose the corresponding integer type to be
2089 -- Standard_Integer.
2090 -- Here and in other similar routines, the Sloc of the generated internal
2091 -- type must be the same as the sloc of the defining identifier of the
2092 -- formal type declaration, to provide proper source navigation.
2094 procedure Analyze_Formal_Decimal_Fixed_Point_Type
2098 Loc : constant Source_Ptr := Sloc (Def);
2100 Base : constant Entity_Id :=
2102 (E_Decimal_Fixed_Point_Type,
2104 Sloc (Defining_Identifier (Parent (Def))), 'G');
2106 Int_Base : constant Entity_Id := Standard_Integer;
2107 Delta_Val : constant Ureal := Ureal_1;
2108 Digs_Val : constant Uint := Uint_6;
2110 function Make_Dummy_Bound return Node_Id;
2111 -- Return a properly typed universal real literal to use as a bound
2113 ----------------------
2114 -- Make_Dummy_Bound --
2115 ----------------------
2117 function Make_Dummy_Bound return Node_Id is
2118 Bound : constant Node_Id := Make_Real_Literal (Loc, Ureal_1);
2120 Set_Etype (Bound, Universal_Real);
2122 end Make_Dummy_Bound;
2124 -- Start of processing for Analyze_Formal_Decimal_Fixed_Point_Type
2129 Set_Etype (Base, Base);
2130 Set_Size_Info (Base, Int_Base);
2131 Set_RM_Size (Base, RM_Size (Int_Base));
2132 Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
2133 Set_Digits_Value (Base, Digs_Val);
2134 Set_Delta_Value (Base, Delta_Val);
2135 Set_Small_Value (Base, Delta_Val);
2136 Set_Scalar_Range (Base,
2138 Low_Bound => Make_Dummy_Bound,
2139 High_Bound => Make_Dummy_Bound));
2141 Set_Is_Generic_Type (Base);
2142 Set_Parent (Base, Parent (Def));
2144 Set_Ekind (T, E_Decimal_Fixed_Point_Subtype);
2145 Set_Etype (T, Base);
2146 Set_Size_Info (T, Int_Base);
2147 Set_RM_Size (T, RM_Size (Int_Base));
2148 Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
2149 Set_Digits_Value (T, Digs_Val);
2150 Set_Delta_Value (T, Delta_Val);
2151 Set_Small_Value (T, Delta_Val);
2152 Set_Scalar_Range (T, Scalar_Range (Base));
2153 Set_Is_Constrained (T);
2155 Check_Restriction (No_Fixed_Point, Def);
2156 end Analyze_Formal_Decimal_Fixed_Point_Type;
2158 -------------------------------------------
2159 -- Analyze_Formal_Derived_Interface_Type --
2160 -------------------------------------------
2162 procedure Analyze_Formal_Derived_Interface_Type
2167 Loc : constant Source_Ptr := Sloc (Def);
2170 -- Rewrite as a type declaration of a derived type. This ensures that
2171 -- the interface list and primitive operations are properly captured.
2174 Make_Full_Type_Declaration (Loc,
2175 Defining_Identifier => T,
2176 Type_Definition => Def));
2178 Set_Is_Generic_Type (T);
2179 end Analyze_Formal_Derived_Interface_Type;
2181 ---------------------------------
2182 -- Analyze_Formal_Derived_Type --
2183 ---------------------------------
2185 procedure Analyze_Formal_Derived_Type
2190 Loc : constant Source_Ptr := Sloc (Def);
2191 Unk_Disc : constant Boolean := Unknown_Discriminants_Present (N);
2195 Set_Is_Generic_Type (T);
2197 if Private_Present (Def) then
2199 Make_Private_Extension_Declaration (Loc,
2200 Defining_Identifier => T,
2201 Discriminant_Specifications => Discriminant_Specifications (N),
2202 Unknown_Discriminants_Present => Unk_Disc,
2203 Subtype_Indication => Subtype_Mark (Def),
2204 Interface_List => Interface_List (Def));
2206 Set_Abstract_Present (New_N, Abstract_Present (Def));
2207 Set_Limited_Present (New_N, Limited_Present (Def));
2208 Set_Synchronized_Present (New_N, Synchronized_Present (Def));
2212 Make_Full_Type_Declaration (Loc,
2213 Defining_Identifier => T,
2214 Discriminant_Specifications =>
2215 Discriminant_Specifications (Parent (T)),
2217 Make_Derived_Type_Definition (Loc,
2218 Subtype_Indication => Subtype_Mark (Def)));
2220 Set_Abstract_Present
2221 (Type_Definition (New_N), Abstract_Present (Def));
2223 (Type_Definition (New_N), Limited_Present (Def));
2230 if not Is_Composite_Type (T) then
2232 ("unknown discriminants not allowed for elementary types", N);
2234 Set_Has_Unknown_Discriminants (T);
2235 Set_Is_Constrained (T, False);
2239 -- If the parent type has a known size, so does the formal, which makes
2240 -- legal representation clauses that involve the formal.
2242 Set_Size_Known_At_Compile_Time
2243 (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
2244 end Analyze_Formal_Derived_Type;
2246 ----------------------------------
2247 -- Analyze_Formal_Discrete_Type --
2248 ----------------------------------
2250 -- The operations defined for a discrete types are those of an enumeration
2251 -- type. The size is set to an arbitrary value, for use in analyzing the
2254 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
2255 Loc : constant Source_Ptr := Sloc (Def);
2259 Base : constant Entity_Id :=
2261 (E_Floating_Point_Type, Current_Scope,
2262 Sloc (Defining_Identifier (Parent (Def))), 'G');
2266 Set_Ekind (T, E_Enumeration_Subtype);
2267 Set_Etype (T, Base);
2270 Set_Is_Generic_Type (T);
2271 Set_Is_Constrained (T);
2273 -- For semantic analysis, the bounds of the type must be set to some
2274 -- non-static value. The simplest is to create attribute nodes for those
2275 -- bounds, that refer to the type itself. These bounds are never
2276 -- analyzed but serve as place-holders.
2279 Make_Attribute_Reference (Loc,
2280 Attribute_Name => Name_First,
2281 Prefix => New_Occurrence_Of (T, Loc));
2285 Make_Attribute_Reference (Loc,
2286 Attribute_Name => Name_Last,
2287 Prefix => New_Occurrence_Of (T, Loc));
2290 Set_Scalar_Range (T,
2295 Set_Ekind (Base, E_Enumeration_Type);
2296 Set_Etype (Base, Base);
2297 Init_Size (Base, 8);
2298 Init_Alignment (Base);
2299 Set_Is_Generic_Type (Base);
2300 Set_Scalar_Range (Base, Scalar_Range (T));
2301 Set_Parent (Base, Parent (Def));
2302 end Analyze_Formal_Discrete_Type;
2304 ----------------------------------
2305 -- Analyze_Formal_Floating_Type --
2306 ---------------------------------
2308 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
2309 Base : constant Entity_Id :=
2311 (E_Floating_Point_Type, Current_Scope,
2312 Sloc (Defining_Identifier (Parent (Def))), 'G');
2315 -- The various semantic attributes are taken from the predefined type
2316 -- Float, just so that all of them are initialized. Their values are
2317 -- never used because no constant folding or expansion takes place in
2318 -- the generic itself.
2321 Set_Ekind (T, E_Floating_Point_Subtype);
2322 Set_Etype (T, Base);
2323 Set_Size_Info (T, (Standard_Float));
2324 Set_RM_Size (T, RM_Size (Standard_Float));
2325 Set_Digits_Value (T, Digits_Value (Standard_Float));
2326 Set_Scalar_Range (T, Scalar_Range (Standard_Float));
2327 Set_Is_Constrained (T);
2329 Set_Is_Generic_Type (Base);
2330 Set_Etype (Base, Base);
2331 Set_Size_Info (Base, (Standard_Float));
2332 Set_RM_Size (Base, RM_Size (Standard_Float));
2333 Set_Digits_Value (Base, Digits_Value (Standard_Float));
2334 Set_Scalar_Range (Base, Scalar_Range (Standard_Float));
2335 Set_Parent (Base, Parent (Def));
2337 Check_Restriction (No_Floating_Point, Def);
2338 end Analyze_Formal_Floating_Type;
2340 -----------------------------------
2341 -- Analyze_Formal_Interface_Type;--
2342 -----------------------------------
2344 procedure Analyze_Formal_Interface_Type
2349 Loc : constant Source_Ptr := Sloc (N);
2354 Make_Full_Type_Declaration (Loc,
2355 Defining_Identifier => T,
2356 Type_Definition => Def);
2360 Set_Is_Generic_Type (T);
2361 end Analyze_Formal_Interface_Type;
2363 ---------------------------------
2364 -- Analyze_Formal_Modular_Type --
2365 ---------------------------------
2367 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
2369 -- Apart from their entity kind, generic modular types are treated like
2370 -- signed integer types, and have the same attributes.
2372 Analyze_Formal_Signed_Integer_Type (T, Def);
2373 Set_Ekind (T, E_Modular_Integer_Subtype);
2374 Set_Ekind (Etype (T), E_Modular_Integer_Type);
2376 end Analyze_Formal_Modular_Type;
2378 ---------------------------------------
2379 -- Analyze_Formal_Object_Declaration --
2380 ---------------------------------------
2382 procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
2383 E : constant Node_Id := Default_Expression (N);
2384 Id : constant Node_Id := Defining_Identifier (N);
2391 -- Determine the mode of the formal object
2393 if Out_Present (N) then
2394 K := E_Generic_In_Out_Parameter;
2396 if not In_Present (N) then
2397 Error_Msg_N ("formal generic objects cannot have mode OUT", N);
2401 K := E_Generic_In_Parameter;
2404 if Present (Subtype_Mark (N)) then
2405 Find_Type (Subtype_Mark (N));
2406 T := Entity (Subtype_Mark (N));
2408 -- Verify that there is no redundant null exclusion
2410 if Null_Exclusion_Present (N) then
2411 if not Is_Access_Type (T) then
2413 ("null exclusion can only apply to an access type", N);
2415 elsif Can_Never_Be_Null (T) then
2417 ("`NOT NULL` not allowed (& already excludes null)",
2422 -- Ada 2005 (AI-423): Formal object with an access definition
2425 Check_Access_Definition (N);
2426 T := Access_Definition
2428 N => Access_Definition (N));
2431 if Ekind (T) = E_Incomplete_Type then
2433 Error_Node : Node_Id;
2436 if Present (Subtype_Mark (N)) then
2437 Error_Node := Subtype_Mark (N);
2439 Check_Access_Definition (N);
2440 Error_Node := Access_Definition (N);
2443 Error_Msg_N ("premature usage of incomplete type", Error_Node);
2447 if K = E_Generic_In_Parameter then
2449 -- Ada 2005 (AI-287): Limited aggregates allowed in generic formals
2451 if Ada_Version < Ada_2005 and then Is_Limited_Type (T) then
2453 ("generic formal of mode IN must not be of limited type", N);
2454 Explain_Limited_Type (T, N);
2457 if Is_Abstract_Type (T) then
2459 ("generic formal of mode IN must not be of abstract type", N);
2463 Preanalyze_Spec_Expression (E, T);
2465 if Is_Limited_Type (T) and then not OK_For_Limited_Init (T, E) then
2467 ("initialization not allowed for limited types", E);
2468 Explain_Limited_Type (T, E);
2475 -- Case of generic IN OUT parameter
2478 -- If the formal has an unconstrained type, construct its actual
2479 -- subtype, as is done for subprogram formals. In this fashion, all
2480 -- its uses can refer to specific bounds.
2485 if (Is_Array_Type (T) and then not Is_Constrained (T))
2486 or else (Ekind (T) = E_Record_Type and then Has_Discriminants (T))
2489 Non_Freezing_Ref : constant Node_Id :=
2490 New_Occurrence_Of (Id, Sloc (Id));
2494 -- Make sure the actual subtype doesn't generate bogus freezing
2496 Set_Must_Not_Freeze (Non_Freezing_Ref);
2497 Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
2498 Insert_Before_And_Analyze (N, Decl);
2499 Set_Actual_Subtype (Id, Defining_Identifier (Decl));
2502 Set_Actual_Subtype (Id, T);
2507 ("initialization not allowed for `IN OUT` formals", N);
2511 if Has_Aspects (N) then
2512 Analyze_Aspect_Specifications (N, Id);
2514 end Analyze_Formal_Object_Declaration;
2516 ----------------------------------------------
2517 -- Analyze_Formal_Ordinary_Fixed_Point_Type --
2518 ----------------------------------------------
2520 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
2524 Loc : constant Source_Ptr := Sloc (Def);
2525 Base : constant Entity_Id :=
2527 (E_Ordinary_Fixed_Point_Type, Current_Scope,
2528 Sloc (Defining_Identifier (Parent (Def))), 'G');
2531 -- The semantic attributes are set for completeness only, their values
2532 -- will never be used, since all properties of the type are non-static.
2535 Set_Ekind (T, E_Ordinary_Fixed_Point_Subtype);
2536 Set_Etype (T, Base);
2537 Set_Size_Info (T, Standard_Integer);
2538 Set_RM_Size (T, RM_Size (Standard_Integer));
2539 Set_Small_Value (T, Ureal_1);
2540 Set_Delta_Value (T, Ureal_1);
2541 Set_Scalar_Range (T,
2543 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
2544 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
2545 Set_Is_Constrained (T);
2547 Set_Is_Generic_Type (Base);
2548 Set_Etype (Base, Base);
2549 Set_Size_Info (Base, Standard_Integer);
2550 Set_RM_Size (Base, RM_Size (Standard_Integer));
2551 Set_Small_Value (Base, Ureal_1);
2552 Set_Delta_Value (Base, Ureal_1);
2553 Set_Scalar_Range (Base, Scalar_Range (T));
2554 Set_Parent (Base, Parent (Def));
2556 Check_Restriction (No_Fixed_Point, Def);
2557 end Analyze_Formal_Ordinary_Fixed_Point_Type;
2559 ----------------------------------------
2560 -- Analyze_Formal_Package_Declaration --
2561 ----------------------------------------
2563 procedure Analyze_Formal_Package_Declaration (N : Node_Id) is
2564 Loc : constant Source_Ptr := Sloc (N);
2565 Pack_Id : constant Entity_Id := Defining_Identifier (N);
2567 Gen_Id : constant Node_Id := Name (N);
2569 Gen_Unit : Entity_Id;
2571 Parent_Installed : Boolean := False;
2573 Parent_Instance : Entity_Id;
2574 Renaming_In_Par : Entity_Id;
2575 Associations : Boolean := True;
2577 Vis_Prims_List : Elist_Id := No_Elist;
2578 -- List of primitives made temporarily visible in the instantiation
2579 -- to match the visibility of the formal type
2581 function Build_Local_Package return Node_Id;
2582 -- The formal package is rewritten so that its parameters are replaced
2583 -- with corresponding declarations. For parameters with bona fide
2584 -- associations these declarations are created by Analyze_Associations
2585 -- as for a regular instantiation. For boxed parameters, we preserve
2586 -- the formal declarations and analyze them, in order to introduce
2587 -- entities of the right kind in the environment of the formal.
2589 -------------------------
2590 -- Build_Local_Package --
2591 -------------------------
2593 function Build_Local_Package return Node_Id is
2595 Pack_Decl : Node_Id;
2598 -- Within the formal, the name of the generic package is a renaming
2599 -- of the formal (as for a regular instantiation).
2602 Make_Package_Declaration (Loc,
2605 (Specification (Original_Node (Gen_Decl)),
2606 Empty, Instantiating => True));
2608 Renaming := Make_Package_Renaming_Declaration (Loc,
2609 Defining_Unit_Name =>
2610 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2611 Name => New_Occurrence_Of (Formal, Loc));
2613 if Nkind (Gen_Id) = N_Identifier
2614 and then Chars (Gen_Id) = Chars (Pack_Id)
2617 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2620 -- If the formal is declared with a box, or with an others choice,
2621 -- create corresponding declarations for all entities in the formal
2622 -- part, so that names with the proper types are available in the
2623 -- specification of the formal package.
2625 -- On the other hand, if there are no associations, then all the
2626 -- formals must have defaults, and this will be checked by the
2627 -- call to Analyze_Associations.
2630 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2633 Formal_Decl : Node_Id;
2636 -- TBA : for a formal package, need to recurse ???
2641 (Generic_Formal_Declarations (Original_Node (Gen_Decl)));
2642 while Present (Formal_Decl) loop
2644 (Decls, Copy_Generic_Node (Formal_Decl, Empty, True));
2649 -- If generic associations are present, use Analyze_Associations to
2650 -- create the proper renaming declarations.
2654 Act_Tree : constant Node_Id :=
2656 (Original_Node (Gen_Decl), Empty,
2657 Instantiating => True);
2660 Generic_Renamings.Set_Last (0);
2661 Generic_Renamings_HTable.Reset;
2662 Instantiation_Node := N;
2665 Analyze_Associations
2666 (I_Node => Original_Node (N),
2667 Formals => Generic_Formal_Declarations (Act_Tree),
2668 F_Copy => Generic_Formal_Declarations (Gen_Decl));
2670 Vis_Prims_List := Check_Hidden_Primitives (Decls);
2674 Append (Renaming, To => Decls);
2676 -- Add generated declarations ahead of local declarations in
2679 if No (Visible_Declarations (Specification (Pack_Decl))) then
2680 Set_Visible_Declarations (Specification (Pack_Decl), Decls);
2683 (First (Visible_Declarations (Specification (Pack_Decl))),
2688 end Build_Local_Package;
2690 -- Start of processing for Analyze_Formal_Package_Declaration
2693 Check_Text_IO_Special_Unit (Gen_Id);
2696 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2697 Gen_Unit := Entity (Gen_Id);
2699 -- Check for a formal package that is a package renaming
2701 if Present (Renamed_Object (Gen_Unit)) then
2703 -- Indicate that unit is used, before replacing it with renamed
2704 -- entity for use below.
2706 if In_Extended_Main_Source_Unit (N) then
2707 Set_Is_Instantiated (Gen_Unit);
2708 Generate_Reference (Gen_Unit, N);
2711 Gen_Unit := Renamed_Object (Gen_Unit);
2714 if Ekind (Gen_Unit) /= E_Generic_Package then
2715 Error_Msg_N ("expect generic package name", Gen_Id);
2719 elsif Gen_Unit = Current_Scope then
2721 ("generic package cannot be used as a formal package of itself",
2726 elsif In_Open_Scopes (Gen_Unit) then
2727 if Is_Compilation_Unit (Gen_Unit)
2728 and then Is_Child_Unit (Current_Scope)
2730 -- Special-case the error when the formal is a parent, and
2731 -- continue analysis to minimize cascaded errors.
2734 ("generic parent cannot be used as formal package "
2735 & "of a child unit",
2740 ("generic package cannot be used as a formal package "
2748 -- Check that name of formal package does not hide name of generic,
2749 -- or its leading prefix. This check must be done separately because
2750 -- the name of the generic has already been analyzed.
2753 Gen_Name : Entity_Id;
2757 while Nkind (Gen_Name) = N_Expanded_Name loop
2758 Gen_Name := Prefix (Gen_Name);
2761 if Chars (Gen_Name) = Chars (Pack_Id) then
2763 ("& is hidden within declaration of formal package",
2769 or else No (Generic_Associations (N))
2770 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2772 Associations := False;
2775 -- If there are no generic associations, the generic parameters appear
2776 -- as local entities and are instantiated like them. We copy the generic
2777 -- package declaration as if it were an instantiation, and analyze it
2778 -- like a regular package, except that we treat the formals as
2779 -- additional visible components.
2781 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2783 if In_Extended_Main_Source_Unit (N) then
2784 Set_Is_Instantiated (Gen_Unit);
2785 Generate_Reference (Gen_Unit, N);
2788 Formal := New_Copy (Pack_Id);
2789 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2792 -- Make local generic without formals. The formals will be replaced
2793 -- with internal declarations.
2795 New_N := Build_Local_Package;
2797 -- If there are errors in the parameter list, Analyze_Associations
2798 -- raises Instantiation_Error. Patch the declaration to prevent
2799 -- further exception propagation.
2802 when Instantiation_Error =>
2804 Enter_Name (Formal);
2805 Set_Ekind (Formal, E_Variable);
2806 Set_Etype (Formal, Any_Type);
2807 Restore_Hidden_Primitives (Vis_Prims_List);
2809 if Parent_Installed then
2817 Set_Defining_Unit_Name (Specification (New_N), Formal);
2818 Set_Generic_Parent (Specification (N), Gen_Unit);
2819 Set_Instance_Env (Gen_Unit, Formal);
2820 Set_Is_Generic_Instance (Formal);
2822 Enter_Name (Formal);
2823 Set_Ekind (Formal, E_Package);
2824 Set_Etype (Formal, Standard_Void_Type);
2825 Set_Inner_Instances (Formal, New_Elmt_List);
2826 Push_Scope (Formal);
2828 if Is_Child_Unit (Gen_Unit)
2829 and then Parent_Installed
2831 -- Similarly, we have to make the name of the formal visible in the
2832 -- parent instance, to resolve properly fully qualified names that
2833 -- may appear in the generic unit. The parent instance has been
2834 -- placed on the scope stack ahead of the current scope.
2836 Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
2839 Make_Defining_Identifier (Loc, Chars (Gen_Unit));
2840 Set_Ekind (Renaming_In_Par, E_Package);
2841 Set_Etype (Renaming_In_Par, Standard_Void_Type);
2842 Set_Scope (Renaming_In_Par, Parent_Instance);
2843 Set_Parent (Renaming_In_Par, Parent (Formal));
2844 Set_Renamed_Object (Renaming_In_Par, Formal);
2845 Append_Entity (Renaming_In_Par, Parent_Instance);
2848 Analyze (Specification (N));
2850 -- The formals for which associations are provided are not visible
2851 -- outside of the formal package. The others are still declared by a
2852 -- formal parameter declaration.
2854 -- If there are no associations, the only local entity to hide is the
2855 -- generated package renaming itself.
2861 E := First_Entity (Formal);
2862 while Present (E) loop
2864 and then not Is_Generic_Formal (E)
2869 if Ekind (E) = E_Package
2870 and then Renamed_Entity (E) = Formal
2880 End_Package_Scope (Formal);
2881 Restore_Hidden_Primitives (Vis_Prims_List);
2883 if Parent_Installed then
2889 -- Inside the generic unit, the formal package is a regular package, but
2890 -- no body is needed for it. Note that after instantiation, the defining
2891 -- unit name we need is in the new tree and not in the original (see
2892 -- Package_Instantiation). A generic formal package is an instance, and
2893 -- can be used as an actual for an inner instance.
2895 Set_Has_Completion (Formal, True);
2897 -- Add semantic information to the original defining identifier.
2900 Set_Ekind (Pack_Id, E_Package);
2901 Set_Etype (Pack_Id, Standard_Void_Type);
2902 Set_Scope (Pack_Id, Scope (Formal));
2903 Set_Has_Completion (Pack_Id, True);
2906 if Has_Aspects (N) then
2907 Analyze_Aspect_Specifications (N, Pack_Id);
2909 end Analyze_Formal_Package_Declaration;
2911 ---------------------------------
2912 -- Analyze_Formal_Private_Type --
2913 ---------------------------------
2915 procedure Analyze_Formal_Private_Type
2921 New_Private_Type (N, T, Def);
2923 -- Set the size to an arbitrary but legal value
2925 Set_Size_Info (T, Standard_Integer);
2926 Set_RM_Size (T, RM_Size (Standard_Integer));
2927 end Analyze_Formal_Private_Type;
2929 ------------------------------------
2930 -- Analyze_Formal_Incomplete_Type --
2931 ------------------------------------
2933 procedure Analyze_Formal_Incomplete_Type
2939 Set_Ekind (T, E_Incomplete_Type);
2941 Set_Private_Dependents (T, New_Elmt_List);
2943 if Tagged_Present (Def) then
2944 Set_Is_Tagged_Type (T);
2945 Make_Class_Wide_Type (T);
2946 Set_Direct_Primitive_Operations (T, New_Elmt_List);
2948 end Analyze_Formal_Incomplete_Type;
2950 ----------------------------------------
2951 -- Analyze_Formal_Signed_Integer_Type --
2952 ----------------------------------------
2954 procedure Analyze_Formal_Signed_Integer_Type
2958 Base : constant Entity_Id :=
2960 (E_Signed_Integer_Type,
2962 Sloc (Defining_Identifier (Parent (Def))), 'G');
2967 Set_Ekind (T, E_Signed_Integer_Subtype);
2968 Set_Etype (T, Base);
2969 Set_Size_Info (T, Standard_Integer);
2970 Set_RM_Size (T, RM_Size (Standard_Integer));
2971 Set_Scalar_Range (T, Scalar_Range (Standard_Integer));
2972 Set_Is_Constrained (T);
2974 Set_Is_Generic_Type (Base);
2975 Set_Size_Info (Base, Standard_Integer);
2976 Set_RM_Size (Base, RM_Size (Standard_Integer));
2977 Set_Etype (Base, Base);
2978 Set_Scalar_Range (Base, Scalar_Range (Standard_Integer));
2979 Set_Parent (Base, Parent (Def));
2980 end Analyze_Formal_Signed_Integer_Type;
2982 -------------------------------------------
2983 -- Analyze_Formal_Subprogram_Declaration --
2984 -------------------------------------------
2986 procedure Analyze_Formal_Subprogram_Declaration (N : Node_Id) is
2987 Spec : constant Node_Id := Specification (N);
2988 Def : constant Node_Id := Default_Name (N);
2989 Nam : constant Entity_Id := Defining_Unit_Name (Spec);
2997 if Nkind (Nam) = N_Defining_Program_Unit_Name then
2998 Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
3002 Analyze_Subprogram_Declaration (N);
3003 Set_Is_Formal_Subprogram (Nam);
3004 Set_Has_Completion (Nam);
3006 if Nkind (N) = N_Formal_Abstract_Subprogram_Declaration then
3007 Set_Is_Abstract_Subprogram (Nam);
3008 Set_Is_Dispatching_Operation (Nam);
3011 Ctrl_Type : constant Entity_Id := Find_Dispatching_Type (Nam);
3013 if No (Ctrl_Type) then
3015 ("abstract formal subprogram must have a controlling type",
3018 elsif Ada_Version >= Ada_2012
3019 and then Is_Incomplete_Type (Ctrl_Type)
3022 ("controlling type of abstract formal subprogram cannot " &
3023 "be incomplete type", N, Ctrl_Type);
3026 Check_Controlling_Formals (Ctrl_Type, Nam);
3031 -- Default name is resolved at the point of instantiation
3033 if Box_Present (N) then
3036 -- Else default is bound at the point of generic declaration
3038 elsif Present (Def) then
3039 if Nkind (Def) = N_Operator_Symbol then
3040 Find_Direct_Name (Def);
3042 elsif Nkind (Def) /= N_Attribute_Reference then
3046 -- For an attribute reference, analyze the prefix and verify
3047 -- that it has the proper profile for the subprogram.
3049 Analyze (Prefix (Def));
3050 Valid_Default_Attribute (Nam, Def);
3054 -- Default name may be overloaded, in which case the interpretation
3055 -- with the correct profile must be selected, as for a renaming.
3056 -- If the definition is an indexed component, it must denote a
3057 -- member of an entry family. If it is a selected component, it
3058 -- can be a protected operation.
3060 if Etype (Def) = Any_Type then
3063 elsif Nkind (Def) = N_Selected_Component then
3064 if not Is_Overloadable (Entity (Selector_Name (Def))) then
3065 Error_Msg_N ("expect valid subprogram name as default", Def);
3068 elsif Nkind (Def) = N_Indexed_Component then
3069 if Is_Entity_Name (Prefix (Def)) then
3070 if Ekind (Entity (Prefix (Def))) /= E_Entry_Family then
3071 Error_Msg_N ("expect valid subprogram name as default", Def);
3074 elsif Nkind (Prefix (Def)) = N_Selected_Component then
3075 if Ekind (Entity (Selector_Name (Prefix (Def)))) /=
3078 Error_Msg_N ("expect valid subprogram name as default", Def);
3082 Error_Msg_N ("expect valid subprogram name as default", Def);
3086 elsif Nkind (Def) = N_Character_Literal then
3088 -- Needs some type checks: subprogram should be parameterless???
3090 Resolve (Def, (Etype (Nam)));
3092 elsif not Is_Entity_Name (Def)
3093 or else not Is_Overloadable (Entity (Def))
3095 Error_Msg_N ("expect valid subprogram name as default", Def);
3098 elsif not Is_Overloaded (Def) then
3099 Subp := Entity (Def);
3102 Error_Msg_N ("premature usage of formal subprogram", Def);
3104 elsif not Entity_Matches_Spec (Subp, Nam) then
3105 Error_Msg_N ("no visible entity matches specification", Def);
3108 -- More than one interpretation, so disambiguate as for a renaming
3113 I1 : Interp_Index := 0;
3119 Get_First_Interp (Def, I, It);
3120 while Present (It.Nam) loop
3121 if Entity_Matches_Spec (It.Nam, Nam) then
3122 if Subp /= Any_Id then
3123 It1 := Disambiguate (Def, I1, I, Etype (Subp));
3125 if It1 = No_Interp then
3126 Error_Msg_N ("ambiguous default subprogram", Def);
3139 Get_Next_Interp (I, It);
3143 if Subp /= Any_Id then
3145 -- Subprogram found, generate reference to it
3147 Set_Entity (Def, Subp);
3148 Generate_Reference (Subp, Def);
3151 Error_Msg_N ("premature usage of formal subprogram", Def);
3153 elsif Ekind (Subp) /= E_Operator then
3154 Check_Mode_Conformant (Subp, Nam);
3158 Error_Msg_N ("no visible subprogram matches specification", N);
3164 if Has_Aspects (N) then
3165 Analyze_Aspect_Specifications (N, Nam);
3168 end Analyze_Formal_Subprogram_Declaration;
3170 -------------------------------------
3171 -- Analyze_Formal_Type_Declaration --
3172 -------------------------------------
3174 procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
3175 Def : constant Node_Id := Formal_Type_Definition (N);
3179 T := Defining_Identifier (N);
3181 if Present (Discriminant_Specifications (N))
3182 and then Nkind (Def) /= N_Formal_Private_Type_Definition
3185 ("discriminants not allowed for this formal type", T);
3188 -- Enter the new name, and branch to specific routine
3191 when N_Formal_Private_Type_Definition =>
3192 Analyze_Formal_Private_Type (N, T, Def);
3194 when N_Formal_Derived_Type_Definition =>
3195 Analyze_Formal_Derived_Type (N, T, Def);
3197 when N_Formal_Incomplete_Type_Definition =>
3198 Analyze_Formal_Incomplete_Type (T, Def);
3200 when N_Formal_Discrete_Type_Definition =>
3201 Analyze_Formal_Discrete_Type (T, Def);
3203 when N_Formal_Signed_Integer_Type_Definition =>
3204 Analyze_Formal_Signed_Integer_Type (T, Def);
3206 when N_Formal_Modular_Type_Definition =>
3207 Analyze_Formal_Modular_Type (T, Def);
3209 when N_Formal_Floating_Point_Definition =>
3210 Analyze_Formal_Floating_Type (T, Def);
3212 when N_Formal_Ordinary_Fixed_Point_Definition =>
3213 Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
3215 when N_Formal_Decimal_Fixed_Point_Definition =>
3216 Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
3218 when N_Array_Type_Definition =>
3219 Analyze_Formal_Array_Type (T, Def);
3221 when N_Access_To_Object_Definition |
3222 N_Access_Function_Definition |
3223 N_Access_Procedure_Definition =>
3224 Analyze_Generic_Access_Type (T, Def);
3226 -- Ada 2005: a interface declaration is encoded as an abstract
3227 -- record declaration or a abstract type derivation.
3229 when N_Record_Definition =>
3230 Analyze_Formal_Interface_Type (N, T, Def);
3232 when N_Derived_Type_Definition =>
3233 Analyze_Formal_Derived_Interface_Type (N, T, Def);
3239 raise Program_Error;
3243 Set_Is_Generic_Type (T);
3245 if Has_Aspects (N) then
3246 Analyze_Aspect_Specifications (N, T);
3248 end Analyze_Formal_Type_Declaration;
3250 ------------------------------------
3251 -- Analyze_Function_Instantiation --
3252 ------------------------------------
3254 procedure Analyze_Function_Instantiation (N : Node_Id) is
3256 Analyze_Subprogram_Instantiation (N, E_Function);
3257 end Analyze_Function_Instantiation;
3259 ---------------------------------
3260 -- Analyze_Generic_Access_Type --
3261 ---------------------------------
3263 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
3267 if Nkind (Def) = N_Access_To_Object_Definition then
3268 Access_Type_Declaration (T, Def);
3270 if Is_Incomplete_Or_Private_Type (Designated_Type (T))
3271 and then No (Full_View (Designated_Type (T)))
3272 and then not Is_Generic_Type (Designated_Type (T))
3274 Error_Msg_N ("premature usage of incomplete type", Def);
3276 elsif not Is_Entity_Name (Subtype_Indication (Def)) then
3278 ("only a subtype mark is allowed in a formal", Def);
3282 Access_Subprogram_Declaration (T, Def);
3284 end Analyze_Generic_Access_Type;
3286 ---------------------------------
3287 -- Analyze_Generic_Formal_Part --
3288 ---------------------------------
3290 procedure Analyze_Generic_Formal_Part (N : Node_Id) is
3291 Gen_Parm_Decl : Node_Id;
3294 -- The generic formals are processed in the scope of the generic unit,
3295 -- where they are immediately visible. The scope is installed by the
3298 Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
3300 while Present (Gen_Parm_Decl) loop
3301 Analyze (Gen_Parm_Decl);
3302 Next (Gen_Parm_Decl);
3305 Generate_Reference_To_Generic_Formals (Current_Scope);
3306 end Analyze_Generic_Formal_Part;
3308 ------------------------------------------
3309 -- Analyze_Generic_Package_Declaration --
3310 ------------------------------------------
3312 procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
3313 Loc : constant Source_Ptr := Sloc (N);
3316 Save_Parent : Node_Id;
3318 Decls : constant List_Id :=
3319 Visible_Declarations (Specification (N));
3323 Check_SPARK_05_Restriction ("generic is not allowed", N);
3325 -- We introduce a renaming of the enclosing package, to have a usable
3326 -- entity as the prefix of an expanded name for a local entity of the
3327 -- form Par.P.Q, where P is the generic package. This is because a local
3328 -- entity named P may hide it, so that the usual visibility rules in
3329 -- the instance will not resolve properly.
3332 Make_Package_Renaming_Declaration (Loc,
3333 Defining_Unit_Name =>
3334 Make_Defining_Identifier (Loc,
3335 Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
3336 Name => Make_Identifier (Loc, Chars (Defining_Entity (N))));
3338 if Present (Decls) then
3339 Decl := First (Decls);
3340 while Present (Decl)
3341 and then Nkind (Decl) = N_Pragma
3346 if Present (Decl) then
3347 Insert_Before (Decl, Renaming);
3349 Append (Renaming, Visible_Declarations (Specification (N)));
3353 Set_Visible_Declarations (Specification (N), New_List (Renaming));
3356 -- Create copy of generic unit, and save for instantiation. If the unit
3357 -- is a child unit, do not copy the specifications for the parent, which
3358 -- are not part of the generic tree.
3360 Save_Parent := Parent_Spec (N);
3361 Set_Parent_Spec (N, Empty);
3363 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3364 Set_Parent_Spec (New_N, Save_Parent);
3367 -- Once the contents of the generic copy and the template are swapped,
3368 -- do the same for their respective aspect specifications.
3370 Exchange_Aspects (N, New_N);
3371 Id := Defining_Entity (N);
3372 Generate_Definition (Id);
3374 -- Expansion is not applied to generic units
3379 Set_Ekind (Id, E_Generic_Package);
3380 Set_Etype (Id, Standard_Void_Type);
3381 Set_Contract (Id, Make_Contract (Sloc (Id)));
3383 -- A generic package declared within a Ghost scope is rendered Ghost
3384 -- (SPARK RM 6.9(2)).
3386 if Within_Ghost_Scope then
3387 Set_Is_Ghost_Entity (Id);
3390 -- Analyze aspects now, so that generated pragmas appear in the
3391 -- declarations before building and analyzing the generic copy.
3393 if Has_Aspects (N) then
3394 Analyze_Aspect_Specifications (N, Id);
3398 Enter_Generic_Scope (Id);
3399 Set_Inner_Instances (Id, New_Elmt_List);
3401 Set_Categorization_From_Pragmas (N);
3402 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3404 -- Link the declaration of the generic homonym in the generic copy to
3405 -- the package it renames, so that it is always resolved properly.
3407 Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
3408 Set_Entity (Associated_Node (Name (Renaming)), Id);
3410 -- For a library unit, we have reconstructed the entity for the unit,
3411 -- and must reset it in the library tables.
3413 if Nkind (Parent (N)) = N_Compilation_Unit then
3414 Set_Cunit_Entity (Current_Sem_Unit, Id);
3417 Analyze_Generic_Formal_Part (N);
3419 -- After processing the generic formals, analysis proceeds as for a
3420 -- non-generic package.
3422 Analyze (Specification (N));
3424 Validate_Categorization_Dependency (N, Id);
3428 End_Package_Scope (Id);
3429 Exit_Generic_Scope (Id);
3431 if Nkind (Parent (N)) /= N_Compilation_Unit then
3432 Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
3433 Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
3434 Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
3437 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3438 Validate_RT_RAT_Component (N);
3440 -- If this is a spec without a body, check that generic parameters
3443 if not Body_Required (Parent (N)) then
3444 Check_References (Id);
3448 -- If there is a specified storage pool in the context, create an
3449 -- aspect on the package declaration, so that it is used in any
3450 -- instance that does not override it.
3452 if Present (Default_Pool) then
3458 Make_Aspect_Specification (Loc,
3459 Identifier => Make_Identifier (Loc, Name_Default_Storage_Pool),
3460 Expression => New_Copy (Default_Pool));
3462 if No (Aspect_Specifications (Specification (N))) then
3463 Set_Aspect_Specifications (Specification (N), New_List (ASN));
3465 Append (ASN, Aspect_Specifications (Specification (N)));
3469 end Analyze_Generic_Package_Declaration;
3471 --------------------------------------------
3472 -- Analyze_Generic_Subprogram_Declaration --
3473 --------------------------------------------
3475 procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
3480 Result_Type : Entity_Id;
3481 Save_Parent : Node_Id;
3485 Check_SPARK_05_Restriction ("generic is not allowed", N);
3487 -- Create copy of generic unit, and save for instantiation. If the unit
3488 -- is a child unit, do not copy the specifications for the parent, which
3489 -- are not part of the generic tree.
3491 Save_Parent := Parent_Spec (N);
3492 Set_Parent_Spec (N, Empty);
3494 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3495 Set_Parent_Spec (New_N, Save_Parent);
3498 -- Once the contents of the generic copy and the template are swapped,
3499 -- do the same for their respective aspect specifications.
3501 Exchange_Aspects (N, New_N);
3503 Spec := Specification (N);
3504 Id := Defining_Entity (Spec);
3505 Generate_Definition (Id);
3506 Set_Contract (Id, Make_Contract (Sloc (Id)));
3508 if Nkind (Id) = N_Defining_Operator_Symbol then
3510 ("operator symbol not allowed for generic subprogram", Id);
3516 Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
3518 -- Analyze the aspects of the generic copy to ensure that all generated
3519 -- pragmas (if any) perform their semantic effects.
3521 if Has_Aspects (N) then
3522 Analyze_Aspect_Specifications (N, Id);
3526 Enter_Generic_Scope (Id);
3527 Set_Inner_Instances (Id, New_Elmt_List);
3528 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3530 Analyze_Generic_Formal_Part (N);
3532 Formals := Parameter_Specifications (Spec);
3534 if Present (Formals) then
3535 Process_Formals (Formals, Spec);
3538 if Nkind (Spec) = N_Function_Specification then
3539 Set_Ekind (Id, E_Generic_Function);
3541 if Nkind (Result_Definition (Spec)) = N_Access_Definition then
3542 Result_Type := Access_Definition (Spec, Result_Definition (Spec));
3543 Set_Etype (Id, Result_Type);
3545 -- Check restriction imposed by AI05-073: a generic function
3546 -- cannot return an abstract type or an access to such.
3548 -- This is a binding interpretation should it apply to earlier
3549 -- versions of Ada as well as Ada 2012???
3551 if Is_Abstract_Type (Designated_Type (Result_Type))
3552 and then Ada_Version >= Ada_2012
3554 Error_Msg_N ("generic function cannot have an access result"
3555 & " that designates an abstract type", Spec);
3559 Find_Type (Result_Definition (Spec));
3560 Typ := Entity (Result_Definition (Spec));
3562 if Is_Abstract_Type (Typ)
3563 and then Ada_Version >= Ada_2012
3566 ("generic function cannot have abstract result type", Spec);
3569 -- If a null exclusion is imposed on the result type, then create
3570 -- a null-excluding itype (an access subtype) and use it as the
3571 -- function's Etype.
3573 if Is_Access_Type (Typ)
3574 and then Null_Exclusion_Present (Spec)
3577 Create_Null_Excluding_Itype
3579 Related_Nod => Spec,
3580 Scope_Id => Defining_Unit_Name (Spec)));
3582 Set_Etype (Id, Typ);
3587 Set_Ekind (Id, E_Generic_Procedure);
3588 Set_Etype (Id, Standard_Void_Type);
3591 -- A generic subprogram declared within a Ghost scope is rendered Ghost
3592 -- (SPARK RM 6.9(2)).
3594 if Within_Ghost_Scope then
3595 Set_Is_Ghost_Entity (Id);
3598 -- For a library unit, we have reconstructed the entity for the unit,
3599 -- and must reset it in the library tables. We also make sure that
3600 -- Body_Required is set properly in the original compilation unit node.
3602 if Nkind (Parent (N)) = N_Compilation_Unit then
3603 Set_Cunit_Entity (Current_Sem_Unit, Id);
3604 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3607 Set_Categorization_From_Pragmas (N);
3608 Validate_Categorization_Dependency (N, Id);
3610 Save_Global_References (Original_Node (N));
3612 -- For ASIS purposes, convert any postcondition, precondition pragmas
3613 -- into aspects, if N is not a compilation unit by itself, in order to
3614 -- enable the analysis of expressions inside the corresponding PPC
3617 if ASIS_Mode and then Is_List_Member (N) then
3618 Make_Aspect_For_PPC_In_Gen_Sub_Decl (N);
3623 Exit_Generic_Scope (Id);
3624 Generate_Reference_To_Formals (Id);
3626 List_Inherited_Pre_Post_Aspects (Id);
3627 end Analyze_Generic_Subprogram_Declaration;
3629 -----------------------------------
3630 -- Analyze_Package_Instantiation --
3631 -----------------------------------
3633 procedure Analyze_Package_Instantiation (N : Node_Id) is
3634 Loc : constant Source_Ptr := Sloc (N);
3635 Gen_Id : constant Node_Id := Name (N);
3638 Act_Decl_Name : Node_Id;
3639 Act_Decl_Id : Entity_Id;
3645 Gen_Unit : Entity_Id;
3647 Is_Actual_Pack : constant Boolean :=
3648 Is_Internal (Defining_Entity (N));
3650 Env_Installed : Boolean := False;
3651 Parent_Installed : Boolean := False;
3652 Renaming_List : List_Id;
3653 Unit_Renaming : Node_Id;
3654 Needs_Body : Boolean;
3655 Inline_Now : Boolean := False;
3657 Save_IPSM : constant Boolean := Ignore_Pragma_SPARK_Mode;
3658 -- Save flag Ignore_Pragma_SPARK_Mode for restore on exit
3660 Save_SM : constant SPARK_Mode_Type := SPARK_Mode;
3661 Save_SMP : constant Node_Id := SPARK_Mode_Pragma;
3662 -- Save the SPARK_Mode-related data for restore on exit
3664 Save_Style_Check : constant Boolean := Style_Check;
3665 -- Save style check mode for restore on exit
3667 procedure Delay_Descriptors (E : Entity_Id);
3668 -- Delay generation of subprogram descriptors for given entity
3670 function Might_Inline_Subp return Boolean;
3671 -- If inlining is active and the generic contains inlined subprograms,
3672 -- we instantiate the body. This may cause superfluous instantiations,
3673 -- but it is simpler than detecting the need for the body at the point
3674 -- of inlining, when the context of the instance is not available.
3676 -----------------------
3677 -- Delay_Descriptors --
3678 -----------------------
3680 procedure Delay_Descriptors (E : Entity_Id) is
3682 if not Delay_Subprogram_Descriptors (E) then
3683 Set_Delay_Subprogram_Descriptors (E);
3684 Pending_Descriptor.Append (E);
3686 end Delay_Descriptors;
3688 -----------------------
3689 -- Might_Inline_Subp --
3690 -----------------------
3692 function Might_Inline_Subp return Boolean is
3696 if not Inline_Processing_Required then
3700 E := First_Entity (Gen_Unit);
3701 while Present (E) loop
3702 if Is_Subprogram (E) and then Is_Inlined (E) then
3711 end Might_Inline_Subp;
3713 -- Local declarations
3715 Vis_Prims_List : Elist_Id := No_Elist;
3716 -- List of primitives made temporarily visible in the instantiation
3717 -- to match the visibility of the formal type
3719 -- Start of processing for Analyze_Package_Instantiation
3722 Check_SPARK_05_Restriction ("generic is not allowed", N);
3724 -- Very first thing: check for Text_IO sp[ecial unit in case we are
3725 -- instantiating one of the children of [[Wide_]Wide_]Text_IO.
3727 Check_Text_IO_Special_Unit (Name (N));
3729 -- Make node global for error reporting
3731 Instantiation_Node := N;
3733 -- Turn off style checking in instances. If the check is enabled on the
3734 -- generic unit, a warning in an instance would just be noise. If not
3735 -- enabled on the generic, then a warning in an instance is just wrong.
3737 Style_Check := False;
3739 -- Case of instantiation of a generic package
3741 if Nkind (N) = N_Package_Instantiation then
3742 Act_Decl_Id := New_Copy (Defining_Entity (N));
3743 Set_Comes_From_Source (Act_Decl_Id, True);
3745 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3747 Make_Defining_Program_Unit_Name (Loc,
3748 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
3749 Defining_Identifier => Act_Decl_Id);
3751 Act_Decl_Name := Act_Decl_Id;
3754 -- Case of instantiation of a formal package
3757 Act_Decl_Id := Defining_Identifier (N);
3758 Act_Decl_Name := Act_Decl_Id;
3761 Generate_Definition (Act_Decl_Id);
3762 Preanalyze_Actuals (N);
3765 Env_Installed := True;
3767 -- Reset renaming map for formal types. The mapping is established
3768 -- when analyzing the generic associations, but some mappings are
3769 -- inherited from formal packages of parent units, and these are
3770 -- constructed when the parents are installed.
3772 Generic_Renamings.Set_Last (0);
3773 Generic_Renamings_HTable.Reset;
3775 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3776 Gen_Unit := Entity (Gen_Id);
3778 -- Verify that it is the name of a generic package
3780 -- A visibility glitch: if the instance is a child unit and the generic
3781 -- is the generic unit of a parent instance (i.e. both the parent and
3782 -- the child units are instances of the same package) the name now
3783 -- denotes the renaming within the parent, not the intended generic
3784 -- unit. See if there is a homonym that is the desired generic. The
3785 -- renaming declaration must be visible inside the instance of the
3786 -- child, but not when analyzing the name in the instantiation itself.
3788 if Ekind (Gen_Unit) = E_Package
3789 and then Present (Renamed_Entity (Gen_Unit))
3790 and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3791 and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3792 and then Present (Homonym (Gen_Unit))
3794 Gen_Unit := Homonym (Gen_Unit);
3797 if Etype (Gen_Unit) = Any_Type then
3801 elsif Ekind (Gen_Unit) /= E_Generic_Package then
3803 -- Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3805 if From_Limited_With (Gen_Unit) then
3807 ("cannot instantiate a limited withed package", Gen_Id);
3810 ("& is not the name of a generic package", Gen_Id, Gen_Unit);
3817 if In_Extended_Main_Source_Unit (N) then
3818 Set_Is_Instantiated (Gen_Unit);
3819 Generate_Reference (Gen_Unit, N);
3821 if Present (Renamed_Object (Gen_Unit)) then
3822 Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3823 Generate_Reference (Renamed_Object (Gen_Unit), N);
3827 if Nkind (Gen_Id) = N_Identifier
3828 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3831 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3833 elsif Nkind (Gen_Id) = N_Expanded_Name
3834 and then Is_Child_Unit (Gen_Unit)
3835 and then Nkind (Prefix (Gen_Id)) = N_Identifier
3836 and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3839 ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3842 Set_Entity (Gen_Id, Gen_Unit);
3844 -- If generic is a renaming, get original generic unit
3846 if Present (Renamed_Object (Gen_Unit))
3847 and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3849 Gen_Unit := Renamed_Object (Gen_Unit);
3852 -- Verify that there are no circular instantiations
3854 if In_Open_Scopes (Gen_Unit) then
3855 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3859 elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3860 Error_Msg_Node_2 := Current_Scope;
3862 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3863 Circularity_Detected := True;
3868 -- If the context of the instance is subject to SPARK_Mode "off",
3869 -- set the global flag which signals Analyze_Pragma to ignore all
3870 -- SPARK_Mode pragmas within the instance.
3872 if SPARK_Mode = Off then
3873 Ignore_Pragma_SPARK_Mode := True;
3876 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3877 Gen_Spec := Specification (Gen_Decl);
3879 -- Initialize renamings map, for error checking, and the list that
3880 -- holds private entities whose views have changed between generic
3881 -- definition and instantiation. If this is the instance created to
3882 -- validate an actual package, the instantiation environment is that
3883 -- of the enclosing instance.
3885 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3887 -- Copy original generic tree, to produce text for instantiation
3891 (Original_Node (Gen_Decl), Empty, Instantiating => True);
3893 Act_Spec := Specification (Act_Tree);
3895 -- If this is the instance created to validate an actual package,
3896 -- only the formals matter, do not examine the package spec itself.
3898 if Is_Actual_Pack then
3899 Set_Visible_Declarations (Act_Spec, New_List);
3900 Set_Private_Declarations (Act_Spec, New_List);
3904 Analyze_Associations
3906 Formals => Generic_Formal_Declarations (Act_Tree),
3907 F_Copy => Generic_Formal_Declarations (Gen_Decl));
3909 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
3911 Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3912 Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3913 Set_Is_Generic_Instance (Act_Decl_Id);
3914 Set_Generic_Parent (Act_Spec, Gen_Unit);
3916 -- References to the generic in its own declaration or its body are
3917 -- references to the instance. Add a renaming declaration for the
3918 -- generic unit itself. This declaration, as well as the renaming
3919 -- declarations for the generic formals, must remain private to the
3920 -- unit: the formals, because this is the language semantics, and
3921 -- the unit because its use is an artifact of the implementation.
3924 Make_Package_Renaming_Declaration (Loc,
3925 Defining_Unit_Name =>
3926 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3927 Name => New_Occurrence_Of (Act_Decl_Id, Loc));
3929 Append (Unit_Renaming, Renaming_List);
3931 -- The renaming declarations are the first local declarations of the
3934 if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3936 (First (Visible_Declarations (Act_Spec)), Renaming_List);
3938 Set_Visible_Declarations (Act_Spec, Renaming_List);
3941 Act_Decl := Make_Package_Declaration (Loc, Specification => Act_Spec);
3943 -- Propagate the aspect specifications from the package declaration
3944 -- template to the instantiated version of the package declaration.
3946 if Has_Aspects (Act_Tree) then
3947 Set_Aspect_Specifications (Act_Decl,
3948 New_Copy_List_Tree (Aspect_Specifications (Act_Tree)));
3951 -- The generic may have a generated Default_Storage_Pool aspect,
3952 -- set at the point of generic declaration. If the instance has
3953 -- that aspect, it overrides the one inherited from the generic.
3955 if Has_Aspects (Gen_Spec) then
3956 if No (Aspect_Specifications (N)) then
3957 Set_Aspect_Specifications (N,
3959 (Aspect_Specifications (Gen_Spec))));
3963 ASN1, ASN2 : Node_Id;
3966 ASN1 := First (Aspect_Specifications (N));
3967 while Present (ASN1) loop
3968 if Chars (Identifier (ASN1))
3969 = Name_Default_Storage_Pool
3971 -- If generic carries a default storage pool, remove
3972 -- it in favor of the instance one.
3974 ASN2 := First (Aspect_Specifications (Gen_Spec));
3975 while Present (ASN2) loop
3976 if Chars (Identifier (ASN2)) =
3977 Name_Default_Storage_Pool
3990 Prepend_List_To (Aspect_Specifications (N),
3992 (Aspect_Specifications (Gen_Spec))));
3997 -- Save the instantiation node, for subsequent instantiation of the
3998 -- body, if there is one and we are generating code for the current
3999 -- unit. Mark unit as having a body (avoids premature error message).
4001 -- We instantiate the body if we are generating code, if we are
4002 -- generating cross-reference information, or if we are building
4003 -- trees for ASIS use or GNATprove use.
4006 Enclosing_Body_Present : Boolean := False;
4007 -- If the generic unit is not a compilation unit, then a body may
4008 -- be present in its parent even if none is required. We create a
4009 -- tentative pending instantiation for the body, which will be
4010 -- discarded if none is actually present.
4015 if Scope (Gen_Unit) /= Standard_Standard
4016 and then not Is_Child_Unit (Gen_Unit)
4018 Scop := Scope (Gen_Unit);
4020 while Present (Scop)
4021 and then Scop /= Standard_Standard
4023 if Unit_Requires_Body (Scop) then
4024 Enclosing_Body_Present := True;
4027 elsif In_Open_Scopes (Scop)
4028 and then In_Package_Body (Scop)
4030 Enclosing_Body_Present := True;
4034 exit when Is_Compilation_Unit (Scop);
4035 Scop := Scope (Scop);
4039 -- If front-end inlining is enabled, and this is a unit for which
4040 -- code will be generated, we instantiate the body at once.
4042 -- This is done if the instance is not the main unit, and if the
4043 -- generic is not a child unit of another generic, to avoid scope
4044 -- problems and the reinstallation of parent instances.
4047 and then (not Is_Child_Unit (Gen_Unit)
4048 or else not Is_Generic_Unit (Scope (Gen_Unit)))
4049 and then Might_Inline_Subp
4050 and then not Is_Actual_Pack
4052 if not Back_End_Inlining
4053 and then Front_End_Inlining
4054 and then (Is_In_Main_Unit (N)
4055 or else In_Main_Context (Current_Scope))
4056 and then Nkind (Parent (N)) /= N_Compilation_Unit
4060 -- In configurable_run_time mode we force the inlining of
4061 -- predefined subprograms marked Inline_Always, to minimize
4062 -- the use of the run-time library.
4064 elsif Is_Predefined_File_Name
4065 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
4066 and then Configurable_Run_Time_Mode
4067 and then Nkind (Parent (N)) /= N_Compilation_Unit
4072 -- If the current scope is itself an instance within a child
4073 -- unit, there will be duplications in the scope stack, and the
4074 -- unstacking mechanism in Inline_Instance_Body will fail.
4075 -- This loses some rare cases of optimization, and might be
4076 -- improved some day, if we can find a proper abstraction for
4077 -- "the complete compilation context" that can be saved and
4080 if Is_Generic_Instance (Current_Scope) then
4082 Curr_Unit : constant Entity_Id :=
4083 Cunit_Entity (Current_Sem_Unit);
4085 if Curr_Unit /= Current_Scope
4086 and then Is_Child_Unit (Curr_Unit)
4088 Inline_Now := False;
4095 (Unit_Requires_Body (Gen_Unit)
4096 or else Enclosing_Body_Present
4097 or else Present (Corresponding_Body (Gen_Decl)))
4098 and then (Is_In_Main_Unit (N) or else Might_Inline_Subp)
4099 and then not Is_Actual_Pack
4100 and then not Inline_Now
4101 and then (Operating_Mode = Generate_Code
4103 -- Need comment for this check ???
4105 or else (Operating_Mode = Check_Semantics
4106 and then (ASIS_Mode or GNATprove_Mode)));
4108 -- If front_end_inlining is enabled, do not instantiate body if
4109 -- within a generic context.
4111 if (Front_End_Inlining and then not Expander_Active)
4112 or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
4114 Needs_Body := False;
4117 -- If the current context is generic, and the package being
4118 -- instantiated is declared within a formal package, there is no
4119 -- body to instantiate until the enclosing generic is instantiated
4120 -- and there is an actual for the formal package. If the formal
4121 -- package has parameters, we build a regular package instance for
4122 -- it, that precedes the original formal package declaration.
4124 if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
4126 Decl : constant Node_Id :=
4128 (Unit_Declaration_Node (Scope (Gen_Unit)));
4130 if Nkind (Decl) = N_Formal_Package_Declaration
4131 or else (Nkind (Decl) = N_Package_Declaration
4132 and then Is_List_Member (Decl)
4133 and then Present (Next (Decl))
4135 Nkind (Next (Decl)) =
4136 N_Formal_Package_Declaration)
4138 Needs_Body := False;
4144 -- For RCI unit calling stubs, we omit the instance body if the
4145 -- instance is the RCI library unit itself.
4147 -- However there is a special case for nested instances: in this case
4148 -- we do generate the instance body, as it might be required, e.g.
4149 -- because it provides stream attributes for some type used in the
4150 -- profile of a remote subprogram. This is consistent with 12.3(12),
4151 -- which indicates that the instance body occurs at the place of the
4152 -- instantiation, and thus is part of the RCI declaration, which is
4153 -- present on all client partitions (this is E.2.3(18)).
4155 -- Note that AI12-0002 may make it illegal at some point to have
4156 -- stream attributes defined in an RCI unit, in which case this
4157 -- special case will become unnecessary. In the meantime, there
4158 -- is known application code in production that depends on this
4159 -- being possible, so we definitely cannot eliminate the body in
4160 -- the case of nested instances for the time being.
4162 -- When we generate a nested instance body, calling stubs for any
4163 -- relevant subprogram will be be inserted immediately after the
4164 -- subprogram declarations, and will take precedence over the
4165 -- subsequent (original) body. (The stub and original body will be
4166 -- complete homographs, but this is permitted in an instance).
4167 -- (Could we do better and remove the original body???)
4169 if Distribution_Stub_Mode = Generate_Caller_Stub_Body
4170 and then Comes_From_Source (N)
4171 and then Nkind (Parent (N)) = N_Compilation_Unit
4173 Needs_Body := False;
4178 -- Here is a defence against a ludicrous number of instantiations
4179 -- caused by a circular set of instantiation attempts.
4181 if Pending_Instantiations.Last > Maximum_Instantiations then
4182 Error_Msg_Uint_1 := UI_From_Int (Maximum_Instantiations);
4183 Error_Msg_N ("too many instantiations, exceeds max of^", N);
4184 Error_Msg_N ("\limit can be changed using -gnateinn switch", N);
4185 raise Unrecoverable_Error;
4188 -- Indicate that the enclosing scopes contain an instantiation,
4189 -- and that cleanup actions should be delayed until after the
4190 -- instance body is expanded.
4192 Check_Forward_Instantiation (Gen_Decl);
4193 if Nkind (N) = N_Package_Instantiation then
4195 Enclosing_Master : Entity_Id;
4198 -- Loop to search enclosing masters
4200 Enclosing_Master := Current_Scope;
4201 Scope_Loop : while Enclosing_Master /= Standard_Standard loop
4202 if Ekind (Enclosing_Master) = E_Package then
4203 if Is_Compilation_Unit (Enclosing_Master) then
4204 if In_Package_Body (Enclosing_Master) then
4206 (Body_Entity (Enclosing_Master));
4215 Enclosing_Master := Scope (Enclosing_Master);
4218 elsif Is_Generic_Unit (Enclosing_Master)
4219 or else Ekind (Enclosing_Master) = E_Void
4221 -- Cleanup actions will eventually be performed on the
4222 -- enclosing subprogram or package instance, if any.
4223 -- Enclosing scope is void in the formal part of a
4224 -- generic subprogram.
4229 if Ekind (Enclosing_Master) = E_Entry
4231 Ekind (Scope (Enclosing_Master)) = E_Protected_Type
4233 if not Expander_Active then
4237 Protected_Body_Subprogram (Enclosing_Master);
4241 Set_Delay_Cleanups (Enclosing_Master);
4243 while Ekind (Enclosing_Master) = E_Block loop
4244 Enclosing_Master := Scope (Enclosing_Master);
4247 if Is_Subprogram (Enclosing_Master) then
4248 Delay_Descriptors (Enclosing_Master);
4250 elsif Is_Task_Type (Enclosing_Master) then
4252 TBP : constant Node_Id :=
4253 Get_Task_Body_Procedure
4256 if Present (TBP) then
4257 Delay_Descriptors (TBP);
4258 Set_Delay_Cleanups (TBP);
4265 end loop Scope_Loop;
4268 -- Make entry in table
4270 Pending_Instantiations.Append
4272 Act_Decl => Act_Decl,
4273 Expander_Status => Expander_Active,
4274 Current_Sem_Unit => Current_Sem_Unit,
4275 Scope_Suppress => Scope_Suppress,
4276 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4277 Version => Ada_Version,
4278 Version_Pragma => Ada_Version_Pragma,
4279 Warnings => Save_Warnings,
4280 SPARK_Mode => SPARK_Mode,
4281 SPARK_Mode_Pragma => SPARK_Mode_Pragma));
4285 Set_Categorization_From_Pragmas (Act_Decl);
4287 if Parent_Installed then
4291 Set_Instance_Spec (N, Act_Decl);
4293 -- If not a compilation unit, insert the package declaration before
4294 -- the original instantiation node.
4296 if Nkind (Parent (N)) /= N_Compilation_Unit then
4297 Mark_Rewrite_Insertion (Act_Decl);
4298 Insert_Before (N, Act_Decl);
4300 if Has_Aspects (N) then
4301 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4303 -- The pragma created for a Default_Storage_Pool aspect must
4304 -- appear ahead of the declarations in the instance spec.
4305 -- Analysis has placed it after the instance node, so remove
4306 -- it and reinsert it properly now.
4309 ASN : constant Node_Id := First (Aspect_Specifications (N));
4310 A_Name : constant Name_Id := Chars (Identifier (ASN));
4314 if A_Name = Name_Default_Storage_Pool then
4315 if No (Visible_Declarations (Act_Spec)) then
4316 Set_Visible_Declarations (Act_Spec, New_List);
4320 while Present (Decl) loop
4321 if Nkind (Decl) = N_Pragma then
4323 Prepend (Decl, Visible_Declarations (Act_Spec));
4335 -- For an instantiation that is a compilation unit, place
4336 -- declaration on current node so context is complete for analysis
4337 -- (including nested instantiations). If this is the main unit,
4338 -- the declaration eventually replaces the instantiation node.
4339 -- If the instance body is created later, it replaces the
4340 -- instance node, and the declaration is attached to it
4341 -- (see Build_Instance_Compilation_Unit_Nodes).
4344 if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
4346 -- The entity for the current unit is the newly created one,
4347 -- and all semantic information is attached to it.
4349 Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
4351 -- If this is the main unit, replace the main entity as well
4353 if Current_Sem_Unit = Main_Unit then
4354 Main_Unit_Entity := Act_Decl_Id;
4358 Set_Unit (Parent (N), Act_Decl);
4359 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
4360 Set_Package_Instantiation (Act_Decl_Id, N);
4362 -- Process aspect specifications of the instance node, if any, to
4363 -- take into account categorization pragmas before analyzing the
4366 if Has_Aspects (N) then
4367 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4371 Set_Unit (Parent (N), N);
4372 Set_Body_Required (Parent (N), False);
4374 -- We never need elaboration checks on instantiations, since by
4375 -- definition, the body instantiation is elaborated at the same
4376 -- time as the spec instantiation.
4378 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4379 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4382 Check_Elab_Instantiation (N);
4384 if ABE_Is_Certain (N) and then Needs_Body then
4385 Pending_Instantiations.Decrement_Last;
4388 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4390 Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
4391 First_Private_Entity (Act_Decl_Id));
4393 -- If the instantiation will receive a body, the unit will be
4394 -- transformed into a package body, and receive its own elaboration
4395 -- entity. Otherwise, the nature of the unit is now a package
4398 if Nkind (Parent (N)) = N_Compilation_Unit
4399 and then not Needs_Body
4401 Rewrite (N, Act_Decl);
4404 if Present (Corresponding_Body (Gen_Decl))
4405 or else Unit_Requires_Body (Gen_Unit)
4407 Set_Has_Completion (Act_Decl_Id);
4410 Check_Formal_Packages (Act_Decl_Id);
4412 Restore_Hidden_Primitives (Vis_Prims_List);
4413 Restore_Private_Views (Act_Decl_Id);
4415 Inherit_Context (Gen_Decl, N);
4417 if Parent_Installed then
4422 Env_Installed := False;
4425 Validate_Categorization_Dependency (N, Act_Decl_Id);
4427 -- There used to be a check here to prevent instantiations in local
4428 -- contexts if the No_Local_Allocators restriction was active. This
4429 -- check was removed by a binding interpretation in AI-95-00130/07,
4430 -- but we retain the code for documentation purposes.
4432 -- if Ekind (Act_Decl_Id) /= E_Void
4433 -- and then not Is_Library_Level_Entity (Act_Decl_Id)
4435 -- Check_Restriction (No_Local_Allocators, N);
4439 Inline_Instance_Body (N, Gen_Unit, Act_Decl);
4442 -- The following is a tree patch for ASIS: ASIS needs separate nodes to
4443 -- be used as defining identifiers for a formal package and for the
4444 -- corresponding expanded package.
4446 if Nkind (N) = N_Formal_Package_Declaration then
4447 Act_Decl_Id := New_Copy (Defining_Entity (N));
4448 Set_Comes_From_Source (Act_Decl_Id, True);
4449 Set_Is_Generic_Instance (Act_Decl_Id, False);
4450 Set_Defining_Identifier (N, Act_Decl_Id);
4453 Ignore_Pragma_SPARK_Mode := Save_IPSM;
4454 SPARK_Mode := Save_SM;
4455 SPARK_Mode_Pragma := Save_SMP;
4456 Style_Check := Save_Style_Check;
4458 if SPARK_Mode = On then
4459 Dynamic_Elaboration_Checks := False;
4462 -- Check that if N is an instantiation of System.Dim_Float_IO or
4463 -- System.Dim_Integer_IO, the formal type has a dimension system.
4465 if Nkind (N) = N_Package_Instantiation
4466 and then Is_Dim_IO_Package_Instantiation (N)
4469 Assoc : constant Node_Id := First (Generic_Associations (N));
4471 if not Has_Dimension_System
4472 (Etype (Explicit_Generic_Actual_Parameter (Assoc)))
4474 Error_Msg_N ("type with a dimension system expected", Assoc);
4480 if Has_Aspects (N) and then Nkind (Parent (N)) /= N_Compilation_Unit then
4481 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4485 when Instantiation_Error =>
4486 if Parent_Installed then
4490 if Env_Installed then
4494 Ignore_Pragma_SPARK_Mode := Save_IPSM;
4495 SPARK_Mode := Save_SM;
4496 SPARK_Mode_Pragma := Save_SMP;
4497 Style_Check := Save_Style_Check;
4499 if SPARK_Mode = On then
4500 Dynamic_Elaboration_Checks := False;
4502 end Analyze_Package_Instantiation;
4504 --------------------------
4505 -- Inline_Instance_Body --
4506 --------------------------
4508 procedure Inline_Instance_Body
4510 Gen_Unit : Entity_Id;
4513 Curr_Comp : constant Node_Id := Cunit (Current_Sem_Unit);
4514 Curr_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
4515 Gen_Comp : constant Entity_Id :=
4516 Cunit_Entity (Get_Source_Unit (Gen_Unit));
4518 Save_SM : constant SPARK_Mode_Type := SPARK_Mode;
4519 Save_SMP : constant Node_Id := SPARK_Mode_Pragma;
4520 -- Save all SPARK_Mode-related attributes as removing enclosing scopes
4521 -- to provide a clean environment for analysis of the inlined body will
4522 -- eliminate any previously set SPARK_Mode.
4524 Scope_Stack_Depth : constant Int :=
4525 Scope_Stack.Last - Scope_Stack.First + 1;
4527 Use_Clauses : array (1 .. Scope_Stack_Depth) of Node_Id;
4528 Instances : array (1 .. Scope_Stack_Depth) of Entity_Id;
4529 Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
4530 Curr_Scope : Entity_Id := Empty;
4532 Num_Inner : Int := 0;
4533 Num_Scopes : Int := 0;
4534 N_Instances : Int := 0;
4535 Removed : Boolean := False;
4540 -- Case of generic unit defined in another unit. We must remove the
4541 -- complete context of the current unit to install that of the generic.
4543 if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
4545 -- Add some comments for the following two loops ???
4548 while Present (S) and then S /= Standard_Standard loop
4550 Num_Scopes := Num_Scopes + 1;
4552 Use_Clauses (Num_Scopes) :=
4554 (Scope_Stack.Last - Num_Scopes + 1).
4556 End_Use_Clauses (Use_Clauses (Num_Scopes));
4558 exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
4559 or else Scope_Stack.Table
4560 (Scope_Stack.Last - Num_Scopes).Entity = Scope (S);
4563 exit when Is_Generic_Instance (S)
4564 and then (In_Package_Body (S)
4565 or else Ekind (S) = E_Procedure
4566 or else Ekind (S) = E_Function);
4570 Vis := Is_Immediately_Visible (Gen_Comp);
4572 -- Find and save all enclosing instances
4577 and then S /= Standard_Standard
4579 if Is_Generic_Instance (S) then
4580 N_Instances := N_Instances + 1;
4581 Instances (N_Instances) := S;
4583 exit when In_Package_Body (S);
4589 -- Remove context of current compilation unit, unless we are within a
4590 -- nested package instantiation, in which case the context has been
4591 -- removed previously.
4593 -- If current scope is the body of a child unit, remove context of
4594 -- spec as well. If an enclosing scope is an instance body, the
4595 -- context has already been removed, but the entities in the body
4596 -- must be made invisible as well.
4601 and then S /= Standard_Standard
4603 if Is_Generic_Instance (S)
4604 and then (In_Package_Body (S)
4605 or else Ekind_In (S, E_Procedure, E_Function))
4607 -- We still have to remove the entities of the enclosing
4608 -- instance from direct visibility.
4613 E := First_Entity (S);
4614 while Present (E) loop
4615 Set_Is_Immediately_Visible (E, False);
4624 or else (Ekind (Curr_Unit) = E_Package_Body
4625 and then S = Spec_Entity (Curr_Unit))
4626 or else (Ekind (Curr_Unit) = E_Subprogram_Body
4629 (Unit_Declaration_Node (Curr_Unit)))
4633 -- Remove entities in current scopes from visibility, so that
4634 -- instance body is compiled in a clean environment.
4636 List := Save_Scope_Stack (Handle_Use => False);
4638 if Is_Child_Unit (S) then
4640 -- Remove child unit from stack, as well as inner scopes.
4641 -- Removing the context of a child unit removes parent units
4644 while Current_Scope /= S loop
4645 Num_Inner := Num_Inner + 1;
4646 Inner_Scopes (Num_Inner) := Current_Scope;
4651 Remove_Context (Curr_Comp);
4655 Remove_Context (Curr_Comp);
4658 if Ekind (Curr_Unit) = E_Package_Body then
4659 Remove_Context (Library_Unit (Curr_Comp));
4666 pragma Assert (Num_Inner < Num_Scopes);
4668 -- The inlined package body must be analyzed with the SPARK_Mode of
4669 -- the enclosing context, otherwise the body may cause bogus errors
4670 -- if a configuration SPARK_Mode pragma in in effect.
4672 Push_Scope (Standard_Standard);
4673 Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4674 Instantiate_Package_Body
4677 Act_Decl => Act_Decl,
4678 Expander_Status => Expander_Active,
4679 Current_Sem_Unit => Current_Sem_Unit,
4680 Scope_Suppress => Scope_Suppress,
4681 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4682 Version => Ada_Version,
4683 Version_Pragma => Ada_Version_Pragma,
4684 Warnings => Save_Warnings,
4685 SPARK_Mode => Save_SM,
4686 SPARK_Mode_Pragma => Save_SMP)),
4687 Inlined_Body => True);
4693 Set_Is_Immediately_Visible (Gen_Comp, Vis);
4695 -- Reset Generic_Instance flag so that use clauses can be installed
4696 -- in the proper order. (See Use_One_Package for effect of enclosing
4697 -- instances on processing of use clauses).
4699 for J in 1 .. N_Instances loop
4700 Set_Is_Generic_Instance (Instances (J), False);
4704 Install_Context (Curr_Comp);
4706 if Present (Curr_Scope)
4707 and then Is_Child_Unit (Curr_Scope)
4709 Push_Scope (Curr_Scope);
4710 Set_Is_Immediately_Visible (Curr_Scope);
4712 -- Finally, restore inner scopes as well
4714 for J in reverse 1 .. Num_Inner loop
4715 Push_Scope (Inner_Scopes (J));
4719 Restore_Scope_Stack (List, Handle_Use => False);
4721 if Present (Curr_Scope)
4723 (In_Private_Part (Curr_Scope)
4724 or else In_Package_Body (Curr_Scope))
4726 -- Install private declaration of ancestor units, which are
4727 -- currently available. Restore_Scope_Stack and Install_Context
4728 -- only install the visible part of parents.
4733 Par := Scope (Curr_Scope);
4734 while (Present (Par))
4735 and then Par /= Standard_Standard
4737 Install_Private_Declarations (Par);
4744 -- Restore use clauses. For a child unit, use clauses in the parents
4745 -- are restored when installing the context, so only those in inner
4746 -- scopes (and those local to the child unit itself) need to be
4747 -- installed explicitly.
4749 if Is_Child_Unit (Curr_Unit)
4752 for J in reverse 1 .. Num_Inner + 1 loop
4753 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4755 Install_Use_Clauses (Use_Clauses (J));
4759 for J in reverse 1 .. Num_Scopes loop
4760 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4762 Install_Use_Clauses (Use_Clauses (J));
4766 -- Restore status of instances. If one of them is a body, make its
4767 -- local entities visible again.
4774 for J in 1 .. N_Instances loop
4775 Inst := Instances (J);
4776 Set_Is_Generic_Instance (Inst, True);
4778 if In_Package_Body (Inst)
4779 or else Ekind_In (S, E_Procedure, E_Function)
4781 E := First_Entity (Instances (J));
4782 while Present (E) loop
4783 Set_Is_Immediately_Visible (E);
4790 -- If generic unit is in current unit, current context is correct. Note
4791 -- that the context is guaranteed to carry the correct SPARK_Mode as no
4792 -- enclosing scopes were removed.
4795 Instantiate_Package_Body
4798 Act_Decl => Act_Decl,
4799 Expander_Status => Expander_Active,
4800 Current_Sem_Unit => Current_Sem_Unit,
4801 Scope_Suppress => Scope_Suppress,
4802 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4803 Version => Ada_Version,
4804 Version_Pragma => Ada_Version_Pragma,
4805 Warnings => Save_Warnings,
4806 SPARK_Mode => SPARK_Mode,
4807 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
4808 Inlined_Body => True);
4810 end Inline_Instance_Body;
4812 -------------------------------------
4813 -- Analyze_Procedure_Instantiation --
4814 -------------------------------------
4816 procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4818 Analyze_Subprogram_Instantiation (N, E_Procedure);
4819 end Analyze_Procedure_Instantiation;
4821 -----------------------------------
4822 -- Need_Subprogram_Instance_Body --
4823 -----------------------------------
4825 function Need_Subprogram_Instance_Body
4827 Subp : Entity_Id) return Boolean
4830 -- Must be inlined (or inlined renaming)
4832 if (Is_In_Main_Unit (N)
4833 or else Is_Inlined (Subp)
4834 or else Is_Inlined (Alias (Subp)))
4836 -- Must be generating code or analyzing code in ASIS/GNATprove mode
4838 and then (Operating_Mode = Generate_Code
4839 or else (Operating_Mode = Check_Semantics
4840 and then (ASIS_Mode or GNATprove_Mode)))
4842 -- The body is needed when generating code (full expansion), in ASIS
4843 -- mode for other tools, and in GNATprove mode (special expansion) for
4844 -- formal verification of the body itself.
4846 and then (Expander_Active or ASIS_Mode or GNATprove_Mode)
4848 -- No point in inlining if ABE is inevitable
4850 and then not ABE_Is_Certain (N)
4852 -- Or if subprogram is eliminated
4854 and then not Is_Eliminated (Subp)
4856 Pending_Instantiations.Append
4858 Act_Decl => Unit_Declaration_Node (Subp),
4859 Expander_Status => Expander_Active,
4860 Current_Sem_Unit => Current_Sem_Unit,
4861 Scope_Suppress => Scope_Suppress,
4862 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4863 Version => Ada_Version,
4864 Version_Pragma => Ada_Version_Pragma,
4865 Warnings => Save_Warnings,
4866 SPARK_Mode => SPARK_Mode,
4867 SPARK_Mode_Pragma => SPARK_Mode_Pragma));
4870 -- Here if not inlined, or we ignore the inlining
4875 end Need_Subprogram_Instance_Body;
4877 --------------------------------------
4878 -- Analyze_Subprogram_Instantiation --
4879 --------------------------------------
4881 procedure Analyze_Subprogram_Instantiation
4885 Loc : constant Source_Ptr := Sloc (N);
4886 Gen_Id : constant Node_Id := Name (N);
4888 Anon_Id : constant Entity_Id :=
4889 Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4890 Chars => New_External_Name
4891 (Chars (Defining_Entity (N)), 'R'));
4893 Act_Decl_Id : Entity_Id;
4898 Env_Installed : Boolean := False;
4899 Gen_Unit : Entity_Id;
4901 Pack_Id : Entity_Id;
4902 Parent_Installed : Boolean := False;
4903 Renaming_List : List_Id;
4905 procedure Analyze_Instance_And_Renamings;
4906 -- The instance must be analyzed in a context that includes the mappings
4907 -- of generic parameters into actuals. We create a package declaration
4908 -- for this purpose, and a subprogram with an internal name within the
4909 -- package. The subprogram instance is simply an alias for the internal
4910 -- subprogram, declared in the current scope.
4912 ------------------------------------
4913 -- Analyze_Instance_And_Renamings --
4914 ------------------------------------
4916 procedure Analyze_Instance_And_Renamings is
4917 Def_Ent : constant Entity_Id := Defining_Entity (N);
4918 Pack_Decl : Node_Id;
4921 if Nkind (Parent (N)) = N_Compilation_Unit then
4923 -- For the case of a compilation unit, the container package has
4924 -- the same name as the instantiation, to insure that the binder
4925 -- calls the elaboration procedure with the right name. Copy the
4926 -- entity of the instance, which may have compilation level flags
4927 -- (e.g. Is_Child_Unit) set.
4929 Pack_Id := New_Copy (Def_Ent);
4932 -- Otherwise we use the name of the instantiation concatenated
4933 -- with its source position to ensure uniqueness if there are
4934 -- several instantiations with the same name.
4937 Make_Defining_Identifier (Loc,
4938 Chars => New_External_Name
4939 (Related_Id => Chars (Def_Ent),
4941 Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4944 Pack_Decl := Make_Package_Declaration (Loc,
4945 Specification => Make_Package_Specification (Loc,
4946 Defining_Unit_Name => Pack_Id,
4947 Visible_Declarations => Renaming_List,
4948 End_Label => Empty));
4950 Set_Instance_Spec (N, Pack_Decl);
4951 Set_Is_Generic_Instance (Pack_Id);
4952 Set_Debug_Info_Needed (Pack_Id);
4954 -- Case of not a compilation unit
4956 if Nkind (Parent (N)) /= N_Compilation_Unit then
4957 Mark_Rewrite_Insertion (Pack_Decl);
4958 Insert_Before (N, Pack_Decl);
4959 Set_Has_Completion (Pack_Id);
4961 -- Case of an instantiation that is a compilation unit
4963 -- Place declaration on current node so context is complete for
4964 -- analysis (including nested instantiations), and for use in a
4965 -- context_clause (see Analyze_With_Clause).
4968 Set_Unit (Parent (N), Pack_Decl);
4969 Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4972 Analyze (Pack_Decl);
4973 Check_Formal_Packages (Pack_Id);
4974 Set_Is_Generic_Instance (Pack_Id, False);
4976 -- Why do we clear Is_Generic_Instance??? We set it 20 lines
4979 -- Body of the enclosing package is supplied when instantiating the
4980 -- subprogram body, after semantic analysis is completed.
4982 if Nkind (Parent (N)) = N_Compilation_Unit then
4984 -- Remove package itself from visibility, so it does not
4985 -- conflict with subprogram.
4987 Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4989 -- Set name and scope of internal subprogram so that the proper
4990 -- external name will be generated. The proper scope is the scope
4991 -- of the wrapper package. We need to generate debugging info for
4992 -- the internal subprogram, so set flag accordingly.
4994 Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4995 Set_Scope (Anon_Id, Scope (Pack_Id));
4997 -- Mark wrapper package as referenced, to avoid spurious warnings
4998 -- if the instantiation appears in various with_ clauses of
4999 -- subunits of the main unit.
5001 Set_Referenced (Pack_Id);
5004 Set_Is_Generic_Instance (Anon_Id);
5005 Set_Debug_Info_Needed (Anon_Id);
5006 Act_Decl_Id := New_Copy (Anon_Id);
5008 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
5009 Set_Chars (Act_Decl_Id, Chars (Defining_Entity (N)));
5010 Set_Sloc (Act_Decl_Id, Sloc (Defining_Entity (N)));
5011 Set_Comes_From_Source (Act_Decl_Id, True);
5013 -- The signature may involve types that are not frozen yet, but the
5014 -- subprogram will be frozen at the point the wrapper package is
5015 -- frozen, so it does not need its own freeze node. In fact, if one
5016 -- is created, it might conflict with the freezing actions from the
5019 Set_Has_Delayed_Freeze (Anon_Id, False);
5021 -- If the instance is a child unit, mark the Id accordingly. Mark
5022 -- the anonymous entity as well, which is the real subprogram and
5023 -- which is used when the instance appears in a context clause.
5024 -- Similarly, propagate the Is_Eliminated flag to handle properly
5025 -- nested eliminated subprograms.
5027 Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
5028 Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
5029 New_Overloaded_Entity (Act_Decl_Id);
5030 Check_Eliminated (Act_Decl_Id);
5031 Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
5033 -- In compilation unit case, kill elaboration checks on the
5034 -- instantiation, since they are never needed -- the body is
5035 -- instantiated at the same point as the spec.
5037 if Nkind (Parent (N)) = N_Compilation_Unit then
5038 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
5039 Set_Kill_Elaboration_Checks (Act_Decl_Id);
5040 Set_Is_Compilation_Unit (Anon_Id);
5042 Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
5045 -- The instance is not a freezing point for the new subprogram
5047 Set_Is_Frozen (Act_Decl_Id, False);
5049 if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
5050 Valid_Operator_Definition (Act_Decl_Id);
5053 Set_Alias (Act_Decl_Id, Anon_Id);
5054 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
5055 Set_Has_Completion (Act_Decl_Id);
5056 Set_Related_Instance (Pack_Id, Act_Decl_Id);
5058 if Nkind (Parent (N)) = N_Compilation_Unit then
5059 Set_Body_Required (Parent (N), False);
5061 end Analyze_Instance_And_Renamings;
5065 Save_IPSM : constant Boolean := Ignore_Pragma_SPARK_Mode;
5066 -- Save flag Ignore_Pragma_SPARK_Mode for restore on exit
5068 Save_SM : constant SPARK_Mode_Type := SPARK_Mode;
5069 Save_SMP : constant Node_Id := SPARK_Mode_Pragma;
5070 -- Save the SPARK_Mode-related data for restore on exit
5072 Vis_Prims_List : Elist_Id := No_Elist;
5073 -- List of primitives made temporarily visible in the instantiation
5074 -- to match the visibility of the formal type
5076 -- Start of processing for Analyze_Subprogram_Instantiation
5079 Check_SPARK_05_Restriction ("generic is not allowed", N);
5081 -- Very first thing: check for special Text_IO unit in case we are
5082 -- instantiating one of the children of [[Wide_]Wide_]Text_IO. Of course
5083 -- such an instantiation is bogus (these are packages, not subprograms),
5084 -- but we get a better error message if we do this.
5086 Check_Text_IO_Special_Unit (Gen_Id);
5088 -- Make node global for error reporting
5090 Instantiation_Node := N;
5092 -- For package instantiations we turn off style checks, because they
5093 -- will have been emitted in the generic. For subprogram instantiations
5094 -- we want to apply at least the check on overriding indicators so we
5095 -- do not modify the style check status.
5097 -- The renaming declarations for the actuals do not come from source and
5098 -- will not generate spurious warnings.
5100 Preanalyze_Actuals (N);
5103 Env_Installed := True;
5104 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
5105 Gen_Unit := Entity (Gen_Id);
5107 Generate_Reference (Gen_Unit, Gen_Id);
5109 if Nkind (Gen_Id) = N_Identifier
5110 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
5113 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
5116 if Etype (Gen_Unit) = Any_Type then
5121 -- Verify that it is a generic subprogram of the right kind, and that
5122 -- it does not lead to a circular instantiation.
5124 if K = E_Procedure and then Ekind (Gen_Unit) /= E_Generic_Procedure then
5126 ("& is not the name of a generic procedure", Gen_Id, Gen_Unit);
5128 elsif K = E_Function and then Ekind (Gen_Unit) /= E_Generic_Function then
5130 ("& is not the name of a generic function", Gen_Id, Gen_Unit);
5132 elsif In_Open_Scopes (Gen_Unit) then
5133 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
5136 -- If the context of the instance is subject to SPARK_Mode "off",
5137 -- set the global flag which signals Analyze_Pragma to ignore all
5138 -- SPARK_Mode pragmas within the instance.
5140 if SPARK_Mode = Off then
5141 Ignore_Pragma_SPARK_Mode := True;
5144 Set_Entity (Gen_Id, Gen_Unit);
5145 Set_Is_Instantiated (Gen_Unit);
5147 if In_Extended_Main_Source_Unit (N) then
5148 Generate_Reference (Gen_Unit, N);
5151 -- If renaming, get original unit
5153 if Present (Renamed_Object (Gen_Unit))
5154 and then Ekind_In (Renamed_Object (Gen_Unit), E_Generic_Procedure,
5157 Gen_Unit := Renamed_Object (Gen_Unit);
5158 Set_Is_Instantiated (Gen_Unit);
5159 Generate_Reference (Gen_Unit, N);
5162 if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
5163 Error_Msg_Node_2 := Current_Scope;
5165 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
5166 Circularity_Detected := True;
5167 Restore_Hidden_Primitives (Vis_Prims_List);
5171 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
5173 -- Initialize renamings map, for error checking
5175 Generic_Renamings.Set_Last (0);
5176 Generic_Renamings_HTable.Reset;
5178 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
5180 -- Copy original generic tree, to produce text for instantiation
5184 (Original_Node (Gen_Decl), Empty, Instantiating => True);
5186 -- Inherit overriding indicator from instance node
5188 Act_Spec := Specification (Act_Tree);
5189 Set_Must_Override (Act_Spec, Must_Override (N));
5190 Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
5193 Analyze_Associations
5195 Formals => Generic_Formal_Declarations (Act_Tree),
5196 F_Copy => Generic_Formal_Declarations (Gen_Decl));
5198 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
5200 -- The subprogram itself cannot contain a nested instance, so the
5201 -- current parent is left empty.
5203 Set_Instance_Env (Gen_Unit, Empty);
5205 -- Build the subprogram declaration, which does not appear in the
5206 -- generic template, and give it a sloc consistent with that of the
5209 Set_Defining_Unit_Name (Act_Spec, Anon_Id);
5210 Set_Generic_Parent (Act_Spec, Gen_Unit);
5212 Make_Subprogram_Declaration (Sloc (Act_Spec),
5213 Specification => Act_Spec);
5215 -- The aspects have been copied previously, but they have to be
5216 -- linked explicitly to the new subprogram declaration. Explicit
5217 -- pre/postconditions on the instance are analyzed below, in a
5220 Move_Aspects (Act_Tree, To => Act_Decl);
5221 Set_Categorization_From_Pragmas (Act_Decl);
5223 if Parent_Installed then
5227 Append (Act_Decl, Renaming_List);
5228 Analyze_Instance_And_Renamings;
5230 -- If the generic is marked Import (Intrinsic), then so is the
5231 -- instance. This indicates that there is no body to instantiate. If
5232 -- generic is marked inline, so it the instance, and the anonymous
5233 -- subprogram it renames. If inlined, or else if inlining is enabled
5234 -- for the compilation, we generate the instance body even if it is
5235 -- not within the main unit.
5237 if Is_Intrinsic_Subprogram (Gen_Unit) then
5238 Set_Is_Intrinsic_Subprogram (Anon_Id);
5239 Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
5241 if Chars (Gen_Unit) = Name_Unchecked_Conversion then
5242 Validate_Unchecked_Conversion (N, Act_Decl_Id);
5246 -- Inherit convention from generic unit. Intrinsic convention, as for
5247 -- an instance of unchecked conversion, is not inherited because an
5248 -- explicit Ada instance has been created.
5250 if Has_Convention_Pragma (Gen_Unit)
5251 and then Convention (Gen_Unit) /= Convention_Intrinsic
5253 Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
5254 Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
5257 Generate_Definition (Act_Decl_Id);
5258 -- Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id)));
5260 Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
5262 -- Inherit all inlining-related flags which apply to the generic in
5263 -- the subprogram and its declaration.
5265 Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
5266 Set_Is_Inlined (Anon_Id, Is_Inlined (Gen_Unit));
5268 Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
5269 Set_Has_Pragma_Inline (Anon_Id, Has_Pragma_Inline (Gen_Unit));
5271 Set_Has_Pragma_Inline_Always
5272 (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
5273 Set_Has_Pragma_Inline_Always
5274 (Anon_Id, Has_Pragma_Inline_Always (Gen_Unit));
5276 if not Is_Intrinsic_Subprogram (Gen_Unit) then
5277 Check_Elab_Instantiation (N);
5280 if Is_Dispatching_Operation (Act_Decl_Id)
5281 and then Ada_Version >= Ada_2005
5287 Formal := First_Formal (Act_Decl_Id);
5288 while Present (Formal) loop
5289 if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
5290 and then Is_Controlling_Formal (Formal)
5291 and then not Can_Never_Be_Null (Formal)
5293 Error_Msg_NE ("access parameter& is controlling,",
5296 ("\corresponding parameter of & must be"
5297 & " explicitly null-excluding", N, Gen_Id);
5300 Next_Formal (Formal);
5305 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
5307 Validate_Categorization_Dependency (N, Act_Decl_Id);
5309 if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
5310 Inherit_Context (Gen_Decl, N);
5312 Restore_Private_Views (Pack_Id, False);
5314 -- If the context requires a full instantiation, mark node for
5315 -- subsequent construction of the body.
5317 if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
5318 Check_Forward_Instantiation (Gen_Decl);
5320 -- The wrapper package is always delayed, because it does not
5321 -- constitute a freeze point, but to insure that the freeze
5322 -- node is placed properly, it is created directly when
5323 -- instantiating the body (otherwise the freeze node might
5324 -- appear to early for nested instantiations).
5326 elsif Nkind (Parent (N)) = N_Compilation_Unit then
5328 -- For ASIS purposes, indicate that the wrapper package has
5329 -- replaced the instantiation node.
5331 Rewrite (N, Unit (Parent (N)));
5332 Set_Unit (Parent (N), N);
5335 elsif Nkind (Parent (N)) = N_Compilation_Unit then
5337 -- Replace instance node for library-level instantiations of
5338 -- intrinsic subprograms, for ASIS use.
5340 Rewrite (N, Unit (Parent (N)));
5341 Set_Unit (Parent (N), N);
5344 if Parent_Installed then
5348 Restore_Hidden_Primitives (Vis_Prims_List);
5350 Env_Installed := False;
5351 Generic_Renamings.Set_Last (0);
5352 Generic_Renamings_HTable.Reset;
5354 Ignore_Pragma_SPARK_Mode := Save_IPSM;
5355 SPARK_Mode := Save_SM;
5356 SPARK_Mode_Pragma := Save_SMP;
5358 if SPARK_Mode = On then
5359 Dynamic_Elaboration_Checks := False;
5365 if Has_Aspects (N) then
5366 Analyze_Aspect_Specifications (N, Act_Decl_Id);
5370 when Instantiation_Error =>
5371 if Parent_Installed then
5375 if Env_Installed then
5379 Ignore_Pragma_SPARK_Mode := Save_IPSM;
5380 SPARK_Mode := Save_SM;
5381 SPARK_Mode_Pragma := Save_SMP;
5383 if SPARK_Mode = On then
5384 Dynamic_Elaboration_Checks := False;
5386 end Analyze_Subprogram_Instantiation;
5388 -------------------------
5389 -- Get_Associated_Node --
5390 -------------------------
5392 function Get_Associated_Node (N : Node_Id) return Node_Id is
5396 Assoc := Associated_Node (N);
5398 if Nkind (Assoc) /= Nkind (N) then
5401 elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
5405 -- If the node is part of an inner generic, it may itself have been
5406 -- remapped into a further generic copy. Associated_Node is otherwise
5407 -- used for the entity of the node, and will be of a different node
5408 -- kind, or else N has been rewritten as a literal or function call.
5410 while Present (Associated_Node (Assoc))
5411 and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
5413 Assoc := Associated_Node (Assoc);
5416 -- Follow and additional link in case the final node was rewritten.
5417 -- This can only happen with nested generic units.
5419 if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
5420 and then Present (Associated_Node (Assoc))
5421 and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
5422 N_Explicit_Dereference,
5427 Assoc := Associated_Node (Assoc);
5430 -- An additional special case: an unconstrained type in an object
5431 -- declaration may have been rewritten as a local subtype constrained
5432 -- by the expression in the declaration. We need to recover the
5433 -- original entity which may be global.
5435 if Present (Original_Node (Assoc))
5436 and then Nkind (Parent (N)) = N_Object_Declaration
5438 Assoc := Original_Node (Assoc);
5443 end Get_Associated_Node;
5445 -------------------------------------------
5446 -- Build_Instance_Compilation_Unit_Nodes --
5447 -------------------------------------------
5449 procedure Build_Instance_Compilation_Unit_Nodes
5454 Decl_Cunit : Node_Id;
5455 Body_Cunit : Node_Id;
5457 New_Main : constant Entity_Id := Defining_Entity (Act_Decl);
5458 Old_Main : constant Entity_Id := Cunit_Entity (Main_Unit);
5461 -- A new compilation unit node is built for the instance declaration
5464 Make_Compilation_Unit (Sloc (N),
5465 Context_Items => Empty_List,
5467 Aux_Decls_Node => Make_Compilation_Unit_Aux (Sloc (N)));
5469 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
5471 -- The new compilation unit is linked to its body, but both share the
5472 -- same file, so we do not set Body_Required on the new unit so as not
5473 -- to create a spurious dependency on a non-existent body in the ali.
5474 -- This simplifies CodePeer unit traversal.
5476 -- We use the original instantiation compilation unit as the resulting
5477 -- compilation unit of the instance, since this is the main unit.
5479 Rewrite (N, Act_Body);
5481 -- Propagate the aspect specifications from the package body template to
5482 -- the instantiated version of the package body.
5484 if Has_Aspects (Act_Body) then
5485 Set_Aspect_Specifications
5486 (N, New_Copy_List_Tree (Aspect_Specifications (Act_Body)));
5489 Body_Cunit := Parent (N);
5491 -- The two compilation unit nodes are linked by the Library_Unit field
5493 Set_Library_Unit (Decl_Cunit, Body_Cunit);
5494 Set_Library_Unit (Body_Cunit, Decl_Cunit);
5496 -- Preserve the private nature of the package if needed
5498 Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
5500 -- If the instance is not the main unit, its context, categorization
5501 -- and elaboration entity are not relevant to the compilation.
5503 if Body_Cunit /= Cunit (Main_Unit) then
5504 Make_Instance_Unit (Body_Cunit, In_Main => False);
5508 -- The context clause items on the instantiation, which are now attached
5509 -- to the body compilation unit (since the body overwrote the original
5510 -- instantiation node), semantically belong on the spec, so copy them
5511 -- there. It's harmless to leave them on the body as well. In fact one
5512 -- could argue that they belong in both places.
5514 Citem := First (Context_Items (Body_Cunit));
5515 while Present (Citem) loop
5516 Append (New_Copy (Citem), Context_Items (Decl_Cunit));
5520 -- Propagate categorization flags on packages, so that they appear in
5521 -- the ali file for the spec of the unit.
5523 if Ekind (New_Main) = E_Package then
5524 Set_Is_Pure (Old_Main, Is_Pure (New_Main));
5525 Set_Is_Preelaborated (Old_Main, Is_Preelaborated (New_Main));
5526 Set_Is_Remote_Types (Old_Main, Is_Remote_Types (New_Main));
5527 Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
5528 Set_Is_Remote_Call_Interface
5529 (Old_Main, Is_Remote_Call_Interface (New_Main));
5532 -- Make entry in Units table, so that binder can generate call to
5533 -- elaboration procedure for body, if any.
5535 Make_Instance_Unit (Body_Cunit, In_Main => True);
5536 Main_Unit_Entity := New_Main;
5537 Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
5539 -- Build elaboration entity, since the instance may certainly generate
5540 -- elaboration code requiring a flag for protection.
5542 Build_Elaboration_Entity (Decl_Cunit, New_Main);
5543 end Build_Instance_Compilation_Unit_Nodes;
5545 -----------------------------
5546 -- Check_Access_Definition --
5547 -----------------------------
5549 procedure Check_Access_Definition (N : Node_Id) is
5552 (Ada_Version >= Ada_2005 and then Present (Access_Definition (N)));
5554 end Check_Access_Definition;
5556 -----------------------------------
5557 -- Check_Formal_Package_Instance --
5558 -----------------------------------
5560 -- If the formal has specific parameters, they must match those of the
5561 -- actual. Both of them are instances, and the renaming declarations for
5562 -- their formal parameters appear in the same order in both. The analyzed
5563 -- formal has been analyzed in the context of the current instance.
5565 procedure Check_Formal_Package_Instance
5566 (Formal_Pack : Entity_Id;
5567 Actual_Pack : Entity_Id)
5569 E1 : Entity_Id := First_Entity (Actual_Pack);
5570 E2 : Entity_Id := First_Entity (Formal_Pack);
5575 procedure Check_Mismatch (B : Boolean);
5576 -- Common error routine for mismatch between the parameters of the
5577 -- actual instance and those of the formal package.
5579 function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
5580 -- The formal may come from a nested formal package, and the actual may
5581 -- have been constant-folded. To determine whether the two denote the
5582 -- same entity we may have to traverse several definitions to recover
5583 -- the ultimate entity that they refer to.
5585 function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
5586 -- Similarly, if the formal comes from a nested formal package, the
5587 -- actual may designate the formal through multiple renamings, which
5588 -- have to be followed to determine the original variable in question.
5590 --------------------
5591 -- Check_Mismatch --
5592 --------------------
5594 procedure Check_Mismatch (B : Boolean) is
5595 Kind : constant Node_Kind := Nkind (Parent (E2));
5598 if Kind = N_Formal_Type_Declaration then
5601 elsif Nkind_In (Kind, N_Formal_Object_Declaration,
5602 N_Formal_Package_Declaration)
5603 or else Kind in N_Formal_Subprogram_Declaration
5609 ("actual for & in actual instance does not match formal",
5610 Parent (Actual_Pack), E1);
5614 --------------------------------
5615 -- Same_Instantiated_Constant --
5616 --------------------------------
5618 function Same_Instantiated_Constant
5619 (E1, E2 : Entity_Id) return Boolean
5625 while Present (Ent) loop
5629 elsif Ekind (Ent) /= E_Constant then
5632 elsif Is_Entity_Name (Constant_Value (Ent)) then
5633 if Entity (Constant_Value (Ent)) = E1 then
5636 Ent := Entity (Constant_Value (Ent));
5639 -- The actual may be a constant that has been folded. Recover
5642 elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5643 Ent := Entity (Original_Node (Constant_Value (Ent)));
5650 end Same_Instantiated_Constant;
5652 --------------------------------
5653 -- Same_Instantiated_Variable --
5654 --------------------------------
5656 function Same_Instantiated_Variable
5657 (E1, E2 : Entity_Id) return Boolean
5659 function Original_Entity (E : Entity_Id) return Entity_Id;
5660 -- Follow chain of renamings to the ultimate ancestor
5662 ---------------------
5663 -- Original_Entity --
5664 ---------------------
5666 function Original_Entity (E : Entity_Id) return Entity_Id is
5671 while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5672 and then Present (Renamed_Object (Orig))
5673 and then Is_Entity_Name (Renamed_Object (Orig))
5675 Orig := Entity (Renamed_Object (Orig));
5679 end Original_Entity;
5681 -- Start of processing for Same_Instantiated_Variable
5684 return Ekind (E1) = Ekind (E2)
5685 and then Original_Entity (E1) = Original_Entity (E2);
5686 end Same_Instantiated_Variable;
5688 -- Start of processing for Check_Formal_Package_Instance
5692 and then Present (E2)
5694 exit when Ekind (E1) = E_Package
5695 and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5697 -- If the formal is the renaming of the formal package, this
5698 -- is the end of its formal part, which may occur before the
5699 -- end of the formal part in the actual in the presence of
5700 -- defaulted parameters in the formal package.
5702 exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5703 and then Renamed_Entity (E2) = Scope (E2);
5705 -- The analysis of the actual may generate additional internal
5706 -- entities. If the formal is defaulted, there is no corresponding
5707 -- analysis and the internal entities must be skipped, until we
5708 -- find corresponding entities again.
5710 if Comes_From_Source (E2)
5711 and then not Comes_From_Source (E1)
5712 and then Chars (E1) /= Chars (E2)
5715 and then Chars (E1) /= Chars (E2)
5724 -- If the formal entity comes from a formal declaration, it was
5725 -- defaulted in the formal package, and no check is needed on it.
5727 elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
5730 -- Ditto for defaulted formal subprograms.
5732 elsif Is_Overloadable (E1)
5733 and then Nkind (Unit_Declaration_Node (E2)) in
5734 N_Formal_Subprogram_Declaration
5738 elsif Is_Type (E1) then
5740 -- Subtypes must statically match. E1, E2 are the local entities
5741 -- that are subtypes of the actuals. Itypes generated for other
5742 -- parameters need not be checked, the check will be performed
5743 -- on the parameters themselves.
5745 -- If E2 is a formal type declaration, it is a defaulted parameter
5746 -- and needs no checking.
5748 if not Is_Itype (E1)
5749 and then not Is_Itype (E2)
5753 or else Etype (E1) /= Etype (E2)
5754 or else not Subtypes_Statically_Match (E1, E2));
5757 elsif Ekind (E1) = E_Constant then
5759 -- IN parameters must denote the same static value, or the same
5760 -- constant, or the literal null.
5762 Expr1 := Expression (Parent (E1));
5764 if Ekind (E2) /= E_Constant then
5765 Check_Mismatch (True);
5768 Expr2 := Expression (Parent (E2));
5771 if Is_OK_Static_Expression (Expr1) then
5772 if not Is_OK_Static_Expression (Expr2) then
5773 Check_Mismatch (True);
5775 elsif Is_Discrete_Type (Etype (E1)) then
5777 V1 : constant Uint := Expr_Value (Expr1);
5778 V2 : constant Uint := Expr_Value (Expr2);
5780 Check_Mismatch (V1 /= V2);
5783 elsif Is_Real_Type (Etype (E1)) then
5785 V1 : constant Ureal := Expr_Value_R (Expr1);
5786 V2 : constant Ureal := Expr_Value_R (Expr2);
5788 Check_Mismatch (V1 /= V2);
5791 elsif Is_String_Type (Etype (E1))
5792 and then Nkind (Expr1) = N_String_Literal
5794 if Nkind (Expr2) /= N_String_Literal then
5795 Check_Mismatch (True);
5798 (not String_Equal (Strval (Expr1), Strval (Expr2)));
5802 elsif Is_Entity_Name (Expr1) then
5803 if Is_Entity_Name (Expr2) then
5804 if Entity (Expr1) = Entity (Expr2) then
5808 (not Same_Instantiated_Constant
5809 (Entity (Expr1), Entity (Expr2)));
5812 Check_Mismatch (True);
5815 elsif Is_Entity_Name (Original_Node (Expr1))
5816 and then Is_Entity_Name (Expr2)
5818 Same_Instantiated_Constant
5819 (Entity (Original_Node (Expr1)), Entity (Expr2))
5823 elsif Nkind (Expr1) = N_Null then
5824 Check_Mismatch (Nkind (Expr1) /= N_Null);
5827 Check_Mismatch (True);
5830 elsif Ekind (E1) = E_Variable then
5831 Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5833 elsif Ekind (E1) = E_Package then
5835 (Ekind (E1) /= Ekind (E2)
5836 or else Renamed_Object (E1) /= Renamed_Object (E2));
5838 elsif Is_Overloadable (E1) then
5840 -- Verify that the actual subprograms match. Note that actuals
5841 -- that are attributes are rewritten as subprograms. If the
5842 -- subprogram in the formal package is defaulted, no check is
5843 -- needed. Note that this can only happen in Ada 2005 when the
5844 -- formal package can be partially parameterized.
5846 if Nkind (Unit_Declaration_Node (E1)) =
5847 N_Subprogram_Renaming_Declaration
5848 and then From_Default (Unit_Declaration_Node (E1))
5852 -- If the formal package has an "others" box association that
5853 -- covers this formal, there is no need for a check either.
5855 elsif Nkind (Unit_Declaration_Node (E2)) in
5856 N_Formal_Subprogram_Declaration
5857 and then Box_Present (Unit_Declaration_Node (E2))
5861 -- No check needed if subprogram is a defaulted null procedure
5863 elsif No (Alias (E2))
5864 and then Ekind (E2) = E_Procedure
5866 Null_Present (Specification (Unit_Declaration_Node (E2)))
5870 -- Otherwise the actual in the formal and the actual in the
5871 -- instantiation of the formal must match, up to renamings.
5875 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5879 raise Program_Error;
5886 end Check_Formal_Package_Instance;
5888 ---------------------------
5889 -- Check_Formal_Packages --
5890 ---------------------------
5892 procedure Check_Formal_Packages (P_Id : Entity_Id) is
5894 Formal_P : Entity_Id;
5897 -- Iterate through the declarations in the instance, looking for package
5898 -- renaming declarations that denote instances of formal packages. Stop
5899 -- when we find the renaming of the current package itself. The
5900 -- declaration for a formal package without a box is followed by an
5901 -- internal entity that repeats the instantiation.
5903 E := First_Entity (P_Id);
5904 while Present (E) loop
5905 if Ekind (E) = E_Package then
5906 if Renamed_Object (E) = P_Id then
5909 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5912 elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5913 Formal_P := Next_Entity (E);
5914 Check_Formal_Package_Instance (Formal_P, E);
5916 -- After checking, remove the internal validating package. It
5917 -- is only needed for semantic checks, and as it may contain
5918 -- generic formal declarations it should not reach gigi.
5920 Remove (Unit_Declaration_Node (Formal_P));
5926 end Check_Formal_Packages;
5928 ---------------------------------
5929 -- Check_Forward_Instantiation --
5930 ---------------------------------
5932 procedure Check_Forward_Instantiation (Decl : Node_Id) is
5934 Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5937 -- The instantiation appears before the generic body if we are in the
5938 -- scope of the unit containing the generic, either in its spec or in
5939 -- the package body, and before the generic body.
5941 if Ekind (Gen_Comp) = E_Package_Body then
5942 Gen_Comp := Spec_Entity (Gen_Comp);
5945 if In_Open_Scopes (Gen_Comp)
5946 and then No (Corresponding_Body (Decl))
5951 and then not Is_Compilation_Unit (S)
5952 and then not Is_Child_Unit (S)
5954 if Ekind (S) = E_Package then
5955 Set_Has_Forward_Instantiation (S);
5961 end Check_Forward_Instantiation;
5963 ---------------------------
5964 -- Check_Generic_Actuals --
5965 ---------------------------
5967 -- The visibility of the actuals may be different between the point of
5968 -- generic instantiation and the instantiation of the body.
5970 procedure Check_Generic_Actuals
5971 (Instance : Entity_Id;
5972 Is_Formal_Box : Boolean)
5977 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5978 -- For a formal that is an array type, the component type is often a
5979 -- previous formal in the same unit. The privacy status of the component
5980 -- type will have been examined earlier in the traversal of the
5981 -- corresponding actuals, and this status should not be modified for
5982 -- the array (sub)type itself. However, if the base type of the array
5983 -- (sub)type is private, its full view must be restored in the body to
5984 -- be consistent with subsequent index subtypes, etc.
5986 -- To detect this case we have to rescan the list of formals, which is
5987 -- usually short enough to ignore the resulting inefficiency.
5989 -----------------------------
5990 -- Denotes_Previous_Actual --
5991 -----------------------------
5993 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5997 Prev := First_Entity (Instance);
5998 while Present (Prev) loop
6000 and then Nkind (Parent (Prev)) = N_Subtype_Declaration
6001 and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
6002 and then Entity (Subtype_Indication (Parent (Prev))) = Typ
6015 end Denotes_Previous_Actual;
6017 -- Start of processing for Check_Generic_Actuals
6020 E := First_Entity (Instance);
6021 while Present (E) loop
6023 and then Nkind (Parent (E)) = N_Subtype_Declaration
6024 and then Scope (Etype (E)) /= Instance
6025 and then Is_Entity_Name (Subtype_Indication (Parent (E)))
6027 if Is_Array_Type (E)
6028 and then not Is_Private_Type (Etype (E))
6029 and then Denotes_Previous_Actual (Component_Type (E))
6033 Check_Private_View (Subtype_Indication (Parent (E)));
6036 Set_Is_Generic_Actual_Type (E, True);
6037 Set_Is_Hidden (E, False);
6038 Set_Is_Potentially_Use_Visible (E,
6041 -- We constructed the generic actual type as a subtype of the
6042 -- supplied type. This means that it normally would not inherit
6043 -- subtype specific attributes of the actual, which is wrong for
6044 -- the generic case.
6046 Astype := Ancestor_Subtype (E);
6050 -- This can happen when E is an itype that is the full view of
6051 -- a private type completed, e.g. with a constrained array. In
6052 -- that case, use the first subtype, which will carry size
6053 -- information. The base type itself is unconstrained and will
6056 Astype := First_Subtype (E);
6059 Set_Size_Info (E, (Astype));
6060 Set_RM_Size (E, RM_Size (Astype));
6061 Set_First_Rep_Item (E, First_Rep_Item (Astype));
6063 if Is_Discrete_Or_Fixed_Point_Type (E) then
6064 Set_RM_Size (E, RM_Size (Astype));
6066 -- In nested instances, the base type of an access actual may
6067 -- itself be private, and need to be exchanged.
6069 elsif Is_Access_Type (E)
6070 and then Is_Private_Type (Etype (E))
6073 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
6076 elsif Ekind (E) = E_Package then
6078 -- If this is the renaming for the current instance, we're done.
6079 -- Otherwise it is a formal package. If the corresponding formal
6080 -- was declared with a box, the (instantiations of the) generic
6081 -- formal part are also visible. Otherwise, ignore the entity
6082 -- created to validate the actuals.
6084 if Renamed_Object (E) = Instance then
6087 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
6090 -- The visibility of a formal of an enclosing generic is already
6093 elsif Denotes_Formal_Package (E) then
6096 elsif Present (Associated_Formal_Package (E))
6097 and then not Is_Generic_Formal (E)
6099 if Box_Present (Parent (Associated_Formal_Package (E))) then
6100 Check_Generic_Actuals (Renamed_Object (E), True);
6103 Check_Generic_Actuals (Renamed_Object (E), False);
6106 Set_Is_Hidden (E, False);
6109 -- If this is a subprogram instance (in a wrapper package) the
6110 -- actual is fully visible.
6112 elsif Is_Wrapper_Package (Instance) then
6113 Set_Is_Hidden (E, False);
6115 -- If the formal package is declared with a box, or if the formal
6116 -- parameter is defaulted, it is visible in the body.
6118 elsif Is_Formal_Box or else Is_Visible_Formal (E) then
6119 Set_Is_Hidden (E, False);
6122 if Ekind (E) = E_Constant then
6124 -- If the type of the actual is a private type declared in the
6125 -- enclosing scope of the generic unit, the body of the generic
6126 -- sees the full view of the type (because it has to appear in
6127 -- the corresponding package body). If the type is private now,
6128 -- exchange views to restore the proper visiblity in the instance.
6131 Typ : constant Entity_Id := Base_Type (Etype (E));
6132 -- The type of the actual
6137 Parent_Scope : Entity_Id;
6138 -- The enclosing scope of the generic unit
6141 if Is_Wrapper_Package (Instance) then
6145 (Unit_Declaration_Node
6146 (Related_Instance (Instance))));
6149 Generic_Parent (Package_Specification (Instance));
6152 Parent_Scope := Scope (Gen_Id);
6154 -- The exchange is only needed if the generic is defined
6155 -- within a package which is not a common ancestor of the
6156 -- scope of the instance, and is not already in scope.
6158 if Is_Private_Type (Typ)
6159 and then Scope (Typ) = Parent_Scope
6160 and then Scope (Instance) /= Parent_Scope
6161 and then Ekind (Parent_Scope) = E_Package
6162 and then not Is_Child_Unit (Gen_Id)
6166 -- If the type of the entity is a subtype, it may also have
6167 -- to be made visible, together with the base type of its
6168 -- full view, after exchange.
6170 if Is_Private_Type (Etype (E)) then
6171 Switch_View (Etype (E));
6172 Switch_View (Base_Type (Etype (E)));
6180 end Check_Generic_Actuals;
6182 ------------------------------
6183 -- Check_Generic_Child_Unit --
6184 ------------------------------
6186 procedure Check_Generic_Child_Unit
6188 Parent_Installed : in out Boolean)
6190 Loc : constant Source_Ptr := Sloc (Gen_Id);
6191 Gen_Par : Entity_Id := Empty;
6193 Inst_Par : Entity_Id;
6196 function Find_Generic_Child
6198 Id : Node_Id) return Entity_Id;
6199 -- Search generic parent for possible child unit with the given name
6201 function In_Enclosing_Instance return Boolean;
6202 -- Within an instance of the parent, the child unit may be denoted by
6203 -- a simple name, or an abbreviated expanded name. Examine enclosing
6204 -- scopes to locate a possible parent instantiation.
6206 ------------------------
6207 -- Find_Generic_Child --
6208 ------------------------
6210 function Find_Generic_Child
6212 Id : Node_Id) return Entity_Id
6217 -- If entity of name is already set, instance has already been
6218 -- resolved, e.g. in an enclosing instantiation.
6220 if Present (Entity (Id)) then
6221 if Scope (Entity (Id)) = Scop then
6228 E := First_Entity (Scop);
6229 while Present (E) loop
6230 if Chars (E) = Chars (Id)
6231 and then Is_Child_Unit (E)
6233 if Is_Child_Unit (E)
6234 and then not Is_Visible_Lib_Unit (E)
6237 ("generic child unit& is not visible", Gen_Id, E);
6249 end Find_Generic_Child;
6251 ---------------------------
6252 -- In_Enclosing_Instance --
6253 ---------------------------
6255 function In_Enclosing_Instance return Boolean is
6256 Enclosing_Instance : Node_Id;
6257 Instance_Decl : Node_Id;
6260 -- We do not inline any call that contains instantiations, except
6261 -- for instantiations of Unchecked_Conversion, so if we are within
6262 -- an inlined body the current instance does not require parents.
6264 if In_Inlined_Body then
6265 pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
6269 -- Loop to check enclosing scopes
6271 Enclosing_Instance := Current_Scope;
6272 while Present (Enclosing_Instance) loop
6273 Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
6275 if Ekind (Enclosing_Instance) = E_Package
6276 and then Is_Generic_Instance (Enclosing_Instance)
6278 (Generic_Parent (Specification (Instance_Decl)))
6280 -- Check whether the generic we are looking for is a child of
6283 E := Find_Generic_Child
6284 (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
6285 exit when Present (E);
6291 Enclosing_Instance := Scope (Enclosing_Instance);
6303 Make_Expanded_Name (Loc,
6305 Prefix => New_Occurrence_Of (Enclosing_Instance, Loc),
6306 Selector_Name => New_Occurrence_Of (E, Loc)));
6308 Set_Entity (Gen_Id, E);
6309 Set_Etype (Gen_Id, Etype (E));
6310 Parent_Installed := False; -- Already in scope.
6313 end In_Enclosing_Instance;
6315 -- Start of processing for Check_Generic_Child_Unit
6318 -- If the name of the generic is given by a selected component, it may
6319 -- be the name of a generic child unit, and the prefix is the name of an
6320 -- instance of the parent, in which case the child unit must be visible.
6321 -- If this instance is not in scope, it must be placed there and removed
6322 -- after instantiation, because what is being instantiated is not the
6323 -- original child, but the corresponding child present in the instance
6326 -- If the child is instantiated within the parent, it can be given by
6327 -- a simple name. In this case the instance is already in scope, but
6328 -- the child generic must be recovered from the generic parent as well.
6330 if Nkind (Gen_Id) = N_Selected_Component then
6331 S := Selector_Name (Gen_Id);
6332 Analyze (Prefix (Gen_Id));
6333 Inst_Par := Entity (Prefix (Gen_Id));
6335 if Ekind (Inst_Par) = E_Package
6336 and then Present (Renamed_Object (Inst_Par))
6338 Inst_Par := Renamed_Object (Inst_Par);
6341 if Ekind (Inst_Par) = E_Package then
6342 if Nkind (Parent (Inst_Par)) = N_Package_Specification then
6343 Gen_Par := Generic_Parent (Parent (Inst_Par));
6345 elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
6347 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
6349 Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
6352 elsif Ekind (Inst_Par) = E_Generic_Package
6353 and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
6355 -- A formal package may be a real child package, and not the
6356 -- implicit instance within a parent. In this case the child is
6357 -- not visible and has to be retrieved explicitly as well.
6359 Gen_Par := Inst_Par;
6362 if Present (Gen_Par) then
6364 -- The prefix denotes an instantiation. The entity itself may be a
6365 -- nested generic, or a child unit.
6367 E := Find_Generic_Child (Gen_Par, S);
6370 Change_Selected_Component_To_Expanded_Name (Gen_Id);
6371 Set_Entity (Gen_Id, E);
6372 Set_Etype (Gen_Id, Etype (E));
6374 Set_Etype (S, Etype (E));
6376 -- Indicate that this is a reference to the parent
6378 if In_Extended_Main_Source_Unit (Gen_Id) then
6379 Set_Is_Instantiated (Inst_Par);
6382 -- A common mistake is to replicate the naming scheme of a
6383 -- hierarchy by instantiating a generic child directly, rather
6384 -- than the implicit child in a parent instance:
6386 -- generic .. package Gpar is ..
6387 -- generic .. package Gpar.Child is ..
6388 -- package Par is new Gpar ();
6391 -- package Par.Child is new Gpar.Child ();
6392 -- rather than Par.Child
6394 -- In this case the instantiation is within Par, which is an
6395 -- instance, but Gpar does not denote Par because we are not IN
6396 -- the instance of Gpar, so this is illegal. The test below
6397 -- recognizes this particular case.
6399 if Is_Child_Unit (E)
6400 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
6401 and then (not In_Instance
6402 or else Nkind (Parent (Parent (Gen_Id))) =
6406 ("prefix of generic child unit must be instance of parent",
6410 if not In_Open_Scopes (Inst_Par)
6411 and then Nkind (Parent (Gen_Id)) not in
6412 N_Generic_Renaming_Declaration
6414 Install_Parent (Inst_Par);
6415 Parent_Installed := True;
6417 elsif In_Open_Scopes (Inst_Par) then
6419 -- If the parent is already installed, install the actuals
6420 -- for its formal packages. This is necessary when the child
6421 -- instance is a child of the parent instance: in this case,
6422 -- the parent is placed on the scope stack but the formal
6423 -- packages are not made visible.
6425 Install_Formal_Packages (Inst_Par);
6429 -- If the generic parent does not contain an entity that
6430 -- corresponds to the selector, the instance doesn't either.
6431 -- Analyzing the node will yield the appropriate error message.
6432 -- If the entity is not a child unit, then it is an inner
6433 -- generic in the parent.
6441 if Is_Child_Unit (Entity (Gen_Id))
6443 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6444 and then not In_Open_Scopes (Inst_Par)
6446 Install_Parent (Inst_Par);
6447 Parent_Installed := True;
6449 -- The generic unit may be the renaming of the implicit child
6450 -- present in an instance. In that case the parent instance is
6451 -- obtained from the name of the renamed entity.
6453 elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
6454 and then Present (Renamed_Entity (Entity (Gen_Id)))
6455 and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
6458 Renamed_Package : constant Node_Id :=
6459 Name (Parent (Entity (Gen_Id)));
6461 if Nkind (Renamed_Package) = N_Expanded_Name then
6462 Inst_Par := Entity (Prefix (Renamed_Package));
6463 Install_Parent (Inst_Par);
6464 Parent_Installed := True;
6470 elsif Nkind (Gen_Id) = N_Expanded_Name then
6472 -- Entity already present, analyze prefix, whose meaning may be
6473 -- an instance in the current context. If it is an instance of
6474 -- a relative within another, the proper parent may still have
6475 -- to be installed, if they are not of the same generation.
6477 Analyze (Prefix (Gen_Id));
6479 -- In the unlikely case that a local declaration hides the name
6480 -- of the parent package, locate it on the homonym chain. If the
6481 -- context is an instance of the parent, the renaming entity is
6484 Inst_Par := Entity (Prefix (Gen_Id));
6485 while Present (Inst_Par)
6486 and then not Is_Package_Or_Generic_Package (Inst_Par)
6488 Inst_Par := Homonym (Inst_Par);
6491 pragma Assert (Present (Inst_Par));
6492 Set_Entity (Prefix (Gen_Id), Inst_Par);
6494 if In_Enclosing_Instance then
6497 elsif Present (Entity (Gen_Id))
6498 and then Is_Child_Unit (Entity (Gen_Id))
6499 and then not In_Open_Scopes (Inst_Par)
6501 Install_Parent (Inst_Par);
6502 Parent_Installed := True;
6505 elsif In_Enclosing_Instance then
6507 -- The child unit is found in some enclosing scope
6514 -- If this is the renaming of the implicit child in a parent
6515 -- instance, recover the parent name and install it.
6517 if Is_Entity_Name (Gen_Id) then
6518 E := Entity (Gen_Id);
6520 if Is_Generic_Unit (E)
6521 and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
6522 and then Is_Child_Unit (Renamed_Object (E))
6523 and then Is_Generic_Unit (Scope (Renamed_Object (E)))
6524 and then Nkind (Name (Parent (E))) = N_Expanded_Name
6527 New_Copy_Tree (Name (Parent (E))));
6528 Inst_Par := Entity (Prefix (Gen_Id));
6530 if not In_Open_Scopes (Inst_Par) then
6531 Install_Parent (Inst_Par);
6532 Parent_Installed := True;
6535 -- If it is a child unit of a non-generic parent, it may be
6536 -- use-visible and given by a direct name. Install parent as
6539 elsif Is_Generic_Unit (E)
6540 and then Is_Child_Unit (E)
6542 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6543 and then not Is_Generic_Unit (Scope (E))
6545 if not In_Open_Scopes (Scope (E)) then
6546 Install_Parent (Scope (E));
6547 Parent_Installed := True;
6552 end Check_Generic_Child_Unit;
6554 -----------------------------
6555 -- Check_Hidden_Child_Unit --
6556 -----------------------------
6558 procedure Check_Hidden_Child_Unit
6560 Gen_Unit : Entity_Id;
6561 Act_Decl_Id : Entity_Id)
6563 Gen_Id : constant Node_Id := Name (N);
6566 if Is_Child_Unit (Gen_Unit)
6567 and then Is_Child_Unit (Act_Decl_Id)
6568 and then Nkind (Gen_Id) = N_Expanded_Name
6569 and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
6570 and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
6572 Error_Msg_Node_2 := Scope (Act_Decl_Id);
6574 ("generic unit & is implicitly declared in &",
6575 Defining_Unit_Name (N), Gen_Unit);
6576 Error_Msg_N ("\instance must have different name",
6577 Defining_Unit_Name (N));
6579 end Check_Hidden_Child_Unit;
6581 ------------------------
6582 -- Check_Private_View --
6583 ------------------------
6585 procedure Check_Private_View (N : Node_Id) is
6586 T : constant Entity_Id := Etype (N);
6590 -- Exchange views if the type was not private in the generic but is
6591 -- private at the point of instantiation. Do not exchange views if
6592 -- the scope of the type is in scope. This can happen if both generic
6593 -- and instance are sibling units, or if type is defined in a parent.
6594 -- In this case the visibility of the type will be correct for all
6598 BT := Base_Type (T);
6600 if Is_Private_Type (T)
6601 and then not Has_Private_View (N)
6602 and then Present (Full_View (T))
6603 and then not In_Open_Scopes (Scope (T))
6605 -- In the generic, the full type was visible. Save the private
6606 -- entity, for subsequent exchange.
6610 elsif Has_Private_View (N)
6611 and then not Is_Private_Type (T)
6612 and then not Has_Been_Exchanged (T)
6613 and then Etype (Get_Associated_Node (N)) /= T
6615 -- Only the private declaration was visible in the generic. If
6616 -- the type appears in a subtype declaration, the subtype in the
6617 -- instance must have a view compatible with that of its parent,
6618 -- which must be exchanged (see corresponding code in Restore_
6619 -- Private_Views). Otherwise, if the type is defined in a parent
6620 -- unit, leave full visibility within instance, which is safe.
6622 if In_Open_Scopes (Scope (Base_Type (T)))
6623 and then not Is_Private_Type (Base_Type (T))
6624 and then Comes_From_Source (Base_Type (T))
6628 elsif Nkind (Parent (N)) = N_Subtype_Declaration
6629 or else not In_Private_Part (Scope (Base_Type (T)))
6631 Prepend_Elmt (T, Exchanged_Views);
6632 Exchange_Declarations (Etype (Get_Associated_Node (N)));
6635 -- For composite types with inconsistent representation exchange
6636 -- component types accordingly.
6638 elsif Is_Access_Type (T)
6639 and then Is_Private_Type (Designated_Type (T))
6640 and then not Has_Private_View (N)
6641 and then Present (Full_View (Designated_Type (T)))
6643 Switch_View (Designated_Type (T));
6645 elsif Is_Array_Type (T) then
6646 if Is_Private_Type (Component_Type (T))
6647 and then not Has_Private_View (N)
6648 and then Present (Full_View (Component_Type (T)))
6650 Switch_View (Component_Type (T));
6653 -- The normal exchange mechanism relies on the setting of a
6654 -- flag on the reference in the generic. However, an additional
6655 -- mechanism is needed for types that are not explicitly
6656 -- mentioned in the generic, but may be needed in expanded code
6657 -- in the instance. This includes component types of arrays and
6658 -- designated types of access types. This processing must also
6659 -- include the index types of arrays which we take care of here.
6666 Indx := First_Index (T);
6667 while Present (Indx) loop
6668 Typ := Base_Type (Etype (Indx));
6670 if Is_Private_Type (Typ)
6671 and then Present (Full_View (Typ))
6680 elsif Is_Private_Type (T)
6681 and then Present (Full_View (T))
6682 and then Is_Array_Type (Full_View (T))
6683 and then Is_Private_Type (Component_Type (Full_View (T)))
6687 -- Finally, a non-private subtype may have a private base type, which
6688 -- must be exchanged for consistency. This can happen when a package
6689 -- body is instantiated, when the scope stack is empty but in fact
6690 -- the subtype and the base type are declared in an enclosing scope.
6692 -- Note that in this case we introduce an inconsistency in the view
6693 -- set, because we switch the base type BT, but there could be some
6694 -- private dependent subtypes of BT which remain unswitched. Such
6695 -- subtypes might need to be switched at a later point (see specific
6696 -- provision for that case in Switch_View).
6698 elsif not Is_Private_Type (T)
6699 and then not Has_Private_View (N)
6700 and then Is_Private_Type (BT)
6701 and then Present (Full_View (BT))
6702 and then not Is_Generic_Type (BT)
6703 and then not In_Open_Scopes (BT)
6705 Prepend_Elmt (Full_View (BT), Exchanged_Views);
6706 Exchange_Declarations (BT);
6709 end Check_Private_View;
6711 -----------------------------
6712 -- Check_Hidden_Primitives --
6713 -----------------------------
6715 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6718 Result : Elist_Id := No_Elist;
6721 if No (Assoc_List) then
6725 -- Traverse the list of associations between formals and actuals
6726 -- searching for renamings of tagged types
6728 Actual := First (Assoc_List);
6729 while Present (Actual) loop
6730 if Nkind (Actual) = N_Subtype_Declaration then
6731 Gen_T := Generic_Parent_Type (Actual);
6734 and then Is_Tagged_Type (Gen_T)
6736 -- Traverse the list of primitives of the actual types
6737 -- searching for hidden primitives that are visible in the
6738 -- corresponding generic formal; leave them visible and
6739 -- append them to Result to restore their decoration later.
6741 Install_Hidden_Primitives
6742 (Prims_List => Result,
6744 Act_T => Entity (Subtype_Indication (Actual)));
6752 end Check_Hidden_Primitives;
6754 --------------------------
6755 -- Contains_Instance_Of --
6756 --------------------------
6758 function Contains_Instance_Of
6761 N : Node_Id) return Boolean
6769 -- Verify that there are no circular instantiations. We check whether
6770 -- the unit contains an instance of the current scope or some enclosing
6771 -- scope (in case one of the instances appears in a subunit). Longer
6772 -- circularities involving subunits might seem too pathological to
6773 -- consider, but they were not too pathological for the authors of
6774 -- DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6775 -- enclosing generic scopes as containing an instance.
6778 -- Within a generic subprogram body, the scope is not generic, to
6779 -- allow for recursive subprograms. Use the declaration to determine
6780 -- whether this is a generic unit.
6782 if Ekind (Scop) = E_Generic_Package
6783 or else (Is_Subprogram (Scop)
6784 and then Nkind (Unit_Declaration_Node (Scop)) =
6785 N_Generic_Subprogram_Declaration)
6787 Elmt := First_Elmt (Inner_Instances (Inner));
6789 while Present (Elmt) loop
6790 if Node (Elmt) = Scop then
6791 Error_Msg_Node_2 := Inner;
6793 ("circular Instantiation: & instantiated within &!",
6797 elsif Node (Elmt) = Inner then
6800 elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6801 Error_Msg_Node_2 := Inner;
6803 ("circular Instantiation: & instantiated within &!",
6811 -- Indicate that Inner is being instantiated within Scop
6813 Append_Elmt (Inner, Inner_Instances (Scop));
6816 if Scop = Standard_Standard then
6819 Scop := Scope (Scop);
6824 end Contains_Instance_Of;
6826 -----------------------
6827 -- Copy_Generic_Node --
6828 -----------------------
6830 function Copy_Generic_Node
6832 Parent_Id : Node_Id;
6833 Instantiating : Boolean) return Node_Id
6838 function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6839 -- Check the given value of one of the Fields referenced by the current
6840 -- node to determine whether to copy it recursively. The field may hold
6841 -- a Node_Id, a List_Id, or an Elist_Id, or a plain value (Sloc, Uint,
6842 -- Char) in which case it need not be copied.
6844 procedure Copy_Descendants;
6845 -- Common utility for various nodes
6847 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6848 -- Make copy of element list
6850 function Copy_Generic_List
6852 Parent_Id : Node_Id) return List_Id;
6853 -- Apply Copy_Node recursively to the members of a node list
6855 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6856 -- True if an identifier is part of the defining program unit name of
6857 -- a child unit. The entity of such an identifier must be kept (for
6858 -- ASIS use) even though as the name of an enclosing generic it would
6859 -- otherwise not be preserved in the generic tree.
6861 ----------------------
6862 -- Copy_Descendants --
6863 ----------------------
6865 procedure Copy_Descendants is
6867 use Atree.Unchecked_Access;
6868 -- This code section is part of the implementation of an untyped
6869 -- tree traversal, so it needs direct access to node fields.
6872 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6873 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6874 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6875 Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6876 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6877 end Copy_Descendants;
6879 -----------------------------
6880 -- Copy_Generic_Descendant --
6881 -----------------------------
6883 function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6885 if D = Union_Id (Empty) then
6888 elsif D in Node_Range then
6890 (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6892 elsif D in List_Range then
6893 return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6895 elsif D in Elist_Range then
6896 return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6898 -- Nothing else is copyable (e.g. Uint values), return as is
6903 end Copy_Generic_Descendant;
6905 ------------------------
6906 -- Copy_Generic_Elist --
6907 ------------------------
6909 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6916 M := First_Elmt (E);
6917 while Present (M) loop
6919 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6928 end Copy_Generic_Elist;
6930 -----------------------
6931 -- Copy_Generic_List --
6932 -----------------------
6934 function Copy_Generic_List
6936 Parent_Id : Node_Id) return List_Id
6944 Set_Parent (New_L, Parent_Id);
6947 while Present (N) loop
6948 Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6957 end Copy_Generic_List;
6959 ---------------------------
6960 -- In_Defining_Unit_Name --
6961 ---------------------------
6963 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6965 return Present (Parent (Nam))
6966 and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6968 (Nkind (Parent (Nam)) = N_Expanded_Name
6969 and then In_Defining_Unit_Name (Parent (Nam))));
6970 end In_Defining_Unit_Name;
6972 -- Start of processing for Copy_Generic_Node
6979 New_N := New_Copy (N);
6981 -- Copy aspects if present
6983 if Has_Aspects (N) then
6984 Set_Has_Aspects (New_N, False);
6985 Set_Aspect_Specifications
6986 (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6989 if Instantiating then
6990 Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6993 if not Is_List_Member (N) then
6994 Set_Parent (New_N, Parent_Id);
6997 -- If defining identifier, then all fields have been copied already
6999 if Nkind (New_N) in N_Entity then
7002 -- Special casing for identifiers and other entity names and operators
7004 elsif Nkind_In (New_N, N_Identifier,
7005 N_Character_Literal,
7008 or else Nkind (New_N) in N_Op
7010 if not Instantiating then
7012 -- Link both nodes in order to assign subsequently the entity of
7013 -- the copy to the original node, in case this is a global
7016 Set_Associated_Node (N, New_N);
7018 -- If we are within an instantiation, this is a nested generic
7019 -- that has already been analyzed at the point of definition.
7020 -- We must preserve references that were global to the enclosing
7021 -- parent at that point. Other occurrences, whether global or
7022 -- local to the current generic, must be resolved anew, so we
7023 -- reset the entity in the generic copy. A global reference has a
7024 -- smaller depth than the parent, or else the same depth in case
7025 -- both are distinct compilation units.
7027 -- A child unit is implicitly declared within the enclosing parent
7028 -- but is in fact global to it, and must be preserved.
7030 -- It is also possible for Current_Instantiated_Parent to be
7031 -- defined, and for this not to be a nested generic, namely if
7032 -- the unit is loaded through Rtsfind. In that case, the entity of
7033 -- New_N is only a link to the associated node, and not a defining
7036 -- The entities for parent units in the defining_program_unit of a
7037 -- generic child unit are established when the context of the unit
7038 -- is first analyzed, before the generic copy is made. They are
7039 -- preserved in the copy for use in ASIS queries.
7041 Ent := Entity (New_N);
7043 if No (Current_Instantiated_Parent.Gen_Id) then
7045 or else Nkind (Ent) /= N_Defining_Identifier
7046 or else not In_Defining_Unit_Name (N)
7048 Set_Associated_Node (New_N, Empty);
7053 not Nkind_In (Ent, N_Defining_Identifier,
7054 N_Defining_Character_Literal,
7055 N_Defining_Operator_Symbol)
7056 or else No (Scope (Ent))
7058 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
7059 and then not Is_Child_Unit (Ent))
7061 (Scope_Depth (Scope (Ent)) >
7062 Scope_Depth (Current_Instantiated_Parent.Gen_Id)
7064 Get_Source_Unit (Ent) =
7065 Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
7067 Set_Associated_Node (New_N, Empty);
7070 -- Case of instantiating identifier or some other name or operator
7073 -- If the associated node is still defined, the entity in it
7074 -- is global, and must be copied to the instance. If this copy
7075 -- is being made for a body to inline, it is applied to an
7076 -- instantiated tree, and the entity is already present and
7077 -- must be also preserved.
7080 Assoc : constant Node_Id := Get_Associated_Node (N);
7083 if Present (Assoc) then
7084 if Nkind (Assoc) = Nkind (N) then
7085 Set_Entity (New_N, Entity (Assoc));
7086 Check_Private_View (N);
7088 -- The name in the call may be a selected component if the
7089 -- call has not been analyzed yet, as may be the case for
7090 -- pre/post conditions in a generic unit.
7092 elsif Nkind (Assoc) = N_Function_Call
7093 and then Is_Entity_Name (Name (Assoc))
7095 Set_Entity (New_N, Entity (Name (Assoc)));
7097 elsif Nkind_In (Assoc, N_Defining_Identifier,
7098 N_Defining_Character_Literal,
7099 N_Defining_Operator_Symbol)
7100 and then Expander_Active
7102 -- Inlining case: we are copying a tree that contains
7103 -- global entities, which are preserved in the copy to be
7104 -- used for subsequent inlining.
7109 Set_Entity (New_N, Empty);
7115 -- For expanded name, we must copy the Prefix and Selector_Name
7117 if Nkind (N) = N_Expanded_Name then
7119 (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
7121 Set_Selector_Name (New_N,
7122 Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
7124 -- For operators, we must copy the right operand
7126 elsif Nkind (N) in N_Op then
7127 Set_Right_Opnd (New_N,
7128 Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
7130 -- And for binary operators, the left operand as well
7132 if Nkind (N) in N_Binary_Op then
7133 Set_Left_Opnd (New_N,
7134 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
7138 -- Special casing for stubs
7140 elsif Nkind (N) in N_Body_Stub then
7142 -- In any case, we must copy the specification or defining
7143 -- identifier as appropriate.
7145 if Nkind (N) = N_Subprogram_Body_Stub then
7146 Set_Specification (New_N,
7147 Copy_Generic_Node (Specification (N), New_N, Instantiating));
7150 Set_Defining_Identifier (New_N,
7152 (Defining_Identifier (N), New_N, Instantiating));
7155 -- If we are not instantiating, then this is where we load and
7156 -- analyze subunits, i.e. at the point where the stub occurs. A
7157 -- more permissive system might defer this analysis to the point
7158 -- of instantiation, but this seems too complicated for now.
7160 if not Instantiating then
7162 Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
7164 Unum : Unit_Number_Type;
7168 -- Make sure that, if it is a subunit of the main unit that is
7169 -- preprocessed and if -gnateG is specified, the preprocessed
7170 -- file will be written.
7172 Lib.Analysing_Subunit_Of_Main :=
7173 Lib.In_Extended_Main_Source_Unit (N);
7176 (Load_Name => Subunit_Name,
7180 Lib.Analysing_Subunit_Of_Main := False;
7182 -- If the proper body is not found, a warning message will be
7183 -- emitted when analyzing the stub, or later at the point of
7184 -- instantiation. Here we just leave the stub as is.
7186 if Unum = No_Unit then
7187 Subunits_Missing := True;
7188 goto Subunit_Not_Found;
7191 Subunit := Cunit (Unum);
7193 if Nkind (Unit (Subunit)) /= N_Subunit then
7195 ("found child unit instead of expected SEPARATE subunit",
7197 Error_Msg_Sloc := Sloc (N);
7198 Error_Msg_N ("\to complete stub #", Subunit);
7199 goto Subunit_Not_Found;
7202 -- We must create a generic copy of the subunit, in order to
7203 -- perform semantic analysis on it, and we must replace the
7204 -- stub in the original generic unit with the subunit, in order
7205 -- to preserve non-local references within.
7207 -- Only the proper body needs to be copied. Library_Unit and
7208 -- context clause are simply inherited by the generic copy.
7209 -- Note that the copy (which may be recursive if there are
7210 -- nested subunits) must be done first, before attaching it to
7211 -- the enclosing generic.
7215 (Proper_Body (Unit (Subunit)),
7216 Empty, Instantiating => False);
7218 -- Now place the original proper body in the original generic
7219 -- unit. This is a body, not a compilation unit.
7221 Rewrite (N, Proper_Body (Unit (Subunit)));
7222 Set_Is_Compilation_Unit (Defining_Entity (N), False);
7223 Set_Was_Originally_Stub (N);
7225 -- Finally replace the body of the subunit with its copy, and
7226 -- make this new subunit into the library unit of the generic
7227 -- copy, which does not have stubs any longer.
7229 Set_Proper_Body (Unit (Subunit), New_Body);
7230 Set_Library_Unit (New_N, Subunit);
7231 Inherit_Context (Unit (Subunit), N);
7234 -- If we are instantiating, this must be an error case, since
7235 -- otherwise we would have replaced the stub node by the proper body
7236 -- that corresponds. So just ignore it in the copy (i.e. we have
7237 -- copied it, and that is good enough).
7243 <<Subunit_Not_Found>> null;
7245 -- If the node is a compilation unit, it is the subunit of a stub, which
7246 -- has been loaded already (see code below). In this case, the library
7247 -- unit field of N points to the parent unit (which is a compilation
7248 -- unit) and need not (and cannot) be copied.
7250 -- When the proper body of the stub is analyzed, the library_unit link
7251 -- is used to establish the proper context (see sem_ch10).
7253 -- The other fields of a compilation unit are copied as usual
7255 elsif Nkind (N) = N_Compilation_Unit then
7257 -- This code can only be executed when not instantiating, because in
7258 -- the copy made for an instantiation, the compilation unit node has
7259 -- disappeared at the point that a stub is replaced by its proper
7262 pragma Assert (not Instantiating);
7264 Set_Context_Items (New_N,
7265 Copy_Generic_List (Context_Items (N), New_N));
7268 Copy_Generic_Node (Unit (N), New_N, False));
7270 Set_First_Inlined_Subprogram (New_N,
7272 (First_Inlined_Subprogram (N), New_N, False));
7274 Set_Aux_Decls_Node (New_N,
7275 Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
7277 -- For an assignment node, the assignment is known to be semantically
7278 -- legal if we are instantiating the template. This avoids incorrect
7279 -- diagnostics in generated code.
7281 elsif Nkind (N) = N_Assignment_Statement then
7283 -- Copy name and expression fields in usual manner
7286 Copy_Generic_Node (Name (N), New_N, Instantiating));
7288 Set_Expression (New_N,
7289 Copy_Generic_Node (Expression (N), New_N, Instantiating));
7291 if Instantiating then
7292 Set_Assignment_OK (Name (New_N), True);
7295 elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
7296 if not Instantiating then
7297 Set_Associated_Node (N, New_N);
7300 if Present (Get_Associated_Node (N))
7301 and then Nkind (Get_Associated_Node (N)) = Nkind (N)
7303 -- In the generic the aggregate has some composite type. If at
7304 -- the point of instantiation the type has a private view,
7305 -- install the full view (and that of its ancestors, if any).
7308 T : Entity_Id := (Etype (Get_Associated_Node (New_N)));
7313 and then Is_Private_Type (T)
7319 and then Is_Tagged_Type (T)
7320 and then Is_Derived_Type (T)
7322 Rt := Root_Type (T);
7327 if Is_Private_Type (T) then
7338 -- Do not copy the associated node, which points to the generic copy
7339 -- of the aggregate.
7342 use Atree.Unchecked_Access;
7343 -- This code section is part of the implementation of an untyped
7344 -- tree traversal, so it needs direct access to node fields.
7347 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
7348 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
7349 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
7350 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
7353 -- Allocators do not have an identifier denoting the access type, so we
7354 -- must locate it through the expression to check whether the views are
7357 elsif Nkind (N) = N_Allocator
7358 and then Nkind (Expression (N)) = N_Qualified_Expression
7359 and then Is_Entity_Name (Subtype_Mark (Expression (N)))
7360 and then Instantiating
7363 T : constant Node_Id :=
7364 Get_Associated_Node (Subtype_Mark (Expression (N)));
7370 -- Retrieve the allocator node in the generic copy
7372 Acc_T := Etype (Parent (Parent (T)));
7374 and then Is_Private_Type (Acc_T)
7376 Switch_View (Acc_T);
7383 -- For a proper body, we must catch the case of a proper body that
7384 -- replaces a stub. This represents the point at which a separate
7385 -- compilation unit, and hence template file, may be referenced, so we
7386 -- must make a new source instantiation entry for the template of the
7387 -- subunit, and ensure that all nodes in the subunit are adjusted using
7388 -- this new source instantiation entry.
7390 elsif Nkind (N) in N_Proper_Body then
7392 Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
7395 if Instantiating and then Was_Originally_Stub (N) then
7396 Create_Instantiation_Source
7397 (Instantiation_Node,
7398 Defining_Entity (N),
7403 -- Now copy the fields of the proper body, using the new
7404 -- adjustment factor if one was needed as per test above.
7408 -- Restore the original adjustment factor in case changed
7410 S_Adjustment := Save_Adjustment;
7413 -- Don't copy Ident or Comment pragmas, since the comment belongs to the
7414 -- generic unit, not to the instantiating unit.
7416 elsif Nkind (N) = N_Pragma and then Instantiating then
7418 Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
7420 if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
7421 New_N := Make_Null_Statement (Sloc (N));
7427 elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
7429 -- No descendant fields need traversing
7433 elsif Nkind (N) = N_String_Literal
7434 and then Present (Etype (N))
7435 and then Instantiating
7437 -- If the string is declared in an outer scope, the string_literal
7438 -- subtype created for it may have the wrong scope. We force the
7439 -- reanalysis of the constant to generate a new itype in the proper
7442 Set_Etype (New_N, Empty);
7443 Set_Analyzed (New_N, False);
7445 -- For the remaining nodes, copy their descendants recursively
7450 if Instantiating and then Nkind (N) = N_Subprogram_Body then
7451 Set_Generic_Parent (Specification (New_N), N);
7453 -- Should preserve Corresponding_Spec??? (12.3(14))
7458 end Copy_Generic_Node;
7460 ----------------------------
7461 -- Denotes_Formal_Package --
7462 ----------------------------
7464 function Denotes_Formal_Package
7466 On_Exit : Boolean := False;
7467 Instance : Entity_Id := Empty) return Boolean
7470 Scop : constant Entity_Id := Scope (Pack);
7473 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
7474 -- The package in question may be an actual for a previous formal
7475 -- package P of the current instance, so examine its actuals as well.
7476 -- This must be recursive over other formal packages.
7478 ----------------------------------
7479 -- Is_Actual_Of_Previous_Formal --
7480 ----------------------------------
7482 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
7486 E1 := First_Entity (P);
7487 while Present (E1) and then E1 /= Instance loop
7488 if Ekind (E1) = E_Package
7489 and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
7491 if Renamed_Object (E1) = Pack then
7494 elsif E1 = P or else Renamed_Object (E1) = P then
7497 elsif Is_Actual_Of_Previous_Formal (E1) then
7506 end Is_Actual_Of_Previous_Formal;
7508 -- Start of processing for Denotes_Formal_Package
7514 (Instance_Envs.Last).Instantiated_Parent.Act_Id;
7516 Par := Current_Instantiated_Parent.Act_Id;
7519 if Ekind (Scop) = E_Generic_Package
7520 or else Nkind (Unit_Declaration_Node (Scop)) =
7521 N_Generic_Subprogram_Declaration
7525 elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
7526 N_Formal_Package_Declaration
7534 -- Check whether this package is associated with a formal package of
7535 -- the enclosing instantiation. Iterate over the list of renamings.
7537 E := First_Entity (Par);
7538 while Present (E) loop
7539 if Ekind (E) /= E_Package
7540 or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
7544 elsif Renamed_Object (E) = Par then
7547 elsif Renamed_Object (E) = Pack then
7550 elsif Is_Actual_Of_Previous_Formal (E) then
7560 end Denotes_Formal_Package;
7566 procedure End_Generic is
7568 -- ??? More things could be factored out in this routine. Should
7569 -- probably be done at a later stage.
7571 Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
7572 Generic_Flags.Decrement_Last;
7574 Expander_Mode_Restore;
7581 function Earlier (N1, N2 : Node_Id) return Boolean is
7582 procedure Find_Depth (P : in out Node_Id; D : in out Integer);
7583 -- Find distance from given node to enclosing compilation unit
7589 procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
7592 and then Nkind (P) /= N_Compilation_Unit
7594 P := True_Parent (P);
7599 -- Local declarations
7608 -- Start of processing for Earlier
7611 Find_Depth (P1, D1);
7612 Find_Depth (P2, D2);
7622 P1 := True_Parent (P1);
7627 P2 := True_Parent (P2);
7631 -- At this point P1 and P2 are at the same distance from the root.
7632 -- We examine their parents until we find a common declarative list.
7633 -- If we reach the root, N1 and N2 do not descend from the same
7634 -- declarative list (e.g. one is nested in the declarative part and
7635 -- the other is in a block in the statement part) and the earlier
7636 -- one is already frozen.
7638 while not Is_List_Member (P1)
7639 or else not Is_List_Member (P2)
7640 or else List_Containing (P1) /= List_Containing (P2)
7642 P1 := True_Parent (P1);
7643 P2 := True_Parent (P2);
7645 if Nkind (Parent (P1)) = N_Subunit then
7646 P1 := Corresponding_Stub (Parent (P1));
7649 if Nkind (Parent (P2)) = N_Subunit then
7650 P2 := Corresponding_Stub (Parent (P2));
7658 -- Expanded code usually shares the source location of the original
7659 -- construct it was generated for. This however may not necessarely
7660 -- reflect the true location of the code within the tree.
7662 -- Before comparing the slocs of the two nodes, make sure that we are
7663 -- working with correct source locations. Assume that P1 is to the left
7664 -- of P2. If either one does not come from source, traverse the common
7665 -- list heading towards the other node and locate the first source
7669 -- ----+===+===+--------------+===+===+----
7670 -- expanded code expanded code
7672 if not Comes_From_Source (P1) then
7673 while Present (P1) loop
7675 -- Neither P2 nor a source statement were located during the
7676 -- search. If we reach the end of the list, then P1 does not
7677 -- occur earlier than P2.
7680 -- start --- P2 ----- P1 --- end
7682 if No (Next (P1)) then
7685 -- We encounter P2 while going to the right of the list. This
7686 -- means that P1 does indeed appear earlier.
7689 -- start --- P1 ===== P2 --- end
7690 -- expanded code in between
7695 -- No need to look any further since we have located a source
7698 elsif Comes_From_Source (P1) then
7708 if not Comes_From_Source (P2) then
7709 while Present (P2) loop
7711 -- Neither P1 nor a source statement were located during the
7712 -- search. If we reach the start of the list, then P1 does not
7713 -- occur earlier than P2.
7716 -- start --- P2 --- P1 --- end
7718 if No (Prev (P2)) then
7721 -- We encounter P1 while going to the left of the list. This
7722 -- means that P1 does indeed appear earlier.
7725 -- start --- P1 ===== P2 --- end
7726 -- expanded code in between
7731 -- No need to look any further since we have located a source
7734 elsif Comes_From_Source (P2) then
7744 -- At this point either both nodes came from source or we approximated
7745 -- their source locations through neighbouring source statements.
7747 T1 := Top_Level_Location (Sloc (P1));
7748 T2 := Top_Level_Location (Sloc (P2));
7750 -- When two nodes come from the same instance, they have identical top
7751 -- level locations. To determine proper relation within the tree, check
7752 -- their locations within the template.
7755 return Sloc (P1) < Sloc (P2);
7757 -- The two nodes either come from unrelated instances or do not come
7758 -- from instantiated code at all.
7765 ----------------------
7766 -- Find_Actual_Type --
7767 ----------------------
7769 function Find_Actual_Type
7771 Gen_Type : Entity_Id) return Entity_Id
7773 Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7777 -- Special processing only applies to child units
7779 if not Is_Child_Unit (Gen_Scope) then
7780 return Get_Instance_Of (Typ);
7782 -- If designated or component type is itself a formal of the child unit,
7783 -- its instance is available.
7785 elsif Scope (Typ) = Gen_Scope then
7786 return Get_Instance_Of (Typ);
7788 -- If the array or access type is not declared in the parent unit,
7789 -- no special processing needed.
7791 elsif not Is_Generic_Type (Typ)
7792 and then Scope (Gen_Scope) /= Scope (Typ)
7794 return Get_Instance_Of (Typ);
7796 -- Otherwise, retrieve designated or component type by visibility
7799 T := Current_Entity (Typ);
7800 while Present (T) loop
7801 if In_Open_Scopes (Scope (T)) then
7804 elsif Is_Generic_Actual_Type (T) then
7813 end Find_Actual_Type;
7815 ----------------------------
7816 -- Freeze_Subprogram_Body --
7817 ----------------------------
7819 procedure Freeze_Subprogram_Body
7820 (Inst_Node : Node_Id;
7822 Pack_Id : Entity_Id)
7824 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7825 Par : constant Entity_Id := Scope (Gen_Unit);
7831 function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7832 -- Find innermost package body that encloses the given node, and which
7833 -- is not a compilation unit. Freeze nodes for the instance, or for its
7834 -- enclosing body, may be inserted after the enclosing_body of the
7835 -- generic unit. Used to determine proper placement of freeze node for
7836 -- both package and subprogram instances.
7838 function Package_Freeze_Node (B : Node_Id) return Node_Id;
7839 -- Find entity for given package body, and locate or create a freeze
7842 ----------------------------
7843 -- Enclosing_Package_Body --
7844 ----------------------------
7846 function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7852 and then Nkind (Parent (P)) /= N_Compilation_Unit
7854 if Nkind (P) = N_Package_Body then
7855 if Nkind (Parent (P)) = N_Subunit then
7856 return Corresponding_Stub (Parent (P));
7862 P := True_Parent (P);
7866 end Enclosing_Package_Body;
7868 -------------------------
7869 -- Package_Freeze_Node --
7870 -------------------------
7872 function Package_Freeze_Node (B : Node_Id) return Node_Id is
7876 if Nkind (B) = N_Package_Body then
7877 Id := Corresponding_Spec (B);
7878 else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7879 Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7882 Ensure_Freeze_Node (Id);
7883 return Freeze_Node (Id);
7884 end Package_Freeze_Node;
7886 -- Start of processing of Freeze_Subprogram_Body
7889 -- If the instance and the generic body appear within the same unit, and
7890 -- the instance precedes the generic, the freeze node for the instance
7891 -- must appear after that of the generic. If the generic is nested
7892 -- within another instance I2, then current instance must be frozen
7893 -- after I2. In both cases, the freeze nodes are those of enclosing
7894 -- packages. Otherwise, the freeze node is placed at the end of the
7895 -- current declarative part.
7897 Enc_G := Enclosing_Package_Body (Gen_Body);
7898 Enc_I := Enclosing_Package_Body (Inst_Node);
7899 Ensure_Freeze_Node (Pack_Id);
7900 F_Node := Freeze_Node (Pack_Id);
7902 if Is_Generic_Instance (Par)
7903 and then Present (Freeze_Node (Par))
7904 and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7906 -- The parent was a premature instantiation. Insert freeze node at
7907 -- the end the current declarative part.
7909 if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7910 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7912 -- Handle the following case:
7914 -- package Parent_Inst is new ...
7917 -- procedure P ... -- this body freezes Parent_Inst
7919 -- package Inst is new ...
7921 -- In this particular scenario, the freeze node for Inst must be
7922 -- inserted in the same manner as that of Parent_Inst - before the
7923 -- next source body or at the end of the declarative list (body not
7924 -- available). If body P did not exist and Parent_Inst was frozen
7925 -- after Inst, either by a body following Inst or at the end of the
7926 -- declarative region, the freeze node for Inst must be inserted
7927 -- after that of Parent_Inst. This relation is established by
7928 -- comparing the Slocs of Parent_Inst freeze node and Inst.
7930 elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7931 List_Containing (Inst_Node)
7932 and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7934 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7937 Insert_After (Freeze_Node (Par), F_Node);
7940 -- The body enclosing the instance should be frozen after the body that
7941 -- includes the generic, because the body of the instance may make
7942 -- references to entities therein. If the two are not in the same
7943 -- declarative part, or if the one enclosing the instance is frozen
7944 -- already, freeze the instance at the end of the current declarative
7947 elsif Is_Generic_Instance (Par)
7948 and then Present (Freeze_Node (Par))
7949 and then Present (Enc_I)
7951 if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7953 (Nkind (Enc_I) = N_Package_Body
7955 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7957 -- The enclosing package may contain several instances. Rather
7958 -- than computing the earliest point at which to insert its freeze
7959 -- node, we place it at the end of the declarative part of the
7960 -- parent of the generic.
7962 Insert_Freeze_Node_For_Instance
7963 (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7966 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7968 elsif Present (Enc_G)
7969 and then Present (Enc_I)
7970 and then Enc_G /= Enc_I
7971 and then Earlier (Inst_Node, Gen_Body)
7973 if Nkind (Enc_G) = N_Package_Body then
7974 E_G_Id := Corresponding_Spec (Enc_G);
7975 else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7977 Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7980 -- Freeze package that encloses instance, and place node after the
7981 -- package that encloses generic. If enclosing package is already
7982 -- frozen we have to assume it is at the proper place. This may be a
7983 -- potential ABE that requires dynamic checking. Do not add a freeze
7984 -- node if the package that encloses the generic is inside the body
7985 -- that encloses the instance, because the freeze node would be in
7986 -- the wrong scope. Additional contortions needed if the bodies are
7987 -- within a subunit.
7990 Enclosing_Body : Node_Id;
7993 if Nkind (Enc_I) = N_Package_Body_Stub then
7994 Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7996 Enclosing_Body := Enc_I;
7999 if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
8000 Insert_Freeze_Node_For_Instance
8001 (Enc_G, Package_Freeze_Node (Enc_I));
8005 -- Freeze enclosing subunit before instance
8007 Ensure_Freeze_Node (E_G_Id);
8009 if not Is_List_Member (Freeze_Node (E_G_Id)) then
8010 Insert_After (Enc_G, Freeze_Node (E_G_Id));
8013 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
8016 -- If none of the above, insert freeze node at the end of the current
8017 -- declarative part.
8019 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
8021 end Freeze_Subprogram_Body;
8027 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
8029 return Generic_Renamings.Table (E).Gen_Id;
8032 ---------------------
8033 -- Get_Instance_Of --
8034 ---------------------
8036 function Get_Instance_Of (A : Entity_Id) return Entity_Id is
8037 Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
8040 if Res /= Assoc_Null then
8041 return Generic_Renamings.Table (Res).Act_Id;
8043 -- On exit, entity is not instantiated: not a generic parameter, or
8044 -- else parameter of an inner generic unit.
8048 end Get_Instance_Of;
8050 ------------------------------------
8051 -- Get_Package_Instantiation_Node --
8052 ------------------------------------
8054 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
8055 Decl : Node_Id := Unit_Declaration_Node (A);
8059 -- If the Package_Instantiation attribute has been set on the package
8060 -- entity, then use it directly when it (or its Original_Node) refers
8061 -- to an N_Package_Instantiation node. In principle it should be
8062 -- possible to have this field set in all cases, which should be
8063 -- investigated, and would allow this function to be significantly
8066 Inst := Package_Instantiation (A);
8068 if Present (Inst) then
8069 if Nkind (Inst) = N_Package_Instantiation then
8072 elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
8073 return Original_Node (Inst);
8077 -- If the instantiation is a compilation unit that does not need body
8078 -- then the instantiation node has been rewritten as a package
8079 -- declaration for the instance, and we return the original node.
8081 -- If it is a compilation unit and the instance node has not been
8082 -- rewritten, then it is still the unit of the compilation. Finally, if
8083 -- a body is present, this is a parent of the main unit whose body has
8084 -- been compiled for inlining purposes, and the instantiation node has
8085 -- been rewritten with the instance body.
8087 -- Otherwise the instantiation node appears after the declaration. If
8088 -- the entity is a formal package, the declaration may have been
8089 -- rewritten as a generic declaration (in the case of a formal with box)
8090 -- or left as a formal package declaration if it has actuals, and is
8091 -- found with a forward search.
8093 if Nkind (Parent (Decl)) = N_Compilation_Unit then
8094 if Nkind (Decl) = N_Package_Declaration
8095 and then Present (Corresponding_Body (Decl))
8097 Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
8100 if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
8101 return Original_Node (Decl);
8103 return Unit (Parent (Decl));
8106 elsif Nkind (Decl) = N_Package_Declaration
8107 and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
8109 return Original_Node (Decl);
8112 Inst := Next (Decl);
8113 while not Nkind_In (Inst, N_Package_Instantiation,
8114 N_Formal_Package_Declaration)
8121 end Get_Package_Instantiation_Node;
8123 ------------------------
8124 -- Has_Been_Exchanged --
8125 ------------------------
8127 function Has_Been_Exchanged (E : Entity_Id) return Boolean is
8131 Next := First_Elmt (Exchanged_Views);
8132 while Present (Next) loop
8133 if Full_View (Node (Next)) = E then
8141 end Has_Been_Exchanged;
8147 function Hash (F : Entity_Id) return HTable_Range is
8149 return HTable_Range (F mod HTable_Size);
8152 ------------------------
8153 -- Hide_Current_Scope --
8154 ------------------------
8156 procedure Hide_Current_Scope is
8157 C : constant Entity_Id := Current_Scope;
8161 Set_Is_Hidden_Open_Scope (C);
8163 E := First_Entity (C);
8164 while Present (E) loop
8165 if Is_Immediately_Visible (E) then
8166 Set_Is_Immediately_Visible (E, False);
8167 Append_Elmt (E, Hidden_Entities);
8173 -- Make the scope name invisible as well. This is necessary, but might
8174 -- conflict with calls to Rtsfind later on, in case the scope is a
8175 -- predefined one. There is no clean solution to this problem, so for
8176 -- now we depend on the user not redefining Standard itself in one of
8177 -- the parent units.
8179 if Is_Immediately_Visible (C) and then C /= Standard_Standard then
8180 Set_Is_Immediately_Visible (C, False);
8181 Append_Elmt (C, Hidden_Entities);
8184 end Hide_Current_Scope;
8190 procedure Init_Env is
8191 Saved : Instance_Env;
8194 Saved.Instantiated_Parent := Current_Instantiated_Parent;
8195 Saved.Exchanged_Views := Exchanged_Views;
8196 Saved.Hidden_Entities := Hidden_Entities;
8197 Saved.Current_Sem_Unit := Current_Sem_Unit;
8198 Saved.Parent_Unit_Visible := Parent_Unit_Visible;
8199 Saved.Instance_Parent_Unit := Instance_Parent_Unit;
8201 -- Save configuration switches. These may be reset if the unit is a
8202 -- predefined unit, and the current mode is not Ada 2005.
8204 Save_Opt_Config_Switches (Saved.Switches);
8206 Instance_Envs.Append (Saved);
8208 Exchanged_Views := New_Elmt_List;
8209 Hidden_Entities := New_Elmt_List;
8211 -- Make dummy entry for Instantiated parent. If generic unit is legal,
8212 -- this is set properly in Set_Instance_Env.
8214 Current_Instantiated_Parent :=
8215 (Current_Scope, Current_Scope, Assoc_Null);
8218 ------------------------------
8219 -- In_Same_Declarative_Part --
8220 ------------------------------
8222 function In_Same_Declarative_Part
8224 Inst : Node_Id) return Boolean
8226 Decls : constant Node_Id := Parent (F_Node);
8227 Nod : Node_Id := Parent (Inst);
8230 while Present (Nod) loop
8234 elsif Nkind_In (Nod, N_Subprogram_Body,
8236 N_Package_Declaration,
8243 elsif Nkind (Nod) = N_Subunit then
8244 Nod := Corresponding_Stub (Nod);
8246 elsif Nkind (Nod) = N_Compilation_Unit then
8250 Nod := Parent (Nod);
8255 end In_Same_Declarative_Part;
8257 ---------------------
8258 -- In_Main_Context --
8259 ---------------------
8261 function In_Main_Context (E : Entity_Id) return Boolean is
8267 if not Is_Compilation_Unit (E)
8268 or else Ekind (E) /= E_Package
8269 or else In_Private_Part (E)
8274 Context := Context_Items (Cunit (Main_Unit));
8276 Clause := First (Context);
8277 while Present (Clause) loop
8278 if Nkind (Clause) = N_With_Clause then
8279 Nam := Name (Clause);
8281 -- If the current scope is part of the context of the main unit,
8282 -- analysis of the corresponding with_clause is not complete, and
8283 -- the entity is not set. We use the Chars field directly, which
8284 -- might produce false positives in rare cases, but guarantees
8285 -- that we produce all the instance bodies we will need.
8287 if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
8288 or else (Nkind (Nam) = N_Selected_Component
8289 and then Chars (Selector_Name (Nam)) = Chars (E))
8299 end In_Main_Context;
8301 ---------------------
8302 -- Inherit_Context --
8303 ---------------------
8305 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
8306 Current_Context : List_Id;
8307 Current_Unit : Node_Id;
8316 if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
8318 -- The inherited context is attached to the enclosing compilation
8319 -- unit. This is either the main unit, or the declaration for the
8320 -- main unit (in case the instantiation appears within the package
8321 -- declaration and the main unit is its body).
8323 Current_Unit := Parent (Inst);
8324 while Present (Current_Unit)
8325 and then Nkind (Current_Unit) /= N_Compilation_Unit
8327 Current_Unit := Parent (Current_Unit);
8330 Current_Context := Context_Items (Current_Unit);
8332 Item := First (Context_Items (Parent (Gen_Decl)));
8333 while Present (Item) loop
8334 if Nkind (Item) = N_With_Clause then
8335 Lib_Unit := Library_Unit (Item);
8337 -- Take care to prevent direct cyclic with's
8339 if Lib_Unit /= Current_Unit then
8341 -- Do not add a unit if it is already in the context
8343 Clause := First (Current_Context);
8345 while Present (Clause) loop
8346 if Nkind (Clause) = N_With_Clause and then
8347 Library_Unit (Clause) = Lib_Unit
8357 New_I := New_Copy (Item);
8358 Set_Implicit_With (New_I, True);
8359 Set_Implicit_With_From_Instantiation (New_I, True);
8360 Append (New_I, Current_Context);
8368 end Inherit_Context;
8374 procedure Initialize is
8376 Generic_Renamings.Init;
8379 Generic_Renamings_HTable.Reset;
8380 Circularity_Detected := False;
8381 Exchanged_Views := No_Elist;
8382 Hidden_Entities := No_Elist;
8385 -------------------------------------
8386 -- Insert_Freeze_Node_For_Instance --
8387 -------------------------------------
8389 procedure Insert_Freeze_Node_For_Instance
8398 function Enclosing_Body (N : Node_Id) return Node_Id;
8399 -- Find enclosing package or subprogram body, if any. Freeze node may
8400 -- be placed at end of current declarative list if previous instance
8401 -- and current one have different enclosing bodies.
8403 function Previous_Instance (Gen : Entity_Id) return Entity_Id;
8404 -- Find the local instance, if any, that declares the generic that is
8405 -- being instantiated. If present, the freeze node for this instance
8406 -- must follow the freeze node for the previous instance.
8408 --------------------
8409 -- Enclosing_Body --
8410 --------------------
8412 function Enclosing_Body (N : Node_Id) return Node_Id is
8418 and then Nkind (Parent (P)) /= N_Compilation_Unit
8420 if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
8421 if Nkind (Parent (P)) = N_Subunit then
8422 return Corresponding_Stub (Parent (P));
8428 P := True_Parent (P);
8434 -----------------------
8435 -- Previous_Instance --
8436 -----------------------
8438 function Previous_Instance (Gen : Entity_Id) return Entity_Id is
8444 and then S /= Standard_Standard
8446 if Is_Generic_Instance (S)
8447 and then In_Same_Source_Unit (S, N)
8456 end Previous_Instance;
8458 -- Start of processing for Insert_Freeze_Node_For_Instance
8461 if not Is_List_Member (F_Node) then
8463 Decls := List_Containing (N);
8464 Inst := Entity (F_Node);
8465 Par_N := Parent (Decls);
8467 -- When processing a subprogram instantiation, utilize the actual
8468 -- subprogram instantiation rather than its package wrapper as it
8469 -- carries all the context information.
8471 if Is_Wrapper_Package (Inst) then
8472 Inst := Related_Instance (Inst);
8475 -- If this is a package instance, check whether the generic is
8476 -- declared in a previous instance and the current instance is
8477 -- not within the previous one.
8479 if Present (Generic_Parent (Parent (Inst)))
8480 and then Is_In_Main_Unit (N)
8483 Enclosing_N : constant Node_Id := Enclosing_Body (N);
8484 Par_I : constant Entity_Id :=
8486 (Generic_Parent (Parent (Inst)));
8491 and then Earlier (N, Freeze_Node (Par_I))
8493 Scop := Scope (Inst);
8495 -- If the current instance is within the one that contains
8496 -- the generic, the freeze node for the current one must
8497 -- appear in the current declarative part. Ditto, if the
8498 -- current instance is within another package instance or
8499 -- within a body that does not enclose the current instance.
8500 -- In these three cases the freeze node of the previous
8501 -- instance is not relevant.
8503 while Present (Scop)
8504 and then Scop /= Standard_Standard
8506 exit when Scop = Par_I
8508 (Is_Generic_Instance (Scop)
8509 and then Scope_Depth (Scop) > Scope_Depth (Par_I));
8510 Scop := Scope (Scop);
8513 -- Previous instance encloses current instance
8515 if Scop = Par_I then
8518 -- If the next node is a source body we must freeze in
8519 -- the current scope as well.
8521 elsif Present (Next (N))
8522 and then Nkind_In (Next (N),
8523 N_Subprogram_Body, N_Package_Body)
8524 and then Comes_From_Source (Next (N))
8528 -- Current instance is within an unrelated instance
8530 elsif Is_Generic_Instance (Scop) then
8533 -- Current instance is within an unrelated body
8535 elsif Present (Enclosing_N)
8536 and then Enclosing_N /= Enclosing_Body (Par_I)
8541 Insert_After (Freeze_Node (Par_I), F_Node);
8548 -- When the instantiation occurs in a package declaration, append the
8549 -- freeze node to the private declarations (if any).
8551 if Nkind (Par_N) = N_Package_Specification
8552 and then Decls = Visible_Declarations (Par_N)
8553 and then Present (Private_Declarations (Par_N))
8554 and then not Is_Empty_List (Private_Declarations (Par_N))
8556 Decls := Private_Declarations (Par_N);
8557 Decl := First (Decls);
8560 -- Determine the proper freeze point of a package instantiation. We
8561 -- adhere to the general rule of a package or subprogram body causing
8562 -- freezing of anything before it in the same declarative region. In
8563 -- this case, the proper freeze point of a package instantiation is
8564 -- before the first source body which follows, or before a stub. This
8565 -- ensures that entities coming from the instance are already frozen
8566 -- and usable in source bodies.
8568 if Nkind (Par_N) /= N_Package_Declaration
8569 and then Ekind (Inst) = E_Package
8570 and then Is_Generic_Instance (Inst)
8572 not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
8574 while Present (Decl) loop
8575 if (Nkind (Decl) in N_Unit_Body
8577 Nkind (Decl) in N_Body_Stub)
8578 and then Comes_From_Source (Decl)
8580 Insert_Before (Decl, F_Node);
8588 -- In a package declaration, or if no previous body, insert at end
8591 Set_Sloc (F_Node, Sloc (Last (Decls)));
8592 Insert_After (Last (Decls), F_Node);
8594 end Insert_Freeze_Node_For_Instance;
8600 procedure Install_Body
8601 (Act_Body : Node_Id;
8606 Act_Id : constant Entity_Id := Corresponding_Spec (Act_Body);
8607 Act_Unit : constant Node_Id := Unit (Cunit (Get_Source_Unit (N)));
8608 Gen_Id : constant Entity_Id := Corresponding_Spec (Gen_Body);
8609 Par : constant Entity_Id := Scope (Gen_Id);
8610 Gen_Unit : constant Node_Id :=
8611 Unit (Cunit (Get_Source_Unit (Gen_Decl)));
8612 Orig_Body : Node_Id := Gen_Body;
8614 Body_Unit : Node_Id;
8616 Must_Delay : Boolean;
8618 function In_Same_Enclosing_Subp return Boolean;
8619 -- Check whether instance and generic body are within same subprogram.
8621 function True_Sloc (N : Node_Id) return Source_Ptr;
8622 -- If the instance is nested inside a generic unit, the Sloc of the
8623 -- instance indicates the place of the original definition, not the
8624 -- point of the current enclosing instance. Pending a better usage of
8625 -- Slocs to indicate instantiation places, we determine the place of
8626 -- origin of a node by finding the maximum sloc of any ancestor node.
8627 -- Why is this not equivalent to Top_Level_Location ???
8629 ----------------------------
8630 -- In_Same_Enclosing_Subp --
8631 ----------------------------
8633 function In_Same_Enclosing_Subp return Boolean is
8638 Scop := Scope (Act_Id);
8639 while Scop /= Standard_Standard
8640 and then not Is_Overloadable (Scop)
8642 Scop := Scope (Scop);
8645 if Scop = Standard_Standard then
8651 Scop := Scope (Gen_Id);
8652 while Scop /= Standard_Standard loop
8656 Scop := Scope (Scop);
8661 end In_Same_Enclosing_Subp;
8667 function True_Sloc (N : Node_Id) return Source_Ptr is
8674 while Present (N1) and then N1 /= Act_Unit loop
8675 if Sloc (N1) > Res then
8685 -- Start of processing for Install_Body
8688 -- If the body is a subunit, the freeze point is the corresponding stub
8689 -- in the current compilation, not the subunit itself.
8691 if Nkind (Parent (Gen_Body)) = N_Subunit then
8692 Orig_Body := Corresponding_Stub (Parent (Gen_Body));
8694 Orig_Body := Gen_Body;
8697 Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8699 -- If the instantiation and the generic definition appear in the same
8700 -- package declaration, this is an early instantiation. If they appear
8701 -- in the same declarative part, it is an early instantiation only if
8702 -- the generic body appears textually later, and the generic body is
8703 -- also in the main unit.
8705 -- If instance is nested within a subprogram, and the generic body
8706 -- is not, the instance is delayed because the enclosing body is. If
8707 -- instance and body are within the same scope, or the same subprogram
8708 -- body, indicate explicitly that the instance is delayed.
8711 (Gen_Unit = Act_Unit
8712 and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8713 N_Generic_Package_Declaration)
8714 or else (Gen_Unit = Body_Unit
8715 and then True_Sloc (N) < Sloc (Orig_Body)))
8716 and then Is_In_Main_Unit (Gen_Unit)
8717 and then (Scope (Act_Id) = Scope (Gen_Id)
8718 or else In_Same_Enclosing_Subp));
8720 -- If this is an early instantiation, the freeze node is placed after
8721 -- the generic body. Otherwise, if the generic appears in an instance,
8722 -- we cannot freeze the current instance until the outer one is frozen.
8723 -- This is only relevant if the current instance is nested within some
8724 -- inner scope not itself within the outer instance. If this scope is
8725 -- a package body in the same declarative part as the outer instance,
8726 -- then that body needs to be frozen after the outer instance. Finally,
8727 -- if no delay is needed, we place the freeze node at the end of the
8728 -- current declarative part.
8730 if Expander_Active then
8731 Ensure_Freeze_Node (Act_Id);
8732 F_Node := Freeze_Node (Act_Id);
8735 Insert_After (Orig_Body, F_Node);
8737 elsif Is_Generic_Instance (Par)
8738 and then Present (Freeze_Node (Par))
8739 and then Scope (Act_Id) /= Par
8741 -- Freeze instance of inner generic after instance of enclosing
8744 if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8746 -- Handle the following case:
8748 -- package Parent_Inst is new ...
8751 -- procedure P ... -- this body freezes Parent_Inst
8753 -- package Inst is new ...
8755 -- In this particular scenario, the freeze node for Inst must
8756 -- be inserted in the same manner as that of Parent_Inst,
8757 -- before the next source body or at the end of the declarative
8758 -- list (body not available). If body P did not exist and
8759 -- Parent_Inst was frozen after Inst, either by a body
8760 -- following Inst or at the end of the declarative region,
8761 -- the freeze node for Inst must be inserted after that of
8762 -- Parent_Inst. This relation is established by comparing
8763 -- the Slocs of Parent_Inst freeze node and Inst.
8765 if List_Containing (Get_Package_Instantiation_Node (Par)) =
8767 and then Sloc (Freeze_Node (Par)) < Sloc (N)
8769 Insert_Freeze_Node_For_Instance (N, F_Node);
8771 Insert_After (Freeze_Node (Par), F_Node);
8774 -- Freeze package enclosing instance of inner generic after
8775 -- instance of enclosing generic.
8777 elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8778 and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8781 Enclosing : Entity_Id;
8784 Enclosing := Corresponding_Spec (Parent (N));
8786 if No (Enclosing) then
8787 Enclosing := Defining_Entity (Parent (N));
8790 Insert_Freeze_Node_For_Instance (N, F_Node);
8791 Ensure_Freeze_Node (Enclosing);
8793 if not Is_List_Member (Freeze_Node (Enclosing)) then
8795 -- The enclosing context is a subunit, insert the freeze
8796 -- node after the stub.
8798 if Nkind (Parent (Parent (N))) = N_Subunit then
8799 Insert_Freeze_Node_For_Instance
8800 (Corresponding_Stub (Parent (Parent (N))),
8801 Freeze_Node (Enclosing));
8803 -- The enclosing context is a package with a stub body
8804 -- which has already been replaced by the real body.
8805 -- Insert the freeze node after the actual body.
8807 elsif Ekind (Enclosing) = E_Package
8808 and then Present (Body_Entity (Enclosing))
8809 and then Was_Originally_Stub
8810 (Parent (Body_Entity (Enclosing)))
8812 Insert_Freeze_Node_For_Instance
8813 (Parent (Body_Entity (Enclosing)),
8814 Freeze_Node (Enclosing));
8816 -- The parent instance has been frozen before the body of
8817 -- the enclosing package, insert the freeze node after
8820 elsif List_Containing (Freeze_Node (Par)) =
8821 List_Containing (Parent (N))
8822 and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8824 Insert_Freeze_Node_For_Instance
8825 (Parent (N), Freeze_Node (Enclosing));
8829 (Freeze_Node (Par), Freeze_Node (Enclosing));
8835 Insert_Freeze_Node_For_Instance (N, F_Node);
8839 Insert_Freeze_Node_For_Instance (N, F_Node);
8843 Set_Is_Frozen (Act_Id);
8844 Insert_Before (N, Act_Body);
8845 Mark_Rewrite_Insertion (Act_Body);
8848 -----------------------------
8849 -- Install_Formal_Packages --
8850 -----------------------------
8852 procedure Install_Formal_Packages (Par : Entity_Id) is
8855 Gen_E : Entity_Id := Empty;
8858 E := First_Entity (Par);
8860 -- If we are installing an instance parent, locate the formal packages
8861 -- of its generic parent.
8863 if Is_Generic_Instance (Par) then
8864 Gen := Generic_Parent (Package_Specification (Par));
8865 Gen_E := First_Entity (Gen);
8868 while Present (E) loop
8869 if Ekind (E) = E_Package
8870 and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8872 -- If this is the renaming for the parent instance, done
8874 if Renamed_Object (E) = Par then
8877 -- The visibility of a formal of an enclosing generic is already
8880 elsif Denotes_Formal_Package (E) then
8883 elsif Present (Associated_Formal_Package (E)) then
8884 Check_Generic_Actuals (Renamed_Object (E), True);
8885 Set_Is_Hidden (E, False);
8887 -- Find formal package in generic unit that corresponds to
8888 -- (instance of) formal package in instance.
8890 while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8891 Next_Entity (Gen_E);
8894 if Present (Gen_E) then
8895 Map_Formal_Package_Entities (Gen_E, E);
8901 if Present (Gen_E) then
8902 Next_Entity (Gen_E);
8905 end Install_Formal_Packages;
8907 --------------------
8908 -- Install_Parent --
8909 --------------------
8911 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8912 Ancestors : constant Elist_Id := New_Elmt_List;
8913 S : constant Entity_Id := Current_Scope;
8914 Inst_Par : Entity_Id;
8915 First_Par : Entity_Id;
8916 Inst_Node : Node_Id;
8917 Gen_Par : Entity_Id;
8918 First_Gen : Entity_Id;
8921 procedure Install_Noninstance_Specs (Par : Entity_Id);
8922 -- Install the scopes of noninstance parent units ending with Par
8924 procedure Install_Spec (Par : Entity_Id);
8925 -- The child unit is within the declarative part of the parent, so the
8926 -- declarations within the parent are immediately visible.
8928 -------------------------------
8929 -- Install_Noninstance_Specs --
8930 -------------------------------
8932 procedure Install_Noninstance_Specs (Par : Entity_Id) is
8935 and then Par /= Standard_Standard
8936 and then not In_Open_Scopes (Par)
8938 Install_Noninstance_Specs (Scope (Par));
8941 end Install_Noninstance_Specs;
8947 procedure Install_Spec (Par : Entity_Id) is
8948 Spec : constant Node_Id := Package_Specification (Par);
8951 -- If this parent of the child instance is a top-level unit,
8952 -- then record the unit and its visibility for later resetting in
8953 -- Remove_Parent. We exclude units that are generic instances, as we
8954 -- only want to record this information for the ultimate top-level
8955 -- noninstance parent (is that always correct???).
8957 if Scope (Par) = Standard_Standard
8958 and then not Is_Generic_Instance (Par)
8960 Parent_Unit_Visible := Is_Immediately_Visible (Par);
8961 Instance_Parent_Unit := Par;
8964 -- Open the parent scope and make it and its declarations visible.
8965 -- If this point is not within a body, then only the visible
8966 -- declarations should be made visible, and installation of the
8967 -- private declarations is deferred until the appropriate point
8968 -- within analysis of the spec being instantiated (see the handling
8969 -- of parent visibility in Analyze_Package_Specification). This is
8970 -- relaxed in the case where the parent unit is Ada.Tags, to avoid
8971 -- private view problems that occur when compiling instantiations of
8972 -- a generic child of that package (Generic_Dispatching_Constructor).
8973 -- If the instance freezes a tagged type, inlinings of operations
8974 -- from Ada.Tags may need the full view of type Tag. If inlining took
8975 -- proper account of establishing visibility of inlined subprograms'
8976 -- parents then it should be possible to remove this
8977 -- special check. ???
8980 Set_Is_Immediately_Visible (Par);
8981 Install_Visible_Declarations (Par);
8982 Set_Use (Visible_Declarations (Spec));
8984 if In_Body or else Is_RTU (Par, Ada_Tags) then
8985 Install_Private_Declarations (Par);
8986 Set_Use (Private_Declarations (Spec));
8990 -- Start of processing for Install_Parent
8993 -- We need to install the parent instance to compile the instantiation
8994 -- of the child, but the child instance must appear in the current
8995 -- scope. Given that we cannot place the parent above the current scope
8996 -- in the scope stack, we duplicate the current scope and unstack both
8997 -- after the instantiation is complete.
8999 -- If the parent is itself the instantiation of a child unit, we must
9000 -- also stack the instantiation of its parent, and so on. Each such
9001 -- ancestor is the prefix of the name in a prior instantiation.
9003 -- If this is a nested instance, the parent unit itself resolves to
9004 -- a renaming of the parent instance, whose declaration we need.
9006 -- Finally, the parent may be a generic (not an instance) when the
9007 -- child unit appears as a formal package.
9011 if Present (Renamed_Entity (Inst_Par)) then
9012 Inst_Par := Renamed_Entity (Inst_Par);
9015 First_Par := Inst_Par;
9017 Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
9019 First_Gen := Gen_Par;
9021 while Present (Gen_Par)
9022 and then Is_Child_Unit (Gen_Par)
9024 -- Load grandparent instance as well
9026 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
9028 if Nkind (Name (Inst_Node)) = N_Expanded_Name then
9029 Inst_Par := Entity (Prefix (Name (Inst_Node)));
9031 if Present (Renamed_Entity (Inst_Par)) then
9032 Inst_Par := Renamed_Entity (Inst_Par);
9035 Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
9037 if Present (Gen_Par) then
9038 Prepend_Elmt (Inst_Par, Ancestors);
9041 -- Parent is not the name of an instantiation
9043 Install_Noninstance_Specs (Inst_Par);
9054 if Present (First_Gen) then
9055 Append_Elmt (First_Par, Ancestors);
9057 Install_Noninstance_Specs (First_Par);
9060 if not Is_Empty_Elmt_List (Ancestors) then
9061 Elmt := First_Elmt (Ancestors);
9062 while Present (Elmt) loop
9063 Install_Spec (Node (Elmt));
9064 Install_Formal_Packages (Node (Elmt));
9074 -------------------------------
9075 -- Install_Hidden_Primitives --
9076 -------------------------------
9078 procedure Install_Hidden_Primitives
9079 (Prims_List : in out Elist_Id;
9084 List : Elist_Id := No_Elist;
9085 Prim_G_Elmt : Elmt_Id;
9086 Prim_A_Elmt : Elmt_Id;
9091 -- No action needed in case of serious errors because we cannot trust
9092 -- in the order of primitives
9094 if Serious_Errors_Detected > 0 then
9097 -- No action possible if we don't have available the list of primitive
9101 or else not Is_Record_Type (Gen_T)
9102 or else not Is_Tagged_Type (Gen_T)
9103 or else not Is_Record_Type (Act_T)
9104 or else not Is_Tagged_Type (Act_T)
9108 -- There is no need to handle interface types since their primitives
9111 elsif Is_Interface (Gen_T) then
9115 Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
9117 if not Is_Class_Wide_Type (Act_T) then
9118 Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
9120 Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
9124 -- Skip predefined primitives in the generic formal
9126 while Present (Prim_G_Elmt)
9127 and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
9129 Next_Elmt (Prim_G_Elmt);
9132 -- Skip predefined primitives in the generic actual
9134 while Present (Prim_A_Elmt)
9135 and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
9137 Next_Elmt (Prim_A_Elmt);
9140 exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
9142 Prim_G := Node (Prim_G_Elmt);
9143 Prim_A := Node (Prim_A_Elmt);
9145 -- There is no need to handle interface primitives because their
9146 -- primitives are not hidden
9148 exit when Present (Interface_Alias (Prim_G));
9150 -- Here we install one hidden primitive
9152 if Chars (Prim_G) /= Chars (Prim_A)
9153 and then Has_Suffix (Prim_A, 'P')
9154 and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
9156 Set_Chars (Prim_A, Chars (Prim_G));
9157 Append_New_Elmt (Prim_A, To => List);
9160 Next_Elmt (Prim_A_Elmt);
9161 Next_Elmt (Prim_G_Elmt);
9164 -- Append the elements to the list of temporarily visible primitives
9165 -- avoiding duplicates.
9167 if Present (List) then
9168 if No (Prims_List) then
9169 Prims_List := New_Elmt_List;
9172 Elmt := First_Elmt (List);
9173 while Present (Elmt) loop
9174 Append_Unique_Elmt (Node (Elmt), Prims_List);
9178 end Install_Hidden_Primitives;
9180 -------------------------------
9181 -- Restore_Hidden_Primitives --
9182 -------------------------------
9184 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
9185 Prim_Elmt : Elmt_Id;
9189 if Prims_List /= No_Elist then
9190 Prim_Elmt := First_Elmt (Prims_List);
9191 while Present (Prim_Elmt) loop
9192 Prim := Node (Prim_Elmt);
9193 Set_Chars (Prim, Add_Suffix (Prim, 'P'));
9194 Next_Elmt (Prim_Elmt);
9197 Prims_List := No_Elist;
9199 end Restore_Hidden_Primitives;
9201 --------------------------------
9202 -- Instantiate_Formal_Package --
9203 --------------------------------
9205 function Instantiate_Formal_Package
9208 Analyzed_Formal : Node_Id) return List_Id
9210 Loc : constant Source_Ptr := Sloc (Actual);
9211 Actual_Pack : Entity_Id;
9212 Formal_Pack : Entity_Id;
9213 Gen_Parent : Entity_Id;
9216 Parent_Spec : Node_Id;
9218 procedure Find_Matching_Actual
9220 Act : in out Entity_Id);
9221 -- We need to associate each formal entity in the formal package with
9222 -- the corresponding entity in the actual package. The actual package
9223 -- has been analyzed and possibly expanded, and as a result there is
9224 -- no one-to-one correspondence between the two lists (for example,
9225 -- the actual may include subtypes, itypes, and inherited primitive
9226 -- operations, interspersed among the renaming declarations for the
9227 -- actuals) . We retrieve the corresponding actual by name because each
9228 -- actual has the same name as the formal, and they do appear in the
9231 function Get_Formal_Entity (N : Node_Id) return Entity_Id;
9232 -- Retrieve entity of defining entity of generic formal parameter.
9233 -- Only the declarations of formals need to be considered when
9234 -- linking them to actuals, but the declarative list may include
9235 -- internal entities generated during analysis, and those are ignored.
9237 procedure Match_Formal_Entity
9238 (Formal_Node : Node_Id;
9239 Formal_Ent : Entity_Id;
9240 Actual_Ent : Entity_Id);
9241 -- Associates the formal entity with the actual. In the case where
9242 -- Formal_Ent is a formal package, this procedure iterates through all
9243 -- of its formals and enters associations between the actuals occurring
9244 -- in the formal package's corresponding actual package (given by
9245 -- Actual_Ent) and the formal package's formal parameters. This
9246 -- procedure recurses if any of the parameters is itself a package.
9248 function Is_Instance_Of
9249 (Act_Spec : Entity_Id;
9250 Gen_Anc : Entity_Id) return Boolean;
9251 -- The actual can be an instantiation of a generic within another
9252 -- instance, in which case there is no direct link from it to the
9253 -- original generic ancestor. In that case, we recognize that the
9254 -- ultimate ancestor is the same by examining names and scopes.
9256 procedure Process_Nested_Formal (Formal : Entity_Id);
9257 -- If the current formal is declared with a box, its own formals are
9258 -- visible in the instance, as they were in the generic, and their
9259 -- Hidden flag must be reset. If some of these formals are themselves
9260 -- packages declared with a box, the processing must be recursive.
9262 --------------------------
9263 -- Find_Matching_Actual --
9264 --------------------------
9266 procedure Find_Matching_Actual
9268 Act : in out Entity_Id)
9270 Formal_Ent : Entity_Id;
9273 case Nkind (Original_Node (F)) is
9274 when N_Formal_Object_Declaration |
9275 N_Formal_Type_Declaration =>
9276 Formal_Ent := Defining_Identifier (F);
9278 while Chars (Act) /= Chars (Formal_Ent) loop
9282 when N_Formal_Subprogram_Declaration |
9283 N_Formal_Package_Declaration |
9284 N_Package_Declaration |
9285 N_Generic_Package_Declaration =>
9286 Formal_Ent := Defining_Entity (F);
9288 while Chars (Act) /= Chars (Formal_Ent) loop
9293 raise Program_Error;
9295 end Find_Matching_Actual;
9297 -------------------------
9298 -- Match_Formal_Entity --
9299 -------------------------
9301 procedure Match_Formal_Entity
9302 (Formal_Node : Node_Id;
9303 Formal_Ent : Entity_Id;
9304 Actual_Ent : Entity_Id)
9306 Act_Pkg : Entity_Id;
9309 Set_Instance_Of (Formal_Ent, Actual_Ent);
9311 if Ekind (Actual_Ent) = E_Package then
9313 -- Record associations for each parameter
9315 Act_Pkg := Actual_Ent;
9318 A_Ent : Entity_Id := First_Entity (Act_Pkg);
9327 -- Retrieve the actual given in the formal package declaration
9329 Actual := Entity (Name (Original_Node (Formal_Node)));
9331 -- The actual in the formal package declaration may be a
9332 -- renamed generic package, in which case we want to retrieve
9333 -- the original generic in order to traverse its formal part.
9335 if Present (Renamed_Entity (Actual)) then
9336 Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
9338 Gen_Decl := Unit_Declaration_Node (Actual);
9341 Formals := Generic_Formal_Declarations (Gen_Decl);
9343 if Present (Formals) then
9344 F_Node := First_Non_Pragma (Formals);
9349 while Present (A_Ent)
9350 and then Present (F_Node)
9351 and then A_Ent /= First_Private_Entity (Act_Pkg)
9353 F_Ent := Get_Formal_Entity (F_Node);
9355 if Present (F_Ent) then
9357 -- This is a formal of the original package. Record
9358 -- association and recurse.
9360 Find_Matching_Actual (F_Node, A_Ent);
9361 Match_Formal_Entity (F_Node, F_Ent, A_Ent);
9362 Next_Entity (A_Ent);
9365 Next_Non_Pragma (F_Node);
9369 end Match_Formal_Entity;
9371 -----------------------
9372 -- Get_Formal_Entity --
9373 -----------------------
9375 function Get_Formal_Entity (N : Node_Id) return Entity_Id is
9376 Kind : constant Node_Kind := Nkind (Original_Node (N));
9379 when N_Formal_Object_Declaration =>
9380 return Defining_Identifier (N);
9382 when N_Formal_Type_Declaration =>
9383 return Defining_Identifier (N);
9385 when N_Formal_Subprogram_Declaration =>
9386 return Defining_Unit_Name (Specification (N));
9388 when N_Formal_Package_Declaration =>
9389 return Defining_Identifier (Original_Node (N));
9391 when N_Generic_Package_Declaration =>
9392 return Defining_Identifier (Original_Node (N));
9394 -- All other declarations are introduced by semantic analysis and
9395 -- have no match in the actual.
9400 end Get_Formal_Entity;
9402 --------------------
9403 -- Is_Instance_Of --
9404 --------------------
9406 function Is_Instance_Of
9407 (Act_Spec : Entity_Id;
9408 Gen_Anc : Entity_Id) return Boolean
9410 Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
9413 if No (Gen_Par) then
9416 -- Simplest case: the generic parent of the actual is the formal
9418 elsif Gen_Par = Gen_Anc then
9421 elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
9424 -- The actual may be obtained through several instantiations. Its
9425 -- scope must itself be an instance of a generic declared in the
9426 -- same scope as the formal. Any other case is detected above.
9428 elsif not Is_Generic_Instance (Scope (Gen_Par)) then
9432 return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
9436 ---------------------------
9437 -- Process_Nested_Formal --
9438 ---------------------------
9440 procedure Process_Nested_Formal (Formal : Entity_Id) is
9444 if Present (Associated_Formal_Package (Formal))
9445 and then Box_Present (Parent (Associated_Formal_Package (Formal)))
9447 Ent := First_Entity (Formal);
9448 while Present (Ent) loop
9449 Set_Is_Hidden (Ent, False);
9450 Set_Is_Visible_Formal (Ent);
9451 Set_Is_Potentially_Use_Visible
9452 (Ent, Is_Potentially_Use_Visible (Formal));
9454 if Ekind (Ent) = E_Package then
9455 exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
9456 Process_Nested_Formal (Ent);
9462 end Process_Nested_Formal;
9464 -- Start of processing for Instantiate_Formal_Package
9469 if not Is_Entity_Name (Actual)
9470 or else Ekind (Entity (Actual)) /= E_Package
9473 ("expect package instance to instantiate formal", Actual);
9474 Abandon_Instantiation (Actual);
9475 raise Program_Error;
9478 Actual_Pack := Entity (Actual);
9479 Set_Is_Instantiated (Actual_Pack);
9481 -- The actual may be a renamed package, or an outer generic formal
9482 -- package whose instantiation is converted into a renaming.
9484 if Present (Renamed_Object (Actual_Pack)) then
9485 Actual_Pack := Renamed_Object (Actual_Pack);
9488 if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
9489 Gen_Parent := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
9490 Formal_Pack := Defining_Identifier (Analyzed_Formal);
9493 Generic_Parent (Specification (Analyzed_Formal));
9495 Defining_Unit_Name (Specification (Analyzed_Formal));
9498 if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
9499 Parent_Spec := Package_Specification (Actual_Pack);
9501 Parent_Spec := Parent (Actual_Pack);
9504 if Gen_Parent = Any_Id then
9506 ("previous error in declaration of formal package", Actual);
9507 Abandon_Instantiation (Actual);
9510 Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
9516 ("actual parameter must be instance of&", Actual, Gen_Parent);
9517 Abandon_Instantiation (Actual);
9520 Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
9521 Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
9524 Make_Package_Renaming_Declaration (Loc,
9525 Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
9526 Name => New_Occurrence_Of (Actual_Pack, Loc));
9528 Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
9529 Defining_Identifier (Formal));
9530 Decls := New_List (Nod);
9532 -- If the formal F has a box, then the generic declarations are
9533 -- visible in the generic G. In an instance of G, the corresponding
9534 -- entities in the actual for F (which are the actuals for the
9535 -- instantiation of the generic that F denotes) must also be made
9536 -- visible for analysis of the current instance. On exit from the
9537 -- current instance, those entities are made private again. If the
9538 -- actual is currently in use, these entities are also use-visible.
9540 -- The loop through the actual entities also steps through the formal
9541 -- entities and enters associations from formals to actuals into the
9542 -- renaming map. This is necessary to properly handle checking of
9543 -- actual parameter associations for later formals that depend on
9544 -- actuals declared in the formal package.
9546 -- In Ada 2005, partial parameterization requires that we make
9547 -- visible the actuals corresponding to formals that were defaulted
9548 -- in the formal package. There formals are identified because they
9549 -- remain formal generics within the formal package, rather than
9550 -- being renamings of the actuals supplied.
9553 Gen_Decl : constant Node_Id :=
9554 Unit_Declaration_Node (Gen_Parent);
9555 Formals : constant List_Id :=
9556 Generic_Formal_Declarations (Gen_Decl);
9558 Actual_Ent : Entity_Id;
9559 Actual_Of_Formal : Node_Id;
9560 Formal_Node : Node_Id;
9561 Formal_Ent : Entity_Id;
9564 if Present (Formals) then
9565 Formal_Node := First_Non_Pragma (Formals);
9567 Formal_Node := Empty;
9570 Actual_Ent := First_Entity (Actual_Pack);
9572 First (Visible_Declarations (Specification (Analyzed_Formal)));
9573 while Present (Actual_Ent)
9574 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9576 if Present (Formal_Node) then
9577 Formal_Ent := Get_Formal_Entity (Formal_Node);
9579 if Present (Formal_Ent) then
9580 Find_Matching_Actual (Formal_Node, Actual_Ent);
9582 (Formal_Node, Formal_Ent, Actual_Ent);
9584 -- We iterate at the same time over the actuals of the
9585 -- local package created for the formal, to determine
9586 -- which one of the formals of the original generic were
9587 -- defaulted in the formal. The corresponding actual
9588 -- entities are visible in the enclosing instance.
9590 if Box_Present (Formal)
9592 (Present (Actual_Of_Formal)
9595 (Get_Formal_Entity (Actual_Of_Formal)))
9597 Set_Is_Hidden (Actual_Ent, False);
9598 Set_Is_Visible_Formal (Actual_Ent);
9599 Set_Is_Potentially_Use_Visible
9600 (Actual_Ent, In_Use (Actual_Pack));
9602 if Ekind (Actual_Ent) = E_Package then
9603 Process_Nested_Formal (Actual_Ent);
9607 Set_Is_Hidden (Actual_Ent);
9608 Set_Is_Potentially_Use_Visible (Actual_Ent, False);
9612 Next_Non_Pragma (Formal_Node);
9613 Next (Actual_Of_Formal);
9616 -- No further formals to match, but the generic part may
9617 -- contain inherited operation that are not hidden in the
9618 -- enclosing instance.
9620 Next_Entity (Actual_Ent);
9624 -- Inherited subprograms generated by formal derived types are
9625 -- also visible if the types are.
9627 Actual_Ent := First_Entity (Actual_Pack);
9628 while Present (Actual_Ent)
9629 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9631 if Is_Overloadable (Actual_Ent)
9633 Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
9635 not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
9637 Set_Is_Hidden (Actual_Ent, False);
9638 Set_Is_Potentially_Use_Visible
9639 (Actual_Ent, In_Use (Actual_Pack));
9642 Next_Entity (Actual_Ent);
9646 -- If the formal is not declared with a box, reanalyze it as an
9647 -- abbreviated instantiation, to verify the matching rules of 12.7.
9648 -- The actual checks are performed after the generic associations
9649 -- have been analyzed, to guarantee the same visibility for this
9650 -- instantiation and for the actuals.
9652 -- In Ada 2005, the generic associations for the formal can include
9653 -- defaulted parameters. These are ignored during check. This
9654 -- internal instantiation is removed from the tree after conformance
9655 -- checking, because it contains formal declarations for those
9656 -- defaulted parameters, and those should not reach the back-end.
9658 if not Box_Present (Formal) then
9660 I_Pack : constant Entity_Id :=
9661 Make_Temporary (Sloc (Actual), 'P');
9664 Set_Is_Internal (I_Pack);
9667 Make_Package_Instantiation (Sloc (Actual),
9668 Defining_Unit_Name => I_Pack,
9671 (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
9672 Generic_Associations =>
9673 Generic_Associations (Formal)));
9679 end Instantiate_Formal_Package;
9681 -----------------------------------
9682 -- Instantiate_Formal_Subprogram --
9683 -----------------------------------
9685 function Instantiate_Formal_Subprogram
9688 Analyzed_Formal : Node_Id) return Node_Id
9690 Analyzed_S : constant Entity_Id :=
9691 Defining_Unit_Name (Specification (Analyzed_Formal));
9692 Formal_Sub : constant Entity_Id :=
9693 Defining_Unit_Name (Specification (Formal));
9695 function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9696 -- If the generic is a child unit, the parent has been installed on the
9697 -- scope stack, but a default subprogram cannot resolve to something
9698 -- on the parent because that parent is not really part of the visible
9699 -- context (it is there to resolve explicit local entities). If the
9700 -- default has resolved in this way, we remove the entity from immediate
9701 -- visibility and analyze the node again to emit an error message or
9702 -- find another visible candidate.
9704 procedure Valid_Actual_Subprogram (Act : Node_Id);
9705 -- Perform legality check and raise exception on failure
9707 -----------------------
9708 -- From_Parent_Scope --
9709 -----------------------
9711 function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9712 Gen_Scope : Node_Id;
9715 Gen_Scope := Scope (Analyzed_S);
9716 while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9717 if Scope (Subp) = Scope (Gen_Scope) then
9721 Gen_Scope := Scope (Gen_Scope);
9725 end From_Parent_Scope;
9727 -----------------------------
9728 -- Valid_Actual_Subprogram --
9729 -----------------------------
9731 procedure Valid_Actual_Subprogram (Act : Node_Id) is
9735 if Is_Entity_Name (Act) then
9736 Act_E := Entity (Act);
9738 elsif Nkind (Act) = N_Selected_Component
9739 and then Is_Entity_Name (Selector_Name (Act))
9741 Act_E := Entity (Selector_Name (Act));
9747 if (Present (Act_E) and then Is_Overloadable (Act_E))
9748 or else Nkind_In (Act, N_Attribute_Reference,
9749 N_Indexed_Component,
9750 N_Character_Literal,
9751 N_Explicit_Dereference)
9757 ("expect subprogram or entry name in instantiation of&",
9758 Instantiation_Node, Formal_Sub);
9759 Abandon_Instantiation (Instantiation_Node);
9760 end Valid_Actual_Subprogram;
9764 Decl_Node : Node_Id;
9768 New_Subp : Entity_Id;
9770 -- Start of processing for Instantiate_Formal_Subprogram
9773 New_Spec := New_Copy_Tree (Specification (Formal));
9775 -- The tree copy has created the proper instantiation sloc for the
9776 -- new specification. Use this location for all other constructed
9779 Loc := Sloc (Defining_Unit_Name (New_Spec));
9781 -- Create new entity for the actual (New_Copy_Tree does not), and
9782 -- indicate that it is an actual.
9784 New_Subp := Make_Defining_Identifier (Loc, Chars (Formal_Sub));
9785 Set_Ekind (New_Subp, Ekind (Analyzed_S));
9786 Set_Is_Generic_Actual_Subprogram (New_Subp);
9787 Set_Defining_Unit_Name (New_Spec, New_Subp);
9789 -- Create new entities for the each of the formals in the specification
9790 -- of the renaming declaration built for the actual.
9792 if Present (Parameter_Specifications (New_Spec)) then
9798 F := First (Parameter_Specifications (New_Spec));
9799 while Present (F) loop
9800 F_Id := Defining_Identifier (F);
9802 Set_Defining_Identifier (F,
9803 Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id)));
9809 -- Find entity of actual. If the actual is an attribute reference, it
9810 -- cannot be resolved here (its formal is missing) but is handled
9811 -- instead in Attribute_Renaming. If the actual is overloaded, it is
9812 -- fully resolved subsequently, when the renaming declaration for the
9813 -- formal is analyzed. If it is an explicit dereference, resolve the
9814 -- prefix but not the actual itself, to prevent interpretation as call.
9816 if Present (Actual) then
9817 Loc := Sloc (Actual);
9818 Set_Sloc (New_Spec, Loc);
9820 if Nkind (Actual) = N_Operator_Symbol then
9821 Find_Direct_Name (Actual);
9823 elsif Nkind (Actual) = N_Explicit_Dereference then
9824 Analyze (Prefix (Actual));
9826 elsif Nkind (Actual) /= N_Attribute_Reference then
9830 Valid_Actual_Subprogram (Actual);
9833 elsif Present (Default_Name (Formal)) then
9834 if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9835 N_Selected_Component,
9836 N_Indexed_Component,
9837 N_Character_Literal)
9838 and then Present (Entity (Default_Name (Formal)))
9840 Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9842 Nam := New_Copy (Default_Name (Formal));
9843 Set_Sloc (Nam, Loc);
9846 elsif Box_Present (Formal) then
9848 -- Actual is resolved at the point of instantiation. Create an
9849 -- identifier or operator with the same name as the formal.
9851 if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9853 Make_Operator_Symbol (Loc,
9854 Chars => Chars (Formal_Sub),
9855 Strval => No_String);
9857 Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9860 elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9861 and then Null_Present (Specification (Formal))
9863 -- Generate null body for procedure, for use in the instance
9866 Make_Subprogram_Body (Loc,
9867 Specification => New_Spec,
9868 Declarations => New_List,
9869 Handled_Statement_Sequence =>
9870 Make_Handled_Sequence_Of_Statements (Loc,
9871 Statements => New_List (Make_Null_Statement (Loc))));
9873 Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9877 Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9879 ("missing actual&", Instantiation_Node, Formal_Sub);
9881 ("\in instantiation of & declared#",
9882 Instantiation_Node, Scope (Analyzed_S));
9883 Abandon_Instantiation (Instantiation_Node);
9887 Make_Subprogram_Renaming_Declaration (Loc,
9888 Specification => New_Spec,
9891 -- If we do not have an actual and the formal specified <> then set to
9892 -- get proper default.
9894 if No (Actual) and then Box_Present (Formal) then
9895 Set_From_Default (Decl_Node);
9898 -- Gather possible interpretations for the actual before analyzing the
9899 -- instance. If overloaded, it will be resolved when analyzing the
9900 -- renaming declaration.
9902 if Box_Present (Formal) and then No (Actual) then
9905 if Is_Child_Unit (Scope (Analyzed_S))
9906 and then Present (Entity (Nam))
9908 if not Is_Overloaded (Nam) then
9909 if From_Parent_Scope (Entity (Nam)) then
9910 Set_Is_Immediately_Visible (Entity (Nam), False);
9911 Set_Entity (Nam, Empty);
9912 Set_Etype (Nam, Empty);
9915 Set_Is_Immediately_Visible (Entity (Nam));
9924 Get_First_Interp (Nam, I, It);
9925 while Present (It.Nam) loop
9926 if From_Parent_Scope (It.Nam) then
9930 Get_Next_Interp (I, It);
9937 -- The generic instantiation freezes the actual. This can only be done
9938 -- once the actual is resolved, in the analysis of the renaming
9939 -- declaration. To make the formal subprogram entity available, we set
9940 -- Corresponding_Formal_Spec to point to the formal subprogram entity.
9941 -- This is also needed in Analyze_Subprogram_Renaming for the processing
9942 -- of formal abstract subprograms.
9944 Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9946 -- We cannot analyze the renaming declaration, and thus find the actual,
9947 -- until all the actuals are assembled in the instance. For subsequent
9948 -- checks of other actuals, indicate the node that will hold the
9949 -- instance of this formal.
9951 Set_Instance_Of (Analyzed_S, Nam);
9953 if Nkind (Actual) = N_Selected_Component
9954 and then Is_Task_Type (Etype (Prefix (Actual)))
9955 and then not Is_Frozen (Etype (Prefix (Actual)))
9957 -- The renaming declaration will create a body, which must appear
9958 -- outside of the instantiation, We move the renaming declaration
9959 -- out of the instance, and create an additional renaming inside,
9960 -- to prevent freezing anomalies.
9963 Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9966 Set_Defining_Unit_Name (New_Spec, Anon_Id);
9967 Insert_Before (Instantiation_Node, Decl_Node);
9968 Analyze (Decl_Node);
9970 -- Now create renaming within the instance
9973 Make_Subprogram_Renaming_Declaration (Loc,
9974 Specification => New_Copy_Tree (New_Spec),
9975 Name => New_Occurrence_Of (Anon_Id, Loc));
9977 Set_Defining_Unit_Name (Specification (Decl_Node),
9978 Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9983 end Instantiate_Formal_Subprogram;
9985 ------------------------
9986 -- Instantiate_Object --
9987 ------------------------
9989 function Instantiate_Object
9992 Analyzed_Formal : Node_Id) return List_Id
9994 Gen_Obj : constant Entity_Id := Defining_Identifier (Formal);
9995 A_Gen_Obj : constant Entity_Id :=
9996 Defining_Identifier (Analyzed_Formal);
9997 Acc_Def : Node_Id := Empty;
9998 Act_Assoc : constant Node_Id := Parent (Actual);
9999 Actual_Decl : Node_Id := Empty;
10000 Decl_Node : Node_Id;
10003 List : constant List_Id := New_List;
10004 Loc : constant Source_Ptr := Sloc (Actual);
10005 Orig_Ftyp : constant Entity_Id := Etype (A_Gen_Obj);
10006 Subt_Decl : Node_Id := Empty;
10007 Subt_Mark : Node_Id := Empty;
10010 if Present (Subtype_Mark (Formal)) then
10011 Subt_Mark := Subtype_Mark (Formal);
10013 Check_Access_Definition (Formal);
10014 Acc_Def := Access_Definition (Formal);
10017 -- Sloc for error message on missing actual
10019 Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
10021 if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
10022 Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
10025 Set_Parent (List, Parent (Actual));
10029 if Out_Present (Formal) then
10031 -- An IN OUT generic actual must be a name. The instantiation is a
10032 -- renaming declaration. The actual is the name being renamed. We
10033 -- use the actual directly, rather than a copy, because it is not
10034 -- used further in the list of actuals, and because a copy or a use
10035 -- of relocate_node is incorrect if the instance is nested within a
10036 -- generic. In order to simplify ASIS searches, the Generic_Parent
10037 -- field links the declaration to the generic association.
10039 if No (Actual) then
10041 ("missing actual&",
10042 Instantiation_Node, Gen_Obj);
10044 ("\in instantiation of & declared#",
10045 Instantiation_Node, Scope (A_Gen_Obj));
10046 Abandon_Instantiation (Instantiation_Node);
10049 if Present (Subt_Mark) then
10051 Make_Object_Renaming_Declaration (Loc,
10052 Defining_Identifier => New_Copy (Gen_Obj),
10053 Subtype_Mark => New_Copy_Tree (Subt_Mark),
10056 else pragma Assert (Present (Acc_Def));
10058 Make_Object_Renaming_Declaration (Loc,
10059 Defining_Identifier => New_Copy (Gen_Obj),
10060 Access_Definition => New_Copy_Tree (Acc_Def),
10064 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
10066 -- The analysis of the actual may produce Insert_Action nodes, so
10067 -- the declaration must have a context in which to attach them.
10069 Append (Decl_Node, List);
10072 -- Return if the analysis of the actual reported some error
10074 if Etype (Actual) = Any_Type then
10078 -- This check is performed here because Analyze_Object_Renaming will
10079 -- not check it when Comes_From_Source is False. Note though that the
10080 -- check for the actual being the name of an object will be performed
10081 -- in Analyze_Object_Renaming.
10083 if Is_Object_Reference (Actual)
10084 and then Is_Dependent_Component_Of_Mutable_Object (Actual)
10087 ("illegal discriminant-dependent component for in out parameter",
10091 -- The actual has to be resolved in order to check that it is a
10092 -- variable (due to cases such as F (1), where F returns access to
10093 -- an array, and for overloaded prefixes).
10095 Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
10097 -- If the type of the formal is not itself a formal, and the current
10098 -- unit is a child unit, the formal type must be declared in a
10099 -- parent, and must be retrieved by visibility.
10101 if Ftyp = Orig_Ftyp
10102 and then Is_Generic_Unit (Scope (Ftyp))
10103 and then Is_Child_Unit (Scope (A_Gen_Obj))
10106 Temp : constant Node_Id :=
10107 New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
10109 Set_Entity (Temp, Empty);
10111 Ftyp := Entity (Temp);
10115 if Is_Private_Type (Ftyp)
10116 and then not Is_Private_Type (Etype (Actual))
10117 and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
10118 or else Base_Type (Etype (Actual)) = Ftyp)
10120 -- If the actual has the type of the full view of the formal, or
10121 -- else a non-private subtype of the formal, then the visibility
10122 -- of the formal type has changed. Add to the actuals a subtype
10123 -- declaration that will force the exchange of views in the body
10124 -- of the instance as well.
10127 Make_Subtype_Declaration (Loc,
10128 Defining_Identifier => Make_Temporary (Loc, 'P'),
10129 Subtype_Indication => New_Occurrence_Of (Ftyp, Loc));
10131 Prepend (Subt_Decl, List);
10133 Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
10134 Exchange_Declarations (Ftyp);
10137 Resolve (Actual, Ftyp);
10139 if not Denotes_Variable (Actual) then
10141 ("actual for& must be a variable", Actual, Gen_Obj);
10143 elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
10145 -- Ada 2005 (AI-423): For a generic formal object of mode in out,
10146 -- the type of the actual shall resolve to a specific anonymous
10149 if Ada_Version < Ada_2005
10150 or else Ekind (Base_Type (Ftyp)) /=
10151 E_Anonymous_Access_Type
10152 or else Ekind (Base_Type (Etype (Actual))) /=
10153 E_Anonymous_Access_Type
10156 ("type of actual does not match type of&", Actual, Gen_Obj);
10160 Note_Possible_Modification (Actual, Sure => True);
10162 -- Check for instantiation of atomic/volatile actual for
10163 -- non-atomic/volatile formal (RM C.6 (12)).
10165 if Is_Atomic_Object (Actual) and then not Is_Atomic (Orig_Ftyp) then
10167 ("cannot instantiate non-atomic formal object "
10168 & "with atomic actual", Actual);
10170 elsif Is_Volatile_Object (Actual) and then not Is_Volatile (Orig_Ftyp)
10173 ("cannot instantiate non-volatile formal object "
10174 & "with volatile actual", Actual);
10177 -- Formal in-parameter
10180 -- The instantiation of a generic formal in-parameter is constant
10181 -- declaration. The actual is the expression for that declaration.
10183 if Present (Actual) then
10184 if Present (Subt_Mark) then
10186 else pragma Assert (Present (Acc_Def));
10191 Make_Object_Declaration (Loc,
10192 Defining_Identifier => New_Copy (Gen_Obj),
10193 Constant_Present => True,
10194 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10195 Object_Definition => New_Copy_Tree (Def),
10196 Expression => Actual);
10198 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
10200 -- A generic formal object of a tagged type is defined to be
10201 -- aliased so the new constant must also be treated as aliased.
10203 if Is_Tagged_Type (Etype (A_Gen_Obj)) then
10204 Set_Aliased_Present (Decl_Node);
10207 Append (Decl_Node, List);
10209 -- No need to repeat (pre-)analysis of some expression nodes
10210 -- already handled in Preanalyze_Actuals.
10212 if Nkind (Actual) /= N_Allocator then
10215 -- Return if the analysis of the actual reported some error
10217 if Etype (Actual) = Any_Type then
10223 Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
10227 Typ := Get_Instance_Of (Formal_Type);
10229 -- If the actual appears in the current or an enclosing scope,
10230 -- use its type directly. This is relevant if it has an actual
10231 -- subtype that is distinct from its nominal one. This cannot
10232 -- be done in general because the type of the actual may
10233 -- depend on other actuals, and only be fully determined when
10234 -- the enclosing instance is analyzed.
10236 if Present (Etype (Actual))
10237 and then Is_Constr_Subt_For_U_Nominal (Etype (Actual))
10239 Freeze_Before (Instantiation_Node, Etype (Actual));
10242 Freeze_Before (Instantiation_Node, Typ);
10245 -- If the actual is an aggregate, perform name resolution on
10246 -- its components (the analysis of an aggregate does not do it)
10247 -- to capture local names that may be hidden if the generic is
10250 if Nkind (Actual) = N_Aggregate then
10251 Preanalyze_And_Resolve (Actual, Typ);
10254 if Is_Limited_Type (Typ)
10255 and then not OK_For_Limited_Init (Typ, Actual)
10258 ("initialization not allowed for limited types", Actual);
10259 Explain_Limited_Type (Typ, Actual);
10263 elsif Present (Default_Expression (Formal)) then
10265 -- Use default to construct declaration
10267 if Present (Subt_Mark) then
10269 else pragma Assert (Present (Acc_Def));
10274 Make_Object_Declaration (Sloc (Formal),
10275 Defining_Identifier => New_Copy (Gen_Obj),
10276 Constant_Present => True,
10277 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10278 Object_Definition => New_Copy (Def),
10279 Expression => New_Copy_Tree
10280 (Default_Expression (Formal)));
10282 Append (Decl_Node, List);
10283 Set_Analyzed (Expression (Decl_Node), False);
10287 ("missing actual&",
10288 Instantiation_Node, Gen_Obj);
10289 Error_Msg_NE ("\in instantiation of & declared#",
10290 Instantiation_Node, Scope (A_Gen_Obj));
10292 if Is_Scalar_Type (Etype (A_Gen_Obj)) then
10294 -- Create dummy constant declaration so that instance can be
10295 -- analyzed, to minimize cascaded visibility errors.
10297 if Present (Subt_Mark) then
10299 else pragma Assert (Present (Acc_Def));
10304 Make_Object_Declaration (Loc,
10305 Defining_Identifier => New_Copy (Gen_Obj),
10306 Constant_Present => True,
10307 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10308 Object_Definition => New_Copy (Def),
10310 Make_Attribute_Reference (Sloc (Gen_Obj),
10311 Attribute_Name => Name_First,
10312 Prefix => New_Copy (Def)));
10314 Append (Decl_Node, List);
10317 Abandon_Instantiation (Instantiation_Node);
10322 if Nkind (Actual) in N_Has_Entity then
10323 Actual_Decl := Parent (Entity (Actual));
10326 -- Ada 2005 (AI-423): For a formal object declaration with a null
10327 -- exclusion or an access definition that has a null exclusion: If the
10328 -- actual matching the formal object declaration denotes a generic
10329 -- formal object of another generic unit G, and the instantiation
10330 -- containing the actual occurs within the body of G or within the body
10331 -- of a generic unit declared within the declarative region of G, then
10332 -- the declaration of the formal object of G must have a null exclusion.
10333 -- Otherwise, the subtype of the actual matching the formal object
10334 -- declaration shall exclude null.
10336 if Ada_Version >= Ada_2005
10337 and then Present (Actual_Decl)
10339 Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
10340 N_Object_Declaration)
10341 and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
10342 and then not Has_Null_Exclusion (Actual_Decl)
10343 and then Has_Null_Exclusion (Analyzed_Formal)
10345 Error_Msg_Sloc := Sloc (Analyzed_Formal);
10347 ("actual must exclude null to match generic formal#", Actual);
10350 -- An effectively volatile object cannot be used as an actual in
10351 -- a generic instance. The following check is only relevant when
10352 -- SPARK_Mode is on as it is not a standard Ada legality rule.
10355 and then Present (Actual)
10356 and then Is_Effectively_Volatile_Object (Actual)
10359 ("volatile object cannot act as actual in generic instantiation "
10360 & "(SPARK RM 7.1.3(8))", Actual);
10364 end Instantiate_Object;
10366 ------------------------------
10367 -- Instantiate_Package_Body --
10368 ------------------------------
10370 procedure Instantiate_Package_Body
10371 (Body_Info : Pending_Body_Info;
10372 Inlined_Body : Boolean := False;
10373 Body_Optional : Boolean := False)
10375 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10376 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10377 Loc : constant Source_Ptr := Sloc (Inst_Node);
10379 Gen_Id : constant Node_Id := Name (Inst_Node);
10380 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10381 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10382 Act_Spec : constant Node_Id := Specification (Act_Decl);
10383 Act_Decl_Id : constant Entity_Id := Defining_Entity (Act_Spec);
10385 Act_Body_Name : Node_Id;
10386 Gen_Body : Node_Id;
10387 Gen_Body_Id : Node_Id;
10388 Act_Body : Node_Id;
10389 Act_Body_Id : Entity_Id;
10391 Parent_Installed : Boolean := False;
10392 Save_Style_Check : constant Boolean := Style_Check;
10394 Par_Ent : Entity_Id := Empty;
10395 Par_Vis : Boolean := False;
10397 Vis_Prims_List : Elist_Id := No_Elist;
10398 -- List of primitives made temporarily visible in the instantiation
10399 -- to match the visibility of the formal type
10401 procedure Check_Initialized_Types;
10402 -- In a generic package body, an entity of a generic private type may
10403 -- appear uninitialized. This is suspicious, unless the actual is a
10404 -- fully initialized type.
10406 -----------------------------
10407 -- Check_Initialized_Types --
10408 -----------------------------
10410 procedure Check_Initialized_Types is
10412 Formal : Entity_Id;
10413 Actual : Entity_Id;
10414 Uninit_Var : Entity_Id;
10417 Decl := First (Generic_Formal_Declarations (Gen_Decl));
10418 while Present (Decl) loop
10419 Uninit_Var := Empty;
10421 if Nkind (Decl) = N_Private_Extension_Declaration then
10422 Uninit_Var := Uninitialized_Variable (Decl);
10424 elsif Nkind (Decl) = N_Formal_Type_Declaration
10425 and then Nkind (Formal_Type_Definition (Decl)) =
10426 N_Formal_Private_Type_Definition
10429 Uninitialized_Variable (Formal_Type_Definition (Decl));
10432 if Present (Uninit_Var) then
10433 Formal := Defining_Identifier (Decl);
10434 Actual := First_Entity (Act_Decl_Id);
10436 -- For each formal there is a subtype declaration that renames
10437 -- the actual and has the same name as the formal. Locate the
10438 -- formal for warning message about uninitialized variables
10439 -- in the generic, for which the actual type should be a fully
10440 -- initialized type.
10442 while Present (Actual) loop
10443 exit when Ekind (Actual) = E_Package
10444 and then Present (Renamed_Object (Actual));
10446 if Chars (Actual) = Chars (Formal)
10447 and then not Is_Scalar_Type (Actual)
10448 and then not Is_Fully_Initialized_Type (Actual)
10449 and then Warn_On_No_Value_Assigned
10451 Error_Msg_Node_2 := Formal;
10453 ("generic unit has uninitialized variable& of "
10454 & "formal private type &?v?", Actual, Uninit_Var);
10456 ("actual type for& should be fully initialized type?v?",
10461 Next_Entity (Actual);
10467 end Check_Initialized_Types;
10469 -- Start of processing for Instantiate_Package_Body
10472 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10474 -- The instance body may already have been processed, as the parent of
10475 -- another instance that is inlined (Load_Parent_Of_Generic).
10477 if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
10481 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10483 -- Re-establish the state of information on which checks are suppressed.
10484 -- This information was set in Body_Info at the point of instantiation,
10485 -- and now we restore it so that the instance is compiled using the
10486 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10488 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10489 Scope_Suppress := Body_Info.Scope_Suppress;
10490 Opt.Ada_Version := Body_Info.Version;
10491 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10492 Restore_Warnings (Body_Info.Warnings);
10493 Opt.SPARK_Mode := Body_Info.SPARK_Mode;
10494 Opt.SPARK_Mode_Pragma := Body_Info.SPARK_Mode_Pragma;
10496 if No (Gen_Body_Id) then
10498 -- Do not look for parent of generic body if none is required.
10499 -- This may happen when the routine is called as part of the
10500 -- Pending_Instantiations processing, when nested instances
10501 -- may precede the one generated from the main unit.
10503 if not Unit_Requires_Body (Defining_Entity (Gen_Decl))
10504 and then Body_Optional
10508 Load_Parent_Of_Generic
10509 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10510 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10514 -- Establish global variable for sloc adjustment and for error recovery
10516 Instantiation_Node := Inst_Node;
10518 if Present (Gen_Body_Id) then
10519 Save_Env (Gen_Unit, Act_Decl_Id);
10520 Style_Check := False;
10521 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10523 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10525 Create_Instantiation_Source
10526 (Inst_Node, Gen_Body_Id, False, S_Adjustment);
10530 (Original_Node (Gen_Body), Empty, Instantiating => True);
10532 -- Build new name (possibly qualified) for body declaration
10534 Act_Body_Id := New_Copy (Act_Decl_Id);
10536 -- Some attributes of spec entity are not inherited by body entity
10538 Set_Handler_Records (Act_Body_Id, No_List);
10540 if Nkind (Defining_Unit_Name (Act_Spec)) =
10541 N_Defining_Program_Unit_Name
10544 Make_Defining_Program_Unit_Name (Loc,
10545 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
10546 Defining_Identifier => Act_Body_Id);
10548 Act_Body_Name := Act_Body_Id;
10551 Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
10553 Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
10554 Check_Generic_Actuals (Act_Decl_Id, False);
10555 Check_Initialized_Types;
10557 -- Install primitives hidden at the point of the instantiation but
10558 -- visible when processing the generic formals
10564 E := First_Entity (Act_Decl_Id);
10565 while Present (E) loop
10567 and then Is_Generic_Actual_Type (E)
10568 and then Is_Tagged_Type (E)
10570 Install_Hidden_Primitives
10571 (Prims_List => Vis_Prims_List,
10572 Gen_T => Generic_Parent_Type (Parent (E)),
10580 -- If it is a child unit, make the parent instance (which is an
10581 -- instance of the parent of the generic) visible. The parent
10582 -- instance is the prefix of the name of the generic unit.
10584 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10585 and then Nkind (Gen_Id) = N_Expanded_Name
10587 Par_Ent := Entity (Prefix (Gen_Id));
10588 Par_Vis := Is_Immediately_Visible (Par_Ent);
10589 Install_Parent (Par_Ent, In_Body => True);
10590 Parent_Installed := True;
10592 elsif Is_Child_Unit (Gen_Unit) then
10593 Par_Ent := Scope (Gen_Unit);
10594 Par_Vis := Is_Immediately_Visible (Par_Ent);
10595 Install_Parent (Par_Ent, In_Body => True);
10596 Parent_Installed := True;
10599 -- If the instantiation is a library unit, and this is the main unit,
10600 -- then build the resulting compilation unit nodes for the instance.
10601 -- If this is a compilation unit but it is not the main unit, then it
10602 -- is the body of a unit in the context, that is being compiled
10603 -- because it is encloses some inlined unit or another generic unit
10604 -- being instantiated. In that case, this body is not part of the
10605 -- current compilation, and is not attached to the tree, but its
10606 -- parent must be set for analysis.
10608 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10610 -- Replace instance node with body of instance, and create new
10611 -- node for corresponding instance declaration.
10613 Build_Instance_Compilation_Unit_Nodes
10614 (Inst_Node, Act_Body, Act_Decl);
10615 Analyze (Inst_Node);
10617 if Parent (Inst_Node) = Cunit (Main_Unit) then
10619 -- If the instance is a child unit itself, then set the scope
10620 -- of the expanded body to be the parent of the instantiation
10621 -- (ensuring that the fully qualified name will be generated
10622 -- for the elaboration subprogram).
10624 if Nkind (Defining_Unit_Name (Act_Spec)) =
10625 N_Defining_Program_Unit_Name
10628 (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
10632 -- Case where instantiation is not a library unit
10635 -- If this is an early instantiation, i.e. appears textually
10636 -- before the corresponding body and must be elaborated first,
10637 -- indicate that the body instance is to be delayed.
10639 Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
10641 -- Now analyze the body. We turn off all checks if this is an
10642 -- internal unit, since there is no reason to have checks on for
10643 -- any predefined run-time library code. All such code is designed
10644 -- to be compiled with checks off.
10646 -- Note that we do NOT apply this criterion to children of GNAT
10647 -- The latter units must suppress checks explicitly if needed.
10649 if Is_Predefined_File_Name
10650 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
10652 Analyze (Act_Body, Suppress => All_Checks);
10654 Analyze (Act_Body);
10658 Inherit_Context (Gen_Body, Inst_Node);
10660 -- Remove the parent instances if they have been placed on the scope
10661 -- stack to compile the body.
10663 if Parent_Installed then
10664 Remove_Parent (In_Body => True);
10666 -- Restore the previous visibility of the parent
10668 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10671 Restore_Hidden_Primitives (Vis_Prims_List);
10672 Restore_Private_Views (Act_Decl_Id);
10674 -- Remove the current unit from visibility if this is an instance
10675 -- that is not elaborated on the fly for inlining purposes.
10677 if not Inlined_Body then
10678 Set_Is_Immediately_Visible (Act_Decl_Id, False);
10682 Style_Check := Save_Style_Check;
10684 -- If we have no body, and the unit requires a body, then complain. This
10685 -- complaint is suppressed if we have detected other errors (since a
10686 -- common reason for missing the body is that it had errors).
10687 -- In CodePeer mode, a warning has been emitted already, no need for
10688 -- further messages.
10690 elsif Unit_Requires_Body (Gen_Unit)
10691 and then not Body_Optional
10693 if CodePeer_Mode then
10696 elsif Serious_Errors_Detected = 0 then
10698 ("cannot find body of generic package &", Inst_Node, Gen_Unit);
10700 -- Don't attempt to perform any cleanup actions if some other error
10701 -- was already detected, since this can cause blowups.
10707 -- Case of package that does not need a body
10710 -- If the instantiation of the declaration is a library unit, rewrite
10711 -- the original package instantiation as a package declaration in the
10712 -- compilation unit node.
10714 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10715 Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
10716 Rewrite (Inst_Node, Act_Decl);
10718 -- Generate elaboration entity, in case spec has elaboration code.
10719 -- This cannot be done when the instance is analyzed, because it
10720 -- is not known yet whether the body exists.
10722 Set_Elaboration_Entity_Required (Act_Decl_Id, False);
10723 Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
10725 -- If the instantiation is not a library unit, then append the
10726 -- declaration to the list of implicitly generated entities, unless
10727 -- it is already a list member which means that it was already
10730 elsif not Is_List_Member (Act_Decl) then
10731 Mark_Rewrite_Insertion (Act_Decl);
10732 Insert_Before (Inst_Node, Act_Decl);
10736 Expander_Mode_Restore;
10737 end Instantiate_Package_Body;
10739 ---------------------------------
10740 -- Instantiate_Subprogram_Body --
10741 ---------------------------------
10743 procedure Instantiate_Subprogram_Body
10744 (Body_Info : Pending_Body_Info;
10745 Body_Optional : Boolean := False)
10747 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10748 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10749 Loc : constant Source_Ptr := Sloc (Inst_Node);
10750 Gen_Id : constant Node_Id := Name (Inst_Node);
10751 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10752 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10753 Anon_Id : constant Entity_Id :=
10754 Defining_Unit_Name (Specification (Act_Decl));
10755 Pack_Id : constant Entity_Id :=
10756 Defining_Unit_Name (Parent (Act_Decl));
10758 Gen_Body : Node_Id;
10759 Gen_Body_Id : Node_Id;
10760 Act_Body : Node_Id;
10761 Pack_Body : Node_Id;
10762 Prev_Formal : Entity_Id;
10763 Ret_Expr : Node_Id;
10764 Unit_Renaming : Node_Id;
10766 Parent_Installed : Boolean := False;
10768 Saved_Style_Check : constant Boolean := Style_Check;
10769 Saved_Warnings : constant Warning_Record := Save_Warnings;
10771 Par_Ent : Entity_Id := Empty;
10772 Par_Vis : Boolean := False;
10775 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10777 -- Subprogram body may have been created already because of an inline
10778 -- pragma, or because of multiple elaborations of the enclosing package
10779 -- when several instances of the subprogram appear in the main unit.
10781 if Present (Corresponding_Body (Act_Decl)) then
10785 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10787 -- Re-establish the state of information on which checks are suppressed.
10788 -- This information was set in Body_Info at the point of instantiation,
10789 -- and now we restore it so that the instance is compiled using the
10790 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10792 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10793 Scope_Suppress := Body_Info.Scope_Suppress;
10794 Opt.Ada_Version := Body_Info.Version;
10795 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10796 Restore_Warnings (Body_Info.Warnings);
10797 Opt.SPARK_Mode := Body_Info.SPARK_Mode;
10798 Opt.SPARK_Mode_Pragma := Body_Info.SPARK_Mode_Pragma;
10800 if No (Gen_Body_Id) then
10802 -- For imported generic subprogram, no body to compile, complete
10803 -- the spec entity appropriately.
10805 if Is_Imported (Gen_Unit) then
10806 Set_Is_Imported (Anon_Id);
10807 Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10808 Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10809 Set_Convention (Anon_Id, Convention (Gen_Unit));
10810 Set_Has_Completion (Anon_Id);
10813 -- For other cases, compile the body
10816 Load_Parent_Of_Generic
10817 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10818 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10822 Instantiation_Node := Inst_Node;
10824 if Present (Gen_Body_Id) then
10825 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10827 if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10829 -- Either body is not present, or context is non-expanding, as
10830 -- when compiling a subunit. Mark the instance as completed, and
10831 -- diagnose a missing body when needed.
10834 and then Operating_Mode = Generate_Code
10837 ("missing proper body for instantiation", Gen_Body);
10840 Set_Has_Completion (Anon_Id);
10844 Save_Env (Gen_Unit, Anon_Id);
10845 Style_Check := False;
10846 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10847 Create_Instantiation_Source
10855 (Original_Node (Gen_Body), Empty, Instantiating => True);
10857 -- Create proper defining name for the body, to correspond to
10858 -- the one in the spec.
10860 Set_Defining_Unit_Name (Specification (Act_Body),
10861 Make_Defining_Identifier
10862 (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10863 Set_Corresponding_Spec (Act_Body, Anon_Id);
10864 Set_Has_Completion (Anon_Id);
10865 Check_Generic_Actuals (Pack_Id, False);
10867 -- Generate a reference to link the visible subprogram instance to
10868 -- the generic body, which for navigation purposes is the only
10869 -- available source for the instance.
10872 (Related_Instance (Pack_Id),
10873 Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10875 -- If it is a child unit, make the parent instance (which is an
10876 -- instance of the parent of the generic) visible. The parent
10877 -- instance is the prefix of the name of the generic unit.
10879 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10880 and then Nkind (Gen_Id) = N_Expanded_Name
10882 Par_Ent := Entity (Prefix (Gen_Id));
10883 Par_Vis := Is_Immediately_Visible (Par_Ent);
10884 Install_Parent (Par_Ent, In_Body => True);
10885 Parent_Installed := True;
10887 elsif Is_Child_Unit (Gen_Unit) then
10888 Par_Ent := Scope (Gen_Unit);
10889 Par_Vis := Is_Immediately_Visible (Par_Ent);
10890 Install_Parent (Par_Ent, In_Body => True);
10891 Parent_Installed := True;
10894 -- Inside its body, a reference to the generic unit is a reference
10895 -- to the instance. The corresponding renaming is the first
10896 -- declaration in the body.
10899 Make_Subprogram_Renaming_Declaration (Loc,
10901 Copy_Generic_Node (
10902 Specification (Original_Node (Gen_Body)),
10904 Instantiating => True),
10905 Name => New_Occurrence_Of (Anon_Id, Loc));
10907 -- If there is a formal subprogram with the same name as the unit
10908 -- itself, do not add this renaming declaration. This is a temporary
10909 -- fix for one ACVC test. ???
10911 Prev_Formal := First_Entity (Pack_Id);
10912 while Present (Prev_Formal) loop
10913 if Chars (Prev_Formal) = Chars (Gen_Unit)
10914 and then Is_Overloadable (Prev_Formal)
10919 Next_Entity (Prev_Formal);
10922 if Present (Prev_Formal) then
10923 Decls := New_List (Act_Body);
10925 Decls := New_List (Unit_Renaming, Act_Body);
10928 -- The subprogram body is placed in the body of a dummy package body,
10929 -- whose spec contains the subprogram declaration as well as the
10930 -- renaming declarations for the generic parameters.
10932 Pack_Body := Make_Package_Body (Loc,
10933 Defining_Unit_Name => New_Copy (Pack_Id),
10934 Declarations => Decls);
10936 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10938 -- If the instantiation is a library unit, then build resulting
10939 -- compilation unit nodes for the instance. The declaration of
10940 -- the enclosing package is the grandparent of the subprogram
10941 -- declaration. First replace the instantiation node as the unit
10942 -- of the corresponding compilation.
10944 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10945 if Parent (Inst_Node) = Cunit (Main_Unit) then
10946 Set_Unit (Parent (Inst_Node), Inst_Node);
10947 Build_Instance_Compilation_Unit_Nodes
10948 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10949 Analyze (Inst_Node);
10951 Set_Parent (Pack_Body, Parent (Inst_Node));
10952 Analyze (Pack_Body);
10956 Insert_Before (Inst_Node, Pack_Body);
10957 Mark_Rewrite_Insertion (Pack_Body);
10958 Analyze (Pack_Body);
10960 if Expander_Active then
10961 Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10965 Inherit_Context (Gen_Body, Inst_Node);
10967 Restore_Private_Views (Pack_Id, False);
10969 if Parent_Installed then
10970 Remove_Parent (In_Body => True);
10972 -- Restore the previous visibility of the parent
10974 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10978 Style_Check := Saved_Style_Check;
10979 Restore_Warnings (Saved_Warnings);
10981 -- Body not found. Error was emitted already. If there were no previous
10982 -- errors, this may be an instance whose scope is a premature instance.
10983 -- In that case we must insure that the (legal) program does raise
10984 -- program error if executed. We generate a subprogram body for this
10985 -- purpose. See DEC ac30vso.
10987 -- Should not reference proprietary DEC tests in comments ???
10989 elsif Serious_Errors_Detected = 0
10990 and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
10992 if Body_Optional then
10995 elsif Ekind (Anon_Id) = E_Procedure then
10997 Make_Subprogram_Body (Loc,
10999 Make_Procedure_Specification (Loc,
11000 Defining_Unit_Name =>
11001 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
11002 Parameter_Specifications =>
11004 (Parameter_Specifications (Parent (Anon_Id)))),
11006 Declarations => Empty_List,
11007 Handled_Statement_Sequence =>
11008 Make_Handled_Sequence_Of_Statements (Loc,
11011 Make_Raise_Program_Error (Loc,
11013 PE_Access_Before_Elaboration))));
11017 Make_Raise_Program_Error (Loc,
11018 Reason => PE_Access_Before_Elaboration);
11020 Set_Etype (Ret_Expr, (Etype (Anon_Id)));
11021 Set_Analyzed (Ret_Expr);
11024 Make_Subprogram_Body (Loc,
11026 Make_Function_Specification (Loc,
11027 Defining_Unit_Name =>
11028 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
11029 Parameter_Specifications =>
11031 (Parameter_Specifications (Parent (Anon_Id))),
11032 Result_Definition =>
11033 New_Occurrence_Of (Etype (Anon_Id), Loc)),
11035 Declarations => Empty_List,
11036 Handled_Statement_Sequence =>
11037 Make_Handled_Sequence_Of_Statements (Loc,
11040 (Make_Simple_Return_Statement (Loc, Ret_Expr))));
11043 Pack_Body := Make_Package_Body (Loc,
11044 Defining_Unit_Name => New_Copy (Pack_Id),
11045 Declarations => New_List (Act_Body));
11047 Insert_After (Inst_Node, Pack_Body);
11048 Set_Corresponding_Spec (Pack_Body, Pack_Id);
11049 Analyze (Pack_Body);
11052 Expander_Mode_Restore;
11053 end Instantiate_Subprogram_Body;
11055 ----------------------
11056 -- Instantiate_Type --
11057 ----------------------
11059 function Instantiate_Type
11062 Analyzed_Formal : Node_Id;
11063 Actual_Decls : List_Id) return List_Id
11065 Gen_T : constant Entity_Id := Defining_Identifier (Formal);
11066 A_Gen_T : constant Entity_Id :=
11067 Defining_Identifier (Analyzed_Formal);
11068 Ancestor : Entity_Id := Empty;
11069 Def : constant Node_Id := Formal_Type_Definition (Formal);
11071 Decl_Node : Node_Id;
11072 Decl_Nodes : List_Id;
11076 procedure Diagnose_Predicated_Actual;
11077 -- There are a number of constructs in which a discrete type with
11078 -- predicates is illegal, e.g. as an index in an array type declaration.
11079 -- If a generic type is used is such a construct in a generic package
11080 -- declaration, it carries the flag No_Predicate_On_Actual. it is part
11081 -- of the generic contract that the actual cannot have predicates.
11083 procedure Validate_Array_Type_Instance;
11084 procedure Validate_Access_Subprogram_Instance;
11085 procedure Validate_Access_Type_Instance;
11086 procedure Validate_Derived_Type_Instance;
11087 procedure Validate_Derived_Interface_Type_Instance;
11088 procedure Validate_Discriminated_Formal_Type;
11089 procedure Validate_Interface_Type_Instance;
11090 procedure Validate_Private_Type_Instance;
11091 procedure Validate_Incomplete_Type_Instance;
11092 -- These procedures perform validation tests for the named case.
11093 -- Validate_Discriminated_Formal_Type is shared by formal private
11094 -- types and Ada 2012 formal incomplete types.
11096 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
11097 -- Check that base types are the same and that the subtypes match
11098 -- statically. Used in several of the above.
11100 ---------------------------------
11101 -- Diagnose_Predicated_Actual --
11102 ---------------------------------
11104 procedure Diagnose_Predicated_Actual is
11106 if No_Predicate_On_Actual (A_Gen_T)
11107 and then Has_Predicates (Act_T)
11110 ("actual for& cannot be a type with predicate",
11111 Instantiation_Node, A_Gen_T);
11113 elsif No_Dynamic_Predicate_On_Actual (A_Gen_T)
11114 and then Has_Predicates (Act_T)
11115 and then not Has_Static_Predicate_Aspect (Act_T)
11118 ("actual for& cannot be a type with a dynamic predicate",
11119 Instantiation_Node, A_Gen_T);
11121 end Diagnose_Predicated_Actual;
11123 --------------------
11124 -- Subtypes_Match --
11125 --------------------
11127 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
11128 T : constant Entity_Id := Get_Instance_Of (Gen_T);
11131 -- Some detailed comments would be useful here ???
11133 return ((Base_Type (T) = Act_T
11134 or else Base_Type (T) = Base_Type (Act_T))
11135 and then Subtypes_Statically_Match (T, Act_T))
11137 or else (Is_Class_Wide_Type (Gen_T)
11138 and then Is_Class_Wide_Type (Act_T)
11139 and then Subtypes_Match
11140 (Get_Instance_Of (Root_Type (Gen_T)),
11141 Root_Type (Act_T)))
11144 (Ekind_In (Gen_T, E_Anonymous_Access_Subprogram_Type,
11145 E_Anonymous_Access_Type)
11146 and then Ekind (Act_T) = Ekind (Gen_T)
11147 and then Subtypes_Statically_Match
11148 (Designated_Type (Gen_T), Designated_Type (Act_T)));
11149 end Subtypes_Match;
11151 -----------------------------------------
11152 -- Validate_Access_Subprogram_Instance --
11153 -----------------------------------------
11155 procedure Validate_Access_Subprogram_Instance is
11157 if not Is_Access_Type (Act_T)
11158 or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
11161 ("expect access type in instantiation of &", Actual, Gen_T);
11162 Abandon_Instantiation (Actual);
11165 -- According to AI05-288, actuals for access_to_subprograms must be
11166 -- subtype conformant with the generic formal. Previous to AI05-288
11167 -- only mode conformance was required.
11169 -- This is a binding interpretation that applies to previous versions
11170 -- of the language, no need to maintain previous weaker checks.
11172 Check_Subtype_Conformant
11173 (Designated_Type (Act_T),
11174 Designated_Type (A_Gen_T),
11178 if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
11179 if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
11181 ("protected access type not allowed for formal &",
11185 elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
11187 ("expect protected access type for formal &",
11190 end Validate_Access_Subprogram_Instance;
11192 -----------------------------------
11193 -- Validate_Access_Type_Instance --
11194 -----------------------------------
11196 procedure Validate_Access_Type_Instance is
11197 Desig_Type : constant Entity_Id :=
11198 Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
11199 Desig_Act : Entity_Id;
11202 if not Is_Access_Type (Act_T) then
11204 ("expect access type in instantiation of &", Actual, Gen_T);
11205 Abandon_Instantiation (Actual);
11208 if Is_Access_Constant (A_Gen_T) then
11209 if not Is_Access_Constant (Act_T) then
11211 ("actual type must be access-to-constant type", Actual);
11212 Abandon_Instantiation (Actual);
11215 if Is_Access_Constant (Act_T) then
11217 ("actual type must be access-to-variable type", Actual);
11218 Abandon_Instantiation (Actual);
11220 elsif Ekind (A_Gen_T) = E_General_Access_Type
11221 and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
11223 Error_Msg_N -- CODEFIX
11224 ("actual must be general access type!", Actual);
11225 Error_Msg_NE -- CODEFIX
11226 ("add ALL to }!", Actual, Act_T);
11227 Abandon_Instantiation (Actual);
11231 -- The designated subtypes, that is to say the subtypes introduced
11232 -- by an access type declaration (and not by a subtype declaration)
11235 Desig_Act := Designated_Type (Base_Type (Act_T));
11237 -- The designated type may have been introduced through a limited_
11238 -- with clause, in which case retrieve the non-limited view. This
11239 -- applies to incomplete types as well as to class-wide types.
11241 if From_Limited_With (Desig_Act) then
11242 Desig_Act := Available_View (Desig_Act);
11245 if not Subtypes_Match (Desig_Type, Desig_Act) then
11247 ("designated type of actual does not match that of formal &",
11250 if not Predicates_Match (Desig_Type, Desig_Act) then
11251 Error_Msg_N ("\predicates do not match", Actual);
11254 Abandon_Instantiation (Actual);
11256 elsif Is_Access_Type (Designated_Type (Act_T))
11257 and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
11259 Is_Constrained (Designated_Type (Desig_Type))
11262 ("designated type of actual does not match that of formal &",
11265 if not Predicates_Match (Desig_Type, Desig_Act) then
11266 Error_Msg_N ("\predicates do not match", Actual);
11269 Abandon_Instantiation (Actual);
11272 -- Ada 2005: null-exclusion indicators of the two types must agree
11274 if Can_Never_Be_Null (A_Gen_T) /= Can_Never_Be_Null (Act_T) then
11276 ("non null exclusion of actual and formal & do not match",
11279 end Validate_Access_Type_Instance;
11281 ----------------------------------
11282 -- Validate_Array_Type_Instance --
11283 ----------------------------------
11285 procedure Validate_Array_Type_Instance is
11290 function Formal_Dimensions return Int;
11291 -- Count number of dimensions in array type formal
11293 -----------------------
11294 -- Formal_Dimensions --
11295 -----------------------
11297 function Formal_Dimensions return Int is
11302 if Nkind (Def) = N_Constrained_Array_Definition then
11303 Index := First (Discrete_Subtype_Definitions (Def));
11305 Index := First (Subtype_Marks (Def));
11308 while Present (Index) loop
11310 Next_Index (Index);
11314 end Formal_Dimensions;
11316 -- Start of processing for Validate_Array_Type_Instance
11319 if not Is_Array_Type (Act_T) then
11321 ("expect array type in instantiation of &", Actual, Gen_T);
11322 Abandon_Instantiation (Actual);
11324 elsif Nkind (Def) = N_Constrained_Array_Definition then
11325 if not (Is_Constrained (Act_T)) then
11327 ("expect constrained array in instantiation of &",
11329 Abandon_Instantiation (Actual);
11333 if Is_Constrained (Act_T) then
11335 ("expect unconstrained array in instantiation of &",
11337 Abandon_Instantiation (Actual);
11341 if Formal_Dimensions /= Number_Dimensions (Act_T) then
11343 ("dimensions of actual do not match formal &", Actual, Gen_T);
11344 Abandon_Instantiation (Actual);
11347 I1 := First_Index (A_Gen_T);
11348 I2 := First_Index (Act_T);
11349 for J in 1 .. Formal_Dimensions loop
11351 -- If the indexes of the actual were given by a subtype_mark,
11352 -- the index was transformed into a range attribute. Retrieve
11353 -- the original type mark for checking.
11355 if Is_Entity_Name (Original_Node (I2)) then
11356 T2 := Entity (Original_Node (I2));
11361 if not Subtypes_Match
11362 (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
11365 ("index types of actual do not match those of formal &",
11367 Abandon_Instantiation (Actual);
11374 -- Check matching subtypes. Note that there are complex visibility
11375 -- issues when the generic is a child unit and some aspect of the
11376 -- generic type is declared in a parent unit of the generic. We do
11377 -- the test to handle this special case only after a direct check
11378 -- for static matching has failed. The case where both the component
11379 -- type and the array type are separate formals, and the component
11380 -- type is a private view may also require special checking in
11384 (Component_Type (A_Gen_T), Component_Type (Act_T))
11387 (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
11388 Component_Type (Act_T))
11393 ("component subtype of actual does not match that of formal &",
11395 Abandon_Instantiation (Actual);
11398 if Has_Aliased_Components (A_Gen_T)
11399 and then not Has_Aliased_Components (Act_T)
11402 ("actual must have aliased components to match formal type &",
11405 end Validate_Array_Type_Instance;
11407 -----------------------------------------------
11408 -- Validate_Derived_Interface_Type_Instance --
11409 -----------------------------------------------
11411 procedure Validate_Derived_Interface_Type_Instance is
11412 Par : constant Entity_Id := Entity (Subtype_Indication (Def));
11416 -- First apply interface instance checks
11418 Validate_Interface_Type_Instance;
11420 -- Verify that immediate parent interface is an ancestor of
11424 and then not Interface_Present_In_Ancestor (Act_T, Par)
11427 ("interface actual must include progenitor&", Actual, Par);
11430 -- Now verify that the actual includes all other ancestors of
11433 Elmt := First_Elmt (Interfaces (A_Gen_T));
11434 while Present (Elmt) loop
11435 if not Interface_Present_In_Ancestor
11436 (Act_T, Get_Instance_Of (Node (Elmt)))
11439 ("interface actual must include progenitor&",
11440 Actual, Node (Elmt));
11445 end Validate_Derived_Interface_Type_Instance;
11447 ------------------------------------
11448 -- Validate_Derived_Type_Instance --
11449 ------------------------------------
11451 procedure Validate_Derived_Type_Instance is
11452 Actual_Discr : Entity_Id;
11453 Ancestor_Discr : Entity_Id;
11456 -- If the parent type in the generic declaration is itself a previous
11457 -- formal type, then it is local to the generic and absent from the
11458 -- analyzed generic definition. In that case the ancestor is the
11459 -- instance of the formal (which must have been instantiated
11460 -- previously), unless the ancestor is itself a formal derived type.
11461 -- In this latter case (which is the subject of Corrigendum 8652/0038
11462 -- (AI-202) the ancestor of the formals is the ancestor of its
11463 -- parent. Otherwise, the analyzed generic carries the parent type.
11464 -- If the parent type is defined in a previous formal package, then
11465 -- the scope of that formal package is that of the generic type
11466 -- itself, and it has already been mapped into the corresponding type
11467 -- in the actual package.
11469 -- Common case: parent type defined outside of the generic
11471 if Is_Entity_Name (Subtype_Mark (Def))
11472 and then Present (Entity (Subtype_Mark (Def)))
11474 Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
11476 -- Check whether parent is defined in a previous formal package
11479 Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
11482 Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
11484 -- The type may be a local derivation, or a type extension of a
11485 -- previous formal, or of a formal of a parent package.
11487 elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
11489 Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
11491 -- Check whether the parent is another derived formal type in the
11492 -- same generic unit.
11494 if Etype (A_Gen_T) /= A_Gen_T
11495 and then Is_Generic_Type (Etype (A_Gen_T))
11496 and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
11497 and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
11499 -- Locate ancestor of parent from the subtype declaration
11500 -- created for the actual.
11506 Decl := First (Actual_Decls);
11507 while Present (Decl) loop
11508 if Nkind (Decl) = N_Subtype_Declaration
11509 and then Chars (Defining_Identifier (Decl)) =
11510 Chars (Etype (A_Gen_T))
11512 Ancestor := Generic_Parent_Type (Decl);
11520 pragma Assert (Present (Ancestor));
11522 -- The ancestor itself may be a previous formal that has been
11525 Ancestor := Get_Instance_Of (Ancestor);
11529 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
11532 -- An unusual case: the actual is a type declared in a parent unit,
11533 -- but is not a formal type so there is no instance_of for it.
11534 -- Retrieve it by analyzing the record extension.
11536 elsif Is_Child_Unit (Scope (A_Gen_T))
11537 and then In_Open_Scopes (Scope (Act_T))
11538 and then Is_Generic_Instance (Scope (Act_T))
11540 Analyze (Subtype_Mark (Def));
11541 Ancestor := Entity (Subtype_Mark (Def));
11544 Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
11547 -- If the formal derived type has pragma Preelaborable_Initialization
11548 -- then the actual type must have preelaborable initialization.
11550 if Known_To_Have_Preelab_Init (A_Gen_T)
11551 and then not Has_Preelaborable_Initialization (Act_T)
11554 ("actual for & must have preelaborable initialization",
11558 -- Ada 2005 (AI-251)
11560 if Ada_Version >= Ada_2005 and then Is_Interface (Ancestor) then
11561 if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
11563 ("(Ada 2005) expected type implementing & in instantiation",
11567 elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
11569 ("expect type derived from & in instantiation",
11570 Actual, First_Subtype (Ancestor));
11571 Abandon_Instantiation (Actual);
11574 -- Ada 2005 (AI-443): Synchronized formal derived type checks. Note
11575 -- that the formal type declaration has been rewritten as a private
11578 if Ada_Version >= Ada_2005
11579 and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
11580 and then Synchronized_Present (Parent (A_Gen_T))
11582 -- The actual must be a synchronized tagged type
11584 if not Is_Tagged_Type (Act_T) then
11586 ("actual of synchronized type must be tagged", Actual);
11587 Abandon_Instantiation (Actual);
11589 elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
11590 and then Nkind (Type_Definition (Parent (Act_T))) =
11591 N_Derived_Type_Definition
11592 and then not Synchronized_Present (Type_Definition
11596 ("actual of synchronized type must be synchronized", Actual);
11597 Abandon_Instantiation (Actual);
11601 -- Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
11602 -- removes the second instance of the phrase "or allow pass by copy".
11604 if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
11606 ("cannot have atomic actual type for non-atomic formal type",
11609 elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
11611 ("cannot have volatile actual type for non-volatile formal type",
11615 -- It should not be necessary to check for unknown discriminants on
11616 -- Formal, but for some reason Has_Unknown_Discriminants is false for
11617 -- A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
11618 -- needs fixing. ???
11620 if not Is_Indefinite_Subtype (A_Gen_T)
11621 and then not Unknown_Discriminants_Present (Formal)
11622 and then Is_Indefinite_Subtype (Act_T)
11625 ("actual subtype must be constrained", Actual);
11626 Abandon_Instantiation (Actual);
11629 if not Unknown_Discriminants_Present (Formal) then
11630 if Is_Constrained (Ancestor) then
11631 if not Is_Constrained (Act_T) then
11633 ("actual subtype must be constrained", Actual);
11634 Abandon_Instantiation (Actual);
11637 -- Ancestor is unconstrained, Check if generic formal and actual
11638 -- agree on constrainedness. The check only applies to array types
11639 -- and discriminated types.
11641 elsif Is_Constrained (Act_T) then
11642 if Ekind (Ancestor) = E_Access_Type
11643 or else (not Is_Constrained (A_Gen_T)
11644 and then Is_Composite_Type (A_Gen_T))
11646 Error_Msg_N ("actual subtype must be unconstrained", Actual);
11647 Abandon_Instantiation (Actual);
11650 -- A class-wide type is only allowed if the formal has unknown
11653 elsif Is_Class_Wide_Type (Act_T)
11654 and then not Has_Unknown_Discriminants (Ancestor)
11657 ("actual for & cannot be a class-wide type", Actual, Gen_T);
11658 Abandon_Instantiation (Actual);
11660 -- Otherwise, the formal and actual must have the same number
11661 -- of discriminants and each discriminant of the actual must
11662 -- correspond to a discriminant of the formal.
11664 elsif Has_Discriminants (Act_T)
11665 and then not Has_Unknown_Discriminants (Act_T)
11666 and then Has_Discriminants (Ancestor)
11668 Actual_Discr := First_Discriminant (Act_T);
11669 Ancestor_Discr := First_Discriminant (Ancestor);
11670 while Present (Actual_Discr)
11671 and then Present (Ancestor_Discr)
11673 if Base_Type (Act_T) /= Base_Type (Ancestor) and then
11674 No (Corresponding_Discriminant (Actual_Discr))
11677 ("discriminant & does not correspond " &
11678 "to ancestor discriminant", Actual, Actual_Discr);
11679 Abandon_Instantiation (Actual);
11682 Next_Discriminant (Actual_Discr);
11683 Next_Discriminant (Ancestor_Discr);
11686 if Present (Actual_Discr) or else Present (Ancestor_Discr) then
11688 ("actual for & must have same number of discriminants",
11690 Abandon_Instantiation (Actual);
11693 -- This case should be caught by the earlier check for
11694 -- constrainedness, but the check here is added for completeness.
11696 elsif Has_Discriminants (Act_T)
11697 and then not Has_Unknown_Discriminants (Act_T)
11700 ("actual for & must not have discriminants", Actual, Gen_T);
11701 Abandon_Instantiation (Actual);
11703 elsif Has_Discriminants (Ancestor) then
11705 ("actual for & must have known discriminants", Actual, Gen_T);
11706 Abandon_Instantiation (Actual);
11709 if not Subtypes_Statically_Compatible
11710 (Act_T, Ancestor, Formal_Derived_Matching => True)
11713 ("constraint on actual is incompatible with formal", Actual);
11714 Abandon_Instantiation (Actual);
11718 -- If the formal and actual types are abstract, check that there
11719 -- are no abstract primitives of the actual type that correspond to
11720 -- nonabstract primitives of the formal type (second sentence of
11723 if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
11724 Check_Abstract_Primitives : declare
11725 Gen_Prims : constant Elist_Id :=
11726 Primitive_Operations (A_Gen_T);
11727 Gen_Elmt : Elmt_Id;
11728 Gen_Subp : Entity_Id;
11729 Anc_Subp : Entity_Id;
11730 Anc_Formal : Entity_Id;
11731 Anc_F_Type : Entity_Id;
11733 Act_Prims : constant Elist_Id := Primitive_Operations (Act_T);
11734 Act_Elmt : Elmt_Id;
11735 Act_Subp : Entity_Id;
11736 Act_Formal : Entity_Id;
11737 Act_F_Type : Entity_Id;
11739 Subprograms_Correspond : Boolean;
11741 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
11742 -- Returns true if T2 is derived directly or indirectly from
11743 -- T1, including derivations from interfaces. T1 and T2 are
11744 -- required to be specific tagged base types.
11746 ------------------------
11747 -- Is_Tagged_Ancestor --
11748 ------------------------
11750 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
11752 Intfc_Elmt : Elmt_Id;
11755 -- The predicate is satisfied if the types are the same
11760 -- If we've reached the top of the derivation chain then
11761 -- we know that T1 is not an ancestor of T2.
11763 elsif Etype (T2) = T2 then
11766 -- Proceed to check T2's immediate parent
11768 elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
11771 -- Finally, check to see if T1 is an ancestor of any of T2's
11775 Intfc_Elmt := First_Elmt (Interfaces (T2));
11776 while Present (Intfc_Elmt) loop
11777 if Is_Ancestor (T1, Node (Intfc_Elmt)) then
11781 Next_Elmt (Intfc_Elmt);
11786 end Is_Tagged_Ancestor;
11788 -- Start of processing for Check_Abstract_Primitives
11791 -- Loop over all of the formal derived type's primitives
11793 Gen_Elmt := First_Elmt (Gen_Prims);
11794 while Present (Gen_Elmt) loop
11795 Gen_Subp := Node (Gen_Elmt);
11797 -- If the primitive of the formal is not abstract, then
11798 -- determine whether there is a corresponding primitive of
11799 -- the actual type that's abstract.
11801 if not Is_Abstract_Subprogram (Gen_Subp) then
11802 Act_Elmt := First_Elmt (Act_Prims);
11803 while Present (Act_Elmt) loop
11804 Act_Subp := Node (Act_Elmt);
11806 -- If we find an abstract primitive of the actual,
11807 -- then we need to test whether it corresponds to the
11808 -- subprogram from which the generic formal primitive
11811 if Is_Abstract_Subprogram (Act_Subp) then
11812 Anc_Subp := Alias (Gen_Subp);
11814 -- Test whether we have a corresponding primitive
11815 -- by comparing names, kinds, formal types, and
11818 if Chars (Anc_Subp) = Chars (Act_Subp)
11819 and then Ekind (Anc_Subp) = Ekind (Act_Subp)
11821 Anc_Formal := First_Formal (Anc_Subp);
11822 Act_Formal := First_Formal (Act_Subp);
11823 while Present (Anc_Formal)
11824 and then Present (Act_Formal)
11826 Anc_F_Type := Etype (Anc_Formal);
11827 Act_F_Type := Etype (Act_Formal);
11829 if Ekind (Anc_F_Type)
11830 = E_Anonymous_Access_Type
11832 Anc_F_Type := Designated_Type (Anc_F_Type);
11834 if Ekind (Act_F_Type)
11835 = E_Anonymous_Access_Type
11838 Designated_Type (Act_F_Type);
11844 Ekind (Act_F_Type) = E_Anonymous_Access_Type
11849 Anc_F_Type := Base_Type (Anc_F_Type);
11850 Act_F_Type := Base_Type (Act_F_Type);
11852 -- If the formal is controlling, then the
11853 -- the type of the actual primitive's formal
11854 -- must be derived directly or indirectly
11855 -- from the type of the ancestor primitive's
11858 if Is_Controlling_Formal (Anc_Formal) then
11859 if not Is_Tagged_Ancestor
11860 (Anc_F_Type, Act_F_Type)
11865 -- Otherwise the types of the formals must
11868 elsif Anc_F_Type /= Act_F_Type then
11872 Next_Entity (Anc_Formal);
11873 Next_Entity (Act_Formal);
11876 -- If we traversed through all of the formals
11877 -- then so far the subprograms correspond, so
11878 -- now check that any result types correspond.
11880 if No (Anc_Formal) and then No (Act_Formal) then
11881 Subprograms_Correspond := True;
11883 if Ekind (Act_Subp) = E_Function then
11884 Anc_F_Type := Etype (Anc_Subp);
11885 Act_F_Type := Etype (Act_Subp);
11887 if Ekind (Anc_F_Type)
11888 = E_Anonymous_Access_Type
11891 Designated_Type (Anc_F_Type);
11893 if Ekind (Act_F_Type)
11894 = E_Anonymous_Access_Type
11897 Designated_Type (Act_F_Type);
11899 Subprograms_Correspond := False;
11904 = E_Anonymous_Access_Type
11906 Subprograms_Correspond := False;
11909 Anc_F_Type := Base_Type (Anc_F_Type);
11910 Act_F_Type := Base_Type (Act_F_Type);
11912 -- Now either the result types must be
11913 -- the same or, if the result type is
11914 -- controlling, the result type of the
11915 -- actual primitive must descend from the
11916 -- result type of the ancestor primitive.
11918 if Subprograms_Correspond
11919 and then Anc_F_Type /= Act_F_Type
11921 Has_Controlling_Result (Anc_Subp)
11923 not Is_Tagged_Ancestor
11924 (Anc_F_Type, Act_F_Type)
11926 Subprograms_Correspond := False;
11930 -- Found a matching subprogram belonging to
11931 -- formal ancestor type, so actual subprogram
11932 -- corresponds and this violates 3.9.3(9).
11934 if Subprograms_Correspond then
11936 ("abstract subprogram & overrides " &
11937 "nonabstract subprogram of ancestor",
11945 Next_Elmt (Act_Elmt);
11949 Next_Elmt (Gen_Elmt);
11951 end Check_Abstract_Primitives;
11954 -- Verify that limitedness matches. If parent is a limited
11955 -- interface then the generic formal is not unless declared
11956 -- explicitly so. If not declared limited, the actual cannot be
11957 -- limited (see AI05-0087).
11959 -- Even though this AI is a binding interpretation, we enable the
11960 -- check only in Ada 2012 mode, because this improper construct
11961 -- shows up in user code and in existing B-tests.
11963 if Is_Limited_Type (Act_T)
11964 and then not Is_Limited_Type (A_Gen_T)
11965 and then Ada_Version >= Ada_2012
11967 if In_Instance then
11971 ("actual for non-limited & cannot be a limited type", Actual,
11973 Explain_Limited_Type (Act_T, Actual);
11974 Abandon_Instantiation (Actual);
11977 end Validate_Derived_Type_Instance;
11979 ----------------------------------------
11980 -- Validate_Discriminated_Formal_Type --
11981 ----------------------------------------
11983 procedure Validate_Discriminated_Formal_Type is
11984 Formal_Discr : Entity_Id;
11985 Actual_Discr : Entity_Id;
11986 Formal_Subt : Entity_Id;
11989 if Has_Discriminants (A_Gen_T) then
11990 if not Has_Discriminants (Act_T) then
11992 ("actual for & must have discriminants", Actual, Gen_T);
11993 Abandon_Instantiation (Actual);
11995 elsif Is_Constrained (Act_T) then
11997 ("actual for & must be unconstrained", Actual, Gen_T);
11998 Abandon_Instantiation (Actual);
12001 Formal_Discr := First_Discriminant (A_Gen_T);
12002 Actual_Discr := First_Discriminant (Act_T);
12003 while Formal_Discr /= Empty loop
12004 if Actual_Discr = Empty then
12006 ("discriminants on actual do not match formal",
12008 Abandon_Instantiation (Actual);
12011 Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
12013 -- Access discriminants match if designated types do
12015 if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
12016 and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
12017 E_Anonymous_Access_Type
12020 (Designated_Type (Base_Type (Formal_Subt))) =
12021 Designated_Type (Base_Type (Etype (Actual_Discr)))
12025 elsif Base_Type (Formal_Subt) /=
12026 Base_Type (Etype (Actual_Discr))
12029 ("types of actual discriminants must match formal",
12031 Abandon_Instantiation (Actual);
12033 elsif not Subtypes_Statically_Match
12034 (Formal_Subt, Etype (Actual_Discr))
12035 and then Ada_Version >= Ada_95
12038 ("subtypes of actual discriminants must match formal",
12040 Abandon_Instantiation (Actual);
12043 Next_Discriminant (Formal_Discr);
12044 Next_Discriminant (Actual_Discr);
12047 if Actual_Discr /= Empty then
12049 ("discriminants on actual do not match formal",
12051 Abandon_Instantiation (Actual);
12055 end Validate_Discriminated_Formal_Type;
12057 ---------------------------------------
12058 -- Validate_Incomplete_Type_Instance --
12059 ---------------------------------------
12061 procedure Validate_Incomplete_Type_Instance is
12063 if not Is_Tagged_Type (Act_T)
12064 and then Is_Tagged_Type (A_Gen_T)
12067 ("actual for & must be a tagged type", Actual, Gen_T);
12070 Validate_Discriminated_Formal_Type;
12071 end Validate_Incomplete_Type_Instance;
12073 --------------------------------------
12074 -- Validate_Interface_Type_Instance --
12075 --------------------------------------
12077 procedure Validate_Interface_Type_Instance is
12079 if not Is_Interface (Act_T) then
12081 ("actual for formal interface type must be an interface",
12084 elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
12085 or else Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
12086 or else Is_Protected_Interface (A_Gen_T) /=
12087 Is_Protected_Interface (Act_T)
12088 or else Is_Synchronized_Interface (A_Gen_T) /=
12089 Is_Synchronized_Interface (Act_T)
12092 ("actual for interface& does not match (RM 12.5.5(4))",
12095 end Validate_Interface_Type_Instance;
12097 ------------------------------------
12098 -- Validate_Private_Type_Instance --
12099 ------------------------------------
12101 procedure Validate_Private_Type_Instance is
12103 if Is_Limited_Type (Act_T)
12104 and then not Is_Limited_Type (A_Gen_T)
12106 if In_Instance then
12110 ("actual for non-limited & cannot be a limited type", Actual,
12112 Explain_Limited_Type (Act_T, Actual);
12113 Abandon_Instantiation (Actual);
12116 elsif Known_To_Have_Preelab_Init (A_Gen_T)
12117 and then not Has_Preelaborable_Initialization (Act_T)
12120 ("actual for & must have preelaborable initialization", Actual,
12123 elsif Is_Indefinite_Subtype (Act_T)
12124 and then not Is_Indefinite_Subtype (A_Gen_T)
12125 and then Ada_Version >= Ada_95
12128 ("actual for & must be a definite subtype", Actual, Gen_T);
12130 elsif not Is_Tagged_Type (Act_T)
12131 and then Is_Tagged_Type (A_Gen_T)
12134 ("actual for & must be a tagged type", Actual, Gen_T);
12137 Validate_Discriminated_Formal_Type;
12139 end Validate_Private_Type_Instance;
12141 -- Start of processing for Instantiate_Type
12144 if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
12145 Error_Msg_N ("duplicate instantiation of generic type", Actual);
12146 return New_List (Error);
12148 elsif not Is_Entity_Name (Actual)
12149 or else not Is_Type (Entity (Actual))
12152 ("expect valid subtype mark to instantiate &", Actual, Gen_T);
12153 Abandon_Instantiation (Actual);
12156 Act_T := Entity (Actual);
12158 -- Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
12159 -- as a generic actual parameter if the corresponding formal type
12160 -- does not have a known_discriminant_part, or is a formal derived
12161 -- type that is an Unchecked_Union type.
12163 if Is_Unchecked_Union (Base_Type (Act_T)) then
12164 if not Has_Discriminants (A_Gen_T)
12165 or else (Is_Derived_Type (A_Gen_T)
12166 and then Is_Unchecked_Union (A_Gen_T))
12170 Error_Msg_N ("unchecked union cannot be the actual for a "
12171 & "discriminated formal type", Act_T);
12176 -- Deal with fixed/floating restrictions
12178 if Is_Floating_Point_Type (Act_T) then
12179 Check_Restriction (No_Floating_Point, Actual);
12180 elsif Is_Fixed_Point_Type (Act_T) then
12181 Check_Restriction (No_Fixed_Point, Actual);
12184 -- Deal with error of using incomplete type as generic actual.
12185 -- This includes limited views of a type, even if the non-limited
12186 -- view may be available.
12188 if Ekind (Act_T) = E_Incomplete_Type
12189 or else (Is_Class_Wide_Type (Act_T)
12190 and then Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
12192 -- If the formal is an incomplete type, the actual can be
12193 -- incomplete as well.
12195 if Ekind (A_Gen_T) = E_Incomplete_Type then
12198 elsif Is_Class_Wide_Type (Act_T)
12199 or else No (Full_View (Act_T))
12201 Error_Msg_N ("premature use of incomplete type", Actual);
12202 Abandon_Instantiation (Actual);
12204 Act_T := Full_View (Act_T);
12205 Set_Entity (Actual, Act_T);
12207 if Has_Private_Component (Act_T) then
12209 ("premature use of type with private component", Actual);
12213 -- Deal with error of premature use of private type as generic actual
12215 elsif Is_Private_Type (Act_T)
12216 and then Is_Private_Type (Base_Type (Act_T))
12217 and then not Is_Generic_Type (Act_T)
12218 and then not Is_Derived_Type (Act_T)
12219 and then No (Full_View (Root_Type (Act_T)))
12221 -- If the formal is an incomplete type, the actual can be
12222 -- private or incomplete as well.
12224 if Ekind (A_Gen_T) = E_Incomplete_Type then
12227 Error_Msg_N ("premature use of private type", Actual);
12230 elsif Has_Private_Component (Act_T) then
12232 ("premature use of type with private component", Actual);
12235 Set_Instance_Of (A_Gen_T, Act_T);
12237 -- If the type is generic, the class-wide type may also be used
12239 if Is_Tagged_Type (A_Gen_T)
12240 and then Is_Tagged_Type (Act_T)
12241 and then not Is_Class_Wide_Type (A_Gen_T)
12243 Set_Instance_Of (Class_Wide_Type (A_Gen_T),
12244 Class_Wide_Type (Act_T));
12247 if not Is_Abstract_Type (A_Gen_T)
12248 and then Is_Abstract_Type (Act_T)
12251 ("actual of non-abstract formal cannot be abstract", Actual);
12254 -- A generic scalar type is a first subtype for which we generate
12255 -- an anonymous base type. Indicate that the instance of this base
12256 -- is the base type of the actual.
12258 if Is_Scalar_Type (A_Gen_T) then
12259 Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
12263 if Error_Posted (Act_T) then
12266 case Nkind (Def) is
12267 when N_Formal_Private_Type_Definition =>
12268 Validate_Private_Type_Instance;
12270 when N_Formal_Incomplete_Type_Definition =>
12271 Validate_Incomplete_Type_Instance;
12273 when N_Formal_Derived_Type_Definition =>
12274 Validate_Derived_Type_Instance;
12276 when N_Formal_Discrete_Type_Definition =>
12277 if not Is_Discrete_Type (Act_T) then
12279 ("expect discrete type in instantiation of&",
12281 Abandon_Instantiation (Actual);
12284 Diagnose_Predicated_Actual;
12286 when N_Formal_Signed_Integer_Type_Definition =>
12287 if not Is_Signed_Integer_Type (Act_T) then
12289 ("expect signed integer type in instantiation of&",
12291 Abandon_Instantiation (Actual);
12294 Diagnose_Predicated_Actual;
12296 when N_Formal_Modular_Type_Definition =>
12297 if not Is_Modular_Integer_Type (Act_T) then
12299 ("expect modular type in instantiation of &",
12301 Abandon_Instantiation (Actual);
12304 Diagnose_Predicated_Actual;
12306 when N_Formal_Floating_Point_Definition =>
12307 if not Is_Floating_Point_Type (Act_T) then
12309 ("expect float type in instantiation of &", Actual, Gen_T);
12310 Abandon_Instantiation (Actual);
12313 when N_Formal_Ordinary_Fixed_Point_Definition =>
12314 if not Is_Ordinary_Fixed_Point_Type (Act_T) then
12316 ("expect ordinary fixed point type in instantiation of &",
12318 Abandon_Instantiation (Actual);
12321 when N_Formal_Decimal_Fixed_Point_Definition =>
12322 if not Is_Decimal_Fixed_Point_Type (Act_T) then
12324 ("expect decimal type in instantiation of &",
12326 Abandon_Instantiation (Actual);
12329 when N_Array_Type_Definition =>
12330 Validate_Array_Type_Instance;
12332 when N_Access_To_Object_Definition =>
12333 Validate_Access_Type_Instance;
12335 when N_Access_Function_Definition |
12336 N_Access_Procedure_Definition =>
12337 Validate_Access_Subprogram_Instance;
12339 when N_Record_Definition =>
12340 Validate_Interface_Type_Instance;
12342 when N_Derived_Type_Definition =>
12343 Validate_Derived_Interface_Type_Instance;
12346 raise Program_Error;
12351 Subt := New_Copy (Gen_T);
12353 -- Use adjusted sloc of subtype name as the location for other nodes in
12354 -- the subtype declaration.
12356 Loc := Sloc (Subt);
12359 Make_Subtype_Declaration (Loc,
12360 Defining_Identifier => Subt,
12361 Subtype_Indication => New_Occurrence_Of (Act_T, Loc));
12363 if Is_Private_Type (Act_T) then
12364 Set_Has_Private_View (Subtype_Indication (Decl_Node));
12366 elsif Is_Access_Type (Act_T)
12367 and then Is_Private_Type (Designated_Type (Act_T))
12369 Set_Has_Private_View (Subtype_Indication (Decl_Node));
12372 Decl_Nodes := New_List (Decl_Node);
12374 -- Flag actual derived types so their elaboration produces the
12375 -- appropriate renamings for the primitive operations of the ancestor.
12376 -- Flag actual for formal private types as well, to determine whether
12377 -- operations in the private part may override inherited operations.
12378 -- If the formal has an interface list, the ancestor is not the
12379 -- parent, but the analyzed formal that includes the interface
12380 -- operations of all its progenitors.
12382 -- Same treatment for formal private types, so we can check whether the
12383 -- type is tagged limited when validating derivations in the private
12384 -- part. (See AI05-096).
12386 if Nkind (Def) = N_Formal_Derived_Type_Definition then
12387 if Present (Interface_List (Def)) then
12388 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
12390 Set_Generic_Parent_Type (Decl_Node, Ancestor);
12393 elsif Nkind_In (Def,
12394 N_Formal_Private_Type_Definition,
12395 N_Formal_Incomplete_Type_Definition)
12397 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
12400 -- If the actual is a synchronized type that implements an interface,
12401 -- the primitive operations are attached to the corresponding record,
12402 -- and we have to treat it as an additional generic actual, so that its
12403 -- primitive operations become visible in the instance. The task or
12404 -- protected type itself does not carry primitive operations.
12406 if Is_Concurrent_Type (Act_T)
12407 and then Is_Tagged_Type (Act_T)
12408 and then Present (Corresponding_Record_Type (Act_T))
12409 and then Present (Ancestor)
12410 and then Is_Interface (Ancestor)
12413 Corr_Rec : constant Entity_Id :=
12414 Corresponding_Record_Type (Act_T);
12415 New_Corr : Entity_Id;
12416 Corr_Decl : Node_Id;
12419 New_Corr := Make_Temporary (Loc, 'S');
12421 Make_Subtype_Declaration (Loc,
12422 Defining_Identifier => New_Corr,
12423 Subtype_Indication =>
12424 New_Occurrence_Of (Corr_Rec, Loc));
12425 Append_To (Decl_Nodes, Corr_Decl);
12427 if Ekind (Act_T) = E_Task_Type then
12428 Set_Ekind (Subt, E_Task_Subtype);
12430 Set_Ekind (Subt, E_Protected_Subtype);
12433 Set_Corresponding_Record_Type (Subt, Corr_Rec);
12434 Set_Generic_Parent_Type (Corr_Decl, Ancestor);
12435 Set_Generic_Parent_Type (Decl_Node, Empty);
12440 end Instantiate_Type;
12442 ---------------------
12443 -- Is_In_Main_Unit --
12444 ---------------------
12446 function Is_In_Main_Unit (N : Node_Id) return Boolean is
12447 Unum : constant Unit_Number_Type := Get_Source_Unit (N);
12448 Current_Unit : Node_Id;
12451 if Unum = Main_Unit then
12454 -- If the current unit is a subunit then it is either the main unit or
12455 -- is being compiled as part of the main unit.
12457 elsif Nkind (N) = N_Compilation_Unit then
12458 return Nkind (Unit (N)) = N_Subunit;
12461 Current_Unit := Parent (N);
12462 while Present (Current_Unit)
12463 and then Nkind (Current_Unit) /= N_Compilation_Unit
12465 Current_Unit := Parent (Current_Unit);
12468 -- The instantiation node is in the main unit, or else the current node
12469 -- (perhaps as the result of nested instantiations) is in the main unit,
12470 -- or in the declaration of the main unit, which in this last case must
12473 return Unum = Main_Unit
12474 or else Current_Unit = Cunit (Main_Unit)
12475 or else Current_Unit = Library_Unit (Cunit (Main_Unit))
12476 or else (Present (Library_Unit (Current_Unit))
12477 and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
12478 end Is_In_Main_Unit;
12480 ----------------------------
12481 -- Load_Parent_Of_Generic --
12482 ----------------------------
12484 procedure Load_Parent_Of_Generic
12487 Body_Optional : Boolean := False)
12489 Comp_Unit : constant Node_Id := Cunit (Get_Source_Unit (Spec));
12490 Saved_Style_Check : constant Boolean := Style_Check;
12491 Saved_Warnings : constant Warning_Record := Save_Warnings;
12492 True_Parent : Node_Id;
12493 Inst_Node : Node_Id;
12495 Previous_Instances : constant Elist_Id := New_Elmt_List;
12497 procedure Collect_Previous_Instances (Decls : List_Id);
12498 -- Collect all instantiations in the given list of declarations, that
12499 -- precede the generic that we need to load. If the bodies of these
12500 -- instantiations are available, we must analyze them, to ensure that
12501 -- the public symbols generated are the same when the unit is compiled
12502 -- to generate code, and when it is compiled in the context of a unit
12503 -- that needs a particular nested instance. This process is applied to
12504 -- both package and subprogram instances.
12506 --------------------------------
12507 -- Collect_Previous_Instances --
12508 --------------------------------
12510 procedure Collect_Previous_Instances (Decls : List_Id) is
12514 Decl := First (Decls);
12515 while Present (Decl) loop
12516 if Sloc (Decl) >= Sloc (Inst_Node) then
12519 -- If Decl is an instantiation, then record it as requiring
12520 -- instantiation of the corresponding body, except if it is an
12521 -- abbreviated instantiation generated internally for conformance
12522 -- checking purposes only for the case of a formal package
12523 -- declared without a box (see Instantiate_Formal_Package). Such
12524 -- an instantiation does not generate any code (the actual code
12525 -- comes from actual) and thus does not need to be analyzed here.
12526 -- If the instantiation appears with a generic package body it is
12527 -- not analyzed here either.
12529 elsif Nkind (Decl) = N_Package_Instantiation
12530 and then not Is_Internal (Defining_Entity (Decl))
12532 Append_Elmt (Decl, Previous_Instances);
12534 -- For a subprogram instantiation, omit instantiations intrinsic
12535 -- operations (Unchecked_Conversions, etc.) that have no bodies.
12537 elsif Nkind_In (Decl, N_Function_Instantiation,
12538 N_Procedure_Instantiation)
12539 and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
12541 Append_Elmt (Decl, Previous_Instances);
12543 elsif Nkind (Decl) = N_Package_Declaration then
12544 Collect_Previous_Instances
12545 (Visible_Declarations (Specification (Decl)));
12546 Collect_Previous_Instances
12547 (Private_Declarations (Specification (Decl)));
12549 -- Previous non-generic bodies may contain instances as well
12551 elsif Nkind (Decl) = N_Package_Body
12552 and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
12554 Collect_Previous_Instances (Declarations (Decl));
12556 elsif Nkind (Decl) = N_Subprogram_Body
12557 and then not Acts_As_Spec (Decl)
12558 and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
12560 Collect_Previous_Instances (Declarations (Decl));
12565 end Collect_Previous_Instances;
12567 -- Start of processing for Load_Parent_Of_Generic
12570 if not In_Same_Source_Unit (N, Spec)
12571 or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
12572 or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
12573 and then not Is_In_Main_Unit (Spec))
12575 -- Find body of parent of spec, and analyze it. A special case arises
12576 -- when the parent is an instantiation, that is to say when we are
12577 -- currently instantiating a nested generic. In that case, there is
12578 -- no separate file for the body of the enclosing instance. Instead,
12579 -- the enclosing body must be instantiated as if it were a pending
12580 -- instantiation, in order to produce the body for the nested generic
12581 -- we require now. Note that in that case the generic may be defined
12582 -- in a package body, the instance defined in the same package body,
12583 -- and the original enclosing body may not be in the main unit.
12585 Inst_Node := Empty;
12587 True_Parent := Parent (Spec);
12588 while Present (True_Parent)
12589 and then Nkind (True_Parent) /= N_Compilation_Unit
12591 if Nkind (True_Parent) = N_Package_Declaration
12593 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
12595 -- Parent is a compilation unit that is an instantiation.
12596 -- Instantiation node has been replaced with package decl.
12598 Inst_Node := Original_Node (True_Parent);
12601 elsif Nkind (True_Parent) = N_Package_Declaration
12602 and then Present (Generic_Parent (Specification (True_Parent)))
12603 and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12605 -- Parent is an instantiation within another specification.
12606 -- Declaration for instance has been inserted before original
12607 -- instantiation node. A direct link would be preferable?
12609 Inst_Node := Next (True_Parent);
12610 while Present (Inst_Node)
12611 and then Nkind (Inst_Node) /= N_Package_Instantiation
12616 -- If the instance appears within a generic, and the generic
12617 -- unit is defined within a formal package of the enclosing
12618 -- generic, there is no generic body available, and none
12619 -- needed. A more precise test should be used ???
12621 if No (Inst_Node) then
12628 True_Parent := Parent (True_Parent);
12632 -- Case where we are currently instantiating a nested generic
12634 if Present (Inst_Node) then
12635 if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
12637 -- Instantiation node and declaration of instantiated package
12638 -- were exchanged when only the declaration was needed.
12639 -- Restore instantiation node before proceeding with body.
12641 Set_Unit (Parent (True_Parent), Inst_Node);
12644 -- Now complete instantiation of enclosing body, if it appears in
12645 -- some other unit. If it appears in the current unit, the body
12646 -- will have been instantiated already.
12648 if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
12650 -- We need to determine the expander mode to instantiate the
12651 -- enclosing body. Because the generic body we need may use
12652 -- global entities declared in the enclosing package (including
12653 -- aggregates) it is in general necessary to compile this body
12654 -- with expansion enabled, except if we are within a generic
12655 -- package, in which case the usual generic rule applies.
12658 Exp_Status : Boolean := True;
12662 -- Loop through scopes looking for generic package
12664 Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
12665 while Present (Scop)
12666 and then Scop /= Standard_Standard
12668 if Ekind (Scop) = E_Generic_Package then
12669 Exp_Status := False;
12673 Scop := Scope (Scop);
12676 -- Collect previous instantiations in the unit that contains
12677 -- the desired generic.
12679 if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12680 and then not Body_Optional
12684 Info : Pending_Body_Info;
12688 Par := Parent (Inst_Node);
12689 while Present (Par) loop
12690 exit when Nkind (Parent (Par)) = N_Compilation_Unit;
12691 Par := Parent (Par);
12694 pragma Assert (Present (Par));
12696 if Nkind (Par) = N_Package_Body then
12697 Collect_Previous_Instances (Declarations (Par));
12699 elsif Nkind (Par) = N_Package_Declaration then
12700 Collect_Previous_Instances
12701 (Visible_Declarations (Specification (Par)));
12702 Collect_Previous_Instances
12703 (Private_Declarations (Specification (Par)));
12706 -- Enclosing unit is a subprogram body. In this
12707 -- case all instance bodies are processed in order
12708 -- and there is no need to collect them separately.
12713 Decl := First_Elmt (Previous_Instances);
12714 while Present (Decl) loop
12716 (Inst_Node => Node (Decl),
12718 Instance_Spec (Node (Decl)),
12719 Expander_Status => Exp_Status,
12720 Current_Sem_Unit =>
12721 Get_Code_Unit (Sloc (Node (Decl))),
12722 Scope_Suppress => Scope_Suppress,
12723 Local_Suppress_Stack_Top =>
12724 Local_Suppress_Stack_Top,
12725 Version => Ada_Version,
12726 Version_Pragma => Ada_Version_Pragma,
12727 Warnings => Save_Warnings,
12728 SPARK_Mode => SPARK_Mode,
12729 SPARK_Mode_Pragma => SPARK_Mode_Pragma);
12731 -- Package instance
12734 Nkind (Node (Decl)) = N_Package_Instantiation
12736 Instantiate_Package_Body
12737 (Info, Body_Optional => True);
12739 -- Subprogram instance
12742 -- The instance_spec is the wrapper package,
12743 -- and the subprogram declaration is the last
12744 -- declaration in the wrapper.
12748 (Visible_Declarations
12749 (Specification (Info.Act_Decl)));
12751 Instantiate_Subprogram_Body
12752 (Info, Body_Optional => True);
12760 Instantiate_Package_Body
12762 ((Inst_Node => Inst_Node,
12763 Act_Decl => True_Parent,
12764 Expander_Status => Exp_Status,
12765 Current_Sem_Unit => Get_Code_Unit
12766 (Sloc (Inst_Node)),
12767 Scope_Suppress => Scope_Suppress,
12768 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
12769 Version => Ada_Version,
12770 Version_Pragma => Ada_Version_Pragma,
12771 Warnings => Save_Warnings,
12772 SPARK_Mode => SPARK_Mode,
12773 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
12774 Body_Optional => Body_Optional);
12778 -- Case where we are not instantiating a nested generic
12781 Opt.Style_Check := False;
12782 Expander_Mode_Save_And_Set (True);
12783 Load_Needed_Body (Comp_Unit, OK);
12784 Opt.Style_Check := Saved_Style_Check;
12785 Restore_Warnings (Saved_Warnings);
12786 Expander_Mode_Restore;
12789 and then Unit_Requires_Body (Defining_Entity (Spec))
12790 and then not Body_Optional
12793 Bname : constant Unit_Name_Type :=
12794 Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
12797 -- In CodePeer mode, the missing body may make the analysis
12798 -- incomplete, but we do not treat it as fatal.
12800 if CodePeer_Mode then
12804 Error_Msg_Unit_1 := Bname;
12805 Error_Msg_N ("this instantiation requires$!", N);
12806 Error_Msg_File_1 :=
12807 Get_File_Name (Bname, Subunit => False);
12808 Error_Msg_N ("\but file{ was not found!", N);
12809 raise Unrecoverable_Error;
12816 -- If loading parent of the generic caused an instantiation circularity,
12817 -- we abandon compilation at this point, because otherwise in some cases
12818 -- we get into trouble with infinite recursions after this point.
12820 if Circularity_Detected then
12821 raise Unrecoverable_Error;
12823 end Load_Parent_Of_Generic;
12825 ---------------------------------
12826 -- Map_Formal_Package_Entities --
12827 ---------------------------------
12829 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
12834 Set_Instance_Of (Form, Act);
12836 -- Traverse formal and actual package to map the corresponding entities.
12837 -- We skip over internal entities that may be generated during semantic
12838 -- analysis, and find the matching entities by name, given that they
12839 -- must appear in the same order.
12841 E1 := First_Entity (Form);
12842 E2 := First_Entity (Act);
12843 while Present (E1) and then E1 /= First_Private_Entity (Form) loop
12844 -- Could this test be a single condition??? Seems like it could, and
12845 -- isn't FPE (Form) a constant anyway???
12847 if not Is_Internal (E1)
12848 and then Present (Parent (E1))
12849 and then not Is_Class_Wide_Type (E1)
12850 and then not Is_Internal_Name (Chars (E1))
12852 while Present (E2) and then Chars (E2) /= Chars (E1) loop
12859 Set_Instance_Of (E1, E2);
12861 if Is_Type (E1) and then Is_Tagged_Type (E2) then
12862 Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
12865 if Is_Constrained (E1) then
12866 Set_Instance_Of (Base_Type (E1), Base_Type (E2));
12869 if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
12870 Map_Formal_Package_Entities (E1, E2);
12877 end Map_Formal_Package_Entities;
12879 -----------------------
12880 -- Move_Freeze_Nodes --
12881 -----------------------
12883 procedure Move_Freeze_Nodes
12884 (Out_Of : Entity_Id;
12889 Next_Decl : Node_Id;
12890 Next_Node : Node_Id := After;
12893 function Is_Outer_Type (T : Entity_Id) return Boolean;
12894 -- Check whether entity is declared in a scope external to that of the
12897 -------------------
12898 -- Is_Outer_Type --
12899 -------------------
12901 function Is_Outer_Type (T : Entity_Id) return Boolean is
12902 Scop : Entity_Id := Scope (T);
12905 if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12909 while Scop /= Standard_Standard loop
12910 if Scop = Out_Of then
12913 Scop := Scope (Scop);
12921 -- Start of processing for Move_Freeze_Nodes
12928 -- First remove the freeze nodes that may appear before all other
12932 while Present (Decl)
12933 and then Nkind (Decl) = N_Freeze_Entity
12934 and then Is_Outer_Type (Entity (Decl))
12936 Decl := Remove_Head (L);
12937 Insert_After (Next_Node, Decl);
12938 Set_Analyzed (Decl, False);
12943 -- Next scan the list of declarations and remove each freeze node that
12944 -- appears ahead of the current node.
12946 while Present (Decl) loop
12947 while Present (Next (Decl))
12948 and then Nkind (Next (Decl)) = N_Freeze_Entity
12949 and then Is_Outer_Type (Entity (Next (Decl)))
12951 Next_Decl := Remove_Next (Decl);
12952 Insert_After (Next_Node, Next_Decl);
12953 Set_Analyzed (Next_Decl, False);
12954 Next_Node := Next_Decl;
12957 -- If the declaration is a nested package or concurrent type, then
12958 -- recurse. Nested generic packages will have been processed from the
12961 case Nkind (Decl) is
12962 when N_Package_Declaration =>
12963 Spec := Specification (Decl);
12965 when N_Task_Type_Declaration =>
12966 Spec := Task_Definition (Decl);
12968 when N_Protected_Type_Declaration =>
12969 Spec := Protected_Definition (Decl);
12975 if Present (Spec) then
12976 Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
12977 Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
12982 end Move_Freeze_Nodes;
12988 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
12990 return Generic_Renamings.Table (E).Next_In_HTable;
12993 ------------------------
12994 -- Preanalyze_Actuals --
12995 ------------------------
12997 procedure Preanalyze_Actuals (N : Node_Id) is
13000 Errs : constant Int := Serious_Errors_Detected;
13002 Cur : Entity_Id := Empty;
13003 -- Current homograph of the instance name
13006 -- Saved visibility status of the current homograph
13009 Assoc := First (Generic_Associations (N));
13011 -- If the instance is a child unit, its name may hide an outer homonym,
13012 -- so make it invisible to perform name resolution on the actuals.
13014 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
13016 (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
13018 Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
13020 if Is_Compilation_Unit (Cur) then
13021 Vis := Is_Immediately_Visible (Cur);
13022 Set_Is_Immediately_Visible (Cur, False);
13028 while Present (Assoc) loop
13029 if Nkind (Assoc) /= N_Others_Choice then
13030 Act := Explicit_Generic_Actual_Parameter (Assoc);
13032 -- Within a nested instantiation, a defaulted actual is an empty
13033 -- association, so nothing to analyze. If the subprogram actual
13034 -- is an attribute, analyze prefix only, because actual is not a
13035 -- complete attribute reference.
13037 -- If actual is an allocator, analyze expression only. The full
13038 -- analysis can generate code, and if instance is a compilation
13039 -- unit we have to wait until the package instance is installed
13040 -- to have a proper place to insert this code.
13042 -- String literals may be operators, but at this point we do not
13043 -- know whether the actual is a formal subprogram or a string.
13048 elsif Nkind (Act) = N_Attribute_Reference then
13049 Analyze (Prefix (Act));
13051 elsif Nkind (Act) = N_Explicit_Dereference then
13052 Analyze (Prefix (Act));
13054 elsif Nkind (Act) = N_Allocator then
13056 Expr : constant Node_Id := Expression (Act);
13059 if Nkind (Expr) = N_Subtype_Indication then
13060 Analyze (Subtype_Mark (Expr));
13062 -- Analyze separately each discriminant constraint, when
13063 -- given with a named association.
13069 Constr := First (Constraints (Constraint (Expr)));
13070 while Present (Constr) loop
13071 if Nkind (Constr) = N_Discriminant_Association then
13072 Analyze (Expression (Constr));
13086 elsif Nkind (Act) /= N_Operator_Symbol then
13090 if Errs /= Serious_Errors_Detected then
13092 -- Do a minimal analysis of the generic, to prevent spurious
13093 -- warnings complaining about the generic being unreferenced,
13094 -- before abandoning the instantiation.
13096 Analyze (Name (N));
13098 if Is_Entity_Name (Name (N))
13099 and then Etype (Name (N)) /= Any_Type
13101 Generate_Reference (Entity (Name (N)), Name (N));
13102 Set_Is_Instantiated (Entity (Name (N)));
13105 if Present (Cur) then
13107 -- For the case of a child instance hiding an outer homonym,
13108 -- provide additional warning which might explain the error.
13110 Set_Is_Immediately_Visible (Cur, Vis);
13111 Error_Msg_NE ("& hides outer unit with the same name??",
13112 N, Defining_Unit_Name (N));
13115 Abandon_Instantiation (Act);
13122 if Present (Cur) then
13123 Set_Is_Immediately_Visible (Cur, Vis);
13125 end Preanalyze_Actuals;
13127 -------------------
13128 -- Remove_Parent --
13129 -------------------
13131 procedure Remove_Parent (In_Body : Boolean := False) is
13132 S : Entity_Id := Current_Scope;
13133 -- S is the scope containing the instantiation just completed. The scope
13134 -- stack contains the parent instances of the instantiation, followed by
13143 -- After child instantiation is complete, remove from scope stack the
13144 -- extra copy of the current scope, and then remove parent instances.
13146 if not In_Body then
13149 while Current_Scope /= S loop
13150 P := Current_Scope;
13151 End_Package_Scope (Current_Scope);
13153 if In_Open_Scopes (P) then
13154 E := First_Entity (P);
13155 while Present (E) loop
13156 Set_Is_Immediately_Visible (E, True);
13160 -- If instantiation is declared in a block, it is the enclosing
13161 -- scope that might be a parent instance. Note that only one
13162 -- block can be involved, because the parent instances have
13163 -- been installed within it.
13165 if Ekind (P) = E_Block then
13166 Cur_P := Scope (P);
13171 if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
13172 -- We are within an instance of some sibling. Retain
13173 -- visibility of parent, for proper subsequent cleanup, and
13174 -- reinstall private declarations as well.
13176 Set_In_Private_Part (P);
13177 Install_Private_Declarations (P);
13180 -- If the ultimate parent is a top-level unit recorded in
13181 -- Instance_Parent_Unit, then reset its visibility to what it was
13182 -- before instantiation. (It's not clear what the purpose is of
13183 -- testing whether Scope (P) is In_Open_Scopes, but that test was
13184 -- present before the ultimate parent test was added.???)
13186 elsif not In_Open_Scopes (Scope (P))
13187 or else (P = Instance_Parent_Unit
13188 and then not Parent_Unit_Visible)
13190 Set_Is_Immediately_Visible (P, False);
13192 -- If the current scope is itself an instantiation of a generic
13193 -- nested within P, and we are in the private part of body of this
13194 -- instantiation, restore the full views of P, that were removed
13195 -- in End_Package_Scope above. This obscure case can occur when a
13196 -- subunit of a generic contains an instance of a child unit of
13197 -- its generic parent unit.
13199 elsif S = Current_Scope and then Is_Generic_Instance (S) then
13201 Par : constant Entity_Id :=
13202 Generic_Parent (Package_Specification (S));
13205 and then P = Scope (Par)
13206 and then (In_Package_Body (S) or else In_Private_Part (S))
13208 Set_In_Private_Part (P);
13209 Install_Private_Declarations (P);
13215 -- Reset visibility of entities in the enclosing scope
13217 Set_Is_Hidden_Open_Scope (Current_Scope, False);
13219 Hidden := First_Elmt (Hidden_Entities);
13220 while Present (Hidden) loop
13221 Set_Is_Immediately_Visible (Node (Hidden), True);
13222 Next_Elmt (Hidden);
13226 -- Each body is analyzed separately, and there is no context that
13227 -- needs preserving from one body instance to the next, so remove all
13228 -- parent scopes that have been installed.
13230 while Present (S) loop
13231 End_Package_Scope (S);
13232 Set_Is_Immediately_Visible (S, False);
13233 S := Current_Scope;
13234 exit when S = Standard_Standard;
13243 procedure Restore_Env is
13244 Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
13247 if No (Current_Instantiated_Parent.Act_Id) then
13248 -- Restore environment after subprogram inlining
13250 Restore_Private_Views (Empty);
13253 Current_Instantiated_Parent := Saved.Instantiated_Parent;
13254 Exchanged_Views := Saved.Exchanged_Views;
13255 Hidden_Entities := Saved.Hidden_Entities;
13256 Current_Sem_Unit := Saved.Current_Sem_Unit;
13257 Parent_Unit_Visible := Saved.Parent_Unit_Visible;
13258 Instance_Parent_Unit := Saved.Instance_Parent_Unit;
13260 Restore_Opt_Config_Switches (Saved.Switches);
13262 Instance_Envs.Decrement_Last;
13265 ---------------------------
13266 -- Restore_Private_Views --
13267 ---------------------------
13269 procedure Restore_Private_Views
13270 (Pack_Id : Entity_Id;
13271 Is_Package : Boolean := True)
13276 Dep_Elmt : Elmt_Id;
13279 procedure Restore_Nested_Formal (Formal : Entity_Id);
13280 -- Hide the generic formals of formal packages declared with box which
13281 -- were reachable in the current instantiation.
13283 ---------------------------
13284 -- Restore_Nested_Formal --
13285 ---------------------------
13287 procedure Restore_Nested_Formal (Formal : Entity_Id) is
13291 if Present (Renamed_Object (Formal))
13292 and then Denotes_Formal_Package (Renamed_Object (Formal), True)
13296 elsif Present (Associated_Formal_Package (Formal)) then
13297 Ent := First_Entity (Formal);
13298 while Present (Ent) loop
13299 exit when Ekind (Ent) = E_Package
13300 and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
13302 Set_Is_Hidden (Ent);
13303 Set_Is_Potentially_Use_Visible (Ent, False);
13305 -- If package, then recurse
13307 if Ekind (Ent) = E_Package then
13308 Restore_Nested_Formal (Ent);
13314 end Restore_Nested_Formal;
13316 -- Start of processing for Restore_Private_Views
13319 M := First_Elmt (Exchanged_Views);
13320 while Present (M) loop
13323 -- Subtypes of types whose views have been exchanged, and that are
13324 -- defined within the instance, were not on the Private_Dependents
13325 -- list on entry to the instance, so they have to be exchanged
13326 -- explicitly now, in order to remain consistent with the view of the
13329 if Ekind_In (Typ, E_Private_Type,
13330 E_Limited_Private_Type,
13331 E_Record_Type_With_Private)
13333 Dep_Elmt := First_Elmt (Private_Dependents (Typ));
13334 while Present (Dep_Elmt) loop
13335 Dep_Typ := Node (Dep_Elmt);
13337 if Scope (Dep_Typ) = Pack_Id
13338 and then Present (Full_View (Dep_Typ))
13340 Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
13341 Exchange_Declarations (Dep_Typ);
13344 Next_Elmt (Dep_Elmt);
13348 Exchange_Declarations (Node (M));
13352 if No (Pack_Id) then
13356 -- Make the generic formal parameters private, and make the formal types
13357 -- into subtypes of the actuals again.
13359 E := First_Entity (Pack_Id);
13360 while Present (E) loop
13361 Set_Is_Hidden (E, True);
13364 and then Nkind (Parent (E)) = N_Subtype_Declaration
13366 -- If the actual for E is itself a generic actual type from
13367 -- an enclosing instance, E is still a generic actual type
13368 -- outside of the current instance. This matter when resolving
13369 -- an overloaded call that may be ambiguous in the enclosing
13370 -- instance, when two of its actuals coincide.
13372 if Is_Entity_Name (Subtype_Indication (Parent (E)))
13373 and then Is_Generic_Actual_Type
13374 (Entity (Subtype_Indication (Parent (E))))
13378 Set_Is_Generic_Actual_Type (E, False);
13381 -- An unusual case of aliasing: the actual may also be directly
13382 -- visible in the generic, and be private there, while it is fully
13383 -- visible in the context of the instance. The internal subtype
13384 -- is private in the instance but has full visibility like its
13385 -- parent in the enclosing scope. This enforces the invariant that
13386 -- the privacy status of all private dependents of a type coincide
13387 -- with that of the parent type. This can only happen when a
13388 -- generic child unit is instantiated within a sibling.
13390 if Is_Private_Type (E)
13391 and then not Is_Private_Type (Etype (E))
13393 Exchange_Declarations (E);
13396 elsif Ekind (E) = E_Package then
13398 -- The end of the renaming list is the renaming of the generic
13399 -- package itself. If the instance is a subprogram, all entities
13400 -- in the corresponding package are renamings. If this entity is
13401 -- a formal package, make its own formals private as well. The
13402 -- actual in this case is itself the renaming of an instantiation.
13403 -- If the entity is not a package renaming, it is the entity
13404 -- created to validate formal package actuals: ignore it.
13406 -- If the actual is itself a formal package for the enclosing
13407 -- generic, or the actual for such a formal package, it remains
13408 -- visible on exit from the instance, and therefore nothing needs
13409 -- to be done either, except to keep it accessible.
13411 if Is_Package and then Renamed_Object (E) = Pack_Id then
13414 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
13418 Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
13420 Set_Is_Hidden (E, False);
13424 Act_P : constant Entity_Id := Renamed_Object (E);
13428 Id := First_Entity (Act_P);
13430 and then Id /= First_Private_Entity (Act_P)
13432 exit when Ekind (Id) = E_Package
13433 and then Renamed_Object (Id) = Act_P;
13435 Set_Is_Hidden (Id, True);
13436 Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
13438 if Ekind (Id) = E_Package then
13439 Restore_Nested_Formal (Id);
13450 end Restore_Private_Views;
13457 (Gen_Unit : Entity_Id;
13458 Act_Unit : Entity_Id)
13462 Set_Instance_Env (Gen_Unit, Act_Unit);
13465 ----------------------------
13466 -- Save_Global_References --
13467 ----------------------------
13469 procedure Save_Global_References (N : Node_Id) is
13470 Gen_Scope : Entity_Id;
13474 function Is_Global (E : Entity_Id) return Boolean;
13475 -- Check whether entity is defined outside of generic unit. Examine the
13476 -- scope of an entity, and the scope of the scope, etc, until we find
13477 -- either Standard, in which case the entity is global, or the generic
13478 -- unit itself, which indicates that the entity is local. If the entity
13479 -- is the generic unit itself, as in the case of a recursive call, or
13480 -- the enclosing generic unit, if different from the current scope, then
13481 -- it is local as well, because it will be replaced at the point of
13482 -- instantiation. On the other hand, if it is a reference to a child
13483 -- unit of a common ancestor, which appears in an instantiation, it is
13484 -- global because it is used to denote a specific compilation unit at
13485 -- the time the instantiations will be analyzed.
13487 procedure Reset_Entity (N : Node_Id);
13488 -- Save semantic information on global entity so that it is not resolved
13489 -- again at instantiation time.
13491 procedure Save_Entity_Descendants (N : Node_Id);
13492 -- Apply Save_Global_References to the two syntactic descendants of
13493 -- non-terminal nodes that carry an Associated_Node and are processed
13494 -- through Reset_Entity. Once the global entity (if any) has been
13495 -- captured together with its type, only two syntactic descendants need
13496 -- to be traversed to complete the processing of the tree rooted at N.
13497 -- This applies to Selected_Components, Expanded_Names, and to Operator
13498 -- nodes. N can also be a character literal, identifier, or operator
13499 -- symbol node, but the call has no effect in these cases.
13501 procedure Save_Global_Defaults (N1, N2 : Node_Id);
13502 -- Default actuals in nested instances must be handled specially
13503 -- because there is no link to them from the original tree. When an
13504 -- actual subprogram is given by a default, we add an explicit generic
13505 -- association for it in the instantiation node. When we save the
13506 -- global references on the name of the instance, we recover the list
13507 -- of generic associations, and add an explicit one to the original
13508 -- generic tree, through which a global actual can be preserved.
13509 -- Similarly, if a child unit is instantiated within a sibling, in the
13510 -- context of the parent, we must preserve the identifier of the parent
13511 -- so that it can be properly resolved in a subsequent instantiation.
13513 procedure Save_Global_Descendant (D : Union_Id);
13514 -- Apply Save_Global_References recursively to the descendents of the
13517 procedure Save_References (N : Node_Id);
13518 -- This is the recursive procedure that does the work, once the
13519 -- enclosing generic scope has been established.
13525 function Is_Global (E : Entity_Id) return Boolean is
13528 function Is_Instance_Node (Decl : Node_Id) return Boolean;
13529 -- Determine whether the parent node of a reference to a child unit
13530 -- denotes an instantiation or a formal package, in which case the
13531 -- reference to the child unit is global, even if it appears within
13532 -- the current scope (e.g. when the instance appears within the body
13533 -- of an ancestor).
13535 ----------------------
13536 -- Is_Instance_Node --
13537 ----------------------
13539 function Is_Instance_Node (Decl : Node_Id) return Boolean is
13541 return Nkind (Decl) in N_Generic_Instantiation
13543 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
13544 end Is_Instance_Node;
13546 -- Start of processing for Is_Global
13549 if E = Gen_Scope then
13552 elsif E = Standard_Standard then
13555 elsif Is_Child_Unit (E)
13556 and then (Is_Instance_Node (Parent (N2))
13557 or else (Nkind (Parent (N2)) = N_Expanded_Name
13558 and then N2 = Selector_Name (Parent (N2))
13560 Is_Instance_Node (Parent (Parent (N2)))))
13566 while Se /= Gen_Scope loop
13567 if Se = Standard_Standard then
13582 procedure Reset_Entity (N : Node_Id) is
13584 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
13585 -- If the type of N2 is global to the generic unit, save the type in
13586 -- the generic node. Just as we perform name capture for explicit
13587 -- references within the generic, we must capture the global types
13588 -- of local entities because they may participate in resolution in
13591 function Top_Ancestor (E : Entity_Id) return Entity_Id;
13592 -- Find the ultimate ancestor of the current unit. If it is not a
13593 -- generic unit, then the name of the current unit in the prefix of
13594 -- an expanded name must be replaced with its generic homonym to
13595 -- ensure that it will be properly resolved in an instance.
13597 ---------------------
13598 -- Set_Global_Type --
13599 ---------------------
13601 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
13602 Typ : constant Entity_Id := Etype (N2);
13605 Set_Etype (N, Typ);
13607 if Entity (N) /= N2
13608 and then Has_Private_View (Entity (N))
13610 -- If the entity of N is not the associated node, this is a
13611 -- nested generic and it has an associated node as well, whose
13612 -- type is already the full view (see below). Indicate that the
13613 -- original node has a private view.
13615 Set_Has_Private_View (N);
13618 -- If not a private type, nothing else to do
13620 if not Is_Private_Type (Typ) then
13621 if Is_Array_Type (Typ)
13622 and then Is_Private_Type (Component_Type (Typ))
13624 Set_Has_Private_View (N);
13627 -- If it is a derivation of a private type in a context where no
13628 -- full view is needed, nothing to do either.
13630 elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
13633 -- Otherwise mark the type for flipping and use the full view when
13637 Set_Has_Private_View (N);
13639 if Present (Full_View (Typ)) then
13640 Set_Etype (N2, Full_View (Typ));
13643 end Set_Global_Type;
13649 function Top_Ancestor (E : Entity_Id) return Entity_Id is
13654 while Is_Child_Unit (Par) loop
13655 Par := Scope (Par);
13661 -- Start of processing for Reset_Entity
13664 N2 := Get_Associated_Node (N);
13667 if Present (E) then
13669 -- If the node is an entry call to an entry in an enclosing task,
13670 -- it is rewritten as a selected component. No global entity to
13671 -- preserve in this case, since the expansion will be redone in
13674 if not Nkind_In (E, N_Defining_Identifier,
13675 N_Defining_Character_Literal,
13676 N_Defining_Operator_Symbol)
13678 Set_Associated_Node (N, Empty);
13679 Set_Etype (N, Empty);
13683 -- If the entity is an itype created as a subtype of an access
13684 -- type with a null exclusion restore source entity for proper
13685 -- visibility. The itype will be created anew in the instance.
13688 and then Ekind (E) = E_Access_Subtype
13689 and then Is_Entity_Name (N)
13690 and then Chars (Etype (E)) = Chars (N)
13693 Set_Entity (N2, E);
13697 if Is_Global (E) then
13699 -- If the entity is a package renaming that is the prefix of
13700 -- an expanded name, it has been rewritten as the renamed
13701 -- package, which is necessary semantically but complicates
13702 -- ASIS tree traversal, so we recover the original entity to
13703 -- expose the renaming. Take into account that the context may
13704 -- be a nested generic, that the original node may itself have
13705 -- an associated node that had better be an entity, and that
13706 -- the current node is still a selected component.
13708 if Ekind (E) = E_Package
13709 and then Nkind (N) = N_Selected_Component
13710 and then Nkind (Parent (N)) = N_Expanded_Name
13711 and then Present (Original_Node (N2))
13712 and then Is_Entity_Name (Original_Node (N2))
13713 and then Present (Entity (Original_Node (N2)))
13715 if Is_Global (Entity (Original_Node (N2))) then
13716 N2 := Original_Node (N2);
13717 Set_Associated_Node (N, N2);
13718 Set_Global_Type (N, N2);
13721 -- Renaming is local, and will be resolved in instance
13723 Set_Associated_Node (N, Empty);
13724 Set_Etype (N, Empty);
13728 Set_Global_Type (N, N2);
13731 elsif Nkind (N) = N_Op_Concat
13732 and then Is_Generic_Type (Etype (N2))
13733 and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
13735 Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
13736 and then Is_Intrinsic_Subprogram (E)
13741 -- Entity is local. Mark generic node as unresolved.
13742 -- Note that now it does not have an entity.
13744 Set_Associated_Node (N, Empty);
13745 Set_Etype (N, Empty);
13748 if Nkind (Parent (N)) in N_Generic_Instantiation
13749 and then N = Name (Parent (N))
13751 Save_Global_Defaults (Parent (N), Parent (N2));
13754 elsif Nkind (Parent (N)) = N_Selected_Component
13755 and then Nkind (Parent (N2)) = N_Expanded_Name
13757 if Is_Global (Entity (Parent (N2))) then
13758 Change_Selected_Component_To_Expanded_Name (Parent (N));
13759 Set_Associated_Node (Parent (N), Parent (N2));
13760 Set_Global_Type (Parent (N), Parent (N2));
13761 Save_Entity_Descendants (N);
13763 -- If this is a reference to the current generic entity, replace
13764 -- by the name of the generic homonym of the current package. This
13765 -- is because in an instantiation Par.P.Q will not resolve to the
13766 -- name of the instance, whose enclosing scope is not necessarily
13767 -- Par. We use the generic homonym rather that the name of the
13768 -- generic itself because it may be hidden by a local declaration.
13770 elsif In_Open_Scopes (Entity (Parent (N2)))
13772 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
13774 if Ekind (Entity (Parent (N2))) = E_Generic_Package then
13775 Rewrite (Parent (N),
13776 Make_Identifier (Sloc (N),
13778 Chars (Generic_Homonym (Entity (Parent (N2))))));
13780 Rewrite (Parent (N),
13781 Make_Identifier (Sloc (N),
13782 Chars => Chars (Selector_Name (Parent (N2)))));
13786 if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
13787 and then Parent (N) = Name (Parent (Parent (N)))
13789 Save_Global_Defaults
13790 (Parent (Parent (N)), Parent (Parent ((N2))));
13793 -- A selected component may denote a static constant that has been
13794 -- folded. If the static constant is global to the generic, capture
13795 -- its value. Otherwise the folding will happen in any instantiation.
13797 elsif Nkind (Parent (N)) = N_Selected_Component
13798 and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
13800 if Present (Entity (Original_Node (Parent (N2))))
13801 and then Is_Global (Entity (Original_Node (Parent (N2))))
13803 Rewrite (Parent (N), New_Copy (Parent (N2)));
13804 Set_Analyzed (Parent (N), False);
13810 -- A selected component may be transformed into a parameterless
13811 -- function call. If the called entity is global, rewrite the node
13812 -- appropriately, i.e. as an extended name for the global entity.
13814 elsif Nkind (Parent (N)) = N_Selected_Component
13815 and then Nkind (Parent (N2)) = N_Function_Call
13816 and then N = Selector_Name (Parent (N))
13818 if No (Parameter_Associations (Parent (N2))) then
13819 if Is_Global (Entity (Name (Parent (N2)))) then
13820 Change_Selected_Component_To_Expanded_Name (Parent (N));
13821 Set_Associated_Node (Parent (N), Name (Parent (N2)));
13822 Set_Global_Type (Parent (N), Name (Parent (N2)));
13823 Save_Entity_Descendants (N);
13826 Set_Is_Prefixed_Call (Parent (N));
13827 Set_Associated_Node (N, Empty);
13828 Set_Etype (N, Empty);
13831 -- In Ada 2005, X.F may be a call to a primitive operation,
13832 -- rewritten as F (X). This rewriting will be done again in an
13833 -- instance, so keep the original node. Global entities will be
13834 -- captured as for other constructs. Indicate that this must
13835 -- resolve as a call, to prevent accidental overloading in the
13836 -- instance, if both a component and a primitive operation appear
13840 Set_Is_Prefixed_Call (Parent (N));
13843 -- Entity is local. Reset in generic unit, so that node is resolved
13844 -- anew at the point of instantiation.
13847 Set_Associated_Node (N, Empty);
13848 Set_Etype (N, Empty);
13852 -----------------------------
13853 -- Save_Entity_Descendants --
13854 -----------------------------
13856 procedure Save_Entity_Descendants (N : Node_Id) is
13859 when N_Binary_Op =>
13860 Save_Global_Descendant (Union_Id (Left_Opnd (N)));
13861 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13864 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13866 when N_Expanded_Name | N_Selected_Component =>
13867 Save_Global_Descendant (Union_Id (Prefix (N)));
13868 Save_Global_Descendant (Union_Id (Selector_Name (N)));
13870 when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
13874 raise Program_Error;
13876 end Save_Entity_Descendants;
13878 --------------------------
13879 -- Save_Global_Defaults --
13880 --------------------------
13882 procedure Save_Global_Defaults (N1, N2 : Node_Id) is
13883 Loc : constant Source_Ptr := Sloc (N1);
13884 Assoc2 : constant List_Id := Generic_Associations (N2);
13885 Gen_Id : constant Entity_Id := Get_Generic_Entity (N2);
13892 Actual : Entity_Id;
13895 Assoc1 := Generic_Associations (N1);
13897 if Present (Assoc1) then
13898 Act1 := First (Assoc1);
13901 Set_Generic_Associations (N1, New_List);
13902 Assoc1 := Generic_Associations (N1);
13905 if Present (Assoc2) then
13906 Act2 := First (Assoc2);
13911 while Present (Act1) and then Present (Act2) loop
13916 -- Find the associations added for default subprograms
13918 if Present (Act2) then
13919 while Nkind (Act2) /= N_Generic_Association
13920 or else No (Entity (Selector_Name (Act2)))
13921 or else not Is_Overloadable (Entity (Selector_Name (Act2)))
13926 -- Add a similar association if the default is global. The
13927 -- renaming declaration for the actual has been analyzed, and
13928 -- its alias is the program it renames. Link the actual in the
13929 -- original generic tree with the node in the analyzed tree.
13931 while Present (Act2) loop
13932 Subp := Entity (Selector_Name (Act2));
13933 Def := Explicit_Generic_Actual_Parameter (Act2);
13935 -- Following test is defence against rubbish errors
13937 if No (Alias (Subp)) then
13941 -- Retrieve the resolved actual from the renaming declaration
13942 -- created for the instantiated formal.
13944 Actual := Entity (Name (Parent (Parent (Subp))));
13945 Set_Entity (Def, Actual);
13946 Set_Etype (Def, Etype (Actual));
13948 if Is_Global (Actual) then
13950 Make_Generic_Association (Loc,
13951 Selector_Name => New_Occurrence_Of (Subp, Loc),
13952 Explicit_Generic_Actual_Parameter =>
13953 New_Occurrence_Of (Actual, Loc));
13955 Set_Associated_Node
13956 (Explicit_Generic_Actual_Parameter (Ndec), Def);
13958 Append (Ndec, Assoc1);
13960 -- If there are other defaults, add a dummy association in case
13961 -- there are other defaulted formals with the same name.
13963 elsif Present (Next (Act2)) then
13965 Make_Generic_Association (Loc,
13966 Selector_Name => New_Occurrence_Of (Subp, Loc),
13967 Explicit_Generic_Actual_Parameter => Empty);
13969 Append (Ndec, Assoc1);
13976 if Nkind (Name (N1)) = N_Identifier
13977 and then Is_Child_Unit (Gen_Id)
13978 and then Is_Global (Gen_Id)
13979 and then Is_Generic_Unit (Scope (Gen_Id))
13980 and then In_Open_Scopes (Scope (Gen_Id))
13982 -- This is an instantiation of a child unit within a sibling, so
13983 -- that the generic parent is in scope. An eventual instance must
13984 -- occur within the scope of an instance of the parent. Make name
13985 -- in instance into an expanded name, to preserve the identifier
13986 -- of the parent, so it can be resolved subsequently.
13988 Rewrite (Name (N2),
13989 Make_Expanded_Name (Loc,
13990 Chars => Chars (Gen_Id),
13991 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13992 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13993 Set_Entity (Name (N2), Gen_Id);
13995 Rewrite (Name (N1),
13996 Make_Expanded_Name (Loc,
13997 Chars => Chars (Gen_Id),
13998 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13999 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
14001 Set_Associated_Node (Name (N1), Name (N2));
14002 Set_Associated_Node (Prefix (Name (N1)), Empty);
14003 Set_Associated_Node
14004 (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
14005 Set_Etype (Name (N1), Etype (Gen_Id));
14008 end Save_Global_Defaults;
14010 ----------------------------
14011 -- Save_Global_Descendant --
14012 ----------------------------
14014 procedure Save_Global_Descendant (D : Union_Id) is
14018 if D in Node_Range then
14019 if D = Union_Id (Empty) then
14022 elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
14023 Save_References (Node_Id (D));
14026 elsif D in List_Range then
14027 if D = Union_Id (No_List) or else Is_Empty_List (List_Id (D)) then
14031 N1 := First (List_Id (D));
14032 while Present (N1) loop
14033 Save_References (N1);
14038 -- Element list or other non-node field, nothing to do
14043 end Save_Global_Descendant;
14045 ---------------------
14046 -- Save_References --
14047 ---------------------
14049 -- This is the recursive procedure that does the work once the enclosing
14050 -- generic scope has been established. We have to treat specially a
14051 -- number of node rewritings that are required by semantic processing
14052 -- and which change the kind of nodes in the generic copy: typically
14053 -- constant-folding, replacing an operator node by a string literal, or
14054 -- a selected component by an expanded name. In each of those cases, the
14055 -- transformation is propagated to the generic unit.
14057 procedure Save_References (N : Node_Id) is
14058 Loc : constant Source_Ptr := Sloc (N);
14064 elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
14065 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14068 elsif Nkind (N) = N_Operator_Symbol
14069 and then Nkind (Get_Associated_Node (N)) = N_String_Literal
14071 Change_Operator_Symbol_To_String_Literal (N);
14074 elsif Nkind (N) in N_Op then
14075 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14076 if Nkind (N) = N_Op_Concat then
14077 Set_Is_Component_Left_Opnd (N,
14078 Is_Component_Left_Opnd (Get_Associated_Node (N)));
14080 Set_Is_Component_Right_Opnd (N,
14081 Is_Component_Right_Opnd (Get_Associated_Node (N)));
14087 -- Node may be transformed into call to a user-defined operator
14089 N2 := Get_Associated_Node (N);
14091 if Nkind (N2) = N_Function_Call then
14092 E := Entity (Name (N2));
14095 and then Is_Global (E)
14097 Set_Etype (N, Etype (N2));
14099 Set_Associated_Node (N, Empty);
14100 Set_Etype (N, Empty);
14103 elsif Nkind_In (N2, N_Integer_Literal,
14107 if Present (Original_Node (N2))
14108 and then Nkind (Original_Node (N2)) = Nkind (N)
14111 -- Operation was constant-folded. Whenever possible,
14112 -- recover semantic information from unfolded node,
14115 Set_Associated_Node (N, Original_Node (N2));
14117 if Nkind (N) = N_Op_Concat then
14118 Set_Is_Component_Left_Opnd (N,
14119 Is_Component_Left_Opnd (Get_Associated_Node (N)));
14120 Set_Is_Component_Right_Opnd (N,
14121 Is_Component_Right_Opnd (Get_Associated_Node (N)));
14127 -- If original node is already modified, propagate
14128 -- constant-folding to template.
14130 Rewrite (N, New_Copy (N2));
14131 Set_Analyzed (N, False);
14134 elsif Nkind (N2) = N_Identifier
14135 and then Ekind (Entity (N2)) = E_Enumeration_Literal
14137 -- Same if call was folded into a literal, but in this case
14138 -- retain the entity to avoid spurious ambiguities if it is
14139 -- overloaded at the point of instantiation or inlining.
14141 Rewrite (N, New_Copy (N2));
14142 Set_Analyzed (N, False);
14146 -- Complete operands check if node has not been constant-folded
14148 if Nkind (N) in N_Op then
14149 Save_Entity_Descendants (N);
14152 elsif Nkind (N) = N_Identifier then
14153 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14155 -- If this is a discriminant reference, always save it. It is
14156 -- used in the instance to find the corresponding discriminant
14157 -- positionally rather than by name.
14159 Set_Original_Discriminant
14160 (N, Original_Discriminant (Get_Associated_Node (N)));
14164 N2 := Get_Associated_Node (N);
14166 if Nkind (N2) = N_Function_Call then
14167 E := Entity (Name (N2));
14169 -- Name resolves to a call to parameterless function. If
14170 -- original entity is global, mark node as resolved.
14173 and then Is_Global (E)
14175 Set_Etype (N, Etype (N2));
14177 Set_Associated_Node (N, Empty);
14178 Set_Etype (N, Empty);
14181 elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
14182 and then Is_Entity_Name (Original_Node (N2))
14184 -- Name resolves to named number that is constant-folded,
14185 -- We must preserve the original name for ASIS use, and
14186 -- undo the constant-folding, which will be repeated in
14189 Set_Associated_Node (N, Original_Node (N2));
14192 elsif Nkind (N2) = N_String_Literal then
14194 -- Name resolves to string literal. Perform the same
14195 -- replacement in generic.
14197 Rewrite (N, New_Copy (N2));
14199 elsif Nkind (N2) = N_Explicit_Dereference then
14201 -- An identifier is rewritten as a dereference if it is the
14202 -- prefix in an implicit dereference (call or attribute).
14203 -- The analysis of an instantiation will expand the node
14204 -- again, so we preserve the original tree but link it to
14205 -- the resolved entity in case it is global.
14207 if Is_Entity_Name (Prefix (N2))
14208 and then Present (Entity (Prefix (N2)))
14209 and then Is_Global (Entity (Prefix (N2)))
14211 Set_Associated_Node (N, Prefix (N2));
14213 elsif Nkind (Prefix (N2)) = N_Function_Call
14214 and then Is_Global (Entity (Name (Prefix (N2))))
14217 Make_Explicit_Dereference (Loc,
14218 Prefix => Make_Function_Call (Loc,
14220 New_Occurrence_Of (Entity (Name (Prefix (N2))),
14224 Set_Associated_Node (N, Empty);
14225 Set_Etype (N, Empty);
14228 -- The subtype mark of a nominally unconstrained object is
14229 -- rewritten as a subtype indication using the bounds of the
14230 -- expression. Recover the original subtype mark.
14232 elsif Nkind (N2) = N_Subtype_Indication
14233 and then Is_Entity_Name (Original_Node (N2))
14235 Set_Associated_Node (N, Original_Node (N2));
14243 elsif Nkind (N) in N_Entity then
14248 Qual : Node_Id := Empty;
14249 Typ : Entity_Id := Empty;
14252 use Atree.Unchecked_Access;
14253 -- This code section is part of implementing an untyped tree
14254 -- traversal, so it needs direct access to node fields.
14257 if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
14258 N2 := Get_Associated_Node (N);
14265 -- In an instance within a generic, use the name of the
14266 -- actual and not the original generic parameter. If the
14267 -- actual is global in the current generic it must be
14268 -- preserved for its instantiation.
14270 if Nkind (Parent (Typ)) = N_Subtype_Declaration
14272 Present (Generic_Parent_Type (Parent (Typ)))
14274 Typ := Base_Type (Typ);
14275 Set_Etype (N2, Typ);
14279 if No (N2) or else No (Typ) or else not Is_Global (Typ) then
14280 Set_Associated_Node (N, Empty);
14282 -- If the aggregate is an actual in a call, it has been
14283 -- resolved in the current context, to some local type.
14284 -- The enclosing call may have been disambiguated by the
14285 -- aggregate, and this disambiguation might fail at
14286 -- instantiation time because the type to which the
14287 -- aggregate did resolve is not preserved. In order to
14288 -- preserve some of this information, we wrap the
14289 -- aggregate in a qualified expression, using the id of
14290 -- its type. For further disambiguation we qualify the
14291 -- type name with its scope (if visible) because both
14292 -- id's will have corresponding entities in an instance.
14293 -- This resolves most of the problems with missing type
14294 -- information on aggregates in instances.
14296 if Nkind (N2) = Nkind (N)
14297 and then Nkind (Parent (N2)) in N_Subprogram_Call
14298 and then Comes_From_Source (Typ)
14300 if Is_Immediately_Visible (Scope (Typ)) then
14301 Nam := Make_Selected_Component (Loc,
14303 Make_Identifier (Loc, Chars (Scope (Typ))),
14305 Make_Identifier (Loc, Chars (Typ)));
14307 Nam := Make_Identifier (Loc, Chars (Typ));
14311 Make_Qualified_Expression (Loc,
14312 Subtype_Mark => Nam,
14313 Expression => Relocate_Node (N));
14317 Save_Global_Descendant (Field1 (N));
14318 Save_Global_Descendant (Field2 (N));
14319 Save_Global_Descendant (Field3 (N));
14320 Save_Global_Descendant (Field5 (N));
14322 if Present (Qual) then
14326 -- All other cases than aggregates
14329 Save_Global_Descendant (Field1 (N));
14330 Save_Global_Descendant (Field2 (N));
14331 Save_Global_Descendant (Field3 (N));
14332 Save_Global_Descendant (Field4 (N));
14333 Save_Global_Descendant (Field5 (N));
14338 -- If a node has aspects, references within their expressions must
14339 -- be saved separately, given they are not directly in the tree.
14341 if Has_Aspects (N) then
14346 Aspect := First (Aspect_Specifications (N));
14347 while Present (Aspect) loop
14348 if Present (Expression (Aspect)) then
14349 Save_Global_References (Expression (Aspect));
14356 end Save_References;
14358 -- Start of processing for Save_Global_References
14361 Gen_Scope := Current_Scope;
14363 -- If the generic unit is a child unit, references to entities in the
14364 -- parent are treated as local, because they will be resolved anew in
14365 -- the context of the instance of the parent.
14367 while Is_Child_Unit (Gen_Scope)
14368 and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
14370 Gen_Scope := Scope (Gen_Scope);
14373 Save_References (N);
14374 end Save_Global_References;
14376 --------------------------------------
14377 -- Set_Copied_Sloc_For_Inlined_Body --
14378 --------------------------------------
14380 procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
14382 Create_Instantiation_Source (N, E, True, S_Adjustment);
14383 end Set_Copied_Sloc_For_Inlined_Body;
14385 ---------------------
14386 -- Set_Instance_Of --
14387 ---------------------
14389 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
14391 Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
14392 Generic_Renamings_HTable.Set (Generic_Renamings.Last);
14393 Generic_Renamings.Increment_Last;
14394 end Set_Instance_Of;
14396 --------------------
14397 -- Set_Next_Assoc --
14398 --------------------
14400 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
14402 Generic_Renamings.Table (E).Next_In_HTable := Next;
14403 end Set_Next_Assoc;
14405 -------------------
14406 -- Start_Generic --
14407 -------------------
14409 procedure Start_Generic is
14411 -- ??? More things could be factored out in this routine.
14412 -- Should probably be done at a later stage.
14414 Generic_Flags.Append (Inside_A_Generic);
14415 Inside_A_Generic := True;
14417 Expander_Mode_Save_And_Set (False);
14420 ----------------------
14421 -- Set_Instance_Env --
14422 ----------------------
14424 procedure Set_Instance_Env
14425 (Gen_Unit : Entity_Id;
14426 Act_Unit : Entity_Id)
14428 Assertion_Status : constant Boolean := Assertions_Enabled;
14429 Save_SPARK_Mode : constant SPARK_Mode_Type := SPARK_Mode;
14430 Save_SPARK_Mode_Pragma : constant Node_Id := SPARK_Mode_Pragma;
14433 -- Regardless of the current mode, predefined units are analyzed in the
14434 -- most current Ada mode, and earlier version Ada checks do not apply
14435 -- to predefined units. Nothing needs to be done for non-internal units.
14436 -- These are always analyzed in the current mode.
14438 if Is_Internal_File_Name
14439 (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
14440 Renamings_Included => True)
14442 Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
14444 -- In Ada2012 we may want to enable assertions in an instance of a
14445 -- predefined unit, in which case we need to preserve the current
14446 -- setting for the Assertions_Enabled flag. This will become more
14447 -- critical when pre/postconditions are added to predefined units,
14448 -- as is already the case for some numeric libraries.
14450 if Ada_Version >= Ada_2012 then
14451 Assertions_Enabled := Assertion_Status;
14454 -- SPARK_Mode for an instance is the one applicable at the point of
14457 SPARK_Mode := Save_SPARK_Mode;
14458 SPARK_Mode_Pragma := Save_SPARK_Mode_Pragma;
14460 -- Make sure dynamic elaboration checks are off in SPARK Mode
14462 if SPARK_Mode = On then
14463 Dynamic_Elaboration_Checks := False;
14467 Current_Instantiated_Parent :=
14468 (Gen_Id => Gen_Unit,
14469 Act_Id => Act_Unit,
14470 Next_In_HTable => Assoc_Null);
14471 end Set_Instance_Env;
14477 procedure Switch_View (T : Entity_Id) is
14478 BT : constant Entity_Id := Base_Type (T);
14479 Priv_Elmt : Elmt_Id := No_Elmt;
14480 Priv_Sub : Entity_Id;
14483 -- T may be private but its base type may have been exchanged through
14484 -- some other occurrence, in which case there is nothing to switch
14485 -- besides T itself. Note that a private dependent subtype of a private
14486 -- type might not have been switched even if the base type has been,
14487 -- because of the last branch of Check_Private_View (see comment there).
14489 if not Is_Private_Type (BT) then
14490 Prepend_Elmt (Full_View (T), Exchanged_Views);
14491 Exchange_Declarations (T);
14495 Priv_Elmt := First_Elmt (Private_Dependents (BT));
14497 if Present (Full_View (BT)) then
14498 Prepend_Elmt (Full_View (BT), Exchanged_Views);
14499 Exchange_Declarations (BT);
14502 while Present (Priv_Elmt) loop
14503 Priv_Sub := (Node (Priv_Elmt));
14505 -- We avoid flipping the subtype if the Etype of its full view is
14506 -- private because this would result in a malformed subtype. This
14507 -- occurs when the Etype of the subtype full view is the full view of
14508 -- the base type (and since the base types were just switched, the
14509 -- subtype is pointing to the wrong view). This is currently the case
14510 -- for tagged record types, access types (maybe more?) and needs to
14511 -- be resolved. ???
14513 if Present (Full_View (Priv_Sub))
14514 and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
14516 Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
14517 Exchange_Declarations (Priv_Sub);
14520 Next_Elmt (Priv_Elmt);
14528 function True_Parent (N : Node_Id) return Node_Id is
14530 if Nkind (Parent (N)) = N_Subunit then
14531 return Parent (Corresponding_Stub (Parent (N)));
14537 -----------------------------
14538 -- Valid_Default_Attribute --
14539 -----------------------------
14541 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
14542 Attr_Id : constant Attribute_Id :=
14543 Get_Attribute_Id (Attribute_Name (Def));
14544 T : constant Entity_Id := Entity (Prefix (Def));
14545 Is_Fun : constant Boolean := (Ekind (Nam) = E_Function);
14551 if No (T) or else T = Any_Id then
14556 F := First_Formal (Nam);
14557 while Present (F) loop
14558 Num_F := Num_F + 1;
14563 when Attribute_Adjacent | Attribute_Ceiling | Attribute_Copy_Sign |
14564 Attribute_Floor | Attribute_Fraction | Attribute_Machine |
14565 Attribute_Model | Attribute_Remainder | Attribute_Rounding |
14566 Attribute_Unbiased_Rounding =>
14569 and then Is_Floating_Point_Type (T);
14571 when Attribute_Image | Attribute_Pred | Attribute_Succ |
14572 Attribute_Value | Attribute_Wide_Image |
14573 Attribute_Wide_Value =>
14574 OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
14576 when Attribute_Max | Attribute_Min =>
14577 OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
14579 when Attribute_Input =>
14580 OK := (Is_Fun and then Num_F = 1);
14582 when Attribute_Output | Attribute_Read | Attribute_Write =>
14583 OK := (not Is_Fun and then Num_F = 2);
14590 Error_Msg_N ("attribute reference has wrong profile for subprogram",
14593 end Valid_Default_Attribute;