gcc/ada/
[official-gcc.git] / gcc / ada / sem_ch12.adb
blob88126e428cf4da316c487b0de16fef9d07a4e023
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- S E M _ C H 1 2 --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1992-2014, Free Software Foundation, Inc. --
10 -- --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
24 ------------------------------------------------------------------------------
26 with Aspects; use Aspects;
27 with Atree; use Atree;
28 with Einfo; use Einfo;
29 with Elists; use Elists;
30 with Errout; use Errout;
31 with Expander; use Expander;
32 with Exp_Disp; use Exp_Disp;
33 with Exp_Util; use Exp_Util;
34 with Fname; use Fname;
35 with Fname.UF; use Fname.UF;
36 with Freeze; use Freeze;
37 with Itypes; use Itypes;
38 with Lib; use Lib;
39 with Lib.Load; use Lib.Load;
40 with Lib.Xref; use Lib.Xref;
41 with Nlists; use Nlists;
42 with Namet; use Namet;
43 with Nmake; use Nmake;
44 with Opt; use Opt;
45 with Rident; use Rident;
46 with Restrict; use Restrict;
47 with Rtsfind; use Rtsfind;
48 with Sem; use Sem;
49 with Sem_Aux; use Sem_Aux;
50 with Sem_Cat; use Sem_Cat;
51 with Sem_Ch3; use Sem_Ch3;
52 with Sem_Ch6; use Sem_Ch6;
53 with Sem_Ch7; use Sem_Ch7;
54 with Sem_Ch8; use Sem_Ch8;
55 with Sem_Ch10; use Sem_Ch10;
56 with Sem_Ch13; use Sem_Ch13;
57 with Sem_Dim; use Sem_Dim;
58 with Sem_Disp; use Sem_Disp;
59 with Sem_Elab; use Sem_Elab;
60 with Sem_Elim; use Sem_Elim;
61 with Sem_Eval; use Sem_Eval;
62 with Sem_Prag; use Sem_Prag;
63 with Sem_Res; use Sem_Res;
64 with Sem_Type; use Sem_Type;
65 with Sem_Util; use Sem_Util;
66 with Sem_Warn; use Sem_Warn;
67 with Stand; use Stand;
68 with Sinfo; use Sinfo;
69 with Sinfo.CN; use Sinfo.CN;
70 with Sinput; use Sinput;
71 with Sinput.L; use Sinput.L;
72 with Snames; use Snames;
73 with Stringt; use Stringt;
74 with Uname; use Uname;
75 with Table;
76 with Tbuild; use Tbuild;
77 with Uintp; use Uintp;
78 with Urealp; use Urealp;
79 with Warnsw; use Warnsw;
81 with GNAT.HTable;
83 package body Sem_Ch12 is
85 ----------------------------------------------------------
86 -- Implementation of Generic Analysis and Instantiation --
87 ----------------------------------------------------------
89 -- GNAT implements generics by macro expansion. No attempt is made to share
90 -- generic instantiations (for now). Analysis of a generic definition does
91 -- not perform any expansion action, but the expander must be called on the
92 -- tree for each instantiation, because the expansion may of course depend
93 -- on the generic actuals. All of this is best achieved as follows:
95 -- a) Semantic analysis of a generic unit is performed on a copy of the
96 -- tree for the generic unit. All tree modifications that follow analysis
97 -- do not affect the original tree. Links are kept between the original
98 -- tree and the copy, in order to recognize non-local references within
99 -- the generic, and propagate them to each instance (recall that name
100 -- resolution is done on the generic declaration: generics are not really
101 -- macros). This is summarized in the following diagram:
103 -- .-----------. .----------.
104 -- | semantic |<--------------| generic |
105 -- | copy | | unit |
106 -- | |==============>| |
107 -- |___________| global |__________|
108 -- references | | |
109 -- | | |
110 -- .-----|--|.
111 -- | .-----|---.
112 -- | | .----------.
113 -- | | | generic |
114 -- |__| | |
115 -- |__| instance |
116 -- |__________|
118 -- b) Each instantiation copies the original tree, and inserts into it a
119 -- series of declarations that describe the mapping between generic formals
120 -- and actuals. For example, a generic In OUT parameter is an object
121 -- renaming of the corresponding actual, etc. Generic IN parameters are
122 -- constant declarations.
124 -- c) In order to give the right visibility for these renamings, we use
125 -- a different scheme for package and subprogram instantiations. For
126 -- packages, the list of renamings is inserted into the package
127 -- specification, before the visible declarations of the package. The
128 -- renamings are analyzed before any of the text of the instance, and are
129 -- thus visible at the right place. Furthermore, outside of the instance,
130 -- the generic parameters are visible and denote their corresponding
131 -- actuals.
133 -- For subprograms, we create a container package to hold the renamings
134 -- and the subprogram instance itself. Analysis of the package makes the
135 -- renaming declarations visible to the subprogram. After analyzing the
136 -- package, the defining entity for the subprogram is touched-up so that
137 -- it appears declared in the current scope, and not inside the container
138 -- package.
140 -- If the instantiation is a compilation unit, the container package is
141 -- given the same name as the subprogram instance. This ensures that
142 -- the elaboration procedure called by the binder, using the compilation
143 -- unit name, calls in fact the elaboration procedure for the package.
145 -- Not surprisingly, private types complicate this approach. By saving in
146 -- the original generic object the non-local references, we guarantee that
147 -- the proper entities are referenced at the point of instantiation.
148 -- However, for private types, this by itself does not insure that the
149 -- proper VIEW of the entity is used (the full type may be visible at the
150 -- point of generic definition, but not at instantiation, or vice-versa).
151 -- In order to reference the proper view, we special-case any reference
152 -- to private types in the generic object, by saving both views, one in
153 -- the generic and one in the semantic copy. At time of instantiation, we
154 -- check whether the two views are consistent, and exchange declarations if
155 -- necessary, in order to restore the correct visibility. Similarly, if
156 -- the instance view is private when the generic view was not, we perform
157 -- the exchange. After completing the instantiation, we restore the
158 -- current visibility. The flag Has_Private_View marks identifiers in the
159 -- the generic unit that require checking.
161 -- Visibility within nested generic units requires special handling.
162 -- Consider the following scheme:
164 -- type Global is ... -- outside of generic unit.
165 -- generic ...
166 -- package Outer is
167 -- ...
168 -- type Semi_Global is ... -- global to inner.
170 -- generic ... -- 1
171 -- procedure inner (X1 : Global; X2 : Semi_Global);
173 -- procedure in2 is new inner (...); -- 4
174 -- end Outer;
176 -- package New_Outer is new Outer (...); -- 2
177 -- procedure New_Inner is new New_Outer.Inner (...); -- 3
179 -- The semantic analysis of Outer captures all occurrences of Global.
180 -- The semantic analysis of Inner (at 1) captures both occurrences of
181 -- Global and Semi_Global.
183 -- At point 2 (instantiation of Outer), we also produce a generic copy
184 -- of Inner, even though Inner is, at that point, not being instantiated.
185 -- (This is just part of the semantic analysis of New_Outer).
187 -- Critically, references to Global within Inner must be preserved, while
188 -- references to Semi_Global should not preserved, because they must now
189 -- resolve to an entity within New_Outer. To distinguish between these, we
190 -- use a global variable, Current_Instantiated_Parent, which is set when
191 -- performing a generic copy during instantiation (at 2). This variable is
192 -- used when performing a generic copy that is not an instantiation, but
193 -- that is nested within one, as the occurrence of 1 within 2. The analysis
194 -- of a nested generic only preserves references that are global to the
195 -- enclosing Current_Instantiated_Parent. We use the Scope_Depth value to
196 -- determine whether a reference is external to the given parent.
198 -- The instantiation at point 3 requires no special treatment. The method
199 -- works as well for further nestings of generic units, but of course the
200 -- variable Current_Instantiated_Parent must be stacked because nested
201 -- instantiations can occur, e.g. the occurrence of 4 within 2.
203 -- The instantiation of package and subprogram bodies is handled in a
204 -- similar manner, except that it is delayed until after semantic
205 -- analysis is complete. In this fashion complex cross-dependencies
206 -- between several package declarations and bodies containing generics
207 -- can be compiled which otherwise would diagnose spurious circularities.
209 -- For example, it is possible to compile two packages A and B that
210 -- have the following structure:
212 -- package A is package B is
213 -- generic ... generic ...
214 -- package G_A is package G_B is
216 -- with B; with A;
217 -- package body A is package body B is
218 -- package N_B is new G_B (..) package N_A is new G_A (..)
220 -- The table Pending_Instantiations in package Inline is used to keep
221 -- track of body instantiations that are delayed in this manner. Inline
222 -- handles the actual calls to do the body instantiations. This activity
223 -- is part of Inline, since the processing occurs at the same point, and
224 -- for essentially the same reason, as the handling of inlined routines.
226 ----------------------------------------------
227 -- Detection of Instantiation Circularities --
228 ----------------------------------------------
230 -- If we have a chain of instantiations that is circular, this is static
231 -- error which must be detected at compile time. The detection of these
232 -- circularities is carried out at the point that we insert a generic
233 -- instance spec or body. If there is a circularity, then the analysis of
234 -- the offending spec or body will eventually result in trying to load the
235 -- same unit again, and we detect this problem as we analyze the package
236 -- instantiation for the second time.
238 -- At least in some cases after we have detected the circularity, we get
239 -- into trouble if we try to keep going. The following flag is set if a
240 -- circularity is detected, and used to abandon compilation after the
241 -- messages have been posted.
243 Circularity_Detected : Boolean := False;
244 -- This should really be reset on encountering a new main unit, but in
245 -- practice we are not using multiple main units so it is not critical.
247 --------------------------------------------------
248 -- Formal packages and partial parameterization --
249 --------------------------------------------------
251 -- When compiling a generic, a formal package is a local instantiation. If
252 -- declared with a box, its generic formals are visible in the enclosing
253 -- generic. If declared with a partial list of actuals, those actuals that
254 -- are defaulted (covered by an Others clause, or given an explicit box
255 -- initialization) are also visible in the enclosing generic, while those
256 -- that have a corresponding actual are not.
258 -- In our source model of instantiation, the same visibility must be
259 -- present in the spec and body of an instance: the names of the formals
260 -- that are defaulted must be made visible within the instance, and made
261 -- invisible (hidden) after the instantiation is complete, so that they
262 -- are not accessible outside of the instance.
264 -- In a generic, a formal package is treated like a special instantiation.
265 -- Our Ada 95 compiler handled formals with and without box in different
266 -- ways. With partial parameterization, we use a single model for both.
267 -- We create a package declaration that consists of the specification of
268 -- the generic package, and a set of declarations that map the actuals
269 -- into local renamings, just as we do for bona fide instantiations. For
270 -- defaulted parameters and formals with a box, we copy directly the
271 -- declarations of the formal into this local package. The result is a
272 -- a package whose visible declarations may include generic formals. This
273 -- package is only used for type checking and visibility analysis, and
274 -- never reaches the back-end, so it can freely violate the placement
275 -- rules for generic formal declarations.
277 -- The list of declarations (renamings and copies of formals) is built
278 -- by Analyze_Associations, just as for regular instantiations.
280 -- At the point of instantiation, conformance checking must be applied only
281 -- to those parameters that were specified in the formal. We perform this
282 -- checking by creating another internal instantiation, this one including
283 -- only the renamings and the formals (the rest of the package spec is not
284 -- relevant to conformance checking). We can then traverse two lists: the
285 -- list of actuals in the instance that corresponds to the formal package,
286 -- and the list of actuals produced for this bogus instantiation. We apply
287 -- the conformance rules to those actuals that are not defaulted (i.e.
288 -- which still appear as generic formals.
290 -- When we compile an instance body we must make the right parameters
291 -- visible again. The predicate Is_Generic_Formal indicates which of the
292 -- formals should have its Is_Hidden flag reset.
294 -----------------------
295 -- Local subprograms --
296 -----------------------
298 procedure Abandon_Instantiation (N : Node_Id);
299 pragma No_Return (Abandon_Instantiation);
300 -- Posts an error message "instantiation abandoned" at the indicated node
301 -- and then raises the exception Instantiation_Error to do it.
303 procedure Analyze_Formal_Array_Type
304 (T : in out Entity_Id;
305 Def : Node_Id);
306 -- A formal array type is treated like an array type declaration, and
307 -- invokes Array_Type_Declaration (sem_ch3) whose first parameter is
308 -- in-out, because in the case of an anonymous type the entity is
309 -- actually created in the procedure.
311 -- The following procedures treat other kinds of formal parameters
313 procedure Analyze_Formal_Derived_Interface_Type
314 (N : Node_Id;
315 T : Entity_Id;
316 Def : Node_Id);
318 procedure Analyze_Formal_Derived_Type
319 (N : Node_Id;
320 T : Entity_Id;
321 Def : Node_Id);
323 procedure Analyze_Formal_Interface_Type
324 (N : Node_Id;
325 T : Entity_Id;
326 Def : Node_Id);
328 -- The following subprograms create abbreviated declarations for formal
329 -- scalar types. We introduce an anonymous base of the proper class for
330 -- each of them, and define the formals as constrained first subtypes of
331 -- their bases. The bounds are expressions that are non-static in the
332 -- generic.
334 procedure Analyze_Formal_Decimal_Fixed_Point_Type
335 (T : Entity_Id; Def : Node_Id);
336 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id);
337 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id);
338 procedure Analyze_Formal_Signed_Integer_Type (T : Entity_Id; Def : Node_Id);
339 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id);
340 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
341 (T : Entity_Id; Def : Node_Id);
343 procedure Analyze_Formal_Private_Type
344 (N : Node_Id;
345 T : Entity_Id;
346 Def : Node_Id);
347 -- Creates a new private type, which does not require completion
349 procedure Analyze_Formal_Incomplete_Type (T : Entity_Id; Def : Node_Id);
350 -- Ada 2012: Creates a new incomplete type whose actual does not freeze
352 procedure Analyze_Generic_Formal_Part (N : Node_Id);
353 -- Analyze generic formal part
355 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
356 -- Create a new access type with the given designated type
358 function Analyze_Associations
359 (I_Node : Node_Id;
360 Formals : List_Id;
361 F_Copy : List_Id) return List_Id;
362 -- At instantiation time, build the list of associations between formals
363 -- and actuals. Each association becomes a renaming declaration for the
364 -- formal entity. F_Copy is the analyzed list of formals in the generic
365 -- copy. It is used to apply legality checks to the actuals. I_Node is the
366 -- instantiation node itself.
368 procedure Analyze_Subprogram_Instantiation
369 (N : Node_Id;
370 K : Entity_Kind);
372 procedure Build_Instance_Compilation_Unit_Nodes
373 (N : Node_Id;
374 Act_Body : Node_Id;
375 Act_Decl : Node_Id);
376 -- This procedure is used in the case where the generic instance of a
377 -- subprogram body or package body is a library unit. In this case, the
378 -- original library unit node for the generic instantiation must be
379 -- replaced by the resulting generic body, and a link made to a new
380 -- compilation unit node for the generic declaration. The argument N is
381 -- the original generic instantiation. Act_Body and Act_Decl are the body
382 -- and declaration of the instance (either package body and declaration
383 -- nodes or subprogram body and declaration nodes depending on the case).
384 -- On return, the node N has been rewritten with the actual body.
386 procedure Check_Access_Definition (N : Node_Id);
387 -- Subsidiary routine to null exclusion processing. Perform an assertion
388 -- check on Ada version and the presence of an access definition in N.
390 procedure Check_Formal_Packages (P_Id : Entity_Id);
391 -- Apply the following to all formal packages in generic associations
393 procedure Check_Formal_Package_Instance
394 (Formal_Pack : Entity_Id;
395 Actual_Pack : Entity_Id);
396 -- Verify that the actuals of the actual instance match the actuals of
397 -- the template for a formal package that is not declared with a box.
399 procedure Check_Forward_Instantiation (Decl : Node_Id);
400 -- If the generic is a local entity and the corresponding body has not
401 -- been seen yet, flag enclosing packages to indicate that it will be
402 -- elaborated after the generic body. Subprograms declared in the same
403 -- package cannot be inlined by the front-end because front-end inlining
404 -- requires a strict linear order of elaboration.
406 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id;
407 -- Check if some association between formals and actuals requires to make
408 -- visible primitives of a tagged type, and make those primitives visible.
409 -- Return the list of primitives whose visibility is modified (to restore
410 -- their visibility later through Restore_Hidden_Primitives). If no
411 -- candidate is found then return No_Elist.
413 procedure Check_Hidden_Child_Unit
414 (N : Node_Id;
415 Gen_Unit : Entity_Id;
416 Act_Decl_Id : Entity_Id);
417 -- If the generic unit is an implicit child instance within a parent
418 -- instance, we need to make an explicit test that it is not hidden by
419 -- a child instance of the same name and parent.
421 procedure Check_Generic_Actuals
422 (Instance : Entity_Id;
423 Is_Formal_Box : Boolean);
424 -- Similar to previous one. Check the actuals in the instantiation,
425 -- whose views can change between the point of instantiation and the point
426 -- of instantiation of the body. In addition, mark the generic renamings
427 -- as generic actuals, so that they are not compatible with other actuals.
428 -- Recurse on an actual that is a formal package whose declaration has
429 -- a box.
431 function Contains_Instance_Of
432 (Inner : Entity_Id;
433 Outer : Entity_Id;
434 N : Node_Id) return Boolean;
435 -- Inner is instantiated within the generic Outer. Check whether Inner
436 -- directly or indirectly contains an instance of Outer or of one of its
437 -- parents, in the case of a subunit. Each generic unit holds a list of
438 -- the entities instantiated within (at any depth). This procedure
439 -- determines whether the set of such lists contains a cycle, i.e. an
440 -- illegal circular instantiation.
442 function Denotes_Formal_Package
443 (Pack : Entity_Id;
444 On_Exit : Boolean := False;
445 Instance : Entity_Id := Empty) return Boolean;
446 -- Returns True if E is a formal package of an enclosing generic, or
447 -- the actual for such a formal in an enclosing instantiation. If such
448 -- a package is used as a formal in an nested generic, or as an actual
449 -- in a nested instantiation, the visibility of ITS formals should not
450 -- be modified. When called from within Restore_Private_Views, the flag
451 -- On_Exit is true, to indicate that the search for a possible enclosing
452 -- instance should ignore the current one. In that case Instance denotes
453 -- the declaration for which this is an actual. This declaration may be
454 -- an instantiation in the source, or the internal instantiation that
455 -- corresponds to the actual for a formal package.
457 function Earlier (N1, N2 : Node_Id) return Boolean;
458 -- Yields True if N1 and N2 appear in the same compilation unit,
459 -- ignoring subunits, and if N1 is to the left of N2 in a left-to-right
460 -- traversal of the tree for the unit. Used to determine the placement
461 -- of freeze nodes for instance bodies that may depend on other instances.
463 function Find_Actual_Type
464 (Typ : Entity_Id;
465 Gen_Type : Entity_Id) return Entity_Id;
466 -- When validating the actual types of a child instance, check whether
467 -- the formal is a formal type of the parent unit, and retrieve the current
468 -- actual for it. Typ is the entity in the analyzed formal type declaration
469 -- (component or index type of an array type, or designated type of an
470 -- access formal) and Gen_Type is the enclosing analyzed formal array
471 -- or access type. The desired actual may be a formal of a parent, or may
472 -- be declared in a formal package of a parent. In both cases it is a
473 -- generic actual type because it appears within a visible instance.
474 -- Finally, it may be declared in a parent unit without being a formal
475 -- of that unit, in which case it must be retrieved by visibility.
476 -- Ambiguities may still arise if two homonyms are declared in two formal
477 -- packages, and the prefix of the formal type may be needed to resolve
478 -- the ambiguity in the instance ???
480 function In_Same_Declarative_Part
481 (F_Node : Node_Id;
482 Inst : Node_Id) return Boolean;
483 -- True if the instantiation Inst and the given freeze_node F_Node appear
484 -- within the same declarative part, ignoring subunits, but with no inter-
485 -- vening subprograms or concurrent units. Used to find the proper plave
486 -- for the freeze node of an instance, when the generic is declared in a
487 -- previous instance. If predicate is true, the freeze node of the instance
488 -- can be placed after the freeze node of the previous instance, Otherwise
489 -- it has to be placed at the end of the current declarative part.
491 function In_Main_Context (E : Entity_Id) return Boolean;
492 -- Check whether an instantiation is in the context of the main unit.
493 -- Used to determine whether its body should be elaborated to allow
494 -- front-end inlining.
496 procedure Set_Instance_Env
497 (Gen_Unit : Entity_Id;
498 Act_Unit : Entity_Id);
499 -- Save current instance on saved environment, to be used to determine
500 -- the global status of entities in nested instances. Part of Save_Env.
501 -- called after verifying that the generic unit is legal for the instance,
502 -- The procedure also examines whether the generic unit is a predefined
503 -- unit, in order to set configuration switches accordingly. As a result
504 -- the procedure must be called after analyzing and freezing the actuals.
506 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id);
507 -- Associate analyzed generic parameter with corresponding
508 -- instance. Used for semantic checks at instantiation time.
510 function Has_Been_Exchanged (E : Entity_Id) return Boolean;
511 -- Traverse the Exchanged_Views list to see if a type was private
512 -- and has already been flipped during this phase of instantiation.
514 procedure Hide_Current_Scope;
515 -- When instantiating a generic child unit, the parent context must be
516 -- present, but the instance and all entities that may be generated
517 -- must be inserted in the current scope. We leave the current scope
518 -- on the stack, but make its entities invisible to avoid visibility
519 -- problems. This is reversed at the end of the instantiation. This is
520 -- not done for the instantiation of the bodies, which only require the
521 -- instances of the generic parents to be in scope.
523 procedure Install_Body
524 (Act_Body : Node_Id;
525 N : Node_Id;
526 Gen_Body : Node_Id;
527 Gen_Decl : Node_Id);
528 -- If the instantiation happens textually before the body of the generic,
529 -- the instantiation of the body must be analyzed after the generic body,
530 -- and not at the point of instantiation. Such early instantiations can
531 -- happen if the generic and the instance appear in a package declaration
532 -- because the generic body can only appear in the corresponding package
533 -- body. Early instantiations can also appear if generic, instance and
534 -- body are all in the declarative part of a subprogram or entry. Entities
535 -- of packages that are early instantiations are delayed, and their freeze
536 -- node appears after the generic body.
538 procedure Insert_Freeze_Node_For_Instance
539 (N : Node_Id;
540 F_Node : Node_Id);
541 -- N denotes a package or a subprogram instantiation and F_Node is the
542 -- associated freeze node. Insert the freeze node before the first source
543 -- body which follows immediately after N. If no such body is found, the
544 -- freeze node is inserted at the end of the declarative region which
545 -- contains N.
547 procedure Freeze_Subprogram_Body
548 (Inst_Node : Node_Id;
549 Gen_Body : Node_Id;
550 Pack_Id : Entity_Id);
551 -- The generic body may appear textually after the instance, including
552 -- in the proper body of a stub, or within a different package instance.
553 -- Given that the instance can only be elaborated after the generic, we
554 -- place freeze_nodes for the instance and/or for packages that may enclose
555 -- the instance and the generic, so that the back-end can establish the
556 -- proper order of elaboration.
558 procedure Init_Env;
559 -- Establish environment for subsequent instantiation. Separated from
560 -- Save_Env because data-structures for visibility handling must be
561 -- initialized before call to Check_Generic_Child_Unit.
563 procedure Install_Formal_Packages (Par : Entity_Id);
564 -- Install the visible part of any formal of the parent that is a formal
565 -- package. Note that for the case of a formal package with a box, this
566 -- includes the formal part of the formal package (12.7(10/2)).
568 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False);
569 -- When compiling an instance of a child unit the parent (which is
570 -- itself an instance) is an enclosing scope that must be made
571 -- immediately visible. This procedure is also used to install the non-
572 -- generic parent of a generic child unit when compiling its body, so
573 -- that full views of types in the parent are made visible.
575 procedure Remove_Parent (In_Body : Boolean := False);
576 -- Reverse effect after instantiation of child is complete
578 procedure Install_Hidden_Primitives
579 (Prims_List : in out Elist_Id;
580 Gen_T : Entity_Id;
581 Act_T : Entity_Id);
582 -- Remove suffix 'P' from hidden primitives of Act_T to match the
583 -- visibility of primitives of Gen_T. The list of primitives to which
584 -- the suffix is removed is added to Prims_List to restore them later.
586 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id);
587 -- Restore suffix 'P' to primitives of Prims_List and leave Prims_List
588 -- set to No_Elist.
590 procedure Inline_Instance_Body
591 (N : Node_Id;
592 Gen_Unit : Entity_Id;
593 Act_Decl : Node_Id);
594 -- If front-end inlining is requested, instantiate the package body,
595 -- and preserve the visibility of its compilation unit, to insure
596 -- that successive instantiations succeed.
598 -- The functions Instantiate_XXX perform various legality checks and build
599 -- the declarations for instantiated generic parameters. In all of these
600 -- Formal is the entity in the generic unit, Actual is the entity of
601 -- expression in the generic associations, and Analyzed_Formal is the
602 -- formal in the generic copy, which contains the semantic information to
603 -- be used to validate the actual.
605 function Instantiate_Object
606 (Formal : Node_Id;
607 Actual : Node_Id;
608 Analyzed_Formal : Node_Id) return List_Id;
610 function Instantiate_Type
611 (Formal : Node_Id;
612 Actual : Node_Id;
613 Analyzed_Formal : Node_Id;
614 Actual_Decls : List_Id) return List_Id;
616 function Instantiate_Formal_Subprogram
617 (Formal : Node_Id;
618 Actual : Node_Id;
619 Analyzed_Formal : Node_Id) return Node_Id;
621 function Instantiate_Formal_Package
622 (Formal : Node_Id;
623 Actual : Node_Id;
624 Analyzed_Formal : Node_Id) return List_Id;
625 -- If the formal package is declared with a box, special visibility rules
626 -- apply to its formals: they are in the visible part of the package. This
627 -- is true in the declarative region of the formal package, that is to say
628 -- in the enclosing generic or instantiation. For an instantiation, the
629 -- parameters of the formal package are made visible in an explicit step.
630 -- Furthermore, if the actual has a visible USE clause, these formals must
631 -- be made potentially use-visible as well. On exit from the enclosing
632 -- instantiation, the reverse must be done.
634 -- For a formal package declared without a box, there are conformance rules
635 -- that apply to the actuals in the generic declaration and the actuals of
636 -- the actual package in the enclosing instantiation. The simplest way to
637 -- apply these rules is to repeat the instantiation of the formal package
638 -- in the context of the enclosing instance, and compare the generic
639 -- associations of this instantiation with those of the actual package.
640 -- This internal instantiation only needs to contain the renamings of the
641 -- formals: the visible and private declarations themselves need not be
642 -- created.
644 -- In Ada 2005, the formal package may be only partially parameterized.
645 -- In that case the visibility step must make visible those actuals whose
646 -- corresponding formals were given with a box. A final complication
647 -- involves inherited operations from formal derived types, which must
648 -- be visible if the type is.
650 function Is_In_Main_Unit (N : Node_Id) return Boolean;
651 -- Test if given node is in the main unit
653 procedure Load_Parent_Of_Generic
654 (N : Node_Id;
655 Spec : Node_Id;
656 Body_Optional : Boolean := False);
657 -- If the generic appears in a separate non-generic library unit, load the
658 -- corresponding body to retrieve the body of the generic. N is the node
659 -- for the generic instantiation, Spec is the generic package declaration.
661 -- Body_Optional is a flag that indicates that the body is being loaded to
662 -- ensure that temporaries are generated consistently when there are other
663 -- instances in the current declarative part that precede the one being
664 -- loaded. In that case a missing body is acceptable.
666 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id);
667 -- Add the context clause of the unit containing a generic unit to a
668 -- compilation unit that is, or contains, an instantiation.
670 function Get_Associated_Node (N : Node_Id) return Node_Id;
671 -- In order to propagate semantic information back from the analyzed copy
672 -- to the original generic, we maintain links between selected nodes in the
673 -- generic and their corresponding copies. At the end of generic analysis,
674 -- the routine Save_Global_References traverses the generic tree, examines
675 -- the semantic information, and preserves the links to those nodes that
676 -- contain global information. At instantiation, the information from the
677 -- associated node is placed on the new copy, so that name resolution is
678 -- not repeated.
680 -- Three kinds of source nodes have associated nodes:
682 -- a) those that can reference (denote) entities, that is identifiers,
683 -- character literals, expanded_names, operator symbols, operators,
684 -- and attribute reference nodes. These nodes have an Entity field
685 -- and are the set of nodes that are in N_Has_Entity.
687 -- b) aggregates (N_Aggregate and N_Extension_Aggregate)
689 -- c) selected components (N_Selected_Component)
691 -- For the first class, the associated node preserves the entity if it is
692 -- global. If the generic contains nested instantiations, the associated
693 -- node itself has been recopied, and a chain of them must be followed.
695 -- For aggregates, the associated node allows retrieval of the type, which
696 -- may otherwise not appear in the generic. The view of this type may be
697 -- different between generic and instantiation, and the full view can be
698 -- installed before the instantiation is analyzed. For aggregates of type
699 -- extensions, the same view exchange may have to be performed for some of
700 -- the ancestor types, if their view is private at the point of
701 -- instantiation.
703 -- Nodes that are selected components in the parse tree may be rewritten
704 -- as expanded names after resolution, and must be treated as potential
705 -- entity holders, which is why they also have an Associated_Node.
707 -- Nodes that do not come from source, such as freeze nodes, do not appear
708 -- in the generic tree, and need not have an associated node.
710 -- The associated node is stored in the Associated_Node field. Note that
711 -- this field overlaps Entity, which is fine, because the whole point is
712 -- that we don't need or want the normal Entity field in this situation.
714 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id);
715 -- Within the generic part, entities in the formal package are
716 -- visible. To validate subsequent type declarations, indicate
717 -- the correspondence between the entities in the analyzed formal,
718 -- and the entities in the actual package. There are three packages
719 -- involved in the instantiation of a formal package: the parent
720 -- generic P1 which appears in the generic declaration, the fake
721 -- instantiation P2 which appears in the analyzed generic, and whose
722 -- visible entities may be used in subsequent formals, and the actual
723 -- P3 in the instance. To validate subsequent formals, me indicate
724 -- that the entities in P2 are mapped into those of P3. The mapping of
725 -- entities has to be done recursively for nested packages.
727 procedure Move_Freeze_Nodes
728 (Out_Of : Entity_Id;
729 After : Node_Id;
730 L : List_Id);
731 -- Freeze nodes can be generated in the analysis of a generic unit, but
732 -- will not be seen by the back-end. It is necessary to move those nodes
733 -- to the enclosing scope if they freeze an outer entity. We place them
734 -- at the end of the enclosing generic package, which is semantically
735 -- neutral.
737 procedure Preanalyze_Actuals (N : Node_Id);
738 -- Analyze actuals to perform name resolution. Full resolution is done
739 -- later, when the expected types are known, but names have to be captured
740 -- before installing parents of generics, that are not visible for the
741 -- actuals themselves.
743 function True_Parent (N : Node_Id) return Node_Id;
744 -- For a subunit, return parent of corresponding stub, else return
745 -- parent of node.
747 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id);
748 -- Verify that an attribute that appears as the default for a formal
749 -- subprogram is a function or procedure with the correct profile.
751 -------------------------------------------
752 -- Data Structures for Generic Renamings --
753 -------------------------------------------
755 -- The map Generic_Renamings associates generic entities with their
756 -- corresponding actuals. Currently used to validate type instances. It
757 -- will eventually be used for all generic parameters to eliminate the
758 -- need for overload resolution in the instance.
760 type Assoc_Ptr is new Int;
762 Assoc_Null : constant Assoc_Ptr := -1;
764 type Assoc is record
765 Gen_Id : Entity_Id;
766 Act_Id : Entity_Id;
767 Next_In_HTable : Assoc_Ptr;
768 end record;
770 package Generic_Renamings is new Table.Table
771 (Table_Component_Type => Assoc,
772 Table_Index_Type => Assoc_Ptr,
773 Table_Low_Bound => 0,
774 Table_Initial => 10,
775 Table_Increment => 100,
776 Table_Name => "Generic_Renamings");
778 -- Variable to hold enclosing instantiation. When the environment is
779 -- saved for a subprogram inlining, the corresponding Act_Id is empty.
781 Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
783 -- Hash table for associations
785 HTable_Size : constant := 37;
786 type HTable_Range is range 0 .. HTable_Size - 1;
788 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr);
789 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr;
790 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id;
791 function Hash (F : Entity_Id) return HTable_Range;
793 package Generic_Renamings_HTable is new GNAT.HTable.Static_HTable (
794 Header_Num => HTable_Range,
795 Element => Assoc,
796 Elmt_Ptr => Assoc_Ptr,
797 Null_Ptr => Assoc_Null,
798 Set_Next => Set_Next_Assoc,
799 Next => Next_Assoc,
800 Key => Entity_Id,
801 Get_Key => Get_Gen_Id,
802 Hash => Hash,
803 Equal => "=");
805 Exchanged_Views : Elist_Id;
806 -- This list holds the private views that have been exchanged during
807 -- instantiation to restore the visibility of the generic declaration.
808 -- (see comments above). After instantiation, the current visibility is
809 -- reestablished by means of a traversal of this list.
811 Hidden_Entities : Elist_Id;
812 -- This list holds the entities of the current scope that are removed
813 -- from immediate visibility when instantiating a child unit. Their
814 -- visibility is restored in Remove_Parent.
816 -- Because instantiations can be recursive, the following must be saved
817 -- on entry and restored on exit from an instantiation (spec or body).
818 -- This is done by the two procedures Save_Env and Restore_Env. For
819 -- package and subprogram instantiations (but not for the body instances)
820 -- the action of Save_Env is done in two steps: Init_Env is called before
821 -- Check_Generic_Child_Unit, because setting the parent instances requires
822 -- that the visibility data structures be properly initialized. Once the
823 -- generic is unit is validated, Set_Instance_Env completes Save_Env.
825 Parent_Unit_Visible : Boolean := False;
826 -- Parent_Unit_Visible is used when the generic is a child unit, and
827 -- indicates whether the ultimate parent of the generic is visible in the
828 -- instantiation environment. It is used to reset the visibility of the
829 -- parent at the end of the instantiation (see Remove_Parent).
831 Instance_Parent_Unit : Entity_Id := Empty;
832 -- This records the ultimate parent unit of an instance of a generic
833 -- child unit and is used in conjunction with Parent_Unit_Visible to
834 -- indicate the unit to which the Parent_Unit_Visible flag corresponds.
836 type Instance_Env is record
837 Instantiated_Parent : Assoc;
838 Exchanged_Views : Elist_Id;
839 Hidden_Entities : Elist_Id;
840 Current_Sem_Unit : Unit_Number_Type;
841 Parent_Unit_Visible : Boolean := False;
842 Instance_Parent_Unit : Entity_Id := Empty;
843 Switches : Config_Switches_Type;
844 end record;
846 package Instance_Envs is new Table.Table (
847 Table_Component_Type => Instance_Env,
848 Table_Index_Type => Int,
849 Table_Low_Bound => 0,
850 Table_Initial => 32,
851 Table_Increment => 100,
852 Table_Name => "Instance_Envs");
854 procedure Restore_Private_Views
855 (Pack_Id : Entity_Id;
856 Is_Package : Boolean := True);
857 -- Restore the private views of external types, and unmark the generic
858 -- renamings of actuals, so that they become compatible subtypes again.
859 -- For subprograms, Pack_Id is the package constructed to hold the
860 -- renamings.
862 procedure Switch_View (T : Entity_Id);
863 -- Switch the partial and full views of a type and its private
864 -- dependents (i.e. its subtypes and derived types).
866 ------------------------------------
867 -- Structures for Error Reporting --
868 ------------------------------------
870 Instantiation_Node : Node_Id;
871 -- Used by subprograms that validate instantiation of formal parameters
872 -- where there might be no actual on which to place the error message.
873 -- Also used to locate the instantiation node for generic subunits.
875 Instantiation_Error : exception;
876 -- When there is a semantic error in the generic parameter matching,
877 -- there is no point in continuing the instantiation, because the
878 -- number of cascaded errors is unpredictable. This exception aborts
879 -- the instantiation process altogether.
881 S_Adjustment : Sloc_Adjustment;
882 -- Offset created for each node in an instantiation, in order to keep
883 -- track of the source position of the instantiation in each of its nodes.
884 -- A subsequent semantic error or warning on a construct of the instance
885 -- points to both places: the original generic node, and the point of
886 -- instantiation. See Sinput and Sinput.L for additional details.
888 ------------------------------------------------------------
889 -- Data structure for keeping track when inside a Generic --
890 ------------------------------------------------------------
892 -- The following table is used to save values of the Inside_A_Generic
893 -- flag (see spec of Sem) when they are saved by Start_Generic.
895 package Generic_Flags is new Table.Table (
896 Table_Component_Type => Boolean,
897 Table_Index_Type => Int,
898 Table_Low_Bound => 0,
899 Table_Initial => 32,
900 Table_Increment => 200,
901 Table_Name => "Generic_Flags");
903 ---------------------------
904 -- Abandon_Instantiation --
905 ---------------------------
907 procedure Abandon_Instantiation (N : Node_Id) is
908 begin
909 Error_Msg_N ("\instantiation abandoned!", N);
910 raise Instantiation_Error;
911 end Abandon_Instantiation;
913 --------------------------
914 -- Analyze_Associations --
915 --------------------------
917 function Analyze_Associations
918 (I_Node : Node_Id;
919 Formals : List_Id;
920 F_Copy : List_Id) return List_Id
922 Actuals_To_Freeze : constant Elist_Id := New_Elmt_List;
923 Assoc : constant List_Id := New_List;
924 Default_Actuals : constant Elist_Id := New_Elmt_List;
925 Gen_Unit : constant Entity_Id :=
926 Defining_Entity (Parent (F_Copy));
928 Actuals : List_Id;
929 Actual : Node_Id;
930 Analyzed_Formal : Node_Id;
931 First_Named : Node_Id := Empty;
932 Formal : Node_Id;
933 Match : Node_Id;
934 Named : Node_Id;
935 Saved_Formal : Node_Id;
937 Default_Formals : constant List_Id := New_List;
938 -- If an Others_Choice is present, some of the formals may be defaulted.
939 -- To simplify the treatment of visibility in an instance, we introduce
940 -- individual defaults for each such formal. These defaults are
941 -- appended to the list of associations and replace the Others_Choice.
943 Found_Assoc : Node_Id;
944 -- Association for the current formal being match. Empty if there are
945 -- no remaining actuals, or if there is no named association with the
946 -- name of the formal.
948 Is_Named_Assoc : Boolean;
949 Num_Matched : Int := 0;
950 Num_Actuals : Int := 0;
952 Others_Present : Boolean := False;
953 Others_Choice : Node_Id := Empty;
954 -- In Ada 2005, indicates partial parameterization of a formal
955 -- package. As usual an other association must be last in the list.
957 function Build_Function_Wrapper
958 (Formal : Entity_Id;
959 Actual : Entity_Id := Empty) return Node_Id;
960 -- In GNATprove mode, create a wrapper function for actuals that are
961 -- functions with any number of formal parameters, in order to propagate
962 -- their contract to the renaming declarations generated for them.
963 -- If the actual is absent, the formal has a default, and the name of
964 -- the function is that of the formal.
966 function Build_Operator_Wrapper
967 (Formal : Entity_Id;
968 Actual : Entity_Id := Empty) return Node_Id;
969 -- In GNATprove mode, create a wrapper function for actuals that are
970 -- operators, in order to propagate their contract to the renaming
971 -- declarations generated for them. If the actual is absent, this is
972 -- a formal with a default, and the name of the operator is that of the
973 -- formal.
975 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id);
976 -- Apply RM 12.3 (9): if a formal subprogram is overloaded, the instance
977 -- cannot have a named association for it. AI05-0025 extends this rule
978 -- to formals of formal packages by AI05-0025, and it also applies to
979 -- box-initialized formals.
981 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean;
982 -- Determine whether the parameter types and the return type of Subp
983 -- are fully defined at the point of instantiation.
985 function Matching_Actual
986 (F : Entity_Id;
987 A_F : Entity_Id) return Node_Id;
988 -- Find actual that corresponds to a given a formal parameter. If the
989 -- actuals are positional, return the next one, if any. If the actuals
990 -- are named, scan the parameter associations to find the right one.
991 -- A_F is the corresponding entity in the analyzed generic,which is
992 -- placed on the selector name for ASIS use.
994 -- In Ada 2005, a named association may be given with a box, in which
995 -- case Matching_Actual sets Found_Assoc to the generic association,
996 -- but return Empty for the actual itself. In this case the code below
997 -- creates a corresponding declaration for the formal.
999 function Partial_Parameterization return Boolean;
1000 -- Ada 2005: if no match is found for a given formal, check if the
1001 -- association for it includes a box, or whether the associations
1002 -- include an Others clause.
1004 procedure Process_Default (F : Entity_Id);
1005 -- Add a copy of the declaration of generic formal F to the list of
1006 -- associations, and add an explicit box association for F if there
1007 -- is none yet, and the default comes from an Others_Choice.
1009 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean;
1010 -- Determine whether Subp renames one of the subprograms defined in the
1011 -- generated package Standard.
1013 procedure Set_Analyzed_Formal;
1014 -- Find the node in the generic copy that corresponds to a given formal.
1015 -- The semantic information on this node is used to perform legality
1016 -- checks on the actuals. Because semantic analysis can introduce some
1017 -- anonymous entities or modify the declaration node itself, the
1018 -- correspondence between the two lists is not one-one. In addition to
1019 -- anonymous types, the presence a formal equality will introduce an
1020 -- implicit declaration for the corresponding inequality.
1022 ----------------------------
1023 -- Build_Function_Wrapper --
1024 ----------------------------
1026 function Build_Function_Wrapper
1027 (Formal : Entity_Id;
1028 Actual : Entity_Id := Empty) return Node_Id
1030 Loc : constant Source_Ptr := Sloc (I_Node);
1031 Actuals : List_Id;
1032 Decl : Node_Id;
1033 Func_Name : Node_Id;
1034 Func : Entity_Id;
1035 Parm_Type : Node_Id;
1036 Profile : List_Id := New_List;
1037 Spec : Node_Id;
1038 Act_F : Entity_Id;
1039 Form_F : Entity_Id;
1040 New_F : Entity_Id;
1042 begin
1043 -- If there is no actual, the formal has a default and is retrieved
1044 -- by name. Otherwise the wrapper encloses a call to the actual.
1046 if No (Actual) then
1047 Func_Name := Make_Identifier (Loc, Chars (Formal));
1048 else
1049 Func_Name := New_Occurrence_Of (Entity (Actual), Loc);
1050 end if;
1052 Func := Make_Defining_Identifier (Loc, Chars (Formal));
1053 Set_Ekind (Func, E_Function);
1054 Set_Is_Generic_Actual_Subprogram (Func);
1056 Actuals := New_List;
1057 Profile := New_List;
1059 if Present (Actual) then
1060 Act_F := First_Formal (Entity (Actual));
1061 else
1062 Act_F := Empty;
1063 end if;
1065 Form_F := First_Formal (Formal);
1066 while Present (Form_F) loop
1068 -- Create new formal for profile of wrapper, and add a reference
1069 -- to it in the list of actuals for the enclosing call. The name
1070 -- must be that of the formal in the formal subprogram, because
1071 -- calls to it in the generic body may use named associations.
1073 New_F := Make_Defining_Identifier (Loc, Chars (Form_F));
1075 if No (Actual) then
1077 -- If formal has a class-wide type rewrite as the corresponding
1078 -- attribute, because the class-wide type is not retrievable by
1079 -- visbility.
1081 if Is_Class_Wide_Type (Etype (Form_F)) then
1082 Parm_Type :=
1083 Make_Attribute_Reference (Loc,
1084 Attribute_Name => Name_Class,
1085 Prefix =>
1086 Make_Identifier (Loc, Chars (Etype (Etype (Form_F)))));
1088 else
1089 Parm_Type :=
1090 Make_Identifier (Loc, Chars (Etype (Etype (Form_F))));
1091 end if;
1093 -- If actual is present, use the type of its own formal
1095 else
1096 Parm_Type := New_Occurrence_Of (Etype (Act_F), Loc);
1097 end if;
1099 Append_To (Profile,
1100 Make_Parameter_Specification (Loc,
1101 Defining_Identifier => New_F,
1102 Parameter_Type => Parm_Type));
1104 Append_To (Actuals, New_Occurrence_Of (New_F, Loc));
1105 Next_Formal (Form_F);
1107 if Present (Act_F) then
1108 Next_Formal (Act_F);
1109 end if;
1110 end loop;
1112 Spec :=
1113 Make_Function_Specification (Loc,
1114 Defining_Unit_Name => Func,
1115 Parameter_Specifications => Profile,
1116 Result_Definition =>
1117 Make_Identifier (Loc, Chars (Etype (Formal))));
1119 Decl :=
1120 Make_Expression_Function (Loc,
1121 Specification => Spec,
1122 Expression =>
1123 Make_Function_Call (Loc,
1124 Name => Func_Name,
1125 Parameter_Associations => Actuals));
1127 return Decl;
1128 end Build_Function_Wrapper;
1130 ----------------------------
1131 -- Build_Operator_Wrapper --
1132 ----------------------------
1134 function Build_Operator_Wrapper
1135 (Formal : Entity_Id;
1136 Actual : Entity_Id := Empty) return Node_Id
1138 Loc : constant Source_Ptr := Sloc (I_Node);
1139 Typ : constant Entity_Id := Etype (Formal);
1140 Is_Binary : constant Boolean :=
1141 Present (Next_Formal (First_Formal (Formal)));
1143 Decl : Node_Id;
1144 Expr : Node_Id;
1145 F1, F2 : Entity_Id;
1146 Func : Entity_Id;
1147 Op_Name : Name_Id;
1148 Spec : Node_Id;
1149 L, R : Node_Id;
1151 begin
1152 if No (Actual) then
1153 Op_Name := Chars (Formal);
1154 else
1155 Op_Name := Chars (Actual);
1156 end if;
1158 -- Create entities for wrapper function and its formals
1160 F1 := Make_Temporary (Loc, 'A');
1161 F2 := Make_Temporary (Loc, 'B');
1162 L := New_Occurrence_Of (F1, Loc);
1163 R := New_Occurrence_Of (F2, Loc);
1165 Func := Make_Defining_Identifier (Loc, Chars (Formal));
1166 Set_Ekind (Func, E_Function);
1167 Set_Is_Generic_Actual_Subprogram (Func);
1169 Spec :=
1170 Make_Function_Specification (Loc,
1171 Defining_Unit_Name => Func,
1172 Parameter_Specifications => New_List (
1173 Make_Parameter_Specification (Loc,
1174 Defining_Identifier => F1,
1175 Parameter_Type =>
1176 Make_Identifier (Loc,
1177 Chars => Chars (Etype (First_Formal (Formal)))))),
1178 Result_Definition => Make_Identifier (Loc, Chars (Typ)));
1180 if Is_Binary then
1181 Append_To (Parameter_Specifications (Spec),
1182 Make_Parameter_Specification (Loc,
1183 Defining_Identifier => F2,
1184 Parameter_Type =>
1185 Make_Identifier (Loc,
1186 Chars (Etype (Next_Formal (First_Formal (Formal)))))));
1187 end if;
1189 -- Build expression as a function call, or as an operator node
1190 -- that corresponds to the name of the actual, starting with binary
1191 -- operators.
1193 if Present (Actual) and then Op_Name not in Any_Operator_Name then
1194 Expr :=
1195 Make_Function_Call (Loc,
1196 Name =>
1197 New_Occurrence_Of (Entity (Actual), Loc),
1198 Parameter_Associations => New_List (L));
1200 if Is_Binary then
1201 Append_To (Parameter_Associations (Expr), R);
1202 end if;
1204 -- Binary operators
1206 elsif Is_Binary then
1207 if Op_Name = Name_Op_And then
1208 Expr := Make_Op_And (Loc, Left_Opnd => L, Right_Opnd => R);
1209 elsif Op_Name = Name_Op_Or then
1210 Expr := Make_Op_Or (Loc, Left_Opnd => L, Right_Opnd => R);
1211 elsif Op_Name = Name_Op_Xor then
1212 Expr := Make_Op_Xor (Loc, Left_Opnd => L, Right_Opnd => R);
1213 elsif Op_Name = Name_Op_Eq then
1214 Expr := Make_Op_Eq (Loc, Left_Opnd => L, Right_Opnd => R);
1215 elsif Op_Name = Name_Op_Ne then
1216 Expr := Make_Op_Ne (Loc, Left_Opnd => L, Right_Opnd => R);
1217 elsif Op_Name = Name_Op_Le then
1218 Expr := Make_Op_Le (Loc, Left_Opnd => L, Right_Opnd => R);
1219 elsif Op_Name = Name_Op_Gt then
1220 Expr := Make_Op_Gt (Loc, Left_Opnd => L, Right_Opnd => R);
1221 elsif Op_Name = Name_Op_Ge then
1222 Expr := Make_Op_Ge (Loc, Left_Opnd => L, Right_Opnd => R);
1223 elsif Op_Name = Name_Op_Lt then
1224 Expr := Make_Op_Lt (Loc, Left_Opnd => L, Right_Opnd => R);
1225 elsif Op_Name = Name_Op_Add then
1226 Expr := Make_Op_Add (Loc, Left_Opnd => L, Right_Opnd => R);
1227 elsif Op_Name = Name_Op_Subtract then
1228 Expr := Make_Op_Subtract (Loc, Left_Opnd => L, Right_Opnd => R);
1229 elsif Op_Name = Name_Op_Concat then
1230 Expr := Make_Op_Concat (Loc, Left_Opnd => L, Right_Opnd => R);
1231 elsif Op_Name = Name_Op_Multiply then
1232 Expr := Make_Op_Multiply (Loc, Left_Opnd => L, Right_Opnd => R);
1233 elsif Op_Name = Name_Op_Divide then
1234 Expr := Make_Op_Divide (Loc, Left_Opnd => L, Right_Opnd => R);
1235 elsif Op_Name = Name_Op_Mod then
1236 Expr := Make_Op_Mod (Loc, Left_Opnd => L, Right_Opnd => R);
1237 elsif Op_Name = Name_Op_Rem then
1238 Expr := Make_Op_Rem (Loc, Left_Opnd => L, Right_Opnd => R);
1239 elsif Op_Name = Name_Op_Expon then
1240 Expr := Make_Op_Expon (Loc, Left_Opnd => L, Right_Opnd => R);
1241 end if;
1243 -- Unary operators
1245 else
1246 if Op_Name = Name_Op_Add then
1247 Expr := Make_Op_Plus (Loc, Right_Opnd => L);
1248 elsif Op_Name = Name_Op_Subtract then
1249 Expr := Make_Op_Minus (Loc, Right_Opnd => L);
1250 elsif Op_Name = Name_Op_Abs then
1251 Expr := Make_Op_Abs (Loc, Right_Opnd => L);
1252 elsif Op_Name = Name_Op_Not then
1253 Expr := Make_Op_Not (Loc, Right_Opnd => L);
1254 end if;
1255 end if;
1257 -- Propagate visible entity to operator node, either from a
1258 -- given actual or from a default.
1260 if Is_Entity_Name (Actual) and then Nkind (Expr) in N_Op then
1261 Set_Entity (Expr, Entity (Actual));
1262 end if;
1264 Decl :=
1265 Make_Expression_Function (Loc,
1266 Specification => Spec,
1267 Expression => Expr);
1269 return Decl;
1270 end Build_Operator_Wrapper;
1272 ----------------------------------------
1273 -- Check_Overloaded_Formal_Subprogram --
1274 ----------------------------------------
1276 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id) is
1277 Temp_Formal : Entity_Id;
1279 begin
1280 Temp_Formal := First (Formals);
1281 while Present (Temp_Formal) loop
1282 if Nkind (Temp_Formal) in N_Formal_Subprogram_Declaration
1283 and then Temp_Formal /= Formal
1284 and then
1285 Chars (Defining_Unit_Name (Specification (Formal))) =
1286 Chars (Defining_Unit_Name (Specification (Temp_Formal)))
1287 then
1288 if Present (Found_Assoc) then
1289 Error_Msg_N
1290 ("named association not allowed for overloaded formal",
1291 Found_Assoc);
1293 else
1294 Error_Msg_N
1295 ("named association not allowed for overloaded formal",
1296 Others_Choice);
1297 end if;
1299 Abandon_Instantiation (Instantiation_Node);
1300 end if;
1302 Next (Temp_Formal);
1303 end loop;
1304 end Check_Overloaded_Formal_Subprogram;
1306 -------------------------------
1307 -- Has_Fully_Defined_Profile --
1308 -------------------------------
1310 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean is
1311 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean;
1312 -- Determine whethet type Typ is fully defined
1314 ---------------------------
1315 -- Is_Fully_Defined_Type --
1316 ---------------------------
1318 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean is
1319 begin
1320 -- A private type without a full view is not fully defined
1322 if Is_Private_Type (Typ)
1323 and then No (Full_View (Typ))
1324 then
1325 return False;
1327 -- An incomplete type is never fully defined
1329 elsif Is_Incomplete_Type (Typ) then
1330 return False;
1332 -- All other types are fully defined
1334 else
1335 return True;
1336 end if;
1337 end Is_Fully_Defined_Type;
1339 -- Local declarations
1341 Param : Entity_Id;
1343 -- Start of processing for Has_Fully_Defined_Profile
1345 begin
1346 -- Check the parameters
1348 Param := First_Formal (Subp);
1349 while Present (Param) loop
1350 if not Is_Fully_Defined_Type (Etype (Param)) then
1351 return False;
1352 end if;
1354 Next_Formal (Param);
1355 end loop;
1357 -- Check the return type
1359 return Is_Fully_Defined_Type (Etype (Subp));
1360 end Has_Fully_Defined_Profile;
1362 ---------------------
1363 -- Matching_Actual --
1364 ---------------------
1366 function Matching_Actual
1367 (F : Entity_Id;
1368 A_F : Entity_Id) return Node_Id
1370 Prev : Node_Id;
1371 Act : Node_Id;
1373 begin
1374 Is_Named_Assoc := False;
1376 -- End of list of purely positional parameters
1378 if No (Actual) or else Nkind (Actual) = N_Others_Choice then
1379 Found_Assoc := Empty;
1380 Act := Empty;
1382 -- Case of positional parameter corresponding to current formal
1384 elsif No (Selector_Name (Actual)) then
1385 Found_Assoc := Actual;
1386 Act := Explicit_Generic_Actual_Parameter (Actual);
1387 Num_Matched := Num_Matched + 1;
1388 Next (Actual);
1390 -- Otherwise scan list of named actuals to find the one with the
1391 -- desired name. All remaining actuals have explicit names.
1393 else
1394 Is_Named_Assoc := True;
1395 Found_Assoc := Empty;
1396 Act := Empty;
1397 Prev := Empty;
1399 while Present (Actual) loop
1400 if Chars (Selector_Name (Actual)) = Chars (F) then
1401 Set_Entity (Selector_Name (Actual), A_F);
1402 Set_Etype (Selector_Name (Actual), Etype (A_F));
1403 Generate_Reference (A_F, Selector_Name (Actual));
1404 Found_Assoc := Actual;
1405 Act := Explicit_Generic_Actual_Parameter (Actual);
1406 Num_Matched := Num_Matched + 1;
1407 exit;
1408 end if;
1410 Prev := Actual;
1411 Next (Actual);
1412 end loop;
1414 -- Reset for subsequent searches. In most cases the named
1415 -- associations are in order. If they are not, we reorder them
1416 -- to avoid scanning twice the same actual. This is not just a
1417 -- question of efficiency: there may be multiple defaults with
1418 -- boxes that have the same name. In a nested instantiation we
1419 -- insert actuals for those defaults, and cannot rely on their
1420 -- names to disambiguate them.
1422 if Actual = First_Named then
1423 Next (First_Named);
1425 elsif Present (Actual) then
1426 Insert_Before (First_Named, Remove_Next (Prev));
1427 end if;
1429 Actual := First_Named;
1430 end if;
1432 if Is_Entity_Name (Act) and then Present (Entity (Act)) then
1433 Set_Used_As_Generic_Actual (Entity (Act));
1434 end if;
1436 return Act;
1437 end Matching_Actual;
1439 ------------------------------
1440 -- Partial_Parameterization --
1441 ------------------------------
1443 function Partial_Parameterization return Boolean is
1444 begin
1445 return Others_Present
1446 or else (Present (Found_Assoc) and then Box_Present (Found_Assoc));
1447 end Partial_Parameterization;
1449 ---------------------
1450 -- Process_Default --
1451 ---------------------
1453 procedure Process_Default (F : Entity_Id) is
1454 Loc : constant Source_Ptr := Sloc (I_Node);
1455 F_Id : constant Entity_Id := Defining_Entity (F);
1456 Decl : Node_Id;
1457 Default : Node_Id;
1458 Id : Entity_Id;
1460 begin
1461 -- Append copy of formal declaration to associations, and create new
1462 -- defining identifier for it.
1464 Decl := New_Copy_Tree (F);
1465 Id := Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id));
1467 if Nkind (F) in N_Formal_Subprogram_Declaration then
1468 Set_Defining_Unit_Name (Specification (Decl), Id);
1470 else
1471 Set_Defining_Identifier (Decl, Id);
1472 end if;
1474 Append (Decl, Assoc);
1476 if No (Found_Assoc) then
1477 Default :=
1478 Make_Generic_Association (Loc,
1479 Selector_Name => New_Occurrence_Of (Id, Loc),
1480 Explicit_Generic_Actual_Parameter => Empty);
1481 Set_Box_Present (Default);
1482 Append (Default, Default_Formals);
1483 end if;
1484 end Process_Default;
1486 ---------------------------------
1487 -- Renames_Standard_Subprogram --
1488 ---------------------------------
1490 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean is
1491 Id : Entity_Id;
1493 begin
1494 Id := Alias (Subp);
1495 while Present (Id) loop
1496 if Scope (Id) = Standard_Standard then
1497 return True;
1498 end if;
1500 Id := Alias (Id);
1501 end loop;
1503 return False;
1504 end Renames_Standard_Subprogram;
1506 -------------------------
1507 -- Set_Analyzed_Formal --
1508 -------------------------
1510 procedure Set_Analyzed_Formal is
1511 Kind : Node_Kind;
1513 begin
1514 while Present (Analyzed_Formal) loop
1515 Kind := Nkind (Analyzed_Formal);
1517 case Nkind (Formal) is
1519 when N_Formal_Subprogram_Declaration =>
1520 exit when Kind in N_Formal_Subprogram_Declaration
1521 and then
1522 Chars
1523 (Defining_Unit_Name (Specification (Formal))) =
1524 Chars
1525 (Defining_Unit_Name (Specification (Analyzed_Formal)));
1527 when N_Formal_Package_Declaration =>
1528 exit when Nkind_In (Kind, N_Formal_Package_Declaration,
1529 N_Generic_Package_Declaration,
1530 N_Package_Declaration);
1532 when N_Use_Package_Clause | N_Use_Type_Clause => exit;
1534 when others =>
1536 -- Skip freeze nodes, and nodes inserted to replace
1537 -- unrecognized pragmas.
1539 exit when
1540 Kind not in N_Formal_Subprogram_Declaration
1541 and then not Nkind_In (Kind, N_Subprogram_Declaration,
1542 N_Freeze_Entity,
1543 N_Null_Statement,
1544 N_Itype_Reference)
1545 and then Chars (Defining_Identifier (Formal)) =
1546 Chars (Defining_Identifier (Analyzed_Formal));
1547 end case;
1549 Next (Analyzed_Formal);
1550 end loop;
1551 end Set_Analyzed_Formal;
1553 -- Start of processing for Analyze_Associations
1555 begin
1556 Actuals := Generic_Associations (I_Node);
1558 if Present (Actuals) then
1560 -- Check for an Others choice, indicating a partial parameterization
1561 -- for a formal package.
1563 Actual := First (Actuals);
1564 while Present (Actual) loop
1565 if Nkind (Actual) = N_Others_Choice then
1566 Others_Present := True;
1567 Others_Choice := Actual;
1569 if Present (Next (Actual)) then
1570 Error_Msg_N ("others must be last association", Actual);
1571 end if;
1573 -- This subprogram is used both for formal packages and for
1574 -- instantiations. For the latter, associations must all be
1575 -- explicit.
1577 if Nkind (I_Node) /= N_Formal_Package_Declaration
1578 and then Comes_From_Source (I_Node)
1579 then
1580 Error_Msg_N
1581 ("others association not allowed in an instance",
1582 Actual);
1583 end if;
1585 -- In any case, nothing to do after the others association
1587 exit;
1589 elsif Box_Present (Actual)
1590 and then Comes_From_Source (I_Node)
1591 and then Nkind (I_Node) /= N_Formal_Package_Declaration
1592 then
1593 Error_Msg_N
1594 ("box association not allowed in an instance", Actual);
1595 end if;
1597 Next (Actual);
1598 end loop;
1600 -- If named associations are present, save first named association
1601 -- (it may of course be Empty) to facilitate subsequent name search.
1603 First_Named := First (Actuals);
1604 while Present (First_Named)
1605 and then Nkind (First_Named) /= N_Others_Choice
1606 and then No (Selector_Name (First_Named))
1607 loop
1608 Num_Actuals := Num_Actuals + 1;
1609 Next (First_Named);
1610 end loop;
1611 end if;
1613 Named := First_Named;
1614 while Present (Named) loop
1615 if Nkind (Named) /= N_Others_Choice
1616 and then No (Selector_Name (Named))
1617 then
1618 Error_Msg_N ("invalid positional actual after named one", Named);
1619 Abandon_Instantiation (Named);
1620 end if;
1622 -- A named association may lack an actual parameter, if it was
1623 -- introduced for a default subprogram that turns out to be local
1624 -- to the outer instantiation.
1626 if Nkind (Named) /= N_Others_Choice
1627 and then Present (Explicit_Generic_Actual_Parameter (Named))
1628 then
1629 Num_Actuals := Num_Actuals + 1;
1630 end if;
1632 Next (Named);
1633 end loop;
1635 if Present (Formals) then
1636 Formal := First_Non_Pragma (Formals);
1637 Analyzed_Formal := First_Non_Pragma (F_Copy);
1639 if Present (Actuals) then
1640 Actual := First (Actuals);
1642 -- All formals should have default values
1644 else
1645 Actual := Empty;
1646 end if;
1648 while Present (Formal) loop
1649 Set_Analyzed_Formal;
1650 Saved_Formal := Next_Non_Pragma (Formal);
1652 case Nkind (Formal) is
1653 when N_Formal_Object_Declaration =>
1654 Match :=
1655 Matching_Actual (
1656 Defining_Identifier (Formal),
1657 Defining_Identifier (Analyzed_Formal));
1659 if No (Match) and then Partial_Parameterization then
1660 Process_Default (Formal);
1661 else
1662 Append_List
1663 (Instantiate_Object (Formal, Match, Analyzed_Formal),
1664 Assoc);
1665 end if;
1667 -- If the object is a call to an expression function, this
1668 -- is a freezing point for it.
1670 if Is_Entity_Name (Match)
1671 and then Present (Entity (Match))
1672 and then Nkind
1673 (Original_Node (Unit_Declaration_Node (Entity (Match))))
1674 = N_Expression_Function
1675 then
1676 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1677 end if;
1679 when N_Formal_Type_Declaration =>
1680 Match :=
1681 Matching_Actual (
1682 Defining_Identifier (Formal),
1683 Defining_Identifier (Analyzed_Formal));
1685 if No (Match) then
1686 if Partial_Parameterization then
1687 Process_Default (Formal);
1689 else
1690 Error_Msg_Sloc := Sloc (Gen_Unit);
1691 Error_Msg_NE
1692 ("missing actual&",
1693 Instantiation_Node,
1694 Defining_Identifier (Formal));
1695 Error_Msg_NE ("\in instantiation of & declared#",
1696 Instantiation_Node, Gen_Unit);
1697 Abandon_Instantiation (Instantiation_Node);
1698 end if;
1700 else
1701 Analyze (Match);
1702 Append_List
1703 (Instantiate_Type
1704 (Formal, Match, Analyzed_Formal, Assoc),
1705 Assoc);
1707 -- An instantiation is a freeze point for the actuals,
1708 -- unless this is a rewritten formal package, or the
1709 -- formal is an Ada 2012 formal incomplete type.
1711 if Nkind (I_Node) = N_Formal_Package_Declaration
1712 or else
1713 (Ada_Version >= Ada_2012
1714 and then
1715 Ekind (Defining_Identifier (Analyzed_Formal)) =
1716 E_Incomplete_Type)
1717 then
1718 null;
1720 else
1721 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1722 end if;
1723 end if;
1725 -- A remote access-to-class-wide type is not a legal actual
1726 -- for a generic formal of an access type (E.2.2(17/2)).
1727 -- In GNAT an exception to this rule is introduced when
1728 -- the formal is marked as remote using implementation
1729 -- defined aspect/pragma Remote_Access_Type. In that case
1730 -- the actual must be remote as well.
1732 -- If the current instantiation is the construction of a
1733 -- local copy for a formal package the actuals may be
1734 -- defaulted, and there is no matching actual to check.
1736 if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1737 and then
1738 Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1739 N_Access_To_Object_Definition
1740 and then Present (Match)
1741 then
1742 declare
1743 Formal_Ent : constant Entity_Id :=
1744 Defining_Identifier (Analyzed_Formal);
1745 begin
1746 if Is_Remote_Access_To_Class_Wide_Type (Entity (Match))
1747 = Is_Remote_Types (Formal_Ent)
1748 then
1749 -- Remoteness of formal and actual match
1751 null;
1753 elsif Is_Remote_Types (Formal_Ent) then
1755 -- Remote formal, non-remote actual
1757 Error_Msg_NE
1758 ("actual for& must be remote", Match, Formal_Ent);
1760 else
1761 -- Non-remote formal, remote actual
1763 Error_Msg_NE
1764 ("actual for& may not be remote",
1765 Match, Formal_Ent);
1766 end if;
1767 end;
1768 end if;
1770 when N_Formal_Subprogram_Declaration =>
1771 Match :=
1772 Matching_Actual
1773 (Defining_Unit_Name (Specification (Formal)),
1774 Defining_Unit_Name (Specification (Analyzed_Formal)));
1776 -- If the formal subprogram has the same name as another
1777 -- formal subprogram of the generic, then a named
1778 -- association is illegal (12.3(9)). Exclude named
1779 -- associations that are generated for a nested instance.
1781 if Present (Match)
1782 and then Is_Named_Assoc
1783 and then Comes_From_Source (Found_Assoc)
1784 then
1785 Check_Overloaded_Formal_Subprogram (Formal);
1786 end if;
1788 -- If there is no corresponding actual, this may be case
1789 -- of partial parameterization, or else the formal has a
1790 -- default or a box.
1792 if No (Match) and then Partial_Parameterization then
1793 Process_Default (Formal);
1795 if Nkind (I_Node) = N_Formal_Package_Declaration then
1796 Check_Overloaded_Formal_Subprogram (Formal);
1797 end if;
1799 else
1800 if GNATprove_Mode
1801 and then Present
1802 (Containing_Package_With_Ext_Axioms
1803 (Defining_Entity (Analyzed_Formal)))
1804 and then Ekind (Defining_Entity (Analyzed_Formal)) =
1805 E_Function
1806 then
1807 -- If actual is an entity (function or operator),
1808 -- build wrapper for it.
1810 if Present (Match) then
1811 if Nkind (Match) = N_Operator_Symbol then
1813 -- If the name is a default, find its visible
1814 -- entity at the point of instantiation.
1816 if Is_Entity_Name (Match)
1817 and then No (Entity (Match))
1818 then
1819 Find_Direct_Name (Match);
1820 end if;
1822 Append_To
1823 (Assoc,
1824 Build_Operator_Wrapper
1825 (Defining_Entity (Analyzed_Formal), Match));
1827 else
1828 Append_To (Assoc,
1829 Build_Function_Wrapper
1830 (Defining_Entity (Analyzed_Formal), Match));
1831 end if;
1833 -- Ditto if formal is an operator with a default.
1835 elsif Box_Present (Formal)
1836 and then Nkind (Defining_Entity (Analyzed_Formal)) =
1837 N_Defining_Operator_Symbol
1838 then
1839 Append_To (Assoc,
1840 Build_Operator_Wrapper
1841 (Defining_Entity (Analyzed_Formal)));
1843 -- Otherwise create renaming declaration.
1845 else
1846 Append_To (Assoc,
1847 Build_Function_Wrapper
1848 (Defining_Entity (Analyzed_Formal)));
1849 end if;
1851 else
1852 Append_To (Assoc,
1853 Instantiate_Formal_Subprogram
1854 (Formal, Match, Analyzed_Formal));
1855 end if;
1857 -- An instantiation is a freeze point for the actuals,
1858 -- unless this is a rewritten formal package.
1860 if Nkind (I_Node) /= N_Formal_Package_Declaration
1861 and then Nkind (Match) = N_Identifier
1862 and then Is_Subprogram (Entity (Match))
1864 -- The actual subprogram may rename a routine defined
1865 -- in Standard. Avoid freezing such renamings because
1866 -- subprograms coming from Standard cannot be frozen.
1868 and then
1869 not Renames_Standard_Subprogram (Entity (Match))
1871 -- If the actual subprogram comes from a different
1872 -- unit, it is already frozen, either by a body in
1873 -- that unit or by the end of the declarative part
1874 -- of the unit. This check avoids the freezing of
1875 -- subprograms defined in Standard which are used
1876 -- as generic actuals.
1878 and then In_Same_Code_Unit (Entity (Match), I_Node)
1879 and then Has_Fully_Defined_Profile (Entity (Match))
1880 then
1881 -- Mark the subprogram as having a delayed freeze
1882 -- since this may be an out-of-order action.
1884 Set_Has_Delayed_Freeze (Entity (Match));
1885 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1886 end if;
1887 end if;
1889 -- If this is a nested generic, preserve default for later
1890 -- instantiations.
1892 if No (Match) and then Box_Present (Formal) then
1893 Append_Elmt
1894 (Defining_Unit_Name (Specification (Last (Assoc))),
1895 Default_Actuals);
1896 end if;
1898 when N_Formal_Package_Declaration =>
1899 Match :=
1900 Matching_Actual (
1901 Defining_Identifier (Formal),
1902 Defining_Identifier (Original_Node (Analyzed_Formal)));
1904 if No (Match) then
1905 if Partial_Parameterization then
1906 Process_Default (Formal);
1908 else
1909 Error_Msg_Sloc := Sloc (Gen_Unit);
1910 Error_Msg_NE
1911 ("missing actual&",
1912 Instantiation_Node, Defining_Identifier (Formal));
1913 Error_Msg_NE ("\in instantiation of & declared#",
1914 Instantiation_Node, Gen_Unit);
1916 Abandon_Instantiation (Instantiation_Node);
1917 end if;
1919 else
1920 Analyze (Match);
1921 Append_List
1922 (Instantiate_Formal_Package
1923 (Formal, Match, Analyzed_Formal),
1924 Assoc);
1925 end if;
1927 -- For use type and use package appearing in the generic part,
1928 -- we have already copied them, so we can just move them where
1929 -- they belong (we mustn't recopy them since this would mess up
1930 -- the Sloc values).
1932 when N_Use_Package_Clause |
1933 N_Use_Type_Clause =>
1934 if Nkind (Original_Node (I_Node)) =
1935 N_Formal_Package_Declaration
1936 then
1937 Append (New_Copy_Tree (Formal), Assoc);
1938 else
1939 Remove (Formal);
1940 Append (Formal, Assoc);
1941 end if;
1943 when others =>
1944 raise Program_Error;
1946 end case;
1948 Formal := Saved_Formal;
1949 Next_Non_Pragma (Analyzed_Formal);
1950 end loop;
1952 if Num_Actuals > Num_Matched then
1953 Error_Msg_Sloc := Sloc (Gen_Unit);
1955 if Present (Selector_Name (Actual)) then
1956 Error_Msg_NE
1957 ("unmatched actual&",
1958 Actual, Selector_Name (Actual));
1959 Error_Msg_NE ("\in instantiation of& declared#",
1960 Actual, Gen_Unit);
1961 else
1962 Error_Msg_NE
1963 ("unmatched actual in instantiation of& declared#",
1964 Actual, Gen_Unit);
1965 end if;
1966 end if;
1968 elsif Present (Actuals) then
1969 Error_Msg_N
1970 ("too many actuals in generic instantiation", Instantiation_Node);
1971 end if;
1973 -- An instantiation freezes all generic actuals. The only exceptions
1974 -- to this are incomplete types and subprograms which are not fully
1975 -- defined at the point of instantiation.
1977 declare
1978 Elmt : Elmt_Id := First_Elmt (Actuals_To_Freeze);
1979 begin
1980 while Present (Elmt) loop
1981 Freeze_Before (I_Node, Node (Elmt));
1982 Next_Elmt (Elmt);
1983 end loop;
1984 end;
1986 -- If there are default subprograms, normalize the tree by adding
1987 -- explicit associations for them. This is required if the instance
1988 -- appears within a generic.
1990 declare
1991 Elmt : Elmt_Id;
1992 Subp : Entity_Id;
1993 New_D : Node_Id;
1995 begin
1996 Elmt := First_Elmt (Default_Actuals);
1997 while Present (Elmt) loop
1998 if No (Actuals) then
1999 Actuals := New_List;
2000 Set_Generic_Associations (I_Node, Actuals);
2001 end if;
2003 Subp := Node (Elmt);
2004 New_D :=
2005 Make_Generic_Association (Sloc (Subp),
2006 Selector_Name => New_Occurrence_Of (Subp, Sloc (Subp)),
2007 Explicit_Generic_Actual_Parameter =>
2008 New_Occurrence_Of (Subp, Sloc (Subp)));
2009 Mark_Rewrite_Insertion (New_D);
2010 Append_To (Actuals, New_D);
2011 Next_Elmt (Elmt);
2012 end loop;
2013 end;
2015 -- If this is a formal package, normalize the parameter list by adding
2016 -- explicit box associations for the formals that are covered by an
2017 -- Others_Choice.
2019 if not Is_Empty_List (Default_Formals) then
2020 Append_List (Default_Formals, Formals);
2021 end if;
2023 return Assoc;
2024 end Analyze_Associations;
2026 -------------------------------
2027 -- Analyze_Formal_Array_Type --
2028 -------------------------------
2030 procedure Analyze_Formal_Array_Type
2031 (T : in out Entity_Id;
2032 Def : Node_Id)
2034 DSS : Node_Id;
2036 begin
2037 -- Treated like a non-generic array declaration, with additional
2038 -- semantic checks.
2040 Enter_Name (T);
2042 if Nkind (Def) = N_Constrained_Array_Definition then
2043 DSS := First (Discrete_Subtype_Definitions (Def));
2044 while Present (DSS) loop
2045 if Nkind_In (DSS, N_Subtype_Indication,
2046 N_Range,
2047 N_Attribute_Reference)
2048 then
2049 Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
2050 end if;
2052 Next (DSS);
2053 end loop;
2054 end if;
2056 Array_Type_Declaration (T, Def);
2057 Set_Is_Generic_Type (Base_Type (T));
2059 if Ekind (Component_Type (T)) = E_Incomplete_Type
2060 and then No (Full_View (Component_Type (T)))
2061 then
2062 Error_Msg_N ("premature usage of incomplete type", Def);
2064 -- Check that range constraint is not allowed on the component type
2065 -- of a generic formal array type (AARM 12.5.3(3))
2067 elsif Is_Internal (Component_Type (T))
2068 and then Present (Subtype_Indication (Component_Definition (Def)))
2069 and then Nkind (Original_Node
2070 (Subtype_Indication (Component_Definition (Def)))) =
2071 N_Subtype_Indication
2072 then
2073 Error_Msg_N
2074 ("in a formal, a subtype indication can only be "
2075 & "a subtype mark (RM 12.5.3(3))",
2076 Subtype_Indication (Component_Definition (Def)));
2077 end if;
2079 end Analyze_Formal_Array_Type;
2081 ---------------------------------------------
2082 -- Analyze_Formal_Decimal_Fixed_Point_Type --
2083 ---------------------------------------------
2085 -- As for other generic types, we create a valid type representation with
2086 -- legal but arbitrary attributes, whose values are never considered
2087 -- static. For all scalar types we introduce an anonymous base type, with
2088 -- the same attributes. We choose the corresponding integer type to be
2089 -- Standard_Integer.
2090 -- Here and in other similar routines, the Sloc of the generated internal
2091 -- type must be the same as the sloc of the defining identifier of the
2092 -- formal type declaration, to provide proper source navigation.
2094 procedure Analyze_Formal_Decimal_Fixed_Point_Type
2095 (T : Entity_Id;
2096 Def : Node_Id)
2098 Loc : constant Source_Ptr := Sloc (Def);
2100 Base : constant Entity_Id :=
2101 New_Internal_Entity
2102 (E_Decimal_Fixed_Point_Type,
2103 Current_Scope,
2104 Sloc (Defining_Identifier (Parent (Def))), 'G');
2106 Int_Base : constant Entity_Id := Standard_Integer;
2107 Delta_Val : constant Ureal := Ureal_1;
2108 Digs_Val : constant Uint := Uint_6;
2110 function Make_Dummy_Bound return Node_Id;
2111 -- Return a properly typed universal real literal to use as a bound
2113 ----------------------
2114 -- Make_Dummy_Bound --
2115 ----------------------
2117 function Make_Dummy_Bound return Node_Id is
2118 Bound : constant Node_Id := Make_Real_Literal (Loc, Ureal_1);
2119 begin
2120 Set_Etype (Bound, Universal_Real);
2121 return Bound;
2122 end Make_Dummy_Bound;
2124 -- Start of processing for Analyze_Formal_Decimal_Fixed_Point_Type
2126 begin
2127 Enter_Name (T);
2129 Set_Etype (Base, Base);
2130 Set_Size_Info (Base, Int_Base);
2131 Set_RM_Size (Base, RM_Size (Int_Base));
2132 Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
2133 Set_Digits_Value (Base, Digs_Val);
2134 Set_Delta_Value (Base, Delta_Val);
2135 Set_Small_Value (Base, Delta_Val);
2136 Set_Scalar_Range (Base,
2137 Make_Range (Loc,
2138 Low_Bound => Make_Dummy_Bound,
2139 High_Bound => Make_Dummy_Bound));
2141 Set_Is_Generic_Type (Base);
2142 Set_Parent (Base, Parent (Def));
2144 Set_Ekind (T, E_Decimal_Fixed_Point_Subtype);
2145 Set_Etype (T, Base);
2146 Set_Size_Info (T, Int_Base);
2147 Set_RM_Size (T, RM_Size (Int_Base));
2148 Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
2149 Set_Digits_Value (T, Digs_Val);
2150 Set_Delta_Value (T, Delta_Val);
2151 Set_Small_Value (T, Delta_Val);
2152 Set_Scalar_Range (T, Scalar_Range (Base));
2153 Set_Is_Constrained (T);
2155 Check_Restriction (No_Fixed_Point, Def);
2156 end Analyze_Formal_Decimal_Fixed_Point_Type;
2158 -------------------------------------------
2159 -- Analyze_Formal_Derived_Interface_Type --
2160 -------------------------------------------
2162 procedure Analyze_Formal_Derived_Interface_Type
2163 (N : Node_Id;
2164 T : Entity_Id;
2165 Def : Node_Id)
2167 Loc : constant Source_Ptr := Sloc (Def);
2169 begin
2170 -- Rewrite as a type declaration of a derived type. This ensures that
2171 -- the interface list and primitive operations are properly captured.
2173 Rewrite (N,
2174 Make_Full_Type_Declaration (Loc,
2175 Defining_Identifier => T,
2176 Type_Definition => Def));
2177 Analyze (N);
2178 Set_Is_Generic_Type (T);
2179 end Analyze_Formal_Derived_Interface_Type;
2181 ---------------------------------
2182 -- Analyze_Formal_Derived_Type --
2183 ---------------------------------
2185 procedure Analyze_Formal_Derived_Type
2186 (N : Node_Id;
2187 T : Entity_Id;
2188 Def : Node_Id)
2190 Loc : constant Source_Ptr := Sloc (Def);
2191 Unk_Disc : constant Boolean := Unknown_Discriminants_Present (N);
2192 New_N : Node_Id;
2194 begin
2195 Set_Is_Generic_Type (T);
2197 if Private_Present (Def) then
2198 New_N :=
2199 Make_Private_Extension_Declaration (Loc,
2200 Defining_Identifier => T,
2201 Discriminant_Specifications => Discriminant_Specifications (N),
2202 Unknown_Discriminants_Present => Unk_Disc,
2203 Subtype_Indication => Subtype_Mark (Def),
2204 Interface_List => Interface_List (Def));
2206 Set_Abstract_Present (New_N, Abstract_Present (Def));
2207 Set_Limited_Present (New_N, Limited_Present (Def));
2208 Set_Synchronized_Present (New_N, Synchronized_Present (Def));
2210 else
2211 New_N :=
2212 Make_Full_Type_Declaration (Loc,
2213 Defining_Identifier => T,
2214 Discriminant_Specifications =>
2215 Discriminant_Specifications (Parent (T)),
2216 Type_Definition =>
2217 Make_Derived_Type_Definition (Loc,
2218 Subtype_Indication => Subtype_Mark (Def)));
2220 Set_Abstract_Present
2221 (Type_Definition (New_N), Abstract_Present (Def));
2222 Set_Limited_Present
2223 (Type_Definition (New_N), Limited_Present (Def));
2224 end if;
2226 Rewrite (N, New_N);
2227 Analyze (N);
2229 if Unk_Disc then
2230 if not Is_Composite_Type (T) then
2231 Error_Msg_N
2232 ("unknown discriminants not allowed for elementary types", N);
2233 else
2234 Set_Has_Unknown_Discriminants (T);
2235 Set_Is_Constrained (T, False);
2236 end if;
2237 end if;
2239 -- If the parent type has a known size, so does the formal, which makes
2240 -- legal representation clauses that involve the formal.
2242 Set_Size_Known_At_Compile_Time
2243 (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
2244 end Analyze_Formal_Derived_Type;
2246 ----------------------------------
2247 -- Analyze_Formal_Discrete_Type --
2248 ----------------------------------
2250 -- The operations defined for a discrete types are those of an enumeration
2251 -- type. The size is set to an arbitrary value, for use in analyzing the
2252 -- generic unit.
2254 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
2255 Loc : constant Source_Ptr := Sloc (Def);
2256 Lo : Node_Id;
2257 Hi : Node_Id;
2259 Base : constant Entity_Id :=
2260 New_Internal_Entity
2261 (E_Floating_Point_Type, Current_Scope,
2262 Sloc (Defining_Identifier (Parent (Def))), 'G');
2264 begin
2265 Enter_Name (T);
2266 Set_Ekind (T, E_Enumeration_Subtype);
2267 Set_Etype (T, Base);
2268 Init_Size (T, 8);
2269 Init_Alignment (T);
2270 Set_Is_Generic_Type (T);
2271 Set_Is_Constrained (T);
2273 -- For semantic analysis, the bounds of the type must be set to some
2274 -- non-static value. The simplest is to create attribute nodes for those
2275 -- bounds, that refer to the type itself. These bounds are never
2276 -- analyzed but serve as place-holders.
2278 Lo :=
2279 Make_Attribute_Reference (Loc,
2280 Attribute_Name => Name_First,
2281 Prefix => New_Occurrence_Of (T, Loc));
2282 Set_Etype (Lo, T);
2284 Hi :=
2285 Make_Attribute_Reference (Loc,
2286 Attribute_Name => Name_Last,
2287 Prefix => New_Occurrence_Of (T, Loc));
2288 Set_Etype (Hi, T);
2290 Set_Scalar_Range (T,
2291 Make_Range (Loc,
2292 Low_Bound => Lo,
2293 High_Bound => Hi));
2295 Set_Ekind (Base, E_Enumeration_Type);
2296 Set_Etype (Base, Base);
2297 Init_Size (Base, 8);
2298 Init_Alignment (Base);
2299 Set_Is_Generic_Type (Base);
2300 Set_Scalar_Range (Base, Scalar_Range (T));
2301 Set_Parent (Base, Parent (Def));
2302 end Analyze_Formal_Discrete_Type;
2304 ----------------------------------
2305 -- Analyze_Formal_Floating_Type --
2306 ---------------------------------
2308 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
2309 Base : constant Entity_Id :=
2310 New_Internal_Entity
2311 (E_Floating_Point_Type, Current_Scope,
2312 Sloc (Defining_Identifier (Parent (Def))), 'G');
2314 begin
2315 -- The various semantic attributes are taken from the predefined type
2316 -- Float, just so that all of them are initialized. Their values are
2317 -- never used because no constant folding or expansion takes place in
2318 -- the generic itself.
2320 Enter_Name (T);
2321 Set_Ekind (T, E_Floating_Point_Subtype);
2322 Set_Etype (T, Base);
2323 Set_Size_Info (T, (Standard_Float));
2324 Set_RM_Size (T, RM_Size (Standard_Float));
2325 Set_Digits_Value (T, Digits_Value (Standard_Float));
2326 Set_Scalar_Range (T, Scalar_Range (Standard_Float));
2327 Set_Is_Constrained (T);
2329 Set_Is_Generic_Type (Base);
2330 Set_Etype (Base, Base);
2331 Set_Size_Info (Base, (Standard_Float));
2332 Set_RM_Size (Base, RM_Size (Standard_Float));
2333 Set_Digits_Value (Base, Digits_Value (Standard_Float));
2334 Set_Scalar_Range (Base, Scalar_Range (Standard_Float));
2335 Set_Parent (Base, Parent (Def));
2337 Check_Restriction (No_Floating_Point, Def);
2338 end Analyze_Formal_Floating_Type;
2340 -----------------------------------
2341 -- Analyze_Formal_Interface_Type;--
2342 -----------------------------------
2344 procedure Analyze_Formal_Interface_Type
2345 (N : Node_Id;
2346 T : Entity_Id;
2347 Def : Node_Id)
2349 Loc : constant Source_Ptr := Sloc (N);
2350 New_N : Node_Id;
2352 begin
2353 New_N :=
2354 Make_Full_Type_Declaration (Loc,
2355 Defining_Identifier => T,
2356 Type_Definition => Def);
2358 Rewrite (N, New_N);
2359 Analyze (N);
2360 Set_Is_Generic_Type (T);
2361 end Analyze_Formal_Interface_Type;
2363 ---------------------------------
2364 -- Analyze_Formal_Modular_Type --
2365 ---------------------------------
2367 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
2368 begin
2369 -- Apart from their entity kind, generic modular types are treated like
2370 -- signed integer types, and have the same attributes.
2372 Analyze_Formal_Signed_Integer_Type (T, Def);
2373 Set_Ekind (T, E_Modular_Integer_Subtype);
2374 Set_Ekind (Etype (T), E_Modular_Integer_Type);
2376 end Analyze_Formal_Modular_Type;
2378 ---------------------------------------
2379 -- Analyze_Formal_Object_Declaration --
2380 ---------------------------------------
2382 procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
2383 E : constant Node_Id := Default_Expression (N);
2384 Id : constant Node_Id := Defining_Identifier (N);
2385 K : Entity_Kind;
2386 T : Node_Id;
2388 begin
2389 Enter_Name (Id);
2391 -- Determine the mode of the formal object
2393 if Out_Present (N) then
2394 K := E_Generic_In_Out_Parameter;
2396 if not In_Present (N) then
2397 Error_Msg_N ("formal generic objects cannot have mode OUT", N);
2398 end if;
2400 else
2401 K := E_Generic_In_Parameter;
2402 end if;
2404 if Present (Subtype_Mark (N)) then
2405 Find_Type (Subtype_Mark (N));
2406 T := Entity (Subtype_Mark (N));
2408 -- Verify that there is no redundant null exclusion
2410 if Null_Exclusion_Present (N) then
2411 if not Is_Access_Type (T) then
2412 Error_Msg_N
2413 ("null exclusion can only apply to an access type", N);
2415 elsif Can_Never_Be_Null (T) then
2416 Error_Msg_NE
2417 ("`NOT NULL` not allowed (& already excludes null)",
2418 N, T);
2419 end if;
2420 end if;
2422 -- Ada 2005 (AI-423): Formal object with an access definition
2424 else
2425 Check_Access_Definition (N);
2426 T := Access_Definition
2427 (Related_Nod => N,
2428 N => Access_Definition (N));
2429 end if;
2431 if Ekind (T) = E_Incomplete_Type then
2432 declare
2433 Error_Node : Node_Id;
2435 begin
2436 if Present (Subtype_Mark (N)) then
2437 Error_Node := Subtype_Mark (N);
2438 else
2439 Check_Access_Definition (N);
2440 Error_Node := Access_Definition (N);
2441 end if;
2443 Error_Msg_N ("premature usage of incomplete type", Error_Node);
2444 end;
2445 end if;
2447 if K = E_Generic_In_Parameter then
2449 -- Ada 2005 (AI-287): Limited aggregates allowed in generic formals
2451 if Ada_Version < Ada_2005 and then Is_Limited_Type (T) then
2452 Error_Msg_N
2453 ("generic formal of mode IN must not be of limited type", N);
2454 Explain_Limited_Type (T, N);
2455 end if;
2457 if Is_Abstract_Type (T) then
2458 Error_Msg_N
2459 ("generic formal of mode IN must not be of abstract type", N);
2460 end if;
2462 if Present (E) then
2463 Preanalyze_Spec_Expression (E, T);
2465 if Is_Limited_Type (T) and then not OK_For_Limited_Init (T, E) then
2466 Error_Msg_N
2467 ("initialization not allowed for limited types", E);
2468 Explain_Limited_Type (T, E);
2469 end if;
2470 end if;
2472 Set_Ekind (Id, K);
2473 Set_Etype (Id, T);
2475 -- Case of generic IN OUT parameter
2477 else
2478 -- If the formal has an unconstrained type, construct its actual
2479 -- subtype, as is done for subprogram formals. In this fashion, all
2480 -- its uses can refer to specific bounds.
2482 Set_Ekind (Id, K);
2483 Set_Etype (Id, T);
2485 if (Is_Array_Type (T) and then not Is_Constrained (T))
2486 or else (Ekind (T) = E_Record_Type and then Has_Discriminants (T))
2487 then
2488 declare
2489 Non_Freezing_Ref : constant Node_Id :=
2490 New_Occurrence_Of (Id, Sloc (Id));
2491 Decl : Node_Id;
2493 begin
2494 -- Make sure the actual subtype doesn't generate bogus freezing
2496 Set_Must_Not_Freeze (Non_Freezing_Ref);
2497 Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
2498 Insert_Before_And_Analyze (N, Decl);
2499 Set_Actual_Subtype (Id, Defining_Identifier (Decl));
2500 end;
2501 else
2502 Set_Actual_Subtype (Id, T);
2503 end if;
2505 if Present (E) then
2506 Error_Msg_N
2507 ("initialization not allowed for `IN OUT` formals", N);
2508 end if;
2509 end if;
2511 if Has_Aspects (N) then
2512 Analyze_Aspect_Specifications (N, Id);
2513 end if;
2514 end Analyze_Formal_Object_Declaration;
2516 ----------------------------------------------
2517 -- Analyze_Formal_Ordinary_Fixed_Point_Type --
2518 ----------------------------------------------
2520 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
2521 (T : Entity_Id;
2522 Def : Node_Id)
2524 Loc : constant Source_Ptr := Sloc (Def);
2525 Base : constant Entity_Id :=
2526 New_Internal_Entity
2527 (E_Ordinary_Fixed_Point_Type, Current_Scope,
2528 Sloc (Defining_Identifier (Parent (Def))), 'G');
2530 begin
2531 -- The semantic attributes are set for completeness only, their values
2532 -- will never be used, since all properties of the type are non-static.
2534 Enter_Name (T);
2535 Set_Ekind (T, E_Ordinary_Fixed_Point_Subtype);
2536 Set_Etype (T, Base);
2537 Set_Size_Info (T, Standard_Integer);
2538 Set_RM_Size (T, RM_Size (Standard_Integer));
2539 Set_Small_Value (T, Ureal_1);
2540 Set_Delta_Value (T, Ureal_1);
2541 Set_Scalar_Range (T,
2542 Make_Range (Loc,
2543 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
2544 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
2545 Set_Is_Constrained (T);
2547 Set_Is_Generic_Type (Base);
2548 Set_Etype (Base, Base);
2549 Set_Size_Info (Base, Standard_Integer);
2550 Set_RM_Size (Base, RM_Size (Standard_Integer));
2551 Set_Small_Value (Base, Ureal_1);
2552 Set_Delta_Value (Base, Ureal_1);
2553 Set_Scalar_Range (Base, Scalar_Range (T));
2554 Set_Parent (Base, Parent (Def));
2556 Check_Restriction (No_Fixed_Point, Def);
2557 end Analyze_Formal_Ordinary_Fixed_Point_Type;
2559 ----------------------------------------
2560 -- Analyze_Formal_Package_Declaration --
2561 ----------------------------------------
2563 procedure Analyze_Formal_Package_Declaration (N : Node_Id) is
2564 Loc : constant Source_Ptr := Sloc (N);
2565 Pack_Id : constant Entity_Id := Defining_Identifier (N);
2566 Formal : Entity_Id;
2567 Gen_Id : constant Node_Id := Name (N);
2568 Gen_Decl : Node_Id;
2569 Gen_Unit : Entity_Id;
2570 New_N : Node_Id;
2571 Parent_Installed : Boolean := False;
2572 Renaming : Node_Id;
2573 Parent_Instance : Entity_Id;
2574 Renaming_In_Par : Entity_Id;
2575 Associations : Boolean := True;
2577 Vis_Prims_List : Elist_Id := No_Elist;
2578 -- List of primitives made temporarily visible in the instantiation
2579 -- to match the visibility of the formal type
2581 function Build_Local_Package return Node_Id;
2582 -- The formal package is rewritten so that its parameters are replaced
2583 -- with corresponding declarations. For parameters with bona fide
2584 -- associations these declarations are created by Analyze_Associations
2585 -- as for a regular instantiation. For boxed parameters, we preserve
2586 -- the formal declarations and analyze them, in order to introduce
2587 -- entities of the right kind in the environment of the formal.
2589 -------------------------
2590 -- Build_Local_Package --
2591 -------------------------
2593 function Build_Local_Package return Node_Id is
2594 Decls : List_Id;
2595 Pack_Decl : Node_Id;
2597 begin
2598 -- Within the formal, the name of the generic package is a renaming
2599 -- of the formal (as for a regular instantiation).
2601 Pack_Decl :=
2602 Make_Package_Declaration (Loc,
2603 Specification =>
2604 Copy_Generic_Node
2605 (Specification (Original_Node (Gen_Decl)),
2606 Empty, Instantiating => True));
2608 Renaming := Make_Package_Renaming_Declaration (Loc,
2609 Defining_Unit_Name =>
2610 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2611 Name => New_Occurrence_Of (Formal, Loc));
2613 if Nkind (Gen_Id) = N_Identifier
2614 and then Chars (Gen_Id) = Chars (Pack_Id)
2615 then
2616 Error_Msg_NE
2617 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2618 end if;
2620 -- If the formal is declared with a box, or with an others choice,
2621 -- create corresponding declarations for all entities in the formal
2622 -- part, so that names with the proper types are available in the
2623 -- specification of the formal package.
2625 -- On the other hand, if there are no associations, then all the
2626 -- formals must have defaults, and this will be checked by the
2627 -- call to Analyze_Associations.
2629 if Box_Present (N)
2630 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2631 then
2632 declare
2633 Formal_Decl : Node_Id;
2635 begin
2636 -- TBA : for a formal package, need to recurse ???
2638 Decls := New_List;
2639 Formal_Decl :=
2640 First
2641 (Generic_Formal_Declarations (Original_Node (Gen_Decl)));
2642 while Present (Formal_Decl) loop
2643 Append_To
2644 (Decls, Copy_Generic_Node (Formal_Decl, Empty, True));
2645 Next (Formal_Decl);
2646 end loop;
2647 end;
2649 -- If generic associations are present, use Analyze_Associations to
2650 -- create the proper renaming declarations.
2652 else
2653 declare
2654 Act_Tree : constant Node_Id :=
2655 Copy_Generic_Node
2656 (Original_Node (Gen_Decl), Empty,
2657 Instantiating => True);
2659 begin
2660 Generic_Renamings.Set_Last (0);
2661 Generic_Renamings_HTable.Reset;
2662 Instantiation_Node := N;
2664 Decls :=
2665 Analyze_Associations
2666 (I_Node => Original_Node (N),
2667 Formals => Generic_Formal_Declarations (Act_Tree),
2668 F_Copy => Generic_Formal_Declarations (Gen_Decl));
2670 Vis_Prims_List := Check_Hidden_Primitives (Decls);
2671 end;
2672 end if;
2674 Append (Renaming, To => Decls);
2676 -- Add generated declarations ahead of local declarations in
2677 -- the package.
2679 if No (Visible_Declarations (Specification (Pack_Decl))) then
2680 Set_Visible_Declarations (Specification (Pack_Decl), Decls);
2681 else
2682 Insert_List_Before
2683 (First (Visible_Declarations (Specification (Pack_Decl))),
2684 Decls);
2685 end if;
2687 return Pack_Decl;
2688 end Build_Local_Package;
2690 -- Start of processing for Analyze_Formal_Package_Declaration
2692 begin
2693 Check_Text_IO_Special_Unit (Gen_Id);
2695 Init_Env;
2696 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2697 Gen_Unit := Entity (Gen_Id);
2699 -- Check for a formal package that is a package renaming
2701 if Present (Renamed_Object (Gen_Unit)) then
2703 -- Indicate that unit is used, before replacing it with renamed
2704 -- entity for use below.
2706 if In_Extended_Main_Source_Unit (N) then
2707 Set_Is_Instantiated (Gen_Unit);
2708 Generate_Reference (Gen_Unit, N);
2709 end if;
2711 Gen_Unit := Renamed_Object (Gen_Unit);
2712 end if;
2714 if Ekind (Gen_Unit) /= E_Generic_Package then
2715 Error_Msg_N ("expect generic package name", Gen_Id);
2716 Restore_Env;
2717 goto Leave;
2719 elsif Gen_Unit = Current_Scope then
2720 Error_Msg_N
2721 ("generic package cannot be used as a formal package of itself",
2722 Gen_Id);
2723 Restore_Env;
2724 goto Leave;
2726 elsif In_Open_Scopes (Gen_Unit) then
2727 if Is_Compilation_Unit (Gen_Unit)
2728 and then Is_Child_Unit (Current_Scope)
2729 then
2730 -- Special-case the error when the formal is a parent, and
2731 -- continue analysis to minimize cascaded errors.
2733 Error_Msg_N
2734 ("generic parent cannot be used as formal package "
2735 & "of a child unit",
2736 Gen_Id);
2738 else
2739 Error_Msg_N
2740 ("generic package cannot be used as a formal package "
2741 & "within itself",
2742 Gen_Id);
2743 Restore_Env;
2744 goto Leave;
2745 end if;
2746 end if;
2748 -- Check that name of formal package does not hide name of generic,
2749 -- or its leading prefix. This check must be done separately because
2750 -- the name of the generic has already been analyzed.
2752 declare
2753 Gen_Name : Entity_Id;
2755 begin
2756 Gen_Name := Gen_Id;
2757 while Nkind (Gen_Name) = N_Expanded_Name loop
2758 Gen_Name := Prefix (Gen_Name);
2759 end loop;
2761 if Chars (Gen_Name) = Chars (Pack_Id) then
2762 Error_Msg_NE
2763 ("& is hidden within declaration of formal package",
2764 Gen_Id, Gen_Name);
2765 end if;
2766 end;
2768 if Box_Present (N)
2769 or else No (Generic_Associations (N))
2770 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2771 then
2772 Associations := False;
2773 end if;
2775 -- If there are no generic associations, the generic parameters appear
2776 -- as local entities and are instantiated like them. We copy the generic
2777 -- package declaration as if it were an instantiation, and analyze it
2778 -- like a regular package, except that we treat the formals as
2779 -- additional visible components.
2781 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2783 if In_Extended_Main_Source_Unit (N) then
2784 Set_Is_Instantiated (Gen_Unit);
2785 Generate_Reference (Gen_Unit, N);
2786 end if;
2788 Formal := New_Copy (Pack_Id);
2789 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2791 begin
2792 -- Make local generic without formals. The formals will be replaced
2793 -- with internal declarations.
2795 New_N := Build_Local_Package;
2797 -- If there are errors in the parameter list, Analyze_Associations
2798 -- raises Instantiation_Error. Patch the declaration to prevent
2799 -- further exception propagation.
2801 exception
2802 when Instantiation_Error =>
2804 Enter_Name (Formal);
2805 Set_Ekind (Formal, E_Variable);
2806 Set_Etype (Formal, Any_Type);
2807 Restore_Hidden_Primitives (Vis_Prims_List);
2809 if Parent_Installed then
2810 Remove_Parent;
2811 end if;
2813 goto Leave;
2814 end;
2816 Rewrite (N, New_N);
2817 Set_Defining_Unit_Name (Specification (New_N), Formal);
2818 Set_Generic_Parent (Specification (N), Gen_Unit);
2819 Set_Instance_Env (Gen_Unit, Formal);
2820 Set_Is_Generic_Instance (Formal);
2822 Enter_Name (Formal);
2823 Set_Ekind (Formal, E_Package);
2824 Set_Etype (Formal, Standard_Void_Type);
2825 Set_Inner_Instances (Formal, New_Elmt_List);
2826 Push_Scope (Formal);
2828 if Is_Child_Unit (Gen_Unit)
2829 and then Parent_Installed
2830 then
2831 -- Similarly, we have to make the name of the formal visible in the
2832 -- parent instance, to resolve properly fully qualified names that
2833 -- may appear in the generic unit. The parent instance has been
2834 -- placed on the scope stack ahead of the current scope.
2836 Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
2838 Renaming_In_Par :=
2839 Make_Defining_Identifier (Loc, Chars (Gen_Unit));
2840 Set_Ekind (Renaming_In_Par, E_Package);
2841 Set_Etype (Renaming_In_Par, Standard_Void_Type);
2842 Set_Scope (Renaming_In_Par, Parent_Instance);
2843 Set_Parent (Renaming_In_Par, Parent (Formal));
2844 Set_Renamed_Object (Renaming_In_Par, Formal);
2845 Append_Entity (Renaming_In_Par, Parent_Instance);
2846 end if;
2848 Analyze (Specification (N));
2850 -- The formals for which associations are provided are not visible
2851 -- outside of the formal package. The others are still declared by a
2852 -- formal parameter declaration.
2854 -- If there are no associations, the only local entity to hide is the
2855 -- generated package renaming itself.
2857 declare
2858 E : Entity_Id;
2860 begin
2861 E := First_Entity (Formal);
2862 while Present (E) loop
2863 if Associations
2864 and then not Is_Generic_Formal (E)
2865 then
2866 Set_Is_Hidden (E);
2867 end if;
2869 if Ekind (E) = E_Package
2870 and then Renamed_Entity (E) = Formal
2871 then
2872 Set_Is_Hidden (E);
2873 exit;
2874 end if;
2876 Next_Entity (E);
2877 end loop;
2878 end;
2880 End_Package_Scope (Formal);
2881 Restore_Hidden_Primitives (Vis_Prims_List);
2883 if Parent_Installed then
2884 Remove_Parent;
2885 end if;
2887 Restore_Env;
2889 -- Inside the generic unit, the formal package is a regular package, but
2890 -- no body is needed for it. Note that after instantiation, the defining
2891 -- unit name we need is in the new tree and not in the original (see
2892 -- Package_Instantiation). A generic formal package is an instance, and
2893 -- can be used as an actual for an inner instance.
2895 Set_Has_Completion (Formal, True);
2897 -- Add semantic information to the original defining identifier.
2898 -- for ASIS use.
2900 Set_Ekind (Pack_Id, E_Package);
2901 Set_Etype (Pack_Id, Standard_Void_Type);
2902 Set_Scope (Pack_Id, Scope (Formal));
2903 Set_Has_Completion (Pack_Id, True);
2905 <<Leave>>
2906 if Has_Aspects (N) then
2907 Analyze_Aspect_Specifications (N, Pack_Id);
2908 end if;
2909 end Analyze_Formal_Package_Declaration;
2911 ---------------------------------
2912 -- Analyze_Formal_Private_Type --
2913 ---------------------------------
2915 procedure Analyze_Formal_Private_Type
2916 (N : Node_Id;
2917 T : Entity_Id;
2918 Def : Node_Id)
2920 begin
2921 New_Private_Type (N, T, Def);
2923 -- Set the size to an arbitrary but legal value
2925 Set_Size_Info (T, Standard_Integer);
2926 Set_RM_Size (T, RM_Size (Standard_Integer));
2927 end Analyze_Formal_Private_Type;
2929 ------------------------------------
2930 -- Analyze_Formal_Incomplete_Type --
2931 ------------------------------------
2933 procedure Analyze_Formal_Incomplete_Type
2934 (T : Entity_Id;
2935 Def : Node_Id)
2937 begin
2938 Enter_Name (T);
2939 Set_Ekind (T, E_Incomplete_Type);
2940 Set_Etype (T, T);
2941 Set_Private_Dependents (T, New_Elmt_List);
2943 if Tagged_Present (Def) then
2944 Set_Is_Tagged_Type (T);
2945 Make_Class_Wide_Type (T);
2946 Set_Direct_Primitive_Operations (T, New_Elmt_List);
2947 end if;
2948 end Analyze_Formal_Incomplete_Type;
2950 ----------------------------------------
2951 -- Analyze_Formal_Signed_Integer_Type --
2952 ----------------------------------------
2954 procedure Analyze_Formal_Signed_Integer_Type
2955 (T : Entity_Id;
2956 Def : Node_Id)
2958 Base : constant Entity_Id :=
2959 New_Internal_Entity
2960 (E_Signed_Integer_Type,
2961 Current_Scope,
2962 Sloc (Defining_Identifier (Parent (Def))), 'G');
2964 begin
2965 Enter_Name (T);
2967 Set_Ekind (T, E_Signed_Integer_Subtype);
2968 Set_Etype (T, Base);
2969 Set_Size_Info (T, Standard_Integer);
2970 Set_RM_Size (T, RM_Size (Standard_Integer));
2971 Set_Scalar_Range (T, Scalar_Range (Standard_Integer));
2972 Set_Is_Constrained (T);
2974 Set_Is_Generic_Type (Base);
2975 Set_Size_Info (Base, Standard_Integer);
2976 Set_RM_Size (Base, RM_Size (Standard_Integer));
2977 Set_Etype (Base, Base);
2978 Set_Scalar_Range (Base, Scalar_Range (Standard_Integer));
2979 Set_Parent (Base, Parent (Def));
2980 end Analyze_Formal_Signed_Integer_Type;
2982 -------------------------------------------
2983 -- Analyze_Formal_Subprogram_Declaration --
2984 -------------------------------------------
2986 procedure Analyze_Formal_Subprogram_Declaration (N : Node_Id) is
2987 Spec : constant Node_Id := Specification (N);
2988 Def : constant Node_Id := Default_Name (N);
2989 Nam : constant Entity_Id := Defining_Unit_Name (Spec);
2990 Subp : Entity_Id;
2992 begin
2993 if Nam = Error then
2994 return;
2995 end if;
2997 if Nkind (Nam) = N_Defining_Program_Unit_Name then
2998 Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
2999 goto Leave;
3000 end if;
3002 Analyze_Subprogram_Declaration (N);
3003 Set_Is_Formal_Subprogram (Nam);
3004 Set_Has_Completion (Nam);
3006 if Nkind (N) = N_Formal_Abstract_Subprogram_Declaration then
3007 Set_Is_Abstract_Subprogram (Nam);
3008 Set_Is_Dispatching_Operation (Nam);
3010 declare
3011 Ctrl_Type : constant Entity_Id := Find_Dispatching_Type (Nam);
3012 begin
3013 if No (Ctrl_Type) then
3014 Error_Msg_N
3015 ("abstract formal subprogram must have a controlling type",
3018 elsif Ada_Version >= Ada_2012
3019 and then Is_Incomplete_Type (Ctrl_Type)
3020 then
3021 Error_Msg_NE
3022 ("controlling type of abstract formal subprogram cannot " &
3023 "be incomplete type", N, Ctrl_Type);
3025 else
3026 Check_Controlling_Formals (Ctrl_Type, Nam);
3027 end if;
3028 end;
3029 end if;
3031 -- Default name is resolved at the point of instantiation
3033 if Box_Present (N) then
3034 null;
3036 -- Else default is bound at the point of generic declaration
3038 elsif Present (Def) then
3039 if Nkind (Def) = N_Operator_Symbol then
3040 Find_Direct_Name (Def);
3042 elsif Nkind (Def) /= N_Attribute_Reference then
3043 Analyze (Def);
3045 else
3046 -- For an attribute reference, analyze the prefix and verify
3047 -- that it has the proper profile for the subprogram.
3049 Analyze (Prefix (Def));
3050 Valid_Default_Attribute (Nam, Def);
3051 goto Leave;
3052 end if;
3054 -- Default name may be overloaded, in which case the interpretation
3055 -- with the correct profile must be selected, as for a renaming.
3056 -- If the definition is an indexed component, it must denote a
3057 -- member of an entry family. If it is a selected component, it
3058 -- can be a protected operation.
3060 if Etype (Def) = Any_Type then
3061 goto Leave;
3063 elsif Nkind (Def) = N_Selected_Component then
3064 if not Is_Overloadable (Entity (Selector_Name (Def))) then
3065 Error_Msg_N ("expect valid subprogram name as default", Def);
3066 end if;
3068 elsif Nkind (Def) = N_Indexed_Component then
3069 if Is_Entity_Name (Prefix (Def)) then
3070 if Ekind (Entity (Prefix (Def))) /= E_Entry_Family then
3071 Error_Msg_N ("expect valid subprogram name as default", Def);
3072 end if;
3074 elsif Nkind (Prefix (Def)) = N_Selected_Component then
3075 if Ekind (Entity (Selector_Name (Prefix (Def)))) /=
3076 E_Entry_Family
3077 then
3078 Error_Msg_N ("expect valid subprogram name as default", Def);
3079 end if;
3081 else
3082 Error_Msg_N ("expect valid subprogram name as default", Def);
3083 goto Leave;
3084 end if;
3086 elsif Nkind (Def) = N_Character_Literal then
3088 -- Needs some type checks: subprogram should be parameterless???
3090 Resolve (Def, (Etype (Nam)));
3092 elsif not Is_Entity_Name (Def)
3093 or else not Is_Overloadable (Entity (Def))
3094 then
3095 Error_Msg_N ("expect valid subprogram name as default", Def);
3096 goto Leave;
3098 elsif not Is_Overloaded (Def) then
3099 Subp := Entity (Def);
3101 if Subp = Nam then
3102 Error_Msg_N ("premature usage of formal subprogram", Def);
3104 elsif not Entity_Matches_Spec (Subp, Nam) then
3105 Error_Msg_N ("no visible entity matches specification", Def);
3106 end if;
3108 -- More than one interpretation, so disambiguate as for a renaming
3110 else
3111 declare
3112 I : Interp_Index;
3113 I1 : Interp_Index := 0;
3114 It : Interp;
3115 It1 : Interp;
3117 begin
3118 Subp := Any_Id;
3119 Get_First_Interp (Def, I, It);
3120 while Present (It.Nam) loop
3121 if Entity_Matches_Spec (It.Nam, Nam) then
3122 if Subp /= Any_Id then
3123 It1 := Disambiguate (Def, I1, I, Etype (Subp));
3125 if It1 = No_Interp then
3126 Error_Msg_N ("ambiguous default subprogram", Def);
3127 else
3128 Subp := It1.Nam;
3129 end if;
3131 exit;
3133 else
3134 I1 := I;
3135 Subp := It.Nam;
3136 end if;
3137 end if;
3139 Get_Next_Interp (I, It);
3140 end loop;
3141 end;
3143 if Subp /= Any_Id then
3145 -- Subprogram found, generate reference to it
3147 Set_Entity (Def, Subp);
3148 Generate_Reference (Subp, Def);
3150 if Subp = Nam then
3151 Error_Msg_N ("premature usage of formal subprogram", Def);
3153 elsif Ekind (Subp) /= E_Operator then
3154 Check_Mode_Conformant (Subp, Nam);
3155 end if;
3157 else
3158 Error_Msg_N ("no visible subprogram matches specification", N);
3159 end if;
3160 end if;
3161 end if;
3163 <<Leave>>
3164 if Has_Aspects (N) then
3165 Analyze_Aspect_Specifications (N, Nam);
3166 end if;
3168 end Analyze_Formal_Subprogram_Declaration;
3170 -------------------------------------
3171 -- Analyze_Formal_Type_Declaration --
3172 -------------------------------------
3174 procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
3175 Def : constant Node_Id := Formal_Type_Definition (N);
3176 T : Entity_Id;
3178 begin
3179 T := Defining_Identifier (N);
3181 if Present (Discriminant_Specifications (N))
3182 and then Nkind (Def) /= N_Formal_Private_Type_Definition
3183 then
3184 Error_Msg_N
3185 ("discriminants not allowed for this formal type", T);
3186 end if;
3188 -- Enter the new name, and branch to specific routine
3190 case Nkind (Def) is
3191 when N_Formal_Private_Type_Definition =>
3192 Analyze_Formal_Private_Type (N, T, Def);
3194 when N_Formal_Derived_Type_Definition =>
3195 Analyze_Formal_Derived_Type (N, T, Def);
3197 when N_Formal_Incomplete_Type_Definition =>
3198 Analyze_Formal_Incomplete_Type (T, Def);
3200 when N_Formal_Discrete_Type_Definition =>
3201 Analyze_Formal_Discrete_Type (T, Def);
3203 when N_Formal_Signed_Integer_Type_Definition =>
3204 Analyze_Formal_Signed_Integer_Type (T, Def);
3206 when N_Formal_Modular_Type_Definition =>
3207 Analyze_Formal_Modular_Type (T, Def);
3209 when N_Formal_Floating_Point_Definition =>
3210 Analyze_Formal_Floating_Type (T, Def);
3212 when N_Formal_Ordinary_Fixed_Point_Definition =>
3213 Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
3215 when N_Formal_Decimal_Fixed_Point_Definition =>
3216 Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
3218 when N_Array_Type_Definition =>
3219 Analyze_Formal_Array_Type (T, Def);
3221 when N_Access_To_Object_Definition |
3222 N_Access_Function_Definition |
3223 N_Access_Procedure_Definition =>
3224 Analyze_Generic_Access_Type (T, Def);
3226 -- Ada 2005: a interface declaration is encoded as an abstract
3227 -- record declaration or a abstract type derivation.
3229 when N_Record_Definition =>
3230 Analyze_Formal_Interface_Type (N, T, Def);
3232 when N_Derived_Type_Definition =>
3233 Analyze_Formal_Derived_Interface_Type (N, T, Def);
3235 when N_Error =>
3236 null;
3238 when others =>
3239 raise Program_Error;
3241 end case;
3243 Set_Is_Generic_Type (T);
3245 if Has_Aspects (N) then
3246 Analyze_Aspect_Specifications (N, T);
3247 end if;
3248 end Analyze_Formal_Type_Declaration;
3250 ------------------------------------
3251 -- Analyze_Function_Instantiation --
3252 ------------------------------------
3254 procedure Analyze_Function_Instantiation (N : Node_Id) is
3255 begin
3256 Analyze_Subprogram_Instantiation (N, E_Function);
3257 end Analyze_Function_Instantiation;
3259 ---------------------------------
3260 -- Analyze_Generic_Access_Type --
3261 ---------------------------------
3263 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
3264 begin
3265 Enter_Name (T);
3267 if Nkind (Def) = N_Access_To_Object_Definition then
3268 Access_Type_Declaration (T, Def);
3270 if Is_Incomplete_Or_Private_Type (Designated_Type (T))
3271 and then No (Full_View (Designated_Type (T)))
3272 and then not Is_Generic_Type (Designated_Type (T))
3273 then
3274 Error_Msg_N ("premature usage of incomplete type", Def);
3276 elsif not Is_Entity_Name (Subtype_Indication (Def)) then
3277 Error_Msg_N
3278 ("only a subtype mark is allowed in a formal", Def);
3279 end if;
3281 else
3282 Access_Subprogram_Declaration (T, Def);
3283 end if;
3284 end Analyze_Generic_Access_Type;
3286 ---------------------------------
3287 -- Analyze_Generic_Formal_Part --
3288 ---------------------------------
3290 procedure Analyze_Generic_Formal_Part (N : Node_Id) is
3291 Gen_Parm_Decl : Node_Id;
3293 begin
3294 -- The generic formals are processed in the scope of the generic unit,
3295 -- where they are immediately visible. The scope is installed by the
3296 -- caller.
3298 Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
3300 while Present (Gen_Parm_Decl) loop
3301 Analyze (Gen_Parm_Decl);
3302 Next (Gen_Parm_Decl);
3303 end loop;
3305 Generate_Reference_To_Generic_Formals (Current_Scope);
3306 end Analyze_Generic_Formal_Part;
3308 ------------------------------------------
3309 -- Analyze_Generic_Package_Declaration --
3310 ------------------------------------------
3312 procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
3313 Loc : constant Source_Ptr := Sloc (N);
3314 Id : Entity_Id;
3315 New_N : Node_Id;
3316 Save_Parent : Node_Id;
3317 Renaming : Node_Id;
3318 Decls : constant List_Id :=
3319 Visible_Declarations (Specification (N));
3320 Decl : Node_Id;
3322 begin
3323 Check_SPARK_05_Restriction ("generic is not allowed", N);
3325 -- We introduce a renaming of the enclosing package, to have a usable
3326 -- entity as the prefix of an expanded name for a local entity of the
3327 -- form Par.P.Q, where P is the generic package. This is because a local
3328 -- entity named P may hide it, so that the usual visibility rules in
3329 -- the instance will not resolve properly.
3331 Renaming :=
3332 Make_Package_Renaming_Declaration (Loc,
3333 Defining_Unit_Name =>
3334 Make_Defining_Identifier (Loc,
3335 Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
3336 Name => Make_Identifier (Loc, Chars (Defining_Entity (N))));
3338 if Present (Decls) then
3339 Decl := First (Decls);
3340 while Present (Decl)
3341 and then Nkind (Decl) = N_Pragma
3342 loop
3343 Next (Decl);
3344 end loop;
3346 if Present (Decl) then
3347 Insert_Before (Decl, Renaming);
3348 else
3349 Append (Renaming, Visible_Declarations (Specification (N)));
3350 end if;
3352 else
3353 Set_Visible_Declarations (Specification (N), New_List (Renaming));
3354 end if;
3356 -- Create copy of generic unit, and save for instantiation. If the unit
3357 -- is a child unit, do not copy the specifications for the parent, which
3358 -- are not part of the generic tree.
3360 Save_Parent := Parent_Spec (N);
3361 Set_Parent_Spec (N, Empty);
3363 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3364 Set_Parent_Spec (New_N, Save_Parent);
3365 Rewrite (N, New_N);
3367 -- Once the contents of the generic copy and the template are swapped,
3368 -- do the same for their respective aspect specifications.
3370 Exchange_Aspects (N, New_N);
3371 Id := Defining_Entity (N);
3372 Generate_Definition (Id);
3374 -- Expansion is not applied to generic units
3376 Start_Generic;
3378 Enter_Name (Id);
3379 Set_Ekind (Id, E_Generic_Package);
3380 Set_Etype (Id, Standard_Void_Type);
3381 Set_Contract (Id, Make_Contract (Sloc (Id)));
3383 -- Analyze aspects now, so that generated pragmas appear in the
3384 -- declarations before building and analyzing the generic copy.
3386 if Has_Aspects (N) then
3387 Analyze_Aspect_Specifications (N, Id);
3388 end if;
3390 Push_Scope (Id);
3391 Enter_Generic_Scope (Id);
3392 Set_Inner_Instances (Id, New_Elmt_List);
3394 Set_Categorization_From_Pragmas (N);
3395 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3397 -- Link the declaration of the generic homonym in the generic copy to
3398 -- the package it renames, so that it is always resolved properly.
3400 Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
3401 Set_Entity (Associated_Node (Name (Renaming)), Id);
3403 -- For a library unit, we have reconstructed the entity for the unit,
3404 -- and must reset it in the library tables.
3406 if Nkind (Parent (N)) = N_Compilation_Unit then
3407 Set_Cunit_Entity (Current_Sem_Unit, Id);
3408 end if;
3410 Analyze_Generic_Formal_Part (N);
3412 -- After processing the generic formals, analysis proceeds as for a
3413 -- non-generic package.
3415 Analyze (Specification (N));
3417 Validate_Categorization_Dependency (N, Id);
3419 End_Generic;
3421 End_Package_Scope (Id);
3422 Exit_Generic_Scope (Id);
3424 if Nkind (Parent (N)) /= N_Compilation_Unit then
3425 Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
3426 Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
3427 Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
3429 else
3430 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3431 Validate_RT_RAT_Component (N);
3433 -- If this is a spec without a body, check that generic parameters
3434 -- are referenced.
3436 if not Body_Required (Parent (N)) then
3437 Check_References (Id);
3438 end if;
3439 end if;
3440 end Analyze_Generic_Package_Declaration;
3442 --------------------------------------------
3443 -- Analyze_Generic_Subprogram_Declaration --
3444 --------------------------------------------
3446 procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
3447 Spec : Node_Id;
3448 Id : Entity_Id;
3449 Formals : List_Id;
3450 New_N : Node_Id;
3451 Result_Type : Entity_Id;
3452 Save_Parent : Node_Id;
3453 Typ : Entity_Id;
3455 begin
3456 Check_SPARK_05_Restriction ("generic is not allowed", N);
3458 -- Create copy of generic unit, and save for instantiation. If the unit
3459 -- is a child unit, do not copy the specifications for the parent, which
3460 -- are not part of the generic tree.
3462 Save_Parent := Parent_Spec (N);
3463 Set_Parent_Spec (N, Empty);
3465 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3466 Set_Parent_Spec (New_N, Save_Parent);
3467 Rewrite (N, New_N);
3469 -- Once the contents of the generic copy and the template are swapped,
3470 -- do the same for their respective aspect specifications.
3472 Exchange_Aspects (N, New_N);
3474 Spec := Specification (N);
3475 Id := Defining_Entity (Spec);
3476 Generate_Definition (Id);
3477 Set_Contract (Id, Make_Contract (Sloc (Id)));
3479 if Nkind (Id) = N_Defining_Operator_Symbol then
3480 Error_Msg_N
3481 ("operator symbol not allowed for generic subprogram", Id);
3482 end if;
3484 Start_Generic;
3486 Enter_Name (Id);
3487 Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
3489 -- Analyze the aspects of the generic copy to ensure that all generated
3490 -- pragmas (if any) perform their semantic effects.
3492 if Has_Aspects (N) then
3493 Analyze_Aspect_Specifications (N, Id);
3494 end if;
3496 Push_Scope (Id);
3497 Enter_Generic_Scope (Id);
3498 Set_Inner_Instances (Id, New_Elmt_List);
3499 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3501 Analyze_Generic_Formal_Part (N);
3503 Formals := Parameter_Specifications (Spec);
3505 if Present (Formals) then
3506 Process_Formals (Formals, Spec);
3507 end if;
3509 if Nkind (Spec) = N_Function_Specification then
3510 Set_Ekind (Id, E_Generic_Function);
3512 if Nkind (Result_Definition (Spec)) = N_Access_Definition then
3513 Result_Type := Access_Definition (Spec, Result_Definition (Spec));
3514 Set_Etype (Id, Result_Type);
3516 -- Check restriction imposed by AI05-073: a generic function
3517 -- cannot return an abstract type or an access to such.
3519 -- This is a binding interpretation should it apply to earlier
3520 -- versions of Ada as well as Ada 2012???
3522 if Is_Abstract_Type (Designated_Type (Result_Type))
3523 and then Ada_Version >= Ada_2012
3524 then
3525 Error_Msg_N ("generic function cannot have an access result"
3526 & " that designates an abstract type", Spec);
3527 end if;
3529 else
3530 Find_Type (Result_Definition (Spec));
3531 Typ := Entity (Result_Definition (Spec));
3533 if Is_Abstract_Type (Typ)
3534 and then Ada_Version >= Ada_2012
3535 then
3536 Error_Msg_N
3537 ("generic function cannot have abstract result type", Spec);
3538 end if;
3540 -- If a null exclusion is imposed on the result type, then create
3541 -- a null-excluding itype (an access subtype) and use it as the
3542 -- function's Etype.
3544 if Is_Access_Type (Typ)
3545 and then Null_Exclusion_Present (Spec)
3546 then
3547 Set_Etype (Id,
3548 Create_Null_Excluding_Itype
3549 (T => Typ,
3550 Related_Nod => Spec,
3551 Scope_Id => Defining_Unit_Name (Spec)));
3552 else
3553 Set_Etype (Id, Typ);
3554 end if;
3555 end if;
3557 else
3558 Set_Ekind (Id, E_Generic_Procedure);
3559 Set_Etype (Id, Standard_Void_Type);
3560 end if;
3562 -- For a library unit, we have reconstructed the entity for the unit,
3563 -- and must reset it in the library tables. We also make sure that
3564 -- Body_Required is set properly in the original compilation unit node.
3566 if Nkind (Parent (N)) = N_Compilation_Unit then
3567 Set_Cunit_Entity (Current_Sem_Unit, Id);
3568 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3569 end if;
3571 Set_Categorization_From_Pragmas (N);
3572 Validate_Categorization_Dependency (N, Id);
3574 Save_Global_References (Original_Node (N));
3576 -- For ASIS purposes, convert any postcondition, precondition pragmas
3577 -- into aspects, if N is not a compilation unit by itself, in order to
3578 -- enable the analysis of expressions inside the corresponding PPC
3579 -- pragmas.
3581 if ASIS_Mode and then Is_List_Member (N) then
3582 Make_Aspect_For_PPC_In_Gen_Sub_Decl (N);
3583 end if;
3585 End_Generic;
3586 End_Scope;
3587 Exit_Generic_Scope (Id);
3588 Generate_Reference_To_Formals (Id);
3590 List_Inherited_Pre_Post_Aspects (Id);
3591 end Analyze_Generic_Subprogram_Declaration;
3593 -----------------------------------
3594 -- Analyze_Package_Instantiation --
3595 -----------------------------------
3597 procedure Analyze_Package_Instantiation (N : Node_Id) is
3598 Loc : constant Source_Ptr := Sloc (N);
3599 Gen_Id : constant Node_Id := Name (N);
3601 Act_Decl : Node_Id;
3602 Act_Decl_Name : Node_Id;
3603 Act_Decl_Id : Entity_Id;
3604 Act_Spec : Node_Id;
3605 Act_Tree : Node_Id;
3607 Gen_Decl : Node_Id;
3608 Gen_Unit : Entity_Id;
3610 Is_Actual_Pack : constant Boolean :=
3611 Is_Internal (Defining_Entity (N));
3613 Env_Installed : Boolean := False;
3614 Parent_Installed : Boolean := False;
3615 Renaming_List : List_Id;
3616 Unit_Renaming : Node_Id;
3617 Needs_Body : Boolean;
3618 Inline_Now : Boolean := False;
3620 Save_IPSM : constant Boolean := Ignore_Pragma_SPARK_Mode;
3621 -- Save flag Ignore_Pragma_SPARK_Mode for restore on exit
3623 Save_SM : constant SPARK_Mode_Type := SPARK_Mode;
3624 Save_SMP : constant Node_Id := SPARK_Mode_Pragma;
3625 -- Save the SPARK_Mode-related data for restore on exit
3627 Save_Style_Check : constant Boolean := Style_Check;
3628 -- Save style check mode for restore on exit
3630 procedure Delay_Descriptors (E : Entity_Id);
3631 -- Delay generation of subprogram descriptors for given entity
3633 function Might_Inline_Subp return Boolean;
3634 -- If inlining is active and the generic contains inlined subprograms,
3635 -- we instantiate the body. This may cause superfluous instantiations,
3636 -- but it is simpler than detecting the need for the body at the point
3637 -- of inlining, when the context of the instance is not available.
3639 function Must_Inline_Subp return Boolean;
3640 -- If inlining is active and the generic contains inlined subprograms,
3641 -- return True if some of the inlined subprograms must be inlined by
3642 -- the frontend.
3644 -----------------------
3645 -- Delay_Descriptors --
3646 -----------------------
3648 procedure Delay_Descriptors (E : Entity_Id) is
3649 begin
3650 if not Delay_Subprogram_Descriptors (E) then
3651 Set_Delay_Subprogram_Descriptors (E);
3652 Pending_Descriptor.Append (E);
3653 end if;
3654 end Delay_Descriptors;
3656 -----------------------
3657 -- Might_Inline_Subp --
3658 -----------------------
3660 function Might_Inline_Subp return Boolean is
3661 E : Entity_Id;
3663 begin
3664 if not Inline_Processing_Required then
3665 return False;
3667 else
3668 E := First_Entity (Gen_Unit);
3669 while Present (E) loop
3670 if Is_Subprogram (E) and then Is_Inlined (E) then
3671 return True;
3672 end if;
3674 Next_Entity (E);
3675 end loop;
3676 end if;
3678 return False;
3679 end Might_Inline_Subp;
3681 ----------------------
3682 -- Must_Inline_Subp --
3683 ----------------------
3685 function Must_Inline_Subp return Boolean is
3686 E : Entity_Id;
3688 begin
3689 if not Inline_Processing_Required then
3690 return False;
3692 else
3693 E := First_Entity (Gen_Unit);
3694 while Present (E) loop
3695 if Is_Subprogram (E)
3696 and then Is_Inlined (E)
3697 and then Must_Inline (E)
3698 then
3699 return True;
3700 end if;
3702 Next_Entity (E);
3703 end loop;
3704 end if;
3706 return False;
3707 end Must_Inline_Subp;
3709 -- Local declarations
3711 Vis_Prims_List : Elist_Id := No_Elist;
3712 -- List of primitives made temporarily visible in the instantiation
3713 -- to match the visibility of the formal type
3715 -- Start of processing for Analyze_Package_Instantiation
3717 begin
3718 Check_SPARK_05_Restriction ("generic is not allowed", N);
3720 -- Very first thing: check for Text_IO sp[ecial unit in case we are
3721 -- instantiating one of the children of [[Wide_]Wide_]Text_IO.
3723 Check_Text_IO_Special_Unit (Name (N));
3725 -- Make node global for error reporting
3727 Instantiation_Node := N;
3729 -- Turn off style checking in instances. If the check is enabled on the
3730 -- generic unit, a warning in an instance would just be noise. If not
3731 -- enabled on the generic, then a warning in an instance is just wrong.
3733 Style_Check := False;
3735 -- Case of instantiation of a generic package
3737 if Nkind (N) = N_Package_Instantiation then
3738 Act_Decl_Id := New_Copy (Defining_Entity (N));
3739 Set_Comes_From_Source (Act_Decl_Id, True);
3741 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3742 Act_Decl_Name :=
3743 Make_Defining_Program_Unit_Name (Loc,
3744 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
3745 Defining_Identifier => Act_Decl_Id);
3746 else
3747 Act_Decl_Name := Act_Decl_Id;
3748 end if;
3750 -- Case of instantiation of a formal package
3752 else
3753 Act_Decl_Id := Defining_Identifier (N);
3754 Act_Decl_Name := Act_Decl_Id;
3755 end if;
3757 Generate_Definition (Act_Decl_Id);
3758 Preanalyze_Actuals (N);
3760 Init_Env;
3761 Env_Installed := True;
3763 -- Reset renaming map for formal types. The mapping is established
3764 -- when analyzing the generic associations, but some mappings are
3765 -- inherited from formal packages of parent units, and these are
3766 -- constructed when the parents are installed.
3768 Generic_Renamings.Set_Last (0);
3769 Generic_Renamings_HTable.Reset;
3771 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3772 Gen_Unit := Entity (Gen_Id);
3774 -- Verify that it is the name of a generic package
3776 -- A visibility glitch: if the instance is a child unit and the generic
3777 -- is the generic unit of a parent instance (i.e. both the parent and
3778 -- the child units are instances of the same package) the name now
3779 -- denotes the renaming within the parent, not the intended generic
3780 -- unit. See if there is a homonym that is the desired generic. The
3781 -- renaming declaration must be visible inside the instance of the
3782 -- child, but not when analyzing the name in the instantiation itself.
3784 if Ekind (Gen_Unit) = E_Package
3785 and then Present (Renamed_Entity (Gen_Unit))
3786 and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3787 and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3788 and then Present (Homonym (Gen_Unit))
3789 then
3790 Gen_Unit := Homonym (Gen_Unit);
3791 end if;
3793 if Etype (Gen_Unit) = Any_Type then
3794 Restore_Env;
3795 goto Leave;
3797 elsif Ekind (Gen_Unit) /= E_Generic_Package then
3799 -- Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3801 if From_Limited_With (Gen_Unit) then
3802 Error_Msg_N
3803 ("cannot instantiate a limited withed package", Gen_Id);
3804 else
3805 Error_Msg_NE
3806 ("& is not the name of a generic package", Gen_Id, Gen_Unit);
3807 end if;
3809 Restore_Env;
3810 goto Leave;
3811 end if;
3813 if In_Extended_Main_Source_Unit (N) then
3814 Set_Is_Instantiated (Gen_Unit);
3815 Generate_Reference (Gen_Unit, N);
3817 if Present (Renamed_Object (Gen_Unit)) then
3818 Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3819 Generate_Reference (Renamed_Object (Gen_Unit), N);
3820 end if;
3821 end if;
3823 if Nkind (Gen_Id) = N_Identifier
3824 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3825 then
3826 Error_Msg_NE
3827 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3829 elsif Nkind (Gen_Id) = N_Expanded_Name
3830 and then Is_Child_Unit (Gen_Unit)
3831 and then Nkind (Prefix (Gen_Id)) = N_Identifier
3832 and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3833 then
3834 Error_Msg_N
3835 ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3836 end if;
3838 Set_Entity (Gen_Id, Gen_Unit);
3840 -- If generic is a renaming, get original generic unit
3842 if Present (Renamed_Object (Gen_Unit))
3843 and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3844 then
3845 Gen_Unit := Renamed_Object (Gen_Unit);
3846 end if;
3848 -- Verify that there are no circular instantiations
3850 if In_Open_Scopes (Gen_Unit) then
3851 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3852 Restore_Env;
3853 goto Leave;
3855 elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3856 Error_Msg_Node_2 := Current_Scope;
3857 Error_Msg_NE
3858 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3859 Circularity_Detected := True;
3860 Restore_Env;
3861 goto Leave;
3863 else
3864 -- If the context of the instance is subject to SPARK_Mode "off",
3865 -- set the global flag which signals Analyze_Pragma to ignore all
3866 -- SPARK_Mode pragmas within the instance.
3868 if SPARK_Mode = Off then
3869 Ignore_Pragma_SPARK_Mode := True;
3870 end if;
3872 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3874 -- Initialize renamings map, for error checking, and the list that
3875 -- holds private entities whose views have changed between generic
3876 -- definition and instantiation. If this is the instance created to
3877 -- validate an actual package, the instantiation environment is that
3878 -- of the enclosing instance.
3880 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3882 -- Copy original generic tree, to produce text for instantiation
3884 Act_Tree :=
3885 Copy_Generic_Node
3886 (Original_Node (Gen_Decl), Empty, Instantiating => True);
3888 Act_Spec := Specification (Act_Tree);
3890 -- If this is the instance created to validate an actual package,
3891 -- only the formals matter, do not examine the package spec itself.
3893 if Is_Actual_Pack then
3894 Set_Visible_Declarations (Act_Spec, New_List);
3895 Set_Private_Declarations (Act_Spec, New_List);
3896 end if;
3898 Renaming_List :=
3899 Analyze_Associations
3900 (I_Node => N,
3901 Formals => Generic_Formal_Declarations (Act_Tree),
3902 F_Copy => Generic_Formal_Declarations (Gen_Decl));
3904 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
3906 Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3907 Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3908 Set_Is_Generic_Instance (Act_Decl_Id);
3909 Set_Generic_Parent (Act_Spec, Gen_Unit);
3911 -- References to the generic in its own declaration or its body are
3912 -- references to the instance. Add a renaming declaration for the
3913 -- generic unit itself. This declaration, as well as the renaming
3914 -- declarations for the generic formals, must remain private to the
3915 -- unit: the formals, because this is the language semantics, and
3916 -- the unit because its use is an artifact of the implementation.
3918 Unit_Renaming :=
3919 Make_Package_Renaming_Declaration (Loc,
3920 Defining_Unit_Name =>
3921 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3922 Name => New_Occurrence_Of (Act_Decl_Id, Loc));
3924 Append (Unit_Renaming, Renaming_List);
3926 -- The renaming declarations are the first local declarations of the
3927 -- new unit.
3929 if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3930 Insert_List_Before
3931 (First (Visible_Declarations (Act_Spec)), Renaming_List);
3932 else
3933 Set_Visible_Declarations (Act_Spec, Renaming_List);
3934 end if;
3936 Act_Decl := Make_Package_Declaration (Loc, Specification => Act_Spec);
3938 -- Propagate the aspect specifications from the package declaration
3939 -- template to the instantiated version of the package declaration.
3941 if Has_Aspects (Act_Tree) then
3942 Set_Aspect_Specifications (Act_Decl,
3943 New_Copy_List_Tree (Aspect_Specifications (Act_Tree)));
3944 end if;
3946 -- Save the instantiation node, for subsequent instantiation of the
3947 -- body, if there is one and we are generating code for the current
3948 -- unit. Mark unit as having a body (avoids premature error message).
3950 -- We instantiate the body if we are generating code, if we are
3951 -- generating cross-reference information, or if we are building
3952 -- trees for ASIS use or GNATprove use.
3954 declare
3955 Enclosing_Body_Present : Boolean := False;
3956 -- If the generic unit is not a compilation unit, then a body may
3957 -- be present in its parent even if none is required. We create a
3958 -- tentative pending instantiation for the body, which will be
3959 -- discarded if none is actually present.
3961 Scop : Entity_Id;
3963 begin
3964 if Scope (Gen_Unit) /= Standard_Standard
3965 and then not Is_Child_Unit (Gen_Unit)
3966 then
3967 Scop := Scope (Gen_Unit);
3969 while Present (Scop)
3970 and then Scop /= Standard_Standard
3971 loop
3972 if Unit_Requires_Body (Scop) then
3973 Enclosing_Body_Present := True;
3974 exit;
3976 elsif In_Open_Scopes (Scop)
3977 and then In_Package_Body (Scop)
3978 then
3979 Enclosing_Body_Present := True;
3980 exit;
3981 end if;
3983 exit when Is_Compilation_Unit (Scop);
3984 Scop := Scope (Scop);
3985 end loop;
3986 end if;
3988 -- If front-end inlining is enabled, and this is a unit for which
3989 -- code will be generated, we instantiate the body at once.
3991 -- This is done if the instance is not the main unit, and if the
3992 -- generic is not a child unit of another generic, to avoid scope
3993 -- problems and the reinstallation of parent instances.
3995 if Expander_Active
3996 and then (not Is_Child_Unit (Gen_Unit)
3997 or else not Is_Generic_Unit (Scope (Gen_Unit)))
3998 and then Might_Inline_Subp
3999 and then not Is_Actual_Pack
4000 then
4001 if not Back_End_Inlining
4002 and then Front_End_Inlining
4003 and then (Is_In_Main_Unit (N)
4004 or else In_Main_Context (Current_Scope))
4005 and then Nkind (Parent (N)) /= N_Compilation_Unit
4006 then
4007 Inline_Now := True;
4009 elsif Back_End_Inlining
4010 and then Must_Inline_Subp
4011 and then (Is_In_Main_Unit (N)
4012 or else In_Main_Context (Current_Scope))
4013 and then Nkind (Parent (N)) /= N_Compilation_Unit
4014 then
4015 Inline_Now := True;
4017 -- In configurable_run_time mode we force the inlining of
4018 -- predefined subprograms marked Inline_Always, to minimize
4019 -- the use of the run-time library.
4021 elsif Is_Predefined_File_Name
4022 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
4023 and then Configurable_Run_Time_Mode
4024 and then Nkind (Parent (N)) /= N_Compilation_Unit
4025 then
4026 Inline_Now := True;
4027 end if;
4029 -- If the current scope is itself an instance within a child
4030 -- unit, there will be duplications in the scope stack, and the
4031 -- unstacking mechanism in Inline_Instance_Body will fail.
4032 -- This loses some rare cases of optimization, and might be
4033 -- improved some day, if we can find a proper abstraction for
4034 -- "the complete compilation context" that can be saved and
4035 -- restored. ???
4037 if Is_Generic_Instance (Current_Scope) then
4038 declare
4039 Curr_Unit : constant Entity_Id :=
4040 Cunit_Entity (Current_Sem_Unit);
4041 begin
4042 if Curr_Unit /= Current_Scope
4043 and then Is_Child_Unit (Curr_Unit)
4044 then
4045 Inline_Now := False;
4046 end if;
4047 end;
4048 end if;
4049 end if;
4051 Needs_Body :=
4052 (Unit_Requires_Body (Gen_Unit)
4053 or else Enclosing_Body_Present
4054 or else Present (Corresponding_Body (Gen_Decl)))
4055 and then (Is_In_Main_Unit (N) or else Might_Inline_Subp)
4056 and then not Is_Actual_Pack
4057 and then not Inline_Now
4058 and then (Operating_Mode = Generate_Code
4060 -- Need comment for this check ???
4062 or else (Operating_Mode = Check_Semantics
4063 and then (ASIS_Mode or GNATprove_Mode)));
4065 -- If front_end_inlining is enabled, do not instantiate body if
4066 -- within a generic context.
4068 if (Front_End_Inlining and then not Expander_Active)
4069 or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
4070 then
4071 Needs_Body := False;
4072 end if;
4074 -- If the current context is generic, and the package being
4075 -- instantiated is declared within a formal package, there is no
4076 -- body to instantiate until the enclosing generic is instantiated
4077 -- and there is an actual for the formal package. If the formal
4078 -- package has parameters, we build a regular package instance for
4079 -- it, that precedes the original formal package declaration.
4081 if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
4082 declare
4083 Decl : constant Node_Id :=
4084 Original_Node
4085 (Unit_Declaration_Node (Scope (Gen_Unit)));
4086 begin
4087 if Nkind (Decl) = N_Formal_Package_Declaration
4088 or else (Nkind (Decl) = N_Package_Declaration
4089 and then Is_List_Member (Decl)
4090 and then Present (Next (Decl))
4091 and then
4092 Nkind (Next (Decl)) =
4093 N_Formal_Package_Declaration)
4094 then
4095 Needs_Body := False;
4096 end if;
4097 end;
4098 end if;
4099 end;
4101 -- For RCI unit calling stubs, we omit the instance body if the
4102 -- instance is the RCI library unit itself.
4104 -- However there is a special case for nested instances: in this case
4105 -- we do generate the instance body, as it might be required, e.g.
4106 -- because it provides stream attributes for some type used in the
4107 -- profile of a remote subprogram. This is consistent with 12.3(12),
4108 -- which indicates that the instance body occurs at the place of the
4109 -- instantiation, and thus is part of the RCI declaration, which is
4110 -- present on all client partitions (this is E.2.3(18)).
4112 -- Note that AI12-0002 may make it illegal at some point to have
4113 -- stream attributes defined in an RCI unit, in which case this
4114 -- special case will become unnecessary. In the meantime, there
4115 -- is known application code in production that depends on this
4116 -- being possible, so we definitely cannot eliminate the body in
4117 -- the case of nested instances for the time being.
4119 -- When we generate a nested instance body, calling stubs for any
4120 -- relevant subprogram will be be inserted immediately after the
4121 -- subprogram declarations, and will take precedence over the
4122 -- subsequent (original) body. (The stub and original body will be
4123 -- complete homographs, but this is permitted in an instance).
4124 -- (Could we do better and remove the original body???)
4126 if Distribution_Stub_Mode = Generate_Caller_Stub_Body
4127 and then Comes_From_Source (N)
4128 and then Nkind (Parent (N)) = N_Compilation_Unit
4129 then
4130 Needs_Body := False;
4131 end if;
4133 if Needs_Body then
4135 -- Here is a defence against a ludicrous number of instantiations
4136 -- caused by a circular set of instantiation attempts.
4138 if Pending_Instantiations.Last > Maximum_Instantiations then
4139 Error_Msg_Uint_1 := UI_From_Int (Maximum_Instantiations);
4140 Error_Msg_N ("too many instantiations, exceeds max of^", N);
4141 Error_Msg_N ("\limit can be changed using -gnateinn switch", N);
4142 raise Unrecoverable_Error;
4143 end if;
4145 -- Indicate that the enclosing scopes contain an instantiation,
4146 -- and that cleanup actions should be delayed until after the
4147 -- instance body is expanded.
4149 Check_Forward_Instantiation (Gen_Decl);
4150 if Nkind (N) = N_Package_Instantiation then
4151 declare
4152 Enclosing_Master : Entity_Id;
4154 begin
4155 -- Loop to search enclosing masters
4157 Enclosing_Master := Current_Scope;
4158 Scope_Loop : while Enclosing_Master /= Standard_Standard loop
4159 if Ekind (Enclosing_Master) = E_Package then
4160 if Is_Compilation_Unit (Enclosing_Master) then
4161 if In_Package_Body (Enclosing_Master) then
4162 Delay_Descriptors
4163 (Body_Entity (Enclosing_Master));
4164 else
4165 Delay_Descriptors
4166 (Enclosing_Master);
4167 end if;
4169 exit Scope_Loop;
4171 else
4172 Enclosing_Master := Scope (Enclosing_Master);
4173 end if;
4175 elsif Is_Generic_Unit (Enclosing_Master)
4176 or else Ekind (Enclosing_Master) = E_Void
4177 then
4178 -- Cleanup actions will eventually be performed on the
4179 -- enclosing subprogram or package instance, if any.
4180 -- Enclosing scope is void in the formal part of a
4181 -- generic subprogram.
4183 exit Scope_Loop;
4185 else
4186 if Ekind (Enclosing_Master) = E_Entry
4187 and then
4188 Ekind (Scope (Enclosing_Master)) = E_Protected_Type
4189 then
4190 if not Expander_Active then
4191 exit Scope_Loop;
4192 else
4193 Enclosing_Master :=
4194 Protected_Body_Subprogram (Enclosing_Master);
4195 end if;
4196 end if;
4198 Set_Delay_Cleanups (Enclosing_Master);
4200 while Ekind (Enclosing_Master) = E_Block loop
4201 Enclosing_Master := Scope (Enclosing_Master);
4202 end loop;
4204 if Is_Subprogram (Enclosing_Master) then
4205 Delay_Descriptors (Enclosing_Master);
4207 elsif Is_Task_Type (Enclosing_Master) then
4208 declare
4209 TBP : constant Node_Id :=
4210 Get_Task_Body_Procedure
4211 (Enclosing_Master);
4212 begin
4213 if Present (TBP) then
4214 Delay_Descriptors (TBP);
4215 Set_Delay_Cleanups (TBP);
4216 end if;
4217 end;
4218 end if;
4220 exit Scope_Loop;
4221 end if;
4222 end loop Scope_Loop;
4223 end;
4225 -- Make entry in table
4227 Pending_Instantiations.Append
4228 ((Inst_Node => N,
4229 Act_Decl => Act_Decl,
4230 Expander_Status => Expander_Active,
4231 Current_Sem_Unit => Current_Sem_Unit,
4232 Scope_Suppress => Scope_Suppress,
4233 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4234 Version => Ada_Version,
4235 Version_Pragma => Ada_Version_Pragma,
4236 Warnings => Save_Warnings,
4237 SPARK_Mode => SPARK_Mode,
4238 SPARK_Mode_Pragma => SPARK_Mode_Pragma));
4239 end if;
4240 end if;
4242 Set_Categorization_From_Pragmas (Act_Decl);
4244 if Parent_Installed then
4245 Hide_Current_Scope;
4246 end if;
4248 Set_Instance_Spec (N, Act_Decl);
4250 -- If not a compilation unit, insert the package declaration before
4251 -- the original instantiation node.
4253 if Nkind (Parent (N)) /= N_Compilation_Unit then
4254 Mark_Rewrite_Insertion (Act_Decl);
4255 Insert_Before (N, Act_Decl);
4256 Analyze (Act_Decl);
4258 -- For an instantiation that is a compilation unit, place
4259 -- declaration on current node so context is complete for analysis
4260 -- (including nested instantiations). If this is the main unit,
4261 -- the declaration eventually replaces the instantiation node.
4262 -- If the instance body is created later, it replaces the
4263 -- instance node, and the declaration is attached to it
4264 -- (see Build_Instance_Compilation_Unit_Nodes).
4266 else
4267 if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
4269 -- The entity for the current unit is the newly created one,
4270 -- and all semantic information is attached to it.
4272 Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
4274 -- If this is the main unit, replace the main entity as well
4276 if Current_Sem_Unit = Main_Unit then
4277 Main_Unit_Entity := Act_Decl_Id;
4278 end if;
4279 end if;
4281 Set_Unit (Parent (N), Act_Decl);
4282 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
4283 Set_Package_Instantiation (Act_Decl_Id, N);
4285 -- Process aspect specifications of the instance node, if any, to
4286 -- take into account categorization pragmas before analyzing the
4287 -- instance.
4289 if Has_Aspects (N) then
4290 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4291 end if;
4293 Analyze (Act_Decl);
4294 Set_Unit (Parent (N), N);
4295 Set_Body_Required (Parent (N), False);
4297 -- We never need elaboration checks on instantiations, since by
4298 -- definition, the body instantiation is elaborated at the same
4299 -- time as the spec instantiation.
4301 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4302 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4303 end if;
4305 Check_Elab_Instantiation (N);
4307 if ABE_Is_Certain (N) and then Needs_Body then
4308 Pending_Instantiations.Decrement_Last;
4309 end if;
4311 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4313 Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
4314 First_Private_Entity (Act_Decl_Id));
4316 -- If the instantiation will receive a body, the unit will be
4317 -- transformed into a package body, and receive its own elaboration
4318 -- entity. Otherwise, the nature of the unit is now a package
4319 -- declaration.
4321 if Nkind (Parent (N)) = N_Compilation_Unit
4322 and then not Needs_Body
4323 then
4324 Rewrite (N, Act_Decl);
4325 end if;
4327 if Present (Corresponding_Body (Gen_Decl))
4328 or else Unit_Requires_Body (Gen_Unit)
4329 then
4330 Set_Has_Completion (Act_Decl_Id);
4331 end if;
4333 Check_Formal_Packages (Act_Decl_Id);
4335 Restore_Hidden_Primitives (Vis_Prims_List);
4336 Restore_Private_Views (Act_Decl_Id);
4338 Inherit_Context (Gen_Decl, N);
4340 if Parent_Installed then
4341 Remove_Parent;
4342 end if;
4344 Restore_Env;
4345 Env_Installed := False;
4346 end if;
4348 Validate_Categorization_Dependency (N, Act_Decl_Id);
4350 -- There used to be a check here to prevent instantiations in local
4351 -- contexts if the No_Local_Allocators restriction was active. This
4352 -- check was removed by a binding interpretation in AI-95-00130/07,
4353 -- but we retain the code for documentation purposes.
4355 -- if Ekind (Act_Decl_Id) /= E_Void
4356 -- and then not Is_Library_Level_Entity (Act_Decl_Id)
4357 -- then
4358 -- Check_Restriction (No_Local_Allocators, N);
4359 -- end if;
4361 if Inline_Now then
4362 Inline_Instance_Body (N, Gen_Unit, Act_Decl);
4363 end if;
4365 -- The following is a tree patch for ASIS: ASIS needs separate nodes to
4366 -- be used as defining identifiers for a formal package and for the
4367 -- corresponding expanded package.
4369 if Nkind (N) = N_Formal_Package_Declaration then
4370 Act_Decl_Id := New_Copy (Defining_Entity (N));
4371 Set_Comes_From_Source (Act_Decl_Id, True);
4372 Set_Is_Generic_Instance (Act_Decl_Id, False);
4373 Set_Defining_Identifier (N, Act_Decl_Id);
4374 end if;
4376 Ignore_Pragma_SPARK_Mode := Save_IPSM;
4377 SPARK_Mode := Save_SM;
4378 SPARK_Mode_Pragma := Save_SMP;
4379 Style_Check := Save_Style_Check;
4381 -- Check that if N is an instantiation of System.Dim_Float_IO or
4382 -- System.Dim_Integer_IO, the formal type has a dimension system.
4384 if Nkind (N) = N_Package_Instantiation
4385 and then Is_Dim_IO_Package_Instantiation (N)
4386 then
4387 declare
4388 Assoc : constant Node_Id := First (Generic_Associations (N));
4389 begin
4390 if not Has_Dimension_System
4391 (Etype (Explicit_Generic_Actual_Parameter (Assoc)))
4392 then
4393 Error_Msg_N ("type with a dimension system expected", Assoc);
4394 end if;
4395 end;
4396 end if;
4398 <<Leave>>
4399 if Has_Aspects (N) and then Nkind (Parent (N)) /= N_Compilation_Unit then
4400 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4401 end if;
4403 exception
4404 when Instantiation_Error =>
4405 if Parent_Installed then
4406 Remove_Parent;
4407 end if;
4409 if Env_Installed then
4410 Restore_Env;
4411 end if;
4413 Ignore_Pragma_SPARK_Mode := Save_IPSM;
4414 SPARK_Mode := Save_SM;
4415 SPARK_Mode_Pragma := Save_SMP;
4416 Style_Check := Save_Style_Check;
4417 end Analyze_Package_Instantiation;
4419 --------------------------
4420 -- Inline_Instance_Body --
4421 --------------------------
4423 procedure Inline_Instance_Body
4424 (N : Node_Id;
4425 Gen_Unit : Entity_Id;
4426 Act_Decl : Node_Id)
4428 Curr_Comp : constant Node_Id := Cunit (Current_Sem_Unit);
4429 Curr_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
4430 Gen_Comp : constant Entity_Id :=
4431 Cunit_Entity (Get_Source_Unit (Gen_Unit));
4433 Save_SM : constant SPARK_Mode_Type := SPARK_Mode;
4434 Save_SMP : constant Node_Id := SPARK_Mode_Pragma;
4435 -- Save all SPARK_Mode-related attributes as removing enclosing scopes
4436 -- to provide a clean environment for analysis of the inlined body will
4437 -- eliminate any previously set SPARK_Mode.
4439 Scope_Stack_Depth : constant Int :=
4440 Scope_Stack.Last - Scope_Stack.First + 1;
4442 Use_Clauses : array (1 .. Scope_Stack_Depth) of Node_Id;
4443 Instances : array (1 .. Scope_Stack_Depth) of Entity_Id;
4444 Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
4445 Curr_Scope : Entity_Id := Empty;
4446 List : Elist_Id;
4447 Num_Inner : Int := 0;
4448 Num_Scopes : Int := 0;
4449 N_Instances : Int := 0;
4450 Removed : Boolean := False;
4451 S : Entity_Id;
4452 Vis : Boolean;
4454 begin
4455 -- Case of generic unit defined in another unit. We must remove the
4456 -- complete context of the current unit to install that of the generic.
4458 if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
4460 -- Add some comments for the following two loops ???
4462 S := Current_Scope;
4463 while Present (S) and then S /= Standard_Standard loop
4464 loop
4465 Num_Scopes := Num_Scopes + 1;
4467 Use_Clauses (Num_Scopes) :=
4468 (Scope_Stack.Table
4469 (Scope_Stack.Last - Num_Scopes + 1).
4470 First_Use_Clause);
4471 End_Use_Clauses (Use_Clauses (Num_Scopes));
4473 exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
4474 or else Scope_Stack.Table
4475 (Scope_Stack.Last - Num_Scopes).Entity = Scope (S);
4476 end loop;
4478 exit when Is_Generic_Instance (S)
4479 and then (In_Package_Body (S)
4480 or else Ekind (S) = E_Procedure
4481 or else Ekind (S) = E_Function);
4482 S := Scope (S);
4483 end loop;
4485 Vis := Is_Immediately_Visible (Gen_Comp);
4487 -- Find and save all enclosing instances
4489 S := Current_Scope;
4491 while Present (S)
4492 and then S /= Standard_Standard
4493 loop
4494 if Is_Generic_Instance (S) then
4495 N_Instances := N_Instances + 1;
4496 Instances (N_Instances) := S;
4498 exit when In_Package_Body (S);
4499 end if;
4501 S := Scope (S);
4502 end loop;
4504 -- Remove context of current compilation unit, unless we are within a
4505 -- nested package instantiation, in which case the context has been
4506 -- removed previously.
4508 -- If current scope is the body of a child unit, remove context of
4509 -- spec as well. If an enclosing scope is an instance body, the
4510 -- context has already been removed, but the entities in the body
4511 -- must be made invisible as well.
4513 S := Current_Scope;
4515 while Present (S)
4516 and then S /= Standard_Standard
4517 loop
4518 if Is_Generic_Instance (S)
4519 and then (In_Package_Body (S)
4520 or else Ekind_In (S, E_Procedure, E_Function))
4521 then
4522 -- We still have to remove the entities of the enclosing
4523 -- instance from direct visibility.
4525 declare
4526 E : Entity_Id;
4527 begin
4528 E := First_Entity (S);
4529 while Present (E) loop
4530 Set_Is_Immediately_Visible (E, False);
4531 Next_Entity (E);
4532 end loop;
4533 end;
4535 exit;
4536 end if;
4538 if S = Curr_Unit
4539 or else (Ekind (Curr_Unit) = E_Package_Body
4540 and then S = Spec_Entity (Curr_Unit))
4541 or else (Ekind (Curr_Unit) = E_Subprogram_Body
4542 and then S =
4543 Corresponding_Spec
4544 (Unit_Declaration_Node (Curr_Unit)))
4545 then
4546 Removed := True;
4548 -- Remove entities in current scopes from visibility, so that
4549 -- instance body is compiled in a clean environment.
4551 List := Save_Scope_Stack (Handle_Use => False);
4553 if Is_Child_Unit (S) then
4555 -- Remove child unit from stack, as well as inner scopes.
4556 -- Removing the context of a child unit removes parent units
4557 -- as well.
4559 while Current_Scope /= S loop
4560 Num_Inner := Num_Inner + 1;
4561 Inner_Scopes (Num_Inner) := Current_Scope;
4562 Pop_Scope;
4563 end loop;
4565 Pop_Scope;
4566 Remove_Context (Curr_Comp);
4567 Curr_Scope := S;
4569 else
4570 Remove_Context (Curr_Comp);
4571 end if;
4573 if Ekind (Curr_Unit) = E_Package_Body then
4574 Remove_Context (Library_Unit (Curr_Comp));
4575 end if;
4576 end if;
4578 S := Scope (S);
4579 end loop;
4581 pragma Assert (Num_Inner < Num_Scopes);
4583 -- The inlined package body must be analyzed with the SPARK_Mode of
4584 -- the enclosing context, otherwise the body may cause bogus errors
4585 -- if a configuration SPARK_Mode pragma in in effect.
4587 Push_Scope (Standard_Standard);
4588 Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4589 Instantiate_Package_Body
4590 (Body_Info =>
4591 ((Inst_Node => N,
4592 Act_Decl => Act_Decl,
4593 Expander_Status => Expander_Active,
4594 Current_Sem_Unit => Current_Sem_Unit,
4595 Scope_Suppress => Scope_Suppress,
4596 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4597 Version => Ada_Version,
4598 Version_Pragma => Ada_Version_Pragma,
4599 Warnings => Save_Warnings,
4600 SPARK_Mode => Save_SM,
4601 SPARK_Mode_Pragma => Save_SMP)),
4602 Inlined_Body => True);
4604 Pop_Scope;
4606 -- Restore context
4608 Set_Is_Immediately_Visible (Gen_Comp, Vis);
4610 -- Reset Generic_Instance flag so that use clauses can be installed
4611 -- in the proper order. (See Use_One_Package for effect of enclosing
4612 -- instances on processing of use clauses).
4614 for J in 1 .. N_Instances loop
4615 Set_Is_Generic_Instance (Instances (J), False);
4616 end loop;
4618 if Removed then
4619 Install_Context (Curr_Comp);
4621 if Present (Curr_Scope)
4622 and then Is_Child_Unit (Curr_Scope)
4623 then
4624 Push_Scope (Curr_Scope);
4625 Set_Is_Immediately_Visible (Curr_Scope);
4627 -- Finally, restore inner scopes as well
4629 for J in reverse 1 .. Num_Inner loop
4630 Push_Scope (Inner_Scopes (J));
4631 end loop;
4632 end if;
4634 Restore_Scope_Stack (List, Handle_Use => False);
4636 if Present (Curr_Scope)
4637 and then
4638 (In_Private_Part (Curr_Scope)
4639 or else In_Package_Body (Curr_Scope))
4640 then
4641 -- Install private declaration of ancestor units, which are
4642 -- currently available. Restore_Scope_Stack and Install_Context
4643 -- only install the visible part of parents.
4645 declare
4646 Par : Entity_Id;
4647 begin
4648 Par := Scope (Curr_Scope);
4649 while (Present (Par))
4650 and then Par /= Standard_Standard
4651 loop
4652 Install_Private_Declarations (Par);
4653 Par := Scope (Par);
4654 end loop;
4655 end;
4656 end if;
4657 end if;
4659 -- Restore use clauses. For a child unit, use clauses in the parents
4660 -- are restored when installing the context, so only those in inner
4661 -- scopes (and those local to the child unit itself) need to be
4662 -- installed explicitly.
4664 if Is_Child_Unit (Curr_Unit)
4665 and then Removed
4666 then
4667 for J in reverse 1 .. Num_Inner + 1 loop
4668 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4669 Use_Clauses (J);
4670 Install_Use_Clauses (Use_Clauses (J));
4671 end loop;
4673 else
4674 for J in reverse 1 .. Num_Scopes loop
4675 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4676 Use_Clauses (J);
4677 Install_Use_Clauses (Use_Clauses (J));
4678 end loop;
4679 end if;
4681 -- Restore status of instances. If one of them is a body, make its
4682 -- local entities visible again.
4684 declare
4685 E : Entity_Id;
4686 Inst : Entity_Id;
4688 begin
4689 for J in 1 .. N_Instances loop
4690 Inst := Instances (J);
4691 Set_Is_Generic_Instance (Inst, True);
4693 if In_Package_Body (Inst)
4694 or else Ekind_In (S, E_Procedure, E_Function)
4695 then
4696 E := First_Entity (Instances (J));
4697 while Present (E) loop
4698 Set_Is_Immediately_Visible (E);
4699 Next_Entity (E);
4700 end loop;
4701 end if;
4702 end loop;
4703 end;
4705 -- If generic unit is in current unit, current context is correct. Note
4706 -- that the context is guaranteed to carry the correct SPARK_Mode as no
4707 -- enclosing scopes were removed.
4709 else
4710 Instantiate_Package_Body
4711 (Body_Info =>
4712 ((Inst_Node => N,
4713 Act_Decl => Act_Decl,
4714 Expander_Status => Expander_Active,
4715 Current_Sem_Unit => Current_Sem_Unit,
4716 Scope_Suppress => Scope_Suppress,
4717 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4718 Version => Ada_Version,
4719 Version_Pragma => Ada_Version_Pragma,
4720 Warnings => Save_Warnings,
4721 SPARK_Mode => SPARK_Mode,
4722 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
4723 Inlined_Body => True);
4724 end if;
4725 end Inline_Instance_Body;
4727 -------------------------------------
4728 -- Analyze_Procedure_Instantiation --
4729 -------------------------------------
4731 procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4732 begin
4733 Analyze_Subprogram_Instantiation (N, E_Procedure);
4734 end Analyze_Procedure_Instantiation;
4736 -----------------------------------
4737 -- Need_Subprogram_Instance_Body --
4738 -----------------------------------
4740 function Need_Subprogram_Instance_Body
4741 (N : Node_Id;
4742 Subp : Entity_Id) return Boolean
4744 begin
4745 -- Must be inlined (or inlined renaming)
4747 if (Is_In_Main_Unit (N)
4748 or else Is_Inlined (Subp)
4749 or else Is_Inlined (Alias (Subp)))
4751 -- Must be generating code or analyzing code in ASIS/GNATprove mode
4753 and then (Operating_Mode = Generate_Code
4754 or else (Operating_Mode = Check_Semantics
4755 and then (ASIS_Mode or GNATprove_Mode)))
4757 -- The body is needed when generating code (full expansion), in ASIS
4758 -- mode for other tools, and in GNATprove mode (special expansion) for
4759 -- formal verification of the body itself.
4761 and then (Expander_Active or ASIS_Mode or GNATprove_Mode)
4763 -- No point in inlining if ABE is inevitable
4765 and then not ABE_Is_Certain (N)
4767 -- Or if subprogram is eliminated
4769 and then not Is_Eliminated (Subp)
4770 then
4771 Pending_Instantiations.Append
4772 ((Inst_Node => N,
4773 Act_Decl => Unit_Declaration_Node (Subp),
4774 Expander_Status => Expander_Active,
4775 Current_Sem_Unit => Current_Sem_Unit,
4776 Scope_Suppress => Scope_Suppress,
4777 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4778 Version => Ada_Version,
4779 Version_Pragma => Ada_Version_Pragma,
4780 Warnings => Save_Warnings,
4781 SPARK_Mode => SPARK_Mode,
4782 SPARK_Mode_Pragma => SPARK_Mode_Pragma));
4783 return True;
4785 -- Here if not inlined, or we ignore the inlining
4787 else
4788 return False;
4789 end if;
4790 end Need_Subprogram_Instance_Body;
4792 --------------------------------------
4793 -- Analyze_Subprogram_Instantiation --
4794 --------------------------------------
4796 procedure Analyze_Subprogram_Instantiation
4797 (N : Node_Id;
4798 K : Entity_Kind)
4800 Loc : constant Source_Ptr := Sloc (N);
4801 Gen_Id : constant Node_Id := Name (N);
4803 Anon_Id : constant Entity_Id :=
4804 Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4805 Chars => New_External_Name
4806 (Chars (Defining_Entity (N)), 'R'));
4808 Act_Decl_Id : Entity_Id;
4809 Act_Decl : Node_Id;
4810 Act_Spec : Node_Id;
4811 Act_Tree : Node_Id;
4813 Env_Installed : Boolean := False;
4814 Gen_Unit : Entity_Id;
4815 Gen_Decl : Node_Id;
4816 Pack_Id : Entity_Id;
4817 Parent_Installed : Boolean := False;
4818 Renaming_List : List_Id;
4820 procedure Analyze_Instance_And_Renamings;
4821 -- The instance must be analyzed in a context that includes the mappings
4822 -- of generic parameters into actuals. We create a package declaration
4823 -- for this purpose, and a subprogram with an internal name within the
4824 -- package. The subprogram instance is simply an alias for the internal
4825 -- subprogram, declared in the current scope.
4827 ------------------------------------
4828 -- Analyze_Instance_And_Renamings --
4829 ------------------------------------
4831 procedure Analyze_Instance_And_Renamings is
4832 Def_Ent : constant Entity_Id := Defining_Entity (N);
4833 Pack_Decl : Node_Id;
4835 begin
4836 if Nkind (Parent (N)) = N_Compilation_Unit then
4838 -- For the case of a compilation unit, the container package has
4839 -- the same name as the instantiation, to insure that the binder
4840 -- calls the elaboration procedure with the right name. Copy the
4841 -- entity of the instance, which may have compilation level flags
4842 -- (e.g. Is_Child_Unit) set.
4844 Pack_Id := New_Copy (Def_Ent);
4846 else
4847 -- Otherwise we use the name of the instantiation concatenated
4848 -- with its source position to ensure uniqueness if there are
4849 -- several instantiations with the same name.
4851 Pack_Id :=
4852 Make_Defining_Identifier (Loc,
4853 Chars => New_External_Name
4854 (Related_Id => Chars (Def_Ent),
4855 Suffix => "GP",
4856 Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4857 end if;
4859 Pack_Decl := Make_Package_Declaration (Loc,
4860 Specification => Make_Package_Specification (Loc,
4861 Defining_Unit_Name => Pack_Id,
4862 Visible_Declarations => Renaming_List,
4863 End_Label => Empty));
4865 Set_Instance_Spec (N, Pack_Decl);
4866 Set_Is_Generic_Instance (Pack_Id);
4867 Set_Debug_Info_Needed (Pack_Id);
4869 -- Case of not a compilation unit
4871 if Nkind (Parent (N)) /= N_Compilation_Unit then
4872 Mark_Rewrite_Insertion (Pack_Decl);
4873 Insert_Before (N, Pack_Decl);
4874 Set_Has_Completion (Pack_Id);
4876 -- Case of an instantiation that is a compilation unit
4878 -- Place declaration on current node so context is complete for
4879 -- analysis (including nested instantiations), and for use in a
4880 -- context_clause (see Analyze_With_Clause).
4882 else
4883 Set_Unit (Parent (N), Pack_Decl);
4884 Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4885 end if;
4887 Analyze (Pack_Decl);
4888 Check_Formal_Packages (Pack_Id);
4889 Set_Is_Generic_Instance (Pack_Id, False);
4891 -- Why do we clear Is_Generic_Instance??? We set it 20 lines
4892 -- above???
4894 -- Body of the enclosing package is supplied when instantiating the
4895 -- subprogram body, after semantic analysis is completed.
4897 if Nkind (Parent (N)) = N_Compilation_Unit then
4899 -- Remove package itself from visibility, so it does not
4900 -- conflict with subprogram.
4902 Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4904 -- Set name and scope of internal subprogram so that the proper
4905 -- external name will be generated. The proper scope is the scope
4906 -- of the wrapper package. We need to generate debugging info for
4907 -- the internal subprogram, so set flag accordingly.
4909 Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4910 Set_Scope (Anon_Id, Scope (Pack_Id));
4912 -- Mark wrapper package as referenced, to avoid spurious warnings
4913 -- if the instantiation appears in various with_ clauses of
4914 -- subunits of the main unit.
4916 Set_Referenced (Pack_Id);
4917 end if;
4919 Set_Is_Generic_Instance (Anon_Id);
4920 Set_Debug_Info_Needed (Anon_Id);
4921 Act_Decl_Id := New_Copy (Anon_Id);
4923 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4924 Set_Chars (Act_Decl_Id, Chars (Defining_Entity (N)));
4925 Set_Sloc (Act_Decl_Id, Sloc (Defining_Entity (N)));
4926 Set_Comes_From_Source (Act_Decl_Id, True);
4928 -- The signature may involve types that are not frozen yet, but the
4929 -- subprogram will be frozen at the point the wrapper package is
4930 -- frozen, so it does not need its own freeze node. In fact, if one
4931 -- is created, it might conflict with the freezing actions from the
4932 -- wrapper package.
4934 Set_Has_Delayed_Freeze (Anon_Id, False);
4936 -- If the instance is a child unit, mark the Id accordingly. Mark
4937 -- the anonymous entity as well, which is the real subprogram and
4938 -- which is used when the instance appears in a context clause.
4939 -- Similarly, propagate the Is_Eliminated flag to handle properly
4940 -- nested eliminated subprograms.
4942 Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
4943 Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
4944 New_Overloaded_Entity (Act_Decl_Id);
4945 Check_Eliminated (Act_Decl_Id);
4946 Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
4948 -- In compilation unit case, kill elaboration checks on the
4949 -- instantiation, since they are never needed -- the body is
4950 -- instantiated at the same point as the spec.
4952 if Nkind (Parent (N)) = N_Compilation_Unit then
4953 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4954 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4955 Set_Is_Compilation_Unit (Anon_Id);
4957 Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
4958 end if;
4960 -- The instance is not a freezing point for the new subprogram
4962 Set_Is_Frozen (Act_Decl_Id, False);
4964 if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
4965 Valid_Operator_Definition (Act_Decl_Id);
4966 end if;
4968 Set_Alias (Act_Decl_Id, Anon_Id);
4969 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4970 Set_Has_Completion (Act_Decl_Id);
4971 Set_Related_Instance (Pack_Id, Act_Decl_Id);
4973 if Nkind (Parent (N)) = N_Compilation_Unit then
4974 Set_Body_Required (Parent (N), False);
4975 end if;
4976 end Analyze_Instance_And_Renamings;
4978 -- Local variables
4980 Save_IPSM : constant Boolean := Ignore_Pragma_SPARK_Mode;
4981 -- Save flag Ignore_Pragma_SPARK_Mode for restore on exit
4983 Save_SM : constant SPARK_Mode_Type := SPARK_Mode;
4984 Save_SMP : constant Node_Id := SPARK_Mode_Pragma;
4985 -- Save the SPARK_Mode-related data for restore on exit
4987 Vis_Prims_List : Elist_Id := No_Elist;
4988 -- List of primitives made temporarily visible in the instantiation
4989 -- to match the visibility of the formal type
4991 -- Start of processing for Analyze_Subprogram_Instantiation
4993 begin
4994 Check_SPARK_05_Restriction ("generic is not allowed", N);
4996 -- Very first thing: check for special Text_IO unit in case we are
4997 -- instantiating one of the children of [[Wide_]Wide_]Text_IO. Of course
4998 -- such an instantiation is bogus (these are packages, not subprograms),
4999 -- but we get a better error message if we do this.
5001 Check_Text_IO_Special_Unit (Gen_Id);
5003 -- Make node global for error reporting
5005 Instantiation_Node := N;
5007 -- For package instantiations we turn off style checks, because they
5008 -- will have been emitted in the generic. For subprogram instantiations
5009 -- we want to apply at least the check on overriding indicators so we
5010 -- do not modify the style check status.
5012 -- The renaming declarations for the actuals do not come from source and
5013 -- will not generate spurious warnings.
5015 Preanalyze_Actuals (N);
5017 Init_Env;
5018 Env_Installed := True;
5019 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
5020 Gen_Unit := Entity (Gen_Id);
5022 Generate_Reference (Gen_Unit, Gen_Id);
5024 if Nkind (Gen_Id) = N_Identifier
5025 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
5026 then
5027 Error_Msg_NE
5028 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
5029 end if;
5031 if Etype (Gen_Unit) = Any_Type then
5032 Restore_Env;
5033 return;
5034 end if;
5036 -- Verify that it is a generic subprogram of the right kind, and that
5037 -- it does not lead to a circular instantiation.
5039 if K = E_Procedure and then Ekind (Gen_Unit) /= E_Generic_Procedure then
5040 Error_Msg_NE
5041 ("& is not the name of a generic procedure", Gen_Id, Gen_Unit);
5043 elsif K = E_Function and then Ekind (Gen_Unit) /= E_Generic_Function then
5044 Error_Msg_NE
5045 ("& is not the name of a generic function", Gen_Id, Gen_Unit);
5047 elsif In_Open_Scopes (Gen_Unit) then
5048 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
5050 else
5051 -- If the context of the instance is subject to SPARK_Mode "off",
5052 -- set the global flag which signals Analyze_Pragma to ignore all
5053 -- SPARK_Mode pragmas within the instance.
5055 if SPARK_Mode = Off then
5056 Ignore_Pragma_SPARK_Mode := True;
5057 end if;
5059 Set_Entity (Gen_Id, Gen_Unit);
5060 Set_Is_Instantiated (Gen_Unit);
5062 if In_Extended_Main_Source_Unit (N) then
5063 Generate_Reference (Gen_Unit, N);
5064 end if;
5066 -- If renaming, get original unit
5068 if Present (Renamed_Object (Gen_Unit))
5069 and then Ekind_In (Renamed_Object (Gen_Unit), E_Generic_Procedure,
5070 E_Generic_Function)
5071 then
5072 Gen_Unit := Renamed_Object (Gen_Unit);
5073 Set_Is_Instantiated (Gen_Unit);
5074 Generate_Reference (Gen_Unit, N);
5075 end if;
5077 if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
5078 Error_Msg_Node_2 := Current_Scope;
5079 Error_Msg_NE
5080 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
5081 Circularity_Detected := True;
5082 Restore_Hidden_Primitives (Vis_Prims_List);
5083 goto Leave;
5084 end if;
5086 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
5088 -- Initialize renamings map, for error checking
5090 Generic_Renamings.Set_Last (0);
5091 Generic_Renamings_HTable.Reset;
5093 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
5095 -- Copy original generic tree, to produce text for instantiation
5097 Act_Tree :=
5098 Copy_Generic_Node
5099 (Original_Node (Gen_Decl), Empty, Instantiating => True);
5101 -- Inherit overriding indicator from instance node
5103 Act_Spec := Specification (Act_Tree);
5104 Set_Must_Override (Act_Spec, Must_Override (N));
5105 Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
5107 Renaming_List :=
5108 Analyze_Associations
5109 (I_Node => N,
5110 Formals => Generic_Formal_Declarations (Act_Tree),
5111 F_Copy => Generic_Formal_Declarations (Gen_Decl));
5113 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
5115 -- The subprogram itself cannot contain a nested instance, so the
5116 -- current parent is left empty.
5118 Set_Instance_Env (Gen_Unit, Empty);
5120 -- Build the subprogram declaration, which does not appear in the
5121 -- generic template, and give it a sloc consistent with that of the
5122 -- template.
5124 Set_Defining_Unit_Name (Act_Spec, Anon_Id);
5125 Set_Generic_Parent (Act_Spec, Gen_Unit);
5126 Act_Decl :=
5127 Make_Subprogram_Declaration (Sloc (Act_Spec),
5128 Specification => Act_Spec);
5130 -- The aspects have been copied previously, but they have to be
5131 -- linked explicitly to the new subprogram declaration. Explicit
5132 -- pre/postconditions on the instance are analyzed below, in a
5133 -- separate step.
5135 Move_Aspects (Act_Tree, To => Act_Decl);
5136 Set_Categorization_From_Pragmas (Act_Decl);
5138 if Parent_Installed then
5139 Hide_Current_Scope;
5140 end if;
5142 Append (Act_Decl, Renaming_List);
5143 Analyze_Instance_And_Renamings;
5145 -- If the generic is marked Import (Intrinsic), then so is the
5146 -- instance. This indicates that there is no body to instantiate. If
5147 -- generic is marked inline, so it the instance, and the anonymous
5148 -- subprogram it renames. If inlined, or else if inlining is enabled
5149 -- for the compilation, we generate the instance body even if it is
5150 -- not within the main unit.
5152 if Is_Intrinsic_Subprogram (Gen_Unit) then
5153 Set_Is_Intrinsic_Subprogram (Anon_Id);
5154 Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
5156 if Chars (Gen_Unit) = Name_Unchecked_Conversion then
5157 Validate_Unchecked_Conversion (N, Act_Decl_Id);
5158 end if;
5159 end if;
5161 -- Inherit convention from generic unit. Intrinsic convention, as for
5162 -- an instance of unchecked conversion, is not inherited because an
5163 -- explicit Ada instance has been created.
5165 if Has_Convention_Pragma (Gen_Unit)
5166 and then Convention (Gen_Unit) /= Convention_Intrinsic
5167 then
5168 Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
5169 Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
5170 end if;
5172 Generate_Definition (Act_Decl_Id);
5173 -- Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id)));
5174 -- ??? needed?
5175 Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
5177 -- Inherit all inlining-related flags which apply to the generic in
5178 -- the subprogram and its declaration.
5180 Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
5181 Set_Is_Inlined (Anon_Id, Is_Inlined (Gen_Unit));
5183 Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
5184 Set_Has_Pragma_Inline (Anon_Id, Has_Pragma_Inline (Gen_Unit));
5186 Set_Has_Pragma_Inline_Always
5187 (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
5188 Set_Has_Pragma_Inline_Always
5189 (Anon_Id, Has_Pragma_Inline_Always (Gen_Unit));
5191 if not Is_Intrinsic_Subprogram (Gen_Unit) then
5192 Check_Elab_Instantiation (N);
5193 end if;
5195 if Is_Dispatching_Operation (Act_Decl_Id)
5196 and then Ada_Version >= Ada_2005
5197 then
5198 declare
5199 Formal : Entity_Id;
5201 begin
5202 Formal := First_Formal (Act_Decl_Id);
5203 while Present (Formal) loop
5204 if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
5205 and then Is_Controlling_Formal (Formal)
5206 and then not Can_Never_Be_Null (Formal)
5207 then
5208 Error_Msg_NE ("access parameter& is controlling,",
5209 N, Formal);
5210 Error_Msg_NE
5211 ("\corresponding parameter of & must be"
5212 & " explicitly null-excluding", N, Gen_Id);
5213 end if;
5215 Next_Formal (Formal);
5216 end loop;
5217 end;
5218 end if;
5220 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
5222 Validate_Categorization_Dependency (N, Act_Decl_Id);
5224 if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
5225 Inherit_Context (Gen_Decl, N);
5227 Restore_Private_Views (Pack_Id, False);
5229 -- If the context requires a full instantiation, mark node for
5230 -- subsequent construction of the body.
5232 if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
5233 Check_Forward_Instantiation (Gen_Decl);
5235 -- The wrapper package is always delayed, because it does not
5236 -- constitute a freeze point, but to insure that the freeze
5237 -- node is placed properly, it is created directly when
5238 -- instantiating the body (otherwise the freeze node might
5239 -- appear to early for nested instantiations).
5241 elsif Nkind (Parent (N)) = N_Compilation_Unit then
5243 -- For ASIS purposes, indicate that the wrapper package has
5244 -- replaced the instantiation node.
5246 Rewrite (N, Unit (Parent (N)));
5247 Set_Unit (Parent (N), N);
5248 end if;
5250 elsif Nkind (Parent (N)) = N_Compilation_Unit then
5252 -- Replace instance node for library-level instantiations of
5253 -- intrinsic subprograms, for ASIS use.
5255 Rewrite (N, Unit (Parent (N)));
5256 Set_Unit (Parent (N), N);
5257 end if;
5259 if Parent_Installed then
5260 Remove_Parent;
5261 end if;
5263 Restore_Hidden_Primitives (Vis_Prims_List);
5264 Restore_Env;
5265 Env_Installed := False;
5266 Generic_Renamings.Set_Last (0);
5267 Generic_Renamings_HTable.Reset;
5269 Ignore_Pragma_SPARK_Mode := Save_IPSM;
5270 SPARK_Mode := Save_SM;
5271 SPARK_Mode_Pragma := Save_SMP;
5272 end if;
5274 <<Leave>>
5275 if Has_Aspects (N) then
5276 Analyze_Aspect_Specifications (N, Act_Decl_Id);
5277 end if;
5279 exception
5280 when Instantiation_Error =>
5281 if Parent_Installed then
5282 Remove_Parent;
5283 end if;
5285 if Env_Installed then
5286 Restore_Env;
5287 end if;
5289 Ignore_Pragma_SPARK_Mode := Save_IPSM;
5290 SPARK_Mode := Save_SM;
5291 SPARK_Mode_Pragma := Save_SMP;
5292 end Analyze_Subprogram_Instantiation;
5294 -------------------------
5295 -- Get_Associated_Node --
5296 -------------------------
5298 function Get_Associated_Node (N : Node_Id) return Node_Id is
5299 Assoc : Node_Id;
5301 begin
5302 Assoc := Associated_Node (N);
5304 if Nkind (Assoc) /= Nkind (N) then
5305 return Assoc;
5307 elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
5308 return Assoc;
5310 else
5311 -- If the node is part of an inner generic, it may itself have been
5312 -- remapped into a further generic copy. Associated_Node is otherwise
5313 -- used for the entity of the node, and will be of a different node
5314 -- kind, or else N has been rewritten as a literal or function call.
5316 while Present (Associated_Node (Assoc))
5317 and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
5318 loop
5319 Assoc := Associated_Node (Assoc);
5320 end loop;
5322 -- Follow and additional link in case the final node was rewritten.
5323 -- This can only happen with nested generic units.
5325 if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
5326 and then Present (Associated_Node (Assoc))
5327 and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
5328 N_Explicit_Dereference,
5329 N_Integer_Literal,
5330 N_Real_Literal,
5331 N_String_Literal))
5332 then
5333 Assoc := Associated_Node (Assoc);
5334 end if;
5336 -- An additional special case: an unconstrained type in an object
5337 -- declaration may have been rewritten as a local subtype constrained
5338 -- by the expression in the declaration. We need to recover the
5339 -- original entity which may be global.
5341 if Present (Original_Node (Assoc))
5342 and then Nkind (Parent (N)) = N_Object_Declaration
5343 then
5344 Assoc := Original_Node (Assoc);
5345 end if;
5347 return Assoc;
5348 end if;
5349 end Get_Associated_Node;
5351 -------------------------------------------
5352 -- Build_Instance_Compilation_Unit_Nodes --
5353 -------------------------------------------
5355 procedure Build_Instance_Compilation_Unit_Nodes
5356 (N : Node_Id;
5357 Act_Body : Node_Id;
5358 Act_Decl : Node_Id)
5360 Decl_Cunit : Node_Id;
5361 Body_Cunit : Node_Id;
5362 Citem : Node_Id;
5363 New_Main : constant Entity_Id := Defining_Entity (Act_Decl);
5364 Old_Main : constant Entity_Id := Cunit_Entity (Main_Unit);
5366 begin
5367 -- A new compilation unit node is built for the instance declaration
5369 Decl_Cunit :=
5370 Make_Compilation_Unit (Sloc (N),
5371 Context_Items => Empty_List,
5372 Unit => Act_Decl,
5373 Aux_Decls_Node => Make_Compilation_Unit_Aux (Sloc (N)));
5375 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
5377 -- The new compilation unit is linked to its body, but both share the
5378 -- same file, so we do not set Body_Required on the new unit so as not
5379 -- to create a spurious dependency on a non-existent body in the ali.
5380 -- This simplifies CodePeer unit traversal.
5382 -- We use the original instantiation compilation unit as the resulting
5383 -- compilation unit of the instance, since this is the main unit.
5385 Rewrite (N, Act_Body);
5387 -- Propagate the aspect specifications from the package body template to
5388 -- the instantiated version of the package body.
5390 if Has_Aspects (Act_Body) then
5391 Set_Aspect_Specifications
5392 (N, New_Copy_List_Tree (Aspect_Specifications (Act_Body)));
5393 end if;
5395 Body_Cunit := Parent (N);
5397 -- The two compilation unit nodes are linked by the Library_Unit field
5399 Set_Library_Unit (Decl_Cunit, Body_Cunit);
5400 Set_Library_Unit (Body_Cunit, Decl_Cunit);
5402 -- Preserve the private nature of the package if needed
5404 Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
5406 -- If the instance is not the main unit, its context, categorization
5407 -- and elaboration entity are not relevant to the compilation.
5409 if Body_Cunit /= Cunit (Main_Unit) then
5410 Make_Instance_Unit (Body_Cunit, In_Main => False);
5411 return;
5412 end if;
5414 -- The context clause items on the instantiation, which are now attached
5415 -- to the body compilation unit (since the body overwrote the original
5416 -- instantiation node), semantically belong on the spec, so copy them
5417 -- there. It's harmless to leave them on the body as well. In fact one
5418 -- could argue that they belong in both places.
5420 Citem := First (Context_Items (Body_Cunit));
5421 while Present (Citem) loop
5422 Append (New_Copy (Citem), Context_Items (Decl_Cunit));
5423 Next (Citem);
5424 end loop;
5426 -- Propagate categorization flags on packages, so that they appear in
5427 -- the ali file for the spec of the unit.
5429 if Ekind (New_Main) = E_Package then
5430 Set_Is_Pure (Old_Main, Is_Pure (New_Main));
5431 Set_Is_Preelaborated (Old_Main, Is_Preelaborated (New_Main));
5432 Set_Is_Remote_Types (Old_Main, Is_Remote_Types (New_Main));
5433 Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
5434 Set_Is_Remote_Call_Interface
5435 (Old_Main, Is_Remote_Call_Interface (New_Main));
5436 end if;
5438 -- Make entry in Units table, so that binder can generate call to
5439 -- elaboration procedure for body, if any.
5441 Make_Instance_Unit (Body_Cunit, In_Main => True);
5442 Main_Unit_Entity := New_Main;
5443 Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
5445 -- Build elaboration entity, since the instance may certainly generate
5446 -- elaboration code requiring a flag for protection.
5448 Build_Elaboration_Entity (Decl_Cunit, New_Main);
5449 end Build_Instance_Compilation_Unit_Nodes;
5451 -----------------------------
5452 -- Check_Access_Definition --
5453 -----------------------------
5455 procedure Check_Access_Definition (N : Node_Id) is
5456 begin
5457 pragma Assert
5458 (Ada_Version >= Ada_2005 and then Present (Access_Definition (N)));
5459 null;
5460 end Check_Access_Definition;
5462 -----------------------------------
5463 -- Check_Formal_Package_Instance --
5464 -----------------------------------
5466 -- If the formal has specific parameters, they must match those of the
5467 -- actual. Both of them are instances, and the renaming declarations for
5468 -- their formal parameters appear in the same order in both. The analyzed
5469 -- formal has been analyzed in the context of the current instance.
5471 procedure Check_Formal_Package_Instance
5472 (Formal_Pack : Entity_Id;
5473 Actual_Pack : Entity_Id)
5475 E1 : Entity_Id := First_Entity (Actual_Pack);
5476 E2 : Entity_Id := First_Entity (Formal_Pack);
5478 Expr1 : Node_Id;
5479 Expr2 : Node_Id;
5481 procedure Check_Mismatch (B : Boolean);
5482 -- Common error routine for mismatch between the parameters of the
5483 -- actual instance and those of the formal package.
5485 function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
5486 -- The formal may come from a nested formal package, and the actual may
5487 -- have been constant-folded. To determine whether the two denote the
5488 -- same entity we may have to traverse several definitions to recover
5489 -- the ultimate entity that they refer to.
5491 function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
5492 -- Similarly, if the formal comes from a nested formal package, the
5493 -- actual may designate the formal through multiple renamings, which
5494 -- have to be followed to determine the original variable in question.
5496 --------------------
5497 -- Check_Mismatch --
5498 --------------------
5500 procedure Check_Mismatch (B : Boolean) is
5501 Kind : constant Node_Kind := Nkind (Parent (E2));
5503 begin
5504 if Kind = N_Formal_Type_Declaration then
5505 return;
5507 elsif Nkind_In (Kind, N_Formal_Object_Declaration,
5508 N_Formal_Package_Declaration)
5509 or else Kind in N_Formal_Subprogram_Declaration
5510 then
5511 null;
5513 elsif B then
5514 Error_Msg_NE
5515 ("actual for & in actual instance does not match formal",
5516 Parent (Actual_Pack), E1);
5517 end if;
5518 end Check_Mismatch;
5520 --------------------------------
5521 -- Same_Instantiated_Constant --
5522 --------------------------------
5524 function Same_Instantiated_Constant
5525 (E1, E2 : Entity_Id) return Boolean
5527 Ent : Entity_Id;
5529 begin
5530 Ent := E2;
5531 while Present (Ent) loop
5532 if E1 = Ent then
5533 return True;
5535 elsif Ekind (Ent) /= E_Constant then
5536 return False;
5538 elsif Is_Entity_Name (Constant_Value (Ent)) then
5539 if Entity (Constant_Value (Ent)) = E1 then
5540 return True;
5541 else
5542 Ent := Entity (Constant_Value (Ent));
5543 end if;
5545 -- The actual may be a constant that has been folded. Recover
5546 -- original name.
5548 elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5549 Ent := Entity (Original_Node (Constant_Value (Ent)));
5550 else
5551 return False;
5552 end if;
5553 end loop;
5555 return False;
5556 end Same_Instantiated_Constant;
5558 --------------------------------
5559 -- Same_Instantiated_Variable --
5560 --------------------------------
5562 function Same_Instantiated_Variable
5563 (E1, E2 : Entity_Id) return Boolean
5565 function Original_Entity (E : Entity_Id) return Entity_Id;
5566 -- Follow chain of renamings to the ultimate ancestor
5568 ---------------------
5569 -- Original_Entity --
5570 ---------------------
5572 function Original_Entity (E : Entity_Id) return Entity_Id is
5573 Orig : Entity_Id;
5575 begin
5576 Orig := E;
5577 while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5578 and then Present (Renamed_Object (Orig))
5579 and then Is_Entity_Name (Renamed_Object (Orig))
5580 loop
5581 Orig := Entity (Renamed_Object (Orig));
5582 end loop;
5584 return Orig;
5585 end Original_Entity;
5587 -- Start of processing for Same_Instantiated_Variable
5589 begin
5590 return Ekind (E1) = Ekind (E2)
5591 and then Original_Entity (E1) = Original_Entity (E2);
5592 end Same_Instantiated_Variable;
5594 -- Start of processing for Check_Formal_Package_Instance
5596 begin
5597 while Present (E1)
5598 and then Present (E2)
5599 loop
5600 exit when Ekind (E1) = E_Package
5601 and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5603 -- If the formal is the renaming of the formal package, this
5604 -- is the end of its formal part, which may occur before the
5605 -- end of the formal part in the actual in the presence of
5606 -- defaulted parameters in the formal package.
5608 exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5609 and then Renamed_Entity (E2) = Scope (E2);
5611 -- The analysis of the actual may generate additional internal
5612 -- entities. If the formal is defaulted, there is no corresponding
5613 -- analysis and the internal entities must be skipped, until we
5614 -- find corresponding entities again.
5616 if Comes_From_Source (E2)
5617 and then not Comes_From_Source (E1)
5618 and then Chars (E1) /= Chars (E2)
5619 then
5620 while Present (E1)
5621 and then Chars (E1) /= Chars (E2)
5622 loop
5623 Next_Entity (E1);
5624 end loop;
5625 end if;
5627 if No (E1) then
5628 return;
5630 -- If the formal entity comes from a formal declaration, it was
5631 -- defaulted in the formal package, and no check is needed on it.
5633 elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
5634 goto Next_E;
5636 -- Ditto for defaulted formal subprograms.
5638 elsif Is_Overloadable (E1)
5639 and then Nkind (Unit_Declaration_Node (E2)) in
5640 N_Formal_Subprogram_Declaration
5641 then
5642 goto Next_E;
5644 elsif Is_Type (E1) then
5646 -- Subtypes must statically match. E1, E2 are the local entities
5647 -- that are subtypes of the actuals. Itypes generated for other
5648 -- parameters need not be checked, the check will be performed
5649 -- on the parameters themselves.
5651 -- If E2 is a formal type declaration, it is a defaulted parameter
5652 -- and needs no checking.
5654 if not Is_Itype (E1)
5655 and then not Is_Itype (E2)
5656 then
5657 Check_Mismatch
5658 (not Is_Type (E2)
5659 or else Etype (E1) /= Etype (E2)
5660 or else not Subtypes_Statically_Match (E1, E2));
5661 end if;
5663 elsif Ekind (E1) = E_Constant then
5665 -- IN parameters must denote the same static value, or the same
5666 -- constant, or the literal null.
5668 Expr1 := Expression (Parent (E1));
5670 if Ekind (E2) /= E_Constant then
5671 Check_Mismatch (True);
5672 goto Next_E;
5673 else
5674 Expr2 := Expression (Parent (E2));
5675 end if;
5677 if Is_OK_Static_Expression (Expr1) then
5678 if not Is_OK_Static_Expression (Expr2) then
5679 Check_Mismatch (True);
5681 elsif Is_Discrete_Type (Etype (E1)) then
5682 declare
5683 V1 : constant Uint := Expr_Value (Expr1);
5684 V2 : constant Uint := Expr_Value (Expr2);
5685 begin
5686 Check_Mismatch (V1 /= V2);
5687 end;
5689 elsif Is_Real_Type (Etype (E1)) then
5690 declare
5691 V1 : constant Ureal := Expr_Value_R (Expr1);
5692 V2 : constant Ureal := Expr_Value_R (Expr2);
5693 begin
5694 Check_Mismatch (V1 /= V2);
5695 end;
5697 elsif Is_String_Type (Etype (E1))
5698 and then Nkind (Expr1) = N_String_Literal
5699 then
5700 if Nkind (Expr2) /= N_String_Literal then
5701 Check_Mismatch (True);
5702 else
5703 Check_Mismatch
5704 (not String_Equal (Strval (Expr1), Strval (Expr2)));
5705 end if;
5706 end if;
5708 elsif Is_Entity_Name (Expr1) then
5709 if Is_Entity_Name (Expr2) then
5710 if Entity (Expr1) = Entity (Expr2) then
5711 null;
5712 else
5713 Check_Mismatch
5714 (not Same_Instantiated_Constant
5715 (Entity (Expr1), Entity (Expr2)));
5716 end if;
5717 else
5718 Check_Mismatch (True);
5719 end if;
5721 elsif Is_Entity_Name (Original_Node (Expr1))
5722 and then Is_Entity_Name (Expr2)
5723 and then
5724 Same_Instantiated_Constant
5725 (Entity (Original_Node (Expr1)), Entity (Expr2))
5726 then
5727 null;
5729 elsif Nkind (Expr1) = N_Null then
5730 Check_Mismatch (Nkind (Expr1) /= N_Null);
5732 else
5733 Check_Mismatch (True);
5734 end if;
5736 elsif Ekind (E1) = E_Variable then
5737 Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5739 elsif Ekind (E1) = E_Package then
5740 Check_Mismatch
5741 (Ekind (E1) /= Ekind (E2)
5742 or else Renamed_Object (E1) /= Renamed_Object (E2));
5744 elsif Is_Overloadable (E1) then
5746 -- Verify that the actual subprograms match. Note that actuals
5747 -- that are attributes are rewritten as subprograms. If the
5748 -- subprogram in the formal package is defaulted, no check is
5749 -- needed. Note that this can only happen in Ada 2005 when the
5750 -- formal package can be partially parameterized.
5752 if Nkind (Unit_Declaration_Node (E1)) =
5753 N_Subprogram_Renaming_Declaration
5754 and then From_Default (Unit_Declaration_Node (E1))
5755 then
5756 null;
5758 -- If the formal package has an "others" box association that
5759 -- covers this formal, there is no need for a check either.
5761 elsif Nkind (Unit_Declaration_Node (E2)) in
5762 N_Formal_Subprogram_Declaration
5763 and then Box_Present (Unit_Declaration_Node (E2))
5764 then
5765 null;
5767 -- No check needed if subprogram is a defaulted null procedure
5769 elsif No (Alias (E2))
5770 and then Ekind (E2) = E_Procedure
5771 and then
5772 Null_Present (Specification (Unit_Declaration_Node (E2)))
5773 then
5774 null;
5776 -- Otherwise the actual in the formal and the actual in the
5777 -- instantiation of the formal must match, up to renamings.
5779 else
5780 Check_Mismatch
5781 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5782 end if;
5784 else
5785 raise Program_Error;
5786 end if;
5788 <<Next_E>>
5789 Next_Entity (E1);
5790 Next_Entity (E2);
5791 end loop;
5792 end Check_Formal_Package_Instance;
5794 ---------------------------
5795 -- Check_Formal_Packages --
5796 ---------------------------
5798 procedure Check_Formal_Packages (P_Id : Entity_Id) is
5799 E : Entity_Id;
5800 Formal_P : Entity_Id;
5802 begin
5803 -- Iterate through the declarations in the instance, looking for package
5804 -- renaming declarations that denote instances of formal packages. Stop
5805 -- when we find the renaming of the current package itself. The
5806 -- declaration for a formal package without a box is followed by an
5807 -- internal entity that repeats the instantiation.
5809 E := First_Entity (P_Id);
5810 while Present (E) loop
5811 if Ekind (E) = E_Package then
5812 if Renamed_Object (E) = P_Id then
5813 exit;
5815 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5816 null;
5818 elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5819 Formal_P := Next_Entity (E);
5820 Check_Formal_Package_Instance (Formal_P, E);
5822 -- After checking, remove the internal validating package. It
5823 -- is only needed for semantic checks, and as it may contain
5824 -- generic formal declarations it should not reach gigi.
5826 Remove (Unit_Declaration_Node (Formal_P));
5827 end if;
5828 end if;
5830 Next_Entity (E);
5831 end loop;
5832 end Check_Formal_Packages;
5834 ---------------------------------
5835 -- Check_Forward_Instantiation --
5836 ---------------------------------
5838 procedure Check_Forward_Instantiation (Decl : Node_Id) is
5839 S : Entity_Id;
5840 Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5842 begin
5843 -- The instantiation appears before the generic body if we are in the
5844 -- scope of the unit containing the generic, either in its spec or in
5845 -- the package body, and before the generic body.
5847 if Ekind (Gen_Comp) = E_Package_Body then
5848 Gen_Comp := Spec_Entity (Gen_Comp);
5849 end if;
5851 if In_Open_Scopes (Gen_Comp)
5852 and then No (Corresponding_Body (Decl))
5853 then
5854 S := Current_Scope;
5856 while Present (S)
5857 and then not Is_Compilation_Unit (S)
5858 and then not Is_Child_Unit (S)
5859 loop
5860 if Ekind (S) = E_Package then
5861 Set_Has_Forward_Instantiation (S);
5862 end if;
5864 S := Scope (S);
5865 end loop;
5866 end if;
5867 end Check_Forward_Instantiation;
5869 ---------------------------
5870 -- Check_Generic_Actuals --
5871 ---------------------------
5873 -- The visibility of the actuals may be different between the point of
5874 -- generic instantiation and the instantiation of the body.
5876 procedure Check_Generic_Actuals
5877 (Instance : Entity_Id;
5878 Is_Formal_Box : Boolean)
5880 E : Entity_Id;
5881 Astype : Entity_Id;
5883 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5884 -- For a formal that is an array type, the component type is often a
5885 -- previous formal in the same unit. The privacy status of the component
5886 -- type will have been examined earlier in the traversal of the
5887 -- corresponding actuals, and this status should not be modified for
5888 -- the array (sub)type itself. However, if the base type of the array
5889 -- (sub)type is private, its full view must be restored in the body to
5890 -- be consistent with subsequent index subtypes, etc.
5892 -- To detect this case we have to rescan the list of formals, which is
5893 -- usually short enough to ignore the resulting inefficiency.
5895 -----------------------------
5896 -- Denotes_Previous_Actual --
5897 -----------------------------
5899 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5900 Prev : Entity_Id;
5902 begin
5903 Prev := First_Entity (Instance);
5904 while Present (Prev) loop
5905 if Is_Type (Prev)
5906 and then Nkind (Parent (Prev)) = N_Subtype_Declaration
5907 and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
5908 and then Entity (Subtype_Indication (Parent (Prev))) = Typ
5909 then
5910 return True;
5912 elsif Prev = E then
5913 return False;
5915 else
5916 Next_Entity (Prev);
5917 end if;
5918 end loop;
5920 return False;
5921 end Denotes_Previous_Actual;
5923 -- Start of processing for Check_Generic_Actuals
5925 begin
5926 E := First_Entity (Instance);
5927 while Present (E) loop
5928 if Is_Type (E)
5929 and then Nkind (Parent (E)) = N_Subtype_Declaration
5930 and then Scope (Etype (E)) /= Instance
5931 and then Is_Entity_Name (Subtype_Indication (Parent (E)))
5932 then
5933 if Is_Array_Type (E)
5934 and then not Is_Private_Type (Etype (E))
5935 and then Denotes_Previous_Actual (Component_Type (E))
5936 then
5937 null;
5938 else
5939 Check_Private_View (Subtype_Indication (Parent (E)));
5940 end if;
5942 Set_Is_Generic_Actual_Type (E, True);
5943 Set_Is_Hidden (E, False);
5944 Set_Is_Potentially_Use_Visible (E,
5945 In_Use (Instance));
5947 -- We constructed the generic actual type as a subtype of the
5948 -- supplied type. This means that it normally would not inherit
5949 -- subtype specific attributes of the actual, which is wrong for
5950 -- the generic case.
5952 Astype := Ancestor_Subtype (E);
5954 if No (Astype) then
5956 -- This can happen when E is an itype that is the full view of
5957 -- a private type completed, e.g. with a constrained array. In
5958 -- that case, use the first subtype, which will carry size
5959 -- information. The base type itself is unconstrained and will
5960 -- not carry it.
5962 Astype := First_Subtype (E);
5963 end if;
5965 Set_Size_Info (E, (Astype));
5966 Set_RM_Size (E, RM_Size (Astype));
5967 Set_First_Rep_Item (E, First_Rep_Item (Astype));
5969 if Is_Discrete_Or_Fixed_Point_Type (E) then
5970 Set_RM_Size (E, RM_Size (Astype));
5972 -- In nested instances, the base type of an access actual may
5973 -- itself be private, and need to be exchanged.
5975 elsif Is_Access_Type (E)
5976 and then Is_Private_Type (Etype (E))
5977 then
5978 Check_Private_View
5979 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
5980 end if;
5982 elsif Ekind (E) = E_Package then
5984 -- If this is the renaming for the current instance, we're done.
5985 -- Otherwise it is a formal package. If the corresponding formal
5986 -- was declared with a box, the (instantiations of the) generic
5987 -- formal part are also visible. Otherwise, ignore the entity
5988 -- created to validate the actuals.
5990 if Renamed_Object (E) = Instance then
5991 exit;
5993 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5994 null;
5996 -- The visibility of a formal of an enclosing generic is already
5997 -- correct.
5999 elsif Denotes_Formal_Package (E) then
6000 null;
6002 elsif Present (Associated_Formal_Package (E))
6003 and then not Is_Generic_Formal (E)
6004 then
6005 if Box_Present (Parent (Associated_Formal_Package (E))) then
6006 Check_Generic_Actuals (Renamed_Object (E), True);
6008 else
6009 Check_Generic_Actuals (Renamed_Object (E), False);
6010 end if;
6012 Set_Is_Hidden (E, False);
6013 end if;
6015 -- If this is a subprogram instance (in a wrapper package) the
6016 -- actual is fully visible.
6018 elsif Is_Wrapper_Package (Instance) then
6019 Set_Is_Hidden (E, False);
6021 -- If the formal package is declared with a box, or if the formal
6022 -- parameter is defaulted, it is visible in the body.
6024 elsif Is_Formal_Box or else Is_Visible_Formal (E) then
6025 Set_Is_Hidden (E, False);
6026 end if;
6028 if Ekind (E) = E_Constant then
6030 -- If the type of the actual is a private type declared in the
6031 -- enclosing scope of the generic unit, the body of the generic
6032 -- sees the full view of the type (because it has to appear in
6033 -- the corresponding package body). If the type is private now,
6034 -- exchange views to restore the proper visiblity in the instance.
6036 declare
6037 Typ : constant Entity_Id := Base_Type (Etype (E));
6038 -- The type of the actual
6040 Gen_Id : Entity_Id;
6041 -- The generic unit
6043 Parent_Scope : Entity_Id;
6044 -- The enclosing scope of the generic unit
6046 begin
6047 if Is_Wrapper_Package (Instance) then
6048 Gen_Id :=
6049 Generic_Parent
6050 (Specification
6051 (Unit_Declaration_Node
6052 (Related_Instance (Instance))));
6053 else
6054 Gen_Id :=
6055 Generic_Parent (Package_Specification (Instance));
6056 end if;
6058 Parent_Scope := Scope (Gen_Id);
6060 -- The exchange is only needed if the generic is defined
6061 -- within a package which is not a common ancestor of the
6062 -- scope of the instance, and is not already in scope.
6064 if Is_Private_Type (Typ)
6065 and then Scope (Typ) = Parent_Scope
6066 and then Scope (Instance) /= Parent_Scope
6067 and then Ekind (Parent_Scope) = E_Package
6068 and then not Is_Child_Unit (Gen_Id)
6069 then
6070 Switch_View (Typ);
6072 -- If the type of the entity is a subtype, it may also have
6073 -- to be made visible, together with the base type of its
6074 -- full view, after exchange.
6076 if Is_Private_Type (Etype (E)) then
6077 Switch_View (Etype (E));
6078 Switch_View (Base_Type (Etype (E)));
6079 end if;
6080 end if;
6081 end;
6082 end if;
6084 Next_Entity (E);
6085 end loop;
6086 end Check_Generic_Actuals;
6088 ------------------------------
6089 -- Check_Generic_Child_Unit --
6090 ------------------------------
6092 procedure Check_Generic_Child_Unit
6093 (Gen_Id : Node_Id;
6094 Parent_Installed : in out Boolean)
6096 Loc : constant Source_Ptr := Sloc (Gen_Id);
6097 Gen_Par : Entity_Id := Empty;
6098 E : Entity_Id;
6099 Inst_Par : Entity_Id;
6100 S : Node_Id;
6102 function Find_Generic_Child
6103 (Scop : Entity_Id;
6104 Id : Node_Id) return Entity_Id;
6105 -- Search generic parent for possible child unit with the given name
6107 function In_Enclosing_Instance return Boolean;
6108 -- Within an instance of the parent, the child unit may be denoted by
6109 -- a simple name, or an abbreviated expanded name. Examine enclosing
6110 -- scopes to locate a possible parent instantiation.
6112 ------------------------
6113 -- Find_Generic_Child --
6114 ------------------------
6116 function Find_Generic_Child
6117 (Scop : Entity_Id;
6118 Id : Node_Id) return Entity_Id
6120 E : Entity_Id;
6122 begin
6123 -- If entity of name is already set, instance has already been
6124 -- resolved, e.g. in an enclosing instantiation.
6126 if Present (Entity (Id)) then
6127 if Scope (Entity (Id)) = Scop then
6128 return Entity (Id);
6129 else
6130 return Empty;
6131 end if;
6133 else
6134 E := First_Entity (Scop);
6135 while Present (E) loop
6136 if Chars (E) = Chars (Id)
6137 and then Is_Child_Unit (E)
6138 then
6139 if Is_Child_Unit (E)
6140 and then not Is_Visible_Lib_Unit (E)
6141 then
6142 Error_Msg_NE
6143 ("generic child unit& is not visible", Gen_Id, E);
6144 end if;
6146 Set_Entity (Id, E);
6147 return E;
6148 end if;
6150 Next_Entity (E);
6151 end loop;
6153 return Empty;
6154 end if;
6155 end Find_Generic_Child;
6157 ---------------------------
6158 -- In_Enclosing_Instance --
6159 ---------------------------
6161 function In_Enclosing_Instance return Boolean is
6162 Enclosing_Instance : Node_Id;
6163 Instance_Decl : Node_Id;
6165 begin
6166 -- We do not inline any call that contains instantiations, except
6167 -- for instantiations of Unchecked_Conversion, so if we are within
6168 -- an inlined body the current instance does not require parents.
6170 if In_Inlined_Body then
6171 pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
6172 return False;
6173 end if;
6175 -- Loop to check enclosing scopes
6177 Enclosing_Instance := Current_Scope;
6178 while Present (Enclosing_Instance) loop
6179 Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
6181 if Ekind (Enclosing_Instance) = E_Package
6182 and then Is_Generic_Instance (Enclosing_Instance)
6183 and then Present
6184 (Generic_Parent (Specification (Instance_Decl)))
6185 then
6186 -- Check whether the generic we are looking for is a child of
6187 -- this instance.
6189 E := Find_Generic_Child
6190 (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
6191 exit when Present (E);
6193 else
6194 E := Empty;
6195 end if;
6197 Enclosing_Instance := Scope (Enclosing_Instance);
6198 end loop;
6200 if No (E) then
6202 -- Not a child unit
6204 Analyze (Gen_Id);
6205 return False;
6207 else
6208 Rewrite (Gen_Id,
6209 Make_Expanded_Name (Loc,
6210 Chars => Chars (E),
6211 Prefix => New_Occurrence_Of (Enclosing_Instance, Loc),
6212 Selector_Name => New_Occurrence_Of (E, Loc)));
6214 Set_Entity (Gen_Id, E);
6215 Set_Etype (Gen_Id, Etype (E));
6216 Parent_Installed := False; -- Already in scope.
6217 return True;
6218 end if;
6219 end In_Enclosing_Instance;
6221 -- Start of processing for Check_Generic_Child_Unit
6223 begin
6224 -- If the name of the generic is given by a selected component, it may
6225 -- be the name of a generic child unit, and the prefix is the name of an
6226 -- instance of the parent, in which case the child unit must be visible.
6227 -- If this instance is not in scope, it must be placed there and removed
6228 -- after instantiation, because what is being instantiated is not the
6229 -- original child, but the corresponding child present in the instance
6230 -- of the parent.
6232 -- If the child is instantiated within the parent, it can be given by
6233 -- a simple name. In this case the instance is already in scope, but
6234 -- the child generic must be recovered from the generic parent as well.
6236 if Nkind (Gen_Id) = N_Selected_Component then
6237 S := Selector_Name (Gen_Id);
6238 Analyze (Prefix (Gen_Id));
6239 Inst_Par := Entity (Prefix (Gen_Id));
6241 if Ekind (Inst_Par) = E_Package
6242 and then Present (Renamed_Object (Inst_Par))
6243 then
6244 Inst_Par := Renamed_Object (Inst_Par);
6245 end if;
6247 if Ekind (Inst_Par) = E_Package then
6248 if Nkind (Parent (Inst_Par)) = N_Package_Specification then
6249 Gen_Par := Generic_Parent (Parent (Inst_Par));
6251 elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
6252 and then
6253 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
6254 then
6255 Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
6256 end if;
6258 elsif Ekind (Inst_Par) = E_Generic_Package
6259 and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
6260 then
6261 -- A formal package may be a real child package, and not the
6262 -- implicit instance within a parent. In this case the child is
6263 -- not visible and has to be retrieved explicitly as well.
6265 Gen_Par := Inst_Par;
6266 end if;
6268 if Present (Gen_Par) then
6270 -- The prefix denotes an instantiation. The entity itself may be a
6271 -- nested generic, or a child unit.
6273 E := Find_Generic_Child (Gen_Par, S);
6275 if Present (E) then
6276 Change_Selected_Component_To_Expanded_Name (Gen_Id);
6277 Set_Entity (Gen_Id, E);
6278 Set_Etype (Gen_Id, Etype (E));
6279 Set_Entity (S, E);
6280 Set_Etype (S, Etype (E));
6282 -- Indicate that this is a reference to the parent
6284 if In_Extended_Main_Source_Unit (Gen_Id) then
6285 Set_Is_Instantiated (Inst_Par);
6286 end if;
6288 -- A common mistake is to replicate the naming scheme of a
6289 -- hierarchy by instantiating a generic child directly, rather
6290 -- than the implicit child in a parent instance:
6292 -- generic .. package Gpar is ..
6293 -- generic .. package Gpar.Child is ..
6294 -- package Par is new Gpar ();
6296 -- with Gpar.Child;
6297 -- package Par.Child is new Gpar.Child ();
6298 -- rather than Par.Child
6300 -- In this case the instantiation is within Par, which is an
6301 -- instance, but Gpar does not denote Par because we are not IN
6302 -- the instance of Gpar, so this is illegal. The test below
6303 -- recognizes this particular case.
6305 if Is_Child_Unit (E)
6306 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
6307 and then (not In_Instance
6308 or else Nkind (Parent (Parent (Gen_Id))) =
6309 N_Compilation_Unit)
6310 then
6311 Error_Msg_N
6312 ("prefix of generic child unit must be instance of parent",
6313 Gen_Id);
6314 end if;
6316 if not In_Open_Scopes (Inst_Par)
6317 and then Nkind (Parent (Gen_Id)) not in
6318 N_Generic_Renaming_Declaration
6319 then
6320 Install_Parent (Inst_Par);
6321 Parent_Installed := True;
6323 elsif In_Open_Scopes (Inst_Par) then
6325 -- If the parent is already installed, install the actuals
6326 -- for its formal packages. This is necessary when the child
6327 -- instance is a child of the parent instance: in this case,
6328 -- the parent is placed on the scope stack but the formal
6329 -- packages are not made visible.
6331 Install_Formal_Packages (Inst_Par);
6332 end if;
6334 else
6335 -- If the generic parent does not contain an entity that
6336 -- corresponds to the selector, the instance doesn't either.
6337 -- Analyzing the node will yield the appropriate error message.
6338 -- If the entity is not a child unit, then it is an inner
6339 -- generic in the parent.
6341 Analyze (Gen_Id);
6342 end if;
6344 else
6345 Analyze (Gen_Id);
6347 if Is_Child_Unit (Entity (Gen_Id))
6348 and then
6349 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6350 and then not In_Open_Scopes (Inst_Par)
6351 then
6352 Install_Parent (Inst_Par);
6353 Parent_Installed := True;
6355 -- The generic unit may be the renaming of the implicit child
6356 -- present in an instance. In that case the parent instance is
6357 -- obtained from the name of the renamed entity.
6359 elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
6360 and then Present (Renamed_Entity (Entity (Gen_Id)))
6361 and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
6362 then
6363 declare
6364 Renamed_Package : constant Node_Id :=
6365 Name (Parent (Entity (Gen_Id)));
6366 begin
6367 if Nkind (Renamed_Package) = N_Expanded_Name then
6368 Inst_Par := Entity (Prefix (Renamed_Package));
6369 Install_Parent (Inst_Par);
6370 Parent_Installed := True;
6371 end if;
6372 end;
6373 end if;
6374 end if;
6376 elsif Nkind (Gen_Id) = N_Expanded_Name then
6378 -- Entity already present, analyze prefix, whose meaning may be
6379 -- an instance in the current context. If it is an instance of
6380 -- a relative within another, the proper parent may still have
6381 -- to be installed, if they are not of the same generation.
6383 Analyze (Prefix (Gen_Id));
6385 -- In the unlikely case that a local declaration hides the name
6386 -- of the parent package, locate it on the homonym chain. If the
6387 -- context is an instance of the parent, the renaming entity is
6388 -- flagged as such.
6390 Inst_Par := Entity (Prefix (Gen_Id));
6391 while Present (Inst_Par)
6392 and then not Is_Package_Or_Generic_Package (Inst_Par)
6393 loop
6394 Inst_Par := Homonym (Inst_Par);
6395 end loop;
6397 pragma Assert (Present (Inst_Par));
6398 Set_Entity (Prefix (Gen_Id), Inst_Par);
6400 if In_Enclosing_Instance then
6401 null;
6403 elsif Present (Entity (Gen_Id))
6404 and then Is_Child_Unit (Entity (Gen_Id))
6405 and then not In_Open_Scopes (Inst_Par)
6406 then
6407 Install_Parent (Inst_Par);
6408 Parent_Installed := True;
6409 end if;
6411 elsif In_Enclosing_Instance then
6413 -- The child unit is found in some enclosing scope
6415 null;
6417 else
6418 Analyze (Gen_Id);
6420 -- If this is the renaming of the implicit child in a parent
6421 -- instance, recover the parent name and install it.
6423 if Is_Entity_Name (Gen_Id) then
6424 E := Entity (Gen_Id);
6426 if Is_Generic_Unit (E)
6427 and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
6428 and then Is_Child_Unit (Renamed_Object (E))
6429 and then Is_Generic_Unit (Scope (Renamed_Object (E)))
6430 and then Nkind (Name (Parent (E))) = N_Expanded_Name
6431 then
6432 Rewrite (Gen_Id,
6433 New_Copy_Tree (Name (Parent (E))));
6434 Inst_Par := Entity (Prefix (Gen_Id));
6436 if not In_Open_Scopes (Inst_Par) then
6437 Install_Parent (Inst_Par);
6438 Parent_Installed := True;
6439 end if;
6441 -- If it is a child unit of a non-generic parent, it may be
6442 -- use-visible and given by a direct name. Install parent as
6443 -- for other cases.
6445 elsif Is_Generic_Unit (E)
6446 and then Is_Child_Unit (E)
6447 and then
6448 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6449 and then not Is_Generic_Unit (Scope (E))
6450 then
6451 if not In_Open_Scopes (Scope (E)) then
6452 Install_Parent (Scope (E));
6453 Parent_Installed := True;
6454 end if;
6455 end if;
6456 end if;
6457 end if;
6458 end Check_Generic_Child_Unit;
6460 -----------------------------
6461 -- Check_Hidden_Child_Unit --
6462 -----------------------------
6464 procedure Check_Hidden_Child_Unit
6465 (N : Node_Id;
6466 Gen_Unit : Entity_Id;
6467 Act_Decl_Id : Entity_Id)
6469 Gen_Id : constant Node_Id := Name (N);
6471 begin
6472 if Is_Child_Unit (Gen_Unit)
6473 and then Is_Child_Unit (Act_Decl_Id)
6474 and then Nkind (Gen_Id) = N_Expanded_Name
6475 and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
6476 and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
6477 then
6478 Error_Msg_Node_2 := Scope (Act_Decl_Id);
6479 Error_Msg_NE
6480 ("generic unit & is implicitly declared in &",
6481 Defining_Unit_Name (N), Gen_Unit);
6482 Error_Msg_N ("\instance must have different name",
6483 Defining_Unit_Name (N));
6484 end if;
6485 end Check_Hidden_Child_Unit;
6487 ------------------------
6488 -- Check_Private_View --
6489 ------------------------
6491 procedure Check_Private_View (N : Node_Id) is
6492 T : constant Entity_Id := Etype (N);
6493 BT : Entity_Id;
6495 begin
6496 -- Exchange views if the type was not private in the generic but is
6497 -- private at the point of instantiation. Do not exchange views if
6498 -- the scope of the type is in scope. This can happen if both generic
6499 -- and instance are sibling units, or if type is defined in a parent.
6500 -- In this case the visibility of the type will be correct for all
6501 -- semantic checks.
6503 if Present (T) then
6504 BT := Base_Type (T);
6506 if Is_Private_Type (T)
6507 and then not Has_Private_View (N)
6508 and then Present (Full_View (T))
6509 and then not In_Open_Scopes (Scope (T))
6510 then
6511 -- In the generic, the full type was visible. Save the private
6512 -- entity, for subsequent exchange.
6514 Switch_View (T);
6516 elsif Has_Private_View (N)
6517 and then not Is_Private_Type (T)
6518 and then not Has_Been_Exchanged (T)
6519 and then Etype (Get_Associated_Node (N)) /= T
6520 then
6521 -- Only the private declaration was visible in the generic. If
6522 -- the type appears in a subtype declaration, the subtype in the
6523 -- instance must have a view compatible with that of its parent,
6524 -- which must be exchanged (see corresponding code in Restore_
6525 -- Private_Views). Otherwise, if the type is defined in a parent
6526 -- unit, leave full visibility within instance, which is safe.
6528 if In_Open_Scopes (Scope (Base_Type (T)))
6529 and then not Is_Private_Type (Base_Type (T))
6530 and then Comes_From_Source (Base_Type (T))
6531 then
6532 null;
6534 elsif Nkind (Parent (N)) = N_Subtype_Declaration
6535 or else not In_Private_Part (Scope (Base_Type (T)))
6536 then
6537 Prepend_Elmt (T, Exchanged_Views);
6538 Exchange_Declarations (Etype (Get_Associated_Node (N)));
6539 end if;
6541 -- For composite types with inconsistent representation exchange
6542 -- component types accordingly.
6544 elsif Is_Access_Type (T)
6545 and then Is_Private_Type (Designated_Type (T))
6546 and then not Has_Private_View (N)
6547 and then Present (Full_View (Designated_Type (T)))
6548 then
6549 Switch_View (Designated_Type (T));
6551 elsif Is_Array_Type (T) then
6552 if Is_Private_Type (Component_Type (T))
6553 and then not Has_Private_View (N)
6554 and then Present (Full_View (Component_Type (T)))
6555 then
6556 Switch_View (Component_Type (T));
6557 end if;
6559 -- The normal exchange mechanism relies on the setting of a
6560 -- flag on the reference in the generic. However, an additional
6561 -- mechanism is needed for types that are not explicitly
6562 -- mentioned in the generic, but may be needed in expanded code
6563 -- in the instance. This includes component types of arrays and
6564 -- designated types of access types. This processing must also
6565 -- include the index types of arrays which we take care of here.
6567 declare
6568 Indx : Node_Id;
6569 Typ : Entity_Id;
6571 begin
6572 Indx := First_Index (T);
6573 while Present (Indx) loop
6574 Typ := Base_Type (Etype (Indx));
6576 if Is_Private_Type (Typ)
6577 and then Present (Full_View (Typ))
6578 then
6579 Switch_View (Typ);
6580 end if;
6582 Next_Index (Indx);
6583 end loop;
6584 end;
6586 elsif Is_Private_Type (T)
6587 and then Present (Full_View (T))
6588 and then Is_Array_Type (Full_View (T))
6589 and then Is_Private_Type (Component_Type (Full_View (T)))
6590 then
6591 Switch_View (T);
6593 -- Finally, a non-private subtype may have a private base type, which
6594 -- must be exchanged for consistency. This can happen when a package
6595 -- body is instantiated, when the scope stack is empty but in fact
6596 -- the subtype and the base type are declared in an enclosing scope.
6598 -- Note that in this case we introduce an inconsistency in the view
6599 -- set, because we switch the base type BT, but there could be some
6600 -- private dependent subtypes of BT which remain unswitched. Such
6601 -- subtypes might need to be switched at a later point (see specific
6602 -- provision for that case in Switch_View).
6604 elsif not Is_Private_Type (T)
6605 and then not Has_Private_View (N)
6606 and then Is_Private_Type (BT)
6607 and then Present (Full_View (BT))
6608 and then not Is_Generic_Type (BT)
6609 and then not In_Open_Scopes (BT)
6610 then
6611 Prepend_Elmt (Full_View (BT), Exchanged_Views);
6612 Exchange_Declarations (BT);
6613 end if;
6614 end if;
6615 end Check_Private_View;
6617 -----------------------------
6618 -- Check_Hidden_Primitives --
6619 -----------------------------
6621 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6622 Actual : Node_Id;
6623 Gen_T : Entity_Id;
6624 Result : Elist_Id := No_Elist;
6626 begin
6627 if No (Assoc_List) then
6628 return No_Elist;
6629 end if;
6631 -- Traverse the list of associations between formals and actuals
6632 -- searching for renamings of tagged types
6634 Actual := First (Assoc_List);
6635 while Present (Actual) loop
6636 if Nkind (Actual) = N_Subtype_Declaration then
6637 Gen_T := Generic_Parent_Type (Actual);
6639 if Present (Gen_T)
6640 and then Is_Tagged_Type (Gen_T)
6641 then
6642 -- Traverse the list of primitives of the actual types
6643 -- searching for hidden primitives that are visible in the
6644 -- corresponding generic formal; leave them visible and
6645 -- append them to Result to restore their decoration later.
6647 Install_Hidden_Primitives
6648 (Prims_List => Result,
6649 Gen_T => Gen_T,
6650 Act_T => Entity (Subtype_Indication (Actual)));
6651 end if;
6652 end if;
6654 Next (Actual);
6655 end loop;
6657 return Result;
6658 end Check_Hidden_Primitives;
6660 --------------------------
6661 -- Contains_Instance_Of --
6662 --------------------------
6664 function Contains_Instance_Of
6665 (Inner : Entity_Id;
6666 Outer : Entity_Id;
6667 N : Node_Id) return Boolean
6669 Elmt : Elmt_Id;
6670 Scop : Entity_Id;
6672 begin
6673 Scop := Outer;
6675 -- Verify that there are no circular instantiations. We check whether
6676 -- the unit contains an instance of the current scope or some enclosing
6677 -- scope (in case one of the instances appears in a subunit). Longer
6678 -- circularities involving subunits might seem too pathological to
6679 -- consider, but they were not too pathological for the authors of
6680 -- DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6681 -- enclosing generic scopes as containing an instance.
6683 loop
6684 -- Within a generic subprogram body, the scope is not generic, to
6685 -- allow for recursive subprograms. Use the declaration to determine
6686 -- whether this is a generic unit.
6688 if Ekind (Scop) = E_Generic_Package
6689 or else (Is_Subprogram (Scop)
6690 and then Nkind (Unit_Declaration_Node (Scop)) =
6691 N_Generic_Subprogram_Declaration)
6692 then
6693 Elmt := First_Elmt (Inner_Instances (Inner));
6695 while Present (Elmt) loop
6696 if Node (Elmt) = Scop then
6697 Error_Msg_Node_2 := Inner;
6698 Error_Msg_NE
6699 ("circular Instantiation: & instantiated within &!",
6700 N, Scop);
6701 return True;
6703 elsif Node (Elmt) = Inner then
6704 return True;
6706 elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6707 Error_Msg_Node_2 := Inner;
6708 Error_Msg_NE
6709 ("circular Instantiation: & instantiated within &!",
6710 N, Node (Elmt));
6711 return True;
6712 end if;
6714 Next_Elmt (Elmt);
6715 end loop;
6717 -- Indicate that Inner is being instantiated within Scop
6719 Append_Elmt (Inner, Inner_Instances (Scop));
6720 end if;
6722 if Scop = Standard_Standard then
6723 exit;
6724 else
6725 Scop := Scope (Scop);
6726 end if;
6727 end loop;
6729 return False;
6730 end Contains_Instance_Of;
6732 -----------------------
6733 -- Copy_Generic_Node --
6734 -----------------------
6736 function Copy_Generic_Node
6737 (N : Node_Id;
6738 Parent_Id : Node_Id;
6739 Instantiating : Boolean) return Node_Id
6741 Ent : Entity_Id;
6742 New_N : Node_Id;
6744 function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6745 -- Check the given value of one of the Fields referenced by the current
6746 -- node to determine whether to copy it recursively. The field may hold
6747 -- a Node_Id, a List_Id, or an Elist_Id, or a plain value (Sloc, Uint,
6748 -- Char) in which case it need not be copied.
6750 procedure Copy_Descendants;
6751 -- Common utility for various nodes
6753 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6754 -- Make copy of element list
6756 function Copy_Generic_List
6757 (L : List_Id;
6758 Parent_Id : Node_Id) return List_Id;
6759 -- Apply Copy_Node recursively to the members of a node list
6761 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6762 -- True if an identifier is part of the defining program unit name of
6763 -- a child unit. The entity of such an identifier must be kept (for
6764 -- ASIS use) even though as the name of an enclosing generic it would
6765 -- otherwise not be preserved in the generic tree.
6767 ----------------------
6768 -- Copy_Descendants --
6769 ----------------------
6771 procedure Copy_Descendants is
6773 use Atree.Unchecked_Access;
6774 -- This code section is part of the implementation of an untyped
6775 -- tree traversal, so it needs direct access to node fields.
6777 begin
6778 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6779 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6780 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6781 Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6782 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6783 end Copy_Descendants;
6785 -----------------------------
6786 -- Copy_Generic_Descendant --
6787 -----------------------------
6789 function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6790 begin
6791 if D = Union_Id (Empty) then
6792 return D;
6794 elsif D in Node_Range then
6795 return Union_Id
6796 (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6798 elsif D in List_Range then
6799 return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6801 elsif D in Elist_Range then
6802 return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6804 -- Nothing else is copyable (e.g. Uint values), return as is
6806 else
6807 return D;
6808 end if;
6809 end Copy_Generic_Descendant;
6811 ------------------------
6812 -- Copy_Generic_Elist --
6813 ------------------------
6815 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6816 M : Elmt_Id;
6817 L : Elist_Id;
6819 begin
6820 if Present (E) then
6821 L := New_Elmt_List;
6822 M := First_Elmt (E);
6823 while Present (M) loop
6824 Append_Elmt
6825 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6826 Next_Elmt (M);
6827 end loop;
6829 return L;
6831 else
6832 return No_Elist;
6833 end if;
6834 end Copy_Generic_Elist;
6836 -----------------------
6837 -- Copy_Generic_List --
6838 -----------------------
6840 function Copy_Generic_List
6841 (L : List_Id;
6842 Parent_Id : Node_Id) return List_Id
6844 N : Node_Id;
6845 New_L : List_Id;
6847 begin
6848 if Present (L) then
6849 New_L := New_List;
6850 Set_Parent (New_L, Parent_Id);
6852 N := First (L);
6853 while Present (N) loop
6854 Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6855 Next (N);
6856 end loop;
6858 return New_L;
6860 else
6861 return No_List;
6862 end if;
6863 end Copy_Generic_List;
6865 ---------------------------
6866 -- In_Defining_Unit_Name --
6867 ---------------------------
6869 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6870 begin
6871 return Present (Parent (Nam))
6872 and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6873 or else
6874 (Nkind (Parent (Nam)) = N_Expanded_Name
6875 and then In_Defining_Unit_Name (Parent (Nam))));
6876 end In_Defining_Unit_Name;
6878 -- Start of processing for Copy_Generic_Node
6880 begin
6881 if N = Empty then
6882 return N;
6883 end if;
6885 New_N := New_Copy (N);
6887 -- Copy aspects if present
6889 if Has_Aspects (N) then
6890 Set_Has_Aspects (New_N, False);
6891 Set_Aspect_Specifications
6892 (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6893 end if;
6895 if Instantiating then
6896 Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6897 end if;
6899 if not Is_List_Member (N) then
6900 Set_Parent (New_N, Parent_Id);
6901 end if;
6903 -- If defining identifier, then all fields have been copied already
6905 if Nkind (New_N) in N_Entity then
6906 null;
6908 -- Special casing for identifiers and other entity names and operators
6910 elsif Nkind_In (New_N, N_Identifier,
6911 N_Character_Literal,
6912 N_Expanded_Name,
6913 N_Operator_Symbol)
6914 or else Nkind (New_N) in N_Op
6915 then
6916 if not Instantiating then
6918 -- Link both nodes in order to assign subsequently the entity of
6919 -- the copy to the original node, in case this is a global
6920 -- reference.
6922 Set_Associated_Node (N, New_N);
6924 -- If we are within an instantiation, this is a nested generic
6925 -- that has already been analyzed at the point of definition.
6926 -- We must preserve references that were global to the enclosing
6927 -- parent at that point. Other occurrences, whether global or
6928 -- local to the current generic, must be resolved anew, so we
6929 -- reset the entity in the generic copy. A global reference has a
6930 -- smaller depth than the parent, or else the same depth in case
6931 -- both are distinct compilation units.
6933 -- A child unit is implicitly declared within the enclosing parent
6934 -- but is in fact global to it, and must be preserved.
6936 -- It is also possible for Current_Instantiated_Parent to be
6937 -- defined, and for this not to be a nested generic, namely if
6938 -- the unit is loaded through Rtsfind. In that case, the entity of
6939 -- New_N is only a link to the associated node, and not a defining
6940 -- occurrence.
6942 -- The entities for parent units in the defining_program_unit of a
6943 -- generic child unit are established when the context of the unit
6944 -- is first analyzed, before the generic copy is made. They are
6945 -- preserved in the copy for use in ASIS queries.
6947 Ent := Entity (New_N);
6949 if No (Current_Instantiated_Parent.Gen_Id) then
6950 if No (Ent)
6951 or else Nkind (Ent) /= N_Defining_Identifier
6952 or else not In_Defining_Unit_Name (N)
6953 then
6954 Set_Associated_Node (New_N, Empty);
6955 end if;
6957 elsif No (Ent)
6958 or else
6959 not Nkind_In (Ent, N_Defining_Identifier,
6960 N_Defining_Character_Literal,
6961 N_Defining_Operator_Symbol)
6962 or else No (Scope (Ent))
6963 or else
6964 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
6965 and then not Is_Child_Unit (Ent))
6966 or else
6967 (Scope_Depth (Scope (Ent)) >
6968 Scope_Depth (Current_Instantiated_Parent.Gen_Id)
6969 and then
6970 Get_Source_Unit (Ent) =
6971 Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
6972 then
6973 Set_Associated_Node (New_N, Empty);
6974 end if;
6976 -- Case of instantiating identifier or some other name or operator
6978 else
6979 -- If the associated node is still defined, the entity in it
6980 -- is global, and must be copied to the instance. If this copy
6981 -- is being made for a body to inline, it is applied to an
6982 -- instantiated tree, and the entity is already present and
6983 -- must be also preserved.
6985 declare
6986 Assoc : constant Node_Id := Get_Associated_Node (N);
6988 begin
6989 if Present (Assoc) then
6990 if Nkind (Assoc) = Nkind (N) then
6991 Set_Entity (New_N, Entity (Assoc));
6992 Check_Private_View (N);
6994 -- The name in the call may be a selected component if the
6995 -- call has not been analyzed yet, as may be the case for
6996 -- pre/post conditions in a generic unit.
6998 elsif Nkind (Assoc) = N_Function_Call
6999 and then Is_Entity_Name (Name (Assoc))
7000 then
7001 Set_Entity (New_N, Entity (Name (Assoc)));
7003 elsif Nkind_In (Assoc, N_Defining_Identifier,
7004 N_Defining_Character_Literal,
7005 N_Defining_Operator_Symbol)
7006 and then Expander_Active
7007 then
7008 -- Inlining case: we are copying a tree that contains
7009 -- global entities, which are preserved in the copy to be
7010 -- used for subsequent inlining.
7012 null;
7014 else
7015 Set_Entity (New_N, Empty);
7016 end if;
7017 end if;
7018 end;
7019 end if;
7021 -- For expanded name, we must copy the Prefix and Selector_Name
7023 if Nkind (N) = N_Expanded_Name then
7024 Set_Prefix
7025 (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
7027 Set_Selector_Name (New_N,
7028 Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
7030 -- For operators, we must copy the right operand
7032 elsif Nkind (N) in N_Op then
7033 Set_Right_Opnd (New_N,
7034 Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
7036 -- And for binary operators, the left operand as well
7038 if Nkind (N) in N_Binary_Op then
7039 Set_Left_Opnd (New_N,
7040 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
7041 end if;
7042 end if;
7044 -- Special casing for stubs
7046 elsif Nkind (N) in N_Body_Stub then
7048 -- In any case, we must copy the specification or defining
7049 -- identifier as appropriate.
7051 if Nkind (N) = N_Subprogram_Body_Stub then
7052 Set_Specification (New_N,
7053 Copy_Generic_Node (Specification (N), New_N, Instantiating));
7055 else
7056 Set_Defining_Identifier (New_N,
7057 Copy_Generic_Node
7058 (Defining_Identifier (N), New_N, Instantiating));
7059 end if;
7061 -- If we are not instantiating, then this is where we load and
7062 -- analyze subunits, i.e. at the point where the stub occurs. A
7063 -- more permissive system might defer this analysis to the point
7064 -- of instantiation, but this seems too complicated for now.
7066 if not Instantiating then
7067 declare
7068 Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
7069 Subunit : Node_Id;
7070 Unum : Unit_Number_Type;
7071 New_Body : Node_Id;
7073 begin
7074 -- Make sure that, if it is a subunit of the main unit that is
7075 -- preprocessed and if -gnateG is specified, the preprocessed
7076 -- file will be written.
7078 Lib.Analysing_Subunit_Of_Main :=
7079 Lib.In_Extended_Main_Source_Unit (N);
7080 Unum :=
7081 Load_Unit
7082 (Load_Name => Subunit_Name,
7083 Required => False,
7084 Subunit => True,
7085 Error_Node => N);
7086 Lib.Analysing_Subunit_Of_Main := False;
7088 -- If the proper body is not found, a warning message will be
7089 -- emitted when analyzing the stub, or later at the point of
7090 -- instantiation. Here we just leave the stub as is.
7092 if Unum = No_Unit then
7093 Subunits_Missing := True;
7094 goto Subunit_Not_Found;
7095 end if;
7097 Subunit := Cunit (Unum);
7099 if Nkind (Unit (Subunit)) /= N_Subunit then
7100 Error_Msg_N
7101 ("found child unit instead of expected SEPARATE subunit",
7102 Subunit);
7103 Error_Msg_Sloc := Sloc (N);
7104 Error_Msg_N ("\to complete stub #", Subunit);
7105 goto Subunit_Not_Found;
7106 end if;
7108 -- We must create a generic copy of the subunit, in order to
7109 -- perform semantic analysis on it, and we must replace the
7110 -- stub in the original generic unit with the subunit, in order
7111 -- to preserve non-local references within.
7113 -- Only the proper body needs to be copied. Library_Unit and
7114 -- context clause are simply inherited by the generic copy.
7115 -- Note that the copy (which may be recursive if there are
7116 -- nested subunits) must be done first, before attaching it to
7117 -- the enclosing generic.
7119 New_Body :=
7120 Copy_Generic_Node
7121 (Proper_Body (Unit (Subunit)),
7122 Empty, Instantiating => False);
7124 -- Now place the original proper body in the original generic
7125 -- unit. This is a body, not a compilation unit.
7127 Rewrite (N, Proper_Body (Unit (Subunit)));
7128 Set_Is_Compilation_Unit (Defining_Entity (N), False);
7129 Set_Was_Originally_Stub (N);
7131 -- Finally replace the body of the subunit with its copy, and
7132 -- make this new subunit into the library unit of the generic
7133 -- copy, which does not have stubs any longer.
7135 Set_Proper_Body (Unit (Subunit), New_Body);
7136 Set_Library_Unit (New_N, Subunit);
7137 Inherit_Context (Unit (Subunit), N);
7138 end;
7140 -- If we are instantiating, this must be an error case, since
7141 -- otherwise we would have replaced the stub node by the proper body
7142 -- that corresponds. So just ignore it in the copy (i.e. we have
7143 -- copied it, and that is good enough).
7145 else
7146 null;
7147 end if;
7149 <<Subunit_Not_Found>> null;
7151 -- If the node is a compilation unit, it is the subunit of a stub, which
7152 -- has been loaded already (see code below). In this case, the library
7153 -- unit field of N points to the parent unit (which is a compilation
7154 -- unit) and need not (and cannot) be copied.
7156 -- When the proper body of the stub is analyzed, the library_unit link
7157 -- is used to establish the proper context (see sem_ch10).
7159 -- The other fields of a compilation unit are copied as usual
7161 elsif Nkind (N) = N_Compilation_Unit then
7163 -- This code can only be executed when not instantiating, because in
7164 -- the copy made for an instantiation, the compilation unit node has
7165 -- disappeared at the point that a stub is replaced by its proper
7166 -- body.
7168 pragma Assert (not Instantiating);
7170 Set_Context_Items (New_N,
7171 Copy_Generic_List (Context_Items (N), New_N));
7173 Set_Unit (New_N,
7174 Copy_Generic_Node (Unit (N), New_N, False));
7176 Set_First_Inlined_Subprogram (New_N,
7177 Copy_Generic_Node
7178 (First_Inlined_Subprogram (N), New_N, False));
7180 Set_Aux_Decls_Node (New_N,
7181 Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
7183 -- For an assignment node, the assignment is known to be semantically
7184 -- legal if we are instantiating the template. This avoids incorrect
7185 -- diagnostics in generated code.
7187 elsif Nkind (N) = N_Assignment_Statement then
7189 -- Copy name and expression fields in usual manner
7191 Set_Name (New_N,
7192 Copy_Generic_Node (Name (N), New_N, Instantiating));
7194 Set_Expression (New_N,
7195 Copy_Generic_Node (Expression (N), New_N, Instantiating));
7197 if Instantiating then
7198 Set_Assignment_OK (Name (New_N), True);
7199 end if;
7201 elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
7202 if not Instantiating then
7203 Set_Associated_Node (N, New_N);
7205 else
7206 if Present (Get_Associated_Node (N))
7207 and then Nkind (Get_Associated_Node (N)) = Nkind (N)
7208 then
7209 -- In the generic the aggregate has some composite type. If at
7210 -- the point of instantiation the type has a private view,
7211 -- install the full view (and that of its ancestors, if any).
7213 declare
7214 T : Entity_Id := (Etype (Get_Associated_Node (New_N)));
7215 Rt : Entity_Id;
7217 begin
7218 if Present (T)
7219 and then Is_Private_Type (T)
7220 then
7221 Switch_View (T);
7222 end if;
7224 if Present (T)
7225 and then Is_Tagged_Type (T)
7226 and then Is_Derived_Type (T)
7227 then
7228 Rt := Root_Type (T);
7230 loop
7231 T := Etype (T);
7233 if Is_Private_Type (T) then
7234 Switch_View (T);
7235 end if;
7237 exit when T = Rt;
7238 end loop;
7239 end if;
7240 end;
7241 end if;
7242 end if;
7244 -- Do not copy the associated node, which points to the generic copy
7245 -- of the aggregate.
7247 declare
7248 use Atree.Unchecked_Access;
7249 -- This code section is part of the implementation of an untyped
7250 -- tree traversal, so it needs direct access to node fields.
7252 begin
7253 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
7254 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
7255 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
7256 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
7257 end;
7259 -- Allocators do not have an identifier denoting the access type, so we
7260 -- must locate it through the expression to check whether the views are
7261 -- consistent.
7263 elsif Nkind (N) = N_Allocator
7264 and then Nkind (Expression (N)) = N_Qualified_Expression
7265 and then Is_Entity_Name (Subtype_Mark (Expression (N)))
7266 and then Instantiating
7267 then
7268 declare
7269 T : constant Node_Id :=
7270 Get_Associated_Node (Subtype_Mark (Expression (N)));
7271 Acc_T : Entity_Id;
7273 begin
7274 if Present (T) then
7276 -- Retrieve the allocator node in the generic copy
7278 Acc_T := Etype (Parent (Parent (T)));
7279 if Present (Acc_T)
7280 and then Is_Private_Type (Acc_T)
7281 then
7282 Switch_View (Acc_T);
7283 end if;
7284 end if;
7286 Copy_Descendants;
7287 end;
7289 -- For a proper body, we must catch the case of a proper body that
7290 -- replaces a stub. This represents the point at which a separate
7291 -- compilation unit, and hence template file, may be referenced, so we
7292 -- must make a new source instantiation entry for the template of the
7293 -- subunit, and ensure that all nodes in the subunit are adjusted using
7294 -- this new source instantiation entry.
7296 elsif Nkind (N) in N_Proper_Body then
7297 declare
7298 Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
7300 begin
7301 if Instantiating and then Was_Originally_Stub (N) then
7302 Create_Instantiation_Source
7303 (Instantiation_Node,
7304 Defining_Entity (N),
7305 False,
7306 S_Adjustment);
7307 end if;
7309 -- Now copy the fields of the proper body, using the new
7310 -- adjustment factor if one was needed as per test above.
7312 Copy_Descendants;
7314 -- Restore the original adjustment factor in case changed
7316 S_Adjustment := Save_Adjustment;
7317 end;
7319 -- Don't copy Ident or Comment pragmas, since the comment belongs to the
7320 -- generic unit, not to the instantiating unit.
7322 elsif Nkind (N) = N_Pragma and then Instantiating then
7323 declare
7324 Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
7325 begin
7326 if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
7327 New_N := Make_Null_Statement (Sloc (N));
7328 else
7329 Copy_Descendants;
7330 end if;
7331 end;
7333 elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
7335 -- No descendant fields need traversing
7337 null;
7339 elsif Nkind (N) = N_String_Literal
7340 and then Present (Etype (N))
7341 and then Instantiating
7342 then
7343 -- If the string is declared in an outer scope, the string_literal
7344 -- subtype created for it may have the wrong scope. We force the
7345 -- reanalysis of the constant to generate a new itype in the proper
7346 -- context.
7348 Set_Etype (New_N, Empty);
7349 Set_Analyzed (New_N, False);
7351 -- For the remaining nodes, copy their descendants recursively
7353 else
7354 Copy_Descendants;
7356 if Instantiating and then Nkind (N) = N_Subprogram_Body then
7357 Set_Generic_Parent (Specification (New_N), N);
7359 -- Should preserve Corresponding_Spec??? (12.3(14))
7360 end if;
7361 end if;
7363 return New_N;
7364 end Copy_Generic_Node;
7366 ----------------------------
7367 -- Denotes_Formal_Package --
7368 ----------------------------
7370 function Denotes_Formal_Package
7371 (Pack : Entity_Id;
7372 On_Exit : Boolean := False;
7373 Instance : Entity_Id := Empty) return Boolean
7375 Par : Entity_Id;
7376 Scop : constant Entity_Id := Scope (Pack);
7377 E : Entity_Id;
7379 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
7380 -- The package in question may be an actual for a previous formal
7381 -- package P of the current instance, so examine its actuals as well.
7382 -- This must be recursive over other formal packages.
7384 ----------------------------------
7385 -- Is_Actual_Of_Previous_Formal --
7386 ----------------------------------
7388 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
7389 E1 : Entity_Id;
7391 begin
7392 E1 := First_Entity (P);
7393 while Present (E1) and then E1 /= Instance loop
7394 if Ekind (E1) = E_Package
7395 and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
7396 then
7397 if Renamed_Object (E1) = Pack then
7398 return True;
7400 elsif E1 = P or else Renamed_Object (E1) = P then
7401 return False;
7403 elsif Is_Actual_Of_Previous_Formal (E1) then
7404 return True;
7405 end if;
7406 end if;
7408 Next_Entity (E1);
7409 end loop;
7411 return False;
7412 end Is_Actual_Of_Previous_Formal;
7414 -- Start of processing for Denotes_Formal_Package
7416 begin
7417 if On_Exit then
7418 Par :=
7419 Instance_Envs.Table
7420 (Instance_Envs.Last).Instantiated_Parent.Act_Id;
7421 else
7422 Par := Current_Instantiated_Parent.Act_Id;
7423 end if;
7425 if Ekind (Scop) = E_Generic_Package
7426 or else Nkind (Unit_Declaration_Node (Scop)) =
7427 N_Generic_Subprogram_Declaration
7428 then
7429 return True;
7431 elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
7432 N_Formal_Package_Declaration
7433 then
7434 return True;
7436 elsif No (Par) then
7437 return False;
7439 else
7440 -- Check whether this package is associated with a formal package of
7441 -- the enclosing instantiation. Iterate over the list of renamings.
7443 E := First_Entity (Par);
7444 while Present (E) loop
7445 if Ekind (E) /= E_Package
7446 or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
7447 then
7448 null;
7450 elsif Renamed_Object (E) = Par then
7451 return False;
7453 elsif Renamed_Object (E) = Pack then
7454 return True;
7456 elsif Is_Actual_Of_Previous_Formal (E) then
7457 return True;
7459 end if;
7461 Next_Entity (E);
7462 end loop;
7464 return False;
7465 end if;
7466 end Denotes_Formal_Package;
7468 -----------------
7469 -- End_Generic --
7470 -----------------
7472 procedure End_Generic is
7473 begin
7474 -- ??? More things could be factored out in this routine. Should
7475 -- probably be done at a later stage.
7477 Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
7478 Generic_Flags.Decrement_Last;
7480 Expander_Mode_Restore;
7481 end End_Generic;
7483 -------------
7484 -- Earlier --
7485 -------------
7487 function Earlier (N1, N2 : Node_Id) return Boolean is
7488 procedure Find_Depth (P : in out Node_Id; D : in out Integer);
7489 -- Find distance from given node to enclosing compilation unit
7491 ----------------
7492 -- Find_Depth --
7493 ----------------
7495 procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
7496 begin
7497 while Present (P)
7498 and then Nkind (P) /= N_Compilation_Unit
7499 loop
7500 P := True_Parent (P);
7501 D := D + 1;
7502 end loop;
7503 end Find_Depth;
7505 -- Local declarations
7507 D1 : Integer := 0;
7508 D2 : Integer := 0;
7509 P1 : Node_Id := N1;
7510 P2 : Node_Id := N2;
7511 T1 : Source_Ptr;
7512 T2 : Source_Ptr;
7514 -- Start of processing for Earlier
7516 begin
7517 Find_Depth (P1, D1);
7518 Find_Depth (P2, D2);
7520 if P1 /= P2 then
7521 return False;
7522 else
7523 P1 := N1;
7524 P2 := N2;
7525 end if;
7527 while D1 > D2 loop
7528 P1 := True_Parent (P1);
7529 D1 := D1 - 1;
7530 end loop;
7532 while D2 > D1 loop
7533 P2 := True_Parent (P2);
7534 D2 := D2 - 1;
7535 end loop;
7537 -- At this point P1 and P2 are at the same distance from the root.
7538 -- We examine their parents until we find a common declarative list.
7539 -- If we reach the root, N1 and N2 do not descend from the same
7540 -- declarative list (e.g. one is nested in the declarative part and
7541 -- the other is in a block in the statement part) and the earlier
7542 -- one is already frozen.
7544 while not Is_List_Member (P1)
7545 or else not Is_List_Member (P2)
7546 or else List_Containing (P1) /= List_Containing (P2)
7547 loop
7548 P1 := True_Parent (P1);
7549 P2 := True_Parent (P2);
7551 if Nkind (Parent (P1)) = N_Subunit then
7552 P1 := Corresponding_Stub (Parent (P1));
7553 end if;
7555 if Nkind (Parent (P2)) = N_Subunit then
7556 P2 := Corresponding_Stub (Parent (P2));
7557 end if;
7559 if P1 = P2 then
7560 return False;
7561 end if;
7562 end loop;
7564 -- Expanded code usually shares the source location of the original
7565 -- construct it was generated for. This however may not necessarely
7566 -- reflect the true location of the code within the tree.
7568 -- Before comparing the slocs of the two nodes, make sure that we are
7569 -- working with correct source locations. Assume that P1 is to the left
7570 -- of P2. If either one does not come from source, traverse the common
7571 -- list heading towards the other node and locate the first source
7572 -- statement.
7574 -- P1 P2
7575 -- ----+===+===+--------------+===+===+----
7576 -- expanded code expanded code
7578 if not Comes_From_Source (P1) then
7579 while Present (P1) loop
7581 -- Neither P2 nor a source statement were located during the
7582 -- search. If we reach the end of the list, then P1 does not
7583 -- occur earlier than P2.
7585 -- ---->
7586 -- start --- P2 ----- P1 --- end
7588 if No (Next (P1)) then
7589 return False;
7591 -- We encounter P2 while going to the right of the list. This
7592 -- means that P1 does indeed appear earlier.
7594 -- ---->
7595 -- start --- P1 ===== P2 --- end
7596 -- expanded code in between
7598 elsif P1 = P2 then
7599 return True;
7601 -- No need to look any further since we have located a source
7602 -- statement.
7604 elsif Comes_From_Source (P1) then
7605 exit;
7606 end if;
7608 -- Keep going right
7610 Next (P1);
7611 end loop;
7612 end if;
7614 if not Comes_From_Source (P2) then
7615 while Present (P2) loop
7617 -- Neither P1 nor a source statement were located during the
7618 -- search. If we reach the start of the list, then P1 does not
7619 -- occur earlier than P2.
7621 -- <----
7622 -- start --- P2 --- P1 --- end
7624 if No (Prev (P2)) then
7625 return False;
7627 -- We encounter P1 while going to the left of the list. This
7628 -- means that P1 does indeed appear earlier.
7630 -- <----
7631 -- start --- P1 ===== P2 --- end
7632 -- expanded code in between
7634 elsif P2 = P1 then
7635 return True;
7637 -- No need to look any further since we have located a source
7638 -- statement.
7640 elsif Comes_From_Source (P2) then
7641 exit;
7642 end if;
7644 -- Keep going left
7646 Prev (P2);
7647 end loop;
7648 end if;
7650 -- At this point either both nodes came from source or we approximated
7651 -- their source locations through neighbouring source statements.
7653 T1 := Top_Level_Location (Sloc (P1));
7654 T2 := Top_Level_Location (Sloc (P2));
7656 -- When two nodes come from the same instance, they have identical top
7657 -- level locations. To determine proper relation within the tree, check
7658 -- their locations within the template.
7660 if T1 = T2 then
7661 return Sloc (P1) < Sloc (P2);
7663 -- The two nodes either come from unrelated instances or do not come
7664 -- from instantiated code at all.
7666 else
7667 return T1 < T2;
7668 end if;
7669 end Earlier;
7671 ----------------------
7672 -- Find_Actual_Type --
7673 ----------------------
7675 function Find_Actual_Type
7676 (Typ : Entity_Id;
7677 Gen_Type : Entity_Id) return Entity_Id
7679 Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7680 T : Entity_Id;
7682 begin
7683 -- Special processing only applies to child units
7685 if not Is_Child_Unit (Gen_Scope) then
7686 return Get_Instance_Of (Typ);
7688 -- If designated or component type is itself a formal of the child unit,
7689 -- its instance is available.
7691 elsif Scope (Typ) = Gen_Scope then
7692 return Get_Instance_Of (Typ);
7694 -- If the array or access type is not declared in the parent unit,
7695 -- no special processing needed.
7697 elsif not Is_Generic_Type (Typ)
7698 and then Scope (Gen_Scope) /= Scope (Typ)
7699 then
7700 return Get_Instance_Of (Typ);
7702 -- Otherwise, retrieve designated or component type by visibility
7704 else
7705 T := Current_Entity (Typ);
7706 while Present (T) loop
7707 if In_Open_Scopes (Scope (T)) then
7708 return T;
7710 elsif Is_Generic_Actual_Type (T) then
7711 return T;
7712 end if;
7714 T := Homonym (T);
7715 end loop;
7717 return Typ;
7718 end if;
7719 end Find_Actual_Type;
7721 ----------------------------
7722 -- Freeze_Subprogram_Body --
7723 ----------------------------
7725 procedure Freeze_Subprogram_Body
7726 (Inst_Node : Node_Id;
7727 Gen_Body : Node_Id;
7728 Pack_Id : Entity_Id)
7730 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7731 Par : constant Entity_Id := Scope (Gen_Unit);
7732 E_G_Id : Entity_Id;
7733 Enc_G : Entity_Id;
7734 Enc_I : Node_Id;
7735 F_Node : Node_Id;
7737 function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7738 -- Find innermost package body that encloses the given node, and which
7739 -- is not a compilation unit. Freeze nodes for the instance, or for its
7740 -- enclosing body, may be inserted after the enclosing_body of the
7741 -- generic unit. Used to determine proper placement of freeze node for
7742 -- both package and subprogram instances.
7744 function Package_Freeze_Node (B : Node_Id) return Node_Id;
7745 -- Find entity for given package body, and locate or create a freeze
7746 -- node for it.
7748 ----------------------------
7749 -- Enclosing_Package_Body --
7750 ----------------------------
7752 function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7753 P : Node_Id;
7755 begin
7756 P := Parent (N);
7757 while Present (P)
7758 and then Nkind (Parent (P)) /= N_Compilation_Unit
7759 loop
7760 if Nkind (P) = N_Package_Body then
7761 if Nkind (Parent (P)) = N_Subunit then
7762 return Corresponding_Stub (Parent (P));
7763 else
7764 return P;
7765 end if;
7766 end if;
7768 P := True_Parent (P);
7769 end loop;
7771 return Empty;
7772 end Enclosing_Package_Body;
7774 -------------------------
7775 -- Package_Freeze_Node --
7776 -------------------------
7778 function Package_Freeze_Node (B : Node_Id) return Node_Id is
7779 Id : Entity_Id;
7781 begin
7782 if Nkind (B) = N_Package_Body then
7783 Id := Corresponding_Spec (B);
7784 else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7785 Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7786 end if;
7788 Ensure_Freeze_Node (Id);
7789 return Freeze_Node (Id);
7790 end Package_Freeze_Node;
7792 -- Start of processing of Freeze_Subprogram_Body
7794 begin
7795 -- If the instance and the generic body appear within the same unit, and
7796 -- the instance precedes the generic, the freeze node for the instance
7797 -- must appear after that of the generic. If the generic is nested
7798 -- within another instance I2, then current instance must be frozen
7799 -- after I2. In both cases, the freeze nodes are those of enclosing
7800 -- packages. Otherwise, the freeze node is placed at the end of the
7801 -- current declarative part.
7803 Enc_G := Enclosing_Package_Body (Gen_Body);
7804 Enc_I := Enclosing_Package_Body (Inst_Node);
7805 Ensure_Freeze_Node (Pack_Id);
7806 F_Node := Freeze_Node (Pack_Id);
7808 if Is_Generic_Instance (Par)
7809 and then Present (Freeze_Node (Par))
7810 and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7811 then
7812 -- The parent was a premature instantiation. Insert freeze node at
7813 -- the end the current declarative part.
7815 if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7816 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7818 -- Handle the following case:
7820 -- package Parent_Inst is new ...
7821 -- Parent_Inst []
7823 -- procedure P ... -- this body freezes Parent_Inst
7825 -- package Inst is new ...
7827 -- In this particular scenario, the freeze node for Inst must be
7828 -- inserted in the same manner as that of Parent_Inst - before the
7829 -- next source body or at the end of the declarative list (body not
7830 -- available). If body P did not exist and Parent_Inst was frozen
7831 -- after Inst, either by a body following Inst or at the end of the
7832 -- declarative region, the freeze node for Inst must be inserted
7833 -- after that of Parent_Inst. This relation is established by
7834 -- comparing the Slocs of Parent_Inst freeze node and Inst.
7836 elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7837 List_Containing (Inst_Node)
7838 and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7839 then
7840 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7842 else
7843 Insert_After (Freeze_Node (Par), F_Node);
7844 end if;
7846 -- The body enclosing the instance should be frozen after the body that
7847 -- includes the generic, because the body of the instance may make
7848 -- references to entities therein. If the two are not in the same
7849 -- declarative part, or if the one enclosing the instance is frozen
7850 -- already, freeze the instance at the end of the current declarative
7851 -- part.
7853 elsif Is_Generic_Instance (Par)
7854 and then Present (Freeze_Node (Par))
7855 and then Present (Enc_I)
7856 then
7857 if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7858 or else
7859 (Nkind (Enc_I) = N_Package_Body
7860 and then
7861 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7862 then
7863 -- The enclosing package may contain several instances. Rather
7864 -- than computing the earliest point at which to insert its freeze
7865 -- node, we place it at the end of the declarative part of the
7866 -- parent of the generic.
7868 Insert_Freeze_Node_For_Instance
7869 (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7870 end if;
7872 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7874 elsif Present (Enc_G)
7875 and then Present (Enc_I)
7876 and then Enc_G /= Enc_I
7877 and then Earlier (Inst_Node, Gen_Body)
7878 then
7879 if Nkind (Enc_G) = N_Package_Body then
7880 E_G_Id := Corresponding_Spec (Enc_G);
7881 else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7882 E_G_Id :=
7883 Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7884 end if;
7886 -- Freeze package that encloses instance, and place node after the
7887 -- package that encloses generic. If enclosing package is already
7888 -- frozen we have to assume it is at the proper place. This may be a
7889 -- potential ABE that requires dynamic checking. Do not add a freeze
7890 -- node if the package that encloses the generic is inside the body
7891 -- that encloses the instance, because the freeze node would be in
7892 -- the wrong scope. Additional contortions needed if the bodies are
7893 -- within a subunit.
7895 declare
7896 Enclosing_Body : Node_Id;
7898 begin
7899 if Nkind (Enc_I) = N_Package_Body_Stub then
7900 Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7901 else
7902 Enclosing_Body := Enc_I;
7903 end if;
7905 if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
7906 Insert_Freeze_Node_For_Instance
7907 (Enc_G, Package_Freeze_Node (Enc_I));
7908 end if;
7909 end;
7911 -- Freeze enclosing subunit before instance
7913 Ensure_Freeze_Node (E_G_Id);
7915 if not Is_List_Member (Freeze_Node (E_G_Id)) then
7916 Insert_After (Enc_G, Freeze_Node (E_G_Id));
7917 end if;
7919 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7921 else
7922 -- If none of the above, insert freeze node at the end of the current
7923 -- declarative part.
7925 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7926 end if;
7927 end Freeze_Subprogram_Body;
7929 ----------------
7930 -- Get_Gen_Id --
7931 ----------------
7933 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
7934 begin
7935 return Generic_Renamings.Table (E).Gen_Id;
7936 end Get_Gen_Id;
7938 ---------------------
7939 -- Get_Instance_Of --
7940 ---------------------
7942 function Get_Instance_Of (A : Entity_Id) return Entity_Id is
7943 Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
7945 begin
7946 if Res /= Assoc_Null then
7947 return Generic_Renamings.Table (Res).Act_Id;
7948 else
7949 -- On exit, entity is not instantiated: not a generic parameter, or
7950 -- else parameter of an inner generic unit.
7952 return A;
7953 end if;
7954 end Get_Instance_Of;
7956 ------------------------------------
7957 -- Get_Package_Instantiation_Node --
7958 ------------------------------------
7960 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
7961 Decl : Node_Id := Unit_Declaration_Node (A);
7962 Inst : Node_Id;
7964 begin
7965 -- If the Package_Instantiation attribute has been set on the package
7966 -- entity, then use it directly when it (or its Original_Node) refers
7967 -- to an N_Package_Instantiation node. In principle it should be
7968 -- possible to have this field set in all cases, which should be
7969 -- investigated, and would allow this function to be significantly
7970 -- simplified. ???
7972 Inst := Package_Instantiation (A);
7974 if Present (Inst) then
7975 if Nkind (Inst) = N_Package_Instantiation then
7976 return Inst;
7978 elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
7979 return Original_Node (Inst);
7980 end if;
7981 end if;
7983 -- If the instantiation is a compilation unit that does not need body
7984 -- then the instantiation node has been rewritten as a package
7985 -- declaration for the instance, and we return the original node.
7987 -- If it is a compilation unit and the instance node has not been
7988 -- rewritten, then it is still the unit of the compilation. Finally, if
7989 -- a body is present, this is a parent of the main unit whose body has
7990 -- been compiled for inlining purposes, and the instantiation node has
7991 -- been rewritten with the instance body.
7993 -- Otherwise the instantiation node appears after the declaration. If
7994 -- the entity is a formal package, the declaration may have been
7995 -- rewritten as a generic declaration (in the case of a formal with box)
7996 -- or left as a formal package declaration if it has actuals, and is
7997 -- found with a forward search.
7999 if Nkind (Parent (Decl)) = N_Compilation_Unit then
8000 if Nkind (Decl) = N_Package_Declaration
8001 and then Present (Corresponding_Body (Decl))
8002 then
8003 Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
8004 end if;
8006 if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
8007 return Original_Node (Decl);
8008 else
8009 return Unit (Parent (Decl));
8010 end if;
8012 elsif Nkind (Decl) = N_Package_Declaration
8013 and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
8014 then
8015 return Original_Node (Decl);
8017 else
8018 Inst := Next (Decl);
8019 while not Nkind_In (Inst, N_Package_Instantiation,
8020 N_Formal_Package_Declaration)
8021 loop
8022 Next (Inst);
8023 end loop;
8025 return Inst;
8026 end if;
8027 end Get_Package_Instantiation_Node;
8029 ------------------------
8030 -- Has_Been_Exchanged --
8031 ------------------------
8033 function Has_Been_Exchanged (E : Entity_Id) return Boolean is
8034 Next : Elmt_Id;
8036 begin
8037 Next := First_Elmt (Exchanged_Views);
8038 while Present (Next) loop
8039 if Full_View (Node (Next)) = E then
8040 return True;
8041 end if;
8043 Next_Elmt (Next);
8044 end loop;
8046 return False;
8047 end Has_Been_Exchanged;
8049 ----------
8050 -- Hash --
8051 ----------
8053 function Hash (F : Entity_Id) return HTable_Range is
8054 begin
8055 return HTable_Range (F mod HTable_Size);
8056 end Hash;
8058 ------------------------
8059 -- Hide_Current_Scope --
8060 ------------------------
8062 procedure Hide_Current_Scope is
8063 C : constant Entity_Id := Current_Scope;
8064 E : Entity_Id;
8066 begin
8067 Set_Is_Hidden_Open_Scope (C);
8069 E := First_Entity (C);
8070 while Present (E) loop
8071 if Is_Immediately_Visible (E) then
8072 Set_Is_Immediately_Visible (E, False);
8073 Append_Elmt (E, Hidden_Entities);
8074 end if;
8076 Next_Entity (E);
8077 end loop;
8079 -- Make the scope name invisible as well. This is necessary, but might
8080 -- conflict with calls to Rtsfind later on, in case the scope is a
8081 -- predefined one. There is no clean solution to this problem, so for
8082 -- now we depend on the user not redefining Standard itself in one of
8083 -- the parent units.
8085 if Is_Immediately_Visible (C) and then C /= Standard_Standard then
8086 Set_Is_Immediately_Visible (C, False);
8087 Append_Elmt (C, Hidden_Entities);
8088 end if;
8090 end Hide_Current_Scope;
8092 --------------
8093 -- Init_Env --
8094 --------------
8096 procedure Init_Env is
8097 Saved : Instance_Env;
8099 begin
8100 Saved.Instantiated_Parent := Current_Instantiated_Parent;
8101 Saved.Exchanged_Views := Exchanged_Views;
8102 Saved.Hidden_Entities := Hidden_Entities;
8103 Saved.Current_Sem_Unit := Current_Sem_Unit;
8104 Saved.Parent_Unit_Visible := Parent_Unit_Visible;
8105 Saved.Instance_Parent_Unit := Instance_Parent_Unit;
8107 -- Save configuration switches. These may be reset if the unit is a
8108 -- predefined unit, and the current mode is not Ada 2005.
8110 Save_Opt_Config_Switches (Saved.Switches);
8112 Instance_Envs.Append (Saved);
8114 Exchanged_Views := New_Elmt_List;
8115 Hidden_Entities := New_Elmt_List;
8117 -- Make dummy entry for Instantiated parent. If generic unit is legal,
8118 -- this is set properly in Set_Instance_Env.
8120 Current_Instantiated_Parent :=
8121 (Current_Scope, Current_Scope, Assoc_Null);
8122 end Init_Env;
8124 ------------------------------
8125 -- In_Same_Declarative_Part --
8126 ------------------------------
8128 function In_Same_Declarative_Part
8129 (F_Node : Node_Id;
8130 Inst : Node_Id) return Boolean
8132 Decls : constant Node_Id := Parent (F_Node);
8133 Nod : Node_Id := Parent (Inst);
8135 begin
8136 while Present (Nod) loop
8137 if Nod = Decls then
8138 return True;
8140 elsif Nkind_In (Nod, N_Subprogram_Body,
8141 N_Package_Body,
8142 N_Package_Declaration,
8143 N_Task_Body,
8144 N_Protected_Body,
8145 N_Block_Statement)
8146 then
8147 return False;
8149 elsif Nkind (Nod) = N_Subunit then
8150 Nod := Corresponding_Stub (Nod);
8152 elsif Nkind (Nod) = N_Compilation_Unit then
8153 return False;
8155 else
8156 Nod := Parent (Nod);
8157 end if;
8158 end loop;
8160 return False;
8161 end In_Same_Declarative_Part;
8163 ---------------------
8164 -- In_Main_Context --
8165 ---------------------
8167 function In_Main_Context (E : Entity_Id) return Boolean is
8168 Context : List_Id;
8169 Clause : Node_Id;
8170 Nam : Node_Id;
8172 begin
8173 if not Is_Compilation_Unit (E)
8174 or else Ekind (E) /= E_Package
8175 or else In_Private_Part (E)
8176 then
8177 return False;
8178 end if;
8180 Context := Context_Items (Cunit (Main_Unit));
8182 Clause := First (Context);
8183 while Present (Clause) loop
8184 if Nkind (Clause) = N_With_Clause then
8185 Nam := Name (Clause);
8187 -- If the current scope is part of the context of the main unit,
8188 -- analysis of the corresponding with_clause is not complete, and
8189 -- the entity is not set. We use the Chars field directly, which
8190 -- might produce false positives in rare cases, but guarantees
8191 -- that we produce all the instance bodies we will need.
8193 if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
8194 or else (Nkind (Nam) = N_Selected_Component
8195 and then Chars (Selector_Name (Nam)) = Chars (E))
8196 then
8197 return True;
8198 end if;
8199 end if;
8201 Next (Clause);
8202 end loop;
8204 return False;
8205 end In_Main_Context;
8207 ---------------------
8208 -- Inherit_Context --
8209 ---------------------
8211 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
8212 Current_Context : List_Id;
8213 Current_Unit : Node_Id;
8214 Item : Node_Id;
8215 New_I : Node_Id;
8217 Clause : Node_Id;
8218 OK : Boolean;
8219 Lib_Unit : Node_Id;
8221 begin
8222 if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
8224 -- The inherited context is attached to the enclosing compilation
8225 -- unit. This is either the main unit, or the declaration for the
8226 -- main unit (in case the instantiation appears within the package
8227 -- declaration and the main unit is its body).
8229 Current_Unit := Parent (Inst);
8230 while Present (Current_Unit)
8231 and then Nkind (Current_Unit) /= N_Compilation_Unit
8232 loop
8233 Current_Unit := Parent (Current_Unit);
8234 end loop;
8236 Current_Context := Context_Items (Current_Unit);
8238 Item := First (Context_Items (Parent (Gen_Decl)));
8239 while Present (Item) loop
8240 if Nkind (Item) = N_With_Clause then
8241 Lib_Unit := Library_Unit (Item);
8243 -- Take care to prevent direct cyclic with's
8245 if Lib_Unit /= Current_Unit then
8247 -- Do not add a unit if it is already in the context
8249 Clause := First (Current_Context);
8250 OK := True;
8251 while Present (Clause) loop
8252 if Nkind (Clause) = N_With_Clause and then
8253 Library_Unit (Clause) = Lib_Unit
8254 then
8255 OK := False;
8256 exit;
8257 end if;
8259 Next (Clause);
8260 end loop;
8262 if OK then
8263 New_I := New_Copy (Item);
8264 Set_Implicit_With (New_I, True);
8265 Set_Implicit_With_From_Instantiation (New_I, True);
8266 Append (New_I, Current_Context);
8267 end if;
8268 end if;
8269 end if;
8271 Next (Item);
8272 end loop;
8273 end if;
8274 end Inherit_Context;
8276 ----------------
8277 -- Initialize --
8278 ----------------
8280 procedure Initialize is
8281 begin
8282 Generic_Renamings.Init;
8283 Instance_Envs.Init;
8284 Generic_Flags.Init;
8285 Generic_Renamings_HTable.Reset;
8286 Circularity_Detected := False;
8287 Exchanged_Views := No_Elist;
8288 Hidden_Entities := No_Elist;
8289 end Initialize;
8291 -------------------------------------
8292 -- Insert_Freeze_Node_For_Instance --
8293 -------------------------------------
8295 procedure Insert_Freeze_Node_For_Instance
8296 (N : Node_Id;
8297 F_Node : Node_Id)
8299 Decl : Node_Id;
8300 Decls : List_Id;
8301 Inst : Entity_Id;
8302 Par_N : Node_Id;
8304 function Enclosing_Body (N : Node_Id) return Node_Id;
8305 -- Find enclosing package or subprogram body, if any. Freeze node may
8306 -- be placed at end of current declarative list if previous instance
8307 -- and current one have different enclosing bodies.
8309 function Previous_Instance (Gen : Entity_Id) return Entity_Id;
8310 -- Find the local instance, if any, that declares the generic that is
8311 -- being instantiated. If present, the freeze node for this instance
8312 -- must follow the freeze node for the previous instance.
8314 --------------------
8315 -- Enclosing_Body --
8316 --------------------
8318 function Enclosing_Body (N : Node_Id) return Node_Id is
8319 P : Node_Id;
8321 begin
8322 P := Parent (N);
8323 while Present (P)
8324 and then Nkind (Parent (P)) /= N_Compilation_Unit
8325 loop
8326 if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
8327 if Nkind (Parent (P)) = N_Subunit then
8328 return Corresponding_Stub (Parent (P));
8329 else
8330 return P;
8331 end if;
8332 end if;
8334 P := True_Parent (P);
8335 end loop;
8337 return Empty;
8338 end Enclosing_Body;
8340 -----------------------
8341 -- Previous_Instance --
8342 -----------------------
8344 function Previous_Instance (Gen : Entity_Id) return Entity_Id is
8345 S : Entity_Id;
8347 begin
8348 S := Scope (Gen);
8349 while Present (S)
8350 and then S /= Standard_Standard
8351 loop
8352 if Is_Generic_Instance (S)
8353 and then In_Same_Source_Unit (S, N)
8354 then
8355 return S;
8356 end if;
8358 S := Scope (S);
8359 end loop;
8361 return Empty;
8362 end Previous_Instance;
8364 -- Start of processing for Insert_Freeze_Node_For_Instance
8366 begin
8367 if not Is_List_Member (F_Node) then
8368 Decl := N;
8369 Decls := List_Containing (N);
8370 Inst := Entity (F_Node);
8371 Par_N := Parent (Decls);
8373 -- When processing a subprogram instantiation, utilize the actual
8374 -- subprogram instantiation rather than its package wrapper as it
8375 -- carries all the context information.
8377 if Is_Wrapper_Package (Inst) then
8378 Inst := Related_Instance (Inst);
8379 end if;
8381 -- If this is a package instance, check whether the generic is
8382 -- declared in a previous instance and the current instance is
8383 -- not within the previous one.
8385 if Present (Generic_Parent (Parent (Inst)))
8386 and then Is_In_Main_Unit (N)
8387 then
8388 declare
8389 Enclosing_N : constant Node_Id := Enclosing_Body (N);
8390 Par_I : constant Entity_Id :=
8391 Previous_Instance
8392 (Generic_Parent (Parent (Inst)));
8393 Scop : Entity_Id;
8395 begin
8396 if Present (Par_I)
8397 and then Earlier (N, Freeze_Node (Par_I))
8398 then
8399 Scop := Scope (Inst);
8401 -- If the current instance is within the one that contains
8402 -- the generic, the freeze node for the current one must
8403 -- appear in the current declarative part. Ditto, if the
8404 -- current instance is within another package instance or
8405 -- within a body that does not enclose the current instance.
8406 -- In these three cases the freeze node of the previous
8407 -- instance is not relevant.
8409 while Present (Scop)
8410 and then Scop /= Standard_Standard
8411 loop
8412 exit when Scop = Par_I
8413 or else
8414 (Is_Generic_Instance (Scop)
8415 and then Scope_Depth (Scop) > Scope_Depth (Par_I));
8416 Scop := Scope (Scop);
8417 end loop;
8419 -- Previous instance encloses current instance
8421 if Scop = Par_I then
8422 null;
8424 -- If the next node is a source body we must freeze in
8425 -- the current scope as well.
8427 elsif Present (Next (N))
8428 and then Nkind_In (Next (N),
8429 N_Subprogram_Body, N_Package_Body)
8430 and then Comes_From_Source (Next (N))
8431 then
8432 null;
8434 -- Current instance is within an unrelated instance
8436 elsif Is_Generic_Instance (Scop) then
8437 null;
8439 -- Current instance is within an unrelated body
8441 elsif Present (Enclosing_N)
8442 and then Enclosing_N /= Enclosing_Body (Par_I)
8443 then
8444 null;
8446 else
8447 Insert_After (Freeze_Node (Par_I), F_Node);
8448 return;
8449 end if;
8450 end if;
8451 end;
8452 end if;
8454 -- When the instantiation occurs in a package declaration, append the
8455 -- freeze node to the private declarations (if any).
8457 if Nkind (Par_N) = N_Package_Specification
8458 and then Decls = Visible_Declarations (Par_N)
8459 and then Present (Private_Declarations (Par_N))
8460 and then not Is_Empty_List (Private_Declarations (Par_N))
8461 then
8462 Decls := Private_Declarations (Par_N);
8463 Decl := First (Decls);
8464 end if;
8466 -- Determine the proper freeze point of a package instantiation. We
8467 -- adhere to the general rule of a package or subprogram body causing
8468 -- freezing of anything before it in the same declarative region. In
8469 -- this case, the proper freeze point of a package instantiation is
8470 -- before the first source body which follows, or before a stub. This
8471 -- ensures that entities coming from the instance are already frozen
8472 -- and usable in source bodies.
8474 if Nkind (Par_N) /= N_Package_Declaration
8475 and then Ekind (Inst) = E_Package
8476 and then Is_Generic_Instance (Inst)
8477 and then
8478 not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
8479 then
8480 while Present (Decl) loop
8481 if (Nkind (Decl) in N_Unit_Body
8482 or else
8483 Nkind (Decl) in N_Body_Stub)
8484 and then Comes_From_Source (Decl)
8485 then
8486 Insert_Before (Decl, F_Node);
8487 return;
8488 end if;
8490 Next (Decl);
8491 end loop;
8492 end if;
8494 -- In a package declaration, or if no previous body, insert at end
8495 -- of list.
8497 Set_Sloc (F_Node, Sloc (Last (Decls)));
8498 Insert_After (Last (Decls), F_Node);
8499 end if;
8500 end Insert_Freeze_Node_For_Instance;
8502 ------------------
8503 -- Install_Body --
8504 ------------------
8506 procedure Install_Body
8507 (Act_Body : Node_Id;
8508 N : Node_Id;
8509 Gen_Body : Node_Id;
8510 Gen_Decl : Node_Id)
8512 Act_Id : constant Entity_Id := Corresponding_Spec (Act_Body);
8513 Act_Unit : constant Node_Id := Unit (Cunit (Get_Source_Unit (N)));
8514 Gen_Id : constant Entity_Id := Corresponding_Spec (Gen_Body);
8515 Par : constant Entity_Id := Scope (Gen_Id);
8516 Gen_Unit : constant Node_Id :=
8517 Unit (Cunit (Get_Source_Unit (Gen_Decl)));
8518 Orig_Body : Node_Id := Gen_Body;
8519 F_Node : Node_Id;
8520 Body_Unit : Node_Id;
8522 Must_Delay : Boolean;
8524 function In_Same_Enclosing_Subp return Boolean;
8525 -- Check whether instance and generic body are within same subprogram.
8527 function True_Sloc (N : Node_Id) return Source_Ptr;
8528 -- If the instance is nested inside a generic unit, the Sloc of the
8529 -- instance indicates the place of the original definition, not the
8530 -- point of the current enclosing instance. Pending a better usage of
8531 -- Slocs to indicate instantiation places, we determine the place of
8532 -- origin of a node by finding the maximum sloc of any ancestor node.
8533 -- Why is this not equivalent to Top_Level_Location ???
8535 ----------------------------
8536 -- In_Same_Enclosing_Subp --
8537 ----------------------------
8539 function In_Same_Enclosing_Subp return Boolean is
8540 Scop : Entity_Id;
8541 Subp : Entity_Id;
8543 begin
8544 Scop := Scope (Act_Id);
8545 while Scop /= Standard_Standard
8546 and then not Is_Overloadable (Scop)
8547 loop
8548 Scop := Scope (Scop);
8549 end loop;
8551 if Scop = Standard_Standard then
8552 return False;
8553 else
8554 Subp := Scop;
8555 end if;
8557 Scop := Scope (Gen_Id);
8558 while Scop /= Standard_Standard loop
8559 if Scop = Subp then
8560 return True;
8561 else
8562 Scop := Scope (Scop);
8563 end if;
8564 end loop;
8566 return False;
8567 end In_Same_Enclosing_Subp;
8569 ---------------
8570 -- True_Sloc --
8571 ---------------
8573 function True_Sloc (N : Node_Id) return Source_Ptr is
8574 Res : Source_Ptr;
8575 N1 : Node_Id;
8577 begin
8578 Res := Sloc (N);
8579 N1 := N;
8580 while Present (N1) and then N1 /= Act_Unit loop
8581 if Sloc (N1) > Res then
8582 Res := Sloc (N1);
8583 end if;
8585 N1 := Parent (N1);
8586 end loop;
8588 return Res;
8589 end True_Sloc;
8591 -- Start of processing for Install_Body
8593 begin
8594 -- If the body is a subunit, the freeze point is the corresponding stub
8595 -- in the current compilation, not the subunit itself.
8597 if Nkind (Parent (Gen_Body)) = N_Subunit then
8598 Orig_Body := Corresponding_Stub (Parent (Gen_Body));
8599 else
8600 Orig_Body := Gen_Body;
8601 end if;
8603 Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8605 -- If the instantiation and the generic definition appear in the same
8606 -- package declaration, this is an early instantiation. If they appear
8607 -- in the same declarative part, it is an early instantiation only if
8608 -- the generic body appears textually later, and the generic body is
8609 -- also in the main unit.
8611 -- If instance is nested within a subprogram, and the generic body
8612 -- is not, the instance is delayed because the enclosing body is. If
8613 -- instance and body are within the same scope, or the same subprogram
8614 -- body, indicate explicitly that the instance is delayed.
8616 Must_Delay :=
8617 (Gen_Unit = Act_Unit
8618 and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8619 N_Generic_Package_Declaration)
8620 or else (Gen_Unit = Body_Unit
8621 and then True_Sloc (N) < Sloc (Orig_Body)))
8622 and then Is_In_Main_Unit (Gen_Unit)
8623 and then (Scope (Act_Id) = Scope (Gen_Id)
8624 or else In_Same_Enclosing_Subp));
8626 -- If this is an early instantiation, the freeze node is placed after
8627 -- the generic body. Otherwise, if the generic appears in an instance,
8628 -- we cannot freeze the current instance until the outer one is frozen.
8629 -- This is only relevant if the current instance is nested within some
8630 -- inner scope not itself within the outer instance. If this scope is
8631 -- a package body in the same declarative part as the outer instance,
8632 -- then that body needs to be frozen after the outer instance. Finally,
8633 -- if no delay is needed, we place the freeze node at the end of the
8634 -- current declarative part.
8636 if Expander_Active then
8637 Ensure_Freeze_Node (Act_Id);
8638 F_Node := Freeze_Node (Act_Id);
8640 if Must_Delay then
8641 Insert_After (Orig_Body, F_Node);
8643 elsif Is_Generic_Instance (Par)
8644 and then Present (Freeze_Node (Par))
8645 and then Scope (Act_Id) /= Par
8646 then
8647 -- Freeze instance of inner generic after instance of enclosing
8648 -- generic.
8650 if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8652 -- Handle the following case:
8654 -- package Parent_Inst is new ...
8655 -- Parent_Inst []
8657 -- procedure P ... -- this body freezes Parent_Inst
8659 -- package Inst is new ...
8661 -- In this particular scenario, the freeze node for Inst must
8662 -- be inserted in the same manner as that of Parent_Inst,
8663 -- before the next source body or at the end of the declarative
8664 -- list (body not available). If body P did not exist and
8665 -- Parent_Inst was frozen after Inst, either by a body
8666 -- following Inst or at the end of the declarative region,
8667 -- the freeze node for Inst must be inserted after that of
8668 -- Parent_Inst. This relation is established by comparing
8669 -- the Slocs of Parent_Inst freeze node and Inst.
8671 if List_Containing (Get_Package_Instantiation_Node (Par)) =
8672 List_Containing (N)
8673 and then Sloc (Freeze_Node (Par)) < Sloc (N)
8674 then
8675 Insert_Freeze_Node_For_Instance (N, F_Node);
8676 else
8677 Insert_After (Freeze_Node (Par), F_Node);
8678 end if;
8680 -- Freeze package enclosing instance of inner generic after
8681 -- instance of enclosing generic.
8683 elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8684 and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8685 then
8686 declare
8687 Enclosing : Entity_Id;
8689 begin
8690 Enclosing := Corresponding_Spec (Parent (N));
8692 if No (Enclosing) then
8693 Enclosing := Defining_Entity (Parent (N));
8694 end if;
8696 Insert_Freeze_Node_For_Instance (N, F_Node);
8697 Ensure_Freeze_Node (Enclosing);
8699 if not Is_List_Member (Freeze_Node (Enclosing)) then
8701 -- The enclosing context is a subunit, insert the freeze
8702 -- node after the stub.
8704 if Nkind (Parent (Parent (N))) = N_Subunit then
8705 Insert_Freeze_Node_For_Instance
8706 (Corresponding_Stub (Parent (Parent (N))),
8707 Freeze_Node (Enclosing));
8709 -- The enclosing context is a package with a stub body
8710 -- which has already been replaced by the real body.
8711 -- Insert the freeze node after the actual body.
8713 elsif Ekind (Enclosing) = E_Package
8714 and then Present (Body_Entity (Enclosing))
8715 and then Was_Originally_Stub
8716 (Parent (Body_Entity (Enclosing)))
8717 then
8718 Insert_Freeze_Node_For_Instance
8719 (Parent (Body_Entity (Enclosing)),
8720 Freeze_Node (Enclosing));
8722 -- The parent instance has been frozen before the body of
8723 -- the enclosing package, insert the freeze node after
8724 -- the body.
8726 elsif List_Containing (Freeze_Node (Par)) =
8727 List_Containing (Parent (N))
8728 and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8729 then
8730 Insert_Freeze_Node_For_Instance
8731 (Parent (N), Freeze_Node (Enclosing));
8733 else
8734 Insert_After
8735 (Freeze_Node (Par), Freeze_Node (Enclosing));
8736 end if;
8737 end if;
8738 end;
8740 else
8741 Insert_Freeze_Node_For_Instance (N, F_Node);
8742 end if;
8744 else
8745 Insert_Freeze_Node_For_Instance (N, F_Node);
8746 end if;
8747 end if;
8749 Set_Is_Frozen (Act_Id);
8750 Insert_Before (N, Act_Body);
8751 Mark_Rewrite_Insertion (Act_Body);
8752 end Install_Body;
8754 -----------------------------
8755 -- Install_Formal_Packages --
8756 -----------------------------
8758 procedure Install_Formal_Packages (Par : Entity_Id) is
8759 E : Entity_Id;
8760 Gen : Entity_Id;
8761 Gen_E : Entity_Id := Empty;
8763 begin
8764 E := First_Entity (Par);
8766 -- If we are installing an instance parent, locate the formal packages
8767 -- of its generic parent.
8769 if Is_Generic_Instance (Par) then
8770 Gen := Generic_Parent (Package_Specification (Par));
8771 Gen_E := First_Entity (Gen);
8772 end if;
8774 while Present (E) loop
8775 if Ekind (E) = E_Package
8776 and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8777 then
8778 -- If this is the renaming for the parent instance, done
8780 if Renamed_Object (E) = Par then
8781 exit;
8783 -- The visibility of a formal of an enclosing generic is already
8784 -- correct.
8786 elsif Denotes_Formal_Package (E) then
8787 null;
8789 elsif Present (Associated_Formal_Package (E)) then
8790 Check_Generic_Actuals (Renamed_Object (E), True);
8791 Set_Is_Hidden (E, False);
8793 -- Find formal package in generic unit that corresponds to
8794 -- (instance of) formal package in instance.
8796 while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8797 Next_Entity (Gen_E);
8798 end loop;
8800 if Present (Gen_E) then
8801 Map_Formal_Package_Entities (Gen_E, E);
8802 end if;
8803 end if;
8804 end if;
8806 Next_Entity (E);
8807 if Present (Gen_E) then
8808 Next_Entity (Gen_E);
8809 end if;
8810 end loop;
8811 end Install_Formal_Packages;
8813 --------------------
8814 -- Install_Parent --
8815 --------------------
8817 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8818 Ancestors : constant Elist_Id := New_Elmt_List;
8819 S : constant Entity_Id := Current_Scope;
8820 Inst_Par : Entity_Id;
8821 First_Par : Entity_Id;
8822 Inst_Node : Node_Id;
8823 Gen_Par : Entity_Id;
8824 First_Gen : Entity_Id;
8825 Elmt : Elmt_Id;
8827 procedure Install_Noninstance_Specs (Par : Entity_Id);
8828 -- Install the scopes of noninstance parent units ending with Par
8830 procedure Install_Spec (Par : Entity_Id);
8831 -- The child unit is within the declarative part of the parent, so the
8832 -- declarations within the parent are immediately visible.
8834 -------------------------------
8835 -- Install_Noninstance_Specs --
8836 -------------------------------
8838 procedure Install_Noninstance_Specs (Par : Entity_Id) is
8839 begin
8840 if Present (Par)
8841 and then Par /= Standard_Standard
8842 and then not In_Open_Scopes (Par)
8843 then
8844 Install_Noninstance_Specs (Scope (Par));
8845 Install_Spec (Par);
8846 end if;
8847 end Install_Noninstance_Specs;
8849 ------------------
8850 -- Install_Spec --
8851 ------------------
8853 procedure Install_Spec (Par : Entity_Id) is
8854 Spec : constant Node_Id := Package_Specification (Par);
8856 begin
8857 -- If this parent of the child instance is a top-level unit,
8858 -- then record the unit and its visibility for later resetting in
8859 -- Remove_Parent. We exclude units that are generic instances, as we
8860 -- only want to record this information for the ultimate top-level
8861 -- noninstance parent (is that always correct???).
8863 if Scope (Par) = Standard_Standard
8864 and then not Is_Generic_Instance (Par)
8865 then
8866 Parent_Unit_Visible := Is_Immediately_Visible (Par);
8867 Instance_Parent_Unit := Par;
8868 end if;
8870 -- Open the parent scope and make it and its declarations visible.
8871 -- If this point is not within a body, then only the visible
8872 -- declarations should be made visible, and installation of the
8873 -- private declarations is deferred until the appropriate point
8874 -- within analysis of the spec being instantiated (see the handling
8875 -- of parent visibility in Analyze_Package_Specification). This is
8876 -- relaxed in the case where the parent unit is Ada.Tags, to avoid
8877 -- private view problems that occur when compiling instantiations of
8878 -- a generic child of that package (Generic_Dispatching_Constructor).
8879 -- If the instance freezes a tagged type, inlinings of operations
8880 -- from Ada.Tags may need the full view of type Tag. If inlining took
8881 -- proper account of establishing visibility of inlined subprograms'
8882 -- parents then it should be possible to remove this
8883 -- special check. ???
8885 Push_Scope (Par);
8886 Set_Is_Immediately_Visible (Par);
8887 Install_Visible_Declarations (Par);
8888 Set_Use (Visible_Declarations (Spec));
8890 if In_Body or else Is_RTU (Par, Ada_Tags) then
8891 Install_Private_Declarations (Par);
8892 Set_Use (Private_Declarations (Spec));
8893 end if;
8894 end Install_Spec;
8896 -- Start of processing for Install_Parent
8898 begin
8899 -- We need to install the parent instance to compile the instantiation
8900 -- of the child, but the child instance must appear in the current
8901 -- scope. Given that we cannot place the parent above the current scope
8902 -- in the scope stack, we duplicate the current scope and unstack both
8903 -- after the instantiation is complete.
8905 -- If the parent is itself the instantiation of a child unit, we must
8906 -- also stack the instantiation of its parent, and so on. Each such
8907 -- ancestor is the prefix of the name in a prior instantiation.
8909 -- If this is a nested instance, the parent unit itself resolves to
8910 -- a renaming of the parent instance, whose declaration we need.
8912 -- Finally, the parent may be a generic (not an instance) when the
8913 -- child unit appears as a formal package.
8915 Inst_Par := P;
8917 if Present (Renamed_Entity (Inst_Par)) then
8918 Inst_Par := Renamed_Entity (Inst_Par);
8919 end if;
8921 First_Par := Inst_Par;
8923 Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
8925 First_Gen := Gen_Par;
8927 while Present (Gen_Par)
8928 and then Is_Child_Unit (Gen_Par)
8929 loop
8930 -- Load grandparent instance as well
8932 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
8934 if Nkind (Name (Inst_Node)) = N_Expanded_Name then
8935 Inst_Par := Entity (Prefix (Name (Inst_Node)));
8937 if Present (Renamed_Entity (Inst_Par)) then
8938 Inst_Par := Renamed_Entity (Inst_Par);
8939 end if;
8941 Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
8943 if Present (Gen_Par) then
8944 Prepend_Elmt (Inst_Par, Ancestors);
8946 else
8947 -- Parent is not the name of an instantiation
8949 Install_Noninstance_Specs (Inst_Par);
8950 exit;
8951 end if;
8953 else
8954 -- Previous error
8956 exit;
8957 end if;
8958 end loop;
8960 if Present (First_Gen) then
8961 Append_Elmt (First_Par, Ancestors);
8962 else
8963 Install_Noninstance_Specs (First_Par);
8964 end if;
8966 if not Is_Empty_Elmt_List (Ancestors) then
8967 Elmt := First_Elmt (Ancestors);
8968 while Present (Elmt) loop
8969 Install_Spec (Node (Elmt));
8970 Install_Formal_Packages (Node (Elmt));
8971 Next_Elmt (Elmt);
8972 end loop;
8973 end if;
8975 if not In_Body then
8976 Push_Scope (S);
8977 end if;
8978 end Install_Parent;
8980 -------------------------------
8981 -- Install_Hidden_Primitives --
8982 -------------------------------
8984 procedure Install_Hidden_Primitives
8985 (Prims_List : in out Elist_Id;
8986 Gen_T : Entity_Id;
8987 Act_T : Entity_Id)
8989 Elmt : Elmt_Id;
8990 List : Elist_Id := No_Elist;
8991 Prim_G_Elmt : Elmt_Id;
8992 Prim_A_Elmt : Elmt_Id;
8993 Prim_G : Node_Id;
8994 Prim_A : Node_Id;
8996 begin
8997 -- No action needed in case of serious errors because we cannot trust
8998 -- in the order of primitives
9000 if Serious_Errors_Detected > 0 then
9001 return;
9003 -- No action possible if we don't have available the list of primitive
9004 -- operations
9006 elsif No (Gen_T)
9007 or else not Is_Record_Type (Gen_T)
9008 or else not Is_Tagged_Type (Gen_T)
9009 or else not Is_Record_Type (Act_T)
9010 or else not Is_Tagged_Type (Act_T)
9011 then
9012 return;
9014 -- There is no need to handle interface types since their primitives
9015 -- cannot be hidden
9017 elsif Is_Interface (Gen_T) then
9018 return;
9019 end if;
9021 Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
9023 if not Is_Class_Wide_Type (Act_T) then
9024 Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
9025 else
9026 Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
9027 end if;
9029 loop
9030 -- Skip predefined primitives in the generic formal
9032 while Present (Prim_G_Elmt)
9033 and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
9034 loop
9035 Next_Elmt (Prim_G_Elmt);
9036 end loop;
9038 -- Skip predefined primitives in the generic actual
9040 while Present (Prim_A_Elmt)
9041 and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
9042 loop
9043 Next_Elmt (Prim_A_Elmt);
9044 end loop;
9046 exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
9048 Prim_G := Node (Prim_G_Elmt);
9049 Prim_A := Node (Prim_A_Elmt);
9051 -- There is no need to handle interface primitives because their
9052 -- primitives are not hidden
9054 exit when Present (Interface_Alias (Prim_G));
9056 -- Here we install one hidden primitive
9058 if Chars (Prim_G) /= Chars (Prim_A)
9059 and then Has_Suffix (Prim_A, 'P')
9060 and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
9061 then
9062 Set_Chars (Prim_A, Chars (Prim_G));
9063 Append_New_Elmt (Prim_A, To => List);
9064 end if;
9066 Next_Elmt (Prim_A_Elmt);
9067 Next_Elmt (Prim_G_Elmt);
9068 end loop;
9070 -- Append the elements to the list of temporarily visible primitives
9071 -- avoiding duplicates.
9073 if Present (List) then
9074 if No (Prims_List) then
9075 Prims_List := New_Elmt_List;
9076 end if;
9078 Elmt := First_Elmt (List);
9079 while Present (Elmt) loop
9080 Append_Unique_Elmt (Node (Elmt), Prims_List);
9081 Next_Elmt (Elmt);
9082 end loop;
9083 end if;
9084 end Install_Hidden_Primitives;
9086 -------------------------------
9087 -- Restore_Hidden_Primitives --
9088 -------------------------------
9090 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
9091 Prim_Elmt : Elmt_Id;
9092 Prim : Node_Id;
9094 begin
9095 if Prims_List /= No_Elist then
9096 Prim_Elmt := First_Elmt (Prims_List);
9097 while Present (Prim_Elmt) loop
9098 Prim := Node (Prim_Elmt);
9099 Set_Chars (Prim, Add_Suffix (Prim, 'P'));
9100 Next_Elmt (Prim_Elmt);
9101 end loop;
9103 Prims_List := No_Elist;
9104 end if;
9105 end Restore_Hidden_Primitives;
9107 --------------------------------
9108 -- Instantiate_Formal_Package --
9109 --------------------------------
9111 function Instantiate_Formal_Package
9112 (Formal : Node_Id;
9113 Actual : Node_Id;
9114 Analyzed_Formal : Node_Id) return List_Id
9116 Loc : constant Source_Ptr := Sloc (Actual);
9117 Actual_Pack : Entity_Id;
9118 Formal_Pack : Entity_Id;
9119 Gen_Parent : Entity_Id;
9120 Decls : List_Id;
9121 Nod : Node_Id;
9122 Parent_Spec : Node_Id;
9124 procedure Find_Matching_Actual
9125 (F : Node_Id;
9126 Act : in out Entity_Id);
9127 -- We need to associate each formal entity in the formal package with
9128 -- the corresponding entity in the actual package. The actual package
9129 -- has been analyzed and possibly expanded, and as a result there is
9130 -- no one-to-one correspondence between the two lists (for example,
9131 -- the actual may include subtypes, itypes, and inherited primitive
9132 -- operations, interspersed among the renaming declarations for the
9133 -- actuals) . We retrieve the corresponding actual by name because each
9134 -- actual has the same name as the formal, and they do appear in the
9135 -- same order.
9137 function Get_Formal_Entity (N : Node_Id) return Entity_Id;
9138 -- Retrieve entity of defining entity of generic formal parameter.
9139 -- Only the declarations of formals need to be considered when
9140 -- linking them to actuals, but the declarative list may include
9141 -- internal entities generated during analysis, and those are ignored.
9143 procedure Match_Formal_Entity
9144 (Formal_Node : Node_Id;
9145 Formal_Ent : Entity_Id;
9146 Actual_Ent : Entity_Id);
9147 -- Associates the formal entity with the actual. In the case where
9148 -- Formal_Ent is a formal package, this procedure iterates through all
9149 -- of its formals and enters associations between the actuals occurring
9150 -- in the formal package's corresponding actual package (given by
9151 -- Actual_Ent) and the formal package's formal parameters. This
9152 -- procedure recurses if any of the parameters is itself a package.
9154 function Is_Instance_Of
9155 (Act_Spec : Entity_Id;
9156 Gen_Anc : Entity_Id) return Boolean;
9157 -- The actual can be an instantiation of a generic within another
9158 -- instance, in which case there is no direct link from it to the
9159 -- original generic ancestor. In that case, we recognize that the
9160 -- ultimate ancestor is the same by examining names and scopes.
9162 procedure Process_Nested_Formal (Formal : Entity_Id);
9163 -- If the current formal is declared with a box, its own formals are
9164 -- visible in the instance, as they were in the generic, and their
9165 -- Hidden flag must be reset. If some of these formals are themselves
9166 -- packages declared with a box, the processing must be recursive.
9168 --------------------------
9169 -- Find_Matching_Actual --
9170 --------------------------
9172 procedure Find_Matching_Actual
9173 (F : Node_Id;
9174 Act : in out Entity_Id)
9176 Formal_Ent : Entity_Id;
9178 begin
9179 case Nkind (Original_Node (F)) is
9180 when N_Formal_Object_Declaration |
9181 N_Formal_Type_Declaration =>
9182 Formal_Ent := Defining_Identifier (F);
9184 while Chars (Act) /= Chars (Formal_Ent) loop
9185 Next_Entity (Act);
9186 end loop;
9188 when N_Formal_Subprogram_Declaration |
9189 N_Formal_Package_Declaration |
9190 N_Package_Declaration |
9191 N_Generic_Package_Declaration =>
9192 Formal_Ent := Defining_Entity (F);
9194 while Chars (Act) /= Chars (Formal_Ent) loop
9195 Next_Entity (Act);
9196 end loop;
9198 when others =>
9199 raise Program_Error;
9200 end case;
9201 end Find_Matching_Actual;
9203 -------------------------
9204 -- Match_Formal_Entity --
9205 -------------------------
9207 procedure Match_Formal_Entity
9208 (Formal_Node : Node_Id;
9209 Formal_Ent : Entity_Id;
9210 Actual_Ent : Entity_Id)
9212 Act_Pkg : Entity_Id;
9214 begin
9215 Set_Instance_Of (Formal_Ent, Actual_Ent);
9217 if Ekind (Actual_Ent) = E_Package then
9219 -- Record associations for each parameter
9221 Act_Pkg := Actual_Ent;
9223 declare
9224 A_Ent : Entity_Id := First_Entity (Act_Pkg);
9225 F_Ent : Entity_Id;
9226 F_Node : Node_Id;
9228 Gen_Decl : Node_Id;
9229 Formals : List_Id;
9230 Actual : Entity_Id;
9232 begin
9233 -- Retrieve the actual given in the formal package declaration
9235 Actual := Entity (Name (Original_Node (Formal_Node)));
9237 -- The actual in the formal package declaration may be a
9238 -- renamed generic package, in which case we want to retrieve
9239 -- the original generic in order to traverse its formal part.
9241 if Present (Renamed_Entity (Actual)) then
9242 Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
9243 else
9244 Gen_Decl := Unit_Declaration_Node (Actual);
9245 end if;
9247 Formals := Generic_Formal_Declarations (Gen_Decl);
9249 if Present (Formals) then
9250 F_Node := First_Non_Pragma (Formals);
9251 else
9252 F_Node := Empty;
9253 end if;
9255 while Present (A_Ent)
9256 and then Present (F_Node)
9257 and then A_Ent /= First_Private_Entity (Act_Pkg)
9258 loop
9259 F_Ent := Get_Formal_Entity (F_Node);
9261 if Present (F_Ent) then
9263 -- This is a formal of the original package. Record
9264 -- association and recurse.
9266 Find_Matching_Actual (F_Node, A_Ent);
9267 Match_Formal_Entity (F_Node, F_Ent, A_Ent);
9268 Next_Entity (A_Ent);
9269 end if;
9271 Next_Non_Pragma (F_Node);
9272 end loop;
9273 end;
9274 end if;
9275 end Match_Formal_Entity;
9277 -----------------------
9278 -- Get_Formal_Entity --
9279 -----------------------
9281 function Get_Formal_Entity (N : Node_Id) return Entity_Id is
9282 Kind : constant Node_Kind := Nkind (Original_Node (N));
9283 begin
9284 case Kind is
9285 when N_Formal_Object_Declaration =>
9286 return Defining_Identifier (N);
9288 when N_Formal_Type_Declaration =>
9289 return Defining_Identifier (N);
9291 when N_Formal_Subprogram_Declaration =>
9292 return Defining_Unit_Name (Specification (N));
9294 when N_Formal_Package_Declaration =>
9295 return Defining_Identifier (Original_Node (N));
9297 when N_Generic_Package_Declaration =>
9298 return Defining_Identifier (Original_Node (N));
9300 -- All other declarations are introduced by semantic analysis and
9301 -- have no match in the actual.
9303 when others =>
9304 return Empty;
9305 end case;
9306 end Get_Formal_Entity;
9308 --------------------
9309 -- Is_Instance_Of --
9310 --------------------
9312 function Is_Instance_Of
9313 (Act_Spec : Entity_Id;
9314 Gen_Anc : Entity_Id) return Boolean
9316 Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
9318 begin
9319 if No (Gen_Par) then
9320 return False;
9322 -- Simplest case: the generic parent of the actual is the formal
9324 elsif Gen_Par = Gen_Anc then
9325 return True;
9327 elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
9328 return False;
9330 -- The actual may be obtained through several instantiations. Its
9331 -- scope must itself be an instance of a generic declared in the
9332 -- same scope as the formal. Any other case is detected above.
9334 elsif not Is_Generic_Instance (Scope (Gen_Par)) then
9335 return False;
9337 else
9338 return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
9339 end if;
9340 end Is_Instance_Of;
9342 ---------------------------
9343 -- Process_Nested_Formal --
9344 ---------------------------
9346 procedure Process_Nested_Formal (Formal : Entity_Id) is
9347 Ent : Entity_Id;
9349 begin
9350 if Present (Associated_Formal_Package (Formal))
9351 and then Box_Present (Parent (Associated_Formal_Package (Formal)))
9352 then
9353 Ent := First_Entity (Formal);
9354 while Present (Ent) loop
9355 Set_Is_Hidden (Ent, False);
9356 Set_Is_Visible_Formal (Ent);
9357 Set_Is_Potentially_Use_Visible
9358 (Ent, Is_Potentially_Use_Visible (Formal));
9360 if Ekind (Ent) = E_Package then
9361 exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
9362 Process_Nested_Formal (Ent);
9363 end if;
9365 Next_Entity (Ent);
9366 end loop;
9367 end if;
9368 end Process_Nested_Formal;
9370 -- Start of processing for Instantiate_Formal_Package
9372 begin
9373 Analyze (Actual);
9375 if not Is_Entity_Name (Actual)
9376 or else Ekind (Entity (Actual)) /= E_Package
9377 then
9378 Error_Msg_N
9379 ("expect package instance to instantiate formal", Actual);
9380 Abandon_Instantiation (Actual);
9381 raise Program_Error;
9383 else
9384 Actual_Pack := Entity (Actual);
9385 Set_Is_Instantiated (Actual_Pack);
9387 -- The actual may be a renamed package, or an outer generic formal
9388 -- package whose instantiation is converted into a renaming.
9390 if Present (Renamed_Object (Actual_Pack)) then
9391 Actual_Pack := Renamed_Object (Actual_Pack);
9392 end if;
9394 if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
9395 Gen_Parent := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
9396 Formal_Pack := Defining_Identifier (Analyzed_Formal);
9397 else
9398 Gen_Parent :=
9399 Generic_Parent (Specification (Analyzed_Formal));
9400 Formal_Pack :=
9401 Defining_Unit_Name (Specification (Analyzed_Formal));
9402 end if;
9404 if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
9405 Parent_Spec := Package_Specification (Actual_Pack);
9406 else
9407 Parent_Spec := Parent (Actual_Pack);
9408 end if;
9410 if Gen_Parent = Any_Id then
9411 Error_Msg_N
9412 ("previous error in declaration of formal package", Actual);
9413 Abandon_Instantiation (Actual);
9415 elsif
9416 Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
9417 then
9418 null;
9420 else
9421 Error_Msg_NE
9422 ("actual parameter must be instance of&", Actual, Gen_Parent);
9423 Abandon_Instantiation (Actual);
9424 end if;
9426 Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
9427 Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
9429 Nod :=
9430 Make_Package_Renaming_Declaration (Loc,
9431 Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
9432 Name => New_Occurrence_Of (Actual_Pack, Loc));
9434 Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
9435 Defining_Identifier (Formal));
9436 Decls := New_List (Nod);
9438 -- If the formal F has a box, then the generic declarations are
9439 -- visible in the generic G. In an instance of G, the corresponding
9440 -- entities in the actual for F (which are the actuals for the
9441 -- instantiation of the generic that F denotes) must also be made
9442 -- visible for analysis of the current instance. On exit from the
9443 -- current instance, those entities are made private again. If the
9444 -- actual is currently in use, these entities are also use-visible.
9446 -- The loop through the actual entities also steps through the formal
9447 -- entities and enters associations from formals to actuals into the
9448 -- renaming map. This is necessary to properly handle checking of
9449 -- actual parameter associations for later formals that depend on
9450 -- actuals declared in the formal package.
9452 -- In Ada 2005, partial parameterization requires that we make
9453 -- visible the actuals corresponding to formals that were defaulted
9454 -- in the formal package. There formals are identified because they
9455 -- remain formal generics within the formal package, rather than
9456 -- being renamings of the actuals supplied.
9458 declare
9459 Gen_Decl : constant Node_Id :=
9460 Unit_Declaration_Node (Gen_Parent);
9461 Formals : constant List_Id :=
9462 Generic_Formal_Declarations (Gen_Decl);
9464 Actual_Ent : Entity_Id;
9465 Actual_Of_Formal : Node_Id;
9466 Formal_Node : Node_Id;
9467 Formal_Ent : Entity_Id;
9469 begin
9470 if Present (Formals) then
9471 Formal_Node := First_Non_Pragma (Formals);
9472 else
9473 Formal_Node := Empty;
9474 end if;
9476 Actual_Ent := First_Entity (Actual_Pack);
9477 Actual_Of_Formal :=
9478 First (Visible_Declarations (Specification (Analyzed_Formal)));
9479 while Present (Actual_Ent)
9480 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9481 loop
9482 if Present (Formal_Node) then
9483 Formal_Ent := Get_Formal_Entity (Formal_Node);
9485 if Present (Formal_Ent) then
9486 Find_Matching_Actual (Formal_Node, Actual_Ent);
9487 Match_Formal_Entity
9488 (Formal_Node, Formal_Ent, Actual_Ent);
9490 -- We iterate at the same time over the actuals of the
9491 -- local package created for the formal, to determine
9492 -- which one of the formals of the original generic were
9493 -- defaulted in the formal. The corresponding actual
9494 -- entities are visible in the enclosing instance.
9496 if Box_Present (Formal)
9497 or else
9498 (Present (Actual_Of_Formal)
9499 and then
9500 Is_Generic_Formal
9501 (Get_Formal_Entity (Actual_Of_Formal)))
9502 then
9503 Set_Is_Hidden (Actual_Ent, False);
9504 Set_Is_Visible_Formal (Actual_Ent);
9505 Set_Is_Potentially_Use_Visible
9506 (Actual_Ent, In_Use (Actual_Pack));
9508 if Ekind (Actual_Ent) = E_Package then
9509 Process_Nested_Formal (Actual_Ent);
9510 end if;
9512 else
9513 Set_Is_Hidden (Actual_Ent);
9514 Set_Is_Potentially_Use_Visible (Actual_Ent, False);
9515 end if;
9516 end if;
9518 Next_Non_Pragma (Formal_Node);
9519 Next (Actual_Of_Formal);
9521 else
9522 -- No further formals to match, but the generic part may
9523 -- contain inherited operation that are not hidden in the
9524 -- enclosing instance.
9526 Next_Entity (Actual_Ent);
9527 end if;
9528 end loop;
9530 -- Inherited subprograms generated by formal derived types are
9531 -- also visible if the types are.
9533 Actual_Ent := First_Entity (Actual_Pack);
9534 while Present (Actual_Ent)
9535 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9536 loop
9537 if Is_Overloadable (Actual_Ent)
9538 and then
9539 Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
9540 and then
9541 not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
9542 then
9543 Set_Is_Hidden (Actual_Ent, False);
9544 Set_Is_Potentially_Use_Visible
9545 (Actual_Ent, In_Use (Actual_Pack));
9546 end if;
9548 Next_Entity (Actual_Ent);
9549 end loop;
9550 end;
9552 -- If the formal is not declared with a box, reanalyze it as an
9553 -- abbreviated instantiation, to verify the matching rules of 12.7.
9554 -- The actual checks are performed after the generic associations
9555 -- have been analyzed, to guarantee the same visibility for this
9556 -- instantiation and for the actuals.
9558 -- In Ada 2005, the generic associations for the formal can include
9559 -- defaulted parameters. These are ignored during check. This
9560 -- internal instantiation is removed from the tree after conformance
9561 -- checking, because it contains formal declarations for those
9562 -- defaulted parameters, and those should not reach the back-end.
9564 if not Box_Present (Formal) then
9565 declare
9566 I_Pack : constant Entity_Id :=
9567 Make_Temporary (Sloc (Actual), 'P');
9569 begin
9570 Set_Is_Internal (I_Pack);
9572 Append_To (Decls,
9573 Make_Package_Instantiation (Sloc (Actual),
9574 Defining_Unit_Name => I_Pack,
9575 Name =>
9576 New_Occurrence_Of
9577 (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
9578 Generic_Associations =>
9579 Generic_Associations (Formal)));
9580 end;
9581 end if;
9583 return Decls;
9584 end if;
9585 end Instantiate_Formal_Package;
9587 -----------------------------------
9588 -- Instantiate_Formal_Subprogram --
9589 -----------------------------------
9591 function Instantiate_Formal_Subprogram
9592 (Formal : Node_Id;
9593 Actual : Node_Id;
9594 Analyzed_Formal : Node_Id) return Node_Id
9596 Analyzed_S : constant Entity_Id :=
9597 Defining_Unit_Name (Specification (Analyzed_Formal));
9598 Formal_Sub : constant Entity_Id :=
9599 Defining_Unit_Name (Specification (Formal));
9601 function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9602 -- If the generic is a child unit, the parent has been installed on the
9603 -- scope stack, but a default subprogram cannot resolve to something
9604 -- on the parent because that parent is not really part of the visible
9605 -- context (it is there to resolve explicit local entities). If the
9606 -- default has resolved in this way, we remove the entity from immediate
9607 -- visibility and analyze the node again to emit an error message or
9608 -- find another visible candidate.
9610 procedure Valid_Actual_Subprogram (Act : Node_Id);
9611 -- Perform legality check and raise exception on failure
9613 -----------------------
9614 -- From_Parent_Scope --
9615 -----------------------
9617 function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9618 Gen_Scope : Node_Id;
9620 begin
9621 Gen_Scope := Scope (Analyzed_S);
9622 while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9623 if Scope (Subp) = Scope (Gen_Scope) then
9624 return True;
9625 end if;
9627 Gen_Scope := Scope (Gen_Scope);
9628 end loop;
9630 return False;
9631 end From_Parent_Scope;
9633 -----------------------------
9634 -- Valid_Actual_Subprogram --
9635 -----------------------------
9637 procedure Valid_Actual_Subprogram (Act : Node_Id) is
9638 Act_E : Entity_Id;
9640 begin
9641 if Is_Entity_Name (Act) then
9642 Act_E := Entity (Act);
9644 elsif Nkind (Act) = N_Selected_Component
9645 and then Is_Entity_Name (Selector_Name (Act))
9646 then
9647 Act_E := Entity (Selector_Name (Act));
9649 else
9650 Act_E := Empty;
9651 end if;
9653 if (Present (Act_E) and then Is_Overloadable (Act_E))
9654 or else Nkind_In (Act, N_Attribute_Reference,
9655 N_Indexed_Component,
9656 N_Character_Literal,
9657 N_Explicit_Dereference)
9658 then
9659 return;
9660 end if;
9662 Error_Msg_NE
9663 ("expect subprogram or entry name in instantiation of&",
9664 Instantiation_Node, Formal_Sub);
9665 Abandon_Instantiation (Instantiation_Node);
9666 end Valid_Actual_Subprogram;
9668 -- Local variables
9670 Decl_Node : Node_Id;
9671 Loc : Source_Ptr;
9672 Nam : Node_Id;
9673 New_Spec : Node_Id;
9675 -- Start of processing for Instantiate_Formal_Subprogram
9677 begin
9678 New_Spec := New_Copy_Tree (Specification (Formal));
9680 -- The tree copy has created the proper instantiation sloc for the
9681 -- new specification. Use this location for all other constructed
9682 -- declarations.
9684 Loc := Sloc (Defining_Unit_Name (New_Spec));
9686 -- Create new entity for the actual (New_Copy_Tree does not), and
9687 -- indicate that it is an actual.
9689 Set_Defining_Unit_Name
9690 (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9691 Set_Ekind (Defining_Unit_Name (New_Spec), Ekind (Analyzed_S));
9692 Set_Is_Generic_Actual_Subprogram (Defining_Unit_Name (New_Spec));
9694 -- Create new entities for the each of the formals in the specification
9695 -- of the renaming declaration built for the actual.
9697 if Present (Parameter_Specifications (New_Spec)) then
9698 declare
9699 F : Node_Id;
9700 F_Id : Entity_Id;
9702 begin
9703 F := First (Parameter_Specifications (New_Spec));
9704 while Present (F) loop
9705 F_Id := Defining_Identifier (F);
9707 Set_Defining_Identifier (F,
9708 Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id)));
9709 Next (F);
9710 end loop;
9711 end;
9712 end if;
9714 -- Find entity of actual. If the actual is an attribute reference, it
9715 -- cannot be resolved here (its formal is missing) but is handled
9716 -- instead in Attribute_Renaming. If the actual is overloaded, it is
9717 -- fully resolved subsequently, when the renaming declaration for the
9718 -- formal is analyzed. If it is an explicit dereference, resolve the
9719 -- prefix but not the actual itself, to prevent interpretation as call.
9721 if Present (Actual) then
9722 Loc := Sloc (Actual);
9723 Set_Sloc (New_Spec, Loc);
9725 if Nkind (Actual) = N_Operator_Symbol then
9726 Find_Direct_Name (Actual);
9728 elsif Nkind (Actual) = N_Explicit_Dereference then
9729 Analyze (Prefix (Actual));
9731 elsif Nkind (Actual) /= N_Attribute_Reference then
9732 Analyze (Actual);
9733 end if;
9735 Valid_Actual_Subprogram (Actual);
9736 Nam := Actual;
9738 elsif Present (Default_Name (Formal)) then
9739 if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9740 N_Selected_Component,
9741 N_Indexed_Component,
9742 N_Character_Literal)
9743 and then Present (Entity (Default_Name (Formal)))
9744 then
9745 Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9746 else
9747 Nam := New_Copy (Default_Name (Formal));
9748 Set_Sloc (Nam, Loc);
9749 end if;
9751 elsif Box_Present (Formal) then
9753 -- Actual is resolved at the point of instantiation. Create an
9754 -- identifier or operator with the same name as the formal.
9756 if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9757 Nam :=
9758 Make_Operator_Symbol (Loc,
9759 Chars => Chars (Formal_Sub),
9760 Strval => No_String);
9761 else
9762 Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9763 end if;
9765 elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9766 and then Null_Present (Specification (Formal))
9767 then
9768 -- Generate null body for procedure, for use in the instance
9770 Decl_Node :=
9771 Make_Subprogram_Body (Loc,
9772 Specification => New_Spec,
9773 Declarations => New_List,
9774 Handled_Statement_Sequence =>
9775 Make_Handled_Sequence_Of_Statements (Loc,
9776 Statements => New_List (Make_Null_Statement (Loc))));
9778 Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9779 return Decl_Node;
9781 else
9782 Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9783 Error_Msg_NE
9784 ("missing actual&", Instantiation_Node, Formal_Sub);
9785 Error_Msg_NE
9786 ("\in instantiation of & declared#",
9787 Instantiation_Node, Scope (Analyzed_S));
9788 Abandon_Instantiation (Instantiation_Node);
9789 end if;
9791 Decl_Node :=
9792 Make_Subprogram_Renaming_Declaration (Loc,
9793 Specification => New_Spec,
9794 Name => Nam);
9796 -- If we do not have an actual and the formal specified <> then set to
9797 -- get proper default.
9799 if No (Actual) and then Box_Present (Formal) then
9800 Set_From_Default (Decl_Node);
9801 end if;
9803 -- Gather possible interpretations for the actual before analyzing the
9804 -- instance. If overloaded, it will be resolved when analyzing the
9805 -- renaming declaration.
9807 if Box_Present (Formal) and then No (Actual) then
9808 Analyze (Nam);
9810 if Is_Child_Unit (Scope (Analyzed_S))
9811 and then Present (Entity (Nam))
9812 then
9813 if not Is_Overloaded (Nam) then
9814 if From_Parent_Scope (Entity (Nam)) then
9815 Set_Is_Immediately_Visible (Entity (Nam), False);
9816 Set_Entity (Nam, Empty);
9817 Set_Etype (Nam, Empty);
9819 Analyze (Nam);
9820 Set_Is_Immediately_Visible (Entity (Nam));
9821 end if;
9823 else
9824 declare
9825 I : Interp_Index;
9826 It : Interp;
9828 begin
9829 Get_First_Interp (Nam, I, It);
9830 while Present (It.Nam) loop
9831 if From_Parent_Scope (It.Nam) then
9832 Remove_Interp (I);
9833 end if;
9835 Get_Next_Interp (I, It);
9836 end loop;
9837 end;
9838 end if;
9839 end if;
9840 end if;
9842 -- The generic instantiation freezes the actual. This can only be done
9843 -- once the actual is resolved, in the analysis of the renaming
9844 -- declaration. To make the formal subprogram entity available, we set
9845 -- Corresponding_Formal_Spec to point to the formal subprogram entity.
9846 -- This is also needed in Analyze_Subprogram_Renaming for the processing
9847 -- of formal abstract subprograms.
9849 Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9851 -- We cannot analyze the renaming declaration, and thus find the actual,
9852 -- until all the actuals are assembled in the instance. For subsequent
9853 -- checks of other actuals, indicate the node that will hold the
9854 -- instance of this formal.
9856 Set_Instance_Of (Analyzed_S, Nam);
9858 if Nkind (Actual) = N_Selected_Component
9859 and then Is_Task_Type (Etype (Prefix (Actual)))
9860 and then not Is_Frozen (Etype (Prefix (Actual)))
9861 then
9862 -- The renaming declaration will create a body, which must appear
9863 -- outside of the instantiation, We move the renaming declaration
9864 -- out of the instance, and create an additional renaming inside,
9865 -- to prevent freezing anomalies.
9867 declare
9868 Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9870 begin
9871 Set_Defining_Unit_Name (New_Spec, Anon_Id);
9872 Insert_Before (Instantiation_Node, Decl_Node);
9873 Analyze (Decl_Node);
9875 -- Now create renaming within the instance
9877 Decl_Node :=
9878 Make_Subprogram_Renaming_Declaration (Loc,
9879 Specification => New_Copy_Tree (New_Spec),
9880 Name => New_Occurrence_Of (Anon_Id, Loc));
9882 Set_Defining_Unit_Name (Specification (Decl_Node),
9883 Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9884 end;
9885 end if;
9887 return Decl_Node;
9888 end Instantiate_Formal_Subprogram;
9890 ------------------------
9891 -- Instantiate_Object --
9892 ------------------------
9894 function Instantiate_Object
9895 (Formal : Node_Id;
9896 Actual : Node_Id;
9897 Analyzed_Formal : Node_Id) return List_Id
9899 Gen_Obj : constant Entity_Id := Defining_Identifier (Formal);
9900 A_Gen_Obj : constant Entity_Id :=
9901 Defining_Identifier (Analyzed_Formal);
9902 Acc_Def : Node_Id := Empty;
9903 Act_Assoc : constant Node_Id := Parent (Actual);
9904 Actual_Decl : Node_Id := Empty;
9905 Decl_Node : Node_Id;
9906 Def : Node_Id;
9907 Ftyp : Entity_Id;
9908 List : constant List_Id := New_List;
9909 Loc : constant Source_Ptr := Sloc (Actual);
9910 Orig_Ftyp : constant Entity_Id := Etype (A_Gen_Obj);
9911 Subt_Decl : Node_Id := Empty;
9912 Subt_Mark : Node_Id := Empty;
9914 begin
9915 if Present (Subtype_Mark (Formal)) then
9916 Subt_Mark := Subtype_Mark (Formal);
9917 else
9918 Check_Access_Definition (Formal);
9919 Acc_Def := Access_Definition (Formal);
9920 end if;
9922 -- Sloc for error message on missing actual
9924 Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
9926 if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
9927 Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
9928 end if;
9930 Set_Parent (List, Parent (Actual));
9932 -- OUT present
9934 if Out_Present (Formal) then
9936 -- An IN OUT generic actual must be a name. The instantiation is a
9937 -- renaming declaration. The actual is the name being renamed. We
9938 -- use the actual directly, rather than a copy, because it is not
9939 -- used further in the list of actuals, and because a copy or a use
9940 -- of relocate_node is incorrect if the instance is nested within a
9941 -- generic. In order to simplify ASIS searches, the Generic_Parent
9942 -- field links the declaration to the generic association.
9944 if No (Actual) then
9945 Error_Msg_NE
9946 ("missing actual&",
9947 Instantiation_Node, Gen_Obj);
9948 Error_Msg_NE
9949 ("\in instantiation of & declared#",
9950 Instantiation_Node, Scope (A_Gen_Obj));
9951 Abandon_Instantiation (Instantiation_Node);
9952 end if;
9954 if Present (Subt_Mark) then
9955 Decl_Node :=
9956 Make_Object_Renaming_Declaration (Loc,
9957 Defining_Identifier => New_Copy (Gen_Obj),
9958 Subtype_Mark => New_Copy_Tree (Subt_Mark),
9959 Name => Actual);
9961 else pragma Assert (Present (Acc_Def));
9962 Decl_Node :=
9963 Make_Object_Renaming_Declaration (Loc,
9964 Defining_Identifier => New_Copy (Gen_Obj),
9965 Access_Definition => New_Copy_Tree (Acc_Def),
9966 Name => Actual);
9967 end if;
9969 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9971 -- The analysis of the actual may produce Insert_Action nodes, so
9972 -- the declaration must have a context in which to attach them.
9974 Append (Decl_Node, List);
9975 Analyze (Actual);
9977 -- Return if the analysis of the actual reported some error
9979 if Etype (Actual) = Any_Type then
9980 return List;
9981 end if;
9983 -- This check is performed here because Analyze_Object_Renaming will
9984 -- not check it when Comes_From_Source is False. Note though that the
9985 -- check for the actual being the name of an object will be performed
9986 -- in Analyze_Object_Renaming.
9988 if Is_Object_Reference (Actual)
9989 and then Is_Dependent_Component_Of_Mutable_Object (Actual)
9990 then
9991 Error_Msg_N
9992 ("illegal discriminant-dependent component for in out parameter",
9993 Actual);
9994 end if;
9996 -- The actual has to be resolved in order to check that it is a
9997 -- variable (due to cases such as F (1), where F returns access to
9998 -- an array, and for overloaded prefixes).
10000 Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
10002 -- If the type of the formal is not itself a formal, and the current
10003 -- unit is a child unit, the formal type must be declared in a
10004 -- parent, and must be retrieved by visibility.
10006 if Ftyp = Orig_Ftyp
10007 and then Is_Generic_Unit (Scope (Ftyp))
10008 and then Is_Child_Unit (Scope (A_Gen_Obj))
10009 then
10010 declare
10011 Temp : constant Node_Id :=
10012 New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
10013 begin
10014 Set_Entity (Temp, Empty);
10015 Find_Type (Temp);
10016 Ftyp := Entity (Temp);
10017 end;
10018 end if;
10020 if Is_Private_Type (Ftyp)
10021 and then not Is_Private_Type (Etype (Actual))
10022 and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
10023 or else Base_Type (Etype (Actual)) = Ftyp)
10024 then
10025 -- If the actual has the type of the full view of the formal, or
10026 -- else a non-private subtype of the formal, then the visibility
10027 -- of the formal type has changed. Add to the actuals a subtype
10028 -- declaration that will force the exchange of views in the body
10029 -- of the instance as well.
10031 Subt_Decl :=
10032 Make_Subtype_Declaration (Loc,
10033 Defining_Identifier => Make_Temporary (Loc, 'P'),
10034 Subtype_Indication => New_Occurrence_Of (Ftyp, Loc));
10036 Prepend (Subt_Decl, List);
10038 Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
10039 Exchange_Declarations (Ftyp);
10040 end if;
10042 Resolve (Actual, Ftyp);
10044 if not Denotes_Variable (Actual) then
10045 Error_Msg_NE
10046 ("actual for& must be a variable", Actual, Gen_Obj);
10048 elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
10050 -- Ada 2005 (AI-423): For a generic formal object of mode in out,
10051 -- the type of the actual shall resolve to a specific anonymous
10052 -- access type.
10054 if Ada_Version < Ada_2005
10055 or else Ekind (Base_Type (Ftyp)) /=
10056 E_Anonymous_Access_Type
10057 or else Ekind (Base_Type (Etype (Actual))) /=
10058 E_Anonymous_Access_Type
10059 then
10060 Error_Msg_NE
10061 ("type of actual does not match type of&", Actual, Gen_Obj);
10062 end if;
10063 end if;
10065 Note_Possible_Modification (Actual, Sure => True);
10067 -- Check for instantiation of atomic/volatile actual for
10068 -- non-atomic/volatile formal (RM C.6 (12)).
10070 if Is_Atomic_Object (Actual) and then not Is_Atomic (Orig_Ftyp) then
10071 Error_Msg_N
10072 ("cannot instantiate non-atomic formal object "
10073 & "with atomic actual", Actual);
10075 elsif Is_Volatile_Object (Actual) and then not Is_Volatile (Orig_Ftyp)
10076 then
10077 Error_Msg_N
10078 ("cannot instantiate non-volatile formal object "
10079 & "with volatile actual", Actual);
10080 end if;
10082 -- Formal in-parameter
10084 else
10085 -- The instantiation of a generic formal in-parameter is constant
10086 -- declaration. The actual is the expression for that declaration.
10088 if Present (Actual) then
10089 if Present (Subt_Mark) then
10090 Def := Subt_Mark;
10091 else pragma Assert (Present (Acc_Def));
10092 Def := Acc_Def;
10093 end if;
10095 Decl_Node :=
10096 Make_Object_Declaration (Loc,
10097 Defining_Identifier => New_Copy (Gen_Obj),
10098 Constant_Present => True,
10099 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10100 Object_Definition => New_Copy_Tree (Def),
10101 Expression => Actual);
10103 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
10105 -- A generic formal object of a tagged type is defined to be
10106 -- aliased so the new constant must also be treated as aliased.
10108 if Is_Tagged_Type (Etype (A_Gen_Obj)) then
10109 Set_Aliased_Present (Decl_Node);
10110 end if;
10112 Append (Decl_Node, List);
10114 -- No need to repeat (pre-)analysis of some expression nodes
10115 -- already handled in Preanalyze_Actuals.
10117 if Nkind (Actual) /= N_Allocator then
10118 Analyze (Actual);
10120 -- Return if the analysis of the actual reported some error
10122 if Etype (Actual) = Any_Type then
10123 return List;
10124 end if;
10125 end if;
10127 declare
10128 Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
10129 Typ : Entity_Id;
10131 begin
10132 Typ := Get_Instance_Of (Formal_Type);
10134 Freeze_Before (Instantiation_Node, Typ);
10136 -- If the actual is an aggregate, perform name resolution on
10137 -- its components (the analysis of an aggregate does not do it)
10138 -- to capture local names that may be hidden if the generic is
10139 -- a child unit.
10141 if Nkind (Actual) = N_Aggregate then
10142 Preanalyze_And_Resolve (Actual, Typ);
10143 end if;
10145 if Is_Limited_Type (Typ)
10146 and then not OK_For_Limited_Init (Typ, Actual)
10147 then
10148 Error_Msg_N
10149 ("initialization not allowed for limited types", Actual);
10150 Explain_Limited_Type (Typ, Actual);
10151 end if;
10152 end;
10154 elsif Present (Default_Expression (Formal)) then
10156 -- Use default to construct declaration
10158 if Present (Subt_Mark) then
10159 Def := Subt_Mark;
10160 else pragma Assert (Present (Acc_Def));
10161 Def := Acc_Def;
10162 end if;
10164 Decl_Node :=
10165 Make_Object_Declaration (Sloc (Formal),
10166 Defining_Identifier => New_Copy (Gen_Obj),
10167 Constant_Present => True,
10168 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10169 Object_Definition => New_Copy (Def),
10170 Expression => New_Copy_Tree
10171 (Default_Expression (Formal)));
10173 Append (Decl_Node, List);
10174 Set_Analyzed (Expression (Decl_Node), False);
10176 else
10177 Error_Msg_NE
10178 ("missing actual&",
10179 Instantiation_Node, Gen_Obj);
10180 Error_Msg_NE ("\in instantiation of & declared#",
10181 Instantiation_Node, Scope (A_Gen_Obj));
10183 if Is_Scalar_Type (Etype (A_Gen_Obj)) then
10185 -- Create dummy constant declaration so that instance can be
10186 -- analyzed, to minimize cascaded visibility errors.
10188 if Present (Subt_Mark) then
10189 Def := Subt_Mark;
10190 else pragma Assert (Present (Acc_Def));
10191 Def := Acc_Def;
10192 end if;
10194 Decl_Node :=
10195 Make_Object_Declaration (Loc,
10196 Defining_Identifier => New_Copy (Gen_Obj),
10197 Constant_Present => True,
10198 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10199 Object_Definition => New_Copy (Def),
10200 Expression =>
10201 Make_Attribute_Reference (Sloc (Gen_Obj),
10202 Attribute_Name => Name_First,
10203 Prefix => New_Copy (Def)));
10205 Append (Decl_Node, List);
10207 else
10208 Abandon_Instantiation (Instantiation_Node);
10209 end if;
10210 end if;
10211 end if;
10213 if Nkind (Actual) in N_Has_Entity then
10214 Actual_Decl := Parent (Entity (Actual));
10215 end if;
10217 -- Ada 2005 (AI-423): For a formal object declaration with a null
10218 -- exclusion or an access definition that has a null exclusion: If the
10219 -- actual matching the formal object declaration denotes a generic
10220 -- formal object of another generic unit G, and the instantiation
10221 -- containing the actual occurs within the body of G or within the body
10222 -- of a generic unit declared within the declarative region of G, then
10223 -- the declaration of the formal object of G must have a null exclusion.
10224 -- Otherwise, the subtype of the actual matching the formal object
10225 -- declaration shall exclude null.
10227 if Ada_Version >= Ada_2005
10228 and then Present (Actual_Decl)
10229 and then
10230 Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
10231 N_Object_Declaration)
10232 and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
10233 and then not Has_Null_Exclusion (Actual_Decl)
10234 and then Has_Null_Exclusion (Analyzed_Formal)
10235 then
10236 Error_Msg_Sloc := Sloc (Analyzed_Formal);
10237 Error_Msg_N
10238 ("actual must exclude null to match generic formal#", Actual);
10239 end if;
10241 -- An effectively volatile object cannot be used as an actual in
10242 -- a generic instance. The following check is only relevant when
10243 -- SPARK_Mode is on as it is not a standard Ada legality rule.
10245 if SPARK_Mode = On
10246 and then Present (Actual)
10247 and then Is_Effectively_Volatile_Object (Actual)
10248 then
10249 Error_Msg_N
10250 ("volatile object cannot act as actual in generic instantiation "
10251 & "(SPARK RM 7.1.3(8))", Actual);
10252 end if;
10254 return List;
10255 end Instantiate_Object;
10257 ------------------------------
10258 -- Instantiate_Package_Body --
10259 ------------------------------
10261 procedure Instantiate_Package_Body
10262 (Body_Info : Pending_Body_Info;
10263 Inlined_Body : Boolean := False;
10264 Body_Optional : Boolean := False)
10266 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10267 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10268 Loc : constant Source_Ptr := Sloc (Inst_Node);
10270 Gen_Id : constant Node_Id := Name (Inst_Node);
10271 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10272 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10273 Act_Spec : constant Node_Id := Specification (Act_Decl);
10274 Act_Decl_Id : constant Entity_Id := Defining_Entity (Act_Spec);
10276 Act_Body_Name : Node_Id;
10277 Gen_Body : Node_Id;
10278 Gen_Body_Id : Node_Id;
10279 Act_Body : Node_Id;
10280 Act_Body_Id : Entity_Id;
10282 Parent_Installed : Boolean := False;
10283 Save_Style_Check : constant Boolean := Style_Check;
10285 Par_Ent : Entity_Id := Empty;
10286 Par_Vis : Boolean := False;
10288 Vis_Prims_List : Elist_Id := No_Elist;
10289 -- List of primitives made temporarily visible in the instantiation
10290 -- to match the visibility of the formal type
10292 procedure Check_Initialized_Types;
10293 -- In a generic package body, an entity of a generic private type may
10294 -- appear uninitialized. This is suspicious, unless the actual is a
10295 -- fully initialized type.
10297 -----------------------------
10298 -- Check_Initialized_Types --
10299 -----------------------------
10301 procedure Check_Initialized_Types is
10302 Decl : Node_Id;
10303 Formal : Entity_Id;
10304 Actual : Entity_Id;
10305 Uninit_Var : Entity_Id;
10307 begin
10308 Decl := First (Generic_Formal_Declarations (Gen_Decl));
10309 while Present (Decl) loop
10310 Uninit_Var := Empty;
10312 if Nkind (Decl) = N_Private_Extension_Declaration then
10313 Uninit_Var := Uninitialized_Variable (Decl);
10315 elsif Nkind (Decl) = N_Formal_Type_Declaration
10316 and then Nkind (Formal_Type_Definition (Decl)) =
10317 N_Formal_Private_Type_Definition
10318 then
10319 Uninit_Var :=
10320 Uninitialized_Variable (Formal_Type_Definition (Decl));
10321 end if;
10323 if Present (Uninit_Var) then
10324 Formal := Defining_Identifier (Decl);
10325 Actual := First_Entity (Act_Decl_Id);
10327 -- For each formal there is a subtype declaration that renames
10328 -- the actual and has the same name as the formal. Locate the
10329 -- formal for warning message about uninitialized variables
10330 -- in the generic, for which the actual type should be a fully
10331 -- initialized type.
10333 while Present (Actual) loop
10334 exit when Ekind (Actual) = E_Package
10335 and then Present (Renamed_Object (Actual));
10337 if Chars (Actual) = Chars (Formal)
10338 and then not Is_Scalar_Type (Actual)
10339 and then not Is_Fully_Initialized_Type (Actual)
10340 and then Warn_On_No_Value_Assigned
10341 then
10342 Error_Msg_Node_2 := Formal;
10343 Error_Msg_NE
10344 ("generic unit has uninitialized variable& of "
10345 & "formal private type &?v?", Actual, Uninit_Var);
10346 Error_Msg_NE
10347 ("actual type for& should be fully initialized type?v?",
10348 Actual, Formal);
10349 exit;
10350 end if;
10352 Next_Entity (Actual);
10353 end loop;
10354 end if;
10356 Next (Decl);
10357 end loop;
10358 end Check_Initialized_Types;
10360 -- Start of processing for Instantiate_Package_Body
10362 begin
10363 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10365 -- The instance body may already have been processed, as the parent of
10366 -- another instance that is inlined (Load_Parent_Of_Generic).
10368 if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
10369 return;
10370 end if;
10372 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10374 -- Re-establish the state of information on which checks are suppressed.
10375 -- This information was set in Body_Info at the point of instantiation,
10376 -- and now we restore it so that the instance is compiled using the
10377 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10379 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10380 Scope_Suppress := Body_Info.Scope_Suppress;
10381 Opt.Ada_Version := Body_Info.Version;
10382 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10383 Restore_Warnings (Body_Info.Warnings);
10384 Opt.SPARK_Mode := Body_Info.SPARK_Mode;
10385 Opt.SPARK_Mode_Pragma := Body_Info.SPARK_Mode_Pragma;
10387 if No (Gen_Body_Id) then
10389 -- Do not look for parent of generic body if none is required.
10390 -- This may happen when the routine is called as part of the
10391 -- Pending_Instantiations processing, when nested instances
10392 -- may precede the one generated from the main unit.
10394 if not Unit_Requires_Body (Defining_Entity (Gen_Decl))
10395 and then Body_Optional
10396 then
10397 return;
10398 else
10399 Load_Parent_Of_Generic
10400 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10401 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10402 end if;
10403 end if;
10405 -- Establish global variable for sloc adjustment and for error recovery
10407 Instantiation_Node := Inst_Node;
10409 if Present (Gen_Body_Id) then
10410 Save_Env (Gen_Unit, Act_Decl_Id);
10411 Style_Check := False;
10412 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10414 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10416 Create_Instantiation_Source
10417 (Inst_Node, Gen_Body_Id, False, S_Adjustment);
10419 Act_Body :=
10420 Copy_Generic_Node
10421 (Original_Node (Gen_Body), Empty, Instantiating => True);
10423 -- Build new name (possibly qualified) for body declaration
10425 Act_Body_Id := New_Copy (Act_Decl_Id);
10427 -- Some attributes of spec entity are not inherited by body entity
10429 Set_Handler_Records (Act_Body_Id, No_List);
10431 if Nkind (Defining_Unit_Name (Act_Spec)) =
10432 N_Defining_Program_Unit_Name
10433 then
10434 Act_Body_Name :=
10435 Make_Defining_Program_Unit_Name (Loc,
10436 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
10437 Defining_Identifier => Act_Body_Id);
10438 else
10439 Act_Body_Name := Act_Body_Id;
10440 end if;
10442 Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
10444 Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
10445 Check_Generic_Actuals (Act_Decl_Id, False);
10446 Check_Initialized_Types;
10448 -- Install primitives hidden at the point of the instantiation but
10449 -- visible when processing the generic formals
10451 declare
10452 E : Entity_Id;
10454 begin
10455 E := First_Entity (Act_Decl_Id);
10456 while Present (E) loop
10457 if Is_Type (E)
10458 and then Is_Generic_Actual_Type (E)
10459 and then Is_Tagged_Type (E)
10460 then
10461 Install_Hidden_Primitives
10462 (Prims_List => Vis_Prims_List,
10463 Gen_T => Generic_Parent_Type (Parent (E)),
10464 Act_T => E);
10465 end if;
10467 Next_Entity (E);
10468 end loop;
10469 end;
10471 -- If it is a child unit, make the parent instance (which is an
10472 -- instance of the parent of the generic) visible. The parent
10473 -- instance is the prefix of the name of the generic unit.
10475 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10476 and then Nkind (Gen_Id) = N_Expanded_Name
10477 then
10478 Par_Ent := Entity (Prefix (Gen_Id));
10479 Par_Vis := Is_Immediately_Visible (Par_Ent);
10480 Install_Parent (Par_Ent, In_Body => True);
10481 Parent_Installed := True;
10483 elsif Is_Child_Unit (Gen_Unit) then
10484 Par_Ent := Scope (Gen_Unit);
10485 Par_Vis := Is_Immediately_Visible (Par_Ent);
10486 Install_Parent (Par_Ent, In_Body => True);
10487 Parent_Installed := True;
10488 end if;
10490 -- If the instantiation is a library unit, and this is the main unit,
10491 -- then build the resulting compilation unit nodes for the instance.
10492 -- If this is a compilation unit but it is not the main unit, then it
10493 -- is the body of a unit in the context, that is being compiled
10494 -- because it is encloses some inlined unit or another generic unit
10495 -- being instantiated. In that case, this body is not part of the
10496 -- current compilation, and is not attached to the tree, but its
10497 -- parent must be set for analysis.
10499 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10501 -- Replace instance node with body of instance, and create new
10502 -- node for corresponding instance declaration.
10504 Build_Instance_Compilation_Unit_Nodes
10505 (Inst_Node, Act_Body, Act_Decl);
10506 Analyze (Inst_Node);
10508 if Parent (Inst_Node) = Cunit (Main_Unit) then
10510 -- If the instance is a child unit itself, then set the scope
10511 -- of the expanded body to be the parent of the instantiation
10512 -- (ensuring that the fully qualified name will be generated
10513 -- for the elaboration subprogram).
10515 if Nkind (Defining_Unit_Name (Act_Spec)) =
10516 N_Defining_Program_Unit_Name
10517 then
10518 Set_Scope
10519 (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
10520 end if;
10521 end if;
10523 -- Case where instantiation is not a library unit
10525 else
10526 -- If this is an early instantiation, i.e. appears textually
10527 -- before the corresponding body and must be elaborated first,
10528 -- indicate that the body instance is to be delayed.
10530 Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
10532 -- Now analyze the body. We turn off all checks if this is an
10533 -- internal unit, since there is no reason to have checks on for
10534 -- any predefined run-time library code. All such code is designed
10535 -- to be compiled with checks off.
10537 -- Note that we do NOT apply this criterion to children of GNAT
10538 -- The latter units must suppress checks explicitly if needed.
10540 if Is_Predefined_File_Name
10541 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
10542 then
10543 Analyze (Act_Body, Suppress => All_Checks);
10544 else
10545 Analyze (Act_Body);
10546 end if;
10547 end if;
10549 Inherit_Context (Gen_Body, Inst_Node);
10551 -- Remove the parent instances if they have been placed on the scope
10552 -- stack to compile the body.
10554 if Parent_Installed then
10555 Remove_Parent (In_Body => True);
10557 -- Restore the previous visibility of the parent
10559 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10560 end if;
10562 Restore_Hidden_Primitives (Vis_Prims_List);
10563 Restore_Private_Views (Act_Decl_Id);
10565 -- Remove the current unit from visibility if this is an instance
10566 -- that is not elaborated on the fly for inlining purposes.
10568 if not Inlined_Body then
10569 Set_Is_Immediately_Visible (Act_Decl_Id, False);
10570 end if;
10572 Restore_Env;
10573 Style_Check := Save_Style_Check;
10575 -- If we have no body, and the unit requires a body, then complain. This
10576 -- complaint is suppressed if we have detected other errors (since a
10577 -- common reason for missing the body is that it had errors).
10578 -- In CodePeer mode, a warning has been emitted already, no need for
10579 -- further messages.
10581 elsif Unit_Requires_Body (Gen_Unit)
10582 and then not Body_Optional
10583 then
10584 if CodePeer_Mode then
10585 null;
10587 elsif Serious_Errors_Detected = 0 then
10588 Error_Msg_NE
10589 ("cannot find body of generic package &", Inst_Node, Gen_Unit);
10591 -- Don't attempt to perform any cleanup actions if some other error
10592 -- was already detected, since this can cause blowups.
10594 else
10595 return;
10596 end if;
10598 -- Case of package that does not need a body
10600 else
10601 -- If the instantiation of the declaration is a library unit, rewrite
10602 -- the original package instantiation as a package declaration in the
10603 -- compilation unit node.
10605 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10606 Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
10607 Rewrite (Inst_Node, Act_Decl);
10609 -- Generate elaboration entity, in case spec has elaboration code.
10610 -- This cannot be done when the instance is analyzed, because it
10611 -- is not known yet whether the body exists.
10613 Set_Elaboration_Entity_Required (Act_Decl_Id, False);
10614 Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
10616 -- If the instantiation is not a library unit, then append the
10617 -- declaration to the list of implicitly generated entities, unless
10618 -- it is already a list member which means that it was already
10619 -- processed
10621 elsif not Is_List_Member (Act_Decl) then
10622 Mark_Rewrite_Insertion (Act_Decl);
10623 Insert_Before (Inst_Node, Act_Decl);
10624 end if;
10625 end if;
10627 Expander_Mode_Restore;
10628 end Instantiate_Package_Body;
10630 ---------------------------------
10631 -- Instantiate_Subprogram_Body --
10632 ---------------------------------
10634 procedure Instantiate_Subprogram_Body
10635 (Body_Info : Pending_Body_Info;
10636 Body_Optional : Boolean := False)
10638 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10639 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10640 Loc : constant Source_Ptr := Sloc (Inst_Node);
10641 Gen_Id : constant Node_Id := Name (Inst_Node);
10642 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10643 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10644 Anon_Id : constant Entity_Id :=
10645 Defining_Unit_Name (Specification (Act_Decl));
10646 Pack_Id : constant Entity_Id :=
10647 Defining_Unit_Name (Parent (Act_Decl));
10648 Decls : List_Id;
10649 Gen_Body : Node_Id;
10650 Gen_Body_Id : Node_Id;
10651 Act_Body : Node_Id;
10652 Pack_Body : Node_Id;
10653 Prev_Formal : Entity_Id;
10654 Ret_Expr : Node_Id;
10655 Unit_Renaming : Node_Id;
10657 Parent_Installed : Boolean := False;
10659 Saved_Style_Check : constant Boolean := Style_Check;
10660 Saved_Warnings : constant Warning_Record := Save_Warnings;
10662 Par_Ent : Entity_Id := Empty;
10663 Par_Vis : Boolean := False;
10665 begin
10666 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10668 -- Subprogram body may have been created already because of an inline
10669 -- pragma, or because of multiple elaborations of the enclosing package
10670 -- when several instances of the subprogram appear in the main unit.
10672 if Present (Corresponding_Body (Act_Decl)) then
10673 return;
10674 end if;
10676 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10678 -- Re-establish the state of information on which checks are suppressed.
10679 -- This information was set in Body_Info at the point of instantiation,
10680 -- and now we restore it so that the instance is compiled using the
10681 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10683 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10684 Scope_Suppress := Body_Info.Scope_Suppress;
10685 Opt.Ada_Version := Body_Info.Version;
10686 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10687 Restore_Warnings (Body_Info.Warnings);
10688 Opt.SPARK_Mode := Body_Info.SPARK_Mode;
10689 Opt.SPARK_Mode_Pragma := Body_Info.SPARK_Mode_Pragma;
10691 if No (Gen_Body_Id) then
10693 -- For imported generic subprogram, no body to compile, complete
10694 -- the spec entity appropriately.
10696 if Is_Imported (Gen_Unit) then
10697 Set_Is_Imported (Anon_Id);
10698 Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10699 Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10700 Set_Convention (Anon_Id, Convention (Gen_Unit));
10701 Set_Has_Completion (Anon_Id);
10702 return;
10704 -- For other cases, compile the body
10706 else
10707 Load_Parent_Of_Generic
10708 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10709 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10710 end if;
10711 end if;
10713 Instantiation_Node := Inst_Node;
10715 if Present (Gen_Body_Id) then
10716 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10718 if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10720 -- Either body is not present, or context is non-expanding, as
10721 -- when compiling a subunit. Mark the instance as completed, and
10722 -- diagnose a missing body when needed.
10724 if Expander_Active
10725 and then Operating_Mode = Generate_Code
10726 then
10727 Error_Msg_N
10728 ("missing proper body for instantiation", Gen_Body);
10729 end if;
10731 Set_Has_Completion (Anon_Id);
10732 return;
10733 end if;
10735 Save_Env (Gen_Unit, Anon_Id);
10736 Style_Check := False;
10737 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10738 Create_Instantiation_Source
10739 (Inst_Node,
10740 Gen_Body_Id,
10741 False,
10742 S_Adjustment);
10744 Act_Body :=
10745 Copy_Generic_Node
10746 (Original_Node (Gen_Body), Empty, Instantiating => True);
10748 -- Create proper defining name for the body, to correspond to
10749 -- the one in the spec.
10751 Set_Defining_Unit_Name (Specification (Act_Body),
10752 Make_Defining_Identifier
10753 (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10754 Set_Corresponding_Spec (Act_Body, Anon_Id);
10755 Set_Has_Completion (Anon_Id);
10756 Check_Generic_Actuals (Pack_Id, False);
10758 -- Generate a reference to link the visible subprogram instance to
10759 -- the generic body, which for navigation purposes is the only
10760 -- available source for the instance.
10762 Generate_Reference
10763 (Related_Instance (Pack_Id),
10764 Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10766 -- If it is a child unit, make the parent instance (which is an
10767 -- instance of the parent of the generic) visible. The parent
10768 -- instance is the prefix of the name of the generic unit.
10770 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10771 and then Nkind (Gen_Id) = N_Expanded_Name
10772 then
10773 Par_Ent := Entity (Prefix (Gen_Id));
10774 Par_Vis := Is_Immediately_Visible (Par_Ent);
10775 Install_Parent (Par_Ent, In_Body => True);
10776 Parent_Installed := True;
10778 elsif Is_Child_Unit (Gen_Unit) then
10779 Par_Ent := Scope (Gen_Unit);
10780 Par_Vis := Is_Immediately_Visible (Par_Ent);
10781 Install_Parent (Par_Ent, In_Body => True);
10782 Parent_Installed := True;
10783 end if;
10785 -- Inside its body, a reference to the generic unit is a reference
10786 -- to the instance. The corresponding renaming is the first
10787 -- declaration in the body.
10789 Unit_Renaming :=
10790 Make_Subprogram_Renaming_Declaration (Loc,
10791 Specification =>
10792 Copy_Generic_Node (
10793 Specification (Original_Node (Gen_Body)),
10794 Empty,
10795 Instantiating => True),
10796 Name => New_Occurrence_Of (Anon_Id, Loc));
10798 -- If there is a formal subprogram with the same name as the unit
10799 -- itself, do not add this renaming declaration. This is a temporary
10800 -- fix for one ACVC test. ???
10802 Prev_Formal := First_Entity (Pack_Id);
10803 while Present (Prev_Formal) loop
10804 if Chars (Prev_Formal) = Chars (Gen_Unit)
10805 and then Is_Overloadable (Prev_Formal)
10806 then
10807 exit;
10808 end if;
10810 Next_Entity (Prev_Formal);
10811 end loop;
10813 if Present (Prev_Formal) then
10814 Decls := New_List (Act_Body);
10815 else
10816 Decls := New_List (Unit_Renaming, Act_Body);
10817 end if;
10819 -- The subprogram body is placed in the body of a dummy package body,
10820 -- whose spec contains the subprogram declaration as well as the
10821 -- renaming declarations for the generic parameters.
10823 Pack_Body := Make_Package_Body (Loc,
10824 Defining_Unit_Name => New_Copy (Pack_Id),
10825 Declarations => Decls);
10827 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10829 -- If the instantiation is a library unit, then build resulting
10830 -- compilation unit nodes for the instance. The declaration of
10831 -- the enclosing package is the grandparent of the subprogram
10832 -- declaration. First replace the instantiation node as the unit
10833 -- of the corresponding compilation.
10835 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10836 if Parent (Inst_Node) = Cunit (Main_Unit) then
10837 Set_Unit (Parent (Inst_Node), Inst_Node);
10838 Build_Instance_Compilation_Unit_Nodes
10839 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10840 Analyze (Inst_Node);
10841 else
10842 Set_Parent (Pack_Body, Parent (Inst_Node));
10843 Analyze (Pack_Body);
10844 end if;
10846 else
10847 Insert_Before (Inst_Node, Pack_Body);
10848 Mark_Rewrite_Insertion (Pack_Body);
10849 Analyze (Pack_Body);
10851 if Expander_Active then
10852 Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10853 end if;
10854 end if;
10856 Inherit_Context (Gen_Body, Inst_Node);
10858 Restore_Private_Views (Pack_Id, False);
10860 if Parent_Installed then
10861 Remove_Parent (In_Body => True);
10863 -- Restore the previous visibility of the parent
10865 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10866 end if;
10868 Restore_Env;
10869 Style_Check := Saved_Style_Check;
10870 Restore_Warnings (Saved_Warnings);
10872 -- Body not found. Error was emitted already. If there were no previous
10873 -- errors, this may be an instance whose scope is a premature instance.
10874 -- In that case we must insure that the (legal) program does raise
10875 -- program error if executed. We generate a subprogram body for this
10876 -- purpose. See DEC ac30vso.
10878 -- Should not reference proprietary DEC tests in comments ???
10880 elsif Serious_Errors_Detected = 0
10881 and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
10882 then
10883 if Body_Optional then
10884 return;
10886 elsif Ekind (Anon_Id) = E_Procedure then
10887 Act_Body :=
10888 Make_Subprogram_Body (Loc,
10889 Specification =>
10890 Make_Procedure_Specification (Loc,
10891 Defining_Unit_Name =>
10892 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10893 Parameter_Specifications =>
10894 New_Copy_List
10895 (Parameter_Specifications (Parent (Anon_Id)))),
10897 Declarations => Empty_List,
10898 Handled_Statement_Sequence =>
10899 Make_Handled_Sequence_Of_Statements (Loc,
10900 Statements =>
10901 New_List (
10902 Make_Raise_Program_Error (Loc,
10903 Reason =>
10904 PE_Access_Before_Elaboration))));
10906 else
10907 Ret_Expr :=
10908 Make_Raise_Program_Error (Loc,
10909 Reason => PE_Access_Before_Elaboration);
10911 Set_Etype (Ret_Expr, (Etype (Anon_Id)));
10912 Set_Analyzed (Ret_Expr);
10914 Act_Body :=
10915 Make_Subprogram_Body (Loc,
10916 Specification =>
10917 Make_Function_Specification (Loc,
10918 Defining_Unit_Name =>
10919 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10920 Parameter_Specifications =>
10921 New_Copy_List
10922 (Parameter_Specifications (Parent (Anon_Id))),
10923 Result_Definition =>
10924 New_Occurrence_Of (Etype (Anon_Id), Loc)),
10926 Declarations => Empty_List,
10927 Handled_Statement_Sequence =>
10928 Make_Handled_Sequence_Of_Statements (Loc,
10929 Statements =>
10930 New_List
10931 (Make_Simple_Return_Statement (Loc, Ret_Expr))));
10932 end if;
10934 Pack_Body := Make_Package_Body (Loc,
10935 Defining_Unit_Name => New_Copy (Pack_Id),
10936 Declarations => New_List (Act_Body));
10938 Insert_After (Inst_Node, Pack_Body);
10939 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10940 Analyze (Pack_Body);
10941 end if;
10943 Expander_Mode_Restore;
10944 end Instantiate_Subprogram_Body;
10946 ----------------------
10947 -- Instantiate_Type --
10948 ----------------------
10950 function Instantiate_Type
10951 (Formal : Node_Id;
10952 Actual : Node_Id;
10953 Analyzed_Formal : Node_Id;
10954 Actual_Decls : List_Id) return List_Id
10956 Gen_T : constant Entity_Id := Defining_Identifier (Formal);
10957 A_Gen_T : constant Entity_Id :=
10958 Defining_Identifier (Analyzed_Formal);
10959 Ancestor : Entity_Id := Empty;
10960 Def : constant Node_Id := Formal_Type_Definition (Formal);
10961 Act_T : Entity_Id;
10962 Decl_Node : Node_Id;
10963 Decl_Nodes : List_Id;
10964 Loc : Source_Ptr;
10965 Subt : Entity_Id;
10967 procedure Diagnose_Predicated_Actual;
10968 -- There are a number of constructs in which a discrete type with
10969 -- predicates is illegal, e.g. as an index in an array type declaration.
10970 -- If a generic type is used is such a construct in a generic package
10971 -- declaration, it carries the flag No_Predicate_On_Actual. it is part
10972 -- of the generic contract that the actual cannot have predicates.
10974 procedure Validate_Array_Type_Instance;
10975 procedure Validate_Access_Subprogram_Instance;
10976 procedure Validate_Access_Type_Instance;
10977 procedure Validate_Derived_Type_Instance;
10978 procedure Validate_Derived_Interface_Type_Instance;
10979 procedure Validate_Discriminated_Formal_Type;
10980 procedure Validate_Interface_Type_Instance;
10981 procedure Validate_Private_Type_Instance;
10982 procedure Validate_Incomplete_Type_Instance;
10983 -- These procedures perform validation tests for the named case.
10984 -- Validate_Discriminated_Formal_Type is shared by formal private
10985 -- types and Ada 2012 formal incomplete types.
10987 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
10988 -- Check that base types are the same and that the subtypes match
10989 -- statically. Used in several of the above.
10991 ---------------------------------
10992 -- Diagnose_Predicated_Actual --
10993 ---------------------------------
10995 procedure Diagnose_Predicated_Actual is
10996 begin
10997 if No_Predicate_On_Actual (A_Gen_T)
10998 and then Has_Predicates (Act_T)
10999 then
11000 Error_Msg_NE
11001 ("actual for& cannot be a type with predicate",
11002 Instantiation_Node, A_Gen_T);
11004 elsif No_Dynamic_Predicate_On_Actual (A_Gen_T)
11005 and then Has_Predicates (Act_T)
11006 and then not Has_Static_Predicate_Aspect (Act_T)
11007 then
11008 Error_Msg_NE
11009 ("actual for& cannot be a type with a dynamic predicate",
11010 Instantiation_Node, A_Gen_T);
11011 end if;
11012 end Diagnose_Predicated_Actual;
11014 --------------------
11015 -- Subtypes_Match --
11016 --------------------
11018 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
11019 T : constant Entity_Id := Get_Instance_Of (Gen_T);
11021 begin
11022 -- Some detailed comments would be useful here ???
11024 return ((Base_Type (T) = Act_T
11025 or else Base_Type (T) = Base_Type (Act_T))
11026 and then Subtypes_Statically_Match (T, Act_T))
11028 or else (Is_Class_Wide_Type (Gen_T)
11029 and then Is_Class_Wide_Type (Act_T)
11030 and then Subtypes_Match
11031 (Get_Instance_Of (Root_Type (Gen_T)),
11032 Root_Type (Act_T)))
11034 or else
11035 (Ekind_In (Gen_T, E_Anonymous_Access_Subprogram_Type,
11036 E_Anonymous_Access_Type)
11037 and then Ekind (Act_T) = Ekind (Gen_T)
11038 and then Subtypes_Statically_Match
11039 (Designated_Type (Gen_T), Designated_Type (Act_T)));
11040 end Subtypes_Match;
11042 -----------------------------------------
11043 -- Validate_Access_Subprogram_Instance --
11044 -----------------------------------------
11046 procedure Validate_Access_Subprogram_Instance is
11047 begin
11048 if not Is_Access_Type (Act_T)
11049 or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
11050 then
11051 Error_Msg_NE
11052 ("expect access type in instantiation of &", Actual, Gen_T);
11053 Abandon_Instantiation (Actual);
11054 end if;
11056 -- According to AI05-288, actuals for access_to_subprograms must be
11057 -- subtype conformant with the generic formal. Previous to AI05-288
11058 -- only mode conformance was required.
11060 -- This is a binding interpretation that applies to previous versions
11061 -- of the language, no need to maintain previous weaker checks.
11063 Check_Subtype_Conformant
11064 (Designated_Type (Act_T),
11065 Designated_Type (A_Gen_T),
11066 Actual,
11067 Get_Inst => True);
11069 if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
11070 if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
11071 Error_Msg_NE
11072 ("protected access type not allowed for formal &",
11073 Actual, Gen_T);
11074 end if;
11076 elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
11077 Error_Msg_NE
11078 ("expect protected access type for formal &",
11079 Actual, Gen_T);
11080 end if;
11081 end Validate_Access_Subprogram_Instance;
11083 -----------------------------------
11084 -- Validate_Access_Type_Instance --
11085 -----------------------------------
11087 procedure Validate_Access_Type_Instance is
11088 Desig_Type : constant Entity_Id :=
11089 Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
11090 Desig_Act : Entity_Id;
11092 begin
11093 if not Is_Access_Type (Act_T) then
11094 Error_Msg_NE
11095 ("expect access type in instantiation of &", Actual, Gen_T);
11096 Abandon_Instantiation (Actual);
11097 end if;
11099 if Is_Access_Constant (A_Gen_T) then
11100 if not Is_Access_Constant (Act_T) then
11101 Error_Msg_N
11102 ("actual type must be access-to-constant type", Actual);
11103 Abandon_Instantiation (Actual);
11104 end if;
11105 else
11106 if Is_Access_Constant (Act_T) then
11107 Error_Msg_N
11108 ("actual type must be access-to-variable type", Actual);
11109 Abandon_Instantiation (Actual);
11111 elsif Ekind (A_Gen_T) = E_General_Access_Type
11112 and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
11113 then
11114 Error_Msg_N -- CODEFIX
11115 ("actual must be general access type!", Actual);
11116 Error_Msg_NE -- CODEFIX
11117 ("add ALL to }!", Actual, Act_T);
11118 Abandon_Instantiation (Actual);
11119 end if;
11120 end if;
11122 -- The designated subtypes, that is to say the subtypes introduced
11123 -- by an access type declaration (and not by a subtype declaration)
11124 -- must match.
11126 Desig_Act := Designated_Type (Base_Type (Act_T));
11128 -- The designated type may have been introduced through a limited_
11129 -- with clause, in which case retrieve the non-limited view. This
11130 -- applies to incomplete types as well as to class-wide types.
11132 if From_Limited_With (Desig_Act) then
11133 Desig_Act := Available_View (Desig_Act);
11134 end if;
11136 if not Subtypes_Match (Desig_Type, Desig_Act) then
11137 Error_Msg_NE
11138 ("designated type of actual does not match that of formal &",
11139 Actual, Gen_T);
11141 if not Predicates_Match (Desig_Type, Desig_Act) then
11142 Error_Msg_N ("\predicates do not match", Actual);
11143 end if;
11145 Abandon_Instantiation (Actual);
11147 elsif Is_Access_Type (Designated_Type (Act_T))
11148 and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
11150 Is_Constrained (Designated_Type (Desig_Type))
11151 then
11152 Error_Msg_NE
11153 ("designated type of actual does not match that of formal &",
11154 Actual, Gen_T);
11156 if not Predicates_Match (Desig_Type, Desig_Act) then
11157 Error_Msg_N ("\predicates do not match", Actual);
11158 end if;
11160 Abandon_Instantiation (Actual);
11161 end if;
11163 -- Ada 2005: null-exclusion indicators of the two types must agree
11165 if Can_Never_Be_Null (A_Gen_T) /= Can_Never_Be_Null (Act_T) then
11166 Error_Msg_NE
11167 ("non null exclusion of actual and formal & do not match",
11168 Actual, Gen_T);
11169 end if;
11170 end Validate_Access_Type_Instance;
11172 ----------------------------------
11173 -- Validate_Array_Type_Instance --
11174 ----------------------------------
11176 procedure Validate_Array_Type_Instance is
11177 I1 : Node_Id;
11178 I2 : Node_Id;
11179 T2 : Entity_Id;
11181 function Formal_Dimensions return Int;
11182 -- Count number of dimensions in array type formal
11184 -----------------------
11185 -- Formal_Dimensions --
11186 -----------------------
11188 function Formal_Dimensions return Int is
11189 Num : Int := 0;
11190 Index : Node_Id;
11192 begin
11193 if Nkind (Def) = N_Constrained_Array_Definition then
11194 Index := First (Discrete_Subtype_Definitions (Def));
11195 else
11196 Index := First (Subtype_Marks (Def));
11197 end if;
11199 while Present (Index) loop
11200 Num := Num + 1;
11201 Next_Index (Index);
11202 end loop;
11204 return Num;
11205 end Formal_Dimensions;
11207 -- Start of processing for Validate_Array_Type_Instance
11209 begin
11210 if not Is_Array_Type (Act_T) then
11211 Error_Msg_NE
11212 ("expect array type in instantiation of &", Actual, Gen_T);
11213 Abandon_Instantiation (Actual);
11215 elsif Nkind (Def) = N_Constrained_Array_Definition then
11216 if not (Is_Constrained (Act_T)) then
11217 Error_Msg_NE
11218 ("expect constrained array in instantiation of &",
11219 Actual, Gen_T);
11220 Abandon_Instantiation (Actual);
11221 end if;
11223 else
11224 if Is_Constrained (Act_T) then
11225 Error_Msg_NE
11226 ("expect unconstrained array in instantiation of &",
11227 Actual, Gen_T);
11228 Abandon_Instantiation (Actual);
11229 end if;
11230 end if;
11232 if Formal_Dimensions /= Number_Dimensions (Act_T) then
11233 Error_Msg_NE
11234 ("dimensions of actual do not match formal &", Actual, Gen_T);
11235 Abandon_Instantiation (Actual);
11236 end if;
11238 I1 := First_Index (A_Gen_T);
11239 I2 := First_Index (Act_T);
11240 for J in 1 .. Formal_Dimensions loop
11242 -- If the indexes of the actual were given by a subtype_mark,
11243 -- the index was transformed into a range attribute. Retrieve
11244 -- the original type mark for checking.
11246 if Is_Entity_Name (Original_Node (I2)) then
11247 T2 := Entity (Original_Node (I2));
11248 else
11249 T2 := Etype (I2);
11250 end if;
11252 if not Subtypes_Match
11253 (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
11254 then
11255 Error_Msg_NE
11256 ("index types of actual do not match those of formal &",
11257 Actual, Gen_T);
11258 Abandon_Instantiation (Actual);
11259 end if;
11261 Next_Index (I1);
11262 Next_Index (I2);
11263 end loop;
11265 -- Check matching subtypes. Note that there are complex visibility
11266 -- issues when the generic is a child unit and some aspect of the
11267 -- generic type is declared in a parent unit of the generic. We do
11268 -- the test to handle this special case only after a direct check
11269 -- for static matching has failed. The case where both the component
11270 -- type and the array type are separate formals, and the component
11271 -- type is a private view may also require special checking in
11272 -- Subtypes_Match.
11274 if Subtypes_Match
11275 (Component_Type (A_Gen_T), Component_Type (Act_T))
11276 or else
11277 Subtypes_Match
11278 (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
11279 Component_Type (Act_T))
11280 then
11281 null;
11282 else
11283 Error_Msg_NE
11284 ("component subtype of actual does not match that of formal &",
11285 Actual, Gen_T);
11286 Abandon_Instantiation (Actual);
11287 end if;
11289 if Has_Aliased_Components (A_Gen_T)
11290 and then not Has_Aliased_Components (Act_T)
11291 then
11292 Error_Msg_NE
11293 ("actual must have aliased components to match formal type &",
11294 Actual, Gen_T);
11295 end if;
11296 end Validate_Array_Type_Instance;
11298 -----------------------------------------------
11299 -- Validate_Derived_Interface_Type_Instance --
11300 -----------------------------------------------
11302 procedure Validate_Derived_Interface_Type_Instance is
11303 Par : constant Entity_Id := Entity (Subtype_Indication (Def));
11304 Elmt : Elmt_Id;
11306 begin
11307 -- First apply interface instance checks
11309 Validate_Interface_Type_Instance;
11311 -- Verify that immediate parent interface is an ancestor of
11312 -- the actual.
11314 if Present (Par)
11315 and then not Interface_Present_In_Ancestor (Act_T, Par)
11316 then
11317 Error_Msg_NE
11318 ("interface actual must include progenitor&", Actual, Par);
11319 end if;
11321 -- Now verify that the actual includes all other ancestors of
11322 -- the formal.
11324 Elmt := First_Elmt (Interfaces (A_Gen_T));
11325 while Present (Elmt) loop
11326 if not Interface_Present_In_Ancestor
11327 (Act_T, Get_Instance_Of (Node (Elmt)))
11328 then
11329 Error_Msg_NE
11330 ("interface actual must include progenitor&",
11331 Actual, Node (Elmt));
11332 end if;
11334 Next_Elmt (Elmt);
11335 end loop;
11336 end Validate_Derived_Interface_Type_Instance;
11338 ------------------------------------
11339 -- Validate_Derived_Type_Instance --
11340 ------------------------------------
11342 procedure Validate_Derived_Type_Instance is
11343 Actual_Discr : Entity_Id;
11344 Ancestor_Discr : Entity_Id;
11346 begin
11347 -- If the parent type in the generic declaration is itself a previous
11348 -- formal type, then it is local to the generic and absent from the
11349 -- analyzed generic definition. In that case the ancestor is the
11350 -- instance of the formal (which must have been instantiated
11351 -- previously), unless the ancestor is itself a formal derived type.
11352 -- In this latter case (which is the subject of Corrigendum 8652/0038
11353 -- (AI-202) the ancestor of the formals is the ancestor of its
11354 -- parent. Otherwise, the analyzed generic carries the parent type.
11355 -- If the parent type is defined in a previous formal package, then
11356 -- the scope of that formal package is that of the generic type
11357 -- itself, and it has already been mapped into the corresponding type
11358 -- in the actual package.
11360 -- Common case: parent type defined outside of the generic
11362 if Is_Entity_Name (Subtype_Mark (Def))
11363 and then Present (Entity (Subtype_Mark (Def)))
11364 then
11365 Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
11367 -- Check whether parent is defined in a previous formal package
11369 elsif
11370 Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
11371 then
11372 Ancestor :=
11373 Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
11375 -- The type may be a local derivation, or a type extension of a
11376 -- previous formal, or of a formal of a parent package.
11378 elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
11379 or else
11380 Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
11381 then
11382 -- Check whether the parent is another derived formal type in the
11383 -- same generic unit.
11385 if Etype (A_Gen_T) /= A_Gen_T
11386 and then Is_Generic_Type (Etype (A_Gen_T))
11387 and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
11388 and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
11389 then
11390 -- Locate ancestor of parent from the subtype declaration
11391 -- created for the actual.
11393 declare
11394 Decl : Node_Id;
11396 begin
11397 Decl := First (Actual_Decls);
11398 while Present (Decl) loop
11399 if Nkind (Decl) = N_Subtype_Declaration
11400 and then Chars (Defining_Identifier (Decl)) =
11401 Chars (Etype (A_Gen_T))
11402 then
11403 Ancestor := Generic_Parent_Type (Decl);
11404 exit;
11405 else
11406 Next (Decl);
11407 end if;
11408 end loop;
11409 end;
11411 pragma Assert (Present (Ancestor));
11413 -- The ancestor itself may be a previous formal that has been
11414 -- instantiated.
11416 Ancestor := Get_Instance_Of (Ancestor);
11418 else
11419 Ancestor :=
11420 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
11421 end if;
11423 -- An unusual case: the actual is a type declared in a parent unit,
11424 -- but is not a formal type so there is no instance_of for it.
11425 -- Retrieve it by analyzing the record extension.
11427 elsif Is_Child_Unit (Scope (A_Gen_T))
11428 and then In_Open_Scopes (Scope (Act_T))
11429 and then Is_Generic_Instance (Scope (Act_T))
11430 then
11431 Analyze (Subtype_Mark (Def));
11432 Ancestor := Entity (Subtype_Mark (Def));
11434 else
11435 Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
11436 end if;
11438 -- If the formal derived type has pragma Preelaborable_Initialization
11439 -- then the actual type must have preelaborable initialization.
11441 if Known_To_Have_Preelab_Init (A_Gen_T)
11442 and then not Has_Preelaborable_Initialization (Act_T)
11443 then
11444 Error_Msg_NE
11445 ("actual for & must have preelaborable initialization",
11446 Actual, Gen_T);
11447 end if;
11449 -- Ada 2005 (AI-251)
11451 if Ada_Version >= Ada_2005 and then Is_Interface (Ancestor) then
11452 if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
11453 Error_Msg_NE
11454 ("(Ada 2005) expected type implementing & in instantiation",
11455 Actual, Ancestor);
11456 end if;
11458 elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
11459 Error_Msg_NE
11460 ("expect type derived from & in instantiation",
11461 Actual, First_Subtype (Ancestor));
11462 Abandon_Instantiation (Actual);
11463 end if;
11465 -- Ada 2005 (AI-443): Synchronized formal derived type checks. Note
11466 -- that the formal type declaration has been rewritten as a private
11467 -- extension.
11469 if Ada_Version >= Ada_2005
11470 and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
11471 and then Synchronized_Present (Parent (A_Gen_T))
11472 then
11473 -- The actual must be a synchronized tagged type
11475 if not Is_Tagged_Type (Act_T) then
11476 Error_Msg_N
11477 ("actual of synchronized type must be tagged", Actual);
11478 Abandon_Instantiation (Actual);
11480 elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
11481 and then Nkind (Type_Definition (Parent (Act_T))) =
11482 N_Derived_Type_Definition
11483 and then not Synchronized_Present (Type_Definition
11484 (Parent (Act_T)))
11485 then
11486 Error_Msg_N
11487 ("actual of synchronized type must be synchronized", Actual);
11488 Abandon_Instantiation (Actual);
11489 end if;
11490 end if;
11492 -- Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
11493 -- removes the second instance of the phrase "or allow pass by copy".
11495 if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
11496 Error_Msg_N
11497 ("cannot have atomic actual type for non-atomic formal type",
11498 Actual);
11500 elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
11501 Error_Msg_N
11502 ("cannot have volatile actual type for non-volatile formal type",
11503 Actual);
11504 end if;
11506 -- It should not be necessary to check for unknown discriminants on
11507 -- Formal, but for some reason Has_Unknown_Discriminants is false for
11508 -- A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
11509 -- needs fixing. ???
11511 if not Is_Indefinite_Subtype (A_Gen_T)
11512 and then not Unknown_Discriminants_Present (Formal)
11513 and then Is_Indefinite_Subtype (Act_T)
11514 then
11515 Error_Msg_N
11516 ("actual subtype must be constrained", Actual);
11517 Abandon_Instantiation (Actual);
11518 end if;
11520 if not Unknown_Discriminants_Present (Formal) then
11521 if Is_Constrained (Ancestor) then
11522 if not Is_Constrained (Act_T) then
11523 Error_Msg_N
11524 ("actual subtype must be constrained", Actual);
11525 Abandon_Instantiation (Actual);
11526 end if;
11528 -- Ancestor is unconstrained, Check if generic formal and actual
11529 -- agree on constrainedness. The check only applies to array types
11530 -- and discriminated types.
11532 elsif Is_Constrained (Act_T) then
11533 if Ekind (Ancestor) = E_Access_Type
11534 or else (not Is_Constrained (A_Gen_T)
11535 and then Is_Composite_Type (A_Gen_T))
11536 then
11537 Error_Msg_N ("actual subtype must be unconstrained", Actual);
11538 Abandon_Instantiation (Actual);
11539 end if;
11541 -- A class-wide type is only allowed if the formal has unknown
11542 -- discriminants.
11544 elsif Is_Class_Wide_Type (Act_T)
11545 and then not Has_Unknown_Discriminants (Ancestor)
11546 then
11547 Error_Msg_NE
11548 ("actual for & cannot be a class-wide type", Actual, Gen_T);
11549 Abandon_Instantiation (Actual);
11551 -- Otherwise, the formal and actual must have the same number
11552 -- of discriminants and each discriminant of the actual must
11553 -- correspond to a discriminant of the formal.
11555 elsif Has_Discriminants (Act_T)
11556 and then not Has_Unknown_Discriminants (Act_T)
11557 and then Has_Discriminants (Ancestor)
11558 then
11559 Actual_Discr := First_Discriminant (Act_T);
11560 Ancestor_Discr := First_Discriminant (Ancestor);
11561 while Present (Actual_Discr)
11562 and then Present (Ancestor_Discr)
11563 loop
11564 if Base_Type (Act_T) /= Base_Type (Ancestor) and then
11565 No (Corresponding_Discriminant (Actual_Discr))
11566 then
11567 Error_Msg_NE
11568 ("discriminant & does not correspond " &
11569 "to ancestor discriminant", Actual, Actual_Discr);
11570 Abandon_Instantiation (Actual);
11571 end if;
11573 Next_Discriminant (Actual_Discr);
11574 Next_Discriminant (Ancestor_Discr);
11575 end loop;
11577 if Present (Actual_Discr) or else Present (Ancestor_Discr) then
11578 Error_Msg_NE
11579 ("actual for & must have same number of discriminants",
11580 Actual, Gen_T);
11581 Abandon_Instantiation (Actual);
11582 end if;
11584 -- This case should be caught by the earlier check for
11585 -- constrainedness, but the check here is added for completeness.
11587 elsif Has_Discriminants (Act_T)
11588 and then not Has_Unknown_Discriminants (Act_T)
11589 then
11590 Error_Msg_NE
11591 ("actual for & must not have discriminants", Actual, Gen_T);
11592 Abandon_Instantiation (Actual);
11594 elsif Has_Discriminants (Ancestor) then
11595 Error_Msg_NE
11596 ("actual for & must have known discriminants", Actual, Gen_T);
11597 Abandon_Instantiation (Actual);
11598 end if;
11600 if not Subtypes_Statically_Compatible
11601 (Act_T, Ancestor, Formal_Derived_Matching => True)
11602 then
11603 Error_Msg_N
11604 ("constraint on actual is incompatible with formal", Actual);
11605 Abandon_Instantiation (Actual);
11606 end if;
11607 end if;
11609 -- If the formal and actual types are abstract, check that there
11610 -- are no abstract primitives of the actual type that correspond to
11611 -- nonabstract primitives of the formal type (second sentence of
11612 -- RM95-3.9.3(9)).
11614 if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
11615 Check_Abstract_Primitives : declare
11616 Gen_Prims : constant Elist_Id :=
11617 Primitive_Operations (A_Gen_T);
11618 Gen_Elmt : Elmt_Id;
11619 Gen_Subp : Entity_Id;
11620 Anc_Subp : Entity_Id;
11621 Anc_Formal : Entity_Id;
11622 Anc_F_Type : Entity_Id;
11624 Act_Prims : constant Elist_Id := Primitive_Operations (Act_T);
11625 Act_Elmt : Elmt_Id;
11626 Act_Subp : Entity_Id;
11627 Act_Formal : Entity_Id;
11628 Act_F_Type : Entity_Id;
11630 Subprograms_Correspond : Boolean;
11632 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
11633 -- Returns true if T2 is derived directly or indirectly from
11634 -- T1, including derivations from interfaces. T1 and T2 are
11635 -- required to be specific tagged base types.
11637 ------------------------
11638 -- Is_Tagged_Ancestor --
11639 ------------------------
11641 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
11643 Intfc_Elmt : Elmt_Id;
11645 begin
11646 -- The predicate is satisfied if the types are the same
11648 if T1 = T2 then
11649 return True;
11651 -- If we've reached the top of the derivation chain then
11652 -- we know that T1 is not an ancestor of T2.
11654 elsif Etype (T2) = T2 then
11655 return False;
11657 -- Proceed to check T2's immediate parent
11659 elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
11660 return True;
11662 -- Finally, check to see if T1 is an ancestor of any of T2's
11663 -- progenitors.
11665 else
11666 Intfc_Elmt := First_Elmt (Interfaces (T2));
11667 while Present (Intfc_Elmt) loop
11668 if Is_Ancestor (T1, Node (Intfc_Elmt)) then
11669 return True;
11670 end if;
11672 Next_Elmt (Intfc_Elmt);
11673 end loop;
11674 end if;
11676 return False;
11677 end Is_Tagged_Ancestor;
11679 -- Start of processing for Check_Abstract_Primitives
11681 begin
11682 -- Loop over all of the formal derived type's primitives
11684 Gen_Elmt := First_Elmt (Gen_Prims);
11685 while Present (Gen_Elmt) loop
11686 Gen_Subp := Node (Gen_Elmt);
11688 -- If the primitive of the formal is not abstract, then
11689 -- determine whether there is a corresponding primitive of
11690 -- the actual type that's abstract.
11692 if not Is_Abstract_Subprogram (Gen_Subp) then
11693 Act_Elmt := First_Elmt (Act_Prims);
11694 while Present (Act_Elmt) loop
11695 Act_Subp := Node (Act_Elmt);
11697 -- If we find an abstract primitive of the actual,
11698 -- then we need to test whether it corresponds to the
11699 -- subprogram from which the generic formal primitive
11700 -- is inherited.
11702 if Is_Abstract_Subprogram (Act_Subp) then
11703 Anc_Subp := Alias (Gen_Subp);
11705 -- Test whether we have a corresponding primitive
11706 -- by comparing names, kinds, formal types, and
11707 -- result types.
11709 if Chars (Anc_Subp) = Chars (Act_Subp)
11710 and then Ekind (Anc_Subp) = Ekind (Act_Subp)
11711 then
11712 Anc_Formal := First_Formal (Anc_Subp);
11713 Act_Formal := First_Formal (Act_Subp);
11714 while Present (Anc_Formal)
11715 and then Present (Act_Formal)
11716 loop
11717 Anc_F_Type := Etype (Anc_Formal);
11718 Act_F_Type := Etype (Act_Formal);
11720 if Ekind (Anc_F_Type)
11721 = E_Anonymous_Access_Type
11722 then
11723 Anc_F_Type := Designated_Type (Anc_F_Type);
11725 if Ekind (Act_F_Type)
11726 = E_Anonymous_Access_Type
11727 then
11728 Act_F_Type :=
11729 Designated_Type (Act_F_Type);
11730 else
11731 exit;
11732 end if;
11734 elsif
11735 Ekind (Act_F_Type) = E_Anonymous_Access_Type
11736 then
11737 exit;
11738 end if;
11740 Anc_F_Type := Base_Type (Anc_F_Type);
11741 Act_F_Type := Base_Type (Act_F_Type);
11743 -- If the formal is controlling, then the
11744 -- the type of the actual primitive's formal
11745 -- must be derived directly or indirectly
11746 -- from the type of the ancestor primitive's
11747 -- formal.
11749 if Is_Controlling_Formal (Anc_Formal) then
11750 if not Is_Tagged_Ancestor
11751 (Anc_F_Type, Act_F_Type)
11752 then
11753 exit;
11754 end if;
11756 -- Otherwise the types of the formals must
11757 -- be the same.
11759 elsif Anc_F_Type /= Act_F_Type then
11760 exit;
11761 end if;
11763 Next_Entity (Anc_Formal);
11764 Next_Entity (Act_Formal);
11765 end loop;
11767 -- If we traversed through all of the formals
11768 -- then so far the subprograms correspond, so
11769 -- now check that any result types correspond.
11771 if No (Anc_Formal) and then No (Act_Formal) then
11772 Subprograms_Correspond := True;
11774 if Ekind (Act_Subp) = E_Function then
11775 Anc_F_Type := Etype (Anc_Subp);
11776 Act_F_Type := Etype (Act_Subp);
11778 if Ekind (Anc_F_Type)
11779 = E_Anonymous_Access_Type
11780 then
11781 Anc_F_Type :=
11782 Designated_Type (Anc_F_Type);
11784 if Ekind (Act_F_Type)
11785 = E_Anonymous_Access_Type
11786 then
11787 Act_F_Type :=
11788 Designated_Type (Act_F_Type);
11789 else
11790 Subprograms_Correspond := False;
11791 end if;
11793 elsif
11794 Ekind (Act_F_Type)
11795 = E_Anonymous_Access_Type
11796 then
11797 Subprograms_Correspond := False;
11798 end if;
11800 Anc_F_Type := Base_Type (Anc_F_Type);
11801 Act_F_Type := Base_Type (Act_F_Type);
11803 -- Now either the result types must be
11804 -- the same or, if the result type is
11805 -- controlling, the result type of the
11806 -- actual primitive must descend from the
11807 -- result type of the ancestor primitive.
11809 if Subprograms_Correspond
11810 and then Anc_F_Type /= Act_F_Type
11811 and then
11812 Has_Controlling_Result (Anc_Subp)
11813 and then
11814 not Is_Tagged_Ancestor
11815 (Anc_F_Type, Act_F_Type)
11816 then
11817 Subprograms_Correspond := False;
11818 end if;
11819 end if;
11821 -- Found a matching subprogram belonging to
11822 -- formal ancestor type, so actual subprogram
11823 -- corresponds and this violates 3.9.3(9).
11825 if Subprograms_Correspond then
11826 Error_Msg_NE
11827 ("abstract subprogram & overrides " &
11828 "nonabstract subprogram of ancestor",
11829 Actual,
11830 Act_Subp);
11831 end if;
11832 end if;
11833 end if;
11834 end if;
11836 Next_Elmt (Act_Elmt);
11837 end loop;
11838 end if;
11840 Next_Elmt (Gen_Elmt);
11841 end loop;
11842 end Check_Abstract_Primitives;
11843 end if;
11845 -- Verify that limitedness matches. If parent is a limited
11846 -- interface then the generic formal is not unless declared
11847 -- explicitly so. If not declared limited, the actual cannot be
11848 -- limited (see AI05-0087).
11850 -- Even though this AI is a binding interpretation, we enable the
11851 -- check only in Ada 2012 mode, because this improper construct
11852 -- shows up in user code and in existing B-tests.
11854 if Is_Limited_Type (Act_T)
11855 and then not Is_Limited_Type (A_Gen_T)
11856 and then Ada_Version >= Ada_2012
11857 then
11858 if In_Instance then
11859 null;
11860 else
11861 Error_Msg_NE
11862 ("actual for non-limited & cannot be a limited type", Actual,
11863 Gen_T);
11864 Explain_Limited_Type (Act_T, Actual);
11865 Abandon_Instantiation (Actual);
11866 end if;
11867 end if;
11868 end Validate_Derived_Type_Instance;
11870 ----------------------------------------
11871 -- Validate_Discriminated_Formal_Type --
11872 ----------------------------------------
11874 procedure Validate_Discriminated_Formal_Type is
11875 Formal_Discr : Entity_Id;
11876 Actual_Discr : Entity_Id;
11877 Formal_Subt : Entity_Id;
11879 begin
11880 if Has_Discriminants (A_Gen_T) then
11881 if not Has_Discriminants (Act_T) then
11882 Error_Msg_NE
11883 ("actual for & must have discriminants", Actual, Gen_T);
11884 Abandon_Instantiation (Actual);
11886 elsif Is_Constrained (Act_T) then
11887 Error_Msg_NE
11888 ("actual for & must be unconstrained", Actual, Gen_T);
11889 Abandon_Instantiation (Actual);
11891 else
11892 Formal_Discr := First_Discriminant (A_Gen_T);
11893 Actual_Discr := First_Discriminant (Act_T);
11894 while Formal_Discr /= Empty loop
11895 if Actual_Discr = Empty then
11896 Error_Msg_NE
11897 ("discriminants on actual do not match formal",
11898 Actual, Gen_T);
11899 Abandon_Instantiation (Actual);
11900 end if;
11902 Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
11904 -- Access discriminants match if designated types do
11906 if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
11907 and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
11908 E_Anonymous_Access_Type
11909 and then
11910 Get_Instance_Of
11911 (Designated_Type (Base_Type (Formal_Subt))) =
11912 Designated_Type (Base_Type (Etype (Actual_Discr)))
11913 then
11914 null;
11916 elsif Base_Type (Formal_Subt) /=
11917 Base_Type (Etype (Actual_Discr))
11918 then
11919 Error_Msg_NE
11920 ("types of actual discriminants must match formal",
11921 Actual, Gen_T);
11922 Abandon_Instantiation (Actual);
11924 elsif not Subtypes_Statically_Match
11925 (Formal_Subt, Etype (Actual_Discr))
11926 and then Ada_Version >= Ada_95
11927 then
11928 Error_Msg_NE
11929 ("subtypes of actual discriminants must match formal",
11930 Actual, Gen_T);
11931 Abandon_Instantiation (Actual);
11932 end if;
11934 Next_Discriminant (Formal_Discr);
11935 Next_Discriminant (Actual_Discr);
11936 end loop;
11938 if Actual_Discr /= Empty then
11939 Error_Msg_NE
11940 ("discriminants on actual do not match formal",
11941 Actual, Gen_T);
11942 Abandon_Instantiation (Actual);
11943 end if;
11944 end if;
11945 end if;
11946 end Validate_Discriminated_Formal_Type;
11948 ---------------------------------------
11949 -- Validate_Incomplete_Type_Instance --
11950 ---------------------------------------
11952 procedure Validate_Incomplete_Type_Instance is
11953 begin
11954 if not Is_Tagged_Type (Act_T)
11955 and then Is_Tagged_Type (A_Gen_T)
11956 then
11957 Error_Msg_NE
11958 ("actual for & must be a tagged type", Actual, Gen_T);
11959 end if;
11961 Validate_Discriminated_Formal_Type;
11962 end Validate_Incomplete_Type_Instance;
11964 --------------------------------------
11965 -- Validate_Interface_Type_Instance --
11966 --------------------------------------
11968 procedure Validate_Interface_Type_Instance is
11969 begin
11970 if not Is_Interface (Act_T) then
11971 Error_Msg_NE
11972 ("actual for formal interface type must be an interface",
11973 Actual, Gen_T);
11975 elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
11976 or else Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
11977 or else Is_Protected_Interface (A_Gen_T) /=
11978 Is_Protected_Interface (Act_T)
11979 or else Is_Synchronized_Interface (A_Gen_T) /=
11980 Is_Synchronized_Interface (Act_T)
11981 then
11982 Error_Msg_NE
11983 ("actual for interface& does not match (RM 12.5.5(4))",
11984 Actual, Gen_T);
11985 end if;
11986 end Validate_Interface_Type_Instance;
11988 ------------------------------------
11989 -- Validate_Private_Type_Instance --
11990 ------------------------------------
11992 procedure Validate_Private_Type_Instance is
11993 begin
11994 if Is_Limited_Type (Act_T)
11995 and then not Is_Limited_Type (A_Gen_T)
11996 then
11997 if In_Instance then
11998 null;
11999 else
12000 Error_Msg_NE
12001 ("actual for non-limited & cannot be a limited type", Actual,
12002 Gen_T);
12003 Explain_Limited_Type (Act_T, Actual);
12004 Abandon_Instantiation (Actual);
12005 end if;
12007 elsif Known_To_Have_Preelab_Init (A_Gen_T)
12008 and then not Has_Preelaborable_Initialization (Act_T)
12009 then
12010 Error_Msg_NE
12011 ("actual for & must have preelaborable initialization", Actual,
12012 Gen_T);
12014 elsif Is_Indefinite_Subtype (Act_T)
12015 and then not Is_Indefinite_Subtype (A_Gen_T)
12016 and then Ada_Version >= Ada_95
12017 then
12018 Error_Msg_NE
12019 ("actual for & must be a definite subtype", Actual, Gen_T);
12021 elsif not Is_Tagged_Type (Act_T)
12022 and then Is_Tagged_Type (A_Gen_T)
12023 then
12024 Error_Msg_NE
12025 ("actual for & must be a tagged type", Actual, Gen_T);
12026 end if;
12028 Validate_Discriminated_Formal_Type;
12029 Ancestor := Gen_T;
12030 end Validate_Private_Type_Instance;
12032 -- Start of processing for Instantiate_Type
12034 begin
12035 if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
12036 Error_Msg_N ("duplicate instantiation of generic type", Actual);
12037 return New_List (Error);
12039 elsif not Is_Entity_Name (Actual)
12040 or else not Is_Type (Entity (Actual))
12041 then
12042 Error_Msg_NE
12043 ("expect valid subtype mark to instantiate &", Actual, Gen_T);
12044 Abandon_Instantiation (Actual);
12046 else
12047 Act_T := Entity (Actual);
12049 -- Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
12050 -- as a generic actual parameter if the corresponding formal type
12051 -- does not have a known_discriminant_part, or is a formal derived
12052 -- type that is an Unchecked_Union type.
12054 if Is_Unchecked_Union (Base_Type (Act_T)) then
12055 if not Has_Discriminants (A_Gen_T)
12056 or else (Is_Derived_Type (A_Gen_T)
12057 and then Is_Unchecked_Union (A_Gen_T))
12058 then
12059 null;
12060 else
12061 Error_Msg_N ("unchecked union cannot be the actual for a "
12062 & "discriminated formal type", Act_T);
12064 end if;
12065 end if;
12067 -- Deal with fixed/floating restrictions
12069 if Is_Floating_Point_Type (Act_T) then
12070 Check_Restriction (No_Floating_Point, Actual);
12071 elsif Is_Fixed_Point_Type (Act_T) then
12072 Check_Restriction (No_Fixed_Point, Actual);
12073 end if;
12075 -- Deal with error of using incomplete type as generic actual.
12076 -- This includes limited views of a type, even if the non-limited
12077 -- view may be available.
12079 if Ekind (Act_T) = E_Incomplete_Type
12080 or else (Is_Class_Wide_Type (Act_T)
12081 and then Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
12082 then
12083 -- If the formal is an incomplete type, the actual can be
12084 -- incomplete as well.
12086 if Ekind (A_Gen_T) = E_Incomplete_Type then
12087 null;
12089 elsif Is_Class_Wide_Type (Act_T)
12090 or else No (Full_View (Act_T))
12091 then
12092 Error_Msg_N ("premature use of incomplete type", Actual);
12093 Abandon_Instantiation (Actual);
12094 else
12095 Act_T := Full_View (Act_T);
12096 Set_Entity (Actual, Act_T);
12098 if Has_Private_Component (Act_T) then
12099 Error_Msg_N
12100 ("premature use of type with private component", Actual);
12101 end if;
12102 end if;
12104 -- Deal with error of premature use of private type as generic actual
12106 elsif Is_Private_Type (Act_T)
12107 and then Is_Private_Type (Base_Type (Act_T))
12108 and then not Is_Generic_Type (Act_T)
12109 and then not Is_Derived_Type (Act_T)
12110 and then No (Full_View (Root_Type (Act_T)))
12111 then
12112 -- If the formal is an incomplete type, the actual can be
12113 -- private or incomplete as well.
12115 if Ekind (A_Gen_T) = E_Incomplete_Type then
12116 null;
12117 else
12118 Error_Msg_N ("premature use of private type", Actual);
12119 end if;
12121 elsif Has_Private_Component (Act_T) then
12122 Error_Msg_N
12123 ("premature use of type with private component", Actual);
12124 end if;
12126 Set_Instance_Of (A_Gen_T, Act_T);
12128 -- If the type is generic, the class-wide type may also be used
12130 if Is_Tagged_Type (A_Gen_T)
12131 and then Is_Tagged_Type (Act_T)
12132 and then not Is_Class_Wide_Type (A_Gen_T)
12133 then
12134 Set_Instance_Of (Class_Wide_Type (A_Gen_T),
12135 Class_Wide_Type (Act_T));
12136 end if;
12138 if not Is_Abstract_Type (A_Gen_T)
12139 and then Is_Abstract_Type (Act_T)
12140 then
12141 Error_Msg_N
12142 ("actual of non-abstract formal cannot be abstract", Actual);
12143 end if;
12145 -- A generic scalar type is a first subtype for which we generate
12146 -- an anonymous base type. Indicate that the instance of this base
12147 -- is the base type of the actual.
12149 if Is_Scalar_Type (A_Gen_T) then
12150 Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
12151 end if;
12152 end if;
12154 if Error_Posted (Act_T) then
12155 null;
12156 else
12157 case Nkind (Def) is
12158 when N_Formal_Private_Type_Definition =>
12159 Validate_Private_Type_Instance;
12161 when N_Formal_Incomplete_Type_Definition =>
12162 Validate_Incomplete_Type_Instance;
12164 when N_Formal_Derived_Type_Definition =>
12165 Validate_Derived_Type_Instance;
12167 when N_Formal_Discrete_Type_Definition =>
12168 if not Is_Discrete_Type (Act_T) then
12169 Error_Msg_NE
12170 ("expect discrete type in instantiation of&",
12171 Actual, Gen_T);
12172 Abandon_Instantiation (Actual);
12173 end if;
12175 Diagnose_Predicated_Actual;
12177 when N_Formal_Signed_Integer_Type_Definition =>
12178 if not Is_Signed_Integer_Type (Act_T) then
12179 Error_Msg_NE
12180 ("expect signed integer type in instantiation of&",
12181 Actual, Gen_T);
12182 Abandon_Instantiation (Actual);
12183 end if;
12185 Diagnose_Predicated_Actual;
12187 when N_Formal_Modular_Type_Definition =>
12188 if not Is_Modular_Integer_Type (Act_T) then
12189 Error_Msg_NE
12190 ("expect modular type in instantiation of &",
12191 Actual, Gen_T);
12192 Abandon_Instantiation (Actual);
12193 end if;
12195 Diagnose_Predicated_Actual;
12197 when N_Formal_Floating_Point_Definition =>
12198 if not Is_Floating_Point_Type (Act_T) then
12199 Error_Msg_NE
12200 ("expect float type in instantiation of &", Actual, Gen_T);
12201 Abandon_Instantiation (Actual);
12202 end if;
12204 when N_Formal_Ordinary_Fixed_Point_Definition =>
12205 if not Is_Ordinary_Fixed_Point_Type (Act_T) then
12206 Error_Msg_NE
12207 ("expect ordinary fixed point type in instantiation of &",
12208 Actual, Gen_T);
12209 Abandon_Instantiation (Actual);
12210 end if;
12212 when N_Formal_Decimal_Fixed_Point_Definition =>
12213 if not Is_Decimal_Fixed_Point_Type (Act_T) then
12214 Error_Msg_NE
12215 ("expect decimal type in instantiation of &",
12216 Actual, Gen_T);
12217 Abandon_Instantiation (Actual);
12218 end if;
12220 when N_Array_Type_Definition =>
12221 Validate_Array_Type_Instance;
12223 when N_Access_To_Object_Definition =>
12224 Validate_Access_Type_Instance;
12226 when N_Access_Function_Definition |
12227 N_Access_Procedure_Definition =>
12228 Validate_Access_Subprogram_Instance;
12230 when N_Record_Definition =>
12231 Validate_Interface_Type_Instance;
12233 when N_Derived_Type_Definition =>
12234 Validate_Derived_Interface_Type_Instance;
12236 when others =>
12237 raise Program_Error;
12239 end case;
12240 end if;
12242 Subt := New_Copy (Gen_T);
12244 -- Use adjusted sloc of subtype name as the location for other nodes in
12245 -- the subtype declaration.
12247 Loc := Sloc (Subt);
12249 Decl_Node :=
12250 Make_Subtype_Declaration (Loc,
12251 Defining_Identifier => Subt,
12252 Subtype_Indication => New_Occurrence_Of (Act_T, Loc));
12254 if Is_Private_Type (Act_T) then
12255 Set_Has_Private_View (Subtype_Indication (Decl_Node));
12257 elsif Is_Access_Type (Act_T)
12258 and then Is_Private_Type (Designated_Type (Act_T))
12259 then
12260 Set_Has_Private_View (Subtype_Indication (Decl_Node));
12261 end if;
12263 Decl_Nodes := New_List (Decl_Node);
12265 -- Flag actual derived types so their elaboration produces the
12266 -- appropriate renamings for the primitive operations of the ancestor.
12267 -- Flag actual for formal private types as well, to determine whether
12268 -- operations in the private part may override inherited operations.
12269 -- If the formal has an interface list, the ancestor is not the
12270 -- parent, but the analyzed formal that includes the interface
12271 -- operations of all its progenitors.
12273 -- Same treatment for formal private types, so we can check whether the
12274 -- type is tagged limited when validating derivations in the private
12275 -- part. (See AI05-096).
12277 if Nkind (Def) = N_Formal_Derived_Type_Definition then
12278 if Present (Interface_List (Def)) then
12279 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
12280 else
12281 Set_Generic_Parent_Type (Decl_Node, Ancestor);
12282 end if;
12284 elsif Nkind_In (Def,
12285 N_Formal_Private_Type_Definition,
12286 N_Formal_Incomplete_Type_Definition)
12287 then
12288 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
12289 end if;
12291 -- If the actual is a synchronized type that implements an interface,
12292 -- the primitive operations are attached to the corresponding record,
12293 -- and we have to treat it as an additional generic actual, so that its
12294 -- primitive operations become visible in the instance. The task or
12295 -- protected type itself does not carry primitive operations.
12297 if Is_Concurrent_Type (Act_T)
12298 and then Is_Tagged_Type (Act_T)
12299 and then Present (Corresponding_Record_Type (Act_T))
12300 and then Present (Ancestor)
12301 and then Is_Interface (Ancestor)
12302 then
12303 declare
12304 Corr_Rec : constant Entity_Id :=
12305 Corresponding_Record_Type (Act_T);
12306 New_Corr : Entity_Id;
12307 Corr_Decl : Node_Id;
12309 begin
12310 New_Corr := Make_Temporary (Loc, 'S');
12311 Corr_Decl :=
12312 Make_Subtype_Declaration (Loc,
12313 Defining_Identifier => New_Corr,
12314 Subtype_Indication =>
12315 New_Occurrence_Of (Corr_Rec, Loc));
12316 Append_To (Decl_Nodes, Corr_Decl);
12318 if Ekind (Act_T) = E_Task_Type then
12319 Set_Ekind (Subt, E_Task_Subtype);
12320 else
12321 Set_Ekind (Subt, E_Protected_Subtype);
12322 end if;
12324 Set_Corresponding_Record_Type (Subt, Corr_Rec);
12325 Set_Generic_Parent_Type (Corr_Decl, Ancestor);
12326 Set_Generic_Parent_Type (Decl_Node, Empty);
12327 end;
12328 end if;
12330 return Decl_Nodes;
12331 end Instantiate_Type;
12333 ---------------------
12334 -- Is_In_Main_Unit --
12335 ---------------------
12337 function Is_In_Main_Unit (N : Node_Id) return Boolean is
12338 Unum : constant Unit_Number_Type := Get_Source_Unit (N);
12339 Current_Unit : Node_Id;
12341 begin
12342 if Unum = Main_Unit then
12343 return True;
12345 -- If the current unit is a subunit then it is either the main unit or
12346 -- is being compiled as part of the main unit.
12348 elsif Nkind (N) = N_Compilation_Unit then
12349 return Nkind (Unit (N)) = N_Subunit;
12350 end if;
12352 Current_Unit := Parent (N);
12353 while Present (Current_Unit)
12354 and then Nkind (Current_Unit) /= N_Compilation_Unit
12355 loop
12356 Current_Unit := Parent (Current_Unit);
12357 end loop;
12359 -- The instantiation node is in the main unit, or else the current node
12360 -- (perhaps as the result of nested instantiations) is in the main unit,
12361 -- or in the declaration of the main unit, which in this last case must
12362 -- be a body.
12364 return Unum = Main_Unit
12365 or else Current_Unit = Cunit (Main_Unit)
12366 or else Current_Unit = Library_Unit (Cunit (Main_Unit))
12367 or else (Present (Library_Unit (Current_Unit))
12368 and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
12369 end Is_In_Main_Unit;
12371 ----------------------------
12372 -- Load_Parent_Of_Generic --
12373 ----------------------------
12375 procedure Load_Parent_Of_Generic
12376 (N : Node_Id;
12377 Spec : Node_Id;
12378 Body_Optional : Boolean := False)
12380 Comp_Unit : constant Node_Id := Cunit (Get_Source_Unit (Spec));
12381 Saved_Style_Check : constant Boolean := Style_Check;
12382 Saved_Warnings : constant Warning_Record := Save_Warnings;
12383 True_Parent : Node_Id;
12384 Inst_Node : Node_Id;
12385 OK : Boolean;
12386 Previous_Instances : constant Elist_Id := New_Elmt_List;
12388 procedure Collect_Previous_Instances (Decls : List_Id);
12389 -- Collect all instantiations in the given list of declarations, that
12390 -- precede the generic that we need to load. If the bodies of these
12391 -- instantiations are available, we must analyze them, to ensure that
12392 -- the public symbols generated are the same when the unit is compiled
12393 -- to generate code, and when it is compiled in the context of a unit
12394 -- that needs a particular nested instance. This process is applied to
12395 -- both package and subprogram instances.
12397 --------------------------------
12398 -- Collect_Previous_Instances --
12399 --------------------------------
12401 procedure Collect_Previous_Instances (Decls : List_Id) is
12402 Decl : Node_Id;
12404 begin
12405 Decl := First (Decls);
12406 while Present (Decl) loop
12407 if Sloc (Decl) >= Sloc (Inst_Node) then
12408 return;
12410 -- If Decl is an instantiation, then record it as requiring
12411 -- instantiation of the corresponding body, except if it is an
12412 -- abbreviated instantiation generated internally for conformance
12413 -- checking purposes only for the case of a formal package
12414 -- declared without a box (see Instantiate_Formal_Package). Such
12415 -- an instantiation does not generate any code (the actual code
12416 -- comes from actual) and thus does not need to be analyzed here.
12417 -- If the instantiation appears with a generic package body it is
12418 -- not analyzed here either.
12420 elsif Nkind (Decl) = N_Package_Instantiation
12421 and then not Is_Internal (Defining_Entity (Decl))
12422 then
12423 Append_Elmt (Decl, Previous_Instances);
12425 -- For a subprogram instantiation, omit instantiations intrinsic
12426 -- operations (Unchecked_Conversions, etc.) that have no bodies.
12428 elsif Nkind_In (Decl, N_Function_Instantiation,
12429 N_Procedure_Instantiation)
12430 and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
12431 then
12432 Append_Elmt (Decl, Previous_Instances);
12434 elsif Nkind (Decl) = N_Package_Declaration then
12435 Collect_Previous_Instances
12436 (Visible_Declarations (Specification (Decl)));
12437 Collect_Previous_Instances
12438 (Private_Declarations (Specification (Decl)));
12440 -- Previous non-generic bodies may contain instances as well
12442 elsif Nkind (Decl) = N_Package_Body
12443 and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
12444 then
12445 Collect_Previous_Instances (Declarations (Decl));
12447 elsif Nkind (Decl) = N_Subprogram_Body
12448 and then not Acts_As_Spec (Decl)
12449 and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
12450 then
12451 Collect_Previous_Instances (Declarations (Decl));
12452 end if;
12454 Next (Decl);
12455 end loop;
12456 end Collect_Previous_Instances;
12458 -- Start of processing for Load_Parent_Of_Generic
12460 begin
12461 if not In_Same_Source_Unit (N, Spec)
12462 or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
12463 or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
12464 and then not Is_In_Main_Unit (Spec))
12465 then
12466 -- Find body of parent of spec, and analyze it. A special case arises
12467 -- when the parent is an instantiation, that is to say when we are
12468 -- currently instantiating a nested generic. In that case, there is
12469 -- no separate file for the body of the enclosing instance. Instead,
12470 -- the enclosing body must be instantiated as if it were a pending
12471 -- instantiation, in order to produce the body for the nested generic
12472 -- we require now. Note that in that case the generic may be defined
12473 -- in a package body, the instance defined in the same package body,
12474 -- and the original enclosing body may not be in the main unit.
12476 Inst_Node := Empty;
12478 True_Parent := Parent (Spec);
12479 while Present (True_Parent)
12480 and then Nkind (True_Parent) /= N_Compilation_Unit
12481 loop
12482 if Nkind (True_Parent) = N_Package_Declaration
12483 and then
12484 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
12485 then
12486 -- Parent is a compilation unit that is an instantiation.
12487 -- Instantiation node has been replaced with package decl.
12489 Inst_Node := Original_Node (True_Parent);
12490 exit;
12492 elsif Nkind (True_Parent) = N_Package_Declaration
12493 and then Present (Generic_Parent (Specification (True_Parent)))
12494 and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12495 then
12496 -- Parent is an instantiation within another specification.
12497 -- Declaration for instance has been inserted before original
12498 -- instantiation node. A direct link would be preferable?
12500 Inst_Node := Next (True_Parent);
12501 while Present (Inst_Node)
12502 and then Nkind (Inst_Node) /= N_Package_Instantiation
12503 loop
12504 Next (Inst_Node);
12505 end loop;
12507 -- If the instance appears within a generic, and the generic
12508 -- unit is defined within a formal package of the enclosing
12509 -- generic, there is no generic body available, and none
12510 -- needed. A more precise test should be used ???
12512 if No (Inst_Node) then
12513 return;
12514 end if;
12516 exit;
12518 else
12519 True_Parent := Parent (True_Parent);
12520 end if;
12521 end loop;
12523 -- Case where we are currently instantiating a nested generic
12525 if Present (Inst_Node) then
12526 if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
12528 -- Instantiation node and declaration of instantiated package
12529 -- were exchanged when only the declaration was needed.
12530 -- Restore instantiation node before proceeding with body.
12532 Set_Unit (Parent (True_Parent), Inst_Node);
12533 end if;
12535 -- Now complete instantiation of enclosing body, if it appears in
12536 -- some other unit. If it appears in the current unit, the body
12537 -- will have been instantiated already.
12539 if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
12541 -- We need to determine the expander mode to instantiate the
12542 -- enclosing body. Because the generic body we need may use
12543 -- global entities declared in the enclosing package (including
12544 -- aggregates) it is in general necessary to compile this body
12545 -- with expansion enabled, except if we are within a generic
12546 -- package, in which case the usual generic rule applies.
12548 declare
12549 Exp_Status : Boolean := True;
12550 Scop : Entity_Id;
12552 begin
12553 -- Loop through scopes looking for generic package
12555 Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
12556 while Present (Scop)
12557 and then Scop /= Standard_Standard
12558 loop
12559 if Ekind (Scop) = E_Generic_Package then
12560 Exp_Status := False;
12561 exit;
12562 end if;
12564 Scop := Scope (Scop);
12565 end loop;
12567 -- Collect previous instantiations in the unit that contains
12568 -- the desired generic.
12570 if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12571 and then not Body_Optional
12572 then
12573 declare
12574 Decl : Elmt_Id;
12575 Info : Pending_Body_Info;
12576 Par : Node_Id;
12578 begin
12579 Par := Parent (Inst_Node);
12580 while Present (Par) loop
12581 exit when Nkind (Parent (Par)) = N_Compilation_Unit;
12582 Par := Parent (Par);
12583 end loop;
12585 pragma Assert (Present (Par));
12587 if Nkind (Par) = N_Package_Body then
12588 Collect_Previous_Instances (Declarations (Par));
12590 elsif Nkind (Par) = N_Package_Declaration then
12591 Collect_Previous_Instances
12592 (Visible_Declarations (Specification (Par)));
12593 Collect_Previous_Instances
12594 (Private_Declarations (Specification (Par)));
12596 else
12597 -- Enclosing unit is a subprogram body. In this
12598 -- case all instance bodies are processed in order
12599 -- and there is no need to collect them separately.
12601 null;
12602 end if;
12604 Decl := First_Elmt (Previous_Instances);
12605 while Present (Decl) loop
12606 Info :=
12607 (Inst_Node => Node (Decl),
12608 Act_Decl =>
12609 Instance_Spec (Node (Decl)),
12610 Expander_Status => Exp_Status,
12611 Current_Sem_Unit =>
12612 Get_Code_Unit (Sloc (Node (Decl))),
12613 Scope_Suppress => Scope_Suppress,
12614 Local_Suppress_Stack_Top =>
12615 Local_Suppress_Stack_Top,
12616 Version => Ada_Version,
12617 Version_Pragma => Ada_Version_Pragma,
12618 Warnings => Save_Warnings,
12619 SPARK_Mode => SPARK_Mode,
12620 SPARK_Mode_Pragma => SPARK_Mode_Pragma);
12622 -- Package instance
12625 Nkind (Node (Decl)) = N_Package_Instantiation
12626 then
12627 Instantiate_Package_Body
12628 (Info, Body_Optional => True);
12630 -- Subprogram instance
12632 else
12633 -- The instance_spec is the wrapper package,
12634 -- and the subprogram declaration is the last
12635 -- declaration in the wrapper.
12637 Info.Act_Decl :=
12638 Last
12639 (Visible_Declarations
12640 (Specification (Info.Act_Decl)));
12642 Instantiate_Subprogram_Body
12643 (Info, Body_Optional => True);
12644 end if;
12646 Next_Elmt (Decl);
12647 end loop;
12648 end;
12649 end if;
12651 Instantiate_Package_Body
12652 (Body_Info =>
12653 ((Inst_Node => Inst_Node,
12654 Act_Decl => True_Parent,
12655 Expander_Status => Exp_Status,
12656 Current_Sem_Unit => Get_Code_Unit
12657 (Sloc (Inst_Node)),
12658 Scope_Suppress => Scope_Suppress,
12659 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
12660 Version => Ada_Version,
12661 Version_Pragma => Ada_Version_Pragma,
12662 Warnings => Save_Warnings,
12663 SPARK_Mode => SPARK_Mode,
12664 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
12665 Body_Optional => Body_Optional);
12666 end;
12667 end if;
12669 -- Case where we are not instantiating a nested generic
12671 else
12672 Opt.Style_Check := False;
12673 Expander_Mode_Save_And_Set (True);
12674 Load_Needed_Body (Comp_Unit, OK);
12675 Opt.Style_Check := Saved_Style_Check;
12676 Restore_Warnings (Saved_Warnings);
12677 Expander_Mode_Restore;
12679 if not OK
12680 and then Unit_Requires_Body (Defining_Entity (Spec))
12681 and then not Body_Optional
12682 then
12683 declare
12684 Bname : constant Unit_Name_Type :=
12685 Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
12687 begin
12688 -- In CodePeer mode, the missing body may make the analysis
12689 -- incomplete, but we do not treat it as fatal.
12691 if CodePeer_Mode then
12692 return;
12694 else
12695 Error_Msg_Unit_1 := Bname;
12696 Error_Msg_N ("this instantiation requires$!", N);
12697 Error_Msg_File_1 :=
12698 Get_File_Name (Bname, Subunit => False);
12699 Error_Msg_N ("\but file{ was not found!", N);
12700 raise Unrecoverable_Error;
12701 end if;
12702 end;
12703 end if;
12704 end if;
12705 end if;
12707 -- If loading parent of the generic caused an instantiation circularity,
12708 -- we abandon compilation at this point, because otherwise in some cases
12709 -- we get into trouble with infinite recursions after this point.
12711 if Circularity_Detected then
12712 raise Unrecoverable_Error;
12713 end if;
12714 end Load_Parent_Of_Generic;
12716 ---------------------------------
12717 -- Map_Formal_Package_Entities --
12718 ---------------------------------
12720 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
12721 E1 : Entity_Id;
12722 E2 : Entity_Id;
12724 begin
12725 Set_Instance_Of (Form, Act);
12727 -- Traverse formal and actual package to map the corresponding entities.
12728 -- We skip over internal entities that may be generated during semantic
12729 -- analysis, and find the matching entities by name, given that they
12730 -- must appear in the same order.
12732 E1 := First_Entity (Form);
12733 E2 := First_Entity (Act);
12734 while Present (E1) and then E1 /= First_Private_Entity (Form) loop
12735 -- Could this test be a single condition??? Seems like it could, and
12736 -- isn't FPE (Form) a constant anyway???
12738 if not Is_Internal (E1)
12739 and then Present (Parent (E1))
12740 and then not Is_Class_Wide_Type (E1)
12741 and then not Is_Internal_Name (Chars (E1))
12742 then
12743 while Present (E2) and then Chars (E2) /= Chars (E1) loop
12744 Next_Entity (E2);
12745 end loop;
12747 if No (E2) then
12748 exit;
12749 else
12750 Set_Instance_Of (E1, E2);
12752 if Is_Type (E1) and then Is_Tagged_Type (E2) then
12753 Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
12754 end if;
12756 if Is_Constrained (E1) then
12757 Set_Instance_Of (Base_Type (E1), Base_Type (E2));
12758 end if;
12760 if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
12761 Map_Formal_Package_Entities (E1, E2);
12762 end if;
12763 end if;
12764 end if;
12766 Next_Entity (E1);
12767 end loop;
12768 end Map_Formal_Package_Entities;
12770 -----------------------
12771 -- Move_Freeze_Nodes --
12772 -----------------------
12774 procedure Move_Freeze_Nodes
12775 (Out_Of : Entity_Id;
12776 After : Node_Id;
12777 L : List_Id)
12779 Decl : Node_Id;
12780 Next_Decl : Node_Id;
12781 Next_Node : Node_Id := After;
12782 Spec : Node_Id;
12784 function Is_Outer_Type (T : Entity_Id) return Boolean;
12785 -- Check whether entity is declared in a scope external to that of the
12786 -- generic unit.
12788 -------------------
12789 -- Is_Outer_Type --
12790 -------------------
12792 function Is_Outer_Type (T : Entity_Id) return Boolean is
12793 Scop : Entity_Id := Scope (T);
12795 begin
12796 if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12797 return True;
12799 else
12800 while Scop /= Standard_Standard loop
12801 if Scop = Out_Of then
12802 return False;
12803 else
12804 Scop := Scope (Scop);
12805 end if;
12806 end loop;
12808 return True;
12809 end if;
12810 end Is_Outer_Type;
12812 -- Start of processing for Move_Freeze_Nodes
12814 begin
12815 if No (L) then
12816 return;
12817 end if;
12819 -- First remove the freeze nodes that may appear before all other
12820 -- declarations.
12822 Decl := First (L);
12823 while Present (Decl)
12824 and then Nkind (Decl) = N_Freeze_Entity
12825 and then Is_Outer_Type (Entity (Decl))
12826 loop
12827 Decl := Remove_Head (L);
12828 Insert_After (Next_Node, Decl);
12829 Set_Analyzed (Decl, False);
12830 Next_Node := Decl;
12831 Decl := First (L);
12832 end loop;
12834 -- Next scan the list of declarations and remove each freeze node that
12835 -- appears ahead of the current node.
12837 while Present (Decl) loop
12838 while Present (Next (Decl))
12839 and then Nkind (Next (Decl)) = N_Freeze_Entity
12840 and then Is_Outer_Type (Entity (Next (Decl)))
12841 loop
12842 Next_Decl := Remove_Next (Decl);
12843 Insert_After (Next_Node, Next_Decl);
12844 Set_Analyzed (Next_Decl, False);
12845 Next_Node := Next_Decl;
12846 end loop;
12848 -- If the declaration is a nested package or concurrent type, then
12849 -- recurse. Nested generic packages will have been processed from the
12850 -- inside out.
12852 case Nkind (Decl) is
12853 when N_Package_Declaration =>
12854 Spec := Specification (Decl);
12856 when N_Task_Type_Declaration =>
12857 Spec := Task_Definition (Decl);
12859 when N_Protected_Type_Declaration =>
12860 Spec := Protected_Definition (Decl);
12862 when others =>
12863 Spec := Empty;
12864 end case;
12866 if Present (Spec) then
12867 Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
12868 Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
12869 end if;
12871 Next (Decl);
12872 end loop;
12873 end Move_Freeze_Nodes;
12875 ----------------
12876 -- Next_Assoc --
12877 ----------------
12879 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
12880 begin
12881 return Generic_Renamings.Table (E).Next_In_HTable;
12882 end Next_Assoc;
12884 ------------------------
12885 -- Preanalyze_Actuals --
12886 ------------------------
12888 procedure Preanalyze_Actuals (N : Node_Id) is
12889 Assoc : Node_Id;
12890 Act : Node_Id;
12891 Errs : constant Int := Serious_Errors_Detected;
12893 Cur : Entity_Id := Empty;
12894 -- Current homograph of the instance name
12896 Vis : Boolean;
12897 -- Saved visibility status of the current homograph
12899 begin
12900 Assoc := First (Generic_Associations (N));
12902 -- If the instance is a child unit, its name may hide an outer homonym,
12903 -- so make it invisible to perform name resolution on the actuals.
12905 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
12906 and then Present
12907 (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
12908 then
12909 Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
12911 if Is_Compilation_Unit (Cur) then
12912 Vis := Is_Immediately_Visible (Cur);
12913 Set_Is_Immediately_Visible (Cur, False);
12914 else
12915 Cur := Empty;
12916 end if;
12917 end if;
12919 while Present (Assoc) loop
12920 if Nkind (Assoc) /= N_Others_Choice then
12921 Act := Explicit_Generic_Actual_Parameter (Assoc);
12923 -- Within a nested instantiation, a defaulted actual is an empty
12924 -- association, so nothing to analyze. If the subprogram actual
12925 -- is an attribute, analyze prefix only, because actual is not a
12926 -- complete attribute reference.
12928 -- If actual is an allocator, analyze expression only. The full
12929 -- analysis can generate code, and if instance is a compilation
12930 -- unit we have to wait until the package instance is installed
12931 -- to have a proper place to insert this code.
12933 -- String literals may be operators, but at this point we do not
12934 -- know whether the actual is a formal subprogram or a string.
12936 if No (Act) then
12937 null;
12939 elsif Nkind (Act) = N_Attribute_Reference then
12940 Analyze (Prefix (Act));
12942 elsif Nkind (Act) = N_Explicit_Dereference then
12943 Analyze (Prefix (Act));
12945 elsif Nkind (Act) = N_Allocator then
12946 declare
12947 Expr : constant Node_Id := Expression (Act);
12949 begin
12950 if Nkind (Expr) = N_Subtype_Indication then
12951 Analyze (Subtype_Mark (Expr));
12953 -- Analyze separately each discriminant constraint, when
12954 -- given with a named association.
12956 declare
12957 Constr : Node_Id;
12959 begin
12960 Constr := First (Constraints (Constraint (Expr)));
12961 while Present (Constr) loop
12962 if Nkind (Constr) = N_Discriminant_Association then
12963 Analyze (Expression (Constr));
12964 else
12965 Analyze (Constr);
12966 end if;
12968 Next (Constr);
12969 end loop;
12970 end;
12972 else
12973 Analyze (Expr);
12974 end if;
12975 end;
12977 elsif Nkind (Act) /= N_Operator_Symbol then
12978 Analyze (Act);
12979 end if;
12981 -- Ensure that a ghost subprogram does not act as generic actual
12983 if Is_Entity_Name (Act)
12984 and then Is_Ghost_Subprogram (Entity (Act))
12985 then
12986 Error_Msg_N
12987 ("ghost subprogram & cannot act as generic actual", Act);
12988 Abandon_Instantiation (Act);
12990 elsif Errs /= Serious_Errors_Detected then
12992 -- Do a minimal analysis of the generic, to prevent spurious
12993 -- warnings complaining about the generic being unreferenced,
12994 -- before abandoning the instantiation.
12996 Analyze (Name (N));
12998 if Is_Entity_Name (Name (N))
12999 and then Etype (Name (N)) /= Any_Type
13000 then
13001 Generate_Reference (Entity (Name (N)), Name (N));
13002 Set_Is_Instantiated (Entity (Name (N)));
13003 end if;
13005 if Present (Cur) then
13007 -- For the case of a child instance hiding an outer homonym,
13008 -- provide additional warning which might explain the error.
13010 Set_Is_Immediately_Visible (Cur, Vis);
13011 Error_Msg_NE ("& hides outer unit with the same name??",
13012 N, Defining_Unit_Name (N));
13013 end if;
13015 Abandon_Instantiation (Act);
13016 end if;
13017 end if;
13019 Next (Assoc);
13020 end loop;
13022 if Present (Cur) then
13023 Set_Is_Immediately_Visible (Cur, Vis);
13024 end if;
13025 end Preanalyze_Actuals;
13027 -------------------
13028 -- Remove_Parent --
13029 -------------------
13031 procedure Remove_Parent (In_Body : Boolean := False) is
13032 S : Entity_Id := Current_Scope;
13033 -- S is the scope containing the instantiation just completed. The scope
13034 -- stack contains the parent instances of the instantiation, followed by
13035 -- the original S.
13037 Cur_P : Entity_Id;
13038 E : Entity_Id;
13039 P : Entity_Id;
13040 Hidden : Elmt_Id;
13042 begin
13043 -- After child instantiation is complete, remove from scope stack the
13044 -- extra copy of the current scope, and then remove parent instances.
13046 if not In_Body then
13047 Pop_Scope;
13049 while Current_Scope /= S loop
13050 P := Current_Scope;
13051 End_Package_Scope (Current_Scope);
13053 if In_Open_Scopes (P) then
13054 E := First_Entity (P);
13055 while Present (E) loop
13056 Set_Is_Immediately_Visible (E, True);
13057 Next_Entity (E);
13058 end loop;
13060 -- If instantiation is declared in a block, it is the enclosing
13061 -- scope that might be a parent instance. Note that only one
13062 -- block can be involved, because the parent instances have
13063 -- been installed within it.
13065 if Ekind (P) = E_Block then
13066 Cur_P := Scope (P);
13067 else
13068 Cur_P := P;
13069 end if;
13071 if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
13072 -- We are within an instance of some sibling. Retain
13073 -- visibility of parent, for proper subsequent cleanup, and
13074 -- reinstall private declarations as well.
13076 Set_In_Private_Part (P);
13077 Install_Private_Declarations (P);
13078 end if;
13080 -- If the ultimate parent is a top-level unit recorded in
13081 -- Instance_Parent_Unit, then reset its visibility to what it was
13082 -- before instantiation. (It's not clear what the purpose is of
13083 -- testing whether Scope (P) is In_Open_Scopes, but that test was
13084 -- present before the ultimate parent test was added.???)
13086 elsif not In_Open_Scopes (Scope (P))
13087 or else (P = Instance_Parent_Unit
13088 and then not Parent_Unit_Visible)
13089 then
13090 Set_Is_Immediately_Visible (P, False);
13092 -- If the current scope is itself an instantiation of a generic
13093 -- nested within P, and we are in the private part of body of this
13094 -- instantiation, restore the full views of P, that were removed
13095 -- in End_Package_Scope above. This obscure case can occur when a
13096 -- subunit of a generic contains an instance of a child unit of
13097 -- its generic parent unit.
13099 elsif S = Current_Scope and then Is_Generic_Instance (S) then
13100 declare
13101 Par : constant Entity_Id :=
13102 Generic_Parent (Package_Specification (S));
13103 begin
13104 if Present (Par)
13105 and then P = Scope (Par)
13106 and then (In_Package_Body (S) or else In_Private_Part (S))
13107 then
13108 Set_In_Private_Part (P);
13109 Install_Private_Declarations (P);
13110 end if;
13111 end;
13112 end if;
13113 end loop;
13115 -- Reset visibility of entities in the enclosing scope
13117 Set_Is_Hidden_Open_Scope (Current_Scope, False);
13119 Hidden := First_Elmt (Hidden_Entities);
13120 while Present (Hidden) loop
13121 Set_Is_Immediately_Visible (Node (Hidden), True);
13122 Next_Elmt (Hidden);
13123 end loop;
13125 else
13126 -- Each body is analyzed separately, and there is no context that
13127 -- needs preserving from one body instance to the next, so remove all
13128 -- parent scopes that have been installed.
13130 while Present (S) loop
13131 End_Package_Scope (S);
13132 Set_Is_Immediately_Visible (S, False);
13133 S := Current_Scope;
13134 exit when S = Standard_Standard;
13135 end loop;
13136 end if;
13137 end Remove_Parent;
13139 -----------------
13140 -- Restore_Env --
13141 -----------------
13143 procedure Restore_Env is
13144 Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
13146 begin
13147 if No (Current_Instantiated_Parent.Act_Id) then
13148 -- Restore environment after subprogram inlining
13150 Restore_Private_Views (Empty);
13151 end if;
13153 Current_Instantiated_Parent := Saved.Instantiated_Parent;
13154 Exchanged_Views := Saved.Exchanged_Views;
13155 Hidden_Entities := Saved.Hidden_Entities;
13156 Current_Sem_Unit := Saved.Current_Sem_Unit;
13157 Parent_Unit_Visible := Saved.Parent_Unit_Visible;
13158 Instance_Parent_Unit := Saved.Instance_Parent_Unit;
13160 Restore_Opt_Config_Switches (Saved.Switches);
13162 Instance_Envs.Decrement_Last;
13163 end Restore_Env;
13165 ---------------------------
13166 -- Restore_Private_Views --
13167 ---------------------------
13169 procedure Restore_Private_Views
13170 (Pack_Id : Entity_Id;
13171 Is_Package : Boolean := True)
13173 M : Elmt_Id;
13174 E : Entity_Id;
13175 Typ : Entity_Id;
13176 Dep_Elmt : Elmt_Id;
13177 Dep_Typ : Node_Id;
13179 procedure Restore_Nested_Formal (Formal : Entity_Id);
13180 -- Hide the generic formals of formal packages declared with box which
13181 -- were reachable in the current instantiation.
13183 ---------------------------
13184 -- Restore_Nested_Formal --
13185 ---------------------------
13187 procedure Restore_Nested_Formal (Formal : Entity_Id) is
13188 Ent : Entity_Id;
13190 begin
13191 if Present (Renamed_Object (Formal))
13192 and then Denotes_Formal_Package (Renamed_Object (Formal), True)
13193 then
13194 return;
13196 elsif Present (Associated_Formal_Package (Formal)) then
13197 Ent := First_Entity (Formal);
13198 while Present (Ent) loop
13199 exit when Ekind (Ent) = E_Package
13200 and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
13202 Set_Is_Hidden (Ent);
13203 Set_Is_Potentially_Use_Visible (Ent, False);
13205 -- If package, then recurse
13207 if Ekind (Ent) = E_Package then
13208 Restore_Nested_Formal (Ent);
13209 end if;
13211 Next_Entity (Ent);
13212 end loop;
13213 end if;
13214 end Restore_Nested_Formal;
13216 -- Start of processing for Restore_Private_Views
13218 begin
13219 M := First_Elmt (Exchanged_Views);
13220 while Present (M) loop
13221 Typ := Node (M);
13223 -- Subtypes of types whose views have been exchanged, and that are
13224 -- defined within the instance, were not on the Private_Dependents
13225 -- list on entry to the instance, so they have to be exchanged
13226 -- explicitly now, in order to remain consistent with the view of the
13227 -- parent type.
13229 if Ekind_In (Typ, E_Private_Type,
13230 E_Limited_Private_Type,
13231 E_Record_Type_With_Private)
13232 then
13233 Dep_Elmt := First_Elmt (Private_Dependents (Typ));
13234 while Present (Dep_Elmt) loop
13235 Dep_Typ := Node (Dep_Elmt);
13237 if Scope (Dep_Typ) = Pack_Id
13238 and then Present (Full_View (Dep_Typ))
13239 then
13240 Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
13241 Exchange_Declarations (Dep_Typ);
13242 end if;
13244 Next_Elmt (Dep_Elmt);
13245 end loop;
13246 end if;
13248 Exchange_Declarations (Node (M));
13249 Next_Elmt (M);
13250 end loop;
13252 if No (Pack_Id) then
13253 return;
13254 end if;
13256 -- Make the generic formal parameters private, and make the formal types
13257 -- into subtypes of the actuals again.
13259 E := First_Entity (Pack_Id);
13260 while Present (E) loop
13261 Set_Is_Hidden (E, True);
13263 if Is_Type (E)
13264 and then Nkind (Parent (E)) = N_Subtype_Declaration
13265 then
13266 -- If the actual for E is itself a generic actual type from
13267 -- an enclosing instance, E is still a generic actual type
13268 -- outside of the current instance. This matter when resolving
13269 -- an overloaded call that may be ambiguous in the enclosing
13270 -- instance, when two of its actuals coincide.
13272 if Is_Entity_Name (Subtype_Indication (Parent (E)))
13273 and then Is_Generic_Actual_Type
13274 (Entity (Subtype_Indication (Parent (E))))
13275 then
13276 null;
13277 else
13278 Set_Is_Generic_Actual_Type (E, False);
13279 end if;
13281 -- An unusual case of aliasing: the actual may also be directly
13282 -- visible in the generic, and be private there, while it is fully
13283 -- visible in the context of the instance. The internal subtype
13284 -- is private in the instance but has full visibility like its
13285 -- parent in the enclosing scope. This enforces the invariant that
13286 -- the privacy status of all private dependents of a type coincide
13287 -- with that of the parent type. This can only happen when a
13288 -- generic child unit is instantiated within a sibling.
13290 if Is_Private_Type (E)
13291 and then not Is_Private_Type (Etype (E))
13292 then
13293 Exchange_Declarations (E);
13294 end if;
13296 elsif Ekind (E) = E_Package then
13298 -- The end of the renaming list is the renaming of the generic
13299 -- package itself. If the instance is a subprogram, all entities
13300 -- in the corresponding package are renamings. If this entity is
13301 -- a formal package, make its own formals private as well. The
13302 -- actual in this case is itself the renaming of an instantiation.
13303 -- If the entity is not a package renaming, it is the entity
13304 -- created to validate formal package actuals: ignore it.
13306 -- If the actual is itself a formal package for the enclosing
13307 -- generic, or the actual for such a formal package, it remains
13308 -- visible on exit from the instance, and therefore nothing needs
13309 -- to be done either, except to keep it accessible.
13311 if Is_Package and then Renamed_Object (E) = Pack_Id then
13312 exit;
13314 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
13315 null;
13317 elsif
13318 Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
13319 then
13320 Set_Is_Hidden (E, False);
13322 else
13323 declare
13324 Act_P : constant Entity_Id := Renamed_Object (E);
13325 Id : Entity_Id;
13327 begin
13328 Id := First_Entity (Act_P);
13329 while Present (Id)
13330 and then Id /= First_Private_Entity (Act_P)
13331 loop
13332 exit when Ekind (Id) = E_Package
13333 and then Renamed_Object (Id) = Act_P;
13335 Set_Is_Hidden (Id, True);
13336 Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
13338 if Ekind (Id) = E_Package then
13339 Restore_Nested_Formal (Id);
13340 end if;
13342 Next_Entity (Id);
13343 end loop;
13344 end;
13345 end if;
13346 end if;
13348 Next_Entity (E);
13349 end loop;
13350 end Restore_Private_Views;
13352 --------------
13353 -- Save_Env --
13354 --------------
13356 procedure Save_Env
13357 (Gen_Unit : Entity_Id;
13358 Act_Unit : Entity_Id)
13360 begin
13361 Init_Env;
13362 Set_Instance_Env (Gen_Unit, Act_Unit);
13363 end Save_Env;
13365 ----------------------------
13366 -- Save_Global_References --
13367 ----------------------------
13369 procedure Save_Global_References (N : Node_Id) is
13370 Gen_Scope : Entity_Id;
13371 E : Entity_Id;
13372 N2 : Node_Id;
13374 function Is_Global (E : Entity_Id) return Boolean;
13375 -- Check whether entity is defined outside of generic unit. Examine the
13376 -- scope of an entity, and the scope of the scope, etc, until we find
13377 -- either Standard, in which case the entity is global, or the generic
13378 -- unit itself, which indicates that the entity is local. If the entity
13379 -- is the generic unit itself, as in the case of a recursive call, or
13380 -- the enclosing generic unit, if different from the current scope, then
13381 -- it is local as well, because it will be replaced at the point of
13382 -- instantiation. On the other hand, if it is a reference to a child
13383 -- unit of a common ancestor, which appears in an instantiation, it is
13384 -- global because it is used to denote a specific compilation unit at
13385 -- the time the instantiations will be analyzed.
13387 procedure Reset_Entity (N : Node_Id);
13388 -- Save semantic information on global entity so that it is not resolved
13389 -- again at instantiation time.
13391 procedure Save_Entity_Descendants (N : Node_Id);
13392 -- Apply Save_Global_References to the two syntactic descendants of
13393 -- non-terminal nodes that carry an Associated_Node and are processed
13394 -- through Reset_Entity. Once the global entity (if any) has been
13395 -- captured together with its type, only two syntactic descendants need
13396 -- to be traversed to complete the processing of the tree rooted at N.
13397 -- This applies to Selected_Components, Expanded_Names, and to Operator
13398 -- nodes. N can also be a character literal, identifier, or operator
13399 -- symbol node, but the call has no effect in these cases.
13401 procedure Save_Global_Defaults (N1, N2 : Node_Id);
13402 -- Default actuals in nested instances must be handled specially
13403 -- because there is no link to them from the original tree. When an
13404 -- actual subprogram is given by a default, we add an explicit generic
13405 -- association for it in the instantiation node. When we save the
13406 -- global references on the name of the instance, we recover the list
13407 -- of generic associations, and add an explicit one to the original
13408 -- generic tree, through which a global actual can be preserved.
13409 -- Similarly, if a child unit is instantiated within a sibling, in the
13410 -- context of the parent, we must preserve the identifier of the parent
13411 -- so that it can be properly resolved in a subsequent instantiation.
13413 procedure Save_Global_Descendant (D : Union_Id);
13414 -- Apply Save_Global_References recursively to the descendents of the
13415 -- current node.
13417 procedure Save_References (N : Node_Id);
13418 -- This is the recursive procedure that does the work, once the
13419 -- enclosing generic scope has been established.
13421 ---------------
13422 -- Is_Global --
13423 ---------------
13425 function Is_Global (E : Entity_Id) return Boolean is
13426 Se : Entity_Id;
13428 function Is_Instance_Node (Decl : Node_Id) return Boolean;
13429 -- Determine whether the parent node of a reference to a child unit
13430 -- denotes an instantiation or a formal package, in which case the
13431 -- reference to the child unit is global, even if it appears within
13432 -- the current scope (e.g. when the instance appears within the body
13433 -- of an ancestor).
13435 ----------------------
13436 -- Is_Instance_Node --
13437 ----------------------
13439 function Is_Instance_Node (Decl : Node_Id) return Boolean is
13440 begin
13441 return Nkind (Decl) in N_Generic_Instantiation
13442 or else
13443 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
13444 end Is_Instance_Node;
13446 -- Start of processing for Is_Global
13448 begin
13449 if E = Gen_Scope then
13450 return False;
13452 elsif E = Standard_Standard then
13453 return True;
13455 elsif Is_Child_Unit (E)
13456 and then (Is_Instance_Node (Parent (N2))
13457 or else (Nkind (Parent (N2)) = N_Expanded_Name
13458 and then N2 = Selector_Name (Parent (N2))
13459 and then
13460 Is_Instance_Node (Parent (Parent (N2)))))
13461 then
13462 return True;
13464 else
13465 Se := Scope (E);
13466 while Se /= Gen_Scope loop
13467 if Se = Standard_Standard then
13468 return True;
13469 else
13470 Se := Scope (Se);
13471 end if;
13472 end loop;
13474 return False;
13475 end if;
13476 end Is_Global;
13478 ------------------
13479 -- Reset_Entity --
13480 ------------------
13482 procedure Reset_Entity (N : Node_Id) is
13484 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
13485 -- If the type of N2 is global to the generic unit, save the type in
13486 -- the generic node. Just as we perform name capture for explicit
13487 -- references within the generic, we must capture the global types
13488 -- of local entities because they may participate in resolution in
13489 -- the instance.
13491 function Top_Ancestor (E : Entity_Id) return Entity_Id;
13492 -- Find the ultimate ancestor of the current unit. If it is not a
13493 -- generic unit, then the name of the current unit in the prefix of
13494 -- an expanded name must be replaced with its generic homonym to
13495 -- ensure that it will be properly resolved in an instance.
13497 ---------------------
13498 -- Set_Global_Type --
13499 ---------------------
13501 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
13502 Typ : constant Entity_Id := Etype (N2);
13504 begin
13505 Set_Etype (N, Typ);
13507 if Entity (N) /= N2
13508 and then Has_Private_View (Entity (N))
13509 then
13510 -- If the entity of N is not the associated node, this is a
13511 -- nested generic and it has an associated node as well, whose
13512 -- type is already the full view (see below). Indicate that the
13513 -- original node has a private view.
13515 Set_Has_Private_View (N);
13516 end if;
13518 -- If not a private type, nothing else to do
13520 if not Is_Private_Type (Typ) then
13521 if Is_Array_Type (Typ)
13522 and then Is_Private_Type (Component_Type (Typ))
13523 then
13524 Set_Has_Private_View (N);
13525 end if;
13527 -- If it is a derivation of a private type in a context where no
13528 -- full view is needed, nothing to do either.
13530 elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
13531 null;
13533 -- Otherwise mark the type for flipping and use the full view when
13534 -- available.
13536 else
13537 Set_Has_Private_View (N);
13539 if Present (Full_View (Typ)) then
13540 Set_Etype (N2, Full_View (Typ));
13541 end if;
13542 end if;
13543 end Set_Global_Type;
13545 ------------------
13546 -- Top_Ancestor --
13547 ------------------
13549 function Top_Ancestor (E : Entity_Id) return Entity_Id is
13550 Par : Entity_Id;
13552 begin
13553 Par := E;
13554 while Is_Child_Unit (Par) loop
13555 Par := Scope (Par);
13556 end loop;
13558 return Par;
13559 end Top_Ancestor;
13561 -- Start of processing for Reset_Entity
13563 begin
13564 N2 := Get_Associated_Node (N);
13565 E := Entity (N2);
13567 if Present (E) then
13569 -- If the node is an entry call to an entry in an enclosing task,
13570 -- it is rewritten as a selected component. No global entity to
13571 -- preserve in this case, since the expansion will be redone in
13572 -- the instance.
13574 if not Nkind_In (E, N_Defining_Identifier,
13575 N_Defining_Character_Literal,
13576 N_Defining_Operator_Symbol)
13577 then
13578 Set_Associated_Node (N, Empty);
13579 Set_Etype (N, Empty);
13580 return;
13581 end if;
13583 -- If the entity is an itype created as a subtype of an access
13584 -- type with a null exclusion restore source entity for proper
13585 -- visibility. The itype will be created anew in the instance.
13587 if Is_Itype (E)
13588 and then Ekind (E) = E_Access_Subtype
13589 and then Is_Entity_Name (N)
13590 and then Chars (Etype (E)) = Chars (N)
13591 then
13592 E := Etype (E);
13593 Set_Entity (N2, E);
13594 Set_Etype (N2, E);
13595 end if;
13597 if Is_Global (E) then
13599 -- If the entity is a package renaming that is the prefix of
13600 -- an expanded name, it has been rewritten as the renamed
13601 -- package, which is necessary semantically but complicates
13602 -- ASIS tree traversal, so we recover the original entity to
13603 -- expose the renaming. Take into account that the context may
13604 -- be a nested generic, that the original node may itself have
13605 -- an associated node that had better be an entity, and that
13606 -- the current node is still a selected component.
13608 if Ekind (E) = E_Package
13609 and then Nkind (N) = N_Selected_Component
13610 and then Nkind (Parent (N)) = N_Expanded_Name
13611 and then Present (Original_Node (N2))
13612 and then Is_Entity_Name (Original_Node (N2))
13613 and then Present (Entity (Original_Node (N2)))
13614 then
13615 if Is_Global (Entity (Original_Node (N2))) then
13616 N2 := Original_Node (N2);
13617 Set_Associated_Node (N, N2);
13618 Set_Global_Type (N, N2);
13620 else
13621 -- Renaming is local, and will be resolved in instance
13623 Set_Associated_Node (N, Empty);
13624 Set_Etype (N, Empty);
13625 end if;
13627 else
13628 Set_Global_Type (N, N2);
13629 end if;
13631 elsif Nkind (N) = N_Op_Concat
13632 and then Is_Generic_Type (Etype (N2))
13633 and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
13634 or else
13635 Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
13636 and then Is_Intrinsic_Subprogram (E)
13637 then
13638 null;
13640 else
13641 -- Entity is local. Mark generic node as unresolved.
13642 -- Note that now it does not have an entity.
13644 Set_Associated_Node (N, Empty);
13645 Set_Etype (N, Empty);
13646 end if;
13648 if Nkind (Parent (N)) in N_Generic_Instantiation
13649 and then N = Name (Parent (N))
13650 then
13651 Save_Global_Defaults (Parent (N), Parent (N2));
13652 end if;
13654 elsif Nkind (Parent (N)) = N_Selected_Component
13655 and then Nkind (Parent (N2)) = N_Expanded_Name
13656 then
13657 if Is_Global (Entity (Parent (N2))) then
13658 Change_Selected_Component_To_Expanded_Name (Parent (N));
13659 Set_Associated_Node (Parent (N), Parent (N2));
13660 Set_Global_Type (Parent (N), Parent (N2));
13661 Save_Entity_Descendants (N);
13663 -- If this is a reference to the current generic entity, replace
13664 -- by the name of the generic homonym of the current package. This
13665 -- is because in an instantiation Par.P.Q will not resolve to the
13666 -- name of the instance, whose enclosing scope is not necessarily
13667 -- Par. We use the generic homonym rather that the name of the
13668 -- generic itself because it may be hidden by a local declaration.
13670 elsif In_Open_Scopes (Entity (Parent (N2)))
13671 and then not
13672 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
13673 then
13674 if Ekind (Entity (Parent (N2))) = E_Generic_Package then
13675 Rewrite (Parent (N),
13676 Make_Identifier (Sloc (N),
13677 Chars =>
13678 Chars (Generic_Homonym (Entity (Parent (N2))))));
13679 else
13680 Rewrite (Parent (N),
13681 Make_Identifier (Sloc (N),
13682 Chars => Chars (Selector_Name (Parent (N2)))));
13683 end if;
13684 end if;
13686 if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
13687 and then Parent (N) = Name (Parent (Parent (N)))
13688 then
13689 Save_Global_Defaults
13690 (Parent (Parent (N)), Parent (Parent ((N2))));
13691 end if;
13693 -- A selected component may denote a static constant that has been
13694 -- folded. If the static constant is global to the generic, capture
13695 -- its value. Otherwise the folding will happen in any instantiation.
13697 elsif Nkind (Parent (N)) = N_Selected_Component
13698 and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
13699 then
13700 if Present (Entity (Original_Node (Parent (N2))))
13701 and then Is_Global (Entity (Original_Node (Parent (N2))))
13702 then
13703 Rewrite (Parent (N), New_Copy (Parent (N2)));
13704 Set_Analyzed (Parent (N), False);
13706 else
13707 null;
13708 end if;
13710 -- A selected component may be transformed into a parameterless
13711 -- function call. If the called entity is global, rewrite the node
13712 -- appropriately, i.e. as an extended name for the global entity.
13714 elsif Nkind (Parent (N)) = N_Selected_Component
13715 and then Nkind (Parent (N2)) = N_Function_Call
13716 and then N = Selector_Name (Parent (N))
13717 then
13718 if No (Parameter_Associations (Parent (N2))) then
13719 if Is_Global (Entity (Name (Parent (N2)))) then
13720 Change_Selected_Component_To_Expanded_Name (Parent (N));
13721 Set_Associated_Node (Parent (N), Name (Parent (N2)));
13722 Set_Global_Type (Parent (N), Name (Parent (N2)));
13723 Save_Entity_Descendants (N);
13725 else
13726 Set_Is_Prefixed_Call (Parent (N));
13727 Set_Associated_Node (N, Empty);
13728 Set_Etype (N, Empty);
13729 end if;
13731 -- In Ada 2005, X.F may be a call to a primitive operation,
13732 -- rewritten as F (X). This rewriting will be done again in an
13733 -- instance, so keep the original node. Global entities will be
13734 -- captured as for other constructs. Indicate that this must
13735 -- resolve as a call, to prevent accidental overloading in the
13736 -- instance, if both a component and a primitive operation appear
13737 -- as candidates.
13739 else
13740 Set_Is_Prefixed_Call (Parent (N));
13741 end if;
13743 -- Entity is local. Reset in generic unit, so that node is resolved
13744 -- anew at the point of instantiation.
13746 else
13747 Set_Associated_Node (N, Empty);
13748 Set_Etype (N, Empty);
13749 end if;
13750 end Reset_Entity;
13752 -----------------------------
13753 -- Save_Entity_Descendants --
13754 -----------------------------
13756 procedure Save_Entity_Descendants (N : Node_Id) is
13757 begin
13758 case Nkind (N) is
13759 when N_Binary_Op =>
13760 Save_Global_Descendant (Union_Id (Left_Opnd (N)));
13761 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13763 when N_Unary_Op =>
13764 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13766 when N_Expanded_Name | N_Selected_Component =>
13767 Save_Global_Descendant (Union_Id (Prefix (N)));
13768 Save_Global_Descendant (Union_Id (Selector_Name (N)));
13770 when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
13771 null;
13773 when others =>
13774 raise Program_Error;
13775 end case;
13776 end Save_Entity_Descendants;
13778 --------------------------
13779 -- Save_Global_Defaults --
13780 --------------------------
13782 procedure Save_Global_Defaults (N1, N2 : Node_Id) is
13783 Loc : constant Source_Ptr := Sloc (N1);
13784 Assoc2 : constant List_Id := Generic_Associations (N2);
13785 Gen_Id : constant Entity_Id := Get_Generic_Entity (N2);
13786 Assoc1 : List_Id;
13787 Act1 : Node_Id;
13788 Act2 : Node_Id;
13789 Def : Node_Id;
13790 Ndec : Node_Id;
13791 Subp : Entity_Id;
13792 Actual : Entity_Id;
13794 begin
13795 Assoc1 := Generic_Associations (N1);
13797 if Present (Assoc1) then
13798 Act1 := First (Assoc1);
13799 else
13800 Act1 := Empty;
13801 Set_Generic_Associations (N1, New_List);
13802 Assoc1 := Generic_Associations (N1);
13803 end if;
13805 if Present (Assoc2) then
13806 Act2 := First (Assoc2);
13807 else
13808 return;
13809 end if;
13811 while Present (Act1) and then Present (Act2) loop
13812 Next (Act1);
13813 Next (Act2);
13814 end loop;
13816 -- Find the associations added for default subprograms
13818 if Present (Act2) then
13819 while Nkind (Act2) /= N_Generic_Association
13820 or else No (Entity (Selector_Name (Act2)))
13821 or else not Is_Overloadable (Entity (Selector_Name (Act2)))
13822 loop
13823 Next (Act2);
13824 end loop;
13826 -- Add a similar association if the default is global. The
13827 -- renaming declaration for the actual has been analyzed, and
13828 -- its alias is the program it renames. Link the actual in the
13829 -- original generic tree with the node in the analyzed tree.
13831 while Present (Act2) loop
13832 Subp := Entity (Selector_Name (Act2));
13833 Def := Explicit_Generic_Actual_Parameter (Act2);
13835 -- Following test is defence against rubbish errors
13837 if No (Alias (Subp)) then
13838 return;
13839 end if;
13841 -- Retrieve the resolved actual from the renaming declaration
13842 -- created for the instantiated formal.
13844 Actual := Entity (Name (Parent (Parent (Subp))));
13845 Set_Entity (Def, Actual);
13846 Set_Etype (Def, Etype (Actual));
13848 if Is_Global (Actual) then
13849 Ndec :=
13850 Make_Generic_Association (Loc,
13851 Selector_Name => New_Occurrence_Of (Subp, Loc),
13852 Explicit_Generic_Actual_Parameter =>
13853 New_Occurrence_Of (Actual, Loc));
13855 Set_Associated_Node
13856 (Explicit_Generic_Actual_Parameter (Ndec), Def);
13858 Append (Ndec, Assoc1);
13860 -- If there are other defaults, add a dummy association in case
13861 -- there are other defaulted formals with the same name.
13863 elsif Present (Next (Act2)) then
13864 Ndec :=
13865 Make_Generic_Association (Loc,
13866 Selector_Name => New_Occurrence_Of (Subp, Loc),
13867 Explicit_Generic_Actual_Parameter => Empty);
13869 Append (Ndec, Assoc1);
13870 end if;
13872 Next (Act2);
13873 end loop;
13874 end if;
13876 if Nkind (Name (N1)) = N_Identifier
13877 and then Is_Child_Unit (Gen_Id)
13878 and then Is_Global (Gen_Id)
13879 and then Is_Generic_Unit (Scope (Gen_Id))
13880 and then In_Open_Scopes (Scope (Gen_Id))
13881 then
13882 -- This is an instantiation of a child unit within a sibling, so
13883 -- that the generic parent is in scope. An eventual instance must
13884 -- occur within the scope of an instance of the parent. Make name
13885 -- in instance into an expanded name, to preserve the identifier
13886 -- of the parent, so it can be resolved subsequently.
13888 Rewrite (Name (N2),
13889 Make_Expanded_Name (Loc,
13890 Chars => Chars (Gen_Id),
13891 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13892 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13893 Set_Entity (Name (N2), Gen_Id);
13895 Rewrite (Name (N1),
13896 Make_Expanded_Name (Loc,
13897 Chars => Chars (Gen_Id),
13898 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13899 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13901 Set_Associated_Node (Name (N1), Name (N2));
13902 Set_Associated_Node (Prefix (Name (N1)), Empty);
13903 Set_Associated_Node
13904 (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
13905 Set_Etype (Name (N1), Etype (Gen_Id));
13906 end if;
13908 end Save_Global_Defaults;
13910 ----------------------------
13911 -- Save_Global_Descendant --
13912 ----------------------------
13914 procedure Save_Global_Descendant (D : Union_Id) is
13915 N1 : Node_Id;
13917 begin
13918 if D in Node_Range then
13919 if D = Union_Id (Empty) then
13920 null;
13922 elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
13923 Save_References (Node_Id (D));
13924 end if;
13926 elsif D in List_Range then
13927 if D = Union_Id (No_List) or else Is_Empty_List (List_Id (D)) then
13928 null;
13930 else
13931 N1 := First (List_Id (D));
13932 while Present (N1) loop
13933 Save_References (N1);
13934 Next (N1);
13935 end loop;
13936 end if;
13938 -- Element list or other non-node field, nothing to do
13940 else
13941 null;
13942 end if;
13943 end Save_Global_Descendant;
13945 ---------------------
13946 -- Save_References --
13947 ---------------------
13949 -- This is the recursive procedure that does the work once the enclosing
13950 -- generic scope has been established. We have to treat specially a
13951 -- number of node rewritings that are required by semantic processing
13952 -- and which change the kind of nodes in the generic copy: typically
13953 -- constant-folding, replacing an operator node by a string literal, or
13954 -- a selected component by an expanded name. In each of those cases, the
13955 -- transformation is propagated to the generic unit.
13957 procedure Save_References (N : Node_Id) is
13958 Loc : constant Source_Ptr := Sloc (N);
13960 begin
13961 if N = Empty then
13962 null;
13964 elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
13965 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13966 Reset_Entity (N);
13968 elsif Nkind (N) = N_Operator_Symbol
13969 and then Nkind (Get_Associated_Node (N)) = N_String_Literal
13970 then
13971 Change_Operator_Symbol_To_String_Literal (N);
13972 end if;
13974 elsif Nkind (N) in N_Op then
13975 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13976 if Nkind (N) = N_Op_Concat then
13977 Set_Is_Component_Left_Opnd (N,
13978 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13980 Set_Is_Component_Right_Opnd (N,
13981 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13982 end if;
13984 Reset_Entity (N);
13986 else
13987 -- Node may be transformed into call to a user-defined operator
13989 N2 := Get_Associated_Node (N);
13991 if Nkind (N2) = N_Function_Call then
13992 E := Entity (Name (N2));
13994 if Present (E)
13995 and then Is_Global (E)
13996 then
13997 Set_Etype (N, Etype (N2));
13998 else
13999 Set_Associated_Node (N, Empty);
14000 Set_Etype (N, Empty);
14001 end if;
14003 elsif Nkind_In (N2, N_Integer_Literal,
14004 N_Real_Literal,
14005 N_String_Literal)
14006 then
14007 if Present (Original_Node (N2))
14008 and then Nkind (Original_Node (N2)) = Nkind (N)
14009 then
14011 -- Operation was constant-folded. Whenever possible,
14012 -- recover semantic information from unfolded node,
14013 -- for ASIS use.
14015 Set_Associated_Node (N, Original_Node (N2));
14017 if Nkind (N) = N_Op_Concat then
14018 Set_Is_Component_Left_Opnd (N,
14019 Is_Component_Left_Opnd (Get_Associated_Node (N)));
14020 Set_Is_Component_Right_Opnd (N,
14021 Is_Component_Right_Opnd (Get_Associated_Node (N)));
14022 end if;
14024 Reset_Entity (N);
14026 else
14027 -- If original node is already modified, propagate
14028 -- constant-folding to template.
14030 Rewrite (N, New_Copy (N2));
14031 Set_Analyzed (N, False);
14032 end if;
14034 elsif Nkind (N2) = N_Identifier
14035 and then Ekind (Entity (N2)) = E_Enumeration_Literal
14036 then
14037 -- Same if call was folded into a literal, but in this case
14038 -- retain the entity to avoid spurious ambiguities if it is
14039 -- overloaded at the point of instantiation or inlining.
14041 Rewrite (N, New_Copy (N2));
14042 Set_Analyzed (N, False);
14043 end if;
14044 end if;
14046 -- Complete operands check if node has not been constant-folded
14048 if Nkind (N) in N_Op then
14049 Save_Entity_Descendants (N);
14050 end if;
14052 elsif Nkind (N) = N_Identifier then
14053 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14055 -- If this is a discriminant reference, always save it. It is
14056 -- used in the instance to find the corresponding discriminant
14057 -- positionally rather than by name.
14059 Set_Original_Discriminant
14060 (N, Original_Discriminant (Get_Associated_Node (N)));
14061 Reset_Entity (N);
14063 else
14064 N2 := Get_Associated_Node (N);
14066 if Nkind (N2) = N_Function_Call then
14067 E := Entity (Name (N2));
14069 -- Name resolves to a call to parameterless function. If
14070 -- original entity is global, mark node as resolved.
14072 if Present (E)
14073 and then Is_Global (E)
14074 then
14075 Set_Etype (N, Etype (N2));
14076 else
14077 Set_Associated_Node (N, Empty);
14078 Set_Etype (N, Empty);
14079 end if;
14081 elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
14082 and then Is_Entity_Name (Original_Node (N2))
14083 then
14084 -- Name resolves to named number that is constant-folded,
14085 -- We must preserve the original name for ASIS use, and
14086 -- undo the constant-folding, which will be repeated in
14087 -- each instance.
14089 Set_Associated_Node (N, Original_Node (N2));
14090 Reset_Entity (N);
14092 elsif Nkind (N2) = N_String_Literal then
14094 -- Name resolves to string literal. Perform the same
14095 -- replacement in generic.
14097 Rewrite (N, New_Copy (N2));
14099 elsif Nkind (N2) = N_Explicit_Dereference then
14101 -- An identifier is rewritten as a dereference if it is the
14102 -- prefix in an implicit dereference (call or attribute).
14103 -- The analysis of an instantiation will expand the node
14104 -- again, so we preserve the original tree but link it to
14105 -- the resolved entity in case it is global.
14107 if Is_Entity_Name (Prefix (N2))
14108 and then Present (Entity (Prefix (N2)))
14109 and then Is_Global (Entity (Prefix (N2)))
14110 then
14111 Set_Associated_Node (N, Prefix (N2));
14113 elsif Nkind (Prefix (N2)) = N_Function_Call
14114 and then Is_Global (Entity (Name (Prefix (N2))))
14115 then
14116 Rewrite (N,
14117 Make_Explicit_Dereference (Loc,
14118 Prefix => Make_Function_Call (Loc,
14119 Name =>
14120 New_Occurrence_Of (Entity (Name (Prefix (N2))),
14121 Loc))));
14123 else
14124 Set_Associated_Node (N, Empty);
14125 Set_Etype (N, Empty);
14126 end if;
14128 -- The subtype mark of a nominally unconstrained object is
14129 -- rewritten as a subtype indication using the bounds of the
14130 -- expression. Recover the original subtype mark.
14132 elsif Nkind (N2) = N_Subtype_Indication
14133 and then Is_Entity_Name (Original_Node (N2))
14134 then
14135 Set_Associated_Node (N, Original_Node (N2));
14136 Reset_Entity (N);
14138 else
14139 null;
14140 end if;
14141 end if;
14143 elsif Nkind (N) in N_Entity then
14144 null;
14146 else
14147 declare
14148 Qual : Node_Id := Empty;
14149 Typ : Entity_Id := Empty;
14150 Nam : Node_Id;
14152 use Atree.Unchecked_Access;
14153 -- This code section is part of implementing an untyped tree
14154 -- traversal, so it needs direct access to node fields.
14156 begin
14157 if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
14158 N2 := Get_Associated_Node (N);
14160 if No (N2) then
14161 Typ := Empty;
14162 else
14163 Typ := Etype (N2);
14165 -- In an instance within a generic, use the name of the
14166 -- actual and not the original generic parameter. If the
14167 -- actual is global in the current generic it must be
14168 -- preserved for its instantiation.
14170 if Nkind (Parent (Typ)) = N_Subtype_Declaration
14171 and then
14172 Present (Generic_Parent_Type (Parent (Typ)))
14173 then
14174 Typ := Base_Type (Typ);
14175 Set_Etype (N2, Typ);
14176 end if;
14177 end if;
14179 if No (N2) or else No (Typ) or else not Is_Global (Typ) then
14180 Set_Associated_Node (N, Empty);
14182 -- If the aggregate is an actual in a call, it has been
14183 -- resolved in the current context, to some local type.
14184 -- The enclosing call may have been disambiguated by the
14185 -- aggregate, and this disambiguation might fail at
14186 -- instantiation time because the type to which the
14187 -- aggregate did resolve is not preserved. In order to
14188 -- preserve some of this information, we wrap the
14189 -- aggregate in a qualified expression, using the id of
14190 -- its type. For further disambiguation we qualify the
14191 -- type name with its scope (if visible) because both
14192 -- id's will have corresponding entities in an instance.
14193 -- This resolves most of the problems with missing type
14194 -- information on aggregates in instances.
14196 if Nkind (N2) = Nkind (N)
14197 and then Nkind (Parent (N2)) in N_Subprogram_Call
14198 and then Comes_From_Source (Typ)
14199 then
14200 if Is_Immediately_Visible (Scope (Typ)) then
14201 Nam := Make_Selected_Component (Loc,
14202 Prefix =>
14203 Make_Identifier (Loc, Chars (Scope (Typ))),
14204 Selector_Name =>
14205 Make_Identifier (Loc, Chars (Typ)));
14206 else
14207 Nam := Make_Identifier (Loc, Chars (Typ));
14208 end if;
14210 Qual :=
14211 Make_Qualified_Expression (Loc,
14212 Subtype_Mark => Nam,
14213 Expression => Relocate_Node (N));
14214 end if;
14215 end if;
14217 Save_Global_Descendant (Field1 (N));
14218 Save_Global_Descendant (Field2 (N));
14219 Save_Global_Descendant (Field3 (N));
14220 Save_Global_Descendant (Field5 (N));
14222 if Present (Qual) then
14223 Rewrite (N, Qual);
14224 end if;
14226 -- All other cases than aggregates
14228 else
14229 Save_Global_Descendant (Field1 (N));
14230 Save_Global_Descendant (Field2 (N));
14231 Save_Global_Descendant (Field3 (N));
14232 Save_Global_Descendant (Field4 (N));
14233 Save_Global_Descendant (Field5 (N));
14234 end if;
14235 end;
14236 end if;
14238 -- If a node has aspects, references within their expressions must
14239 -- be saved separately, given they are not directly in the tree.
14241 if Has_Aspects (N) then
14242 declare
14243 Aspect : Node_Id;
14245 begin
14246 Aspect := First (Aspect_Specifications (N));
14247 while Present (Aspect) loop
14248 if Present (Expression (Aspect)) then
14249 Save_Global_References (Expression (Aspect));
14250 end if;
14252 Next (Aspect);
14253 end loop;
14254 end;
14255 end if;
14256 end Save_References;
14258 -- Start of processing for Save_Global_References
14260 begin
14261 Gen_Scope := Current_Scope;
14263 -- If the generic unit is a child unit, references to entities in the
14264 -- parent are treated as local, because they will be resolved anew in
14265 -- the context of the instance of the parent.
14267 while Is_Child_Unit (Gen_Scope)
14268 and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
14269 loop
14270 Gen_Scope := Scope (Gen_Scope);
14271 end loop;
14273 Save_References (N);
14274 end Save_Global_References;
14276 --------------------------------------
14277 -- Set_Copied_Sloc_For_Inlined_Body --
14278 --------------------------------------
14280 procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
14281 begin
14282 Create_Instantiation_Source (N, E, True, S_Adjustment);
14283 end Set_Copied_Sloc_For_Inlined_Body;
14285 ---------------------
14286 -- Set_Instance_Of --
14287 ---------------------
14289 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
14290 begin
14291 Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
14292 Generic_Renamings_HTable.Set (Generic_Renamings.Last);
14293 Generic_Renamings.Increment_Last;
14294 end Set_Instance_Of;
14296 --------------------
14297 -- Set_Next_Assoc --
14298 --------------------
14300 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
14301 begin
14302 Generic_Renamings.Table (E).Next_In_HTable := Next;
14303 end Set_Next_Assoc;
14305 -------------------
14306 -- Start_Generic --
14307 -------------------
14309 procedure Start_Generic is
14310 begin
14311 -- ??? More things could be factored out in this routine.
14312 -- Should probably be done at a later stage.
14314 Generic_Flags.Append (Inside_A_Generic);
14315 Inside_A_Generic := True;
14317 Expander_Mode_Save_And_Set (False);
14318 end Start_Generic;
14320 ----------------------
14321 -- Set_Instance_Env --
14322 ----------------------
14324 procedure Set_Instance_Env
14325 (Gen_Unit : Entity_Id;
14326 Act_Unit : Entity_Id)
14328 Assertion_Status : constant Boolean := Assertions_Enabled;
14329 Save_SPARK_Mode : constant SPARK_Mode_Type := SPARK_Mode;
14330 Save_SPARK_Mode_Pragma : constant Node_Id := SPARK_Mode_Pragma;
14332 begin
14333 -- Regardless of the current mode, predefined units are analyzed in the
14334 -- most current Ada mode, and earlier version Ada checks do not apply
14335 -- to predefined units. Nothing needs to be done for non-internal units.
14336 -- These are always analyzed in the current mode.
14338 if Is_Internal_File_Name
14339 (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
14340 Renamings_Included => True)
14341 then
14342 Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
14344 -- In Ada2012 we may want to enable assertions in an instance of a
14345 -- predefined unit, in which case we need to preserve the current
14346 -- setting for the Assertions_Enabled flag. This will become more
14347 -- critical when pre/postconditions are added to predefined units,
14348 -- as is already the case for some numeric libraries.
14350 if Ada_Version >= Ada_2012 then
14351 Assertions_Enabled := Assertion_Status;
14352 end if;
14354 -- SPARK_Mode for an instance is the one applicable at the point of
14355 -- instantiation.
14357 SPARK_Mode := Save_SPARK_Mode;
14358 SPARK_Mode_Pragma := Save_SPARK_Mode_Pragma;
14359 end if;
14361 Current_Instantiated_Parent :=
14362 (Gen_Id => Gen_Unit,
14363 Act_Id => Act_Unit,
14364 Next_In_HTable => Assoc_Null);
14365 end Set_Instance_Env;
14367 -----------------
14368 -- Switch_View --
14369 -----------------
14371 procedure Switch_View (T : Entity_Id) is
14372 BT : constant Entity_Id := Base_Type (T);
14373 Priv_Elmt : Elmt_Id := No_Elmt;
14374 Priv_Sub : Entity_Id;
14376 begin
14377 -- T may be private but its base type may have been exchanged through
14378 -- some other occurrence, in which case there is nothing to switch
14379 -- besides T itself. Note that a private dependent subtype of a private
14380 -- type might not have been switched even if the base type has been,
14381 -- because of the last branch of Check_Private_View (see comment there).
14383 if not Is_Private_Type (BT) then
14384 Prepend_Elmt (Full_View (T), Exchanged_Views);
14385 Exchange_Declarations (T);
14386 return;
14387 end if;
14389 Priv_Elmt := First_Elmt (Private_Dependents (BT));
14391 if Present (Full_View (BT)) then
14392 Prepend_Elmt (Full_View (BT), Exchanged_Views);
14393 Exchange_Declarations (BT);
14394 end if;
14396 while Present (Priv_Elmt) loop
14397 Priv_Sub := (Node (Priv_Elmt));
14399 -- We avoid flipping the subtype if the Etype of its full view is
14400 -- private because this would result in a malformed subtype. This
14401 -- occurs when the Etype of the subtype full view is the full view of
14402 -- the base type (and since the base types were just switched, the
14403 -- subtype is pointing to the wrong view). This is currently the case
14404 -- for tagged record types, access types (maybe more?) and needs to
14405 -- be resolved. ???
14407 if Present (Full_View (Priv_Sub))
14408 and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
14409 then
14410 Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
14411 Exchange_Declarations (Priv_Sub);
14412 end if;
14414 Next_Elmt (Priv_Elmt);
14415 end loop;
14416 end Switch_View;
14418 -----------------
14419 -- True_Parent --
14420 -----------------
14422 function True_Parent (N : Node_Id) return Node_Id is
14423 begin
14424 if Nkind (Parent (N)) = N_Subunit then
14425 return Parent (Corresponding_Stub (Parent (N)));
14426 else
14427 return Parent (N);
14428 end if;
14429 end True_Parent;
14431 -----------------------------
14432 -- Valid_Default_Attribute --
14433 -----------------------------
14435 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
14436 Attr_Id : constant Attribute_Id :=
14437 Get_Attribute_Id (Attribute_Name (Def));
14438 T : constant Entity_Id := Entity (Prefix (Def));
14439 Is_Fun : constant Boolean := (Ekind (Nam) = E_Function);
14440 F : Entity_Id;
14441 Num_F : Int;
14442 OK : Boolean;
14444 begin
14445 if No (T) or else T = Any_Id then
14446 return;
14447 end if;
14449 Num_F := 0;
14450 F := First_Formal (Nam);
14451 while Present (F) loop
14452 Num_F := Num_F + 1;
14453 Next_Formal (F);
14454 end loop;
14456 case Attr_Id is
14457 when Attribute_Adjacent | Attribute_Ceiling | Attribute_Copy_Sign |
14458 Attribute_Floor | Attribute_Fraction | Attribute_Machine |
14459 Attribute_Model | Attribute_Remainder | Attribute_Rounding |
14460 Attribute_Unbiased_Rounding =>
14461 OK := Is_Fun
14462 and then Num_F = 1
14463 and then Is_Floating_Point_Type (T);
14465 when Attribute_Image | Attribute_Pred | Attribute_Succ |
14466 Attribute_Value | Attribute_Wide_Image |
14467 Attribute_Wide_Value =>
14468 OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
14470 when Attribute_Max | Attribute_Min =>
14471 OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
14473 when Attribute_Input =>
14474 OK := (Is_Fun and then Num_F = 1);
14476 when Attribute_Output | Attribute_Read | Attribute_Write =>
14477 OK := (not Is_Fun and then Num_F = 2);
14479 when others =>
14480 OK := False;
14481 end case;
14483 if not OK then
14484 Error_Msg_N ("attribute reference has wrong profile for subprogram",
14485 Def);
14486 end if;
14487 end Valid_Default_Attribute;
14489 end Sem_Ch12;