1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2011, 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 Fname; use Fname;
33 with Fname.UF; use Fname.UF;
34 with Freeze; use Freeze;
36 with Itypes; use Itypes;
38 with Lib.Load; use Lib.Load;
39 with Lib.Xref; use Lib.Xref;
40 with Nlists; use Nlists;
41 with Namet; use Namet;
42 with Nmake; use Nmake;
44 with Rident; use Rident;
45 with Restrict; use Restrict;
46 with Rtsfind; use Rtsfind;
48 with Sem_Aux; use Sem_Aux;
49 with Sem_Cat; use Sem_Cat;
50 with Sem_Ch3; use Sem_Ch3;
51 with Sem_Ch6; use Sem_Ch6;
52 with Sem_Ch7; use Sem_Ch7;
53 with Sem_Ch8; use Sem_Ch8;
54 with Sem_Ch10; use Sem_Ch10;
55 with Sem_Ch13; use Sem_Ch13;
56 with Sem_Disp; use Sem_Disp;
57 with Sem_Elab; use Sem_Elab;
58 with Sem_Elim; use Sem_Elim;
59 with Sem_Eval; use Sem_Eval;
60 with Sem_Res; use Sem_Res;
61 with Sem_Type; use Sem_Type;
62 with Sem_Util; use Sem_Util;
63 with Sem_Warn; use Sem_Warn;
64 with Stand; use Stand;
65 with Sinfo; use Sinfo;
66 with Sinfo.CN; use Sinfo.CN;
67 with Sinput; use Sinput;
68 with Sinput.L; use Sinput.L;
69 with Snames; use Snames;
70 with Stringt; use Stringt;
71 with Uname; use Uname;
73 with Tbuild; use Tbuild;
74 with Uintp; use Uintp;
75 with Urealp; use Urealp;
79 package body Sem_Ch12 is
81 ----------------------------------------------------------
82 -- Implementation of Generic Analysis and Instantiation --
83 ----------------------------------------------------------
85 -- GNAT implements generics by macro expansion. No attempt is made to share
86 -- generic instantiations (for now). Analysis of a generic definition does
87 -- not perform any expansion action, but the expander must be called on the
88 -- tree for each instantiation, because the expansion may of course depend
89 -- on the generic actuals. All of this is best achieved as follows:
91 -- a) Semantic analysis of a generic unit is performed on a copy of the
92 -- tree for the generic unit. All tree modifications that follow analysis
93 -- do not affect the original tree. Links are kept between the original
94 -- tree and the copy, in order to recognize non-local references within
95 -- the generic, and propagate them to each instance (recall that name
96 -- resolution is done on the generic declaration: generics are not really
97 -- macros!). This is summarized in the following diagram:
99 -- .-----------. .----------.
100 -- | semantic |<--------------| generic |
102 -- | |==============>| |
103 -- |___________| global |__________|
114 -- b) Each instantiation copies the original tree, and inserts into it a
115 -- series of declarations that describe the mapping between generic formals
116 -- and actuals. For example, a generic In OUT parameter is an object
117 -- renaming of the corresponding actual, etc. Generic IN parameters are
118 -- constant declarations.
120 -- c) In order to give the right visibility for these renamings, we use
121 -- a different scheme for package and subprogram instantiations. For
122 -- packages, the list of renamings is inserted into the package
123 -- specification, before the visible declarations of the package. The
124 -- renamings are analyzed before any of the text of the instance, and are
125 -- thus visible at the right place. Furthermore, outside of the instance,
126 -- the generic parameters are visible and denote their corresponding
129 -- For subprograms, we create a container package to hold the renamings
130 -- and the subprogram instance itself. Analysis of the package makes the
131 -- renaming declarations visible to the subprogram. After analyzing the
132 -- package, the defining entity for the subprogram is touched-up so that
133 -- it appears declared in the current scope, and not inside the container
136 -- If the instantiation is a compilation unit, the container package is
137 -- given the same name as the subprogram instance. This ensures that
138 -- the elaboration procedure called by the binder, using the compilation
139 -- unit name, calls in fact the elaboration procedure for the package.
141 -- Not surprisingly, private types complicate this approach. By saving in
142 -- the original generic object the non-local references, we guarantee that
143 -- the proper entities are referenced at the point of instantiation.
144 -- However, for private types, this by itself does not insure that the
145 -- proper VIEW of the entity is used (the full type may be visible at the
146 -- point of generic definition, but not at instantiation, or vice-versa).
147 -- In order to reference the proper view, we special-case any reference
148 -- to private types in the generic object, by saving both views, one in
149 -- the generic and one in the semantic copy. At time of instantiation, we
150 -- check whether the two views are consistent, and exchange declarations if
151 -- necessary, in order to restore the correct visibility. Similarly, if
152 -- the instance view is private when the generic view was not, we perform
153 -- the exchange. After completing the instantiation, we restore the
154 -- current visibility. The flag Has_Private_View marks identifiers in the
155 -- the generic unit that require checking.
157 -- Visibility within nested generic units requires special handling.
158 -- Consider the following scheme:
160 -- type Global is ... -- outside of generic unit.
164 -- type Semi_Global is ... -- global to inner.
167 -- procedure inner (X1 : Global; X2 : Semi_Global);
169 -- procedure in2 is new inner (...); -- 4
172 -- package New_Outer is new Outer (...); -- 2
173 -- procedure New_Inner is new New_Outer.Inner (...); -- 3
175 -- The semantic analysis of Outer captures all occurrences of Global.
176 -- The semantic analysis of Inner (at 1) captures both occurrences of
177 -- Global and Semi_Global.
179 -- At point 2 (instantiation of Outer), we also produce a generic copy
180 -- of Inner, even though Inner is, at that point, not being instantiated.
181 -- (This is just part of the semantic analysis of New_Outer).
183 -- Critically, references to Global within Inner must be preserved, while
184 -- references to Semi_Global should not preserved, because they must now
185 -- resolve to an entity within New_Outer. To distinguish between these, we
186 -- use a global variable, Current_Instantiated_Parent, which is set when
187 -- performing a generic copy during instantiation (at 2). This variable is
188 -- used when performing a generic copy that is not an instantiation, but
189 -- that is nested within one, as the occurrence of 1 within 2. The analysis
190 -- of a nested generic only preserves references that are global to the
191 -- enclosing Current_Instantiated_Parent. We use the Scope_Depth value to
192 -- determine whether a reference is external to the given parent.
194 -- The instantiation at point 3 requires no special treatment. The method
195 -- works as well for further nestings of generic units, but of course the
196 -- variable Current_Instantiated_Parent must be stacked because nested
197 -- instantiations can occur, e.g. the occurrence of 4 within 2.
199 -- The instantiation of package and subprogram bodies is handled in a
200 -- similar manner, except that it is delayed until after semantic
201 -- analysis is complete. In this fashion complex cross-dependencies
202 -- between several package declarations and bodies containing generics
203 -- can be compiled which otherwise would diagnose spurious circularities.
205 -- For example, it is possible to compile two packages A and B that
206 -- have the following structure:
208 -- package A is package B is
209 -- generic ... generic ...
210 -- package G_A is package G_B is
213 -- package body A is package body B is
214 -- package N_B is new G_B (..) package N_A is new G_A (..)
216 -- The table Pending_Instantiations in package Inline is used to keep
217 -- track of body instantiations that are delayed in this manner. Inline
218 -- handles the actual calls to do the body instantiations. This activity
219 -- is part of Inline, since the processing occurs at the same point, and
220 -- for essentially the same reason, as the handling of inlined routines.
222 ----------------------------------------------
223 -- Detection of Instantiation Circularities --
224 ----------------------------------------------
226 -- If we have a chain of instantiations that is circular, this is static
227 -- error which must be detected at compile time. The detection of these
228 -- circularities is carried out at the point that we insert a generic
229 -- instance spec or body. If there is a circularity, then the analysis of
230 -- the offending spec or body will eventually result in trying to load the
231 -- same unit again, and we detect this problem as we analyze the package
232 -- instantiation for the second time.
234 -- At least in some cases after we have detected the circularity, we get
235 -- into trouble if we try to keep going. The following flag is set if a
236 -- circularity is detected, and used to abandon compilation after the
237 -- messages have been posted.
239 Circularity_Detected : Boolean := False;
240 -- This should really be reset on encountering a new main unit, but in
241 -- practice we are not using multiple main units so it is not critical.
243 -------------------------------------------------
244 -- Formal packages and partial parametrization --
245 -------------------------------------------------
247 -- When compiling a generic, a formal package is a local instantiation. If
248 -- declared with a box, its generic formals are visible in the enclosing
249 -- generic. If declared with a partial list of actuals, those actuals that
250 -- are defaulted (covered by an Others clause, or given an explicit box
251 -- initialization) are also visible in the enclosing generic, while those
252 -- that have a corresponding actual are not.
254 -- In our source model of instantiation, the same visibility must be
255 -- present in the spec and body of an instance: the names of the formals
256 -- that are defaulted must be made visible within the instance, and made
257 -- invisible (hidden) after the instantiation is complete, so that they
258 -- are not accessible outside of the instance.
260 -- In a generic, a formal package is treated like a special instantiation.
261 -- Our Ada 95 compiler handled formals with and without box in different
262 -- ways. With partial parametrization, we use a single model for both.
263 -- We create a package declaration that consists of the specification of
264 -- the generic package, and a set of declarations that map the actuals
265 -- into local renamings, just as we do for bona fide instantiations. For
266 -- defaulted parameters and formals with a box, we copy directly the
267 -- declarations of the formal into this local package. The result is a
268 -- a package whose visible declarations may include generic formals. This
269 -- package is only used for type checking and visibility analysis, and
270 -- never reaches the back-end, so it can freely violate the placement
271 -- rules for generic formal declarations.
273 -- The list of declarations (renamings and copies of formals) is built
274 -- by Analyze_Associations, just as for regular instantiations.
276 -- At the point of instantiation, conformance checking must be applied only
277 -- to those parameters that were specified in the formal. We perform this
278 -- checking by creating another internal instantiation, this one including
279 -- only the renamings and the formals (the rest of the package spec is not
280 -- relevant to conformance checking). We can then traverse two lists: the
281 -- list of actuals in the instance that corresponds to the formal package,
282 -- and the list of actuals produced for this bogus instantiation. We apply
283 -- the conformance rules to those actuals that are not defaulted (i.e.
284 -- which still appear as generic formals.
286 -- When we compile an instance body we must make the right parameters
287 -- visible again. The predicate Is_Generic_Formal indicates which of the
288 -- formals should have its Is_Hidden flag reset.
290 -----------------------
291 -- Local subprograms --
292 -----------------------
294 procedure Abandon_Instantiation (N : Node_Id);
295 pragma No_Return (Abandon_Instantiation);
296 -- Posts an error message "instantiation abandoned" at the indicated node
297 -- and then raises the exception Instantiation_Error to do it.
299 procedure Analyze_Formal_Array_Type
300 (T : in out Entity_Id;
302 -- A formal array type is treated like an array type declaration, and
303 -- invokes Array_Type_Declaration (sem_ch3) whose first parameter is
304 -- in-out, because in the case of an anonymous type the entity is
305 -- actually created in the procedure.
307 -- The following procedures treat other kinds of formal parameters
309 procedure Analyze_Formal_Derived_Interface_Type
314 procedure Analyze_Formal_Derived_Type
319 procedure Analyze_Formal_Interface_Type
324 -- The following subprograms create abbreviated declarations for formal
325 -- scalar types. We introduce an anonymous base of the proper class for
326 -- each of them, and define the formals as constrained first subtypes of
327 -- their bases. The bounds are expressions that are non-static in the
330 procedure Analyze_Formal_Decimal_Fixed_Point_Type
331 (T : Entity_Id; Def : Node_Id);
332 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id);
333 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id);
334 procedure Analyze_Formal_Signed_Integer_Type (T : Entity_Id; Def : Node_Id);
335 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id);
336 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
337 (T : Entity_Id; Def : Node_Id);
339 procedure Analyze_Formal_Private_Type
343 -- Creates a new private type, which does not require completion
345 procedure Analyze_Formal_Incomplete_Type (T : Entity_Id; Def : Node_Id);
346 -- Ada 2012: Creates a new incomplete type whose actual does not freeze
348 procedure Analyze_Generic_Formal_Part (N : Node_Id);
349 -- Analyze generic formal part
351 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
352 -- Create a new access type with the given designated type
354 function Analyze_Associations
357 F_Copy : List_Id) return List_Id;
358 -- At instantiation time, build the list of associations between formals
359 -- and actuals. Each association becomes a renaming declaration for the
360 -- formal entity. F_Copy is the analyzed list of formals in the generic
361 -- copy. It is used to apply legality checks to the actuals. I_Node is the
362 -- instantiation node itself.
364 procedure Analyze_Subprogram_Instantiation
368 procedure Build_Instance_Compilation_Unit_Nodes
372 -- This procedure is used in the case where the generic instance of a
373 -- subprogram body or package body is a library unit. In this case, the
374 -- original library unit node for the generic instantiation must be
375 -- replaced by the resulting generic body, and a link made to a new
376 -- compilation unit node for the generic declaration. The argument N is
377 -- the original generic instantiation. Act_Body and Act_Decl are the body
378 -- and declaration of the instance (either package body and declaration
379 -- nodes or subprogram body and declaration nodes depending on the case).
380 -- On return, the node N has been rewritten with the actual body.
382 procedure Check_Access_Definition (N : Node_Id);
383 -- Subsidiary routine to null exclusion processing. Perform an assertion
384 -- check on Ada version and the presence of an access definition in N.
386 procedure Check_Formal_Packages (P_Id : Entity_Id);
387 -- Apply the following to all formal packages in generic associations
389 procedure Check_Formal_Package_Instance
390 (Formal_Pack : Entity_Id;
391 Actual_Pack : Entity_Id);
392 -- Verify that the actuals of the actual instance match the actuals of
393 -- the template for a formal package that is not declared with a box.
395 procedure Check_Forward_Instantiation (Decl : Node_Id);
396 -- If the generic is a local entity and the corresponding body has not
397 -- been seen yet, flag enclosing packages to indicate that it will be
398 -- elaborated after the generic body. Subprograms declared in the same
399 -- package cannot be inlined by the front-end because front-end inlining
400 -- requires a strict linear order of elaboration.
402 procedure Check_Hidden_Child_Unit
404 Gen_Unit : Entity_Id;
405 Act_Decl_Id : Entity_Id);
406 -- If the generic unit is an implicit child instance within a parent
407 -- instance, we need to make an explicit test that it is not hidden by
408 -- a child instance of the same name and parent.
410 procedure Check_Generic_Actuals
411 (Instance : Entity_Id;
412 Is_Formal_Box : Boolean);
413 -- Similar to previous one. Check the actuals in the instantiation,
414 -- whose views can change between the point of instantiation and the point
415 -- of instantiation of the body. In addition, mark the generic renamings
416 -- as generic actuals, so that they are not compatible with other actuals.
417 -- Recurse on an actual that is a formal package whose declaration has
420 function Contains_Instance_Of
423 N : Node_Id) return Boolean;
424 -- Inner is instantiated within the generic Outer. Check whether Inner
425 -- directly or indirectly contains an instance of Outer or of one of its
426 -- parents, in the case of a subunit. Each generic unit holds a list of
427 -- the entities instantiated within (at any depth). This procedure
428 -- determines whether the set of such lists contains a cycle, i.e. an
429 -- illegal circular instantiation.
431 function Denotes_Formal_Package
433 On_Exit : Boolean := False;
434 Instance : Entity_Id := Empty) return Boolean;
435 -- Returns True if E is a formal package of an enclosing generic, or
436 -- the actual for such a formal in an enclosing instantiation. If such
437 -- a package is used as a formal in an nested generic, or as an actual
438 -- in a nested instantiation, the visibility of ITS formals should not
439 -- be modified. When called from within Restore_Private_Views, the flag
440 -- On_Exit is true, to indicate that the search for a possible enclosing
441 -- instance should ignore the current one. In that case Instance denotes
442 -- the declaration for which this is an actual. This declaration may be
443 -- an instantiation in the source, or the internal instantiation that
444 -- corresponds to the actual for a formal package.
446 function Find_Actual_Type
448 Gen_Type : Entity_Id) return Entity_Id;
449 -- When validating the actual types of a child instance, check whether
450 -- the formal is a formal type of the parent unit, and retrieve the current
451 -- actual for it. Typ is the entity in the analyzed formal type declaration
452 -- (component or index type of an array type, or designated type of an
453 -- access formal) and Gen_Type is the enclosing analyzed formal array
454 -- or access type. The desired actual may be a formal of a parent, or may
455 -- be declared in a formal package of a parent. In both cases it is a
456 -- generic actual type because it appears within a visible instance.
457 -- Finally, it may be declared in a parent unit without being a formal
458 -- of that unit, in which case it must be retrieved by visibility.
459 -- Ambiguities may still arise if two homonyms are declared in two formal
460 -- packages, and the prefix of the formal type may be needed to resolve
461 -- the ambiguity in the instance ???
463 function In_Same_Declarative_Part
465 Inst : Node_Id) return Boolean;
466 -- True if the instantiation Inst and the given freeze_node F_Node appear
467 -- within the same declarative part, ignoring subunits, but with no inter-
468 -- vening subprograms or concurrent units. If true, the freeze node
469 -- of the instance can be placed after the freeze node of the parent,
470 -- which it itself an instance.
472 function In_Main_Context (E : Entity_Id) return Boolean;
473 -- Check whether an instantiation is in the context of the main unit.
474 -- Used to determine whether its body should be elaborated to allow
475 -- front-end inlining.
477 procedure Set_Instance_Env
478 (Gen_Unit : Entity_Id;
479 Act_Unit : Entity_Id);
480 -- Save current instance on saved environment, to be used to determine
481 -- the global status of entities in nested instances. Part of Save_Env.
482 -- called after verifying that the generic unit is legal for the instance,
483 -- The procedure also examines whether the generic unit is a predefined
484 -- unit, in order to set configuration switches accordingly. As a result
485 -- the procedure must be called after analyzing and freezing the actuals.
487 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id);
488 -- Associate analyzed generic parameter with corresponding
489 -- instance. Used for semantic checks at instantiation time.
491 function Has_Been_Exchanged (E : Entity_Id) return Boolean;
492 -- Traverse the Exchanged_Views list to see if a type was private
493 -- and has already been flipped during this phase of instantiation.
495 procedure Hide_Current_Scope;
496 -- When instantiating a generic child unit, the parent context must be
497 -- present, but the instance and all entities that may be generated
498 -- must be inserted in the current scope. We leave the current scope
499 -- on the stack, but make its entities invisible to avoid visibility
500 -- problems. This is reversed at the end of the instantiation. This is
501 -- not done for the instantiation of the bodies, which only require the
502 -- instances of the generic parents to be in scope.
504 procedure Install_Body
509 -- If the instantiation happens textually before the body of the generic,
510 -- the instantiation of the body must be analyzed after the generic body,
511 -- and not at the point of instantiation. Such early instantiations can
512 -- happen if the generic and the instance appear in a package declaration
513 -- because the generic body can only appear in the corresponding package
514 -- body. Early instantiations can also appear if generic, instance and
515 -- body are all in the declarative part of a subprogram or entry. Entities
516 -- of packages that are early instantiations are delayed, and their freeze
517 -- node appears after the generic body.
519 procedure Insert_Freeze_Node_For_Instance
522 -- N denotes a package or a subprogram instantiation and F_Node is the
523 -- associated freeze node. Insert the freeze node before the first source
524 -- body which follows immediately after N. If no such body is found, the
525 -- freeze node is inserted at the end of the declarative region which
528 procedure Freeze_Subprogram_Body
529 (Inst_Node : Node_Id;
531 Pack_Id : Entity_Id);
532 -- The generic body may appear textually after the instance, including
533 -- in the proper body of a stub, or within a different package instance.
534 -- Given that the instance can only be elaborated after the generic, we
535 -- place freeze_nodes for the instance and/or for packages that may enclose
536 -- the instance and the generic, so that the back-end can establish the
537 -- proper order of elaboration.
540 -- Establish environment for subsequent instantiation. Separated from
541 -- Save_Env because data-structures for visibility handling must be
542 -- initialized before call to Check_Generic_Child_Unit.
544 procedure Install_Formal_Packages (Par : Entity_Id);
545 -- Install the visible part of any formal of the parent that is a formal
546 -- package. Note that for the case of a formal package with a box, this
547 -- includes the formal part of the formal package (12.7(10/2)).
549 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False);
550 -- When compiling an instance of a child unit the parent (which is
551 -- itself an instance) is an enclosing scope that must be made
552 -- immediately visible. This procedure is also used to install the non-
553 -- generic parent of a generic child unit when compiling its body, so
554 -- that full views of types in the parent are made visible.
556 procedure Remove_Parent (In_Body : Boolean := False);
557 -- Reverse effect after instantiation of child is complete
559 procedure Inline_Instance_Body
561 Gen_Unit : Entity_Id;
563 -- If front-end inlining is requested, instantiate the package body,
564 -- and preserve the visibility of its compilation unit, to insure
565 -- that successive instantiations succeed.
567 -- The functions Instantiate_XXX perform various legality checks and build
568 -- the declarations for instantiated generic parameters. In all of these
569 -- Formal is the entity in the generic unit, Actual is the entity of
570 -- expression in the generic associations, and Analyzed_Formal is the
571 -- formal in the generic copy, which contains the semantic information to
572 -- be used to validate the actual.
574 function Instantiate_Object
577 Analyzed_Formal : Node_Id) return List_Id;
579 function Instantiate_Type
582 Analyzed_Formal : Node_Id;
583 Actual_Decls : List_Id) return List_Id;
585 function Instantiate_Formal_Subprogram
588 Analyzed_Formal : Node_Id) return Node_Id;
590 function Instantiate_Formal_Package
593 Analyzed_Formal : Node_Id) return List_Id;
594 -- If the formal package is declared with a box, special visibility rules
595 -- apply to its formals: they are in the visible part of the package. This
596 -- is true in the declarative region of the formal package, that is to say
597 -- in the enclosing generic or instantiation. For an instantiation, the
598 -- parameters of the formal package are made visible in an explicit step.
599 -- Furthermore, if the actual has a visible USE clause, these formals must
600 -- be made potentially use-visible as well. On exit from the enclosing
601 -- instantiation, the reverse must be done.
603 -- For a formal package declared without a box, there are conformance rules
604 -- that apply to the actuals in the generic declaration and the actuals of
605 -- the actual package in the enclosing instantiation. The simplest way to
606 -- apply these rules is to repeat the instantiation of the formal package
607 -- in the context of the enclosing instance, and compare the generic
608 -- associations of this instantiation with those of the actual package.
609 -- This internal instantiation only needs to contain the renamings of the
610 -- formals: the visible and private declarations themselves need not be
613 -- In Ada 2005, the formal package may be only partially parameterized.
614 -- In that case the visibility step must make visible those actuals whose
615 -- corresponding formals were given with a box. A final complication
616 -- involves inherited operations from formal derived types, which must
617 -- be visible if the type is.
619 function Is_In_Main_Unit (N : Node_Id) return Boolean;
620 -- Test if given node is in the main unit
622 procedure Load_Parent_Of_Generic
625 Body_Optional : Boolean := False);
626 -- If the generic appears in a separate non-generic library unit, load the
627 -- corresponding body to retrieve the body of the generic. N is the node
628 -- for the generic instantiation, Spec is the generic package declaration.
630 -- Body_Optional is a flag that indicates that the body is being loaded to
631 -- ensure that temporaries are generated consistently when there are other
632 -- instances in the current declarative part that precede the one being
633 -- loaded. In that case a missing body is acceptable.
635 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id);
636 -- Add the context clause of the unit containing a generic unit to a
637 -- compilation unit that is, or contains, an instantiation.
639 function Get_Associated_Node (N : Node_Id) return Node_Id;
640 -- In order to propagate semantic information back from the analyzed copy
641 -- to the original generic, we maintain links between selected nodes in the
642 -- generic and their corresponding copies. At the end of generic analysis,
643 -- the routine Save_Global_References traverses the generic tree, examines
644 -- the semantic information, and preserves the links to those nodes that
645 -- contain global information. At instantiation, the information from the
646 -- associated node is placed on the new copy, so that name resolution is
649 -- Three kinds of source nodes have associated nodes:
651 -- a) those that can reference (denote) entities, that is identifiers,
652 -- character literals, expanded_names, operator symbols, operators,
653 -- and attribute reference nodes. These nodes have an Entity field
654 -- and are the set of nodes that are in N_Has_Entity.
656 -- b) aggregates (N_Aggregate and N_Extension_Aggregate)
658 -- c) selected components (N_Selected_Component)
660 -- For the first class, the associated node preserves the entity if it is
661 -- global. If the generic contains nested instantiations, the associated
662 -- node itself has been recopied, and a chain of them must be followed.
664 -- For aggregates, the associated node allows retrieval of the type, which
665 -- may otherwise not appear in the generic. The view of this type may be
666 -- different between generic and instantiation, and the full view can be
667 -- installed before the instantiation is analyzed. For aggregates of type
668 -- extensions, the same view exchange may have to be performed for some of
669 -- the ancestor types, if their view is private at the point of
672 -- Nodes that are selected components in the parse tree may be rewritten
673 -- as expanded names after resolution, and must be treated as potential
674 -- entity holders, which is why they also have an Associated_Node.
676 -- Nodes that do not come from source, such as freeze nodes, do not appear
677 -- in the generic tree, and need not have an associated node.
679 -- The associated node is stored in the Associated_Node field. Note that
680 -- this field overlaps Entity, which is fine, because the whole point is
681 -- that we don't need or want the normal Entity field in this situation.
683 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id);
684 -- Within the generic part, entities in the formal package are
685 -- visible. To validate subsequent type declarations, indicate
686 -- the correspondence between the entities in the analyzed formal,
687 -- and the entities in the actual package. There are three packages
688 -- involved in the instantiation of a formal package: the parent
689 -- generic P1 which appears in the generic declaration, the fake
690 -- instantiation P2 which appears in the analyzed generic, and whose
691 -- visible entities may be used in subsequent formals, and the actual
692 -- P3 in the instance. To validate subsequent formals, me indicate
693 -- that the entities in P2 are mapped into those of P3. The mapping of
694 -- entities has to be done recursively for nested packages.
696 procedure Move_Freeze_Nodes
700 -- Freeze nodes can be generated in the analysis of a generic unit, but
701 -- will not be seen by the back-end. It is necessary to move those nodes
702 -- to the enclosing scope if they freeze an outer entity. We place them
703 -- at the end of the enclosing generic package, which is semantically
706 procedure Preanalyze_Actuals (N : Node_Id);
707 -- Analyze actuals to perform name resolution. Full resolution is done
708 -- later, when the expected types are known, but names have to be captured
709 -- before installing parents of generics, that are not visible for the
710 -- actuals themselves.
712 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id);
713 -- Verify that an attribute that appears as the default for a formal
714 -- subprogram is a function or procedure with the correct profile.
716 -------------------------------------------
717 -- Data Structures for Generic Renamings --
718 -------------------------------------------
720 -- The map Generic_Renamings associates generic entities with their
721 -- corresponding actuals. Currently used to validate type instances. It
722 -- will eventually be used for all generic parameters to eliminate the
723 -- need for overload resolution in the instance.
725 type Assoc_Ptr is new Int;
727 Assoc_Null : constant Assoc_Ptr := -1;
732 Next_In_HTable : Assoc_Ptr;
735 package Generic_Renamings is new Table.Table
736 (Table_Component_Type => Assoc,
737 Table_Index_Type => Assoc_Ptr,
738 Table_Low_Bound => 0,
740 Table_Increment => 100,
741 Table_Name => "Generic_Renamings");
743 -- Variable to hold enclosing instantiation. When the environment is
744 -- saved for a subprogram inlining, the corresponding Act_Id is empty.
746 Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
748 -- Hash table for associations
750 HTable_Size : constant := 37;
751 type HTable_Range is range 0 .. HTable_Size - 1;
753 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr);
754 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr;
755 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id;
756 function Hash (F : Entity_Id) return HTable_Range;
758 package Generic_Renamings_HTable is new GNAT.HTable.Static_HTable (
759 Header_Num => HTable_Range,
761 Elmt_Ptr => Assoc_Ptr,
762 Null_Ptr => Assoc_Null,
763 Set_Next => Set_Next_Assoc,
766 Get_Key => Get_Gen_Id,
770 Exchanged_Views : Elist_Id;
771 -- This list holds the private views that have been exchanged during
772 -- instantiation to restore the visibility of the generic declaration.
773 -- (see comments above). After instantiation, the current visibility is
774 -- reestablished by means of a traversal of this list.
776 Hidden_Entities : Elist_Id;
777 -- This list holds the entities of the current scope that are removed
778 -- from immediate visibility when instantiating a child unit. Their
779 -- visibility is restored in Remove_Parent.
781 -- Because instantiations can be recursive, the following must be saved
782 -- on entry and restored on exit from an instantiation (spec or body).
783 -- This is done by the two procedures Save_Env and Restore_Env. For
784 -- package and subprogram instantiations (but not for the body instances)
785 -- the action of Save_Env is done in two steps: Init_Env is called before
786 -- Check_Generic_Child_Unit, because setting the parent instances requires
787 -- that the visibility data structures be properly initialized. Once the
788 -- generic is unit is validated, Set_Instance_Env completes Save_Env.
790 Parent_Unit_Visible : Boolean := False;
791 -- Parent_Unit_Visible is used when the generic is a child unit, and
792 -- indicates whether the ultimate parent of the generic is visible in the
793 -- instantiation environment. It is used to reset the visibility of the
794 -- parent at the end of the instantiation (see Remove_Parent).
796 Instance_Parent_Unit : Entity_Id := Empty;
797 -- This records the ultimate parent unit of an instance of a generic
798 -- child unit and is used in conjunction with Parent_Unit_Visible to
799 -- indicate the unit to which the Parent_Unit_Visible flag corresponds.
801 type Instance_Env is record
802 Instantiated_Parent : Assoc;
803 Exchanged_Views : Elist_Id;
804 Hidden_Entities : Elist_Id;
805 Current_Sem_Unit : Unit_Number_Type;
806 Parent_Unit_Visible : Boolean := False;
807 Instance_Parent_Unit : Entity_Id := Empty;
808 Switches : Config_Switches_Type;
811 package Instance_Envs is new Table.Table (
812 Table_Component_Type => Instance_Env,
813 Table_Index_Type => Int,
814 Table_Low_Bound => 0,
816 Table_Increment => 100,
817 Table_Name => "Instance_Envs");
819 procedure Restore_Private_Views
820 (Pack_Id : Entity_Id;
821 Is_Package : Boolean := True);
822 -- Restore the private views of external types, and unmark the generic
823 -- renamings of actuals, so that they become compatible subtypes again.
824 -- For subprograms, Pack_Id is the package constructed to hold the
827 procedure Switch_View (T : Entity_Id);
828 -- Switch the partial and full views of a type and its private
829 -- dependents (i.e. its subtypes and derived types).
831 ------------------------------------
832 -- Structures for Error Reporting --
833 ------------------------------------
835 Instantiation_Node : Node_Id;
836 -- Used by subprograms that validate instantiation of formal parameters
837 -- where there might be no actual on which to place the error message.
838 -- Also used to locate the instantiation node for generic subunits.
840 Instantiation_Error : exception;
841 -- When there is a semantic error in the generic parameter matching,
842 -- there is no point in continuing the instantiation, because the
843 -- number of cascaded errors is unpredictable. This exception aborts
844 -- the instantiation process altogether.
846 S_Adjustment : Sloc_Adjustment;
847 -- Offset created for each node in an instantiation, in order to keep
848 -- track of the source position of the instantiation in each of its nodes.
849 -- A subsequent semantic error or warning on a construct of the instance
850 -- points to both places: the original generic node, and the point of
851 -- instantiation. See Sinput and Sinput.L for additional details.
853 ------------------------------------------------------------
854 -- Data structure for keeping track when inside a Generic --
855 ------------------------------------------------------------
857 -- The following table is used to save values of the Inside_A_Generic
858 -- flag (see spec of Sem) when they are saved by Start_Generic.
860 package Generic_Flags is new Table.Table (
861 Table_Component_Type => Boolean,
862 Table_Index_Type => Int,
863 Table_Low_Bound => 0,
865 Table_Increment => 200,
866 Table_Name => "Generic_Flags");
868 ---------------------------
869 -- Abandon_Instantiation --
870 ---------------------------
872 procedure Abandon_Instantiation (N : Node_Id) is
874 Error_Msg_N ("\instantiation abandoned!", N);
875 raise Instantiation_Error;
876 end Abandon_Instantiation;
878 --------------------------
879 -- Analyze_Associations --
880 --------------------------
882 function Analyze_Associations
885 F_Copy : List_Id) return List_Id
888 Actual_Types : constant Elist_Id := New_Elmt_List;
889 Assoc : constant List_Id := New_List;
890 Default_Actuals : constant Elist_Id := New_Elmt_List;
891 Gen_Unit : constant Entity_Id :=
892 Defining_Entity (Parent (F_Copy));
897 Next_Formal : Node_Id;
898 Analyzed_Formal : Node_Id;
901 First_Named : Node_Id := Empty;
903 Default_Formals : constant List_Id := New_List;
904 -- If an Others_Choice is present, some of the formals may be defaulted.
905 -- To simplify the treatment of visibility in an instance, we introduce
906 -- individual defaults for each such formal. These defaults are
907 -- appended to the list of associations and replace the Others_Choice.
909 Found_Assoc : Node_Id;
910 -- Association for the current formal being match. Empty if there are
911 -- no remaining actuals, or if there is no named association with the
912 -- name of the formal.
914 Is_Named_Assoc : Boolean;
915 Num_Matched : Int := 0;
916 Num_Actuals : Int := 0;
918 Others_Present : Boolean := False;
919 Others_Choice : Node_Id := Empty;
920 -- In Ada 2005, indicates partial parametrization of a formal
921 -- package. As usual an other association must be last in the list.
923 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id);
924 -- Apply RM 12.3 (9): if a formal subprogram is overloaded, the instance
925 -- cannot have a named association for it. AI05-0025 extends this rule
926 -- to formals of formal packages by AI05-0025, and it also applies to
927 -- box-initialized formals.
929 function Matching_Actual
931 A_F : Entity_Id) return Node_Id;
932 -- Find actual that corresponds to a given a formal parameter. If the
933 -- actuals are positional, return the next one, if any. If the actuals
934 -- are named, scan the parameter associations to find the right one.
935 -- A_F is the corresponding entity in the analyzed generic,which is
936 -- placed on the selector name for ASIS use.
938 -- In Ada 2005, a named association may be given with a box, in which
939 -- case Matching_Actual sets Found_Assoc to the generic association,
940 -- but return Empty for the actual itself. In this case the code below
941 -- creates a corresponding declaration for the formal.
943 function Partial_Parametrization return Boolean;
944 -- Ada 2005: if no match is found for a given formal, check if the
945 -- association for it includes a box, or whether the associations
946 -- include an Others clause.
948 procedure Process_Default (F : Entity_Id);
949 -- Add a copy of the declaration of generic formal F to the list of
950 -- associations, and add an explicit box association for F if there
951 -- is none yet, and the default comes from an Others_Choice.
953 procedure Set_Analyzed_Formal;
954 -- Find the node in the generic copy that corresponds to a given formal.
955 -- The semantic information on this node is used to perform legality
956 -- checks on the actuals. Because semantic analysis can introduce some
957 -- anonymous entities or modify the declaration node itself, the
958 -- correspondence between the two lists is not one-one. In addition to
959 -- anonymous types, the presence a formal equality will introduce an
960 -- implicit declaration for the corresponding inequality.
962 ----------------------------------------
963 -- Check_Overloaded_Formal_Subprogram --
964 ----------------------------------------
966 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id) is
967 Temp_Formal : Entity_Id;
970 Temp_Formal := First (Formals);
971 while Present (Temp_Formal) loop
972 if Nkind (Temp_Formal) in N_Formal_Subprogram_Declaration
973 and then Temp_Formal /= Formal
975 Chars (Defining_Unit_Name (Specification (Formal))) =
976 Chars (Defining_Unit_Name (Specification (Temp_Formal)))
978 if Present (Found_Assoc) then
980 ("named association not allowed for overloaded formal",
985 ("named association not allowed for overloaded formal",
989 Abandon_Instantiation (Instantiation_Node);
994 end Check_Overloaded_Formal_Subprogram;
996 ---------------------
997 -- Matching_Actual --
998 ---------------------
1000 function Matching_Actual
1002 A_F : Entity_Id) return Node_Id
1008 Is_Named_Assoc := False;
1010 -- End of list of purely positional parameters
1012 if No (Actual) or else Nkind (Actual) = N_Others_Choice then
1013 Found_Assoc := Empty;
1016 -- Case of positional parameter corresponding to current formal
1018 elsif No (Selector_Name (Actual)) then
1019 Found_Assoc := Actual;
1020 Act := Explicit_Generic_Actual_Parameter (Actual);
1021 Num_Matched := Num_Matched + 1;
1024 -- Otherwise scan list of named actuals to find the one with the
1025 -- desired name. All remaining actuals have explicit names.
1028 Is_Named_Assoc := True;
1029 Found_Assoc := Empty;
1033 while Present (Actual) loop
1034 if Chars (Selector_Name (Actual)) = Chars (F) then
1035 Set_Entity (Selector_Name (Actual), A_F);
1036 Set_Etype (Selector_Name (Actual), Etype (A_F));
1037 Generate_Reference (A_F, Selector_Name (Actual));
1038 Found_Assoc := Actual;
1039 Act := Explicit_Generic_Actual_Parameter (Actual);
1040 Num_Matched := Num_Matched + 1;
1048 -- Reset for subsequent searches. In most cases the named
1049 -- associations are in order. If they are not, we reorder them
1050 -- to avoid scanning twice the same actual. This is not just a
1051 -- question of efficiency: there may be multiple defaults with
1052 -- boxes that have the same name. In a nested instantiation we
1053 -- insert actuals for those defaults, and cannot rely on their
1054 -- names to disambiguate them.
1056 if Actual = First_Named then
1059 elsif Present (Actual) then
1060 Insert_Before (First_Named, Remove_Next (Prev));
1063 Actual := First_Named;
1066 if Is_Entity_Name (Act) and then Present (Entity (Act)) then
1067 Set_Used_As_Generic_Actual (Entity (Act));
1071 end Matching_Actual;
1073 -----------------------------
1074 -- Partial_Parametrization --
1075 -----------------------------
1077 function Partial_Parametrization return Boolean is
1079 return Others_Present
1080 or else (Present (Found_Assoc) and then Box_Present (Found_Assoc));
1081 end Partial_Parametrization;
1083 ---------------------
1084 -- Process_Default --
1085 ---------------------
1087 procedure Process_Default (F : Entity_Id) is
1088 Loc : constant Source_Ptr := Sloc (I_Node);
1089 F_Id : constant Entity_Id := Defining_Entity (F);
1095 -- Append copy of formal declaration to associations, and create new
1096 -- defining identifier for it.
1098 Decl := New_Copy_Tree (F);
1099 Id := Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id));
1101 if Nkind (F) in N_Formal_Subprogram_Declaration then
1102 Set_Defining_Unit_Name (Specification (Decl), Id);
1105 Set_Defining_Identifier (Decl, Id);
1108 Append (Decl, Assoc);
1110 if No (Found_Assoc) then
1112 Make_Generic_Association (Loc,
1113 Selector_Name => New_Occurrence_Of (Id, Loc),
1114 Explicit_Generic_Actual_Parameter => Empty);
1115 Set_Box_Present (Default);
1116 Append (Default, Default_Formals);
1118 end Process_Default;
1120 -------------------------
1121 -- Set_Analyzed_Formal --
1122 -------------------------
1124 procedure Set_Analyzed_Formal is
1128 while Present (Analyzed_Formal) loop
1129 Kind := Nkind (Analyzed_Formal);
1131 case Nkind (Formal) is
1133 when N_Formal_Subprogram_Declaration =>
1134 exit when Kind in N_Formal_Subprogram_Declaration
1137 (Defining_Unit_Name (Specification (Formal))) =
1139 (Defining_Unit_Name (Specification (Analyzed_Formal)));
1141 when N_Formal_Package_Declaration =>
1142 exit when Nkind_In (Kind, N_Formal_Package_Declaration,
1143 N_Generic_Package_Declaration,
1144 N_Package_Declaration);
1146 when N_Use_Package_Clause | N_Use_Type_Clause => exit;
1150 -- Skip freeze nodes, and nodes inserted to replace
1151 -- unrecognized pragmas.
1154 Kind not in N_Formal_Subprogram_Declaration
1155 and then not Nkind_In (Kind, N_Subprogram_Declaration,
1159 and then Chars (Defining_Identifier (Formal)) =
1160 Chars (Defining_Identifier (Analyzed_Formal));
1163 Next (Analyzed_Formal);
1165 end Set_Analyzed_Formal;
1167 -- Start of processing for Analyze_Associations
1170 Actuals := Generic_Associations (I_Node);
1172 if Present (Actuals) then
1174 -- Check for an Others choice, indicating a partial parametrization
1175 -- for a formal package.
1177 Actual := First (Actuals);
1178 while Present (Actual) loop
1179 if Nkind (Actual) = N_Others_Choice then
1180 Others_Present := True;
1181 Others_Choice := Actual;
1183 if Present (Next (Actual)) then
1184 Error_Msg_N ("others must be last association", Actual);
1187 -- This subprogram is used both for formal packages and for
1188 -- instantiations. For the latter, associations must all be
1191 if Nkind (I_Node) /= N_Formal_Package_Declaration
1192 and then Comes_From_Source (I_Node)
1195 ("others association not allowed in an instance",
1199 -- In any case, nothing to do after the others association
1203 elsif Box_Present (Actual)
1204 and then Comes_From_Source (I_Node)
1205 and then Nkind (I_Node) /= N_Formal_Package_Declaration
1208 ("box association not allowed in an instance", Actual);
1214 -- If named associations are present, save first named association
1215 -- (it may of course be Empty) to facilitate subsequent name search.
1217 First_Named := First (Actuals);
1218 while Present (First_Named)
1219 and then Nkind (First_Named) /= N_Others_Choice
1220 and then No (Selector_Name (First_Named))
1222 Num_Actuals := Num_Actuals + 1;
1227 Named := First_Named;
1228 while Present (Named) loop
1229 if Nkind (Named) /= N_Others_Choice
1230 and then No (Selector_Name (Named))
1232 Error_Msg_N ("invalid positional actual after named one", Named);
1233 Abandon_Instantiation (Named);
1236 -- A named association may lack an actual parameter, if it was
1237 -- introduced for a default subprogram that turns out to be local
1238 -- to the outer instantiation.
1240 if Nkind (Named) /= N_Others_Choice
1241 and then Present (Explicit_Generic_Actual_Parameter (Named))
1243 Num_Actuals := Num_Actuals + 1;
1249 if Present (Formals) then
1250 Formal := First_Non_Pragma (Formals);
1251 Analyzed_Formal := First_Non_Pragma (F_Copy);
1253 if Present (Actuals) then
1254 Actual := First (Actuals);
1256 -- All formals should have default values
1262 while Present (Formal) loop
1263 Set_Analyzed_Formal;
1264 Next_Formal := Next_Non_Pragma (Formal);
1266 case Nkind (Formal) is
1267 when N_Formal_Object_Declaration =>
1270 Defining_Identifier (Formal),
1271 Defining_Identifier (Analyzed_Formal));
1273 if No (Match) and then Partial_Parametrization then
1274 Process_Default (Formal);
1277 (Instantiate_Object (Formal, Match, Analyzed_Formal),
1281 when N_Formal_Type_Declaration =>
1284 Defining_Identifier (Formal),
1285 Defining_Identifier (Analyzed_Formal));
1288 if Partial_Parametrization then
1289 Process_Default (Formal);
1292 Error_Msg_Sloc := Sloc (Gen_Unit);
1296 Defining_Identifier (Formal));
1297 Error_Msg_NE ("\in instantiation of & declared#",
1298 Instantiation_Node, Gen_Unit);
1299 Abandon_Instantiation (Instantiation_Node);
1306 (Formal, Match, Analyzed_Formal, Assoc),
1309 -- An instantiation is a freeze point for the actuals,
1310 -- unless this is a rewritten formal package, or the
1311 -- formal is an Ada 2012 formal incomplete type.
1313 if Nkind (I_Node) /= N_Formal_Package_Declaration
1315 Ekind (Defining_Identifier (Analyzed_Formal)) /=
1318 Append_Elmt (Entity (Match), Actual_Types);
1322 -- A remote access-to-class-wide type is not a legal actual
1323 -- for a generic formal of an access type (E.2.2(17)).
1325 if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1327 Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1328 N_Access_To_Object_Definition
1330 Validate_Remote_Access_To_Class_Wide_Type (Match);
1333 when N_Formal_Subprogram_Declaration =>
1336 Defining_Unit_Name (Specification (Formal)),
1337 Defining_Unit_Name (Specification (Analyzed_Formal)));
1339 -- If the formal subprogram has the same name as another
1340 -- formal subprogram of the generic, then a named
1341 -- association is illegal (12.3(9)). Exclude named
1342 -- associations that are generated for a nested instance.
1345 and then Is_Named_Assoc
1346 and then Comes_From_Source (Found_Assoc)
1348 Check_Overloaded_Formal_Subprogram (Formal);
1351 -- If there is no corresponding actual, this may be case of
1352 -- partial parametrization, or else the formal has a default
1356 and then Partial_Parametrization
1358 Process_Default (Formal);
1359 if Nkind (I_Node) = N_Formal_Package_Declaration then
1360 Check_Overloaded_Formal_Subprogram (Formal);
1365 Instantiate_Formal_Subprogram
1366 (Formal, Match, Analyzed_Formal));
1369 -- If this is a nested generic, preserve default for later
1373 and then Box_Present (Formal)
1376 (Defining_Unit_Name (Specification (Last (Assoc))),
1380 when N_Formal_Package_Declaration =>
1383 Defining_Identifier (Formal),
1384 Defining_Identifier (Original_Node (Analyzed_Formal)));
1387 if Partial_Parametrization then
1388 Process_Default (Formal);
1391 Error_Msg_Sloc := Sloc (Gen_Unit);
1394 Instantiation_Node, Defining_Identifier (Formal));
1395 Error_Msg_NE ("\in instantiation of & declared#",
1396 Instantiation_Node, Gen_Unit);
1398 Abandon_Instantiation (Instantiation_Node);
1404 (Instantiate_Formal_Package
1405 (Formal, Match, Analyzed_Formal),
1409 -- For use type and use package appearing in the generic part,
1410 -- we have already copied them, so we can just move them where
1411 -- they belong (we mustn't recopy them since this would mess up
1412 -- the Sloc values).
1414 when N_Use_Package_Clause |
1415 N_Use_Type_Clause =>
1416 if Nkind (Original_Node (I_Node)) =
1417 N_Formal_Package_Declaration
1419 Append (New_Copy_Tree (Formal), Assoc);
1422 Append (Formal, Assoc);
1426 raise Program_Error;
1430 Formal := Next_Formal;
1431 Next_Non_Pragma (Analyzed_Formal);
1434 if Num_Actuals > Num_Matched then
1435 Error_Msg_Sloc := Sloc (Gen_Unit);
1437 if Present (Selector_Name (Actual)) then
1439 ("unmatched actual&",
1440 Actual, Selector_Name (Actual));
1441 Error_Msg_NE ("\in instantiation of& declared#",
1445 ("unmatched actual in instantiation of& declared#",
1450 elsif Present (Actuals) then
1452 ("too many actuals in generic instantiation", Instantiation_Node);
1456 Elmt : Elmt_Id := First_Elmt (Actual_Types);
1458 while Present (Elmt) loop
1459 Freeze_Before (I_Node, Node (Elmt));
1464 -- If there are default subprograms, normalize the tree by adding
1465 -- explicit associations for them. This is required if the instance
1466 -- appears within a generic.
1474 Elmt := First_Elmt (Default_Actuals);
1475 while Present (Elmt) loop
1476 if No (Actuals) then
1477 Actuals := New_List;
1478 Set_Generic_Associations (I_Node, Actuals);
1481 Subp := Node (Elmt);
1483 Make_Generic_Association (Sloc (Subp),
1484 Selector_Name => New_Occurrence_Of (Subp, Sloc (Subp)),
1485 Explicit_Generic_Actual_Parameter =>
1486 New_Occurrence_Of (Subp, Sloc (Subp)));
1487 Mark_Rewrite_Insertion (New_D);
1488 Append_To (Actuals, New_D);
1493 -- If this is a formal package, normalize the parameter list by adding
1494 -- explicit box associations for the formals that are covered by an
1497 if not Is_Empty_List (Default_Formals) then
1498 Append_List (Default_Formals, Formals);
1502 end Analyze_Associations;
1504 -------------------------------
1505 -- Analyze_Formal_Array_Type --
1506 -------------------------------
1508 procedure Analyze_Formal_Array_Type
1509 (T : in out Entity_Id;
1515 -- Treated like a non-generic array declaration, with additional
1520 if Nkind (Def) = N_Constrained_Array_Definition then
1521 DSS := First (Discrete_Subtype_Definitions (Def));
1522 while Present (DSS) loop
1523 if Nkind_In (DSS, N_Subtype_Indication,
1525 N_Attribute_Reference)
1527 Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
1534 Array_Type_Declaration (T, Def);
1535 Set_Is_Generic_Type (Base_Type (T));
1537 if Ekind (Component_Type (T)) = E_Incomplete_Type
1538 and then No (Full_View (Component_Type (T)))
1540 Error_Msg_N ("premature usage of incomplete type", Def);
1542 -- Check that range constraint is not allowed on the component type
1543 -- of a generic formal array type (AARM 12.5.3(3))
1545 elsif Is_Internal (Component_Type (T))
1546 and then Present (Subtype_Indication (Component_Definition (Def)))
1547 and then Nkind (Original_Node
1548 (Subtype_Indication (Component_Definition (Def)))) =
1549 N_Subtype_Indication
1552 ("in a formal, a subtype indication can only be "
1553 & "a subtype mark (RM 12.5.3(3))",
1554 Subtype_Indication (Component_Definition (Def)));
1557 end Analyze_Formal_Array_Type;
1559 ---------------------------------------------
1560 -- Analyze_Formal_Decimal_Fixed_Point_Type --
1561 ---------------------------------------------
1563 -- As for other generic types, we create a valid type representation with
1564 -- legal but arbitrary attributes, whose values are never considered
1565 -- static. For all scalar types we introduce an anonymous base type, with
1566 -- the same attributes. We choose the corresponding integer type to be
1567 -- Standard_Integer.
1568 -- Here and in other similar routines, the Sloc of the generated internal
1569 -- type must be the same as the sloc of the defining identifier of the
1570 -- formal type declaration, to provide proper source navigation.
1572 procedure Analyze_Formal_Decimal_Fixed_Point_Type
1576 Loc : constant Source_Ptr := Sloc (Def);
1577 Base : constant Entity_Id :=
1579 (E_Decimal_Fixed_Point_Type,
1581 Sloc (Defining_Identifier (Parent (Def))), 'G');
1582 Int_Base : constant Entity_Id := Standard_Integer;
1583 Delta_Val : constant Ureal := Ureal_1;
1584 Digs_Val : constant Uint := Uint_6;
1589 Set_Etype (Base, Base);
1590 Set_Size_Info (Base, Int_Base);
1591 Set_RM_Size (Base, RM_Size (Int_Base));
1592 Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
1593 Set_Digits_Value (Base, Digs_Val);
1594 Set_Delta_Value (Base, Delta_Val);
1595 Set_Small_Value (Base, Delta_Val);
1596 Set_Scalar_Range (Base,
1598 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
1599 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
1601 Set_Is_Generic_Type (Base);
1602 Set_Parent (Base, Parent (Def));
1604 Set_Ekind (T, E_Decimal_Fixed_Point_Subtype);
1605 Set_Etype (T, Base);
1606 Set_Size_Info (T, Int_Base);
1607 Set_RM_Size (T, RM_Size (Int_Base));
1608 Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
1609 Set_Digits_Value (T, Digs_Val);
1610 Set_Delta_Value (T, Delta_Val);
1611 Set_Small_Value (T, Delta_Val);
1612 Set_Scalar_Range (T, Scalar_Range (Base));
1613 Set_Is_Constrained (T);
1615 Check_Restriction (No_Fixed_Point, Def);
1616 end Analyze_Formal_Decimal_Fixed_Point_Type;
1618 -------------------------------------------
1619 -- Analyze_Formal_Derived_Interface_Type --
1620 -------------------------------------------
1622 procedure Analyze_Formal_Derived_Interface_Type
1627 Loc : constant Source_Ptr := Sloc (Def);
1630 -- Rewrite as a type declaration of a derived type. This ensures that
1631 -- the interface list and primitive operations are properly captured.
1634 Make_Full_Type_Declaration (Loc,
1635 Defining_Identifier => T,
1636 Type_Definition => Def));
1638 Set_Is_Generic_Type (T);
1639 end Analyze_Formal_Derived_Interface_Type;
1641 ---------------------------------
1642 -- Analyze_Formal_Derived_Type --
1643 ---------------------------------
1645 procedure Analyze_Formal_Derived_Type
1650 Loc : constant Source_Ptr := Sloc (Def);
1651 Unk_Disc : constant Boolean := Unknown_Discriminants_Present (N);
1655 Set_Is_Generic_Type (T);
1657 if Private_Present (Def) then
1659 Make_Private_Extension_Declaration (Loc,
1660 Defining_Identifier => T,
1661 Discriminant_Specifications => Discriminant_Specifications (N),
1662 Unknown_Discriminants_Present => Unk_Disc,
1663 Subtype_Indication => Subtype_Mark (Def),
1664 Interface_List => Interface_List (Def));
1666 Set_Abstract_Present (New_N, Abstract_Present (Def));
1667 Set_Limited_Present (New_N, Limited_Present (Def));
1668 Set_Synchronized_Present (New_N, Synchronized_Present (Def));
1672 Make_Full_Type_Declaration (Loc,
1673 Defining_Identifier => T,
1674 Discriminant_Specifications =>
1675 Discriminant_Specifications (Parent (T)),
1677 Make_Derived_Type_Definition (Loc,
1678 Subtype_Indication => Subtype_Mark (Def)));
1680 Set_Abstract_Present
1681 (Type_Definition (New_N), Abstract_Present (Def));
1683 (Type_Definition (New_N), Limited_Present (Def));
1690 if not Is_Composite_Type (T) then
1692 ("unknown discriminants not allowed for elementary types", N);
1694 Set_Has_Unknown_Discriminants (T);
1695 Set_Is_Constrained (T, False);
1699 -- If the parent type has a known size, so does the formal, which makes
1700 -- legal representation clauses that involve the formal.
1702 Set_Size_Known_At_Compile_Time
1703 (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
1704 end Analyze_Formal_Derived_Type;
1706 ----------------------------------
1707 -- Analyze_Formal_Discrete_Type --
1708 ----------------------------------
1710 -- The operations defined for a discrete types are those of an enumeration
1711 -- type. The size is set to an arbitrary value, for use in analyzing the
1714 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
1715 Loc : constant Source_Ptr := Sloc (Def);
1719 Base : constant Entity_Id :=
1721 (E_Floating_Point_Type, Current_Scope,
1722 Sloc (Defining_Identifier (Parent (Def))), 'G');
1725 Set_Ekind (T, E_Enumeration_Subtype);
1726 Set_Etype (T, Base);
1729 Set_Is_Generic_Type (T);
1730 Set_Is_Constrained (T);
1732 -- For semantic analysis, the bounds of the type must be set to some
1733 -- non-static value. The simplest is to create attribute nodes for those
1734 -- bounds, that refer to the type itself. These bounds are never
1735 -- analyzed but serve as place-holders.
1738 Make_Attribute_Reference (Loc,
1739 Attribute_Name => Name_First,
1740 Prefix => New_Reference_To (T, Loc));
1744 Make_Attribute_Reference (Loc,
1745 Attribute_Name => Name_Last,
1746 Prefix => New_Reference_To (T, Loc));
1749 Set_Scalar_Range (T,
1754 Set_Ekind (Base, E_Enumeration_Type);
1755 Set_Etype (Base, Base);
1756 Init_Size (Base, 8);
1757 Init_Alignment (Base);
1758 Set_Is_Generic_Type (Base);
1759 Set_Scalar_Range (Base, Scalar_Range (T));
1760 Set_Parent (Base, Parent (Def));
1761 end Analyze_Formal_Discrete_Type;
1763 ----------------------------------
1764 -- Analyze_Formal_Floating_Type --
1765 ---------------------------------
1767 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
1768 Base : constant Entity_Id :=
1770 (E_Floating_Point_Type, Current_Scope,
1771 Sloc (Defining_Identifier (Parent (Def))), 'G');
1774 -- The various semantic attributes are taken from the predefined type
1775 -- Float, just so that all of them are initialized. Their values are
1776 -- never used because no constant folding or expansion takes place in
1777 -- the generic itself.
1780 Set_Ekind (T, E_Floating_Point_Subtype);
1781 Set_Etype (T, Base);
1782 Set_Size_Info (T, (Standard_Float));
1783 Set_RM_Size (T, RM_Size (Standard_Float));
1784 Set_Digits_Value (T, Digits_Value (Standard_Float));
1785 Set_Scalar_Range (T, Scalar_Range (Standard_Float));
1786 Set_Is_Constrained (T);
1788 Set_Is_Generic_Type (Base);
1789 Set_Etype (Base, Base);
1790 Set_Size_Info (Base, (Standard_Float));
1791 Set_RM_Size (Base, RM_Size (Standard_Float));
1792 Set_Digits_Value (Base, Digits_Value (Standard_Float));
1793 Set_Scalar_Range (Base, Scalar_Range (Standard_Float));
1794 Set_Parent (Base, Parent (Def));
1796 Check_Restriction (No_Floating_Point, Def);
1797 end Analyze_Formal_Floating_Type;
1799 -----------------------------------
1800 -- Analyze_Formal_Interface_Type;--
1801 -----------------------------------
1803 procedure Analyze_Formal_Interface_Type
1808 Loc : constant Source_Ptr := Sloc (N);
1813 Make_Full_Type_Declaration (Loc,
1814 Defining_Identifier => T,
1815 Type_Definition => Def);
1819 Set_Is_Generic_Type (T);
1820 end Analyze_Formal_Interface_Type;
1822 ---------------------------------
1823 -- Analyze_Formal_Modular_Type --
1824 ---------------------------------
1826 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
1828 -- Apart from their entity kind, generic modular types are treated like
1829 -- signed integer types, and have the same attributes.
1831 Analyze_Formal_Signed_Integer_Type (T, Def);
1832 Set_Ekind (T, E_Modular_Integer_Subtype);
1833 Set_Ekind (Etype (T), E_Modular_Integer_Type);
1835 end Analyze_Formal_Modular_Type;
1837 ---------------------------------------
1838 -- Analyze_Formal_Object_Declaration --
1839 ---------------------------------------
1841 procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
1842 E : constant Node_Id := Default_Expression (N);
1843 Id : constant Node_Id := Defining_Identifier (N);
1850 -- Determine the mode of the formal object
1852 if Out_Present (N) then
1853 K := E_Generic_In_Out_Parameter;
1855 if not In_Present (N) then
1856 Error_Msg_N ("formal generic objects cannot have mode OUT", N);
1860 K := E_Generic_In_Parameter;
1863 if Present (Subtype_Mark (N)) then
1864 Find_Type (Subtype_Mark (N));
1865 T := Entity (Subtype_Mark (N));
1867 -- Verify that there is no redundant null exclusion
1869 if Null_Exclusion_Present (N) then
1870 if not Is_Access_Type (T) then
1872 ("null exclusion can only apply to an access type", N);
1874 elsif Can_Never_Be_Null (T) then
1876 ("`NOT NULL` not allowed (& already excludes null)",
1881 -- Ada 2005 (AI-423): Formal object with an access definition
1884 Check_Access_Definition (N);
1885 T := Access_Definition
1887 N => Access_Definition (N));
1890 if Ekind (T) = E_Incomplete_Type then
1892 Error_Node : Node_Id;
1895 if Present (Subtype_Mark (N)) then
1896 Error_Node := Subtype_Mark (N);
1898 Check_Access_Definition (N);
1899 Error_Node := Access_Definition (N);
1902 Error_Msg_N ("premature usage of incomplete type", Error_Node);
1906 if K = E_Generic_In_Parameter then
1908 -- Ada 2005 (AI-287): Limited aggregates allowed in generic formals
1910 if Ada_Version < Ada_2005 and then Is_Limited_Type (T) then
1912 ("generic formal of mode IN must not be of limited type", N);
1913 Explain_Limited_Type (T, N);
1916 if Is_Abstract_Type (T) then
1918 ("generic formal of mode IN must not be of abstract type", N);
1922 Preanalyze_Spec_Expression (E, T);
1924 if Is_Limited_Type (T) and then not OK_For_Limited_Init (T, E) then
1926 ("initialization not allowed for limited types", E);
1927 Explain_Limited_Type (T, E);
1934 -- Case of generic IN OUT parameter
1937 -- If the formal has an unconstrained type, construct its actual
1938 -- subtype, as is done for subprogram formals. In this fashion, all
1939 -- its uses can refer to specific bounds.
1944 if (Is_Array_Type (T)
1945 and then not Is_Constrained (T))
1947 (Ekind (T) = E_Record_Type
1948 and then Has_Discriminants (T))
1951 Non_Freezing_Ref : constant Node_Id :=
1952 New_Reference_To (Id, Sloc (Id));
1956 -- Make sure the actual subtype doesn't generate bogus freezing
1958 Set_Must_Not_Freeze (Non_Freezing_Ref);
1959 Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
1960 Insert_Before_And_Analyze (N, Decl);
1961 Set_Actual_Subtype (Id, Defining_Identifier (Decl));
1964 Set_Actual_Subtype (Id, T);
1969 ("initialization not allowed for `IN OUT` formals", N);
1973 if Has_Aspects (N) then
1974 Analyze_Aspect_Specifications (N, Id);
1976 end Analyze_Formal_Object_Declaration;
1978 ----------------------------------------------
1979 -- Analyze_Formal_Ordinary_Fixed_Point_Type --
1980 ----------------------------------------------
1982 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
1986 Loc : constant Source_Ptr := Sloc (Def);
1987 Base : constant Entity_Id :=
1989 (E_Ordinary_Fixed_Point_Type, Current_Scope,
1990 Sloc (Defining_Identifier (Parent (Def))), 'G');
1992 -- The semantic attributes are set for completeness only, their values
1993 -- will never be used, since all properties of the type are non-static.
1996 Set_Ekind (T, E_Ordinary_Fixed_Point_Subtype);
1997 Set_Etype (T, Base);
1998 Set_Size_Info (T, Standard_Integer);
1999 Set_RM_Size (T, RM_Size (Standard_Integer));
2000 Set_Small_Value (T, Ureal_1);
2001 Set_Delta_Value (T, Ureal_1);
2002 Set_Scalar_Range (T,
2004 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
2005 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
2006 Set_Is_Constrained (T);
2008 Set_Is_Generic_Type (Base);
2009 Set_Etype (Base, Base);
2010 Set_Size_Info (Base, Standard_Integer);
2011 Set_RM_Size (Base, RM_Size (Standard_Integer));
2012 Set_Small_Value (Base, Ureal_1);
2013 Set_Delta_Value (Base, Ureal_1);
2014 Set_Scalar_Range (Base, Scalar_Range (T));
2015 Set_Parent (Base, Parent (Def));
2017 Check_Restriction (No_Fixed_Point, Def);
2018 end Analyze_Formal_Ordinary_Fixed_Point_Type;
2020 ----------------------------------------
2021 -- Analyze_Formal_Package_Declaration --
2022 ----------------------------------------
2024 procedure Analyze_Formal_Package_Declaration (N : Node_Id) is
2025 Loc : constant Source_Ptr := Sloc (N);
2026 Pack_Id : constant Entity_Id := Defining_Identifier (N);
2028 Gen_Id : constant Node_Id := Name (N);
2030 Gen_Unit : Entity_Id;
2032 Parent_Installed : Boolean := False;
2034 Parent_Instance : Entity_Id;
2035 Renaming_In_Par : Entity_Id;
2036 Associations : Boolean := True;
2038 function Build_Local_Package return Node_Id;
2039 -- The formal package is rewritten so that its parameters are replaced
2040 -- with corresponding declarations. For parameters with bona fide
2041 -- associations these declarations are created by Analyze_Associations
2042 -- as for a regular instantiation. For boxed parameters, we preserve
2043 -- the formal declarations and analyze them, in order to introduce
2044 -- entities of the right kind in the environment of the formal.
2046 -------------------------
2047 -- Build_Local_Package --
2048 -------------------------
2050 function Build_Local_Package return Node_Id is
2052 Pack_Decl : Node_Id;
2055 -- Within the formal, the name of the generic package is a renaming
2056 -- of the formal (as for a regular instantiation).
2059 Make_Package_Declaration (Loc,
2062 (Specification (Original_Node (Gen_Decl)),
2063 Empty, Instantiating => True));
2065 Renaming := Make_Package_Renaming_Declaration (Loc,
2066 Defining_Unit_Name =>
2067 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2068 Name => New_Occurrence_Of (Formal, Loc));
2070 if Nkind (Gen_Id) = N_Identifier
2071 and then Chars (Gen_Id) = Chars (Pack_Id)
2074 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2077 -- If the formal is declared with a box, or with an others choice,
2078 -- create corresponding declarations for all entities in the formal
2079 -- part, so that names with the proper types are available in the
2080 -- specification of the formal package.
2082 -- On the other hand, if there are no associations, then all the
2083 -- formals must have defaults, and this will be checked by the
2084 -- call to Analyze_Associations.
2087 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2090 Formal_Decl : Node_Id;
2093 -- TBA : for a formal package, need to recurse ???
2098 (Generic_Formal_Declarations (Original_Node (Gen_Decl)));
2099 while Present (Formal_Decl) loop
2101 (Decls, Copy_Generic_Node (Formal_Decl, Empty, True));
2106 -- If generic associations are present, use Analyze_Associations to
2107 -- create the proper renaming declarations.
2111 Act_Tree : constant Node_Id :=
2113 (Original_Node (Gen_Decl), Empty,
2114 Instantiating => True);
2117 Generic_Renamings.Set_Last (0);
2118 Generic_Renamings_HTable.Reset;
2119 Instantiation_Node := N;
2122 Analyze_Associations
2124 Generic_Formal_Declarations (Act_Tree),
2125 Generic_Formal_Declarations (Gen_Decl));
2129 Append (Renaming, To => Decls);
2131 -- Add generated declarations ahead of local declarations in
2134 if No (Visible_Declarations (Specification (Pack_Decl))) then
2135 Set_Visible_Declarations (Specification (Pack_Decl), Decls);
2138 (First (Visible_Declarations (Specification (Pack_Decl))),
2143 end Build_Local_Package;
2145 -- Start of processing for Analyze_Formal_Package_Declaration
2148 Text_IO_Kludge (Gen_Id);
2151 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2152 Gen_Unit := Entity (Gen_Id);
2154 -- Check for a formal package that is a package renaming
2156 if Present (Renamed_Object (Gen_Unit)) then
2158 -- Indicate that unit is used, before replacing it with renamed
2159 -- entity for use below.
2161 if In_Extended_Main_Source_Unit (N) then
2162 Set_Is_Instantiated (Gen_Unit);
2163 Generate_Reference (Gen_Unit, N);
2166 Gen_Unit := Renamed_Object (Gen_Unit);
2169 if Ekind (Gen_Unit) /= E_Generic_Package then
2170 Error_Msg_N ("expect generic package name", Gen_Id);
2174 elsif Gen_Unit = Current_Scope then
2176 ("generic package cannot be used as a formal package of itself",
2181 elsif In_Open_Scopes (Gen_Unit) then
2182 if Is_Compilation_Unit (Gen_Unit)
2183 and then Is_Child_Unit (Current_Scope)
2185 -- Special-case the error when the formal is a parent, and
2186 -- continue analysis to minimize cascaded errors.
2189 ("generic parent cannot be used as formal package "
2190 & "of a child unit",
2195 ("generic package cannot be used as a formal package "
2203 -- Check that name of formal package does not hide name of generic,
2204 -- or its leading prefix. This check must be done separately because
2205 -- the name of the generic has already been analyzed.
2208 Gen_Name : Entity_Id;
2212 while Nkind (Gen_Name) = N_Expanded_Name loop
2213 Gen_Name := Prefix (Gen_Name);
2216 if Chars (Gen_Name) = Chars (Pack_Id) then
2218 ("& is hidden within declaration of formal package",
2224 or else No (Generic_Associations (N))
2225 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2227 Associations := False;
2230 -- If there are no generic associations, the generic parameters appear
2231 -- as local entities and are instantiated like them. We copy the generic
2232 -- package declaration as if it were an instantiation, and analyze it
2233 -- like a regular package, except that we treat the formals as
2234 -- additional visible components.
2236 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2238 if In_Extended_Main_Source_Unit (N) then
2239 Set_Is_Instantiated (Gen_Unit);
2240 Generate_Reference (Gen_Unit, N);
2243 Formal := New_Copy (Pack_Id);
2244 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2247 -- Make local generic without formals. The formals will be replaced
2248 -- with internal declarations.
2250 New_N := Build_Local_Package;
2252 -- If there are errors in the parameter list, Analyze_Associations
2253 -- raises Instantiation_Error. Patch the declaration to prevent
2254 -- further exception propagation.
2257 when Instantiation_Error =>
2259 Enter_Name (Formal);
2260 Set_Ekind (Formal, E_Variable);
2261 Set_Etype (Formal, Any_Type);
2263 if Parent_Installed then
2271 Set_Defining_Unit_Name (Specification (New_N), Formal);
2272 Set_Generic_Parent (Specification (N), Gen_Unit);
2273 Set_Instance_Env (Gen_Unit, Formal);
2274 Set_Is_Generic_Instance (Formal);
2276 Enter_Name (Formal);
2277 Set_Ekind (Formal, E_Package);
2278 Set_Etype (Formal, Standard_Void_Type);
2279 Set_Inner_Instances (Formal, New_Elmt_List);
2280 Push_Scope (Formal);
2282 if Is_Child_Unit (Gen_Unit)
2283 and then Parent_Installed
2285 -- Similarly, we have to make the name of the formal visible in the
2286 -- parent instance, to resolve properly fully qualified names that
2287 -- may appear in the generic unit. The parent instance has been
2288 -- placed on the scope stack ahead of the current scope.
2290 Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
2293 Make_Defining_Identifier (Loc, Chars (Gen_Unit));
2294 Set_Ekind (Renaming_In_Par, E_Package);
2295 Set_Etype (Renaming_In_Par, Standard_Void_Type);
2296 Set_Scope (Renaming_In_Par, Parent_Instance);
2297 Set_Parent (Renaming_In_Par, Parent (Formal));
2298 Set_Renamed_Object (Renaming_In_Par, Formal);
2299 Append_Entity (Renaming_In_Par, Parent_Instance);
2302 Analyze (Specification (N));
2304 -- The formals for which associations are provided are not visible
2305 -- outside of the formal package. The others are still declared by a
2306 -- formal parameter declaration.
2308 -- If there are no associations, the only local entity to hide is the
2309 -- generated package renaming itself.
2315 E := First_Entity (Formal);
2316 while Present (E) loop
2318 and then not Is_Generic_Formal (E)
2323 if Ekind (E) = E_Package
2324 and then Renamed_Entity (E) = Formal
2334 End_Package_Scope (Formal);
2336 if Parent_Installed then
2342 -- Inside the generic unit, the formal package is a regular package, but
2343 -- no body is needed for it. Note that after instantiation, the defining
2344 -- unit name we need is in the new tree and not in the original (see
2345 -- Package_Instantiation). A generic formal package is an instance, and
2346 -- can be used as an actual for an inner instance.
2348 Set_Has_Completion (Formal, True);
2350 -- Add semantic information to the original defining identifier.
2353 Set_Ekind (Pack_Id, E_Package);
2354 Set_Etype (Pack_Id, Standard_Void_Type);
2355 Set_Scope (Pack_Id, Scope (Formal));
2356 Set_Has_Completion (Pack_Id, True);
2359 if Has_Aspects (N) then
2360 Analyze_Aspect_Specifications (N, Pack_Id);
2362 end Analyze_Formal_Package_Declaration;
2364 ---------------------------------
2365 -- Analyze_Formal_Private_Type --
2366 ---------------------------------
2368 procedure Analyze_Formal_Private_Type
2374 New_Private_Type (N, T, Def);
2376 -- Set the size to an arbitrary but legal value
2378 Set_Size_Info (T, Standard_Integer);
2379 Set_RM_Size (T, RM_Size (Standard_Integer));
2380 end Analyze_Formal_Private_Type;
2382 ------------------------------------
2383 -- Analyze_Formal_Incomplete_Type --
2384 ------------------------------------
2386 procedure Analyze_Formal_Incomplete_Type
2392 Set_Ekind (T, E_Incomplete_Type);
2394 Set_Private_Dependents (T, New_Elmt_List);
2396 if Tagged_Present (Def) then
2397 Set_Is_Tagged_Type (T);
2398 Make_Class_Wide_Type (T);
2399 Set_Direct_Primitive_Operations (T, New_Elmt_List);
2401 end Analyze_Formal_Incomplete_Type;
2403 ----------------------------------------
2404 -- Analyze_Formal_Signed_Integer_Type --
2405 ----------------------------------------
2407 procedure Analyze_Formal_Signed_Integer_Type
2411 Base : constant Entity_Id :=
2413 (E_Signed_Integer_Type,
2415 Sloc (Defining_Identifier (Parent (Def))), 'G');
2420 Set_Ekind (T, E_Signed_Integer_Subtype);
2421 Set_Etype (T, Base);
2422 Set_Size_Info (T, Standard_Integer);
2423 Set_RM_Size (T, RM_Size (Standard_Integer));
2424 Set_Scalar_Range (T, Scalar_Range (Standard_Integer));
2425 Set_Is_Constrained (T);
2427 Set_Is_Generic_Type (Base);
2428 Set_Size_Info (Base, Standard_Integer);
2429 Set_RM_Size (Base, RM_Size (Standard_Integer));
2430 Set_Etype (Base, Base);
2431 Set_Scalar_Range (Base, Scalar_Range (Standard_Integer));
2432 Set_Parent (Base, Parent (Def));
2433 end Analyze_Formal_Signed_Integer_Type;
2435 -------------------------------------------
2436 -- Analyze_Formal_Subprogram_Declaration --
2437 -------------------------------------------
2439 procedure Analyze_Formal_Subprogram_Declaration (N : Node_Id) is
2440 Spec : constant Node_Id := Specification (N);
2441 Def : constant Node_Id := Default_Name (N);
2442 Nam : constant Entity_Id := Defining_Unit_Name (Spec);
2450 if Nkind (Nam) = N_Defining_Program_Unit_Name then
2451 Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
2455 Analyze_Subprogram_Declaration (N);
2456 Set_Is_Formal_Subprogram (Nam);
2457 Set_Has_Completion (Nam);
2459 if Nkind (N) = N_Formal_Abstract_Subprogram_Declaration then
2460 Set_Is_Abstract_Subprogram (Nam);
2461 Set_Is_Dispatching_Operation (Nam);
2464 Ctrl_Type : constant Entity_Id := Find_Dispatching_Type (Nam);
2466 if No (Ctrl_Type) then
2468 ("abstract formal subprogram must have a controlling type",
2471 Check_Controlling_Formals (Ctrl_Type, Nam);
2476 -- Default name is resolved at the point of instantiation
2478 if Box_Present (N) then
2481 -- Else default is bound at the point of generic declaration
2483 elsif Present (Def) then
2484 if Nkind (Def) = N_Operator_Symbol then
2485 Find_Direct_Name (Def);
2487 elsif Nkind (Def) /= N_Attribute_Reference then
2491 -- For an attribute reference, analyze the prefix and verify
2492 -- that it has the proper profile for the subprogram.
2494 Analyze (Prefix (Def));
2495 Valid_Default_Attribute (Nam, Def);
2499 -- Default name may be overloaded, in which case the interpretation
2500 -- with the correct profile must be selected, as for a renaming.
2501 -- If the definition is an indexed component, it must denote a
2502 -- member of an entry family. If it is a selected component, it
2503 -- can be a protected operation.
2505 if Etype (Def) = Any_Type then
2508 elsif Nkind (Def) = N_Selected_Component then
2509 if not Is_Overloadable (Entity (Selector_Name (Def))) then
2510 Error_Msg_N ("expect valid subprogram name as default", Def);
2513 elsif Nkind (Def) = N_Indexed_Component then
2514 if Is_Entity_Name (Prefix (Def)) then
2515 if Ekind (Entity (Prefix (Def))) /= E_Entry_Family then
2516 Error_Msg_N ("expect valid subprogram name as default", Def);
2519 elsif Nkind (Prefix (Def)) = N_Selected_Component then
2520 if Ekind (Entity (Selector_Name (Prefix (Def)))) /=
2523 Error_Msg_N ("expect valid subprogram name as default", Def);
2527 Error_Msg_N ("expect valid subprogram name as default", Def);
2531 elsif Nkind (Def) = N_Character_Literal then
2533 -- Needs some type checks: subprogram should be parameterless???
2535 Resolve (Def, (Etype (Nam)));
2537 elsif not Is_Entity_Name (Def)
2538 or else not Is_Overloadable (Entity (Def))
2540 Error_Msg_N ("expect valid subprogram name as default", Def);
2543 elsif not Is_Overloaded (Def) then
2544 Subp := Entity (Def);
2547 Error_Msg_N ("premature usage of formal subprogram", Def);
2549 elsif not Entity_Matches_Spec (Subp, Nam) then
2550 Error_Msg_N ("no visible entity matches specification", Def);
2553 -- More than one interpretation, so disambiguate as for a renaming
2558 I1 : Interp_Index := 0;
2564 Get_First_Interp (Def, I, It);
2565 while Present (It.Nam) loop
2566 if Entity_Matches_Spec (It.Nam, Nam) then
2567 if Subp /= Any_Id then
2568 It1 := Disambiguate (Def, I1, I, Etype (Subp));
2570 if It1 = No_Interp then
2571 Error_Msg_N ("ambiguous default subprogram", Def);
2584 Get_Next_Interp (I, It);
2588 if Subp /= Any_Id then
2590 -- Subprogram found, generate reference to it
2592 Set_Entity (Def, Subp);
2593 Generate_Reference (Subp, Def);
2596 Error_Msg_N ("premature usage of formal subprogram", Def);
2598 elsif Ekind (Subp) /= E_Operator then
2599 Check_Mode_Conformant (Subp, Nam);
2603 Error_Msg_N ("no visible subprogram matches specification", N);
2609 if Has_Aspects (N) then
2610 Analyze_Aspect_Specifications (N, Nam);
2613 end Analyze_Formal_Subprogram_Declaration;
2615 -------------------------------------
2616 -- Analyze_Formal_Type_Declaration --
2617 -------------------------------------
2619 procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
2620 Def : constant Node_Id := Formal_Type_Definition (N);
2624 T := Defining_Identifier (N);
2626 if Present (Discriminant_Specifications (N))
2627 and then Nkind (Def) /= N_Formal_Private_Type_Definition
2630 ("discriminants not allowed for this formal type", T);
2633 -- Enter the new name, and branch to specific routine
2636 when N_Formal_Private_Type_Definition =>
2637 Analyze_Formal_Private_Type (N, T, Def);
2639 when N_Formal_Derived_Type_Definition =>
2640 Analyze_Formal_Derived_Type (N, T, Def);
2642 when N_Formal_Incomplete_Type_Definition =>
2643 Analyze_Formal_Incomplete_Type (T, Def);
2645 when N_Formal_Discrete_Type_Definition =>
2646 Analyze_Formal_Discrete_Type (T, Def);
2648 when N_Formal_Signed_Integer_Type_Definition =>
2649 Analyze_Formal_Signed_Integer_Type (T, Def);
2651 when N_Formal_Modular_Type_Definition =>
2652 Analyze_Formal_Modular_Type (T, Def);
2654 when N_Formal_Floating_Point_Definition =>
2655 Analyze_Formal_Floating_Type (T, Def);
2657 when N_Formal_Ordinary_Fixed_Point_Definition =>
2658 Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
2660 when N_Formal_Decimal_Fixed_Point_Definition =>
2661 Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
2663 when N_Array_Type_Definition =>
2664 Analyze_Formal_Array_Type (T, Def);
2666 when N_Access_To_Object_Definition |
2667 N_Access_Function_Definition |
2668 N_Access_Procedure_Definition =>
2669 Analyze_Generic_Access_Type (T, Def);
2671 -- Ada 2005: a interface declaration is encoded as an abstract
2672 -- record declaration or a abstract type derivation.
2674 when N_Record_Definition =>
2675 Analyze_Formal_Interface_Type (N, T, Def);
2677 when N_Derived_Type_Definition =>
2678 Analyze_Formal_Derived_Interface_Type (N, T, Def);
2684 raise Program_Error;
2688 Set_Is_Generic_Type (T);
2690 if Has_Aspects (N) then
2691 Analyze_Aspect_Specifications (N, T);
2693 end Analyze_Formal_Type_Declaration;
2695 ------------------------------------
2696 -- Analyze_Function_Instantiation --
2697 ------------------------------------
2699 procedure Analyze_Function_Instantiation (N : Node_Id) is
2701 Analyze_Subprogram_Instantiation (N, E_Function);
2702 end Analyze_Function_Instantiation;
2704 ---------------------------------
2705 -- Analyze_Generic_Access_Type --
2706 ---------------------------------
2708 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
2712 if Nkind (Def) = N_Access_To_Object_Definition then
2713 Access_Type_Declaration (T, Def);
2715 if Is_Incomplete_Or_Private_Type (Designated_Type (T))
2716 and then No (Full_View (Designated_Type (T)))
2717 and then not Is_Generic_Type (Designated_Type (T))
2719 Error_Msg_N ("premature usage of incomplete type", Def);
2721 elsif not Is_Entity_Name (Subtype_Indication (Def)) then
2723 ("only a subtype mark is allowed in a formal", Def);
2727 Access_Subprogram_Declaration (T, Def);
2729 end Analyze_Generic_Access_Type;
2731 ---------------------------------
2732 -- Analyze_Generic_Formal_Part --
2733 ---------------------------------
2735 procedure Analyze_Generic_Formal_Part (N : Node_Id) is
2736 Gen_Parm_Decl : Node_Id;
2739 -- The generic formals are processed in the scope of the generic unit,
2740 -- where they are immediately visible. The scope is installed by the
2743 Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
2745 while Present (Gen_Parm_Decl) loop
2746 Analyze (Gen_Parm_Decl);
2747 Next (Gen_Parm_Decl);
2750 Generate_Reference_To_Generic_Formals (Current_Scope);
2751 end Analyze_Generic_Formal_Part;
2753 ------------------------------------------
2754 -- Analyze_Generic_Package_Declaration --
2755 ------------------------------------------
2757 procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
2758 Loc : constant Source_Ptr := Sloc (N);
2761 Save_Parent : Node_Id;
2763 Decls : constant List_Id :=
2764 Visible_Declarations (Specification (N));
2768 Check_SPARK_Restriction ("generic is not allowed", N);
2770 -- We introduce a renaming of the enclosing package, to have a usable
2771 -- entity as the prefix of an expanded name for a local entity of the
2772 -- form Par.P.Q, where P is the generic package. This is because a local
2773 -- entity named P may hide it, so that the usual visibility rules in
2774 -- the instance will not resolve properly.
2777 Make_Package_Renaming_Declaration (Loc,
2778 Defining_Unit_Name =>
2779 Make_Defining_Identifier (Loc,
2780 Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
2781 Name => Make_Identifier (Loc, Chars (Defining_Entity (N))));
2783 if Present (Decls) then
2784 Decl := First (Decls);
2785 while Present (Decl)
2786 and then Nkind (Decl) = N_Pragma
2791 if Present (Decl) then
2792 Insert_Before (Decl, Renaming);
2794 Append (Renaming, Visible_Declarations (Specification (N)));
2798 Set_Visible_Declarations (Specification (N), New_List (Renaming));
2801 -- Create copy of generic unit, and save for instantiation. If the unit
2802 -- is a child unit, do not copy the specifications for the parent, which
2803 -- are not part of the generic tree.
2805 Save_Parent := Parent_Spec (N);
2806 Set_Parent_Spec (N, Empty);
2808 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
2809 Set_Parent_Spec (New_N, Save_Parent);
2811 Id := Defining_Entity (N);
2812 Generate_Definition (Id);
2814 -- Expansion is not applied to generic units
2819 Set_Ekind (Id, E_Generic_Package);
2820 Set_Etype (Id, Standard_Void_Type);
2822 Enter_Generic_Scope (Id);
2823 Set_Inner_Instances (Id, New_Elmt_List);
2825 Set_Categorization_From_Pragmas (N);
2826 Set_Is_Pure (Id, Is_Pure (Current_Scope));
2828 -- Link the declaration of the generic homonym in the generic copy to
2829 -- the package it renames, so that it is always resolved properly.
2831 Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
2832 Set_Entity (Associated_Node (Name (Renaming)), Id);
2834 -- For a library unit, we have reconstructed the entity for the unit,
2835 -- and must reset it in the library tables.
2837 if Nkind (Parent (N)) = N_Compilation_Unit then
2838 Set_Cunit_Entity (Current_Sem_Unit, Id);
2841 Analyze_Generic_Formal_Part (N);
2843 -- After processing the generic formals, analysis proceeds as for a
2844 -- non-generic package.
2846 Analyze (Specification (N));
2848 Validate_Categorization_Dependency (N, Id);
2852 End_Package_Scope (Id);
2853 Exit_Generic_Scope (Id);
2855 if Nkind (Parent (N)) /= N_Compilation_Unit then
2856 Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
2857 Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
2858 Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
2861 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
2862 Validate_RT_RAT_Component (N);
2864 -- If this is a spec without a body, check that generic parameters
2867 if not Body_Required (Parent (N)) then
2868 Check_References (Id);
2872 if Has_Aspects (N) then
2873 Analyze_Aspect_Specifications (N, Id);
2875 end Analyze_Generic_Package_Declaration;
2877 --------------------------------------------
2878 -- Analyze_Generic_Subprogram_Declaration --
2879 --------------------------------------------
2881 procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
2886 Result_Type : Entity_Id;
2887 Save_Parent : Node_Id;
2891 Check_SPARK_Restriction ("generic is not allowed", N);
2893 -- Create copy of generic unit, and save for instantiation. If the unit
2894 -- is a child unit, do not copy the specifications for the parent, which
2895 -- are not part of the generic tree.
2897 Save_Parent := Parent_Spec (N);
2898 Set_Parent_Spec (N, Empty);
2900 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
2901 Set_Parent_Spec (New_N, Save_Parent);
2904 -- The aspect specifications are not attached to the tree, and must
2905 -- be copied and attached to the generic copy explicitly.
2907 if Present (Aspect_Specifications (New_N)) then
2909 Aspects : constant List_Id := Aspect_Specifications (N);
2911 Set_Has_Aspects (N, False);
2912 Move_Aspects (New_N, N);
2913 Set_Has_Aspects (Original_Node (N), False);
2914 Set_Aspect_Specifications (Original_Node (N), Aspects);
2918 Spec := Specification (N);
2919 Id := Defining_Entity (Spec);
2920 Generate_Definition (Id);
2921 Set_Contract (Id, Make_Contract (Sloc (Id)));
2923 if Nkind (Id) = N_Defining_Operator_Symbol then
2925 ("operator symbol not allowed for generic subprogram", Id);
2932 Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
2934 Enter_Generic_Scope (Id);
2935 Set_Inner_Instances (Id, New_Elmt_List);
2936 Set_Is_Pure (Id, Is_Pure (Current_Scope));
2938 Analyze_Generic_Formal_Part (N);
2940 Formals := Parameter_Specifications (Spec);
2942 if Present (Formals) then
2943 Process_Formals (Formals, Spec);
2946 if Nkind (Spec) = N_Function_Specification then
2947 Set_Ekind (Id, E_Generic_Function);
2949 if Nkind (Result_Definition (Spec)) = N_Access_Definition then
2950 Result_Type := Access_Definition (Spec, Result_Definition (Spec));
2951 Set_Etype (Id, Result_Type);
2953 -- Check restriction imposed by AI05-073: a generic function
2954 -- cannot return an abstract type or an access to such.
2956 -- This is a binding interpretation should it apply to earlier
2957 -- versions of Ada as well as Ada 2012???
2959 if Is_Abstract_Type (Designated_Type (Result_Type))
2960 and then Ada_Version >= Ada_2012
2962 Error_Msg_N ("generic function cannot have an access result"
2963 & " that designates an abstract type", Spec);
2967 Find_Type (Result_Definition (Spec));
2968 Typ := Entity (Result_Definition (Spec));
2970 if Is_Abstract_Type (Typ)
2971 and then Ada_Version >= Ada_2012
2974 ("generic function cannot have abstract result type", Spec);
2977 -- If a null exclusion is imposed on the result type, then create
2978 -- a null-excluding itype (an access subtype) and use it as the
2979 -- function's Etype.
2981 if Is_Access_Type (Typ)
2982 and then Null_Exclusion_Present (Spec)
2985 Create_Null_Excluding_Itype
2987 Related_Nod => Spec,
2988 Scope_Id => Defining_Unit_Name (Spec)));
2990 Set_Etype (Id, Typ);
2995 Set_Ekind (Id, E_Generic_Procedure);
2996 Set_Etype (Id, Standard_Void_Type);
2999 -- For a library unit, we have reconstructed the entity for the unit,
3000 -- and must reset it in the library tables. We also make sure that
3001 -- Body_Required is set properly in the original compilation unit node.
3003 if Nkind (Parent (N)) = N_Compilation_Unit then
3004 Set_Cunit_Entity (Current_Sem_Unit, Id);
3005 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3008 Set_Categorization_From_Pragmas (N);
3009 Validate_Categorization_Dependency (N, Id);
3011 Save_Global_References (Original_Node (N));
3013 -- To capture global references, analyze the expressions of aspects,
3014 -- and propagate information to original tree. Note that in this case
3015 -- analysis of attributes is not delayed until the freeze point.
3017 -- It seems very hard to recreate the proper visibility of the generic
3018 -- subprogram at a later point because the analysis of an aspect may
3019 -- create pragmas after the generic copies have been made ???
3021 if Has_Aspects (N) then
3026 Aspect := First (Aspect_Specifications (N));
3027 while Present (Aspect) loop
3028 if Get_Aspect_Id (Chars (Identifier (Aspect)))
3031 Analyze (Expression (Aspect));
3036 Aspect := First (Aspect_Specifications (Original_Node (N)));
3037 while Present (Aspect) loop
3038 Save_Global_References (Expression (Aspect));
3046 Exit_Generic_Scope (Id);
3047 Generate_Reference_To_Formals (Id);
3049 List_Inherited_Pre_Post_Aspects (Id);
3050 end Analyze_Generic_Subprogram_Declaration;
3052 -----------------------------------
3053 -- Analyze_Package_Instantiation --
3054 -----------------------------------
3056 procedure Analyze_Package_Instantiation (N : Node_Id) is
3057 Loc : constant Source_Ptr := Sloc (N);
3058 Gen_Id : constant Node_Id := Name (N);
3061 Act_Decl_Name : Node_Id;
3062 Act_Decl_Id : Entity_Id;
3067 Gen_Unit : Entity_Id;
3069 Is_Actual_Pack : constant Boolean :=
3070 Is_Internal (Defining_Entity (N));
3072 Env_Installed : Boolean := False;
3073 Parent_Installed : Boolean := False;
3074 Renaming_List : List_Id;
3075 Unit_Renaming : Node_Id;
3076 Needs_Body : Boolean;
3077 Inline_Now : Boolean := False;
3079 Save_Style_Check : constant Boolean := Style_Check;
3080 -- Save style check mode for restore on exit
3082 procedure Delay_Descriptors (E : Entity_Id);
3083 -- Delay generation of subprogram descriptors for given entity
3085 function Might_Inline_Subp return Boolean;
3086 -- If inlining is active and the generic contains inlined subprograms,
3087 -- we instantiate the body. This may cause superfluous instantiations,
3088 -- but it is simpler than detecting the need for the body at the point
3089 -- of inlining, when the context of the instance is not available.
3091 -----------------------
3092 -- Delay_Descriptors --
3093 -----------------------
3095 procedure Delay_Descriptors (E : Entity_Id) is
3097 if not Delay_Subprogram_Descriptors (E) then
3098 Set_Delay_Subprogram_Descriptors (E);
3099 Pending_Descriptor.Append (E);
3101 end Delay_Descriptors;
3103 -----------------------
3104 -- Might_Inline_Subp --
3105 -----------------------
3107 function Might_Inline_Subp return Boolean is
3111 if not Inline_Processing_Required then
3115 E := First_Entity (Gen_Unit);
3116 while Present (E) loop
3117 if Is_Subprogram (E)
3118 and then Is_Inlined (E)
3128 end Might_Inline_Subp;
3130 -- Start of processing for Analyze_Package_Instantiation
3133 Check_SPARK_Restriction ("generic is not allowed", N);
3135 -- Very first thing: apply the special kludge for Text_IO processing
3136 -- in case we are instantiating one of the children of [Wide_]Text_IO.
3138 Text_IO_Kludge (Name (N));
3140 -- Make node global for error reporting
3142 Instantiation_Node := N;
3144 -- Turn off style checking in instances. If the check is enabled on the
3145 -- generic unit, a warning in an instance would just be noise. If not
3146 -- enabled on the generic, then a warning in an instance is just wrong.
3148 Style_Check := False;
3150 -- Case of instantiation of a generic package
3152 if Nkind (N) = N_Package_Instantiation then
3153 Act_Decl_Id := New_Copy (Defining_Entity (N));
3154 Set_Comes_From_Source (Act_Decl_Id, True);
3156 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3158 Make_Defining_Program_Unit_Name (Loc,
3159 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
3160 Defining_Identifier => Act_Decl_Id);
3162 Act_Decl_Name := Act_Decl_Id;
3165 -- Case of instantiation of a formal package
3168 Act_Decl_Id := Defining_Identifier (N);
3169 Act_Decl_Name := Act_Decl_Id;
3172 Generate_Definition (Act_Decl_Id);
3173 Preanalyze_Actuals (N);
3176 Env_Installed := True;
3178 -- Reset renaming map for formal types. The mapping is established
3179 -- when analyzing the generic associations, but some mappings are
3180 -- inherited from formal packages of parent units, and these are
3181 -- constructed when the parents are installed.
3183 Generic_Renamings.Set_Last (0);
3184 Generic_Renamings_HTable.Reset;
3186 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3187 Gen_Unit := Entity (Gen_Id);
3189 -- Verify that it is the name of a generic package
3191 -- A visibility glitch: if the instance is a child unit and the generic
3192 -- is the generic unit of a parent instance (i.e. both the parent and
3193 -- the child units are instances of the same package) the name now
3194 -- denotes the renaming within the parent, not the intended generic
3195 -- unit. See if there is a homonym that is the desired generic. The
3196 -- renaming declaration must be visible inside the instance of the
3197 -- child, but not when analyzing the name in the instantiation itself.
3199 if Ekind (Gen_Unit) = E_Package
3200 and then Present (Renamed_Entity (Gen_Unit))
3201 and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3202 and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3203 and then Present (Homonym (Gen_Unit))
3205 Gen_Unit := Homonym (Gen_Unit);
3208 if Etype (Gen_Unit) = Any_Type then
3212 elsif Ekind (Gen_Unit) /= E_Generic_Package then
3214 -- Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3216 if From_With_Type (Gen_Unit) then
3218 ("cannot instantiate a limited withed package", Gen_Id);
3221 ("expect name of generic package in instantiation", Gen_Id);
3228 if In_Extended_Main_Source_Unit (N) then
3229 Set_Is_Instantiated (Gen_Unit);
3230 Generate_Reference (Gen_Unit, N);
3232 if Present (Renamed_Object (Gen_Unit)) then
3233 Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3234 Generate_Reference (Renamed_Object (Gen_Unit), N);
3238 if Nkind (Gen_Id) = N_Identifier
3239 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3242 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3244 elsif Nkind (Gen_Id) = N_Expanded_Name
3245 and then Is_Child_Unit (Gen_Unit)
3246 and then Nkind (Prefix (Gen_Id)) = N_Identifier
3247 and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3250 ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3253 Set_Entity (Gen_Id, Gen_Unit);
3255 -- If generic is a renaming, get original generic unit
3257 if Present (Renamed_Object (Gen_Unit))
3258 and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3260 Gen_Unit := Renamed_Object (Gen_Unit);
3263 -- Verify that there are no circular instantiations
3265 if In_Open_Scopes (Gen_Unit) then
3266 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3270 elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3271 Error_Msg_Node_2 := Current_Scope;
3273 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3274 Circularity_Detected := True;
3279 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3281 -- Initialize renamings map, for error checking, and the list that
3282 -- holds private entities whose views have changed between generic
3283 -- definition and instantiation. If this is the instance created to
3284 -- validate an actual package, the instantiation environment is that
3285 -- of the enclosing instance.
3287 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3289 -- Copy original generic tree, to produce text for instantiation
3293 (Original_Node (Gen_Decl), Empty, Instantiating => True);
3295 Act_Spec := Specification (Act_Tree);
3297 -- If this is the instance created to validate an actual package,
3298 -- only the formals matter, do not examine the package spec itself.
3300 if Is_Actual_Pack then
3301 Set_Visible_Declarations (Act_Spec, New_List);
3302 Set_Private_Declarations (Act_Spec, New_List);
3306 Analyze_Associations
3308 Generic_Formal_Declarations (Act_Tree),
3309 Generic_Formal_Declarations (Gen_Decl));
3311 Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3312 Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3313 Set_Is_Generic_Instance (Act_Decl_Id);
3315 Set_Generic_Parent (Act_Spec, Gen_Unit);
3317 -- References to the generic in its own declaration or its body are
3318 -- references to the instance. Add a renaming declaration for the
3319 -- generic unit itself. This declaration, as well as the renaming
3320 -- declarations for the generic formals, must remain private to the
3321 -- unit: the formals, because this is the language semantics, and
3322 -- the unit because its use is an artifact of the implementation.
3325 Make_Package_Renaming_Declaration (Loc,
3326 Defining_Unit_Name =>
3327 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3328 Name => New_Reference_To (Act_Decl_Id, Loc));
3330 Append (Unit_Renaming, Renaming_List);
3332 -- The renaming declarations are the first local declarations of
3335 if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3337 (First (Visible_Declarations (Act_Spec)), Renaming_List);
3339 Set_Visible_Declarations (Act_Spec, Renaming_List);
3343 Make_Package_Declaration (Loc,
3344 Specification => Act_Spec);
3346 -- Save the instantiation node, for subsequent instantiation of the
3347 -- body, if there is one and we are generating code for the current
3348 -- unit. Mark the unit as having a body, to avoid a premature error
3351 -- We instantiate the body if we are generating code, if we are
3352 -- generating cross-reference information, or if we are building
3353 -- trees for ASIS use.
3356 Enclosing_Body_Present : Boolean := False;
3357 -- If the generic unit is not a compilation unit, then a body may
3358 -- be present in its parent even if none is required. We create a
3359 -- tentative pending instantiation for the body, which will be
3360 -- discarded if none is actually present.
3365 if Scope (Gen_Unit) /= Standard_Standard
3366 and then not Is_Child_Unit (Gen_Unit)
3368 Scop := Scope (Gen_Unit);
3370 while Present (Scop)
3371 and then Scop /= Standard_Standard
3373 if Unit_Requires_Body (Scop) then
3374 Enclosing_Body_Present := True;
3377 elsif In_Open_Scopes (Scop)
3378 and then In_Package_Body (Scop)
3380 Enclosing_Body_Present := True;
3384 exit when Is_Compilation_Unit (Scop);
3385 Scop := Scope (Scop);
3389 -- If front-end inlining is enabled, and this is a unit for which
3390 -- code will be generated, we instantiate the body at once.
3392 -- This is done if the instance is not the main unit, and if the
3393 -- generic is not a child unit of another generic, to avoid scope
3394 -- problems and the reinstallation of parent instances.
3397 and then (not Is_Child_Unit (Gen_Unit)
3398 or else not Is_Generic_Unit (Scope (Gen_Unit)))
3399 and then Might_Inline_Subp
3400 and then not Is_Actual_Pack
3402 if Front_End_Inlining
3403 and then (Is_In_Main_Unit (N)
3404 or else In_Main_Context (Current_Scope))
3405 and then Nkind (Parent (N)) /= N_Compilation_Unit
3409 -- In configurable_run_time mode we force the inlining of
3410 -- predefined subprograms marked Inline_Always, to minimize
3411 -- the use of the run-time library.
3413 elsif Is_Predefined_File_Name
3414 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
3415 and then Configurable_Run_Time_Mode
3416 and then Nkind (Parent (N)) /= N_Compilation_Unit
3421 -- If the current scope is itself an instance within a child
3422 -- unit, there will be duplications in the scope stack, and the
3423 -- unstacking mechanism in Inline_Instance_Body will fail.
3424 -- This loses some rare cases of optimization, and might be
3425 -- improved some day, if we can find a proper abstraction for
3426 -- "the complete compilation context" that can be saved and
3429 if Is_Generic_Instance (Current_Scope) then
3431 Curr_Unit : constant Entity_Id :=
3432 Cunit_Entity (Current_Sem_Unit);
3434 if Curr_Unit /= Current_Scope
3435 and then Is_Child_Unit (Curr_Unit)
3437 Inline_Now := False;
3444 (Unit_Requires_Body (Gen_Unit)
3445 or else Enclosing_Body_Present
3446 or else Present (Corresponding_Body (Gen_Decl)))
3447 and then (Is_In_Main_Unit (N)
3448 or else Might_Inline_Subp)
3449 and then not Is_Actual_Pack
3450 and then not Inline_Now
3451 and then not Alfa_Mode
3452 and then (Operating_Mode = Generate_Code
3453 or else (Operating_Mode = Check_Semantics
3454 and then ASIS_Mode));
3456 -- If front_end_inlining is enabled, do not instantiate body if
3457 -- within a generic context.
3459 if (Front_End_Inlining
3460 and then not Expander_Active)
3461 or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
3463 Needs_Body := False;
3466 -- If the current context is generic, and the package being
3467 -- instantiated is declared within a formal package, there is no
3468 -- body to instantiate until the enclosing generic is instantiated
3469 -- and there is an actual for the formal package. If the formal
3470 -- package has parameters, we build a regular package instance for
3471 -- it, that precedes the original formal package declaration.
3473 if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
3475 Decl : constant Node_Id :=
3477 (Unit_Declaration_Node (Scope (Gen_Unit)));
3479 if Nkind (Decl) = N_Formal_Package_Declaration
3480 or else (Nkind (Decl) = N_Package_Declaration
3481 and then Is_List_Member (Decl)
3482 and then Present (Next (Decl))
3484 Nkind (Next (Decl)) =
3485 N_Formal_Package_Declaration)
3487 Needs_Body := False;
3493 -- Note that we generate the instance body even when generating
3494 -- calling stubs for an RCI unit: it may be required e.g. if it
3495 -- provides stream attributes for some type used in the profile of a
3496 -- remote subprogram. If the instantiation is within the visible part
3497 -- of the RCI, then calling stubs for any relevant subprogram will
3498 -- be inserted immediately after the subprogram declaration, and
3499 -- will take precedence over the subsequent (original) body. (The
3500 -- stub and original body will be complete homographs, but this is
3501 -- permitted in an instance).
3503 -- Could we do better and remove the original subprogram body in that
3508 -- Here is a defence against a ludicrous number of instantiations
3509 -- caused by a circular set of instantiation attempts.
3511 if Pending_Instantiations.Last >
3512 Hostparm.Max_Instantiations
3514 Error_Msg_N ("too many instantiations", N);
3515 raise Unrecoverable_Error;
3518 -- Indicate that the enclosing scopes contain an instantiation,
3519 -- and that cleanup actions should be delayed until after the
3520 -- instance body is expanded.
3522 Check_Forward_Instantiation (Gen_Decl);
3523 if Nkind (N) = N_Package_Instantiation then
3525 Enclosing_Master : Entity_Id;
3528 -- Loop to search enclosing masters
3530 Enclosing_Master := Current_Scope;
3531 Scope_Loop : while Enclosing_Master /= Standard_Standard loop
3532 if Ekind (Enclosing_Master) = E_Package then
3533 if Is_Compilation_Unit (Enclosing_Master) then
3534 if In_Package_Body (Enclosing_Master) then
3536 (Body_Entity (Enclosing_Master));
3545 Enclosing_Master := Scope (Enclosing_Master);
3548 elsif Is_Generic_Unit (Enclosing_Master)
3549 or else Ekind (Enclosing_Master) = E_Void
3551 -- Cleanup actions will eventually be performed on the
3552 -- enclosing subprogram or package instance, if any.
3553 -- Enclosing scope is void in the formal part of a
3554 -- generic subprogram.
3559 if Ekind (Enclosing_Master) = E_Entry
3561 Ekind (Scope (Enclosing_Master)) = E_Protected_Type
3563 if not Expander_Active then
3567 Protected_Body_Subprogram (Enclosing_Master);
3571 Set_Delay_Cleanups (Enclosing_Master);
3573 while Ekind (Enclosing_Master) = E_Block loop
3574 Enclosing_Master := Scope (Enclosing_Master);
3577 if Is_Subprogram (Enclosing_Master) then
3578 Delay_Descriptors (Enclosing_Master);
3580 elsif Is_Task_Type (Enclosing_Master) then
3582 TBP : constant Node_Id :=
3583 Get_Task_Body_Procedure
3586 if Present (TBP) then
3587 Delay_Descriptors (TBP);
3588 Set_Delay_Cleanups (TBP);
3595 end loop Scope_Loop;
3598 -- Make entry in table
3600 Pending_Instantiations.Append
3602 Act_Decl => Act_Decl,
3603 Expander_Status => Expander_Active,
3604 Current_Sem_Unit => Current_Sem_Unit,
3605 Scope_Suppress => Scope_Suppress,
3606 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
3607 Version => Ada_Version));
3611 Set_Categorization_From_Pragmas (Act_Decl);
3613 if Parent_Installed then
3617 Set_Instance_Spec (N, Act_Decl);
3619 -- If not a compilation unit, insert the package declaration before
3620 -- the original instantiation node.
3622 if Nkind (Parent (N)) /= N_Compilation_Unit then
3623 Mark_Rewrite_Insertion (Act_Decl);
3624 Insert_Before (N, Act_Decl);
3627 -- For an instantiation that is a compilation unit, place declaration
3628 -- on current node so context is complete for analysis (including
3629 -- nested instantiations). If this is the main unit, the declaration
3630 -- eventually replaces the instantiation node. If the instance body
3631 -- is created later, it replaces the instance node, and the
3632 -- declaration is attached to it (see
3633 -- Build_Instance_Compilation_Unit_Nodes).
3636 if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
3638 -- The entity for the current unit is the newly created one,
3639 -- and all semantic information is attached to it.
3641 Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
3643 -- If this is the main unit, replace the main entity as well
3645 if Current_Sem_Unit = Main_Unit then
3646 Main_Unit_Entity := Act_Decl_Id;
3650 Set_Unit (Parent (N), Act_Decl);
3651 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
3652 Set_Package_Instantiation (Act_Decl_Id, N);
3654 Set_Unit (Parent (N), N);
3655 Set_Body_Required (Parent (N), False);
3657 -- We never need elaboration checks on instantiations, since by
3658 -- definition, the body instantiation is elaborated at the same
3659 -- time as the spec instantiation.
3661 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
3662 Set_Kill_Elaboration_Checks (Act_Decl_Id);
3665 Check_Elab_Instantiation (N);
3667 if ABE_Is_Certain (N) and then Needs_Body then
3668 Pending_Instantiations.Decrement_Last;
3671 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
3673 Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
3674 First_Private_Entity (Act_Decl_Id));
3676 -- If the instantiation will receive a body, the unit will be
3677 -- transformed into a package body, and receive its own elaboration
3678 -- entity. Otherwise, the nature of the unit is now a package
3681 if Nkind (Parent (N)) = N_Compilation_Unit
3682 and then not Needs_Body
3684 Rewrite (N, Act_Decl);
3687 if Present (Corresponding_Body (Gen_Decl))
3688 or else Unit_Requires_Body (Gen_Unit)
3690 Set_Has_Completion (Act_Decl_Id);
3693 Check_Formal_Packages (Act_Decl_Id);
3695 Restore_Private_Views (Act_Decl_Id);
3697 Inherit_Context (Gen_Decl, N);
3699 if Parent_Installed then
3704 Env_Installed := False;
3707 Validate_Categorization_Dependency (N, Act_Decl_Id);
3709 -- There used to be a check here to prevent instantiations in local
3710 -- contexts if the No_Local_Allocators restriction was active. This
3711 -- check was removed by a binding interpretation in AI-95-00130/07,
3712 -- but we retain the code for documentation purposes.
3714 -- if Ekind (Act_Decl_Id) /= E_Void
3715 -- and then not Is_Library_Level_Entity (Act_Decl_Id)
3717 -- Check_Restriction (No_Local_Allocators, N);
3721 Inline_Instance_Body (N, Gen_Unit, Act_Decl);
3724 -- The following is a tree patch for ASIS: ASIS needs separate nodes to
3725 -- be used as defining identifiers for a formal package and for the
3726 -- corresponding expanded package.
3728 if Nkind (N) = N_Formal_Package_Declaration then
3729 Act_Decl_Id := New_Copy (Defining_Entity (N));
3730 Set_Comes_From_Source (Act_Decl_Id, True);
3731 Set_Is_Generic_Instance (Act_Decl_Id, False);
3732 Set_Defining_Identifier (N, Act_Decl_Id);
3735 Style_Check := Save_Style_Check;
3738 if Has_Aspects (N) then
3739 Analyze_Aspect_Specifications (N, Act_Decl_Id);
3743 when Instantiation_Error =>
3744 if Parent_Installed then
3748 if Env_Installed then
3752 Style_Check := Save_Style_Check;
3753 end Analyze_Package_Instantiation;
3755 --------------------------
3756 -- Inline_Instance_Body --
3757 --------------------------
3759 procedure Inline_Instance_Body
3761 Gen_Unit : Entity_Id;
3765 Gen_Comp : constant Entity_Id :=
3766 Cunit_Entity (Get_Source_Unit (Gen_Unit));
3767 Curr_Comp : constant Node_Id := Cunit (Current_Sem_Unit);
3768 Curr_Scope : Entity_Id := Empty;
3769 Curr_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
3770 Removed : Boolean := False;
3771 Num_Scopes : Int := 0;
3773 Scope_Stack_Depth : constant Int :=
3774 Scope_Stack.Last - Scope_Stack.First + 1;
3776 Use_Clauses : array (1 .. Scope_Stack_Depth) of Node_Id;
3777 Instances : array (1 .. Scope_Stack_Depth) of Entity_Id;
3778 Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
3779 Num_Inner : Int := 0;
3780 N_Instances : Int := 0;
3784 -- Case of generic unit defined in another unit. We must remove the
3785 -- complete context of the current unit to install that of the generic.
3787 if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
3789 -- Add some comments for the following two loops ???
3792 while Present (S) and then S /= Standard_Standard loop
3794 Num_Scopes := Num_Scopes + 1;
3796 Use_Clauses (Num_Scopes) :=
3798 (Scope_Stack.Last - Num_Scopes + 1).
3800 End_Use_Clauses (Use_Clauses (Num_Scopes));
3802 exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
3803 or else Scope_Stack.Table
3804 (Scope_Stack.Last - Num_Scopes).Entity
3808 exit when Is_Generic_Instance (S)
3809 and then (In_Package_Body (S)
3810 or else Ekind (S) = E_Procedure
3811 or else Ekind (S) = E_Function);
3815 Vis := Is_Immediately_Visible (Gen_Comp);
3817 -- Find and save all enclosing instances
3822 and then S /= Standard_Standard
3824 if Is_Generic_Instance (S) then
3825 N_Instances := N_Instances + 1;
3826 Instances (N_Instances) := S;
3828 exit when In_Package_Body (S);
3834 -- Remove context of current compilation unit, unless we are within a
3835 -- nested package instantiation, in which case the context has been
3836 -- removed previously.
3838 -- If current scope is the body of a child unit, remove context of
3839 -- spec as well. If an enclosing scope is an instance body, the
3840 -- context has already been removed, but the entities in the body
3841 -- must be made invisible as well.
3846 and then S /= Standard_Standard
3848 if Is_Generic_Instance (S)
3849 and then (In_Package_Body (S)
3850 or else Ekind (S) = E_Procedure
3851 or else Ekind (S) = E_Function)
3853 -- We still have to remove the entities of the enclosing
3854 -- instance from direct visibility.
3859 E := First_Entity (S);
3860 while Present (E) loop
3861 Set_Is_Immediately_Visible (E, False);
3870 or else (Ekind (Curr_Unit) = E_Package_Body
3871 and then S = Spec_Entity (Curr_Unit))
3872 or else (Ekind (Curr_Unit) = E_Subprogram_Body
3875 (Unit_Declaration_Node (Curr_Unit)))
3879 -- Remove entities in current scopes from visibility, so that
3880 -- instance body is compiled in a clean environment.
3882 Save_Scope_Stack (Handle_Use => False);
3884 if Is_Child_Unit (S) then
3886 -- Remove child unit from stack, as well as inner scopes.
3887 -- Removing the context of a child unit removes parent units
3890 while Current_Scope /= S loop
3891 Num_Inner := Num_Inner + 1;
3892 Inner_Scopes (Num_Inner) := Current_Scope;
3897 Remove_Context (Curr_Comp);
3901 Remove_Context (Curr_Comp);
3904 if Ekind (Curr_Unit) = E_Package_Body then
3905 Remove_Context (Library_Unit (Curr_Comp));
3911 pragma Assert (Num_Inner < Num_Scopes);
3913 Push_Scope (Standard_Standard);
3914 Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
3915 Instantiate_Package_Body
3918 Act_Decl => Act_Decl,
3919 Expander_Status => Expander_Active,
3920 Current_Sem_Unit => Current_Sem_Unit,
3921 Scope_Suppress => Scope_Suppress,
3922 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
3923 Version => Ada_Version)),
3924 Inlined_Body => True);
3930 Set_Is_Immediately_Visible (Gen_Comp, Vis);
3932 -- Reset Generic_Instance flag so that use clauses can be installed
3933 -- in the proper order. (See Use_One_Package for effect of enclosing
3934 -- instances on processing of use clauses).
3936 for J in 1 .. N_Instances loop
3937 Set_Is_Generic_Instance (Instances (J), False);
3941 Install_Context (Curr_Comp);
3943 if Present (Curr_Scope)
3944 and then Is_Child_Unit (Curr_Scope)
3946 Push_Scope (Curr_Scope);
3947 Set_Is_Immediately_Visible (Curr_Scope);
3949 -- Finally, restore inner scopes as well
3951 for J in reverse 1 .. Num_Inner loop
3952 Push_Scope (Inner_Scopes (J));
3956 Restore_Scope_Stack (Handle_Use => False);
3958 if Present (Curr_Scope)
3960 (In_Private_Part (Curr_Scope)
3961 or else In_Package_Body (Curr_Scope))
3963 -- Install private declaration of ancestor units, which are
3964 -- currently available. Restore_Scope_Stack and Install_Context
3965 -- only install the visible part of parents.
3970 Par := Scope (Curr_Scope);
3971 while (Present (Par))
3972 and then Par /= Standard_Standard
3974 Install_Private_Declarations (Par);
3981 -- Restore use clauses. For a child unit, use clauses in the parents
3982 -- are restored when installing the context, so only those in inner
3983 -- scopes (and those local to the child unit itself) need to be
3984 -- installed explicitly.
3986 if Is_Child_Unit (Curr_Unit)
3989 for J in reverse 1 .. Num_Inner + 1 loop
3990 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
3992 Install_Use_Clauses (Use_Clauses (J));
3996 for J in reverse 1 .. Num_Scopes loop
3997 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
3999 Install_Use_Clauses (Use_Clauses (J));
4003 -- Restore status of instances. If one of them is a body, make
4004 -- its local entities visible again.
4011 for J in 1 .. N_Instances loop
4012 Inst := Instances (J);
4013 Set_Is_Generic_Instance (Inst, True);
4015 if In_Package_Body (Inst)
4016 or else Ekind (S) = E_Procedure
4017 or else Ekind (S) = E_Function
4019 E := First_Entity (Instances (J));
4020 while Present (E) loop
4021 Set_Is_Immediately_Visible (E);
4028 -- If generic unit is in current unit, current context is correct
4031 Instantiate_Package_Body
4034 Act_Decl => Act_Decl,
4035 Expander_Status => Expander_Active,
4036 Current_Sem_Unit => Current_Sem_Unit,
4037 Scope_Suppress => Scope_Suppress,
4038 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4039 Version => Ada_Version)),
4040 Inlined_Body => True);
4042 end Inline_Instance_Body;
4044 -------------------------------------
4045 -- Analyze_Procedure_Instantiation --
4046 -------------------------------------
4048 procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4050 Analyze_Subprogram_Instantiation (N, E_Procedure);
4051 end Analyze_Procedure_Instantiation;
4053 -----------------------------------
4054 -- Need_Subprogram_Instance_Body --
4055 -----------------------------------
4057 function Need_Subprogram_Instance_Body
4059 Subp : Entity_Id) return Boolean
4062 if (Is_In_Main_Unit (N)
4063 or else Is_Inlined (Subp)
4064 or else Is_Inlined (Alias (Subp)))
4065 and then (Operating_Mode = Generate_Code
4066 or else (Operating_Mode = Check_Semantics
4067 and then ASIS_Mode))
4068 and then (Full_Expander_Active or else ASIS_Mode)
4069 and then not ABE_Is_Certain (N)
4070 and then not Is_Eliminated (Subp)
4072 Pending_Instantiations.Append
4074 Act_Decl => Unit_Declaration_Node (Subp),
4075 Expander_Status => Expander_Active,
4076 Current_Sem_Unit => Current_Sem_Unit,
4077 Scope_Suppress => Scope_Suppress,
4078 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4079 Version => Ada_Version));
4085 end Need_Subprogram_Instance_Body;
4087 --------------------------------------
4088 -- Analyze_Subprogram_Instantiation --
4089 --------------------------------------
4091 procedure Analyze_Subprogram_Instantiation
4095 Loc : constant Source_Ptr := Sloc (N);
4096 Gen_Id : constant Node_Id := Name (N);
4098 Anon_Id : constant Entity_Id :=
4099 Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4100 Chars => New_External_Name
4101 (Chars (Defining_Entity (N)), 'R'));
4103 Act_Decl_Id : Entity_Id;
4108 Env_Installed : Boolean := False;
4109 Gen_Unit : Entity_Id;
4111 Pack_Id : Entity_Id;
4112 Parent_Installed : Boolean := False;
4113 Renaming_List : List_Id;
4115 Save_Style_Check : constant Boolean := Style_Check;
4116 -- Save style check mode for restore on exit
4118 procedure Analyze_Instance_And_Renamings;
4119 -- The instance must be analyzed in a context that includes the mappings
4120 -- of generic parameters into actuals. We create a package declaration
4121 -- for this purpose, and a subprogram with an internal name within the
4122 -- package. The subprogram instance is simply an alias for the internal
4123 -- subprogram, declared in the current scope.
4125 ------------------------------------
4126 -- Analyze_Instance_And_Renamings --
4127 ------------------------------------
4129 procedure Analyze_Instance_And_Renamings is
4130 Def_Ent : constant Entity_Id := Defining_Entity (N);
4131 Pack_Decl : Node_Id;
4134 if Nkind (Parent (N)) = N_Compilation_Unit then
4136 -- For the case of a compilation unit, the container package has
4137 -- the same name as the instantiation, to insure that the binder
4138 -- calls the elaboration procedure with the right name. Copy the
4139 -- entity of the instance, which may have compilation level flags
4140 -- (e.g. Is_Child_Unit) set.
4142 Pack_Id := New_Copy (Def_Ent);
4145 -- Otherwise we use the name of the instantiation concatenated
4146 -- with its source position to ensure uniqueness if there are
4147 -- several instantiations with the same name.
4150 Make_Defining_Identifier (Loc,
4151 Chars => New_External_Name
4152 (Related_Id => Chars (Def_Ent),
4154 Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4157 Pack_Decl := Make_Package_Declaration (Loc,
4158 Specification => Make_Package_Specification (Loc,
4159 Defining_Unit_Name => Pack_Id,
4160 Visible_Declarations => Renaming_List,
4161 End_Label => Empty));
4163 Set_Instance_Spec (N, Pack_Decl);
4164 Set_Is_Generic_Instance (Pack_Id);
4165 Set_Debug_Info_Needed (Pack_Id);
4167 -- Case of not a compilation unit
4169 if Nkind (Parent (N)) /= N_Compilation_Unit then
4170 Mark_Rewrite_Insertion (Pack_Decl);
4171 Insert_Before (N, Pack_Decl);
4172 Set_Has_Completion (Pack_Id);
4174 -- Case of an instantiation that is a compilation unit
4176 -- Place declaration on current node so context is complete for
4177 -- analysis (including nested instantiations), and for use in a
4178 -- context_clause (see Analyze_With_Clause).
4181 Set_Unit (Parent (N), Pack_Decl);
4182 Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4185 Analyze (Pack_Decl);
4186 Check_Formal_Packages (Pack_Id);
4187 Set_Is_Generic_Instance (Pack_Id, False);
4189 -- Why do we clear Is_Generic_Instance??? We set it 20 lines
4192 -- Body of the enclosing package is supplied when instantiating the
4193 -- subprogram body, after semantic analysis is completed.
4195 if Nkind (Parent (N)) = N_Compilation_Unit then
4197 -- Remove package itself from visibility, so it does not
4198 -- conflict with subprogram.
4200 Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4202 -- Set name and scope of internal subprogram so that the proper
4203 -- external name will be generated. The proper scope is the scope
4204 -- of the wrapper package. We need to generate debugging info for
4205 -- the internal subprogram, so set flag accordingly.
4207 Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4208 Set_Scope (Anon_Id, Scope (Pack_Id));
4210 -- Mark wrapper package as referenced, to avoid spurious warnings
4211 -- if the instantiation appears in various with_ clauses of
4212 -- subunits of the main unit.
4214 Set_Referenced (Pack_Id);
4217 Set_Is_Generic_Instance (Anon_Id);
4218 Set_Debug_Info_Needed (Anon_Id);
4219 Act_Decl_Id := New_Copy (Anon_Id);
4221 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4222 Set_Chars (Act_Decl_Id, Chars (Defining_Entity (N)));
4223 Set_Sloc (Act_Decl_Id, Sloc (Defining_Entity (N)));
4224 Set_Comes_From_Source (Act_Decl_Id, True);
4226 -- The signature may involve types that are not frozen yet, but the
4227 -- subprogram will be frozen at the point the wrapper package is
4228 -- frozen, so it does not need its own freeze node. In fact, if one
4229 -- is created, it might conflict with the freezing actions from the
4232 Set_Has_Delayed_Freeze (Anon_Id, False);
4234 -- If the instance is a child unit, mark the Id accordingly. Mark
4235 -- the anonymous entity as well, which is the real subprogram and
4236 -- which is used when the instance appears in a context clause.
4237 -- Similarly, propagate the Is_Eliminated flag to handle properly
4238 -- nested eliminated subprograms.
4240 Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
4241 Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
4242 New_Overloaded_Entity (Act_Decl_Id);
4243 Check_Eliminated (Act_Decl_Id);
4244 Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
4246 -- In compilation unit case, kill elaboration checks on the
4247 -- instantiation, since they are never needed -- the body is
4248 -- instantiated at the same point as the spec.
4250 if Nkind (Parent (N)) = N_Compilation_Unit then
4251 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4252 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4253 Set_Is_Compilation_Unit (Anon_Id);
4255 Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
4258 -- The instance is not a freezing point for the new subprogram
4260 Set_Is_Frozen (Act_Decl_Id, False);
4262 if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
4263 Valid_Operator_Definition (Act_Decl_Id);
4266 Set_Alias (Act_Decl_Id, Anon_Id);
4267 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4268 Set_Has_Completion (Act_Decl_Id);
4269 Set_Related_Instance (Pack_Id, Act_Decl_Id);
4271 if Nkind (Parent (N)) = N_Compilation_Unit then
4272 Set_Body_Required (Parent (N), False);
4274 end Analyze_Instance_And_Renamings;
4276 -- Start of processing for Analyze_Subprogram_Instantiation
4279 Check_SPARK_Restriction ("generic is not allowed", N);
4281 -- Very first thing: apply the special kludge for Text_IO processing
4282 -- in case we are instantiating one of the children of [Wide_]Text_IO.
4283 -- Of course such an instantiation is bogus (these are packages, not
4284 -- subprograms), but we get a better error message if we do this.
4286 Text_IO_Kludge (Gen_Id);
4288 -- Make node global for error reporting
4290 Instantiation_Node := N;
4292 -- Turn off style checking in instances. If the check is enabled on the
4293 -- generic unit, a warning in an instance would just be noise. If not
4294 -- enabled on the generic, then a warning in an instance is just wrong.
4296 Style_Check := False;
4298 Preanalyze_Actuals (N);
4301 Env_Installed := True;
4302 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
4303 Gen_Unit := Entity (Gen_Id);
4305 Generate_Reference (Gen_Unit, Gen_Id);
4307 if Nkind (Gen_Id) = N_Identifier
4308 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
4311 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
4314 if Etype (Gen_Unit) = Any_Type then
4319 -- Verify that it is a generic subprogram of the right kind, and that
4320 -- it does not lead to a circular instantiation.
4322 if not Ekind_In (Gen_Unit, E_Generic_Procedure, E_Generic_Function) then
4323 Error_Msg_N ("expect generic subprogram in instantiation", Gen_Id);
4325 elsif In_Open_Scopes (Gen_Unit) then
4326 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
4328 elsif K = E_Procedure
4329 and then Ekind (Gen_Unit) /= E_Generic_Procedure
4331 if Ekind (Gen_Unit) = E_Generic_Function then
4333 ("cannot instantiate generic function as procedure", Gen_Id);
4336 ("expect name of generic procedure in instantiation", Gen_Id);
4339 elsif K = E_Function
4340 and then Ekind (Gen_Unit) /= E_Generic_Function
4342 if Ekind (Gen_Unit) = E_Generic_Procedure then
4344 ("cannot instantiate generic procedure as function", Gen_Id);
4347 ("expect name of generic function in instantiation", Gen_Id);
4351 Set_Entity (Gen_Id, Gen_Unit);
4352 Set_Is_Instantiated (Gen_Unit);
4354 if In_Extended_Main_Source_Unit (N) then
4355 Generate_Reference (Gen_Unit, N);
4358 -- If renaming, get original unit
4360 if Present (Renamed_Object (Gen_Unit))
4361 and then (Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Procedure
4363 Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Function)
4365 Gen_Unit := Renamed_Object (Gen_Unit);
4366 Set_Is_Instantiated (Gen_Unit);
4367 Generate_Reference (Gen_Unit, N);
4370 if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
4371 Error_Msg_Node_2 := Current_Scope;
4373 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
4374 Circularity_Detected := True;
4378 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
4380 -- Initialize renamings map, for error checking
4382 Generic_Renamings.Set_Last (0);
4383 Generic_Renamings_HTable.Reset;
4385 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
4387 -- Copy original generic tree, to produce text for instantiation
4391 (Original_Node (Gen_Decl), Empty, Instantiating => True);
4393 -- Inherit overriding indicator from instance node
4395 Act_Spec := Specification (Act_Tree);
4396 Set_Must_Override (Act_Spec, Must_Override (N));
4397 Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
4400 Analyze_Associations
4402 Generic_Formal_Declarations (Act_Tree),
4403 Generic_Formal_Declarations (Gen_Decl));
4405 -- The subprogram itself cannot contain a nested instance, so the
4406 -- current parent is left empty.
4408 Set_Instance_Env (Gen_Unit, Empty);
4410 -- Build the subprogram declaration, which does not appear in the
4411 -- generic template, and give it a sloc consistent with that of the
4414 Set_Defining_Unit_Name (Act_Spec, Anon_Id);
4415 Set_Generic_Parent (Act_Spec, Gen_Unit);
4417 Make_Subprogram_Declaration (Sloc (Act_Spec),
4418 Specification => Act_Spec);
4420 -- The aspects have been copied previously, but they have to be
4421 -- linked explicitly to the new subprogram declaration. Explicit
4422 -- pre/postconditions on the instance are analyzed below, in a
4425 Move_Aspects (Act_Tree, Act_Decl);
4426 Set_Categorization_From_Pragmas (Act_Decl);
4428 if Parent_Installed then
4432 Append (Act_Decl, Renaming_List);
4433 Analyze_Instance_And_Renamings;
4435 -- If the generic is marked Import (Intrinsic), then so is the
4436 -- instance. This indicates that there is no body to instantiate. If
4437 -- generic is marked inline, so it the instance, and the anonymous
4438 -- subprogram it renames. If inlined, or else if inlining is enabled
4439 -- for the compilation, we generate the instance body even if it is
4440 -- not within the main unit.
4442 if Is_Intrinsic_Subprogram (Gen_Unit) then
4443 Set_Is_Intrinsic_Subprogram (Anon_Id);
4444 Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
4446 if Chars (Gen_Unit) = Name_Unchecked_Conversion then
4447 Validate_Unchecked_Conversion (N, Act_Decl_Id);
4451 -- Inherit convention from generic unit. Intrinsic convention, as for
4452 -- an instance of unchecked conversion, is not inherited because an
4453 -- explicit Ada instance has been created.
4455 if Has_Convention_Pragma (Gen_Unit)
4456 and then Convention (Gen_Unit) /= Convention_Intrinsic
4458 Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
4459 Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
4462 Generate_Definition (Act_Decl_Id);
4463 Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id))); -- ??? needed?
4464 Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
4466 -- Inherit all inlining-related flags which apply to the generic in
4467 -- the subprogram and its declaration.
4469 Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
4470 Set_Is_Inlined (Anon_Id, Is_Inlined (Gen_Unit));
4472 Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
4473 Set_Has_Pragma_Inline (Anon_Id, Has_Pragma_Inline (Gen_Unit));
4475 Set_Has_Pragma_Inline_Always
4476 (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
4477 Set_Has_Pragma_Inline_Always
4478 (Anon_Id, Has_Pragma_Inline_Always (Gen_Unit));
4480 if not Is_Intrinsic_Subprogram (Gen_Unit) then
4481 Check_Elab_Instantiation (N);
4484 if Is_Dispatching_Operation (Act_Decl_Id)
4485 and then Ada_Version >= Ada_2005
4491 Formal := First_Formal (Act_Decl_Id);
4492 while Present (Formal) loop
4493 if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
4494 and then Is_Controlling_Formal (Formal)
4495 and then not Can_Never_Be_Null (Formal)
4497 Error_Msg_NE ("access parameter& is controlling,",
4500 ("\corresponding parameter of & must be"
4501 & " explicitly null-excluding", N, Gen_Id);
4504 Next_Formal (Formal);
4509 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4511 Validate_Categorization_Dependency (N, Act_Decl_Id);
4513 if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
4514 Inherit_Context (Gen_Decl, N);
4516 Restore_Private_Views (Pack_Id, False);
4518 -- If the context requires a full instantiation, mark node for
4519 -- subsequent construction of the body.
4521 if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
4523 Check_Forward_Instantiation (Gen_Decl);
4525 -- The wrapper package is always delayed, because it does not
4526 -- constitute a freeze point, but to insure that the freeze
4527 -- node is placed properly, it is created directly when
4528 -- instantiating the body (otherwise the freeze node might
4529 -- appear to early for nested instantiations).
4531 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4533 -- For ASIS purposes, indicate that the wrapper package has
4534 -- replaced the instantiation node.
4536 Rewrite (N, Unit (Parent (N)));
4537 Set_Unit (Parent (N), N);
4540 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4542 -- Replace instance node for library-level instantiations of
4543 -- intrinsic subprograms, for ASIS use.
4545 Rewrite (N, Unit (Parent (N)));
4546 Set_Unit (Parent (N), N);
4549 if Parent_Installed then
4554 Env_Installed := False;
4555 Generic_Renamings.Set_Last (0);
4556 Generic_Renamings_HTable.Reset;
4559 Style_Check := Save_Style_Check;
4562 if Has_Aspects (N) then
4563 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4567 when Instantiation_Error =>
4568 if Parent_Installed then
4572 if Env_Installed then
4576 Style_Check := Save_Style_Check;
4577 end Analyze_Subprogram_Instantiation;
4579 -------------------------
4580 -- Get_Associated_Node --
4581 -------------------------
4583 function Get_Associated_Node (N : Node_Id) return Node_Id is
4587 Assoc := Associated_Node (N);
4589 if Nkind (Assoc) /= Nkind (N) then
4592 elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
4596 -- If the node is part of an inner generic, it may itself have been
4597 -- remapped into a further generic copy. Associated_Node is otherwise
4598 -- used for the entity of the node, and will be of a different node
4599 -- kind, or else N has been rewritten as a literal or function call.
4601 while Present (Associated_Node (Assoc))
4602 and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
4604 Assoc := Associated_Node (Assoc);
4607 -- Follow and additional link in case the final node was rewritten.
4608 -- This can only happen with nested generic units.
4610 if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
4611 and then Present (Associated_Node (Assoc))
4612 and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
4613 N_Explicit_Dereference,
4618 Assoc := Associated_Node (Assoc);
4623 end Get_Associated_Node;
4625 -------------------------------------------
4626 -- Build_Instance_Compilation_Unit_Nodes --
4627 -------------------------------------------
4629 procedure Build_Instance_Compilation_Unit_Nodes
4634 Decl_Cunit : Node_Id;
4635 Body_Cunit : Node_Id;
4637 New_Main : constant Entity_Id := Defining_Entity (Act_Decl);
4638 Old_Main : constant Entity_Id := Cunit_Entity (Main_Unit);
4641 -- A new compilation unit node is built for the instance declaration
4644 Make_Compilation_Unit (Sloc (N),
4645 Context_Items => Empty_List,
4648 Make_Compilation_Unit_Aux (Sloc (N)));
4650 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
4652 -- The new compilation unit is linked to its body, but both share the
4653 -- same file, so we do not set Body_Required on the new unit so as not
4654 -- to create a spurious dependency on a non-existent body in the ali.
4655 -- This simplifies CodePeer unit traversal.
4657 -- We use the original instantiation compilation unit as the resulting
4658 -- compilation unit of the instance, since this is the main unit.
4660 Rewrite (N, Act_Body);
4661 Body_Cunit := Parent (N);
4663 -- The two compilation unit nodes are linked by the Library_Unit field
4665 Set_Library_Unit (Decl_Cunit, Body_Cunit);
4666 Set_Library_Unit (Body_Cunit, Decl_Cunit);
4668 -- Preserve the private nature of the package if needed
4670 Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
4672 -- If the instance is not the main unit, its context, categorization
4673 -- and elaboration entity are not relevant to the compilation.
4675 if Body_Cunit /= Cunit (Main_Unit) then
4676 Make_Instance_Unit (Body_Cunit, In_Main => False);
4680 -- The context clause items on the instantiation, which are now attached
4681 -- to the body compilation unit (since the body overwrote the original
4682 -- instantiation node), semantically belong on the spec, so copy them
4683 -- there. It's harmless to leave them on the body as well. In fact one
4684 -- could argue that they belong in both places.
4686 Citem := First (Context_Items (Body_Cunit));
4687 while Present (Citem) loop
4688 Append (New_Copy (Citem), Context_Items (Decl_Cunit));
4692 -- Propagate categorization flags on packages, so that they appear in
4693 -- the ali file for the spec of the unit.
4695 if Ekind (New_Main) = E_Package then
4696 Set_Is_Pure (Old_Main, Is_Pure (New_Main));
4697 Set_Is_Preelaborated (Old_Main, Is_Preelaborated (New_Main));
4698 Set_Is_Remote_Types (Old_Main, Is_Remote_Types (New_Main));
4699 Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
4700 Set_Is_Remote_Call_Interface
4701 (Old_Main, Is_Remote_Call_Interface (New_Main));
4704 -- Make entry in Units table, so that binder can generate call to
4705 -- elaboration procedure for body, if any.
4707 Make_Instance_Unit (Body_Cunit, In_Main => True);
4708 Main_Unit_Entity := New_Main;
4709 Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
4711 -- Build elaboration entity, since the instance may certainly generate
4712 -- elaboration code requiring a flag for protection.
4714 Build_Elaboration_Entity (Decl_Cunit, New_Main);
4715 end Build_Instance_Compilation_Unit_Nodes;
4717 -----------------------------
4718 -- Check_Access_Definition --
4719 -----------------------------
4721 procedure Check_Access_Definition (N : Node_Id) is
4724 (Ada_Version >= Ada_2005
4725 and then Present (Access_Definition (N)));
4727 end Check_Access_Definition;
4729 -----------------------------------
4730 -- Check_Formal_Package_Instance --
4731 -----------------------------------
4733 -- If the formal has specific parameters, they must match those of the
4734 -- actual. Both of them are instances, and the renaming declarations for
4735 -- their formal parameters appear in the same order in both. The analyzed
4736 -- formal has been analyzed in the context of the current instance.
4738 procedure Check_Formal_Package_Instance
4739 (Formal_Pack : Entity_Id;
4740 Actual_Pack : Entity_Id)
4742 E1 : Entity_Id := First_Entity (Actual_Pack);
4743 E2 : Entity_Id := First_Entity (Formal_Pack);
4748 procedure Check_Mismatch (B : Boolean);
4749 -- Common error routine for mismatch between the parameters of the
4750 -- actual instance and those of the formal package.
4752 function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
4753 -- The formal may come from a nested formal package, and the actual may
4754 -- have been constant-folded. To determine whether the two denote the
4755 -- same entity we may have to traverse several definitions to recover
4756 -- the ultimate entity that they refer to.
4758 function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
4759 -- Similarly, if the formal comes from a nested formal package, the
4760 -- actual may designate the formal through multiple renamings, which
4761 -- have to be followed to determine the original variable in question.
4763 --------------------
4764 -- Check_Mismatch --
4765 --------------------
4767 procedure Check_Mismatch (B : Boolean) is
4768 Kind : constant Node_Kind := Nkind (Parent (E2));
4771 if Kind = N_Formal_Type_Declaration then
4774 elsif Nkind_In (Kind, N_Formal_Object_Declaration,
4775 N_Formal_Package_Declaration)
4776 or else Kind in N_Formal_Subprogram_Declaration
4782 ("actual for & in actual instance does not match formal",
4783 Parent (Actual_Pack), E1);
4787 --------------------------------
4788 -- Same_Instantiated_Constant --
4789 --------------------------------
4791 function Same_Instantiated_Constant
4792 (E1, E2 : Entity_Id) return Boolean
4798 while Present (Ent) loop
4802 elsif Ekind (Ent) /= E_Constant then
4805 elsif Is_Entity_Name (Constant_Value (Ent)) then
4806 if Entity (Constant_Value (Ent)) = E1 then
4809 Ent := Entity (Constant_Value (Ent));
4812 -- The actual may be a constant that has been folded. Recover
4815 elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
4816 Ent := Entity (Original_Node (Constant_Value (Ent)));
4823 end Same_Instantiated_Constant;
4825 --------------------------------
4826 -- Same_Instantiated_Variable --
4827 --------------------------------
4829 function Same_Instantiated_Variable
4830 (E1, E2 : Entity_Id) return Boolean
4832 function Original_Entity (E : Entity_Id) return Entity_Id;
4833 -- Follow chain of renamings to the ultimate ancestor
4835 ---------------------
4836 -- Original_Entity --
4837 ---------------------
4839 function Original_Entity (E : Entity_Id) return Entity_Id is
4844 while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
4845 and then Present (Renamed_Object (Orig))
4846 and then Is_Entity_Name (Renamed_Object (Orig))
4848 Orig := Entity (Renamed_Object (Orig));
4852 end Original_Entity;
4854 -- Start of processing for Same_Instantiated_Variable
4857 return Ekind (E1) = Ekind (E2)
4858 and then Original_Entity (E1) = Original_Entity (E2);
4859 end Same_Instantiated_Variable;
4861 -- Start of processing for Check_Formal_Package_Instance
4865 and then Present (E2)
4867 exit when Ekind (E1) = E_Package
4868 and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
4870 -- If the formal is the renaming of the formal package, this
4871 -- is the end of its formal part, which may occur before the
4872 -- end of the formal part in the actual in the presence of
4873 -- defaulted parameters in the formal package.
4875 exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
4876 and then Renamed_Entity (E2) = Scope (E2);
4878 -- The analysis of the actual may generate additional internal
4879 -- entities. If the formal is defaulted, there is no corresponding
4880 -- analysis and the internal entities must be skipped, until we
4881 -- find corresponding entities again.
4883 if Comes_From_Source (E2)
4884 and then not Comes_From_Source (E1)
4885 and then Chars (E1) /= Chars (E2)
4888 and then Chars (E1) /= Chars (E2)
4897 -- If the formal entity comes from a formal declaration, it was
4898 -- defaulted in the formal package, and no check is needed on it.
4900 elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
4903 elsif Is_Type (E1) then
4905 -- Subtypes must statically match. E1, E2 are the local entities
4906 -- that are subtypes of the actuals. Itypes generated for other
4907 -- parameters need not be checked, the check will be performed
4908 -- on the parameters themselves.
4910 -- If E2 is a formal type declaration, it is a defaulted parameter
4911 -- and needs no checking.
4913 if not Is_Itype (E1)
4914 and then not Is_Itype (E2)
4918 or else Etype (E1) /= Etype (E2)
4919 or else not Subtypes_Statically_Match (E1, E2));
4922 elsif Ekind (E1) = E_Constant then
4924 -- IN parameters must denote the same static value, or the same
4925 -- constant, or the literal null.
4927 Expr1 := Expression (Parent (E1));
4929 if Ekind (E2) /= E_Constant then
4930 Check_Mismatch (True);
4933 Expr2 := Expression (Parent (E2));
4936 if Is_Static_Expression (Expr1) then
4938 if not Is_Static_Expression (Expr2) then
4939 Check_Mismatch (True);
4941 elsif Is_Discrete_Type (Etype (E1)) then
4943 V1 : constant Uint := Expr_Value (Expr1);
4944 V2 : constant Uint := Expr_Value (Expr2);
4946 Check_Mismatch (V1 /= V2);
4949 elsif Is_Real_Type (Etype (E1)) then
4951 V1 : constant Ureal := Expr_Value_R (Expr1);
4952 V2 : constant Ureal := Expr_Value_R (Expr2);
4954 Check_Mismatch (V1 /= V2);
4957 elsif Is_String_Type (Etype (E1))
4958 and then Nkind (Expr1) = N_String_Literal
4960 if Nkind (Expr2) /= N_String_Literal then
4961 Check_Mismatch (True);
4964 (not String_Equal (Strval (Expr1), Strval (Expr2)));
4968 elsif Is_Entity_Name (Expr1) then
4969 if Is_Entity_Name (Expr2) then
4970 if Entity (Expr1) = Entity (Expr2) then
4974 (not Same_Instantiated_Constant
4975 (Entity (Expr1), Entity (Expr2)));
4978 Check_Mismatch (True);
4981 elsif Is_Entity_Name (Original_Node (Expr1))
4982 and then Is_Entity_Name (Expr2)
4984 Same_Instantiated_Constant
4985 (Entity (Original_Node (Expr1)), Entity (Expr2))
4989 elsif Nkind (Expr1) = N_Null then
4990 Check_Mismatch (Nkind (Expr1) /= N_Null);
4993 Check_Mismatch (True);
4996 elsif Ekind (E1) = E_Variable then
4997 Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
4999 elsif Ekind (E1) = E_Package then
5001 (Ekind (E1) /= Ekind (E2)
5002 or else Renamed_Object (E1) /= Renamed_Object (E2));
5004 elsif Is_Overloadable (E1) then
5006 -- Verify that the actual subprograms match. Note that actuals
5007 -- that are attributes are rewritten as subprograms. If the
5008 -- subprogram in the formal package is defaulted, no check is
5009 -- needed. Note that this can only happen in Ada 2005 when the
5010 -- formal package can be partially parameterized.
5012 if Nkind (Unit_Declaration_Node (E1)) =
5013 N_Subprogram_Renaming_Declaration
5014 and then From_Default (Unit_Declaration_Node (E1))
5020 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5024 raise Program_Error;
5031 end Check_Formal_Package_Instance;
5033 ---------------------------
5034 -- Check_Formal_Packages --
5035 ---------------------------
5037 procedure Check_Formal_Packages (P_Id : Entity_Id) is
5039 Formal_P : Entity_Id;
5042 -- Iterate through the declarations in the instance, looking for package
5043 -- renaming declarations that denote instances of formal packages. Stop
5044 -- when we find the renaming of the current package itself. The
5045 -- declaration for a formal package without a box is followed by an
5046 -- internal entity that repeats the instantiation.
5048 E := First_Entity (P_Id);
5049 while Present (E) loop
5050 if Ekind (E) = E_Package then
5051 if Renamed_Object (E) = P_Id then
5054 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5057 elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5058 Formal_P := Next_Entity (E);
5059 Check_Formal_Package_Instance (Formal_P, E);
5061 -- After checking, remove the internal validating package. It
5062 -- is only needed for semantic checks, and as it may contain
5063 -- generic formal declarations it should not reach gigi.
5065 Remove (Unit_Declaration_Node (Formal_P));
5071 end Check_Formal_Packages;
5073 ---------------------------------
5074 -- Check_Forward_Instantiation --
5075 ---------------------------------
5077 procedure Check_Forward_Instantiation (Decl : Node_Id) is
5079 Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5082 -- The instantiation appears before the generic body if we are in the
5083 -- scope of the unit containing the generic, either in its spec or in
5084 -- the package body, and before the generic body.
5086 if Ekind (Gen_Comp) = E_Package_Body then
5087 Gen_Comp := Spec_Entity (Gen_Comp);
5090 if In_Open_Scopes (Gen_Comp)
5091 and then No (Corresponding_Body (Decl))
5096 and then not Is_Compilation_Unit (S)
5097 and then not Is_Child_Unit (S)
5099 if Ekind (S) = E_Package then
5100 Set_Has_Forward_Instantiation (S);
5106 end Check_Forward_Instantiation;
5108 ---------------------------
5109 -- Check_Generic_Actuals --
5110 ---------------------------
5112 -- The visibility of the actuals may be different between the point of
5113 -- generic instantiation and the instantiation of the body.
5115 procedure Check_Generic_Actuals
5116 (Instance : Entity_Id;
5117 Is_Formal_Box : Boolean)
5122 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5123 -- For a formal that is an array type, the component type is often a
5124 -- previous formal in the same unit. The privacy status of the component
5125 -- type will have been examined earlier in the traversal of the
5126 -- corresponding actuals, and this status should not be modified for the
5127 -- array type itself.
5129 -- To detect this case we have to rescan the list of formals, which
5130 -- is usually short enough to ignore the resulting inefficiency.
5132 -----------------------------
5133 -- Denotes_Previous_Actual --
5134 -----------------------------
5136 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5140 Prev := First_Entity (Instance);
5141 while Present (Prev) loop
5143 and then Nkind (Parent (Prev)) = N_Subtype_Declaration
5144 and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
5145 and then Entity (Subtype_Indication (Parent (Prev))) = Typ
5158 end Denotes_Previous_Actual;
5160 -- Start of processing for Check_Generic_Actuals
5163 E := First_Entity (Instance);
5164 while Present (E) loop
5166 and then Nkind (Parent (E)) = N_Subtype_Declaration
5167 and then Scope (Etype (E)) /= Instance
5168 and then Is_Entity_Name (Subtype_Indication (Parent (E)))
5170 if Is_Array_Type (E)
5171 and then Denotes_Previous_Actual (Component_Type (E))
5175 Check_Private_View (Subtype_Indication (Parent (E)));
5178 Set_Is_Generic_Actual_Type (E, True);
5179 Set_Is_Hidden (E, False);
5180 Set_Is_Potentially_Use_Visible (E,
5183 -- We constructed the generic actual type as a subtype of the
5184 -- supplied type. This means that it normally would not inherit
5185 -- subtype specific attributes of the actual, which is wrong for
5186 -- the generic case.
5188 Astype := Ancestor_Subtype (E);
5192 -- This can happen when E is an itype that is the full view of
5193 -- a private type completed, e.g. with a constrained array. In
5194 -- that case, use the first subtype, which will carry size
5195 -- information. The base type itself is unconstrained and will
5198 Astype := First_Subtype (E);
5201 Set_Size_Info (E, (Astype));
5202 Set_RM_Size (E, RM_Size (Astype));
5203 Set_First_Rep_Item (E, First_Rep_Item (Astype));
5205 if Is_Discrete_Or_Fixed_Point_Type (E) then
5206 Set_RM_Size (E, RM_Size (Astype));
5208 -- In nested instances, the base type of an access actual
5209 -- may itself be private, and need to be exchanged.
5211 elsif Is_Access_Type (E)
5212 and then Is_Private_Type (Etype (E))
5215 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
5218 elsif Ekind (E) = E_Package then
5220 -- If this is the renaming for the current instance, we're done.
5221 -- Otherwise it is a formal package. If the corresponding formal
5222 -- was declared with a box, the (instantiations of the) generic
5223 -- formal part are also visible. Otherwise, ignore the entity
5224 -- created to validate the actuals.
5226 if Renamed_Object (E) = Instance then
5229 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5232 -- The visibility of a formal of an enclosing generic is already
5235 elsif Denotes_Formal_Package (E) then
5238 elsif Present (Associated_Formal_Package (E))
5239 and then not Is_Generic_Formal (E)
5241 if Box_Present (Parent (Associated_Formal_Package (E))) then
5242 Check_Generic_Actuals (Renamed_Object (E), True);
5245 Check_Generic_Actuals (Renamed_Object (E), False);
5248 Set_Is_Hidden (E, False);
5251 -- If this is a subprogram instance (in a wrapper package) the
5252 -- actual is fully visible.
5254 elsif Is_Wrapper_Package (Instance) then
5255 Set_Is_Hidden (E, False);
5257 -- If the formal package is declared with a box, or if the formal
5258 -- parameter is defaulted, it is visible in the body.
5261 or else Is_Visible_Formal (E)
5263 Set_Is_Hidden (E, False);
5266 if Ekind (E) = E_Constant then
5268 -- If the type of the actual is a private type declared in the
5269 -- enclosing scope of the generic unit, the body of the generic
5270 -- sees the full view of the type (because it has to appear in
5271 -- the corresponding package body). If the type is private now,
5272 -- exchange views to restore the proper visiblity in the instance.
5275 Typ : constant Entity_Id := Base_Type (Etype (E));
5276 -- The type of the actual
5281 Parent_Scope : Entity_Id;
5282 -- The enclosing scope of the generic unit
5285 if Is_Wrapper_Package (Instance) then
5289 (Unit_Declaration_Node
5290 (Related_Instance (Instance))));
5294 (Specification (Unit_Declaration_Node (Instance)));
5297 Parent_Scope := Scope (Gen_Id);
5299 -- The exchange is only needed if the generic is defined
5300 -- within a package which is not a common ancestor of the
5301 -- scope of the instance, and is not already in scope.
5303 if Is_Private_Type (Typ)
5304 and then Scope (Typ) = Parent_Scope
5305 and then Scope (Instance) /= Parent_Scope
5306 and then Ekind (Parent_Scope) = E_Package
5307 and then not Is_Child_Unit (Gen_Id)
5311 -- If the type of the entity is a subtype, it may also
5312 -- have to be made visible, together with the base type
5313 -- of its full view, after exchange.
5315 if Is_Private_Type (Etype (E)) then
5316 Switch_View (Etype (E));
5317 Switch_View (Base_Type (Etype (E)));
5325 end Check_Generic_Actuals;
5327 ------------------------------
5328 -- Check_Generic_Child_Unit --
5329 ------------------------------
5331 procedure Check_Generic_Child_Unit
5333 Parent_Installed : in out Boolean)
5335 Loc : constant Source_Ptr := Sloc (Gen_Id);
5336 Gen_Par : Entity_Id := Empty;
5338 Inst_Par : Entity_Id;
5341 function Find_Generic_Child
5343 Id : Node_Id) return Entity_Id;
5344 -- Search generic parent for possible child unit with the given name
5346 function In_Enclosing_Instance return Boolean;
5347 -- Within an instance of the parent, the child unit may be denoted
5348 -- by a simple name, or an abbreviated expanded name. Examine enclosing
5349 -- scopes to locate a possible parent instantiation.
5351 ------------------------
5352 -- Find_Generic_Child --
5353 ------------------------
5355 function Find_Generic_Child
5357 Id : Node_Id) return Entity_Id
5362 -- If entity of name is already set, instance has already been
5363 -- resolved, e.g. in an enclosing instantiation.
5365 if Present (Entity (Id)) then
5366 if Scope (Entity (Id)) = Scop then
5373 E := First_Entity (Scop);
5374 while Present (E) loop
5375 if Chars (E) = Chars (Id)
5376 and then Is_Child_Unit (E)
5378 if Is_Child_Unit (E)
5379 and then not Is_Visible_Child_Unit (E)
5382 ("generic child unit& is not visible", Gen_Id, E);
5394 end Find_Generic_Child;
5396 ---------------------------
5397 -- In_Enclosing_Instance --
5398 ---------------------------
5400 function In_Enclosing_Instance return Boolean is
5401 Enclosing_Instance : Node_Id;
5402 Instance_Decl : Node_Id;
5405 -- We do not inline any call that contains instantiations, except
5406 -- for instantiations of Unchecked_Conversion, so if we are within
5407 -- an inlined body the current instance does not require parents.
5409 if In_Inlined_Body then
5410 pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
5414 -- Loop to check enclosing scopes
5416 Enclosing_Instance := Current_Scope;
5417 while Present (Enclosing_Instance) loop
5418 Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
5420 if Ekind (Enclosing_Instance) = E_Package
5421 and then Is_Generic_Instance (Enclosing_Instance)
5423 (Generic_Parent (Specification (Instance_Decl)))
5425 -- Check whether the generic we are looking for is a child of
5428 E := Find_Generic_Child
5429 (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
5430 exit when Present (E);
5436 Enclosing_Instance := Scope (Enclosing_Instance);
5448 Make_Expanded_Name (Loc,
5450 Prefix => New_Occurrence_Of (Enclosing_Instance, Loc),
5451 Selector_Name => New_Occurrence_Of (E, Loc)));
5453 Set_Entity (Gen_Id, E);
5454 Set_Etype (Gen_Id, Etype (E));
5455 Parent_Installed := False; -- Already in scope.
5458 end In_Enclosing_Instance;
5460 -- Start of processing for Check_Generic_Child_Unit
5463 -- If the name of the generic is given by a selected component, it may
5464 -- be the name of a generic child unit, and the prefix is the name of an
5465 -- instance of the parent, in which case the child unit must be visible.
5466 -- If this instance is not in scope, it must be placed there and removed
5467 -- after instantiation, because what is being instantiated is not the
5468 -- original child, but the corresponding child present in the instance
5471 -- If the child is instantiated within the parent, it can be given by
5472 -- a simple name. In this case the instance is already in scope, but
5473 -- the child generic must be recovered from the generic parent as well.
5475 if Nkind (Gen_Id) = N_Selected_Component then
5476 S := Selector_Name (Gen_Id);
5477 Analyze (Prefix (Gen_Id));
5478 Inst_Par := Entity (Prefix (Gen_Id));
5480 if Ekind (Inst_Par) = E_Package
5481 and then Present (Renamed_Object (Inst_Par))
5483 Inst_Par := Renamed_Object (Inst_Par);
5486 if Ekind (Inst_Par) = E_Package then
5487 if Nkind (Parent (Inst_Par)) = N_Package_Specification then
5488 Gen_Par := Generic_Parent (Parent (Inst_Par));
5490 elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
5492 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
5494 Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
5497 elsif Ekind (Inst_Par) = E_Generic_Package
5498 and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
5500 -- A formal package may be a real child package, and not the
5501 -- implicit instance within a parent. In this case the child is
5502 -- not visible and has to be retrieved explicitly as well.
5504 Gen_Par := Inst_Par;
5507 if Present (Gen_Par) then
5509 -- The prefix denotes an instantiation. The entity itself may be a
5510 -- nested generic, or a child unit.
5512 E := Find_Generic_Child (Gen_Par, S);
5515 Change_Selected_Component_To_Expanded_Name (Gen_Id);
5516 Set_Entity (Gen_Id, E);
5517 Set_Etype (Gen_Id, Etype (E));
5519 Set_Etype (S, Etype (E));
5521 -- Indicate that this is a reference to the parent
5523 if In_Extended_Main_Source_Unit (Gen_Id) then
5524 Set_Is_Instantiated (Inst_Par);
5527 -- A common mistake is to replicate the naming scheme of a
5528 -- hierarchy by instantiating a generic child directly, rather
5529 -- than the implicit child in a parent instance:
5531 -- generic .. package Gpar is ..
5532 -- generic .. package Gpar.Child is ..
5533 -- package Par is new Gpar ();
5536 -- package Par.Child is new Gpar.Child ();
5537 -- rather than Par.Child
5539 -- In this case the instantiation is within Par, which is an
5540 -- instance, but Gpar does not denote Par because we are not IN
5541 -- the instance of Gpar, so this is illegal. The test below
5542 -- recognizes this particular case.
5544 if Is_Child_Unit (E)
5545 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
5546 and then (not In_Instance
5547 or else Nkind (Parent (Parent (Gen_Id))) =
5551 ("prefix of generic child unit must be instance of parent",
5555 if not In_Open_Scopes (Inst_Par)
5556 and then Nkind (Parent (Gen_Id)) not in
5557 N_Generic_Renaming_Declaration
5559 Install_Parent (Inst_Par);
5560 Parent_Installed := True;
5562 elsif In_Open_Scopes (Inst_Par) then
5564 -- If the parent is already installed, install the actuals
5565 -- for its formal packages. This is necessary when the
5566 -- child instance is a child of the parent instance:
5567 -- in this case, the parent is placed on the scope stack
5568 -- but the formal packages are not made visible.
5570 Install_Formal_Packages (Inst_Par);
5574 -- If the generic parent does not contain an entity that
5575 -- corresponds to the selector, the instance doesn't either.
5576 -- Analyzing the node will yield the appropriate error message.
5577 -- If the entity is not a child unit, then it is an inner
5578 -- generic in the parent.
5586 if Is_Child_Unit (Entity (Gen_Id))
5588 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
5589 and then not In_Open_Scopes (Inst_Par)
5591 Install_Parent (Inst_Par);
5592 Parent_Installed := True;
5594 -- The generic unit may be the renaming of the implicit child
5595 -- present in an instance. In that case the parent instance is
5596 -- obtained from the name of the renamed entity.
5598 elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
5599 and then Present (Renamed_Entity (Entity (Gen_Id)))
5600 and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
5603 Renamed_Package : constant Node_Id :=
5604 Name (Parent (Entity (Gen_Id)));
5606 if Nkind (Renamed_Package) = N_Expanded_Name then
5607 Inst_Par := Entity (Prefix (Renamed_Package));
5608 Install_Parent (Inst_Par);
5609 Parent_Installed := True;
5615 elsif Nkind (Gen_Id) = N_Expanded_Name then
5617 -- Entity already present, analyze prefix, whose meaning may be
5618 -- an instance in the current context. If it is an instance of
5619 -- a relative within another, the proper parent may still have
5620 -- to be installed, if they are not of the same generation.
5622 Analyze (Prefix (Gen_Id));
5624 -- In the unlikely case that a local declaration hides the name
5625 -- of the parent package, locate it on the homonym chain. If the
5626 -- context is an instance of the parent, the renaming entity is
5629 Inst_Par := Entity (Prefix (Gen_Id));
5630 while Present (Inst_Par)
5631 and then not Is_Package_Or_Generic_Package (Inst_Par)
5633 Inst_Par := Homonym (Inst_Par);
5636 pragma Assert (Present (Inst_Par));
5637 Set_Entity (Prefix (Gen_Id), Inst_Par);
5639 if In_Enclosing_Instance then
5642 elsif Present (Entity (Gen_Id))
5643 and then Is_Child_Unit (Entity (Gen_Id))
5644 and then not In_Open_Scopes (Inst_Par)
5646 Install_Parent (Inst_Par);
5647 Parent_Installed := True;
5650 elsif In_Enclosing_Instance then
5652 -- The child unit is found in some enclosing scope
5659 -- If this is the renaming of the implicit child in a parent
5660 -- instance, recover the parent name and install it.
5662 if Is_Entity_Name (Gen_Id) then
5663 E := Entity (Gen_Id);
5665 if Is_Generic_Unit (E)
5666 and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
5667 and then Is_Child_Unit (Renamed_Object (E))
5668 and then Is_Generic_Unit (Scope (Renamed_Object (E)))
5669 and then Nkind (Name (Parent (E))) = N_Expanded_Name
5672 New_Copy_Tree (Name (Parent (E))));
5673 Inst_Par := Entity (Prefix (Gen_Id));
5675 if not In_Open_Scopes (Inst_Par) then
5676 Install_Parent (Inst_Par);
5677 Parent_Installed := True;
5680 -- If it is a child unit of a non-generic parent, it may be
5681 -- use-visible and given by a direct name. Install parent as
5684 elsif Is_Generic_Unit (E)
5685 and then Is_Child_Unit (E)
5687 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
5688 and then not Is_Generic_Unit (Scope (E))
5690 if not In_Open_Scopes (Scope (E)) then
5691 Install_Parent (Scope (E));
5692 Parent_Installed := True;
5697 end Check_Generic_Child_Unit;
5699 -----------------------------
5700 -- Check_Hidden_Child_Unit --
5701 -----------------------------
5703 procedure Check_Hidden_Child_Unit
5705 Gen_Unit : Entity_Id;
5706 Act_Decl_Id : Entity_Id)
5708 Gen_Id : constant Node_Id := Name (N);
5711 if Is_Child_Unit (Gen_Unit)
5712 and then Is_Child_Unit (Act_Decl_Id)
5713 and then Nkind (Gen_Id) = N_Expanded_Name
5714 and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
5715 and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
5717 Error_Msg_Node_2 := Scope (Act_Decl_Id);
5719 ("generic unit & is implicitly declared in &",
5720 Defining_Unit_Name (N), Gen_Unit);
5721 Error_Msg_N ("\instance must have different name",
5722 Defining_Unit_Name (N));
5724 end Check_Hidden_Child_Unit;
5726 ------------------------
5727 -- Check_Private_View --
5728 ------------------------
5730 procedure Check_Private_View (N : Node_Id) is
5731 T : constant Entity_Id := Etype (N);
5735 -- Exchange views if the type was not private in the generic but is
5736 -- private at the point of instantiation. Do not exchange views if
5737 -- the scope of the type is in scope. This can happen if both generic
5738 -- and instance are sibling units, or if type is defined in a parent.
5739 -- In this case the visibility of the type will be correct for all
5743 BT := Base_Type (T);
5745 if Is_Private_Type (T)
5746 and then not Has_Private_View (N)
5747 and then Present (Full_View (T))
5748 and then not In_Open_Scopes (Scope (T))
5750 -- In the generic, the full type was visible. Save the private
5751 -- entity, for subsequent exchange.
5755 elsif Has_Private_View (N)
5756 and then not Is_Private_Type (T)
5757 and then not Has_Been_Exchanged (T)
5758 and then Etype (Get_Associated_Node (N)) /= T
5760 -- Only the private declaration was visible in the generic. If
5761 -- the type appears in a subtype declaration, the subtype in the
5762 -- instance must have a view compatible with that of its parent,
5763 -- which must be exchanged (see corresponding code in Restore_
5764 -- Private_Views). Otherwise, if the type is defined in a parent
5765 -- unit, leave full visibility within instance, which is safe.
5767 if In_Open_Scopes (Scope (Base_Type (T)))
5768 and then not Is_Private_Type (Base_Type (T))
5769 and then Comes_From_Source (Base_Type (T))
5773 elsif Nkind (Parent (N)) = N_Subtype_Declaration
5774 or else not In_Private_Part (Scope (Base_Type (T)))
5776 Prepend_Elmt (T, Exchanged_Views);
5777 Exchange_Declarations (Etype (Get_Associated_Node (N)));
5780 -- For composite types with inconsistent representation exchange
5781 -- component types accordingly.
5783 elsif Is_Access_Type (T)
5784 and then Is_Private_Type (Designated_Type (T))
5785 and then not Has_Private_View (N)
5786 and then Present (Full_View (Designated_Type (T)))
5788 Switch_View (Designated_Type (T));
5790 elsif Is_Array_Type (T) then
5791 if Is_Private_Type (Component_Type (T))
5792 and then not Has_Private_View (N)
5793 and then Present (Full_View (Component_Type (T)))
5795 Switch_View (Component_Type (T));
5798 -- The normal exchange mechanism relies on the setting of a
5799 -- flag on the reference in the generic. However, an additional
5800 -- mechanism is needed for types that are not explicitly mentioned
5801 -- in the generic, but may be needed in expanded code in the
5802 -- instance. This includes component types of arrays and
5803 -- designated types of access types. This processing must also
5804 -- include the index types of arrays which we take care of here.
5811 Indx := First_Index (T);
5812 Typ := Base_Type (Etype (Indx));
5813 while Present (Indx) loop
5814 if Is_Private_Type (Typ)
5815 and then Present (Full_View (Typ))
5824 elsif Is_Private_Type (T)
5825 and then Present (Full_View (T))
5826 and then Is_Array_Type (Full_View (T))
5827 and then Is_Private_Type (Component_Type (Full_View (T)))
5831 -- Finally, a non-private subtype may have a private base type, which
5832 -- must be exchanged for consistency. This can happen when a package
5833 -- body is instantiated, when the scope stack is empty but in fact
5834 -- the subtype and the base type are declared in an enclosing scope.
5836 -- Note that in this case we introduce an inconsistency in the view
5837 -- set, because we switch the base type BT, but there could be some
5838 -- private dependent subtypes of BT which remain unswitched. Such
5839 -- subtypes might need to be switched at a later point (see specific
5840 -- provision for that case in Switch_View).
5842 elsif not Is_Private_Type (T)
5843 and then not Has_Private_View (N)
5844 and then Is_Private_Type (BT)
5845 and then Present (Full_View (BT))
5846 and then not Is_Generic_Type (BT)
5847 and then not In_Open_Scopes (BT)
5849 Prepend_Elmt (Full_View (BT), Exchanged_Views);
5850 Exchange_Declarations (BT);
5853 end Check_Private_View;
5855 --------------------------
5856 -- Contains_Instance_Of --
5857 --------------------------
5859 function Contains_Instance_Of
5862 N : Node_Id) return Boolean
5870 -- Verify that there are no circular instantiations. We check whether
5871 -- the unit contains an instance of the current scope or some enclosing
5872 -- scope (in case one of the instances appears in a subunit). Longer
5873 -- circularities involving subunits might seem too pathological to
5874 -- consider, but they were not too pathological for the authors of
5875 -- DEC bc30vsq, so we loop over all enclosing scopes, and mark all
5876 -- enclosing generic scopes as containing an instance.
5879 -- Within a generic subprogram body, the scope is not generic, to
5880 -- allow for recursive subprograms. Use the declaration to determine
5881 -- whether this is a generic unit.
5883 if Ekind (Scop) = E_Generic_Package
5884 or else (Is_Subprogram (Scop)
5885 and then Nkind (Unit_Declaration_Node (Scop)) =
5886 N_Generic_Subprogram_Declaration)
5888 Elmt := First_Elmt (Inner_Instances (Inner));
5890 while Present (Elmt) loop
5891 if Node (Elmt) = Scop then
5892 Error_Msg_Node_2 := Inner;
5894 ("circular Instantiation: & instantiated within &!",
5898 elsif Node (Elmt) = Inner then
5901 elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
5902 Error_Msg_Node_2 := Inner;
5904 ("circular Instantiation: & instantiated within &!",
5912 -- Indicate that Inner is being instantiated within Scop
5914 Append_Elmt (Inner, Inner_Instances (Scop));
5917 if Scop = Standard_Standard then
5920 Scop := Scope (Scop);
5925 end Contains_Instance_Of;
5927 -----------------------
5928 -- Copy_Generic_Node --
5929 -----------------------
5931 function Copy_Generic_Node
5933 Parent_Id : Node_Id;
5934 Instantiating : Boolean) return Node_Id
5939 function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
5940 -- Check the given value of one of the Fields referenced by the
5941 -- current node to determine whether to copy it recursively. The
5942 -- field may hold a Node_Id, a List_Id, or an Elist_Id, or a plain
5943 -- value (Sloc, Uint, Char) in which case it need not be copied.
5945 procedure Copy_Descendants;
5946 -- Common utility for various nodes
5948 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
5949 -- Make copy of element list
5951 function Copy_Generic_List
5953 Parent_Id : Node_Id) return List_Id;
5954 -- Apply Copy_Node recursively to the members of a node list
5956 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
5957 -- True if an identifier is part of the defining program unit name
5958 -- of a child unit. The entity of such an identifier must be kept
5959 -- (for ASIS use) even though as the name of an enclosing generic
5960 -- it would otherwise not be preserved in the generic tree.
5962 ----------------------
5963 -- Copy_Descendants --
5964 ----------------------
5966 procedure Copy_Descendants is
5968 use Atree.Unchecked_Access;
5969 -- This code section is part of the implementation of an untyped
5970 -- tree traversal, so it needs direct access to node fields.
5973 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
5974 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
5975 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
5976 Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
5977 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
5978 end Copy_Descendants;
5980 -----------------------------
5981 -- Copy_Generic_Descendant --
5982 -----------------------------
5984 function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
5986 if D = Union_Id (Empty) then
5989 elsif D in Node_Range then
5991 (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
5993 elsif D in List_Range then
5994 return Union_Id (Copy_Generic_List (List_Id (D), New_N));
5996 elsif D in Elist_Range then
5997 return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
5999 -- Nothing else is copyable (e.g. Uint values), return as is
6004 end Copy_Generic_Descendant;
6006 ------------------------
6007 -- Copy_Generic_Elist --
6008 ------------------------
6010 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6017 M := First_Elmt (E);
6018 while Present (M) loop
6020 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6029 end Copy_Generic_Elist;
6031 -----------------------
6032 -- Copy_Generic_List --
6033 -----------------------
6035 function Copy_Generic_List
6037 Parent_Id : Node_Id) return List_Id
6045 Set_Parent (New_L, Parent_Id);
6048 while Present (N) loop
6049 Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6058 end Copy_Generic_List;
6060 ---------------------------
6061 -- In_Defining_Unit_Name --
6062 ---------------------------
6064 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6066 return Present (Parent (Nam))
6067 and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6069 (Nkind (Parent (Nam)) = N_Expanded_Name
6070 and then In_Defining_Unit_Name (Parent (Nam))));
6071 end In_Defining_Unit_Name;
6073 -- Start of processing for Copy_Generic_Node
6080 New_N := New_Copy (N);
6082 -- Copy aspects if present
6084 if Has_Aspects (N) then
6085 Set_Has_Aspects (New_N, False);
6086 Set_Aspect_Specifications
6087 (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6090 if Instantiating then
6091 Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6094 if not Is_List_Member (N) then
6095 Set_Parent (New_N, Parent_Id);
6098 -- If defining identifier, then all fields have been copied already
6100 if Nkind (New_N) in N_Entity then
6103 -- Special casing for identifiers and other entity names and operators
6105 elsif Nkind_In (New_N, N_Identifier,
6106 N_Character_Literal,
6109 or else Nkind (New_N) in N_Op
6111 if not Instantiating then
6113 -- Link both nodes in order to assign subsequently the entity of
6114 -- the copy to the original node, in case this is a global
6117 Set_Associated_Node (N, New_N);
6119 -- If we are within an instantiation, this is a nested generic
6120 -- that has already been analyzed at the point of definition. We
6121 -- must preserve references that were global to the enclosing
6122 -- parent at that point. Other occurrences, whether global or
6123 -- local to the current generic, must be resolved anew, so we
6124 -- reset the entity in the generic copy. A global reference has a
6125 -- smaller depth than the parent, or else the same depth in case
6126 -- both are distinct compilation units.
6127 -- A child unit is implicitly declared within the enclosing parent
6128 -- but is in fact global to it, and must be preserved.
6130 -- It is also possible for Current_Instantiated_Parent to be
6131 -- defined, and for this not to be a nested generic, namely if the
6132 -- unit is loaded through Rtsfind. In that case, the entity of
6133 -- New_N is only a link to the associated node, and not a defining
6136 -- The entities for parent units in the defining_program_unit of a
6137 -- generic child unit are established when the context of the unit
6138 -- is first analyzed, before the generic copy is made. They are
6139 -- preserved in the copy for use in ASIS queries.
6141 Ent := Entity (New_N);
6143 if No (Current_Instantiated_Parent.Gen_Id) then
6145 or else Nkind (Ent) /= N_Defining_Identifier
6146 or else not In_Defining_Unit_Name (N)
6148 Set_Associated_Node (New_N, Empty);
6153 not Nkind_In (Ent, N_Defining_Identifier,
6154 N_Defining_Character_Literal,
6155 N_Defining_Operator_Symbol)
6156 or else No (Scope (Ent))
6158 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
6159 and then not Is_Child_Unit (Ent))
6161 (Scope_Depth (Scope (Ent)) >
6162 Scope_Depth (Current_Instantiated_Parent.Gen_Id)
6164 Get_Source_Unit (Ent) =
6165 Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
6167 Set_Associated_Node (New_N, Empty);
6170 -- Case of instantiating identifier or some other name or operator
6173 -- If the associated node is still defined, the entity in it is
6174 -- global, and must be copied to the instance. If this copy is
6175 -- being made for a body to inline, it is applied to an
6176 -- instantiated tree, and the entity is already present and must
6177 -- be also preserved.
6180 Assoc : constant Node_Id := Get_Associated_Node (N);
6183 if Present (Assoc) then
6184 if Nkind (Assoc) = Nkind (N) then
6185 Set_Entity (New_N, Entity (Assoc));
6186 Check_Private_View (N);
6188 elsif Nkind (Assoc) = N_Function_Call then
6189 Set_Entity (New_N, Entity (Name (Assoc)));
6191 elsif Nkind_In (Assoc, N_Defining_Identifier,
6192 N_Defining_Character_Literal,
6193 N_Defining_Operator_Symbol)
6194 and then Expander_Active
6196 -- Inlining case: we are copying a tree that contains
6197 -- global entities, which are preserved in the copy to be
6198 -- used for subsequent inlining.
6203 Set_Entity (New_N, Empty);
6209 -- For expanded name, we must copy the Prefix and Selector_Name
6211 if Nkind (N) = N_Expanded_Name then
6213 (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
6215 Set_Selector_Name (New_N,
6216 Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
6218 -- For operators, we must copy the right operand
6220 elsif Nkind (N) in N_Op then
6221 Set_Right_Opnd (New_N,
6222 Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
6224 -- And for binary operators, the left operand as well
6226 if Nkind (N) in N_Binary_Op then
6227 Set_Left_Opnd (New_N,
6228 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
6232 -- Special casing for stubs
6234 elsif Nkind (N) in N_Body_Stub then
6236 -- In any case, we must copy the specification or defining
6237 -- identifier as appropriate.
6239 if Nkind (N) = N_Subprogram_Body_Stub then
6240 Set_Specification (New_N,
6241 Copy_Generic_Node (Specification (N), New_N, Instantiating));
6244 Set_Defining_Identifier (New_N,
6246 (Defining_Identifier (N), New_N, Instantiating));
6249 -- If we are not instantiating, then this is where we load and
6250 -- analyze subunits, i.e. at the point where the stub occurs. A
6251 -- more permissive system might defer this analysis to the point
6252 -- of instantiation, but this seems to complicated for now.
6254 if not Instantiating then
6256 Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
6258 Unum : Unit_Number_Type;
6262 -- Make sure that, if it is a subunit of the main unit that is
6263 -- preprocessed and if -gnateG is specified, the preprocessed
6264 -- file will be written.
6266 Lib.Analysing_Subunit_Of_Main :=
6267 Lib.In_Extended_Main_Source_Unit (N);
6270 (Load_Name => Subunit_Name,
6274 Lib.Analysing_Subunit_Of_Main := False;
6276 -- If the proper body is not found, a warning message will be
6277 -- emitted when analyzing the stub, or later at the point
6278 -- of instantiation. Here we just leave the stub as is.
6280 if Unum = No_Unit then
6281 Subunits_Missing := True;
6282 goto Subunit_Not_Found;
6285 Subunit := Cunit (Unum);
6287 if Nkind (Unit (Subunit)) /= N_Subunit then
6289 ("found child unit instead of expected SEPARATE subunit",
6291 Error_Msg_Sloc := Sloc (N);
6292 Error_Msg_N ("\to complete stub #", Subunit);
6293 goto Subunit_Not_Found;
6296 -- We must create a generic copy of the subunit, in order to
6297 -- perform semantic analysis on it, and we must replace the
6298 -- stub in the original generic unit with the subunit, in order
6299 -- to preserve non-local references within.
6301 -- Only the proper body needs to be copied. Library_Unit and
6302 -- context clause are simply inherited by the generic copy.
6303 -- Note that the copy (which may be recursive if there are
6304 -- nested subunits) must be done first, before attaching it to
6305 -- the enclosing generic.
6309 (Proper_Body (Unit (Subunit)),
6310 Empty, Instantiating => False);
6312 -- Now place the original proper body in the original generic
6313 -- unit. This is a body, not a compilation unit.
6315 Rewrite (N, Proper_Body (Unit (Subunit)));
6316 Set_Is_Compilation_Unit (Defining_Entity (N), False);
6317 Set_Was_Originally_Stub (N);
6319 -- Finally replace the body of the subunit with its copy, and
6320 -- make this new subunit into the library unit of the generic
6321 -- copy, which does not have stubs any longer.
6323 Set_Proper_Body (Unit (Subunit), New_Body);
6324 Set_Library_Unit (New_N, Subunit);
6325 Inherit_Context (Unit (Subunit), N);
6328 -- If we are instantiating, this must be an error case, since
6329 -- otherwise we would have replaced the stub node by the proper body
6330 -- that corresponds. So just ignore it in the copy (i.e. we have
6331 -- copied it, and that is good enough).
6337 <<Subunit_Not_Found>> null;
6339 -- If the node is a compilation unit, it is the subunit of a stub, which
6340 -- has been loaded already (see code below). In this case, the library
6341 -- unit field of N points to the parent unit (which is a compilation
6342 -- unit) and need not (and cannot!) be copied.
6344 -- When the proper body of the stub is analyzed, the library_unit link
6345 -- is used to establish the proper context (see sem_ch10).
6347 -- The other fields of a compilation unit are copied as usual
6349 elsif Nkind (N) = N_Compilation_Unit then
6351 -- This code can only be executed when not instantiating, because in
6352 -- the copy made for an instantiation, the compilation unit node has
6353 -- disappeared at the point that a stub is replaced by its proper
6356 pragma Assert (not Instantiating);
6358 Set_Context_Items (New_N,
6359 Copy_Generic_List (Context_Items (N), New_N));
6362 Copy_Generic_Node (Unit (N), New_N, False));
6364 Set_First_Inlined_Subprogram (New_N,
6366 (First_Inlined_Subprogram (N), New_N, False));
6368 Set_Aux_Decls_Node (New_N,
6369 Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
6371 -- For an assignment node, the assignment is known to be semantically
6372 -- legal if we are instantiating the template. This avoids incorrect
6373 -- diagnostics in generated code.
6375 elsif Nkind (N) = N_Assignment_Statement then
6377 -- Copy name and expression fields in usual manner
6380 Copy_Generic_Node (Name (N), New_N, Instantiating));
6382 Set_Expression (New_N,
6383 Copy_Generic_Node (Expression (N), New_N, Instantiating));
6385 if Instantiating then
6386 Set_Assignment_OK (Name (New_N), True);
6389 elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
6390 if not Instantiating then
6391 Set_Associated_Node (N, New_N);
6394 if Present (Get_Associated_Node (N))
6395 and then Nkind (Get_Associated_Node (N)) = Nkind (N)
6397 -- In the generic the aggregate has some composite type. If at
6398 -- the point of instantiation the type has a private view,
6399 -- install the full view (and that of its ancestors, if any).
6402 T : Entity_Id := (Etype (Get_Associated_Node (New_N)));
6407 and then Is_Private_Type (T)
6413 and then Is_Tagged_Type (T)
6414 and then Is_Derived_Type (T)
6416 Rt := Root_Type (T);
6421 if Is_Private_Type (T) then
6432 -- Do not copy the associated node, which points to the generic copy
6433 -- of the aggregate.
6436 use Atree.Unchecked_Access;
6437 -- This code section is part of the implementation of an untyped
6438 -- tree traversal, so it needs direct access to node fields.
6441 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6442 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6443 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6444 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6447 -- Allocators do not have an identifier denoting the access type, so we
6448 -- must locate it through the expression to check whether the views are
6451 elsif Nkind (N) = N_Allocator
6452 and then Nkind (Expression (N)) = N_Qualified_Expression
6453 and then Is_Entity_Name (Subtype_Mark (Expression (N)))
6454 and then Instantiating
6457 T : constant Node_Id :=
6458 Get_Associated_Node (Subtype_Mark (Expression (N)));
6464 -- Retrieve the allocator node in the generic copy
6466 Acc_T := Etype (Parent (Parent (T)));
6468 and then Is_Private_Type (Acc_T)
6470 Switch_View (Acc_T);
6477 -- For a proper body, we must catch the case of a proper body that
6478 -- replaces a stub. This represents the point at which a separate
6479 -- compilation unit, and hence template file, may be referenced, so we
6480 -- must make a new source instantiation entry for the template of the
6481 -- subunit, and ensure that all nodes in the subunit are adjusted using
6482 -- this new source instantiation entry.
6484 elsif Nkind (N) in N_Proper_Body then
6486 Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
6489 if Instantiating and then Was_Originally_Stub (N) then
6490 Create_Instantiation_Source
6491 (Instantiation_Node,
6492 Defining_Entity (N),
6497 -- Now copy the fields of the proper body, using the new
6498 -- adjustment factor if one was needed as per test above.
6502 -- Restore the original adjustment factor in case changed
6504 S_Adjustment := Save_Adjustment;
6507 -- Don't copy Ident or Comment pragmas, since the comment belongs to the
6508 -- generic unit, not to the instantiating unit.
6510 elsif Nkind (N) = N_Pragma and then Instantiating then
6512 Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
6514 if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
6515 New_N := Make_Null_Statement (Sloc (N));
6522 elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
6524 -- No descendant fields need traversing
6528 elsif Nkind (N) = N_String_Literal
6529 and then Present (Etype (N))
6530 and then Instantiating
6532 -- If the string is declared in an outer scope, the string_literal
6533 -- subtype created for it may have the wrong scope. We force the
6534 -- reanalysis of the constant to generate a new itype in the proper
6537 Set_Etype (New_N, Empty);
6538 Set_Analyzed (New_N, False);
6540 -- For the remaining nodes, copy their descendants recursively
6545 if Instantiating and then Nkind (N) = N_Subprogram_Body then
6546 Set_Generic_Parent (Specification (New_N), N);
6548 -- Should preserve Corresponding_Spec??? (12.3(14))
6553 end Copy_Generic_Node;
6555 ----------------------------
6556 -- Denotes_Formal_Package --
6557 ----------------------------
6559 function Denotes_Formal_Package
6561 On_Exit : Boolean := False;
6562 Instance : Entity_Id := Empty) return Boolean
6565 Scop : constant Entity_Id := Scope (Pack);
6568 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
6569 -- The package in question may be an actual for a previous formal
6570 -- package P of the current instance, so examine its actuals as well.
6571 -- This must be recursive over other formal packages.
6573 ----------------------------------
6574 -- Is_Actual_Of_Previous_Formal --
6575 ----------------------------------
6577 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
6581 E1 := First_Entity (P);
6582 while Present (E1) and then E1 /= Instance loop
6583 if Ekind (E1) = E_Package
6584 and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
6586 if Renamed_Object (E1) = Pack then
6589 elsif E1 = P or else Renamed_Object (E1) = P then
6592 elsif Is_Actual_Of_Previous_Formal (E1) then
6601 end Is_Actual_Of_Previous_Formal;
6603 -- Start of processing for Denotes_Formal_Package
6609 (Instance_Envs.Last).Instantiated_Parent.Act_Id;
6611 Par := Current_Instantiated_Parent.Act_Id;
6614 if Ekind (Scop) = E_Generic_Package
6615 or else Nkind (Unit_Declaration_Node (Scop)) =
6616 N_Generic_Subprogram_Declaration
6620 elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
6621 N_Formal_Package_Declaration
6629 -- Check whether this package is associated with a formal package of
6630 -- the enclosing instantiation. Iterate over the list of renamings.
6632 E := First_Entity (Par);
6633 while Present (E) loop
6634 if Ekind (E) /= E_Package
6635 or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
6639 elsif Renamed_Object (E) = Par then
6642 elsif Renamed_Object (E) = Pack then
6645 elsif Is_Actual_Of_Previous_Formal (E) then
6655 end Denotes_Formal_Package;
6661 procedure End_Generic is
6663 -- ??? More things could be factored out in this routine. Should
6664 -- probably be done at a later stage.
6666 Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
6667 Generic_Flags.Decrement_Last;
6669 Expander_Mode_Restore;
6672 ----------------------
6673 -- Find_Actual_Type --
6674 ----------------------
6676 function Find_Actual_Type
6678 Gen_Type : Entity_Id) return Entity_Id
6680 Gen_Scope : constant Entity_Id := Scope (Gen_Type);
6684 -- Special processing only applies to child units
6686 if not Is_Child_Unit (Gen_Scope) then
6687 return Get_Instance_Of (Typ);
6689 -- If designated or component type is itself a formal of the child unit,
6690 -- its instance is available.
6692 elsif Scope (Typ) = Gen_Scope then
6693 return Get_Instance_Of (Typ);
6695 -- If the array or access type is not declared in the parent unit,
6696 -- no special processing needed.
6698 elsif not Is_Generic_Type (Typ)
6699 and then Scope (Gen_Scope) /= Scope (Typ)
6701 return Get_Instance_Of (Typ);
6703 -- Otherwise, retrieve designated or component type by visibility
6706 T := Current_Entity (Typ);
6707 while Present (T) loop
6708 if In_Open_Scopes (Scope (T)) then
6711 elsif Is_Generic_Actual_Type (T) then
6720 end Find_Actual_Type;
6722 ----------------------------
6723 -- Freeze_Subprogram_Body --
6724 ----------------------------
6726 procedure Freeze_Subprogram_Body
6727 (Inst_Node : Node_Id;
6729 Pack_Id : Entity_Id)
6731 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
6732 Par : constant Entity_Id := Scope (Gen_Unit);
6738 function Earlier (N1, N2 : Node_Id) return Boolean;
6739 -- Yields True if N1 and N2 appear in the same compilation unit,
6740 -- ignoring subunits, and if N1 is to the left of N2 in a left-to-right
6741 -- traversal of the tree for the unit.
6743 function Enclosing_Body (N : Node_Id) return Node_Id;
6744 -- Find innermost package body that encloses the given node, and which
6745 -- is not a compilation unit. Freeze nodes for the instance, or for its
6746 -- enclosing body, may be inserted after the enclosing_body of the
6749 function Package_Freeze_Node (B : Node_Id) return Node_Id;
6750 -- Find entity for given package body, and locate or create a freeze
6753 function True_Parent (N : Node_Id) return Node_Id;
6754 -- For a subunit, return parent of corresponding stub
6760 function Earlier (N1, N2 : Node_Id) return Boolean is
6766 procedure Find_Depth (P : in out Node_Id; D : in out Integer);
6767 -- Find distance from given node to enclosing compilation unit
6773 procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
6776 and then Nkind (P) /= N_Compilation_Unit
6778 P := True_Parent (P);
6783 -- Start of processing for Earlier
6786 Find_Depth (P1, D1);
6787 Find_Depth (P2, D2);
6797 P1 := True_Parent (P1);
6802 P2 := True_Parent (P2);
6806 -- At this point P1 and P2 are at the same distance from the root.
6807 -- We examine their parents until we find a common declarative list,
6808 -- at which point we can establish their relative placement by
6809 -- comparing their ultimate slocs. If we reach the root, N1 and N2
6810 -- do not descend from the same declarative list (e.g. one is nested
6811 -- in the declarative part and the other is in a block in the
6812 -- statement part) and the earlier one is already frozen.
6814 while not Is_List_Member (P1)
6815 or else not Is_List_Member (P2)
6816 or else List_Containing (P1) /= List_Containing (P2)
6818 P1 := True_Parent (P1);
6819 P2 := True_Parent (P2);
6821 if Nkind (Parent (P1)) = N_Subunit then
6822 P1 := Corresponding_Stub (Parent (P1));
6825 if Nkind (Parent (P2)) = N_Subunit then
6826 P2 := Corresponding_Stub (Parent (P2));
6835 Top_Level_Location (Sloc (P1)) < Top_Level_Location (Sloc (P2));
6838 --------------------
6839 -- Enclosing_Body --
6840 --------------------
6842 function Enclosing_Body (N : Node_Id) return Node_Id is
6843 P : Node_Id := Parent (N);
6847 and then Nkind (Parent (P)) /= N_Compilation_Unit
6849 if Nkind (P) = N_Package_Body then
6851 if Nkind (Parent (P)) = N_Subunit then
6852 return Corresponding_Stub (Parent (P));
6858 P := True_Parent (P);
6864 -------------------------
6865 -- Package_Freeze_Node --
6866 -------------------------
6868 function Package_Freeze_Node (B : Node_Id) return Node_Id is
6872 if Nkind (B) = N_Package_Body then
6873 Id := Corresponding_Spec (B);
6875 else pragma Assert (Nkind (B) = N_Package_Body_Stub);
6876 Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
6879 Ensure_Freeze_Node (Id);
6880 return Freeze_Node (Id);
6881 end Package_Freeze_Node;
6887 function True_Parent (N : Node_Id) return Node_Id is
6889 if Nkind (Parent (N)) = N_Subunit then
6890 return Parent (Corresponding_Stub (Parent (N)));
6896 -- Start of processing of Freeze_Subprogram_Body
6899 -- If the instance and the generic body appear within the same unit, and
6900 -- the instance precedes the generic, the freeze node for the instance
6901 -- must appear after that of the generic. If the generic is nested
6902 -- within another instance I2, then current instance must be frozen
6903 -- after I2. In both cases, the freeze nodes are those of enclosing
6904 -- packages. Otherwise, the freeze node is placed at the end of the
6905 -- current declarative part.
6907 Enc_G := Enclosing_Body (Gen_Body);
6908 Enc_I := Enclosing_Body (Inst_Node);
6909 Ensure_Freeze_Node (Pack_Id);
6910 F_Node := Freeze_Node (Pack_Id);
6912 if Is_Generic_Instance (Par)
6913 and then Present (Freeze_Node (Par))
6914 and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
6916 -- The parent was a premature instantiation. Insert freeze node at
6917 -- the end the current declarative part.
6919 if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
6920 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
6922 -- Handle the following case:
6924 -- package Parent_Inst is new ...
6927 -- procedure P ... -- this body freezes Parent_Inst
6929 -- package Inst is new ...
6931 -- In this particular scenario, the freeze node for Inst must be
6932 -- inserted in the same manner as that of Parent_Inst - before the
6933 -- next source body or at the end of the declarative list (body not
6934 -- available). If body P did not exist and Parent_Inst was frozen
6935 -- after Inst, either by a body following Inst or at the end of the
6936 -- declarative region, the freeze node for Inst must be inserted
6937 -- after that of Parent_Inst. This relation is established by
6938 -- comparing the Slocs of Parent_Inst freeze node and Inst.
6940 elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
6941 List_Containing (Inst_Node)
6942 and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
6944 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
6947 Insert_After (Freeze_Node (Par), F_Node);
6950 -- The body enclosing the instance should be frozen after the body that
6951 -- includes the generic, because the body of the instance may make
6952 -- references to entities therein. If the two are not in the same
6953 -- declarative part, or if the one enclosing the instance is frozen
6954 -- already, freeze the instance at the end of the current declarative
6957 elsif Is_Generic_Instance (Par)
6958 and then Present (Freeze_Node (Par))
6959 and then Present (Enc_I)
6961 if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
6963 (Nkind (Enc_I) = N_Package_Body
6965 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
6967 -- The enclosing package may contain several instances. Rather
6968 -- than computing the earliest point at which to insert its freeze
6969 -- node, we place it at the end of the declarative part of the
6970 -- parent of the generic.
6972 Insert_Freeze_Node_For_Instance
6973 (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
6976 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
6978 elsif Present (Enc_G)
6979 and then Present (Enc_I)
6980 and then Enc_G /= Enc_I
6981 and then Earlier (Inst_Node, Gen_Body)
6983 if Nkind (Enc_G) = N_Package_Body then
6984 E_G_Id := Corresponding_Spec (Enc_G);
6985 else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
6987 Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
6990 -- Freeze package that encloses instance, and place node after
6991 -- package that encloses generic. If enclosing package is already
6992 -- frozen we have to assume it is at the proper place. This may be a
6993 -- potential ABE that requires dynamic checking. Do not add a freeze
6994 -- node if the package that encloses the generic is inside the body
6995 -- that encloses the instance, because the freeze node would be in
6996 -- the wrong scope. Additional contortions needed if the bodies are
6997 -- within a subunit.
7000 Enclosing_Body : Node_Id;
7003 if Nkind (Enc_I) = N_Package_Body_Stub then
7004 Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7006 Enclosing_Body := Enc_I;
7009 if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
7010 Insert_Freeze_Node_For_Instance
7011 (Enc_G, Package_Freeze_Node (Enc_I));
7015 -- Freeze enclosing subunit before instance
7017 Ensure_Freeze_Node (E_G_Id);
7019 if not Is_List_Member (Freeze_Node (E_G_Id)) then
7020 Insert_After (Enc_G, Freeze_Node (E_G_Id));
7023 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7026 -- If none of the above, insert freeze node at the end of the current
7027 -- declarative part.
7029 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7031 end Freeze_Subprogram_Body;
7037 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
7039 return Generic_Renamings.Table (E).Gen_Id;
7042 ---------------------
7043 -- Get_Instance_Of --
7044 ---------------------
7046 function Get_Instance_Of (A : Entity_Id) return Entity_Id is
7047 Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
7050 if Res /= Assoc_Null then
7051 return Generic_Renamings.Table (Res).Act_Id;
7053 -- On exit, entity is not instantiated: not a generic parameter, or
7054 -- else parameter of an inner generic unit.
7058 end Get_Instance_Of;
7060 ------------------------------------
7061 -- Get_Package_Instantiation_Node --
7062 ------------------------------------
7064 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
7065 Decl : Node_Id := Unit_Declaration_Node (A);
7069 -- If the Package_Instantiation attribute has been set on the package
7070 -- entity, then use it directly when it (or its Original_Node) refers
7071 -- to an N_Package_Instantiation node. In principle it should be
7072 -- possible to have this field set in all cases, which should be
7073 -- investigated, and would allow this function to be significantly
7076 Inst := Package_Instantiation (A);
7078 if Present (Inst) then
7079 if Nkind (Inst) = N_Package_Instantiation then
7082 elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
7083 return Original_Node (Inst);
7087 -- If the instantiation is a compilation unit that does not need body
7088 -- then the instantiation node has been rewritten as a package
7089 -- declaration for the instance, and we return the original node.
7091 -- If it is a compilation unit and the instance node has not been
7092 -- rewritten, then it is still the unit of the compilation. Finally, if
7093 -- a body is present, this is a parent of the main unit whose body has
7094 -- been compiled for inlining purposes, and the instantiation node has
7095 -- been rewritten with the instance body.
7097 -- Otherwise the instantiation node appears after the declaration. If
7098 -- the entity is a formal package, the declaration may have been
7099 -- rewritten as a generic declaration (in the case of a formal with box)
7100 -- or left as a formal package declaration if it has actuals, and is
7101 -- found with a forward search.
7103 if Nkind (Parent (Decl)) = N_Compilation_Unit then
7104 if Nkind (Decl) = N_Package_Declaration
7105 and then Present (Corresponding_Body (Decl))
7107 Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
7110 if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
7111 return Original_Node (Decl);
7113 return Unit (Parent (Decl));
7116 elsif Nkind (Decl) = N_Package_Declaration
7117 and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
7119 return Original_Node (Decl);
7122 Inst := Next (Decl);
7123 while not Nkind_In (Inst, N_Package_Instantiation,
7124 N_Formal_Package_Declaration)
7131 end Get_Package_Instantiation_Node;
7133 ------------------------
7134 -- Has_Been_Exchanged --
7135 ------------------------
7137 function Has_Been_Exchanged (E : Entity_Id) return Boolean is
7141 Next := First_Elmt (Exchanged_Views);
7142 while Present (Next) loop
7143 if Full_View (Node (Next)) = E then
7151 end Has_Been_Exchanged;
7157 function Hash (F : Entity_Id) return HTable_Range is
7159 return HTable_Range (F mod HTable_Size);
7162 ------------------------
7163 -- Hide_Current_Scope --
7164 ------------------------
7166 procedure Hide_Current_Scope is
7167 C : constant Entity_Id := Current_Scope;
7171 Set_Is_Hidden_Open_Scope (C);
7173 E := First_Entity (C);
7174 while Present (E) loop
7175 if Is_Immediately_Visible (E) then
7176 Set_Is_Immediately_Visible (E, False);
7177 Append_Elmt (E, Hidden_Entities);
7183 -- Make the scope name invisible as well. This is necessary, but might
7184 -- conflict with calls to Rtsfind later on, in case the scope is a
7185 -- predefined one. There is no clean solution to this problem, so for
7186 -- now we depend on the user not redefining Standard itself in one of
7187 -- the parent units.
7189 if Is_Immediately_Visible (C) and then C /= Standard_Standard then
7190 Set_Is_Immediately_Visible (C, False);
7191 Append_Elmt (C, Hidden_Entities);
7194 end Hide_Current_Scope;
7200 procedure Init_Env is
7201 Saved : Instance_Env;
7204 Saved.Instantiated_Parent := Current_Instantiated_Parent;
7205 Saved.Exchanged_Views := Exchanged_Views;
7206 Saved.Hidden_Entities := Hidden_Entities;
7207 Saved.Current_Sem_Unit := Current_Sem_Unit;
7208 Saved.Parent_Unit_Visible := Parent_Unit_Visible;
7209 Saved.Instance_Parent_Unit := Instance_Parent_Unit;
7211 -- Save configuration switches. These may be reset if the unit is a
7212 -- predefined unit, and the current mode is not Ada 2005.
7214 Save_Opt_Config_Switches (Saved.Switches);
7216 Instance_Envs.Append (Saved);
7218 Exchanged_Views := New_Elmt_List;
7219 Hidden_Entities := New_Elmt_List;
7221 -- Make dummy entry for Instantiated parent. If generic unit is legal,
7222 -- this is set properly in Set_Instance_Env.
7224 Current_Instantiated_Parent :=
7225 (Current_Scope, Current_Scope, Assoc_Null);
7228 ------------------------------
7229 -- In_Same_Declarative_Part --
7230 ------------------------------
7232 function In_Same_Declarative_Part
7234 Inst : Node_Id) return Boolean
7236 Decls : constant Node_Id := Parent (F_Node);
7237 Nod : Node_Id := Parent (Inst);
7240 while Present (Nod) loop
7244 elsif Nkind_In (Nod, N_Subprogram_Body,
7252 elsif Nkind (Nod) = N_Subunit then
7253 Nod := Corresponding_Stub (Nod);
7255 elsif Nkind (Nod) = N_Compilation_Unit then
7259 Nod := Parent (Nod);
7264 end In_Same_Declarative_Part;
7266 ---------------------
7267 -- In_Main_Context --
7268 ---------------------
7270 function In_Main_Context (E : Entity_Id) return Boolean is
7276 if not Is_Compilation_Unit (E)
7277 or else Ekind (E) /= E_Package
7278 or else In_Private_Part (E)
7283 Context := Context_Items (Cunit (Main_Unit));
7285 Clause := First (Context);
7286 while Present (Clause) loop
7287 if Nkind (Clause) = N_With_Clause then
7288 Nam := Name (Clause);
7290 -- If the current scope is part of the context of the main unit,
7291 -- analysis of the corresponding with_clause is not complete, and
7292 -- the entity is not set. We use the Chars field directly, which
7293 -- might produce false positives in rare cases, but guarantees
7294 -- that we produce all the instance bodies we will need.
7296 if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
7297 or else (Nkind (Nam) = N_Selected_Component
7298 and then Chars (Selector_Name (Nam)) = Chars (E))
7308 end In_Main_Context;
7310 ---------------------
7311 -- Inherit_Context --
7312 ---------------------
7314 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
7315 Current_Context : List_Id;
7316 Current_Unit : Node_Id;
7321 if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
7323 -- The inherited context is attached to the enclosing compilation
7324 -- unit. This is either the main unit, or the declaration for the
7325 -- main unit (in case the instantiation appears within the package
7326 -- declaration and the main unit is its body).
7328 Current_Unit := Parent (Inst);
7329 while Present (Current_Unit)
7330 and then Nkind (Current_Unit) /= N_Compilation_Unit
7332 Current_Unit := Parent (Current_Unit);
7335 Current_Context := Context_Items (Current_Unit);
7337 Item := First (Context_Items (Parent (Gen_Decl)));
7338 while Present (Item) loop
7339 if Nkind (Item) = N_With_Clause then
7341 -- Take care to prevent direct cyclic with's, which can happen
7342 -- if the generic body with's the current unit. Such a case
7343 -- would result in binder errors (or run-time errors if the
7344 -- -gnatE switch is in effect), but we want to prevent it here,
7345 -- because Sem.Walk_Library_Items doesn't like cycles. Note
7346 -- that we don't bother to detect indirect cycles.
7348 if Library_Unit (Item) /= Current_Unit then
7349 New_I := New_Copy (Item);
7350 Set_Implicit_With (New_I, True);
7351 Append (New_I, Current_Context);
7358 end Inherit_Context;
7364 procedure Initialize is
7366 Generic_Renamings.Init;
7369 Generic_Renamings_HTable.Reset;
7370 Circularity_Detected := False;
7371 Exchanged_Views := No_Elist;
7372 Hidden_Entities := No_Elist;
7375 -------------------------------------
7376 -- Insert_Freeze_Node_For_Instance --
7377 -------------------------------------
7379 procedure Insert_Freeze_Node_For_Instance
7383 Inst : constant Entity_Id := Entity (F_Node);
7389 if not Is_List_Member (F_Node) then
7390 Decls := List_Containing (N);
7391 Par_N := Parent (Decls);
7394 -- When the instantiation occurs in a package declaration, append the
7395 -- freeze node to the private declarations (if any).
7397 if Nkind (Par_N) = N_Package_Specification
7398 and then Decls = Visible_Declarations (Par_N)
7399 and then Present (Private_Declarations (Par_N))
7400 and then not Is_Empty_List (Private_Declarations (Par_N))
7402 Decls := Private_Declarations (Par_N);
7403 Decl := First (Decls);
7406 -- Determine the proper freeze point of a package instantiation. We
7407 -- adhere to the general rule of a package or subprogram body causing
7408 -- freezing of anything before it in the same declarative region. In
7409 -- this case, the proper freeze point of a package instantiation is
7410 -- before the first source body which follows. This ensures that
7411 -- entities coming from the instance are already frozen and usable
7412 -- in source bodies.
7414 if Nkind (Par_N) /= N_Package_Declaration
7415 and then Ekind (Inst) = E_Package
7416 and then Is_Generic_Instance (Inst)
7418 not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
7420 while Present (Decl) loop
7421 if Nkind_In (Decl, N_Package_Body, N_Subprogram_Body)
7422 and then Comes_From_Source (Decl)
7424 Insert_Before (Decl, F_Node);
7432 -- In a package declaration, or if no previous body, insert at end
7435 Insert_After (Last (Decls), F_Node);
7437 end Insert_Freeze_Node_For_Instance;
7443 procedure Install_Body
7444 (Act_Body : Node_Id;
7449 Act_Id : constant Entity_Id := Corresponding_Spec (Act_Body);
7450 Act_Unit : constant Node_Id := Unit (Cunit (Get_Source_Unit (N)));
7451 Gen_Id : constant Entity_Id := Corresponding_Spec (Gen_Body);
7452 Par : constant Entity_Id := Scope (Gen_Id);
7453 Gen_Unit : constant Node_Id :=
7454 Unit (Cunit (Get_Source_Unit (Gen_Decl)));
7455 Orig_Body : Node_Id := Gen_Body;
7457 Body_Unit : Node_Id;
7459 Must_Delay : Boolean;
7461 function Enclosing_Subp (Id : Entity_Id) return Entity_Id;
7462 -- Find subprogram (if any) that encloses instance and/or generic body
7464 function True_Sloc (N : Node_Id) return Source_Ptr;
7465 -- If the instance is nested inside a generic unit, the Sloc of the
7466 -- instance indicates the place of the original definition, not the
7467 -- point of the current enclosing instance. Pending a better usage of
7468 -- Slocs to indicate instantiation places, we determine the place of
7469 -- origin of a node by finding the maximum sloc of any ancestor node.
7470 -- Why is this not equivalent to Top_Level_Location ???
7472 --------------------
7473 -- Enclosing_Subp --
7474 --------------------
7476 function Enclosing_Subp (Id : Entity_Id) return Entity_Id is
7477 Scop : Entity_Id := Scope (Id);
7480 while Scop /= Standard_Standard
7481 and then not Is_Overloadable (Scop)
7483 Scop := Scope (Scop);
7493 function True_Sloc (N : Node_Id) return Source_Ptr is
7500 while Present (N1) and then N1 /= Act_Unit loop
7501 if Sloc (N1) > Res then
7511 -- Start of processing for Install_Body
7515 -- If the body is a subunit, the freeze point is the corresponding stub
7516 -- in the current compilation, not the subunit itself.
7518 if Nkind (Parent (Gen_Body)) = N_Subunit then
7519 Orig_Body := Corresponding_Stub (Parent (Gen_Body));
7521 Orig_Body := Gen_Body;
7524 Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
7526 -- If the instantiation and the generic definition appear in the same
7527 -- package declaration, this is an early instantiation. If they appear
7528 -- in the same declarative part, it is an early instantiation only if
7529 -- the generic body appears textually later, and the generic body is
7530 -- also in the main unit.
7532 -- If instance is nested within a subprogram, and the generic body is
7533 -- not, the instance is delayed because the enclosing body is. If
7534 -- instance and body are within the same scope, or the same sub-
7535 -- program body, indicate explicitly that the instance is delayed.
7538 (Gen_Unit = Act_Unit
7539 and then (Nkind_In (Gen_Unit, N_Package_Declaration,
7540 N_Generic_Package_Declaration)
7541 or else (Gen_Unit = Body_Unit
7542 and then True_Sloc (N) < Sloc (Orig_Body)))
7543 and then Is_In_Main_Unit (Gen_Unit)
7544 and then (Scope (Act_Id) = Scope (Gen_Id)
7546 Enclosing_Subp (Act_Id) = Enclosing_Subp (Gen_Id)));
7548 -- If this is an early instantiation, the freeze node is placed after
7549 -- the generic body. Otherwise, if the generic appears in an instance,
7550 -- we cannot freeze the current instance until the outer one is frozen.
7551 -- This is only relevant if the current instance is nested within some
7552 -- inner scope not itself within the outer instance. If this scope is
7553 -- a package body in the same declarative part as the outer instance,
7554 -- then that body needs to be frozen after the outer instance. Finally,
7555 -- if no delay is needed, we place the freeze node at the end of the
7556 -- current declarative part.
7558 if Expander_Active then
7559 Ensure_Freeze_Node (Act_Id);
7560 F_Node := Freeze_Node (Act_Id);
7563 Insert_After (Orig_Body, F_Node);
7565 elsif Is_Generic_Instance (Par)
7566 and then Present (Freeze_Node (Par))
7567 and then Scope (Act_Id) /= Par
7569 -- Freeze instance of inner generic after instance of enclosing
7572 if In_Same_Declarative_Part (Freeze_Node (Par), N) then
7574 -- Handle the following case:
7576 -- package Parent_Inst is new ...
7579 -- procedure P ... -- this body freezes Parent_Inst
7581 -- package Inst is new ...
7583 -- In this particular scenario, the freeze node for Inst must
7584 -- be inserted in the same manner as that of Parent_Inst -
7585 -- before the next source body or at the end of the declarative
7586 -- list (body not available). If body P did not exist and
7587 -- Parent_Inst was frozen after Inst, either by a body
7588 -- following Inst or at the end of the declarative region, the
7589 -- freeze node for Inst must be inserted after that of
7590 -- Parent_Inst. This relation is established by comparing the
7591 -- Slocs of Parent_Inst freeze node and Inst.
7593 if List_Containing (Get_Package_Instantiation_Node (Par)) =
7595 and then Sloc (Freeze_Node (Par)) < Sloc (N)
7597 Insert_Freeze_Node_For_Instance (N, F_Node);
7599 Insert_After (Freeze_Node (Par), F_Node);
7602 -- Freeze package enclosing instance of inner generic after
7603 -- instance of enclosing generic.
7605 elsif Nkind (Parent (N)) = N_Package_Body
7606 and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
7609 Enclosing : constant Entity_Id :=
7610 Corresponding_Spec (Parent (N));
7613 Insert_Freeze_Node_For_Instance (N, F_Node);
7614 Ensure_Freeze_Node (Enclosing);
7616 if not Is_List_Member (Freeze_Node (Enclosing)) then
7618 -- The enclosing context is a subunit, insert the freeze
7619 -- node after the stub.
7621 if Nkind (Parent (Parent (N))) = N_Subunit then
7622 Insert_Freeze_Node_For_Instance
7623 (Corresponding_Stub (Parent (Parent (N))),
7624 Freeze_Node (Enclosing));
7626 -- The parent instance has been frozen before the body of
7627 -- the enclosing package, insert the freeze node after
7630 elsif List_Containing (Freeze_Node (Par)) =
7631 List_Containing (Parent (N))
7632 and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
7634 Insert_Freeze_Node_For_Instance
7635 (Parent (N), Freeze_Node (Enclosing));
7639 (Freeze_Node (Par), Freeze_Node (Enclosing));
7645 Insert_Freeze_Node_For_Instance (N, F_Node);
7649 Insert_Freeze_Node_For_Instance (N, F_Node);
7653 Set_Is_Frozen (Act_Id);
7654 Insert_Before (N, Act_Body);
7655 Mark_Rewrite_Insertion (Act_Body);
7658 -----------------------------
7659 -- Install_Formal_Packages --
7660 -----------------------------
7662 procedure Install_Formal_Packages (Par : Entity_Id) is
7665 Gen_E : Entity_Id := Empty;
7668 E := First_Entity (Par);
7670 -- In we are installing an instance parent, locate the formal packages
7671 -- of its generic parent.
7673 if Is_Generic_Instance (Par) then
7674 Gen := Generic_Parent (Specification (Unit_Declaration_Node (Par)));
7675 Gen_E := First_Entity (Gen);
7678 while Present (E) loop
7679 if Ekind (E) = E_Package
7680 and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
7682 -- If this is the renaming for the parent instance, done
7684 if Renamed_Object (E) = Par then
7687 -- The visibility of a formal of an enclosing generic is already
7690 elsif Denotes_Formal_Package (E) then
7693 elsif Present (Associated_Formal_Package (E)) then
7694 Check_Generic_Actuals (Renamed_Object (E), True);
7695 Set_Is_Hidden (E, False);
7697 -- Find formal package in generic unit that corresponds to
7698 -- (instance of) formal package in instance.
7700 while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
7701 Next_Entity (Gen_E);
7704 if Present (Gen_E) then
7705 Map_Formal_Package_Entities (Gen_E, E);
7711 if Present (Gen_E) then
7712 Next_Entity (Gen_E);
7715 end Install_Formal_Packages;
7717 --------------------
7718 -- Install_Parent --
7719 --------------------
7721 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
7722 Ancestors : constant Elist_Id := New_Elmt_List;
7723 S : constant Entity_Id := Current_Scope;
7724 Inst_Par : Entity_Id;
7725 First_Par : Entity_Id;
7726 Inst_Node : Node_Id;
7727 Gen_Par : Entity_Id;
7728 First_Gen : Entity_Id;
7731 procedure Install_Noninstance_Specs (Par : Entity_Id);
7732 -- Install the scopes of noninstance parent units ending with Par
7734 procedure Install_Spec (Par : Entity_Id);
7735 -- The child unit is within the declarative part of the parent, so
7736 -- the declarations within the parent are immediately visible.
7738 -------------------------------
7739 -- Install_Noninstance_Specs --
7740 -------------------------------
7742 procedure Install_Noninstance_Specs (Par : Entity_Id) is
7745 and then Par /= Standard_Standard
7746 and then not In_Open_Scopes (Par)
7748 Install_Noninstance_Specs (Scope (Par));
7751 end Install_Noninstance_Specs;
7757 procedure Install_Spec (Par : Entity_Id) is
7758 Spec : constant Node_Id :=
7759 Specification (Unit_Declaration_Node (Par));
7762 -- If this parent of the child instance is a top-level unit,
7763 -- then record the unit and its visibility for later resetting
7764 -- in Remove_Parent. We exclude units that are generic instances,
7765 -- as we only want to record this information for the ultimate
7766 -- top-level noninstance parent (is that always correct???).
7768 if Scope (Par) = Standard_Standard
7769 and then not Is_Generic_Instance (Par)
7771 Parent_Unit_Visible := Is_Immediately_Visible (Par);
7772 Instance_Parent_Unit := Par;
7775 -- Open the parent scope and make it and its declarations visible.
7776 -- If this point is not within a body, then only the visible
7777 -- declarations should be made visible, and installation of the
7778 -- private declarations is deferred until the appropriate point
7779 -- within analysis of the spec being instantiated (see the handling
7780 -- of parent visibility in Analyze_Package_Specification). This is
7781 -- relaxed in the case where the parent unit is Ada.Tags, to avoid
7782 -- private view problems that occur when compiling instantiations of
7783 -- a generic child of that package (Generic_Dispatching_Constructor).
7784 -- If the instance freezes a tagged type, inlinings of operations
7785 -- from Ada.Tags may need the full view of type Tag. If inlining took
7786 -- proper account of establishing visibility of inlined subprograms'
7787 -- parents then it should be possible to remove this
7788 -- special check. ???
7791 Set_Is_Immediately_Visible (Par);
7792 Install_Visible_Declarations (Par);
7793 Set_Use (Visible_Declarations (Spec));
7795 if In_Body or else Is_RTU (Par, Ada_Tags) then
7796 Install_Private_Declarations (Par);
7797 Set_Use (Private_Declarations (Spec));
7801 -- Start of processing for Install_Parent
7804 -- We need to install the parent instance to compile the instantiation
7805 -- of the child, but the child instance must appear in the current
7806 -- scope. Given that we cannot place the parent above the current scope
7807 -- in the scope stack, we duplicate the current scope and unstack both
7808 -- after the instantiation is complete.
7810 -- If the parent is itself the instantiation of a child unit, we must
7811 -- also stack the instantiation of its parent, and so on. Each such
7812 -- ancestor is the prefix of the name in a prior instantiation.
7814 -- If this is a nested instance, the parent unit itself resolves to
7815 -- a renaming of the parent instance, whose declaration we need.
7817 -- Finally, the parent may be a generic (not an instance) when the
7818 -- child unit appears as a formal package.
7822 if Present (Renamed_Entity (Inst_Par)) then
7823 Inst_Par := Renamed_Entity (Inst_Par);
7826 First_Par := Inst_Par;
7829 Generic_Parent (Specification (Unit_Declaration_Node (Inst_Par)));
7831 First_Gen := Gen_Par;
7833 while Present (Gen_Par)
7834 and then Is_Child_Unit (Gen_Par)
7836 -- Load grandparent instance as well
7838 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
7840 if Nkind (Name (Inst_Node)) = N_Expanded_Name then
7841 Inst_Par := Entity (Prefix (Name (Inst_Node)));
7843 if Present (Renamed_Entity (Inst_Par)) then
7844 Inst_Par := Renamed_Entity (Inst_Par);
7849 (Specification (Unit_Declaration_Node (Inst_Par)));
7851 if Present (Gen_Par) then
7852 Prepend_Elmt (Inst_Par, Ancestors);
7855 -- Parent is not the name of an instantiation
7857 Install_Noninstance_Specs (Inst_Par);
7869 if Present (First_Gen) then
7870 Append_Elmt (First_Par, Ancestors);
7873 Install_Noninstance_Specs (First_Par);
7876 if not Is_Empty_Elmt_List (Ancestors) then
7877 Elmt := First_Elmt (Ancestors);
7879 while Present (Elmt) loop
7880 Install_Spec (Node (Elmt));
7881 Install_Formal_Packages (Node (Elmt));
7892 --------------------------------
7893 -- Instantiate_Formal_Package --
7894 --------------------------------
7896 function Instantiate_Formal_Package
7899 Analyzed_Formal : Node_Id) return List_Id
7901 Loc : constant Source_Ptr := Sloc (Actual);
7902 Actual_Pack : Entity_Id;
7903 Formal_Pack : Entity_Id;
7904 Gen_Parent : Entity_Id;
7907 Parent_Spec : Node_Id;
7909 procedure Find_Matching_Actual
7911 Act : in out Entity_Id);
7912 -- We need to associate each formal entity in the formal package
7913 -- with the corresponding entity in the actual package. The actual
7914 -- package has been analyzed and possibly expanded, and as a result
7915 -- there is no one-to-one correspondence between the two lists (for
7916 -- example, the actual may include subtypes, itypes, and inherited
7917 -- primitive operations, interspersed among the renaming declarations
7918 -- for the actuals) . We retrieve the corresponding actual by name
7919 -- because each actual has the same name as the formal, and they do
7920 -- appear in the same order.
7922 function Get_Formal_Entity (N : Node_Id) return Entity_Id;
7923 -- Retrieve entity of defining entity of generic formal parameter.
7924 -- Only the declarations of formals need to be considered when
7925 -- linking them to actuals, but the declarative list may include
7926 -- internal entities generated during analysis, and those are ignored.
7928 procedure Match_Formal_Entity
7929 (Formal_Node : Node_Id;
7930 Formal_Ent : Entity_Id;
7931 Actual_Ent : Entity_Id);
7932 -- Associates the formal entity with the actual. In the case
7933 -- where Formal_Ent is a formal package, this procedure iterates
7934 -- through all of its formals and enters associations between the
7935 -- actuals occurring in the formal package's corresponding actual
7936 -- package (given by Actual_Ent) and the formal package's formal
7937 -- parameters. This procedure recurses if any of the parameters is
7938 -- itself a package.
7940 function Is_Instance_Of
7941 (Act_Spec : Entity_Id;
7942 Gen_Anc : Entity_Id) return Boolean;
7943 -- The actual can be an instantiation of a generic within another
7944 -- instance, in which case there is no direct link from it to the
7945 -- original generic ancestor. In that case, we recognize that the
7946 -- ultimate ancestor is the same by examining names and scopes.
7948 procedure Process_Nested_Formal (Formal : Entity_Id);
7949 -- If the current formal is declared with a box, its own formals are
7950 -- visible in the instance, as they were in the generic, and their
7951 -- Hidden flag must be reset. If some of these formals are themselves
7952 -- packages declared with a box, the processing must be recursive.
7954 --------------------------
7955 -- Find_Matching_Actual --
7956 --------------------------
7958 procedure Find_Matching_Actual
7960 Act : in out Entity_Id)
7962 Formal_Ent : Entity_Id;
7965 case Nkind (Original_Node (F)) is
7966 when N_Formal_Object_Declaration |
7967 N_Formal_Type_Declaration =>
7968 Formal_Ent := Defining_Identifier (F);
7970 while Chars (Act) /= Chars (Formal_Ent) loop
7974 when N_Formal_Subprogram_Declaration |
7975 N_Formal_Package_Declaration |
7976 N_Package_Declaration |
7977 N_Generic_Package_Declaration =>
7978 Formal_Ent := Defining_Entity (F);
7980 while Chars (Act) /= Chars (Formal_Ent) loop
7985 raise Program_Error;
7987 end Find_Matching_Actual;
7989 -------------------------
7990 -- Match_Formal_Entity --
7991 -------------------------
7993 procedure Match_Formal_Entity
7994 (Formal_Node : Node_Id;
7995 Formal_Ent : Entity_Id;
7996 Actual_Ent : Entity_Id)
7998 Act_Pkg : Entity_Id;
8001 Set_Instance_Of (Formal_Ent, Actual_Ent);
8003 if Ekind (Actual_Ent) = E_Package then
8005 -- Record associations for each parameter
8007 Act_Pkg := Actual_Ent;
8010 A_Ent : Entity_Id := First_Entity (Act_Pkg);
8019 -- Retrieve the actual given in the formal package declaration
8021 Actual := Entity (Name (Original_Node (Formal_Node)));
8023 -- The actual in the formal package declaration may be a
8024 -- renamed generic package, in which case we want to retrieve
8025 -- the original generic in order to traverse its formal part.
8027 if Present (Renamed_Entity (Actual)) then
8028 Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
8030 Gen_Decl := Unit_Declaration_Node (Actual);
8033 Formals := Generic_Formal_Declarations (Gen_Decl);
8035 if Present (Formals) then
8036 F_Node := First_Non_Pragma (Formals);
8041 while Present (A_Ent)
8042 and then Present (F_Node)
8043 and then A_Ent /= First_Private_Entity (Act_Pkg)
8045 F_Ent := Get_Formal_Entity (F_Node);
8047 if Present (F_Ent) then
8049 -- This is a formal of the original package. Record
8050 -- association and recurse.
8052 Find_Matching_Actual (F_Node, A_Ent);
8053 Match_Formal_Entity (F_Node, F_Ent, A_Ent);
8054 Next_Entity (A_Ent);
8057 Next_Non_Pragma (F_Node);
8061 end Match_Formal_Entity;
8063 -----------------------
8064 -- Get_Formal_Entity --
8065 -----------------------
8067 function Get_Formal_Entity (N : Node_Id) return Entity_Id is
8068 Kind : constant Node_Kind := Nkind (Original_Node (N));
8071 when N_Formal_Object_Declaration =>
8072 return Defining_Identifier (N);
8074 when N_Formal_Type_Declaration =>
8075 return Defining_Identifier (N);
8077 when N_Formal_Subprogram_Declaration =>
8078 return Defining_Unit_Name (Specification (N));
8080 when N_Formal_Package_Declaration =>
8081 return Defining_Identifier (Original_Node (N));
8083 when N_Generic_Package_Declaration =>
8084 return Defining_Identifier (Original_Node (N));
8086 -- All other declarations are introduced by semantic analysis and
8087 -- have no match in the actual.
8092 end Get_Formal_Entity;
8094 --------------------
8095 -- Is_Instance_Of --
8096 --------------------
8098 function Is_Instance_Of
8099 (Act_Spec : Entity_Id;
8100 Gen_Anc : Entity_Id) return Boolean
8102 Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
8105 if No (Gen_Par) then
8108 -- Simplest case: the generic parent of the actual is the formal
8110 elsif Gen_Par = Gen_Anc then
8113 elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
8116 -- The actual may be obtained through several instantiations. Its
8117 -- scope must itself be an instance of a generic declared in the
8118 -- same scope as the formal. Any other case is detected above.
8120 elsif not Is_Generic_Instance (Scope (Gen_Par)) then
8124 return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
8128 ---------------------------
8129 -- Process_Nested_Formal --
8130 ---------------------------
8132 procedure Process_Nested_Formal (Formal : Entity_Id) is
8136 if Present (Associated_Formal_Package (Formal))
8137 and then Box_Present (Parent (Associated_Formal_Package (Formal)))
8139 Ent := First_Entity (Formal);
8140 while Present (Ent) loop
8141 Set_Is_Hidden (Ent, False);
8142 Set_Is_Visible_Formal (Ent);
8143 Set_Is_Potentially_Use_Visible
8144 (Ent, Is_Potentially_Use_Visible (Formal));
8146 if Ekind (Ent) = E_Package then
8147 exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
8148 Process_Nested_Formal (Ent);
8154 end Process_Nested_Formal;
8156 -- Start of processing for Instantiate_Formal_Package
8161 if not Is_Entity_Name (Actual)
8162 or else Ekind (Entity (Actual)) /= E_Package
8165 ("expect package instance to instantiate formal", Actual);
8166 Abandon_Instantiation (Actual);
8167 raise Program_Error;
8170 Actual_Pack := Entity (Actual);
8171 Set_Is_Instantiated (Actual_Pack);
8173 -- The actual may be a renamed package, or an outer generic formal
8174 -- package whose instantiation is converted into a renaming.
8176 if Present (Renamed_Object (Actual_Pack)) then
8177 Actual_Pack := Renamed_Object (Actual_Pack);
8180 if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
8181 Gen_Parent := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
8182 Formal_Pack := Defining_Identifier (Analyzed_Formal);
8185 Generic_Parent (Specification (Analyzed_Formal));
8187 Defining_Unit_Name (Specification (Analyzed_Formal));
8190 if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
8191 Parent_Spec := Specification (Unit_Declaration_Node (Actual_Pack));
8193 Parent_Spec := Parent (Actual_Pack);
8196 if Gen_Parent = Any_Id then
8198 ("previous error in declaration of formal package", Actual);
8199 Abandon_Instantiation (Actual);
8202 Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
8208 ("actual parameter must be instance of&", Actual, Gen_Parent);
8209 Abandon_Instantiation (Actual);
8212 Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
8213 Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
8216 Make_Package_Renaming_Declaration (Loc,
8217 Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
8218 Name => New_Reference_To (Actual_Pack, Loc));
8220 Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
8221 Defining_Identifier (Formal));
8222 Decls := New_List (Nod);
8224 -- If the formal F has a box, then the generic declarations are
8225 -- visible in the generic G. In an instance of G, the corresponding
8226 -- entities in the actual for F (which are the actuals for the
8227 -- instantiation of the generic that F denotes) must also be made
8228 -- visible for analysis of the current instance. On exit from the
8229 -- current instance, those entities are made private again. If the
8230 -- actual is currently in use, these entities are also use-visible.
8232 -- The loop through the actual entities also steps through the formal
8233 -- entities and enters associations from formals to actuals into the
8234 -- renaming map. This is necessary to properly handle checking of
8235 -- actual parameter associations for later formals that depend on
8236 -- actuals declared in the formal package.
8238 -- In Ada 2005, partial parametrization requires that we make visible
8239 -- the actuals corresponding to formals that were defaulted in the
8240 -- formal package. There formals are identified because they remain
8241 -- formal generics within the formal package, rather than being
8242 -- renamings of the actuals supplied.
8245 Gen_Decl : constant Node_Id :=
8246 Unit_Declaration_Node (Gen_Parent);
8247 Formals : constant List_Id :=
8248 Generic_Formal_Declarations (Gen_Decl);
8250 Actual_Ent : Entity_Id;
8251 Actual_Of_Formal : Node_Id;
8252 Formal_Node : Node_Id;
8253 Formal_Ent : Entity_Id;
8256 if Present (Formals) then
8257 Formal_Node := First_Non_Pragma (Formals);
8259 Formal_Node := Empty;
8262 Actual_Ent := First_Entity (Actual_Pack);
8264 First (Visible_Declarations (Specification (Analyzed_Formal)));
8265 while Present (Actual_Ent)
8266 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
8268 if Present (Formal_Node) then
8269 Formal_Ent := Get_Formal_Entity (Formal_Node);
8271 if Present (Formal_Ent) then
8272 Find_Matching_Actual (Formal_Node, Actual_Ent);
8274 (Formal_Node, Formal_Ent, Actual_Ent);
8276 -- We iterate at the same time over the actuals of the
8277 -- local package created for the formal, to determine
8278 -- which one of the formals of the original generic were
8279 -- defaulted in the formal. The corresponding actual
8280 -- entities are visible in the enclosing instance.
8282 if Box_Present (Formal)
8284 (Present (Actual_Of_Formal)
8287 (Get_Formal_Entity (Actual_Of_Formal)))
8289 Set_Is_Hidden (Actual_Ent, False);
8290 Set_Is_Visible_Formal (Actual_Ent);
8291 Set_Is_Potentially_Use_Visible
8292 (Actual_Ent, In_Use (Actual_Pack));
8294 if Ekind (Actual_Ent) = E_Package then
8295 Process_Nested_Formal (Actual_Ent);
8299 Set_Is_Hidden (Actual_Ent);
8300 Set_Is_Potentially_Use_Visible (Actual_Ent, False);
8304 Next_Non_Pragma (Formal_Node);
8305 Next (Actual_Of_Formal);
8308 -- No further formals to match, but the generic part may
8309 -- contain inherited operation that are not hidden in the
8310 -- enclosing instance.
8312 Next_Entity (Actual_Ent);
8316 -- Inherited subprograms generated by formal derived types are
8317 -- also visible if the types are.
8319 Actual_Ent := First_Entity (Actual_Pack);
8320 while Present (Actual_Ent)
8321 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
8323 if Is_Overloadable (Actual_Ent)
8325 Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
8327 not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
8329 Set_Is_Hidden (Actual_Ent, False);
8330 Set_Is_Potentially_Use_Visible
8331 (Actual_Ent, In_Use (Actual_Pack));
8334 Next_Entity (Actual_Ent);
8338 -- If the formal is not declared with a box, reanalyze it as an
8339 -- abbreviated instantiation, to verify the matching rules of 12.7.
8340 -- The actual checks are performed after the generic associations
8341 -- have been analyzed, to guarantee the same visibility for this
8342 -- instantiation and for the actuals.
8344 -- In Ada 2005, the generic associations for the formal can include
8345 -- defaulted parameters. These are ignored during check. This
8346 -- internal instantiation is removed from the tree after conformance
8347 -- checking, because it contains formal declarations for those
8348 -- defaulted parameters, and those should not reach the back-end.
8350 if not Box_Present (Formal) then
8352 I_Pack : constant Entity_Id :=
8353 Make_Temporary (Sloc (Actual), 'P');
8356 Set_Is_Internal (I_Pack);
8359 Make_Package_Instantiation (Sloc (Actual),
8360 Defining_Unit_Name => I_Pack,
8363 (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
8364 Generic_Associations =>
8365 Generic_Associations (Formal)));
8371 end Instantiate_Formal_Package;
8373 -----------------------------------
8374 -- Instantiate_Formal_Subprogram --
8375 -----------------------------------
8377 function Instantiate_Formal_Subprogram
8380 Analyzed_Formal : Node_Id) return Node_Id
8383 Formal_Sub : constant Entity_Id :=
8384 Defining_Unit_Name (Specification (Formal));
8385 Analyzed_S : constant Entity_Id :=
8386 Defining_Unit_Name (Specification (Analyzed_Formal));
8387 Decl_Node : Node_Id;
8391 function From_Parent_Scope (Subp : Entity_Id) return Boolean;
8392 -- If the generic is a child unit, the parent has been installed on the
8393 -- scope stack, but a default subprogram cannot resolve to something on
8394 -- the parent because that parent is not really part of the visible
8395 -- context (it is there to resolve explicit local entities). If the
8396 -- default has resolved in this way, we remove the entity from
8397 -- immediate visibility and analyze the node again to emit an error
8398 -- message or find another visible candidate.
8400 procedure Valid_Actual_Subprogram (Act : Node_Id);
8401 -- Perform legality check and raise exception on failure
8403 -----------------------
8404 -- From_Parent_Scope --
8405 -----------------------
8407 function From_Parent_Scope (Subp : Entity_Id) return Boolean is
8408 Gen_Scope : Node_Id;
8411 Gen_Scope := Scope (Analyzed_S);
8412 while Present (Gen_Scope)
8413 and then Is_Child_Unit (Gen_Scope)
8415 if Scope (Subp) = Scope (Gen_Scope) then
8419 Gen_Scope := Scope (Gen_Scope);
8423 end From_Parent_Scope;
8425 -----------------------------
8426 -- Valid_Actual_Subprogram --
8427 -----------------------------
8429 procedure Valid_Actual_Subprogram (Act : Node_Id) is
8433 if Is_Entity_Name (Act) then
8434 Act_E := Entity (Act);
8436 elsif Nkind (Act) = N_Selected_Component
8437 and then Is_Entity_Name (Selector_Name (Act))
8439 Act_E := Entity (Selector_Name (Act));
8445 if (Present (Act_E) and then Is_Overloadable (Act_E))
8446 or else Nkind_In (Act, N_Attribute_Reference,
8447 N_Indexed_Component,
8448 N_Character_Literal,
8449 N_Explicit_Dereference)
8455 ("expect subprogram or entry name in instantiation of&",
8456 Instantiation_Node, Formal_Sub);
8457 Abandon_Instantiation (Instantiation_Node);
8459 end Valid_Actual_Subprogram;
8461 -- Start of processing for Instantiate_Formal_Subprogram
8464 New_Spec := New_Copy_Tree (Specification (Formal));
8466 -- The tree copy has created the proper instantiation sloc for the
8467 -- new specification. Use this location for all other constructed
8470 Loc := Sloc (Defining_Unit_Name (New_Spec));
8472 -- Create new entity for the actual (New_Copy_Tree does not)
8474 Set_Defining_Unit_Name
8475 (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
8477 -- Create new entities for the each of the formals in the
8478 -- specification of the renaming declaration built for the actual.
8480 if Present (Parameter_Specifications (New_Spec)) then
8484 F := First (Parameter_Specifications (New_Spec));
8485 while Present (F) loop
8486 Set_Defining_Identifier (F,
8487 Make_Defining_Identifier (Sloc (F),
8488 Chars => Chars (Defining_Identifier (F))));
8494 -- Find entity of actual. If the actual is an attribute reference, it
8495 -- cannot be resolved here (its formal is missing) but is handled
8496 -- instead in Attribute_Renaming. If the actual is overloaded, it is
8497 -- fully resolved subsequently, when the renaming declaration for the
8498 -- formal is analyzed. If it is an explicit dereference, resolve the
8499 -- prefix but not the actual itself, to prevent interpretation as call.
8501 if Present (Actual) then
8502 Loc := Sloc (Actual);
8503 Set_Sloc (New_Spec, Loc);
8505 if Nkind (Actual) = N_Operator_Symbol then
8506 Find_Direct_Name (Actual);
8508 elsif Nkind (Actual) = N_Explicit_Dereference then
8509 Analyze (Prefix (Actual));
8511 elsif Nkind (Actual) /= N_Attribute_Reference then
8515 Valid_Actual_Subprogram (Actual);
8518 elsif Present (Default_Name (Formal)) then
8519 if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
8520 N_Selected_Component,
8521 N_Indexed_Component,
8522 N_Character_Literal)
8523 and then Present (Entity (Default_Name (Formal)))
8525 Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
8527 Nam := New_Copy (Default_Name (Formal));
8528 Set_Sloc (Nam, Loc);
8531 elsif Box_Present (Formal) then
8533 -- Actual is resolved at the point of instantiation. Create an
8534 -- identifier or operator with the same name as the formal.
8536 if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
8537 Nam := Make_Operator_Symbol (Loc,
8538 Chars => Chars (Formal_Sub),
8539 Strval => No_String);
8541 Nam := Make_Identifier (Loc, Chars (Formal_Sub));
8544 elsif Nkind (Specification (Formal)) = N_Procedure_Specification
8545 and then Null_Present (Specification (Formal))
8547 -- Generate null body for procedure, for use in the instance
8550 Make_Subprogram_Body (Loc,
8551 Specification => New_Spec,
8552 Declarations => New_List,
8553 Handled_Statement_Sequence =>
8554 Make_Handled_Sequence_Of_Statements (Loc,
8555 Statements => New_List (Make_Null_Statement (Loc))));
8557 Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
8561 Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
8563 ("missing actual&", Instantiation_Node, Formal_Sub);
8565 ("\in instantiation of & declared#",
8566 Instantiation_Node, Scope (Analyzed_S));
8567 Abandon_Instantiation (Instantiation_Node);
8571 Make_Subprogram_Renaming_Declaration (Loc,
8572 Specification => New_Spec,
8575 -- If we do not have an actual and the formal specified <> then set to
8576 -- get proper default.
8578 if No (Actual) and then Box_Present (Formal) then
8579 Set_From_Default (Decl_Node);
8582 -- Gather possible interpretations for the actual before analyzing the
8583 -- instance. If overloaded, it will be resolved when analyzing the
8584 -- renaming declaration.
8586 if Box_Present (Formal)
8587 and then No (Actual)
8591 if Is_Child_Unit (Scope (Analyzed_S))
8592 and then Present (Entity (Nam))
8594 if not Is_Overloaded (Nam) then
8596 if From_Parent_Scope (Entity (Nam)) then
8597 Set_Is_Immediately_Visible (Entity (Nam), False);
8598 Set_Entity (Nam, Empty);
8599 Set_Etype (Nam, Empty);
8603 Set_Is_Immediately_Visible (Entity (Nam));
8612 Get_First_Interp (Nam, I, It);
8614 while Present (It.Nam) loop
8615 if From_Parent_Scope (It.Nam) then
8619 Get_Next_Interp (I, It);
8626 -- The generic instantiation freezes the actual. This can only be done
8627 -- once the actual is resolved, in the analysis of the renaming
8628 -- declaration. To make the formal subprogram entity available, we set
8629 -- Corresponding_Formal_Spec to point to the formal subprogram entity.
8630 -- This is also needed in Analyze_Subprogram_Renaming for the processing
8631 -- of formal abstract subprograms.
8633 Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
8635 -- We cannot analyze the renaming declaration, and thus find the actual,
8636 -- until all the actuals are assembled in the instance. For subsequent
8637 -- checks of other actuals, indicate the node that will hold the
8638 -- instance of this formal.
8640 Set_Instance_Of (Analyzed_S, Nam);
8642 if Nkind (Actual) = N_Selected_Component
8643 and then Is_Task_Type (Etype (Prefix (Actual)))
8644 and then not Is_Frozen (Etype (Prefix (Actual)))
8646 -- The renaming declaration will create a body, which must appear
8647 -- outside of the instantiation, We move the renaming declaration
8648 -- out of the instance, and create an additional renaming inside,
8649 -- to prevent freezing anomalies.
8652 Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
8655 Set_Defining_Unit_Name (New_Spec, Anon_Id);
8656 Insert_Before (Instantiation_Node, Decl_Node);
8657 Analyze (Decl_Node);
8659 -- Now create renaming within the instance
8662 Make_Subprogram_Renaming_Declaration (Loc,
8663 Specification => New_Copy_Tree (New_Spec),
8664 Name => New_Occurrence_Of (Anon_Id, Loc));
8666 Set_Defining_Unit_Name (Specification (Decl_Node),
8667 Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
8672 end Instantiate_Formal_Subprogram;
8674 ------------------------
8675 -- Instantiate_Object --
8676 ------------------------
8678 function Instantiate_Object
8681 Analyzed_Formal : Node_Id) return List_Id
8683 Gen_Obj : constant Entity_Id := Defining_Identifier (Formal);
8684 A_Gen_Obj : constant Entity_Id :=
8685 Defining_Identifier (Analyzed_Formal);
8686 Acc_Def : Node_Id := Empty;
8687 Act_Assoc : constant Node_Id := Parent (Actual);
8688 Actual_Decl : Node_Id := Empty;
8689 Decl_Node : Node_Id;
8692 List : constant List_Id := New_List;
8693 Loc : constant Source_Ptr := Sloc (Actual);
8694 Orig_Ftyp : constant Entity_Id := Etype (A_Gen_Obj);
8695 Subt_Decl : Node_Id := Empty;
8696 Subt_Mark : Node_Id := Empty;
8699 if Present (Subtype_Mark (Formal)) then
8700 Subt_Mark := Subtype_Mark (Formal);
8702 Check_Access_Definition (Formal);
8703 Acc_Def := Access_Definition (Formal);
8706 -- Sloc for error message on missing actual
8708 Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
8710 if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
8711 Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
8714 Set_Parent (List, Parent (Actual));
8718 if Out_Present (Formal) then
8720 -- An IN OUT generic actual must be a name. The instantiation is a
8721 -- renaming declaration. The actual is the name being renamed. We
8722 -- use the actual directly, rather than a copy, because it is not
8723 -- used further in the list of actuals, and because a copy or a use
8724 -- of relocate_node is incorrect if the instance is nested within a
8725 -- generic. In order to simplify ASIS searches, the Generic_Parent
8726 -- field links the declaration to the generic association.
8731 Instantiation_Node, Gen_Obj);
8733 ("\in instantiation of & declared#",
8734 Instantiation_Node, Scope (A_Gen_Obj));
8735 Abandon_Instantiation (Instantiation_Node);
8738 if Present (Subt_Mark) then
8740 Make_Object_Renaming_Declaration (Loc,
8741 Defining_Identifier => New_Copy (Gen_Obj),
8742 Subtype_Mark => New_Copy_Tree (Subt_Mark),
8745 else pragma Assert (Present (Acc_Def));
8747 Make_Object_Renaming_Declaration (Loc,
8748 Defining_Identifier => New_Copy (Gen_Obj),
8749 Access_Definition => New_Copy_Tree (Acc_Def),
8753 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
8755 -- The analysis of the actual may produce insert_action nodes, so
8756 -- the declaration must have a context in which to attach them.
8758 Append (Decl_Node, List);
8761 -- Return if the analysis of the actual reported some error
8763 if Etype (Actual) = Any_Type then
8767 -- This check is performed here because Analyze_Object_Renaming will
8768 -- not check it when Comes_From_Source is False. Note though that the
8769 -- check for the actual being the name of an object will be performed
8770 -- in Analyze_Object_Renaming.
8772 if Is_Object_Reference (Actual)
8773 and then Is_Dependent_Component_Of_Mutable_Object (Actual)
8776 ("illegal discriminant-dependent component for in out parameter",
8780 -- The actual has to be resolved in order to check that it is a
8781 -- variable (due to cases such as F (1), where F returns access to an
8782 -- array, and for overloaded prefixes).
8784 Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
8786 -- If the type of the formal is not itself a formal, and the
8787 -- current unit is a child unit, the formal type must be declared
8788 -- in a parent, and must be retrieved by visibility.
8791 and then Is_Generic_Unit (Scope (Ftyp))
8792 and then Is_Child_Unit (Scope (A_Gen_Obj))
8795 Temp : constant Node_Id :=
8796 New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
8798 Set_Entity (Temp, Empty);
8800 Ftyp := Entity (Temp);
8804 if Is_Private_Type (Ftyp)
8805 and then not Is_Private_Type (Etype (Actual))
8806 and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
8807 or else Base_Type (Etype (Actual)) = Ftyp)
8809 -- If the actual has the type of the full view of the formal, or
8810 -- else a non-private subtype of the formal, then the visibility
8811 -- of the formal type has changed. Add to the actuals a subtype
8812 -- declaration that will force the exchange of views in the body
8813 -- of the instance as well.
8816 Make_Subtype_Declaration (Loc,
8817 Defining_Identifier => Make_Temporary (Loc, 'P'),
8818 Subtype_Indication => New_Occurrence_Of (Ftyp, Loc));
8820 Prepend (Subt_Decl, List);
8822 Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
8823 Exchange_Declarations (Ftyp);
8826 Resolve (Actual, Ftyp);
8828 if not Denotes_Variable (Actual) then
8830 ("actual for& must be a variable", Actual, Gen_Obj);
8832 elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
8834 -- Ada 2005 (AI-423): For a generic formal object of mode in out,
8835 -- the type of the actual shall resolve to a specific anonymous
8838 if Ada_Version < Ada_2005
8840 Ekind (Base_Type (Ftyp)) /=
8841 E_Anonymous_Access_Type
8843 Ekind (Base_Type (Etype (Actual))) /=
8844 E_Anonymous_Access_Type
8846 Error_Msg_NE ("type of actual does not match type of&",
8851 Note_Possible_Modification (Actual, Sure => True);
8853 -- Check for instantiation of atomic/volatile actual for
8854 -- non-atomic/volatile formal (RM C.6 (12)).
8856 if Is_Atomic_Object (Actual)
8857 and then not Is_Atomic (Orig_Ftyp)
8860 ("cannot instantiate non-atomic formal object " &
8861 "with atomic actual", Actual);
8863 elsif Is_Volatile_Object (Actual)
8864 and then not Is_Volatile (Orig_Ftyp)
8867 ("cannot instantiate non-volatile formal object " &
8868 "with volatile actual", Actual);
8871 -- Formal in-parameter
8874 -- The instantiation of a generic formal in-parameter is constant
8875 -- declaration. The actual is the expression for that declaration.
8877 if Present (Actual) then
8878 if Present (Subt_Mark) then
8880 else pragma Assert (Present (Acc_Def));
8885 Make_Object_Declaration (Loc,
8886 Defining_Identifier => New_Copy (Gen_Obj),
8887 Constant_Present => True,
8888 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
8889 Object_Definition => New_Copy_Tree (Def),
8890 Expression => Actual);
8892 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
8894 -- A generic formal object of a tagged type is defined to be
8895 -- aliased so the new constant must also be treated as aliased.
8897 if Is_Tagged_Type (Etype (A_Gen_Obj)) then
8898 Set_Aliased_Present (Decl_Node);
8901 Append (Decl_Node, List);
8903 -- No need to repeat (pre-)analysis of some expression nodes
8904 -- already handled in Preanalyze_Actuals.
8906 if Nkind (Actual) /= N_Allocator then
8909 -- Return if the analysis of the actual reported some error
8911 if Etype (Actual) = Any_Type then
8917 Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
8921 Typ := Get_Instance_Of (Formal_Type);
8923 Freeze_Before (Instantiation_Node, Typ);
8925 -- If the actual is an aggregate, perform name resolution on
8926 -- its components (the analysis of an aggregate does not do it)
8927 -- to capture local names that may be hidden if the generic is
8930 if Nkind (Actual) = N_Aggregate then
8931 Preanalyze_And_Resolve (Actual, Typ);
8934 if Is_Limited_Type (Typ)
8935 and then not OK_For_Limited_Init (Typ, Actual)
8938 ("initialization not allowed for limited types", Actual);
8939 Explain_Limited_Type (Typ, Actual);
8943 elsif Present (Default_Expression (Formal)) then
8945 -- Use default to construct declaration
8947 if Present (Subt_Mark) then
8949 else pragma Assert (Present (Acc_Def));
8954 Make_Object_Declaration (Sloc (Formal),
8955 Defining_Identifier => New_Copy (Gen_Obj),
8956 Constant_Present => True,
8957 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
8958 Object_Definition => New_Copy (Def),
8959 Expression => New_Copy_Tree
8960 (Default_Expression (Formal)));
8962 Append (Decl_Node, List);
8963 Set_Analyzed (Expression (Decl_Node), False);
8968 Instantiation_Node, Gen_Obj);
8969 Error_Msg_NE ("\in instantiation of & declared#",
8970 Instantiation_Node, Scope (A_Gen_Obj));
8972 if Is_Scalar_Type (Etype (A_Gen_Obj)) then
8974 -- Create dummy constant declaration so that instance can be
8975 -- analyzed, to minimize cascaded visibility errors.
8977 if Present (Subt_Mark) then
8979 else pragma Assert (Present (Acc_Def));
8984 Make_Object_Declaration (Loc,
8985 Defining_Identifier => New_Copy (Gen_Obj),
8986 Constant_Present => True,
8987 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
8988 Object_Definition => New_Copy (Def),
8990 Make_Attribute_Reference (Sloc (Gen_Obj),
8991 Attribute_Name => Name_First,
8992 Prefix => New_Copy (Def)));
8994 Append (Decl_Node, List);
8997 Abandon_Instantiation (Instantiation_Node);
9002 if Nkind (Actual) in N_Has_Entity then
9003 Actual_Decl := Parent (Entity (Actual));
9006 -- Ada 2005 (AI-423): For a formal object declaration with a null
9007 -- exclusion or an access definition that has a null exclusion: If the
9008 -- actual matching the formal object declaration denotes a generic
9009 -- formal object of another generic unit G, and the instantiation
9010 -- containing the actual occurs within the body of G or within the body
9011 -- of a generic unit declared within the declarative region of G, then
9012 -- the declaration of the formal object of G must have a null exclusion.
9013 -- Otherwise, the subtype of the actual matching the formal object
9014 -- declaration shall exclude null.
9016 if Ada_Version >= Ada_2005
9017 and then Present (Actual_Decl)
9019 Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
9020 N_Object_Declaration)
9021 and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
9022 and then not Has_Null_Exclusion (Actual_Decl)
9023 and then Has_Null_Exclusion (Analyzed_Formal)
9025 Error_Msg_Sloc := Sloc (Analyzed_Formal);
9027 ("actual must exclude null to match generic formal#", Actual);
9031 end Instantiate_Object;
9033 ------------------------------
9034 -- Instantiate_Package_Body --
9035 ------------------------------
9037 procedure Instantiate_Package_Body
9038 (Body_Info : Pending_Body_Info;
9039 Inlined_Body : Boolean := False;
9040 Body_Optional : Boolean := False)
9042 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
9043 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
9044 Loc : constant Source_Ptr := Sloc (Inst_Node);
9046 Gen_Id : constant Node_Id := Name (Inst_Node);
9047 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
9048 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
9049 Act_Spec : constant Node_Id := Specification (Act_Decl);
9050 Act_Decl_Id : constant Entity_Id := Defining_Entity (Act_Spec);
9052 Act_Body_Name : Node_Id;
9054 Gen_Body_Id : Node_Id;
9056 Act_Body_Id : Entity_Id;
9058 Parent_Installed : Boolean := False;
9059 Save_Style_Check : constant Boolean := Style_Check;
9061 Par_Ent : Entity_Id := Empty;
9062 Par_Vis : Boolean := False;
9065 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9067 -- The instance body may already have been processed, as the parent of
9068 -- another instance that is inlined (Load_Parent_Of_Generic).
9070 if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
9074 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
9076 -- Re-establish the state of information on which checks are suppressed.
9077 -- This information was set in Body_Info at the point of instantiation,
9078 -- and now we restore it so that the instance is compiled using the
9079 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
9081 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
9082 Scope_Suppress := Body_Info.Scope_Suppress;
9083 Opt.Ada_Version := Body_Info.Version;
9085 if No (Gen_Body_Id) then
9086 Load_Parent_Of_Generic
9087 (Inst_Node, Specification (Gen_Decl), Body_Optional);
9088 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9091 -- Establish global variable for sloc adjustment and for error recovery
9093 Instantiation_Node := Inst_Node;
9095 if Present (Gen_Body_Id) then
9096 Save_Env (Gen_Unit, Act_Decl_Id);
9097 Style_Check := False;
9098 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
9100 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
9102 Create_Instantiation_Source
9103 (Inst_Node, Gen_Body_Id, False, S_Adjustment);
9107 (Original_Node (Gen_Body), Empty, Instantiating => True);
9109 -- Build new name (possibly qualified) for body declaration
9111 Act_Body_Id := New_Copy (Act_Decl_Id);
9113 -- Some attributes of spec entity are not inherited by body entity
9115 Set_Handler_Records (Act_Body_Id, No_List);
9117 if Nkind (Defining_Unit_Name (Act_Spec)) =
9118 N_Defining_Program_Unit_Name
9121 Make_Defining_Program_Unit_Name (Loc,
9122 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
9123 Defining_Identifier => Act_Body_Id);
9125 Act_Body_Name := Act_Body_Id;
9128 Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
9130 Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
9131 Check_Generic_Actuals (Act_Decl_Id, False);
9133 -- If it is a child unit, make the parent instance (which is an
9134 -- instance of the parent of the generic) visible. The parent
9135 -- instance is the prefix of the name of the generic unit.
9137 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
9138 and then Nkind (Gen_Id) = N_Expanded_Name
9140 Par_Ent := Entity (Prefix (Gen_Id));
9141 Par_Vis := Is_Immediately_Visible (Par_Ent);
9142 Install_Parent (Par_Ent, In_Body => True);
9143 Parent_Installed := True;
9145 elsif Is_Child_Unit (Gen_Unit) then
9146 Par_Ent := Scope (Gen_Unit);
9147 Par_Vis := Is_Immediately_Visible (Par_Ent);
9148 Install_Parent (Par_Ent, In_Body => True);
9149 Parent_Installed := True;
9152 -- If the instantiation is a library unit, and this is the main unit,
9153 -- then build the resulting compilation unit nodes for the instance.
9154 -- If this is a compilation unit but it is not the main unit, then it
9155 -- is the body of a unit in the context, that is being compiled
9156 -- because it is encloses some inlined unit or another generic unit
9157 -- being instantiated. In that case, this body is not part of the
9158 -- current compilation, and is not attached to the tree, but its
9159 -- parent must be set for analysis.
9161 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
9163 -- Replace instance node with body of instance, and create new
9164 -- node for corresponding instance declaration.
9166 Build_Instance_Compilation_Unit_Nodes
9167 (Inst_Node, Act_Body, Act_Decl);
9168 Analyze (Inst_Node);
9170 if Parent (Inst_Node) = Cunit (Main_Unit) then
9172 -- If the instance is a child unit itself, then set the scope
9173 -- of the expanded body to be the parent of the instantiation
9174 -- (ensuring that the fully qualified name will be generated
9175 -- for the elaboration subprogram).
9177 if Nkind (Defining_Unit_Name (Act_Spec)) =
9178 N_Defining_Program_Unit_Name
9181 (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
9185 -- Case where instantiation is not a library unit
9188 -- If this is an early instantiation, i.e. appears textually
9189 -- before the corresponding body and must be elaborated first,
9190 -- indicate that the body instance is to be delayed.
9192 Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
9194 -- Now analyze the body. We turn off all checks if this is an
9195 -- internal unit, since there is no reason to have checks on for
9196 -- any predefined run-time library code. All such code is designed
9197 -- to be compiled with checks off.
9199 -- Note that we do NOT apply this criterion to children of GNAT
9200 -- (or on VMS, children of DEC). The latter units must suppress
9201 -- checks explicitly if this is needed.
9203 if Is_Predefined_File_Name
9204 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
9206 Analyze (Act_Body, Suppress => All_Checks);
9212 Inherit_Context (Gen_Body, Inst_Node);
9214 -- Remove the parent instances if they have been placed on the scope
9215 -- stack to compile the body.
9217 if Parent_Installed then
9218 Remove_Parent (In_Body => True);
9220 -- Restore the previous visibility of the parent
9222 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
9225 Restore_Private_Views (Act_Decl_Id);
9227 -- Remove the current unit from visibility if this is an instance
9228 -- that is not elaborated on the fly for inlining purposes.
9230 if not Inlined_Body then
9231 Set_Is_Immediately_Visible (Act_Decl_Id, False);
9235 Style_Check := Save_Style_Check;
9237 -- If we have no body, and the unit requires a body, then complain. This
9238 -- complaint is suppressed if we have detected other errors (since a
9239 -- common reason for missing the body is that it had errors).
9240 -- In CodePeer mode, a warning has been emitted already, no need for
9241 -- further messages.
9243 elsif Unit_Requires_Body (Gen_Unit)
9244 and then not Body_Optional
9246 if CodePeer_Mode then
9249 elsif Serious_Errors_Detected = 0 then
9251 ("cannot find body of generic package &", Inst_Node, Gen_Unit);
9253 -- Don't attempt to perform any cleanup actions if some other error
9254 -- was already detected, since this can cause blowups.
9260 -- Case of package that does not need a body
9263 -- If the instantiation of the declaration is a library unit, rewrite
9264 -- the original package instantiation as a package declaration in the
9265 -- compilation unit node.
9267 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
9268 Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
9269 Rewrite (Inst_Node, Act_Decl);
9271 -- Generate elaboration entity, in case spec has elaboration code.
9272 -- This cannot be done when the instance is analyzed, because it
9273 -- is not known yet whether the body exists.
9275 Set_Elaboration_Entity_Required (Act_Decl_Id, False);
9276 Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
9278 -- If the instantiation is not a library unit, then append the
9279 -- declaration to the list of implicitly generated entities, unless
9280 -- it is already a list member which means that it was already
9283 elsif not Is_List_Member (Act_Decl) then
9284 Mark_Rewrite_Insertion (Act_Decl);
9285 Insert_Before (Inst_Node, Act_Decl);
9289 Expander_Mode_Restore;
9290 end Instantiate_Package_Body;
9292 ---------------------------------
9293 -- Instantiate_Subprogram_Body --
9294 ---------------------------------
9296 procedure Instantiate_Subprogram_Body
9297 (Body_Info : Pending_Body_Info;
9298 Body_Optional : Boolean := False)
9300 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
9301 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
9302 Loc : constant Source_Ptr := Sloc (Inst_Node);
9303 Gen_Id : constant Node_Id := Name (Inst_Node);
9304 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
9305 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
9306 Anon_Id : constant Entity_Id :=
9307 Defining_Unit_Name (Specification (Act_Decl));
9308 Pack_Id : constant Entity_Id :=
9309 Defining_Unit_Name (Parent (Act_Decl));
9312 Gen_Body_Id : Node_Id;
9314 Pack_Body : Node_Id;
9315 Prev_Formal : Entity_Id;
9317 Unit_Renaming : Node_Id;
9319 Parent_Installed : Boolean := False;
9320 Save_Style_Check : constant Boolean := Style_Check;
9322 Par_Ent : Entity_Id := Empty;
9323 Par_Vis : Boolean := False;
9326 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9328 -- Subprogram body may have been created already because of an inline
9329 -- pragma, or because of multiple elaborations of the enclosing package
9330 -- when several instances of the subprogram appear in the main unit.
9332 if Present (Corresponding_Body (Act_Decl)) then
9336 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
9338 -- Re-establish the state of information on which checks are suppressed.
9339 -- This information was set in Body_Info at the point of instantiation,
9340 -- and now we restore it so that the instance is compiled using the
9341 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
9343 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
9344 Scope_Suppress := Body_Info.Scope_Suppress;
9345 Opt.Ada_Version := Body_Info.Version;
9347 if No (Gen_Body_Id) then
9349 -- For imported generic subprogram, no body to compile, complete
9350 -- the spec entity appropriately.
9352 if Is_Imported (Gen_Unit) then
9353 Set_Is_Imported (Anon_Id);
9354 Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
9355 Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
9356 Set_Convention (Anon_Id, Convention (Gen_Unit));
9357 Set_Has_Completion (Anon_Id);
9360 -- For other cases, compile the body
9363 Load_Parent_Of_Generic
9364 (Inst_Node, Specification (Gen_Decl), Body_Optional);
9365 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9369 Instantiation_Node := Inst_Node;
9371 if Present (Gen_Body_Id) then
9372 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
9374 if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
9376 -- Either body is not present, or context is non-expanding, as
9377 -- when compiling a subunit. Mark the instance as completed, and
9378 -- diagnose a missing body when needed.
9381 and then Operating_Mode = Generate_Code
9384 ("missing proper body for instantiation", Gen_Body);
9387 Set_Has_Completion (Anon_Id);
9391 Save_Env (Gen_Unit, Anon_Id);
9392 Style_Check := False;
9393 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
9394 Create_Instantiation_Source
9402 (Original_Node (Gen_Body), Empty, Instantiating => True);
9404 -- Create proper defining name for the body, to correspond to
9405 -- the one in the spec.
9407 Set_Defining_Unit_Name (Specification (Act_Body),
9408 Make_Defining_Identifier
9409 (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
9410 Set_Corresponding_Spec (Act_Body, Anon_Id);
9411 Set_Has_Completion (Anon_Id);
9412 Check_Generic_Actuals (Pack_Id, False);
9414 -- Generate a reference to link the visible subprogram instance to
9415 -- the generic body, which for navigation purposes is the only
9416 -- available source for the instance.
9419 (Related_Instance (Pack_Id),
9420 Gen_Body_Id, 'b', Set_Ref => False, Force => True);
9422 -- If it is a child unit, make the parent instance (which is an
9423 -- instance of the parent of the generic) visible. The parent
9424 -- instance is the prefix of the name of the generic unit.
9426 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
9427 and then Nkind (Gen_Id) = N_Expanded_Name
9429 Par_Ent := Entity (Prefix (Gen_Id));
9430 Par_Vis := Is_Immediately_Visible (Par_Ent);
9431 Install_Parent (Par_Ent, In_Body => True);
9432 Parent_Installed := True;
9434 elsif Is_Child_Unit (Gen_Unit) then
9435 Par_Ent := Scope (Gen_Unit);
9436 Par_Vis := Is_Immediately_Visible (Par_Ent);
9437 Install_Parent (Par_Ent, In_Body => True);
9438 Parent_Installed := True;
9441 -- Inside its body, a reference to the generic unit is a reference
9442 -- to the instance. The corresponding renaming is the first
9443 -- declaration in the body.
9446 Make_Subprogram_Renaming_Declaration (Loc,
9449 Specification (Original_Node (Gen_Body)),
9451 Instantiating => True),
9452 Name => New_Occurrence_Of (Anon_Id, Loc));
9454 -- If there is a formal subprogram with the same name as the unit
9455 -- itself, do not add this renaming declaration. This is a temporary
9456 -- fix for one ACVC test. ???
9458 Prev_Formal := First_Entity (Pack_Id);
9459 while Present (Prev_Formal) loop
9460 if Chars (Prev_Formal) = Chars (Gen_Unit)
9461 and then Is_Overloadable (Prev_Formal)
9466 Next_Entity (Prev_Formal);
9469 if Present (Prev_Formal) then
9470 Decls := New_List (Act_Body);
9472 Decls := New_List (Unit_Renaming, Act_Body);
9475 -- The subprogram body is placed in the body of a dummy package body,
9476 -- whose spec contains the subprogram declaration as well as the
9477 -- renaming declarations for the generic parameters.
9479 Pack_Body := Make_Package_Body (Loc,
9480 Defining_Unit_Name => New_Copy (Pack_Id),
9481 Declarations => Decls);
9483 Set_Corresponding_Spec (Pack_Body, Pack_Id);
9485 -- If the instantiation is a library unit, then build resulting
9486 -- compilation unit nodes for the instance. The declaration of
9487 -- the enclosing package is the grandparent of the subprogram
9488 -- declaration. First replace the instantiation node as the unit
9489 -- of the corresponding compilation.
9491 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
9492 if Parent (Inst_Node) = Cunit (Main_Unit) then
9493 Set_Unit (Parent (Inst_Node), Inst_Node);
9494 Build_Instance_Compilation_Unit_Nodes
9495 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
9496 Analyze (Inst_Node);
9498 Set_Parent (Pack_Body, Parent (Inst_Node));
9499 Analyze (Pack_Body);
9503 Insert_Before (Inst_Node, Pack_Body);
9504 Mark_Rewrite_Insertion (Pack_Body);
9505 Analyze (Pack_Body);
9507 if Expander_Active then
9508 Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
9512 Inherit_Context (Gen_Body, Inst_Node);
9514 Restore_Private_Views (Pack_Id, False);
9516 if Parent_Installed then
9517 Remove_Parent (In_Body => True);
9519 -- Restore the previous visibility of the parent
9521 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
9525 Style_Check := Save_Style_Check;
9527 -- Body not found. Error was emitted already. If there were no previous
9528 -- errors, this may be an instance whose scope is a premature instance.
9529 -- In that case we must insure that the (legal) program does raise
9530 -- program error if executed. We generate a subprogram body for this
9531 -- purpose. See DEC ac30vso.
9533 -- Should not reference proprietary DEC tests in comments ???
9535 elsif Serious_Errors_Detected = 0
9536 and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
9538 if Body_Optional then
9541 elsif Ekind (Anon_Id) = E_Procedure then
9543 Make_Subprogram_Body (Loc,
9545 Make_Procedure_Specification (Loc,
9546 Defining_Unit_Name =>
9547 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
9548 Parameter_Specifications =>
9550 (Parameter_Specifications (Parent (Anon_Id)))),
9552 Declarations => Empty_List,
9553 Handled_Statement_Sequence =>
9554 Make_Handled_Sequence_Of_Statements (Loc,
9557 Make_Raise_Program_Error (Loc,
9559 PE_Access_Before_Elaboration))));
9563 Make_Raise_Program_Error (Loc,
9564 Reason => PE_Access_Before_Elaboration);
9566 Set_Etype (Ret_Expr, (Etype (Anon_Id)));
9567 Set_Analyzed (Ret_Expr);
9570 Make_Subprogram_Body (Loc,
9572 Make_Function_Specification (Loc,
9573 Defining_Unit_Name =>
9574 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
9575 Parameter_Specifications =>
9577 (Parameter_Specifications (Parent (Anon_Id))),
9578 Result_Definition =>
9579 New_Occurrence_Of (Etype (Anon_Id), Loc)),
9581 Declarations => Empty_List,
9582 Handled_Statement_Sequence =>
9583 Make_Handled_Sequence_Of_Statements (Loc,
9586 (Make_Simple_Return_Statement (Loc, Ret_Expr))));
9589 Pack_Body := Make_Package_Body (Loc,
9590 Defining_Unit_Name => New_Copy (Pack_Id),
9591 Declarations => New_List (Act_Body));
9593 Insert_After (Inst_Node, Pack_Body);
9594 Set_Corresponding_Spec (Pack_Body, Pack_Id);
9595 Analyze (Pack_Body);
9598 Expander_Mode_Restore;
9599 end Instantiate_Subprogram_Body;
9601 ----------------------
9602 -- Instantiate_Type --
9603 ----------------------
9605 function Instantiate_Type
9608 Analyzed_Formal : Node_Id;
9609 Actual_Decls : List_Id) return List_Id
9611 Gen_T : constant Entity_Id := Defining_Identifier (Formal);
9612 A_Gen_T : constant Entity_Id :=
9613 Defining_Identifier (Analyzed_Formal);
9614 Ancestor : Entity_Id := Empty;
9615 Def : constant Node_Id := Formal_Type_Definition (Formal);
9617 Decl_Node : Node_Id;
9618 Decl_Nodes : List_Id;
9622 procedure Validate_Array_Type_Instance;
9623 procedure Validate_Access_Subprogram_Instance;
9624 procedure Validate_Access_Type_Instance;
9625 procedure Validate_Derived_Type_Instance;
9626 procedure Validate_Derived_Interface_Type_Instance;
9627 procedure Validate_Discriminated_Formal_Type;
9628 procedure Validate_Interface_Type_Instance;
9629 procedure Validate_Private_Type_Instance;
9630 procedure Validate_Incomplete_Type_Instance;
9631 -- These procedures perform validation tests for the named case.
9632 -- Validate_Discriminated_Formal_Type is shared by formal private
9633 -- types and Ada 2012 formal incomplete types.
9635 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
9636 -- Check that base types are the same and that the subtypes match
9637 -- statically. Used in several of the above.
9639 --------------------
9640 -- Subtypes_Match --
9641 --------------------
9643 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
9644 T : constant Entity_Id := Get_Instance_Of (Gen_T);
9647 return (Base_Type (T) = Base_Type (Act_T)
9648 and then Subtypes_Statically_Match (T, Act_T))
9650 or else (Is_Class_Wide_Type (Gen_T)
9651 and then Is_Class_Wide_Type (Act_T)
9654 (Get_Instance_Of (Root_Type (Gen_T)),
9658 ((Ekind (Gen_T) = E_Anonymous_Access_Subprogram_Type
9659 or else Ekind (Gen_T) = E_Anonymous_Access_Type)
9660 and then Ekind (Act_T) = Ekind (Gen_T)
9662 Subtypes_Statically_Match
9663 (Designated_Type (Gen_T), Designated_Type (Act_T)));
9666 -----------------------------------------
9667 -- Validate_Access_Subprogram_Instance --
9668 -----------------------------------------
9670 procedure Validate_Access_Subprogram_Instance is
9672 if not Is_Access_Type (Act_T)
9673 or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
9676 ("expect access type in instantiation of &", Actual, Gen_T);
9677 Abandon_Instantiation (Actual);
9680 Check_Mode_Conformant
9681 (Designated_Type (Act_T),
9682 Designated_Type (A_Gen_T),
9686 if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
9687 if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
9689 ("protected access type not allowed for formal &",
9693 elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
9695 ("expect protected access type for formal &",
9698 end Validate_Access_Subprogram_Instance;
9700 -----------------------------------
9701 -- Validate_Access_Type_Instance --
9702 -----------------------------------
9704 procedure Validate_Access_Type_Instance is
9705 Desig_Type : constant Entity_Id :=
9706 Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
9707 Desig_Act : Entity_Id;
9710 if not Is_Access_Type (Act_T) then
9712 ("expect access type in instantiation of &", Actual, Gen_T);
9713 Abandon_Instantiation (Actual);
9716 if Is_Access_Constant (A_Gen_T) then
9717 if not Is_Access_Constant (Act_T) then
9719 ("actual type must be access-to-constant type", Actual);
9720 Abandon_Instantiation (Actual);
9723 if Is_Access_Constant (Act_T) then
9725 ("actual type must be access-to-variable type", Actual);
9726 Abandon_Instantiation (Actual);
9728 elsif Ekind (A_Gen_T) = E_General_Access_Type
9729 and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
9731 Error_Msg_N -- CODEFIX
9732 ("actual must be general access type!", Actual);
9733 Error_Msg_NE -- CODEFIX
9734 ("add ALL to }!", Actual, Act_T);
9735 Abandon_Instantiation (Actual);
9739 -- The designated subtypes, that is to say the subtypes introduced
9740 -- by an access type declaration (and not by a subtype declaration)
9743 Desig_Act := Designated_Type (Base_Type (Act_T));
9745 -- The designated type may have been introduced through a limited_
9746 -- with clause, in which case retrieve the non-limited view. This
9747 -- applies to incomplete types as well as to class-wide types.
9749 if From_With_Type (Desig_Act) then
9750 Desig_Act := Available_View (Desig_Act);
9753 if not Subtypes_Match
9754 (Desig_Type, Desig_Act) then
9756 ("designated type of actual does not match that of formal &",
9758 Abandon_Instantiation (Actual);
9760 elsif Is_Access_Type (Designated_Type (Act_T))
9761 and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
9763 Is_Constrained (Designated_Type (Desig_Type))
9766 ("designated type of actual does not match that of formal &",
9768 Abandon_Instantiation (Actual);
9771 -- Ada 2005: null-exclusion indicators of the two types must agree
9773 if Can_Never_Be_Null (A_Gen_T) /= Can_Never_Be_Null (Act_T) then
9775 ("non null exclusion of actual and formal & do not match",
9778 end Validate_Access_Type_Instance;
9780 ----------------------------------
9781 -- Validate_Array_Type_Instance --
9782 ----------------------------------
9784 procedure Validate_Array_Type_Instance is
9789 function Formal_Dimensions return Int;
9790 -- Count number of dimensions in array type formal
9792 -----------------------
9793 -- Formal_Dimensions --
9794 -----------------------
9796 function Formal_Dimensions return Int is
9801 if Nkind (Def) = N_Constrained_Array_Definition then
9802 Index := First (Discrete_Subtype_Definitions (Def));
9804 Index := First (Subtype_Marks (Def));
9807 while Present (Index) loop
9813 end Formal_Dimensions;
9815 -- Start of processing for Validate_Array_Type_Instance
9818 if not Is_Array_Type (Act_T) then
9820 ("expect array type in instantiation of &", Actual, Gen_T);
9821 Abandon_Instantiation (Actual);
9823 elsif Nkind (Def) = N_Constrained_Array_Definition then
9824 if not (Is_Constrained (Act_T)) then
9826 ("expect constrained array in instantiation of &",
9828 Abandon_Instantiation (Actual);
9832 if Is_Constrained (Act_T) then
9834 ("expect unconstrained array in instantiation of &",
9836 Abandon_Instantiation (Actual);
9840 if Formal_Dimensions /= Number_Dimensions (Act_T) then
9842 ("dimensions of actual do not match formal &", Actual, Gen_T);
9843 Abandon_Instantiation (Actual);
9846 I1 := First_Index (A_Gen_T);
9847 I2 := First_Index (Act_T);
9848 for J in 1 .. Formal_Dimensions loop
9850 -- If the indexes of the actual were given by a subtype_mark,
9851 -- the index was transformed into a range attribute. Retrieve
9852 -- the original type mark for checking.
9854 if Is_Entity_Name (Original_Node (I2)) then
9855 T2 := Entity (Original_Node (I2));
9860 if not Subtypes_Match
9861 (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
9864 ("index types of actual do not match those of formal &",
9866 Abandon_Instantiation (Actual);
9873 -- Check matching subtypes. Note that there are complex visibility
9874 -- issues when the generic is a child unit and some aspect of the
9875 -- generic type is declared in a parent unit of the generic. We do
9876 -- the test to handle this special case only after a direct check
9877 -- for static matching has failed.
9880 (Component_Type (A_Gen_T), Component_Type (Act_T))
9881 or else Subtypes_Match
9882 (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
9883 Component_Type (Act_T))
9888 ("component subtype of actual does not match that of formal &",
9890 Abandon_Instantiation (Actual);
9893 if Has_Aliased_Components (A_Gen_T)
9894 and then not Has_Aliased_Components (Act_T)
9897 ("actual must have aliased components to match formal type &",
9900 end Validate_Array_Type_Instance;
9902 -----------------------------------------------
9903 -- Validate_Derived_Interface_Type_Instance --
9904 -----------------------------------------------
9906 procedure Validate_Derived_Interface_Type_Instance is
9907 Par : constant Entity_Id := Entity (Subtype_Indication (Def));
9911 -- First apply interface instance checks
9913 Validate_Interface_Type_Instance;
9915 -- Verify that immediate parent interface is an ancestor of
9919 and then not Interface_Present_In_Ancestor (Act_T, Par)
9922 ("interface actual must include progenitor&", Actual, Par);
9925 -- Now verify that the actual includes all other ancestors of
9928 Elmt := First_Elmt (Interfaces (A_Gen_T));
9929 while Present (Elmt) loop
9930 if not Interface_Present_In_Ancestor
9931 (Act_T, Get_Instance_Of (Node (Elmt)))
9934 ("interface actual must include progenitor&",
9935 Actual, Node (Elmt));
9940 end Validate_Derived_Interface_Type_Instance;
9942 ------------------------------------
9943 -- Validate_Derived_Type_Instance --
9944 ------------------------------------
9946 procedure Validate_Derived_Type_Instance is
9947 Actual_Discr : Entity_Id;
9948 Ancestor_Discr : Entity_Id;
9951 -- If the parent type in the generic declaration is itself a previous
9952 -- formal type, then it is local to the generic and absent from the
9953 -- analyzed generic definition. In that case the ancestor is the
9954 -- instance of the formal (which must have been instantiated
9955 -- previously), unless the ancestor is itself a formal derived type.
9956 -- In this latter case (which is the subject of Corrigendum 8652/0038
9957 -- (AI-202) the ancestor of the formals is the ancestor of its
9958 -- parent. Otherwise, the analyzed generic carries the parent type.
9959 -- If the parent type is defined in a previous formal package, then
9960 -- the scope of that formal package is that of the generic type
9961 -- itself, and it has already been mapped into the corresponding type
9962 -- in the actual package.
9964 -- Common case: parent type defined outside of the generic
9966 if Is_Entity_Name (Subtype_Mark (Def))
9967 and then Present (Entity (Subtype_Mark (Def)))
9969 Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
9971 -- Check whether parent is defined in a previous formal package
9974 Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
9977 Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
9979 -- The type may be a local derivation, or a type extension of a
9980 -- previous formal, or of a formal of a parent package.
9982 elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
9984 Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
9986 -- Check whether the parent is another derived formal type in the
9987 -- same generic unit.
9989 if Etype (A_Gen_T) /= A_Gen_T
9990 and then Is_Generic_Type (Etype (A_Gen_T))
9991 and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
9992 and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
9994 -- Locate ancestor of parent from the subtype declaration
9995 -- created for the actual.
10001 Decl := First (Actual_Decls);
10002 while Present (Decl) loop
10003 if Nkind (Decl) = N_Subtype_Declaration
10004 and then Chars (Defining_Identifier (Decl)) =
10005 Chars (Etype (A_Gen_T))
10007 Ancestor := Generic_Parent_Type (Decl);
10015 pragma Assert (Present (Ancestor));
10019 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
10023 Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
10026 -- If the formal derived type has pragma Preelaborable_Initialization
10027 -- then the actual type must have preelaborable initialization.
10029 if Known_To_Have_Preelab_Init (A_Gen_T)
10030 and then not Has_Preelaborable_Initialization (Act_T)
10033 ("actual for & must have preelaborable initialization",
10037 -- Ada 2005 (AI-251)
10039 if Ada_Version >= Ada_2005
10040 and then Is_Interface (Ancestor)
10042 if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
10044 ("(Ada 2005) expected type implementing & in instantiation",
10048 elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
10050 ("expect type derived from & in instantiation",
10051 Actual, First_Subtype (Ancestor));
10052 Abandon_Instantiation (Actual);
10055 -- Ada 2005 (AI-443): Synchronized formal derived type checks. Note
10056 -- that the formal type declaration has been rewritten as a private
10059 if Ada_Version >= Ada_2005
10060 and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
10061 and then Synchronized_Present (Parent (A_Gen_T))
10063 -- The actual must be a synchronized tagged type
10065 if not Is_Tagged_Type (Act_T) then
10067 ("actual of synchronized type must be tagged", Actual);
10068 Abandon_Instantiation (Actual);
10070 elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
10071 and then Nkind (Type_Definition (Parent (Act_T))) =
10072 N_Derived_Type_Definition
10073 and then not Synchronized_Present (Type_Definition
10077 ("actual of synchronized type must be synchronized", Actual);
10078 Abandon_Instantiation (Actual);
10082 -- Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
10083 -- removes the second instance of the phrase "or allow pass by copy".
10085 if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
10087 ("cannot have atomic actual type for non-atomic formal type",
10090 elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
10092 ("cannot have volatile actual type for non-volatile formal type",
10096 -- It should not be necessary to check for unknown discriminants on
10097 -- Formal, but for some reason Has_Unknown_Discriminants is false for
10098 -- A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
10099 -- needs fixing. ???
10101 if not Is_Indefinite_Subtype (A_Gen_T)
10102 and then not Unknown_Discriminants_Present (Formal)
10103 and then Is_Indefinite_Subtype (Act_T)
10106 ("actual subtype must be constrained", Actual);
10107 Abandon_Instantiation (Actual);
10110 if not Unknown_Discriminants_Present (Formal) then
10111 if Is_Constrained (Ancestor) then
10112 if not Is_Constrained (Act_T) then
10114 ("actual subtype must be constrained", Actual);
10115 Abandon_Instantiation (Actual);
10118 -- Ancestor is unconstrained, Check if generic formal and actual
10119 -- agree on constrainedness. The check only applies to array types
10120 -- and discriminated types.
10122 elsif Is_Constrained (Act_T) then
10123 if Ekind (Ancestor) = E_Access_Type
10125 (not Is_Constrained (A_Gen_T)
10126 and then Is_Composite_Type (A_Gen_T))
10129 ("actual subtype must be unconstrained", Actual);
10130 Abandon_Instantiation (Actual);
10133 -- A class-wide type is only allowed if the formal has unknown
10136 elsif Is_Class_Wide_Type (Act_T)
10137 and then not Has_Unknown_Discriminants (Ancestor)
10140 ("actual for & cannot be a class-wide type", Actual, Gen_T);
10141 Abandon_Instantiation (Actual);
10143 -- Otherwise, the formal and actual shall have the same number
10144 -- of discriminants and each discriminant of the actual must
10145 -- correspond to a discriminant of the formal.
10147 elsif Has_Discriminants (Act_T)
10148 and then not Has_Unknown_Discriminants (Act_T)
10149 and then Has_Discriminants (Ancestor)
10151 Actual_Discr := First_Discriminant (Act_T);
10152 Ancestor_Discr := First_Discriminant (Ancestor);
10153 while Present (Actual_Discr)
10154 and then Present (Ancestor_Discr)
10156 if Base_Type (Act_T) /= Base_Type (Ancestor) and then
10157 No (Corresponding_Discriminant (Actual_Discr))
10160 ("discriminant & does not correspond " &
10161 "to ancestor discriminant", Actual, Actual_Discr);
10162 Abandon_Instantiation (Actual);
10165 Next_Discriminant (Actual_Discr);
10166 Next_Discriminant (Ancestor_Discr);
10169 if Present (Actual_Discr) or else Present (Ancestor_Discr) then
10171 ("actual for & must have same number of discriminants",
10173 Abandon_Instantiation (Actual);
10176 -- This case should be caught by the earlier check for
10177 -- constrainedness, but the check here is added for completeness.
10179 elsif Has_Discriminants (Act_T)
10180 and then not Has_Unknown_Discriminants (Act_T)
10183 ("actual for & must not have discriminants", Actual, Gen_T);
10184 Abandon_Instantiation (Actual);
10186 elsif Has_Discriminants (Ancestor) then
10188 ("actual for & must have known discriminants", Actual, Gen_T);
10189 Abandon_Instantiation (Actual);
10192 if not Subtypes_Statically_Compatible (Act_T, Ancestor) then
10194 ("constraint on actual is incompatible with formal", Actual);
10195 Abandon_Instantiation (Actual);
10199 -- If the formal and actual types are abstract, check that there
10200 -- are no abstract primitives of the actual type that correspond to
10201 -- nonabstract primitives of the formal type (second sentence of
10204 if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
10205 Check_Abstract_Primitives : declare
10206 Gen_Prims : constant Elist_Id :=
10207 Primitive_Operations (A_Gen_T);
10208 Gen_Elmt : Elmt_Id;
10209 Gen_Subp : Entity_Id;
10210 Anc_Subp : Entity_Id;
10211 Anc_Formal : Entity_Id;
10212 Anc_F_Type : Entity_Id;
10214 Act_Prims : constant Elist_Id := Primitive_Operations (Act_T);
10215 Act_Elmt : Elmt_Id;
10216 Act_Subp : Entity_Id;
10217 Act_Formal : Entity_Id;
10218 Act_F_Type : Entity_Id;
10220 Subprograms_Correspond : Boolean;
10222 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
10223 -- Returns true if T2 is derived directly or indirectly from
10224 -- T1, including derivations from interfaces. T1 and T2 are
10225 -- required to be specific tagged base types.
10227 ------------------------
10228 -- Is_Tagged_Ancestor --
10229 ------------------------
10231 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
10233 Intfc_Elmt : Elmt_Id;
10236 -- The predicate is satisfied if the types are the same
10241 -- If we've reached the top of the derivation chain then
10242 -- we know that T1 is not an ancestor of T2.
10244 elsif Etype (T2) = T2 then
10247 -- Proceed to check T2's immediate parent
10249 elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
10252 -- Finally, check to see if T1 is an ancestor of any of T2's
10256 Intfc_Elmt := First_Elmt (Interfaces (T2));
10257 while Present (Intfc_Elmt) loop
10258 if Is_Ancestor (T1, Node (Intfc_Elmt)) then
10262 Next_Elmt (Intfc_Elmt);
10267 end Is_Tagged_Ancestor;
10269 -- Start of processing for Check_Abstract_Primitives
10272 -- Loop over all of the formal derived type's primitives
10274 Gen_Elmt := First_Elmt (Gen_Prims);
10275 while Present (Gen_Elmt) loop
10276 Gen_Subp := Node (Gen_Elmt);
10278 -- If the primitive of the formal is not abstract, then
10279 -- determine whether there is a corresponding primitive of
10280 -- the actual type that's abstract.
10282 if not Is_Abstract_Subprogram (Gen_Subp) then
10283 Act_Elmt := First_Elmt (Act_Prims);
10284 while Present (Act_Elmt) loop
10285 Act_Subp := Node (Act_Elmt);
10287 -- If we find an abstract primitive of the actual,
10288 -- then we need to test whether it corresponds to the
10289 -- subprogram from which the generic formal primitive
10292 if Is_Abstract_Subprogram (Act_Subp) then
10293 Anc_Subp := Alias (Gen_Subp);
10295 -- Test whether we have a corresponding primitive
10296 -- by comparing names, kinds, formal types, and
10299 if Chars (Anc_Subp) = Chars (Act_Subp)
10300 and then Ekind (Anc_Subp) = Ekind (Act_Subp)
10302 Anc_Formal := First_Formal (Anc_Subp);
10303 Act_Formal := First_Formal (Act_Subp);
10304 while Present (Anc_Formal)
10305 and then Present (Act_Formal)
10307 Anc_F_Type := Etype (Anc_Formal);
10308 Act_F_Type := Etype (Act_Formal);
10310 if Ekind (Anc_F_Type)
10311 = E_Anonymous_Access_Type
10313 Anc_F_Type := Designated_Type (Anc_F_Type);
10315 if Ekind (Act_F_Type)
10316 = E_Anonymous_Access_Type
10319 Designated_Type (Act_F_Type);
10325 Ekind (Act_F_Type) = E_Anonymous_Access_Type
10330 Anc_F_Type := Base_Type (Anc_F_Type);
10331 Act_F_Type := Base_Type (Act_F_Type);
10333 -- If the formal is controlling, then the
10334 -- the type of the actual primitive's formal
10335 -- must be derived directly or indirectly
10336 -- from the type of the ancestor primitive's
10339 if Is_Controlling_Formal (Anc_Formal) then
10340 if not Is_Tagged_Ancestor
10341 (Anc_F_Type, Act_F_Type)
10346 -- Otherwise the types of the formals must
10349 elsif Anc_F_Type /= Act_F_Type then
10353 Next_Entity (Anc_Formal);
10354 Next_Entity (Act_Formal);
10357 -- If we traversed through all of the formals
10358 -- then so far the subprograms correspond, so
10359 -- now check that any result types correspond.
10361 if No (Anc_Formal) and then No (Act_Formal) then
10362 Subprograms_Correspond := True;
10364 if Ekind (Act_Subp) = E_Function then
10365 Anc_F_Type := Etype (Anc_Subp);
10366 Act_F_Type := Etype (Act_Subp);
10368 if Ekind (Anc_F_Type)
10369 = E_Anonymous_Access_Type
10372 Designated_Type (Anc_F_Type);
10374 if Ekind (Act_F_Type)
10375 = E_Anonymous_Access_Type
10378 Designated_Type (Act_F_Type);
10380 Subprograms_Correspond := False;
10385 = E_Anonymous_Access_Type
10387 Subprograms_Correspond := False;
10390 Anc_F_Type := Base_Type (Anc_F_Type);
10391 Act_F_Type := Base_Type (Act_F_Type);
10393 -- Now either the result types must be
10394 -- the same or, if the result type is
10395 -- controlling, the result type of the
10396 -- actual primitive must descend from the
10397 -- result type of the ancestor primitive.
10399 if Subprograms_Correspond
10400 and then Anc_F_Type /= Act_F_Type
10402 Has_Controlling_Result (Anc_Subp)
10404 not Is_Tagged_Ancestor
10405 (Anc_F_Type, Act_F_Type)
10407 Subprograms_Correspond := False;
10411 -- Found a matching subprogram belonging to
10412 -- formal ancestor type, so actual subprogram
10413 -- corresponds and this violates 3.9.3(9).
10415 if Subprograms_Correspond then
10417 ("abstract subprogram & overrides " &
10418 "nonabstract subprogram of ancestor",
10426 Next_Elmt (Act_Elmt);
10430 Next_Elmt (Gen_Elmt);
10432 end Check_Abstract_Primitives;
10435 -- Verify that limitedness matches. If parent is a limited
10436 -- interface then the generic formal is not unless declared
10437 -- explicitly so. If not declared limited, the actual cannot be
10438 -- limited (see AI05-0087).
10440 -- Even though this AI is a binding interpretation, we enable the
10441 -- check only in Ada 2012 mode, because this improper construct
10442 -- shows up in user code and in existing B-tests.
10444 if Is_Limited_Type (Act_T)
10445 and then not Is_Limited_Type (A_Gen_T)
10446 and then Ada_Version >= Ada_2012
10448 if In_Instance then
10452 ("actual for non-limited & cannot be a limited type", Actual,
10454 Explain_Limited_Type (Act_T, Actual);
10455 Abandon_Instantiation (Actual);
10458 end Validate_Derived_Type_Instance;
10460 ----------------------------------------
10461 -- Validate_Discriminated_Formal_Type --
10462 ----------------------------------------
10464 procedure Validate_Discriminated_Formal_Type is
10465 Formal_Discr : Entity_Id;
10466 Actual_Discr : Entity_Id;
10467 Formal_Subt : Entity_Id;
10470 if Has_Discriminants (A_Gen_T) then
10471 if not Has_Discriminants (Act_T) then
10473 ("actual for & must have discriminants", Actual, Gen_T);
10474 Abandon_Instantiation (Actual);
10476 elsif Is_Constrained (Act_T) then
10478 ("actual for & must be unconstrained", Actual, Gen_T);
10479 Abandon_Instantiation (Actual);
10482 Formal_Discr := First_Discriminant (A_Gen_T);
10483 Actual_Discr := First_Discriminant (Act_T);
10484 while Formal_Discr /= Empty loop
10485 if Actual_Discr = Empty then
10487 ("discriminants on actual do not match formal",
10489 Abandon_Instantiation (Actual);
10492 Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
10494 -- Access discriminants match if designated types do
10496 if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
10497 and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
10498 E_Anonymous_Access_Type
10501 (Designated_Type (Base_Type (Formal_Subt))) =
10502 Designated_Type (Base_Type (Etype (Actual_Discr)))
10506 elsif Base_Type (Formal_Subt) /=
10507 Base_Type (Etype (Actual_Discr))
10510 ("types of actual discriminants must match formal",
10512 Abandon_Instantiation (Actual);
10514 elsif not Subtypes_Statically_Match
10515 (Formal_Subt, Etype (Actual_Discr))
10516 and then Ada_Version >= Ada_95
10519 ("subtypes of actual discriminants must match formal",
10521 Abandon_Instantiation (Actual);
10524 Next_Discriminant (Formal_Discr);
10525 Next_Discriminant (Actual_Discr);
10528 if Actual_Discr /= Empty then
10530 ("discriminants on actual do not match formal",
10532 Abandon_Instantiation (Actual);
10536 end Validate_Discriminated_Formal_Type;
10538 ---------------------------------------
10539 -- Validate_Incomplete_Type_Instance --
10540 ---------------------------------------
10542 procedure Validate_Incomplete_Type_Instance is
10544 if not Is_Tagged_Type (Act_T)
10545 and then Is_Tagged_Type (A_Gen_T)
10548 ("actual for & must be a tagged type", Actual, Gen_T);
10551 Validate_Discriminated_Formal_Type;
10552 end Validate_Incomplete_Type_Instance;
10554 --------------------------------------
10555 -- Validate_Interface_Type_Instance --
10556 --------------------------------------
10558 procedure Validate_Interface_Type_Instance is
10560 if not Is_Interface (Act_T) then
10562 ("actual for formal interface type must be an interface",
10565 elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
10567 Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
10569 Is_Protected_Interface (A_Gen_T) /=
10570 Is_Protected_Interface (Act_T)
10572 Is_Synchronized_Interface (A_Gen_T) /=
10573 Is_Synchronized_Interface (Act_T)
10576 ("actual for interface& does not match (RM 12.5.5(4))",
10579 end Validate_Interface_Type_Instance;
10581 ------------------------------------
10582 -- Validate_Private_Type_Instance --
10583 ------------------------------------
10585 procedure Validate_Private_Type_Instance is
10587 if Is_Limited_Type (Act_T)
10588 and then not Is_Limited_Type (A_Gen_T)
10590 if In_Instance then
10594 ("actual for non-limited & cannot be a limited type", Actual,
10596 Explain_Limited_Type (Act_T, Actual);
10597 Abandon_Instantiation (Actual);
10600 elsif Known_To_Have_Preelab_Init (A_Gen_T)
10601 and then not Has_Preelaborable_Initialization (Act_T)
10604 ("actual for & must have preelaborable initialization", Actual,
10607 elsif Is_Indefinite_Subtype (Act_T)
10608 and then not Is_Indefinite_Subtype (A_Gen_T)
10609 and then Ada_Version >= Ada_95
10612 ("actual for & must be a definite subtype", Actual, Gen_T);
10614 elsif not Is_Tagged_Type (Act_T)
10615 and then Is_Tagged_Type (A_Gen_T)
10618 ("actual for & must be a tagged type", Actual, Gen_T);
10621 Validate_Discriminated_Formal_Type;
10623 end Validate_Private_Type_Instance;
10625 -- Start of processing for Instantiate_Type
10628 if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
10629 Error_Msg_N ("duplicate instantiation of generic type", Actual);
10630 return New_List (Error);
10632 elsif not Is_Entity_Name (Actual)
10633 or else not Is_Type (Entity (Actual))
10636 ("expect valid subtype mark to instantiate &", Actual, Gen_T);
10637 Abandon_Instantiation (Actual);
10640 Act_T := Entity (Actual);
10642 -- Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
10643 -- as a generic actual parameter if the corresponding formal type
10644 -- does not have a known_discriminant_part, or is a formal derived
10645 -- type that is an Unchecked_Union type.
10647 if Is_Unchecked_Union (Base_Type (Act_T)) then
10648 if not Has_Discriminants (A_Gen_T)
10650 (Is_Derived_Type (A_Gen_T)
10652 Is_Unchecked_Union (A_Gen_T))
10656 Error_Msg_N ("Unchecked_Union cannot be the actual for a" &
10657 " discriminated formal type", Act_T);
10662 -- Deal with fixed/floating restrictions
10664 if Is_Floating_Point_Type (Act_T) then
10665 Check_Restriction (No_Floating_Point, Actual);
10666 elsif Is_Fixed_Point_Type (Act_T) then
10667 Check_Restriction (No_Fixed_Point, Actual);
10670 -- Deal with error of using incomplete type as generic actual.
10671 -- This includes limited views of a type, even if the non-limited
10672 -- view may be available.
10674 if Ekind (Act_T) = E_Incomplete_Type
10675 or else (Is_Class_Wide_Type (Act_T)
10677 Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
10679 -- If the formal is an incomplete type, the actual can be
10680 -- incomplete as well.
10682 if Ekind (A_Gen_T) = E_Incomplete_Type then
10685 elsif Is_Class_Wide_Type (Act_T)
10686 or else No (Full_View (Act_T))
10688 Error_Msg_N ("premature use of incomplete type", Actual);
10689 Abandon_Instantiation (Actual);
10691 Act_T := Full_View (Act_T);
10692 Set_Entity (Actual, Act_T);
10694 if Has_Private_Component (Act_T) then
10696 ("premature use of type with private component", Actual);
10700 -- Deal with error of premature use of private type as generic actual
10702 elsif Is_Private_Type (Act_T)
10703 and then Is_Private_Type (Base_Type (Act_T))
10704 and then not Is_Generic_Type (Act_T)
10705 and then not Is_Derived_Type (Act_T)
10706 and then No (Full_View (Root_Type (Act_T)))
10708 -- If the formal is an incomplete type, the actual can be
10709 -- private or incomplete as well.
10711 if Ekind (A_Gen_T) = E_Incomplete_Type then
10714 Error_Msg_N ("premature use of private type", Actual);
10717 elsif Has_Private_Component (Act_T) then
10719 ("premature use of type with private component", Actual);
10722 Set_Instance_Of (A_Gen_T, Act_T);
10724 -- If the type is generic, the class-wide type may also be used
10726 if Is_Tagged_Type (A_Gen_T)
10727 and then Is_Tagged_Type (Act_T)
10728 and then not Is_Class_Wide_Type (A_Gen_T)
10730 Set_Instance_Of (Class_Wide_Type (A_Gen_T),
10731 Class_Wide_Type (Act_T));
10734 if not Is_Abstract_Type (A_Gen_T)
10735 and then Is_Abstract_Type (Act_T)
10738 ("actual of non-abstract formal cannot be abstract", Actual);
10741 -- A generic scalar type is a first subtype for which we generate
10742 -- an anonymous base type. Indicate that the instance of this base
10743 -- is the base type of the actual.
10745 if Is_Scalar_Type (A_Gen_T) then
10746 Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
10750 if Error_Posted (Act_T) then
10753 case Nkind (Def) is
10754 when N_Formal_Private_Type_Definition =>
10755 Validate_Private_Type_Instance;
10757 when N_Formal_Incomplete_Type_Definition =>
10758 Validate_Incomplete_Type_Instance;
10760 when N_Formal_Derived_Type_Definition =>
10761 Validate_Derived_Type_Instance;
10763 when N_Formal_Discrete_Type_Definition =>
10764 if not Is_Discrete_Type (Act_T) then
10766 ("expect discrete type in instantiation of&",
10768 Abandon_Instantiation (Actual);
10771 when N_Formal_Signed_Integer_Type_Definition =>
10772 if not Is_Signed_Integer_Type (Act_T) then
10774 ("expect signed integer type in instantiation of&",
10776 Abandon_Instantiation (Actual);
10779 when N_Formal_Modular_Type_Definition =>
10780 if not Is_Modular_Integer_Type (Act_T) then
10782 ("expect modular type in instantiation of &",
10784 Abandon_Instantiation (Actual);
10787 when N_Formal_Floating_Point_Definition =>
10788 if not Is_Floating_Point_Type (Act_T) then
10790 ("expect float type in instantiation of &", Actual, Gen_T);
10791 Abandon_Instantiation (Actual);
10794 when N_Formal_Ordinary_Fixed_Point_Definition =>
10795 if not Is_Ordinary_Fixed_Point_Type (Act_T) then
10797 ("expect ordinary fixed point type in instantiation of &",
10799 Abandon_Instantiation (Actual);
10802 when N_Formal_Decimal_Fixed_Point_Definition =>
10803 if not Is_Decimal_Fixed_Point_Type (Act_T) then
10805 ("expect decimal type in instantiation of &",
10807 Abandon_Instantiation (Actual);
10810 when N_Array_Type_Definition =>
10811 Validate_Array_Type_Instance;
10813 when N_Access_To_Object_Definition =>
10814 Validate_Access_Type_Instance;
10816 when N_Access_Function_Definition |
10817 N_Access_Procedure_Definition =>
10818 Validate_Access_Subprogram_Instance;
10820 when N_Record_Definition =>
10821 Validate_Interface_Type_Instance;
10823 when N_Derived_Type_Definition =>
10824 Validate_Derived_Interface_Type_Instance;
10827 raise Program_Error;
10832 Subt := New_Copy (Gen_T);
10834 -- Use adjusted sloc of subtype name as the location for other nodes in
10835 -- the subtype declaration.
10837 Loc := Sloc (Subt);
10840 Make_Subtype_Declaration (Loc,
10841 Defining_Identifier => Subt,
10842 Subtype_Indication => New_Reference_To (Act_T, Loc));
10844 if Is_Private_Type (Act_T) then
10845 Set_Has_Private_View (Subtype_Indication (Decl_Node));
10847 elsif Is_Access_Type (Act_T)
10848 and then Is_Private_Type (Designated_Type (Act_T))
10850 Set_Has_Private_View (Subtype_Indication (Decl_Node));
10853 Decl_Nodes := New_List (Decl_Node);
10855 -- Flag actual derived types so their elaboration produces the
10856 -- appropriate renamings for the primitive operations of the ancestor.
10857 -- Flag actual for formal private types as well, to determine whether
10858 -- operations in the private part may override inherited operations.
10859 -- If the formal has an interface list, the ancestor is not the
10860 -- parent, but the analyzed formal that includes the interface
10861 -- operations of all its progenitors.
10863 -- Same treatment for formal private types, so we can check whether the
10864 -- type is tagged limited when validating derivations in the private
10865 -- part. (See AI05-096).
10867 if Nkind (Def) = N_Formal_Derived_Type_Definition then
10868 if Present (Interface_List (Def)) then
10869 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
10871 Set_Generic_Parent_Type (Decl_Node, Ancestor);
10874 elsif Nkind_In (Def,
10875 N_Formal_Private_Type_Definition,
10876 N_Formal_Incomplete_Type_Definition)
10878 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
10881 -- If the actual is a synchronized type that implements an interface,
10882 -- the primitive operations are attached to the corresponding record,
10883 -- and we have to treat it as an additional generic actual, so that its
10884 -- primitive operations become visible in the instance. The task or
10885 -- protected type itself does not carry primitive operations.
10887 if Is_Concurrent_Type (Act_T)
10888 and then Is_Tagged_Type (Act_T)
10889 and then Present (Corresponding_Record_Type (Act_T))
10890 and then Present (Ancestor)
10891 and then Is_Interface (Ancestor)
10894 Corr_Rec : constant Entity_Id :=
10895 Corresponding_Record_Type (Act_T);
10896 New_Corr : Entity_Id;
10897 Corr_Decl : Node_Id;
10900 New_Corr := Make_Temporary (Loc, 'S');
10902 Make_Subtype_Declaration (Loc,
10903 Defining_Identifier => New_Corr,
10904 Subtype_Indication =>
10905 New_Reference_To (Corr_Rec, Loc));
10906 Append_To (Decl_Nodes, Corr_Decl);
10908 if Ekind (Act_T) = E_Task_Type then
10909 Set_Ekind (Subt, E_Task_Subtype);
10911 Set_Ekind (Subt, E_Protected_Subtype);
10914 Set_Corresponding_Record_Type (Subt, Corr_Rec);
10915 Set_Generic_Parent_Type (Corr_Decl, Ancestor);
10916 Set_Generic_Parent_Type (Decl_Node, Empty);
10921 end Instantiate_Type;
10923 ---------------------
10924 -- Is_In_Main_Unit --
10925 ---------------------
10927 function Is_In_Main_Unit (N : Node_Id) return Boolean is
10928 Unum : constant Unit_Number_Type := Get_Source_Unit (N);
10929 Current_Unit : Node_Id;
10932 if Unum = Main_Unit then
10935 -- If the current unit is a subunit then it is either the main unit or
10936 -- is being compiled as part of the main unit.
10938 elsif Nkind (N) = N_Compilation_Unit then
10939 return Nkind (Unit (N)) = N_Subunit;
10942 Current_Unit := Parent (N);
10943 while Present (Current_Unit)
10944 and then Nkind (Current_Unit) /= N_Compilation_Unit
10946 Current_Unit := Parent (Current_Unit);
10949 -- The instantiation node is in the main unit, or else the current node
10950 -- (perhaps as the result of nested instantiations) is in the main unit,
10951 -- or in the declaration of the main unit, which in this last case must
10954 return Unum = Main_Unit
10955 or else Current_Unit = Cunit (Main_Unit)
10956 or else Current_Unit = Library_Unit (Cunit (Main_Unit))
10957 or else (Present (Library_Unit (Current_Unit))
10958 and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
10959 end Is_In_Main_Unit;
10961 ----------------------------
10962 -- Load_Parent_Of_Generic --
10963 ----------------------------
10965 procedure Load_Parent_Of_Generic
10968 Body_Optional : Boolean := False)
10970 Comp_Unit : constant Node_Id := Cunit (Get_Source_Unit (Spec));
10971 Save_Style_Check : constant Boolean := Style_Check;
10972 True_Parent : Node_Id;
10973 Inst_Node : Node_Id;
10975 Previous_Instances : constant Elist_Id := New_Elmt_List;
10977 procedure Collect_Previous_Instances (Decls : List_Id);
10978 -- Collect all instantiations in the given list of declarations, that
10979 -- precede the generic that we need to load. If the bodies of these
10980 -- instantiations are available, we must analyze them, to ensure that
10981 -- the public symbols generated are the same when the unit is compiled
10982 -- to generate code, and when it is compiled in the context of a unit
10983 -- that needs a particular nested instance. This process is applied to
10984 -- both package and subprogram instances.
10986 --------------------------------
10987 -- Collect_Previous_Instances --
10988 --------------------------------
10990 procedure Collect_Previous_Instances (Decls : List_Id) is
10994 Decl := First (Decls);
10995 while Present (Decl) loop
10996 if Sloc (Decl) >= Sloc (Inst_Node) then
10999 -- If Decl is an instantiation, then record it as requiring
11000 -- instantiation of the corresponding body, except if it is an
11001 -- abbreviated instantiation generated internally for conformance
11002 -- checking purposes only for the case of a formal package
11003 -- declared without a box (see Instantiate_Formal_Package). Such
11004 -- an instantiation does not generate any code (the actual code
11005 -- comes from actual) and thus does not need to be analyzed here.
11006 -- If the instantiation appears with a generic package body it is
11007 -- not analyzed here either.
11009 elsif Nkind (Decl) = N_Package_Instantiation
11010 and then not Is_Internal (Defining_Entity (Decl))
11012 Append_Elmt (Decl, Previous_Instances);
11014 -- For a subprogram instantiation, omit instantiations intrinsic
11015 -- operations (Unchecked_Conversions, etc.) that have no bodies.
11017 elsif Nkind_In (Decl, N_Function_Instantiation,
11018 N_Procedure_Instantiation)
11019 and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
11021 Append_Elmt (Decl, Previous_Instances);
11023 elsif Nkind (Decl) = N_Package_Declaration then
11024 Collect_Previous_Instances
11025 (Visible_Declarations (Specification (Decl)));
11026 Collect_Previous_Instances
11027 (Private_Declarations (Specification (Decl)));
11029 -- Previous non-generic bodies may contain instances as well
11031 elsif Nkind (Decl) = N_Package_Body
11032 and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
11034 Collect_Previous_Instances (Declarations (Decl));
11036 elsif Nkind (Decl) = N_Subprogram_Body
11037 and then not Acts_As_Spec (Decl)
11038 and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
11040 Collect_Previous_Instances (Declarations (Decl));
11045 end Collect_Previous_Instances;
11047 -- Start of processing for Load_Parent_Of_Generic
11050 if not In_Same_Source_Unit (N, Spec)
11051 or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
11052 or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
11053 and then not Is_In_Main_Unit (Spec))
11055 -- Find body of parent of spec, and analyze it. A special case arises
11056 -- when the parent is an instantiation, that is to say when we are
11057 -- currently instantiating a nested generic. In that case, there is
11058 -- no separate file for the body of the enclosing instance. Instead,
11059 -- the enclosing body must be instantiated as if it were a pending
11060 -- instantiation, in order to produce the body for the nested generic
11061 -- we require now. Note that in that case the generic may be defined
11062 -- in a package body, the instance defined in the same package body,
11063 -- and the original enclosing body may not be in the main unit.
11065 Inst_Node := Empty;
11067 True_Parent := Parent (Spec);
11068 while Present (True_Parent)
11069 and then Nkind (True_Parent) /= N_Compilation_Unit
11071 if Nkind (True_Parent) = N_Package_Declaration
11073 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
11075 -- Parent is a compilation unit that is an instantiation.
11076 -- Instantiation node has been replaced with package decl.
11078 Inst_Node := Original_Node (True_Parent);
11081 elsif Nkind (True_Parent) = N_Package_Declaration
11082 and then Present (Generic_Parent (Specification (True_Parent)))
11083 and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
11085 -- Parent is an instantiation within another specification.
11086 -- Declaration for instance has been inserted before original
11087 -- instantiation node. A direct link would be preferable?
11089 Inst_Node := Next (True_Parent);
11090 while Present (Inst_Node)
11091 and then Nkind (Inst_Node) /= N_Package_Instantiation
11096 -- If the instance appears within a generic, and the generic
11097 -- unit is defined within a formal package of the enclosing
11098 -- generic, there is no generic body available, and none
11099 -- needed. A more precise test should be used ???
11101 if No (Inst_Node) then
11108 True_Parent := Parent (True_Parent);
11112 -- Case where we are currently instantiating a nested generic
11114 if Present (Inst_Node) then
11115 if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
11117 -- Instantiation node and declaration of instantiated package
11118 -- were exchanged when only the declaration was needed.
11119 -- Restore instantiation node before proceeding with body.
11121 Set_Unit (Parent (True_Parent), Inst_Node);
11124 -- Now complete instantiation of enclosing body, if it appears in
11125 -- some other unit. If it appears in the current unit, the body
11126 -- will have been instantiated already.
11128 if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
11130 -- We need to determine the expander mode to instantiate the
11131 -- enclosing body. Because the generic body we need may use
11132 -- global entities declared in the enclosing package (including
11133 -- aggregates) it is in general necessary to compile this body
11134 -- with expansion enabled, except if we are within a generic
11135 -- package, in which case the usual generic rule applies.
11138 Exp_Status : Boolean := True;
11142 -- Loop through scopes looking for generic package
11144 Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
11145 while Present (Scop)
11146 and then Scop /= Standard_Standard
11148 if Ekind (Scop) = E_Generic_Package then
11149 Exp_Status := False;
11153 Scop := Scope (Scop);
11156 -- Collect previous instantiations in the unit that contains
11157 -- the desired generic.
11159 if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
11160 and then not Body_Optional
11164 Info : Pending_Body_Info;
11168 Par := Parent (Inst_Node);
11169 while Present (Par) loop
11170 exit when Nkind (Parent (Par)) = N_Compilation_Unit;
11171 Par := Parent (Par);
11174 pragma Assert (Present (Par));
11176 if Nkind (Par) = N_Package_Body then
11177 Collect_Previous_Instances (Declarations (Par));
11179 elsif Nkind (Par) = N_Package_Declaration then
11180 Collect_Previous_Instances
11181 (Visible_Declarations (Specification (Par)));
11182 Collect_Previous_Instances
11183 (Private_Declarations (Specification (Par)));
11186 -- Enclosing unit is a subprogram body. In this
11187 -- case all instance bodies are processed in order
11188 -- and there is no need to collect them separately.
11193 Decl := First_Elmt (Previous_Instances);
11194 while Present (Decl) loop
11196 (Inst_Node => Node (Decl),
11198 Instance_Spec (Node (Decl)),
11199 Expander_Status => Exp_Status,
11200 Current_Sem_Unit =>
11201 Get_Code_Unit (Sloc (Node (Decl))),
11202 Scope_Suppress => Scope_Suppress,
11203 Local_Suppress_Stack_Top =>
11204 Local_Suppress_Stack_Top,
11205 Version => Ada_Version);
11207 -- Package instance
11210 Nkind (Node (Decl)) = N_Package_Instantiation
11212 Instantiate_Package_Body
11213 (Info, Body_Optional => True);
11215 -- Subprogram instance
11218 -- The instance_spec is the wrapper package,
11219 -- and the subprogram declaration is the last
11220 -- declaration in the wrapper.
11224 (Visible_Declarations
11225 (Specification (Info.Act_Decl)));
11227 Instantiate_Subprogram_Body
11228 (Info, Body_Optional => True);
11236 Instantiate_Package_Body
11238 ((Inst_Node => Inst_Node,
11239 Act_Decl => True_Parent,
11240 Expander_Status => Exp_Status,
11241 Current_Sem_Unit =>
11242 Get_Code_Unit (Sloc (Inst_Node)),
11243 Scope_Suppress => Scope_Suppress,
11244 Local_Suppress_Stack_Top =>
11245 Local_Suppress_Stack_Top,
11246 Version => Ada_Version)),
11247 Body_Optional => Body_Optional);
11251 -- Case where we are not instantiating a nested generic
11254 Opt.Style_Check := False;
11255 Expander_Mode_Save_And_Set (True);
11256 Load_Needed_Body (Comp_Unit, OK);
11257 Opt.Style_Check := Save_Style_Check;
11258 Expander_Mode_Restore;
11261 and then Unit_Requires_Body (Defining_Entity (Spec))
11262 and then not Body_Optional
11265 Bname : constant Unit_Name_Type :=
11266 Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
11269 -- In CodePeer mode, the missing body may make the analysis
11270 -- incomplete, but we do not treat it as fatal.
11272 if CodePeer_Mode then
11276 Error_Msg_Unit_1 := Bname;
11277 Error_Msg_N ("this instantiation requires$!", N);
11278 Error_Msg_File_1 :=
11279 Get_File_Name (Bname, Subunit => False);
11280 Error_Msg_N ("\but file{ was not found!", N);
11281 raise Unrecoverable_Error;
11288 -- If loading parent of the generic caused an instantiation circularity,
11289 -- we abandon compilation at this point, because otherwise in some cases
11290 -- we get into trouble with infinite recursions after this point.
11292 if Circularity_Detected then
11293 raise Unrecoverable_Error;
11295 end Load_Parent_Of_Generic;
11297 ---------------------------------
11298 -- Map_Formal_Package_Entities --
11299 ---------------------------------
11301 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
11306 Set_Instance_Of (Form, Act);
11308 -- Traverse formal and actual package to map the corresponding entities.
11309 -- We skip over internal entities that may be generated during semantic
11310 -- analysis, and find the matching entities by name, given that they
11311 -- must appear in the same order.
11313 E1 := First_Entity (Form);
11314 E2 := First_Entity (Act);
11315 while Present (E1) and then E1 /= First_Private_Entity (Form) loop
11316 -- Could this test be a single condition???
11317 -- Seems like it could, and isn't FPE (Form) a constant anyway???
11319 if not Is_Internal (E1)
11320 and then Present (Parent (E1))
11321 and then not Is_Class_Wide_Type (E1)
11322 and then not Is_Internal_Name (Chars (E1))
11324 while Present (E2) and then Chars (E2) /= Chars (E1) loop
11331 Set_Instance_Of (E1, E2);
11333 if Is_Type (E1) and then Is_Tagged_Type (E2) then
11334 Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
11337 if Is_Constrained (E1) then
11338 Set_Instance_Of (Base_Type (E1), Base_Type (E2));
11341 if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
11342 Map_Formal_Package_Entities (E1, E2);
11349 end Map_Formal_Package_Entities;
11351 -----------------------
11352 -- Move_Freeze_Nodes --
11353 -----------------------
11355 procedure Move_Freeze_Nodes
11356 (Out_Of : Entity_Id;
11361 Next_Decl : Node_Id;
11362 Next_Node : Node_Id := After;
11365 function Is_Outer_Type (T : Entity_Id) return Boolean;
11366 -- Check whether entity is declared in a scope external to that of the
11369 -------------------
11370 -- Is_Outer_Type --
11371 -------------------
11373 function Is_Outer_Type (T : Entity_Id) return Boolean is
11374 Scop : Entity_Id := Scope (T);
11377 if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
11381 while Scop /= Standard_Standard loop
11382 if Scop = Out_Of then
11385 Scop := Scope (Scop);
11393 -- Start of processing for Move_Freeze_Nodes
11400 -- First remove the freeze nodes that may appear before all other
11404 while Present (Decl)
11405 and then Nkind (Decl) = N_Freeze_Entity
11406 and then Is_Outer_Type (Entity (Decl))
11408 Decl := Remove_Head (L);
11409 Insert_After (Next_Node, Decl);
11410 Set_Analyzed (Decl, False);
11415 -- Next scan the list of declarations and remove each freeze node that
11416 -- appears ahead of the current node.
11418 while Present (Decl) loop
11419 while Present (Next (Decl))
11420 and then Nkind (Next (Decl)) = N_Freeze_Entity
11421 and then Is_Outer_Type (Entity (Next (Decl)))
11423 Next_Decl := Remove_Next (Decl);
11424 Insert_After (Next_Node, Next_Decl);
11425 Set_Analyzed (Next_Decl, False);
11426 Next_Node := Next_Decl;
11429 -- If the declaration is a nested package or concurrent type, then
11430 -- recurse. Nested generic packages will have been processed from the
11433 case Nkind (Decl) is
11434 when N_Package_Declaration =>
11435 Spec := Specification (Decl);
11437 when N_Task_Type_Declaration =>
11438 Spec := Task_Definition (Decl);
11440 when N_Protected_Type_Declaration =>
11441 Spec := Protected_Definition (Decl);
11447 if Present (Spec) then
11448 Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
11449 Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
11454 end Move_Freeze_Nodes;
11460 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
11462 return Generic_Renamings.Table (E).Next_In_HTable;
11465 ------------------------
11466 -- Preanalyze_Actuals --
11467 ------------------------
11469 procedure Preanalyze_Actuals (N : Node_Id) is
11472 Errs : constant Int := Serious_Errors_Detected;
11474 Cur : Entity_Id := Empty;
11475 -- Current homograph of the instance name
11478 -- Saved visibility status of the current homograph
11481 Assoc := First (Generic_Associations (N));
11483 -- If the instance is a child unit, its name may hide an outer homonym,
11484 -- so make it invisible to perform name resolution on the actuals.
11486 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
11488 (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
11490 Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
11492 if Is_Compilation_Unit (Cur) then
11493 Vis := Is_Immediately_Visible (Cur);
11494 Set_Is_Immediately_Visible (Cur, False);
11500 while Present (Assoc) loop
11501 if Nkind (Assoc) /= N_Others_Choice then
11502 Act := Explicit_Generic_Actual_Parameter (Assoc);
11504 -- Within a nested instantiation, a defaulted actual is an empty
11505 -- association, so nothing to analyze. If the subprogram actual
11506 -- is an attribute, analyze prefix only, because actual is not a
11507 -- complete attribute reference.
11509 -- If actual is an allocator, analyze expression only. The full
11510 -- analysis can generate code, and if instance is a compilation
11511 -- unit we have to wait until the package instance is installed
11512 -- to have a proper place to insert this code.
11514 -- String literals may be operators, but at this point we do not
11515 -- know whether the actual is a formal subprogram or a string.
11520 elsif Nkind (Act) = N_Attribute_Reference then
11521 Analyze (Prefix (Act));
11523 elsif Nkind (Act) = N_Explicit_Dereference then
11524 Analyze (Prefix (Act));
11526 elsif Nkind (Act) = N_Allocator then
11528 Expr : constant Node_Id := Expression (Act);
11531 if Nkind (Expr) = N_Subtype_Indication then
11532 Analyze (Subtype_Mark (Expr));
11534 -- Analyze separately each discriminant constraint, when
11535 -- given with a named association.
11541 Constr := First (Constraints (Constraint (Expr)));
11542 while Present (Constr) loop
11543 if Nkind (Constr) = N_Discriminant_Association then
11544 Analyze (Expression (Constr));
11558 elsif Nkind (Act) /= N_Operator_Symbol then
11562 if Errs /= Serious_Errors_Detected then
11564 -- Do a minimal analysis of the generic, to prevent spurious
11565 -- warnings complaining about the generic being unreferenced,
11566 -- before abandoning the instantiation.
11568 Analyze (Name (N));
11570 if Is_Entity_Name (Name (N))
11571 and then Etype (Name (N)) /= Any_Type
11573 Generate_Reference (Entity (Name (N)), Name (N));
11574 Set_Is_Instantiated (Entity (Name (N)));
11577 if Present (Cur) then
11579 -- For the case of a child instance hiding an outer homonym,
11580 -- provide additional warning which might explain the error.
11582 Set_Is_Immediately_Visible (Cur, Vis);
11583 Error_Msg_NE ("& hides outer unit with the same name?",
11584 N, Defining_Unit_Name (N));
11587 Abandon_Instantiation (Act);
11594 if Present (Cur) then
11595 Set_Is_Immediately_Visible (Cur, Vis);
11597 end Preanalyze_Actuals;
11599 -------------------
11600 -- Remove_Parent --
11601 -------------------
11603 procedure Remove_Parent (In_Body : Boolean := False) is
11604 S : Entity_Id := Current_Scope;
11605 -- S is the scope containing the instantiation just completed. The scope
11606 -- stack contains the parent instances of the instantiation, followed by
11615 -- After child instantiation is complete, remove from scope stack the
11616 -- extra copy of the current scope, and then remove parent instances.
11618 if not In_Body then
11621 while Current_Scope /= S loop
11622 P := Current_Scope;
11623 End_Package_Scope (Current_Scope);
11625 if In_Open_Scopes (P) then
11626 E := First_Entity (P);
11627 while Present (E) loop
11628 Set_Is_Immediately_Visible (E, True);
11632 -- If instantiation is declared in a block, it is the enclosing
11633 -- scope that might be a parent instance. Note that only one
11634 -- block can be involved, because the parent instances have
11635 -- been installed within it.
11637 if Ekind (P) = E_Block then
11638 Cur_P := Scope (P);
11643 if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
11644 -- We are within an instance of some sibling. Retain
11645 -- visibility of parent, for proper subsequent cleanup, and
11646 -- reinstall private declarations as well.
11648 Set_In_Private_Part (P);
11649 Install_Private_Declarations (P);
11652 -- If the ultimate parent is a top-level unit recorded in
11653 -- Instance_Parent_Unit, then reset its visibility to what it was
11654 -- before instantiation. (It's not clear what the purpose is of
11655 -- testing whether Scope (P) is In_Open_Scopes, but that test was
11656 -- present before the ultimate parent test was added.???)
11658 elsif not In_Open_Scopes (Scope (P))
11659 or else (P = Instance_Parent_Unit
11660 and then not Parent_Unit_Visible)
11662 Set_Is_Immediately_Visible (P, False);
11664 -- If the current scope is itself an instantiation of a generic
11665 -- nested within P, and we are in the private part of body of this
11666 -- instantiation, restore the full views of P, that were removed
11667 -- in End_Package_Scope above. This obscure case can occur when a
11668 -- subunit of a generic contains an instance of a child unit of
11669 -- its generic parent unit.
11671 elsif S = Current_Scope and then Is_Generic_Instance (S) then
11673 Par : constant Entity_Id :=
11675 (Specification (Unit_Declaration_Node (S)));
11678 and then P = Scope (Par)
11679 and then (In_Package_Body (S) or else In_Private_Part (S))
11681 Set_In_Private_Part (P);
11682 Install_Private_Declarations (P);
11688 -- Reset visibility of entities in the enclosing scope
11690 Set_Is_Hidden_Open_Scope (Current_Scope, False);
11692 Hidden := First_Elmt (Hidden_Entities);
11693 while Present (Hidden) loop
11694 Set_Is_Immediately_Visible (Node (Hidden), True);
11695 Next_Elmt (Hidden);
11699 -- Each body is analyzed separately, and there is no context that
11700 -- needs preserving from one body instance to the next, so remove all
11701 -- parent scopes that have been installed.
11703 while Present (S) loop
11704 End_Package_Scope (S);
11705 Set_Is_Immediately_Visible (S, False);
11706 S := Current_Scope;
11707 exit when S = Standard_Standard;
11716 procedure Restore_Env is
11717 Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
11720 if No (Current_Instantiated_Parent.Act_Id) then
11721 -- Restore environment after subprogram inlining
11723 Restore_Private_Views (Empty);
11726 Current_Instantiated_Parent := Saved.Instantiated_Parent;
11727 Exchanged_Views := Saved.Exchanged_Views;
11728 Hidden_Entities := Saved.Hidden_Entities;
11729 Current_Sem_Unit := Saved.Current_Sem_Unit;
11730 Parent_Unit_Visible := Saved.Parent_Unit_Visible;
11731 Instance_Parent_Unit := Saved.Instance_Parent_Unit;
11733 Restore_Opt_Config_Switches (Saved.Switches);
11735 Instance_Envs.Decrement_Last;
11738 ---------------------------
11739 -- Restore_Private_Views --
11740 ---------------------------
11742 procedure Restore_Private_Views
11743 (Pack_Id : Entity_Id;
11744 Is_Package : Boolean := True)
11749 Dep_Elmt : Elmt_Id;
11752 procedure Restore_Nested_Formal (Formal : Entity_Id);
11753 -- Hide the generic formals of formal packages declared with box which
11754 -- were reachable in the current instantiation.
11756 ---------------------------
11757 -- Restore_Nested_Formal --
11758 ---------------------------
11760 procedure Restore_Nested_Formal (Formal : Entity_Id) is
11764 if Present (Renamed_Object (Formal))
11765 and then Denotes_Formal_Package (Renamed_Object (Formal), True)
11769 elsif Present (Associated_Formal_Package (Formal)) then
11770 Ent := First_Entity (Formal);
11771 while Present (Ent) loop
11772 exit when Ekind (Ent) = E_Package
11773 and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
11775 Set_Is_Hidden (Ent);
11776 Set_Is_Potentially_Use_Visible (Ent, False);
11778 -- If package, then recurse
11780 if Ekind (Ent) = E_Package then
11781 Restore_Nested_Formal (Ent);
11787 end Restore_Nested_Formal;
11789 -- Start of processing for Restore_Private_Views
11792 M := First_Elmt (Exchanged_Views);
11793 while Present (M) loop
11796 -- Subtypes of types whose views have been exchanged, and that are
11797 -- defined within the instance, were not on the Private_Dependents
11798 -- list on entry to the instance, so they have to be exchanged
11799 -- explicitly now, in order to remain consistent with the view of the
11802 if Ekind_In (Typ, E_Private_Type,
11803 E_Limited_Private_Type,
11804 E_Record_Type_With_Private)
11806 Dep_Elmt := First_Elmt (Private_Dependents (Typ));
11807 while Present (Dep_Elmt) loop
11808 Dep_Typ := Node (Dep_Elmt);
11810 if Scope (Dep_Typ) = Pack_Id
11811 and then Present (Full_View (Dep_Typ))
11813 Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
11814 Exchange_Declarations (Dep_Typ);
11817 Next_Elmt (Dep_Elmt);
11821 Exchange_Declarations (Node (M));
11825 if No (Pack_Id) then
11829 -- Make the generic formal parameters private, and make the formal types
11830 -- into subtypes of the actuals again.
11832 E := First_Entity (Pack_Id);
11833 while Present (E) loop
11834 Set_Is_Hidden (E, True);
11837 and then Nkind (Parent (E)) = N_Subtype_Declaration
11839 Set_Is_Generic_Actual_Type (E, False);
11841 -- An unusual case of aliasing: the actual may also be directly
11842 -- visible in the generic, and be private there, while it is fully
11843 -- visible in the context of the instance. The internal subtype
11844 -- is private in the instance but has full visibility like its
11845 -- parent in the enclosing scope. This enforces the invariant that
11846 -- the privacy status of all private dependents of a type coincide
11847 -- with that of the parent type. This can only happen when a
11848 -- generic child unit is instantiated within a sibling.
11850 if Is_Private_Type (E)
11851 and then not Is_Private_Type (Etype (E))
11853 Exchange_Declarations (E);
11856 elsif Ekind (E) = E_Package then
11858 -- The end of the renaming list is the renaming of the generic
11859 -- package itself. If the instance is a subprogram, all entities
11860 -- in the corresponding package are renamings. If this entity is
11861 -- a formal package, make its own formals private as well. The
11862 -- actual in this case is itself the renaming of an instantiation.
11863 -- If the entity is not a package renaming, it is the entity
11864 -- created to validate formal package actuals: ignore it.
11866 -- If the actual is itself a formal package for the enclosing
11867 -- generic, or the actual for such a formal package, it remains
11868 -- visible on exit from the instance, and therefore nothing needs
11869 -- to be done either, except to keep it accessible.
11871 if Is_Package and then Renamed_Object (E) = Pack_Id then
11874 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
11878 Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
11880 Set_Is_Hidden (E, False);
11884 Act_P : constant Entity_Id := Renamed_Object (E);
11888 Id := First_Entity (Act_P);
11890 and then Id /= First_Private_Entity (Act_P)
11892 exit when Ekind (Id) = E_Package
11893 and then Renamed_Object (Id) = Act_P;
11895 Set_Is_Hidden (Id, True);
11896 Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
11898 if Ekind (Id) = E_Package then
11899 Restore_Nested_Formal (Id);
11910 end Restore_Private_Views;
11917 (Gen_Unit : Entity_Id;
11918 Act_Unit : Entity_Id)
11922 Set_Instance_Env (Gen_Unit, Act_Unit);
11925 ----------------------------
11926 -- Save_Global_References --
11927 ----------------------------
11929 procedure Save_Global_References (N : Node_Id) is
11930 Gen_Scope : Entity_Id;
11934 function Is_Global (E : Entity_Id) return Boolean;
11935 -- Check whether entity is defined outside of generic unit. Examine the
11936 -- scope of an entity, and the scope of the scope, etc, until we find
11937 -- either Standard, in which case the entity is global, or the generic
11938 -- unit itself, which indicates that the entity is local. If the entity
11939 -- is the generic unit itself, as in the case of a recursive call, or
11940 -- the enclosing generic unit, if different from the current scope, then
11941 -- it is local as well, because it will be replaced at the point of
11942 -- instantiation. On the other hand, if it is a reference to a child
11943 -- unit of a common ancestor, which appears in an instantiation, it is
11944 -- global because it is used to denote a specific compilation unit at
11945 -- the time the instantiations will be analyzed.
11947 procedure Reset_Entity (N : Node_Id);
11948 -- Save semantic information on global entity so that it is not resolved
11949 -- again at instantiation time.
11951 procedure Save_Entity_Descendants (N : Node_Id);
11952 -- Apply Save_Global_References to the two syntactic descendants of
11953 -- non-terminal nodes that carry an Associated_Node and are processed
11954 -- through Reset_Entity. Once the global entity (if any) has been
11955 -- captured together with its type, only two syntactic descendants need
11956 -- to be traversed to complete the processing of the tree rooted at N.
11957 -- This applies to Selected_Components, Expanded_Names, and to Operator
11958 -- nodes. N can also be a character literal, identifier, or operator
11959 -- symbol node, but the call has no effect in these cases.
11961 procedure Save_Global_Defaults (N1, N2 : Node_Id);
11962 -- Default actuals in nested instances must be handled specially
11963 -- because there is no link to them from the original tree. When an
11964 -- actual subprogram is given by a default, we add an explicit generic
11965 -- association for it in the instantiation node. When we save the
11966 -- global references on the name of the instance, we recover the list
11967 -- of generic associations, and add an explicit one to the original
11968 -- generic tree, through which a global actual can be preserved.
11969 -- Similarly, if a child unit is instantiated within a sibling, in the
11970 -- context of the parent, we must preserve the identifier of the parent
11971 -- so that it can be properly resolved in a subsequent instantiation.
11973 procedure Save_Global_Descendant (D : Union_Id);
11974 -- Apply Save_Global_References recursively to the descendents of the
11977 procedure Save_References (N : Node_Id);
11978 -- This is the recursive procedure that does the work, once the
11979 -- enclosing generic scope has been established.
11985 function Is_Global (E : Entity_Id) return Boolean is
11988 function Is_Instance_Node (Decl : Node_Id) return Boolean;
11989 -- Determine whether the parent node of a reference to a child unit
11990 -- denotes an instantiation or a formal package, in which case the
11991 -- reference to the child unit is global, even if it appears within
11992 -- the current scope (e.g. when the instance appears within the body
11993 -- of an ancestor).
11995 ----------------------
11996 -- Is_Instance_Node --
11997 ----------------------
11999 function Is_Instance_Node (Decl : Node_Id) return Boolean is
12001 return Nkind (Decl) in N_Generic_Instantiation
12003 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
12004 end Is_Instance_Node;
12006 -- Start of processing for Is_Global
12009 if E = Gen_Scope then
12012 elsif E = Standard_Standard then
12015 elsif Is_Child_Unit (E)
12016 and then (Is_Instance_Node (Parent (N2))
12017 or else (Nkind (Parent (N2)) = N_Expanded_Name
12018 and then N2 = Selector_Name (Parent (N2))
12020 Is_Instance_Node (Parent (Parent (N2)))))
12026 while Se /= Gen_Scope loop
12027 if Se = Standard_Standard then
12042 procedure Reset_Entity (N : Node_Id) is
12044 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
12045 -- If the type of N2 is global to the generic unit. Save the type in
12046 -- the generic node.
12047 -- What does this comment mean???
12049 function Top_Ancestor (E : Entity_Id) return Entity_Id;
12050 -- Find the ultimate ancestor of the current unit. If it is not a
12051 -- generic unit, then the name of the current unit in the prefix of
12052 -- an expanded name must be replaced with its generic homonym to
12053 -- ensure that it will be properly resolved in an instance.
12055 ---------------------
12056 -- Set_Global_Type --
12057 ---------------------
12059 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
12060 Typ : constant Entity_Id := Etype (N2);
12063 Set_Etype (N, Typ);
12065 if Entity (N) /= N2
12066 and then Has_Private_View (Entity (N))
12068 -- If the entity of N is not the associated node, this is a
12069 -- nested generic and it has an associated node as well, whose
12070 -- type is already the full view (see below). Indicate that the
12071 -- original node has a private view.
12073 Set_Has_Private_View (N);
12076 -- If not a private type, nothing else to do
12078 if not Is_Private_Type (Typ) then
12079 if Is_Array_Type (Typ)
12080 and then Is_Private_Type (Component_Type (Typ))
12082 Set_Has_Private_View (N);
12085 -- If it is a derivation of a private type in a context where no
12086 -- full view is needed, nothing to do either.
12088 elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
12091 -- Otherwise mark the type for flipping and use the full view when
12095 Set_Has_Private_View (N);
12097 if Present (Full_View (Typ)) then
12098 Set_Etype (N2, Full_View (Typ));
12101 end Set_Global_Type;
12107 function Top_Ancestor (E : Entity_Id) return Entity_Id is
12112 while Is_Child_Unit (Par) loop
12113 Par := Scope (Par);
12119 -- Start of processing for Reset_Entity
12122 N2 := Get_Associated_Node (N);
12125 if Present (E) then
12127 -- If the node is an entry call to an entry in an enclosing task,
12128 -- it is rewritten as a selected component. No global entity to
12129 -- preserve in this case, since the expansion will be redone in
12132 if not Nkind_In (E, N_Defining_Identifier,
12133 N_Defining_Character_Literal,
12134 N_Defining_Operator_Symbol)
12136 Set_Associated_Node (N, Empty);
12137 Set_Etype (N, Empty);
12141 -- If the entity is an itype created as a subtype of an access
12142 -- type with a null exclusion restore source entity for proper
12143 -- visibility. The itype will be created anew in the instance.
12146 and then Ekind (E) = E_Access_Subtype
12147 and then Is_Entity_Name (N)
12148 and then Chars (Etype (E)) = Chars (N)
12151 Set_Entity (N2, E);
12155 if Is_Global (E) then
12156 Set_Global_Type (N, N2);
12158 elsif Nkind (N) = N_Op_Concat
12159 and then Is_Generic_Type (Etype (N2))
12160 and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
12162 Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
12163 and then Is_Intrinsic_Subprogram (E)
12168 -- Entity is local. Mark generic node as unresolved.
12169 -- Note that now it does not have an entity.
12171 Set_Associated_Node (N, Empty);
12172 Set_Etype (N, Empty);
12175 if Nkind (Parent (N)) in N_Generic_Instantiation
12176 and then N = Name (Parent (N))
12178 Save_Global_Defaults (Parent (N), Parent (N2));
12181 elsif Nkind (Parent (N)) = N_Selected_Component
12182 and then Nkind (Parent (N2)) = N_Expanded_Name
12184 if Is_Global (Entity (Parent (N2))) then
12185 Change_Selected_Component_To_Expanded_Name (Parent (N));
12186 Set_Associated_Node (Parent (N), Parent (N2));
12187 Set_Global_Type (Parent (N), Parent (N2));
12188 Save_Entity_Descendants (N);
12190 -- If this is a reference to the current generic entity, replace
12191 -- by the name of the generic homonym of the current package. This
12192 -- is because in an instantiation Par.P.Q will not resolve to the
12193 -- name of the instance, whose enclosing scope is not necessarily
12194 -- Par. We use the generic homonym rather that the name of the
12195 -- generic itself because it may be hidden by a local declaration.
12197 elsif In_Open_Scopes (Entity (Parent (N2)))
12199 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
12201 if Ekind (Entity (Parent (N2))) = E_Generic_Package then
12202 Rewrite (Parent (N),
12203 Make_Identifier (Sloc (N),
12205 Chars (Generic_Homonym (Entity (Parent (N2))))));
12207 Rewrite (Parent (N),
12208 Make_Identifier (Sloc (N),
12209 Chars => Chars (Selector_Name (Parent (N2)))));
12213 if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
12214 and then Parent (N) = Name (Parent (Parent (N)))
12216 Save_Global_Defaults
12217 (Parent (Parent (N)), Parent (Parent ((N2))));
12220 -- A selected component may denote a static constant that has been
12221 -- folded. If the static constant is global to the generic, capture
12222 -- its value. Otherwise the folding will happen in any instantiation.
12224 elsif Nkind (Parent (N)) = N_Selected_Component
12225 and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
12227 if Present (Entity (Original_Node (Parent (N2))))
12228 and then Is_Global (Entity (Original_Node (Parent (N2))))
12230 Rewrite (Parent (N), New_Copy (Parent (N2)));
12231 Set_Analyzed (Parent (N), False);
12237 -- A selected component may be transformed into a parameterless
12238 -- function call. If the called entity is global, rewrite the node
12239 -- appropriately, i.e. as an extended name for the global entity.
12241 elsif Nkind (Parent (N)) = N_Selected_Component
12242 and then Nkind (Parent (N2)) = N_Function_Call
12243 and then N = Selector_Name (Parent (N))
12245 if No (Parameter_Associations (Parent (N2))) then
12246 if Is_Global (Entity (Name (Parent (N2)))) then
12247 Change_Selected_Component_To_Expanded_Name (Parent (N));
12248 Set_Associated_Node (Parent (N), Name (Parent (N2)));
12249 Set_Global_Type (Parent (N), Name (Parent (N2)));
12250 Save_Entity_Descendants (N);
12253 Set_Associated_Node (N, Empty);
12254 Set_Etype (N, Empty);
12257 -- In Ada 2005, X.F may be a call to a primitive operation,
12258 -- rewritten as F (X). This rewriting will be done again in an
12259 -- instance, so keep the original node. Global entities will be
12260 -- captured as for other constructs.
12266 -- Entity is local. Reset in generic unit, so that node is resolved
12267 -- anew at the point of instantiation.
12270 Set_Associated_Node (N, Empty);
12271 Set_Etype (N, Empty);
12275 -----------------------------
12276 -- Save_Entity_Descendants --
12277 -----------------------------
12279 procedure Save_Entity_Descendants (N : Node_Id) is
12282 when N_Binary_Op =>
12283 Save_Global_Descendant (Union_Id (Left_Opnd (N)));
12284 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
12287 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
12289 when N_Expanded_Name | N_Selected_Component =>
12290 Save_Global_Descendant (Union_Id (Prefix (N)));
12291 Save_Global_Descendant (Union_Id (Selector_Name (N)));
12293 when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
12297 raise Program_Error;
12299 end Save_Entity_Descendants;
12301 --------------------------
12302 -- Save_Global_Defaults --
12303 --------------------------
12305 procedure Save_Global_Defaults (N1, N2 : Node_Id) is
12306 Loc : constant Source_Ptr := Sloc (N1);
12307 Assoc2 : constant List_Id := Generic_Associations (N2);
12308 Gen_Id : constant Entity_Id := Get_Generic_Entity (N2);
12315 Actual : Entity_Id;
12318 Assoc1 := Generic_Associations (N1);
12320 if Present (Assoc1) then
12321 Act1 := First (Assoc1);
12324 Set_Generic_Associations (N1, New_List);
12325 Assoc1 := Generic_Associations (N1);
12328 if Present (Assoc2) then
12329 Act2 := First (Assoc2);
12334 while Present (Act1) and then Present (Act2) loop
12339 -- Find the associations added for default subprograms
12341 if Present (Act2) then
12342 while Nkind (Act2) /= N_Generic_Association
12343 or else No (Entity (Selector_Name (Act2)))
12344 or else not Is_Overloadable (Entity (Selector_Name (Act2)))
12349 -- Add a similar association if the default is global. The
12350 -- renaming declaration for the actual has been analyzed, and
12351 -- its alias is the program it renames. Link the actual in the
12352 -- original generic tree with the node in the analyzed tree.
12354 while Present (Act2) loop
12355 Subp := Entity (Selector_Name (Act2));
12356 Def := Explicit_Generic_Actual_Parameter (Act2);
12358 -- Following test is defence against rubbish errors
12360 if No (Alias (Subp)) then
12364 -- Retrieve the resolved actual from the renaming declaration
12365 -- created for the instantiated formal.
12367 Actual := Entity (Name (Parent (Parent (Subp))));
12368 Set_Entity (Def, Actual);
12369 Set_Etype (Def, Etype (Actual));
12371 if Is_Global (Actual) then
12373 Make_Generic_Association (Loc,
12374 Selector_Name => New_Occurrence_Of (Subp, Loc),
12375 Explicit_Generic_Actual_Parameter =>
12376 New_Occurrence_Of (Actual, Loc));
12378 Set_Associated_Node
12379 (Explicit_Generic_Actual_Parameter (Ndec), Def);
12381 Append (Ndec, Assoc1);
12383 -- If there are other defaults, add a dummy association in case
12384 -- there are other defaulted formals with the same name.
12386 elsif Present (Next (Act2)) then
12388 Make_Generic_Association (Loc,
12389 Selector_Name => New_Occurrence_Of (Subp, Loc),
12390 Explicit_Generic_Actual_Parameter => Empty);
12392 Append (Ndec, Assoc1);
12399 if Nkind (Name (N1)) = N_Identifier
12400 and then Is_Child_Unit (Gen_Id)
12401 and then Is_Global (Gen_Id)
12402 and then Is_Generic_Unit (Scope (Gen_Id))
12403 and then In_Open_Scopes (Scope (Gen_Id))
12405 -- This is an instantiation of a child unit within a sibling, so
12406 -- that the generic parent is in scope. An eventual instance must
12407 -- occur within the scope of an instance of the parent. Make name
12408 -- in instance into an expanded name, to preserve the identifier
12409 -- of the parent, so it can be resolved subsequently.
12411 Rewrite (Name (N2),
12412 Make_Expanded_Name (Loc,
12413 Chars => Chars (Gen_Id),
12414 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
12415 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
12416 Set_Entity (Name (N2), Gen_Id);
12418 Rewrite (Name (N1),
12419 Make_Expanded_Name (Loc,
12420 Chars => Chars (Gen_Id),
12421 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
12422 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
12424 Set_Associated_Node (Name (N1), Name (N2));
12425 Set_Associated_Node (Prefix (Name (N1)), Empty);
12426 Set_Associated_Node
12427 (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
12428 Set_Etype (Name (N1), Etype (Gen_Id));
12431 end Save_Global_Defaults;
12433 ----------------------------
12434 -- Save_Global_Descendant --
12435 ----------------------------
12437 procedure Save_Global_Descendant (D : Union_Id) is
12441 if D in Node_Range then
12442 if D = Union_Id (Empty) then
12445 elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
12446 Save_References (Node_Id (D));
12449 elsif D in List_Range then
12450 if D = Union_Id (No_List)
12451 or else Is_Empty_List (List_Id (D))
12456 N1 := First (List_Id (D));
12457 while Present (N1) loop
12458 Save_References (N1);
12463 -- Element list or other non-node field, nothing to do
12468 end Save_Global_Descendant;
12470 ---------------------
12471 -- Save_References --
12472 ---------------------
12474 -- This is the recursive procedure that does the work once the enclosing
12475 -- generic scope has been established. We have to treat specially a
12476 -- number of node rewritings that are required by semantic processing
12477 -- and which change the kind of nodes in the generic copy: typically
12478 -- constant-folding, replacing an operator node by a string literal, or
12479 -- a selected component by an expanded name. In each of those cases, the
12480 -- transformation is propagated to the generic unit.
12482 procedure Save_References (N : Node_Id) is
12483 Loc : constant Source_Ptr := Sloc (N);
12489 elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
12490 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
12493 elsif Nkind (N) = N_Operator_Symbol
12494 and then Nkind (Get_Associated_Node (N)) = N_String_Literal
12496 Change_Operator_Symbol_To_String_Literal (N);
12499 elsif Nkind (N) in N_Op then
12500 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
12501 if Nkind (N) = N_Op_Concat then
12502 Set_Is_Component_Left_Opnd (N,
12503 Is_Component_Left_Opnd (Get_Associated_Node (N)));
12505 Set_Is_Component_Right_Opnd (N,
12506 Is_Component_Right_Opnd (Get_Associated_Node (N)));
12512 -- Node may be transformed into call to a user-defined operator
12514 N2 := Get_Associated_Node (N);
12516 if Nkind (N2) = N_Function_Call then
12517 E := Entity (Name (N2));
12520 and then Is_Global (E)
12522 Set_Etype (N, Etype (N2));
12524 Set_Associated_Node (N, Empty);
12525 Set_Etype (N, Empty);
12528 elsif Nkind_In (N2, N_Integer_Literal,
12532 if Present (Original_Node (N2))
12533 and then Nkind (Original_Node (N2)) = Nkind (N)
12536 -- Operation was constant-folded. Whenever possible,
12537 -- recover semantic information from unfolded node,
12540 Set_Associated_Node (N, Original_Node (N2));
12542 if Nkind (N) = N_Op_Concat then
12543 Set_Is_Component_Left_Opnd (N,
12544 Is_Component_Left_Opnd (Get_Associated_Node (N)));
12545 Set_Is_Component_Right_Opnd (N,
12546 Is_Component_Right_Opnd (Get_Associated_Node (N)));
12552 -- If original node is already modified, propagate
12553 -- constant-folding to template.
12555 Rewrite (N, New_Copy (N2));
12556 Set_Analyzed (N, False);
12559 elsif Nkind (N2) = N_Identifier
12560 and then Ekind (Entity (N2)) = E_Enumeration_Literal
12562 -- Same if call was folded into a literal, but in this case
12563 -- retain the entity to avoid spurious ambiguities if it is
12564 -- overloaded at the point of instantiation or inlining.
12566 Rewrite (N, New_Copy (N2));
12567 Set_Analyzed (N, False);
12571 -- Complete operands check if node has not been constant-folded
12573 if Nkind (N) in N_Op then
12574 Save_Entity_Descendants (N);
12577 elsif Nkind (N) = N_Identifier then
12578 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
12580 -- If this is a discriminant reference, always save it. It is
12581 -- used in the instance to find the corresponding discriminant
12582 -- positionally rather than by name.
12584 Set_Original_Discriminant
12585 (N, Original_Discriminant (Get_Associated_Node (N)));
12589 N2 := Get_Associated_Node (N);
12591 if Nkind (N2) = N_Function_Call then
12592 E := Entity (Name (N2));
12594 -- Name resolves to a call to parameterless function. If
12595 -- original entity is global, mark node as resolved.
12598 and then Is_Global (E)
12600 Set_Etype (N, Etype (N2));
12602 Set_Associated_Node (N, Empty);
12603 Set_Etype (N, Empty);
12606 elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
12607 and then Is_Entity_Name (Original_Node (N2))
12609 -- Name resolves to named number that is constant-folded,
12610 -- We must preserve the original name for ASIS use, and
12611 -- undo the constant-folding, which will be repeated in
12614 Set_Associated_Node (N, Original_Node (N2));
12617 elsif Nkind (N2) = N_String_Literal then
12619 -- Name resolves to string literal. Perform the same
12620 -- replacement in generic.
12622 Rewrite (N, New_Copy (N2));
12624 elsif Nkind (N2) = N_Explicit_Dereference then
12626 -- An identifier is rewritten as a dereference if it is the
12627 -- prefix in an implicit dereference (call or attribute).
12628 -- The analysis of an instantiation will expand the node
12629 -- again, so we preserve the original tree but link it to
12630 -- the resolved entity in case it is global.
12632 if Is_Entity_Name (Prefix (N2))
12633 and then Present (Entity (Prefix (N2)))
12634 and then Is_Global (Entity (Prefix (N2)))
12636 Set_Associated_Node (N, Prefix (N2));
12638 elsif Nkind (Prefix (N2)) = N_Function_Call
12639 and then Is_Global (Entity (Name (Prefix (N2))))
12642 Make_Explicit_Dereference (Loc,
12643 Prefix => Make_Function_Call (Loc,
12645 New_Occurrence_Of (Entity (Name (Prefix (N2))),
12649 Set_Associated_Node (N, Empty);
12650 Set_Etype (N, Empty);
12653 -- The subtype mark of a nominally unconstrained object is
12654 -- rewritten as a subtype indication using the bounds of the
12655 -- expression. Recover the original subtype mark.
12657 elsif Nkind (N2) = N_Subtype_Indication
12658 and then Is_Entity_Name (Original_Node (N2))
12660 Set_Associated_Node (N, Original_Node (N2));
12668 elsif Nkind (N) in N_Entity then
12673 Qual : Node_Id := Empty;
12674 Typ : Entity_Id := Empty;
12677 use Atree.Unchecked_Access;
12678 -- This code section is part of implementing an untyped tree
12679 -- traversal, so it needs direct access to node fields.
12682 if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
12683 N2 := Get_Associated_Node (N);
12690 -- In an instance within a generic, use the name of the
12691 -- actual and not the original generic parameter. If the
12692 -- actual is global in the current generic it must be
12693 -- preserved for its instantiation.
12695 if Nkind (Parent (Typ)) = N_Subtype_Declaration
12697 Present (Generic_Parent_Type (Parent (Typ)))
12699 Typ := Base_Type (Typ);
12700 Set_Etype (N2, Typ);
12706 or else not Is_Global (Typ)
12708 Set_Associated_Node (N, Empty);
12710 -- If the aggregate is an actual in a call, it has been
12711 -- resolved in the current context, to some local type.
12712 -- The enclosing call may have been disambiguated by the
12713 -- aggregate, and this disambiguation might fail at
12714 -- instantiation time because the type to which the
12715 -- aggregate did resolve is not preserved. In order to
12716 -- preserve some of this information, we wrap the
12717 -- aggregate in a qualified expression, using the id of
12718 -- its type. For further disambiguation we qualify the
12719 -- type name with its scope (if visible) because both
12720 -- id's will have corresponding entities in an instance.
12721 -- This resolves most of the problems with missing type
12722 -- information on aggregates in instances.
12724 if Nkind (N2) = Nkind (N)
12726 Nkind_In (Parent (N2), N_Procedure_Call_Statement,
12728 and then Comes_From_Source (Typ)
12730 if Is_Immediately_Visible (Scope (Typ)) then
12731 Nam := Make_Selected_Component (Loc,
12733 Make_Identifier (Loc, Chars (Scope (Typ))),
12735 Make_Identifier (Loc, Chars (Typ)));
12737 Nam := Make_Identifier (Loc, Chars (Typ));
12741 Make_Qualified_Expression (Loc,
12742 Subtype_Mark => Nam,
12743 Expression => Relocate_Node (N));
12747 Save_Global_Descendant (Field1 (N));
12748 Save_Global_Descendant (Field2 (N));
12749 Save_Global_Descendant (Field3 (N));
12750 Save_Global_Descendant (Field5 (N));
12752 if Present (Qual) then
12756 -- All other cases than aggregates
12759 Save_Global_Descendant (Field1 (N));
12760 Save_Global_Descendant (Field2 (N));
12761 Save_Global_Descendant (Field3 (N));
12762 Save_Global_Descendant (Field4 (N));
12763 Save_Global_Descendant (Field5 (N));
12768 -- If a node has aspects, references within their expressions must
12769 -- be saved separately, given that they are not directly in the
12772 if Has_Aspects (N) then
12776 Aspect := First (Aspect_Specifications (N));
12777 while Present (Aspect) loop
12778 Save_Global_References (Expression (Aspect));
12783 end Save_References;
12785 -- Start of processing for Save_Global_References
12788 Gen_Scope := Current_Scope;
12790 -- If the generic unit is a child unit, references to entities in the
12791 -- parent are treated as local, because they will be resolved anew in
12792 -- the context of the instance of the parent.
12794 while Is_Child_Unit (Gen_Scope)
12795 and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
12797 Gen_Scope := Scope (Gen_Scope);
12800 Save_References (N);
12801 end Save_Global_References;
12803 --------------------------------------
12804 -- Set_Copied_Sloc_For_Inlined_Body --
12805 --------------------------------------
12807 procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
12809 Create_Instantiation_Source (N, E, True, S_Adjustment);
12810 end Set_Copied_Sloc_For_Inlined_Body;
12812 ---------------------
12813 -- Set_Instance_Of --
12814 ---------------------
12816 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
12818 Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
12819 Generic_Renamings_HTable.Set (Generic_Renamings.Last);
12820 Generic_Renamings.Increment_Last;
12821 end Set_Instance_Of;
12823 --------------------
12824 -- Set_Next_Assoc --
12825 --------------------
12827 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
12829 Generic_Renamings.Table (E).Next_In_HTable := Next;
12830 end Set_Next_Assoc;
12832 -------------------
12833 -- Start_Generic --
12834 -------------------
12836 procedure Start_Generic is
12838 -- ??? More things could be factored out in this routine.
12839 -- Should probably be done at a later stage.
12841 Generic_Flags.Append (Inside_A_Generic);
12842 Inside_A_Generic := True;
12844 Expander_Mode_Save_And_Set (False);
12847 ----------------------
12848 -- Set_Instance_Env --
12849 ----------------------
12851 procedure Set_Instance_Env
12852 (Gen_Unit : Entity_Id;
12853 Act_Unit : Entity_Id)
12856 -- Regardless of the current mode, predefined units are analyzed in the
12857 -- most current Ada mode, and earlier version Ada checks do not apply
12858 -- to predefined units. Nothing needs to be done for non-internal units.
12859 -- These are always analyzed in the current mode.
12861 if Is_Internal_File_Name
12862 (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
12863 Renamings_Included => True)
12865 Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
12868 Current_Instantiated_Parent :=
12869 (Gen_Id => Gen_Unit,
12870 Act_Id => Act_Unit,
12871 Next_In_HTable => Assoc_Null);
12872 end Set_Instance_Env;
12878 procedure Switch_View (T : Entity_Id) is
12879 BT : constant Entity_Id := Base_Type (T);
12880 Priv_Elmt : Elmt_Id := No_Elmt;
12881 Priv_Sub : Entity_Id;
12884 -- T may be private but its base type may have been exchanged through
12885 -- some other occurrence, in which case there is nothing to switch
12886 -- besides T itself. Note that a private dependent subtype of a private
12887 -- type might not have been switched even if the base type has been,
12888 -- because of the last branch of Check_Private_View (see comment there).
12890 if not Is_Private_Type (BT) then
12891 Prepend_Elmt (Full_View (T), Exchanged_Views);
12892 Exchange_Declarations (T);
12896 Priv_Elmt := First_Elmt (Private_Dependents (BT));
12898 if Present (Full_View (BT)) then
12899 Prepend_Elmt (Full_View (BT), Exchanged_Views);
12900 Exchange_Declarations (BT);
12903 while Present (Priv_Elmt) loop
12904 Priv_Sub := (Node (Priv_Elmt));
12906 -- We avoid flipping the subtype if the Etype of its full view is
12907 -- private because this would result in a malformed subtype. This
12908 -- occurs when the Etype of the subtype full view is the full view of
12909 -- the base type (and since the base types were just switched, the
12910 -- subtype is pointing to the wrong view). This is currently the case
12911 -- for tagged record types, access types (maybe more?) and needs to
12912 -- be resolved. ???
12914 if Present (Full_View (Priv_Sub))
12915 and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
12917 Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
12918 Exchange_Declarations (Priv_Sub);
12921 Next_Elmt (Priv_Elmt);
12925 -----------------------------
12926 -- Valid_Default_Attribute --
12927 -----------------------------
12929 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
12930 Attr_Id : constant Attribute_Id :=
12931 Get_Attribute_Id (Attribute_Name (Def));
12932 T : constant Entity_Id := Entity (Prefix (Def));
12933 Is_Fun : constant Boolean := (Ekind (Nam) = E_Function);
12946 F := First_Formal (Nam);
12947 while Present (F) loop
12948 Num_F := Num_F + 1;
12953 when Attribute_Adjacent | Attribute_Ceiling | Attribute_Copy_Sign |
12954 Attribute_Floor | Attribute_Fraction | Attribute_Machine |
12955 Attribute_Model | Attribute_Remainder | Attribute_Rounding |
12956 Attribute_Unbiased_Rounding =>
12959 and then Is_Floating_Point_Type (T);
12961 when Attribute_Image | Attribute_Pred | Attribute_Succ |
12962 Attribute_Value | Attribute_Wide_Image |
12963 Attribute_Wide_Value =>
12964 OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
12966 when Attribute_Max | Attribute_Min =>
12967 OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
12969 when Attribute_Input =>
12970 OK := (Is_Fun and then Num_F = 1);
12972 when Attribute_Output | Attribute_Read | Attribute_Write =>
12973 OK := (not Is_Fun and then Num_F = 2);
12980 Error_Msg_N ("attribute reference has wrong profile for subprogram",
12983 end Valid_Default_Attribute;