2014-10-31 Ed Schonberg <schonberg@adacore.com>
[official-gcc.git] / gcc / ada / sem_ch12.adb
blob0cf67c6fad295c4f6c9dfb9939e30e7bb34fe11c
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;
3441 -- If there is a specified storage pool in the context, create an
3442 -- aspect on the package declaration, so that it is used in any
3443 -- instance that does not override it.
3445 if Present (Default_Pool) then
3446 declare
3447 ASN : Node_Id;
3449 begin
3450 ASN := Make_Aspect_Specification (Loc,
3451 Identifier => Make_Identifier (Loc, Name_Default_Storage_Pool),
3452 Expression => New_Copy (Default_Pool));
3454 if No (Aspect_Specifications (Specification (N))) then
3455 Set_Aspect_Specifications (Specification (N), New_List (ASN));
3456 else
3457 Append (ASN, Aspect_Specifications (Specification (N)));
3458 end if;
3459 end;
3460 end if;
3461 end Analyze_Generic_Package_Declaration;
3463 --------------------------------------------
3464 -- Analyze_Generic_Subprogram_Declaration --
3465 --------------------------------------------
3467 procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
3468 Spec : Node_Id;
3469 Id : Entity_Id;
3470 Formals : List_Id;
3471 New_N : Node_Id;
3472 Result_Type : Entity_Id;
3473 Save_Parent : Node_Id;
3474 Typ : Entity_Id;
3476 begin
3477 Check_SPARK_05_Restriction ("generic is not allowed", N);
3479 -- Create copy of generic unit, and save for instantiation. If the unit
3480 -- is a child unit, do not copy the specifications for the parent, which
3481 -- are not part of the generic tree.
3483 Save_Parent := Parent_Spec (N);
3484 Set_Parent_Spec (N, Empty);
3486 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3487 Set_Parent_Spec (New_N, Save_Parent);
3488 Rewrite (N, New_N);
3490 -- Once the contents of the generic copy and the template are swapped,
3491 -- do the same for their respective aspect specifications.
3493 Exchange_Aspects (N, New_N);
3495 Spec := Specification (N);
3496 Id := Defining_Entity (Spec);
3497 Generate_Definition (Id);
3498 Set_Contract (Id, Make_Contract (Sloc (Id)));
3500 if Nkind (Id) = N_Defining_Operator_Symbol then
3501 Error_Msg_N
3502 ("operator symbol not allowed for generic subprogram", Id);
3503 end if;
3505 Start_Generic;
3507 Enter_Name (Id);
3508 Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
3510 -- Analyze the aspects of the generic copy to ensure that all generated
3511 -- pragmas (if any) perform their semantic effects.
3513 if Has_Aspects (N) then
3514 Analyze_Aspect_Specifications (N, Id);
3515 end if;
3517 Push_Scope (Id);
3518 Enter_Generic_Scope (Id);
3519 Set_Inner_Instances (Id, New_Elmt_List);
3520 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3522 Analyze_Generic_Formal_Part (N);
3524 Formals := Parameter_Specifications (Spec);
3526 if Present (Formals) then
3527 Process_Formals (Formals, Spec);
3528 end if;
3530 if Nkind (Spec) = N_Function_Specification then
3531 Set_Ekind (Id, E_Generic_Function);
3533 if Nkind (Result_Definition (Spec)) = N_Access_Definition then
3534 Result_Type := Access_Definition (Spec, Result_Definition (Spec));
3535 Set_Etype (Id, Result_Type);
3537 -- Check restriction imposed by AI05-073: a generic function
3538 -- cannot return an abstract type or an access to such.
3540 -- This is a binding interpretation should it apply to earlier
3541 -- versions of Ada as well as Ada 2012???
3543 if Is_Abstract_Type (Designated_Type (Result_Type))
3544 and then Ada_Version >= Ada_2012
3545 then
3546 Error_Msg_N ("generic function cannot have an access result"
3547 & " that designates an abstract type", Spec);
3548 end if;
3550 else
3551 Find_Type (Result_Definition (Spec));
3552 Typ := Entity (Result_Definition (Spec));
3554 if Is_Abstract_Type (Typ)
3555 and then Ada_Version >= Ada_2012
3556 then
3557 Error_Msg_N
3558 ("generic function cannot have abstract result type", Spec);
3559 end if;
3561 -- If a null exclusion is imposed on the result type, then create
3562 -- a null-excluding itype (an access subtype) and use it as the
3563 -- function's Etype.
3565 if Is_Access_Type (Typ)
3566 and then Null_Exclusion_Present (Spec)
3567 then
3568 Set_Etype (Id,
3569 Create_Null_Excluding_Itype
3570 (T => Typ,
3571 Related_Nod => Spec,
3572 Scope_Id => Defining_Unit_Name (Spec)));
3573 else
3574 Set_Etype (Id, Typ);
3575 end if;
3576 end if;
3578 else
3579 Set_Ekind (Id, E_Generic_Procedure);
3580 Set_Etype (Id, Standard_Void_Type);
3581 end if;
3583 -- For a library unit, we have reconstructed the entity for the unit,
3584 -- and must reset it in the library tables. We also make sure that
3585 -- Body_Required is set properly in the original compilation unit node.
3587 if Nkind (Parent (N)) = N_Compilation_Unit then
3588 Set_Cunit_Entity (Current_Sem_Unit, Id);
3589 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3590 end if;
3592 Set_Categorization_From_Pragmas (N);
3593 Validate_Categorization_Dependency (N, Id);
3595 Save_Global_References (Original_Node (N));
3597 -- For ASIS purposes, convert any postcondition, precondition pragmas
3598 -- into aspects, if N is not a compilation unit by itself, in order to
3599 -- enable the analysis of expressions inside the corresponding PPC
3600 -- pragmas.
3602 if ASIS_Mode and then Is_List_Member (N) then
3603 Make_Aspect_For_PPC_In_Gen_Sub_Decl (N);
3604 end if;
3606 End_Generic;
3607 End_Scope;
3608 Exit_Generic_Scope (Id);
3609 Generate_Reference_To_Formals (Id);
3611 List_Inherited_Pre_Post_Aspects (Id);
3612 end Analyze_Generic_Subprogram_Declaration;
3614 -----------------------------------
3615 -- Analyze_Package_Instantiation --
3616 -----------------------------------
3618 procedure Analyze_Package_Instantiation (N : Node_Id) is
3619 Loc : constant Source_Ptr := Sloc (N);
3620 Gen_Id : constant Node_Id := Name (N);
3622 Act_Decl : Node_Id;
3623 Act_Decl_Name : Node_Id;
3624 Act_Decl_Id : Entity_Id;
3625 Act_Spec : Node_Id;
3626 Act_Tree : Node_Id;
3628 Gen_Decl : Node_Id;
3629 Gen_Spec : Node_Id;
3630 Gen_Unit : Entity_Id;
3632 Is_Actual_Pack : constant Boolean :=
3633 Is_Internal (Defining_Entity (N));
3635 Env_Installed : Boolean := False;
3636 Parent_Installed : Boolean := False;
3637 Renaming_List : List_Id;
3638 Unit_Renaming : Node_Id;
3639 Needs_Body : Boolean;
3640 Inline_Now : Boolean := False;
3642 Save_IPSM : constant Boolean := Ignore_Pragma_SPARK_Mode;
3643 -- Save flag Ignore_Pragma_SPARK_Mode for restore on exit
3645 Save_SM : constant SPARK_Mode_Type := SPARK_Mode;
3646 Save_SMP : constant Node_Id := SPARK_Mode_Pragma;
3647 -- Save the SPARK_Mode-related data for restore on exit
3649 Save_Style_Check : constant Boolean := Style_Check;
3650 -- Save style check mode for restore on exit
3652 procedure Delay_Descriptors (E : Entity_Id);
3653 -- Delay generation of subprogram descriptors for given entity
3655 function Might_Inline_Subp return Boolean;
3656 -- If inlining is active and the generic contains inlined subprograms,
3657 -- we instantiate the body. This may cause superfluous instantiations,
3658 -- but it is simpler than detecting the need for the body at the point
3659 -- of inlining, when the context of the instance is not available.
3661 -----------------------
3662 -- Delay_Descriptors --
3663 -----------------------
3665 procedure Delay_Descriptors (E : Entity_Id) is
3666 begin
3667 if not Delay_Subprogram_Descriptors (E) then
3668 Set_Delay_Subprogram_Descriptors (E);
3669 Pending_Descriptor.Append (E);
3670 end if;
3671 end Delay_Descriptors;
3673 -----------------------
3674 -- Might_Inline_Subp --
3675 -----------------------
3677 function Might_Inline_Subp return Boolean is
3678 E : Entity_Id;
3680 begin
3681 if not Inline_Processing_Required then
3682 return False;
3684 else
3685 E := First_Entity (Gen_Unit);
3686 while Present (E) loop
3687 if Is_Subprogram (E) and then Is_Inlined (E) then
3688 return True;
3689 end if;
3691 Next_Entity (E);
3692 end loop;
3693 end if;
3695 return False;
3696 end Might_Inline_Subp;
3698 -- Local declarations
3700 Vis_Prims_List : Elist_Id := No_Elist;
3701 -- List of primitives made temporarily visible in the instantiation
3702 -- to match the visibility of the formal type
3704 -- Start of processing for Analyze_Package_Instantiation
3706 begin
3707 Check_SPARK_05_Restriction ("generic is not allowed", N);
3709 -- Very first thing: check for Text_IO sp[ecial unit in case we are
3710 -- instantiating one of the children of [[Wide_]Wide_]Text_IO.
3712 Check_Text_IO_Special_Unit (Name (N));
3714 -- Make node global for error reporting
3716 Instantiation_Node := N;
3718 -- Turn off style checking in instances. If the check is enabled on the
3719 -- generic unit, a warning in an instance would just be noise. If not
3720 -- enabled on the generic, then a warning in an instance is just wrong.
3722 Style_Check := False;
3724 -- Case of instantiation of a generic package
3726 if Nkind (N) = N_Package_Instantiation then
3727 Act_Decl_Id := New_Copy (Defining_Entity (N));
3728 Set_Comes_From_Source (Act_Decl_Id, True);
3730 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3731 Act_Decl_Name :=
3732 Make_Defining_Program_Unit_Name (Loc,
3733 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
3734 Defining_Identifier => Act_Decl_Id);
3735 else
3736 Act_Decl_Name := Act_Decl_Id;
3737 end if;
3739 -- Case of instantiation of a formal package
3741 else
3742 Act_Decl_Id := Defining_Identifier (N);
3743 Act_Decl_Name := Act_Decl_Id;
3744 end if;
3746 Generate_Definition (Act_Decl_Id);
3747 Preanalyze_Actuals (N);
3749 Init_Env;
3750 Env_Installed := True;
3752 -- Reset renaming map for formal types. The mapping is established
3753 -- when analyzing the generic associations, but some mappings are
3754 -- inherited from formal packages of parent units, and these are
3755 -- constructed when the parents are installed.
3757 Generic_Renamings.Set_Last (0);
3758 Generic_Renamings_HTable.Reset;
3760 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3761 Gen_Unit := Entity (Gen_Id);
3763 -- Verify that it is the name of a generic package
3765 -- A visibility glitch: if the instance is a child unit and the generic
3766 -- is the generic unit of a parent instance (i.e. both the parent and
3767 -- the child units are instances of the same package) the name now
3768 -- denotes the renaming within the parent, not the intended generic
3769 -- unit. See if there is a homonym that is the desired generic. The
3770 -- renaming declaration must be visible inside the instance of the
3771 -- child, but not when analyzing the name in the instantiation itself.
3773 if Ekind (Gen_Unit) = E_Package
3774 and then Present (Renamed_Entity (Gen_Unit))
3775 and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3776 and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3777 and then Present (Homonym (Gen_Unit))
3778 then
3779 Gen_Unit := Homonym (Gen_Unit);
3780 end if;
3782 if Etype (Gen_Unit) = Any_Type then
3783 Restore_Env;
3784 goto Leave;
3786 elsif Ekind (Gen_Unit) /= E_Generic_Package then
3788 -- Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3790 if From_Limited_With (Gen_Unit) then
3791 Error_Msg_N
3792 ("cannot instantiate a limited withed package", Gen_Id);
3793 else
3794 Error_Msg_NE
3795 ("& is not the name of a generic package", Gen_Id, Gen_Unit);
3796 end if;
3798 Restore_Env;
3799 goto Leave;
3800 end if;
3802 if In_Extended_Main_Source_Unit (N) then
3803 Set_Is_Instantiated (Gen_Unit);
3804 Generate_Reference (Gen_Unit, N);
3806 if Present (Renamed_Object (Gen_Unit)) then
3807 Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3808 Generate_Reference (Renamed_Object (Gen_Unit), N);
3809 end if;
3810 end if;
3812 if Nkind (Gen_Id) = N_Identifier
3813 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3814 then
3815 Error_Msg_NE
3816 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3818 elsif Nkind (Gen_Id) = N_Expanded_Name
3819 and then Is_Child_Unit (Gen_Unit)
3820 and then Nkind (Prefix (Gen_Id)) = N_Identifier
3821 and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3822 then
3823 Error_Msg_N
3824 ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3825 end if;
3827 Set_Entity (Gen_Id, Gen_Unit);
3829 -- If generic is a renaming, get original generic unit
3831 if Present (Renamed_Object (Gen_Unit))
3832 and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3833 then
3834 Gen_Unit := Renamed_Object (Gen_Unit);
3835 end if;
3837 -- Verify that there are no circular instantiations
3839 if In_Open_Scopes (Gen_Unit) then
3840 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3841 Restore_Env;
3842 goto Leave;
3844 elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3845 Error_Msg_Node_2 := Current_Scope;
3846 Error_Msg_NE
3847 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3848 Circularity_Detected := True;
3849 Restore_Env;
3850 goto Leave;
3852 else
3853 -- If the context of the instance is subject to SPARK_Mode "off",
3854 -- set the global flag which signals Analyze_Pragma to ignore all
3855 -- SPARK_Mode pragmas within the instance.
3857 if SPARK_Mode = Off then
3858 Ignore_Pragma_SPARK_Mode := True;
3859 end if;
3861 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3862 Gen_Spec := Specification (Gen_Decl);
3864 -- Initialize renamings map, for error checking, and the list that
3865 -- holds private entities whose views have changed between generic
3866 -- definition and instantiation. If this is the instance created to
3867 -- validate an actual package, the instantiation environment is that
3868 -- of the enclosing instance.
3870 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3872 -- Copy original generic tree, to produce text for instantiation
3874 Act_Tree :=
3875 Copy_Generic_Node
3876 (Original_Node (Gen_Decl), Empty, Instantiating => True);
3878 Act_Spec := Specification (Act_Tree);
3880 -- If this is the instance created to validate an actual package,
3881 -- only the formals matter, do not examine the package spec itself.
3883 if Is_Actual_Pack then
3884 Set_Visible_Declarations (Act_Spec, New_List);
3885 Set_Private_Declarations (Act_Spec, New_List);
3886 end if;
3888 Renaming_List :=
3889 Analyze_Associations
3890 (I_Node => N,
3891 Formals => Generic_Formal_Declarations (Act_Tree),
3892 F_Copy => Generic_Formal_Declarations (Gen_Decl));
3894 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
3896 Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3897 Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3898 Set_Is_Generic_Instance (Act_Decl_Id);
3899 Set_Generic_Parent (Act_Spec, Gen_Unit);
3901 -- References to the generic in its own declaration or its body are
3902 -- references to the instance. Add a renaming declaration for the
3903 -- generic unit itself. This declaration, as well as the renaming
3904 -- declarations for the generic formals, must remain private to the
3905 -- unit: the formals, because this is the language semantics, and
3906 -- the unit because its use is an artifact of the implementation.
3908 Unit_Renaming :=
3909 Make_Package_Renaming_Declaration (Loc,
3910 Defining_Unit_Name =>
3911 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3912 Name => New_Occurrence_Of (Act_Decl_Id, Loc));
3914 Append (Unit_Renaming, Renaming_List);
3916 -- The renaming declarations are the first local declarations of the
3917 -- new unit.
3919 if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3920 Insert_List_Before
3921 (First (Visible_Declarations (Act_Spec)), Renaming_List);
3922 else
3923 Set_Visible_Declarations (Act_Spec, Renaming_List);
3924 end if;
3926 Act_Decl := Make_Package_Declaration (Loc, Specification => Act_Spec);
3928 -- Propagate the aspect specifications from the package declaration
3929 -- template to the instantiated version of the package declaration.
3931 if Has_Aspects (Act_Tree) then
3932 Set_Aspect_Specifications (Act_Decl,
3933 New_Copy_List_Tree (Aspect_Specifications (Act_Tree)));
3934 end if;
3936 -- The generic may have a generated Default_Storage_Pool aspect,
3937 -- set at the point of generic declaration. If the instance has
3938 -- that aspect, it overrides the one inherited from the generic.
3940 if Has_Aspects (Gen_Spec) then
3941 if No (Aspect_Specifications (N)) then
3942 Set_Aspect_Specifications (N,
3943 (New_Copy_List_Tree
3944 (Aspect_Specifications (Gen_Spec))));
3946 else
3947 declare
3948 ASN1, ASN2 : Node_Id;
3950 begin
3951 ASN1 := First (Aspect_Specifications (N));
3952 while Present (ASN1) loop
3953 if Chars (Identifier (ASN1))
3954 = Name_Default_Storage_Pool
3955 then
3956 -- If generic carries a default storage pool, remove
3957 -- it in favor of the instance one.
3959 ASN2 := First (Aspect_Specifications (Gen_Spec));
3960 while Present (ASN2) loop
3961 if Chars (Identifier (ASN2))
3962 = Name_Default_Storage_Pool
3963 then
3964 Remove (ASN2);
3965 exit;
3966 end if;
3968 Next (ASN2);
3969 end loop;
3970 end if;
3972 Next (ASN1);
3973 end loop;
3975 Prepend_List_To (Aspect_Specifications (N),
3976 (New_Copy_List_Tree
3977 (Aspect_Specifications (Gen_Spec))));
3978 end;
3979 end if;
3980 end if;
3982 -- Save the instantiation node, for subsequent instantiation of the
3983 -- body, if there is one and we are generating code for the current
3984 -- unit. Mark unit as having a body (avoids premature error message).
3986 -- We instantiate the body if we are generating code, if we are
3987 -- generating cross-reference information, or if we are building
3988 -- trees for ASIS use or GNATprove use.
3990 declare
3991 Enclosing_Body_Present : Boolean := False;
3992 -- If the generic unit is not a compilation unit, then a body may
3993 -- be present in its parent even if none is required. We create a
3994 -- tentative pending instantiation for the body, which will be
3995 -- discarded if none is actually present.
3997 Scop : Entity_Id;
3999 begin
4000 if Scope (Gen_Unit) /= Standard_Standard
4001 and then not Is_Child_Unit (Gen_Unit)
4002 then
4003 Scop := Scope (Gen_Unit);
4005 while Present (Scop)
4006 and then Scop /= Standard_Standard
4007 loop
4008 if Unit_Requires_Body (Scop) then
4009 Enclosing_Body_Present := True;
4010 exit;
4012 elsif In_Open_Scopes (Scop)
4013 and then In_Package_Body (Scop)
4014 then
4015 Enclosing_Body_Present := True;
4016 exit;
4017 end if;
4019 exit when Is_Compilation_Unit (Scop);
4020 Scop := Scope (Scop);
4021 end loop;
4022 end if;
4024 -- If front-end inlining is enabled, and this is a unit for which
4025 -- code will be generated, we instantiate the body at once.
4027 -- This is done if the instance is not the main unit, and if the
4028 -- generic is not a child unit of another generic, to avoid scope
4029 -- problems and the reinstallation of parent instances.
4031 if Expander_Active
4032 and then (not Is_Child_Unit (Gen_Unit)
4033 or else not Is_Generic_Unit (Scope (Gen_Unit)))
4034 and then Might_Inline_Subp
4035 and then not Is_Actual_Pack
4036 then
4037 if not Back_End_Inlining
4038 and then Front_End_Inlining
4039 and then (Is_In_Main_Unit (N)
4040 or else In_Main_Context (Current_Scope))
4041 and then Nkind (Parent (N)) /= N_Compilation_Unit
4042 then
4043 Inline_Now := True;
4045 -- In configurable_run_time mode we force the inlining of
4046 -- predefined subprograms marked Inline_Always, to minimize
4047 -- the use of the run-time library.
4049 elsif Is_Predefined_File_Name
4050 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
4051 and then Configurable_Run_Time_Mode
4052 and then Nkind (Parent (N)) /= N_Compilation_Unit
4053 then
4054 Inline_Now := True;
4055 end if;
4057 -- If the current scope is itself an instance within a child
4058 -- unit, there will be duplications in the scope stack, and the
4059 -- unstacking mechanism in Inline_Instance_Body will fail.
4060 -- This loses some rare cases of optimization, and might be
4061 -- improved some day, if we can find a proper abstraction for
4062 -- "the complete compilation context" that can be saved and
4063 -- restored. ???
4065 if Is_Generic_Instance (Current_Scope) then
4066 declare
4067 Curr_Unit : constant Entity_Id :=
4068 Cunit_Entity (Current_Sem_Unit);
4069 begin
4070 if Curr_Unit /= Current_Scope
4071 and then Is_Child_Unit (Curr_Unit)
4072 then
4073 Inline_Now := False;
4074 end if;
4075 end;
4076 end if;
4077 end if;
4079 Needs_Body :=
4080 (Unit_Requires_Body (Gen_Unit)
4081 or else Enclosing_Body_Present
4082 or else Present (Corresponding_Body (Gen_Decl)))
4083 and then (Is_In_Main_Unit (N) or else Might_Inline_Subp)
4084 and then not Is_Actual_Pack
4085 and then not Inline_Now
4086 and then (Operating_Mode = Generate_Code
4088 -- Need comment for this check ???
4090 or else (Operating_Mode = Check_Semantics
4091 and then (ASIS_Mode or GNATprove_Mode)));
4093 -- If front_end_inlining is enabled, do not instantiate body if
4094 -- within a generic context.
4096 if (Front_End_Inlining and then not Expander_Active)
4097 or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
4098 then
4099 Needs_Body := False;
4100 end if;
4102 -- If the current context is generic, and the package being
4103 -- instantiated is declared within a formal package, there is no
4104 -- body to instantiate until the enclosing generic is instantiated
4105 -- and there is an actual for the formal package. If the formal
4106 -- package has parameters, we build a regular package instance for
4107 -- it, that precedes the original formal package declaration.
4109 if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
4110 declare
4111 Decl : constant Node_Id :=
4112 Original_Node
4113 (Unit_Declaration_Node (Scope (Gen_Unit)));
4114 begin
4115 if Nkind (Decl) = N_Formal_Package_Declaration
4116 or else (Nkind (Decl) = N_Package_Declaration
4117 and then Is_List_Member (Decl)
4118 and then Present (Next (Decl))
4119 and then
4120 Nkind (Next (Decl)) =
4121 N_Formal_Package_Declaration)
4122 then
4123 Needs_Body := False;
4124 end if;
4125 end;
4126 end if;
4127 end;
4129 -- For RCI unit calling stubs, we omit the instance body if the
4130 -- instance is the RCI library unit itself.
4132 -- However there is a special case for nested instances: in this case
4133 -- we do generate the instance body, as it might be required, e.g.
4134 -- because it provides stream attributes for some type used in the
4135 -- profile of a remote subprogram. This is consistent with 12.3(12),
4136 -- which indicates that the instance body occurs at the place of the
4137 -- instantiation, and thus is part of the RCI declaration, which is
4138 -- present on all client partitions (this is E.2.3(18)).
4140 -- Note that AI12-0002 may make it illegal at some point to have
4141 -- stream attributes defined in an RCI unit, in which case this
4142 -- special case will become unnecessary. In the meantime, there
4143 -- is known application code in production that depends on this
4144 -- being possible, so we definitely cannot eliminate the body in
4145 -- the case of nested instances for the time being.
4147 -- When we generate a nested instance body, calling stubs for any
4148 -- relevant subprogram will be be inserted immediately after the
4149 -- subprogram declarations, and will take precedence over the
4150 -- subsequent (original) body. (The stub and original body will be
4151 -- complete homographs, but this is permitted in an instance).
4152 -- (Could we do better and remove the original body???)
4154 if Distribution_Stub_Mode = Generate_Caller_Stub_Body
4155 and then Comes_From_Source (N)
4156 and then Nkind (Parent (N)) = N_Compilation_Unit
4157 then
4158 Needs_Body := False;
4159 end if;
4161 if Needs_Body then
4163 -- Here is a defence against a ludicrous number of instantiations
4164 -- caused by a circular set of instantiation attempts.
4166 if Pending_Instantiations.Last > Maximum_Instantiations then
4167 Error_Msg_Uint_1 := UI_From_Int (Maximum_Instantiations);
4168 Error_Msg_N ("too many instantiations, exceeds max of^", N);
4169 Error_Msg_N ("\limit can be changed using -gnateinn switch", N);
4170 raise Unrecoverable_Error;
4171 end if;
4173 -- Indicate that the enclosing scopes contain an instantiation,
4174 -- and that cleanup actions should be delayed until after the
4175 -- instance body is expanded.
4177 Check_Forward_Instantiation (Gen_Decl);
4178 if Nkind (N) = N_Package_Instantiation then
4179 declare
4180 Enclosing_Master : Entity_Id;
4182 begin
4183 -- Loop to search enclosing masters
4185 Enclosing_Master := Current_Scope;
4186 Scope_Loop : while Enclosing_Master /= Standard_Standard loop
4187 if Ekind (Enclosing_Master) = E_Package then
4188 if Is_Compilation_Unit (Enclosing_Master) then
4189 if In_Package_Body (Enclosing_Master) then
4190 Delay_Descriptors
4191 (Body_Entity (Enclosing_Master));
4192 else
4193 Delay_Descriptors
4194 (Enclosing_Master);
4195 end if;
4197 exit Scope_Loop;
4199 else
4200 Enclosing_Master := Scope (Enclosing_Master);
4201 end if;
4203 elsif Is_Generic_Unit (Enclosing_Master)
4204 or else Ekind (Enclosing_Master) = E_Void
4205 then
4206 -- Cleanup actions will eventually be performed on the
4207 -- enclosing subprogram or package instance, if any.
4208 -- Enclosing scope is void in the formal part of a
4209 -- generic subprogram.
4211 exit Scope_Loop;
4213 else
4214 if Ekind (Enclosing_Master) = E_Entry
4215 and then
4216 Ekind (Scope (Enclosing_Master)) = E_Protected_Type
4217 then
4218 if not Expander_Active then
4219 exit Scope_Loop;
4220 else
4221 Enclosing_Master :=
4222 Protected_Body_Subprogram (Enclosing_Master);
4223 end if;
4224 end if;
4226 Set_Delay_Cleanups (Enclosing_Master);
4228 while Ekind (Enclosing_Master) = E_Block loop
4229 Enclosing_Master := Scope (Enclosing_Master);
4230 end loop;
4232 if Is_Subprogram (Enclosing_Master) then
4233 Delay_Descriptors (Enclosing_Master);
4235 elsif Is_Task_Type (Enclosing_Master) then
4236 declare
4237 TBP : constant Node_Id :=
4238 Get_Task_Body_Procedure
4239 (Enclosing_Master);
4240 begin
4241 if Present (TBP) then
4242 Delay_Descriptors (TBP);
4243 Set_Delay_Cleanups (TBP);
4244 end if;
4245 end;
4246 end if;
4248 exit Scope_Loop;
4249 end if;
4250 end loop Scope_Loop;
4251 end;
4253 -- Make entry in table
4255 Pending_Instantiations.Append
4256 ((Inst_Node => N,
4257 Act_Decl => Act_Decl,
4258 Expander_Status => Expander_Active,
4259 Current_Sem_Unit => Current_Sem_Unit,
4260 Scope_Suppress => Scope_Suppress,
4261 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4262 Version => Ada_Version,
4263 Version_Pragma => Ada_Version_Pragma,
4264 Warnings => Save_Warnings,
4265 SPARK_Mode => SPARK_Mode,
4266 SPARK_Mode_Pragma => SPARK_Mode_Pragma));
4267 end if;
4268 end if;
4270 Set_Categorization_From_Pragmas (Act_Decl);
4272 if Parent_Installed then
4273 Hide_Current_Scope;
4274 end if;
4276 Set_Instance_Spec (N, Act_Decl);
4278 -- If not a compilation unit, insert the package declaration before
4279 -- the original instantiation node.
4281 if Nkind (Parent (N)) /= N_Compilation_Unit then
4282 Mark_Rewrite_Insertion (Act_Decl);
4283 Insert_Before (N, Act_Decl);
4285 if Has_Aspects (N) then
4286 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4288 -- The pragma created for a Default_Storage_Pool aspect must
4289 -- appear ahead of the declarations in the instance spec.
4290 -- Analysis has placed it after the instance node, so remove
4291 -- it and reinsert it properly now.
4293 declare
4294 ASN : constant Node_Id := First (Aspect_Specifications (N));
4295 A_Name : constant Name_Id := Chars (Identifier (ASN));
4296 Decl : Node_Id;
4298 begin
4299 if A_Name = Name_Default_Storage_Pool then
4300 if No (Visible_Declarations (Act_Spec)) then
4301 Set_Visible_Declarations (Act_Spec, New_List);
4302 end if;
4304 Decl := Next (N);
4305 while Present (Decl) loop
4306 if Nkind (Decl) = N_Pragma then
4307 Remove (Decl);
4308 Prepend (Decl, Visible_Declarations (Act_Spec));
4309 exit;
4310 end if;
4312 Next (Decl);
4313 end loop;
4314 end if;
4315 end;
4316 end if;
4318 Analyze (Act_Decl);
4320 -- For an instantiation that is a compilation unit, place
4321 -- declaration on current node so context is complete for analysis
4322 -- (including nested instantiations). If this is the main unit,
4323 -- the declaration eventually replaces the instantiation node.
4324 -- If the instance body is created later, it replaces the
4325 -- instance node, and the declaration is attached to it
4326 -- (see Build_Instance_Compilation_Unit_Nodes).
4328 else
4329 if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
4331 -- The entity for the current unit is the newly created one,
4332 -- and all semantic information is attached to it.
4334 Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
4336 -- If this is the main unit, replace the main entity as well
4338 if Current_Sem_Unit = Main_Unit then
4339 Main_Unit_Entity := Act_Decl_Id;
4340 end if;
4341 end if;
4343 Set_Unit (Parent (N), Act_Decl);
4344 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
4345 Set_Package_Instantiation (Act_Decl_Id, N);
4347 -- Process aspect specifications of the instance node, if any, to
4348 -- take into account categorization pragmas before analyzing the
4349 -- instance.
4351 if Has_Aspects (N) then
4352 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4353 end if;
4355 Analyze (Act_Decl);
4356 Set_Unit (Parent (N), N);
4357 Set_Body_Required (Parent (N), False);
4359 -- We never need elaboration checks on instantiations, since by
4360 -- definition, the body instantiation is elaborated at the same
4361 -- time as the spec instantiation.
4363 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4364 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4365 end if;
4367 Check_Elab_Instantiation (N);
4369 if ABE_Is_Certain (N) and then Needs_Body then
4370 Pending_Instantiations.Decrement_Last;
4371 end if;
4373 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4375 Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
4376 First_Private_Entity (Act_Decl_Id));
4378 -- If the instantiation will receive a body, the unit will be
4379 -- transformed into a package body, and receive its own elaboration
4380 -- entity. Otherwise, the nature of the unit is now a package
4381 -- declaration.
4383 if Nkind (Parent (N)) = N_Compilation_Unit
4384 and then not Needs_Body
4385 then
4386 Rewrite (N, Act_Decl);
4387 end if;
4389 if Present (Corresponding_Body (Gen_Decl))
4390 or else Unit_Requires_Body (Gen_Unit)
4391 then
4392 Set_Has_Completion (Act_Decl_Id);
4393 end if;
4395 Check_Formal_Packages (Act_Decl_Id);
4397 Restore_Hidden_Primitives (Vis_Prims_List);
4398 Restore_Private_Views (Act_Decl_Id);
4400 Inherit_Context (Gen_Decl, N);
4402 if Parent_Installed then
4403 Remove_Parent;
4404 end if;
4406 Restore_Env;
4407 Env_Installed := False;
4408 end if;
4410 Validate_Categorization_Dependency (N, Act_Decl_Id);
4412 -- There used to be a check here to prevent instantiations in local
4413 -- contexts if the No_Local_Allocators restriction was active. This
4414 -- check was removed by a binding interpretation in AI-95-00130/07,
4415 -- but we retain the code for documentation purposes.
4417 -- if Ekind (Act_Decl_Id) /= E_Void
4418 -- and then not Is_Library_Level_Entity (Act_Decl_Id)
4419 -- then
4420 -- Check_Restriction (No_Local_Allocators, N);
4421 -- end if;
4423 if Inline_Now then
4424 Inline_Instance_Body (N, Gen_Unit, Act_Decl);
4425 end if;
4427 -- The following is a tree patch for ASIS: ASIS needs separate nodes to
4428 -- be used as defining identifiers for a formal package and for the
4429 -- corresponding expanded package.
4431 if Nkind (N) = N_Formal_Package_Declaration then
4432 Act_Decl_Id := New_Copy (Defining_Entity (N));
4433 Set_Comes_From_Source (Act_Decl_Id, True);
4434 Set_Is_Generic_Instance (Act_Decl_Id, False);
4435 Set_Defining_Identifier (N, Act_Decl_Id);
4436 end if;
4438 Ignore_Pragma_SPARK_Mode := Save_IPSM;
4439 SPARK_Mode := Save_SM;
4440 SPARK_Mode_Pragma := Save_SMP;
4441 Style_Check := Save_Style_Check;
4443 -- Check that if N is an instantiation of System.Dim_Float_IO or
4444 -- System.Dim_Integer_IO, the formal type has a dimension system.
4446 if Nkind (N) = N_Package_Instantiation
4447 and then Is_Dim_IO_Package_Instantiation (N)
4448 then
4449 declare
4450 Assoc : constant Node_Id := First (Generic_Associations (N));
4451 begin
4452 if not Has_Dimension_System
4453 (Etype (Explicit_Generic_Actual_Parameter (Assoc)))
4454 then
4455 Error_Msg_N ("type with a dimension system expected", Assoc);
4456 end if;
4457 end;
4458 end if;
4460 <<Leave>>
4461 if Has_Aspects (N) and then Nkind (Parent (N)) /= N_Compilation_Unit then
4462 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4463 end if;
4465 exception
4466 when Instantiation_Error =>
4467 if Parent_Installed then
4468 Remove_Parent;
4469 end if;
4471 if Env_Installed then
4472 Restore_Env;
4473 end if;
4475 Ignore_Pragma_SPARK_Mode := Save_IPSM;
4476 SPARK_Mode := Save_SM;
4477 SPARK_Mode_Pragma := Save_SMP;
4478 Style_Check := Save_Style_Check;
4479 end Analyze_Package_Instantiation;
4481 --------------------------
4482 -- Inline_Instance_Body --
4483 --------------------------
4485 procedure Inline_Instance_Body
4486 (N : Node_Id;
4487 Gen_Unit : Entity_Id;
4488 Act_Decl : Node_Id)
4490 Curr_Comp : constant Node_Id := Cunit (Current_Sem_Unit);
4491 Curr_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
4492 Gen_Comp : constant Entity_Id :=
4493 Cunit_Entity (Get_Source_Unit (Gen_Unit));
4495 Save_SM : constant SPARK_Mode_Type := SPARK_Mode;
4496 Save_SMP : constant Node_Id := SPARK_Mode_Pragma;
4497 -- Save all SPARK_Mode-related attributes as removing enclosing scopes
4498 -- to provide a clean environment for analysis of the inlined body will
4499 -- eliminate any previously set SPARK_Mode.
4501 Scope_Stack_Depth : constant Int :=
4502 Scope_Stack.Last - Scope_Stack.First + 1;
4504 Use_Clauses : array (1 .. Scope_Stack_Depth) of Node_Id;
4505 Instances : array (1 .. Scope_Stack_Depth) of Entity_Id;
4506 Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
4507 Curr_Scope : Entity_Id := Empty;
4508 List : Elist_Id;
4509 Num_Inner : Int := 0;
4510 Num_Scopes : Int := 0;
4511 N_Instances : Int := 0;
4512 Removed : Boolean := False;
4513 S : Entity_Id;
4514 Vis : Boolean;
4516 begin
4517 -- Case of generic unit defined in another unit. We must remove the
4518 -- complete context of the current unit to install that of the generic.
4520 if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
4522 -- Add some comments for the following two loops ???
4524 S := Current_Scope;
4525 while Present (S) and then S /= Standard_Standard loop
4526 loop
4527 Num_Scopes := Num_Scopes + 1;
4529 Use_Clauses (Num_Scopes) :=
4530 (Scope_Stack.Table
4531 (Scope_Stack.Last - Num_Scopes + 1).
4532 First_Use_Clause);
4533 End_Use_Clauses (Use_Clauses (Num_Scopes));
4535 exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
4536 or else Scope_Stack.Table
4537 (Scope_Stack.Last - Num_Scopes).Entity = Scope (S);
4538 end loop;
4540 exit when Is_Generic_Instance (S)
4541 and then (In_Package_Body (S)
4542 or else Ekind (S) = E_Procedure
4543 or else Ekind (S) = E_Function);
4544 S := Scope (S);
4545 end loop;
4547 Vis := Is_Immediately_Visible (Gen_Comp);
4549 -- Find and save all enclosing instances
4551 S := Current_Scope;
4553 while Present (S)
4554 and then S /= Standard_Standard
4555 loop
4556 if Is_Generic_Instance (S) then
4557 N_Instances := N_Instances + 1;
4558 Instances (N_Instances) := S;
4560 exit when In_Package_Body (S);
4561 end if;
4563 S := Scope (S);
4564 end loop;
4566 -- Remove context of current compilation unit, unless we are within a
4567 -- nested package instantiation, in which case the context has been
4568 -- removed previously.
4570 -- If current scope is the body of a child unit, remove context of
4571 -- spec as well. If an enclosing scope is an instance body, the
4572 -- context has already been removed, but the entities in the body
4573 -- must be made invisible as well.
4575 S := Current_Scope;
4577 while Present (S)
4578 and then S /= Standard_Standard
4579 loop
4580 if Is_Generic_Instance (S)
4581 and then (In_Package_Body (S)
4582 or else Ekind_In (S, E_Procedure, E_Function))
4583 then
4584 -- We still have to remove the entities of the enclosing
4585 -- instance from direct visibility.
4587 declare
4588 E : Entity_Id;
4589 begin
4590 E := First_Entity (S);
4591 while Present (E) loop
4592 Set_Is_Immediately_Visible (E, False);
4593 Next_Entity (E);
4594 end loop;
4595 end;
4597 exit;
4598 end if;
4600 if S = Curr_Unit
4601 or else (Ekind (Curr_Unit) = E_Package_Body
4602 and then S = Spec_Entity (Curr_Unit))
4603 or else (Ekind (Curr_Unit) = E_Subprogram_Body
4604 and then S =
4605 Corresponding_Spec
4606 (Unit_Declaration_Node (Curr_Unit)))
4607 then
4608 Removed := True;
4610 -- Remove entities in current scopes from visibility, so that
4611 -- instance body is compiled in a clean environment.
4613 List := Save_Scope_Stack (Handle_Use => False);
4615 if Is_Child_Unit (S) then
4617 -- Remove child unit from stack, as well as inner scopes.
4618 -- Removing the context of a child unit removes parent units
4619 -- as well.
4621 while Current_Scope /= S loop
4622 Num_Inner := Num_Inner + 1;
4623 Inner_Scopes (Num_Inner) := Current_Scope;
4624 Pop_Scope;
4625 end loop;
4627 Pop_Scope;
4628 Remove_Context (Curr_Comp);
4629 Curr_Scope := S;
4631 else
4632 Remove_Context (Curr_Comp);
4633 end if;
4635 if Ekind (Curr_Unit) = E_Package_Body then
4636 Remove_Context (Library_Unit (Curr_Comp));
4637 end if;
4638 end if;
4640 S := Scope (S);
4641 end loop;
4643 pragma Assert (Num_Inner < Num_Scopes);
4645 -- The inlined package body must be analyzed with the SPARK_Mode of
4646 -- the enclosing context, otherwise the body may cause bogus errors
4647 -- if a configuration SPARK_Mode pragma in in effect.
4649 Push_Scope (Standard_Standard);
4650 Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4651 Instantiate_Package_Body
4652 (Body_Info =>
4653 ((Inst_Node => N,
4654 Act_Decl => Act_Decl,
4655 Expander_Status => Expander_Active,
4656 Current_Sem_Unit => Current_Sem_Unit,
4657 Scope_Suppress => Scope_Suppress,
4658 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4659 Version => Ada_Version,
4660 Version_Pragma => Ada_Version_Pragma,
4661 Warnings => Save_Warnings,
4662 SPARK_Mode => Save_SM,
4663 SPARK_Mode_Pragma => Save_SMP)),
4664 Inlined_Body => True);
4666 Pop_Scope;
4668 -- Restore context
4670 Set_Is_Immediately_Visible (Gen_Comp, Vis);
4672 -- Reset Generic_Instance flag so that use clauses can be installed
4673 -- in the proper order. (See Use_One_Package for effect of enclosing
4674 -- instances on processing of use clauses).
4676 for J in 1 .. N_Instances loop
4677 Set_Is_Generic_Instance (Instances (J), False);
4678 end loop;
4680 if Removed then
4681 Install_Context (Curr_Comp);
4683 if Present (Curr_Scope)
4684 and then Is_Child_Unit (Curr_Scope)
4685 then
4686 Push_Scope (Curr_Scope);
4687 Set_Is_Immediately_Visible (Curr_Scope);
4689 -- Finally, restore inner scopes as well
4691 for J in reverse 1 .. Num_Inner loop
4692 Push_Scope (Inner_Scopes (J));
4693 end loop;
4694 end if;
4696 Restore_Scope_Stack (List, Handle_Use => False);
4698 if Present (Curr_Scope)
4699 and then
4700 (In_Private_Part (Curr_Scope)
4701 or else In_Package_Body (Curr_Scope))
4702 then
4703 -- Install private declaration of ancestor units, which are
4704 -- currently available. Restore_Scope_Stack and Install_Context
4705 -- only install the visible part of parents.
4707 declare
4708 Par : Entity_Id;
4709 begin
4710 Par := Scope (Curr_Scope);
4711 while (Present (Par))
4712 and then Par /= Standard_Standard
4713 loop
4714 Install_Private_Declarations (Par);
4715 Par := Scope (Par);
4716 end loop;
4717 end;
4718 end if;
4719 end if;
4721 -- Restore use clauses. For a child unit, use clauses in the parents
4722 -- are restored when installing the context, so only those in inner
4723 -- scopes (and those local to the child unit itself) need to be
4724 -- installed explicitly.
4726 if Is_Child_Unit (Curr_Unit)
4727 and then Removed
4728 then
4729 for J in reverse 1 .. Num_Inner + 1 loop
4730 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4731 Use_Clauses (J);
4732 Install_Use_Clauses (Use_Clauses (J));
4733 end loop;
4735 else
4736 for J in reverse 1 .. Num_Scopes loop
4737 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4738 Use_Clauses (J);
4739 Install_Use_Clauses (Use_Clauses (J));
4740 end loop;
4741 end if;
4743 -- Restore status of instances. If one of them is a body, make its
4744 -- local entities visible again.
4746 declare
4747 E : Entity_Id;
4748 Inst : Entity_Id;
4750 begin
4751 for J in 1 .. N_Instances loop
4752 Inst := Instances (J);
4753 Set_Is_Generic_Instance (Inst, True);
4755 if In_Package_Body (Inst)
4756 or else Ekind_In (S, E_Procedure, E_Function)
4757 then
4758 E := First_Entity (Instances (J));
4759 while Present (E) loop
4760 Set_Is_Immediately_Visible (E);
4761 Next_Entity (E);
4762 end loop;
4763 end if;
4764 end loop;
4765 end;
4767 -- If generic unit is in current unit, current context is correct. Note
4768 -- that the context is guaranteed to carry the correct SPARK_Mode as no
4769 -- enclosing scopes were removed.
4771 else
4772 Instantiate_Package_Body
4773 (Body_Info =>
4774 ((Inst_Node => N,
4775 Act_Decl => Act_Decl,
4776 Expander_Status => Expander_Active,
4777 Current_Sem_Unit => Current_Sem_Unit,
4778 Scope_Suppress => Scope_Suppress,
4779 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4780 Version => Ada_Version,
4781 Version_Pragma => Ada_Version_Pragma,
4782 Warnings => Save_Warnings,
4783 SPARK_Mode => SPARK_Mode,
4784 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
4785 Inlined_Body => True);
4786 end if;
4787 end Inline_Instance_Body;
4789 -------------------------------------
4790 -- Analyze_Procedure_Instantiation --
4791 -------------------------------------
4793 procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4794 begin
4795 Analyze_Subprogram_Instantiation (N, E_Procedure);
4796 end Analyze_Procedure_Instantiation;
4798 -----------------------------------
4799 -- Need_Subprogram_Instance_Body --
4800 -----------------------------------
4802 function Need_Subprogram_Instance_Body
4803 (N : Node_Id;
4804 Subp : Entity_Id) return Boolean
4806 begin
4807 -- Must be inlined (or inlined renaming)
4809 if (Is_In_Main_Unit (N)
4810 or else Is_Inlined (Subp)
4811 or else Is_Inlined (Alias (Subp)))
4813 -- Must be generating code or analyzing code in ASIS/GNATprove mode
4815 and then (Operating_Mode = Generate_Code
4816 or else (Operating_Mode = Check_Semantics
4817 and then (ASIS_Mode or GNATprove_Mode)))
4819 -- The body is needed when generating code (full expansion), in ASIS
4820 -- mode for other tools, and in GNATprove mode (special expansion) for
4821 -- formal verification of the body itself.
4823 and then (Expander_Active or ASIS_Mode or GNATprove_Mode)
4825 -- No point in inlining if ABE is inevitable
4827 and then not ABE_Is_Certain (N)
4829 -- Or if subprogram is eliminated
4831 and then not Is_Eliminated (Subp)
4832 then
4833 Pending_Instantiations.Append
4834 ((Inst_Node => N,
4835 Act_Decl => Unit_Declaration_Node (Subp),
4836 Expander_Status => Expander_Active,
4837 Current_Sem_Unit => Current_Sem_Unit,
4838 Scope_Suppress => Scope_Suppress,
4839 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4840 Version => Ada_Version,
4841 Version_Pragma => Ada_Version_Pragma,
4842 Warnings => Save_Warnings,
4843 SPARK_Mode => SPARK_Mode,
4844 SPARK_Mode_Pragma => SPARK_Mode_Pragma));
4845 return True;
4847 -- Here if not inlined, or we ignore the inlining
4849 else
4850 return False;
4851 end if;
4852 end Need_Subprogram_Instance_Body;
4854 --------------------------------------
4855 -- Analyze_Subprogram_Instantiation --
4856 --------------------------------------
4858 procedure Analyze_Subprogram_Instantiation
4859 (N : Node_Id;
4860 K : Entity_Kind)
4862 Loc : constant Source_Ptr := Sloc (N);
4863 Gen_Id : constant Node_Id := Name (N);
4865 Anon_Id : constant Entity_Id :=
4866 Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4867 Chars => New_External_Name
4868 (Chars (Defining_Entity (N)), 'R'));
4870 Act_Decl_Id : Entity_Id;
4871 Act_Decl : Node_Id;
4872 Act_Spec : Node_Id;
4873 Act_Tree : Node_Id;
4875 Env_Installed : Boolean := False;
4876 Gen_Unit : Entity_Id;
4877 Gen_Decl : Node_Id;
4878 Pack_Id : Entity_Id;
4879 Parent_Installed : Boolean := False;
4880 Renaming_List : List_Id;
4882 procedure Analyze_Instance_And_Renamings;
4883 -- The instance must be analyzed in a context that includes the mappings
4884 -- of generic parameters into actuals. We create a package declaration
4885 -- for this purpose, and a subprogram with an internal name within the
4886 -- package. The subprogram instance is simply an alias for the internal
4887 -- subprogram, declared in the current scope.
4889 ------------------------------------
4890 -- Analyze_Instance_And_Renamings --
4891 ------------------------------------
4893 procedure Analyze_Instance_And_Renamings is
4894 Def_Ent : constant Entity_Id := Defining_Entity (N);
4895 Pack_Decl : Node_Id;
4897 begin
4898 if Nkind (Parent (N)) = N_Compilation_Unit then
4900 -- For the case of a compilation unit, the container package has
4901 -- the same name as the instantiation, to insure that the binder
4902 -- calls the elaboration procedure with the right name. Copy the
4903 -- entity of the instance, which may have compilation level flags
4904 -- (e.g. Is_Child_Unit) set.
4906 Pack_Id := New_Copy (Def_Ent);
4908 else
4909 -- Otherwise we use the name of the instantiation concatenated
4910 -- with its source position to ensure uniqueness if there are
4911 -- several instantiations with the same name.
4913 Pack_Id :=
4914 Make_Defining_Identifier (Loc,
4915 Chars => New_External_Name
4916 (Related_Id => Chars (Def_Ent),
4917 Suffix => "GP",
4918 Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4919 end if;
4921 Pack_Decl := Make_Package_Declaration (Loc,
4922 Specification => Make_Package_Specification (Loc,
4923 Defining_Unit_Name => Pack_Id,
4924 Visible_Declarations => Renaming_List,
4925 End_Label => Empty));
4927 Set_Instance_Spec (N, Pack_Decl);
4928 Set_Is_Generic_Instance (Pack_Id);
4929 Set_Debug_Info_Needed (Pack_Id);
4931 -- Case of not a compilation unit
4933 if Nkind (Parent (N)) /= N_Compilation_Unit then
4934 Mark_Rewrite_Insertion (Pack_Decl);
4935 Insert_Before (N, Pack_Decl);
4936 Set_Has_Completion (Pack_Id);
4938 -- Case of an instantiation that is a compilation unit
4940 -- Place declaration on current node so context is complete for
4941 -- analysis (including nested instantiations), and for use in a
4942 -- context_clause (see Analyze_With_Clause).
4944 else
4945 Set_Unit (Parent (N), Pack_Decl);
4946 Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4947 end if;
4949 Analyze (Pack_Decl);
4950 Check_Formal_Packages (Pack_Id);
4951 Set_Is_Generic_Instance (Pack_Id, False);
4953 -- Why do we clear Is_Generic_Instance??? We set it 20 lines
4954 -- above???
4956 -- Body of the enclosing package is supplied when instantiating the
4957 -- subprogram body, after semantic analysis is completed.
4959 if Nkind (Parent (N)) = N_Compilation_Unit then
4961 -- Remove package itself from visibility, so it does not
4962 -- conflict with subprogram.
4964 Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4966 -- Set name and scope of internal subprogram so that the proper
4967 -- external name will be generated. The proper scope is the scope
4968 -- of the wrapper package. We need to generate debugging info for
4969 -- the internal subprogram, so set flag accordingly.
4971 Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4972 Set_Scope (Anon_Id, Scope (Pack_Id));
4974 -- Mark wrapper package as referenced, to avoid spurious warnings
4975 -- if the instantiation appears in various with_ clauses of
4976 -- subunits of the main unit.
4978 Set_Referenced (Pack_Id);
4979 end if;
4981 Set_Is_Generic_Instance (Anon_Id);
4982 Set_Debug_Info_Needed (Anon_Id);
4983 Act_Decl_Id := New_Copy (Anon_Id);
4985 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4986 Set_Chars (Act_Decl_Id, Chars (Defining_Entity (N)));
4987 Set_Sloc (Act_Decl_Id, Sloc (Defining_Entity (N)));
4988 Set_Comes_From_Source (Act_Decl_Id, True);
4990 -- The signature may involve types that are not frozen yet, but the
4991 -- subprogram will be frozen at the point the wrapper package is
4992 -- frozen, so it does not need its own freeze node. In fact, if one
4993 -- is created, it might conflict with the freezing actions from the
4994 -- wrapper package.
4996 Set_Has_Delayed_Freeze (Anon_Id, False);
4998 -- If the instance is a child unit, mark the Id accordingly. Mark
4999 -- the anonymous entity as well, which is the real subprogram and
5000 -- which is used when the instance appears in a context clause.
5001 -- Similarly, propagate the Is_Eliminated flag to handle properly
5002 -- nested eliminated subprograms.
5004 Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
5005 Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
5006 New_Overloaded_Entity (Act_Decl_Id);
5007 Check_Eliminated (Act_Decl_Id);
5008 Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
5010 -- In compilation unit case, kill elaboration checks on the
5011 -- instantiation, since they are never needed -- the body is
5012 -- instantiated at the same point as the spec.
5014 if Nkind (Parent (N)) = N_Compilation_Unit then
5015 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
5016 Set_Kill_Elaboration_Checks (Act_Decl_Id);
5017 Set_Is_Compilation_Unit (Anon_Id);
5019 Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
5020 end if;
5022 -- The instance is not a freezing point for the new subprogram
5024 Set_Is_Frozen (Act_Decl_Id, False);
5026 if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
5027 Valid_Operator_Definition (Act_Decl_Id);
5028 end if;
5030 Set_Alias (Act_Decl_Id, Anon_Id);
5031 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
5032 Set_Has_Completion (Act_Decl_Id);
5033 Set_Related_Instance (Pack_Id, Act_Decl_Id);
5035 if Nkind (Parent (N)) = N_Compilation_Unit then
5036 Set_Body_Required (Parent (N), False);
5037 end if;
5038 end Analyze_Instance_And_Renamings;
5040 -- Local variables
5042 Save_IPSM : constant Boolean := Ignore_Pragma_SPARK_Mode;
5043 -- Save flag Ignore_Pragma_SPARK_Mode for restore on exit
5045 Save_SM : constant SPARK_Mode_Type := SPARK_Mode;
5046 Save_SMP : constant Node_Id := SPARK_Mode_Pragma;
5047 -- Save the SPARK_Mode-related data for restore on exit
5049 Vis_Prims_List : Elist_Id := No_Elist;
5050 -- List of primitives made temporarily visible in the instantiation
5051 -- to match the visibility of the formal type
5053 -- Start of processing for Analyze_Subprogram_Instantiation
5055 begin
5056 Check_SPARK_05_Restriction ("generic is not allowed", N);
5058 -- Very first thing: check for special Text_IO unit in case we are
5059 -- instantiating one of the children of [[Wide_]Wide_]Text_IO. Of course
5060 -- such an instantiation is bogus (these are packages, not subprograms),
5061 -- but we get a better error message if we do this.
5063 Check_Text_IO_Special_Unit (Gen_Id);
5065 -- Make node global for error reporting
5067 Instantiation_Node := N;
5069 -- For package instantiations we turn off style checks, because they
5070 -- will have been emitted in the generic. For subprogram instantiations
5071 -- we want to apply at least the check on overriding indicators so we
5072 -- do not modify the style check status.
5074 -- The renaming declarations for the actuals do not come from source and
5075 -- will not generate spurious warnings.
5077 Preanalyze_Actuals (N);
5079 Init_Env;
5080 Env_Installed := True;
5081 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
5082 Gen_Unit := Entity (Gen_Id);
5084 Generate_Reference (Gen_Unit, Gen_Id);
5086 if Nkind (Gen_Id) = N_Identifier
5087 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
5088 then
5089 Error_Msg_NE
5090 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
5091 end if;
5093 if Etype (Gen_Unit) = Any_Type then
5094 Restore_Env;
5095 return;
5096 end if;
5098 -- Verify that it is a generic subprogram of the right kind, and that
5099 -- it does not lead to a circular instantiation.
5101 if K = E_Procedure and then Ekind (Gen_Unit) /= E_Generic_Procedure then
5102 Error_Msg_NE
5103 ("& is not the name of a generic procedure", Gen_Id, Gen_Unit);
5105 elsif K = E_Function and then Ekind (Gen_Unit) /= E_Generic_Function then
5106 Error_Msg_NE
5107 ("& is not the name of a generic function", Gen_Id, Gen_Unit);
5109 elsif In_Open_Scopes (Gen_Unit) then
5110 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
5112 else
5113 -- If the context of the instance is subject to SPARK_Mode "off",
5114 -- set the global flag which signals Analyze_Pragma to ignore all
5115 -- SPARK_Mode pragmas within the instance.
5117 if SPARK_Mode = Off then
5118 Ignore_Pragma_SPARK_Mode := True;
5119 end if;
5121 Set_Entity (Gen_Id, Gen_Unit);
5122 Set_Is_Instantiated (Gen_Unit);
5124 if In_Extended_Main_Source_Unit (N) then
5125 Generate_Reference (Gen_Unit, N);
5126 end if;
5128 -- If renaming, get original unit
5130 if Present (Renamed_Object (Gen_Unit))
5131 and then Ekind_In (Renamed_Object (Gen_Unit), E_Generic_Procedure,
5132 E_Generic_Function)
5133 then
5134 Gen_Unit := Renamed_Object (Gen_Unit);
5135 Set_Is_Instantiated (Gen_Unit);
5136 Generate_Reference (Gen_Unit, N);
5137 end if;
5139 if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
5140 Error_Msg_Node_2 := Current_Scope;
5141 Error_Msg_NE
5142 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
5143 Circularity_Detected := True;
5144 Restore_Hidden_Primitives (Vis_Prims_List);
5145 goto Leave;
5146 end if;
5148 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
5150 -- Initialize renamings map, for error checking
5152 Generic_Renamings.Set_Last (0);
5153 Generic_Renamings_HTable.Reset;
5155 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
5157 -- Copy original generic tree, to produce text for instantiation
5159 Act_Tree :=
5160 Copy_Generic_Node
5161 (Original_Node (Gen_Decl), Empty, Instantiating => True);
5163 -- Inherit overriding indicator from instance node
5165 Act_Spec := Specification (Act_Tree);
5166 Set_Must_Override (Act_Spec, Must_Override (N));
5167 Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
5169 Renaming_List :=
5170 Analyze_Associations
5171 (I_Node => N,
5172 Formals => Generic_Formal_Declarations (Act_Tree),
5173 F_Copy => Generic_Formal_Declarations (Gen_Decl));
5175 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
5177 -- The subprogram itself cannot contain a nested instance, so the
5178 -- current parent is left empty.
5180 Set_Instance_Env (Gen_Unit, Empty);
5182 -- Build the subprogram declaration, which does not appear in the
5183 -- generic template, and give it a sloc consistent with that of the
5184 -- template.
5186 Set_Defining_Unit_Name (Act_Spec, Anon_Id);
5187 Set_Generic_Parent (Act_Spec, Gen_Unit);
5188 Act_Decl :=
5189 Make_Subprogram_Declaration (Sloc (Act_Spec),
5190 Specification => Act_Spec);
5192 -- The aspects have been copied previously, but they have to be
5193 -- linked explicitly to the new subprogram declaration. Explicit
5194 -- pre/postconditions on the instance are analyzed below, in a
5195 -- separate step.
5197 Move_Aspects (Act_Tree, To => Act_Decl);
5198 Set_Categorization_From_Pragmas (Act_Decl);
5200 if Parent_Installed then
5201 Hide_Current_Scope;
5202 end if;
5204 Append (Act_Decl, Renaming_List);
5205 Analyze_Instance_And_Renamings;
5207 -- If the generic is marked Import (Intrinsic), then so is the
5208 -- instance. This indicates that there is no body to instantiate. If
5209 -- generic is marked inline, so it the instance, and the anonymous
5210 -- subprogram it renames. If inlined, or else if inlining is enabled
5211 -- for the compilation, we generate the instance body even if it is
5212 -- not within the main unit.
5214 if Is_Intrinsic_Subprogram (Gen_Unit) then
5215 Set_Is_Intrinsic_Subprogram (Anon_Id);
5216 Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
5218 if Chars (Gen_Unit) = Name_Unchecked_Conversion then
5219 Validate_Unchecked_Conversion (N, Act_Decl_Id);
5220 end if;
5221 end if;
5223 -- Inherit convention from generic unit. Intrinsic convention, as for
5224 -- an instance of unchecked conversion, is not inherited because an
5225 -- explicit Ada instance has been created.
5227 if Has_Convention_Pragma (Gen_Unit)
5228 and then Convention (Gen_Unit) /= Convention_Intrinsic
5229 then
5230 Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
5231 Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
5232 end if;
5234 Generate_Definition (Act_Decl_Id);
5235 -- Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id)));
5236 -- ??? needed?
5237 Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
5239 -- Inherit all inlining-related flags which apply to the generic in
5240 -- the subprogram and its declaration.
5242 Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
5243 Set_Is_Inlined (Anon_Id, Is_Inlined (Gen_Unit));
5245 Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
5246 Set_Has_Pragma_Inline (Anon_Id, Has_Pragma_Inline (Gen_Unit));
5248 Set_Has_Pragma_Inline_Always
5249 (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
5250 Set_Has_Pragma_Inline_Always
5251 (Anon_Id, Has_Pragma_Inline_Always (Gen_Unit));
5253 if not Is_Intrinsic_Subprogram (Gen_Unit) then
5254 Check_Elab_Instantiation (N);
5255 end if;
5257 if Is_Dispatching_Operation (Act_Decl_Id)
5258 and then Ada_Version >= Ada_2005
5259 then
5260 declare
5261 Formal : Entity_Id;
5263 begin
5264 Formal := First_Formal (Act_Decl_Id);
5265 while Present (Formal) loop
5266 if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
5267 and then Is_Controlling_Formal (Formal)
5268 and then not Can_Never_Be_Null (Formal)
5269 then
5270 Error_Msg_NE ("access parameter& is controlling,",
5271 N, Formal);
5272 Error_Msg_NE
5273 ("\corresponding parameter of & must be"
5274 & " explicitly null-excluding", N, Gen_Id);
5275 end if;
5277 Next_Formal (Formal);
5278 end loop;
5279 end;
5280 end if;
5282 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
5284 Validate_Categorization_Dependency (N, Act_Decl_Id);
5286 if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
5287 Inherit_Context (Gen_Decl, N);
5289 Restore_Private_Views (Pack_Id, False);
5291 -- If the context requires a full instantiation, mark node for
5292 -- subsequent construction of the body.
5294 if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
5295 Check_Forward_Instantiation (Gen_Decl);
5297 -- The wrapper package is always delayed, because it does not
5298 -- constitute a freeze point, but to insure that the freeze
5299 -- node is placed properly, it is created directly when
5300 -- instantiating the body (otherwise the freeze node might
5301 -- appear to early for nested instantiations).
5303 elsif Nkind (Parent (N)) = N_Compilation_Unit then
5305 -- For ASIS purposes, indicate that the wrapper package has
5306 -- replaced the instantiation node.
5308 Rewrite (N, Unit (Parent (N)));
5309 Set_Unit (Parent (N), N);
5310 end if;
5312 elsif Nkind (Parent (N)) = N_Compilation_Unit then
5314 -- Replace instance node for library-level instantiations of
5315 -- intrinsic subprograms, for ASIS use.
5317 Rewrite (N, Unit (Parent (N)));
5318 Set_Unit (Parent (N), N);
5319 end if;
5321 if Parent_Installed then
5322 Remove_Parent;
5323 end if;
5325 Restore_Hidden_Primitives (Vis_Prims_List);
5326 Restore_Env;
5327 Env_Installed := False;
5328 Generic_Renamings.Set_Last (0);
5329 Generic_Renamings_HTable.Reset;
5331 Ignore_Pragma_SPARK_Mode := Save_IPSM;
5332 SPARK_Mode := Save_SM;
5333 SPARK_Mode_Pragma := Save_SMP;
5334 end if;
5336 <<Leave>>
5337 if Has_Aspects (N) then
5338 Analyze_Aspect_Specifications (N, Act_Decl_Id);
5339 end if;
5341 exception
5342 when Instantiation_Error =>
5343 if Parent_Installed then
5344 Remove_Parent;
5345 end if;
5347 if Env_Installed then
5348 Restore_Env;
5349 end if;
5351 Ignore_Pragma_SPARK_Mode := Save_IPSM;
5352 SPARK_Mode := Save_SM;
5353 SPARK_Mode_Pragma := Save_SMP;
5354 end Analyze_Subprogram_Instantiation;
5356 -------------------------
5357 -- Get_Associated_Node --
5358 -------------------------
5360 function Get_Associated_Node (N : Node_Id) return Node_Id is
5361 Assoc : Node_Id;
5363 begin
5364 Assoc := Associated_Node (N);
5366 if Nkind (Assoc) /= Nkind (N) then
5367 return Assoc;
5369 elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
5370 return Assoc;
5372 else
5373 -- If the node is part of an inner generic, it may itself have been
5374 -- remapped into a further generic copy. Associated_Node is otherwise
5375 -- used for the entity of the node, and will be of a different node
5376 -- kind, or else N has been rewritten as a literal or function call.
5378 while Present (Associated_Node (Assoc))
5379 and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
5380 loop
5381 Assoc := Associated_Node (Assoc);
5382 end loop;
5384 -- Follow and additional link in case the final node was rewritten.
5385 -- This can only happen with nested generic units.
5387 if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
5388 and then Present (Associated_Node (Assoc))
5389 and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
5390 N_Explicit_Dereference,
5391 N_Integer_Literal,
5392 N_Real_Literal,
5393 N_String_Literal))
5394 then
5395 Assoc := Associated_Node (Assoc);
5396 end if;
5398 -- An additional special case: an unconstrained type in an object
5399 -- declaration may have been rewritten as a local subtype constrained
5400 -- by the expression in the declaration. We need to recover the
5401 -- original entity which may be global.
5403 if Present (Original_Node (Assoc))
5404 and then Nkind (Parent (N)) = N_Object_Declaration
5405 then
5406 Assoc := Original_Node (Assoc);
5407 end if;
5409 return Assoc;
5410 end if;
5411 end Get_Associated_Node;
5413 -------------------------------------------
5414 -- Build_Instance_Compilation_Unit_Nodes --
5415 -------------------------------------------
5417 procedure Build_Instance_Compilation_Unit_Nodes
5418 (N : Node_Id;
5419 Act_Body : Node_Id;
5420 Act_Decl : Node_Id)
5422 Decl_Cunit : Node_Id;
5423 Body_Cunit : Node_Id;
5424 Citem : Node_Id;
5425 New_Main : constant Entity_Id := Defining_Entity (Act_Decl);
5426 Old_Main : constant Entity_Id := Cunit_Entity (Main_Unit);
5428 begin
5429 -- A new compilation unit node is built for the instance declaration
5431 Decl_Cunit :=
5432 Make_Compilation_Unit (Sloc (N),
5433 Context_Items => Empty_List,
5434 Unit => Act_Decl,
5435 Aux_Decls_Node => Make_Compilation_Unit_Aux (Sloc (N)));
5437 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
5439 -- The new compilation unit is linked to its body, but both share the
5440 -- same file, so we do not set Body_Required on the new unit so as not
5441 -- to create a spurious dependency on a non-existent body in the ali.
5442 -- This simplifies CodePeer unit traversal.
5444 -- We use the original instantiation compilation unit as the resulting
5445 -- compilation unit of the instance, since this is the main unit.
5447 Rewrite (N, Act_Body);
5449 -- Propagate the aspect specifications from the package body template to
5450 -- the instantiated version of the package body.
5452 if Has_Aspects (Act_Body) then
5453 Set_Aspect_Specifications
5454 (N, New_Copy_List_Tree (Aspect_Specifications (Act_Body)));
5455 end if;
5457 Body_Cunit := Parent (N);
5459 -- The two compilation unit nodes are linked by the Library_Unit field
5461 Set_Library_Unit (Decl_Cunit, Body_Cunit);
5462 Set_Library_Unit (Body_Cunit, Decl_Cunit);
5464 -- Preserve the private nature of the package if needed
5466 Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
5468 -- If the instance is not the main unit, its context, categorization
5469 -- and elaboration entity are not relevant to the compilation.
5471 if Body_Cunit /= Cunit (Main_Unit) then
5472 Make_Instance_Unit (Body_Cunit, In_Main => False);
5473 return;
5474 end if;
5476 -- The context clause items on the instantiation, which are now attached
5477 -- to the body compilation unit (since the body overwrote the original
5478 -- instantiation node), semantically belong on the spec, so copy them
5479 -- there. It's harmless to leave them on the body as well. In fact one
5480 -- could argue that they belong in both places.
5482 Citem := First (Context_Items (Body_Cunit));
5483 while Present (Citem) loop
5484 Append (New_Copy (Citem), Context_Items (Decl_Cunit));
5485 Next (Citem);
5486 end loop;
5488 -- Propagate categorization flags on packages, so that they appear in
5489 -- the ali file for the spec of the unit.
5491 if Ekind (New_Main) = E_Package then
5492 Set_Is_Pure (Old_Main, Is_Pure (New_Main));
5493 Set_Is_Preelaborated (Old_Main, Is_Preelaborated (New_Main));
5494 Set_Is_Remote_Types (Old_Main, Is_Remote_Types (New_Main));
5495 Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
5496 Set_Is_Remote_Call_Interface
5497 (Old_Main, Is_Remote_Call_Interface (New_Main));
5498 end if;
5500 -- Make entry in Units table, so that binder can generate call to
5501 -- elaboration procedure for body, if any.
5503 Make_Instance_Unit (Body_Cunit, In_Main => True);
5504 Main_Unit_Entity := New_Main;
5505 Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
5507 -- Build elaboration entity, since the instance may certainly generate
5508 -- elaboration code requiring a flag for protection.
5510 Build_Elaboration_Entity (Decl_Cunit, New_Main);
5511 end Build_Instance_Compilation_Unit_Nodes;
5513 -----------------------------
5514 -- Check_Access_Definition --
5515 -----------------------------
5517 procedure Check_Access_Definition (N : Node_Id) is
5518 begin
5519 pragma Assert
5520 (Ada_Version >= Ada_2005 and then Present (Access_Definition (N)));
5521 null;
5522 end Check_Access_Definition;
5524 -----------------------------------
5525 -- Check_Formal_Package_Instance --
5526 -----------------------------------
5528 -- If the formal has specific parameters, they must match those of the
5529 -- actual. Both of them are instances, and the renaming declarations for
5530 -- their formal parameters appear in the same order in both. The analyzed
5531 -- formal has been analyzed in the context of the current instance.
5533 procedure Check_Formal_Package_Instance
5534 (Formal_Pack : Entity_Id;
5535 Actual_Pack : Entity_Id)
5537 E1 : Entity_Id := First_Entity (Actual_Pack);
5538 E2 : Entity_Id := First_Entity (Formal_Pack);
5540 Expr1 : Node_Id;
5541 Expr2 : Node_Id;
5543 procedure Check_Mismatch (B : Boolean);
5544 -- Common error routine for mismatch between the parameters of the
5545 -- actual instance and those of the formal package.
5547 function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
5548 -- The formal may come from a nested formal package, and the actual may
5549 -- have been constant-folded. To determine whether the two denote the
5550 -- same entity we may have to traverse several definitions to recover
5551 -- the ultimate entity that they refer to.
5553 function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
5554 -- Similarly, if the formal comes from a nested formal package, the
5555 -- actual may designate the formal through multiple renamings, which
5556 -- have to be followed to determine the original variable in question.
5558 --------------------
5559 -- Check_Mismatch --
5560 --------------------
5562 procedure Check_Mismatch (B : Boolean) is
5563 Kind : constant Node_Kind := Nkind (Parent (E2));
5565 begin
5566 if Kind = N_Formal_Type_Declaration then
5567 return;
5569 elsif Nkind_In (Kind, N_Formal_Object_Declaration,
5570 N_Formal_Package_Declaration)
5571 or else Kind in N_Formal_Subprogram_Declaration
5572 then
5573 null;
5575 elsif B then
5576 Error_Msg_NE
5577 ("actual for & in actual instance does not match formal",
5578 Parent (Actual_Pack), E1);
5579 end if;
5580 end Check_Mismatch;
5582 --------------------------------
5583 -- Same_Instantiated_Constant --
5584 --------------------------------
5586 function Same_Instantiated_Constant
5587 (E1, E2 : Entity_Id) return Boolean
5589 Ent : Entity_Id;
5591 begin
5592 Ent := E2;
5593 while Present (Ent) loop
5594 if E1 = Ent then
5595 return True;
5597 elsif Ekind (Ent) /= E_Constant then
5598 return False;
5600 elsif Is_Entity_Name (Constant_Value (Ent)) then
5601 if Entity (Constant_Value (Ent)) = E1 then
5602 return True;
5603 else
5604 Ent := Entity (Constant_Value (Ent));
5605 end if;
5607 -- The actual may be a constant that has been folded. Recover
5608 -- original name.
5610 elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5611 Ent := Entity (Original_Node (Constant_Value (Ent)));
5612 else
5613 return False;
5614 end if;
5615 end loop;
5617 return False;
5618 end Same_Instantiated_Constant;
5620 --------------------------------
5621 -- Same_Instantiated_Variable --
5622 --------------------------------
5624 function Same_Instantiated_Variable
5625 (E1, E2 : Entity_Id) return Boolean
5627 function Original_Entity (E : Entity_Id) return Entity_Id;
5628 -- Follow chain of renamings to the ultimate ancestor
5630 ---------------------
5631 -- Original_Entity --
5632 ---------------------
5634 function Original_Entity (E : Entity_Id) return Entity_Id is
5635 Orig : Entity_Id;
5637 begin
5638 Orig := E;
5639 while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5640 and then Present (Renamed_Object (Orig))
5641 and then Is_Entity_Name (Renamed_Object (Orig))
5642 loop
5643 Orig := Entity (Renamed_Object (Orig));
5644 end loop;
5646 return Orig;
5647 end Original_Entity;
5649 -- Start of processing for Same_Instantiated_Variable
5651 begin
5652 return Ekind (E1) = Ekind (E2)
5653 and then Original_Entity (E1) = Original_Entity (E2);
5654 end Same_Instantiated_Variable;
5656 -- Start of processing for Check_Formal_Package_Instance
5658 begin
5659 while Present (E1)
5660 and then Present (E2)
5661 loop
5662 exit when Ekind (E1) = E_Package
5663 and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5665 -- If the formal is the renaming of the formal package, this
5666 -- is the end of its formal part, which may occur before the
5667 -- end of the formal part in the actual in the presence of
5668 -- defaulted parameters in the formal package.
5670 exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5671 and then Renamed_Entity (E2) = Scope (E2);
5673 -- The analysis of the actual may generate additional internal
5674 -- entities. If the formal is defaulted, there is no corresponding
5675 -- analysis and the internal entities must be skipped, until we
5676 -- find corresponding entities again.
5678 if Comes_From_Source (E2)
5679 and then not Comes_From_Source (E1)
5680 and then Chars (E1) /= Chars (E2)
5681 then
5682 while Present (E1)
5683 and then Chars (E1) /= Chars (E2)
5684 loop
5685 Next_Entity (E1);
5686 end loop;
5687 end if;
5689 if No (E1) then
5690 return;
5692 -- If the formal entity comes from a formal declaration, it was
5693 -- defaulted in the formal package, and no check is needed on it.
5695 elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
5696 goto Next_E;
5698 -- Ditto for defaulted formal subprograms.
5700 elsif Is_Overloadable (E1)
5701 and then Nkind (Unit_Declaration_Node (E2)) in
5702 N_Formal_Subprogram_Declaration
5703 then
5704 goto Next_E;
5706 elsif Is_Type (E1) then
5708 -- Subtypes must statically match. E1, E2 are the local entities
5709 -- that are subtypes of the actuals. Itypes generated for other
5710 -- parameters need not be checked, the check will be performed
5711 -- on the parameters themselves.
5713 -- If E2 is a formal type declaration, it is a defaulted parameter
5714 -- and needs no checking.
5716 if not Is_Itype (E1)
5717 and then not Is_Itype (E2)
5718 then
5719 Check_Mismatch
5720 (not Is_Type (E2)
5721 or else Etype (E1) /= Etype (E2)
5722 or else not Subtypes_Statically_Match (E1, E2));
5723 end if;
5725 elsif Ekind (E1) = E_Constant then
5727 -- IN parameters must denote the same static value, or the same
5728 -- constant, or the literal null.
5730 Expr1 := Expression (Parent (E1));
5732 if Ekind (E2) /= E_Constant then
5733 Check_Mismatch (True);
5734 goto Next_E;
5735 else
5736 Expr2 := Expression (Parent (E2));
5737 end if;
5739 if Is_OK_Static_Expression (Expr1) then
5740 if not Is_OK_Static_Expression (Expr2) then
5741 Check_Mismatch (True);
5743 elsif Is_Discrete_Type (Etype (E1)) then
5744 declare
5745 V1 : constant Uint := Expr_Value (Expr1);
5746 V2 : constant Uint := Expr_Value (Expr2);
5747 begin
5748 Check_Mismatch (V1 /= V2);
5749 end;
5751 elsif Is_Real_Type (Etype (E1)) then
5752 declare
5753 V1 : constant Ureal := Expr_Value_R (Expr1);
5754 V2 : constant Ureal := Expr_Value_R (Expr2);
5755 begin
5756 Check_Mismatch (V1 /= V2);
5757 end;
5759 elsif Is_String_Type (Etype (E1))
5760 and then Nkind (Expr1) = N_String_Literal
5761 then
5762 if Nkind (Expr2) /= N_String_Literal then
5763 Check_Mismatch (True);
5764 else
5765 Check_Mismatch
5766 (not String_Equal (Strval (Expr1), Strval (Expr2)));
5767 end if;
5768 end if;
5770 elsif Is_Entity_Name (Expr1) then
5771 if Is_Entity_Name (Expr2) then
5772 if Entity (Expr1) = Entity (Expr2) then
5773 null;
5774 else
5775 Check_Mismatch
5776 (not Same_Instantiated_Constant
5777 (Entity (Expr1), Entity (Expr2)));
5778 end if;
5779 else
5780 Check_Mismatch (True);
5781 end if;
5783 elsif Is_Entity_Name (Original_Node (Expr1))
5784 and then Is_Entity_Name (Expr2)
5785 and then
5786 Same_Instantiated_Constant
5787 (Entity (Original_Node (Expr1)), Entity (Expr2))
5788 then
5789 null;
5791 elsif Nkind (Expr1) = N_Null then
5792 Check_Mismatch (Nkind (Expr1) /= N_Null);
5794 else
5795 Check_Mismatch (True);
5796 end if;
5798 elsif Ekind (E1) = E_Variable then
5799 Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5801 elsif Ekind (E1) = E_Package then
5802 Check_Mismatch
5803 (Ekind (E1) /= Ekind (E2)
5804 or else Renamed_Object (E1) /= Renamed_Object (E2));
5806 elsif Is_Overloadable (E1) then
5808 -- Verify that the actual subprograms match. Note that actuals
5809 -- that are attributes are rewritten as subprograms. If the
5810 -- subprogram in the formal package is defaulted, no check is
5811 -- needed. Note that this can only happen in Ada 2005 when the
5812 -- formal package can be partially parameterized.
5814 if Nkind (Unit_Declaration_Node (E1)) =
5815 N_Subprogram_Renaming_Declaration
5816 and then From_Default (Unit_Declaration_Node (E1))
5817 then
5818 null;
5820 -- If the formal package has an "others" box association that
5821 -- covers this formal, there is no need for a check either.
5823 elsif Nkind (Unit_Declaration_Node (E2)) in
5824 N_Formal_Subprogram_Declaration
5825 and then Box_Present (Unit_Declaration_Node (E2))
5826 then
5827 null;
5829 -- No check needed if subprogram is a defaulted null procedure
5831 elsif No (Alias (E2))
5832 and then Ekind (E2) = E_Procedure
5833 and then
5834 Null_Present (Specification (Unit_Declaration_Node (E2)))
5835 then
5836 null;
5838 -- Otherwise the actual in the formal and the actual in the
5839 -- instantiation of the formal must match, up to renamings.
5841 else
5842 Check_Mismatch
5843 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5844 end if;
5846 else
5847 raise Program_Error;
5848 end if;
5850 <<Next_E>>
5851 Next_Entity (E1);
5852 Next_Entity (E2);
5853 end loop;
5854 end Check_Formal_Package_Instance;
5856 ---------------------------
5857 -- Check_Formal_Packages --
5858 ---------------------------
5860 procedure Check_Formal_Packages (P_Id : Entity_Id) is
5861 E : Entity_Id;
5862 Formal_P : Entity_Id;
5864 begin
5865 -- Iterate through the declarations in the instance, looking for package
5866 -- renaming declarations that denote instances of formal packages. Stop
5867 -- when we find the renaming of the current package itself. The
5868 -- declaration for a formal package without a box is followed by an
5869 -- internal entity that repeats the instantiation.
5871 E := First_Entity (P_Id);
5872 while Present (E) loop
5873 if Ekind (E) = E_Package then
5874 if Renamed_Object (E) = P_Id then
5875 exit;
5877 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5878 null;
5880 elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5881 Formal_P := Next_Entity (E);
5882 Check_Formal_Package_Instance (Formal_P, E);
5884 -- After checking, remove the internal validating package. It
5885 -- is only needed for semantic checks, and as it may contain
5886 -- generic formal declarations it should not reach gigi.
5888 Remove (Unit_Declaration_Node (Formal_P));
5889 end if;
5890 end if;
5892 Next_Entity (E);
5893 end loop;
5894 end Check_Formal_Packages;
5896 ---------------------------------
5897 -- Check_Forward_Instantiation --
5898 ---------------------------------
5900 procedure Check_Forward_Instantiation (Decl : Node_Id) is
5901 S : Entity_Id;
5902 Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5904 begin
5905 -- The instantiation appears before the generic body if we are in the
5906 -- scope of the unit containing the generic, either in its spec or in
5907 -- the package body, and before the generic body.
5909 if Ekind (Gen_Comp) = E_Package_Body then
5910 Gen_Comp := Spec_Entity (Gen_Comp);
5911 end if;
5913 if In_Open_Scopes (Gen_Comp)
5914 and then No (Corresponding_Body (Decl))
5915 then
5916 S := Current_Scope;
5918 while Present (S)
5919 and then not Is_Compilation_Unit (S)
5920 and then not Is_Child_Unit (S)
5921 loop
5922 if Ekind (S) = E_Package then
5923 Set_Has_Forward_Instantiation (S);
5924 end if;
5926 S := Scope (S);
5927 end loop;
5928 end if;
5929 end Check_Forward_Instantiation;
5931 ---------------------------
5932 -- Check_Generic_Actuals --
5933 ---------------------------
5935 -- The visibility of the actuals may be different between the point of
5936 -- generic instantiation and the instantiation of the body.
5938 procedure Check_Generic_Actuals
5939 (Instance : Entity_Id;
5940 Is_Formal_Box : Boolean)
5942 E : Entity_Id;
5943 Astype : Entity_Id;
5945 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5946 -- For a formal that is an array type, the component type is often a
5947 -- previous formal in the same unit. The privacy status of the component
5948 -- type will have been examined earlier in the traversal of the
5949 -- corresponding actuals, and this status should not be modified for
5950 -- the array (sub)type itself. However, if the base type of the array
5951 -- (sub)type is private, its full view must be restored in the body to
5952 -- be consistent with subsequent index subtypes, etc.
5954 -- To detect this case we have to rescan the list of formals, which is
5955 -- usually short enough to ignore the resulting inefficiency.
5957 -----------------------------
5958 -- Denotes_Previous_Actual --
5959 -----------------------------
5961 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5962 Prev : Entity_Id;
5964 begin
5965 Prev := First_Entity (Instance);
5966 while Present (Prev) loop
5967 if Is_Type (Prev)
5968 and then Nkind (Parent (Prev)) = N_Subtype_Declaration
5969 and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
5970 and then Entity (Subtype_Indication (Parent (Prev))) = Typ
5971 then
5972 return True;
5974 elsif Prev = E then
5975 return False;
5977 else
5978 Next_Entity (Prev);
5979 end if;
5980 end loop;
5982 return False;
5983 end Denotes_Previous_Actual;
5985 -- Start of processing for Check_Generic_Actuals
5987 begin
5988 E := First_Entity (Instance);
5989 while Present (E) loop
5990 if Is_Type (E)
5991 and then Nkind (Parent (E)) = N_Subtype_Declaration
5992 and then Scope (Etype (E)) /= Instance
5993 and then Is_Entity_Name (Subtype_Indication (Parent (E)))
5994 then
5995 if Is_Array_Type (E)
5996 and then not Is_Private_Type (Etype (E))
5997 and then Denotes_Previous_Actual (Component_Type (E))
5998 then
5999 null;
6000 else
6001 Check_Private_View (Subtype_Indication (Parent (E)));
6002 end if;
6004 Set_Is_Generic_Actual_Type (E, True);
6005 Set_Is_Hidden (E, False);
6006 Set_Is_Potentially_Use_Visible (E,
6007 In_Use (Instance));
6009 -- We constructed the generic actual type as a subtype of the
6010 -- supplied type. This means that it normally would not inherit
6011 -- subtype specific attributes of the actual, which is wrong for
6012 -- the generic case.
6014 Astype := Ancestor_Subtype (E);
6016 if No (Astype) then
6018 -- This can happen when E is an itype that is the full view of
6019 -- a private type completed, e.g. with a constrained array. In
6020 -- that case, use the first subtype, which will carry size
6021 -- information. The base type itself is unconstrained and will
6022 -- not carry it.
6024 Astype := First_Subtype (E);
6025 end if;
6027 Set_Size_Info (E, (Astype));
6028 Set_RM_Size (E, RM_Size (Astype));
6029 Set_First_Rep_Item (E, First_Rep_Item (Astype));
6031 if Is_Discrete_Or_Fixed_Point_Type (E) then
6032 Set_RM_Size (E, RM_Size (Astype));
6034 -- In nested instances, the base type of an access actual may
6035 -- itself be private, and need to be exchanged.
6037 elsif Is_Access_Type (E)
6038 and then Is_Private_Type (Etype (E))
6039 then
6040 Check_Private_View
6041 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
6042 end if;
6044 elsif Ekind (E) = E_Package then
6046 -- If this is the renaming for the current instance, we're done.
6047 -- Otherwise it is a formal package. If the corresponding formal
6048 -- was declared with a box, the (instantiations of the) generic
6049 -- formal part are also visible. Otherwise, ignore the entity
6050 -- created to validate the actuals.
6052 if Renamed_Object (E) = Instance then
6053 exit;
6055 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
6056 null;
6058 -- The visibility of a formal of an enclosing generic is already
6059 -- correct.
6061 elsif Denotes_Formal_Package (E) then
6062 null;
6064 elsif Present (Associated_Formal_Package (E))
6065 and then not Is_Generic_Formal (E)
6066 then
6067 if Box_Present (Parent (Associated_Formal_Package (E))) then
6068 Check_Generic_Actuals (Renamed_Object (E), True);
6070 else
6071 Check_Generic_Actuals (Renamed_Object (E), False);
6072 end if;
6074 Set_Is_Hidden (E, False);
6075 end if;
6077 -- If this is a subprogram instance (in a wrapper package) the
6078 -- actual is fully visible.
6080 elsif Is_Wrapper_Package (Instance) then
6081 Set_Is_Hidden (E, False);
6083 -- If the formal package is declared with a box, or if the formal
6084 -- parameter is defaulted, it is visible in the body.
6086 elsif Is_Formal_Box or else Is_Visible_Formal (E) then
6087 Set_Is_Hidden (E, False);
6088 end if;
6090 if Ekind (E) = E_Constant then
6092 -- If the type of the actual is a private type declared in the
6093 -- enclosing scope of the generic unit, the body of the generic
6094 -- sees the full view of the type (because it has to appear in
6095 -- the corresponding package body). If the type is private now,
6096 -- exchange views to restore the proper visiblity in the instance.
6098 declare
6099 Typ : constant Entity_Id := Base_Type (Etype (E));
6100 -- The type of the actual
6102 Gen_Id : Entity_Id;
6103 -- The generic unit
6105 Parent_Scope : Entity_Id;
6106 -- The enclosing scope of the generic unit
6108 begin
6109 if Is_Wrapper_Package (Instance) then
6110 Gen_Id :=
6111 Generic_Parent
6112 (Specification
6113 (Unit_Declaration_Node
6114 (Related_Instance (Instance))));
6115 else
6116 Gen_Id :=
6117 Generic_Parent (Package_Specification (Instance));
6118 end if;
6120 Parent_Scope := Scope (Gen_Id);
6122 -- The exchange is only needed if the generic is defined
6123 -- within a package which is not a common ancestor of the
6124 -- scope of the instance, and is not already in scope.
6126 if Is_Private_Type (Typ)
6127 and then Scope (Typ) = Parent_Scope
6128 and then Scope (Instance) /= Parent_Scope
6129 and then Ekind (Parent_Scope) = E_Package
6130 and then not Is_Child_Unit (Gen_Id)
6131 then
6132 Switch_View (Typ);
6134 -- If the type of the entity is a subtype, it may also have
6135 -- to be made visible, together with the base type of its
6136 -- full view, after exchange.
6138 if Is_Private_Type (Etype (E)) then
6139 Switch_View (Etype (E));
6140 Switch_View (Base_Type (Etype (E)));
6141 end if;
6142 end if;
6143 end;
6144 end if;
6146 Next_Entity (E);
6147 end loop;
6148 end Check_Generic_Actuals;
6150 ------------------------------
6151 -- Check_Generic_Child_Unit --
6152 ------------------------------
6154 procedure Check_Generic_Child_Unit
6155 (Gen_Id : Node_Id;
6156 Parent_Installed : in out Boolean)
6158 Loc : constant Source_Ptr := Sloc (Gen_Id);
6159 Gen_Par : Entity_Id := Empty;
6160 E : Entity_Id;
6161 Inst_Par : Entity_Id;
6162 S : Node_Id;
6164 function Find_Generic_Child
6165 (Scop : Entity_Id;
6166 Id : Node_Id) return Entity_Id;
6167 -- Search generic parent for possible child unit with the given name
6169 function In_Enclosing_Instance return Boolean;
6170 -- Within an instance of the parent, the child unit may be denoted by
6171 -- a simple name, or an abbreviated expanded name. Examine enclosing
6172 -- scopes to locate a possible parent instantiation.
6174 ------------------------
6175 -- Find_Generic_Child --
6176 ------------------------
6178 function Find_Generic_Child
6179 (Scop : Entity_Id;
6180 Id : Node_Id) return Entity_Id
6182 E : Entity_Id;
6184 begin
6185 -- If entity of name is already set, instance has already been
6186 -- resolved, e.g. in an enclosing instantiation.
6188 if Present (Entity (Id)) then
6189 if Scope (Entity (Id)) = Scop then
6190 return Entity (Id);
6191 else
6192 return Empty;
6193 end if;
6195 else
6196 E := First_Entity (Scop);
6197 while Present (E) loop
6198 if Chars (E) = Chars (Id)
6199 and then Is_Child_Unit (E)
6200 then
6201 if Is_Child_Unit (E)
6202 and then not Is_Visible_Lib_Unit (E)
6203 then
6204 Error_Msg_NE
6205 ("generic child unit& is not visible", Gen_Id, E);
6206 end if;
6208 Set_Entity (Id, E);
6209 return E;
6210 end if;
6212 Next_Entity (E);
6213 end loop;
6215 return Empty;
6216 end if;
6217 end Find_Generic_Child;
6219 ---------------------------
6220 -- In_Enclosing_Instance --
6221 ---------------------------
6223 function In_Enclosing_Instance return Boolean is
6224 Enclosing_Instance : Node_Id;
6225 Instance_Decl : Node_Id;
6227 begin
6228 -- We do not inline any call that contains instantiations, except
6229 -- for instantiations of Unchecked_Conversion, so if we are within
6230 -- an inlined body the current instance does not require parents.
6232 if In_Inlined_Body then
6233 pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
6234 return False;
6235 end if;
6237 -- Loop to check enclosing scopes
6239 Enclosing_Instance := Current_Scope;
6240 while Present (Enclosing_Instance) loop
6241 Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
6243 if Ekind (Enclosing_Instance) = E_Package
6244 and then Is_Generic_Instance (Enclosing_Instance)
6245 and then Present
6246 (Generic_Parent (Specification (Instance_Decl)))
6247 then
6248 -- Check whether the generic we are looking for is a child of
6249 -- this instance.
6251 E := Find_Generic_Child
6252 (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
6253 exit when Present (E);
6255 else
6256 E := Empty;
6257 end if;
6259 Enclosing_Instance := Scope (Enclosing_Instance);
6260 end loop;
6262 if No (E) then
6264 -- Not a child unit
6266 Analyze (Gen_Id);
6267 return False;
6269 else
6270 Rewrite (Gen_Id,
6271 Make_Expanded_Name (Loc,
6272 Chars => Chars (E),
6273 Prefix => New_Occurrence_Of (Enclosing_Instance, Loc),
6274 Selector_Name => New_Occurrence_Of (E, Loc)));
6276 Set_Entity (Gen_Id, E);
6277 Set_Etype (Gen_Id, Etype (E));
6278 Parent_Installed := False; -- Already in scope.
6279 return True;
6280 end if;
6281 end In_Enclosing_Instance;
6283 -- Start of processing for Check_Generic_Child_Unit
6285 begin
6286 -- If the name of the generic is given by a selected component, it may
6287 -- be the name of a generic child unit, and the prefix is the name of an
6288 -- instance of the parent, in which case the child unit must be visible.
6289 -- If this instance is not in scope, it must be placed there and removed
6290 -- after instantiation, because what is being instantiated is not the
6291 -- original child, but the corresponding child present in the instance
6292 -- of the parent.
6294 -- If the child is instantiated within the parent, it can be given by
6295 -- a simple name. In this case the instance is already in scope, but
6296 -- the child generic must be recovered from the generic parent as well.
6298 if Nkind (Gen_Id) = N_Selected_Component then
6299 S := Selector_Name (Gen_Id);
6300 Analyze (Prefix (Gen_Id));
6301 Inst_Par := Entity (Prefix (Gen_Id));
6303 if Ekind (Inst_Par) = E_Package
6304 and then Present (Renamed_Object (Inst_Par))
6305 then
6306 Inst_Par := Renamed_Object (Inst_Par);
6307 end if;
6309 if Ekind (Inst_Par) = E_Package then
6310 if Nkind (Parent (Inst_Par)) = N_Package_Specification then
6311 Gen_Par := Generic_Parent (Parent (Inst_Par));
6313 elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
6314 and then
6315 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
6316 then
6317 Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
6318 end if;
6320 elsif Ekind (Inst_Par) = E_Generic_Package
6321 and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
6322 then
6323 -- A formal package may be a real child package, and not the
6324 -- implicit instance within a parent. In this case the child is
6325 -- not visible and has to be retrieved explicitly as well.
6327 Gen_Par := Inst_Par;
6328 end if;
6330 if Present (Gen_Par) then
6332 -- The prefix denotes an instantiation. The entity itself may be a
6333 -- nested generic, or a child unit.
6335 E := Find_Generic_Child (Gen_Par, S);
6337 if Present (E) then
6338 Change_Selected_Component_To_Expanded_Name (Gen_Id);
6339 Set_Entity (Gen_Id, E);
6340 Set_Etype (Gen_Id, Etype (E));
6341 Set_Entity (S, E);
6342 Set_Etype (S, Etype (E));
6344 -- Indicate that this is a reference to the parent
6346 if In_Extended_Main_Source_Unit (Gen_Id) then
6347 Set_Is_Instantiated (Inst_Par);
6348 end if;
6350 -- A common mistake is to replicate the naming scheme of a
6351 -- hierarchy by instantiating a generic child directly, rather
6352 -- than the implicit child in a parent instance:
6354 -- generic .. package Gpar is ..
6355 -- generic .. package Gpar.Child is ..
6356 -- package Par is new Gpar ();
6358 -- with Gpar.Child;
6359 -- package Par.Child is new Gpar.Child ();
6360 -- rather than Par.Child
6362 -- In this case the instantiation is within Par, which is an
6363 -- instance, but Gpar does not denote Par because we are not IN
6364 -- the instance of Gpar, so this is illegal. The test below
6365 -- recognizes this particular case.
6367 if Is_Child_Unit (E)
6368 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
6369 and then (not In_Instance
6370 or else Nkind (Parent (Parent (Gen_Id))) =
6371 N_Compilation_Unit)
6372 then
6373 Error_Msg_N
6374 ("prefix of generic child unit must be instance of parent",
6375 Gen_Id);
6376 end if;
6378 if not In_Open_Scopes (Inst_Par)
6379 and then Nkind (Parent (Gen_Id)) not in
6380 N_Generic_Renaming_Declaration
6381 then
6382 Install_Parent (Inst_Par);
6383 Parent_Installed := True;
6385 elsif In_Open_Scopes (Inst_Par) then
6387 -- If the parent is already installed, install the actuals
6388 -- for its formal packages. This is necessary when the child
6389 -- instance is a child of the parent instance: in this case,
6390 -- the parent is placed on the scope stack but the formal
6391 -- packages are not made visible.
6393 Install_Formal_Packages (Inst_Par);
6394 end if;
6396 else
6397 -- If the generic parent does not contain an entity that
6398 -- corresponds to the selector, the instance doesn't either.
6399 -- Analyzing the node will yield the appropriate error message.
6400 -- If the entity is not a child unit, then it is an inner
6401 -- generic in the parent.
6403 Analyze (Gen_Id);
6404 end if;
6406 else
6407 Analyze (Gen_Id);
6409 if Is_Child_Unit (Entity (Gen_Id))
6410 and then
6411 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6412 and then not In_Open_Scopes (Inst_Par)
6413 then
6414 Install_Parent (Inst_Par);
6415 Parent_Installed := True;
6417 -- The generic unit may be the renaming of the implicit child
6418 -- present in an instance. In that case the parent instance is
6419 -- obtained from the name of the renamed entity.
6421 elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
6422 and then Present (Renamed_Entity (Entity (Gen_Id)))
6423 and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
6424 then
6425 declare
6426 Renamed_Package : constant Node_Id :=
6427 Name (Parent (Entity (Gen_Id)));
6428 begin
6429 if Nkind (Renamed_Package) = N_Expanded_Name then
6430 Inst_Par := Entity (Prefix (Renamed_Package));
6431 Install_Parent (Inst_Par);
6432 Parent_Installed := True;
6433 end if;
6434 end;
6435 end if;
6436 end if;
6438 elsif Nkind (Gen_Id) = N_Expanded_Name then
6440 -- Entity already present, analyze prefix, whose meaning may be
6441 -- an instance in the current context. If it is an instance of
6442 -- a relative within another, the proper parent may still have
6443 -- to be installed, if they are not of the same generation.
6445 Analyze (Prefix (Gen_Id));
6447 -- In the unlikely case that a local declaration hides the name
6448 -- of the parent package, locate it on the homonym chain. If the
6449 -- context is an instance of the parent, the renaming entity is
6450 -- flagged as such.
6452 Inst_Par := Entity (Prefix (Gen_Id));
6453 while Present (Inst_Par)
6454 and then not Is_Package_Or_Generic_Package (Inst_Par)
6455 loop
6456 Inst_Par := Homonym (Inst_Par);
6457 end loop;
6459 pragma Assert (Present (Inst_Par));
6460 Set_Entity (Prefix (Gen_Id), Inst_Par);
6462 if In_Enclosing_Instance then
6463 null;
6465 elsif Present (Entity (Gen_Id))
6466 and then Is_Child_Unit (Entity (Gen_Id))
6467 and then not In_Open_Scopes (Inst_Par)
6468 then
6469 Install_Parent (Inst_Par);
6470 Parent_Installed := True;
6471 end if;
6473 elsif In_Enclosing_Instance then
6475 -- The child unit is found in some enclosing scope
6477 null;
6479 else
6480 Analyze (Gen_Id);
6482 -- If this is the renaming of the implicit child in a parent
6483 -- instance, recover the parent name and install it.
6485 if Is_Entity_Name (Gen_Id) then
6486 E := Entity (Gen_Id);
6488 if Is_Generic_Unit (E)
6489 and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
6490 and then Is_Child_Unit (Renamed_Object (E))
6491 and then Is_Generic_Unit (Scope (Renamed_Object (E)))
6492 and then Nkind (Name (Parent (E))) = N_Expanded_Name
6493 then
6494 Rewrite (Gen_Id,
6495 New_Copy_Tree (Name (Parent (E))));
6496 Inst_Par := Entity (Prefix (Gen_Id));
6498 if not In_Open_Scopes (Inst_Par) then
6499 Install_Parent (Inst_Par);
6500 Parent_Installed := True;
6501 end if;
6503 -- If it is a child unit of a non-generic parent, it may be
6504 -- use-visible and given by a direct name. Install parent as
6505 -- for other cases.
6507 elsif Is_Generic_Unit (E)
6508 and then Is_Child_Unit (E)
6509 and then
6510 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6511 and then not Is_Generic_Unit (Scope (E))
6512 then
6513 if not In_Open_Scopes (Scope (E)) then
6514 Install_Parent (Scope (E));
6515 Parent_Installed := True;
6516 end if;
6517 end if;
6518 end if;
6519 end if;
6520 end Check_Generic_Child_Unit;
6522 -----------------------------
6523 -- Check_Hidden_Child_Unit --
6524 -----------------------------
6526 procedure Check_Hidden_Child_Unit
6527 (N : Node_Id;
6528 Gen_Unit : Entity_Id;
6529 Act_Decl_Id : Entity_Id)
6531 Gen_Id : constant Node_Id := Name (N);
6533 begin
6534 if Is_Child_Unit (Gen_Unit)
6535 and then Is_Child_Unit (Act_Decl_Id)
6536 and then Nkind (Gen_Id) = N_Expanded_Name
6537 and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
6538 and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
6539 then
6540 Error_Msg_Node_2 := Scope (Act_Decl_Id);
6541 Error_Msg_NE
6542 ("generic unit & is implicitly declared in &",
6543 Defining_Unit_Name (N), Gen_Unit);
6544 Error_Msg_N ("\instance must have different name",
6545 Defining_Unit_Name (N));
6546 end if;
6547 end Check_Hidden_Child_Unit;
6549 ------------------------
6550 -- Check_Private_View --
6551 ------------------------
6553 procedure Check_Private_View (N : Node_Id) is
6554 T : constant Entity_Id := Etype (N);
6555 BT : Entity_Id;
6557 begin
6558 -- Exchange views if the type was not private in the generic but is
6559 -- private at the point of instantiation. Do not exchange views if
6560 -- the scope of the type is in scope. This can happen if both generic
6561 -- and instance are sibling units, or if type is defined in a parent.
6562 -- In this case the visibility of the type will be correct for all
6563 -- semantic checks.
6565 if Present (T) then
6566 BT := Base_Type (T);
6568 if Is_Private_Type (T)
6569 and then not Has_Private_View (N)
6570 and then Present (Full_View (T))
6571 and then not In_Open_Scopes (Scope (T))
6572 then
6573 -- In the generic, the full type was visible. Save the private
6574 -- entity, for subsequent exchange.
6576 Switch_View (T);
6578 elsif Has_Private_View (N)
6579 and then not Is_Private_Type (T)
6580 and then not Has_Been_Exchanged (T)
6581 and then Etype (Get_Associated_Node (N)) /= T
6582 then
6583 -- Only the private declaration was visible in the generic. If
6584 -- the type appears in a subtype declaration, the subtype in the
6585 -- instance must have a view compatible with that of its parent,
6586 -- which must be exchanged (see corresponding code in Restore_
6587 -- Private_Views). Otherwise, if the type is defined in a parent
6588 -- unit, leave full visibility within instance, which is safe.
6590 if In_Open_Scopes (Scope (Base_Type (T)))
6591 and then not Is_Private_Type (Base_Type (T))
6592 and then Comes_From_Source (Base_Type (T))
6593 then
6594 null;
6596 elsif Nkind (Parent (N)) = N_Subtype_Declaration
6597 or else not In_Private_Part (Scope (Base_Type (T)))
6598 then
6599 Prepend_Elmt (T, Exchanged_Views);
6600 Exchange_Declarations (Etype (Get_Associated_Node (N)));
6601 end if;
6603 -- For composite types with inconsistent representation exchange
6604 -- component types accordingly.
6606 elsif Is_Access_Type (T)
6607 and then Is_Private_Type (Designated_Type (T))
6608 and then not Has_Private_View (N)
6609 and then Present (Full_View (Designated_Type (T)))
6610 then
6611 Switch_View (Designated_Type (T));
6613 elsif Is_Array_Type (T) then
6614 if Is_Private_Type (Component_Type (T))
6615 and then not Has_Private_View (N)
6616 and then Present (Full_View (Component_Type (T)))
6617 then
6618 Switch_View (Component_Type (T));
6619 end if;
6621 -- The normal exchange mechanism relies on the setting of a
6622 -- flag on the reference in the generic. However, an additional
6623 -- mechanism is needed for types that are not explicitly
6624 -- mentioned in the generic, but may be needed in expanded code
6625 -- in the instance. This includes component types of arrays and
6626 -- designated types of access types. This processing must also
6627 -- include the index types of arrays which we take care of here.
6629 declare
6630 Indx : Node_Id;
6631 Typ : Entity_Id;
6633 begin
6634 Indx := First_Index (T);
6635 while Present (Indx) loop
6636 Typ := Base_Type (Etype (Indx));
6638 if Is_Private_Type (Typ)
6639 and then Present (Full_View (Typ))
6640 then
6641 Switch_View (Typ);
6642 end if;
6644 Next_Index (Indx);
6645 end loop;
6646 end;
6648 elsif Is_Private_Type (T)
6649 and then Present (Full_View (T))
6650 and then Is_Array_Type (Full_View (T))
6651 and then Is_Private_Type (Component_Type (Full_View (T)))
6652 then
6653 Switch_View (T);
6655 -- Finally, a non-private subtype may have a private base type, which
6656 -- must be exchanged for consistency. This can happen when a package
6657 -- body is instantiated, when the scope stack is empty but in fact
6658 -- the subtype and the base type are declared in an enclosing scope.
6660 -- Note that in this case we introduce an inconsistency in the view
6661 -- set, because we switch the base type BT, but there could be some
6662 -- private dependent subtypes of BT which remain unswitched. Such
6663 -- subtypes might need to be switched at a later point (see specific
6664 -- provision for that case in Switch_View).
6666 elsif not Is_Private_Type (T)
6667 and then not Has_Private_View (N)
6668 and then Is_Private_Type (BT)
6669 and then Present (Full_View (BT))
6670 and then not Is_Generic_Type (BT)
6671 and then not In_Open_Scopes (BT)
6672 then
6673 Prepend_Elmt (Full_View (BT), Exchanged_Views);
6674 Exchange_Declarations (BT);
6675 end if;
6676 end if;
6677 end Check_Private_View;
6679 -----------------------------
6680 -- Check_Hidden_Primitives --
6681 -----------------------------
6683 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6684 Actual : Node_Id;
6685 Gen_T : Entity_Id;
6686 Result : Elist_Id := No_Elist;
6688 begin
6689 if No (Assoc_List) then
6690 return No_Elist;
6691 end if;
6693 -- Traverse the list of associations between formals and actuals
6694 -- searching for renamings of tagged types
6696 Actual := First (Assoc_List);
6697 while Present (Actual) loop
6698 if Nkind (Actual) = N_Subtype_Declaration then
6699 Gen_T := Generic_Parent_Type (Actual);
6701 if Present (Gen_T)
6702 and then Is_Tagged_Type (Gen_T)
6703 then
6704 -- Traverse the list of primitives of the actual types
6705 -- searching for hidden primitives that are visible in the
6706 -- corresponding generic formal; leave them visible and
6707 -- append them to Result to restore their decoration later.
6709 Install_Hidden_Primitives
6710 (Prims_List => Result,
6711 Gen_T => Gen_T,
6712 Act_T => Entity (Subtype_Indication (Actual)));
6713 end if;
6714 end if;
6716 Next (Actual);
6717 end loop;
6719 return Result;
6720 end Check_Hidden_Primitives;
6722 --------------------------
6723 -- Contains_Instance_Of --
6724 --------------------------
6726 function Contains_Instance_Of
6727 (Inner : Entity_Id;
6728 Outer : Entity_Id;
6729 N : Node_Id) return Boolean
6731 Elmt : Elmt_Id;
6732 Scop : Entity_Id;
6734 begin
6735 Scop := Outer;
6737 -- Verify that there are no circular instantiations. We check whether
6738 -- the unit contains an instance of the current scope or some enclosing
6739 -- scope (in case one of the instances appears in a subunit). Longer
6740 -- circularities involving subunits might seem too pathological to
6741 -- consider, but they were not too pathological for the authors of
6742 -- DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6743 -- enclosing generic scopes as containing an instance.
6745 loop
6746 -- Within a generic subprogram body, the scope is not generic, to
6747 -- allow for recursive subprograms. Use the declaration to determine
6748 -- whether this is a generic unit.
6750 if Ekind (Scop) = E_Generic_Package
6751 or else (Is_Subprogram (Scop)
6752 and then Nkind (Unit_Declaration_Node (Scop)) =
6753 N_Generic_Subprogram_Declaration)
6754 then
6755 Elmt := First_Elmt (Inner_Instances (Inner));
6757 while Present (Elmt) loop
6758 if Node (Elmt) = Scop then
6759 Error_Msg_Node_2 := Inner;
6760 Error_Msg_NE
6761 ("circular Instantiation: & instantiated within &!",
6762 N, Scop);
6763 return True;
6765 elsif Node (Elmt) = Inner then
6766 return True;
6768 elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6769 Error_Msg_Node_2 := Inner;
6770 Error_Msg_NE
6771 ("circular Instantiation: & instantiated within &!",
6772 N, Node (Elmt));
6773 return True;
6774 end if;
6776 Next_Elmt (Elmt);
6777 end loop;
6779 -- Indicate that Inner is being instantiated within Scop
6781 Append_Elmt (Inner, Inner_Instances (Scop));
6782 end if;
6784 if Scop = Standard_Standard then
6785 exit;
6786 else
6787 Scop := Scope (Scop);
6788 end if;
6789 end loop;
6791 return False;
6792 end Contains_Instance_Of;
6794 -----------------------
6795 -- Copy_Generic_Node --
6796 -----------------------
6798 function Copy_Generic_Node
6799 (N : Node_Id;
6800 Parent_Id : Node_Id;
6801 Instantiating : Boolean) return Node_Id
6803 Ent : Entity_Id;
6804 New_N : Node_Id;
6806 function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6807 -- Check the given value of one of the Fields referenced by the current
6808 -- node to determine whether to copy it recursively. The field may hold
6809 -- a Node_Id, a List_Id, or an Elist_Id, or a plain value (Sloc, Uint,
6810 -- Char) in which case it need not be copied.
6812 procedure Copy_Descendants;
6813 -- Common utility for various nodes
6815 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6816 -- Make copy of element list
6818 function Copy_Generic_List
6819 (L : List_Id;
6820 Parent_Id : Node_Id) return List_Id;
6821 -- Apply Copy_Node recursively to the members of a node list
6823 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6824 -- True if an identifier is part of the defining program unit name of
6825 -- a child unit. The entity of such an identifier must be kept (for
6826 -- ASIS use) even though as the name of an enclosing generic it would
6827 -- otherwise not be preserved in the generic tree.
6829 ----------------------
6830 -- Copy_Descendants --
6831 ----------------------
6833 procedure Copy_Descendants is
6835 use Atree.Unchecked_Access;
6836 -- This code section is part of the implementation of an untyped
6837 -- tree traversal, so it needs direct access to node fields.
6839 begin
6840 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6841 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6842 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6843 Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6844 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6845 end Copy_Descendants;
6847 -----------------------------
6848 -- Copy_Generic_Descendant --
6849 -----------------------------
6851 function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6852 begin
6853 if D = Union_Id (Empty) then
6854 return D;
6856 elsif D in Node_Range then
6857 return Union_Id
6858 (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6860 elsif D in List_Range then
6861 return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6863 elsif D in Elist_Range then
6864 return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6866 -- Nothing else is copyable (e.g. Uint values), return as is
6868 else
6869 return D;
6870 end if;
6871 end Copy_Generic_Descendant;
6873 ------------------------
6874 -- Copy_Generic_Elist --
6875 ------------------------
6877 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6878 M : Elmt_Id;
6879 L : Elist_Id;
6881 begin
6882 if Present (E) then
6883 L := New_Elmt_List;
6884 M := First_Elmt (E);
6885 while Present (M) loop
6886 Append_Elmt
6887 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6888 Next_Elmt (M);
6889 end loop;
6891 return L;
6893 else
6894 return No_Elist;
6895 end if;
6896 end Copy_Generic_Elist;
6898 -----------------------
6899 -- Copy_Generic_List --
6900 -----------------------
6902 function Copy_Generic_List
6903 (L : List_Id;
6904 Parent_Id : Node_Id) return List_Id
6906 N : Node_Id;
6907 New_L : List_Id;
6909 begin
6910 if Present (L) then
6911 New_L := New_List;
6912 Set_Parent (New_L, Parent_Id);
6914 N := First (L);
6915 while Present (N) loop
6916 Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6917 Next (N);
6918 end loop;
6920 return New_L;
6922 else
6923 return No_List;
6924 end if;
6925 end Copy_Generic_List;
6927 ---------------------------
6928 -- In_Defining_Unit_Name --
6929 ---------------------------
6931 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6932 begin
6933 return Present (Parent (Nam))
6934 and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6935 or else
6936 (Nkind (Parent (Nam)) = N_Expanded_Name
6937 and then In_Defining_Unit_Name (Parent (Nam))));
6938 end In_Defining_Unit_Name;
6940 -- Start of processing for Copy_Generic_Node
6942 begin
6943 if N = Empty then
6944 return N;
6945 end if;
6947 New_N := New_Copy (N);
6949 -- Copy aspects if present
6951 if Has_Aspects (N) then
6952 Set_Has_Aspects (New_N, False);
6953 Set_Aspect_Specifications
6954 (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6955 end if;
6957 if Instantiating then
6958 Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6959 end if;
6961 if not Is_List_Member (N) then
6962 Set_Parent (New_N, Parent_Id);
6963 end if;
6965 -- If defining identifier, then all fields have been copied already
6967 if Nkind (New_N) in N_Entity then
6968 null;
6970 -- Special casing for identifiers and other entity names and operators
6972 elsif Nkind_In (New_N, N_Identifier,
6973 N_Character_Literal,
6974 N_Expanded_Name,
6975 N_Operator_Symbol)
6976 or else Nkind (New_N) in N_Op
6977 then
6978 if not Instantiating then
6980 -- Link both nodes in order to assign subsequently the entity of
6981 -- the copy to the original node, in case this is a global
6982 -- reference.
6984 Set_Associated_Node (N, New_N);
6986 -- If we are within an instantiation, this is a nested generic
6987 -- that has already been analyzed at the point of definition.
6988 -- We must preserve references that were global to the enclosing
6989 -- parent at that point. Other occurrences, whether global or
6990 -- local to the current generic, must be resolved anew, so we
6991 -- reset the entity in the generic copy. A global reference has a
6992 -- smaller depth than the parent, or else the same depth in case
6993 -- both are distinct compilation units.
6995 -- A child unit is implicitly declared within the enclosing parent
6996 -- but is in fact global to it, and must be preserved.
6998 -- It is also possible for Current_Instantiated_Parent to be
6999 -- defined, and for this not to be a nested generic, namely if
7000 -- the unit is loaded through Rtsfind. In that case, the entity of
7001 -- New_N is only a link to the associated node, and not a defining
7002 -- occurrence.
7004 -- The entities for parent units in the defining_program_unit of a
7005 -- generic child unit are established when the context of the unit
7006 -- is first analyzed, before the generic copy is made. They are
7007 -- preserved in the copy for use in ASIS queries.
7009 Ent := Entity (New_N);
7011 if No (Current_Instantiated_Parent.Gen_Id) then
7012 if No (Ent)
7013 or else Nkind (Ent) /= N_Defining_Identifier
7014 or else not In_Defining_Unit_Name (N)
7015 then
7016 Set_Associated_Node (New_N, Empty);
7017 end if;
7019 elsif No (Ent)
7020 or else
7021 not Nkind_In (Ent, N_Defining_Identifier,
7022 N_Defining_Character_Literal,
7023 N_Defining_Operator_Symbol)
7024 or else No (Scope (Ent))
7025 or else
7026 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
7027 and then not Is_Child_Unit (Ent))
7028 or else
7029 (Scope_Depth (Scope (Ent)) >
7030 Scope_Depth (Current_Instantiated_Parent.Gen_Id)
7031 and then
7032 Get_Source_Unit (Ent) =
7033 Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
7034 then
7035 Set_Associated_Node (New_N, Empty);
7036 end if;
7038 -- Case of instantiating identifier or some other name or operator
7040 else
7041 -- If the associated node is still defined, the entity in it
7042 -- is global, and must be copied to the instance. If this copy
7043 -- is being made for a body to inline, it is applied to an
7044 -- instantiated tree, and the entity is already present and
7045 -- must be also preserved.
7047 declare
7048 Assoc : constant Node_Id := Get_Associated_Node (N);
7050 begin
7051 if Present (Assoc) then
7052 if Nkind (Assoc) = Nkind (N) then
7053 Set_Entity (New_N, Entity (Assoc));
7054 Check_Private_View (N);
7056 -- The name in the call may be a selected component if the
7057 -- call has not been analyzed yet, as may be the case for
7058 -- pre/post conditions in a generic unit.
7060 elsif Nkind (Assoc) = N_Function_Call
7061 and then Is_Entity_Name (Name (Assoc))
7062 then
7063 Set_Entity (New_N, Entity (Name (Assoc)));
7065 elsif Nkind_In (Assoc, N_Defining_Identifier,
7066 N_Defining_Character_Literal,
7067 N_Defining_Operator_Symbol)
7068 and then Expander_Active
7069 then
7070 -- Inlining case: we are copying a tree that contains
7071 -- global entities, which are preserved in the copy to be
7072 -- used for subsequent inlining.
7074 null;
7076 else
7077 Set_Entity (New_N, Empty);
7078 end if;
7079 end if;
7080 end;
7081 end if;
7083 -- For expanded name, we must copy the Prefix and Selector_Name
7085 if Nkind (N) = N_Expanded_Name then
7086 Set_Prefix
7087 (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
7089 Set_Selector_Name (New_N,
7090 Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
7092 -- For operators, we must copy the right operand
7094 elsif Nkind (N) in N_Op then
7095 Set_Right_Opnd (New_N,
7096 Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
7098 -- And for binary operators, the left operand as well
7100 if Nkind (N) in N_Binary_Op then
7101 Set_Left_Opnd (New_N,
7102 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
7103 end if;
7104 end if;
7106 -- Special casing for stubs
7108 elsif Nkind (N) in N_Body_Stub then
7110 -- In any case, we must copy the specification or defining
7111 -- identifier as appropriate.
7113 if Nkind (N) = N_Subprogram_Body_Stub then
7114 Set_Specification (New_N,
7115 Copy_Generic_Node (Specification (N), New_N, Instantiating));
7117 else
7118 Set_Defining_Identifier (New_N,
7119 Copy_Generic_Node
7120 (Defining_Identifier (N), New_N, Instantiating));
7121 end if;
7123 -- If we are not instantiating, then this is where we load and
7124 -- analyze subunits, i.e. at the point where the stub occurs. A
7125 -- more permissive system might defer this analysis to the point
7126 -- of instantiation, but this seems too complicated for now.
7128 if not Instantiating then
7129 declare
7130 Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
7131 Subunit : Node_Id;
7132 Unum : Unit_Number_Type;
7133 New_Body : Node_Id;
7135 begin
7136 -- Make sure that, if it is a subunit of the main unit that is
7137 -- preprocessed and if -gnateG is specified, the preprocessed
7138 -- file will be written.
7140 Lib.Analysing_Subunit_Of_Main :=
7141 Lib.In_Extended_Main_Source_Unit (N);
7142 Unum :=
7143 Load_Unit
7144 (Load_Name => Subunit_Name,
7145 Required => False,
7146 Subunit => True,
7147 Error_Node => N);
7148 Lib.Analysing_Subunit_Of_Main := False;
7150 -- If the proper body is not found, a warning message will be
7151 -- emitted when analyzing the stub, or later at the point of
7152 -- instantiation. Here we just leave the stub as is.
7154 if Unum = No_Unit then
7155 Subunits_Missing := True;
7156 goto Subunit_Not_Found;
7157 end if;
7159 Subunit := Cunit (Unum);
7161 if Nkind (Unit (Subunit)) /= N_Subunit then
7162 Error_Msg_N
7163 ("found child unit instead of expected SEPARATE subunit",
7164 Subunit);
7165 Error_Msg_Sloc := Sloc (N);
7166 Error_Msg_N ("\to complete stub #", Subunit);
7167 goto Subunit_Not_Found;
7168 end if;
7170 -- We must create a generic copy of the subunit, in order to
7171 -- perform semantic analysis on it, and we must replace the
7172 -- stub in the original generic unit with the subunit, in order
7173 -- to preserve non-local references within.
7175 -- Only the proper body needs to be copied. Library_Unit and
7176 -- context clause are simply inherited by the generic copy.
7177 -- Note that the copy (which may be recursive if there are
7178 -- nested subunits) must be done first, before attaching it to
7179 -- the enclosing generic.
7181 New_Body :=
7182 Copy_Generic_Node
7183 (Proper_Body (Unit (Subunit)),
7184 Empty, Instantiating => False);
7186 -- Now place the original proper body in the original generic
7187 -- unit. This is a body, not a compilation unit.
7189 Rewrite (N, Proper_Body (Unit (Subunit)));
7190 Set_Is_Compilation_Unit (Defining_Entity (N), False);
7191 Set_Was_Originally_Stub (N);
7193 -- Finally replace the body of the subunit with its copy, and
7194 -- make this new subunit into the library unit of the generic
7195 -- copy, which does not have stubs any longer.
7197 Set_Proper_Body (Unit (Subunit), New_Body);
7198 Set_Library_Unit (New_N, Subunit);
7199 Inherit_Context (Unit (Subunit), N);
7200 end;
7202 -- If we are instantiating, this must be an error case, since
7203 -- otherwise we would have replaced the stub node by the proper body
7204 -- that corresponds. So just ignore it in the copy (i.e. we have
7205 -- copied it, and that is good enough).
7207 else
7208 null;
7209 end if;
7211 <<Subunit_Not_Found>> null;
7213 -- If the node is a compilation unit, it is the subunit of a stub, which
7214 -- has been loaded already (see code below). In this case, the library
7215 -- unit field of N points to the parent unit (which is a compilation
7216 -- unit) and need not (and cannot) be copied.
7218 -- When the proper body of the stub is analyzed, the library_unit link
7219 -- is used to establish the proper context (see sem_ch10).
7221 -- The other fields of a compilation unit are copied as usual
7223 elsif Nkind (N) = N_Compilation_Unit then
7225 -- This code can only be executed when not instantiating, because in
7226 -- the copy made for an instantiation, the compilation unit node has
7227 -- disappeared at the point that a stub is replaced by its proper
7228 -- body.
7230 pragma Assert (not Instantiating);
7232 Set_Context_Items (New_N,
7233 Copy_Generic_List (Context_Items (N), New_N));
7235 Set_Unit (New_N,
7236 Copy_Generic_Node (Unit (N), New_N, False));
7238 Set_First_Inlined_Subprogram (New_N,
7239 Copy_Generic_Node
7240 (First_Inlined_Subprogram (N), New_N, False));
7242 Set_Aux_Decls_Node (New_N,
7243 Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
7245 -- For an assignment node, the assignment is known to be semantically
7246 -- legal if we are instantiating the template. This avoids incorrect
7247 -- diagnostics in generated code.
7249 elsif Nkind (N) = N_Assignment_Statement then
7251 -- Copy name and expression fields in usual manner
7253 Set_Name (New_N,
7254 Copy_Generic_Node (Name (N), New_N, Instantiating));
7256 Set_Expression (New_N,
7257 Copy_Generic_Node (Expression (N), New_N, Instantiating));
7259 if Instantiating then
7260 Set_Assignment_OK (Name (New_N), True);
7261 end if;
7263 elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
7264 if not Instantiating then
7265 Set_Associated_Node (N, New_N);
7267 else
7268 if Present (Get_Associated_Node (N))
7269 and then Nkind (Get_Associated_Node (N)) = Nkind (N)
7270 then
7271 -- In the generic the aggregate has some composite type. If at
7272 -- the point of instantiation the type has a private view,
7273 -- install the full view (and that of its ancestors, if any).
7275 declare
7276 T : Entity_Id := (Etype (Get_Associated_Node (New_N)));
7277 Rt : Entity_Id;
7279 begin
7280 if Present (T)
7281 and then Is_Private_Type (T)
7282 then
7283 Switch_View (T);
7284 end if;
7286 if Present (T)
7287 and then Is_Tagged_Type (T)
7288 and then Is_Derived_Type (T)
7289 then
7290 Rt := Root_Type (T);
7292 loop
7293 T := Etype (T);
7295 if Is_Private_Type (T) then
7296 Switch_View (T);
7297 end if;
7299 exit when T = Rt;
7300 end loop;
7301 end if;
7302 end;
7303 end if;
7304 end if;
7306 -- Do not copy the associated node, which points to the generic copy
7307 -- of the aggregate.
7309 declare
7310 use Atree.Unchecked_Access;
7311 -- This code section is part of the implementation of an untyped
7312 -- tree traversal, so it needs direct access to node fields.
7314 begin
7315 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
7316 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
7317 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
7318 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
7319 end;
7321 -- Allocators do not have an identifier denoting the access type, so we
7322 -- must locate it through the expression to check whether the views are
7323 -- consistent.
7325 elsif Nkind (N) = N_Allocator
7326 and then Nkind (Expression (N)) = N_Qualified_Expression
7327 and then Is_Entity_Name (Subtype_Mark (Expression (N)))
7328 and then Instantiating
7329 then
7330 declare
7331 T : constant Node_Id :=
7332 Get_Associated_Node (Subtype_Mark (Expression (N)));
7333 Acc_T : Entity_Id;
7335 begin
7336 if Present (T) then
7338 -- Retrieve the allocator node in the generic copy
7340 Acc_T := Etype (Parent (Parent (T)));
7341 if Present (Acc_T)
7342 and then Is_Private_Type (Acc_T)
7343 then
7344 Switch_View (Acc_T);
7345 end if;
7346 end if;
7348 Copy_Descendants;
7349 end;
7351 -- For a proper body, we must catch the case of a proper body that
7352 -- replaces a stub. This represents the point at which a separate
7353 -- compilation unit, and hence template file, may be referenced, so we
7354 -- must make a new source instantiation entry for the template of the
7355 -- subunit, and ensure that all nodes in the subunit are adjusted using
7356 -- this new source instantiation entry.
7358 elsif Nkind (N) in N_Proper_Body then
7359 declare
7360 Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
7362 begin
7363 if Instantiating and then Was_Originally_Stub (N) then
7364 Create_Instantiation_Source
7365 (Instantiation_Node,
7366 Defining_Entity (N),
7367 False,
7368 S_Adjustment);
7369 end if;
7371 -- Now copy the fields of the proper body, using the new
7372 -- adjustment factor if one was needed as per test above.
7374 Copy_Descendants;
7376 -- Restore the original adjustment factor in case changed
7378 S_Adjustment := Save_Adjustment;
7379 end;
7381 -- Don't copy Ident or Comment pragmas, since the comment belongs to the
7382 -- generic unit, not to the instantiating unit.
7384 elsif Nkind (N) = N_Pragma and then Instantiating then
7385 declare
7386 Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
7387 begin
7388 if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
7389 New_N := Make_Null_Statement (Sloc (N));
7390 else
7391 Copy_Descendants;
7392 end if;
7393 end;
7395 elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
7397 -- No descendant fields need traversing
7399 null;
7401 elsif Nkind (N) = N_String_Literal
7402 and then Present (Etype (N))
7403 and then Instantiating
7404 then
7405 -- If the string is declared in an outer scope, the string_literal
7406 -- subtype created for it may have the wrong scope. We force the
7407 -- reanalysis of the constant to generate a new itype in the proper
7408 -- context.
7410 Set_Etype (New_N, Empty);
7411 Set_Analyzed (New_N, False);
7413 -- For the remaining nodes, copy their descendants recursively
7415 else
7416 Copy_Descendants;
7418 if Instantiating and then Nkind (N) = N_Subprogram_Body then
7419 Set_Generic_Parent (Specification (New_N), N);
7421 -- Should preserve Corresponding_Spec??? (12.3(14))
7422 end if;
7423 end if;
7425 return New_N;
7426 end Copy_Generic_Node;
7428 ----------------------------
7429 -- Denotes_Formal_Package --
7430 ----------------------------
7432 function Denotes_Formal_Package
7433 (Pack : Entity_Id;
7434 On_Exit : Boolean := False;
7435 Instance : Entity_Id := Empty) return Boolean
7437 Par : Entity_Id;
7438 Scop : constant Entity_Id := Scope (Pack);
7439 E : Entity_Id;
7441 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
7442 -- The package in question may be an actual for a previous formal
7443 -- package P of the current instance, so examine its actuals as well.
7444 -- This must be recursive over other formal packages.
7446 ----------------------------------
7447 -- Is_Actual_Of_Previous_Formal --
7448 ----------------------------------
7450 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
7451 E1 : Entity_Id;
7453 begin
7454 E1 := First_Entity (P);
7455 while Present (E1) and then E1 /= Instance loop
7456 if Ekind (E1) = E_Package
7457 and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
7458 then
7459 if Renamed_Object (E1) = Pack then
7460 return True;
7462 elsif E1 = P or else Renamed_Object (E1) = P then
7463 return False;
7465 elsif Is_Actual_Of_Previous_Formal (E1) then
7466 return True;
7467 end if;
7468 end if;
7470 Next_Entity (E1);
7471 end loop;
7473 return False;
7474 end Is_Actual_Of_Previous_Formal;
7476 -- Start of processing for Denotes_Formal_Package
7478 begin
7479 if On_Exit then
7480 Par :=
7481 Instance_Envs.Table
7482 (Instance_Envs.Last).Instantiated_Parent.Act_Id;
7483 else
7484 Par := Current_Instantiated_Parent.Act_Id;
7485 end if;
7487 if Ekind (Scop) = E_Generic_Package
7488 or else Nkind (Unit_Declaration_Node (Scop)) =
7489 N_Generic_Subprogram_Declaration
7490 then
7491 return True;
7493 elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
7494 N_Formal_Package_Declaration
7495 then
7496 return True;
7498 elsif No (Par) then
7499 return False;
7501 else
7502 -- Check whether this package is associated with a formal package of
7503 -- the enclosing instantiation. Iterate over the list of renamings.
7505 E := First_Entity (Par);
7506 while Present (E) loop
7507 if Ekind (E) /= E_Package
7508 or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
7509 then
7510 null;
7512 elsif Renamed_Object (E) = Par then
7513 return False;
7515 elsif Renamed_Object (E) = Pack then
7516 return True;
7518 elsif Is_Actual_Of_Previous_Formal (E) then
7519 return True;
7521 end if;
7523 Next_Entity (E);
7524 end loop;
7526 return False;
7527 end if;
7528 end Denotes_Formal_Package;
7530 -----------------
7531 -- End_Generic --
7532 -----------------
7534 procedure End_Generic is
7535 begin
7536 -- ??? More things could be factored out in this routine. Should
7537 -- probably be done at a later stage.
7539 Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
7540 Generic_Flags.Decrement_Last;
7542 Expander_Mode_Restore;
7543 end End_Generic;
7545 -------------
7546 -- Earlier --
7547 -------------
7549 function Earlier (N1, N2 : Node_Id) return Boolean is
7550 procedure Find_Depth (P : in out Node_Id; D : in out Integer);
7551 -- Find distance from given node to enclosing compilation unit
7553 ----------------
7554 -- Find_Depth --
7555 ----------------
7557 procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
7558 begin
7559 while Present (P)
7560 and then Nkind (P) /= N_Compilation_Unit
7561 loop
7562 P := True_Parent (P);
7563 D := D + 1;
7564 end loop;
7565 end Find_Depth;
7567 -- Local declarations
7569 D1 : Integer := 0;
7570 D2 : Integer := 0;
7571 P1 : Node_Id := N1;
7572 P2 : Node_Id := N2;
7573 T1 : Source_Ptr;
7574 T2 : Source_Ptr;
7576 -- Start of processing for Earlier
7578 begin
7579 Find_Depth (P1, D1);
7580 Find_Depth (P2, D2);
7582 if P1 /= P2 then
7583 return False;
7584 else
7585 P1 := N1;
7586 P2 := N2;
7587 end if;
7589 while D1 > D2 loop
7590 P1 := True_Parent (P1);
7591 D1 := D1 - 1;
7592 end loop;
7594 while D2 > D1 loop
7595 P2 := True_Parent (P2);
7596 D2 := D2 - 1;
7597 end loop;
7599 -- At this point P1 and P2 are at the same distance from the root.
7600 -- We examine their parents until we find a common declarative list.
7601 -- If we reach the root, N1 and N2 do not descend from the same
7602 -- declarative list (e.g. one is nested in the declarative part and
7603 -- the other is in a block in the statement part) and the earlier
7604 -- one is already frozen.
7606 while not Is_List_Member (P1)
7607 or else not Is_List_Member (P2)
7608 or else List_Containing (P1) /= List_Containing (P2)
7609 loop
7610 P1 := True_Parent (P1);
7611 P2 := True_Parent (P2);
7613 if Nkind (Parent (P1)) = N_Subunit then
7614 P1 := Corresponding_Stub (Parent (P1));
7615 end if;
7617 if Nkind (Parent (P2)) = N_Subunit then
7618 P2 := Corresponding_Stub (Parent (P2));
7619 end if;
7621 if P1 = P2 then
7622 return False;
7623 end if;
7624 end loop;
7626 -- Expanded code usually shares the source location of the original
7627 -- construct it was generated for. This however may not necessarely
7628 -- reflect the true location of the code within the tree.
7630 -- Before comparing the slocs of the two nodes, make sure that we are
7631 -- working with correct source locations. Assume that P1 is to the left
7632 -- of P2. If either one does not come from source, traverse the common
7633 -- list heading towards the other node and locate the first source
7634 -- statement.
7636 -- P1 P2
7637 -- ----+===+===+--------------+===+===+----
7638 -- expanded code expanded code
7640 if not Comes_From_Source (P1) then
7641 while Present (P1) loop
7643 -- Neither P2 nor a source statement were located during the
7644 -- search. If we reach the end of the list, then P1 does not
7645 -- occur earlier than P2.
7647 -- ---->
7648 -- start --- P2 ----- P1 --- end
7650 if No (Next (P1)) then
7651 return False;
7653 -- We encounter P2 while going to the right of the list. This
7654 -- means that P1 does indeed appear earlier.
7656 -- ---->
7657 -- start --- P1 ===== P2 --- end
7658 -- expanded code in between
7660 elsif P1 = P2 then
7661 return True;
7663 -- No need to look any further since we have located a source
7664 -- statement.
7666 elsif Comes_From_Source (P1) then
7667 exit;
7668 end if;
7670 -- Keep going right
7672 Next (P1);
7673 end loop;
7674 end if;
7676 if not Comes_From_Source (P2) then
7677 while Present (P2) loop
7679 -- Neither P1 nor a source statement were located during the
7680 -- search. If we reach the start of the list, then P1 does not
7681 -- occur earlier than P2.
7683 -- <----
7684 -- start --- P2 --- P1 --- end
7686 if No (Prev (P2)) then
7687 return False;
7689 -- We encounter P1 while going to the left of the list. This
7690 -- means that P1 does indeed appear earlier.
7692 -- <----
7693 -- start --- P1 ===== P2 --- end
7694 -- expanded code in between
7696 elsif P2 = P1 then
7697 return True;
7699 -- No need to look any further since we have located a source
7700 -- statement.
7702 elsif Comes_From_Source (P2) then
7703 exit;
7704 end if;
7706 -- Keep going left
7708 Prev (P2);
7709 end loop;
7710 end if;
7712 -- At this point either both nodes came from source or we approximated
7713 -- their source locations through neighbouring source statements.
7715 T1 := Top_Level_Location (Sloc (P1));
7716 T2 := Top_Level_Location (Sloc (P2));
7718 -- When two nodes come from the same instance, they have identical top
7719 -- level locations. To determine proper relation within the tree, check
7720 -- their locations within the template.
7722 if T1 = T2 then
7723 return Sloc (P1) < Sloc (P2);
7725 -- The two nodes either come from unrelated instances or do not come
7726 -- from instantiated code at all.
7728 else
7729 return T1 < T2;
7730 end if;
7731 end Earlier;
7733 ----------------------
7734 -- Find_Actual_Type --
7735 ----------------------
7737 function Find_Actual_Type
7738 (Typ : Entity_Id;
7739 Gen_Type : Entity_Id) return Entity_Id
7741 Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7742 T : Entity_Id;
7744 begin
7745 -- Special processing only applies to child units
7747 if not Is_Child_Unit (Gen_Scope) then
7748 return Get_Instance_Of (Typ);
7750 -- If designated or component type is itself a formal of the child unit,
7751 -- its instance is available.
7753 elsif Scope (Typ) = Gen_Scope then
7754 return Get_Instance_Of (Typ);
7756 -- If the array or access type is not declared in the parent unit,
7757 -- no special processing needed.
7759 elsif not Is_Generic_Type (Typ)
7760 and then Scope (Gen_Scope) /= Scope (Typ)
7761 then
7762 return Get_Instance_Of (Typ);
7764 -- Otherwise, retrieve designated or component type by visibility
7766 else
7767 T := Current_Entity (Typ);
7768 while Present (T) loop
7769 if In_Open_Scopes (Scope (T)) then
7770 return T;
7772 elsif Is_Generic_Actual_Type (T) then
7773 return T;
7774 end if;
7776 T := Homonym (T);
7777 end loop;
7779 return Typ;
7780 end if;
7781 end Find_Actual_Type;
7783 ----------------------------
7784 -- Freeze_Subprogram_Body --
7785 ----------------------------
7787 procedure Freeze_Subprogram_Body
7788 (Inst_Node : Node_Id;
7789 Gen_Body : Node_Id;
7790 Pack_Id : Entity_Id)
7792 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7793 Par : constant Entity_Id := Scope (Gen_Unit);
7794 E_G_Id : Entity_Id;
7795 Enc_G : Entity_Id;
7796 Enc_I : Node_Id;
7797 F_Node : Node_Id;
7799 function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7800 -- Find innermost package body that encloses the given node, and which
7801 -- is not a compilation unit. Freeze nodes for the instance, or for its
7802 -- enclosing body, may be inserted after the enclosing_body of the
7803 -- generic unit. Used to determine proper placement of freeze node for
7804 -- both package and subprogram instances.
7806 function Package_Freeze_Node (B : Node_Id) return Node_Id;
7807 -- Find entity for given package body, and locate or create a freeze
7808 -- node for it.
7810 ----------------------------
7811 -- Enclosing_Package_Body --
7812 ----------------------------
7814 function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7815 P : Node_Id;
7817 begin
7818 P := Parent (N);
7819 while Present (P)
7820 and then Nkind (Parent (P)) /= N_Compilation_Unit
7821 loop
7822 if Nkind (P) = N_Package_Body then
7823 if Nkind (Parent (P)) = N_Subunit then
7824 return Corresponding_Stub (Parent (P));
7825 else
7826 return P;
7827 end if;
7828 end if;
7830 P := True_Parent (P);
7831 end loop;
7833 return Empty;
7834 end Enclosing_Package_Body;
7836 -------------------------
7837 -- Package_Freeze_Node --
7838 -------------------------
7840 function Package_Freeze_Node (B : Node_Id) return Node_Id is
7841 Id : Entity_Id;
7843 begin
7844 if Nkind (B) = N_Package_Body then
7845 Id := Corresponding_Spec (B);
7846 else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7847 Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7848 end if;
7850 Ensure_Freeze_Node (Id);
7851 return Freeze_Node (Id);
7852 end Package_Freeze_Node;
7854 -- Start of processing of Freeze_Subprogram_Body
7856 begin
7857 -- If the instance and the generic body appear within the same unit, and
7858 -- the instance precedes the generic, the freeze node for the instance
7859 -- must appear after that of the generic. If the generic is nested
7860 -- within another instance I2, then current instance must be frozen
7861 -- after I2. In both cases, the freeze nodes are those of enclosing
7862 -- packages. Otherwise, the freeze node is placed at the end of the
7863 -- current declarative part.
7865 Enc_G := Enclosing_Package_Body (Gen_Body);
7866 Enc_I := Enclosing_Package_Body (Inst_Node);
7867 Ensure_Freeze_Node (Pack_Id);
7868 F_Node := Freeze_Node (Pack_Id);
7870 if Is_Generic_Instance (Par)
7871 and then Present (Freeze_Node (Par))
7872 and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7873 then
7874 -- The parent was a premature instantiation. Insert freeze node at
7875 -- the end the current declarative part.
7877 if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7878 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7880 -- Handle the following case:
7882 -- package Parent_Inst is new ...
7883 -- Parent_Inst []
7885 -- procedure P ... -- this body freezes Parent_Inst
7887 -- package Inst is new ...
7889 -- In this particular scenario, the freeze node for Inst must be
7890 -- inserted in the same manner as that of Parent_Inst - before the
7891 -- next source body or at the end of the declarative list (body not
7892 -- available). If body P did not exist and Parent_Inst was frozen
7893 -- after Inst, either by a body following Inst or at the end of the
7894 -- declarative region, the freeze node for Inst must be inserted
7895 -- after that of Parent_Inst. This relation is established by
7896 -- comparing the Slocs of Parent_Inst freeze node and Inst.
7898 elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7899 List_Containing (Inst_Node)
7900 and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7901 then
7902 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7904 else
7905 Insert_After (Freeze_Node (Par), F_Node);
7906 end if;
7908 -- The body enclosing the instance should be frozen after the body that
7909 -- includes the generic, because the body of the instance may make
7910 -- references to entities therein. If the two are not in the same
7911 -- declarative part, or if the one enclosing the instance is frozen
7912 -- already, freeze the instance at the end of the current declarative
7913 -- part.
7915 elsif Is_Generic_Instance (Par)
7916 and then Present (Freeze_Node (Par))
7917 and then Present (Enc_I)
7918 then
7919 if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7920 or else
7921 (Nkind (Enc_I) = N_Package_Body
7922 and then
7923 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7924 then
7925 -- The enclosing package may contain several instances. Rather
7926 -- than computing the earliest point at which to insert its freeze
7927 -- node, we place it at the end of the declarative part of the
7928 -- parent of the generic.
7930 Insert_Freeze_Node_For_Instance
7931 (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7932 end if;
7934 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7936 elsif Present (Enc_G)
7937 and then Present (Enc_I)
7938 and then Enc_G /= Enc_I
7939 and then Earlier (Inst_Node, Gen_Body)
7940 then
7941 if Nkind (Enc_G) = N_Package_Body then
7942 E_G_Id := Corresponding_Spec (Enc_G);
7943 else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7944 E_G_Id :=
7945 Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7946 end if;
7948 -- Freeze package that encloses instance, and place node after the
7949 -- package that encloses generic. If enclosing package is already
7950 -- frozen we have to assume it is at the proper place. This may be a
7951 -- potential ABE that requires dynamic checking. Do not add a freeze
7952 -- node if the package that encloses the generic is inside the body
7953 -- that encloses the instance, because the freeze node would be in
7954 -- the wrong scope. Additional contortions needed if the bodies are
7955 -- within a subunit.
7957 declare
7958 Enclosing_Body : Node_Id;
7960 begin
7961 if Nkind (Enc_I) = N_Package_Body_Stub then
7962 Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7963 else
7964 Enclosing_Body := Enc_I;
7965 end if;
7967 if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
7968 Insert_Freeze_Node_For_Instance
7969 (Enc_G, Package_Freeze_Node (Enc_I));
7970 end if;
7971 end;
7973 -- Freeze enclosing subunit before instance
7975 Ensure_Freeze_Node (E_G_Id);
7977 if not Is_List_Member (Freeze_Node (E_G_Id)) then
7978 Insert_After (Enc_G, Freeze_Node (E_G_Id));
7979 end if;
7981 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7983 else
7984 -- If none of the above, insert freeze node at the end of the current
7985 -- declarative part.
7987 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7988 end if;
7989 end Freeze_Subprogram_Body;
7991 ----------------
7992 -- Get_Gen_Id --
7993 ----------------
7995 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
7996 begin
7997 return Generic_Renamings.Table (E).Gen_Id;
7998 end Get_Gen_Id;
8000 ---------------------
8001 -- Get_Instance_Of --
8002 ---------------------
8004 function Get_Instance_Of (A : Entity_Id) return Entity_Id is
8005 Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
8007 begin
8008 if Res /= Assoc_Null then
8009 return Generic_Renamings.Table (Res).Act_Id;
8010 else
8011 -- On exit, entity is not instantiated: not a generic parameter, or
8012 -- else parameter of an inner generic unit.
8014 return A;
8015 end if;
8016 end Get_Instance_Of;
8018 ------------------------------------
8019 -- Get_Package_Instantiation_Node --
8020 ------------------------------------
8022 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
8023 Decl : Node_Id := Unit_Declaration_Node (A);
8024 Inst : Node_Id;
8026 begin
8027 -- If the Package_Instantiation attribute has been set on the package
8028 -- entity, then use it directly when it (or its Original_Node) refers
8029 -- to an N_Package_Instantiation node. In principle it should be
8030 -- possible to have this field set in all cases, which should be
8031 -- investigated, and would allow this function to be significantly
8032 -- simplified. ???
8034 Inst := Package_Instantiation (A);
8036 if Present (Inst) then
8037 if Nkind (Inst) = N_Package_Instantiation then
8038 return Inst;
8040 elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
8041 return Original_Node (Inst);
8042 end if;
8043 end if;
8045 -- If the instantiation is a compilation unit that does not need body
8046 -- then the instantiation node has been rewritten as a package
8047 -- declaration for the instance, and we return the original node.
8049 -- If it is a compilation unit and the instance node has not been
8050 -- rewritten, then it is still the unit of the compilation. Finally, if
8051 -- a body is present, this is a parent of the main unit whose body has
8052 -- been compiled for inlining purposes, and the instantiation node has
8053 -- been rewritten with the instance body.
8055 -- Otherwise the instantiation node appears after the declaration. If
8056 -- the entity is a formal package, the declaration may have been
8057 -- rewritten as a generic declaration (in the case of a formal with box)
8058 -- or left as a formal package declaration if it has actuals, and is
8059 -- found with a forward search.
8061 if Nkind (Parent (Decl)) = N_Compilation_Unit then
8062 if Nkind (Decl) = N_Package_Declaration
8063 and then Present (Corresponding_Body (Decl))
8064 then
8065 Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
8066 end if;
8068 if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
8069 return Original_Node (Decl);
8070 else
8071 return Unit (Parent (Decl));
8072 end if;
8074 elsif Nkind (Decl) = N_Package_Declaration
8075 and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
8076 then
8077 return Original_Node (Decl);
8079 else
8080 Inst := Next (Decl);
8081 while not Nkind_In (Inst, N_Package_Instantiation,
8082 N_Formal_Package_Declaration)
8083 loop
8084 Next (Inst);
8085 end loop;
8087 return Inst;
8088 end if;
8089 end Get_Package_Instantiation_Node;
8091 ------------------------
8092 -- Has_Been_Exchanged --
8093 ------------------------
8095 function Has_Been_Exchanged (E : Entity_Id) return Boolean is
8096 Next : Elmt_Id;
8098 begin
8099 Next := First_Elmt (Exchanged_Views);
8100 while Present (Next) loop
8101 if Full_View (Node (Next)) = E then
8102 return True;
8103 end if;
8105 Next_Elmt (Next);
8106 end loop;
8108 return False;
8109 end Has_Been_Exchanged;
8111 ----------
8112 -- Hash --
8113 ----------
8115 function Hash (F : Entity_Id) return HTable_Range is
8116 begin
8117 return HTable_Range (F mod HTable_Size);
8118 end Hash;
8120 ------------------------
8121 -- Hide_Current_Scope --
8122 ------------------------
8124 procedure Hide_Current_Scope is
8125 C : constant Entity_Id := Current_Scope;
8126 E : Entity_Id;
8128 begin
8129 Set_Is_Hidden_Open_Scope (C);
8131 E := First_Entity (C);
8132 while Present (E) loop
8133 if Is_Immediately_Visible (E) then
8134 Set_Is_Immediately_Visible (E, False);
8135 Append_Elmt (E, Hidden_Entities);
8136 end if;
8138 Next_Entity (E);
8139 end loop;
8141 -- Make the scope name invisible as well. This is necessary, but might
8142 -- conflict with calls to Rtsfind later on, in case the scope is a
8143 -- predefined one. There is no clean solution to this problem, so for
8144 -- now we depend on the user not redefining Standard itself in one of
8145 -- the parent units.
8147 if Is_Immediately_Visible (C) and then C /= Standard_Standard then
8148 Set_Is_Immediately_Visible (C, False);
8149 Append_Elmt (C, Hidden_Entities);
8150 end if;
8152 end Hide_Current_Scope;
8154 --------------
8155 -- Init_Env --
8156 --------------
8158 procedure Init_Env is
8159 Saved : Instance_Env;
8161 begin
8162 Saved.Instantiated_Parent := Current_Instantiated_Parent;
8163 Saved.Exchanged_Views := Exchanged_Views;
8164 Saved.Hidden_Entities := Hidden_Entities;
8165 Saved.Current_Sem_Unit := Current_Sem_Unit;
8166 Saved.Parent_Unit_Visible := Parent_Unit_Visible;
8167 Saved.Instance_Parent_Unit := Instance_Parent_Unit;
8169 -- Save configuration switches. These may be reset if the unit is a
8170 -- predefined unit, and the current mode is not Ada 2005.
8172 Save_Opt_Config_Switches (Saved.Switches);
8174 Instance_Envs.Append (Saved);
8176 Exchanged_Views := New_Elmt_List;
8177 Hidden_Entities := New_Elmt_List;
8179 -- Make dummy entry for Instantiated parent. If generic unit is legal,
8180 -- this is set properly in Set_Instance_Env.
8182 Current_Instantiated_Parent :=
8183 (Current_Scope, Current_Scope, Assoc_Null);
8184 end Init_Env;
8186 ------------------------------
8187 -- In_Same_Declarative_Part --
8188 ------------------------------
8190 function In_Same_Declarative_Part
8191 (F_Node : Node_Id;
8192 Inst : Node_Id) return Boolean
8194 Decls : constant Node_Id := Parent (F_Node);
8195 Nod : Node_Id := Parent (Inst);
8197 begin
8198 while Present (Nod) loop
8199 if Nod = Decls then
8200 return True;
8202 elsif Nkind_In (Nod, N_Subprogram_Body,
8203 N_Package_Body,
8204 N_Package_Declaration,
8205 N_Task_Body,
8206 N_Protected_Body,
8207 N_Block_Statement)
8208 then
8209 return False;
8211 elsif Nkind (Nod) = N_Subunit then
8212 Nod := Corresponding_Stub (Nod);
8214 elsif Nkind (Nod) = N_Compilation_Unit then
8215 return False;
8217 else
8218 Nod := Parent (Nod);
8219 end if;
8220 end loop;
8222 return False;
8223 end In_Same_Declarative_Part;
8225 ---------------------
8226 -- In_Main_Context --
8227 ---------------------
8229 function In_Main_Context (E : Entity_Id) return Boolean is
8230 Context : List_Id;
8231 Clause : Node_Id;
8232 Nam : Node_Id;
8234 begin
8235 if not Is_Compilation_Unit (E)
8236 or else Ekind (E) /= E_Package
8237 or else In_Private_Part (E)
8238 then
8239 return False;
8240 end if;
8242 Context := Context_Items (Cunit (Main_Unit));
8244 Clause := First (Context);
8245 while Present (Clause) loop
8246 if Nkind (Clause) = N_With_Clause then
8247 Nam := Name (Clause);
8249 -- If the current scope is part of the context of the main unit,
8250 -- analysis of the corresponding with_clause is not complete, and
8251 -- the entity is not set. We use the Chars field directly, which
8252 -- might produce false positives in rare cases, but guarantees
8253 -- that we produce all the instance bodies we will need.
8255 if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
8256 or else (Nkind (Nam) = N_Selected_Component
8257 and then Chars (Selector_Name (Nam)) = Chars (E))
8258 then
8259 return True;
8260 end if;
8261 end if;
8263 Next (Clause);
8264 end loop;
8266 return False;
8267 end In_Main_Context;
8269 ---------------------
8270 -- Inherit_Context --
8271 ---------------------
8273 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
8274 Current_Context : List_Id;
8275 Current_Unit : Node_Id;
8276 Item : Node_Id;
8277 New_I : Node_Id;
8279 Clause : Node_Id;
8280 OK : Boolean;
8281 Lib_Unit : Node_Id;
8283 begin
8284 if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
8286 -- The inherited context is attached to the enclosing compilation
8287 -- unit. This is either the main unit, or the declaration for the
8288 -- main unit (in case the instantiation appears within the package
8289 -- declaration and the main unit is its body).
8291 Current_Unit := Parent (Inst);
8292 while Present (Current_Unit)
8293 and then Nkind (Current_Unit) /= N_Compilation_Unit
8294 loop
8295 Current_Unit := Parent (Current_Unit);
8296 end loop;
8298 Current_Context := Context_Items (Current_Unit);
8300 Item := First (Context_Items (Parent (Gen_Decl)));
8301 while Present (Item) loop
8302 if Nkind (Item) = N_With_Clause then
8303 Lib_Unit := Library_Unit (Item);
8305 -- Take care to prevent direct cyclic with's
8307 if Lib_Unit /= Current_Unit then
8309 -- Do not add a unit if it is already in the context
8311 Clause := First (Current_Context);
8312 OK := True;
8313 while Present (Clause) loop
8314 if Nkind (Clause) = N_With_Clause and then
8315 Library_Unit (Clause) = Lib_Unit
8316 then
8317 OK := False;
8318 exit;
8319 end if;
8321 Next (Clause);
8322 end loop;
8324 if OK then
8325 New_I := New_Copy (Item);
8326 Set_Implicit_With (New_I, True);
8327 Set_Implicit_With_From_Instantiation (New_I, True);
8328 Append (New_I, Current_Context);
8329 end if;
8330 end if;
8331 end if;
8333 Next (Item);
8334 end loop;
8335 end if;
8336 end Inherit_Context;
8338 ----------------
8339 -- Initialize --
8340 ----------------
8342 procedure Initialize is
8343 begin
8344 Generic_Renamings.Init;
8345 Instance_Envs.Init;
8346 Generic_Flags.Init;
8347 Generic_Renamings_HTable.Reset;
8348 Circularity_Detected := False;
8349 Exchanged_Views := No_Elist;
8350 Hidden_Entities := No_Elist;
8351 end Initialize;
8353 -------------------------------------
8354 -- Insert_Freeze_Node_For_Instance --
8355 -------------------------------------
8357 procedure Insert_Freeze_Node_For_Instance
8358 (N : Node_Id;
8359 F_Node : Node_Id)
8361 Decl : Node_Id;
8362 Decls : List_Id;
8363 Inst : Entity_Id;
8364 Par_N : Node_Id;
8366 function Enclosing_Body (N : Node_Id) return Node_Id;
8367 -- Find enclosing package or subprogram body, if any. Freeze node may
8368 -- be placed at end of current declarative list if previous instance
8369 -- and current one have different enclosing bodies.
8371 function Previous_Instance (Gen : Entity_Id) return Entity_Id;
8372 -- Find the local instance, if any, that declares the generic that is
8373 -- being instantiated. If present, the freeze node for this instance
8374 -- must follow the freeze node for the previous instance.
8376 --------------------
8377 -- Enclosing_Body --
8378 --------------------
8380 function Enclosing_Body (N : Node_Id) return Node_Id is
8381 P : Node_Id;
8383 begin
8384 P := Parent (N);
8385 while Present (P)
8386 and then Nkind (Parent (P)) /= N_Compilation_Unit
8387 loop
8388 if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
8389 if Nkind (Parent (P)) = N_Subunit then
8390 return Corresponding_Stub (Parent (P));
8391 else
8392 return P;
8393 end if;
8394 end if;
8396 P := True_Parent (P);
8397 end loop;
8399 return Empty;
8400 end Enclosing_Body;
8402 -----------------------
8403 -- Previous_Instance --
8404 -----------------------
8406 function Previous_Instance (Gen : Entity_Id) return Entity_Id is
8407 S : Entity_Id;
8409 begin
8410 S := Scope (Gen);
8411 while Present (S)
8412 and then S /= Standard_Standard
8413 loop
8414 if Is_Generic_Instance (S)
8415 and then In_Same_Source_Unit (S, N)
8416 then
8417 return S;
8418 end if;
8420 S := Scope (S);
8421 end loop;
8423 return Empty;
8424 end Previous_Instance;
8426 -- Start of processing for Insert_Freeze_Node_For_Instance
8428 begin
8429 if not Is_List_Member (F_Node) then
8430 Decl := N;
8431 Decls := List_Containing (N);
8432 Inst := Entity (F_Node);
8433 Par_N := Parent (Decls);
8435 -- When processing a subprogram instantiation, utilize the actual
8436 -- subprogram instantiation rather than its package wrapper as it
8437 -- carries all the context information.
8439 if Is_Wrapper_Package (Inst) then
8440 Inst := Related_Instance (Inst);
8441 end if;
8443 -- If this is a package instance, check whether the generic is
8444 -- declared in a previous instance and the current instance is
8445 -- not within the previous one.
8447 if Present (Generic_Parent (Parent (Inst)))
8448 and then Is_In_Main_Unit (N)
8449 then
8450 declare
8451 Enclosing_N : constant Node_Id := Enclosing_Body (N);
8452 Par_I : constant Entity_Id :=
8453 Previous_Instance
8454 (Generic_Parent (Parent (Inst)));
8455 Scop : Entity_Id;
8457 begin
8458 if Present (Par_I)
8459 and then Earlier (N, Freeze_Node (Par_I))
8460 then
8461 Scop := Scope (Inst);
8463 -- If the current instance is within the one that contains
8464 -- the generic, the freeze node for the current one must
8465 -- appear in the current declarative part. Ditto, if the
8466 -- current instance is within another package instance or
8467 -- within a body that does not enclose the current instance.
8468 -- In these three cases the freeze node of the previous
8469 -- instance is not relevant.
8471 while Present (Scop)
8472 and then Scop /= Standard_Standard
8473 loop
8474 exit when Scop = Par_I
8475 or else
8476 (Is_Generic_Instance (Scop)
8477 and then Scope_Depth (Scop) > Scope_Depth (Par_I));
8478 Scop := Scope (Scop);
8479 end loop;
8481 -- Previous instance encloses current instance
8483 if Scop = Par_I then
8484 null;
8486 -- If the next node is a source body we must freeze in
8487 -- the current scope as well.
8489 elsif Present (Next (N))
8490 and then Nkind_In (Next (N),
8491 N_Subprogram_Body, N_Package_Body)
8492 and then Comes_From_Source (Next (N))
8493 then
8494 null;
8496 -- Current instance is within an unrelated instance
8498 elsif Is_Generic_Instance (Scop) then
8499 null;
8501 -- Current instance is within an unrelated body
8503 elsif Present (Enclosing_N)
8504 and then Enclosing_N /= Enclosing_Body (Par_I)
8505 then
8506 null;
8508 else
8509 Insert_After (Freeze_Node (Par_I), F_Node);
8510 return;
8511 end if;
8512 end if;
8513 end;
8514 end if;
8516 -- When the instantiation occurs in a package declaration, append the
8517 -- freeze node to the private declarations (if any).
8519 if Nkind (Par_N) = N_Package_Specification
8520 and then Decls = Visible_Declarations (Par_N)
8521 and then Present (Private_Declarations (Par_N))
8522 and then not Is_Empty_List (Private_Declarations (Par_N))
8523 then
8524 Decls := Private_Declarations (Par_N);
8525 Decl := First (Decls);
8526 end if;
8528 -- Determine the proper freeze point of a package instantiation. We
8529 -- adhere to the general rule of a package or subprogram body causing
8530 -- freezing of anything before it in the same declarative region. In
8531 -- this case, the proper freeze point of a package instantiation is
8532 -- before the first source body which follows, or before a stub. This
8533 -- ensures that entities coming from the instance are already frozen
8534 -- and usable in source bodies.
8536 if Nkind (Par_N) /= N_Package_Declaration
8537 and then Ekind (Inst) = E_Package
8538 and then Is_Generic_Instance (Inst)
8539 and then
8540 not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
8541 then
8542 while Present (Decl) loop
8543 if (Nkind (Decl) in N_Unit_Body
8544 or else
8545 Nkind (Decl) in N_Body_Stub)
8546 and then Comes_From_Source (Decl)
8547 then
8548 Insert_Before (Decl, F_Node);
8549 return;
8550 end if;
8552 Next (Decl);
8553 end loop;
8554 end if;
8556 -- In a package declaration, or if no previous body, insert at end
8557 -- of list.
8559 Set_Sloc (F_Node, Sloc (Last (Decls)));
8560 Insert_After (Last (Decls), F_Node);
8561 end if;
8562 end Insert_Freeze_Node_For_Instance;
8564 ------------------
8565 -- Install_Body --
8566 ------------------
8568 procedure Install_Body
8569 (Act_Body : Node_Id;
8570 N : Node_Id;
8571 Gen_Body : Node_Id;
8572 Gen_Decl : Node_Id)
8574 Act_Id : constant Entity_Id := Corresponding_Spec (Act_Body);
8575 Act_Unit : constant Node_Id := Unit (Cunit (Get_Source_Unit (N)));
8576 Gen_Id : constant Entity_Id := Corresponding_Spec (Gen_Body);
8577 Par : constant Entity_Id := Scope (Gen_Id);
8578 Gen_Unit : constant Node_Id :=
8579 Unit (Cunit (Get_Source_Unit (Gen_Decl)));
8580 Orig_Body : Node_Id := Gen_Body;
8581 F_Node : Node_Id;
8582 Body_Unit : Node_Id;
8584 Must_Delay : Boolean;
8586 function In_Same_Enclosing_Subp return Boolean;
8587 -- Check whether instance and generic body are within same subprogram.
8589 function True_Sloc (N : Node_Id) return Source_Ptr;
8590 -- If the instance is nested inside a generic unit, the Sloc of the
8591 -- instance indicates the place of the original definition, not the
8592 -- point of the current enclosing instance. Pending a better usage of
8593 -- Slocs to indicate instantiation places, we determine the place of
8594 -- origin of a node by finding the maximum sloc of any ancestor node.
8595 -- Why is this not equivalent to Top_Level_Location ???
8597 ----------------------------
8598 -- In_Same_Enclosing_Subp --
8599 ----------------------------
8601 function In_Same_Enclosing_Subp return Boolean is
8602 Scop : Entity_Id;
8603 Subp : Entity_Id;
8605 begin
8606 Scop := Scope (Act_Id);
8607 while Scop /= Standard_Standard
8608 and then not Is_Overloadable (Scop)
8609 loop
8610 Scop := Scope (Scop);
8611 end loop;
8613 if Scop = Standard_Standard then
8614 return False;
8615 else
8616 Subp := Scop;
8617 end if;
8619 Scop := Scope (Gen_Id);
8620 while Scop /= Standard_Standard loop
8621 if Scop = Subp then
8622 return True;
8623 else
8624 Scop := Scope (Scop);
8625 end if;
8626 end loop;
8628 return False;
8629 end In_Same_Enclosing_Subp;
8631 ---------------
8632 -- True_Sloc --
8633 ---------------
8635 function True_Sloc (N : Node_Id) return Source_Ptr is
8636 Res : Source_Ptr;
8637 N1 : Node_Id;
8639 begin
8640 Res := Sloc (N);
8641 N1 := N;
8642 while Present (N1) and then N1 /= Act_Unit loop
8643 if Sloc (N1) > Res then
8644 Res := Sloc (N1);
8645 end if;
8647 N1 := Parent (N1);
8648 end loop;
8650 return Res;
8651 end True_Sloc;
8653 -- Start of processing for Install_Body
8655 begin
8656 -- If the body is a subunit, the freeze point is the corresponding stub
8657 -- in the current compilation, not the subunit itself.
8659 if Nkind (Parent (Gen_Body)) = N_Subunit then
8660 Orig_Body := Corresponding_Stub (Parent (Gen_Body));
8661 else
8662 Orig_Body := Gen_Body;
8663 end if;
8665 Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8667 -- If the instantiation and the generic definition appear in the same
8668 -- package declaration, this is an early instantiation. If they appear
8669 -- in the same declarative part, it is an early instantiation only if
8670 -- the generic body appears textually later, and the generic body is
8671 -- also in the main unit.
8673 -- If instance is nested within a subprogram, and the generic body
8674 -- is not, the instance is delayed because the enclosing body is. If
8675 -- instance and body are within the same scope, or the same subprogram
8676 -- body, indicate explicitly that the instance is delayed.
8678 Must_Delay :=
8679 (Gen_Unit = Act_Unit
8680 and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8681 N_Generic_Package_Declaration)
8682 or else (Gen_Unit = Body_Unit
8683 and then True_Sloc (N) < Sloc (Orig_Body)))
8684 and then Is_In_Main_Unit (Gen_Unit)
8685 and then (Scope (Act_Id) = Scope (Gen_Id)
8686 or else In_Same_Enclosing_Subp));
8688 -- If this is an early instantiation, the freeze node is placed after
8689 -- the generic body. Otherwise, if the generic appears in an instance,
8690 -- we cannot freeze the current instance until the outer one is frozen.
8691 -- This is only relevant if the current instance is nested within some
8692 -- inner scope not itself within the outer instance. If this scope is
8693 -- a package body in the same declarative part as the outer instance,
8694 -- then that body needs to be frozen after the outer instance. Finally,
8695 -- if no delay is needed, we place the freeze node at the end of the
8696 -- current declarative part.
8698 if Expander_Active then
8699 Ensure_Freeze_Node (Act_Id);
8700 F_Node := Freeze_Node (Act_Id);
8702 if Must_Delay then
8703 Insert_After (Orig_Body, F_Node);
8705 elsif Is_Generic_Instance (Par)
8706 and then Present (Freeze_Node (Par))
8707 and then Scope (Act_Id) /= Par
8708 then
8709 -- Freeze instance of inner generic after instance of enclosing
8710 -- generic.
8712 if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8714 -- Handle the following case:
8716 -- package Parent_Inst is new ...
8717 -- Parent_Inst []
8719 -- procedure P ... -- this body freezes Parent_Inst
8721 -- package Inst is new ...
8723 -- In this particular scenario, the freeze node for Inst must
8724 -- be inserted in the same manner as that of Parent_Inst,
8725 -- before the next source body or at the end of the declarative
8726 -- list (body not available). If body P did not exist and
8727 -- Parent_Inst was frozen after Inst, either by a body
8728 -- following Inst or at the end of the declarative region,
8729 -- the freeze node for Inst must be inserted after that of
8730 -- Parent_Inst. This relation is established by comparing
8731 -- the Slocs of Parent_Inst freeze node and Inst.
8733 if List_Containing (Get_Package_Instantiation_Node (Par)) =
8734 List_Containing (N)
8735 and then Sloc (Freeze_Node (Par)) < Sloc (N)
8736 then
8737 Insert_Freeze_Node_For_Instance (N, F_Node);
8738 else
8739 Insert_After (Freeze_Node (Par), F_Node);
8740 end if;
8742 -- Freeze package enclosing instance of inner generic after
8743 -- instance of enclosing generic.
8745 elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8746 and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8747 then
8748 declare
8749 Enclosing : Entity_Id;
8751 begin
8752 Enclosing := Corresponding_Spec (Parent (N));
8754 if No (Enclosing) then
8755 Enclosing := Defining_Entity (Parent (N));
8756 end if;
8758 Insert_Freeze_Node_For_Instance (N, F_Node);
8759 Ensure_Freeze_Node (Enclosing);
8761 if not Is_List_Member (Freeze_Node (Enclosing)) then
8763 -- The enclosing context is a subunit, insert the freeze
8764 -- node after the stub.
8766 if Nkind (Parent (Parent (N))) = N_Subunit then
8767 Insert_Freeze_Node_For_Instance
8768 (Corresponding_Stub (Parent (Parent (N))),
8769 Freeze_Node (Enclosing));
8771 -- The enclosing context is a package with a stub body
8772 -- which has already been replaced by the real body.
8773 -- Insert the freeze node after the actual body.
8775 elsif Ekind (Enclosing) = E_Package
8776 and then Present (Body_Entity (Enclosing))
8777 and then Was_Originally_Stub
8778 (Parent (Body_Entity (Enclosing)))
8779 then
8780 Insert_Freeze_Node_For_Instance
8781 (Parent (Body_Entity (Enclosing)),
8782 Freeze_Node (Enclosing));
8784 -- The parent instance has been frozen before the body of
8785 -- the enclosing package, insert the freeze node after
8786 -- the body.
8788 elsif List_Containing (Freeze_Node (Par)) =
8789 List_Containing (Parent (N))
8790 and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8791 then
8792 Insert_Freeze_Node_For_Instance
8793 (Parent (N), Freeze_Node (Enclosing));
8795 else
8796 Insert_After
8797 (Freeze_Node (Par), Freeze_Node (Enclosing));
8798 end if;
8799 end if;
8800 end;
8802 else
8803 Insert_Freeze_Node_For_Instance (N, F_Node);
8804 end if;
8806 else
8807 Insert_Freeze_Node_For_Instance (N, F_Node);
8808 end if;
8809 end if;
8811 Set_Is_Frozen (Act_Id);
8812 Insert_Before (N, Act_Body);
8813 Mark_Rewrite_Insertion (Act_Body);
8814 end Install_Body;
8816 -----------------------------
8817 -- Install_Formal_Packages --
8818 -----------------------------
8820 procedure Install_Formal_Packages (Par : Entity_Id) is
8821 E : Entity_Id;
8822 Gen : Entity_Id;
8823 Gen_E : Entity_Id := Empty;
8825 begin
8826 E := First_Entity (Par);
8828 -- If we are installing an instance parent, locate the formal packages
8829 -- of its generic parent.
8831 if Is_Generic_Instance (Par) then
8832 Gen := Generic_Parent (Package_Specification (Par));
8833 Gen_E := First_Entity (Gen);
8834 end if;
8836 while Present (E) loop
8837 if Ekind (E) = E_Package
8838 and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8839 then
8840 -- If this is the renaming for the parent instance, done
8842 if Renamed_Object (E) = Par then
8843 exit;
8845 -- The visibility of a formal of an enclosing generic is already
8846 -- correct.
8848 elsif Denotes_Formal_Package (E) then
8849 null;
8851 elsif Present (Associated_Formal_Package (E)) then
8852 Check_Generic_Actuals (Renamed_Object (E), True);
8853 Set_Is_Hidden (E, False);
8855 -- Find formal package in generic unit that corresponds to
8856 -- (instance of) formal package in instance.
8858 while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8859 Next_Entity (Gen_E);
8860 end loop;
8862 if Present (Gen_E) then
8863 Map_Formal_Package_Entities (Gen_E, E);
8864 end if;
8865 end if;
8866 end if;
8868 Next_Entity (E);
8869 if Present (Gen_E) then
8870 Next_Entity (Gen_E);
8871 end if;
8872 end loop;
8873 end Install_Formal_Packages;
8875 --------------------
8876 -- Install_Parent --
8877 --------------------
8879 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8880 Ancestors : constant Elist_Id := New_Elmt_List;
8881 S : constant Entity_Id := Current_Scope;
8882 Inst_Par : Entity_Id;
8883 First_Par : Entity_Id;
8884 Inst_Node : Node_Id;
8885 Gen_Par : Entity_Id;
8886 First_Gen : Entity_Id;
8887 Elmt : Elmt_Id;
8889 procedure Install_Noninstance_Specs (Par : Entity_Id);
8890 -- Install the scopes of noninstance parent units ending with Par
8892 procedure Install_Spec (Par : Entity_Id);
8893 -- The child unit is within the declarative part of the parent, so the
8894 -- declarations within the parent are immediately visible.
8896 -------------------------------
8897 -- Install_Noninstance_Specs --
8898 -------------------------------
8900 procedure Install_Noninstance_Specs (Par : Entity_Id) is
8901 begin
8902 if Present (Par)
8903 and then Par /= Standard_Standard
8904 and then not In_Open_Scopes (Par)
8905 then
8906 Install_Noninstance_Specs (Scope (Par));
8907 Install_Spec (Par);
8908 end if;
8909 end Install_Noninstance_Specs;
8911 ------------------
8912 -- Install_Spec --
8913 ------------------
8915 procedure Install_Spec (Par : Entity_Id) is
8916 Spec : constant Node_Id := Package_Specification (Par);
8918 begin
8919 -- If this parent of the child instance is a top-level unit,
8920 -- then record the unit and its visibility for later resetting in
8921 -- Remove_Parent. We exclude units that are generic instances, as we
8922 -- only want to record this information for the ultimate top-level
8923 -- noninstance parent (is that always correct???).
8925 if Scope (Par) = Standard_Standard
8926 and then not Is_Generic_Instance (Par)
8927 then
8928 Parent_Unit_Visible := Is_Immediately_Visible (Par);
8929 Instance_Parent_Unit := Par;
8930 end if;
8932 -- Open the parent scope and make it and its declarations visible.
8933 -- If this point is not within a body, then only the visible
8934 -- declarations should be made visible, and installation of the
8935 -- private declarations is deferred until the appropriate point
8936 -- within analysis of the spec being instantiated (see the handling
8937 -- of parent visibility in Analyze_Package_Specification). This is
8938 -- relaxed in the case where the parent unit is Ada.Tags, to avoid
8939 -- private view problems that occur when compiling instantiations of
8940 -- a generic child of that package (Generic_Dispatching_Constructor).
8941 -- If the instance freezes a tagged type, inlinings of operations
8942 -- from Ada.Tags may need the full view of type Tag. If inlining took
8943 -- proper account of establishing visibility of inlined subprograms'
8944 -- parents then it should be possible to remove this
8945 -- special check. ???
8947 Push_Scope (Par);
8948 Set_Is_Immediately_Visible (Par);
8949 Install_Visible_Declarations (Par);
8950 Set_Use (Visible_Declarations (Spec));
8952 if In_Body or else Is_RTU (Par, Ada_Tags) then
8953 Install_Private_Declarations (Par);
8954 Set_Use (Private_Declarations (Spec));
8955 end if;
8956 end Install_Spec;
8958 -- Start of processing for Install_Parent
8960 begin
8961 -- We need to install the parent instance to compile the instantiation
8962 -- of the child, but the child instance must appear in the current
8963 -- scope. Given that we cannot place the parent above the current scope
8964 -- in the scope stack, we duplicate the current scope and unstack both
8965 -- after the instantiation is complete.
8967 -- If the parent is itself the instantiation of a child unit, we must
8968 -- also stack the instantiation of its parent, and so on. Each such
8969 -- ancestor is the prefix of the name in a prior instantiation.
8971 -- If this is a nested instance, the parent unit itself resolves to
8972 -- a renaming of the parent instance, whose declaration we need.
8974 -- Finally, the parent may be a generic (not an instance) when the
8975 -- child unit appears as a formal package.
8977 Inst_Par := P;
8979 if Present (Renamed_Entity (Inst_Par)) then
8980 Inst_Par := Renamed_Entity (Inst_Par);
8981 end if;
8983 First_Par := Inst_Par;
8985 Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
8987 First_Gen := Gen_Par;
8989 while Present (Gen_Par)
8990 and then Is_Child_Unit (Gen_Par)
8991 loop
8992 -- Load grandparent instance as well
8994 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
8996 if Nkind (Name (Inst_Node)) = N_Expanded_Name then
8997 Inst_Par := Entity (Prefix (Name (Inst_Node)));
8999 if Present (Renamed_Entity (Inst_Par)) then
9000 Inst_Par := Renamed_Entity (Inst_Par);
9001 end if;
9003 Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
9005 if Present (Gen_Par) then
9006 Prepend_Elmt (Inst_Par, Ancestors);
9008 else
9009 -- Parent is not the name of an instantiation
9011 Install_Noninstance_Specs (Inst_Par);
9012 exit;
9013 end if;
9015 else
9016 -- Previous error
9018 exit;
9019 end if;
9020 end loop;
9022 if Present (First_Gen) then
9023 Append_Elmt (First_Par, Ancestors);
9024 else
9025 Install_Noninstance_Specs (First_Par);
9026 end if;
9028 if not Is_Empty_Elmt_List (Ancestors) then
9029 Elmt := First_Elmt (Ancestors);
9030 while Present (Elmt) loop
9031 Install_Spec (Node (Elmt));
9032 Install_Formal_Packages (Node (Elmt));
9033 Next_Elmt (Elmt);
9034 end loop;
9035 end if;
9037 if not In_Body then
9038 Push_Scope (S);
9039 end if;
9040 end Install_Parent;
9042 -------------------------------
9043 -- Install_Hidden_Primitives --
9044 -------------------------------
9046 procedure Install_Hidden_Primitives
9047 (Prims_List : in out Elist_Id;
9048 Gen_T : Entity_Id;
9049 Act_T : Entity_Id)
9051 Elmt : Elmt_Id;
9052 List : Elist_Id := No_Elist;
9053 Prim_G_Elmt : Elmt_Id;
9054 Prim_A_Elmt : Elmt_Id;
9055 Prim_G : Node_Id;
9056 Prim_A : Node_Id;
9058 begin
9059 -- No action needed in case of serious errors because we cannot trust
9060 -- in the order of primitives
9062 if Serious_Errors_Detected > 0 then
9063 return;
9065 -- No action possible if we don't have available the list of primitive
9066 -- operations
9068 elsif No (Gen_T)
9069 or else not Is_Record_Type (Gen_T)
9070 or else not Is_Tagged_Type (Gen_T)
9071 or else not Is_Record_Type (Act_T)
9072 or else not Is_Tagged_Type (Act_T)
9073 then
9074 return;
9076 -- There is no need to handle interface types since their primitives
9077 -- cannot be hidden
9079 elsif Is_Interface (Gen_T) then
9080 return;
9081 end if;
9083 Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
9085 if not Is_Class_Wide_Type (Act_T) then
9086 Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
9087 else
9088 Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
9089 end if;
9091 loop
9092 -- Skip predefined primitives in the generic formal
9094 while Present (Prim_G_Elmt)
9095 and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
9096 loop
9097 Next_Elmt (Prim_G_Elmt);
9098 end loop;
9100 -- Skip predefined primitives in the generic actual
9102 while Present (Prim_A_Elmt)
9103 and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
9104 loop
9105 Next_Elmt (Prim_A_Elmt);
9106 end loop;
9108 exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
9110 Prim_G := Node (Prim_G_Elmt);
9111 Prim_A := Node (Prim_A_Elmt);
9113 -- There is no need to handle interface primitives because their
9114 -- primitives are not hidden
9116 exit when Present (Interface_Alias (Prim_G));
9118 -- Here we install one hidden primitive
9120 if Chars (Prim_G) /= Chars (Prim_A)
9121 and then Has_Suffix (Prim_A, 'P')
9122 and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
9123 then
9124 Set_Chars (Prim_A, Chars (Prim_G));
9125 Append_New_Elmt (Prim_A, To => List);
9126 end if;
9128 Next_Elmt (Prim_A_Elmt);
9129 Next_Elmt (Prim_G_Elmt);
9130 end loop;
9132 -- Append the elements to the list of temporarily visible primitives
9133 -- avoiding duplicates.
9135 if Present (List) then
9136 if No (Prims_List) then
9137 Prims_List := New_Elmt_List;
9138 end if;
9140 Elmt := First_Elmt (List);
9141 while Present (Elmt) loop
9142 Append_Unique_Elmt (Node (Elmt), Prims_List);
9143 Next_Elmt (Elmt);
9144 end loop;
9145 end if;
9146 end Install_Hidden_Primitives;
9148 -------------------------------
9149 -- Restore_Hidden_Primitives --
9150 -------------------------------
9152 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
9153 Prim_Elmt : Elmt_Id;
9154 Prim : Node_Id;
9156 begin
9157 if Prims_List /= No_Elist then
9158 Prim_Elmt := First_Elmt (Prims_List);
9159 while Present (Prim_Elmt) loop
9160 Prim := Node (Prim_Elmt);
9161 Set_Chars (Prim, Add_Suffix (Prim, 'P'));
9162 Next_Elmt (Prim_Elmt);
9163 end loop;
9165 Prims_List := No_Elist;
9166 end if;
9167 end Restore_Hidden_Primitives;
9169 --------------------------------
9170 -- Instantiate_Formal_Package --
9171 --------------------------------
9173 function Instantiate_Formal_Package
9174 (Formal : Node_Id;
9175 Actual : Node_Id;
9176 Analyzed_Formal : Node_Id) return List_Id
9178 Loc : constant Source_Ptr := Sloc (Actual);
9179 Actual_Pack : Entity_Id;
9180 Formal_Pack : Entity_Id;
9181 Gen_Parent : Entity_Id;
9182 Decls : List_Id;
9183 Nod : Node_Id;
9184 Parent_Spec : Node_Id;
9186 procedure Find_Matching_Actual
9187 (F : Node_Id;
9188 Act : in out Entity_Id);
9189 -- We need to associate each formal entity in the formal package with
9190 -- the corresponding entity in the actual package. The actual package
9191 -- has been analyzed and possibly expanded, and as a result there is
9192 -- no one-to-one correspondence between the two lists (for example,
9193 -- the actual may include subtypes, itypes, and inherited primitive
9194 -- operations, interspersed among the renaming declarations for the
9195 -- actuals) . We retrieve the corresponding actual by name because each
9196 -- actual has the same name as the formal, and they do appear in the
9197 -- same order.
9199 function Get_Formal_Entity (N : Node_Id) return Entity_Id;
9200 -- Retrieve entity of defining entity of generic formal parameter.
9201 -- Only the declarations of formals need to be considered when
9202 -- linking them to actuals, but the declarative list may include
9203 -- internal entities generated during analysis, and those are ignored.
9205 procedure Match_Formal_Entity
9206 (Formal_Node : Node_Id;
9207 Formal_Ent : Entity_Id;
9208 Actual_Ent : Entity_Id);
9209 -- Associates the formal entity with the actual. In the case where
9210 -- Formal_Ent is a formal package, this procedure iterates through all
9211 -- of its formals and enters associations between the actuals occurring
9212 -- in the formal package's corresponding actual package (given by
9213 -- Actual_Ent) and the formal package's formal parameters. This
9214 -- procedure recurses if any of the parameters is itself a package.
9216 function Is_Instance_Of
9217 (Act_Spec : Entity_Id;
9218 Gen_Anc : Entity_Id) return Boolean;
9219 -- The actual can be an instantiation of a generic within another
9220 -- instance, in which case there is no direct link from it to the
9221 -- original generic ancestor. In that case, we recognize that the
9222 -- ultimate ancestor is the same by examining names and scopes.
9224 procedure Process_Nested_Formal (Formal : Entity_Id);
9225 -- If the current formal is declared with a box, its own formals are
9226 -- visible in the instance, as they were in the generic, and their
9227 -- Hidden flag must be reset. If some of these formals are themselves
9228 -- packages declared with a box, the processing must be recursive.
9230 --------------------------
9231 -- Find_Matching_Actual --
9232 --------------------------
9234 procedure Find_Matching_Actual
9235 (F : Node_Id;
9236 Act : in out Entity_Id)
9238 Formal_Ent : Entity_Id;
9240 begin
9241 case Nkind (Original_Node (F)) is
9242 when N_Formal_Object_Declaration |
9243 N_Formal_Type_Declaration =>
9244 Formal_Ent := Defining_Identifier (F);
9246 while Chars (Act) /= Chars (Formal_Ent) loop
9247 Next_Entity (Act);
9248 end loop;
9250 when N_Formal_Subprogram_Declaration |
9251 N_Formal_Package_Declaration |
9252 N_Package_Declaration |
9253 N_Generic_Package_Declaration =>
9254 Formal_Ent := Defining_Entity (F);
9256 while Chars (Act) /= Chars (Formal_Ent) loop
9257 Next_Entity (Act);
9258 end loop;
9260 when others =>
9261 raise Program_Error;
9262 end case;
9263 end Find_Matching_Actual;
9265 -------------------------
9266 -- Match_Formal_Entity --
9267 -------------------------
9269 procedure Match_Formal_Entity
9270 (Formal_Node : Node_Id;
9271 Formal_Ent : Entity_Id;
9272 Actual_Ent : Entity_Id)
9274 Act_Pkg : Entity_Id;
9276 begin
9277 Set_Instance_Of (Formal_Ent, Actual_Ent);
9279 if Ekind (Actual_Ent) = E_Package then
9281 -- Record associations for each parameter
9283 Act_Pkg := Actual_Ent;
9285 declare
9286 A_Ent : Entity_Id := First_Entity (Act_Pkg);
9287 F_Ent : Entity_Id;
9288 F_Node : Node_Id;
9290 Gen_Decl : Node_Id;
9291 Formals : List_Id;
9292 Actual : Entity_Id;
9294 begin
9295 -- Retrieve the actual given in the formal package declaration
9297 Actual := Entity (Name (Original_Node (Formal_Node)));
9299 -- The actual in the formal package declaration may be a
9300 -- renamed generic package, in which case we want to retrieve
9301 -- the original generic in order to traverse its formal part.
9303 if Present (Renamed_Entity (Actual)) then
9304 Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
9305 else
9306 Gen_Decl := Unit_Declaration_Node (Actual);
9307 end if;
9309 Formals := Generic_Formal_Declarations (Gen_Decl);
9311 if Present (Formals) then
9312 F_Node := First_Non_Pragma (Formals);
9313 else
9314 F_Node := Empty;
9315 end if;
9317 while Present (A_Ent)
9318 and then Present (F_Node)
9319 and then A_Ent /= First_Private_Entity (Act_Pkg)
9320 loop
9321 F_Ent := Get_Formal_Entity (F_Node);
9323 if Present (F_Ent) then
9325 -- This is a formal of the original package. Record
9326 -- association and recurse.
9328 Find_Matching_Actual (F_Node, A_Ent);
9329 Match_Formal_Entity (F_Node, F_Ent, A_Ent);
9330 Next_Entity (A_Ent);
9331 end if;
9333 Next_Non_Pragma (F_Node);
9334 end loop;
9335 end;
9336 end if;
9337 end Match_Formal_Entity;
9339 -----------------------
9340 -- Get_Formal_Entity --
9341 -----------------------
9343 function Get_Formal_Entity (N : Node_Id) return Entity_Id is
9344 Kind : constant Node_Kind := Nkind (Original_Node (N));
9345 begin
9346 case Kind is
9347 when N_Formal_Object_Declaration =>
9348 return Defining_Identifier (N);
9350 when N_Formal_Type_Declaration =>
9351 return Defining_Identifier (N);
9353 when N_Formal_Subprogram_Declaration =>
9354 return Defining_Unit_Name (Specification (N));
9356 when N_Formal_Package_Declaration =>
9357 return Defining_Identifier (Original_Node (N));
9359 when N_Generic_Package_Declaration =>
9360 return Defining_Identifier (Original_Node (N));
9362 -- All other declarations are introduced by semantic analysis and
9363 -- have no match in the actual.
9365 when others =>
9366 return Empty;
9367 end case;
9368 end Get_Formal_Entity;
9370 --------------------
9371 -- Is_Instance_Of --
9372 --------------------
9374 function Is_Instance_Of
9375 (Act_Spec : Entity_Id;
9376 Gen_Anc : Entity_Id) return Boolean
9378 Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
9380 begin
9381 if No (Gen_Par) then
9382 return False;
9384 -- Simplest case: the generic parent of the actual is the formal
9386 elsif Gen_Par = Gen_Anc then
9387 return True;
9389 elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
9390 return False;
9392 -- The actual may be obtained through several instantiations. Its
9393 -- scope must itself be an instance of a generic declared in the
9394 -- same scope as the formal. Any other case is detected above.
9396 elsif not Is_Generic_Instance (Scope (Gen_Par)) then
9397 return False;
9399 else
9400 return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
9401 end if;
9402 end Is_Instance_Of;
9404 ---------------------------
9405 -- Process_Nested_Formal --
9406 ---------------------------
9408 procedure Process_Nested_Formal (Formal : Entity_Id) is
9409 Ent : Entity_Id;
9411 begin
9412 if Present (Associated_Formal_Package (Formal))
9413 and then Box_Present (Parent (Associated_Formal_Package (Formal)))
9414 then
9415 Ent := First_Entity (Formal);
9416 while Present (Ent) loop
9417 Set_Is_Hidden (Ent, False);
9418 Set_Is_Visible_Formal (Ent);
9419 Set_Is_Potentially_Use_Visible
9420 (Ent, Is_Potentially_Use_Visible (Formal));
9422 if Ekind (Ent) = E_Package then
9423 exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
9424 Process_Nested_Formal (Ent);
9425 end if;
9427 Next_Entity (Ent);
9428 end loop;
9429 end if;
9430 end Process_Nested_Formal;
9432 -- Start of processing for Instantiate_Formal_Package
9434 begin
9435 Analyze (Actual);
9437 if not Is_Entity_Name (Actual)
9438 or else Ekind (Entity (Actual)) /= E_Package
9439 then
9440 Error_Msg_N
9441 ("expect package instance to instantiate formal", Actual);
9442 Abandon_Instantiation (Actual);
9443 raise Program_Error;
9445 else
9446 Actual_Pack := Entity (Actual);
9447 Set_Is_Instantiated (Actual_Pack);
9449 -- The actual may be a renamed package, or an outer generic formal
9450 -- package whose instantiation is converted into a renaming.
9452 if Present (Renamed_Object (Actual_Pack)) then
9453 Actual_Pack := Renamed_Object (Actual_Pack);
9454 end if;
9456 if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
9457 Gen_Parent := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
9458 Formal_Pack := Defining_Identifier (Analyzed_Formal);
9459 else
9460 Gen_Parent :=
9461 Generic_Parent (Specification (Analyzed_Formal));
9462 Formal_Pack :=
9463 Defining_Unit_Name (Specification (Analyzed_Formal));
9464 end if;
9466 if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
9467 Parent_Spec := Package_Specification (Actual_Pack);
9468 else
9469 Parent_Spec := Parent (Actual_Pack);
9470 end if;
9472 if Gen_Parent = Any_Id then
9473 Error_Msg_N
9474 ("previous error in declaration of formal package", Actual);
9475 Abandon_Instantiation (Actual);
9477 elsif
9478 Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
9479 then
9480 null;
9482 else
9483 Error_Msg_NE
9484 ("actual parameter must be instance of&", Actual, Gen_Parent);
9485 Abandon_Instantiation (Actual);
9486 end if;
9488 Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
9489 Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
9491 Nod :=
9492 Make_Package_Renaming_Declaration (Loc,
9493 Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
9494 Name => New_Occurrence_Of (Actual_Pack, Loc));
9496 Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
9497 Defining_Identifier (Formal));
9498 Decls := New_List (Nod);
9500 -- If the formal F has a box, then the generic declarations are
9501 -- visible in the generic G. In an instance of G, the corresponding
9502 -- entities in the actual for F (which are the actuals for the
9503 -- instantiation of the generic that F denotes) must also be made
9504 -- visible for analysis of the current instance. On exit from the
9505 -- current instance, those entities are made private again. If the
9506 -- actual is currently in use, these entities are also use-visible.
9508 -- The loop through the actual entities also steps through the formal
9509 -- entities and enters associations from formals to actuals into the
9510 -- renaming map. This is necessary to properly handle checking of
9511 -- actual parameter associations for later formals that depend on
9512 -- actuals declared in the formal package.
9514 -- In Ada 2005, partial parameterization requires that we make
9515 -- visible the actuals corresponding to formals that were defaulted
9516 -- in the formal package. There formals are identified because they
9517 -- remain formal generics within the formal package, rather than
9518 -- being renamings of the actuals supplied.
9520 declare
9521 Gen_Decl : constant Node_Id :=
9522 Unit_Declaration_Node (Gen_Parent);
9523 Formals : constant List_Id :=
9524 Generic_Formal_Declarations (Gen_Decl);
9526 Actual_Ent : Entity_Id;
9527 Actual_Of_Formal : Node_Id;
9528 Formal_Node : Node_Id;
9529 Formal_Ent : Entity_Id;
9531 begin
9532 if Present (Formals) then
9533 Formal_Node := First_Non_Pragma (Formals);
9534 else
9535 Formal_Node := Empty;
9536 end if;
9538 Actual_Ent := First_Entity (Actual_Pack);
9539 Actual_Of_Formal :=
9540 First (Visible_Declarations (Specification (Analyzed_Formal)));
9541 while Present (Actual_Ent)
9542 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9543 loop
9544 if Present (Formal_Node) then
9545 Formal_Ent := Get_Formal_Entity (Formal_Node);
9547 if Present (Formal_Ent) then
9548 Find_Matching_Actual (Formal_Node, Actual_Ent);
9549 Match_Formal_Entity
9550 (Formal_Node, Formal_Ent, Actual_Ent);
9552 -- We iterate at the same time over the actuals of the
9553 -- local package created for the formal, to determine
9554 -- which one of the formals of the original generic were
9555 -- defaulted in the formal. The corresponding actual
9556 -- entities are visible in the enclosing instance.
9558 if Box_Present (Formal)
9559 or else
9560 (Present (Actual_Of_Formal)
9561 and then
9562 Is_Generic_Formal
9563 (Get_Formal_Entity (Actual_Of_Formal)))
9564 then
9565 Set_Is_Hidden (Actual_Ent, False);
9566 Set_Is_Visible_Formal (Actual_Ent);
9567 Set_Is_Potentially_Use_Visible
9568 (Actual_Ent, In_Use (Actual_Pack));
9570 if Ekind (Actual_Ent) = E_Package then
9571 Process_Nested_Formal (Actual_Ent);
9572 end if;
9574 else
9575 Set_Is_Hidden (Actual_Ent);
9576 Set_Is_Potentially_Use_Visible (Actual_Ent, False);
9577 end if;
9578 end if;
9580 Next_Non_Pragma (Formal_Node);
9581 Next (Actual_Of_Formal);
9583 else
9584 -- No further formals to match, but the generic part may
9585 -- contain inherited operation that are not hidden in the
9586 -- enclosing instance.
9588 Next_Entity (Actual_Ent);
9589 end if;
9590 end loop;
9592 -- Inherited subprograms generated by formal derived types are
9593 -- also visible if the types are.
9595 Actual_Ent := First_Entity (Actual_Pack);
9596 while Present (Actual_Ent)
9597 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9598 loop
9599 if Is_Overloadable (Actual_Ent)
9600 and then
9601 Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
9602 and then
9603 not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
9604 then
9605 Set_Is_Hidden (Actual_Ent, False);
9606 Set_Is_Potentially_Use_Visible
9607 (Actual_Ent, In_Use (Actual_Pack));
9608 end if;
9610 Next_Entity (Actual_Ent);
9611 end loop;
9612 end;
9614 -- If the formal is not declared with a box, reanalyze it as an
9615 -- abbreviated instantiation, to verify the matching rules of 12.7.
9616 -- The actual checks are performed after the generic associations
9617 -- have been analyzed, to guarantee the same visibility for this
9618 -- instantiation and for the actuals.
9620 -- In Ada 2005, the generic associations for the formal can include
9621 -- defaulted parameters. These are ignored during check. This
9622 -- internal instantiation is removed from the tree after conformance
9623 -- checking, because it contains formal declarations for those
9624 -- defaulted parameters, and those should not reach the back-end.
9626 if not Box_Present (Formal) then
9627 declare
9628 I_Pack : constant Entity_Id :=
9629 Make_Temporary (Sloc (Actual), 'P');
9631 begin
9632 Set_Is_Internal (I_Pack);
9634 Append_To (Decls,
9635 Make_Package_Instantiation (Sloc (Actual),
9636 Defining_Unit_Name => I_Pack,
9637 Name =>
9638 New_Occurrence_Of
9639 (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
9640 Generic_Associations =>
9641 Generic_Associations (Formal)));
9642 end;
9643 end if;
9645 return Decls;
9646 end if;
9647 end Instantiate_Formal_Package;
9649 -----------------------------------
9650 -- Instantiate_Formal_Subprogram --
9651 -----------------------------------
9653 function Instantiate_Formal_Subprogram
9654 (Formal : Node_Id;
9655 Actual : Node_Id;
9656 Analyzed_Formal : Node_Id) return Node_Id
9658 Analyzed_S : constant Entity_Id :=
9659 Defining_Unit_Name (Specification (Analyzed_Formal));
9660 Formal_Sub : constant Entity_Id :=
9661 Defining_Unit_Name (Specification (Formal));
9663 function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9664 -- If the generic is a child unit, the parent has been installed on the
9665 -- scope stack, but a default subprogram cannot resolve to something
9666 -- on the parent because that parent is not really part of the visible
9667 -- context (it is there to resolve explicit local entities). If the
9668 -- default has resolved in this way, we remove the entity from immediate
9669 -- visibility and analyze the node again to emit an error message or
9670 -- find another visible candidate.
9672 procedure Valid_Actual_Subprogram (Act : Node_Id);
9673 -- Perform legality check and raise exception on failure
9675 -----------------------
9676 -- From_Parent_Scope --
9677 -----------------------
9679 function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9680 Gen_Scope : Node_Id;
9682 begin
9683 Gen_Scope := Scope (Analyzed_S);
9684 while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9685 if Scope (Subp) = Scope (Gen_Scope) then
9686 return True;
9687 end if;
9689 Gen_Scope := Scope (Gen_Scope);
9690 end loop;
9692 return False;
9693 end From_Parent_Scope;
9695 -----------------------------
9696 -- Valid_Actual_Subprogram --
9697 -----------------------------
9699 procedure Valid_Actual_Subprogram (Act : Node_Id) is
9700 Act_E : Entity_Id;
9702 begin
9703 if Is_Entity_Name (Act) then
9704 Act_E := Entity (Act);
9706 elsif Nkind (Act) = N_Selected_Component
9707 and then Is_Entity_Name (Selector_Name (Act))
9708 then
9709 Act_E := Entity (Selector_Name (Act));
9711 else
9712 Act_E := Empty;
9713 end if;
9715 if (Present (Act_E) and then Is_Overloadable (Act_E))
9716 or else Nkind_In (Act, N_Attribute_Reference,
9717 N_Indexed_Component,
9718 N_Character_Literal,
9719 N_Explicit_Dereference)
9720 then
9721 return;
9722 end if;
9724 Error_Msg_NE
9725 ("expect subprogram or entry name in instantiation of&",
9726 Instantiation_Node, Formal_Sub);
9727 Abandon_Instantiation (Instantiation_Node);
9728 end Valid_Actual_Subprogram;
9730 -- Local variables
9732 Decl_Node : Node_Id;
9733 Loc : Source_Ptr;
9734 Nam : Node_Id;
9735 New_Spec : Node_Id;
9737 -- Start of processing for Instantiate_Formal_Subprogram
9739 begin
9740 New_Spec := New_Copy_Tree (Specification (Formal));
9742 -- The tree copy has created the proper instantiation sloc for the
9743 -- new specification. Use this location for all other constructed
9744 -- declarations.
9746 Loc := Sloc (Defining_Unit_Name (New_Spec));
9748 -- Create new entity for the actual (New_Copy_Tree does not), and
9749 -- indicate that it is an actual.
9751 Set_Defining_Unit_Name
9752 (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9753 Set_Ekind (Defining_Unit_Name (New_Spec), Ekind (Analyzed_S));
9754 Set_Is_Generic_Actual_Subprogram (Defining_Unit_Name (New_Spec));
9756 -- Create new entities for the each of the formals in the specification
9757 -- of the renaming declaration built for the actual.
9759 if Present (Parameter_Specifications (New_Spec)) then
9760 declare
9761 F : Node_Id;
9762 F_Id : Entity_Id;
9764 begin
9765 F := First (Parameter_Specifications (New_Spec));
9766 while Present (F) loop
9767 F_Id := Defining_Identifier (F);
9769 Set_Defining_Identifier (F,
9770 Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id)));
9771 Next (F);
9772 end loop;
9773 end;
9774 end if;
9776 -- Find entity of actual. If the actual is an attribute reference, it
9777 -- cannot be resolved here (its formal is missing) but is handled
9778 -- instead in Attribute_Renaming. If the actual is overloaded, it is
9779 -- fully resolved subsequently, when the renaming declaration for the
9780 -- formal is analyzed. If it is an explicit dereference, resolve the
9781 -- prefix but not the actual itself, to prevent interpretation as call.
9783 if Present (Actual) then
9784 Loc := Sloc (Actual);
9785 Set_Sloc (New_Spec, Loc);
9787 if Nkind (Actual) = N_Operator_Symbol then
9788 Find_Direct_Name (Actual);
9790 elsif Nkind (Actual) = N_Explicit_Dereference then
9791 Analyze (Prefix (Actual));
9793 elsif Nkind (Actual) /= N_Attribute_Reference then
9794 Analyze (Actual);
9795 end if;
9797 Valid_Actual_Subprogram (Actual);
9798 Nam := Actual;
9800 elsif Present (Default_Name (Formal)) then
9801 if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9802 N_Selected_Component,
9803 N_Indexed_Component,
9804 N_Character_Literal)
9805 and then Present (Entity (Default_Name (Formal)))
9806 then
9807 Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9808 else
9809 Nam := New_Copy (Default_Name (Formal));
9810 Set_Sloc (Nam, Loc);
9811 end if;
9813 elsif Box_Present (Formal) then
9815 -- Actual is resolved at the point of instantiation. Create an
9816 -- identifier or operator with the same name as the formal.
9818 if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9819 Nam :=
9820 Make_Operator_Symbol (Loc,
9821 Chars => Chars (Formal_Sub),
9822 Strval => No_String);
9823 else
9824 Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9825 end if;
9827 elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9828 and then Null_Present (Specification (Formal))
9829 then
9830 -- Generate null body for procedure, for use in the instance
9832 Decl_Node :=
9833 Make_Subprogram_Body (Loc,
9834 Specification => New_Spec,
9835 Declarations => New_List,
9836 Handled_Statement_Sequence =>
9837 Make_Handled_Sequence_Of_Statements (Loc,
9838 Statements => New_List (Make_Null_Statement (Loc))));
9840 Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9841 return Decl_Node;
9843 else
9844 Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9845 Error_Msg_NE
9846 ("missing actual&", Instantiation_Node, Formal_Sub);
9847 Error_Msg_NE
9848 ("\in instantiation of & declared#",
9849 Instantiation_Node, Scope (Analyzed_S));
9850 Abandon_Instantiation (Instantiation_Node);
9851 end if;
9853 Decl_Node :=
9854 Make_Subprogram_Renaming_Declaration (Loc,
9855 Specification => New_Spec,
9856 Name => Nam);
9858 -- If we do not have an actual and the formal specified <> then set to
9859 -- get proper default.
9861 if No (Actual) and then Box_Present (Formal) then
9862 Set_From_Default (Decl_Node);
9863 end if;
9865 -- Gather possible interpretations for the actual before analyzing the
9866 -- instance. If overloaded, it will be resolved when analyzing the
9867 -- renaming declaration.
9869 if Box_Present (Formal) and then No (Actual) then
9870 Analyze (Nam);
9872 if Is_Child_Unit (Scope (Analyzed_S))
9873 and then Present (Entity (Nam))
9874 then
9875 if not Is_Overloaded (Nam) then
9876 if From_Parent_Scope (Entity (Nam)) then
9877 Set_Is_Immediately_Visible (Entity (Nam), False);
9878 Set_Entity (Nam, Empty);
9879 Set_Etype (Nam, Empty);
9881 Analyze (Nam);
9882 Set_Is_Immediately_Visible (Entity (Nam));
9883 end if;
9885 else
9886 declare
9887 I : Interp_Index;
9888 It : Interp;
9890 begin
9891 Get_First_Interp (Nam, I, It);
9892 while Present (It.Nam) loop
9893 if From_Parent_Scope (It.Nam) then
9894 Remove_Interp (I);
9895 end if;
9897 Get_Next_Interp (I, It);
9898 end loop;
9899 end;
9900 end if;
9901 end if;
9902 end if;
9904 -- The generic instantiation freezes the actual. This can only be done
9905 -- once the actual is resolved, in the analysis of the renaming
9906 -- declaration. To make the formal subprogram entity available, we set
9907 -- Corresponding_Formal_Spec to point to the formal subprogram entity.
9908 -- This is also needed in Analyze_Subprogram_Renaming for the processing
9909 -- of formal abstract subprograms.
9911 Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9913 -- We cannot analyze the renaming declaration, and thus find the actual,
9914 -- until all the actuals are assembled in the instance. For subsequent
9915 -- checks of other actuals, indicate the node that will hold the
9916 -- instance of this formal.
9918 Set_Instance_Of (Analyzed_S, Nam);
9920 if Nkind (Actual) = N_Selected_Component
9921 and then Is_Task_Type (Etype (Prefix (Actual)))
9922 and then not Is_Frozen (Etype (Prefix (Actual)))
9923 then
9924 -- The renaming declaration will create a body, which must appear
9925 -- outside of the instantiation, We move the renaming declaration
9926 -- out of the instance, and create an additional renaming inside,
9927 -- to prevent freezing anomalies.
9929 declare
9930 Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9932 begin
9933 Set_Defining_Unit_Name (New_Spec, Anon_Id);
9934 Insert_Before (Instantiation_Node, Decl_Node);
9935 Analyze (Decl_Node);
9937 -- Now create renaming within the instance
9939 Decl_Node :=
9940 Make_Subprogram_Renaming_Declaration (Loc,
9941 Specification => New_Copy_Tree (New_Spec),
9942 Name => New_Occurrence_Of (Anon_Id, Loc));
9944 Set_Defining_Unit_Name (Specification (Decl_Node),
9945 Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9946 end;
9947 end if;
9949 return Decl_Node;
9950 end Instantiate_Formal_Subprogram;
9952 ------------------------
9953 -- Instantiate_Object --
9954 ------------------------
9956 function Instantiate_Object
9957 (Formal : Node_Id;
9958 Actual : Node_Id;
9959 Analyzed_Formal : Node_Id) return List_Id
9961 Gen_Obj : constant Entity_Id := Defining_Identifier (Formal);
9962 A_Gen_Obj : constant Entity_Id :=
9963 Defining_Identifier (Analyzed_Formal);
9964 Acc_Def : Node_Id := Empty;
9965 Act_Assoc : constant Node_Id := Parent (Actual);
9966 Actual_Decl : Node_Id := Empty;
9967 Decl_Node : Node_Id;
9968 Def : Node_Id;
9969 Ftyp : Entity_Id;
9970 List : constant List_Id := New_List;
9971 Loc : constant Source_Ptr := Sloc (Actual);
9972 Orig_Ftyp : constant Entity_Id := Etype (A_Gen_Obj);
9973 Subt_Decl : Node_Id := Empty;
9974 Subt_Mark : Node_Id := Empty;
9976 begin
9977 if Present (Subtype_Mark (Formal)) then
9978 Subt_Mark := Subtype_Mark (Formal);
9979 else
9980 Check_Access_Definition (Formal);
9981 Acc_Def := Access_Definition (Formal);
9982 end if;
9984 -- Sloc for error message on missing actual
9986 Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
9988 if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
9989 Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
9990 end if;
9992 Set_Parent (List, Parent (Actual));
9994 -- OUT present
9996 if Out_Present (Formal) then
9998 -- An IN OUT generic actual must be a name. The instantiation is a
9999 -- renaming declaration. The actual is the name being renamed. We
10000 -- use the actual directly, rather than a copy, because it is not
10001 -- used further in the list of actuals, and because a copy or a use
10002 -- of relocate_node is incorrect if the instance is nested within a
10003 -- generic. In order to simplify ASIS searches, the Generic_Parent
10004 -- field links the declaration to the generic association.
10006 if No (Actual) then
10007 Error_Msg_NE
10008 ("missing actual&",
10009 Instantiation_Node, Gen_Obj);
10010 Error_Msg_NE
10011 ("\in instantiation of & declared#",
10012 Instantiation_Node, Scope (A_Gen_Obj));
10013 Abandon_Instantiation (Instantiation_Node);
10014 end if;
10016 if Present (Subt_Mark) then
10017 Decl_Node :=
10018 Make_Object_Renaming_Declaration (Loc,
10019 Defining_Identifier => New_Copy (Gen_Obj),
10020 Subtype_Mark => New_Copy_Tree (Subt_Mark),
10021 Name => Actual);
10023 else pragma Assert (Present (Acc_Def));
10024 Decl_Node :=
10025 Make_Object_Renaming_Declaration (Loc,
10026 Defining_Identifier => New_Copy (Gen_Obj),
10027 Access_Definition => New_Copy_Tree (Acc_Def),
10028 Name => Actual);
10029 end if;
10031 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
10033 -- The analysis of the actual may produce Insert_Action nodes, so
10034 -- the declaration must have a context in which to attach them.
10036 Append (Decl_Node, List);
10037 Analyze (Actual);
10039 -- Return if the analysis of the actual reported some error
10041 if Etype (Actual) = Any_Type then
10042 return List;
10043 end if;
10045 -- This check is performed here because Analyze_Object_Renaming will
10046 -- not check it when Comes_From_Source is False. Note though that the
10047 -- check for the actual being the name of an object will be performed
10048 -- in Analyze_Object_Renaming.
10050 if Is_Object_Reference (Actual)
10051 and then Is_Dependent_Component_Of_Mutable_Object (Actual)
10052 then
10053 Error_Msg_N
10054 ("illegal discriminant-dependent component for in out parameter",
10055 Actual);
10056 end if;
10058 -- The actual has to be resolved in order to check that it is a
10059 -- variable (due to cases such as F (1), where F returns access to
10060 -- an array, and for overloaded prefixes).
10062 Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
10064 -- If the type of the formal is not itself a formal, and the current
10065 -- unit is a child unit, the formal type must be declared in a
10066 -- parent, and must be retrieved by visibility.
10068 if Ftyp = Orig_Ftyp
10069 and then Is_Generic_Unit (Scope (Ftyp))
10070 and then Is_Child_Unit (Scope (A_Gen_Obj))
10071 then
10072 declare
10073 Temp : constant Node_Id :=
10074 New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
10075 begin
10076 Set_Entity (Temp, Empty);
10077 Find_Type (Temp);
10078 Ftyp := Entity (Temp);
10079 end;
10080 end if;
10082 if Is_Private_Type (Ftyp)
10083 and then not Is_Private_Type (Etype (Actual))
10084 and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
10085 or else Base_Type (Etype (Actual)) = Ftyp)
10086 then
10087 -- If the actual has the type of the full view of the formal, or
10088 -- else a non-private subtype of the formal, then the visibility
10089 -- of the formal type has changed. Add to the actuals a subtype
10090 -- declaration that will force the exchange of views in the body
10091 -- of the instance as well.
10093 Subt_Decl :=
10094 Make_Subtype_Declaration (Loc,
10095 Defining_Identifier => Make_Temporary (Loc, 'P'),
10096 Subtype_Indication => New_Occurrence_Of (Ftyp, Loc));
10098 Prepend (Subt_Decl, List);
10100 Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
10101 Exchange_Declarations (Ftyp);
10102 end if;
10104 Resolve (Actual, Ftyp);
10106 if not Denotes_Variable (Actual) then
10107 Error_Msg_NE
10108 ("actual for& must be a variable", Actual, Gen_Obj);
10110 elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
10112 -- Ada 2005 (AI-423): For a generic formal object of mode in out,
10113 -- the type of the actual shall resolve to a specific anonymous
10114 -- access type.
10116 if Ada_Version < Ada_2005
10117 or else Ekind (Base_Type (Ftyp)) /=
10118 E_Anonymous_Access_Type
10119 or else Ekind (Base_Type (Etype (Actual))) /=
10120 E_Anonymous_Access_Type
10121 then
10122 Error_Msg_NE
10123 ("type of actual does not match type of&", Actual, Gen_Obj);
10124 end if;
10125 end if;
10127 Note_Possible_Modification (Actual, Sure => True);
10129 -- Check for instantiation of atomic/volatile actual for
10130 -- non-atomic/volatile formal (RM C.6 (12)).
10132 if Is_Atomic_Object (Actual) and then not Is_Atomic (Orig_Ftyp) then
10133 Error_Msg_N
10134 ("cannot instantiate non-atomic formal object "
10135 & "with atomic actual", Actual);
10137 elsif Is_Volatile_Object (Actual) and then not Is_Volatile (Orig_Ftyp)
10138 then
10139 Error_Msg_N
10140 ("cannot instantiate non-volatile formal object "
10141 & "with volatile actual", Actual);
10142 end if;
10144 -- Formal in-parameter
10146 else
10147 -- The instantiation of a generic formal in-parameter is constant
10148 -- declaration. The actual is the expression for that declaration.
10150 if Present (Actual) then
10151 if Present (Subt_Mark) then
10152 Def := Subt_Mark;
10153 else pragma Assert (Present (Acc_Def));
10154 Def := Acc_Def;
10155 end if;
10157 Decl_Node :=
10158 Make_Object_Declaration (Loc,
10159 Defining_Identifier => New_Copy (Gen_Obj),
10160 Constant_Present => True,
10161 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10162 Object_Definition => New_Copy_Tree (Def),
10163 Expression => Actual);
10165 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
10167 -- A generic formal object of a tagged type is defined to be
10168 -- aliased so the new constant must also be treated as aliased.
10170 if Is_Tagged_Type (Etype (A_Gen_Obj)) then
10171 Set_Aliased_Present (Decl_Node);
10172 end if;
10174 Append (Decl_Node, List);
10176 -- No need to repeat (pre-)analysis of some expression nodes
10177 -- already handled in Preanalyze_Actuals.
10179 if Nkind (Actual) /= N_Allocator then
10180 Analyze (Actual);
10182 -- Return if the analysis of the actual reported some error
10184 if Etype (Actual) = Any_Type then
10185 return List;
10186 end if;
10187 end if;
10189 declare
10190 Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
10191 Typ : Entity_Id;
10193 begin
10194 Typ := Get_Instance_Of (Formal_Type);
10196 Freeze_Before (Instantiation_Node, Typ);
10198 -- If the actual is an aggregate, perform name resolution on
10199 -- its components (the analysis of an aggregate does not do it)
10200 -- to capture local names that may be hidden if the generic is
10201 -- a child unit.
10203 if Nkind (Actual) = N_Aggregate then
10204 Preanalyze_And_Resolve (Actual, Typ);
10205 end if;
10207 if Is_Limited_Type (Typ)
10208 and then not OK_For_Limited_Init (Typ, Actual)
10209 then
10210 Error_Msg_N
10211 ("initialization not allowed for limited types", Actual);
10212 Explain_Limited_Type (Typ, Actual);
10213 end if;
10214 end;
10216 elsif Present (Default_Expression (Formal)) then
10218 -- Use default to construct declaration
10220 if Present (Subt_Mark) then
10221 Def := Subt_Mark;
10222 else pragma Assert (Present (Acc_Def));
10223 Def := Acc_Def;
10224 end if;
10226 Decl_Node :=
10227 Make_Object_Declaration (Sloc (Formal),
10228 Defining_Identifier => New_Copy (Gen_Obj),
10229 Constant_Present => True,
10230 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10231 Object_Definition => New_Copy (Def),
10232 Expression => New_Copy_Tree
10233 (Default_Expression (Formal)));
10235 Append (Decl_Node, List);
10236 Set_Analyzed (Expression (Decl_Node), False);
10238 else
10239 Error_Msg_NE
10240 ("missing actual&",
10241 Instantiation_Node, Gen_Obj);
10242 Error_Msg_NE ("\in instantiation of & declared#",
10243 Instantiation_Node, Scope (A_Gen_Obj));
10245 if Is_Scalar_Type (Etype (A_Gen_Obj)) then
10247 -- Create dummy constant declaration so that instance can be
10248 -- analyzed, to minimize cascaded visibility errors.
10250 if Present (Subt_Mark) then
10251 Def := Subt_Mark;
10252 else pragma Assert (Present (Acc_Def));
10253 Def := Acc_Def;
10254 end if;
10256 Decl_Node :=
10257 Make_Object_Declaration (Loc,
10258 Defining_Identifier => New_Copy (Gen_Obj),
10259 Constant_Present => True,
10260 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10261 Object_Definition => New_Copy (Def),
10262 Expression =>
10263 Make_Attribute_Reference (Sloc (Gen_Obj),
10264 Attribute_Name => Name_First,
10265 Prefix => New_Copy (Def)));
10267 Append (Decl_Node, List);
10269 else
10270 Abandon_Instantiation (Instantiation_Node);
10271 end if;
10272 end if;
10273 end if;
10275 if Nkind (Actual) in N_Has_Entity then
10276 Actual_Decl := Parent (Entity (Actual));
10277 end if;
10279 -- Ada 2005 (AI-423): For a formal object declaration with a null
10280 -- exclusion or an access definition that has a null exclusion: If the
10281 -- actual matching the formal object declaration denotes a generic
10282 -- formal object of another generic unit G, and the instantiation
10283 -- containing the actual occurs within the body of G or within the body
10284 -- of a generic unit declared within the declarative region of G, then
10285 -- the declaration of the formal object of G must have a null exclusion.
10286 -- Otherwise, the subtype of the actual matching the formal object
10287 -- declaration shall exclude null.
10289 if Ada_Version >= Ada_2005
10290 and then Present (Actual_Decl)
10291 and then
10292 Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
10293 N_Object_Declaration)
10294 and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
10295 and then not Has_Null_Exclusion (Actual_Decl)
10296 and then Has_Null_Exclusion (Analyzed_Formal)
10297 then
10298 Error_Msg_Sloc := Sloc (Analyzed_Formal);
10299 Error_Msg_N
10300 ("actual must exclude null to match generic formal#", Actual);
10301 end if;
10303 -- An effectively volatile object cannot be used as an actual in
10304 -- a generic instance. The following check is only relevant when
10305 -- SPARK_Mode is on as it is not a standard Ada legality rule.
10307 if SPARK_Mode = On
10308 and then Present (Actual)
10309 and then Is_Effectively_Volatile_Object (Actual)
10310 then
10311 Error_Msg_N
10312 ("volatile object cannot act as actual in generic instantiation "
10313 & "(SPARK RM 7.1.3(8))", Actual);
10314 end if;
10316 return List;
10317 end Instantiate_Object;
10319 ------------------------------
10320 -- Instantiate_Package_Body --
10321 ------------------------------
10323 procedure Instantiate_Package_Body
10324 (Body_Info : Pending_Body_Info;
10325 Inlined_Body : Boolean := False;
10326 Body_Optional : Boolean := False)
10328 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10329 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10330 Loc : constant Source_Ptr := Sloc (Inst_Node);
10332 Gen_Id : constant Node_Id := Name (Inst_Node);
10333 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10334 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10335 Act_Spec : constant Node_Id := Specification (Act_Decl);
10336 Act_Decl_Id : constant Entity_Id := Defining_Entity (Act_Spec);
10338 Act_Body_Name : Node_Id;
10339 Gen_Body : Node_Id;
10340 Gen_Body_Id : Node_Id;
10341 Act_Body : Node_Id;
10342 Act_Body_Id : Entity_Id;
10344 Parent_Installed : Boolean := False;
10345 Save_Style_Check : constant Boolean := Style_Check;
10347 Par_Ent : Entity_Id := Empty;
10348 Par_Vis : Boolean := False;
10350 Vis_Prims_List : Elist_Id := No_Elist;
10351 -- List of primitives made temporarily visible in the instantiation
10352 -- to match the visibility of the formal type
10354 procedure Check_Initialized_Types;
10355 -- In a generic package body, an entity of a generic private type may
10356 -- appear uninitialized. This is suspicious, unless the actual is a
10357 -- fully initialized type.
10359 -----------------------------
10360 -- Check_Initialized_Types --
10361 -----------------------------
10363 procedure Check_Initialized_Types is
10364 Decl : Node_Id;
10365 Formal : Entity_Id;
10366 Actual : Entity_Id;
10367 Uninit_Var : Entity_Id;
10369 begin
10370 Decl := First (Generic_Formal_Declarations (Gen_Decl));
10371 while Present (Decl) loop
10372 Uninit_Var := Empty;
10374 if Nkind (Decl) = N_Private_Extension_Declaration then
10375 Uninit_Var := Uninitialized_Variable (Decl);
10377 elsif Nkind (Decl) = N_Formal_Type_Declaration
10378 and then Nkind (Formal_Type_Definition (Decl)) =
10379 N_Formal_Private_Type_Definition
10380 then
10381 Uninit_Var :=
10382 Uninitialized_Variable (Formal_Type_Definition (Decl));
10383 end if;
10385 if Present (Uninit_Var) then
10386 Formal := Defining_Identifier (Decl);
10387 Actual := First_Entity (Act_Decl_Id);
10389 -- For each formal there is a subtype declaration that renames
10390 -- the actual and has the same name as the formal. Locate the
10391 -- formal for warning message about uninitialized variables
10392 -- in the generic, for which the actual type should be a fully
10393 -- initialized type.
10395 while Present (Actual) loop
10396 exit when Ekind (Actual) = E_Package
10397 and then Present (Renamed_Object (Actual));
10399 if Chars (Actual) = Chars (Formal)
10400 and then not Is_Scalar_Type (Actual)
10401 and then not Is_Fully_Initialized_Type (Actual)
10402 and then Warn_On_No_Value_Assigned
10403 then
10404 Error_Msg_Node_2 := Formal;
10405 Error_Msg_NE
10406 ("generic unit has uninitialized variable& of "
10407 & "formal private type &?v?", Actual, Uninit_Var);
10408 Error_Msg_NE
10409 ("actual type for& should be fully initialized type?v?",
10410 Actual, Formal);
10411 exit;
10412 end if;
10414 Next_Entity (Actual);
10415 end loop;
10416 end if;
10418 Next (Decl);
10419 end loop;
10420 end Check_Initialized_Types;
10422 -- Start of processing for Instantiate_Package_Body
10424 begin
10425 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10427 -- The instance body may already have been processed, as the parent of
10428 -- another instance that is inlined (Load_Parent_Of_Generic).
10430 if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
10431 return;
10432 end if;
10434 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10436 -- Re-establish the state of information on which checks are suppressed.
10437 -- This information was set in Body_Info at the point of instantiation,
10438 -- and now we restore it so that the instance is compiled using the
10439 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10441 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10442 Scope_Suppress := Body_Info.Scope_Suppress;
10443 Opt.Ada_Version := Body_Info.Version;
10444 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10445 Restore_Warnings (Body_Info.Warnings);
10446 Opt.SPARK_Mode := Body_Info.SPARK_Mode;
10447 Opt.SPARK_Mode_Pragma := Body_Info.SPARK_Mode_Pragma;
10449 if No (Gen_Body_Id) then
10451 -- Do not look for parent of generic body if none is required.
10452 -- This may happen when the routine is called as part of the
10453 -- Pending_Instantiations processing, when nested instances
10454 -- may precede the one generated from the main unit.
10456 if not Unit_Requires_Body (Defining_Entity (Gen_Decl))
10457 and then Body_Optional
10458 then
10459 return;
10460 else
10461 Load_Parent_Of_Generic
10462 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10463 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10464 end if;
10465 end if;
10467 -- Establish global variable for sloc adjustment and for error recovery
10469 Instantiation_Node := Inst_Node;
10471 if Present (Gen_Body_Id) then
10472 Save_Env (Gen_Unit, Act_Decl_Id);
10473 Style_Check := False;
10474 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10476 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10478 Create_Instantiation_Source
10479 (Inst_Node, Gen_Body_Id, False, S_Adjustment);
10481 Act_Body :=
10482 Copy_Generic_Node
10483 (Original_Node (Gen_Body), Empty, Instantiating => True);
10485 -- Build new name (possibly qualified) for body declaration
10487 Act_Body_Id := New_Copy (Act_Decl_Id);
10489 -- Some attributes of spec entity are not inherited by body entity
10491 Set_Handler_Records (Act_Body_Id, No_List);
10493 if Nkind (Defining_Unit_Name (Act_Spec)) =
10494 N_Defining_Program_Unit_Name
10495 then
10496 Act_Body_Name :=
10497 Make_Defining_Program_Unit_Name (Loc,
10498 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
10499 Defining_Identifier => Act_Body_Id);
10500 else
10501 Act_Body_Name := Act_Body_Id;
10502 end if;
10504 Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
10506 Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
10507 Check_Generic_Actuals (Act_Decl_Id, False);
10508 Check_Initialized_Types;
10510 -- Install primitives hidden at the point of the instantiation but
10511 -- visible when processing the generic formals
10513 declare
10514 E : Entity_Id;
10516 begin
10517 E := First_Entity (Act_Decl_Id);
10518 while Present (E) loop
10519 if Is_Type (E)
10520 and then Is_Generic_Actual_Type (E)
10521 and then Is_Tagged_Type (E)
10522 then
10523 Install_Hidden_Primitives
10524 (Prims_List => Vis_Prims_List,
10525 Gen_T => Generic_Parent_Type (Parent (E)),
10526 Act_T => E);
10527 end if;
10529 Next_Entity (E);
10530 end loop;
10531 end;
10533 -- If it is a child unit, make the parent instance (which is an
10534 -- instance of the parent of the generic) visible. The parent
10535 -- instance is the prefix of the name of the generic unit.
10537 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10538 and then Nkind (Gen_Id) = N_Expanded_Name
10539 then
10540 Par_Ent := Entity (Prefix (Gen_Id));
10541 Par_Vis := Is_Immediately_Visible (Par_Ent);
10542 Install_Parent (Par_Ent, In_Body => True);
10543 Parent_Installed := True;
10545 elsif Is_Child_Unit (Gen_Unit) then
10546 Par_Ent := Scope (Gen_Unit);
10547 Par_Vis := Is_Immediately_Visible (Par_Ent);
10548 Install_Parent (Par_Ent, In_Body => True);
10549 Parent_Installed := True;
10550 end if;
10552 -- If the instantiation is a library unit, and this is the main unit,
10553 -- then build the resulting compilation unit nodes for the instance.
10554 -- If this is a compilation unit but it is not the main unit, then it
10555 -- is the body of a unit in the context, that is being compiled
10556 -- because it is encloses some inlined unit or another generic unit
10557 -- being instantiated. In that case, this body is not part of the
10558 -- current compilation, and is not attached to the tree, but its
10559 -- parent must be set for analysis.
10561 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10563 -- Replace instance node with body of instance, and create new
10564 -- node for corresponding instance declaration.
10566 Build_Instance_Compilation_Unit_Nodes
10567 (Inst_Node, Act_Body, Act_Decl);
10568 Analyze (Inst_Node);
10570 if Parent (Inst_Node) = Cunit (Main_Unit) then
10572 -- If the instance is a child unit itself, then set the scope
10573 -- of the expanded body to be the parent of the instantiation
10574 -- (ensuring that the fully qualified name will be generated
10575 -- for the elaboration subprogram).
10577 if Nkind (Defining_Unit_Name (Act_Spec)) =
10578 N_Defining_Program_Unit_Name
10579 then
10580 Set_Scope
10581 (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
10582 end if;
10583 end if;
10585 -- Case where instantiation is not a library unit
10587 else
10588 -- If this is an early instantiation, i.e. appears textually
10589 -- before the corresponding body and must be elaborated first,
10590 -- indicate that the body instance is to be delayed.
10592 Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
10594 -- Now analyze the body. We turn off all checks if this is an
10595 -- internal unit, since there is no reason to have checks on for
10596 -- any predefined run-time library code. All such code is designed
10597 -- to be compiled with checks off.
10599 -- Note that we do NOT apply this criterion to children of GNAT
10600 -- The latter units must suppress checks explicitly if needed.
10602 if Is_Predefined_File_Name
10603 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
10604 then
10605 Analyze (Act_Body, Suppress => All_Checks);
10606 else
10607 Analyze (Act_Body);
10608 end if;
10609 end if;
10611 Inherit_Context (Gen_Body, Inst_Node);
10613 -- Remove the parent instances if they have been placed on the scope
10614 -- stack to compile the body.
10616 if Parent_Installed then
10617 Remove_Parent (In_Body => True);
10619 -- Restore the previous visibility of the parent
10621 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10622 end if;
10624 Restore_Hidden_Primitives (Vis_Prims_List);
10625 Restore_Private_Views (Act_Decl_Id);
10627 -- Remove the current unit from visibility if this is an instance
10628 -- that is not elaborated on the fly for inlining purposes.
10630 if not Inlined_Body then
10631 Set_Is_Immediately_Visible (Act_Decl_Id, False);
10632 end if;
10634 Restore_Env;
10635 Style_Check := Save_Style_Check;
10637 -- If we have no body, and the unit requires a body, then complain. This
10638 -- complaint is suppressed if we have detected other errors (since a
10639 -- common reason for missing the body is that it had errors).
10640 -- In CodePeer mode, a warning has been emitted already, no need for
10641 -- further messages.
10643 elsif Unit_Requires_Body (Gen_Unit)
10644 and then not Body_Optional
10645 then
10646 if CodePeer_Mode then
10647 null;
10649 elsif Serious_Errors_Detected = 0 then
10650 Error_Msg_NE
10651 ("cannot find body of generic package &", Inst_Node, Gen_Unit);
10653 -- Don't attempt to perform any cleanup actions if some other error
10654 -- was already detected, since this can cause blowups.
10656 else
10657 return;
10658 end if;
10660 -- Case of package that does not need a body
10662 else
10663 -- If the instantiation of the declaration is a library unit, rewrite
10664 -- the original package instantiation as a package declaration in the
10665 -- compilation unit node.
10667 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10668 Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
10669 Rewrite (Inst_Node, Act_Decl);
10671 -- Generate elaboration entity, in case spec has elaboration code.
10672 -- This cannot be done when the instance is analyzed, because it
10673 -- is not known yet whether the body exists.
10675 Set_Elaboration_Entity_Required (Act_Decl_Id, False);
10676 Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
10678 -- If the instantiation is not a library unit, then append the
10679 -- declaration to the list of implicitly generated entities, unless
10680 -- it is already a list member which means that it was already
10681 -- processed
10683 elsif not Is_List_Member (Act_Decl) then
10684 Mark_Rewrite_Insertion (Act_Decl);
10685 Insert_Before (Inst_Node, Act_Decl);
10686 end if;
10687 end if;
10689 Expander_Mode_Restore;
10690 end Instantiate_Package_Body;
10692 ---------------------------------
10693 -- Instantiate_Subprogram_Body --
10694 ---------------------------------
10696 procedure Instantiate_Subprogram_Body
10697 (Body_Info : Pending_Body_Info;
10698 Body_Optional : Boolean := False)
10700 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10701 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10702 Loc : constant Source_Ptr := Sloc (Inst_Node);
10703 Gen_Id : constant Node_Id := Name (Inst_Node);
10704 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10705 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10706 Anon_Id : constant Entity_Id :=
10707 Defining_Unit_Name (Specification (Act_Decl));
10708 Pack_Id : constant Entity_Id :=
10709 Defining_Unit_Name (Parent (Act_Decl));
10710 Decls : List_Id;
10711 Gen_Body : Node_Id;
10712 Gen_Body_Id : Node_Id;
10713 Act_Body : Node_Id;
10714 Pack_Body : Node_Id;
10715 Prev_Formal : Entity_Id;
10716 Ret_Expr : Node_Id;
10717 Unit_Renaming : Node_Id;
10719 Parent_Installed : Boolean := False;
10721 Saved_Style_Check : constant Boolean := Style_Check;
10722 Saved_Warnings : constant Warning_Record := Save_Warnings;
10724 Par_Ent : Entity_Id := Empty;
10725 Par_Vis : Boolean := False;
10727 begin
10728 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10730 -- Subprogram body may have been created already because of an inline
10731 -- pragma, or because of multiple elaborations of the enclosing package
10732 -- when several instances of the subprogram appear in the main unit.
10734 if Present (Corresponding_Body (Act_Decl)) then
10735 return;
10736 end if;
10738 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10740 -- Re-establish the state of information on which checks are suppressed.
10741 -- This information was set in Body_Info at the point of instantiation,
10742 -- and now we restore it so that the instance is compiled using the
10743 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10745 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10746 Scope_Suppress := Body_Info.Scope_Suppress;
10747 Opt.Ada_Version := Body_Info.Version;
10748 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10749 Restore_Warnings (Body_Info.Warnings);
10750 Opt.SPARK_Mode := Body_Info.SPARK_Mode;
10751 Opt.SPARK_Mode_Pragma := Body_Info.SPARK_Mode_Pragma;
10753 if No (Gen_Body_Id) then
10755 -- For imported generic subprogram, no body to compile, complete
10756 -- the spec entity appropriately.
10758 if Is_Imported (Gen_Unit) then
10759 Set_Is_Imported (Anon_Id);
10760 Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10761 Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10762 Set_Convention (Anon_Id, Convention (Gen_Unit));
10763 Set_Has_Completion (Anon_Id);
10764 return;
10766 -- For other cases, compile the body
10768 else
10769 Load_Parent_Of_Generic
10770 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10771 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10772 end if;
10773 end if;
10775 Instantiation_Node := Inst_Node;
10777 if Present (Gen_Body_Id) then
10778 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10780 if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10782 -- Either body is not present, or context is non-expanding, as
10783 -- when compiling a subunit. Mark the instance as completed, and
10784 -- diagnose a missing body when needed.
10786 if Expander_Active
10787 and then Operating_Mode = Generate_Code
10788 then
10789 Error_Msg_N
10790 ("missing proper body for instantiation", Gen_Body);
10791 end if;
10793 Set_Has_Completion (Anon_Id);
10794 return;
10795 end if;
10797 Save_Env (Gen_Unit, Anon_Id);
10798 Style_Check := False;
10799 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10800 Create_Instantiation_Source
10801 (Inst_Node,
10802 Gen_Body_Id,
10803 False,
10804 S_Adjustment);
10806 Act_Body :=
10807 Copy_Generic_Node
10808 (Original_Node (Gen_Body), Empty, Instantiating => True);
10810 -- Create proper defining name for the body, to correspond to
10811 -- the one in the spec.
10813 Set_Defining_Unit_Name (Specification (Act_Body),
10814 Make_Defining_Identifier
10815 (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10816 Set_Corresponding_Spec (Act_Body, Anon_Id);
10817 Set_Has_Completion (Anon_Id);
10818 Check_Generic_Actuals (Pack_Id, False);
10820 -- Generate a reference to link the visible subprogram instance to
10821 -- the generic body, which for navigation purposes is the only
10822 -- available source for the instance.
10824 Generate_Reference
10825 (Related_Instance (Pack_Id),
10826 Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10828 -- If it is a child unit, make the parent instance (which is an
10829 -- instance of the parent of the generic) visible. The parent
10830 -- instance is the prefix of the name of the generic unit.
10832 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10833 and then Nkind (Gen_Id) = N_Expanded_Name
10834 then
10835 Par_Ent := Entity (Prefix (Gen_Id));
10836 Par_Vis := Is_Immediately_Visible (Par_Ent);
10837 Install_Parent (Par_Ent, In_Body => True);
10838 Parent_Installed := True;
10840 elsif Is_Child_Unit (Gen_Unit) then
10841 Par_Ent := Scope (Gen_Unit);
10842 Par_Vis := Is_Immediately_Visible (Par_Ent);
10843 Install_Parent (Par_Ent, In_Body => True);
10844 Parent_Installed := True;
10845 end if;
10847 -- Inside its body, a reference to the generic unit is a reference
10848 -- to the instance. The corresponding renaming is the first
10849 -- declaration in the body.
10851 Unit_Renaming :=
10852 Make_Subprogram_Renaming_Declaration (Loc,
10853 Specification =>
10854 Copy_Generic_Node (
10855 Specification (Original_Node (Gen_Body)),
10856 Empty,
10857 Instantiating => True),
10858 Name => New_Occurrence_Of (Anon_Id, Loc));
10860 -- If there is a formal subprogram with the same name as the unit
10861 -- itself, do not add this renaming declaration. This is a temporary
10862 -- fix for one ACVC test. ???
10864 Prev_Formal := First_Entity (Pack_Id);
10865 while Present (Prev_Formal) loop
10866 if Chars (Prev_Formal) = Chars (Gen_Unit)
10867 and then Is_Overloadable (Prev_Formal)
10868 then
10869 exit;
10870 end if;
10872 Next_Entity (Prev_Formal);
10873 end loop;
10875 if Present (Prev_Formal) then
10876 Decls := New_List (Act_Body);
10877 else
10878 Decls := New_List (Unit_Renaming, Act_Body);
10879 end if;
10881 -- The subprogram body is placed in the body of a dummy package body,
10882 -- whose spec contains the subprogram declaration as well as the
10883 -- renaming declarations for the generic parameters.
10885 Pack_Body := Make_Package_Body (Loc,
10886 Defining_Unit_Name => New_Copy (Pack_Id),
10887 Declarations => Decls);
10889 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10891 -- If the instantiation is a library unit, then build resulting
10892 -- compilation unit nodes for the instance. The declaration of
10893 -- the enclosing package is the grandparent of the subprogram
10894 -- declaration. First replace the instantiation node as the unit
10895 -- of the corresponding compilation.
10897 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10898 if Parent (Inst_Node) = Cunit (Main_Unit) then
10899 Set_Unit (Parent (Inst_Node), Inst_Node);
10900 Build_Instance_Compilation_Unit_Nodes
10901 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10902 Analyze (Inst_Node);
10903 else
10904 Set_Parent (Pack_Body, Parent (Inst_Node));
10905 Analyze (Pack_Body);
10906 end if;
10908 else
10909 Insert_Before (Inst_Node, Pack_Body);
10910 Mark_Rewrite_Insertion (Pack_Body);
10911 Analyze (Pack_Body);
10913 if Expander_Active then
10914 Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10915 end if;
10916 end if;
10918 Inherit_Context (Gen_Body, Inst_Node);
10920 Restore_Private_Views (Pack_Id, False);
10922 if Parent_Installed then
10923 Remove_Parent (In_Body => True);
10925 -- Restore the previous visibility of the parent
10927 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10928 end if;
10930 Restore_Env;
10931 Style_Check := Saved_Style_Check;
10932 Restore_Warnings (Saved_Warnings);
10934 -- Body not found. Error was emitted already. If there were no previous
10935 -- errors, this may be an instance whose scope is a premature instance.
10936 -- In that case we must insure that the (legal) program does raise
10937 -- program error if executed. We generate a subprogram body for this
10938 -- purpose. See DEC ac30vso.
10940 -- Should not reference proprietary DEC tests in comments ???
10942 elsif Serious_Errors_Detected = 0
10943 and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
10944 then
10945 if Body_Optional then
10946 return;
10948 elsif Ekind (Anon_Id) = E_Procedure then
10949 Act_Body :=
10950 Make_Subprogram_Body (Loc,
10951 Specification =>
10952 Make_Procedure_Specification (Loc,
10953 Defining_Unit_Name =>
10954 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10955 Parameter_Specifications =>
10956 New_Copy_List
10957 (Parameter_Specifications (Parent (Anon_Id)))),
10959 Declarations => Empty_List,
10960 Handled_Statement_Sequence =>
10961 Make_Handled_Sequence_Of_Statements (Loc,
10962 Statements =>
10963 New_List (
10964 Make_Raise_Program_Error (Loc,
10965 Reason =>
10966 PE_Access_Before_Elaboration))));
10968 else
10969 Ret_Expr :=
10970 Make_Raise_Program_Error (Loc,
10971 Reason => PE_Access_Before_Elaboration);
10973 Set_Etype (Ret_Expr, (Etype (Anon_Id)));
10974 Set_Analyzed (Ret_Expr);
10976 Act_Body :=
10977 Make_Subprogram_Body (Loc,
10978 Specification =>
10979 Make_Function_Specification (Loc,
10980 Defining_Unit_Name =>
10981 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10982 Parameter_Specifications =>
10983 New_Copy_List
10984 (Parameter_Specifications (Parent (Anon_Id))),
10985 Result_Definition =>
10986 New_Occurrence_Of (Etype (Anon_Id), Loc)),
10988 Declarations => Empty_List,
10989 Handled_Statement_Sequence =>
10990 Make_Handled_Sequence_Of_Statements (Loc,
10991 Statements =>
10992 New_List
10993 (Make_Simple_Return_Statement (Loc, Ret_Expr))));
10994 end if;
10996 Pack_Body := Make_Package_Body (Loc,
10997 Defining_Unit_Name => New_Copy (Pack_Id),
10998 Declarations => New_List (Act_Body));
11000 Insert_After (Inst_Node, Pack_Body);
11001 Set_Corresponding_Spec (Pack_Body, Pack_Id);
11002 Analyze (Pack_Body);
11003 end if;
11005 Expander_Mode_Restore;
11006 end Instantiate_Subprogram_Body;
11008 ----------------------
11009 -- Instantiate_Type --
11010 ----------------------
11012 function Instantiate_Type
11013 (Formal : Node_Id;
11014 Actual : Node_Id;
11015 Analyzed_Formal : Node_Id;
11016 Actual_Decls : List_Id) return List_Id
11018 Gen_T : constant Entity_Id := Defining_Identifier (Formal);
11019 A_Gen_T : constant Entity_Id :=
11020 Defining_Identifier (Analyzed_Formal);
11021 Ancestor : Entity_Id := Empty;
11022 Def : constant Node_Id := Formal_Type_Definition (Formal);
11023 Act_T : Entity_Id;
11024 Decl_Node : Node_Id;
11025 Decl_Nodes : List_Id;
11026 Loc : Source_Ptr;
11027 Subt : Entity_Id;
11029 procedure Diagnose_Predicated_Actual;
11030 -- There are a number of constructs in which a discrete type with
11031 -- predicates is illegal, e.g. as an index in an array type declaration.
11032 -- If a generic type is used is such a construct in a generic package
11033 -- declaration, it carries the flag No_Predicate_On_Actual. it is part
11034 -- of the generic contract that the actual cannot have predicates.
11036 procedure Validate_Array_Type_Instance;
11037 procedure Validate_Access_Subprogram_Instance;
11038 procedure Validate_Access_Type_Instance;
11039 procedure Validate_Derived_Type_Instance;
11040 procedure Validate_Derived_Interface_Type_Instance;
11041 procedure Validate_Discriminated_Formal_Type;
11042 procedure Validate_Interface_Type_Instance;
11043 procedure Validate_Private_Type_Instance;
11044 procedure Validate_Incomplete_Type_Instance;
11045 -- These procedures perform validation tests for the named case.
11046 -- Validate_Discriminated_Formal_Type is shared by formal private
11047 -- types and Ada 2012 formal incomplete types.
11049 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
11050 -- Check that base types are the same and that the subtypes match
11051 -- statically. Used in several of the above.
11053 ---------------------------------
11054 -- Diagnose_Predicated_Actual --
11055 ---------------------------------
11057 procedure Diagnose_Predicated_Actual is
11058 begin
11059 if No_Predicate_On_Actual (A_Gen_T)
11060 and then Has_Predicates (Act_T)
11061 then
11062 Error_Msg_NE
11063 ("actual for& cannot be a type with predicate",
11064 Instantiation_Node, A_Gen_T);
11066 elsif No_Dynamic_Predicate_On_Actual (A_Gen_T)
11067 and then Has_Predicates (Act_T)
11068 and then not Has_Static_Predicate_Aspect (Act_T)
11069 then
11070 Error_Msg_NE
11071 ("actual for& cannot be a type with a dynamic predicate",
11072 Instantiation_Node, A_Gen_T);
11073 end if;
11074 end Diagnose_Predicated_Actual;
11076 --------------------
11077 -- Subtypes_Match --
11078 --------------------
11080 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
11081 T : constant Entity_Id := Get_Instance_Of (Gen_T);
11083 begin
11084 -- Some detailed comments would be useful here ???
11086 return ((Base_Type (T) = Act_T
11087 or else Base_Type (T) = Base_Type (Act_T))
11088 and then Subtypes_Statically_Match (T, Act_T))
11090 or else (Is_Class_Wide_Type (Gen_T)
11091 and then Is_Class_Wide_Type (Act_T)
11092 and then Subtypes_Match
11093 (Get_Instance_Of (Root_Type (Gen_T)),
11094 Root_Type (Act_T)))
11096 or else
11097 (Ekind_In (Gen_T, E_Anonymous_Access_Subprogram_Type,
11098 E_Anonymous_Access_Type)
11099 and then Ekind (Act_T) = Ekind (Gen_T)
11100 and then Subtypes_Statically_Match
11101 (Designated_Type (Gen_T), Designated_Type (Act_T)));
11102 end Subtypes_Match;
11104 -----------------------------------------
11105 -- Validate_Access_Subprogram_Instance --
11106 -----------------------------------------
11108 procedure Validate_Access_Subprogram_Instance is
11109 begin
11110 if not Is_Access_Type (Act_T)
11111 or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
11112 then
11113 Error_Msg_NE
11114 ("expect access type in instantiation of &", Actual, Gen_T);
11115 Abandon_Instantiation (Actual);
11116 end if;
11118 -- According to AI05-288, actuals for access_to_subprograms must be
11119 -- subtype conformant with the generic formal. Previous to AI05-288
11120 -- only mode conformance was required.
11122 -- This is a binding interpretation that applies to previous versions
11123 -- of the language, no need to maintain previous weaker checks.
11125 Check_Subtype_Conformant
11126 (Designated_Type (Act_T),
11127 Designated_Type (A_Gen_T),
11128 Actual,
11129 Get_Inst => True);
11131 if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
11132 if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
11133 Error_Msg_NE
11134 ("protected access type not allowed for formal &",
11135 Actual, Gen_T);
11136 end if;
11138 elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
11139 Error_Msg_NE
11140 ("expect protected access type for formal &",
11141 Actual, Gen_T);
11142 end if;
11143 end Validate_Access_Subprogram_Instance;
11145 -----------------------------------
11146 -- Validate_Access_Type_Instance --
11147 -----------------------------------
11149 procedure Validate_Access_Type_Instance is
11150 Desig_Type : constant Entity_Id :=
11151 Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
11152 Desig_Act : Entity_Id;
11154 begin
11155 if not Is_Access_Type (Act_T) then
11156 Error_Msg_NE
11157 ("expect access type in instantiation of &", Actual, Gen_T);
11158 Abandon_Instantiation (Actual);
11159 end if;
11161 if Is_Access_Constant (A_Gen_T) then
11162 if not Is_Access_Constant (Act_T) then
11163 Error_Msg_N
11164 ("actual type must be access-to-constant type", Actual);
11165 Abandon_Instantiation (Actual);
11166 end if;
11167 else
11168 if Is_Access_Constant (Act_T) then
11169 Error_Msg_N
11170 ("actual type must be access-to-variable type", Actual);
11171 Abandon_Instantiation (Actual);
11173 elsif Ekind (A_Gen_T) = E_General_Access_Type
11174 and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
11175 then
11176 Error_Msg_N -- CODEFIX
11177 ("actual must be general access type!", Actual);
11178 Error_Msg_NE -- CODEFIX
11179 ("add ALL to }!", Actual, Act_T);
11180 Abandon_Instantiation (Actual);
11181 end if;
11182 end if;
11184 -- The designated subtypes, that is to say the subtypes introduced
11185 -- by an access type declaration (and not by a subtype declaration)
11186 -- must match.
11188 Desig_Act := Designated_Type (Base_Type (Act_T));
11190 -- The designated type may have been introduced through a limited_
11191 -- with clause, in which case retrieve the non-limited view. This
11192 -- applies to incomplete types as well as to class-wide types.
11194 if From_Limited_With (Desig_Act) then
11195 Desig_Act := Available_View (Desig_Act);
11196 end if;
11198 if not Subtypes_Match (Desig_Type, Desig_Act) then
11199 Error_Msg_NE
11200 ("designated type of actual does not match that of formal &",
11201 Actual, Gen_T);
11203 if not Predicates_Match (Desig_Type, Desig_Act) then
11204 Error_Msg_N ("\predicates do not match", Actual);
11205 end if;
11207 Abandon_Instantiation (Actual);
11209 elsif Is_Access_Type (Designated_Type (Act_T))
11210 and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
11212 Is_Constrained (Designated_Type (Desig_Type))
11213 then
11214 Error_Msg_NE
11215 ("designated type of actual does not match that of formal &",
11216 Actual, Gen_T);
11218 if not Predicates_Match (Desig_Type, Desig_Act) then
11219 Error_Msg_N ("\predicates do not match", Actual);
11220 end if;
11222 Abandon_Instantiation (Actual);
11223 end if;
11225 -- Ada 2005: null-exclusion indicators of the two types must agree
11227 if Can_Never_Be_Null (A_Gen_T) /= Can_Never_Be_Null (Act_T) then
11228 Error_Msg_NE
11229 ("non null exclusion of actual and formal & do not match",
11230 Actual, Gen_T);
11231 end if;
11232 end Validate_Access_Type_Instance;
11234 ----------------------------------
11235 -- Validate_Array_Type_Instance --
11236 ----------------------------------
11238 procedure Validate_Array_Type_Instance is
11239 I1 : Node_Id;
11240 I2 : Node_Id;
11241 T2 : Entity_Id;
11243 function Formal_Dimensions return Int;
11244 -- Count number of dimensions in array type formal
11246 -----------------------
11247 -- Formal_Dimensions --
11248 -----------------------
11250 function Formal_Dimensions return Int is
11251 Num : Int := 0;
11252 Index : Node_Id;
11254 begin
11255 if Nkind (Def) = N_Constrained_Array_Definition then
11256 Index := First (Discrete_Subtype_Definitions (Def));
11257 else
11258 Index := First (Subtype_Marks (Def));
11259 end if;
11261 while Present (Index) loop
11262 Num := Num + 1;
11263 Next_Index (Index);
11264 end loop;
11266 return Num;
11267 end Formal_Dimensions;
11269 -- Start of processing for Validate_Array_Type_Instance
11271 begin
11272 if not Is_Array_Type (Act_T) then
11273 Error_Msg_NE
11274 ("expect array type in instantiation of &", Actual, Gen_T);
11275 Abandon_Instantiation (Actual);
11277 elsif Nkind (Def) = N_Constrained_Array_Definition then
11278 if not (Is_Constrained (Act_T)) then
11279 Error_Msg_NE
11280 ("expect constrained array in instantiation of &",
11281 Actual, Gen_T);
11282 Abandon_Instantiation (Actual);
11283 end if;
11285 else
11286 if Is_Constrained (Act_T) then
11287 Error_Msg_NE
11288 ("expect unconstrained array in instantiation of &",
11289 Actual, Gen_T);
11290 Abandon_Instantiation (Actual);
11291 end if;
11292 end if;
11294 if Formal_Dimensions /= Number_Dimensions (Act_T) then
11295 Error_Msg_NE
11296 ("dimensions of actual do not match formal &", Actual, Gen_T);
11297 Abandon_Instantiation (Actual);
11298 end if;
11300 I1 := First_Index (A_Gen_T);
11301 I2 := First_Index (Act_T);
11302 for J in 1 .. Formal_Dimensions loop
11304 -- If the indexes of the actual were given by a subtype_mark,
11305 -- the index was transformed into a range attribute. Retrieve
11306 -- the original type mark for checking.
11308 if Is_Entity_Name (Original_Node (I2)) then
11309 T2 := Entity (Original_Node (I2));
11310 else
11311 T2 := Etype (I2);
11312 end if;
11314 if not Subtypes_Match
11315 (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
11316 then
11317 Error_Msg_NE
11318 ("index types of actual do not match those of formal &",
11319 Actual, Gen_T);
11320 Abandon_Instantiation (Actual);
11321 end if;
11323 Next_Index (I1);
11324 Next_Index (I2);
11325 end loop;
11327 -- Check matching subtypes. Note that there are complex visibility
11328 -- issues when the generic is a child unit and some aspect of the
11329 -- generic type is declared in a parent unit of the generic. We do
11330 -- the test to handle this special case only after a direct check
11331 -- for static matching has failed. The case where both the component
11332 -- type and the array type are separate formals, and the component
11333 -- type is a private view may also require special checking in
11334 -- Subtypes_Match.
11336 if Subtypes_Match
11337 (Component_Type (A_Gen_T), Component_Type (Act_T))
11338 or else
11339 Subtypes_Match
11340 (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
11341 Component_Type (Act_T))
11342 then
11343 null;
11344 else
11345 Error_Msg_NE
11346 ("component subtype of actual does not match that of formal &",
11347 Actual, Gen_T);
11348 Abandon_Instantiation (Actual);
11349 end if;
11351 if Has_Aliased_Components (A_Gen_T)
11352 and then not Has_Aliased_Components (Act_T)
11353 then
11354 Error_Msg_NE
11355 ("actual must have aliased components to match formal type &",
11356 Actual, Gen_T);
11357 end if;
11358 end Validate_Array_Type_Instance;
11360 -----------------------------------------------
11361 -- Validate_Derived_Interface_Type_Instance --
11362 -----------------------------------------------
11364 procedure Validate_Derived_Interface_Type_Instance is
11365 Par : constant Entity_Id := Entity (Subtype_Indication (Def));
11366 Elmt : Elmt_Id;
11368 begin
11369 -- First apply interface instance checks
11371 Validate_Interface_Type_Instance;
11373 -- Verify that immediate parent interface is an ancestor of
11374 -- the actual.
11376 if Present (Par)
11377 and then not Interface_Present_In_Ancestor (Act_T, Par)
11378 then
11379 Error_Msg_NE
11380 ("interface actual must include progenitor&", Actual, Par);
11381 end if;
11383 -- Now verify that the actual includes all other ancestors of
11384 -- the formal.
11386 Elmt := First_Elmt (Interfaces (A_Gen_T));
11387 while Present (Elmt) loop
11388 if not Interface_Present_In_Ancestor
11389 (Act_T, Get_Instance_Of (Node (Elmt)))
11390 then
11391 Error_Msg_NE
11392 ("interface actual must include progenitor&",
11393 Actual, Node (Elmt));
11394 end if;
11396 Next_Elmt (Elmt);
11397 end loop;
11398 end Validate_Derived_Interface_Type_Instance;
11400 ------------------------------------
11401 -- Validate_Derived_Type_Instance --
11402 ------------------------------------
11404 procedure Validate_Derived_Type_Instance is
11405 Actual_Discr : Entity_Id;
11406 Ancestor_Discr : Entity_Id;
11408 begin
11409 -- If the parent type in the generic declaration is itself a previous
11410 -- formal type, then it is local to the generic and absent from the
11411 -- analyzed generic definition. In that case the ancestor is the
11412 -- instance of the formal (which must have been instantiated
11413 -- previously), unless the ancestor is itself a formal derived type.
11414 -- In this latter case (which is the subject of Corrigendum 8652/0038
11415 -- (AI-202) the ancestor of the formals is the ancestor of its
11416 -- parent. Otherwise, the analyzed generic carries the parent type.
11417 -- If the parent type is defined in a previous formal package, then
11418 -- the scope of that formal package is that of the generic type
11419 -- itself, and it has already been mapped into the corresponding type
11420 -- in the actual package.
11422 -- Common case: parent type defined outside of the generic
11424 if Is_Entity_Name (Subtype_Mark (Def))
11425 and then Present (Entity (Subtype_Mark (Def)))
11426 then
11427 Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
11429 -- Check whether parent is defined in a previous formal package
11431 elsif
11432 Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
11433 then
11434 Ancestor :=
11435 Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
11437 -- The type may be a local derivation, or a type extension of a
11438 -- previous formal, or of a formal of a parent package.
11440 elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
11441 or else
11442 Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
11443 then
11444 -- Check whether the parent is another derived formal type in the
11445 -- same generic unit.
11447 if Etype (A_Gen_T) /= A_Gen_T
11448 and then Is_Generic_Type (Etype (A_Gen_T))
11449 and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
11450 and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
11451 then
11452 -- Locate ancestor of parent from the subtype declaration
11453 -- created for the actual.
11455 declare
11456 Decl : Node_Id;
11458 begin
11459 Decl := First (Actual_Decls);
11460 while Present (Decl) loop
11461 if Nkind (Decl) = N_Subtype_Declaration
11462 and then Chars (Defining_Identifier (Decl)) =
11463 Chars (Etype (A_Gen_T))
11464 then
11465 Ancestor := Generic_Parent_Type (Decl);
11466 exit;
11467 else
11468 Next (Decl);
11469 end if;
11470 end loop;
11471 end;
11473 pragma Assert (Present (Ancestor));
11475 -- The ancestor itself may be a previous formal that has been
11476 -- instantiated.
11478 Ancestor := Get_Instance_Of (Ancestor);
11480 else
11481 Ancestor :=
11482 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
11483 end if;
11485 -- An unusual case: the actual is a type declared in a parent unit,
11486 -- but is not a formal type so there is no instance_of for it.
11487 -- Retrieve it by analyzing the record extension.
11489 elsif Is_Child_Unit (Scope (A_Gen_T))
11490 and then In_Open_Scopes (Scope (Act_T))
11491 and then Is_Generic_Instance (Scope (Act_T))
11492 then
11493 Analyze (Subtype_Mark (Def));
11494 Ancestor := Entity (Subtype_Mark (Def));
11496 else
11497 Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
11498 end if;
11500 -- If the formal derived type has pragma Preelaborable_Initialization
11501 -- then the actual type must have preelaborable initialization.
11503 if Known_To_Have_Preelab_Init (A_Gen_T)
11504 and then not Has_Preelaborable_Initialization (Act_T)
11505 then
11506 Error_Msg_NE
11507 ("actual for & must have preelaborable initialization",
11508 Actual, Gen_T);
11509 end if;
11511 -- Ada 2005 (AI-251)
11513 if Ada_Version >= Ada_2005 and then Is_Interface (Ancestor) then
11514 if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
11515 Error_Msg_NE
11516 ("(Ada 2005) expected type implementing & in instantiation",
11517 Actual, Ancestor);
11518 end if;
11520 elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
11521 Error_Msg_NE
11522 ("expect type derived from & in instantiation",
11523 Actual, First_Subtype (Ancestor));
11524 Abandon_Instantiation (Actual);
11525 end if;
11527 -- Ada 2005 (AI-443): Synchronized formal derived type checks. Note
11528 -- that the formal type declaration has been rewritten as a private
11529 -- extension.
11531 if Ada_Version >= Ada_2005
11532 and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
11533 and then Synchronized_Present (Parent (A_Gen_T))
11534 then
11535 -- The actual must be a synchronized tagged type
11537 if not Is_Tagged_Type (Act_T) then
11538 Error_Msg_N
11539 ("actual of synchronized type must be tagged", Actual);
11540 Abandon_Instantiation (Actual);
11542 elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
11543 and then Nkind (Type_Definition (Parent (Act_T))) =
11544 N_Derived_Type_Definition
11545 and then not Synchronized_Present (Type_Definition
11546 (Parent (Act_T)))
11547 then
11548 Error_Msg_N
11549 ("actual of synchronized type must be synchronized", Actual);
11550 Abandon_Instantiation (Actual);
11551 end if;
11552 end if;
11554 -- Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
11555 -- removes the second instance of the phrase "or allow pass by copy".
11557 if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
11558 Error_Msg_N
11559 ("cannot have atomic actual type for non-atomic formal type",
11560 Actual);
11562 elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
11563 Error_Msg_N
11564 ("cannot have volatile actual type for non-volatile formal type",
11565 Actual);
11566 end if;
11568 -- It should not be necessary to check for unknown discriminants on
11569 -- Formal, but for some reason Has_Unknown_Discriminants is false for
11570 -- A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
11571 -- needs fixing. ???
11573 if not Is_Indefinite_Subtype (A_Gen_T)
11574 and then not Unknown_Discriminants_Present (Formal)
11575 and then Is_Indefinite_Subtype (Act_T)
11576 then
11577 Error_Msg_N
11578 ("actual subtype must be constrained", Actual);
11579 Abandon_Instantiation (Actual);
11580 end if;
11582 if not Unknown_Discriminants_Present (Formal) then
11583 if Is_Constrained (Ancestor) then
11584 if not Is_Constrained (Act_T) then
11585 Error_Msg_N
11586 ("actual subtype must be constrained", Actual);
11587 Abandon_Instantiation (Actual);
11588 end if;
11590 -- Ancestor is unconstrained, Check if generic formal and actual
11591 -- agree on constrainedness. The check only applies to array types
11592 -- and discriminated types.
11594 elsif Is_Constrained (Act_T) then
11595 if Ekind (Ancestor) = E_Access_Type
11596 or else (not Is_Constrained (A_Gen_T)
11597 and then Is_Composite_Type (A_Gen_T))
11598 then
11599 Error_Msg_N ("actual subtype must be unconstrained", Actual);
11600 Abandon_Instantiation (Actual);
11601 end if;
11603 -- A class-wide type is only allowed if the formal has unknown
11604 -- discriminants.
11606 elsif Is_Class_Wide_Type (Act_T)
11607 and then not Has_Unknown_Discriminants (Ancestor)
11608 then
11609 Error_Msg_NE
11610 ("actual for & cannot be a class-wide type", Actual, Gen_T);
11611 Abandon_Instantiation (Actual);
11613 -- Otherwise, the formal and actual must have the same number
11614 -- of discriminants and each discriminant of the actual must
11615 -- correspond to a discriminant of the formal.
11617 elsif Has_Discriminants (Act_T)
11618 and then not Has_Unknown_Discriminants (Act_T)
11619 and then Has_Discriminants (Ancestor)
11620 then
11621 Actual_Discr := First_Discriminant (Act_T);
11622 Ancestor_Discr := First_Discriminant (Ancestor);
11623 while Present (Actual_Discr)
11624 and then Present (Ancestor_Discr)
11625 loop
11626 if Base_Type (Act_T) /= Base_Type (Ancestor) and then
11627 No (Corresponding_Discriminant (Actual_Discr))
11628 then
11629 Error_Msg_NE
11630 ("discriminant & does not correspond " &
11631 "to ancestor discriminant", Actual, Actual_Discr);
11632 Abandon_Instantiation (Actual);
11633 end if;
11635 Next_Discriminant (Actual_Discr);
11636 Next_Discriminant (Ancestor_Discr);
11637 end loop;
11639 if Present (Actual_Discr) or else Present (Ancestor_Discr) then
11640 Error_Msg_NE
11641 ("actual for & must have same number of discriminants",
11642 Actual, Gen_T);
11643 Abandon_Instantiation (Actual);
11644 end if;
11646 -- This case should be caught by the earlier check for
11647 -- constrainedness, but the check here is added for completeness.
11649 elsif Has_Discriminants (Act_T)
11650 and then not Has_Unknown_Discriminants (Act_T)
11651 then
11652 Error_Msg_NE
11653 ("actual for & must not have discriminants", Actual, Gen_T);
11654 Abandon_Instantiation (Actual);
11656 elsif Has_Discriminants (Ancestor) then
11657 Error_Msg_NE
11658 ("actual for & must have known discriminants", Actual, Gen_T);
11659 Abandon_Instantiation (Actual);
11660 end if;
11662 if not Subtypes_Statically_Compatible
11663 (Act_T, Ancestor, Formal_Derived_Matching => True)
11664 then
11665 Error_Msg_N
11666 ("constraint on actual is incompatible with formal", Actual);
11667 Abandon_Instantiation (Actual);
11668 end if;
11669 end if;
11671 -- If the formal and actual types are abstract, check that there
11672 -- are no abstract primitives of the actual type that correspond to
11673 -- nonabstract primitives of the formal type (second sentence of
11674 -- RM95-3.9.3(9)).
11676 if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
11677 Check_Abstract_Primitives : declare
11678 Gen_Prims : constant Elist_Id :=
11679 Primitive_Operations (A_Gen_T);
11680 Gen_Elmt : Elmt_Id;
11681 Gen_Subp : Entity_Id;
11682 Anc_Subp : Entity_Id;
11683 Anc_Formal : Entity_Id;
11684 Anc_F_Type : Entity_Id;
11686 Act_Prims : constant Elist_Id := Primitive_Operations (Act_T);
11687 Act_Elmt : Elmt_Id;
11688 Act_Subp : Entity_Id;
11689 Act_Formal : Entity_Id;
11690 Act_F_Type : Entity_Id;
11692 Subprograms_Correspond : Boolean;
11694 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
11695 -- Returns true if T2 is derived directly or indirectly from
11696 -- T1, including derivations from interfaces. T1 and T2 are
11697 -- required to be specific tagged base types.
11699 ------------------------
11700 -- Is_Tagged_Ancestor --
11701 ------------------------
11703 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
11705 Intfc_Elmt : Elmt_Id;
11707 begin
11708 -- The predicate is satisfied if the types are the same
11710 if T1 = T2 then
11711 return True;
11713 -- If we've reached the top of the derivation chain then
11714 -- we know that T1 is not an ancestor of T2.
11716 elsif Etype (T2) = T2 then
11717 return False;
11719 -- Proceed to check T2's immediate parent
11721 elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
11722 return True;
11724 -- Finally, check to see if T1 is an ancestor of any of T2's
11725 -- progenitors.
11727 else
11728 Intfc_Elmt := First_Elmt (Interfaces (T2));
11729 while Present (Intfc_Elmt) loop
11730 if Is_Ancestor (T1, Node (Intfc_Elmt)) then
11731 return True;
11732 end if;
11734 Next_Elmt (Intfc_Elmt);
11735 end loop;
11736 end if;
11738 return False;
11739 end Is_Tagged_Ancestor;
11741 -- Start of processing for Check_Abstract_Primitives
11743 begin
11744 -- Loop over all of the formal derived type's primitives
11746 Gen_Elmt := First_Elmt (Gen_Prims);
11747 while Present (Gen_Elmt) loop
11748 Gen_Subp := Node (Gen_Elmt);
11750 -- If the primitive of the formal is not abstract, then
11751 -- determine whether there is a corresponding primitive of
11752 -- the actual type that's abstract.
11754 if not Is_Abstract_Subprogram (Gen_Subp) then
11755 Act_Elmt := First_Elmt (Act_Prims);
11756 while Present (Act_Elmt) loop
11757 Act_Subp := Node (Act_Elmt);
11759 -- If we find an abstract primitive of the actual,
11760 -- then we need to test whether it corresponds to the
11761 -- subprogram from which the generic formal primitive
11762 -- is inherited.
11764 if Is_Abstract_Subprogram (Act_Subp) then
11765 Anc_Subp := Alias (Gen_Subp);
11767 -- Test whether we have a corresponding primitive
11768 -- by comparing names, kinds, formal types, and
11769 -- result types.
11771 if Chars (Anc_Subp) = Chars (Act_Subp)
11772 and then Ekind (Anc_Subp) = Ekind (Act_Subp)
11773 then
11774 Anc_Formal := First_Formal (Anc_Subp);
11775 Act_Formal := First_Formal (Act_Subp);
11776 while Present (Anc_Formal)
11777 and then Present (Act_Formal)
11778 loop
11779 Anc_F_Type := Etype (Anc_Formal);
11780 Act_F_Type := Etype (Act_Formal);
11782 if Ekind (Anc_F_Type)
11783 = E_Anonymous_Access_Type
11784 then
11785 Anc_F_Type := Designated_Type (Anc_F_Type);
11787 if Ekind (Act_F_Type)
11788 = E_Anonymous_Access_Type
11789 then
11790 Act_F_Type :=
11791 Designated_Type (Act_F_Type);
11792 else
11793 exit;
11794 end if;
11796 elsif
11797 Ekind (Act_F_Type) = E_Anonymous_Access_Type
11798 then
11799 exit;
11800 end if;
11802 Anc_F_Type := Base_Type (Anc_F_Type);
11803 Act_F_Type := Base_Type (Act_F_Type);
11805 -- If the formal is controlling, then the
11806 -- the type of the actual primitive's formal
11807 -- must be derived directly or indirectly
11808 -- from the type of the ancestor primitive's
11809 -- formal.
11811 if Is_Controlling_Formal (Anc_Formal) then
11812 if not Is_Tagged_Ancestor
11813 (Anc_F_Type, Act_F_Type)
11814 then
11815 exit;
11816 end if;
11818 -- Otherwise the types of the formals must
11819 -- be the same.
11821 elsif Anc_F_Type /= Act_F_Type then
11822 exit;
11823 end if;
11825 Next_Entity (Anc_Formal);
11826 Next_Entity (Act_Formal);
11827 end loop;
11829 -- If we traversed through all of the formals
11830 -- then so far the subprograms correspond, so
11831 -- now check that any result types correspond.
11833 if No (Anc_Formal) and then No (Act_Formal) then
11834 Subprograms_Correspond := True;
11836 if Ekind (Act_Subp) = E_Function then
11837 Anc_F_Type := Etype (Anc_Subp);
11838 Act_F_Type := Etype (Act_Subp);
11840 if Ekind (Anc_F_Type)
11841 = E_Anonymous_Access_Type
11842 then
11843 Anc_F_Type :=
11844 Designated_Type (Anc_F_Type);
11846 if Ekind (Act_F_Type)
11847 = E_Anonymous_Access_Type
11848 then
11849 Act_F_Type :=
11850 Designated_Type (Act_F_Type);
11851 else
11852 Subprograms_Correspond := False;
11853 end if;
11855 elsif
11856 Ekind (Act_F_Type)
11857 = E_Anonymous_Access_Type
11858 then
11859 Subprograms_Correspond := False;
11860 end if;
11862 Anc_F_Type := Base_Type (Anc_F_Type);
11863 Act_F_Type := Base_Type (Act_F_Type);
11865 -- Now either the result types must be
11866 -- the same or, if the result type is
11867 -- controlling, the result type of the
11868 -- actual primitive must descend from the
11869 -- result type of the ancestor primitive.
11871 if Subprograms_Correspond
11872 and then Anc_F_Type /= Act_F_Type
11873 and then
11874 Has_Controlling_Result (Anc_Subp)
11875 and then
11876 not Is_Tagged_Ancestor
11877 (Anc_F_Type, Act_F_Type)
11878 then
11879 Subprograms_Correspond := False;
11880 end if;
11881 end if;
11883 -- Found a matching subprogram belonging to
11884 -- formal ancestor type, so actual subprogram
11885 -- corresponds and this violates 3.9.3(9).
11887 if Subprograms_Correspond then
11888 Error_Msg_NE
11889 ("abstract subprogram & overrides " &
11890 "nonabstract subprogram of ancestor",
11891 Actual,
11892 Act_Subp);
11893 end if;
11894 end if;
11895 end if;
11896 end if;
11898 Next_Elmt (Act_Elmt);
11899 end loop;
11900 end if;
11902 Next_Elmt (Gen_Elmt);
11903 end loop;
11904 end Check_Abstract_Primitives;
11905 end if;
11907 -- Verify that limitedness matches. If parent is a limited
11908 -- interface then the generic formal is not unless declared
11909 -- explicitly so. If not declared limited, the actual cannot be
11910 -- limited (see AI05-0087).
11912 -- Even though this AI is a binding interpretation, we enable the
11913 -- check only in Ada 2012 mode, because this improper construct
11914 -- shows up in user code and in existing B-tests.
11916 if Is_Limited_Type (Act_T)
11917 and then not Is_Limited_Type (A_Gen_T)
11918 and then Ada_Version >= Ada_2012
11919 then
11920 if In_Instance then
11921 null;
11922 else
11923 Error_Msg_NE
11924 ("actual for non-limited & cannot be a limited type", Actual,
11925 Gen_T);
11926 Explain_Limited_Type (Act_T, Actual);
11927 Abandon_Instantiation (Actual);
11928 end if;
11929 end if;
11930 end Validate_Derived_Type_Instance;
11932 ----------------------------------------
11933 -- Validate_Discriminated_Formal_Type --
11934 ----------------------------------------
11936 procedure Validate_Discriminated_Formal_Type is
11937 Formal_Discr : Entity_Id;
11938 Actual_Discr : Entity_Id;
11939 Formal_Subt : Entity_Id;
11941 begin
11942 if Has_Discriminants (A_Gen_T) then
11943 if not Has_Discriminants (Act_T) then
11944 Error_Msg_NE
11945 ("actual for & must have discriminants", Actual, Gen_T);
11946 Abandon_Instantiation (Actual);
11948 elsif Is_Constrained (Act_T) then
11949 Error_Msg_NE
11950 ("actual for & must be unconstrained", Actual, Gen_T);
11951 Abandon_Instantiation (Actual);
11953 else
11954 Formal_Discr := First_Discriminant (A_Gen_T);
11955 Actual_Discr := First_Discriminant (Act_T);
11956 while Formal_Discr /= Empty loop
11957 if Actual_Discr = Empty then
11958 Error_Msg_NE
11959 ("discriminants on actual do not match formal",
11960 Actual, Gen_T);
11961 Abandon_Instantiation (Actual);
11962 end if;
11964 Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
11966 -- Access discriminants match if designated types do
11968 if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
11969 and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
11970 E_Anonymous_Access_Type
11971 and then
11972 Get_Instance_Of
11973 (Designated_Type (Base_Type (Formal_Subt))) =
11974 Designated_Type (Base_Type (Etype (Actual_Discr)))
11975 then
11976 null;
11978 elsif Base_Type (Formal_Subt) /=
11979 Base_Type (Etype (Actual_Discr))
11980 then
11981 Error_Msg_NE
11982 ("types of actual discriminants must match formal",
11983 Actual, Gen_T);
11984 Abandon_Instantiation (Actual);
11986 elsif not Subtypes_Statically_Match
11987 (Formal_Subt, Etype (Actual_Discr))
11988 and then Ada_Version >= Ada_95
11989 then
11990 Error_Msg_NE
11991 ("subtypes of actual discriminants must match formal",
11992 Actual, Gen_T);
11993 Abandon_Instantiation (Actual);
11994 end if;
11996 Next_Discriminant (Formal_Discr);
11997 Next_Discriminant (Actual_Discr);
11998 end loop;
12000 if Actual_Discr /= Empty then
12001 Error_Msg_NE
12002 ("discriminants on actual do not match formal",
12003 Actual, Gen_T);
12004 Abandon_Instantiation (Actual);
12005 end if;
12006 end if;
12007 end if;
12008 end Validate_Discriminated_Formal_Type;
12010 ---------------------------------------
12011 -- Validate_Incomplete_Type_Instance --
12012 ---------------------------------------
12014 procedure Validate_Incomplete_Type_Instance is
12015 begin
12016 if not Is_Tagged_Type (Act_T)
12017 and then Is_Tagged_Type (A_Gen_T)
12018 then
12019 Error_Msg_NE
12020 ("actual for & must be a tagged type", Actual, Gen_T);
12021 end if;
12023 Validate_Discriminated_Formal_Type;
12024 end Validate_Incomplete_Type_Instance;
12026 --------------------------------------
12027 -- Validate_Interface_Type_Instance --
12028 --------------------------------------
12030 procedure Validate_Interface_Type_Instance is
12031 begin
12032 if not Is_Interface (Act_T) then
12033 Error_Msg_NE
12034 ("actual for formal interface type must be an interface",
12035 Actual, Gen_T);
12037 elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
12038 or else Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
12039 or else Is_Protected_Interface (A_Gen_T) /=
12040 Is_Protected_Interface (Act_T)
12041 or else Is_Synchronized_Interface (A_Gen_T) /=
12042 Is_Synchronized_Interface (Act_T)
12043 then
12044 Error_Msg_NE
12045 ("actual for interface& does not match (RM 12.5.5(4))",
12046 Actual, Gen_T);
12047 end if;
12048 end Validate_Interface_Type_Instance;
12050 ------------------------------------
12051 -- Validate_Private_Type_Instance --
12052 ------------------------------------
12054 procedure Validate_Private_Type_Instance is
12055 begin
12056 if Is_Limited_Type (Act_T)
12057 and then not Is_Limited_Type (A_Gen_T)
12058 then
12059 if In_Instance then
12060 null;
12061 else
12062 Error_Msg_NE
12063 ("actual for non-limited & cannot be a limited type", Actual,
12064 Gen_T);
12065 Explain_Limited_Type (Act_T, Actual);
12066 Abandon_Instantiation (Actual);
12067 end if;
12069 elsif Known_To_Have_Preelab_Init (A_Gen_T)
12070 and then not Has_Preelaborable_Initialization (Act_T)
12071 then
12072 Error_Msg_NE
12073 ("actual for & must have preelaborable initialization", Actual,
12074 Gen_T);
12076 elsif Is_Indefinite_Subtype (Act_T)
12077 and then not Is_Indefinite_Subtype (A_Gen_T)
12078 and then Ada_Version >= Ada_95
12079 then
12080 Error_Msg_NE
12081 ("actual for & must be a definite subtype", Actual, Gen_T);
12083 elsif not Is_Tagged_Type (Act_T)
12084 and then Is_Tagged_Type (A_Gen_T)
12085 then
12086 Error_Msg_NE
12087 ("actual for & must be a tagged type", Actual, Gen_T);
12088 end if;
12090 Validate_Discriminated_Formal_Type;
12091 Ancestor := Gen_T;
12092 end Validate_Private_Type_Instance;
12094 -- Start of processing for Instantiate_Type
12096 begin
12097 if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
12098 Error_Msg_N ("duplicate instantiation of generic type", Actual);
12099 return New_List (Error);
12101 elsif not Is_Entity_Name (Actual)
12102 or else not Is_Type (Entity (Actual))
12103 then
12104 Error_Msg_NE
12105 ("expect valid subtype mark to instantiate &", Actual, Gen_T);
12106 Abandon_Instantiation (Actual);
12108 else
12109 Act_T := Entity (Actual);
12111 -- Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
12112 -- as a generic actual parameter if the corresponding formal type
12113 -- does not have a known_discriminant_part, or is a formal derived
12114 -- type that is an Unchecked_Union type.
12116 if Is_Unchecked_Union (Base_Type (Act_T)) then
12117 if not Has_Discriminants (A_Gen_T)
12118 or else (Is_Derived_Type (A_Gen_T)
12119 and then Is_Unchecked_Union (A_Gen_T))
12120 then
12121 null;
12122 else
12123 Error_Msg_N ("unchecked union cannot be the actual for a "
12124 & "discriminated formal type", Act_T);
12126 end if;
12127 end if;
12129 -- Deal with fixed/floating restrictions
12131 if Is_Floating_Point_Type (Act_T) then
12132 Check_Restriction (No_Floating_Point, Actual);
12133 elsif Is_Fixed_Point_Type (Act_T) then
12134 Check_Restriction (No_Fixed_Point, Actual);
12135 end if;
12137 -- Deal with error of using incomplete type as generic actual.
12138 -- This includes limited views of a type, even if the non-limited
12139 -- view may be available.
12141 if Ekind (Act_T) = E_Incomplete_Type
12142 or else (Is_Class_Wide_Type (Act_T)
12143 and then Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
12144 then
12145 -- If the formal is an incomplete type, the actual can be
12146 -- incomplete as well.
12148 if Ekind (A_Gen_T) = E_Incomplete_Type then
12149 null;
12151 elsif Is_Class_Wide_Type (Act_T)
12152 or else No (Full_View (Act_T))
12153 then
12154 Error_Msg_N ("premature use of incomplete type", Actual);
12155 Abandon_Instantiation (Actual);
12156 else
12157 Act_T := Full_View (Act_T);
12158 Set_Entity (Actual, Act_T);
12160 if Has_Private_Component (Act_T) then
12161 Error_Msg_N
12162 ("premature use of type with private component", Actual);
12163 end if;
12164 end if;
12166 -- Deal with error of premature use of private type as generic actual
12168 elsif Is_Private_Type (Act_T)
12169 and then Is_Private_Type (Base_Type (Act_T))
12170 and then not Is_Generic_Type (Act_T)
12171 and then not Is_Derived_Type (Act_T)
12172 and then No (Full_View (Root_Type (Act_T)))
12173 then
12174 -- If the formal is an incomplete type, the actual can be
12175 -- private or incomplete as well.
12177 if Ekind (A_Gen_T) = E_Incomplete_Type then
12178 null;
12179 else
12180 Error_Msg_N ("premature use of private type", Actual);
12181 end if;
12183 elsif Has_Private_Component (Act_T) then
12184 Error_Msg_N
12185 ("premature use of type with private component", Actual);
12186 end if;
12188 Set_Instance_Of (A_Gen_T, Act_T);
12190 -- If the type is generic, the class-wide type may also be used
12192 if Is_Tagged_Type (A_Gen_T)
12193 and then Is_Tagged_Type (Act_T)
12194 and then not Is_Class_Wide_Type (A_Gen_T)
12195 then
12196 Set_Instance_Of (Class_Wide_Type (A_Gen_T),
12197 Class_Wide_Type (Act_T));
12198 end if;
12200 if not Is_Abstract_Type (A_Gen_T)
12201 and then Is_Abstract_Type (Act_T)
12202 then
12203 Error_Msg_N
12204 ("actual of non-abstract formal cannot be abstract", Actual);
12205 end if;
12207 -- A generic scalar type is a first subtype for which we generate
12208 -- an anonymous base type. Indicate that the instance of this base
12209 -- is the base type of the actual.
12211 if Is_Scalar_Type (A_Gen_T) then
12212 Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
12213 end if;
12214 end if;
12216 if Error_Posted (Act_T) then
12217 null;
12218 else
12219 case Nkind (Def) is
12220 when N_Formal_Private_Type_Definition =>
12221 Validate_Private_Type_Instance;
12223 when N_Formal_Incomplete_Type_Definition =>
12224 Validate_Incomplete_Type_Instance;
12226 when N_Formal_Derived_Type_Definition =>
12227 Validate_Derived_Type_Instance;
12229 when N_Formal_Discrete_Type_Definition =>
12230 if not Is_Discrete_Type (Act_T) then
12231 Error_Msg_NE
12232 ("expect discrete type in instantiation of&",
12233 Actual, Gen_T);
12234 Abandon_Instantiation (Actual);
12235 end if;
12237 Diagnose_Predicated_Actual;
12239 when N_Formal_Signed_Integer_Type_Definition =>
12240 if not Is_Signed_Integer_Type (Act_T) then
12241 Error_Msg_NE
12242 ("expect signed integer type in instantiation of&",
12243 Actual, Gen_T);
12244 Abandon_Instantiation (Actual);
12245 end if;
12247 Diagnose_Predicated_Actual;
12249 when N_Formal_Modular_Type_Definition =>
12250 if not Is_Modular_Integer_Type (Act_T) then
12251 Error_Msg_NE
12252 ("expect modular type in instantiation of &",
12253 Actual, Gen_T);
12254 Abandon_Instantiation (Actual);
12255 end if;
12257 Diagnose_Predicated_Actual;
12259 when N_Formal_Floating_Point_Definition =>
12260 if not Is_Floating_Point_Type (Act_T) then
12261 Error_Msg_NE
12262 ("expect float type in instantiation of &", Actual, Gen_T);
12263 Abandon_Instantiation (Actual);
12264 end if;
12266 when N_Formal_Ordinary_Fixed_Point_Definition =>
12267 if not Is_Ordinary_Fixed_Point_Type (Act_T) then
12268 Error_Msg_NE
12269 ("expect ordinary fixed point type in instantiation of &",
12270 Actual, Gen_T);
12271 Abandon_Instantiation (Actual);
12272 end if;
12274 when N_Formal_Decimal_Fixed_Point_Definition =>
12275 if not Is_Decimal_Fixed_Point_Type (Act_T) then
12276 Error_Msg_NE
12277 ("expect decimal type in instantiation of &",
12278 Actual, Gen_T);
12279 Abandon_Instantiation (Actual);
12280 end if;
12282 when N_Array_Type_Definition =>
12283 Validate_Array_Type_Instance;
12285 when N_Access_To_Object_Definition =>
12286 Validate_Access_Type_Instance;
12288 when N_Access_Function_Definition |
12289 N_Access_Procedure_Definition =>
12290 Validate_Access_Subprogram_Instance;
12292 when N_Record_Definition =>
12293 Validate_Interface_Type_Instance;
12295 when N_Derived_Type_Definition =>
12296 Validate_Derived_Interface_Type_Instance;
12298 when others =>
12299 raise Program_Error;
12301 end case;
12302 end if;
12304 Subt := New_Copy (Gen_T);
12306 -- Use adjusted sloc of subtype name as the location for other nodes in
12307 -- the subtype declaration.
12309 Loc := Sloc (Subt);
12311 Decl_Node :=
12312 Make_Subtype_Declaration (Loc,
12313 Defining_Identifier => Subt,
12314 Subtype_Indication => New_Occurrence_Of (Act_T, Loc));
12316 if Is_Private_Type (Act_T) then
12317 Set_Has_Private_View (Subtype_Indication (Decl_Node));
12319 elsif Is_Access_Type (Act_T)
12320 and then Is_Private_Type (Designated_Type (Act_T))
12321 then
12322 Set_Has_Private_View (Subtype_Indication (Decl_Node));
12323 end if;
12325 Decl_Nodes := New_List (Decl_Node);
12327 -- Flag actual derived types so their elaboration produces the
12328 -- appropriate renamings for the primitive operations of the ancestor.
12329 -- Flag actual for formal private types as well, to determine whether
12330 -- operations in the private part may override inherited operations.
12331 -- If the formal has an interface list, the ancestor is not the
12332 -- parent, but the analyzed formal that includes the interface
12333 -- operations of all its progenitors.
12335 -- Same treatment for formal private types, so we can check whether the
12336 -- type is tagged limited when validating derivations in the private
12337 -- part. (See AI05-096).
12339 if Nkind (Def) = N_Formal_Derived_Type_Definition then
12340 if Present (Interface_List (Def)) then
12341 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
12342 else
12343 Set_Generic_Parent_Type (Decl_Node, Ancestor);
12344 end if;
12346 elsif Nkind_In (Def,
12347 N_Formal_Private_Type_Definition,
12348 N_Formal_Incomplete_Type_Definition)
12349 then
12350 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
12351 end if;
12353 -- If the actual is a synchronized type that implements an interface,
12354 -- the primitive operations are attached to the corresponding record,
12355 -- and we have to treat it as an additional generic actual, so that its
12356 -- primitive operations become visible in the instance. The task or
12357 -- protected type itself does not carry primitive operations.
12359 if Is_Concurrent_Type (Act_T)
12360 and then Is_Tagged_Type (Act_T)
12361 and then Present (Corresponding_Record_Type (Act_T))
12362 and then Present (Ancestor)
12363 and then Is_Interface (Ancestor)
12364 then
12365 declare
12366 Corr_Rec : constant Entity_Id :=
12367 Corresponding_Record_Type (Act_T);
12368 New_Corr : Entity_Id;
12369 Corr_Decl : Node_Id;
12371 begin
12372 New_Corr := Make_Temporary (Loc, 'S');
12373 Corr_Decl :=
12374 Make_Subtype_Declaration (Loc,
12375 Defining_Identifier => New_Corr,
12376 Subtype_Indication =>
12377 New_Occurrence_Of (Corr_Rec, Loc));
12378 Append_To (Decl_Nodes, Corr_Decl);
12380 if Ekind (Act_T) = E_Task_Type then
12381 Set_Ekind (Subt, E_Task_Subtype);
12382 else
12383 Set_Ekind (Subt, E_Protected_Subtype);
12384 end if;
12386 Set_Corresponding_Record_Type (Subt, Corr_Rec);
12387 Set_Generic_Parent_Type (Corr_Decl, Ancestor);
12388 Set_Generic_Parent_Type (Decl_Node, Empty);
12389 end;
12390 end if;
12392 return Decl_Nodes;
12393 end Instantiate_Type;
12395 ---------------------
12396 -- Is_In_Main_Unit --
12397 ---------------------
12399 function Is_In_Main_Unit (N : Node_Id) return Boolean is
12400 Unum : constant Unit_Number_Type := Get_Source_Unit (N);
12401 Current_Unit : Node_Id;
12403 begin
12404 if Unum = Main_Unit then
12405 return True;
12407 -- If the current unit is a subunit then it is either the main unit or
12408 -- is being compiled as part of the main unit.
12410 elsif Nkind (N) = N_Compilation_Unit then
12411 return Nkind (Unit (N)) = N_Subunit;
12412 end if;
12414 Current_Unit := Parent (N);
12415 while Present (Current_Unit)
12416 and then Nkind (Current_Unit) /= N_Compilation_Unit
12417 loop
12418 Current_Unit := Parent (Current_Unit);
12419 end loop;
12421 -- The instantiation node is in the main unit, or else the current node
12422 -- (perhaps as the result of nested instantiations) is in the main unit,
12423 -- or in the declaration of the main unit, which in this last case must
12424 -- be a body.
12426 return Unum = Main_Unit
12427 or else Current_Unit = Cunit (Main_Unit)
12428 or else Current_Unit = Library_Unit (Cunit (Main_Unit))
12429 or else (Present (Library_Unit (Current_Unit))
12430 and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
12431 end Is_In_Main_Unit;
12433 ----------------------------
12434 -- Load_Parent_Of_Generic --
12435 ----------------------------
12437 procedure Load_Parent_Of_Generic
12438 (N : Node_Id;
12439 Spec : Node_Id;
12440 Body_Optional : Boolean := False)
12442 Comp_Unit : constant Node_Id := Cunit (Get_Source_Unit (Spec));
12443 Saved_Style_Check : constant Boolean := Style_Check;
12444 Saved_Warnings : constant Warning_Record := Save_Warnings;
12445 True_Parent : Node_Id;
12446 Inst_Node : Node_Id;
12447 OK : Boolean;
12448 Previous_Instances : constant Elist_Id := New_Elmt_List;
12450 procedure Collect_Previous_Instances (Decls : List_Id);
12451 -- Collect all instantiations in the given list of declarations, that
12452 -- precede the generic that we need to load. If the bodies of these
12453 -- instantiations are available, we must analyze them, to ensure that
12454 -- the public symbols generated are the same when the unit is compiled
12455 -- to generate code, and when it is compiled in the context of a unit
12456 -- that needs a particular nested instance. This process is applied to
12457 -- both package and subprogram instances.
12459 --------------------------------
12460 -- Collect_Previous_Instances --
12461 --------------------------------
12463 procedure Collect_Previous_Instances (Decls : List_Id) is
12464 Decl : Node_Id;
12466 begin
12467 Decl := First (Decls);
12468 while Present (Decl) loop
12469 if Sloc (Decl) >= Sloc (Inst_Node) then
12470 return;
12472 -- If Decl is an instantiation, then record it as requiring
12473 -- instantiation of the corresponding body, except if it is an
12474 -- abbreviated instantiation generated internally for conformance
12475 -- checking purposes only for the case of a formal package
12476 -- declared without a box (see Instantiate_Formal_Package). Such
12477 -- an instantiation does not generate any code (the actual code
12478 -- comes from actual) and thus does not need to be analyzed here.
12479 -- If the instantiation appears with a generic package body it is
12480 -- not analyzed here either.
12482 elsif Nkind (Decl) = N_Package_Instantiation
12483 and then not Is_Internal (Defining_Entity (Decl))
12484 then
12485 Append_Elmt (Decl, Previous_Instances);
12487 -- For a subprogram instantiation, omit instantiations intrinsic
12488 -- operations (Unchecked_Conversions, etc.) that have no bodies.
12490 elsif Nkind_In (Decl, N_Function_Instantiation,
12491 N_Procedure_Instantiation)
12492 and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
12493 then
12494 Append_Elmt (Decl, Previous_Instances);
12496 elsif Nkind (Decl) = N_Package_Declaration then
12497 Collect_Previous_Instances
12498 (Visible_Declarations (Specification (Decl)));
12499 Collect_Previous_Instances
12500 (Private_Declarations (Specification (Decl)));
12502 -- Previous non-generic bodies may contain instances as well
12504 elsif Nkind (Decl) = N_Package_Body
12505 and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
12506 then
12507 Collect_Previous_Instances (Declarations (Decl));
12509 elsif Nkind (Decl) = N_Subprogram_Body
12510 and then not Acts_As_Spec (Decl)
12511 and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
12512 then
12513 Collect_Previous_Instances (Declarations (Decl));
12514 end if;
12516 Next (Decl);
12517 end loop;
12518 end Collect_Previous_Instances;
12520 -- Start of processing for Load_Parent_Of_Generic
12522 begin
12523 if not In_Same_Source_Unit (N, Spec)
12524 or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
12525 or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
12526 and then not Is_In_Main_Unit (Spec))
12527 then
12528 -- Find body of parent of spec, and analyze it. A special case arises
12529 -- when the parent is an instantiation, that is to say when we are
12530 -- currently instantiating a nested generic. In that case, there is
12531 -- no separate file for the body of the enclosing instance. Instead,
12532 -- the enclosing body must be instantiated as if it were a pending
12533 -- instantiation, in order to produce the body for the nested generic
12534 -- we require now. Note that in that case the generic may be defined
12535 -- in a package body, the instance defined in the same package body,
12536 -- and the original enclosing body may not be in the main unit.
12538 Inst_Node := Empty;
12540 True_Parent := Parent (Spec);
12541 while Present (True_Parent)
12542 and then Nkind (True_Parent) /= N_Compilation_Unit
12543 loop
12544 if Nkind (True_Parent) = N_Package_Declaration
12545 and then
12546 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
12547 then
12548 -- Parent is a compilation unit that is an instantiation.
12549 -- Instantiation node has been replaced with package decl.
12551 Inst_Node := Original_Node (True_Parent);
12552 exit;
12554 elsif Nkind (True_Parent) = N_Package_Declaration
12555 and then Present (Generic_Parent (Specification (True_Parent)))
12556 and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12557 then
12558 -- Parent is an instantiation within another specification.
12559 -- Declaration for instance has been inserted before original
12560 -- instantiation node. A direct link would be preferable?
12562 Inst_Node := Next (True_Parent);
12563 while Present (Inst_Node)
12564 and then Nkind (Inst_Node) /= N_Package_Instantiation
12565 loop
12566 Next (Inst_Node);
12567 end loop;
12569 -- If the instance appears within a generic, and the generic
12570 -- unit is defined within a formal package of the enclosing
12571 -- generic, there is no generic body available, and none
12572 -- needed. A more precise test should be used ???
12574 if No (Inst_Node) then
12575 return;
12576 end if;
12578 exit;
12580 else
12581 True_Parent := Parent (True_Parent);
12582 end if;
12583 end loop;
12585 -- Case where we are currently instantiating a nested generic
12587 if Present (Inst_Node) then
12588 if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
12590 -- Instantiation node and declaration of instantiated package
12591 -- were exchanged when only the declaration was needed.
12592 -- Restore instantiation node before proceeding with body.
12594 Set_Unit (Parent (True_Parent), Inst_Node);
12595 end if;
12597 -- Now complete instantiation of enclosing body, if it appears in
12598 -- some other unit. If it appears in the current unit, the body
12599 -- will have been instantiated already.
12601 if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
12603 -- We need to determine the expander mode to instantiate the
12604 -- enclosing body. Because the generic body we need may use
12605 -- global entities declared in the enclosing package (including
12606 -- aggregates) it is in general necessary to compile this body
12607 -- with expansion enabled, except if we are within a generic
12608 -- package, in which case the usual generic rule applies.
12610 declare
12611 Exp_Status : Boolean := True;
12612 Scop : Entity_Id;
12614 begin
12615 -- Loop through scopes looking for generic package
12617 Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
12618 while Present (Scop)
12619 and then Scop /= Standard_Standard
12620 loop
12621 if Ekind (Scop) = E_Generic_Package then
12622 Exp_Status := False;
12623 exit;
12624 end if;
12626 Scop := Scope (Scop);
12627 end loop;
12629 -- Collect previous instantiations in the unit that contains
12630 -- the desired generic.
12632 if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12633 and then not Body_Optional
12634 then
12635 declare
12636 Decl : Elmt_Id;
12637 Info : Pending_Body_Info;
12638 Par : Node_Id;
12640 begin
12641 Par := Parent (Inst_Node);
12642 while Present (Par) loop
12643 exit when Nkind (Parent (Par)) = N_Compilation_Unit;
12644 Par := Parent (Par);
12645 end loop;
12647 pragma Assert (Present (Par));
12649 if Nkind (Par) = N_Package_Body then
12650 Collect_Previous_Instances (Declarations (Par));
12652 elsif Nkind (Par) = N_Package_Declaration then
12653 Collect_Previous_Instances
12654 (Visible_Declarations (Specification (Par)));
12655 Collect_Previous_Instances
12656 (Private_Declarations (Specification (Par)));
12658 else
12659 -- Enclosing unit is a subprogram body. In this
12660 -- case all instance bodies are processed in order
12661 -- and there is no need to collect them separately.
12663 null;
12664 end if;
12666 Decl := First_Elmt (Previous_Instances);
12667 while Present (Decl) loop
12668 Info :=
12669 (Inst_Node => Node (Decl),
12670 Act_Decl =>
12671 Instance_Spec (Node (Decl)),
12672 Expander_Status => Exp_Status,
12673 Current_Sem_Unit =>
12674 Get_Code_Unit (Sloc (Node (Decl))),
12675 Scope_Suppress => Scope_Suppress,
12676 Local_Suppress_Stack_Top =>
12677 Local_Suppress_Stack_Top,
12678 Version => Ada_Version,
12679 Version_Pragma => Ada_Version_Pragma,
12680 Warnings => Save_Warnings,
12681 SPARK_Mode => SPARK_Mode,
12682 SPARK_Mode_Pragma => SPARK_Mode_Pragma);
12684 -- Package instance
12687 Nkind (Node (Decl)) = N_Package_Instantiation
12688 then
12689 Instantiate_Package_Body
12690 (Info, Body_Optional => True);
12692 -- Subprogram instance
12694 else
12695 -- The instance_spec is the wrapper package,
12696 -- and the subprogram declaration is the last
12697 -- declaration in the wrapper.
12699 Info.Act_Decl :=
12700 Last
12701 (Visible_Declarations
12702 (Specification (Info.Act_Decl)));
12704 Instantiate_Subprogram_Body
12705 (Info, Body_Optional => True);
12706 end if;
12708 Next_Elmt (Decl);
12709 end loop;
12710 end;
12711 end if;
12713 Instantiate_Package_Body
12714 (Body_Info =>
12715 ((Inst_Node => Inst_Node,
12716 Act_Decl => True_Parent,
12717 Expander_Status => Exp_Status,
12718 Current_Sem_Unit => Get_Code_Unit
12719 (Sloc (Inst_Node)),
12720 Scope_Suppress => Scope_Suppress,
12721 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
12722 Version => Ada_Version,
12723 Version_Pragma => Ada_Version_Pragma,
12724 Warnings => Save_Warnings,
12725 SPARK_Mode => SPARK_Mode,
12726 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
12727 Body_Optional => Body_Optional);
12728 end;
12729 end if;
12731 -- Case where we are not instantiating a nested generic
12733 else
12734 Opt.Style_Check := False;
12735 Expander_Mode_Save_And_Set (True);
12736 Load_Needed_Body (Comp_Unit, OK);
12737 Opt.Style_Check := Saved_Style_Check;
12738 Restore_Warnings (Saved_Warnings);
12739 Expander_Mode_Restore;
12741 if not OK
12742 and then Unit_Requires_Body (Defining_Entity (Spec))
12743 and then not Body_Optional
12744 then
12745 declare
12746 Bname : constant Unit_Name_Type :=
12747 Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
12749 begin
12750 -- In CodePeer mode, the missing body may make the analysis
12751 -- incomplete, but we do not treat it as fatal.
12753 if CodePeer_Mode then
12754 return;
12756 else
12757 Error_Msg_Unit_1 := Bname;
12758 Error_Msg_N ("this instantiation requires$!", N);
12759 Error_Msg_File_1 :=
12760 Get_File_Name (Bname, Subunit => False);
12761 Error_Msg_N ("\but file{ was not found!", N);
12762 raise Unrecoverable_Error;
12763 end if;
12764 end;
12765 end if;
12766 end if;
12767 end if;
12769 -- If loading parent of the generic caused an instantiation circularity,
12770 -- we abandon compilation at this point, because otherwise in some cases
12771 -- we get into trouble with infinite recursions after this point.
12773 if Circularity_Detected then
12774 raise Unrecoverable_Error;
12775 end if;
12776 end Load_Parent_Of_Generic;
12778 ---------------------------------
12779 -- Map_Formal_Package_Entities --
12780 ---------------------------------
12782 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
12783 E1 : Entity_Id;
12784 E2 : Entity_Id;
12786 begin
12787 Set_Instance_Of (Form, Act);
12789 -- Traverse formal and actual package to map the corresponding entities.
12790 -- We skip over internal entities that may be generated during semantic
12791 -- analysis, and find the matching entities by name, given that they
12792 -- must appear in the same order.
12794 E1 := First_Entity (Form);
12795 E2 := First_Entity (Act);
12796 while Present (E1) and then E1 /= First_Private_Entity (Form) loop
12797 -- Could this test be a single condition??? Seems like it could, and
12798 -- isn't FPE (Form) a constant anyway???
12800 if not Is_Internal (E1)
12801 and then Present (Parent (E1))
12802 and then not Is_Class_Wide_Type (E1)
12803 and then not Is_Internal_Name (Chars (E1))
12804 then
12805 while Present (E2) and then Chars (E2) /= Chars (E1) loop
12806 Next_Entity (E2);
12807 end loop;
12809 if No (E2) then
12810 exit;
12811 else
12812 Set_Instance_Of (E1, E2);
12814 if Is_Type (E1) and then Is_Tagged_Type (E2) then
12815 Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
12816 end if;
12818 if Is_Constrained (E1) then
12819 Set_Instance_Of (Base_Type (E1), Base_Type (E2));
12820 end if;
12822 if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
12823 Map_Formal_Package_Entities (E1, E2);
12824 end if;
12825 end if;
12826 end if;
12828 Next_Entity (E1);
12829 end loop;
12830 end Map_Formal_Package_Entities;
12832 -----------------------
12833 -- Move_Freeze_Nodes --
12834 -----------------------
12836 procedure Move_Freeze_Nodes
12837 (Out_Of : Entity_Id;
12838 After : Node_Id;
12839 L : List_Id)
12841 Decl : Node_Id;
12842 Next_Decl : Node_Id;
12843 Next_Node : Node_Id := After;
12844 Spec : Node_Id;
12846 function Is_Outer_Type (T : Entity_Id) return Boolean;
12847 -- Check whether entity is declared in a scope external to that of the
12848 -- generic unit.
12850 -------------------
12851 -- Is_Outer_Type --
12852 -------------------
12854 function Is_Outer_Type (T : Entity_Id) return Boolean is
12855 Scop : Entity_Id := Scope (T);
12857 begin
12858 if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12859 return True;
12861 else
12862 while Scop /= Standard_Standard loop
12863 if Scop = Out_Of then
12864 return False;
12865 else
12866 Scop := Scope (Scop);
12867 end if;
12868 end loop;
12870 return True;
12871 end if;
12872 end Is_Outer_Type;
12874 -- Start of processing for Move_Freeze_Nodes
12876 begin
12877 if No (L) then
12878 return;
12879 end if;
12881 -- First remove the freeze nodes that may appear before all other
12882 -- declarations.
12884 Decl := First (L);
12885 while Present (Decl)
12886 and then Nkind (Decl) = N_Freeze_Entity
12887 and then Is_Outer_Type (Entity (Decl))
12888 loop
12889 Decl := Remove_Head (L);
12890 Insert_After (Next_Node, Decl);
12891 Set_Analyzed (Decl, False);
12892 Next_Node := Decl;
12893 Decl := First (L);
12894 end loop;
12896 -- Next scan the list of declarations and remove each freeze node that
12897 -- appears ahead of the current node.
12899 while Present (Decl) loop
12900 while Present (Next (Decl))
12901 and then Nkind (Next (Decl)) = N_Freeze_Entity
12902 and then Is_Outer_Type (Entity (Next (Decl)))
12903 loop
12904 Next_Decl := Remove_Next (Decl);
12905 Insert_After (Next_Node, Next_Decl);
12906 Set_Analyzed (Next_Decl, False);
12907 Next_Node := Next_Decl;
12908 end loop;
12910 -- If the declaration is a nested package or concurrent type, then
12911 -- recurse. Nested generic packages will have been processed from the
12912 -- inside out.
12914 case Nkind (Decl) is
12915 when N_Package_Declaration =>
12916 Spec := Specification (Decl);
12918 when N_Task_Type_Declaration =>
12919 Spec := Task_Definition (Decl);
12921 when N_Protected_Type_Declaration =>
12922 Spec := Protected_Definition (Decl);
12924 when others =>
12925 Spec := Empty;
12926 end case;
12928 if Present (Spec) then
12929 Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
12930 Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
12931 end if;
12933 Next (Decl);
12934 end loop;
12935 end Move_Freeze_Nodes;
12937 ----------------
12938 -- Next_Assoc --
12939 ----------------
12941 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
12942 begin
12943 return Generic_Renamings.Table (E).Next_In_HTable;
12944 end Next_Assoc;
12946 ------------------------
12947 -- Preanalyze_Actuals --
12948 ------------------------
12950 procedure Preanalyze_Actuals (N : Node_Id) is
12951 Assoc : Node_Id;
12952 Act : Node_Id;
12953 Errs : constant Int := Serious_Errors_Detected;
12955 Cur : Entity_Id := Empty;
12956 -- Current homograph of the instance name
12958 Vis : Boolean;
12959 -- Saved visibility status of the current homograph
12961 begin
12962 Assoc := First (Generic_Associations (N));
12964 -- If the instance is a child unit, its name may hide an outer homonym,
12965 -- so make it invisible to perform name resolution on the actuals.
12967 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
12968 and then Present
12969 (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
12970 then
12971 Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
12973 if Is_Compilation_Unit (Cur) then
12974 Vis := Is_Immediately_Visible (Cur);
12975 Set_Is_Immediately_Visible (Cur, False);
12976 else
12977 Cur := Empty;
12978 end if;
12979 end if;
12981 while Present (Assoc) loop
12982 if Nkind (Assoc) /= N_Others_Choice then
12983 Act := Explicit_Generic_Actual_Parameter (Assoc);
12985 -- Within a nested instantiation, a defaulted actual is an empty
12986 -- association, so nothing to analyze. If the subprogram actual
12987 -- is an attribute, analyze prefix only, because actual is not a
12988 -- complete attribute reference.
12990 -- If actual is an allocator, analyze expression only. The full
12991 -- analysis can generate code, and if instance is a compilation
12992 -- unit we have to wait until the package instance is installed
12993 -- to have a proper place to insert this code.
12995 -- String literals may be operators, but at this point we do not
12996 -- know whether the actual is a formal subprogram or a string.
12998 if No (Act) then
12999 null;
13001 elsif Nkind (Act) = N_Attribute_Reference then
13002 Analyze (Prefix (Act));
13004 elsif Nkind (Act) = N_Explicit_Dereference then
13005 Analyze (Prefix (Act));
13007 elsif Nkind (Act) = N_Allocator then
13008 declare
13009 Expr : constant Node_Id := Expression (Act);
13011 begin
13012 if Nkind (Expr) = N_Subtype_Indication then
13013 Analyze (Subtype_Mark (Expr));
13015 -- Analyze separately each discriminant constraint, when
13016 -- given with a named association.
13018 declare
13019 Constr : Node_Id;
13021 begin
13022 Constr := First (Constraints (Constraint (Expr)));
13023 while Present (Constr) loop
13024 if Nkind (Constr) = N_Discriminant_Association then
13025 Analyze (Expression (Constr));
13026 else
13027 Analyze (Constr);
13028 end if;
13030 Next (Constr);
13031 end loop;
13032 end;
13034 else
13035 Analyze (Expr);
13036 end if;
13037 end;
13039 elsif Nkind (Act) /= N_Operator_Symbol then
13040 Analyze (Act);
13041 end if;
13043 -- Ensure that a ghost subprogram does not act as generic actual
13045 if Is_Entity_Name (Act)
13046 and then Is_Ghost_Subprogram (Entity (Act))
13047 then
13048 Error_Msg_N
13049 ("ghost subprogram & cannot act as generic actual", Act);
13050 Abandon_Instantiation (Act);
13052 elsif Errs /= Serious_Errors_Detected then
13054 -- Do a minimal analysis of the generic, to prevent spurious
13055 -- warnings complaining about the generic being unreferenced,
13056 -- before abandoning the instantiation.
13058 Analyze (Name (N));
13060 if Is_Entity_Name (Name (N))
13061 and then Etype (Name (N)) /= Any_Type
13062 then
13063 Generate_Reference (Entity (Name (N)), Name (N));
13064 Set_Is_Instantiated (Entity (Name (N)));
13065 end if;
13067 if Present (Cur) then
13069 -- For the case of a child instance hiding an outer homonym,
13070 -- provide additional warning which might explain the error.
13072 Set_Is_Immediately_Visible (Cur, Vis);
13073 Error_Msg_NE ("& hides outer unit with the same name??",
13074 N, Defining_Unit_Name (N));
13075 end if;
13077 Abandon_Instantiation (Act);
13078 end if;
13079 end if;
13081 Next (Assoc);
13082 end loop;
13084 if Present (Cur) then
13085 Set_Is_Immediately_Visible (Cur, Vis);
13086 end if;
13087 end Preanalyze_Actuals;
13089 -------------------
13090 -- Remove_Parent --
13091 -------------------
13093 procedure Remove_Parent (In_Body : Boolean := False) is
13094 S : Entity_Id := Current_Scope;
13095 -- S is the scope containing the instantiation just completed. The scope
13096 -- stack contains the parent instances of the instantiation, followed by
13097 -- the original S.
13099 Cur_P : Entity_Id;
13100 E : Entity_Id;
13101 P : Entity_Id;
13102 Hidden : Elmt_Id;
13104 begin
13105 -- After child instantiation is complete, remove from scope stack the
13106 -- extra copy of the current scope, and then remove parent instances.
13108 if not In_Body then
13109 Pop_Scope;
13111 while Current_Scope /= S loop
13112 P := Current_Scope;
13113 End_Package_Scope (Current_Scope);
13115 if In_Open_Scopes (P) then
13116 E := First_Entity (P);
13117 while Present (E) loop
13118 Set_Is_Immediately_Visible (E, True);
13119 Next_Entity (E);
13120 end loop;
13122 -- If instantiation is declared in a block, it is the enclosing
13123 -- scope that might be a parent instance. Note that only one
13124 -- block can be involved, because the parent instances have
13125 -- been installed within it.
13127 if Ekind (P) = E_Block then
13128 Cur_P := Scope (P);
13129 else
13130 Cur_P := P;
13131 end if;
13133 if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
13134 -- We are within an instance of some sibling. Retain
13135 -- visibility of parent, for proper subsequent cleanup, and
13136 -- reinstall private declarations as well.
13138 Set_In_Private_Part (P);
13139 Install_Private_Declarations (P);
13140 end if;
13142 -- If the ultimate parent is a top-level unit recorded in
13143 -- Instance_Parent_Unit, then reset its visibility to what it was
13144 -- before instantiation. (It's not clear what the purpose is of
13145 -- testing whether Scope (P) is In_Open_Scopes, but that test was
13146 -- present before the ultimate parent test was added.???)
13148 elsif not In_Open_Scopes (Scope (P))
13149 or else (P = Instance_Parent_Unit
13150 and then not Parent_Unit_Visible)
13151 then
13152 Set_Is_Immediately_Visible (P, False);
13154 -- If the current scope is itself an instantiation of a generic
13155 -- nested within P, and we are in the private part of body of this
13156 -- instantiation, restore the full views of P, that were removed
13157 -- in End_Package_Scope above. This obscure case can occur when a
13158 -- subunit of a generic contains an instance of a child unit of
13159 -- its generic parent unit.
13161 elsif S = Current_Scope and then Is_Generic_Instance (S) then
13162 declare
13163 Par : constant Entity_Id :=
13164 Generic_Parent (Package_Specification (S));
13165 begin
13166 if Present (Par)
13167 and then P = Scope (Par)
13168 and then (In_Package_Body (S) or else In_Private_Part (S))
13169 then
13170 Set_In_Private_Part (P);
13171 Install_Private_Declarations (P);
13172 end if;
13173 end;
13174 end if;
13175 end loop;
13177 -- Reset visibility of entities in the enclosing scope
13179 Set_Is_Hidden_Open_Scope (Current_Scope, False);
13181 Hidden := First_Elmt (Hidden_Entities);
13182 while Present (Hidden) loop
13183 Set_Is_Immediately_Visible (Node (Hidden), True);
13184 Next_Elmt (Hidden);
13185 end loop;
13187 else
13188 -- Each body is analyzed separately, and there is no context that
13189 -- needs preserving from one body instance to the next, so remove all
13190 -- parent scopes that have been installed.
13192 while Present (S) loop
13193 End_Package_Scope (S);
13194 Set_Is_Immediately_Visible (S, False);
13195 S := Current_Scope;
13196 exit when S = Standard_Standard;
13197 end loop;
13198 end if;
13199 end Remove_Parent;
13201 -----------------
13202 -- Restore_Env --
13203 -----------------
13205 procedure Restore_Env is
13206 Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
13208 begin
13209 if No (Current_Instantiated_Parent.Act_Id) then
13210 -- Restore environment after subprogram inlining
13212 Restore_Private_Views (Empty);
13213 end if;
13215 Current_Instantiated_Parent := Saved.Instantiated_Parent;
13216 Exchanged_Views := Saved.Exchanged_Views;
13217 Hidden_Entities := Saved.Hidden_Entities;
13218 Current_Sem_Unit := Saved.Current_Sem_Unit;
13219 Parent_Unit_Visible := Saved.Parent_Unit_Visible;
13220 Instance_Parent_Unit := Saved.Instance_Parent_Unit;
13222 Restore_Opt_Config_Switches (Saved.Switches);
13224 Instance_Envs.Decrement_Last;
13225 end Restore_Env;
13227 ---------------------------
13228 -- Restore_Private_Views --
13229 ---------------------------
13231 procedure Restore_Private_Views
13232 (Pack_Id : Entity_Id;
13233 Is_Package : Boolean := True)
13235 M : Elmt_Id;
13236 E : Entity_Id;
13237 Typ : Entity_Id;
13238 Dep_Elmt : Elmt_Id;
13239 Dep_Typ : Node_Id;
13241 procedure Restore_Nested_Formal (Formal : Entity_Id);
13242 -- Hide the generic formals of formal packages declared with box which
13243 -- were reachable in the current instantiation.
13245 ---------------------------
13246 -- Restore_Nested_Formal --
13247 ---------------------------
13249 procedure Restore_Nested_Formal (Formal : Entity_Id) is
13250 Ent : Entity_Id;
13252 begin
13253 if Present (Renamed_Object (Formal))
13254 and then Denotes_Formal_Package (Renamed_Object (Formal), True)
13255 then
13256 return;
13258 elsif Present (Associated_Formal_Package (Formal)) then
13259 Ent := First_Entity (Formal);
13260 while Present (Ent) loop
13261 exit when Ekind (Ent) = E_Package
13262 and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
13264 Set_Is_Hidden (Ent);
13265 Set_Is_Potentially_Use_Visible (Ent, False);
13267 -- If package, then recurse
13269 if Ekind (Ent) = E_Package then
13270 Restore_Nested_Formal (Ent);
13271 end if;
13273 Next_Entity (Ent);
13274 end loop;
13275 end if;
13276 end Restore_Nested_Formal;
13278 -- Start of processing for Restore_Private_Views
13280 begin
13281 M := First_Elmt (Exchanged_Views);
13282 while Present (M) loop
13283 Typ := Node (M);
13285 -- Subtypes of types whose views have been exchanged, and that are
13286 -- defined within the instance, were not on the Private_Dependents
13287 -- list on entry to the instance, so they have to be exchanged
13288 -- explicitly now, in order to remain consistent with the view of the
13289 -- parent type.
13291 if Ekind_In (Typ, E_Private_Type,
13292 E_Limited_Private_Type,
13293 E_Record_Type_With_Private)
13294 then
13295 Dep_Elmt := First_Elmt (Private_Dependents (Typ));
13296 while Present (Dep_Elmt) loop
13297 Dep_Typ := Node (Dep_Elmt);
13299 if Scope (Dep_Typ) = Pack_Id
13300 and then Present (Full_View (Dep_Typ))
13301 then
13302 Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
13303 Exchange_Declarations (Dep_Typ);
13304 end if;
13306 Next_Elmt (Dep_Elmt);
13307 end loop;
13308 end if;
13310 Exchange_Declarations (Node (M));
13311 Next_Elmt (M);
13312 end loop;
13314 if No (Pack_Id) then
13315 return;
13316 end if;
13318 -- Make the generic formal parameters private, and make the formal types
13319 -- into subtypes of the actuals again.
13321 E := First_Entity (Pack_Id);
13322 while Present (E) loop
13323 Set_Is_Hidden (E, True);
13325 if Is_Type (E)
13326 and then Nkind (Parent (E)) = N_Subtype_Declaration
13327 then
13328 -- If the actual for E is itself a generic actual type from
13329 -- an enclosing instance, E is still a generic actual type
13330 -- outside of the current instance. This matter when resolving
13331 -- an overloaded call that may be ambiguous in the enclosing
13332 -- instance, when two of its actuals coincide.
13334 if Is_Entity_Name (Subtype_Indication (Parent (E)))
13335 and then Is_Generic_Actual_Type
13336 (Entity (Subtype_Indication (Parent (E))))
13337 then
13338 null;
13339 else
13340 Set_Is_Generic_Actual_Type (E, False);
13341 end if;
13343 -- An unusual case of aliasing: the actual may also be directly
13344 -- visible in the generic, and be private there, while it is fully
13345 -- visible in the context of the instance. The internal subtype
13346 -- is private in the instance but has full visibility like its
13347 -- parent in the enclosing scope. This enforces the invariant that
13348 -- the privacy status of all private dependents of a type coincide
13349 -- with that of the parent type. This can only happen when a
13350 -- generic child unit is instantiated within a sibling.
13352 if Is_Private_Type (E)
13353 and then not Is_Private_Type (Etype (E))
13354 then
13355 Exchange_Declarations (E);
13356 end if;
13358 elsif Ekind (E) = E_Package then
13360 -- The end of the renaming list is the renaming of the generic
13361 -- package itself. If the instance is a subprogram, all entities
13362 -- in the corresponding package are renamings. If this entity is
13363 -- a formal package, make its own formals private as well. The
13364 -- actual in this case is itself the renaming of an instantiation.
13365 -- If the entity is not a package renaming, it is the entity
13366 -- created to validate formal package actuals: ignore it.
13368 -- If the actual is itself a formal package for the enclosing
13369 -- generic, or the actual for such a formal package, it remains
13370 -- visible on exit from the instance, and therefore nothing needs
13371 -- to be done either, except to keep it accessible.
13373 if Is_Package and then Renamed_Object (E) = Pack_Id then
13374 exit;
13376 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
13377 null;
13379 elsif
13380 Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
13381 then
13382 Set_Is_Hidden (E, False);
13384 else
13385 declare
13386 Act_P : constant Entity_Id := Renamed_Object (E);
13387 Id : Entity_Id;
13389 begin
13390 Id := First_Entity (Act_P);
13391 while Present (Id)
13392 and then Id /= First_Private_Entity (Act_P)
13393 loop
13394 exit when Ekind (Id) = E_Package
13395 and then Renamed_Object (Id) = Act_P;
13397 Set_Is_Hidden (Id, True);
13398 Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
13400 if Ekind (Id) = E_Package then
13401 Restore_Nested_Formal (Id);
13402 end if;
13404 Next_Entity (Id);
13405 end loop;
13406 end;
13407 end if;
13408 end if;
13410 Next_Entity (E);
13411 end loop;
13412 end Restore_Private_Views;
13414 --------------
13415 -- Save_Env --
13416 --------------
13418 procedure Save_Env
13419 (Gen_Unit : Entity_Id;
13420 Act_Unit : Entity_Id)
13422 begin
13423 Init_Env;
13424 Set_Instance_Env (Gen_Unit, Act_Unit);
13425 end Save_Env;
13427 ----------------------------
13428 -- Save_Global_References --
13429 ----------------------------
13431 procedure Save_Global_References (N : Node_Id) is
13432 Gen_Scope : Entity_Id;
13433 E : Entity_Id;
13434 N2 : Node_Id;
13436 function Is_Global (E : Entity_Id) return Boolean;
13437 -- Check whether entity is defined outside of generic unit. Examine the
13438 -- scope of an entity, and the scope of the scope, etc, until we find
13439 -- either Standard, in which case the entity is global, or the generic
13440 -- unit itself, which indicates that the entity is local. If the entity
13441 -- is the generic unit itself, as in the case of a recursive call, or
13442 -- the enclosing generic unit, if different from the current scope, then
13443 -- it is local as well, because it will be replaced at the point of
13444 -- instantiation. On the other hand, if it is a reference to a child
13445 -- unit of a common ancestor, which appears in an instantiation, it is
13446 -- global because it is used to denote a specific compilation unit at
13447 -- the time the instantiations will be analyzed.
13449 procedure Reset_Entity (N : Node_Id);
13450 -- Save semantic information on global entity so that it is not resolved
13451 -- again at instantiation time.
13453 procedure Save_Entity_Descendants (N : Node_Id);
13454 -- Apply Save_Global_References to the two syntactic descendants of
13455 -- non-terminal nodes that carry an Associated_Node and are processed
13456 -- through Reset_Entity. Once the global entity (if any) has been
13457 -- captured together with its type, only two syntactic descendants need
13458 -- to be traversed to complete the processing of the tree rooted at N.
13459 -- This applies to Selected_Components, Expanded_Names, and to Operator
13460 -- nodes. N can also be a character literal, identifier, or operator
13461 -- symbol node, but the call has no effect in these cases.
13463 procedure Save_Global_Defaults (N1, N2 : Node_Id);
13464 -- Default actuals in nested instances must be handled specially
13465 -- because there is no link to them from the original tree. When an
13466 -- actual subprogram is given by a default, we add an explicit generic
13467 -- association for it in the instantiation node. When we save the
13468 -- global references on the name of the instance, we recover the list
13469 -- of generic associations, and add an explicit one to the original
13470 -- generic tree, through which a global actual can be preserved.
13471 -- Similarly, if a child unit is instantiated within a sibling, in the
13472 -- context of the parent, we must preserve the identifier of the parent
13473 -- so that it can be properly resolved in a subsequent instantiation.
13475 procedure Save_Global_Descendant (D : Union_Id);
13476 -- Apply Save_Global_References recursively to the descendents of the
13477 -- current node.
13479 procedure Save_References (N : Node_Id);
13480 -- This is the recursive procedure that does the work, once the
13481 -- enclosing generic scope has been established.
13483 ---------------
13484 -- Is_Global --
13485 ---------------
13487 function Is_Global (E : Entity_Id) return Boolean is
13488 Se : Entity_Id;
13490 function Is_Instance_Node (Decl : Node_Id) return Boolean;
13491 -- Determine whether the parent node of a reference to a child unit
13492 -- denotes an instantiation or a formal package, in which case the
13493 -- reference to the child unit is global, even if it appears within
13494 -- the current scope (e.g. when the instance appears within the body
13495 -- of an ancestor).
13497 ----------------------
13498 -- Is_Instance_Node --
13499 ----------------------
13501 function Is_Instance_Node (Decl : Node_Id) return Boolean is
13502 begin
13503 return Nkind (Decl) in N_Generic_Instantiation
13504 or else
13505 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
13506 end Is_Instance_Node;
13508 -- Start of processing for Is_Global
13510 begin
13511 if E = Gen_Scope then
13512 return False;
13514 elsif E = Standard_Standard then
13515 return True;
13517 elsif Is_Child_Unit (E)
13518 and then (Is_Instance_Node (Parent (N2))
13519 or else (Nkind (Parent (N2)) = N_Expanded_Name
13520 and then N2 = Selector_Name (Parent (N2))
13521 and then
13522 Is_Instance_Node (Parent (Parent (N2)))))
13523 then
13524 return True;
13526 else
13527 Se := Scope (E);
13528 while Se /= Gen_Scope loop
13529 if Se = Standard_Standard then
13530 return True;
13531 else
13532 Se := Scope (Se);
13533 end if;
13534 end loop;
13536 return False;
13537 end if;
13538 end Is_Global;
13540 ------------------
13541 -- Reset_Entity --
13542 ------------------
13544 procedure Reset_Entity (N : Node_Id) is
13546 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
13547 -- If the type of N2 is global to the generic unit, save the type in
13548 -- the generic node. Just as we perform name capture for explicit
13549 -- references within the generic, we must capture the global types
13550 -- of local entities because they may participate in resolution in
13551 -- the instance.
13553 function Top_Ancestor (E : Entity_Id) return Entity_Id;
13554 -- Find the ultimate ancestor of the current unit. If it is not a
13555 -- generic unit, then the name of the current unit in the prefix of
13556 -- an expanded name must be replaced with its generic homonym to
13557 -- ensure that it will be properly resolved in an instance.
13559 ---------------------
13560 -- Set_Global_Type --
13561 ---------------------
13563 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
13564 Typ : constant Entity_Id := Etype (N2);
13566 begin
13567 Set_Etype (N, Typ);
13569 if Entity (N) /= N2
13570 and then Has_Private_View (Entity (N))
13571 then
13572 -- If the entity of N is not the associated node, this is a
13573 -- nested generic and it has an associated node as well, whose
13574 -- type is already the full view (see below). Indicate that the
13575 -- original node has a private view.
13577 Set_Has_Private_View (N);
13578 end if;
13580 -- If not a private type, nothing else to do
13582 if not Is_Private_Type (Typ) then
13583 if Is_Array_Type (Typ)
13584 and then Is_Private_Type (Component_Type (Typ))
13585 then
13586 Set_Has_Private_View (N);
13587 end if;
13589 -- If it is a derivation of a private type in a context where no
13590 -- full view is needed, nothing to do either.
13592 elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
13593 null;
13595 -- Otherwise mark the type for flipping and use the full view when
13596 -- available.
13598 else
13599 Set_Has_Private_View (N);
13601 if Present (Full_View (Typ)) then
13602 Set_Etype (N2, Full_View (Typ));
13603 end if;
13604 end if;
13605 end Set_Global_Type;
13607 ------------------
13608 -- Top_Ancestor --
13609 ------------------
13611 function Top_Ancestor (E : Entity_Id) return Entity_Id is
13612 Par : Entity_Id;
13614 begin
13615 Par := E;
13616 while Is_Child_Unit (Par) loop
13617 Par := Scope (Par);
13618 end loop;
13620 return Par;
13621 end Top_Ancestor;
13623 -- Start of processing for Reset_Entity
13625 begin
13626 N2 := Get_Associated_Node (N);
13627 E := Entity (N2);
13629 if Present (E) then
13631 -- If the node is an entry call to an entry in an enclosing task,
13632 -- it is rewritten as a selected component. No global entity to
13633 -- preserve in this case, since the expansion will be redone in
13634 -- the instance.
13636 if not Nkind_In (E, N_Defining_Identifier,
13637 N_Defining_Character_Literal,
13638 N_Defining_Operator_Symbol)
13639 then
13640 Set_Associated_Node (N, Empty);
13641 Set_Etype (N, Empty);
13642 return;
13643 end if;
13645 -- If the entity is an itype created as a subtype of an access
13646 -- type with a null exclusion restore source entity for proper
13647 -- visibility. The itype will be created anew in the instance.
13649 if Is_Itype (E)
13650 and then Ekind (E) = E_Access_Subtype
13651 and then Is_Entity_Name (N)
13652 and then Chars (Etype (E)) = Chars (N)
13653 then
13654 E := Etype (E);
13655 Set_Entity (N2, E);
13656 Set_Etype (N2, E);
13657 end if;
13659 if Is_Global (E) then
13661 -- If the entity is a package renaming that is the prefix of
13662 -- an expanded name, it has been rewritten as the renamed
13663 -- package, which is necessary semantically but complicates
13664 -- ASIS tree traversal, so we recover the original entity to
13665 -- expose the renaming. Take into account that the context may
13666 -- be a nested generic, that the original node may itself have
13667 -- an associated node that had better be an entity, and that
13668 -- the current node is still a selected component.
13670 if Ekind (E) = E_Package
13671 and then Nkind (N) = N_Selected_Component
13672 and then Nkind (Parent (N)) = N_Expanded_Name
13673 and then Present (Original_Node (N2))
13674 and then Is_Entity_Name (Original_Node (N2))
13675 and then Present (Entity (Original_Node (N2)))
13676 then
13677 if Is_Global (Entity (Original_Node (N2))) then
13678 N2 := Original_Node (N2);
13679 Set_Associated_Node (N, N2);
13680 Set_Global_Type (N, N2);
13682 else
13683 -- Renaming is local, and will be resolved in instance
13685 Set_Associated_Node (N, Empty);
13686 Set_Etype (N, Empty);
13687 end if;
13689 else
13690 Set_Global_Type (N, N2);
13691 end if;
13693 elsif Nkind (N) = N_Op_Concat
13694 and then Is_Generic_Type (Etype (N2))
13695 and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
13696 or else
13697 Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
13698 and then Is_Intrinsic_Subprogram (E)
13699 then
13700 null;
13702 else
13703 -- Entity is local. Mark generic node as unresolved.
13704 -- Note that now it does not have an entity.
13706 Set_Associated_Node (N, Empty);
13707 Set_Etype (N, Empty);
13708 end if;
13710 if Nkind (Parent (N)) in N_Generic_Instantiation
13711 and then N = Name (Parent (N))
13712 then
13713 Save_Global_Defaults (Parent (N), Parent (N2));
13714 end if;
13716 elsif Nkind (Parent (N)) = N_Selected_Component
13717 and then Nkind (Parent (N2)) = N_Expanded_Name
13718 then
13719 if Is_Global (Entity (Parent (N2))) then
13720 Change_Selected_Component_To_Expanded_Name (Parent (N));
13721 Set_Associated_Node (Parent (N), Parent (N2));
13722 Set_Global_Type (Parent (N), Parent (N2));
13723 Save_Entity_Descendants (N);
13725 -- If this is a reference to the current generic entity, replace
13726 -- by the name of the generic homonym of the current package. This
13727 -- is because in an instantiation Par.P.Q will not resolve to the
13728 -- name of the instance, whose enclosing scope is not necessarily
13729 -- Par. We use the generic homonym rather that the name of the
13730 -- generic itself because it may be hidden by a local declaration.
13732 elsif In_Open_Scopes (Entity (Parent (N2)))
13733 and then not
13734 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
13735 then
13736 if Ekind (Entity (Parent (N2))) = E_Generic_Package then
13737 Rewrite (Parent (N),
13738 Make_Identifier (Sloc (N),
13739 Chars =>
13740 Chars (Generic_Homonym (Entity (Parent (N2))))));
13741 else
13742 Rewrite (Parent (N),
13743 Make_Identifier (Sloc (N),
13744 Chars => Chars (Selector_Name (Parent (N2)))));
13745 end if;
13746 end if;
13748 if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
13749 and then Parent (N) = Name (Parent (Parent (N)))
13750 then
13751 Save_Global_Defaults
13752 (Parent (Parent (N)), Parent (Parent ((N2))));
13753 end if;
13755 -- A selected component may denote a static constant that has been
13756 -- folded. If the static constant is global to the generic, capture
13757 -- its value. Otherwise the folding will happen in any instantiation.
13759 elsif Nkind (Parent (N)) = N_Selected_Component
13760 and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
13761 then
13762 if Present (Entity (Original_Node (Parent (N2))))
13763 and then Is_Global (Entity (Original_Node (Parent (N2))))
13764 then
13765 Rewrite (Parent (N), New_Copy (Parent (N2)));
13766 Set_Analyzed (Parent (N), False);
13768 else
13769 null;
13770 end if;
13772 -- A selected component may be transformed into a parameterless
13773 -- function call. If the called entity is global, rewrite the node
13774 -- appropriately, i.e. as an extended name for the global entity.
13776 elsif Nkind (Parent (N)) = N_Selected_Component
13777 and then Nkind (Parent (N2)) = N_Function_Call
13778 and then N = Selector_Name (Parent (N))
13779 then
13780 if No (Parameter_Associations (Parent (N2))) then
13781 if Is_Global (Entity (Name (Parent (N2)))) then
13782 Change_Selected_Component_To_Expanded_Name (Parent (N));
13783 Set_Associated_Node (Parent (N), Name (Parent (N2)));
13784 Set_Global_Type (Parent (N), Name (Parent (N2)));
13785 Save_Entity_Descendants (N);
13787 else
13788 Set_Is_Prefixed_Call (Parent (N));
13789 Set_Associated_Node (N, Empty);
13790 Set_Etype (N, Empty);
13791 end if;
13793 -- In Ada 2005, X.F may be a call to a primitive operation,
13794 -- rewritten as F (X). This rewriting will be done again in an
13795 -- instance, so keep the original node. Global entities will be
13796 -- captured as for other constructs. Indicate that this must
13797 -- resolve as a call, to prevent accidental overloading in the
13798 -- instance, if both a component and a primitive operation appear
13799 -- as candidates.
13801 else
13802 Set_Is_Prefixed_Call (Parent (N));
13803 end if;
13805 -- Entity is local. Reset in generic unit, so that node is resolved
13806 -- anew at the point of instantiation.
13808 else
13809 Set_Associated_Node (N, Empty);
13810 Set_Etype (N, Empty);
13811 end if;
13812 end Reset_Entity;
13814 -----------------------------
13815 -- Save_Entity_Descendants --
13816 -----------------------------
13818 procedure Save_Entity_Descendants (N : Node_Id) is
13819 begin
13820 case Nkind (N) is
13821 when N_Binary_Op =>
13822 Save_Global_Descendant (Union_Id (Left_Opnd (N)));
13823 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13825 when N_Unary_Op =>
13826 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13828 when N_Expanded_Name | N_Selected_Component =>
13829 Save_Global_Descendant (Union_Id (Prefix (N)));
13830 Save_Global_Descendant (Union_Id (Selector_Name (N)));
13832 when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
13833 null;
13835 when others =>
13836 raise Program_Error;
13837 end case;
13838 end Save_Entity_Descendants;
13840 --------------------------
13841 -- Save_Global_Defaults --
13842 --------------------------
13844 procedure Save_Global_Defaults (N1, N2 : Node_Id) is
13845 Loc : constant Source_Ptr := Sloc (N1);
13846 Assoc2 : constant List_Id := Generic_Associations (N2);
13847 Gen_Id : constant Entity_Id := Get_Generic_Entity (N2);
13848 Assoc1 : List_Id;
13849 Act1 : Node_Id;
13850 Act2 : Node_Id;
13851 Def : Node_Id;
13852 Ndec : Node_Id;
13853 Subp : Entity_Id;
13854 Actual : Entity_Id;
13856 begin
13857 Assoc1 := Generic_Associations (N1);
13859 if Present (Assoc1) then
13860 Act1 := First (Assoc1);
13861 else
13862 Act1 := Empty;
13863 Set_Generic_Associations (N1, New_List);
13864 Assoc1 := Generic_Associations (N1);
13865 end if;
13867 if Present (Assoc2) then
13868 Act2 := First (Assoc2);
13869 else
13870 return;
13871 end if;
13873 while Present (Act1) and then Present (Act2) loop
13874 Next (Act1);
13875 Next (Act2);
13876 end loop;
13878 -- Find the associations added for default subprograms
13880 if Present (Act2) then
13881 while Nkind (Act2) /= N_Generic_Association
13882 or else No (Entity (Selector_Name (Act2)))
13883 or else not Is_Overloadable (Entity (Selector_Name (Act2)))
13884 loop
13885 Next (Act2);
13886 end loop;
13888 -- Add a similar association if the default is global. The
13889 -- renaming declaration for the actual has been analyzed, and
13890 -- its alias is the program it renames. Link the actual in the
13891 -- original generic tree with the node in the analyzed tree.
13893 while Present (Act2) loop
13894 Subp := Entity (Selector_Name (Act2));
13895 Def := Explicit_Generic_Actual_Parameter (Act2);
13897 -- Following test is defence against rubbish errors
13899 if No (Alias (Subp)) then
13900 return;
13901 end if;
13903 -- Retrieve the resolved actual from the renaming declaration
13904 -- created for the instantiated formal.
13906 Actual := Entity (Name (Parent (Parent (Subp))));
13907 Set_Entity (Def, Actual);
13908 Set_Etype (Def, Etype (Actual));
13910 if Is_Global (Actual) then
13911 Ndec :=
13912 Make_Generic_Association (Loc,
13913 Selector_Name => New_Occurrence_Of (Subp, Loc),
13914 Explicit_Generic_Actual_Parameter =>
13915 New_Occurrence_Of (Actual, Loc));
13917 Set_Associated_Node
13918 (Explicit_Generic_Actual_Parameter (Ndec), Def);
13920 Append (Ndec, Assoc1);
13922 -- If there are other defaults, add a dummy association in case
13923 -- there are other defaulted formals with the same name.
13925 elsif Present (Next (Act2)) then
13926 Ndec :=
13927 Make_Generic_Association (Loc,
13928 Selector_Name => New_Occurrence_Of (Subp, Loc),
13929 Explicit_Generic_Actual_Parameter => Empty);
13931 Append (Ndec, Assoc1);
13932 end if;
13934 Next (Act2);
13935 end loop;
13936 end if;
13938 if Nkind (Name (N1)) = N_Identifier
13939 and then Is_Child_Unit (Gen_Id)
13940 and then Is_Global (Gen_Id)
13941 and then Is_Generic_Unit (Scope (Gen_Id))
13942 and then In_Open_Scopes (Scope (Gen_Id))
13943 then
13944 -- This is an instantiation of a child unit within a sibling, so
13945 -- that the generic parent is in scope. An eventual instance must
13946 -- occur within the scope of an instance of the parent. Make name
13947 -- in instance into an expanded name, to preserve the identifier
13948 -- of the parent, so it can be resolved subsequently.
13950 Rewrite (Name (N2),
13951 Make_Expanded_Name (Loc,
13952 Chars => Chars (Gen_Id),
13953 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13954 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13955 Set_Entity (Name (N2), Gen_Id);
13957 Rewrite (Name (N1),
13958 Make_Expanded_Name (Loc,
13959 Chars => Chars (Gen_Id),
13960 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13961 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13963 Set_Associated_Node (Name (N1), Name (N2));
13964 Set_Associated_Node (Prefix (Name (N1)), Empty);
13965 Set_Associated_Node
13966 (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
13967 Set_Etype (Name (N1), Etype (Gen_Id));
13968 end if;
13970 end Save_Global_Defaults;
13972 ----------------------------
13973 -- Save_Global_Descendant --
13974 ----------------------------
13976 procedure Save_Global_Descendant (D : Union_Id) is
13977 N1 : Node_Id;
13979 begin
13980 if D in Node_Range then
13981 if D = Union_Id (Empty) then
13982 null;
13984 elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
13985 Save_References (Node_Id (D));
13986 end if;
13988 elsif D in List_Range then
13989 if D = Union_Id (No_List) or else Is_Empty_List (List_Id (D)) then
13990 null;
13992 else
13993 N1 := First (List_Id (D));
13994 while Present (N1) loop
13995 Save_References (N1);
13996 Next (N1);
13997 end loop;
13998 end if;
14000 -- Element list or other non-node field, nothing to do
14002 else
14003 null;
14004 end if;
14005 end Save_Global_Descendant;
14007 ---------------------
14008 -- Save_References --
14009 ---------------------
14011 -- This is the recursive procedure that does the work once the enclosing
14012 -- generic scope has been established. We have to treat specially a
14013 -- number of node rewritings that are required by semantic processing
14014 -- and which change the kind of nodes in the generic copy: typically
14015 -- constant-folding, replacing an operator node by a string literal, or
14016 -- a selected component by an expanded name. In each of those cases, the
14017 -- transformation is propagated to the generic unit.
14019 procedure Save_References (N : Node_Id) is
14020 Loc : constant Source_Ptr := Sloc (N);
14022 begin
14023 if N = Empty then
14024 null;
14026 elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
14027 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14028 Reset_Entity (N);
14030 elsif Nkind (N) = N_Operator_Symbol
14031 and then Nkind (Get_Associated_Node (N)) = N_String_Literal
14032 then
14033 Change_Operator_Symbol_To_String_Literal (N);
14034 end if;
14036 elsif Nkind (N) in N_Op then
14037 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14038 if Nkind (N) = N_Op_Concat then
14039 Set_Is_Component_Left_Opnd (N,
14040 Is_Component_Left_Opnd (Get_Associated_Node (N)));
14042 Set_Is_Component_Right_Opnd (N,
14043 Is_Component_Right_Opnd (Get_Associated_Node (N)));
14044 end if;
14046 Reset_Entity (N);
14048 else
14049 -- Node may be transformed into call to a user-defined operator
14051 N2 := Get_Associated_Node (N);
14053 if Nkind (N2) = N_Function_Call then
14054 E := Entity (Name (N2));
14056 if Present (E)
14057 and then Is_Global (E)
14058 then
14059 Set_Etype (N, Etype (N2));
14060 else
14061 Set_Associated_Node (N, Empty);
14062 Set_Etype (N, Empty);
14063 end if;
14065 elsif Nkind_In (N2, N_Integer_Literal,
14066 N_Real_Literal,
14067 N_String_Literal)
14068 then
14069 if Present (Original_Node (N2))
14070 and then Nkind (Original_Node (N2)) = Nkind (N)
14071 then
14073 -- Operation was constant-folded. Whenever possible,
14074 -- recover semantic information from unfolded node,
14075 -- for ASIS use.
14077 Set_Associated_Node (N, Original_Node (N2));
14079 if Nkind (N) = N_Op_Concat then
14080 Set_Is_Component_Left_Opnd (N,
14081 Is_Component_Left_Opnd (Get_Associated_Node (N)));
14082 Set_Is_Component_Right_Opnd (N,
14083 Is_Component_Right_Opnd (Get_Associated_Node (N)));
14084 end if;
14086 Reset_Entity (N);
14088 else
14089 -- If original node is already modified, propagate
14090 -- constant-folding to template.
14092 Rewrite (N, New_Copy (N2));
14093 Set_Analyzed (N, False);
14094 end if;
14096 elsif Nkind (N2) = N_Identifier
14097 and then Ekind (Entity (N2)) = E_Enumeration_Literal
14098 then
14099 -- Same if call was folded into a literal, but in this case
14100 -- retain the entity to avoid spurious ambiguities if it is
14101 -- overloaded at the point of instantiation or inlining.
14103 Rewrite (N, New_Copy (N2));
14104 Set_Analyzed (N, False);
14105 end if;
14106 end if;
14108 -- Complete operands check if node has not been constant-folded
14110 if Nkind (N) in N_Op then
14111 Save_Entity_Descendants (N);
14112 end if;
14114 elsif Nkind (N) = N_Identifier then
14115 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14117 -- If this is a discriminant reference, always save it. It is
14118 -- used in the instance to find the corresponding discriminant
14119 -- positionally rather than by name.
14121 Set_Original_Discriminant
14122 (N, Original_Discriminant (Get_Associated_Node (N)));
14123 Reset_Entity (N);
14125 else
14126 N2 := Get_Associated_Node (N);
14128 if Nkind (N2) = N_Function_Call then
14129 E := Entity (Name (N2));
14131 -- Name resolves to a call to parameterless function. If
14132 -- original entity is global, mark node as resolved.
14134 if Present (E)
14135 and then Is_Global (E)
14136 then
14137 Set_Etype (N, Etype (N2));
14138 else
14139 Set_Associated_Node (N, Empty);
14140 Set_Etype (N, Empty);
14141 end if;
14143 elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
14144 and then Is_Entity_Name (Original_Node (N2))
14145 then
14146 -- Name resolves to named number that is constant-folded,
14147 -- We must preserve the original name for ASIS use, and
14148 -- undo the constant-folding, which will be repeated in
14149 -- each instance.
14151 Set_Associated_Node (N, Original_Node (N2));
14152 Reset_Entity (N);
14154 elsif Nkind (N2) = N_String_Literal then
14156 -- Name resolves to string literal. Perform the same
14157 -- replacement in generic.
14159 Rewrite (N, New_Copy (N2));
14161 elsif Nkind (N2) = N_Explicit_Dereference then
14163 -- An identifier is rewritten as a dereference if it is the
14164 -- prefix in an implicit dereference (call or attribute).
14165 -- The analysis of an instantiation will expand the node
14166 -- again, so we preserve the original tree but link it to
14167 -- the resolved entity in case it is global.
14169 if Is_Entity_Name (Prefix (N2))
14170 and then Present (Entity (Prefix (N2)))
14171 and then Is_Global (Entity (Prefix (N2)))
14172 then
14173 Set_Associated_Node (N, Prefix (N2));
14175 elsif Nkind (Prefix (N2)) = N_Function_Call
14176 and then Is_Global (Entity (Name (Prefix (N2))))
14177 then
14178 Rewrite (N,
14179 Make_Explicit_Dereference (Loc,
14180 Prefix => Make_Function_Call (Loc,
14181 Name =>
14182 New_Occurrence_Of (Entity (Name (Prefix (N2))),
14183 Loc))));
14185 else
14186 Set_Associated_Node (N, Empty);
14187 Set_Etype (N, Empty);
14188 end if;
14190 -- The subtype mark of a nominally unconstrained object is
14191 -- rewritten as a subtype indication using the bounds of the
14192 -- expression. Recover the original subtype mark.
14194 elsif Nkind (N2) = N_Subtype_Indication
14195 and then Is_Entity_Name (Original_Node (N2))
14196 then
14197 Set_Associated_Node (N, Original_Node (N2));
14198 Reset_Entity (N);
14200 else
14201 null;
14202 end if;
14203 end if;
14205 elsif Nkind (N) in N_Entity then
14206 null;
14208 else
14209 declare
14210 Qual : Node_Id := Empty;
14211 Typ : Entity_Id := Empty;
14212 Nam : Node_Id;
14214 use Atree.Unchecked_Access;
14215 -- This code section is part of implementing an untyped tree
14216 -- traversal, so it needs direct access to node fields.
14218 begin
14219 if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
14220 N2 := Get_Associated_Node (N);
14222 if No (N2) then
14223 Typ := Empty;
14224 else
14225 Typ := Etype (N2);
14227 -- In an instance within a generic, use the name of the
14228 -- actual and not the original generic parameter. If the
14229 -- actual is global in the current generic it must be
14230 -- preserved for its instantiation.
14232 if Nkind (Parent (Typ)) = N_Subtype_Declaration
14233 and then
14234 Present (Generic_Parent_Type (Parent (Typ)))
14235 then
14236 Typ := Base_Type (Typ);
14237 Set_Etype (N2, Typ);
14238 end if;
14239 end if;
14241 if No (N2) or else No (Typ) or else not Is_Global (Typ) then
14242 Set_Associated_Node (N, Empty);
14244 -- If the aggregate is an actual in a call, it has been
14245 -- resolved in the current context, to some local type.
14246 -- The enclosing call may have been disambiguated by the
14247 -- aggregate, and this disambiguation might fail at
14248 -- instantiation time because the type to which the
14249 -- aggregate did resolve is not preserved. In order to
14250 -- preserve some of this information, we wrap the
14251 -- aggregate in a qualified expression, using the id of
14252 -- its type. For further disambiguation we qualify the
14253 -- type name with its scope (if visible) because both
14254 -- id's will have corresponding entities in an instance.
14255 -- This resolves most of the problems with missing type
14256 -- information on aggregates in instances.
14258 if Nkind (N2) = Nkind (N)
14259 and then Nkind (Parent (N2)) in N_Subprogram_Call
14260 and then Comes_From_Source (Typ)
14261 then
14262 if Is_Immediately_Visible (Scope (Typ)) then
14263 Nam := Make_Selected_Component (Loc,
14264 Prefix =>
14265 Make_Identifier (Loc, Chars (Scope (Typ))),
14266 Selector_Name =>
14267 Make_Identifier (Loc, Chars (Typ)));
14268 else
14269 Nam := Make_Identifier (Loc, Chars (Typ));
14270 end if;
14272 Qual :=
14273 Make_Qualified_Expression (Loc,
14274 Subtype_Mark => Nam,
14275 Expression => Relocate_Node (N));
14276 end if;
14277 end if;
14279 Save_Global_Descendant (Field1 (N));
14280 Save_Global_Descendant (Field2 (N));
14281 Save_Global_Descendant (Field3 (N));
14282 Save_Global_Descendant (Field5 (N));
14284 if Present (Qual) then
14285 Rewrite (N, Qual);
14286 end if;
14288 -- All other cases than aggregates
14290 else
14291 Save_Global_Descendant (Field1 (N));
14292 Save_Global_Descendant (Field2 (N));
14293 Save_Global_Descendant (Field3 (N));
14294 Save_Global_Descendant (Field4 (N));
14295 Save_Global_Descendant (Field5 (N));
14296 end if;
14297 end;
14298 end if;
14300 -- If a node has aspects, references within their expressions must
14301 -- be saved separately, given they are not directly in the tree.
14303 if Has_Aspects (N) then
14304 declare
14305 Aspect : Node_Id;
14307 begin
14308 Aspect := First (Aspect_Specifications (N));
14309 while Present (Aspect) loop
14310 if Present (Expression (Aspect)) then
14311 Save_Global_References (Expression (Aspect));
14312 end if;
14314 Next (Aspect);
14315 end loop;
14316 end;
14317 end if;
14318 end Save_References;
14320 -- Start of processing for Save_Global_References
14322 begin
14323 Gen_Scope := Current_Scope;
14325 -- If the generic unit is a child unit, references to entities in the
14326 -- parent are treated as local, because they will be resolved anew in
14327 -- the context of the instance of the parent.
14329 while Is_Child_Unit (Gen_Scope)
14330 and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
14331 loop
14332 Gen_Scope := Scope (Gen_Scope);
14333 end loop;
14335 Save_References (N);
14336 end Save_Global_References;
14338 --------------------------------------
14339 -- Set_Copied_Sloc_For_Inlined_Body --
14340 --------------------------------------
14342 procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
14343 begin
14344 Create_Instantiation_Source (N, E, True, S_Adjustment);
14345 end Set_Copied_Sloc_For_Inlined_Body;
14347 ---------------------
14348 -- Set_Instance_Of --
14349 ---------------------
14351 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
14352 begin
14353 Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
14354 Generic_Renamings_HTable.Set (Generic_Renamings.Last);
14355 Generic_Renamings.Increment_Last;
14356 end Set_Instance_Of;
14358 --------------------
14359 -- Set_Next_Assoc --
14360 --------------------
14362 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
14363 begin
14364 Generic_Renamings.Table (E).Next_In_HTable := Next;
14365 end Set_Next_Assoc;
14367 -------------------
14368 -- Start_Generic --
14369 -------------------
14371 procedure Start_Generic is
14372 begin
14373 -- ??? More things could be factored out in this routine.
14374 -- Should probably be done at a later stage.
14376 Generic_Flags.Append (Inside_A_Generic);
14377 Inside_A_Generic := True;
14379 Expander_Mode_Save_And_Set (False);
14380 end Start_Generic;
14382 ----------------------
14383 -- Set_Instance_Env --
14384 ----------------------
14386 procedure Set_Instance_Env
14387 (Gen_Unit : Entity_Id;
14388 Act_Unit : Entity_Id)
14390 Assertion_Status : constant Boolean := Assertions_Enabled;
14391 Save_SPARK_Mode : constant SPARK_Mode_Type := SPARK_Mode;
14392 Save_SPARK_Mode_Pragma : constant Node_Id := SPARK_Mode_Pragma;
14394 begin
14395 -- Regardless of the current mode, predefined units are analyzed in the
14396 -- most current Ada mode, and earlier version Ada checks do not apply
14397 -- to predefined units. Nothing needs to be done for non-internal units.
14398 -- These are always analyzed in the current mode.
14400 if Is_Internal_File_Name
14401 (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
14402 Renamings_Included => True)
14403 then
14404 Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
14406 -- In Ada2012 we may want to enable assertions in an instance of a
14407 -- predefined unit, in which case we need to preserve the current
14408 -- setting for the Assertions_Enabled flag. This will become more
14409 -- critical when pre/postconditions are added to predefined units,
14410 -- as is already the case for some numeric libraries.
14412 if Ada_Version >= Ada_2012 then
14413 Assertions_Enabled := Assertion_Status;
14414 end if;
14416 -- SPARK_Mode for an instance is the one applicable at the point of
14417 -- instantiation.
14419 SPARK_Mode := Save_SPARK_Mode;
14420 SPARK_Mode_Pragma := Save_SPARK_Mode_Pragma;
14421 end if;
14423 Current_Instantiated_Parent :=
14424 (Gen_Id => Gen_Unit,
14425 Act_Id => Act_Unit,
14426 Next_In_HTable => Assoc_Null);
14427 end Set_Instance_Env;
14429 -----------------
14430 -- Switch_View --
14431 -----------------
14433 procedure Switch_View (T : Entity_Id) is
14434 BT : constant Entity_Id := Base_Type (T);
14435 Priv_Elmt : Elmt_Id := No_Elmt;
14436 Priv_Sub : Entity_Id;
14438 begin
14439 -- T may be private but its base type may have been exchanged through
14440 -- some other occurrence, in which case there is nothing to switch
14441 -- besides T itself. Note that a private dependent subtype of a private
14442 -- type might not have been switched even if the base type has been,
14443 -- because of the last branch of Check_Private_View (see comment there).
14445 if not Is_Private_Type (BT) then
14446 Prepend_Elmt (Full_View (T), Exchanged_Views);
14447 Exchange_Declarations (T);
14448 return;
14449 end if;
14451 Priv_Elmt := First_Elmt (Private_Dependents (BT));
14453 if Present (Full_View (BT)) then
14454 Prepend_Elmt (Full_View (BT), Exchanged_Views);
14455 Exchange_Declarations (BT);
14456 end if;
14458 while Present (Priv_Elmt) loop
14459 Priv_Sub := (Node (Priv_Elmt));
14461 -- We avoid flipping the subtype if the Etype of its full view is
14462 -- private because this would result in a malformed subtype. This
14463 -- occurs when the Etype of the subtype full view is the full view of
14464 -- the base type (and since the base types were just switched, the
14465 -- subtype is pointing to the wrong view). This is currently the case
14466 -- for tagged record types, access types (maybe more?) and needs to
14467 -- be resolved. ???
14469 if Present (Full_View (Priv_Sub))
14470 and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
14471 then
14472 Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
14473 Exchange_Declarations (Priv_Sub);
14474 end if;
14476 Next_Elmt (Priv_Elmt);
14477 end loop;
14478 end Switch_View;
14480 -----------------
14481 -- True_Parent --
14482 -----------------
14484 function True_Parent (N : Node_Id) return Node_Id is
14485 begin
14486 if Nkind (Parent (N)) = N_Subunit then
14487 return Parent (Corresponding_Stub (Parent (N)));
14488 else
14489 return Parent (N);
14490 end if;
14491 end True_Parent;
14493 -----------------------------
14494 -- Valid_Default_Attribute --
14495 -----------------------------
14497 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
14498 Attr_Id : constant Attribute_Id :=
14499 Get_Attribute_Id (Attribute_Name (Def));
14500 T : constant Entity_Id := Entity (Prefix (Def));
14501 Is_Fun : constant Boolean := (Ekind (Nam) = E_Function);
14502 F : Entity_Id;
14503 Num_F : Int;
14504 OK : Boolean;
14506 begin
14507 if No (T) or else T = Any_Id then
14508 return;
14509 end if;
14511 Num_F := 0;
14512 F := First_Formal (Nam);
14513 while Present (F) loop
14514 Num_F := Num_F + 1;
14515 Next_Formal (F);
14516 end loop;
14518 case Attr_Id is
14519 when Attribute_Adjacent | Attribute_Ceiling | Attribute_Copy_Sign |
14520 Attribute_Floor | Attribute_Fraction | Attribute_Machine |
14521 Attribute_Model | Attribute_Remainder | Attribute_Rounding |
14522 Attribute_Unbiased_Rounding =>
14523 OK := Is_Fun
14524 and then Num_F = 1
14525 and then Is_Floating_Point_Type (T);
14527 when Attribute_Image | Attribute_Pred | Attribute_Succ |
14528 Attribute_Value | Attribute_Wide_Image |
14529 Attribute_Wide_Value =>
14530 OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
14532 when Attribute_Max | Attribute_Min =>
14533 OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
14535 when Attribute_Input =>
14536 OK := (Is_Fun and then Num_F = 1);
14538 when Attribute_Output | Attribute_Read | Attribute_Write =>
14539 OK := (not Is_Fun and then Num_F = 2);
14541 when others =>
14542 OK := False;
14543 end case;
14545 if not OK then
14546 Error_Msg_N ("attribute reference has wrong profile for subprogram",
14547 Def);
14548 end if;
14549 end Valid_Default_Attribute;
14551 end Sem_Ch12;