2014-10-31 Hristian Kirtchev <kirtchev@adacore.com>
[official-gcc.git] / gcc / ada / sem_ch12.adb
blobf982359c749b734f23cc2faefb165bb466a13fbf
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 -- A generic package declared within a Ghost scope is rendered Ghost
3384 -- (SPARK RM 6.9(2)).
3386 if Within_Ghost_Scope then
3387 Set_Is_Ghost_Entity (Id);
3388 end if;
3390 -- Analyze aspects now, so that generated pragmas appear in the
3391 -- declarations before building and analyzing the generic copy.
3393 if Has_Aspects (N) then
3394 Analyze_Aspect_Specifications (N, Id);
3395 end if;
3397 Push_Scope (Id);
3398 Enter_Generic_Scope (Id);
3399 Set_Inner_Instances (Id, New_Elmt_List);
3401 Set_Categorization_From_Pragmas (N);
3402 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3404 -- Link the declaration of the generic homonym in the generic copy to
3405 -- the package it renames, so that it is always resolved properly.
3407 Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
3408 Set_Entity (Associated_Node (Name (Renaming)), Id);
3410 -- For a library unit, we have reconstructed the entity for the unit,
3411 -- and must reset it in the library tables.
3413 if Nkind (Parent (N)) = N_Compilation_Unit then
3414 Set_Cunit_Entity (Current_Sem_Unit, Id);
3415 end if;
3417 Analyze_Generic_Formal_Part (N);
3419 -- After processing the generic formals, analysis proceeds as for a
3420 -- non-generic package.
3422 Analyze (Specification (N));
3424 Validate_Categorization_Dependency (N, Id);
3426 End_Generic;
3428 End_Package_Scope (Id);
3429 Exit_Generic_Scope (Id);
3431 if Nkind (Parent (N)) /= N_Compilation_Unit then
3432 Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
3433 Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
3434 Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
3436 else
3437 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3438 Validate_RT_RAT_Component (N);
3440 -- If this is a spec without a body, check that generic parameters
3441 -- are referenced.
3443 if not Body_Required (Parent (N)) then
3444 Check_References (Id);
3445 end if;
3446 end if;
3448 -- If there is a specified storage pool in the context, create an
3449 -- aspect on the package declaration, so that it is used in any
3450 -- instance that does not override it.
3452 if Present (Default_Pool) then
3453 declare
3454 ASN : Node_Id;
3456 begin
3457 ASN := Make_Aspect_Specification (Loc,
3458 Identifier => Make_Identifier (Loc, Name_Default_Storage_Pool),
3459 Expression => New_Copy (Default_Pool));
3461 if No (Aspect_Specifications (Specification (N))) then
3462 Set_Aspect_Specifications (Specification (N), New_List (ASN));
3463 else
3464 Append (ASN, Aspect_Specifications (Specification (N)));
3465 end if;
3466 end;
3467 end if;
3468 end Analyze_Generic_Package_Declaration;
3470 --------------------------------------------
3471 -- Analyze_Generic_Subprogram_Declaration --
3472 --------------------------------------------
3474 procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
3475 Spec : Node_Id;
3476 Id : Entity_Id;
3477 Formals : List_Id;
3478 New_N : Node_Id;
3479 Result_Type : Entity_Id;
3480 Save_Parent : Node_Id;
3481 Typ : Entity_Id;
3483 begin
3484 Check_SPARK_05_Restriction ("generic is not allowed", N);
3486 -- Create copy of generic unit, and save for instantiation. If the unit
3487 -- is a child unit, do not copy the specifications for the parent, which
3488 -- are not part of the generic tree.
3490 Save_Parent := Parent_Spec (N);
3491 Set_Parent_Spec (N, Empty);
3493 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3494 Set_Parent_Spec (New_N, Save_Parent);
3495 Rewrite (N, New_N);
3497 -- Once the contents of the generic copy and the template are swapped,
3498 -- do the same for their respective aspect specifications.
3500 Exchange_Aspects (N, New_N);
3502 Spec := Specification (N);
3503 Id := Defining_Entity (Spec);
3504 Generate_Definition (Id);
3505 Set_Contract (Id, Make_Contract (Sloc (Id)));
3507 if Nkind (Id) = N_Defining_Operator_Symbol then
3508 Error_Msg_N
3509 ("operator symbol not allowed for generic subprogram", Id);
3510 end if;
3512 Start_Generic;
3514 Enter_Name (Id);
3515 Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
3517 -- Analyze the aspects of the generic copy to ensure that all generated
3518 -- pragmas (if any) perform their semantic effects.
3520 if Has_Aspects (N) then
3521 Analyze_Aspect_Specifications (N, Id);
3522 end if;
3524 Push_Scope (Id);
3525 Enter_Generic_Scope (Id);
3526 Set_Inner_Instances (Id, New_Elmt_List);
3527 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3529 Analyze_Generic_Formal_Part (N);
3531 Formals := Parameter_Specifications (Spec);
3533 if Present (Formals) then
3534 Process_Formals (Formals, Spec);
3535 end if;
3537 if Nkind (Spec) = N_Function_Specification then
3538 Set_Ekind (Id, E_Generic_Function);
3540 if Nkind (Result_Definition (Spec)) = N_Access_Definition then
3541 Result_Type := Access_Definition (Spec, Result_Definition (Spec));
3542 Set_Etype (Id, Result_Type);
3544 -- Check restriction imposed by AI05-073: a generic function
3545 -- cannot return an abstract type or an access to such.
3547 -- This is a binding interpretation should it apply to earlier
3548 -- versions of Ada as well as Ada 2012???
3550 if Is_Abstract_Type (Designated_Type (Result_Type))
3551 and then Ada_Version >= Ada_2012
3552 then
3553 Error_Msg_N ("generic function cannot have an access result"
3554 & " that designates an abstract type", Spec);
3555 end if;
3557 else
3558 Find_Type (Result_Definition (Spec));
3559 Typ := Entity (Result_Definition (Spec));
3561 if Is_Abstract_Type (Typ)
3562 and then Ada_Version >= Ada_2012
3563 then
3564 Error_Msg_N
3565 ("generic function cannot have abstract result type", Spec);
3566 end if;
3568 -- If a null exclusion is imposed on the result type, then create
3569 -- a null-excluding itype (an access subtype) and use it as the
3570 -- function's Etype.
3572 if Is_Access_Type (Typ)
3573 and then Null_Exclusion_Present (Spec)
3574 then
3575 Set_Etype (Id,
3576 Create_Null_Excluding_Itype
3577 (T => Typ,
3578 Related_Nod => Spec,
3579 Scope_Id => Defining_Unit_Name (Spec)));
3580 else
3581 Set_Etype (Id, Typ);
3582 end if;
3583 end if;
3585 else
3586 Set_Ekind (Id, E_Generic_Procedure);
3587 Set_Etype (Id, Standard_Void_Type);
3588 end if;
3590 -- A generic subprogram declared within a Ghost scope is rendered Ghost
3591 -- (SPARK RM 6.9(2)).
3593 if Within_Ghost_Scope then
3594 Set_Is_Ghost_Entity (Id);
3595 end if;
3597 -- For a library unit, we have reconstructed the entity for the unit,
3598 -- and must reset it in the library tables. We also make sure that
3599 -- Body_Required is set properly in the original compilation unit node.
3601 if Nkind (Parent (N)) = N_Compilation_Unit then
3602 Set_Cunit_Entity (Current_Sem_Unit, Id);
3603 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3604 end if;
3606 Set_Categorization_From_Pragmas (N);
3607 Validate_Categorization_Dependency (N, Id);
3609 Save_Global_References (Original_Node (N));
3611 -- For ASIS purposes, convert any postcondition, precondition pragmas
3612 -- into aspects, if N is not a compilation unit by itself, in order to
3613 -- enable the analysis of expressions inside the corresponding PPC
3614 -- pragmas.
3616 if ASIS_Mode and then Is_List_Member (N) then
3617 Make_Aspect_For_PPC_In_Gen_Sub_Decl (N);
3618 end if;
3620 End_Generic;
3621 End_Scope;
3622 Exit_Generic_Scope (Id);
3623 Generate_Reference_To_Formals (Id);
3625 List_Inherited_Pre_Post_Aspects (Id);
3626 end Analyze_Generic_Subprogram_Declaration;
3628 -----------------------------------
3629 -- Analyze_Package_Instantiation --
3630 -----------------------------------
3632 procedure Analyze_Package_Instantiation (N : Node_Id) is
3633 Loc : constant Source_Ptr := Sloc (N);
3634 Gen_Id : constant Node_Id := Name (N);
3636 Act_Decl : Node_Id;
3637 Act_Decl_Name : Node_Id;
3638 Act_Decl_Id : Entity_Id;
3639 Act_Spec : Node_Id;
3640 Act_Tree : Node_Id;
3642 Gen_Decl : Node_Id;
3643 Gen_Spec : Node_Id;
3644 Gen_Unit : Entity_Id;
3646 Is_Actual_Pack : constant Boolean :=
3647 Is_Internal (Defining_Entity (N));
3649 Env_Installed : Boolean := False;
3650 Parent_Installed : Boolean := False;
3651 Renaming_List : List_Id;
3652 Unit_Renaming : Node_Id;
3653 Needs_Body : Boolean;
3654 Inline_Now : Boolean := False;
3656 Save_IPSM : constant Boolean := Ignore_Pragma_SPARK_Mode;
3657 -- Save flag Ignore_Pragma_SPARK_Mode for restore on exit
3659 Save_SM : constant SPARK_Mode_Type := SPARK_Mode;
3660 Save_SMP : constant Node_Id := SPARK_Mode_Pragma;
3661 -- Save the SPARK_Mode-related data for restore on exit
3663 Save_Style_Check : constant Boolean := Style_Check;
3664 -- Save style check mode for restore on exit
3666 procedure Delay_Descriptors (E : Entity_Id);
3667 -- Delay generation of subprogram descriptors for given entity
3669 function Might_Inline_Subp return Boolean;
3670 -- If inlining is active and the generic contains inlined subprograms,
3671 -- we instantiate the body. This may cause superfluous instantiations,
3672 -- but it is simpler than detecting the need for the body at the point
3673 -- of inlining, when the context of the instance is not available.
3675 -----------------------
3676 -- Delay_Descriptors --
3677 -----------------------
3679 procedure Delay_Descriptors (E : Entity_Id) is
3680 begin
3681 if not Delay_Subprogram_Descriptors (E) then
3682 Set_Delay_Subprogram_Descriptors (E);
3683 Pending_Descriptor.Append (E);
3684 end if;
3685 end Delay_Descriptors;
3687 -----------------------
3688 -- Might_Inline_Subp --
3689 -----------------------
3691 function Might_Inline_Subp return Boolean is
3692 E : Entity_Id;
3694 begin
3695 if not Inline_Processing_Required then
3696 return False;
3698 else
3699 E := First_Entity (Gen_Unit);
3700 while Present (E) loop
3701 if Is_Subprogram (E) and then Is_Inlined (E) then
3702 return True;
3703 end if;
3705 Next_Entity (E);
3706 end loop;
3707 end if;
3709 return False;
3710 end Might_Inline_Subp;
3712 -- Local declarations
3714 Vis_Prims_List : Elist_Id := No_Elist;
3715 -- List of primitives made temporarily visible in the instantiation
3716 -- to match the visibility of the formal type
3718 -- Start of processing for Analyze_Package_Instantiation
3720 begin
3721 Check_SPARK_05_Restriction ("generic is not allowed", N);
3723 -- Very first thing: check for Text_IO sp[ecial unit in case we are
3724 -- instantiating one of the children of [[Wide_]Wide_]Text_IO.
3726 Check_Text_IO_Special_Unit (Name (N));
3728 -- Make node global for error reporting
3730 Instantiation_Node := N;
3732 -- Turn off style checking in instances. If the check is enabled on the
3733 -- generic unit, a warning in an instance would just be noise. If not
3734 -- enabled on the generic, then a warning in an instance is just wrong.
3736 Style_Check := False;
3738 -- Case of instantiation of a generic package
3740 if Nkind (N) = N_Package_Instantiation then
3741 Act_Decl_Id := New_Copy (Defining_Entity (N));
3742 Set_Comes_From_Source (Act_Decl_Id, True);
3744 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3745 Act_Decl_Name :=
3746 Make_Defining_Program_Unit_Name (Loc,
3747 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
3748 Defining_Identifier => Act_Decl_Id);
3749 else
3750 Act_Decl_Name := Act_Decl_Id;
3751 end if;
3753 -- Case of instantiation of a formal package
3755 else
3756 Act_Decl_Id := Defining_Identifier (N);
3757 Act_Decl_Name := Act_Decl_Id;
3758 end if;
3760 Generate_Definition (Act_Decl_Id);
3761 Preanalyze_Actuals (N);
3763 Init_Env;
3764 Env_Installed := True;
3766 -- Reset renaming map for formal types. The mapping is established
3767 -- when analyzing the generic associations, but some mappings are
3768 -- inherited from formal packages of parent units, and these are
3769 -- constructed when the parents are installed.
3771 Generic_Renamings.Set_Last (0);
3772 Generic_Renamings_HTable.Reset;
3774 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3775 Gen_Unit := Entity (Gen_Id);
3777 -- Verify that it is the name of a generic package
3779 -- A visibility glitch: if the instance is a child unit and the generic
3780 -- is the generic unit of a parent instance (i.e. both the parent and
3781 -- the child units are instances of the same package) the name now
3782 -- denotes the renaming within the parent, not the intended generic
3783 -- unit. See if there is a homonym that is the desired generic. The
3784 -- renaming declaration must be visible inside the instance of the
3785 -- child, but not when analyzing the name in the instantiation itself.
3787 if Ekind (Gen_Unit) = E_Package
3788 and then Present (Renamed_Entity (Gen_Unit))
3789 and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3790 and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3791 and then Present (Homonym (Gen_Unit))
3792 then
3793 Gen_Unit := Homonym (Gen_Unit);
3794 end if;
3796 if Etype (Gen_Unit) = Any_Type then
3797 Restore_Env;
3798 goto Leave;
3800 elsif Ekind (Gen_Unit) /= E_Generic_Package then
3802 -- Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3804 if From_Limited_With (Gen_Unit) then
3805 Error_Msg_N
3806 ("cannot instantiate a limited withed package", Gen_Id);
3807 else
3808 Error_Msg_NE
3809 ("& is not the name of a generic package", Gen_Id, Gen_Unit);
3810 end if;
3812 Restore_Env;
3813 goto Leave;
3814 end if;
3816 if In_Extended_Main_Source_Unit (N) then
3817 Set_Is_Instantiated (Gen_Unit);
3818 Generate_Reference (Gen_Unit, N);
3820 if Present (Renamed_Object (Gen_Unit)) then
3821 Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3822 Generate_Reference (Renamed_Object (Gen_Unit), N);
3823 end if;
3824 end if;
3826 if Nkind (Gen_Id) = N_Identifier
3827 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3828 then
3829 Error_Msg_NE
3830 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3832 elsif Nkind (Gen_Id) = N_Expanded_Name
3833 and then Is_Child_Unit (Gen_Unit)
3834 and then Nkind (Prefix (Gen_Id)) = N_Identifier
3835 and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3836 then
3837 Error_Msg_N
3838 ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3839 end if;
3841 Set_Entity (Gen_Id, Gen_Unit);
3843 -- If generic is a renaming, get original generic unit
3845 if Present (Renamed_Object (Gen_Unit))
3846 and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3847 then
3848 Gen_Unit := Renamed_Object (Gen_Unit);
3849 end if;
3851 -- Verify that there are no circular instantiations
3853 if In_Open_Scopes (Gen_Unit) then
3854 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3855 Restore_Env;
3856 goto Leave;
3858 elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3859 Error_Msg_Node_2 := Current_Scope;
3860 Error_Msg_NE
3861 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3862 Circularity_Detected := True;
3863 Restore_Env;
3864 goto Leave;
3866 else
3867 -- If the context of the instance is subject to SPARK_Mode "off",
3868 -- set the global flag which signals Analyze_Pragma to ignore all
3869 -- SPARK_Mode pragmas within the instance.
3871 if SPARK_Mode = Off then
3872 Ignore_Pragma_SPARK_Mode := True;
3873 end if;
3875 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3876 Gen_Spec := Specification (Gen_Decl);
3878 -- Initialize renamings map, for error checking, and the list that
3879 -- holds private entities whose views have changed between generic
3880 -- definition and instantiation. If this is the instance created to
3881 -- validate an actual package, the instantiation environment is that
3882 -- of the enclosing instance.
3884 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3886 -- Copy original generic tree, to produce text for instantiation
3888 Act_Tree :=
3889 Copy_Generic_Node
3890 (Original_Node (Gen_Decl), Empty, Instantiating => True);
3892 Act_Spec := Specification (Act_Tree);
3894 -- If this is the instance created to validate an actual package,
3895 -- only the formals matter, do not examine the package spec itself.
3897 if Is_Actual_Pack then
3898 Set_Visible_Declarations (Act_Spec, New_List);
3899 Set_Private_Declarations (Act_Spec, New_List);
3900 end if;
3902 Renaming_List :=
3903 Analyze_Associations
3904 (I_Node => N,
3905 Formals => Generic_Formal_Declarations (Act_Tree),
3906 F_Copy => Generic_Formal_Declarations (Gen_Decl));
3908 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
3910 Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3911 Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3912 Set_Is_Generic_Instance (Act_Decl_Id);
3913 Set_Generic_Parent (Act_Spec, Gen_Unit);
3915 -- References to the generic in its own declaration or its body are
3916 -- references to the instance. Add a renaming declaration for the
3917 -- generic unit itself. This declaration, as well as the renaming
3918 -- declarations for the generic formals, must remain private to the
3919 -- unit: the formals, because this is the language semantics, and
3920 -- the unit because its use is an artifact of the implementation.
3922 Unit_Renaming :=
3923 Make_Package_Renaming_Declaration (Loc,
3924 Defining_Unit_Name =>
3925 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3926 Name => New_Occurrence_Of (Act_Decl_Id, Loc));
3928 Append (Unit_Renaming, Renaming_List);
3930 -- The renaming declarations are the first local declarations of the
3931 -- new unit.
3933 if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3934 Insert_List_Before
3935 (First (Visible_Declarations (Act_Spec)), Renaming_List);
3936 else
3937 Set_Visible_Declarations (Act_Spec, Renaming_List);
3938 end if;
3940 Act_Decl := Make_Package_Declaration (Loc, Specification => Act_Spec);
3942 -- Propagate the aspect specifications from the package declaration
3943 -- template to the instantiated version of the package declaration.
3945 if Has_Aspects (Act_Tree) then
3946 Set_Aspect_Specifications (Act_Decl,
3947 New_Copy_List_Tree (Aspect_Specifications (Act_Tree)));
3948 end if;
3950 -- The generic may have a generated Default_Storage_Pool aspect,
3951 -- set at the point of generic declaration. If the instance has
3952 -- that aspect, it overrides the one inherited from the generic.
3954 if Has_Aspects (Gen_Spec) then
3955 if No (Aspect_Specifications (N)) then
3956 Set_Aspect_Specifications (N,
3957 (New_Copy_List_Tree
3958 (Aspect_Specifications (Gen_Spec))));
3960 else
3961 declare
3962 ASN1, ASN2 : Node_Id;
3964 begin
3965 ASN1 := First (Aspect_Specifications (N));
3966 while Present (ASN1) loop
3967 if Chars (Identifier (ASN1))
3968 = Name_Default_Storage_Pool
3969 then
3970 -- If generic carries a default storage pool, remove
3971 -- it in favor of the instance one.
3973 ASN2 := First (Aspect_Specifications (Gen_Spec));
3974 while Present (ASN2) loop
3975 if Chars (Identifier (ASN2))
3976 = Name_Default_Storage_Pool
3977 then
3978 Remove (ASN2);
3979 exit;
3980 end if;
3982 Next (ASN2);
3983 end loop;
3984 end if;
3986 Next (ASN1);
3987 end loop;
3989 Prepend_List_To (Aspect_Specifications (N),
3990 (New_Copy_List_Tree
3991 (Aspect_Specifications (Gen_Spec))));
3992 end;
3993 end if;
3994 end if;
3996 -- Save the instantiation node, for subsequent instantiation of the
3997 -- body, if there is one and we are generating code for the current
3998 -- unit. Mark unit as having a body (avoids premature error message).
4000 -- We instantiate the body if we are generating code, if we are
4001 -- generating cross-reference information, or if we are building
4002 -- trees for ASIS use or GNATprove use.
4004 declare
4005 Enclosing_Body_Present : Boolean := False;
4006 -- If the generic unit is not a compilation unit, then a body may
4007 -- be present in its parent even if none is required. We create a
4008 -- tentative pending instantiation for the body, which will be
4009 -- discarded if none is actually present.
4011 Scop : Entity_Id;
4013 begin
4014 if Scope (Gen_Unit) /= Standard_Standard
4015 and then not Is_Child_Unit (Gen_Unit)
4016 then
4017 Scop := Scope (Gen_Unit);
4019 while Present (Scop)
4020 and then Scop /= Standard_Standard
4021 loop
4022 if Unit_Requires_Body (Scop) then
4023 Enclosing_Body_Present := True;
4024 exit;
4026 elsif In_Open_Scopes (Scop)
4027 and then In_Package_Body (Scop)
4028 then
4029 Enclosing_Body_Present := True;
4030 exit;
4031 end if;
4033 exit when Is_Compilation_Unit (Scop);
4034 Scop := Scope (Scop);
4035 end loop;
4036 end if;
4038 -- If front-end inlining is enabled, and this is a unit for which
4039 -- code will be generated, we instantiate the body at once.
4041 -- This is done if the instance is not the main unit, and if the
4042 -- generic is not a child unit of another generic, to avoid scope
4043 -- problems and the reinstallation of parent instances.
4045 if Expander_Active
4046 and then (not Is_Child_Unit (Gen_Unit)
4047 or else not Is_Generic_Unit (Scope (Gen_Unit)))
4048 and then Might_Inline_Subp
4049 and then not Is_Actual_Pack
4050 then
4051 if not Back_End_Inlining
4052 and then Front_End_Inlining
4053 and then (Is_In_Main_Unit (N)
4054 or else In_Main_Context (Current_Scope))
4055 and then Nkind (Parent (N)) /= N_Compilation_Unit
4056 then
4057 Inline_Now := True;
4059 -- In configurable_run_time mode we force the inlining of
4060 -- predefined subprograms marked Inline_Always, to minimize
4061 -- the use of the run-time library.
4063 elsif Is_Predefined_File_Name
4064 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
4065 and then Configurable_Run_Time_Mode
4066 and then Nkind (Parent (N)) /= N_Compilation_Unit
4067 then
4068 Inline_Now := True;
4069 end if;
4071 -- If the current scope is itself an instance within a child
4072 -- unit, there will be duplications in the scope stack, and the
4073 -- unstacking mechanism in Inline_Instance_Body will fail.
4074 -- This loses some rare cases of optimization, and might be
4075 -- improved some day, if we can find a proper abstraction for
4076 -- "the complete compilation context" that can be saved and
4077 -- restored. ???
4079 if Is_Generic_Instance (Current_Scope) then
4080 declare
4081 Curr_Unit : constant Entity_Id :=
4082 Cunit_Entity (Current_Sem_Unit);
4083 begin
4084 if Curr_Unit /= Current_Scope
4085 and then Is_Child_Unit (Curr_Unit)
4086 then
4087 Inline_Now := False;
4088 end if;
4089 end;
4090 end if;
4091 end if;
4093 Needs_Body :=
4094 (Unit_Requires_Body (Gen_Unit)
4095 or else Enclosing_Body_Present
4096 or else Present (Corresponding_Body (Gen_Decl)))
4097 and then (Is_In_Main_Unit (N) or else Might_Inline_Subp)
4098 and then not Is_Actual_Pack
4099 and then not Inline_Now
4100 and then (Operating_Mode = Generate_Code
4102 -- Need comment for this check ???
4104 or else (Operating_Mode = Check_Semantics
4105 and then (ASIS_Mode or GNATprove_Mode)));
4107 -- If front_end_inlining is enabled, do not instantiate body if
4108 -- within a generic context.
4110 if (Front_End_Inlining and then not Expander_Active)
4111 or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
4112 then
4113 Needs_Body := False;
4114 end if;
4116 -- If the current context is generic, and the package being
4117 -- instantiated is declared within a formal package, there is no
4118 -- body to instantiate until the enclosing generic is instantiated
4119 -- and there is an actual for the formal package. If the formal
4120 -- package has parameters, we build a regular package instance for
4121 -- it, that precedes the original formal package declaration.
4123 if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
4124 declare
4125 Decl : constant Node_Id :=
4126 Original_Node
4127 (Unit_Declaration_Node (Scope (Gen_Unit)));
4128 begin
4129 if Nkind (Decl) = N_Formal_Package_Declaration
4130 or else (Nkind (Decl) = N_Package_Declaration
4131 and then Is_List_Member (Decl)
4132 and then Present (Next (Decl))
4133 and then
4134 Nkind (Next (Decl)) =
4135 N_Formal_Package_Declaration)
4136 then
4137 Needs_Body := False;
4138 end if;
4139 end;
4140 end if;
4141 end;
4143 -- For RCI unit calling stubs, we omit the instance body if the
4144 -- instance is the RCI library unit itself.
4146 -- However there is a special case for nested instances: in this case
4147 -- we do generate the instance body, as it might be required, e.g.
4148 -- because it provides stream attributes for some type used in the
4149 -- profile of a remote subprogram. This is consistent with 12.3(12),
4150 -- which indicates that the instance body occurs at the place of the
4151 -- instantiation, and thus is part of the RCI declaration, which is
4152 -- present on all client partitions (this is E.2.3(18)).
4154 -- Note that AI12-0002 may make it illegal at some point to have
4155 -- stream attributes defined in an RCI unit, in which case this
4156 -- special case will become unnecessary. In the meantime, there
4157 -- is known application code in production that depends on this
4158 -- being possible, so we definitely cannot eliminate the body in
4159 -- the case of nested instances for the time being.
4161 -- When we generate a nested instance body, calling stubs for any
4162 -- relevant subprogram will be be inserted immediately after the
4163 -- subprogram declarations, and will take precedence over the
4164 -- subsequent (original) body. (The stub and original body will be
4165 -- complete homographs, but this is permitted in an instance).
4166 -- (Could we do better and remove the original body???)
4168 if Distribution_Stub_Mode = Generate_Caller_Stub_Body
4169 and then Comes_From_Source (N)
4170 and then Nkind (Parent (N)) = N_Compilation_Unit
4171 then
4172 Needs_Body := False;
4173 end if;
4175 if Needs_Body then
4177 -- Here is a defence against a ludicrous number of instantiations
4178 -- caused by a circular set of instantiation attempts.
4180 if Pending_Instantiations.Last > Maximum_Instantiations then
4181 Error_Msg_Uint_1 := UI_From_Int (Maximum_Instantiations);
4182 Error_Msg_N ("too many instantiations, exceeds max of^", N);
4183 Error_Msg_N ("\limit can be changed using -gnateinn switch", N);
4184 raise Unrecoverable_Error;
4185 end if;
4187 -- Indicate that the enclosing scopes contain an instantiation,
4188 -- and that cleanup actions should be delayed until after the
4189 -- instance body is expanded.
4191 Check_Forward_Instantiation (Gen_Decl);
4192 if Nkind (N) = N_Package_Instantiation then
4193 declare
4194 Enclosing_Master : Entity_Id;
4196 begin
4197 -- Loop to search enclosing masters
4199 Enclosing_Master := Current_Scope;
4200 Scope_Loop : while Enclosing_Master /= Standard_Standard loop
4201 if Ekind (Enclosing_Master) = E_Package then
4202 if Is_Compilation_Unit (Enclosing_Master) then
4203 if In_Package_Body (Enclosing_Master) then
4204 Delay_Descriptors
4205 (Body_Entity (Enclosing_Master));
4206 else
4207 Delay_Descriptors
4208 (Enclosing_Master);
4209 end if;
4211 exit Scope_Loop;
4213 else
4214 Enclosing_Master := Scope (Enclosing_Master);
4215 end if;
4217 elsif Is_Generic_Unit (Enclosing_Master)
4218 or else Ekind (Enclosing_Master) = E_Void
4219 then
4220 -- Cleanup actions will eventually be performed on the
4221 -- enclosing subprogram or package instance, if any.
4222 -- Enclosing scope is void in the formal part of a
4223 -- generic subprogram.
4225 exit Scope_Loop;
4227 else
4228 if Ekind (Enclosing_Master) = E_Entry
4229 and then
4230 Ekind (Scope (Enclosing_Master)) = E_Protected_Type
4231 then
4232 if not Expander_Active then
4233 exit Scope_Loop;
4234 else
4235 Enclosing_Master :=
4236 Protected_Body_Subprogram (Enclosing_Master);
4237 end if;
4238 end if;
4240 Set_Delay_Cleanups (Enclosing_Master);
4242 while Ekind (Enclosing_Master) = E_Block loop
4243 Enclosing_Master := Scope (Enclosing_Master);
4244 end loop;
4246 if Is_Subprogram (Enclosing_Master) then
4247 Delay_Descriptors (Enclosing_Master);
4249 elsif Is_Task_Type (Enclosing_Master) then
4250 declare
4251 TBP : constant Node_Id :=
4252 Get_Task_Body_Procedure
4253 (Enclosing_Master);
4254 begin
4255 if Present (TBP) then
4256 Delay_Descriptors (TBP);
4257 Set_Delay_Cleanups (TBP);
4258 end if;
4259 end;
4260 end if;
4262 exit Scope_Loop;
4263 end if;
4264 end loop Scope_Loop;
4265 end;
4267 -- Make entry in table
4269 Pending_Instantiations.Append
4270 ((Inst_Node => N,
4271 Act_Decl => Act_Decl,
4272 Expander_Status => Expander_Active,
4273 Current_Sem_Unit => Current_Sem_Unit,
4274 Scope_Suppress => Scope_Suppress,
4275 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4276 Version => Ada_Version,
4277 Version_Pragma => Ada_Version_Pragma,
4278 Warnings => Save_Warnings,
4279 SPARK_Mode => SPARK_Mode,
4280 SPARK_Mode_Pragma => SPARK_Mode_Pragma));
4281 end if;
4282 end if;
4284 Set_Categorization_From_Pragmas (Act_Decl);
4286 if Parent_Installed then
4287 Hide_Current_Scope;
4288 end if;
4290 Set_Instance_Spec (N, Act_Decl);
4292 -- If not a compilation unit, insert the package declaration before
4293 -- the original instantiation node.
4295 if Nkind (Parent (N)) /= N_Compilation_Unit then
4296 Mark_Rewrite_Insertion (Act_Decl);
4297 Insert_Before (N, Act_Decl);
4299 if Has_Aspects (N) then
4300 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4302 -- The pragma created for a Default_Storage_Pool aspect must
4303 -- appear ahead of the declarations in the instance spec.
4304 -- Analysis has placed it after the instance node, so remove
4305 -- it and reinsert it properly now.
4307 declare
4308 ASN : constant Node_Id := First (Aspect_Specifications (N));
4309 A_Name : constant Name_Id := Chars (Identifier (ASN));
4310 Decl : Node_Id;
4312 begin
4313 if A_Name = Name_Default_Storage_Pool then
4314 if No (Visible_Declarations (Act_Spec)) then
4315 Set_Visible_Declarations (Act_Spec, New_List);
4316 end if;
4318 Decl := Next (N);
4319 while Present (Decl) loop
4320 if Nkind (Decl) = N_Pragma then
4321 Remove (Decl);
4322 Prepend (Decl, Visible_Declarations (Act_Spec));
4323 exit;
4324 end if;
4326 Next (Decl);
4327 end loop;
4328 end if;
4329 end;
4330 end if;
4332 Analyze (Act_Decl);
4334 -- For an instantiation that is a compilation unit, place
4335 -- declaration on current node so context is complete for analysis
4336 -- (including nested instantiations). If this is the main unit,
4337 -- the declaration eventually replaces the instantiation node.
4338 -- If the instance body is created later, it replaces the
4339 -- instance node, and the declaration is attached to it
4340 -- (see Build_Instance_Compilation_Unit_Nodes).
4342 else
4343 if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
4345 -- The entity for the current unit is the newly created one,
4346 -- and all semantic information is attached to it.
4348 Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
4350 -- If this is the main unit, replace the main entity as well
4352 if Current_Sem_Unit = Main_Unit then
4353 Main_Unit_Entity := Act_Decl_Id;
4354 end if;
4355 end if;
4357 Set_Unit (Parent (N), Act_Decl);
4358 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
4359 Set_Package_Instantiation (Act_Decl_Id, N);
4361 -- Process aspect specifications of the instance node, if any, to
4362 -- take into account categorization pragmas before analyzing the
4363 -- instance.
4365 if Has_Aspects (N) then
4366 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4367 end if;
4369 Analyze (Act_Decl);
4370 Set_Unit (Parent (N), N);
4371 Set_Body_Required (Parent (N), False);
4373 -- We never need elaboration checks on instantiations, since by
4374 -- definition, the body instantiation is elaborated at the same
4375 -- time as the spec instantiation.
4377 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4378 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4379 end if;
4381 Check_Elab_Instantiation (N);
4383 if ABE_Is_Certain (N) and then Needs_Body then
4384 Pending_Instantiations.Decrement_Last;
4385 end if;
4387 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4389 Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
4390 First_Private_Entity (Act_Decl_Id));
4392 -- If the instantiation will receive a body, the unit will be
4393 -- transformed into a package body, and receive its own elaboration
4394 -- entity. Otherwise, the nature of the unit is now a package
4395 -- declaration.
4397 if Nkind (Parent (N)) = N_Compilation_Unit
4398 and then not Needs_Body
4399 then
4400 Rewrite (N, Act_Decl);
4401 end if;
4403 if Present (Corresponding_Body (Gen_Decl))
4404 or else Unit_Requires_Body (Gen_Unit)
4405 then
4406 Set_Has_Completion (Act_Decl_Id);
4407 end if;
4409 Check_Formal_Packages (Act_Decl_Id);
4411 Restore_Hidden_Primitives (Vis_Prims_List);
4412 Restore_Private_Views (Act_Decl_Id);
4414 Inherit_Context (Gen_Decl, N);
4416 if Parent_Installed then
4417 Remove_Parent;
4418 end if;
4420 Restore_Env;
4421 Env_Installed := False;
4422 end if;
4424 Validate_Categorization_Dependency (N, Act_Decl_Id);
4426 -- There used to be a check here to prevent instantiations in local
4427 -- contexts if the No_Local_Allocators restriction was active. This
4428 -- check was removed by a binding interpretation in AI-95-00130/07,
4429 -- but we retain the code for documentation purposes.
4431 -- if Ekind (Act_Decl_Id) /= E_Void
4432 -- and then not Is_Library_Level_Entity (Act_Decl_Id)
4433 -- then
4434 -- Check_Restriction (No_Local_Allocators, N);
4435 -- end if;
4437 if Inline_Now then
4438 Inline_Instance_Body (N, Gen_Unit, Act_Decl);
4439 end if;
4441 -- The following is a tree patch for ASIS: ASIS needs separate nodes to
4442 -- be used as defining identifiers for a formal package and for the
4443 -- corresponding expanded package.
4445 if Nkind (N) = N_Formal_Package_Declaration then
4446 Act_Decl_Id := New_Copy (Defining_Entity (N));
4447 Set_Comes_From_Source (Act_Decl_Id, True);
4448 Set_Is_Generic_Instance (Act_Decl_Id, False);
4449 Set_Defining_Identifier (N, Act_Decl_Id);
4450 end if;
4452 Ignore_Pragma_SPARK_Mode := Save_IPSM;
4453 SPARK_Mode := Save_SM;
4454 SPARK_Mode_Pragma := Save_SMP;
4455 Style_Check := Save_Style_Check;
4457 -- Check that if N is an instantiation of System.Dim_Float_IO or
4458 -- System.Dim_Integer_IO, the formal type has a dimension system.
4460 if Nkind (N) = N_Package_Instantiation
4461 and then Is_Dim_IO_Package_Instantiation (N)
4462 then
4463 declare
4464 Assoc : constant Node_Id := First (Generic_Associations (N));
4465 begin
4466 if not Has_Dimension_System
4467 (Etype (Explicit_Generic_Actual_Parameter (Assoc)))
4468 then
4469 Error_Msg_N ("type with a dimension system expected", Assoc);
4470 end if;
4471 end;
4472 end if;
4474 <<Leave>>
4475 if Has_Aspects (N) and then Nkind (Parent (N)) /= N_Compilation_Unit then
4476 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4477 end if;
4479 exception
4480 when Instantiation_Error =>
4481 if Parent_Installed then
4482 Remove_Parent;
4483 end if;
4485 if Env_Installed then
4486 Restore_Env;
4487 end if;
4489 Ignore_Pragma_SPARK_Mode := Save_IPSM;
4490 SPARK_Mode := Save_SM;
4491 SPARK_Mode_Pragma := Save_SMP;
4492 Style_Check := Save_Style_Check;
4493 end Analyze_Package_Instantiation;
4495 --------------------------
4496 -- Inline_Instance_Body --
4497 --------------------------
4499 procedure Inline_Instance_Body
4500 (N : Node_Id;
4501 Gen_Unit : Entity_Id;
4502 Act_Decl : Node_Id)
4504 Curr_Comp : constant Node_Id := Cunit (Current_Sem_Unit);
4505 Curr_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
4506 Gen_Comp : constant Entity_Id :=
4507 Cunit_Entity (Get_Source_Unit (Gen_Unit));
4509 Save_SM : constant SPARK_Mode_Type := SPARK_Mode;
4510 Save_SMP : constant Node_Id := SPARK_Mode_Pragma;
4511 -- Save all SPARK_Mode-related attributes as removing enclosing scopes
4512 -- to provide a clean environment for analysis of the inlined body will
4513 -- eliminate any previously set SPARK_Mode.
4515 Scope_Stack_Depth : constant Int :=
4516 Scope_Stack.Last - Scope_Stack.First + 1;
4518 Use_Clauses : array (1 .. Scope_Stack_Depth) of Node_Id;
4519 Instances : array (1 .. Scope_Stack_Depth) of Entity_Id;
4520 Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
4521 Curr_Scope : Entity_Id := Empty;
4522 List : Elist_Id;
4523 Num_Inner : Int := 0;
4524 Num_Scopes : Int := 0;
4525 N_Instances : Int := 0;
4526 Removed : Boolean := False;
4527 S : Entity_Id;
4528 Vis : Boolean;
4530 begin
4531 -- Case of generic unit defined in another unit. We must remove the
4532 -- complete context of the current unit to install that of the generic.
4534 if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
4536 -- Add some comments for the following two loops ???
4538 S := Current_Scope;
4539 while Present (S) and then S /= Standard_Standard loop
4540 loop
4541 Num_Scopes := Num_Scopes + 1;
4543 Use_Clauses (Num_Scopes) :=
4544 (Scope_Stack.Table
4545 (Scope_Stack.Last - Num_Scopes + 1).
4546 First_Use_Clause);
4547 End_Use_Clauses (Use_Clauses (Num_Scopes));
4549 exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
4550 or else Scope_Stack.Table
4551 (Scope_Stack.Last - Num_Scopes).Entity = Scope (S);
4552 end loop;
4554 exit when Is_Generic_Instance (S)
4555 and then (In_Package_Body (S)
4556 or else Ekind (S) = E_Procedure
4557 or else Ekind (S) = E_Function);
4558 S := Scope (S);
4559 end loop;
4561 Vis := Is_Immediately_Visible (Gen_Comp);
4563 -- Find and save all enclosing instances
4565 S := Current_Scope;
4567 while Present (S)
4568 and then S /= Standard_Standard
4569 loop
4570 if Is_Generic_Instance (S) then
4571 N_Instances := N_Instances + 1;
4572 Instances (N_Instances) := S;
4574 exit when In_Package_Body (S);
4575 end if;
4577 S := Scope (S);
4578 end loop;
4580 -- Remove context of current compilation unit, unless we are within a
4581 -- nested package instantiation, in which case the context has been
4582 -- removed previously.
4584 -- If current scope is the body of a child unit, remove context of
4585 -- spec as well. If an enclosing scope is an instance body, the
4586 -- context has already been removed, but the entities in the body
4587 -- must be made invisible as well.
4589 S := Current_Scope;
4591 while Present (S)
4592 and then S /= Standard_Standard
4593 loop
4594 if Is_Generic_Instance (S)
4595 and then (In_Package_Body (S)
4596 or else Ekind_In (S, E_Procedure, E_Function))
4597 then
4598 -- We still have to remove the entities of the enclosing
4599 -- instance from direct visibility.
4601 declare
4602 E : Entity_Id;
4603 begin
4604 E := First_Entity (S);
4605 while Present (E) loop
4606 Set_Is_Immediately_Visible (E, False);
4607 Next_Entity (E);
4608 end loop;
4609 end;
4611 exit;
4612 end if;
4614 if S = Curr_Unit
4615 or else (Ekind (Curr_Unit) = E_Package_Body
4616 and then S = Spec_Entity (Curr_Unit))
4617 or else (Ekind (Curr_Unit) = E_Subprogram_Body
4618 and then S =
4619 Corresponding_Spec
4620 (Unit_Declaration_Node (Curr_Unit)))
4621 then
4622 Removed := True;
4624 -- Remove entities in current scopes from visibility, so that
4625 -- instance body is compiled in a clean environment.
4627 List := Save_Scope_Stack (Handle_Use => False);
4629 if Is_Child_Unit (S) then
4631 -- Remove child unit from stack, as well as inner scopes.
4632 -- Removing the context of a child unit removes parent units
4633 -- as well.
4635 while Current_Scope /= S loop
4636 Num_Inner := Num_Inner + 1;
4637 Inner_Scopes (Num_Inner) := Current_Scope;
4638 Pop_Scope;
4639 end loop;
4641 Pop_Scope;
4642 Remove_Context (Curr_Comp);
4643 Curr_Scope := S;
4645 else
4646 Remove_Context (Curr_Comp);
4647 end if;
4649 if Ekind (Curr_Unit) = E_Package_Body then
4650 Remove_Context (Library_Unit (Curr_Comp));
4651 end if;
4652 end if;
4654 S := Scope (S);
4655 end loop;
4657 pragma Assert (Num_Inner < Num_Scopes);
4659 -- The inlined package body must be analyzed with the SPARK_Mode of
4660 -- the enclosing context, otherwise the body may cause bogus errors
4661 -- if a configuration SPARK_Mode pragma in in effect.
4663 Push_Scope (Standard_Standard);
4664 Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4665 Instantiate_Package_Body
4666 (Body_Info =>
4667 ((Inst_Node => N,
4668 Act_Decl => Act_Decl,
4669 Expander_Status => Expander_Active,
4670 Current_Sem_Unit => Current_Sem_Unit,
4671 Scope_Suppress => Scope_Suppress,
4672 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4673 Version => Ada_Version,
4674 Version_Pragma => Ada_Version_Pragma,
4675 Warnings => Save_Warnings,
4676 SPARK_Mode => Save_SM,
4677 SPARK_Mode_Pragma => Save_SMP)),
4678 Inlined_Body => True);
4680 Pop_Scope;
4682 -- Restore context
4684 Set_Is_Immediately_Visible (Gen_Comp, Vis);
4686 -- Reset Generic_Instance flag so that use clauses can be installed
4687 -- in the proper order. (See Use_One_Package for effect of enclosing
4688 -- instances on processing of use clauses).
4690 for J in 1 .. N_Instances loop
4691 Set_Is_Generic_Instance (Instances (J), False);
4692 end loop;
4694 if Removed then
4695 Install_Context (Curr_Comp);
4697 if Present (Curr_Scope)
4698 and then Is_Child_Unit (Curr_Scope)
4699 then
4700 Push_Scope (Curr_Scope);
4701 Set_Is_Immediately_Visible (Curr_Scope);
4703 -- Finally, restore inner scopes as well
4705 for J in reverse 1 .. Num_Inner loop
4706 Push_Scope (Inner_Scopes (J));
4707 end loop;
4708 end if;
4710 Restore_Scope_Stack (List, Handle_Use => False);
4712 if Present (Curr_Scope)
4713 and then
4714 (In_Private_Part (Curr_Scope)
4715 or else In_Package_Body (Curr_Scope))
4716 then
4717 -- Install private declaration of ancestor units, which are
4718 -- currently available. Restore_Scope_Stack and Install_Context
4719 -- only install the visible part of parents.
4721 declare
4722 Par : Entity_Id;
4723 begin
4724 Par := Scope (Curr_Scope);
4725 while (Present (Par))
4726 and then Par /= Standard_Standard
4727 loop
4728 Install_Private_Declarations (Par);
4729 Par := Scope (Par);
4730 end loop;
4731 end;
4732 end if;
4733 end if;
4735 -- Restore use clauses. For a child unit, use clauses in the parents
4736 -- are restored when installing the context, so only those in inner
4737 -- scopes (and those local to the child unit itself) need to be
4738 -- installed explicitly.
4740 if Is_Child_Unit (Curr_Unit)
4741 and then Removed
4742 then
4743 for J in reverse 1 .. Num_Inner + 1 loop
4744 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4745 Use_Clauses (J);
4746 Install_Use_Clauses (Use_Clauses (J));
4747 end loop;
4749 else
4750 for J in reverse 1 .. Num_Scopes loop
4751 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4752 Use_Clauses (J);
4753 Install_Use_Clauses (Use_Clauses (J));
4754 end loop;
4755 end if;
4757 -- Restore status of instances. If one of them is a body, make its
4758 -- local entities visible again.
4760 declare
4761 E : Entity_Id;
4762 Inst : Entity_Id;
4764 begin
4765 for J in 1 .. N_Instances loop
4766 Inst := Instances (J);
4767 Set_Is_Generic_Instance (Inst, True);
4769 if In_Package_Body (Inst)
4770 or else Ekind_In (S, E_Procedure, E_Function)
4771 then
4772 E := First_Entity (Instances (J));
4773 while Present (E) loop
4774 Set_Is_Immediately_Visible (E);
4775 Next_Entity (E);
4776 end loop;
4777 end if;
4778 end loop;
4779 end;
4781 -- If generic unit is in current unit, current context is correct. Note
4782 -- that the context is guaranteed to carry the correct SPARK_Mode as no
4783 -- enclosing scopes were removed.
4785 else
4786 Instantiate_Package_Body
4787 (Body_Info =>
4788 ((Inst_Node => N,
4789 Act_Decl => Act_Decl,
4790 Expander_Status => Expander_Active,
4791 Current_Sem_Unit => Current_Sem_Unit,
4792 Scope_Suppress => Scope_Suppress,
4793 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4794 Version => Ada_Version,
4795 Version_Pragma => Ada_Version_Pragma,
4796 Warnings => Save_Warnings,
4797 SPARK_Mode => SPARK_Mode,
4798 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
4799 Inlined_Body => True);
4800 end if;
4801 end Inline_Instance_Body;
4803 -------------------------------------
4804 -- Analyze_Procedure_Instantiation --
4805 -------------------------------------
4807 procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4808 begin
4809 Analyze_Subprogram_Instantiation (N, E_Procedure);
4810 end Analyze_Procedure_Instantiation;
4812 -----------------------------------
4813 -- Need_Subprogram_Instance_Body --
4814 -----------------------------------
4816 function Need_Subprogram_Instance_Body
4817 (N : Node_Id;
4818 Subp : Entity_Id) return Boolean
4820 begin
4821 -- Must be inlined (or inlined renaming)
4823 if (Is_In_Main_Unit (N)
4824 or else Is_Inlined (Subp)
4825 or else Is_Inlined (Alias (Subp)))
4827 -- Must be generating code or analyzing code in ASIS/GNATprove mode
4829 and then (Operating_Mode = Generate_Code
4830 or else (Operating_Mode = Check_Semantics
4831 and then (ASIS_Mode or GNATprove_Mode)))
4833 -- The body is needed when generating code (full expansion), in ASIS
4834 -- mode for other tools, and in GNATprove mode (special expansion) for
4835 -- formal verification of the body itself.
4837 and then (Expander_Active or ASIS_Mode or GNATprove_Mode)
4839 -- No point in inlining if ABE is inevitable
4841 and then not ABE_Is_Certain (N)
4843 -- Or if subprogram is eliminated
4845 and then not Is_Eliminated (Subp)
4846 then
4847 Pending_Instantiations.Append
4848 ((Inst_Node => N,
4849 Act_Decl => Unit_Declaration_Node (Subp),
4850 Expander_Status => Expander_Active,
4851 Current_Sem_Unit => Current_Sem_Unit,
4852 Scope_Suppress => Scope_Suppress,
4853 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4854 Version => Ada_Version,
4855 Version_Pragma => Ada_Version_Pragma,
4856 Warnings => Save_Warnings,
4857 SPARK_Mode => SPARK_Mode,
4858 SPARK_Mode_Pragma => SPARK_Mode_Pragma));
4859 return True;
4861 -- Here if not inlined, or we ignore the inlining
4863 else
4864 return False;
4865 end if;
4866 end Need_Subprogram_Instance_Body;
4868 --------------------------------------
4869 -- Analyze_Subprogram_Instantiation --
4870 --------------------------------------
4872 procedure Analyze_Subprogram_Instantiation
4873 (N : Node_Id;
4874 K : Entity_Kind)
4876 Loc : constant Source_Ptr := Sloc (N);
4877 Gen_Id : constant Node_Id := Name (N);
4879 Anon_Id : constant Entity_Id :=
4880 Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4881 Chars => New_External_Name
4882 (Chars (Defining_Entity (N)), 'R'));
4884 Act_Decl_Id : Entity_Id;
4885 Act_Decl : Node_Id;
4886 Act_Spec : Node_Id;
4887 Act_Tree : Node_Id;
4889 Env_Installed : Boolean := False;
4890 Gen_Unit : Entity_Id;
4891 Gen_Decl : Node_Id;
4892 Pack_Id : Entity_Id;
4893 Parent_Installed : Boolean := False;
4894 Renaming_List : List_Id;
4896 procedure Analyze_Instance_And_Renamings;
4897 -- The instance must be analyzed in a context that includes the mappings
4898 -- of generic parameters into actuals. We create a package declaration
4899 -- for this purpose, and a subprogram with an internal name within the
4900 -- package. The subprogram instance is simply an alias for the internal
4901 -- subprogram, declared in the current scope.
4903 ------------------------------------
4904 -- Analyze_Instance_And_Renamings --
4905 ------------------------------------
4907 procedure Analyze_Instance_And_Renamings is
4908 Def_Ent : constant Entity_Id := Defining_Entity (N);
4909 Pack_Decl : Node_Id;
4911 begin
4912 if Nkind (Parent (N)) = N_Compilation_Unit then
4914 -- For the case of a compilation unit, the container package has
4915 -- the same name as the instantiation, to insure that the binder
4916 -- calls the elaboration procedure with the right name. Copy the
4917 -- entity of the instance, which may have compilation level flags
4918 -- (e.g. Is_Child_Unit) set.
4920 Pack_Id := New_Copy (Def_Ent);
4922 else
4923 -- Otherwise we use the name of the instantiation concatenated
4924 -- with its source position to ensure uniqueness if there are
4925 -- several instantiations with the same name.
4927 Pack_Id :=
4928 Make_Defining_Identifier (Loc,
4929 Chars => New_External_Name
4930 (Related_Id => Chars (Def_Ent),
4931 Suffix => "GP",
4932 Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4933 end if;
4935 Pack_Decl := Make_Package_Declaration (Loc,
4936 Specification => Make_Package_Specification (Loc,
4937 Defining_Unit_Name => Pack_Id,
4938 Visible_Declarations => Renaming_List,
4939 End_Label => Empty));
4941 Set_Instance_Spec (N, Pack_Decl);
4942 Set_Is_Generic_Instance (Pack_Id);
4943 Set_Debug_Info_Needed (Pack_Id);
4945 -- Case of not a compilation unit
4947 if Nkind (Parent (N)) /= N_Compilation_Unit then
4948 Mark_Rewrite_Insertion (Pack_Decl);
4949 Insert_Before (N, Pack_Decl);
4950 Set_Has_Completion (Pack_Id);
4952 -- Case of an instantiation that is a compilation unit
4954 -- Place declaration on current node so context is complete for
4955 -- analysis (including nested instantiations), and for use in a
4956 -- context_clause (see Analyze_With_Clause).
4958 else
4959 Set_Unit (Parent (N), Pack_Decl);
4960 Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4961 end if;
4963 Analyze (Pack_Decl);
4964 Check_Formal_Packages (Pack_Id);
4965 Set_Is_Generic_Instance (Pack_Id, False);
4967 -- Why do we clear Is_Generic_Instance??? We set it 20 lines
4968 -- above???
4970 -- Body of the enclosing package is supplied when instantiating the
4971 -- subprogram body, after semantic analysis is completed.
4973 if Nkind (Parent (N)) = N_Compilation_Unit then
4975 -- Remove package itself from visibility, so it does not
4976 -- conflict with subprogram.
4978 Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4980 -- Set name and scope of internal subprogram so that the proper
4981 -- external name will be generated. The proper scope is the scope
4982 -- of the wrapper package. We need to generate debugging info for
4983 -- the internal subprogram, so set flag accordingly.
4985 Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4986 Set_Scope (Anon_Id, Scope (Pack_Id));
4988 -- Mark wrapper package as referenced, to avoid spurious warnings
4989 -- if the instantiation appears in various with_ clauses of
4990 -- subunits of the main unit.
4992 Set_Referenced (Pack_Id);
4993 end if;
4995 Set_Is_Generic_Instance (Anon_Id);
4996 Set_Debug_Info_Needed (Anon_Id);
4997 Act_Decl_Id := New_Copy (Anon_Id);
4999 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
5000 Set_Chars (Act_Decl_Id, Chars (Defining_Entity (N)));
5001 Set_Sloc (Act_Decl_Id, Sloc (Defining_Entity (N)));
5002 Set_Comes_From_Source (Act_Decl_Id, True);
5004 -- The signature may involve types that are not frozen yet, but the
5005 -- subprogram will be frozen at the point the wrapper package is
5006 -- frozen, so it does not need its own freeze node. In fact, if one
5007 -- is created, it might conflict with the freezing actions from the
5008 -- wrapper package.
5010 Set_Has_Delayed_Freeze (Anon_Id, False);
5012 -- If the instance is a child unit, mark the Id accordingly. Mark
5013 -- the anonymous entity as well, which is the real subprogram and
5014 -- which is used when the instance appears in a context clause.
5015 -- Similarly, propagate the Is_Eliminated flag to handle properly
5016 -- nested eliminated subprograms.
5018 Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
5019 Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
5020 New_Overloaded_Entity (Act_Decl_Id);
5021 Check_Eliminated (Act_Decl_Id);
5022 Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
5024 -- In compilation unit case, kill elaboration checks on the
5025 -- instantiation, since they are never needed -- the body is
5026 -- instantiated at the same point as the spec.
5028 if Nkind (Parent (N)) = N_Compilation_Unit then
5029 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
5030 Set_Kill_Elaboration_Checks (Act_Decl_Id);
5031 Set_Is_Compilation_Unit (Anon_Id);
5033 Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
5034 end if;
5036 -- The instance is not a freezing point for the new subprogram
5038 Set_Is_Frozen (Act_Decl_Id, False);
5040 if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
5041 Valid_Operator_Definition (Act_Decl_Id);
5042 end if;
5044 Set_Alias (Act_Decl_Id, Anon_Id);
5045 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
5046 Set_Has_Completion (Act_Decl_Id);
5047 Set_Related_Instance (Pack_Id, Act_Decl_Id);
5049 if Nkind (Parent (N)) = N_Compilation_Unit then
5050 Set_Body_Required (Parent (N), False);
5051 end if;
5052 end Analyze_Instance_And_Renamings;
5054 -- Local variables
5056 Save_IPSM : constant Boolean := Ignore_Pragma_SPARK_Mode;
5057 -- Save flag Ignore_Pragma_SPARK_Mode for restore on exit
5059 Save_SM : constant SPARK_Mode_Type := SPARK_Mode;
5060 Save_SMP : constant Node_Id := SPARK_Mode_Pragma;
5061 -- Save the SPARK_Mode-related data for restore on exit
5063 Vis_Prims_List : Elist_Id := No_Elist;
5064 -- List of primitives made temporarily visible in the instantiation
5065 -- to match the visibility of the formal type
5067 -- Start of processing for Analyze_Subprogram_Instantiation
5069 begin
5070 Check_SPARK_05_Restriction ("generic is not allowed", N);
5072 -- Very first thing: check for special Text_IO unit in case we are
5073 -- instantiating one of the children of [[Wide_]Wide_]Text_IO. Of course
5074 -- such an instantiation is bogus (these are packages, not subprograms),
5075 -- but we get a better error message if we do this.
5077 Check_Text_IO_Special_Unit (Gen_Id);
5079 -- Make node global for error reporting
5081 Instantiation_Node := N;
5083 -- For package instantiations we turn off style checks, because they
5084 -- will have been emitted in the generic. For subprogram instantiations
5085 -- we want to apply at least the check on overriding indicators so we
5086 -- do not modify the style check status.
5088 -- The renaming declarations for the actuals do not come from source and
5089 -- will not generate spurious warnings.
5091 Preanalyze_Actuals (N);
5093 Init_Env;
5094 Env_Installed := True;
5095 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
5096 Gen_Unit := Entity (Gen_Id);
5098 Generate_Reference (Gen_Unit, Gen_Id);
5100 if Nkind (Gen_Id) = N_Identifier
5101 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
5102 then
5103 Error_Msg_NE
5104 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
5105 end if;
5107 if Etype (Gen_Unit) = Any_Type then
5108 Restore_Env;
5109 return;
5110 end if;
5112 -- Verify that it is a generic subprogram of the right kind, and that
5113 -- it does not lead to a circular instantiation.
5115 if K = E_Procedure and then Ekind (Gen_Unit) /= E_Generic_Procedure then
5116 Error_Msg_NE
5117 ("& is not the name of a generic procedure", Gen_Id, Gen_Unit);
5119 elsif K = E_Function and then Ekind (Gen_Unit) /= E_Generic_Function then
5120 Error_Msg_NE
5121 ("& is not the name of a generic function", Gen_Id, Gen_Unit);
5123 elsif In_Open_Scopes (Gen_Unit) then
5124 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
5126 else
5127 -- If the context of the instance is subject to SPARK_Mode "off",
5128 -- set the global flag which signals Analyze_Pragma to ignore all
5129 -- SPARK_Mode pragmas within the instance.
5131 if SPARK_Mode = Off then
5132 Ignore_Pragma_SPARK_Mode := True;
5133 end if;
5135 Set_Entity (Gen_Id, Gen_Unit);
5136 Set_Is_Instantiated (Gen_Unit);
5138 if In_Extended_Main_Source_Unit (N) then
5139 Generate_Reference (Gen_Unit, N);
5140 end if;
5142 -- If renaming, get original unit
5144 if Present (Renamed_Object (Gen_Unit))
5145 and then Ekind_In (Renamed_Object (Gen_Unit), E_Generic_Procedure,
5146 E_Generic_Function)
5147 then
5148 Gen_Unit := Renamed_Object (Gen_Unit);
5149 Set_Is_Instantiated (Gen_Unit);
5150 Generate_Reference (Gen_Unit, N);
5151 end if;
5153 if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
5154 Error_Msg_Node_2 := Current_Scope;
5155 Error_Msg_NE
5156 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
5157 Circularity_Detected := True;
5158 Restore_Hidden_Primitives (Vis_Prims_List);
5159 goto Leave;
5160 end if;
5162 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
5164 -- Initialize renamings map, for error checking
5166 Generic_Renamings.Set_Last (0);
5167 Generic_Renamings_HTable.Reset;
5169 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
5171 -- Copy original generic tree, to produce text for instantiation
5173 Act_Tree :=
5174 Copy_Generic_Node
5175 (Original_Node (Gen_Decl), Empty, Instantiating => True);
5177 -- Inherit overriding indicator from instance node
5179 Act_Spec := Specification (Act_Tree);
5180 Set_Must_Override (Act_Spec, Must_Override (N));
5181 Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
5183 Renaming_List :=
5184 Analyze_Associations
5185 (I_Node => N,
5186 Formals => Generic_Formal_Declarations (Act_Tree),
5187 F_Copy => Generic_Formal_Declarations (Gen_Decl));
5189 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
5191 -- The subprogram itself cannot contain a nested instance, so the
5192 -- current parent is left empty.
5194 Set_Instance_Env (Gen_Unit, Empty);
5196 -- Build the subprogram declaration, which does not appear in the
5197 -- generic template, and give it a sloc consistent with that of the
5198 -- template.
5200 Set_Defining_Unit_Name (Act_Spec, Anon_Id);
5201 Set_Generic_Parent (Act_Spec, Gen_Unit);
5202 Act_Decl :=
5203 Make_Subprogram_Declaration (Sloc (Act_Spec),
5204 Specification => Act_Spec);
5206 -- The aspects have been copied previously, but they have to be
5207 -- linked explicitly to the new subprogram declaration. Explicit
5208 -- pre/postconditions on the instance are analyzed below, in a
5209 -- separate step.
5211 Move_Aspects (Act_Tree, To => Act_Decl);
5212 Set_Categorization_From_Pragmas (Act_Decl);
5214 if Parent_Installed then
5215 Hide_Current_Scope;
5216 end if;
5218 Append (Act_Decl, Renaming_List);
5219 Analyze_Instance_And_Renamings;
5221 -- If the generic is marked Import (Intrinsic), then so is the
5222 -- instance. This indicates that there is no body to instantiate. If
5223 -- generic is marked inline, so it the instance, and the anonymous
5224 -- subprogram it renames. If inlined, or else if inlining is enabled
5225 -- for the compilation, we generate the instance body even if it is
5226 -- not within the main unit.
5228 if Is_Intrinsic_Subprogram (Gen_Unit) then
5229 Set_Is_Intrinsic_Subprogram (Anon_Id);
5230 Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
5232 if Chars (Gen_Unit) = Name_Unchecked_Conversion then
5233 Validate_Unchecked_Conversion (N, Act_Decl_Id);
5234 end if;
5235 end if;
5237 -- Inherit convention from generic unit. Intrinsic convention, as for
5238 -- an instance of unchecked conversion, is not inherited because an
5239 -- explicit Ada instance has been created.
5241 if Has_Convention_Pragma (Gen_Unit)
5242 and then Convention (Gen_Unit) /= Convention_Intrinsic
5243 then
5244 Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
5245 Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
5246 end if;
5248 Generate_Definition (Act_Decl_Id);
5249 -- Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id)));
5250 -- ??? needed?
5251 Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
5253 -- Inherit all inlining-related flags which apply to the generic in
5254 -- the subprogram and its declaration.
5256 Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
5257 Set_Is_Inlined (Anon_Id, Is_Inlined (Gen_Unit));
5259 Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
5260 Set_Has_Pragma_Inline (Anon_Id, Has_Pragma_Inline (Gen_Unit));
5262 Set_Has_Pragma_Inline_Always
5263 (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
5264 Set_Has_Pragma_Inline_Always
5265 (Anon_Id, Has_Pragma_Inline_Always (Gen_Unit));
5267 if not Is_Intrinsic_Subprogram (Gen_Unit) then
5268 Check_Elab_Instantiation (N);
5269 end if;
5271 if Is_Dispatching_Operation (Act_Decl_Id)
5272 and then Ada_Version >= Ada_2005
5273 then
5274 declare
5275 Formal : Entity_Id;
5277 begin
5278 Formal := First_Formal (Act_Decl_Id);
5279 while Present (Formal) loop
5280 if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
5281 and then Is_Controlling_Formal (Formal)
5282 and then not Can_Never_Be_Null (Formal)
5283 then
5284 Error_Msg_NE ("access parameter& is controlling,",
5285 N, Formal);
5286 Error_Msg_NE
5287 ("\corresponding parameter of & must be"
5288 & " explicitly null-excluding", N, Gen_Id);
5289 end if;
5291 Next_Formal (Formal);
5292 end loop;
5293 end;
5294 end if;
5296 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
5298 Validate_Categorization_Dependency (N, Act_Decl_Id);
5300 if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
5301 Inherit_Context (Gen_Decl, N);
5303 Restore_Private_Views (Pack_Id, False);
5305 -- If the context requires a full instantiation, mark node for
5306 -- subsequent construction of the body.
5308 if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
5309 Check_Forward_Instantiation (Gen_Decl);
5311 -- The wrapper package is always delayed, because it does not
5312 -- constitute a freeze point, but to insure that the freeze
5313 -- node is placed properly, it is created directly when
5314 -- instantiating the body (otherwise the freeze node might
5315 -- appear to early for nested instantiations).
5317 elsif Nkind (Parent (N)) = N_Compilation_Unit then
5319 -- For ASIS purposes, indicate that the wrapper package has
5320 -- replaced the instantiation node.
5322 Rewrite (N, Unit (Parent (N)));
5323 Set_Unit (Parent (N), N);
5324 end if;
5326 elsif Nkind (Parent (N)) = N_Compilation_Unit then
5328 -- Replace instance node for library-level instantiations of
5329 -- intrinsic subprograms, for ASIS use.
5331 Rewrite (N, Unit (Parent (N)));
5332 Set_Unit (Parent (N), N);
5333 end if;
5335 if Parent_Installed then
5336 Remove_Parent;
5337 end if;
5339 Restore_Hidden_Primitives (Vis_Prims_List);
5340 Restore_Env;
5341 Env_Installed := False;
5342 Generic_Renamings.Set_Last (0);
5343 Generic_Renamings_HTable.Reset;
5345 Ignore_Pragma_SPARK_Mode := Save_IPSM;
5346 SPARK_Mode := Save_SM;
5347 SPARK_Mode_Pragma := Save_SMP;
5348 end if;
5350 <<Leave>>
5351 if Has_Aspects (N) then
5352 Analyze_Aspect_Specifications (N, Act_Decl_Id);
5353 end if;
5355 exception
5356 when Instantiation_Error =>
5357 if Parent_Installed then
5358 Remove_Parent;
5359 end if;
5361 if Env_Installed then
5362 Restore_Env;
5363 end if;
5365 Ignore_Pragma_SPARK_Mode := Save_IPSM;
5366 SPARK_Mode := Save_SM;
5367 SPARK_Mode_Pragma := Save_SMP;
5368 end Analyze_Subprogram_Instantiation;
5370 -------------------------
5371 -- Get_Associated_Node --
5372 -------------------------
5374 function Get_Associated_Node (N : Node_Id) return Node_Id is
5375 Assoc : Node_Id;
5377 begin
5378 Assoc := Associated_Node (N);
5380 if Nkind (Assoc) /= Nkind (N) then
5381 return Assoc;
5383 elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
5384 return Assoc;
5386 else
5387 -- If the node is part of an inner generic, it may itself have been
5388 -- remapped into a further generic copy. Associated_Node is otherwise
5389 -- used for the entity of the node, and will be of a different node
5390 -- kind, or else N has been rewritten as a literal or function call.
5392 while Present (Associated_Node (Assoc))
5393 and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
5394 loop
5395 Assoc := Associated_Node (Assoc);
5396 end loop;
5398 -- Follow and additional link in case the final node was rewritten.
5399 -- This can only happen with nested generic units.
5401 if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
5402 and then Present (Associated_Node (Assoc))
5403 and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
5404 N_Explicit_Dereference,
5405 N_Integer_Literal,
5406 N_Real_Literal,
5407 N_String_Literal))
5408 then
5409 Assoc := Associated_Node (Assoc);
5410 end if;
5412 -- An additional special case: an unconstrained type in an object
5413 -- declaration may have been rewritten as a local subtype constrained
5414 -- by the expression in the declaration. We need to recover the
5415 -- original entity which may be global.
5417 if Present (Original_Node (Assoc))
5418 and then Nkind (Parent (N)) = N_Object_Declaration
5419 then
5420 Assoc := Original_Node (Assoc);
5421 end if;
5423 return Assoc;
5424 end if;
5425 end Get_Associated_Node;
5427 -------------------------------------------
5428 -- Build_Instance_Compilation_Unit_Nodes --
5429 -------------------------------------------
5431 procedure Build_Instance_Compilation_Unit_Nodes
5432 (N : Node_Id;
5433 Act_Body : Node_Id;
5434 Act_Decl : Node_Id)
5436 Decl_Cunit : Node_Id;
5437 Body_Cunit : Node_Id;
5438 Citem : Node_Id;
5439 New_Main : constant Entity_Id := Defining_Entity (Act_Decl);
5440 Old_Main : constant Entity_Id := Cunit_Entity (Main_Unit);
5442 begin
5443 -- A new compilation unit node is built for the instance declaration
5445 Decl_Cunit :=
5446 Make_Compilation_Unit (Sloc (N),
5447 Context_Items => Empty_List,
5448 Unit => Act_Decl,
5449 Aux_Decls_Node => Make_Compilation_Unit_Aux (Sloc (N)));
5451 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
5453 -- The new compilation unit is linked to its body, but both share the
5454 -- same file, so we do not set Body_Required on the new unit so as not
5455 -- to create a spurious dependency on a non-existent body in the ali.
5456 -- This simplifies CodePeer unit traversal.
5458 -- We use the original instantiation compilation unit as the resulting
5459 -- compilation unit of the instance, since this is the main unit.
5461 Rewrite (N, Act_Body);
5463 -- Propagate the aspect specifications from the package body template to
5464 -- the instantiated version of the package body.
5466 if Has_Aspects (Act_Body) then
5467 Set_Aspect_Specifications
5468 (N, New_Copy_List_Tree (Aspect_Specifications (Act_Body)));
5469 end if;
5471 Body_Cunit := Parent (N);
5473 -- The two compilation unit nodes are linked by the Library_Unit field
5475 Set_Library_Unit (Decl_Cunit, Body_Cunit);
5476 Set_Library_Unit (Body_Cunit, Decl_Cunit);
5478 -- Preserve the private nature of the package if needed
5480 Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
5482 -- If the instance is not the main unit, its context, categorization
5483 -- and elaboration entity are not relevant to the compilation.
5485 if Body_Cunit /= Cunit (Main_Unit) then
5486 Make_Instance_Unit (Body_Cunit, In_Main => False);
5487 return;
5488 end if;
5490 -- The context clause items on the instantiation, which are now attached
5491 -- to the body compilation unit (since the body overwrote the original
5492 -- instantiation node), semantically belong on the spec, so copy them
5493 -- there. It's harmless to leave them on the body as well. In fact one
5494 -- could argue that they belong in both places.
5496 Citem := First (Context_Items (Body_Cunit));
5497 while Present (Citem) loop
5498 Append (New_Copy (Citem), Context_Items (Decl_Cunit));
5499 Next (Citem);
5500 end loop;
5502 -- Propagate categorization flags on packages, so that they appear in
5503 -- the ali file for the spec of the unit.
5505 if Ekind (New_Main) = E_Package then
5506 Set_Is_Pure (Old_Main, Is_Pure (New_Main));
5507 Set_Is_Preelaborated (Old_Main, Is_Preelaborated (New_Main));
5508 Set_Is_Remote_Types (Old_Main, Is_Remote_Types (New_Main));
5509 Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
5510 Set_Is_Remote_Call_Interface
5511 (Old_Main, Is_Remote_Call_Interface (New_Main));
5512 end if;
5514 -- Make entry in Units table, so that binder can generate call to
5515 -- elaboration procedure for body, if any.
5517 Make_Instance_Unit (Body_Cunit, In_Main => True);
5518 Main_Unit_Entity := New_Main;
5519 Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
5521 -- Build elaboration entity, since the instance may certainly generate
5522 -- elaboration code requiring a flag for protection.
5524 Build_Elaboration_Entity (Decl_Cunit, New_Main);
5525 end Build_Instance_Compilation_Unit_Nodes;
5527 -----------------------------
5528 -- Check_Access_Definition --
5529 -----------------------------
5531 procedure Check_Access_Definition (N : Node_Id) is
5532 begin
5533 pragma Assert
5534 (Ada_Version >= Ada_2005 and then Present (Access_Definition (N)));
5535 null;
5536 end Check_Access_Definition;
5538 -----------------------------------
5539 -- Check_Formal_Package_Instance --
5540 -----------------------------------
5542 -- If the formal has specific parameters, they must match those of the
5543 -- actual. Both of them are instances, and the renaming declarations for
5544 -- their formal parameters appear in the same order in both. The analyzed
5545 -- formal has been analyzed in the context of the current instance.
5547 procedure Check_Formal_Package_Instance
5548 (Formal_Pack : Entity_Id;
5549 Actual_Pack : Entity_Id)
5551 E1 : Entity_Id := First_Entity (Actual_Pack);
5552 E2 : Entity_Id := First_Entity (Formal_Pack);
5554 Expr1 : Node_Id;
5555 Expr2 : Node_Id;
5557 procedure Check_Mismatch (B : Boolean);
5558 -- Common error routine for mismatch between the parameters of the
5559 -- actual instance and those of the formal package.
5561 function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
5562 -- The formal may come from a nested formal package, and the actual may
5563 -- have been constant-folded. To determine whether the two denote the
5564 -- same entity we may have to traverse several definitions to recover
5565 -- the ultimate entity that they refer to.
5567 function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
5568 -- Similarly, if the formal comes from a nested formal package, the
5569 -- actual may designate the formal through multiple renamings, which
5570 -- have to be followed to determine the original variable in question.
5572 --------------------
5573 -- Check_Mismatch --
5574 --------------------
5576 procedure Check_Mismatch (B : Boolean) is
5577 Kind : constant Node_Kind := Nkind (Parent (E2));
5579 begin
5580 if Kind = N_Formal_Type_Declaration then
5581 return;
5583 elsif Nkind_In (Kind, N_Formal_Object_Declaration,
5584 N_Formal_Package_Declaration)
5585 or else Kind in N_Formal_Subprogram_Declaration
5586 then
5587 null;
5589 elsif B then
5590 Error_Msg_NE
5591 ("actual for & in actual instance does not match formal",
5592 Parent (Actual_Pack), E1);
5593 end if;
5594 end Check_Mismatch;
5596 --------------------------------
5597 -- Same_Instantiated_Constant --
5598 --------------------------------
5600 function Same_Instantiated_Constant
5601 (E1, E2 : Entity_Id) return Boolean
5603 Ent : Entity_Id;
5605 begin
5606 Ent := E2;
5607 while Present (Ent) loop
5608 if E1 = Ent then
5609 return True;
5611 elsif Ekind (Ent) /= E_Constant then
5612 return False;
5614 elsif Is_Entity_Name (Constant_Value (Ent)) then
5615 if Entity (Constant_Value (Ent)) = E1 then
5616 return True;
5617 else
5618 Ent := Entity (Constant_Value (Ent));
5619 end if;
5621 -- The actual may be a constant that has been folded. Recover
5622 -- original name.
5624 elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5625 Ent := Entity (Original_Node (Constant_Value (Ent)));
5626 else
5627 return False;
5628 end if;
5629 end loop;
5631 return False;
5632 end Same_Instantiated_Constant;
5634 --------------------------------
5635 -- Same_Instantiated_Variable --
5636 --------------------------------
5638 function Same_Instantiated_Variable
5639 (E1, E2 : Entity_Id) return Boolean
5641 function Original_Entity (E : Entity_Id) return Entity_Id;
5642 -- Follow chain of renamings to the ultimate ancestor
5644 ---------------------
5645 -- Original_Entity --
5646 ---------------------
5648 function Original_Entity (E : Entity_Id) return Entity_Id is
5649 Orig : Entity_Id;
5651 begin
5652 Orig := E;
5653 while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5654 and then Present (Renamed_Object (Orig))
5655 and then Is_Entity_Name (Renamed_Object (Orig))
5656 loop
5657 Orig := Entity (Renamed_Object (Orig));
5658 end loop;
5660 return Orig;
5661 end Original_Entity;
5663 -- Start of processing for Same_Instantiated_Variable
5665 begin
5666 return Ekind (E1) = Ekind (E2)
5667 and then Original_Entity (E1) = Original_Entity (E2);
5668 end Same_Instantiated_Variable;
5670 -- Start of processing for Check_Formal_Package_Instance
5672 begin
5673 while Present (E1)
5674 and then Present (E2)
5675 loop
5676 exit when Ekind (E1) = E_Package
5677 and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5679 -- If the formal is the renaming of the formal package, this
5680 -- is the end of its formal part, which may occur before the
5681 -- end of the formal part in the actual in the presence of
5682 -- defaulted parameters in the formal package.
5684 exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5685 and then Renamed_Entity (E2) = Scope (E2);
5687 -- The analysis of the actual may generate additional internal
5688 -- entities. If the formal is defaulted, there is no corresponding
5689 -- analysis and the internal entities must be skipped, until we
5690 -- find corresponding entities again.
5692 if Comes_From_Source (E2)
5693 and then not Comes_From_Source (E1)
5694 and then Chars (E1) /= Chars (E2)
5695 then
5696 while Present (E1)
5697 and then Chars (E1) /= Chars (E2)
5698 loop
5699 Next_Entity (E1);
5700 end loop;
5701 end if;
5703 if No (E1) then
5704 return;
5706 -- If the formal entity comes from a formal declaration, it was
5707 -- defaulted in the formal package, and no check is needed on it.
5709 elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
5710 goto Next_E;
5712 -- Ditto for defaulted formal subprograms.
5714 elsif Is_Overloadable (E1)
5715 and then Nkind (Unit_Declaration_Node (E2)) in
5716 N_Formal_Subprogram_Declaration
5717 then
5718 goto Next_E;
5720 elsif Is_Type (E1) then
5722 -- Subtypes must statically match. E1, E2 are the local entities
5723 -- that are subtypes of the actuals. Itypes generated for other
5724 -- parameters need not be checked, the check will be performed
5725 -- on the parameters themselves.
5727 -- If E2 is a formal type declaration, it is a defaulted parameter
5728 -- and needs no checking.
5730 if not Is_Itype (E1)
5731 and then not Is_Itype (E2)
5732 then
5733 Check_Mismatch
5734 (not Is_Type (E2)
5735 or else Etype (E1) /= Etype (E2)
5736 or else not Subtypes_Statically_Match (E1, E2));
5737 end if;
5739 elsif Ekind (E1) = E_Constant then
5741 -- IN parameters must denote the same static value, or the same
5742 -- constant, or the literal null.
5744 Expr1 := Expression (Parent (E1));
5746 if Ekind (E2) /= E_Constant then
5747 Check_Mismatch (True);
5748 goto Next_E;
5749 else
5750 Expr2 := Expression (Parent (E2));
5751 end if;
5753 if Is_OK_Static_Expression (Expr1) then
5754 if not Is_OK_Static_Expression (Expr2) then
5755 Check_Mismatch (True);
5757 elsif Is_Discrete_Type (Etype (E1)) then
5758 declare
5759 V1 : constant Uint := Expr_Value (Expr1);
5760 V2 : constant Uint := Expr_Value (Expr2);
5761 begin
5762 Check_Mismatch (V1 /= V2);
5763 end;
5765 elsif Is_Real_Type (Etype (E1)) then
5766 declare
5767 V1 : constant Ureal := Expr_Value_R (Expr1);
5768 V2 : constant Ureal := Expr_Value_R (Expr2);
5769 begin
5770 Check_Mismatch (V1 /= V2);
5771 end;
5773 elsif Is_String_Type (Etype (E1))
5774 and then Nkind (Expr1) = N_String_Literal
5775 then
5776 if Nkind (Expr2) /= N_String_Literal then
5777 Check_Mismatch (True);
5778 else
5779 Check_Mismatch
5780 (not String_Equal (Strval (Expr1), Strval (Expr2)));
5781 end if;
5782 end if;
5784 elsif Is_Entity_Name (Expr1) then
5785 if Is_Entity_Name (Expr2) then
5786 if Entity (Expr1) = Entity (Expr2) then
5787 null;
5788 else
5789 Check_Mismatch
5790 (not Same_Instantiated_Constant
5791 (Entity (Expr1), Entity (Expr2)));
5792 end if;
5793 else
5794 Check_Mismatch (True);
5795 end if;
5797 elsif Is_Entity_Name (Original_Node (Expr1))
5798 and then Is_Entity_Name (Expr2)
5799 and then
5800 Same_Instantiated_Constant
5801 (Entity (Original_Node (Expr1)), Entity (Expr2))
5802 then
5803 null;
5805 elsif Nkind (Expr1) = N_Null then
5806 Check_Mismatch (Nkind (Expr1) /= N_Null);
5808 else
5809 Check_Mismatch (True);
5810 end if;
5812 elsif Ekind (E1) = E_Variable then
5813 Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5815 elsif Ekind (E1) = E_Package then
5816 Check_Mismatch
5817 (Ekind (E1) /= Ekind (E2)
5818 or else Renamed_Object (E1) /= Renamed_Object (E2));
5820 elsif Is_Overloadable (E1) then
5822 -- Verify that the actual subprograms match. Note that actuals
5823 -- that are attributes are rewritten as subprograms. If the
5824 -- subprogram in the formal package is defaulted, no check is
5825 -- needed. Note that this can only happen in Ada 2005 when the
5826 -- formal package can be partially parameterized.
5828 if Nkind (Unit_Declaration_Node (E1)) =
5829 N_Subprogram_Renaming_Declaration
5830 and then From_Default (Unit_Declaration_Node (E1))
5831 then
5832 null;
5834 -- If the formal package has an "others" box association that
5835 -- covers this formal, there is no need for a check either.
5837 elsif Nkind (Unit_Declaration_Node (E2)) in
5838 N_Formal_Subprogram_Declaration
5839 and then Box_Present (Unit_Declaration_Node (E2))
5840 then
5841 null;
5843 -- No check needed if subprogram is a defaulted null procedure
5845 elsif No (Alias (E2))
5846 and then Ekind (E2) = E_Procedure
5847 and then
5848 Null_Present (Specification (Unit_Declaration_Node (E2)))
5849 then
5850 null;
5852 -- Otherwise the actual in the formal and the actual in the
5853 -- instantiation of the formal must match, up to renamings.
5855 else
5856 Check_Mismatch
5857 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5858 end if;
5860 else
5861 raise Program_Error;
5862 end if;
5864 <<Next_E>>
5865 Next_Entity (E1);
5866 Next_Entity (E2);
5867 end loop;
5868 end Check_Formal_Package_Instance;
5870 ---------------------------
5871 -- Check_Formal_Packages --
5872 ---------------------------
5874 procedure Check_Formal_Packages (P_Id : Entity_Id) is
5875 E : Entity_Id;
5876 Formal_P : Entity_Id;
5878 begin
5879 -- Iterate through the declarations in the instance, looking for package
5880 -- renaming declarations that denote instances of formal packages. Stop
5881 -- when we find the renaming of the current package itself. The
5882 -- declaration for a formal package without a box is followed by an
5883 -- internal entity that repeats the instantiation.
5885 E := First_Entity (P_Id);
5886 while Present (E) loop
5887 if Ekind (E) = E_Package then
5888 if Renamed_Object (E) = P_Id then
5889 exit;
5891 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5892 null;
5894 elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5895 Formal_P := Next_Entity (E);
5896 Check_Formal_Package_Instance (Formal_P, E);
5898 -- After checking, remove the internal validating package. It
5899 -- is only needed for semantic checks, and as it may contain
5900 -- generic formal declarations it should not reach gigi.
5902 Remove (Unit_Declaration_Node (Formal_P));
5903 end if;
5904 end if;
5906 Next_Entity (E);
5907 end loop;
5908 end Check_Formal_Packages;
5910 ---------------------------------
5911 -- Check_Forward_Instantiation --
5912 ---------------------------------
5914 procedure Check_Forward_Instantiation (Decl : Node_Id) is
5915 S : Entity_Id;
5916 Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5918 begin
5919 -- The instantiation appears before the generic body if we are in the
5920 -- scope of the unit containing the generic, either in its spec or in
5921 -- the package body, and before the generic body.
5923 if Ekind (Gen_Comp) = E_Package_Body then
5924 Gen_Comp := Spec_Entity (Gen_Comp);
5925 end if;
5927 if In_Open_Scopes (Gen_Comp)
5928 and then No (Corresponding_Body (Decl))
5929 then
5930 S := Current_Scope;
5932 while Present (S)
5933 and then not Is_Compilation_Unit (S)
5934 and then not Is_Child_Unit (S)
5935 loop
5936 if Ekind (S) = E_Package then
5937 Set_Has_Forward_Instantiation (S);
5938 end if;
5940 S := Scope (S);
5941 end loop;
5942 end if;
5943 end Check_Forward_Instantiation;
5945 ---------------------------
5946 -- Check_Generic_Actuals --
5947 ---------------------------
5949 -- The visibility of the actuals may be different between the point of
5950 -- generic instantiation and the instantiation of the body.
5952 procedure Check_Generic_Actuals
5953 (Instance : Entity_Id;
5954 Is_Formal_Box : Boolean)
5956 E : Entity_Id;
5957 Astype : Entity_Id;
5959 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5960 -- For a formal that is an array type, the component type is often a
5961 -- previous formal in the same unit. The privacy status of the component
5962 -- type will have been examined earlier in the traversal of the
5963 -- corresponding actuals, and this status should not be modified for
5964 -- the array (sub)type itself. However, if the base type of the array
5965 -- (sub)type is private, its full view must be restored in the body to
5966 -- be consistent with subsequent index subtypes, etc.
5968 -- To detect this case we have to rescan the list of formals, which is
5969 -- usually short enough to ignore the resulting inefficiency.
5971 -----------------------------
5972 -- Denotes_Previous_Actual --
5973 -----------------------------
5975 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5976 Prev : Entity_Id;
5978 begin
5979 Prev := First_Entity (Instance);
5980 while Present (Prev) loop
5981 if Is_Type (Prev)
5982 and then Nkind (Parent (Prev)) = N_Subtype_Declaration
5983 and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
5984 and then Entity (Subtype_Indication (Parent (Prev))) = Typ
5985 then
5986 return True;
5988 elsif Prev = E then
5989 return False;
5991 else
5992 Next_Entity (Prev);
5993 end if;
5994 end loop;
5996 return False;
5997 end Denotes_Previous_Actual;
5999 -- Start of processing for Check_Generic_Actuals
6001 begin
6002 E := First_Entity (Instance);
6003 while Present (E) loop
6004 if Is_Type (E)
6005 and then Nkind (Parent (E)) = N_Subtype_Declaration
6006 and then Scope (Etype (E)) /= Instance
6007 and then Is_Entity_Name (Subtype_Indication (Parent (E)))
6008 then
6009 if Is_Array_Type (E)
6010 and then not Is_Private_Type (Etype (E))
6011 and then Denotes_Previous_Actual (Component_Type (E))
6012 then
6013 null;
6014 else
6015 Check_Private_View (Subtype_Indication (Parent (E)));
6016 end if;
6018 Set_Is_Generic_Actual_Type (E, True);
6019 Set_Is_Hidden (E, False);
6020 Set_Is_Potentially_Use_Visible (E,
6021 In_Use (Instance));
6023 -- We constructed the generic actual type as a subtype of the
6024 -- supplied type. This means that it normally would not inherit
6025 -- subtype specific attributes of the actual, which is wrong for
6026 -- the generic case.
6028 Astype := Ancestor_Subtype (E);
6030 if No (Astype) then
6032 -- This can happen when E is an itype that is the full view of
6033 -- a private type completed, e.g. with a constrained array. In
6034 -- that case, use the first subtype, which will carry size
6035 -- information. The base type itself is unconstrained and will
6036 -- not carry it.
6038 Astype := First_Subtype (E);
6039 end if;
6041 Set_Size_Info (E, (Astype));
6042 Set_RM_Size (E, RM_Size (Astype));
6043 Set_First_Rep_Item (E, First_Rep_Item (Astype));
6045 if Is_Discrete_Or_Fixed_Point_Type (E) then
6046 Set_RM_Size (E, RM_Size (Astype));
6048 -- In nested instances, the base type of an access actual may
6049 -- itself be private, and need to be exchanged.
6051 elsif Is_Access_Type (E)
6052 and then Is_Private_Type (Etype (E))
6053 then
6054 Check_Private_View
6055 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
6056 end if;
6058 elsif Ekind (E) = E_Package then
6060 -- If this is the renaming for the current instance, we're done.
6061 -- Otherwise it is a formal package. If the corresponding formal
6062 -- was declared with a box, the (instantiations of the) generic
6063 -- formal part are also visible. Otherwise, ignore the entity
6064 -- created to validate the actuals.
6066 if Renamed_Object (E) = Instance then
6067 exit;
6069 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
6070 null;
6072 -- The visibility of a formal of an enclosing generic is already
6073 -- correct.
6075 elsif Denotes_Formal_Package (E) then
6076 null;
6078 elsif Present (Associated_Formal_Package (E))
6079 and then not Is_Generic_Formal (E)
6080 then
6081 if Box_Present (Parent (Associated_Formal_Package (E))) then
6082 Check_Generic_Actuals (Renamed_Object (E), True);
6084 else
6085 Check_Generic_Actuals (Renamed_Object (E), False);
6086 end if;
6088 Set_Is_Hidden (E, False);
6089 end if;
6091 -- If this is a subprogram instance (in a wrapper package) the
6092 -- actual is fully visible.
6094 elsif Is_Wrapper_Package (Instance) then
6095 Set_Is_Hidden (E, False);
6097 -- If the formal package is declared with a box, or if the formal
6098 -- parameter is defaulted, it is visible in the body.
6100 elsif Is_Formal_Box or else Is_Visible_Formal (E) then
6101 Set_Is_Hidden (E, False);
6102 end if;
6104 if Ekind (E) = E_Constant then
6106 -- If the type of the actual is a private type declared in the
6107 -- enclosing scope of the generic unit, the body of the generic
6108 -- sees the full view of the type (because it has to appear in
6109 -- the corresponding package body). If the type is private now,
6110 -- exchange views to restore the proper visiblity in the instance.
6112 declare
6113 Typ : constant Entity_Id := Base_Type (Etype (E));
6114 -- The type of the actual
6116 Gen_Id : Entity_Id;
6117 -- The generic unit
6119 Parent_Scope : Entity_Id;
6120 -- The enclosing scope of the generic unit
6122 begin
6123 if Is_Wrapper_Package (Instance) then
6124 Gen_Id :=
6125 Generic_Parent
6126 (Specification
6127 (Unit_Declaration_Node
6128 (Related_Instance (Instance))));
6129 else
6130 Gen_Id :=
6131 Generic_Parent (Package_Specification (Instance));
6132 end if;
6134 Parent_Scope := Scope (Gen_Id);
6136 -- The exchange is only needed if the generic is defined
6137 -- within a package which is not a common ancestor of the
6138 -- scope of the instance, and is not already in scope.
6140 if Is_Private_Type (Typ)
6141 and then Scope (Typ) = Parent_Scope
6142 and then Scope (Instance) /= Parent_Scope
6143 and then Ekind (Parent_Scope) = E_Package
6144 and then not Is_Child_Unit (Gen_Id)
6145 then
6146 Switch_View (Typ);
6148 -- If the type of the entity is a subtype, it may also have
6149 -- to be made visible, together with the base type of its
6150 -- full view, after exchange.
6152 if Is_Private_Type (Etype (E)) then
6153 Switch_View (Etype (E));
6154 Switch_View (Base_Type (Etype (E)));
6155 end if;
6156 end if;
6157 end;
6158 end if;
6160 Next_Entity (E);
6161 end loop;
6162 end Check_Generic_Actuals;
6164 ------------------------------
6165 -- Check_Generic_Child_Unit --
6166 ------------------------------
6168 procedure Check_Generic_Child_Unit
6169 (Gen_Id : Node_Id;
6170 Parent_Installed : in out Boolean)
6172 Loc : constant Source_Ptr := Sloc (Gen_Id);
6173 Gen_Par : Entity_Id := Empty;
6174 E : Entity_Id;
6175 Inst_Par : Entity_Id;
6176 S : Node_Id;
6178 function Find_Generic_Child
6179 (Scop : Entity_Id;
6180 Id : Node_Id) return Entity_Id;
6181 -- Search generic parent for possible child unit with the given name
6183 function In_Enclosing_Instance return Boolean;
6184 -- Within an instance of the parent, the child unit may be denoted by
6185 -- a simple name, or an abbreviated expanded name. Examine enclosing
6186 -- scopes to locate a possible parent instantiation.
6188 ------------------------
6189 -- Find_Generic_Child --
6190 ------------------------
6192 function Find_Generic_Child
6193 (Scop : Entity_Id;
6194 Id : Node_Id) return Entity_Id
6196 E : Entity_Id;
6198 begin
6199 -- If entity of name is already set, instance has already been
6200 -- resolved, e.g. in an enclosing instantiation.
6202 if Present (Entity (Id)) then
6203 if Scope (Entity (Id)) = Scop then
6204 return Entity (Id);
6205 else
6206 return Empty;
6207 end if;
6209 else
6210 E := First_Entity (Scop);
6211 while Present (E) loop
6212 if Chars (E) = Chars (Id)
6213 and then Is_Child_Unit (E)
6214 then
6215 if Is_Child_Unit (E)
6216 and then not Is_Visible_Lib_Unit (E)
6217 then
6218 Error_Msg_NE
6219 ("generic child unit& is not visible", Gen_Id, E);
6220 end if;
6222 Set_Entity (Id, E);
6223 return E;
6224 end if;
6226 Next_Entity (E);
6227 end loop;
6229 return Empty;
6230 end if;
6231 end Find_Generic_Child;
6233 ---------------------------
6234 -- In_Enclosing_Instance --
6235 ---------------------------
6237 function In_Enclosing_Instance return Boolean is
6238 Enclosing_Instance : Node_Id;
6239 Instance_Decl : Node_Id;
6241 begin
6242 -- We do not inline any call that contains instantiations, except
6243 -- for instantiations of Unchecked_Conversion, so if we are within
6244 -- an inlined body the current instance does not require parents.
6246 if In_Inlined_Body then
6247 pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
6248 return False;
6249 end if;
6251 -- Loop to check enclosing scopes
6253 Enclosing_Instance := Current_Scope;
6254 while Present (Enclosing_Instance) loop
6255 Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
6257 if Ekind (Enclosing_Instance) = E_Package
6258 and then Is_Generic_Instance (Enclosing_Instance)
6259 and then Present
6260 (Generic_Parent (Specification (Instance_Decl)))
6261 then
6262 -- Check whether the generic we are looking for is a child of
6263 -- this instance.
6265 E := Find_Generic_Child
6266 (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
6267 exit when Present (E);
6269 else
6270 E := Empty;
6271 end if;
6273 Enclosing_Instance := Scope (Enclosing_Instance);
6274 end loop;
6276 if No (E) then
6278 -- Not a child unit
6280 Analyze (Gen_Id);
6281 return False;
6283 else
6284 Rewrite (Gen_Id,
6285 Make_Expanded_Name (Loc,
6286 Chars => Chars (E),
6287 Prefix => New_Occurrence_Of (Enclosing_Instance, Loc),
6288 Selector_Name => New_Occurrence_Of (E, Loc)));
6290 Set_Entity (Gen_Id, E);
6291 Set_Etype (Gen_Id, Etype (E));
6292 Parent_Installed := False; -- Already in scope.
6293 return True;
6294 end if;
6295 end In_Enclosing_Instance;
6297 -- Start of processing for Check_Generic_Child_Unit
6299 begin
6300 -- If the name of the generic is given by a selected component, it may
6301 -- be the name of a generic child unit, and the prefix is the name of an
6302 -- instance of the parent, in which case the child unit must be visible.
6303 -- If this instance is not in scope, it must be placed there and removed
6304 -- after instantiation, because what is being instantiated is not the
6305 -- original child, but the corresponding child present in the instance
6306 -- of the parent.
6308 -- If the child is instantiated within the parent, it can be given by
6309 -- a simple name. In this case the instance is already in scope, but
6310 -- the child generic must be recovered from the generic parent as well.
6312 if Nkind (Gen_Id) = N_Selected_Component then
6313 S := Selector_Name (Gen_Id);
6314 Analyze (Prefix (Gen_Id));
6315 Inst_Par := Entity (Prefix (Gen_Id));
6317 if Ekind (Inst_Par) = E_Package
6318 and then Present (Renamed_Object (Inst_Par))
6319 then
6320 Inst_Par := Renamed_Object (Inst_Par);
6321 end if;
6323 if Ekind (Inst_Par) = E_Package then
6324 if Nkind (Parent (Inst_Par)) = N_Package_Specification then
6325 Gen_Par := Generic_Parent (Parent (Inst_Par));
6327 elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
6328 and then
6329 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
6330 then
6331 Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
6332 end if;
6334 elsif Ekind (Inst_Par) = E_Generic_Package
6335 and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
6336 then
6337 -- A formal package may be a real child package, and not the
6338 -- implicit instance within a parent. In this case the child is
6339 -- not visible and has to be retrieved explicitly as well.
6341 Gen_Par := Inst_Par;
6342 end if;
6344 if Present (Gen_Par) then
6346 -- The prefix denotes an instantiation. The entity itself may be a
6347 -- nested generic, or a child unit.
6349 E := Find_Generic_Child (Gen_Par, S);
6351 if Present (E) then
6352 Change_Selected_Component_To_Expanded_Name (Gen_Id);
6353 Set_Entity (Gen_Id, E);
6354 Set_Etype (Gen_Id, Etype (E));
6355 Set_Entity (S, E);
6356 Set_Etype (S, Etype (E));
6358 -- Indicate that this is a reference to the parent
6360 if In_Extended_Main_Source_Unit (Gen_Id) then
6361 Set_Is_Instantiated (Inst_Par);
6362 end if;
6364 -- A common mistake is to replicate the naming scheme of a
6365 -- hierarchy by instantiating a generic child directly, rather
6366 -- than the implicit child in a parent instance:
6368 -- generic .. package Gpar is ..
6369 -- generic .. package Gpar.Child is ..
6370 -- package Par is new Gpar ();
6372 -- with Gpar.Child;
6373 -- package Par.Child is new Gpar.Child ();
6374 -- rather than Par.Child
6376 -- In this case the instantiation is within Par, which is an
6377 -- instance, but Gpar does not denote Par because we are not IN
6378 -- the instance of Gpar, so this is illegal. The test below
6379 -- recognizes this particular case.
6381 if Is_Child_Unit (E)
6382 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
6383 and then (not In_Instance
6384 or else Nkind (Parent (Parent (Gen_Id))) =
6385 N_Compilation_Unit)
6386 then
6387 Error_Msg_N
6388 ("prefix of generic child unit must be instance of parent",
6389 Gen_Id);
6390 end if;
6392 if not In_Open_Scopes (Inst_Par)
6393 and then Nkind (Parent (Gen_Id)) not in
6394 N_Generic_Renaming_Declaration
6395 then
6396 Install_Parent (Inst_Par);
6397 Parent_Installed := True;
6399 elsif In_Open_Scopes (Inst_Par) then
6401 -- If the parent is already installed, install the actuals
6402 -- for its formal packages. This is necessary when the child
6403 -- instance is a child of the parent instance: in this case,
6404 -- the parent is placed on the scope stack but the formal
6405 -- packages are not made visible.
6407 Install_Formal_Packages (Inst_Par);
6408 end if;
6410 else
6411 -- If the generic parent does not contain an entity that
6412 -- corresponds to the selector, the instance doesn't either.
6413 -- Analyzing the node will yield the appropriate error message.
6414 -- If the entity is not a child unit, then it is an inner
6415 -- generic in the parent.
6417 Analyze (Gen_Id);
6418 end if;
6420 else
6421 Analyze (Gen_Id);
6423 if Is_Child_Unit (Entity (Gen_Id))
6424 and then
6425 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6426 and then not In_Open_Scopes (Inst_Par)
6427 then
6428 Install_Parent (Inst_Par);
6429 Parent_Installed := True;
6431 -- The generic unit may be the renaming of the implicit child
6432 -- present in an instance. In that case the parent instance is
6433 -- obtained from the name of the renamed entity.
6435 elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
6436 and then Present (Renamed_Entity (Entity (Gen_Id)))
6437 and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
6438 then
6439 declare
6440 Renamed_Package : constant Node_Id :=
6441 Name (Parent (Entity (Gen_Id)));
6442 begin
6443 if Nkind (Renamed_Package) = N_Expanded_Name then
6444 Inst_Par := Entity (Prefix (Renamed_Package));
6445 Install_Parent (Inst_Par);
6446 Parent_Installed := True;
6447 end if;
6448 end;
6449 end if;
6450 end if;
6452 elsif Nkind (Gen_Id) = N_Expanded_Name then
6454 -- Entity already present, analyze prefix, whose meaning may be
6455 -- an instance in the current context. If it is an instance of
6456 -- a relative within another, the proper parent may still have
6457 -- to be installed, if they are not of the same generation.
6459 Analyze (Prefix (Gen_Id));
6461 -- In the unlikely case that a local declaration hides the name
6462 -- of the parent package, locate it on the homonym chain. If the
6463 -- context is an instance of the parent, the renaming entity is
6464 -- flagged as such.
6466 Inst_Par := Entity (Prefix (Gen_Id));
6467 while Present (Inst_Par)
6468 and then not Is_Package_Or_Generic_Package (Inst_Par)
6469 loop
6470 Inst_Par := Homonym (Inst_Par);
6471 end loop;
6473 pragma Assert (Present (Inst_Par));
6474 Set_Entity (Prefix (Gen_Id), Inst_Par);
6476 if In_Enclosing_Instance then
6477 null;
6479 elsif Present (Entity (Gen_Id))
6480 and then Is_Child_Unit (Entity (Gen_Id))
6481 and then not In_Open_Scopes (Inst_Par)
6482 then
6483 Install_Parent (Inst_Par);
6484 Parent_Installed := True;
6485 end if;
6487 elsif In_Enclosing_Instance then
6489 -- The child unit is found in some enclosing scope
6491 null;
6493 else
6494 Analyze (Gen_Id);
6496 -- If this is the renaming of the implicit child in a parent
6497 -- instance, recover the parent name and install it.
6499 if Is_Entity_Name (Gen_Id) then
6500 E := Entity (Gen_Id);
6502 if Is_Generic_Unit (E)
6503 and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
6504 and then Is_Child_Unit (Renamed_Object (E))
6505 and then Is_Generic_Unit (Scope (Renamed_Object (E)))
6506 and then Nkind (Name (Parent (E))) = N_Expanded_Name
6507 then
6508 Rewrite (Gen_Id,
6509 New_Copy_Tree (Name (Parent (E))));
6510 Inst_Par := Entity (Prefix (Gen_Id));
6512 if not In_Open_Scopes (Inst_Par) then
6513 Install_Parent (Inst_Par);
6514 Parent_Installed := True;
6515 end if;
6517 -- If it is a child unit of a non-generic parent, it may be
6518 -- use-visible and given by a direct name. Install parent as
6519 -- for other cases.
6521 elsif Is_Generic_Unit (E)
6522 and then Is_Child_Unit (E)
6523 and then
6524 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6525 and then not Is_Generic_Unit (Scope (E))
6526 then
6527 if not In_Open_Scopes (Scope (E)) then
6528 Install_Parent (Scope (E));
6529 Parent_Installed := True;
6530 end if;
6531 end if;
6532 end if;
6533 end if;
6534 end Check_Generic_Child_Unit;
6536 -----------------------------
6537 -- Check_Hidden_Child_Unit --
6538 -----------------------------
6540 procedure Check_Hidden_Child_Unit
6541 (N : Node_Id;
6542 Gen_Unit : Entity_Id;
6543 Act_Decl_Id : Entity_Id)
6545 Gen_Id : constant Node_Id := Name (N);
6547 begin
6548 if Is_Child_Unit (Gen_Unit)
6549 and then Is_Child_Unit (Act_Decl_Id)
6550 and then Nkind (Gen_Id) = N_Expanded_Name
6551 and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
6552 and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
6553 then
6554 Error_Msg_Node_2 := Scope (Act_Decl_Id);
6555 Error_Msg_NE
6556 ("generic unit & is implicitly declared in &",
6557 Defining_Unit_Name (N), Gen_Unit);
6558 Error_Msg_N ("\instance must have different name",
6559 Defining_Unit_Name (N));
6560 end if;
6561 end Check_Hidden_Child_Unit;
6563 ------------------------
6564 -- Check_Private_View --
6565 ------------------------
6567 procedure Check_Private_View (N : Node_Id) is
6568 T : constant Entity_Id := Etype (N);
6569 BT : Entity_Id;
6571 begin
6572 -- Exchange views if the type was not private in the generic but is
6573 -- private at the point of instantiation. Do not exchange views if
6574 -- the scope of the type is in scope. This can happen if both generic
6575 -- and instance are sibling units, or if type is defined in a parent.
6576 -- In this case the visibility of the type will be correct for all
6577 -- semantic checks.
6579 if Present (T) then
6580 BT := Base_Type (T);
6582 if Is_Private_Type (T)
6583 and then not Has_Private_View (N)
6584 and then Present (Full_View (T))
6585 and then not In_Open_Scopes (Scope (T))
6586 then
6587 -- In the generic, the full type was visible. Save the private
6588 -- entity, for subsequent exchange.
6590 Switch_View (T);
6592 elsif Has_Private_View (N)
6593 and then not Is_Private_Type (T)
6594 and then not Has_Been_Exchanged (T)
6595 and then Etype (Get_Associated_Node (N)) /= T
6596 then
6597 -- Only the private declaration was visible in the generic. If
6598 -- the type appears in a subtype declaration, the subtype in the
6599 -- instance must have a view compatible with that of its parent,
6600 -- which must be exchanged (see corresponding code in Restore_
6601 -- Private_Views). Otherwise, if the type is defined in a parent
6602 -- unit, leave full visibility within instance, which is safe.
6604 if In_Open_Scopes (Scope (Base_Type (T)))
6605 and then not Is_Private_Type (Base_Type (T))
6606 and then Comes_From_Source (Base_Type (T))
6607 then
6608 null;
6610 elsif Nkind (Parent (N)) = N_Subtype_Declaration
6611 or else not In_Private_Part (Scope (Base_Type (T)))
6612 then
6613 Prepend_Elmt (T, Exchanged_Views);
6614 Exchange_Declarations (Etype (Get_Associated_Node (N)));
6615 end if;
6617 -- For composite types with inconsistent representation exchange
6618 -- component types accordingly.
6620 elsif Is_Access_Type (T)
6621 and then Is_Private_Type (Designated_Type (T))
6622 and then not Has_Private_View (N)
6623 and then Present (Full_View (Designated_Type (T)))
6624 then
6625 Switch_View (Designated_Type (T));
6627 elsif Is_Array_Type (T) then
6628 if Is_Private_Type (Component_Type (T))
6629 and then not Has_Private_View (N)
6630 and then Present (Full_View (Component_Type (T)))
6631 then
6632 Switch_View (Component_Type (T));
6633 end if;
6635 -- The normal exchange mechanism relies on the setting of a
6636 -- flag on the reference in the generic. However, an additional
6637 -- mechanism is needed for types that are not explicitly
6638 -- mentioned in the generic, but may be needed in expanded code
6639 -- in the instance. This includes component types of arrays and
6640 -- designated types of access types. This processing must also
6641 -- include the index types of arrays which we take care of here.
6643 declare
6644 Indx : Node_Id;
6645 Typ : Entity_Id;
6647 begin
6648 Indx := First_Index (T);
6649 while Present (Indx) loop
6650 Typ := Base_Type (Etype (Indx));
6652 if Is_Private_Type (Typ)
6653 and then Present (Full_View (Typ))
6654 then
6655 Switch_View (Typ);
6656 end if;
6658 Next_Index (Indx);
6659 end loop;
6660 end;
6662 elsif Is_Private_Type (T)
6663 and then Present (Full_View (T))
6664 and then Is_Array_Type (Full_View (T))
6665 and then Is_Private_Type (Component_Type (Full_View (T)))
6666 then
6667 Switch_View (T);
6669 -- Finally, a non-private subtype may have a private base type, which
6670 -- must be exchanged for consistency. This can happen when a package
6671 -- body is instantiated, when the scope stack is empty but in fact
6672 -- the subtype and the base type are declared in an enclosing scope.
6674 -- Note that in this case we introduce an inconsistency in the view
6675 -- set, because we switch the base type BT, but there could be some
6676 -- private dependent subtypes of BT which remain unswitched. Such
6677 -- subtypes might need to be switched at a later point (see specific
6678 -- provision for that case in Switch_View).
6680 elsif not Is_Private_Type (T)
6681 and then not Has_Private_View (N)
6682 and then Is_Private_Type (BT)
6683 and then Present (Full_View (BT))
6684 and then not Is_Generic_Type (BT)
6685 and then not In_Open_Scopes (BT)
6686 then
6687 Prepend_Elmt (Full_View (BT), Exchanged_Views);
6688 Exchange_Declarations (BT);
6689 end if;
6690 end if;
6691 end Check_Private_View;
6693 -----------------------------
6694 -- Check_Hidden_Primitives --
6695 -----------------------------
6697 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6698 Actual : Node_Id;
6699 Gen_T : Entity_Id;
6700 Result : Elist_Id := No_Elist;
6702 begin
6703 if No (Assoc_List) then
6704 return No_Elist;
6705 end if;
6707 -- Traverse the list of associations between formals and actuals
6708 -- searching for renamings of tagged types
6710 Actual := First (Assoc_List);
6711 while Present (Actual) loop
6712 if Nkind (Actual) = N_Subtype_Declaration then
6713 Gen_T := Generic_Parent_Type (Actual);
6715 if Present (Gen_T)
6716 and then Is_Tagged_Type (Gen_T)
6717 then
6718 -- Traverse the list of primitives of the actual types
6719 -- searching for hidden primitives that are visible in the
6720 -- corresponding generic formal; leave them visible and
6721 -- append them to Result to restore their decoration later.
6723 Install_Hidden_Primitives
6724 (Prims_List => Result,
6725 Gen_T => Gen_T,
6726 Act_T => Entity (Subtype_Indication (Actual)));
6727 end if;
6728 end if;
6730 Next (Actual);
6731 end loop;
6733 return Result;
6734 end Check_Hidden_Primitives;
6736 --------------------------
6737 -- Contains_Instance_Of --
6738 --------------------------
6740 function Contains_Instance_Of
6741 (Inner : Entity_Id;
6742 Outer : Entity_Id;
6743 N : Node_Id) return Boolean
6745 Elmt : Elmt_Id;
6746 Scop : Entity_Id;
6748 begin
6749 Scop := Outer;
6751 -- Verify that there are no circular instantiations. We check whether
6752 -- the unit contains an instance of the current scope or some enclosing
6753 -- scope (in case one of the instances appears in a subunit). Longer
6754 -- circularities involving subunits might seem too pathological to
6755 -- consider, but they were not too pathological for the authors of
6756 -- DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6757 -- enclosing generic scopes as containing an instance.
6759 loop
6760 -- Within a generic subprogram body, the scope is not generic, to
6761 -- allow for recursive subprograms. Use the declaration to determine
6762 -- whether this is a generic unit.
6764 if Ekind (Scop) = E_Generic_Package
6765 or else (Is_Subprogram (Scop)
6766 and then Nkind (Unit_Declaration_Node (Scop)) =
6767 N_Generic_Subprogram_Declaration)
6768 then
6769 Elmt := First_Elmt (Inner_Instances (Inner));
6771 while Present (Elmt) loop
6772 if Node (Elmt) = Scop then
6773 Error_Msg_Node_2 := Inner;
6774 Error_Msg_NE
6775 ("circular Instantiation: & instantiated within &!",
6776 N, Scop);
6777 return True;
6779 elsif Node (Elmt) = Inner then
6780 return True;
6782 elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6783 Error_Msg_Node_2 := Inner;
6784 Error_Msg_NE
6785 ("circular Instantiation: & instantiated within &!",
6786 N, Node (Elmt));
6787 return True;
6788 end if;
6790 Next_Elmt (Elmt);
6791 end loop;
6793 -- Indicate that Inner is being instantiated within Scop
6795 Append_Elmt (Inner, Inner_Instances (Scop));
6796 end if;
6798 if Scop = Standard_Standard then
6799 exit;
6800 else
6801 Scop := Scope (Scop);
6802 end if;
6803 end loop;
6805 return False;
6806 end Contains_Instance_Of;
6808 -----------------------
6809 -- Copy_Generic_Node --
6810 -----------------------
6812 function Copy_Generic_Node
6813 (N : Node_Id;
6814 Parent_Id : Node_Id;
6815 Instantiating : Boolean) return Node_Id
6817 Ent : Entity_Id;
6818 New_N : Node_Id;
6820 function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6821 -- Check the given value of one of the Fields referenced by the current
6822 -- node to determine whether to copy it recursively. The field may hold
6823 -- a Node_Id, a List_Id, or an Elist_Id, or a plain value (Sloc, Uint,
6824 -- Char) in which case it need not be copied.
6826 procedure Copy_Descendants;
6827 -- Common utility for various nodes
6829 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6830 -- Make copy of element list
6832 function Copy_Generic_List
6833 (L : List_Id;
6834 Parent_Id : Node_Id) return List_Id;
6835 -- Apply Copy_Node recursively to the members of a node list
6837 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6838 -- True if an identifier is part of the defining program unit name of
6839 -- a child unit. The entity of such an identifier must be kept (for
6840 -- ASIS use) even though as the name of an enclosing generic it would
6841 -- otherwise not be preserved in the generic tree.
6843 ----------------------
6844 -- Copy_Descendants --
6845 ----------------------
6847 procedure Copy_Descendants is
6849 use Atree.Unchecked_Access;
6850 -- This code section is part of the implementation of an untyped
6851 -- tree traversal, so it needs direct access to node fields.
6853 begin
6854 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6855 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6856 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6857 Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6858 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6859 end Copy_Descendants;
6861 -----------------------------
6862 -- Copy_Generic_Descendant --
6863 -----------------------------
6865 function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6866 begin
6867 if D = Union_Id (Empty) then
6868 return D;
6870 elsif D in Node_Range then
6871 return Union_Id
6872 (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6874 elsif D in List_Range then
6875 return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6877 elsif D in Elist_Range then
6878 return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6880 -- Nothing else is copyable (e.g. Uint values), return as is
6882 else
6883 return D;
6884 end if;
6885 end Copy_Generic_Descendant;
6887 ------------------------
6888 -- Copy_Generic_Elist --
6889 ------------------------
6891 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6892 M : Elmt_Id;
6893 L : Elist_Id;
6895 begin
6896 if Present (E) then
6897 L := New_Elmt_List;
6898 M := First_Elmt (E);
6899 while Present (M) loop
6900 Append_Elmt
6901 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6902 Next_Elmt (M);
6903 end loop;
6905 return L;
6907 else
6908 return No_Elist;
6909 end if;
6910 end Copy_Generic_Elist;
6912 -----------------------
6913 -- Copy_Generic_List --
6914 -----------------------
6916 function Copy_Generic_List
6917 (L : List_Id;
6918 Parent_Id : Node_Id) return List_Id
6920 N : Node_Id;
6921 New_L : List_Id;
6923 begin
6924 if Present (L) then
6925 New_L := New_List;
6926 Set_Parent (New_L, Parent_Id);
6928 N := First (L);
6929 while Present (N) loop
6930 Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6931 Next (N);
6932 end loop;
6934 return New_L;
6936 else
6937 return No_List;
6938 end if;
6939 end Copy_Generic_List;
6941 ---------------------------
6942 -- In_Defining_Unit_Name --
6943 ---------------------------
6945 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6946 begin
6947 return Present (Parent (Nam))
6948 and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6949 or else
6950 (Nkind (Parent (Nam)) = N_Expanded_Name
6951 and then In_Defining_Unit_Name (Parent (Nam))));
6952 end In_Defining_Unit_Name;
6954 -- Start of processing for Copy_Generic_Node
6956 begin
6957 if N = Empty then
6958 return N;
6959 end if;
6961 New_N := New_Copy (N);
6963 -- Copy aspects if present
6965 if Has_Aspects (N) then
6966 Set_Has_Aspects (New_N, False);
6967 Set_Aspect_Specifications
6968 (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6969 end if;
6971 if Instantiating then
6972 Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6973 end if;
6975 if not Is_List_Member (N) then
6976 Set_Parent (New_N, Parent_Id);
6977 end if;
6979 -- If defining identifier, then all fields have been copied already
6981 if Nkind (New_N) in N_Entity then
6982 null;
6984 -- Special casing for identifiers and other entity names and operators
6986 elsif Nkind_In (New_N, N_Identifier,
6987 N_Character_Literal,
6988 N_Expanded_Name,
6989 N_Operator_Symbol)
6990 or else Nkind (New_N) in N_Op
6991 then
6992 if not Instantiating then
6994 -- Link both nodes in order to assign subsequently the entity of
6995 -- the copy to the original node, in case this is a global
6996 -- reference.
6998 Set_Associated_Node (N, New_N);
7000 -- If we are within an instantiation, this is a nested generic
7001 -- that has already been analyzed at the point of definition.
7002 -- We must preserve references that were global to the enclosing
7003 -- parent at that point. Other occurrences, whether global or
7004 -- local to the current generic, must be resolved anew, so we
7005 -- reset the entity in the generic copy. A global reference has a
7006 -- smaller depth than the parent, or else the same depth in case
7007 -- both are distinct compilation units.
7009 -- A child unit is implicitly declared within the enclosing parent
7010 -- but is in fact global to it, and must be preserved.
7012 -- It is also possible for Current_Instantiated_Parent to be
7013 -- defined, and for this not to be a nested generic, namely if
7014 -- the unit is loaded through Rtsfind. In that case, the entity of
7015 -- New_N is only a link to the associated node, and not a defining
7016 -- occurrence.
7018 -- The entities for parent units in the defining_program_unit of a
7019 -- generic child unit are established when the context of the unit
7020 -- is first analyzed, before the generic copy is made. They are
7021 -- preserved in the copy for use in ASIS queries.
7023 Ent := Entity (New_N);
7025 if No (Current_Instantiated_Parent.Gen_Id) then
7026 if No (Ent)
7027 or else Nkind (Ent) /= N_Defining_Identifier
7028 or else not In_Defining_Unit_Name (N)
7029 then
7030 Set_Associated_Node (New_N, Empty);
7031 end if;
7033 elsif No (Ent)
7034 or else
7035 not Nkind_In (Ent, N_Defining_Identifier,
7036 N_Defining_Character_Literal,
7037 N_Defining_Operator_Symbol)
7038 or else No (Scope (Ent))
7039 or else
7040 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
7041 and then not Is_Child_Unit (Ent))
7042 or else
7043 (Scope_Depth (Scope (Ent)) >
7044 Scope_Depth (Current_Instantiated_Parent.Gen_Id)
7045 and then
7046 Get_Source_Unit (Ent) =
7047 Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
7048 then
7049 Set_Associated_Node (New_N, Empty);
7050 end if;
7052 -- Case of instantiating identifier or some other name or operator
7054 else
7055 -- If the associated node is still defined, the entity in it
7056 -- is global, and must be copied to the instance. If this copy
7057 -- is being made for a body to inline, it is applied to an
7058 -- instantiated tree, and the entity is already present and
7059 -- must be also preserved.
7061 declare
7062 Assoc : constant Node_Id := Get_Associated_Node (N);
7064 begin
7065 if Present (Assoc) then
7066 if Nkind (Assoc) = Nkind (N) then
7067 Set_Entity (New_N, Entity (Assoc));
7068 Check_Private_View (N);
7070 -- The name in the call may be a selected component if the
7071 -- call has not been analyzed yet, as may be the case for
7072 -- pre/post conditions in a generic unit.
7074 elsif Nkind (Assoc) = N_Function_Call
7075 and then Is_Entity_Name (Name (Assoc))
7076 then
7077 Set_Entity (New_N, Entity (Name (Assoc)));
7079 elsif Nkind_In (Assoc, N_Defining_Identifier,
7080 N_Defining_Character_Literal,
7081 N_Defining_Operator_Symbol)
7082 and then Expander_Active
7083 then
7084 -- Inlining case: we are copying a tree that contains
7085 -- global entities, which are preserved in the copy to be
7086 -- used for subsequent inlining.
7088 null;
7090 else
7091 Set_Entity (New_N, Empty);
7092 end if;
7093 end if;
7094 end;
7095 end if;
7097 -- For expanded name, we must copy the Prefix and Selector_Name
7099 if Nkind (N) = N_Expanded_Name then
7100 Set_Prefix
7101 (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
7103 Set_Selector_Name (New_N,
7104 Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
7106 -- For operators, we must copy the right operand
7108 elsif Nkind (N) in N_Op then
7109 Set_Right_Opnd (New_N,
7110 Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
7112 -- And for binary operators, the left operand as well
7114 if Nkind (N) in N_Binary_Op then
7115 Set_Left_Opnd (New_N,
7116 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
7117 end if;
7118 end if;
7120 -- Special casing for stubs
7122 elsif Nkind (N) in N_Body_Stub then
7124 -- In any case, we must copy the specification or defining
7125 -- identifier as appropriate.
7127 if Nkind (N) = N_Subprogram_Body_Stub then
7128 Set_Specification (New_N,
7129 Copy_Generic_Node (Specification (N), New_N, Instantiating));
7131 else
7132 Set_Defining_Identifier (New_N,
7133 Copy_Generic_Node
7134 (Defining_Identifier (N), New_N, Instantiating));
7135 end if;
7137 -- If we are not instantiating, then this is where we load and
7138 -- analyze subunits, i.e. at the point where the stub occurs. A
7139 -- more permissive system might defer this analysis to the point
7140 -- of instantiation, but this seems too complicated for now.
7142 if not Instantiating then
7143 declare
7144 Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
7145 Subunit : Node_Id;
7146 Unum : Unit_Number_Type;
7147 New_Body : Node_Id;
7149 begin
7150 -- Make sure that, if it is a subunit of the main unit that is
7151 -- preprocessed and if -gnateG is specified, the preprocessed
7152 -- file will be written.
7154 Lib.Analysing_Subunit_Of_Main :=
7155 Lib.In_Extended_Main_Source_Unit (N);
7156 Unum :=
7157 Load_Unit
7158 (Load_Name => Subunit_Name,
7159 Required => False,
7160 Subunit => True,
7161 Error_Node => N);
7162 Lib.Analysing_Subunit_Of_Main := False;
7164 -- If the proper body is not found, a warning message will be
7165 -- emitted when analyzing the stub, or later at the point of
7166 -- instantiation. Here we just leave the stub as is.
7168 if Unum = No_Unit then
7169 Subunits_Missing := True;
7170 goto Subunit_Not_Found;
7171 end if;
7173 Subunit := Cunit (Unum);
7175 if Nkind (Unit (Subunit)) /= N_Subunit then
7176 Error_Msg_N
7177 ("found child unit instead of expected SEPARATE subunit",
7178 Subunit);
7179 Error_Msg_Sloc := Sloc (N);
7180 Error_Msg_N ("\to complete stub #", Subunit);
7181 goto Subunit_Not_Found;
7182 end if;
7184 -- We must create a generic copy of the subunit, in order to
7185 -- perform semantic analysis on it, and we must replace the
7186 -- stub in the original generic unit with the subunit, in order
7187 -- to preserve non-local references within.
7189 -- Only the proper body needs to be copied. Library_Unit and
7190 -- context clause are simply inherited by the generic copy.
7191 -- Note that the copy (which may be recursive if there are
7192 -- nested subunits) must be done first, before attaching it to
7193 -- the enclosing generic.
7195 New_Body :=
7196 Copy_Generic_Node
7197 (Proper_Body (Unit (Subunit)),
7198 Empty, Instantiating => False);
7200 -- Now place the original proper body in the original generic
7201 -- unit. This is a body, not a compilation unit.
7203 Rewrite (N, Proper_Body (Unit (Subunit)));
7204 Set_Is_Compilation_Unit (Defining_Entity (N), False);
7205 Set_Was_Originally_Stub (N);
7207 -- Finally replace the body of the subunit with its copy, and
7208 -- make this new subunit into the library unit of the generic
7209 -- copy, which does not have stubs any longer.
7211 Set_Proper_Body (Unit (Subunit), New_Body);
7212 Set_Library_Unit (New_N, Subunit);
7213 Inherit_Context (Unit (Subunit), N);
7214 end;
7216 -- If we are instantiating, this must be an error case, since
7217 -- otherwise we would have replaced the stub node by the proper body
7218 -- that corresponds. So just ignore it in the copy (i.e. we have
7219 -- copied it, and that is good enough).
7221 else
7222 null;
7223 end if;
7225 <<Subunit_Not_Found>> null;
7227 -- If the node is a compilation unit, it is the subunit of a stub, which
7228 -- has been loaded already (see code below). In this case, the library
7229 -- unit field of N points to the parent unit (which is a compilation
7230 -- unit) and need not (and cannot) be copied.
7232 -- When the proper body of the stub is analyzed, the library_unit link
7233 -- is used to establish the proper context (see sem_ch10).
7235 -- The other fields of a compilation unit are copied as usual
7237 elsif Nkind (N) = N_Compilation_Unit then
7239 -- This code can only be executed when not instantiating, because in
7240 -- the copy made for an instantiation, the compilation unit node has
7241 -- disappeared at the point that a stub is replaced by its proper
7242 -- body.
7244 pragma Assert (not Instantiating);
7246 Set_Context_Items (New_N,
7247 Copy_Generic_List (Context_Items (N), New_N));
7249 Set_Unit (New_N,
7250 Copy_Generic_Node (Unit (N), New_N, False));
7252 Set_First_Inlined_Subprogram (New_N,
7253 Copy_Generic_Node
7254 (First_Inlined_Subprogram (N), New_N, False));
7256 Set_Aux_Decls_Node (New_N,
7257 Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
7259 -- For an assignment node, the assignment is known to be semantically
7260 -- legal if we are instantiating the template. This avoids incorrect
7261 -- diagnostics in generated code.
7263 elsif Nkind (N) = N_Assignment_Statement then
7265 -- Copy name and expression fields in usual manner
7267 Set_Name (New_N,
7268 Copy_Generic_Node (Name (N), New_N, Instantiating));
7270 Set_Expression (New_N,
7271 Copy_Generic_Node (Expression (N), New_N, Instantiating));
7273 if Instantiating then
7274 Set_Assignment_OK (Name (New_N), True);
7275 end if;
7277 elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
7278 if not Instantiating then
7279 Set_Associated_Node (N, New_N);
7281 else
7282 if Present (Get_Associated_Node (N))
7283 and then Nkind (Get_Associated_Node (N)) = Nkind (N)
7284 then
7285 -- In the generic the aggregate has some composite type. If at
7286 -- the point of instantiation the type has a private view,
7287 -- install the full view (and that of its ancestors, if any).
7289 declare
7290 T : Entity_Id := (Etype (Get_Associated_Node (New_N)));
7291 Rt : Entity_Id;
7293 begin
7294 if Present (T)
7295 and then Is_Private_Type (T)
7296 then
7297 Switch_View (T);
7298 end if;
7300 if Present (T)
7301 and then Is_Tagged_Type (T)
7302 and then Is_Derived_Type (T)
7303 then
7304 Rt := Root_Type (T);
7306 loop
7307 T := Etype (T);
7309 if Is_Private_Type (T) then
7310 Switch_View (T);
7311 end if;
7313 exit when T = Rt;
7314 end loop;
7315 end if;
7316 end;
7317 end if;
7318 end if;
7320 -- Do not copy the associated node, which points to the generic copy
7321 -- of the aggregate.
7323 declare
7324 use Atree.Unchecked_Access;
7325 -- This code section is part of the implementation of an untyped
7326 -- tree traversal, so it needs direct access to node fields.
7328 begin
7329 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
7330 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
7331 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
7332 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
7333 end;
7335 -- Allocators do not have an identifier denoting the access type, so we
7336 -- must locate it through the expression to check whether the views are
7337 -- consistent.
7339 elsif Nkind (N) = N_Allocator
7340 and then Nkind (Expression (N)) = N_Qualified_Expression
7341 and then Is_Entity_Name (Subtype_Mark (Expression (N)))
7342 and then Instantiating
7343 then
7344 declare
7345 T : constant Node_Id :=
7346 Get_Associated_Node (Subtype_Mark (Expression (N)));
7347 Acc_T : Entity_Id;
7349 begin
7350 if Present (T) then
7352 -- Retrieve the allocator node in the generic copy
7354 Acc_T := Etype (Parent (Parent (T)));
7355 if Present (Acc_T)
7356 and then Is_Private_Type (Acc_T)
7357 then
7358 Switch_View (Acc_T);
7359 end if;
7360 end if;
7362 Copy_Descendants;
7363 end;
7365 -- For a proper body, we must catch the case of a proper body that
7366 -- replaces a stub. This represents the point at which a separate
7367 -- compilation unit, and hence template file, may be referenced, so we
7368 -- must make a new source instantiation entry for the template of the
7369 -- subunit, and ensure that all nodes in the subunit are adjusted using
7370 -- this new source instantiation entry.
7372 elsif Nkind (N) in N_Proper_Body then
7373 declare
7374 Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
7376 begin
7377 if Instantiating and then Was_Originally_Stub (N) then
7378 Create_Instantiation_Source
7379 (Instantiation_Node,
7380 Defining_Entity (N),
7381 False,
7382 S_Adjustment);
7383 end if;
7385 -- Now copy the fields of the proper body, using the new
7386 -- adjustment factor if one was needed as per test above.
7388 Copy_Descendants;
7390 -- Restore the original adjustment factor in case changed
7392 S_Adjustment := Save_Adjustment;
7393 end;
7395 -- Don't copy Ident or Comment pragmas, since the comment belongs to the
7396 -- generic unit, not to the instantiating unit.
7398 elsif Nkind (N) = N_Pragma and then Instantiating then
7399 declare
7400 Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
7401 begin
7402 if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
7403 New_N := Make_Null_Statement (Sloc (N));
7404 else
7405 Copy_Descendants;
7406 end if;
7407 end;
7409 elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
7411 -- No descendant fields need traversing
7413 null;
7415 elsif Nkind (N) = N_String_Literal
7416 and then Present (Etype (N))
7417 and then Instantiating
7418 then
7419 -- If the string is declared in an outer scope, the string_literal
7420 -- subtype created for it may have the wrong scope. We force the
7421 -- reanalysis of the constant to generate a new itype in the proper
7422 -- context.
7424 Set_Etype (New_N, Empty);
7425 Set_Analyzed (New_N, False);
7427 -- For the remaining nodes, copy their descendants recursively
7429 else
7430 Copy_Descendants;
7432 if Instantiating and then Nkind (N) = N_Subprogram_Body then
7433 Set_Generic_Parent (Specification (New_N), N);
7435 -- Should preserve Corresponding_Spec??? (12.3(14))
7436 end if;
7437 end if;
7439 return New_N;
7440 end Copy_Generic_Node;
7442 ----------------------------
7443 -- Denotes_Formal_Package --
7444 ----------------------------
7446 function Denotes_Formal_Package
7447 (Pack : Entity_Id;
7448 On_Exit : Boolean := False;
7449 Instance : Entity_Id := Empty) return Boolean
7451 Par : Entity_Id;
7452 Scop : constant Entity_Id := Scope (Pack);
7453 E : Entity_Id;
7455 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
7456 -- The package in question may be an actual for a previous formal
7457 -- package P of the current instance, so examine its actuals as well.
7458 -- This must be recursive over other formal packages.
7460 ----------------------------------
7461 -- Is_Actual_Of_Previous_Formal --
7462 ----------------------------------
7464 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
7465 E1 : Entity_Id;
7467 begin
7468 E1 := First_Entity (P);
7469 while Present (E1) and then E1 /= Instance loop
7470 if Ekind (E1) = E_Package
7471 and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
7472 then
7473 if Renamed_Object (E1) = Pack then
7474 return True;
7476 elsif E1 = P or else Renamed_Object (E1) = P then
7477 return False;
7479 elsif Is_Actual_Of_Previous_Formal (E1) then
7480 return True;
7481 end if;
7482 end if;
7484 Next_Entity (E1);
7485 end loop;
7487 return False;
7488 end Is_Actual_Of_Previous_Formal;
7490 -- Start of processing for Denotes_Formal_Package
7492 begin
7493 if On_Exit then
7494 Par :=
7495 Instance_Envs.Table
7496 (Instance_Envs.Last).Instantiated_Parent.Act_Id;
7497 else
7498 Par := Current_Instantiated_Parent.Act_Id;
7499 end if;
7501 if Ekind (Scop) = E_Generic_Package
7502 or else Nkind (Unit_Declaration_Node (Scop)) =
7503 N_Generic_Subprogram_Declaration
7504 then
7505 return True;
7507 elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
7508 N_Formal_Package_Declaration
7509 then
7510 return True;
7512 elsif No (Par) then
7513 return False;
7515 else
7516 -- Check whether this package is associated with a formal package of
7517 -- the enclosing instantiation. Iterate over the list of renamings.
7519 E := First_Entity (Par);
7520 while Present (E) loop
7521 if Ekind (E) /= E_Package
7522 or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
7523 then
7524 null;
7526 elsif Renamed_Object (E) = Par then
7527 return False;
7529 elsif Renamed_Object (E) = Pack then
7530 return True;
7532 elsif Is_Actual_Of_Previous_Formal (E) then
7533 return True;
7535 end if;
7537 Next_Entity (E);
7538 end loop;
7540 return False;
7541 end if;
7542 end Denotes_Formal_Package;
7544 -----------------
7545 -- End_Generic --
7546 -----------------
7548 procedure End_Generic is
7549 begin
7550 -- ??? More things could be factored out in this routine. Should
7551 -- probably be done at a later stage.
7553 Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
7554 Generic_Flags.Decrement_Last;
7556 Expander_Mode_Restore;
7557 end End_Generic;
7559 -------------
7560 -- Earlier --
7561 -------------
7563 function Earlier (N1, N2 : Node_Id) return Boolean is
7564 procedure Find_Depth (P : in out Node_Id; D : in out Integer);
7565 -- Find distance from given node to enclosing compilation unit
7567 ----------------
7568 -- Find_Depth --
7569 ----------------
7571 procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
7572 begin
7573 while Present (P)
7574 and then Nkind (P) /= N_Compilation_Unit
7575 loop
7576 P := True_Parent (P);
7577 D := D + 1;
7578 end loop;
7579 end Find_Depth;
7581 -- Local declarations
7583 D1 : Integer := 0;
7584 D2 : Integer := 0;
7585 P1 : Node_Id := N1;
7586 P2 : Node_Id := N2;
7587 T1 : Source_Ptr;
7588 T2 : Source_Ptr;
7590 -- Start of processing for Earlier
7592 begin
7593 Find_Depth (P1, D1);
7594 Find_Depth (P2, D2);
7596 if P1 /= P2 then
7597 return False;
7598 else
7599 P1 := N1;
7600 P2 := N2;
7601 end if;
7603 while D1 > D2 loop
7604 P1 := True_Parent (P1);
7605 D1 := D1 - 1;
7606 end loop;
7608 while D2 > D1 loop
7609 P2 := True_Parent (P2);
7610 D2 := D2 - 1;
7611 end loop;
7613 -- At this point P1 and P2 are at the same distance from the root.
7614 -- We examine their parents until we find a common declarative list.
7615 -- If we reach the root, N1 and N2 do not descend from the same
7616 -- declarative list (e.g. one is nested in the declarative part and
7617 -- the other is in a block in the statement part) and the earlier
7618 -- one is already frozen.
7620 while not Is_List_Member (P1)
7621 or else not Is_List_Member (P2)
7622 or else List_Containing (P1) /= List_Containing (P2)
7623 loop
7624 P1 := True_Parent (P1);
7625 P2 := True_Parent (P2);
7627 if Nkind (Parent (P1)) = N_Subunit then
7628 P1 := Corresponding_Stub (Parent (P1));
7629 end if;
7631 if Nkind (Parent (P2)) = N_Subunit then
7632 P2 := Corresponding_Stub (Parent (P2));
7633 end if;
7635 if P1 = P2 then
7636 return False;
7637 end if;
7638 end loop;
7640 -- Expanded code usually shares the source location of the original
7641 -- construct it was generated for. This however may not necessarely
7642 -- reflect the true location of the code within the tree.
7644 -- Before comparing the slocs of the two nodes, make sure that we are
7645 -- working with correct source locations. Assume that P1 is to the left
7646 -- of P2. If either one does not come from source, traverse the common
7647 -- list heading towards the other node and locate the first source
7648 -- statement.
7650 -- P1 P2
7651 -- ----+===+===+--------------+===+===+----
7652 -- expanded code expanded code
7654 if not Comes_From_Source (P1) then
7655 while Present (P1) loop
7657 -- Neither P2 nor a source statement were located during the
7658 -- search. If we reach the end of the list, then P1 does not
7659 -- occur earlier than P2.
7661 -- ---->
7662 -- start --- P2 ----- P1 --- end
7664 if No (Next (P1)) then
7665 return False;
7667 -- We encounter P2 while going to the right of the list. This
7668 -- means that P1 does indeed appear earlier.
7670 -- ---->
7671 -- start --- P1 ===== P2 --- end
7672 -- expanded code in between
7674 elsif P1 = P2 then
7675 return True;
7677 -- No need to look any further since we have located a source
7678 -- statement.
7680 elsif Comes_From_Source (P1) then
7681 exit;
7682 end if;
7684 -- Keep going right
7686 Next (P1);
7687 end loop;
7688 end if;
7690 if not Comes_From_Source (P2) then
7691 while Present (P2) loop
7693 -- Neither P1 nor a source statement were located during the
7694 -- search. If we reach the start of the list, then P1 does not
7695 -- occur earlier than P2.
7697 -- <----
7698 -- start --- P2 --- P1 --- end
7700 if No (Prev (P2)) then
7701 return False;
7703 -- We encounter P1 while going to the left of the list. This
7704 -- means that P1 does indeed appear earlier.
7706 -- <----
7707 -- start --- P1 ===== P2 --- end
7708 -- expanded code in between
7710 elsif P2 = P1 then
7711 return True;
7713 -- No need to look any further since we have located a source
7714 -- statement.
7716 elsif Comes_From_Source (P2) then
7717 exit;
7718 end if;
7720 -- Keep going left
7722 Prev (P2);
7723 end loop;
7724 end if;
7726 -- At this point either both nodes came from source or we approximated
7727 -- their source locations through neighbouring source statements.
7729 T1 := Top_Level_Location (Sloc (P1));
7730 T2 := Top_Level_Location (Sloc (P2));
7732 -- When two nodes come from the same instance, they have identical top
7733 -- level locations. To determine proper relation within the tree, check
7734 -- their locations within the template.
7736 if T1 = T2 then
7737 return Sloc (P1) < Sloc (P2);
7739 -- The two nodes either come from unrelated instances or do not come
7740 -- from instantiated code at all.
7742 else
7743 return T1 < T2;
7744 end if;
7745 end Earlier;
7747 ----------------------
7748 -- Find_Actual_Type --
7749 ----------------------
7751 function Find_Actual_Type
7752 (Typ : Entity_Id;
7753 Gen_Type : Entity_Id) return Entity_Id
7755 Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7756 T : Entity_Id;
7758 begin
7759 -- Special processing only applies to child units
7761 if not Is_Child_Unit (Gen_Scope) then
7762 return Get_Instance_Of (Typ);
7764 -- If designated or component type is itself a formal of the child unit,
7765 -- its instance is available.
7767 elsif Scope (Typ) = Gen_Scope then
7768 return Get_Instance_Of (Typ);
7770 -- If the array or access type is not declared in the parent unit,
7771 -- no special processing needed.
7773 elsif not Is_Generic_Type (Typ)
7774 and then Scope (Gen_Scope) /= Scope (Typ)
7775 then
7776 return Get_Instance_Of (Typ);
7778 -- Otherwise, retrieve designated or component type by visibility
7780 else
7781 T := Current_Entity (Typ);
7782 while Present (T) loop
7783 if In_Open_Scopes (Scope (T)) then
7784 return T;
7786 elsif Is_Generic_Actual_Type (T) then
7787 return T;
7788 end if;
7790 T := Homonym (T);
7791 end loop;
7793 return Typ;
7794 end if;
7795 end Find_Actual_Type;
7797 ----------------------------
7798 -- Freeze_Subprogram_Body --
7799 ----------------------------
7801 procedure Freeze_Subprogram_Body
7802 (Inst_Node : Node_Id;
7803 Gen_Body : Node_Id;
7804 Pack_Id : Entity_Id)
7806 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7807 Par : constant Entity_Id := Scope (Gen_Unit);
7808 E_G_Id : Entity_Id;
7809 Enc_G : Entity_Id;
7810 Enc_I : Node_Id;
7811 F_Node : Node_Id;
7813 function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7814 -- Find innermost package body that encloses the given node, and which
7815 -- is not a compilation unit. Freeze nodes for the instance, or for its
7816 -- enclosing body, may be inserted after the enclosing_body of the
7817 -- generic unit. Used to determine proper placement of freeze node for
7818 -- both package and subprogram instances.
7820 function Package_Freeze_Node (B : Node_Id) return Node_Id;
7821 -- Find entity for given package body, and locate or create a freeze
7822 -- node for it.
7824 ----------------------------
7825 -- Enclosing_Package_Body --
7826 ----------------------------
7828 function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7829 P : Node_Id;
7831 begin
7832 P := Parent (N);
7833 while Present (P)
7834 and then Nkind (Parent (P)) /= N_Compilation_Unit
7835 loop
7836 if Nkind (P) = N_Package_Body then
7837 if Nkind (Parent (P)) = N_Subunit then
7838 return Corresponding_Stub (Parent (P));
7839 else
7840 return P;
7841 end if;
7842 end if;
7844 P := True_Parent (P);
7845 end loop;
7847 return Empty;
7848 end Enclosing_Package_Body;
7850 -------------------------
7851 -- Package_Freeze_Node --
7852 -------------------------
7854 function Package_Freeze_Node (B : Node_Id) return Node_Id is
7855 Id : Entity_Id;
7857 begin
7858 if Nkind (B) = N_Package_Body then
7859 Id := Corresponding_Spec (B);
7860 else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7861 Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7862 end if;
7864 Ensure_Freeze_Node (Id);
7865 return Freeze_Node (Id);
7866 end Package_Freeze_Node;
7868 -- Start of processing of Freeze_Subprogram_Body
7870 begin
7871 -- If the instance and the generic body appear within the same unit, and
7872 -- the instance precedes the generic, the freeze node for the instance
7873 -- must appear after that of the generic. If the generic is nested
7874 -- within another instance I2, then current instance must be frozen
7875 -- after I2. In both cases, the freeze nodes are those of enclosing
7876 -- packages. Otherwise, the freeze node is placed at the end of the
7877 -- current declarative part.
7879 Enc_G := Enclosing_Package_Body (Gen_Body);
7880 Enc_I := Enclosing_Package_Body (Inst_Node);
7881 Ensure_Freeze_Node (Pack_Id);
7882 F_Node := Freeze_Node (Pack_Id);
7884 if Is_Generic_Instance (Par)
7885 and then Present (Freeze_Node (Par))
7886 and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7887 then
7888 -- The parent was a premature instantiation. Insert freeze node at
7889 -- the end the current declarative part.
7891 if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7892 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7894 -- Handle the following case:
7896 -- package Parent_Inst is new ...
7897 -- Parent_Inst []
7899 -- procedure P ... -- this body freezes Parent_Inst
7901 -- package Inst is new ...
7903 -- In this particular scenario, the freeze node for Inst must be
7904 -- inserted in the same manner as that of Parent_Inst - before the
7905 -- next source body or at the end of the declarative list (body not
7906 -- available). If body P did not exist and Parent_Inst was frozen
7907 -- after Inst, either by a body following Inst or at the end of the
7908 -- declarative region, the freeze node for Inst must be inserted
7909 -- after that of Parent_Inst. This relation is established by
7910 -- comparing the Slocs of Parent_Inst freeze node and Inst.
7912 elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7913 List_Containing (Inst_Node)
7914 and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7915 then
7916 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7918 else
7919 Insert_After (Freeze_Node (Par), F_Node);
7920 end if;
7922 -- The body enclosing the instance should be frozen after the body that
7923 -- includes the generic, because the body of the instance may make
7924 -- references to entities therein. If the two are not in the same
7925 -- declarative part, or if the one enclosing the instance is frozen
7926 -- already, freeze the instance at the end of the current declarative
7927 -- part.
7929 elsif Is_Generic_Instance (Par)
7930 and then Present (Freeze_Node (Par))
7931 and then Present (Enc_I)
7932 then
7933 if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7934 or else
7935 (Nkind (Enc_I) = N_Package_Body
7936 and then
7937 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7938 then
7939 -- The enclosing package may contain several instances. Rather
7940 -- than computing the earliest point at which to insert its freeze
7941 -- node, we place it at the end of the declarative part of the
7942 -- parent of the generic.
7944 Insert_Freeze_Node_For_Instance
7945 (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7946 end if;
7948 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7950 elsif Present (Enc_G)
7951 and then Present (Enc_I)
7952 and then Enc_G /= Enc_I
7953 and then Earlier (Inst_Node, Gen_Body)
7954 then
7955 if Nkind (Enc_G) = N_Package_Body then
7956 E_G_Id := Corresponding_Spec (Enc_G);
7957 else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7958 E_G_Id :=
7959 Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7960 end if;
7962 -- Freeze package that encloses instance, and place node after the
7963 -- package that encloses generic. If enclosing package is already
7964 -- frozen we have to assume it is at the proper place. This may be a
7965 -- potential ABE that requires dynamic checking. Do not add a freeze
7966 -- node if the package that encloses the generic is inside the body
7967 -- that encloses the instance, because the freeze node would be in
7968 -- the wrong scope. Additional contortions needed if the bodies are
7969 -- within a subunit.
7971 declare
7972 Enclosing_Body : Node_Id;
7974 begin
7975 if Nkind (Enc_I) = N_Package_Body_Stub then
7976 Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7977 else
7978 Enclosing_Body := Enc_I;
7979 end if;
7981 if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
7982 Insert_Freeze_Node_For_Instance
7983 (Enc_G, Package_Freeze_Node (Enc_I));
7984 end if;
7985 end;
7987 -- Freeze enclosing subunit before instance
7989 Ensure_Freeze_Node (E_G_Id);
7991 if not Is_List_Member (Freeze_Node (E_G_Id)) then
7992 Insert_After (Enc_G, Freeze_Node (E_G_Id));
7993 end if;
7995 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7997 else
7998 -- If none of the above, insert freeze node at the end of the current
7999 -- declarative part.
8001 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
8002 end if;
8003 end Freeze_Subprogram_Body;
8005 ----------------
8006 -- Get_Gen_Id --
8007 ----------------
8009 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
8010 begin
8011 return Generic_Renamings.Table (E).Gen_Id;
8012 end Get_Gen_Id;
8014 ---------------------
8015 -- Get_Instance_Of --
8016 ---------------------
8018 function Get_Instance_Of (A : Entity_Id) return Entity_Id is
8019 Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
8021 begin
8022 if Res /= Assoc_Null then
8023 return Generic_Renamings.Table (Res).Act_Id;
8024 else
8025 -- On exit, entity is not instantiated: not a generic parameter, or
8026 -- else parameter of an inner generic unit.
8028 return A;
8029 end if;
8030 end Get_Instance_Of;
8032 ------------------------------------
8033 -- Get_Package_Instantiation_Node --
8034 ------------------------------------
8036 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
8037 Decl : Node_Id := Unit_Declaration_Node (A);
8038 Inst : Node_Id;
8040 begin
8041 -- If the Package_Instantiation attribute has been set on the package
8042 -- entity, then use it directly when it (or its Original_Node) refers
8043 -- to an N_Package_Instantiation node. In principle it should be
8044 -- possible to have this field set in all cases, which should be
8045 -- investigated, and would allow this function to be significantly
8046 -- simplified. ???
8048 Inst := Package_Instantiation (A);
8050 if Present (Inst) then
8051 if Nkind (Inst) = N_Package_Instantiation then
8052 return Inst;
8054 elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
8055 return Original_Node (Inst);
8056 end if;
8057 end if;
8059 -- If the instantiation is a compilation unit that does not need body
8060 -- then the instantiation node has been rewritten as a package
8061 -- declaration for the instance, and we return the original node.
8063 -- If it is a compilation unit and the instance node has not been
8064 -- rewritten, then it is still the unit of the compilation. Finally, if
8065 -- a body is present, this is a parent of the main unit whose body has
8066 -- been compiled for inlining purposes, and the instantiation node has
8067 -- been rewritten with the instance body.
8069 -- Otherwise the instantiation node appears after the declaration. If
8070 -- the entity is a formal package, the declaration may have been
8071 -- rewritten as a generic declaration (in the case of a formal with box)
8072 -- or left as a formal package declaration if it has actuals, and is
8073 -- found with a forward search.
8075 if Nkind (Parent (Decl)) = N_Compilation_Unit then
8076 if Nkind (Decl) = N_Package_Declaration
8077 and then Present (Corresponding_Body (Decl))
8078 then
8079 Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
8080 end if;
8082 if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
8083 return Original_Node (Decl);
8084 else
8085 return Unit (Parent (Decl));
8086 end if;
8088 elsif Nkind (Decl) = N_Package_Declaration
8089 and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
8090 then
8091 return Original_Node (Decl);
8093 else
8094 Inst := Next (Decl);
8095 while not Nkind_In (Inst, N_Package_Instantiation,
8096 N_Formal_Package_Declaration)
8097 loop
8098 Next (Inst);
8099 end loop;
8101 return Inst;
8102 end if;
8103 end Get_Package_Instantiation_Node;
8105 ------------------------
8106 -- Has_Been_Exchanged --
8107 ------------------------
8109 function Has_Been_Exchanged (E : Entity_Id) return Boolean is
8110 Next : Elmt_Id;
8112 begin
8113 Next := First_Elmt (Exchanged_Views);
8114 while Present (Next) loop
8115 if Full_View (Node (Next)) = E then
8116 return True;
8117 end if;
8119 Next_Elmt (Next);
8120 end loop;
8122 return False;
8123 end Has_Been_Exchanged;
8125 ----------
8126 -- Hash --
8127 ----------
8129 function Hash (F : Entity_Id) return HTable_Range is
8130 begin
8131 return HTable_Range (F mod HTable_Size);
8132 end Hash;
8134 ------------------------
8135 -- Hide_Current_Scope --
8136 ------------------------
8138 procedure Hide_Current_Scope is
8139 C : constant Entity_Id := Current_Scope;
8140 E : Entity_Id;
8142 begin
8143 Set_Is_Hidden_Open_Scope (C);
8145 E := First_Entity (C);
8146 while Present (E) loop
8147 if Is_Immediately_Visible (E) then
8148 Set_Is_Immediately_Visible (E, False);
8149 Append_Elmt (E, Hidden_Entities);
8150 end if;
8152 Next_Entity (E);
8153 end loop;
8155 -- Make the scope name invisible as well. This is necessary, but might
8156 -- conflict with calls to Rtsfind later on, in case the scope is a
8157 -- predefined one. There is no clean solution to this problem, so for
8158 -- now we depend on the user not redefining Standard itself in one of
8159 -- the parent units.
8161 if Is_Immediately_Visible (C) and then C /= Standard_Standard then
8162 Set_Is_Immediately_Visible (C, False);
8163 Append_Elmt (C, Hidden_Entities);
8164 end if;
8166 end Hide_Current_Scope;
8168 --------------
8169 -- Init_Env --
8170 --------------
8172 procedure Init_Env is
8173 Saved : Instance_Env;
8175 begin
8176 Saved.Instantiated_Parent := Current_Instantiated_Parent;
8177 Saved.Exchanged_Views := Exchanged_Views;
8178 Saved.Hidden_Entities := Hidden_Entities;
8179 Saved.Current_Sem_Unit := Current_Sem_Unit;
8180 Saved.Parent_Unit_Visible := Parent_Unit_Visible;
8181 Saved.Instance_Parent_Unit := Instance_Parent_Unit;
8183 -- Save configuration switches. These may be reset if the unit is a
8184 -- predefined unit, and the current mode is not Ada 2005.
8186 Save_Opt_Config_Switches (Saved.Switches);
8188 Instance_Envs.Append (Saved);
8190 Exchanged_Views := New_Elmt_List;
8191 Hidden_Entities := New_Elmt_List;
8193 -- Make dummy entry for Instantiated parent. If generic unit is legal,
8194 -- this is set properly in Set_Instance_Env.
8196 Current_Instantiated_Parent :=
8197 (Current_Scope, Current_Scope, Assoc_Null);
8198 end Init_Env;
8200 ------------------------------
8201 -- In_Same_Declarative_Part --
8202 ------------------------------
8204 function In_Same_Declarative_Part
8205 (F_Node : Node_Id;
8206 Inst : Node_Id) return Boolean
8208 Decls : constant Node_Id := Parent (F_Node);
8209 Nod : Node_Id := Parent (Inst);
8211 begin
8212 while Present (Nod) loop
8213 if Nod = Decls then
8214 return True;
8216 elsif Nkind_In (Nod, N_Subprogram_Body,
8217 N_Package_Body,
8218 N_Package_Declaration,
8219 N_Task_Body,
8220 N_Protected_Body,
8221 N_Block_Statement)
8222 then
8223 return False;
8225 elsif Nkind (Nod) = N_Subunit then
8226 Nod := Corresponding_Stub (Nod);
8228 elsif Nkind (Nod) = N_Compilation_Unit then
8229 return False;
8231 else
8232 Nod := Parent (Nod);
8233 end if;
8234 end loop;
8236 return False;
8237 end In_Same_Declarative_Part;
8239 ---------------------
8240 -- In_Main_Context --
8241 ---------------------
8243 function In_Main_Context (E : Entity_Id) return Boolean is
8244 Context : List_Id;
8245 Clause : Node_Id;
8246 Nam : Node_Id;
8248 begin
8249 if not Is_Compilation_Unit (E)
8250 or else Ekind (E) /= E_Package
8251 or else In_Private_Part (E)
8252 then
8253 return False;
8254 end if;
8256 Context := Context_Items (Cunit (Main_Unit));
8258 Clause := First (Context);
8259 while Present (Clause) loop
8260 if Nkind (Clause) = N_With_Clause then
8261 Nam := Name (Clause);
8263 -- If the current scope is part of the context of the main unit,
8264 -- analysis of the corresponding with_clause is not complete, and
8265 -- the entity is not set. We use the Chars field directly, which
8266 -- might produce false positives in rare cases, but guarantees
8267 -- that we produce all the instance bodies we will need.
8269 if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
8270 or else (Nkind (Nam) = N_Selected_Component
8271 and then Chars (Selector_Name (Nam)) = Chars (E))
8272 then
8273 return True;
8274 end if;
8275 end if;
8277 Next (Clause);
8278 end loop;
8280 return False;
8281 end In_Main_Context;
8283 ---------------------
8284 -- Inherit_Context --
8285 ---------------------
8287 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
8288 Current_Context : List_Id;
8289 Current_Unit : Node_Id;
8290 Item : Node_Id;
8291 New_I : Node_Id;
8293 Clause : Node_Id;
8294 OK : Boolean;
8295 Lib_Unit : Node_Id;
8297 begin
8298 if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
8300 -- The inherited context is attached to the enclosing compilation
8301 -- unit. This is either the main unit, or the declaration for the
8302 -- main unit (in case the instantiation appears within the package
8303 -- declaration and the main unit is its body).
8305 Current_Unit := Parent (Inst);
8306 while Present (Current_Unit)
8307 and then Nkind (Current_Unit) /= N_Compilation_Unit
8308 loop
8309 Current_Unit := Parent (Current_Unit);
8310 end loop;
8312 Current_Context := Context_Items (Current_Unit);
8314 Item := First (Context_Items (Parent (Gen_Decl)));
8315 while Present (Item) loop
8316 if Nkind (Item) = N_With_Clause then
8317 Lib_Unit := Library_Unit (Item);
8319 -- Take care to prevent direct cyclic with's
8321 if Lib_Unit /= Current_Unit then
8323 -- Do not add a unit if it is already in the context
8325 Clause := First (Current_Context);
8326 OK := True;
8327 while Present (Clause) loop
8328 if Nkind (Clause) = N_With_Clause and then
8329 Library_Unit (Clause) = Lib_Unit
8330 then
8331 OK := False;
8332 exit;
8333 end if;
8335 Next (Clause);
8336 end loop;
8338 if OK then
8339 New_I := New_Copy (Item);
8340 Set_Implicit_With (New_I, True);
8341 Set_Implicit_With_From_Instantiation (New_I, True);
8342 Append (New_I, Current_Context);
8343 end if;
8344 end if;
8345 end if;
8347 Next (Item);
8348 end loop;
8349 end if;
8350 end Inherit_Context;
8352 ----------------
8353 -- Initialize --
8354 ----------------
8356 procedure Initialize is
8357 begin
8358 Generic_Renamings.Init;
8359 Instance_Envs.Init;
8360 Generic_Flags.Init;
8361 Generic_Renamings_HTable.Reset;
8362 Circularity_Detected := False;
8363 Exchanged_Views := No_Elist;
8364 Hidden_Entities := No_Elist;
8365 end Initialize;
8367 -------------------------------------
8368 -- Insert_Freeze_Node_For_Instance --
8369 -------------------------------------
8371 procedure Insert_Freeze_Node_For_Instance
8372 (N : Node_Id;
8373 F_Node : Node_Id)
8375 Decl : Node_Id;
8376 Decls : List_Id;
8377 Inst : Entity_Id;
8378 Par_N : Node_Id;
8380 function Enclosing_Body (N : Node_Id) return Node_Id;
8381 -- Find enclosing package or subprogram body, if any. Freeze node may
8382 -- be placed at end of current declarative list if previous instance
8383 -- and current one have different enclosing bodies.
8385 function Previous_Instance (Gen : Entity_Id) return Entity_Id;
8386 -- Find the local instance, if any, that declares the generic that is
8387 -- being instantiated. If present, the freeze node for this instance
8388 -- must follow the freeze node for the previous instance.
8390 --------------------
8391 -- Enclosing_Body --
8392 --------------------
8394 function Enclosing_Body (N : Node_Id) return Node_Id is
8395 P : Node_Id;
8397 begin
8398 P := Parent (N);
8399 while Present (P)
8400 and then Nkind (Parent (P)) /= N_Compilation_Unit
8401 loop
8402 if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
8403 if Nkind (Parent (P)) = N_Subunit then
8404 return Corresponding_Stub (Parent (P));
8405 else
8406 return P;
8407 end if;
8408 end if;
8410 P := True_Parent (P);
8411 end loop;
8413 return Empty;
8414 end Enclosing_Body;
8416 -----------------------
8417 -- Previous_Instance --
8418 -----------------------
8420 function Previous_Instance (Gen : Entity_Id) return Entity_Id is
8421 S : Entity_Id;
8423 begin
8424 S := Scope (Gen);
8425 while Present (S)
8426 and then S /= Standard_Standard
8427 loop
8428 if Is_Generic_Instance (S)
8429 and then In_Same_Source_Unit (S, N)
8430 then
8431 return S;
8432 end if;
8434 S := Scope (S);
8435 end loop;
8437 return Empty;
8438 end Previous_Instance;
8440 -- Start of processing for Insert_Freeze_Node_For_Instance
8442 begin
8443 if not Is_List_Member (F_Node) then
8444 Decl := N;
8445 Decls := List_Containing (N);
8446 Inst := Entity (F_Node);
8447 Par_N := Parent (Decls);
8449 -- When processing a subprogram instantiation, utilize the actual
8450 -- subprogram instantiation rather than its package wrapper as it
8451 -- carries all the context information.
8453 if Is_Wrapper_Package (Inst) then
8454 Inst := Related_Instance (Inst);
8455 end if;
8457 -- If this is a package instance, check whether the generic is
8458 -- declared in a previous instance and the current instance is
8459 -- not within the previous one.
8461 if Present (Generic_Parent (Parent (Inst)))
8462 and then Is_In_Main_Unit (N)
8463 then
8464 declare
8465 Enclosing_N : constant Node_Id := Enclosing_Body (N);
8466 Par_I : constant Entity_Id :=
8467 Previous_Instance
8468 (Generic_Parent (Parent (Inst)));
8469 Scop : Entity_Id;
8471 begin
8472 if Present (Par_I)
8473 and then Earlier (N, Freeze_Node (Par_I))
8474 then
8475 Scop := Scope (Inst);
8477 -- If the current instance is within the one that contains
8478 -- the generic, the freeze node for the current one must
8479 -- appear in the current declarative part. Ditto, if the
8480 -- current instance is within another package instance or
8481 -- within a body that does not enclose the current instance.
8482 -- In these three cases the freeze node of the previous
8483 -- instance is not relevant.
8485 while Present (Scop)
8486 and then Scop /= Standard_Standard
8487 loop
8488 exit when Scop = Par_I
8489 or else
8490 (Is_Generic_Instance (Scop)
8491 and then Scope_Depth (Scop) > Scope_Depth (Par_I));
8492 Scop := Scope (Scop);
8493 end loop;
8495 -- Previous instance encloses current instance
8497 if Scop = Par_I then
8498 null;
8500 -- If the next node is a source body we must freeze in
8501 -- the current scope as well.
8503 elsif Present (Next (N))
8504 and then Nkind_In (Next (N),
8505 N_Subprogram_Body, N_Package_Body)
8506 and then Comes_From_Source (Next (N))
8507 then
8508 null;
8510 -- Current instance is within an unrelated instance
8512 elsif Is_Generic_Instance (Scop) then
8513 null;
8515 -- Current instance is within an unrelated body
8517 elsif Present (Enclosing_N)
8518 and then Enclosing_N /= Enclosing_Body (Par_I)
8519 then
8520 null;
8522 else
8523 Insert_After (Freeze_Node (Par_I), F_Node);
8524 return;
8525 end if;
8526 end if;
8527 end;
8528 end if;
8530 -- When the instantiation occurs in a package declaration, append the
8531 -- freeze node to the private declarations (if any).
8533 if Nkind (Par_N) = N_Package_Specification
8534 and then Decls = Visible_Declarations (Par_N)
8535 and then Present (Private_Declarations (Par_N))
8536 and then not Is_Empty_List (Private_Declarations (Par_N))
8537 then
8538 Decls := Private_Declarations (Par_N);
8539 Decl := First (Decls);
8540 end if;
8542 -- Determine the proper freeze point of a package instantiation. We
8543 -- adhere to the general rule of a package or subprogram body causing
8544 -- freezing of anything before it in the same declarative region. In
8545 -- this case, the proper freeze point of a package instantiation is
8546 -- before the first source body which follows, or before a stub. This
8547 -- ensures that entities coming from the instance are already frozen
8548 -- and usable in source bodies.
8550 if Nkind (Par_N) /= N_Package_Declaration
8551 and then Ekind (Inst) = E_Package
8552 and then Is_Generic_Instance (Inst)
8553 and then
8554 not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
8555 then
8556 while Present (Decl) loop
8557 if (Nkind (Decl) in N_Unit_Body
8558 or else
8559 Nkind (Decl) in N_Body_Stub)
8560 and then Comes_From_Source (Decl)
8561 then
8562 Insert_Before (Decl, F_Node);
8563 return;
8564 end if;
8566 Next (Decl);
8567 end loop;
8568 end if;
8570 -- In a package declaration, or if no previous body, insert at end
8571 -- of list.
8573 Set_Sloc (F_Node, Sloc (Last (Decls)));
8574 Insert_After (Last (Decls), F_Node);
8575 end if;
8576 end Insert_Freeze_Node_For_Instance;
8578 ------------------
8579 -- Install_Body --
8580 ------------------
8582 procedure Install_Body
8583 (Act_Body : Node_Id;
8584 N : Node_Id;
8585 Gen_Body : Node_Id;
8586 Gen_Decl : Node_Id)
8588 Act_Id : constant Entity_Id := Corresponding_Spec (Act_Body);
8589 Act_Unit : constant Node_Id := Unit (Cunit (Get_Source_Unit (N)));
8590 Gen_Id : constant Entity_Id := Corresponding_Spec (Gen_Body);
8591 Par : constant Entity_Id := Scope (Gen_Id);
8592 Gen_Unit : constant Node_Id :=
8593 Unit (Cunit (Get_Source_Unit (Gen_Decl)));
8594 Orig_Body : Node_Id := Gen_Body;
8595 F_Node : Node_Id;
8596 Body_Unit : Node_Id;
8598 Must_Delay : Boolean;
8600 function In_Same_Enclosing_Subp return Boolean;
8601 -- Check whether instance and generic body are within same subprogram.
8603 function True_Sloc (N : Node_Id) return Source_Ptr;
8604 -- If the instance is nested inside a generic unit, the Sloc of the
8605 -- instance indicates the place of the original definition, not the
8606 -- point of the current enclosing instance. Pending a better usage of
8607 -- Slocs to indicate instantiation places, we determine the place of
8608 -- origin of a node by finding the maximum sloc of any ancestor node.
8609 -- Why is this not equivalent to Top_Level_Location ???
8611 ----------------------------
8612 -- In_Same_Enclosing_Subp --
8613 ----------------------------
8615 function In_Same_Enclosing_Subp return Boolean is
8616 Scop : Entity_Id;
8617 Subp : Entity_Id;
8619 begin
8620 Scop := Scope (Act_Id);
8621 while Scop /= Standard_Standard
8622 and then not Is_Overloadable (Scop)
8623 loop
8624 Scop := Scope (Scop);
8625 end loop;
8627 if Scop = Standard_Standard then
8628 return False;
8629 else
8630 Subp := Scop;
8631 end if;
8633 Scop := Scope (Gen_Id);
8634 while Scop /= Standard_Standard loop
8635 if Scop = Subp then
8636 return True;
8637 else
8638 Scop := Scope (Scop);
8639 end if;
8640 end loop;
8642 return False;
8643 end In_Same_Enclosing_Subp;
8645 ---------------
8646 -- True_Sloc --
8647 ---------------
8649 function True_Sloc (N : Node_Id) return Source_Ptr is
8650 Res : Source_Ptr;
8651 N1 : Node_Id;
8653 begin
8654 Res := Sloc (N);
8655 N1 := N;
8656 while Present (N1) and then N1 /= Act_Unit loop
8657 if Sloc (N1) > Res then
8658 Res := Sloc (N1);
8659 end if;
8661 N1 := Parent (N1);
8662 end loop;
8664 return Res;
8665 end True_Sloc;
8667 -- Start of processing for Install_Body
8669 begin
8670 -- If the body is a subunit, the freeze point is the corresponding stub
8671 -- in the current compilation, not the subunit itself.
8673 if Nkind (Parent (Gen_Body)) = N_Subunit then
8674 Orig_Body := Corresponding_Stub (Parent (Gen_Body));
8675 else
8676 Orig_Body := Gen_Body;
8677 end if;
8679 Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8681 -- If the instantiation and the generic definition appear in the same
8682 -- package declaration, this is an early instantiation. If they appear
8683 -- in the same declarative part, it is an early instantiation only if
8684 -- the generic body appears textually later, and the generic body is
8685 -- also in the main unit.
8687 -- If instance is nested within a subprogram, and the generic body
8688 -- is not, the instance is delayed because the enclosing body is. If
8689 -- instance and body are within the same scope, or the same subprogram
8690 -- body, indicate explicitly that the instance is delayed.
8692 Must_Delay :=
8693 (Gen_Unit = Act_Unit
8694 and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8695 N_Generic_Package_Declaration)
8696 or else (Gen_Unit = Body_Unit
8697 and then True_Sloc (N) < Sloc (Orig_Body)))
8698 and then Is_In_Main_Unit (Gen_Unit)
8699 and then (Scope (Act_Id) = Scope (Gen_Id)
8700 or else In_Same_Enclosing_Subp));
8702 -- If this is an early instantiation, the freeze node is placed after
8703 -- the generic body. Otherwise, if the generic appears in an instance,
8704 -- we cannot freeze the current instance until the outer one is frozen.
8705 -- This is only relevant if the current instance is nested within some
8706 -- inner scope not itself within the outer instance. If this scope is
8707 -- a package body in the same declarative part as the outer instance,
8708 -- then that body needs to be frozen after the outer instance. Finally,
8709 -- if no delay is needed, we place the freeze node at the end of the
8710 -- current declarative part.
8712 if Expander_Active then
8713 Ensure_Freeze_Node (Act_Id);
8714 F_Node := Freeze_Node (Act_Id);
8716 if Must_Delay then
8717 Insert_After (Orig_Body, F_Node);
8719 elsif Is_Generic_Instance (Par)
8720 and then Present (Freeze_Node (Par))
8721 and then Scope (Act_Id) /= Par
8722 then
8723 -- Freeze instance of inner generic after instance of enclosing
8724 -- generic.
8726 if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8728 -- Handle the following case:
8730 -- package Parent_Inst is new ...
8731 -- Parent_Inst []
8733 -- procedure P ... -- this body freezes Parent_Inst
8735 -- package Inst is new ...
8737 -- In this particular scenario, the freeze node for Inst must
8738 -- be inserted in the same manner as that of Parent_Inst,
8739 -- before the next source body or at the end of the declarative
8740 -- list (body not available). If body P did not exist and
8741 -- Parent_Inst was frozen after Inst, either by a body
8742 -- following Inst or at the end of the declarative region,
8743 -- the freeze node for Inst must be inserted after that of
8744 -- Parent_Inst. This relation is established by comparing
8745 -- the Slocs of Parent_Inst freeze node and Inst.
8747 if List_Containing (Get_Package_Instantiation_Node (Par)) =
8748 List_Containing (N)
8749 and then Sloc (Freeze_Node (Par)) < Sloc (N)
8750 then
8751 Insert_Freeze_Node_For_Instance (N, F_Node);
8752 else
8753 Insert_After (Freeze_Node (Par), F_Node);
8754 end if;
8756 -- Freeze package enclosing instance of inner generic after
8757 -- instance of enclosing generic.
8759 elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8760 and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8761 then
8762 declare
8763 Enclosing : Entity_Id;
8765 begin
8766 Enclosing := Corresponding_Spec (Parent (N));
8768 if No (Enclosing) then
8769 Enclosing := Defining_Entity (Parent (N));
8770 end if;
8772 Insert_Freeze_Node_For_Instance (N, F_Node);
8773 Ensure_Freeze_Node (Enclosing);
8775 if not Is_List_Member (Freeze_Node (Enclosing)) then
8777 -- The enclosing context is a subunit, insert the freeze
8778 -- node after the stub.
8780 if Nkind (Parent (Parent (N))) = N_Subunit then
8781 Insert_Freeze_Node_For_Instance
8782 (Corresponding_Stub (Parent (Parent (N))),
8783 Freeze_Node (Enclosing));
8785 -- The enclosing context is a package with a stub body
8786 -- which has already been replaced by the real body.
8787 -- Insert the freeze node after the actual body.
8789 elsif Ekind (Enclosing) = E_Package
8790 and then Present (Body_Entity (Enclosing))
8791 and then Was_Originally_Stub
8792 (Parent (Body_Entity (Enclosing)))
8793 then
8794 Insert_Freeze_Node_For_Instance
8795 (Parent (Body_Entity (Enclosing)),
8796 Freeze_Node (Enclosing));
8798 -- The parent instance has been frozen before the body of
8799 -- the enclosing package, insert the freeze node after
8800 -- the body.
8802 elsif List_Containing (Freeze_Node (Par)) =
8803 List_Containing (Parent (N))
8804 and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8805 then
8806 Insert_Freeze_Node_For_Instance
8807 (Parent (N), Freeze_Node (Enclosing));
8809 else
8810 Insert_After
8811 (Freeze_Node (Par), Freeze_Node (Enclosing));
8812 end if;
8813 end if;
8814 end;
8816 else
8817 Insert_Freeze_Node_For_Instance (N, F_Node);
8818 end if;
8820 else
8821 Insert_Freeze_Node_For_Instance (N, F_Node);
8822 end if;
8823 end if;
8825 Set_Is_Frozen (Act_Id);
8826 Insert_Before (N, Act_Body);
8827 Mark_Rewrite_Insertion (Act_Body);
8828 end Install_Body;
8830 -----------------------------
8831 -- Install_Formal_Packages --
8832 -----------------------------
8834 procedure Install_Formal_Packages (Par : Entity_Id) is
8835 E : Entity_Id;
8836 Gen : Entity_Id;
8837 Gen_E : Entity_Id := Empty;
8839 begin
8840 E := First_Entity (Par);
8842 -- If we are installing an instance parent, locate the formal packages
8843 -- of its generic parent.
8845 if Is_Generic_Instance (Par) then
8846 Gen := Generic_Parent (Package_Specification (Par));
8847 Gen_E := First_Entity (Gen);
8848 end if;
8850 while Present (E) loop
8851 if Ekind (E) = E_Package
8852 and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8853 then
8854 -- If this is the renaming for the parent instance, done
8856 if Renamed_Object (E) = Par then
8857 exit;
8859 -- The visibility of a formal of an enclosing generic is already
8860 -- correct.
8862 elsif Denotes_Formal_Package (E) then
8863 null;
8865 elsif Present (Associated_Formal_Package (E)) then
8866 Check_Generic_Actuals (Renamed_Object (E), True);
8867 Set_Is_Hidden (E, False);
8869 -- Find formal package in generic unit that corresponds to
8870 -- (instance of) formal package in instance.
8872 while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8873 Next_Entity (Gen_E);
8874 end loop;
8876 if Present (Gen_E) then
8877 Map_Formal_Package_Entities (Gen_E, E);
8878 end if;
8879 end if;
8880 end if;
8882 Next_Entity (E);
8883 if Present (Gen_E) then
8884 Next_Entity (Gen_E);
8885 end if;
8886 end loop;
8887 end Install_Formal_Packages;
8889 --------------------
8890 -- Install_Parent --
8891 --------------------
8893 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8894 Ancestors : constant Elist_Id := New_Elmt_List;
8895 S : constant Entity_Id := Current_Scope;
8896 Inst_Par : Entity_Id;
8897 First_Par : Entity_Id;
8898 Inst_Node : Node_Id;
8899 Gen_Par : Entity_Id;
8900 First_Gen : Entity_Id;
8901 Elmt : Elmt_Id;
8903 procedure Install_Noninstance_Specs (Par : Entity_Id);
8904 -- Install the scopes of noninstance parent units ending with Par
8906 procedure Install_Spec (Par : Entity_Id);
8907 -- The child unit is within the declarative part of the parent, so the
8908 -- declarations within the parent are immediately visible.
8910 -------------------------------
8911 -- Install_Noninstance_Specs --
8912 -------------------------------
8914 procedure Install_Noninstance_Specs (Par : Entity_Id) is
8915 begin
8916 if Present (Par)
8917 and then Par /= Standard_Standard
8918 and then not In_Open_Scopes (Par)
8919 then
8920 Install_Noninstance_Specs (Scope (Par));
8921 Install_Spec (Par);
8922 end if;
8923 end Install_Noninstance_Specs;
8925 ------------------
8926 -- Install_Spec --
8927 ------------------
8929 procedure Install_Spec (Par : Entity_Id) is
8930 Spec : constant Node_Id := Package_Specification (Par);
8932 begin
8933 -- If this parent of the child instance is a top-level unit,
8934 -- then record the unit and its visibility for later resetting in
8935 -- Remove_Parent. We exclude units that are generic instances, as we
8936 -- only want to record this information for the ultimate top-level
8937 -- noninstance parent (is that always correct???).
8939 if Scope (Par) = Standard_Standard
8940 and then not Is_Generic_Instance (Par)
8941 then
8942 Parent_Unit_Visible := Is_Immediately_Visible (Par);
8943 Instance_Parent_Unit := Par;
8944 end if;
8946 -- Open the parent scope and make it and its declarations visible.
8947 -- If this point is not within a body, then only the visible
8948 -- declarations should be made visible, and installation of the
8949 -- private declarations is deferred until the appropriate point
8950 -- within analysis of the spec being instantiated (see the handling
8951 -- of parent visibility in Analyze_Package_Specification). This is
8952 -- relaxed in the case where the parent unit is Ada.Tags, to avoid
8953 -- private view problems that occur when compiling instantiations of
8954 -- a generic child of that package (Generic_Dispatching_Constructor).
8955 -- If the instance freezes a tagged type, inlinings of operations
8956 -- from Ada.Tags may need the full view of type Tag. If inlining took
8957 -- proper account of establishing visibility of inlined subprograms'
8958 -- parents then it should be possible to remove this
8959 -- special check. ???
8961 Push_Scope (Par);
8962 Set_Is_Immediately_Visible (Par);
8963 Install_Visible_Declarations (Par);
8964 Set_Use (Visible_Declarations (Spec));
8966 if In_Body or else Is_RTU (Par, Ada_Tags) then
8967 Install_Private_Declarations (Par);
8968 Set_Use (Private_Declarations (Spec));
8969 end if;
8970 end Install_Spec;
8972 -- Start of processing for Install_Parent
8974 begin
8975 -- We need to install the parent instance to compile the instantiation
8976 -- of the child, but the child instance must appear in the current
8977 -- scope. Given that we cannot place the parent above the current scope
8978 -- in the scope stack, we duplicate the current scope and unstack both
8979 -- after the instantiation is complete.
8981 -- If the parent is itself the instantiation of a child unit, we must
8982 -- also stack the instantiation of its parent, and so on. Each such
8983 -- ancestor is the prefix of the name in a prior instantiation.
8985 -- If this is a nested instance, the parent unit itself resolves to
8986 -- a renaming of the parent instance, whose declaration we need.
8988 -- Finally, the parent may be a generic (not an instance) when the
8989 -- child unit appears as a formal package.
8991 Inst_Par := P;
8993 if Present (Renamed_Entity (Inst_Par)) then
8994 Inst_Par := Renamed_Entity (Inst_Par);
8995 end if;
8997 First_Par := Inst_Par;
8999 Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
9001 First_Gen := Gen_Par;
9003 while Present (Gen_Par)
9004 and then Is_Child_Unit (Gen_Par)
9005 loop
9006 -- Load grandparent instance as well
9008 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
9010 if Nkind (Name (Inst_Node)) = N_Expanded_Name then
9011 Inst_Par := Entity (Prefix (Name (Inst_Node)));
9013 if Present (Renamed_Entity (Inst_Par)) then
9014 Inst_Par := Renamed_Entity (Inst_Par);
9015 end if;
9017 Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
9019 if Present (Gen_Par) then
9020 Prepend_Elmt (Inst_Par, Ancestors);
9022 else
9023 -- Parent is not the name of an instantiation
9025 Install_Noninstance_Specs (Inst_Par);
9026 exit;
9027 end if;
9029 else
9030 -- Previous error
9032 exit;
9033 end if;
9034 end loop;
9036 if Present (First_Gen) then
9037 Append_Elmt (First_Par, Ancestors);
9038 else
9039 Install_Noninstance_Specs (First_Par);
9040 end if;
9042 if not Is_Empty_Elmt_List (Ancestors) then
9043 Elmt := First_Elmt (Ancestors);
9044 while Present (Elmt) loop
9045 Install_Spec (Node (Elmt));
9046 Install_Formal_Packages (Node (Elmt));
9047 Next_Elmt (Elmt);
9048 end loop;
9049 end if;
9051 if not In_Body then
9052 Push_Scope (S);
9053 end if;
9054 end Install_Parent;
9056 -------------------------------
9057 -- Install_Hidden_Primitives --
9058 -------------------------------
9060 procedure Install_Hidden_Primitives
9061 (Prims_List : in out Elist_Id;
9062 Gen_T : Entity_Id;
9063 Act_T : Entity_Id)
9065 Elmt : Elmt_Id;
9066 List : Elist_Id := No_Elist;
9067 Prim_G_Elmt : Elmt_Id;
9068 Prim_A_Elmt : Elmt_Id;
9069 Prim_G : Node_Id;
9070 Prim_A : Node_Id;
9072 begin
9073 -- No action needed in case of serious errors because we cannot trust
9074 -- in the order of primitives
9076 if Serious_Errors_Detected > 0 then
9077 return;
9079 -- No action possible if we don't have available the list of primitive
9080 -- operations
9082 elsif No (Gen_T)
9083 or else not Is_Record_Type (Gen_T)
9084 or else not Is_Tagged_Type (Gen_T)
9085 or else not Is_Record_Type (Act_T)
9086 or else not Is_Tagged_Type (Act_T)
9087 then
9088 return;
9090 -- There is no need to handle interface types since their primitives
9091 -- cannot be hidden
9093 elsif Is_Interface (Gen_T) then
9094 return;
9095 end if;
9097 Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
9099 if not Is_Class_Wide_Type (Act_T) then
9100 Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
9101 else
9102 Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
9103 end if;
9105 loop
9106 -- Skip predefined primitives in the generic formal
9108 while Present (Prim_G_Elmt)
9109 and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
9110 loop
9111 Next_Elmt (Prim_G_Elmt);
9112 end loop;
9114 -- Skip predefined primitives in the generic actual
9116 while Present (Prim_A_Elmt)
9117 and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
9118 loop
9119 Next_Elmt (Prim_A_Elmt);
9120 end loop;
9122 exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
9124 Prim_G := Node (Prim_G_Elmt);
9125 Prim_A := Node (Prim_A_Elmt);
9127 -- There is no need to handle interface primitives because their
9128 -- primitives are not hidden
9130 exit when Present (Interface_Alias (Prim_G));
9132 -- Here we install one hidden primitive
9134 if Chars (Prim_G) /= Chars (Prim_A)
9135 and then Has_Suffix (Prim_A, 'P')
9136 and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
9137 then
9138 Set_Chars (Prim_A, Chars (Prim_G));
9139 Append_New_Elmt (Prim_A, To => List);
9140 end if;
9142 Next_Elmt (Prim_A_Elmt);
9143 Next_Elmt (Prim_G_Elmt);
9144 end loop;
9146 -- Append the elements to the list of temporarily visible primitives
9147 -- avoiding duplicates.
9149 if Present (List) then
9150 if No (Prims_List) then
9151 Prims_List := New_Elmt_List;
9152 end if;
9154 Elmt := First_Elmt (List);
9155 while Present (Elmt) loop
9156 Append_Unique_Elmt (Node (Elmt), Prims_List);
9157 Next_Elmt (Elmt);
9158 end loop;
9159 end if;
9160 end Install_Hidden_Primitives;
9162 -------------------------------
9163 -- Restore_Hidden_Primitives --
9164 -------------------------------
9166 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
9167 Prim_Elmt : Elmt_Id;
9168 Prim : Node_Id;
9170 begin
9171 if Prims_List /= No_Elist then
9172 Prim_Elmt := First_Elmt (Prims_List);
9173 while Present (Prim_Elmt) loop
9174 Prim := Node (Prim_Elmt);
9175 Set_Chars (Prim, Add_Suffix (Prim, 'P'));
9176 Next_Elmt (Prim_Elmt);
9177 end loop;
9179 Prims_List := No_Elist;
9180 end if;
9181 end Restore_Hidden_Primitives;
9183 --------------------------------
9184 -- Instantiate_Formal_Package --
9185 --------------------------------
9187 function Instantiate_Formal_Package
9188 (Formal : Node_Id;
9189 Actual : Node_Id;
9190 Analyzed_Formal : Node_Id) return List_Id
9192 Loc : constant Source_Ptr := Sloc (Actual);
9193 Actual_Pack : Entity_Id;
9194 Formal_Pack : Entity_Id;
9195 Gen_Parent : Entity_Id;
9196 Decls : List_Id;
9197 Nod : Node_Id;
9198 Parent_Spec : Node_Id;
9200 procedure Find_Matching_Actual
9201 (F : Node_Id;
9202 Act : in out Entity_Id);
9203 -- We need to associate each formal entity in the formal package with
9204 -- the corresponding entity in the actual package. The actual package
9205 -- has been analyzed and possibly expanded, and as a result there is
9206 -- no one-to-one correspondence between the two lists (for example,
9207 -- the actual may include subtypes, itypes, and inherited primitive
9208 -- operations, interspersed among the renaming declarations for the
9209 -- actuals) . We retrieve the corresponding actual by name because each
9210 -- actual has the same name as the formal, and they do appear in the
9211 -- same order.
9213 function Get_Formal_Entity (N : Node_Id) return Entity_Id;
9214 -- Retrieve entity of defining entity of generic formal parameter.
9215 -- Only the declarations of formals need to be considered when
9216 -- linking them to actuals, but the declarative list may include
9217 -- internal entities generated during analysis, and those are ignored.
9219 procedure Match_Formal_Entity
9220 (Formal_Node : Node_Id;
9221 Formal_Ent : Entity_Id;
9222 Actual_Ent : Entity_Id);
9223 -- Associates the formal entity with the actual. In the case where
9224 -- Formal_Ent is a formal package, this procedure iterates through all
9225 -- of its formals and enters associations between the actuals occurring
9226 -- in the formal package's corresponding actual package (given by
9227 -- Actual_Ent) and the formal package's formal parameters. This
9228 -- procedure recurses if any of the parameters is itself a package.
9230 function Is_Instance_Of
9231 (Act_Spec : Entity_Id;
9232 Gen_Anc : Entity_Id) return Boolean;
9233 -- The actual can be an instantiation of a generic within another
9234 -- instance, in which case there is no direct link from it to the
9235 -- original generic ancestor. In that case, we recognize that the
9236 -- ultimate ancestor is the same by examining names and scopes.
9238 procedure Process_Nested_Formal (Formal : Entity_Id);
9239 -- If the current formal is declared with a box, its own formals are
9240 -- visible in the instance, as they were in the generic, and their
9241 -- Hidden flag must be reset. If some of these formals are themselves
9242 -- packages declared with a box, the processing must be recursive.
9244 --------------------------
9245 -- Find_Matching_Actual --
9246 --------------------------
9248 procedure Find_Matching_Actual
9249 (F : Node_Id;
9250 Act : in out Entity_Id)
9252 Formal_Ent : Entity_Id;
9254 begin
9255 case Nkind (Original_Node (F)) is
9256 when N_Formal_Object_Declaration |
9257 N_Formal_Type_Declaration =>
9258 Formal_Ent := Defining_Identifier (F);
9260 while Chars (Act) /= Chars (Formal_Ent) loop
9261 Next_Entity (Act);
9262 end loop;
9264 when N_Formal_Subprogram_Declaration |
9265 N_Formal_Package_Declaration |
9266 N_Package_Declaration |
9267 N_Generic_Package_Declaration =>
9268 Formal_Ent := Defining_Entity (F);
9270 while Chars (Act) /= Chars (Formal_Ent) loop
9271 Next_Entity (Act);
9272 end loop;
9274 when others =>
9275 raise Program_Error;
9276 end case;
9277 end Find_Matching_Actual;
9279 -------------------------
9280 -- Match_Formal_Entity --
9281 -------------------------
9283 procedure Match_Formal_Entity
9284 (Formal_Node : Node_Id;
9285 Formal_Ent : Entity_Id;
9286 Actual_Ent : Entity_Id)
9288 Act_Pkg : Entity_Id;
9290 begin
9291 Set_Instance_Of (Formal_Ent, Actual_Ent);
9293 if Ekind (Actual_Ent) = E_Package then
9295 -- Record associations for each parameter
9297 Act_Pkg := Actual_Ent;
9299 declare
9300 A_Ent : Entity_Id := First_Entity (Act_Pkg);
9301 F_Ent : Entity_Id;
9302 F_Node : Node_Id;
9304 Gen_Decl : Node_Id;
9305 Formals : List_Id;
9306 Actual : Entity_Id;
9308 begin
9309 -- Retrieve the actual given in the formal package declaration
9311 Actual := Entity (Name (Original_Node (Formal_Node)));
9313 -- The actual in the formal package declaration may be a
9314 -- renamed generic package, in which case we want to retrieve
9315 -- the original generic in order to traverse its formal part.
9317 if Present (Renamed_Entity (Actual)) then
9318 Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
9319 else
9320 Gen_Decl := Unit_Declaration_Node (Actual);
9321 end if;
9323 Formals := Generic_Formal_Declarations (Gen_Decl);
9325 if Present (Formals) then
9326 F_Node := First_Non_Pragma (Formals);
9327 else
9328 F_Node := Empty;
9329 end if;
9331 while Present (A_Ent)
9332 and then Present (F_Node)
9333 and then A_Ent /= First_Private_Entity (Act_Pkg)
9334 loop
9335 F_Ent := Get_Formal_Entity (F_Node);
9337 if Present (F_Ent) then
9339 -- This is a formal of the original package. Record
9340 -- association and recurse.
9342 Find_Matching_Actual (F_Node, A_Ent);
9343 Match_Formal_Entity (F_Node, F_Ent, A_Ent);
9344 Next_Entity (A_Ent);
9345 end if;
9347 Next_Non_Pragma (F_Node);
9348 end loop;
9349 end;
9350 end if;
9351 end Match_Formal_Entity;
9353 -----------------------
9354 -- Get_Formal_Entity --
9355 -----------------------
9357 function Get_Formal_Entity (N : Node_Id) return Entity_Id is
9358 Kind : constant Node_Kind := Nkind (Original_Node (N));
9359 begin
9360 case Kind is
9361 when N_Formal_Object_Declaration =>
9362 return Defining_Identifier (N);
9364 when N_Formal_Type_Declaration =>
9365 return Defining_Identifier (N);
9367 when N_Formal_Subprogram_Declaration =>
9368 return Defining_Unit_Name (Specification (N));
9370 when N_Formal_Package_Declaration =>
9371 return Defining_Identifier (Original_Node (N));
9373 when N_Generic_Package_Declaration =>
9374 return Defining_Identifier (Original_Node (N));
9376 -- All other declarations are introduced by semantic analysis and
9377 -- have no match in the actual.
9379 when others =>
9380 return Empty;
9381 end case;
9382 end Get_Formal_Entity;
9384 --------------------
9385 -- Is_Instance_Of --
9386 --------------------
9388 function Is_Instance_Of
9389 (Act_Spec : Entity_Id;
9390 Gen_Anc : Entity_Id) return Boolean
9392 Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
9394 begin
9395 if No (Gen_Par) then
9396 return False;
9398 -- Simplest case: the generic parent of the actual is the formal
9400 elsif Gen_Par = Gen_Anc then
9401 return True;
9403 elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
9404 return False;
9406 -- The actual may be obtained through several instantiations. Its
9407 -- scope must itself be an instance of a generic declared in the
9408 -- same scope as the formal. Any other case is detected above.
9410 elsif not Is_Generic_Instance (Scope (Gen_Par)) then
9411 return False;
9413 else
9414 return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
9415 end if;
9416 end Is_Instance_Of;
9418 ---------------------------
9419 -- Process_Nested_Formal --
9420 ---------------------------
9422 procedure Process_Nested_Formal (Formal : Entity_Id) is
9423 Ent : Entity_Id;
9425 begin
9426 if Present (Associated_Formal_Package (Formal))
9427 and then Box_Present (Parent (Associated_Formal_Package (Formal)))
9428 then
9429 Ent := First_Entity (Formal);
9430 while Present (Ent) loop
9431 Set_Is_Hidden (Ent, False);
9432 Set_Is_Visible_Formal (Ent);
9433 Set_Is_Potentially_Use_Visible
9434 (Ent, Is_Potentially_Use_Visible (Formal));
9436 if Ekind (Ent) = E_Package then
9437 exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
9438 Process_Nested_Formal (Ent);
9439 end if;
9441 Next_Entity (Ent);
9442 end loop;
9443 end if;
9444 end Process_Nested_Formal;
9446 -- Start of processing for Instantiate_Formal_Package
9448 begin
9449 Analyze (Actual);
9451 if not Is_Entity_Name (Actual)
9452 or else Ekind (Entity (Actual)) /= E_Package
9453 then
9454 Error_Msg_N
9455 ("expect package instance to instantiate formal", Actual);
9456 Abandon_Instantiation (Actual);
9457 raise Program_Error;
9459 else
9460 Actual_Pack := Entity (Actual);
9461 Set_Is_Instantiated (Actual_Pack);
9463 -- The actual may be a renamed package, or an outer generic formal
9464 -- package whose instantiation is converted into a renaming.
9466 if Present (Renamed_Object (Actual_Pack)) then
9467 Actual_Pack := Renamed_Object (Actual_Pack);
9468 end if;
9470 if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
9471 Gen_Parent := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
9472 Formal_Pack := Defining_Identifier (Analyzed_Formal);
9473 else
9474 Gen_Parent :=
9475 Generic_Parent (Specification (Analyzed_Formal));
9476 Formal_Pack :=
9477 Defining_Unit_Name (Specification (Analyzed_Formal));
9478 end if;
9480 if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
9481 Parent_Spec := Package_Specification (Actual_Pack);
9482 else
9483 Parent_Spec := Parent (Actual_Pack);
9484 end if;
9486 if Gen_Parent = Any_Id then
9487 Error_Msg_N
9488 ("previous error in declaration of formal package", Actual);
9489 Abandon_Instantiation (Actual);
9491 elsif
9492 Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
9493 then
9494 null;
9496 else
9497 Error_Msg_NE
9498 ("actual parameter must be instance of&", Actual, Gen_Parent);
9499 Abandon_Instantiation (Actual);
9500 end if;
9502 Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
9503 Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
9505 Nod :=
9506 Make_Package_Renaming_Declaration (Loc,
9507 Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
9508 Name => New_Occurrence_Of (Actual_Pack, Loc));
9510 Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
9511 Defining_Identifier (Formal));
9512 Decls := New_List (Nod);
9514 -- If the formal F has a box, then the generic declarations are
9515 -- visible in the generic G. In an instance of G, the corresponding
9516 -- entities in the actual for F (which are the actuals for the
9517 -- instantiation of the generic that F denotes) must also be made
9518 -- visible for analysis of the current instance. On exit from the
9519 -- current instance, those entities are made private again. If the
9520 -- actual is currently in use, these entities are also use-visible.
9522 -- The loop through the actual entities also steps through the formal
9523 -- entities and enters associations from formals to actuals into the
9524 -- renaming map. This is necessary to properly handle checking of
9525 -- actual parameter associations for later formals that depend on
9526 -- actuals declared in the formal package.
9528 -- In Ada 2005, partial parameterization requires that we make
9529 -- visible the actuals corresponding to formals that were defaulted
9530 -- in the formal package. There formals are identified because they
9531 -- remain formal generics within the formal package, rather than
9532 -- being renamings of the actuals supplied.
9534 declare
9535 Gen_Decl : constant Node_Id :=
9536 Unit_Declaration_Node (Gen_Parent);
9537 Formals : constant List_Id :=
9538 Generic_Formal_Declarations (Gen_Decl);
9540 Actual_Ent : Entity_Id;
9541 Actual_Of_Formal : Node_Id;
9542 Formal_Node : Node_Id;
9543 Formal_Ent : Entity_Id;
9545 begin
9546 if Present (Formals) then
9547 Formal_Node := First_Non_Pragma (Formals);
9548 else
9549 Formal_Node := Empty;
9550 end if;
9552 Actual_Ent := First_Entity (Actual_Pack);
9553 Actual_Of_Formal :=
9554 First (Visible_Declarations (Specification (Analyzed_Formal)));
9555 while Present (Actual_Ent)
9556 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9557 loop
9558 if Present (Formal_Node) then
9559 Formal_Ent := Get_Formal_Entity (Formal_Node);
9561 if Present (Formal_Ent) then
9562 Find_Matching_Actual (Formal_Node, Actual_Ent);
9563 Match_Formal_Entity
9564 (Formal_Node, Formal_Ent, Actual_Ent);
9566 -- We iterate at the same time over the actuals of the
9567 -- local package created for the formal, to determine
9568 -- which one of the formals of the original generic were
9569 -- defaulted in the formal. The corresponding actual
9570 -- entities are visible in the enclosing instance.
9572 if Box_Present (Formal)
9573 or else
9574 (Present (Actual_Of_Formal)
9575 and then
9576 Is_Generic_Formal
9577 (Get_Formal_Entity (Actual_Of_Formal)))
9578 then
9579 Set_Is_Hidden (Actual_Ent, False);
9580 Set_Is_Visible_Formal (Actual_Ent);
9581 Set_Is_Potentially_Use_Visible
9582 (Actual_Ent, In_Use (Actual_Pack));
9584 if Ekind (Actual_Ent) = E_Package then
9585 Process_Nested_Formal (Actual_Ent);
9586 end if;
9588 else
9589 Set_Is_Hidden (Actual_Ent);
9590 Set_Is_Potentially_Use_Visible (Actual_Ent, False);
9591 end if;
9592 end if;
9594 Next_Non_Pragma (Formal_Node);
9595 Next (Actual_Of_Formal);
9597 else
9598 -- No further formals to match, but the generic part may
9599 -- contain inherited operation that are not hidden in the
9600 -- enclosing instance.
9602 Next_Entity (Actual_Ent);
9603 end if;
9604 end loop;
9606 -- Inherited subprograms generated by formal derived types are
9607 -- also visible if the types are.
9609 Actual_Ent := First_Entity (Actual_Pack);
9610 while Present (Actual_Ent)
9611 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9612 loop
9613 if Is_Overloadable (Actual_Ent)
9614 and then
9615 Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
9616 and then
9617 not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
9618 then
9619 Set_Is_Hidden (Actual_Ent, False);
9620 Set_Is_Potentially_Use_Visible
9621 (Actual_Ent, In_Use (Actual_Pack));
9622 end if;
9624 Next_Entity (Actual_Ent);
9625 end loop;
9626 end;
9628 -- If the formal is not declared with a box, reanalyze it as an
9629 -- abbreviated instantiation, to verify the matching rules of 12.7.
9630 -- The actual checks are performed after the generic associations
9631 -- have been analyzed, to guarantee the same visibility for this
9632 -- instantiation and for the actuals.
9634 -- In Ada 2005, the generic associations for the formal can include
9635 -- defaulted parameters. These are ignored during check. This
9636 -- internal instantiation is removed from the tree after conformance
9637 -- checking, because it contains formal declarations for those
9638 -- defaulted parameters, and those should not reach the back-end.
9640 if not Box_Present (Formal) then
9641 declare
9642 I_Pack : constant Entity_Id :=
9643 Make_Temporary (Sloc (Actual), 'P');
9645 begin
9646 Set_Is_Internal (I_Pack);
9648 Append_To (Decls,
9649 Make_Package_Instantiation (Sloc (Actual),
9650 Defining_Unit_Name => I_Pack,
9651 Name =>
9652 New_Occurrence_Of
9653 (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
9654 Generic_Associations =>
9655 Generic_Associations (Formal)));
9656 end;
9657 end if;
9659 return Decls;
9660 end if;
9661 end Instantiate_Formal_Package;
9663 -----------------------------------
9664 -- Instantiate_Formal_Subprogram --
9665 -----------------------------------
9667 function Instantiate_Formal_Subprogram
9668 (Formal : Node_Id;
9669 Actual : Node_Id;
9670 Analyzed_Formal : Node_Id) return Node_Id
9672 Analyzed_S : constant Entity_Id :=
9673 Defining_Unit_Name (Specification (Analyzed_Formal));
9674 Formal_Sub : constant Entity_Id :=
9675 Defining_Unit_Name (Specification (Formal));
9677 function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9678 -- If the generic is a child unit, the parent has been installed on the
9679 -- scope stack, but a default subprogram cannot resolve to something
9680 -- on the parent because that parent is not really part of the visible
9681 -- context (it is there to resolve explicit local entities). If the
9682 -- default has resolved in this way, we remove the entity from immediate
9683 -- visibility and analyze the node again to emit an error message or
9684 -- find another visible candidate.
9686 procedure Valid_Actual_Subprogram (Act : Node_Id);
9687 -- Perform legality check and raise exception on failure
9689 -----------------------
9690 -- From_Parent_Scope --
9691 -----------------------
9693 function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9694 Gen_Scope : Node_Id;
9696 begin
9697 Gen_Scope := Scope (Analyzed_S);
9698 while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9699 if Scope (Subp) = Scope (Gen_Scope) then
9700 return True;
9701 end if;
9703 Gen_Scope := Scope (Gen_Scope);
9704 end loop;
9706 return False;
9707 end From_Parent_Scope;
9709 -----------------------------
9710 -- Valid_Actual_Subprogram --
9711 -----------------------------
9713 procedure Valid_Actual_Subprogram (Act : Node_Id) is
9714 Act_E : Entity_Id;
9716 begin
9717 if Is_Entity_Name (Act) then
9718 Act_E := Entity (Act);
9720 elsif Nkind (Act) = N_Selected_Component
9721 and then Is_Entity_Name (Selector_Name (Act))
9722 then
9723 Act_E := Entity (Selector_Name (Act));
9725 else
9726 Act_E := Empty;
9727 end if;
9729 if (Present (Act_E) and then Is_Overloadable (Act_E))
9730 or else Nkind_In (Act, N_Attribute_Reference,
9731 N_Indexed_Component,
9732 N_Character_Literal,
9733 N_Explicit_Dereference)
9734 then
9735 return;
9736 end if;
9738 Error_Msg_NE
9739 ("expect subprogram or entry name in instantiation of&",
9740 Instantiation_Node, Formal_Sub);
9741 Abandon_Instantiation (Instantiation_Node);
9742 end Valid_Actual_Subprogram;
9744 -- Local variables
9746 Decl_Node : Node_Id;
9747 Loc : Source_Ptr;
9748 Nam : Node_Id;
9749 New_Spec : Node_Id;
9751 -- Start of processing for Instantiate_Formal_Subprogram
9753 begin
9754 New_Spec := New_Copy_Tree (Specification (Formal));
9756 -- The tree copy has created the proper instantiation sloc for the
9757 -- new specification. Use this location for all other constructed
9758 -- declarations.
9760 Loc := Sloc (Defining_Unit_Name (New_Spec));
9762 -- Create new entity for the actual (New_Copy_Tree does not), and
9763 -- indicate that it is an actual.
9765 Set_Defining_Unit_Name
9766 (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9767 Set_Ekind (Defining_Unit_Name (New_Spec), Ekind (Analyzed_S));
9768 Set_Is_Generic_Actual_Subprogram (Defining_Unit_Name (New_Spec));
9770 -- Create new entities for the each of the formals in the specification
9771 -- of the renaming declaration built for the actual.
9773 if Present (Parameter_Specifications (New_Spec)) then
9774 declare
9775 F : Node_Id;
9776 F_Id : Entity_Id;
9778 begin
9779 F := First (Parameter_Specifications (New_Spec));
9780 while Present (F) loop
9781 F_Id := Defining_Identifier (F);
9783 Set_Defining_Identifier (F,
9784 Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id)));
9785 Next (F);
9786 end loop;
9787 end;
9788 end if;
9790 -- Find entity of actual. If the actual is an attribute reference, it
9791 -- cannot be resolved here (its formal is missing) but is handled
9792 -- instead in Attribute_Renaming. If the actual is overloaded, it is
9793 -- fully resolved subsequently, when the renaming declaration for the
9794 -- formal is analyzed. If it is an explicit dereference, resolve the
9795 -- prefix but not the actual itself, to prevent interpretation as call.
9797 if Present (Actual) then
9798 Loc := Sloc (Actual);
9799 Set_Sloc (New_Spec, Loc);
9801 if Nkind (Actual) = N_Operator_Symbol then
9802 Find_Direct_Name (Actual);
9804 elsif Nkind (Actual) = N_Explicit_Dereference then
9805 Analyze (Prefix (Actual));
9807 elsif Nkind (Actual) /= N_Attribute_Reference then
9808 Analyze (Actual);
9809 end if;
9811 Valid_Actual_Subprogram (Actual);
9812 Nam := Actual;
9814 elsif Present (Default_Name (Formal)) then
9815 if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9816 N_Selected_Component,
9817 N_Indexed_Component,
9818 N_Character_Literal)
9819 and then Present (Entity (Default_Name (Formal)))
9820 then
9821 Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9822 else
9823 Nam := New_Copy (Default_Name (Formal));
9824 Set_Sloc (Nam, Loc);
9825 end if;
9827 elsif Box_Present (Formal) then
9829 -- Actual is resolved at the point of instantiation. Create an
9830 -- identifier or operator with the same name as the formal.
9832 if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9833 Nam :=
9834 Make_Operator_Symbol (Loc,
9835 Chars => Chars (Formal_Sub),
9836 Strval => No_String);
9837 else
9838 Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9839 end if;
9841 elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9842 and then Null_Present (Specification (Formal))
9843 then
9844 -- Generate null body for procedure, for use in the instance
9846 Decl_Node :=
9847 Make_Subprogram_Body (Loc,
9848 Specification => New_Spec,
9849 Declarations => New_List,
9850 Handled_Statement_Sequence =>
9851 Make_Handled_Sequence_Of_Statements (Loc,
9852 Statements => New_List (Make_Null_Statement (Loc))));
9854 Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9855 return Decl_Node;
9857 else
9858 Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9859 Error_Msg_NE
9860 ("missing actual&", Instantiation_Node, Formal_Sub);
9861 Error_Msg_NE
9862 ("\in instantiation of & declared#",
9863 Instantiation_Node, Scope (Analyzed_S));
9864 Abandon_Instantiation (Instantiation_Node);
9865 end if;
9867 Decl_Node :=
9868 Make_Subprogram_Renaming_Declaration (Loc,
9869 Specification => New_Spec,
9870 Name => Nam);
9872 -- If we do not have an actual and the formal specified <> then set to
9873 -- get proper default.
9875 if No (Actual) and then Box_Present (Formal) then
9876 Set_From_Default (Decl_Node);
9877 end if;
9879 -- Gather possible interpretations for the actual before analyzing the
9880 -- instance. If overloaded, it will be resolved when analyzing the
9881 -- renaming declaration.
9883 if Box_Present (Formal) and then No (Actual) then
9884 Analyze (Nam);
9886 if Is_Child_Unit (Scope (Analyzed_S))
9887 and then Present (Entity (Nam))
9888 then
9889 if not Is_Overloaded (Nam) then
9890 if From_Parent_Scope (Entity (Nam)) then
9891 Set_Is_Immediately_Visible (Entity (Nam), False);
9892 Set_Entity (Nam, Empty);
9893 Set_Etype (Nam, Empty);
9895 Analyze (Nam);
9896 Set_Is_Immediately_Visible (Entity (Nam));
9897 end if;
9899 else
9900 declare
9901 I : Interp_Index;
9902 It : Interp;
9904 begin
9905 Get_First_Interp (Nam, I, It);
9906 while Present (It.Nam) loop
9907 if From_Parent_Scope (It.Nam) then
9908 Remove_Interp (I);
9909 end if;
9911 Get_Next_Interp (I, It);
9912 end loop;
9913 end;
9914 end if;
9915 end if;
9916 end if;
9918 -- The generic instantiation freezes the actual. This can only be done
9919 -- once the actual is resolved, in the analysis of the renaming
9920 -- declaration. To make the formal subprogram entity available, we set
9921 -- Corresponding_Formal_Spec to point to the formal subprogram entity.
9922 -- This is also needed in Analyze_Subprogram_Renaming for the processing
9923 -- of formal abstract subprograms.
9925 Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9927 -- We cannot analyze the renaming declaration, and thus find the actual,
9928 -- until all the actuals are assembled in the instance. For subsequent
9929 -- checks of other actuals, indicate the node that will hold the
9930 -- instance of this formal.
9932 Set_Instance_Of (Analyzed_S, Nam);
9934 if Nkind (Actual) = N_Selected_Component
9935 and then Is_Task_Type (Etype (Prefix (Actual)))
9936 and then not Is_Frozen (Etype (Prefix (Actual)))
9937 then
9938 -- The renaming declaration will create a body, which must appear
9939 -- outside of the instantiation, We move the renaming declaration
9940 -- out of the instance, and create an additional renaming inside,
9941 -- to prevent freezing anomalies.
9943 declare
9944 Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9946 begin
9947 Set_Defining_Unit_Name (New_Spec, Anon_Id);
9948 Insert_Before (Instantiation_Node, Decl_Node);
9949 Analyze (Decl_Node);
9951 -- Now create renaming within the instance
9953 Decl_Node :=
9954 Make_Subprogram_Renaming_Declaration (Loc,
9955 Specification => New_Copy_Tree (New_Spec),
9956 Name => New_Occurrence_Of (Anon_Id, Loc));
9958 Set_Defining_Unit_Name (Specification (Decl_Node),
9959 Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9960 end;
9961 end if;
9963 return Decl_Node;
9964 end Instantiate_Formal_Subprogram;
9966 ------------------------
9967 -- Instantiate_Object --
9968 ------------------------
9970 function Instantiate_Object
9971 (Formal : Node_Id;
9972 Actual : Node_Id;
9973 Analyzed_Formal : Node_Id) return List_Id
9975 Gen_Obj : constant Entity_Id := Defining_Identifier (Formal);
9976 A_Gen_Obj : constant Entity_Id :=
9977 Defining_Identifier (Analyzed_Formal);
9978 Acc_Def : Node_Id := Empty;
9979 Act_Assoc : constant Node_Id := Parent (Actual);
9980 Actual_Decl : Node_Id := Empty;
9981 Decl_Node : Node_Id;
9982 Def : Node_Id;
9983 Ftyp : Entity_Id;
9984 List : constant List_Id := New_List;
9985 Loc : constant Source_Ptr := Sloc (Actual);
9986 Orig_Ftyp : constant Entity_Id := Etype (A_Gen_Obj);
9987 Subt_Decl : Node_Id := Empty;
9988 Subt_Mark : Node_Id := Empty;
9990 begin
9991 if Present (Subtype_Mark (Formal)) then
9992 Subt_Mark := Subtype_Mark (Formal);
9993 else
9994 Check_Access_Definition (Formal);
9995 Acc_Def := Access_Definition (Formal);
9996 end if;
9998 -- Sloc for error message on missing actual
10000 Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
10002 if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
10003 Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
10004 end if;
10006 Set_Parent (List, Parent (Actual));
10008 -- OUT present
10010 if Out_Present (Formal) then
10012 -- An IN OUT generic actual must be a name. The instantiation is a
10013 -- renaming declaration. The actual is the name being renamed. We
10014 -- use the actual directly, rather than a copy, because it is not
10015 -- used further in the list of actuals, and because a copy or a use
10016 -- of relocate_node is incorrect if the instance is nested within a
10017 -- generic. In order to simplify ASIS searches, the Generic_Parent
10018 -- field links the declaration to the generic association.
10020 if No (Actual) then
10021 Error_Msg_NE
10022 ("missing actual&",
10023 Instantiation_Node, Gen_Obj);
10024 Error_Msg_NE
10025 ("\in instantiation of & declared#",
10026 Instantiation_Node, Scope (A_Gen_Obj));
10027 Abandon_Instantiation (Instantiation_Node);
10028 end if;
10030 if Present (Subt_Mark) then
10031 Decl_Node :=
10032 Make_Object_Renaming_Declaration (Loc,
10033 Defining_Identifier => New_Copy (Gen_Obj),
10034 Subtype_Mark => New_Copy_Tree (Subt_Mark),
10035 Name => Actual);
10037 else pragma Assert (Present (Acc_Def));
10038 Decl_Node :=
10039 Make_Object_Renaming_Declaration (Loc,
10040 Defining_Identifier => New_Copy (Gen_Obj),
10041 Access_Definition => New_Copy_Tree (Acc_Def),
10042 Name => Actual);
10043 end if;
10045 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
10047 -- The analysis of the actual may produce Insert_Action nodes, so
10048 -- the declaration must have a context in which to attach them.
10050 Append (Decl_Node, List);
10051 Analyze (Actual);
10053 -- Return if the analysis of the actual reported some error
10055 if Etype (Actual) = Any_Type then
10056 return List;
10057 end if;
10059 -- This check is performed here because Analyze_Object_Renaming will
10060 -- not check it when Comes_From_Source is False. Note though that the
10061 -- check for the actual being the name of an object will be performed
10062 -- in Analyze_Object_Renaming.
10064 if Is_Object_Reference (Actual)
10065 and then Is_Dependent_Component_Of_Mutable_Object (Actual)
10066 then
10067 Error_Msg_N
10068 ("illegal discriminant-dependent component for in out parameter",
10069 Actual);
10070 end if;
10072 -- The actual has to be resolved in order to check that it is a
10073 -- variable (due to cases such as F (1), where F returns access to
10074 -- an array, and for overloaded prefixes).
10076 Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
10078 -- If the type of the formal is not itself a formal, and the current
10079 -- unit is a child unit, the formal type must be declared in a
10080 -- parent, and must be retrieved by visibility.
10082 if Ftyp = Orig_Ftyp
10083 and then Is_Generic_Unit (Scope (Ftyp))
10084 and then Is_Child_Unit (Scope (A_Gen_Obj))
10085 then
10086 declare
10087 Temp : constant Node_Id :=
10088 New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
10089 begin
10090 Set_Entity (Temp, Empty);
10091 Find_Type (Temp);
10092 Ftyp := Entity (Temp);
10093 end;
10094 end if;
10096 if Is_Private_Type (Ftyp)
10097 and then not Is_Private_Type (Etype (Actual))
10098 and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
10099 or else Base_Type (Etype (Actual)) = Ftyp)
10100 then
10101 -- If the actual has the type of the full view of the formal, or
10102 -- else a non-private subtype of the formal, then the visibility
10103 -- of the formal type has changed. Add to the actuals a subtype
10104 -- declaration that will force the exchange of views in the body
10105 -- of the instance as well.
10107 Subt_Decl :=
10108 Make_Subtype_Declaration (Loc,
10109 Defining_Identifier => Make_Temporary (Loc, 'P'),
10110 Subtype_Indication => New_Occurrence_Of (Ftyp, Loc));
10112 Prepend (Subt_Decl, List);
10114 Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
10115 Exchange_Declarations (Ftyp);
10116 end if;
10118 Resolve (Actual, Ftyp);
10120 if not Denotes_Variable (Actual) then
10121 Error_Msg_NE
10122 ("actual for& must be a variable", Actual, Gen_Obj);
10124 elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
10126 -- Ada 2005 (AI-423): For a generic formal object of mode in out,
10127 -- the type of the actual shall resolve to a specific anonymous
10128 -- access type.
10130 if Ada_Version < Ada_2005
10131 or else Ekind (Base_Type (Ftyp)) /=
10132 E_Anonymous_Access_Type
10133 or else Ekind (Base_Type (Etype (Actual))) /=
10134 E_Anonymous_Access_Type
10135 then
10136 Error_Msg_NE
10137 ("type of actual does not match type of&", Actual, Gen_Obj);
10138 end if;
10139 end if;
10141 Note_Possible_Modification (Actual, Sure => True);
10143 -- Check for instantiation of atomic/volatile actual for
10144 -- non-atomic/volatile formal (RM C.6 (12)).
10146 if Is_Atomic_Object (Actual) and then not Is_Atomic (Orig_Ftyp) then
10147 Error_Msg_N
10148 ("cannot instantiate non-atomic formal object "
10149 & "with atomic actual", Actual);
10151 elsif Is_Volatile_Object (Actual) and then not Is_Volatile (Orig_Ftyp)
10152 then
10153 Error_Msg_N
10154 ("cannot instantiate non-volatile formal object "
10155 & "with volatile actual", Actual);
10156 end if;
10158 -- Formal in-parameter
10160 else
10161 -- The instantiation of a generic formal in-parameter is constant
10162 -- declaration. The actual is the expression for that declaration.
10164 if Present (Actual) then
10165 if Present (Subt_Mark) then
10166 Def := Subt_Mark;
10167 else pragma Assert (Present (Acc_Def));
10168 Def := Acc_Def;
10169 end if;
10171 Decl_Node :=
10172 Make_Object_Declaration (Loc,
10173 Defining_Identifier => New_Copy (Gen_Obj),
10174 Constant_Present => True,
10175 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10176 Object_Definition => New_Copy_Tree (Def),
10177 Expression => Actual);
10179 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
10181 -- A generic formal object of a tagged type is defined to be
10182 -- aliased so the new constant must also be treated as aliased.
10184 if Is_Tagged_Type (Etype (A_Gen_Obj)) then
10185 Set_Aliased_Present (Decl_Node);
10186 end if;
10188 Append (Decl_Node, List);
10190 -- No need to repeat (pre-)analysis of some expression nodes
10191 -- already handled in Preanalyze_Actuals.
10193 if Nkind (Actual) /= N_Allocator then
10194 Analyze (Actual);
10196 -- Return if the analysis of the actual reported some error
10198 if Etype (Actual) = Any_Type then
10199 return List;
10200 end if;
10201 end if;
10203 declare
10204 Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
10205 Typ : Entity_Id;
10207 begin
10208 Typ := Get_Instance_Of (Formal_Type);
10210 Freeze_Before (Instantiation_Node, Typ);
10212 -- If the actual is an aggregate, perform name resolution on
10213 -- its components (the analysis of an aggregate does not do it)
10214 -- to capture local names that may be hidden if the generic is
10215 -- a child unit.
10217 if Nkind (Actual) = N_Aggregate then
10218 Preanalyze_And_Resolve (Actual, Typ);
10219 end if;
10221 if Is_Limited_Type (Typ)
10222 and then not OK_For_Limited_Init (Typ, Actual)
10223 then
10224 Error_Msg_N
10225 ("initialization not allowed for limited types", Actual);
10226 Explain_Limited_Type (Typ, Actual);
10227 end if;
10228 end;
10230 elsif Present (Default_Expression (Formal)) then
10232 -- Use default to construct declaration
10234 if Present (Subt_Mark) then
10235 Def := Subt_Mark;
10236 else pragma Assert (Present (Acc_Def));
10237 Def := Acc_Def;
10238 end if;
10240 Decl_Node :=
10241 Make_Object_Declaration (Sloc (Formal),
10242 Defining_Identifier => New_Copy (Gen_Obj),
10243 Constant_Present => True,
10244 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10245 Object_Definition => New_Copy (Def),
10246 Expression => New_Copy_Tree
10247 (Default_Expression (Formal)));
10249 Append (Decl_Node, List);
10250 Set_Analyzed (Expression (Decl_Node), False);
10252 else
10253 Error_Msg_NE
10254 ("missing actual&",
10255 Instantiation_Node, Gen_Obj);
10256 Error_Msg_NE ("\in instantiation of & declared#",
10257 Instantiation_Node, Scope (A_Gen_Obj));
10259 if Is_Scalar_Type (Etype (A_Gen_Obj)) then
10261 -- Create dummy constant declaration so that instance can be
10262 -- analyzed, to minimize cascaded visibility errors.
10264 if Present (Subt_Mark) then
10265 Def := Subt_Mark;
10266 else pragma Assert (Present (Acc_Def));
10267 Def := Acc_Def;
10268 end if;
10270 Decl_Node :=
10271 Make_Object_Declaration (Loc,
10272 Defining_Identifier => New_Copy (Gen_Obj),
10273 Constant_Present => True,
10274 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10275 Object_Definition => New_Copy (Def),
10276 Expression =>
10277 Make_Attribute_Reference (Sloc (Gen_Obj),
10278 Attribute_Name => Name_First,
10279 Prefix => New_Copy (Def)));
10281 Append (Decl_Node, List);
10283 else
10284 Abandon_Instantiation (Instantiation_Node);
10285 end if;
10286 end if;
10287 end if;
10289 if Nkind (Actual) in N_Has_Entity then
10290 Actual_Decl := Parent (Entity (Actual));
10291 end if;
10293 -- Ada 2005 (AI-423): For a formal object declaration with a null
10294 -- exclusion or an access definition that has a null exclusion: If the
10295 -- actual matching the formal object declaration denotes a generic
10296 -- formal object of another generic unit G, and the instantiation
10297 -- containing the actual occurs within the body of G or within the body
10298 -- of a generic unit declared within the declarative region of G, then
10299 -- the declaration of the formal object of G must have a null exclusion.
10300 -- Otherwise, the subtype of the actual matching the formal object
10301 -- declaration shall exclude null.
10303 if Ada_Version >= Ada_2005
10304 and then Present (Actual_Decl)
10305 and then
10306 Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
10307 N_Object_Declaration)
10308 and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
10309 and then not Has_Null_Exclusion (Actual_Decl)
10310 and then Has_Null_Exclusion (Analyzed_Formal)
10311 then
10312 Error_Msg_Sloc := Sloc (Analyzed_Formal);
10313 Error_Msg_N
10314 ("actual must exclude null to match generic formal#", Actual);
10315 end if;
10317 -- An effectively volatile object cannot be used as an actual in
10318 -- a generic instance. The following check is only relevant when
10319 -- SPARK_Mode is on as it is not a standard Ada legality rule.
10321 if SPARK_Mode = On
10322 and then Present (Actual)
10323 and then Is_Effectively_Volatile_Object (Actual)
10324 then
10325 Error_Msg_N
10326 ("volatile object cannot act as actual in generic instantiation "
10327 & "(SPARK RM 7.1.3(8))", Actual);
10328 end if;
10330 return List;
10331 end Instantiate_Object;
10333 ------------------------------
10334 -- Instantiate_Package_Body --
10335 ------------------------------
10337 procedure Instantiate_Package_Body
10338 (Body_Info : Pending_Body_Info;
10339 Inlined_Body : Boolean := False;
10340 Body_Optional : Boolean := False)
10342 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10343 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10344 Loc : constant Source_Ptr := Sloc (Inst_Node);
10346 Gen_Id : constant Node_Id := Name (Inst_Node);
10347 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10348 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10349 Act_Spec : constant Node_Id := Specification (Act_Decl);
10350 Act_Decl_Id : constant Entity_Id := Defining_Entity (Act_Spec);
10352 Act_Body_Name : Node_Id;
10353 Gen_Body : Node_Id;
10354 Gen_Body_Id : Node_Id;
10355 Act_Body : Node_Id;
10356 Act_Body_Id : Entity_Id;
10358 Parent_Installed : Boolean := False;
10359 Save_Style_Check : constant Boolean := Style_Check;
10361 Par_Ent : Entity_Id := Empty;
10362 Par_Vis : Boolean := False;
10364 Vis_Prims_List : Elist_Id := No_Elist;
10365 -- List of primitives made temporarily visible in the instantiation
10366 -- to match the visibility of the formal type
10368 procedure Check_Initialized_Types;
10369 -- In a generic package body, an entity of a generic private type may
10370 -- appear uninitialized. This is suspicious, unless the actual is a
10371 -- fully initialized type.
10373 -----------------------------
10374 -- Check_Initialized_Types --
10375 -----------------------------
10377 procedure Check_Initialized_Types is
10378 Decl : Node_Id;
10379 Formal : Entity_Id;
10380 Actual : Entity_Id;
10381 Uninit_Var : Entity_Id;
10383 begin
10384 Decl := First (Generic_Formal_Declarations (Gen_Decl));
10385 while Present (Decl) loop
10386 Uninit_Var := Empty;
10388 if Nkind (Decl) = N_Private_Extension_Declaration then
10389 Uninit_Var := Uninitialized_Variable (Decl);
10391 elsif Nkind (Decl) = N_Formal_Type_Declaration
10392 and then Nkind (Formal_Type_Definition (Decl)) =
10393 N_Formal_Private_Type_Definition
10394 then
10395 Uninit_Var :=
10396 Uninitialized_Variable (Formal_Type_Definition (Decl));
10397 end if;
10399 if Present (Uninit_Var) then
10400 Formal := Defining_Identifier (Decl);
10401 Actual := First_Entity (Act_Decl_Id);
10403 -- For each formal there is a subtype declaration that renames
10404 -- the actual and has the same name as the formal. Locate the
10405 -- formal for warning message about uninitialized variables
10406 -- in the generic, for which the actual type should be a fully
10407 -- initialized type.
10409 while Present (Actual) loop
10410 exit when Ekind (Actual) = E_Package
10411 and then Present (Renamed_Object (Actual));
10413 if Chars (Actual) = Chars (Formal)
10414 and then not Is_Scalar_Type (Actual)
10415 and then not Is_Fully_Initialized_Type (Actual)
10416 and then Warn_On_No_Value_Assigned
10417 then
10418 Error_Msg_Node_2 := Formal;
10419 Error_Msg_NE
10420 ("generic unit has uninitialized variable& of "
10421 & "formal private type &?v?", Actual, Uninit_Var);
10422 Error_Msg_NE
10423 ("actual type for& should be fully initialized type?v?",
10424 Actual, Formal);
10425 exit;
10426 end if;
10428 Next_Entity (Actual);
10429 end loop;
10430 end if;
10432 Next (Decl);
10433 end loop;
10434 end Check_Initialized_Types;
10436 -- Start of processing for Instantiate_Package_Body
10438 begin
10439 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10441 -- The instance body may already have been processed, as the parent of
10442 -- another instance that is inlined (Load_Parent_Of_Generic).
10444 if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
10445 return;
10446 end if;
10448 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10450 -- Re-establish the state of information on which checks are suppressed.
10451 -- This information was set in Body_Info at the point of instantiation,
10452 -- and now we restore it so that the instance is compiled using the
10453 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10455 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10456 Scope_Suppress := Body_Info.Scope_Suppress;
10457 Opt.Ada_Version := Body_Info.Version;
10458 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10459 Restore_Warnings (Body_Info.Warnings);
10460 Opt.SPARK_Mode := Body_Info.SPARK_Mode;
10461 Opt.SPARK_Mode_Pragma := Body_Info.SPARK_Mode_Pragma;
10463 if No (Gen_Body_Id) then
10465 -- Do not look for parent of generic body if none is required.
10466 -- This may happen when the routine is called as part of the
10467 -- Pending_Instantiations processing, when nested instances
10468 -- may precede the one generated from the main unit.
10470 if not Unit_Requires_Body (Defining_Entity (Gen_Decl))
10471 and then Body_Optional
10472 then
10473 return;
10474 else
10475 Load_Parent_Of_Generic
10476 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10477 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10478 end if;
10479 end if;
10481 -- Establish global variable for sloc adjustment and for error recovery
10483 Instantiation_Node := Inst_Node;
10485 if Present (Gen_Body_Id) then
10486 Save_Env (Gen_Unit, Act_Decl_Id);
10487 Style_Check := False;
10488 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10490 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10492 Create_Instantiation_Source
10493 (Inst_Node, Gen_Body_Id, False, S_Adjustment);
10495 Act_Body :=
10496 Copy_Generic_Node
10497 (Original_Node (Gen_Body), Empty, Instantiating => True);
10499 -- Build new name (possibly qualified) for body declaration
10501 Act_Body_Id := New_Copy (Act_Decl_Id);
10503 -- Some attributes of spec entity are not inherited by body entity
10505 Set_Handler_Records (Act_Body_Id, No_List);
10507 if Nkind (Defining_Unit_Name (Act_Spec)) =
10508 N_Defining_Program_Unit_Name
10509 then
10510 Act_Body_Name :=
10511 Make_Defining_Program_Unit_Name (Loc,
10512 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
10513 Defining_Identifier => Act_Body_Id);
10514 else
10515 Act_Body_Name := Act_Body_Id;
10516 end if;
10518 Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
10520 Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
10521 Check_Generic_Actuals (Act_Decl_Id, False);
10522 Check_Initialized_Types;
10524 -- Install primitives hidden at the point of the instantiation but
10525 -- visible when processing the generic formals
10527 declare
10528 E : Entity_Id;
10530 begin
10531 E := First_Entity (Act_Decl_Id);
10532 while Present (E) loop
10533 if Is_Type (E)
10534 and then Is_Generic_Actual_Type (E)
10535 and then Is_Tagged_Type (E)
10536 then
10537 Install_Hidden_Primitives
10538 (Prims_List => Vis_Prims_List,
10539 Gen_T => Generic_Parent_Type (Parent (E)),
10540 Act_T => E);
10541 end if;
10543 Next_Entity (E);
10544 end loop;
10545 end;
10547 -- If it is a child unit, make the parent instance (which is an
10548 -- instance of the parent of the generic) visible. The parent
10549 -- instance is the prefix of the name of the generic unit.
10551 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10552 and then Nkind (Gen_Id) = N_Expanded_Name
10553 then
10554 Par_Ent := Entity (Prefix (Gen_Id));
10555 Par_Vis := Is_Immediately_Visible (Par_Ent);
10556 Install_Parent (Par_Ent, In_Body => True);
10557 Parent_Installed := True;
10559 elsif Is_Child_Unit (Gen_Unit) then
10560 Par_Ent := Scope (Gen_Unit);
10561 Par_Vis := Is_Immediately_Visible (Par_Ent);
10562 Install_Parent (Par_Ent, In_Body => True);
10563 Parent_Installed := True;
10564 end if;
10566 -- If the instantiation is a library unit, and this is the main unit,
10567 -- then build the resulting compilation unit nodes for the instance.
10568 -- If this is a compilation unit but it is not the main unit, then it
10569 -- is the body of a unit in the context, that is being compiled
10570 -- because it is encloses some inlined unit or another generic unit
10571 -- being instantiated. In that case, this body is not part of the
10572 -- current compilation, and is not attached to the tree, but its
10573 -- parent must be set for analysis.
10575 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10577 -- Replace instance node with body of instance, and create new
10578 -- node for corresponding instance declaration.
10580 Build_Instance_Compilation_Unit_Nodes
10581 (Inst_Node, Act_Body, Act_Decl);
10582 Analyze (Inst_Node);
10584 if Parent (Inst_Node) = Cunit (Main_Unit) then
10586 -- If the instance is a child unit itself, then set the scope
10587 -- of the expanded body to be the parent of the instantiation
10588 -- (ensuring that the fully qualified name will be generated
10589 -- for the elaboration subprogram).
10591 if Nkind (Defining_Unit_Name (Act_Spec)) =
10592 N_Defining_Program_Unit_Name
10593 then
10594 Set_Scope
10595 (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
10596 end if;
10597 end if;
10599 -- Case where instantiation is not a library unit
10601 else
10602 -- If this is an early instantiation, i.e. appears textually
10603 -- before the corresponding body and must be elaborated first,
10604 -- indicate that the body instance is to be delayed.
10606 Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
10608 -- Now analyze the body. We turn off all checks if this is an
10609 -- internal unit, since there is no reason to have checks on for
10610 -- any predefined run-time library code. All such code is designed
10611 -- to be compiled with checks off.
10613 -- Note that we do NOT apply this criterion to children of GNAT
10614 -- The latter units must suppress checks explicitly if needed.
10616 if Is_Predefined_File_Name
10617 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
10618 then
10619 Analyze (Act_Body, Suppress => All_Checks);
10620 else
10621 Analyze (Act_Body);
10622 end if;
10623 end if;
10625 Inherit_Context (Gen_Body, Inst_Node);
10627 -- Remove the parent instances if they have been placed on the scope
10628 -- stack to compile the body.
10630 if Parent_Installed then
10631 Remove_Parent (In_Body => True);
10633 -- Restore the previous visibility of the parent
10635 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10636 end if;
10638 Restore_Hidden_Primitives (Vis_Prims_List);
10639 Restore_Private_Views (Act_Decl_Id);
10641 -- Remove the current unit from visibility if this is an instance
10642 -- that is not elaborated on the fly for inlining purposes.
10644 if not Inlined_Body then
10645 Set_Is_Immediately_Visible (Act_Decl_Id, False);
10646 end if;
10648 Restore_Env;
10649 Style_Check := Save_Style_Check;
10651 -- If we have no body, and the unit requires a body, then complain. This
10652 -- complaint is suppressed if we have detected other errors (since a
10653 -- common reason for missing the body is that it had errors).
10654 -- In CodePeer mode, a warning has been emitted already, no need for
10655 -- further messages.
10657 elsif Unit_Requires_Body (Gen_Unit)
10658 and then not Body_Optional
10659 then
10660 if CodePeer_Mode then
10661 null;
10663 elsif Serious_Errors_Detected = 0 then
10664 Error_Msg_NE
10665 ("cannot find body of generic package &", Inst_Node, Gen_Unit);
10667 -- Don't attempt to perform any cleanup actions if some other error
10668 -- was already detected, since this can cause blowups.
10670 else
10671 return;
10672 end if;
10674 -- Case of package that does not need a body
10676 else
10677 -- If the instantiation of the declaration is a library unit, rewrite
10678 -- the original package instantiation as a package declaration in the
10679 -- compilation unit node.
10681 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10682 Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
10683 Rewrite (Inst_Node, Act_Decl);
10685 -- Generate elaboration entity, in case spec has elaboration code.
10686 -- This cannot be done when the instance is analyzed, because it
10687 -- is not known yet whether the body exists.
10689 Set_Elaboration_Entity_Required (Act_Decl_Id, False);
10690 Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
10692 -- If the instantiation is not a library unit, then append the
10693 -- declaration to the list of implicitly generated entities, unless
10694 -- it is already a list member which means that it was already
10695 -- processed
10697 elsif not Is_List_Member (Act_Decl) then
10698 Mark_Rewrite_Insertion (Act_Decl);
10699 Insert_Before (Inst_Node, Act_Decl);
10700 end if;
10701 end if;
10703 Expander_Mode_Restore;
10704 end Instantiate_Package_Body;
10706 ---------------------------------
10707 -- Instantiate_Subprogram_Body --
10708 ---------------------------------
10710 procedure Instantiate_Subprogram_Body
10711 (Body_Info : Pending_Body_Info;
10712 Body_Optional : Boolean := False)
10714 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10715 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10716 Loc : constant Source_Ptr := Sloc (Inst_Node);
10717 Gen_Id : constant Node_Id := Name (Inst_Node);
10718 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10719 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10720 Anon_Id : constant Entity_Id :=
10721 Defining_Unit_Name (Specification (Act_Decl));
10722 Pack_Id : constant Entity_Id :=
10723 Defining_Unit_Name (Parent (Act_Decl));
10724 Decls : List_Id;
10725 Gen_Body : Node_Id;
10726 Gen_Body_Id : Node_Id;
10727 Act_Body : Node_Id;
10728 Pack_Body : Node_Id;
10729 Prev_Formal : Entity_Id;
10730 Ret_Expr : Node_Id;
10731 Unit_Renaming : Node_Id;
10733 Parent_Installed : Boolean := False;
10735 Saved_Style_Check : constant Boolean := Style_Check;
10736 Saved_Warnings : constant Warning_Record := Save_Warnings;
10738 Par_Ent : Entity_Id := Empty;
10739 Par_Vis : Boolean := False;
10741 begin
10742 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10744 -- Subprogram body may have been created already because of an inline
10745 -- pragma, or because of multiple elaborations of the enclosing package
10746 -- when several instances of the subprogram appear in the main unit.
10748 if Present (Corresponding_Body (Act_Decl)) then
10749 return;
10750 end if;
10752 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10754 -- Re-establish the state of information on which checks are suppressed.
10755 -- This information was set in Body_Info at the point of instantiation,
10756 -- and now we restore it so that the instance is compiled using the
10757 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10759 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10760 Scope_Suppress := Body_Info.Scope_Suppress;
10761 Opt.Ada_Version := Body_Info.Version;
10762 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10763 Restore_Warnings (Body_Info.Warnings);
10764 Opt.SPARK_Mode := Body_Info.SPARK_Mode;
10765 Opt.SPARK_Mode_Pragma := Body_Info.SPARK_Mode_Pragma;
10767 if No (Gen_Body_Id) then
10769 -- For imported generic subprogram, no body to compile, complete
10770 -- the spec entity appropriately.
10772 if Is_Imported (Gen_Unit) then
10773 Set_Is_Imported (Anon_Id);
10774 Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10775 Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10776 Set_Convention (Anon_Id, Convention (Gen_Unit));
10777 Set_Has_Completion (Anon_Id);
10778 return;
10780 -- For other cases, compile the body
10782 else
10783 Load_Parent_Of_Generic
10784 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10785 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10786 end if;
10787 end if;
10789 Instantiation_Node := Inst_Node;
10791 if Present (Gen_Body_Id) then
10792 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10794 if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10796 -- Either body is not present, or context is non-expanding, as
10797 -- when compiling a subunit. Mark the instance as completed, and
10798 -- diagnose a missing body when needed.
10800 if Expander_Active
10801 and then Operating_Mode = Generate_Code
10802 then
10803 Error_Msg_N
10804 ("missing proper body for instantiation", Gen_Body);
10805 end if;
10807 Set_Has_Completion (Anon_Id);
10808 return;
10809 end if;
10811 Save_Env (Gen_Unit, Anon_Id);
10812 Style_Check := False;
10813 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10814 Create_Instantiation_Source
10815 (Inst_Node,
10816 Gen_Body_Id,
10817 False,
10818 S_Adjustment);
10820 Act_Body :=
10821 Copy_Generic_Node
10822 (Original_Node (Gen_Body), Empty, Instantiating => True);
10824 -- Create proper defining name for the body, to correspond to
10825 -- the one in the spec.
10827 Set_Defining_Unit_Name (Specification (Act_Body),
10828 Make_Defining_Identifier
10829 (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10830 Set_Corresponding_Spec (Act_Body, Anon_Id);
10831 Set_Has_Completion (Anon_Id);
10832 Check_Generic_Actuals (Pack_Id, False);
10834 -- Generate a reference to link the visible subprogram instance to
10835 -- the generic body, which for navigation purposes is the only
10836 -- available source for the instance.
10838 Generate_Reference
10839 (Related_Instance (Pack_Id),
10840 Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10842 -- If it is a child unit, make the parent instance (which is an
10843 -- instance of the parent of the generic) visible. The parent
10844 -- instance is the prefix of the name of the generic unit.
10846 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10847 and then Nkind (Gen_Id) = N_Expanded_Name
10848 then
10849 Par_Ent := Entity (Prefix (Gen_Id));
10850 Par_Vis := Is_Immediately_Visible (Par_Ent);
10851 Install_Parent (Par_Ent, In_Body => True);
10852 Parent_Installed := True;
10854 elsif Is_Child_Unit (Gen_Unit) then
10855 Par_Ent := Scope (Gen_Unit);
10856 Par_Vis := Is_Immediately_Visible (Par_Ent);
10857 Install_Parent (Par_Ent, In_Body => True);
10858 Parent_Installed := True;
10859 end if;
10861 -- Inside its body, a reference to the generic unit is a reference
10862 -- to the instance. The corresponding renaming is the first
10863 -- declaration in the body.
10865 Unit_Renaming :=
10866 Make_Subprogram_Renaming_Declaration (Loc,
10867 Specification =>
10868 Copy_Generic_Node (
10869 Specification (Original_Node (Gen_Body)),
10870 Empty,
10871 Instantiating => True),
10872 Name => New_Occurrence_Of (Anon_Id, Loc));
10874 -- If there is a formal subprogram with the same name as the unit
10875 -- itself, do not add this renaming declaration. This is a temporary
10876 -- fix for one ACVC test. ???
10878 Prev_Formal := First_Entity (Pack_Id);
10879 while Present (Prev_Formal) loop
10880 if Chars (Prev_Formal) = Chars (Gen_Unit)
10881 and then Is_Overloadable (Prev_Formal)
10882 then
10883 exit;
10884 end if;
10886 Next_Entity (Prev_Formal);
10887 end loop;
10889 if Present (Prev_Formal) then
10890 Decls := New_List (Act_Body);
10891 else
10892 Decls := New_List (Unit_Renaming, Act_Body);
10893 end if;
10895 -- The subprogram body is placed in the body of a dummy package body,
10896 -- whose spec contains the subprogram declaration as well as the
10897 -- renaming declarations for the generic parameters.
10899 Pack_Body := Make_Package_Body (Loc,
10900 Defining_Unit_Name => New_Copy (Pack_Id),
10901 Declarations => Decls);
10903 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10905 -- If the instantiation is a library unit, then build resulting
10906 -- compilation unit nodes for the instance. The declaration of
10907 -- the enclosing package is the grandparent of the subprogram
10908 -- declaration. First replace the instantiation node as the unit
10909 -- of the corresponding compilation.
10911 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10912 if Parent (Inst_Node) = Cunit (Main_Unit) then
10913 Set_Unit (Parent (Inst_Node), Inst_Node);
10914 Build_Instance_Compilation_Unit_Nodes
10915 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10916 Analyze (Inst_Node);
10917 else
10918 Set_Parent (Pack_Body, Parent (Inst_Node));
10919 Analyze (Pack_Body);
10920 end if;
10922 else
10923 Insert_Before (Inst_Node, Pack_Body);
10924 Mark_Rewrite_Insertion (Pack_Body);
10925 Analyze (Pack_Body);
10927 if Expander_Active then
10928 Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10929 end if;
10930 end if;
10932 Inherit_Context (Gen_Body, Inst_Node);
10934 Restore_Private_Views (Pack_Id, False);
10936 if Parent_Installed then
10937 Remove_Parent (In_Body => True);
10939 -- Restore the previous visibility of the parent
10941 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10942 end if;
10944 Restore_Env;
10945 Style_Check := Saved_Style_Check;
10946 Restore_Warnings (Saved_Warnings);
10948 -- Body not found. Error was emitted already. If there were no previous
10949 -- errors, this may be an instance whose scope is a premature instance.
10950 -- In that case we must insure that the (legal) program does raise
10951 -- program error if executed. We generate a subprogram body for this
10952 -- purpose. See DEC ac30vso.
10954 -- Should not reference proprietary DEC tests in comments ???
10956 elsif Serious_Errors_Detected = 0
10957 and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
10958 then
10959 if Body_Optional then
10960 return;
10962 elsif Ekind (Anon_Id) = E_Procedure then
10963 Act_Body :=
10964 Make_Subprogram_Body (Loc,
10965 Specification =>
10966 Make_Procedure_Specification (Loc,
10967 Defining_Unit_Name =>
10968 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10969 Parameter_Specifications =>
10970 New_Copy_List
10971 (Parameter_Specifications (Parent (Anon_Id)))),
10973 Declarations => Empty_List,
10974 Handled_Statement_Sequence =>
10975 Make_Handled_Sequence_Of_Statements (Loc,
10976 Statements =>
10977 New_List (
10978 Make_Raise_Program_Error (Loc,
10979 Reason =>
10980 PE_Access_Before_Elaboration))));
10982 else
10983 Ret_Expr :=
10984 Make_Raise_Program_Error (Loc,
10985 Reason => PE_Access_Before_Elaboration);
10987 Set_Etype (Ret_Expr, (Etype (Anon_Id)));
10988 Set_Analyzed (Ret_Expr);
10990 Act_Body :=
10991 Make_Subprogram_Body (Loc,
10992 Specification =>
10993 Make_Function_Specification (Loc,
10994 Defining_Unit_Name =>
10995 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10996 Parameter_Specifications =>
10997 New_Copy_List
10998 (Parameter_Specifications (Parent (Anon_Id))),
10999 Result_Definition =>
11000 New_Occurrence_Of (Etype (Anon_Id), Loc)),
11002 Declarations => Empty_List,
11003 Handled_Statement_Sequence =>
11004 Make_Handled_Sequence_Of_Statements (Loc,
11005 Statements =>
11006 New_List
11007 (Make_Simple_Return_Statement (Loc, Ret_Expr))));
11008 end if;
11010 Pack_Body := Make_Package_Body (Loc,
11011 Defining_Unit_Name => New_Copy (Pack_Id),
11012 Declarations => New_List (Act_Body));
11014 Insert_After (Inst_Node, Pack_Body);
11015 Set_Corresponding_Spec (Pack_Body, Pack_Id);
11016 Analyze (Pack_Body);
11017 end if;
11019 Expander_Mode_Restore;
11020 end Instantiate_Subprogram_Body;
11022 ----------------------
11023 -- Instantiate_Type --
11024 ----------------------
11026 function Instantiate_Type
11027 (Formal : Node_Id;
11028 Actual : Node_Id;
11029 Analyzed_Formal : Node_Id;
11030 Actual_Decls : List_Id) return List_Id
11032 Gen_T : constant Entity_Id := Defining_Identifier (Formal);
11033 A_Gen_T : constant Entity_Id :=
11034 Defining_Identifier (Analyzed_Formal);
11035 Ancestor : Entity_Id := Empty;
11036 Def : constant Node_Id := Formal_Type_Definition (Formal);
11037 Act_T : Entity_Id;
11038 Decl_Node : Node_Id;
11039 Decl_Nodes : List_Id;
11040 Loc : Source_Ptr;
11041 Subt : Entity_Id;
11043 procedure Diagnose_Predicated_Actual;
11044 -- There are a number of constructs in which a discrete type with
11045 -- predicates is illegal, e.g. as an index in an array type declaration.
11046 -- If a generic type is used is such a construct in a generic package
11047 -- declaration, it carries the flag No_Predicate_On_Actual. it is part
11048 -- of the generic contract that the actual cannot have predicates.
11050 procedure Validate_Array_Type_Instance;
11051 procedure Validate_Access_Subprogram_Instance;
11052 procedure Validate_Access_Type_Instance;
11053 procedure Validate_Derived_Type_Instance;
11054 procedure Validate_Derived_Interface_Type_Instance;
11055 procedure Validate_Discriminated_Formal_Type;
11056 procedure Validate_Interface_Type_Instance;
11057 procedure Validate_Private_Type_Instance;
11058 procedure Validate_Incomplete_Type_Instance;
11059 -- These procedures perform validation tests for the named case.
11060 -- Validate_Discriminated_Formal_Type is shared by formal private
11061 -- types and Ada 2012 formal incomplete types.
11063 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
11064 -- Check that base types are the same and that the subtypes match
11065 -- statically. Used in several of the above.
11067 ---------------------------------
11068 -- Diagnose_Predicated_Actual --
11069 ---------------------------------
11071 procedure Diagnose_Predicated_Actual is
11072 begin
11073 if No_Predicate_On_Actual (A_Gen_T)
11074 and then Has_Predicates (Act_T)
11075 then
11076 Error_Msg_NE
11077 ("actual for& cannot be a type with predicate",
11078 Instantiation_Node, A_Gen_T);
11080 elsif No_Dynamic_Predicate_On_Actual (A_Gen_T)
11081 and then Has_Predicates (Act_T)
11082 and then not Has_Static_Predicate_Aspect (Act_T)
11083 then
11084 Error_Msg_NE
11085 ("actual for& cannot be a type with a dynamic predicate",
11086 Instantiation_Node, A_Gen_T);
11087 end if;
11088 end Diagnose_Predicated_Actual;
11090 --------------------
11091 -- Subtypes_Match --
11092 --------------------
11094 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
11095 T : constant Entity_Id := Get_Instance_Of (Gen_T);
11097 begin
11098 -- Some detailed comments would be useful here ???
11100 return ((Base_Type (T) = Act_T
11101 or else Base_Type (T) = Base_Type (Act_T))
11102 and then Subtypes_Statically_Match (T, Act_T))
11104 or else (Is_Class_Wide_Type (Gen_T)
11105 and then Is_Class_Wide_Type (Act_T)
11106 and then Subtypes_Match
11107 (Get_Instance_Of (Root_Type (Gen_T)),
11108 Root_Type (Act_T)))
11110 or else
11111 (Ekind_In (Gen_T, E_Anonymous_Access_Subprogram_Type,
11112 E_Anonymous_Access_Type)
11113 and then Ekind (Act_T) = Ekind (Gen_T)
11114 and then Subtypes_Statically_Match
11115 (Designated_Type (Gen_T), Designated_Type (Act_T)));
11116 end Subtypes_Match;
11118 -----------------------------------------
11119 -- Validate_Access_Subprogram_Instance --
11120 -----------------------------------------
11122 procedure Validate_Access_Subprogram_Instance is
11123 begin
11124 if not Is_Access_Type (Act_T)
11125 or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
11126 then
11127 Error_Msg_NE
11128 ("expect access type in instantiation of &", Actual, Gen_T);
11129 Abandon_Instantiation (Actual);
11130 end if;
11132 -- According to AI05-288, actuals for access_to_subprograms must be
11133 -- subtype conformant with the generic formal. Previous to AI05-288
11134 -- only mode conformance was required.
11136 -- This is a binding interpretation that applies to previous versions
11137 -- of the language, no need to maintain previous weaker checks.
11139 Check_Subtype_Conformant
11140 (Designated_Type (Act_T),
11141 Designated_Type (A_Gen_T),
11142 Actual,
11143 Get_Inst => True);
11145 if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
11146 if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
11147 Error_Msg_NE
11148 ("protected access type not allowed for formal &",
11149 Actual, Gen_T);
11150 end if;
11152 elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
11153 Error_Msg_NE
11154 ("expect protected access type for formal &",
11155 Actual, Gen_T);
11156 end if;
11157 end Validate_Access_Subprogram_Instance;
11159 -----------------------------------
11160 -- Validate_Access_Type_Instance --
11161 -----------------------------------
11163 procedure Validate_Access_Type_Instance is
11164 Desig_Type : constant Entity_Id :=
11165 Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
11166 Desig_Act : Entity_Id;
11168 begin
11169 if not Is_Access_Type (Act_T) then
11170 Error_Msg_NE
11171 ("expect access type in instantiation of &", Actual, Gen_T);
11172 Abandon_Instantiation (Actual);
11173 end if;
11175 if Is_Access_Constant (A_Gen_T) then
11176 if not Is_Access_Constant (Act_T) then
11177 Error_Msg_N
11178 ("actual type must be access-to-constant type", Actual);
11179 Abandon_Instantiation (Actual);
11180 end if;
11181 else
11182 if Is_Access_Constant (Act_T) then
11183 Error_Msg_N
11184 ("actual type must be access-to-variable type", Actual);
11185 Abandon_Instantiation (Actual);
11187 elsif Ekind (A_Gen_T) = E_General_Access_Type
11188 and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
11189 then
11190 Error_Msg_N -- CODEFIX
11191 ("actual must be general access type!", Actual);
11192 Error_Msg_NE -- CODEFIX
11193 ("add ALL to }!", Actual, Act_T);
11194 Abandon_Instantiation (Actual);
11195 end if;
11196 end if;
11198 -- The designated subtypes, that is to say the subtypes introduced
11199 -- by an access type declaration (and not by a subtype declaration)
11200 -- must match.
11202 Desig_Act := Designated_Type (Base_Type (Act_T));
11204 -- The designated type may have been introduced through a limited_
11205 -- with clause, in which case retrieve the non-limited view. This
11206 -- applies to incomplete types as well as to class-wide types.
11208 if From_Limited_With (Desig_Act) then
11209 Desig_Act := Available_View (Desig_Act);
11210 end if;
11212 if not Subtypes_Match (Desig_Type, Desig_Act) then
11213 Error_Msg_NE
11214 ("designated type of actual does not match that of formal &",
11215 Actual, Gen_T);
11217 if not Predicates_Match (Desig_Type, Desig_Act) then
11218 Error_Msg_N ("\predicates do not match", Actual);
11219 end if;
11221 Abandon_Instantiation (Actual);
11223 elsif Is_Access_Type (Designated_Type (Act_T))
11224 and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
11226 Is_Constrained (Designated_Type (Desig_Type))
11227 then
11228 Error_Msg_NE
11229 ("designated type of actual does not match that of formal &",
11230 Actual, Gen_T);
11232 if not Predicates_Match (Desig_Type, Desig_Act) then
11233 Error_Msg_N ("\predicates do not match", Actual);
11234 end if;
11236 Abandon_Instantiation (Actual);
11237 end if;
11239 -- Ada 2005: null-exclusion indicators of the two types must agree
11241 if Can_Never_Be_Null (A_Gen_T) /= Can_Never_Be_Null (Act_T) then
11242 Error_Msg_NE
11243 ("non null exclusion of actual and formal & do not match",
11244 Actual, Gen_T);
11245 end if;
11246 end Validate_Access_Type_Instance;
11248 ----------------------------------
11249 -- Validate_Array_Type_Instance --
11250 ----------------------------------
11252 procedure Validate_Array_Type_Instance is
11253 I1 : Node_Id;
11254 I2 : Node_Id;
11255 T2 : Entity_Id;
11257 function Formal_Dimensions return Int;
11258 -- Count number of dimensions in array type formal
11260 -----------------------
11261 -- Formal_Dimensions --
11262 -----------------------
11264 function Formal_Dimensions return Int is
11265 Num : Int := 0;
11266 Index : Node_Id;
11268 begin
11269 if Nkind (Def) = N_Constrained_Array_Definition then
11270 Index := First (Discrete_Subtype_Definitions (Def));
11271 else
11272 Index := First (Subtype_Marks (Def));
11273 end if;
11275 while Present (Index) loop
11276 Num := Num + 1;
11277 Next_Index (Index);
11278 end loop;
11280 return Num;
11281 end Formal_Dimensions;
11283 -- Start of processing for Validate_Array_Type_Instance
11285 begin
11286 if not Is_Array_Type (Act_T) then
11287 Error_Msg_NE
11288 ("expect array type in instantiation of &", Actual, Gen_T);
11289 Abandon_Instantiation (Actual);
11291 elsif Nkind (Def) = N_Constrained_Array_Definition then
11292 if not (Is_Constrained (Act_T)) then
11293 Error_Msg_NE
11294 ("expect constrained array in instantiation of &",
11295 Actual, Gen_T);
11296 Abandon_Instantiation (Actual);
11297 end if;
11299 else
11300 if Is_Constrained (Act_T) then
11301 Error_Msg_NE
11302 ("expect unconstrained array in instantiation of &",
11303 Actual, Gen_T);
11304 Abandon_Instantiation (Actual);
11305 end if;
11306 end if;
11308 if Formal_Dimensions /= Number_Dimensions (Act_T) then
11309 Error_Msg_NE
11310 ("dimensions of actual do not match formal &", Actual, Gen_T);
11311 Abandon_Instantiation (Actual);
11312 end if;
11314 I1 := First_Index (A_Gen_T);
11315 I2 := First_Index (Act_T);
11316 for J in 1 .. Formal_Dimensions loop
11318 -- If the indexes of the actual were given by a subtype_mark,
11319 -- the index was transformed into a range attribute. Retrieve
11320 -- the original type mark for checking.
11322 if Is_Entity_Name (Original_Node (I2)) then
11323 T2 := Entity (Original_Node (I2));
11324 else
11325 T2 := Etype (I2);
11326 end if;
11328 if not Subtypes_Match
11329 (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
11330 then
11331 Error_Msg_NE
11332 ("index types of actual do not match those of formal &",
11333 Actual, Gen_T);
11334 Abandon_Instantiation (Actual);
11335 end if;
11337 Next_Index (I1);
11338 Next_Index (I2);
11339 end loop;
11341 -- Check matching subtypes. Note that there are complex visibility
11342 -- issues when the generic is a child unit and some aspect of the
11343 -- generic type is declared in a parent unit of the generic. We do
11344 -- the test to handle this special case only after a direct check
11345 -- for static matching has failed. The case where both the component
11346 -- type and the array type are separate formals, and the component
11347 -- type is a private view may also require special checking in
11348 -- Subtypes_Match.
11350 if Subtypes_Match
11351 (Component_Type (A_Gen_T), Component_Type (Act_T))
11352 or else
11353 Subtypes_Match
11354 (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
11355 Component_Type (Act_T))
11356 then
11357 null;
11358 else
11359 Error_Msg_NE
11360 ("component subtype of actual does not match that of formal &",
11361 Actual, Gen_T);
11362 Abandon_Instantiation (Actual);
11363 end if;
11365 if Has_Aliased_Components (A_Gen_T)
11366 and then not Has_Aliased_Components (Act_T)
11367 then
11368 Error_Msg_NE
11369 ("actual must have aliased components to match formal type &",
11370 Actual, Gen_T);
11371 end if;
11372 end Validate_Array_Type_Instance;
11374 -----------------------------------------------
11375 -- Validate_Derived_Interface_Type_Instance --
11376 -----------------------------------------------
11378 procedure Validate_Derived_Interface_Type_Instance is
11379 Par : constant Entity_Id := Entity (Subtype_Indication (Def));
11380 Elmt : Elmt_Id;
11382 begin
11383 -- First apply interface instance checks
11385 Validate_Interface_Type_Instance;
11387 -- Verify that immediate parent interface is an ancestor of
11388 -- the actual.
11390 if Present (Par)
11391 and then not Interface_Present_In_Ancestor (Act_T, Par)
11392 then
11393 Error_Msg_NE
11394 ("interface actual must include progenitor&", Actual, Par);
11395 end if;
11397 -- Now verify that the actual includes all other ancestors of
11398 -- the formal.
11400 Elmt := First_Elmt (Interfaces (A_Gen_T));
11401 while Present (Elmt) loop
11402 if not Interface_Present_In_Ancestor
11403 (Act_T, Get_Instance_Of (Node (Elmt)))
11404 then
11405 Error_Msg_NE
11406 ("interface actual must include progenitor&",
11407 Actual, Node (Elmt));
11408 end if;
11410 Next_Elmt (Elmt);
11411 end loop;
11412 end Validate_Derived_Interface_Type_Instance;
11414 ------------------------------------
11415 -- Validate_Derived_Type_Instance --
11416 ------------------------------------
11418 procedure Validate_Derived_Type_Instance is
11419 Actual_Discr : Entity_Id;
11420 Ancestor_Discr : Entity_Id;
11422 begin
11423 -- If the parent type in the generic declaration is itself a previous
11424 -- formal type, then it is local to the generic and absent from the
11425 -- analyzed generic definition. In that case the ancestor is the
11426 -- instance of the formal (which must have been instantiated
11427 -- previously), unless the ancestor is itself a formal derived type.
11428 -- In this latter case (which is the subject of Corrigendum 8652/0038
11429 -- (AI-202) the ancestor of the formals is the ancestor of its
11430 -- parent. Otherwise, the analyzed generic carries the parent type.
11431 -- If the parent type is defined in a previous formal package, then
11432 -- the scope of that formal package is that of the generic type
11433 -- itself, and it has already been mapped into the corresponding type
11434 -- in the actual package.
11436 -- Common case: parent type defined outside of the generic
11438 if Is_Entity_Name (Subtype_Mark (Def))
11439 and then Present (Entity (Subtype_Mark (Def)))
11440 then
11441 Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
11443 -- Check whether parent is defined in a previous formal package
11445 elsif
11446 Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
11447 then
11448 Ancestor :=
11449 Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
11451 -- The type may be a local derivation, or a type extension of a
11452 -- previous formal, or of a formal of a parent package.
11454 elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
11455 or else
11456 Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
11457 then
11458 -- Check whether the parent is another derived formal type in the
11459 -- same generic unit.
11461 if Etype (A_Gen_T) /= A_Gen_T
11462 and then Is_Generic_Type (Etype (A_Gen_T))
11463 and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
11464 and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
11465 then
11466 -- Locate ancestor of parent from the subtype declaration
11467 -- created for the actual.
11469 declare
11470 Decl : Node_Id;
11472 begin
11473 Decl := First (Actual_Decls);
11474 while Present (Decl) loop
11475 if Nkind (Decl) = N_Subtype_Declaration
11476 and then Chars (Defining_Identifier (Decl)) =
11477 Chars (Etype (A_Gen_T))
11478 then
11479 Ancestor := Generic_Parent_Type (Decl);
11480 exit;
11481 else
11482 Next (Decl);
11483 end if;
11484 end loop;
11485 end;
11487 pragma Assert (Present (Ancestor));
11489 -- The ancestor itself may be a previous formal that has been
11490 -- instantiated.
11492 Ancestor := Get_Instance_Of (Ancestor);
11494 else
11495 Ancestor :=
11496 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
11497 end if;
11499 -- An unusual case: the actual is a type declared in a parent unit,
11500 -- but is not a formal type so there is no instance_of for it.
11501 -- Retrieve it by analyzing the record extension.
11503 elsif Is_Child_Unit (Scope (A_Gen_T))
11504 and then In_Open_Scopes (Scope (Act_T))
11505 and then Is_Generic_Instance (Scope (Act_T))
11506 then
11507 Analyze (Subtype_Mark (Def));
11508 Ancestor := Entity (Subtype_Mark (Def));
11510 else
11511 Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
11512 end if;
11514 -- If the formal derived type has pragma Preelaborable_Initialization
11515 -- then the actual type must have preelaborable initialization.
11517 if Known_To_Have_Preelab_Init (A_Gen_T)
11518 and then not Has_Preelaborable_Initialization (Act_T)
11519 then
11520 Error_Msg_NE
11521 ("actual for & must have preelaborable initialization",
11522 Actual, Gen_T);
11523 end if;
11525 -- Ada 2005 (AI-251)
11527 if Ada_Version >= Ada_2005 and then Is_Interface (Ancestor) then
11528 if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
11529 Error_Msg_NE
11530 ("(Ada 2005) expected type implementing & in instantiation",
11531 Actual, Ancestor);
11532 end if;
11534 elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
11535 Error_Msg_NE
11536 ("expect type derived from & in instantiation",
11537 Actual, First_Subtype (Ancestor));
11538 Abandon_Instantiation (Actual);
11539 end if;
11541 -- Ada 2005 (AI-443): Synchronized formal derived type checks. Note
11542 -- that the formal type declaration has been rewritten as a private
11543 -- extension.
11545 if Ada_Version >= Ada_2005
11546 and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
11547 and then Synchronized_Present (Parent (A_Gen_T))
11548 then
11549 -- The actual must be a synchronized tagged type
11551 if not Is_Tagged_Type (Act_T) then
11552 Error_Msg_N
11553 ("actual of synchronized type must be tagged", Actual);
11554 Abandon_Instantiation (Actual);
11556 elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
11557 and then Nkind (Type_Definition (Parent (Act_T))) =
11558 N_Derived_Type_Definition
11559 and then not Synchronized_Present (Type_Definition
11560 (Parent (Act_T)))
11561 then
11562 Error_Msg_N
11563 ("actual of synchronized type must be synchronized", Actual);
11564 Abandon_Instantiation (Actual);
11565 end if;
11566 end if;
11568 -- Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
11569 -- removes the second instance of the phrase "or allow pass by copy".
11571 if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
11572 Error_Msg_N
11573 ("cannot have atomic actual type for non-atomic formal type",
11574 Actual);
11576 elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
11577 Error_Msg_N
11578 ("cannot have volatile actual type for non-volatile formal type",
11579 Actual);
11580 end if;
11582 -- It should not be necessary to check for unknown discriminants on
11583 -- Formal, but for some reason Has_Unknown_Discriminants is false for
11584 -- A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
11585 -- needs fixing. ???
11587 if not Is_Indefinite_Subtype (A_Gen_T)
11588 and then not Unknown_Discriminants_Present (Formal)
11589 and then Is_Indefinite_Subtype (Act_T)
11590 then
11591 Error_Msg_N
11592 ("actual subtype must be constrained", Actual);
11593 Abandon_Instantiation (Actual);
11594 end if;
11596 if not Unknown_Discriminants_Present (Formal) then
11597 if Is_Constrained (Ancestor) then
11598 if not Is_Constrained (Act_T) then
11599 Error_Msg_N
11600 ("actual subtype must be constrained", Actual);
11601 Abandon_Instantiation (Actual);
11602 end if;
11604 -- Ancestor is unconstrained, Check if generic formal and actual
11605 -- agree on constrainedness. The check only applies to array types
11606 -- and discriminated types.
11608 elsif Is_Constrained (Act_T) then
11609 if Ekind (Ancestor) = E_Access_Type
11610 or else (not Is_Constrained (A_Gen_T)
11611 and then Is_Composite_Type (A_Gen_T))
11612 then
11613 Error_Msg_N ("actual subtype must be unconstrained", Actual);
11614 Abandon_Instantiation (Actual);
11615 end if;
11617 -- A class-wide type is only allowed if the formal has unknown
11618 -- discriminants.
11620 elsif Is_Class_Wide_Type (Act_T)
11621 and then not Has_Unknown_Discriminants (Ancestor)
11622 then
11623 Error_Msg_NE
11624 ("actual for & cannot be a class-wide type", Actual, Gen_T);
11625 Abandon_Instantiation (Actual);
11627 -- Otherwise, the formal and actual must have the same number
11628 -- of discriminants and each discriminant of the actual must
11629 -- correspond to a discriminant of the formal.
11631 elsif Has_Discriminants (Act_T)
11632 and then not Has_Unknown_Discriminants (Act_T)
11633 and then Has_Discriminants (Ancestor)
11634 then
11635 Actual_Discr := First_Discriminant (Act_T);
11636 Ancestor_Discr := First_Discriminant (Ancestor);
11637 while Present (Actual_Discr)
11638 and then Present (Ancestor_Discr)
11639 loop
11640 if Base_Type (Act_T) /= Base_Type (Ancestor) and then
11641 No (Corresponding_Discriminant (Actual_Discr))
11642 then
11643 Error_Msg_NE
11644 ("discriminant & does not correspond " &
11645 "to ancestor discriminant", Actual, Actual_Discr);
11646 Abandon_Instantiation (Actual);
11647 end if;
11649 Next_Discriminant (Actual_Discr);
11650 Next_Discriminant (Ancestor_Discr);
11651 end loop;
11653 if Present (Actual_Discr) or else Present (Ancestor_Discr) then
11654 Error_Msg_NE
11655 ("actual for & must have same number of discriminants",
11656 Actual, Gen_T);
11657 Abandon_Instantiation (Actual);
11658 end if;
11660 -- This case should be caught by the earlier check for
11661 -- constrainedness, but the check here is added for completeness.
11663 elsif Has_Discriminants (Act_T)
11664 and then not Has_Unknown_Discriminants (Act_T)
11665 then
11666 Error_Msg_NE
11667 ("actual for & must not have discriminants", Actual, Gen_T);
11668 Abandon_Instantiation (Actual);
11670 elsif Has_Discriminants (Ancestor) then
11671 Error_Msg_NE
11672 ("actual for & must have known discriminants", Actual, Gen_T);
11673 Abandon_Instantiation (Actual);
11674 end if;
11676 if not Subtypes_Statically_Compatible
11677 (Act_T, Ancestor, Formal_Derived_Matching => True)
11678 then
11679 Error_Msg_N
11680 ("constraint on actual is incompatible with formal", Actual);
11681 Abandon_Instantiation (Actual);
11682 end if;
11683 end if;
11685 -- If the formal and actual types are abstract, check that there
11686 -- are no abstract primitives of the actual type that correspond to
11687 -- nonabstract primitives of the formal type (second sentence of
11688 -- RM95-3.9.3(9)).
11690 if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
11691 Check_Abstract_Primitives : declare
11692 Gen_Prims : constant Elist_Id :=
11693 Primitive_Operations (A_Gen_T);
11694 Gen_Elmt : Elmt_Id;
11695 Gen_Subp : Entity_Id;
11696 Anc_Subp : Entity_Id;
11697 Anc_Formal : Entity_Id;
11698 Anc_F_Type : Entity_Id;
11700 Act_Prims : constant Elist_Id := Primitive_Operations (Act_T);
11701 Act_Elmt : Elmt_Id;
11702 Act_Subp : Entity_Id;
11703 Act_Formal : Entity_Id;
11704 Act_F_Type : Entity_Id;
11706 Subprograms_Correspond : Boolean;
11708 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
11709 -- Returns true if T2 is derived directly or indirectly from
11710 -- T1, including derivations from interfaces. T1 and T2 are
11711 -- required to be specific tagged base types.
11713 ------------------------
11714 -- Is_Tagged_Ancestor --
11715 ------------------------
11717 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
11719 Intfc_Elmt : Elmt_Id;
11721 begin
11722 -- The predicate is satisfied if the types are the same
11724 if T1 = T2 then
11725 return True;
11727 -- If we've reached the top of the derivation chain then
11728 -- we know that T1 is not an ancestor of T2.
11730 elsif Etype (T2) = T2 then
11731 return False;
11733 -- Proceed to check T2's immediate parent
11735 elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
11736 return True;
11738 -- Finally, check to see if T1 is an ancestor of any of T2's
11739 -- progenitors.
11741 else
11742 Intfc_Elmt := First_Elmt (Interfaces (T2));
11743 while Present (Intfc_Elmt) loop
11744 if Is_Ancestor (T1, Node (Intfc_Elmt)) then
11745 return True;
11746 end if;
11748 Next_Elmt (Intfc_Elmt);
11749 end loop;
11750 end if;
11752 return False;
11753 end Is_Tagged_Ancestor;
11755 -- Start of processing for Check_Abstract_Primitives
11757 begin
11758 -- Loop over all of the formal derived type's primitives
11760 Gen_Elmt := First_Elmt (Gen_Prims);
11761 while Present (Gen_Elmt) loop
11762 Gen_Subp := Node (Gen_Elmt);
11764 -- If the primitive of the formal is not abstract, then
11765 -- determine whether there is a corresponding primitive of
11766 -- the actual type that's abstract.
11768 if not Is_Abstract_Subprogram (Gen_Subp) then
11769 Act_Elmt := First_Elmt (Act_Prims);
11770 while Present (Act_Elmt) loop
11771 Act_Subp := Node (Act_Elmt);
11773 -- If we find an abstract primitive of the actual,
11774 -- then we need to test whether it corresponds to the
11775 -- subprogram from which the generic formal primitive
11776 -- is inherited.
11778 if Is_Abstract_Subprogram (Act_Subp) then
11779 Anc_Subp := Alias (Gen_Subp);
11781 -- Test whether we have a corresponding primitive
11782 -- by comparing names, kinds, formal types, and
11783 -- result types.
11785 if Chars (Anc_Subp) = Chars (Act_Subp)
11786 and then Ekind (Anc_Subp) = Ekind (Act_Subp)
11787 then
11788 Anc_Formal := First_Formal (Anc_Subp);
11789 Act_Formal := First_Formal (Act_Subp);
11790 while Present (Anc_Formal)
11791 and then Present (Act_Formal)
11792 loop
11793 Anc_F_Type := Etype (Anc_Formal);
11794 Act_F_Type := Etype (Act_Formal);
11796 if Ekind (Anc_F_Type)
11797 = E_Anonymous_Access_Type
11798 then
11799 Anc_F_Type := Designated_Type (Anc_F_Type);
11801 if Ekind (Act_F_Type)
11802 = E_Anonymous_Access_Type
11803 then
11804 Act_F_Type :=
11805 Designated_Type (Act_F_Type);
11806 else
11807 exit;
11808 end if;
11810 elsif
11811 Ekind (Act_F_Type) = E_Anonymous_Access_Type
11812 then
11813 exit;
11814 end if;
11816 Anc_F_Type := Base_Type (Anc_F_Type);
11817 Act_F_Type := Base_Type (Act_F_Type);
11819 -- If the formal is controlling, then the
11820 -- the type of the actual primitive's formal
11821 -- must be derived directly or indirectly
11822 -- from the type of the ancestor primitive's
11823 -- formal.
11825 if Is_Controlling_Formal (Anc_Formal) then
11826 if not Is_Tagged_Ancestor
11827 (Anc_F_Type, Act_F_Type)
11828 then
11829 exit;
11830 end if;
11832 -- Otherwise the types of the formals must
11833 -- be the same.
11835 elsif Anc_F_Type /= Act_F_Type then
11836 exit;
11837 end if;
11839 Next_Entity (Anc_Formal);
11840 Next_Entity (Act_Formal);
11841 end loop;
11843 -- If we traversed through all of the formals
11844 -- then so far the subprograms correspond, so
11845 -- now check that any result types correspond.
11847 if No (Anc_Formal) and then No (Act_Formal) then
11848 Subprograms_Correspond := True;
11850 if Ekind (Act_Subp) = E_Function then
11851 Anc_F_Type := Etype (Anc_Subp);
11852 Act_F_Type := Etype (Act_Subp);
11854 if Ekind (Anc_F_Type)
11855 = E_Anonymous_Access_Type
11856 then
11857 Anc_F_Type :=
11858 Designated_Type (Anc_F_Type);
11860 if Ekind (Act_F_Type)
11861 = E_Anonymous_Access_Type
11862 then
11863 Act_F_Type :=
11864 Designated_Type (Act_F_Type);
11865 else
11866 Subprograms_Correspond := False;
11867 end if;
11869 elsif
11870 Ekind (Act_F_Type)
11871 = E_Anonymous_Access_Type
11872 then
11873 Subprograms_Correspond := False;
11874 end if;
11876 Anc_F_Type := Base_Type (Anc_F_Type);
11877 Act_F_Type := Base_Type (Act_F_Type);
11879 -- Now either the result types must be
11880 -- the same or, if the result type is
11881 -- controlling, the result type of the
11882 -- actual primitive must descend from the
11883 -- result type of the ancestor primitive.
11885 if Subprograms_Correspond
11886 and then Anc_F_Type /= Act_F_Type
11887 and then
11888 Has_Controlling_Result (Anc_Subp)
11889 and then
11890 not Is_Tagged_Ancestor
11891 (Anc_F_Type, Act_F_Type)
11892 then
11893 Subprograms_Correspond := False;
11894 end if;
11895 end if;
11897 -- Found a matching subprogram belonging to
11898 -- formal ancestor type, so actual subprogram
11899 -- corresponds and this violates 3.9.3(9).
11901 if Subprograms_Correspond then
11902 Error_Msg_NE
11903 ("abstract subprogram & overrides " &
11904 "nonabstract subprogram of ancestor",
11905 Actual,
11906 Act_Subp);
11907 end if;
11908 end if;
11909 end if;
11910 end if;
11912 Next_Elmt (Act_Elmt);
11913 end loop;
11914 end if;
11916 Next_Elmt (Gen_Elmt);
11917 end loop;
11918 end Check_Abstract_Primitives;
11919 end if;
11921 -- Verify that limitedness matches. If parent is a limited
11922 -- interface then the generic formal is not unless declared
11923 -- explicitly so. If not declared limited, the actual cannot be
11924 -- limited (see AI05-0087).
11926 -- Even though this AI is a binding interpretation, we enable the
11927 -- check only in Ada 2012 mode, because this improper construct
11928 -- shows up in user code and in existing B-tests.
11930 if Is_Limited_Type (Act_T)
11931 and then not Is_Limited_Type (A_Gen_T)
11932 and then Ada_Version >= Ada_2012
11933 then
11934 if In_Instance then
11935 null;
11936 else
11937 Error_Msg_NE
11938 ("actual for non-limited & cannot be a limited type", Actual,
11939 Gen_T);
11940 Explain_Limited_Type (Act_T, Actual);
11941 Abandon_Instantiation (Actual);
11942 end if;
11943 end if;
11944 end Validate_Derived_Type_Instance;
11946 ----------------------------------------
11947 -- Validate_Discriminated_Formal_Type --
11948 ----------------------------------------
11950 procedure Validate_Discriminated_Formal_Type is
11951 Formal_Discr : Entity_Id;
11952 Actual_Discr : Entity_Id;
11953 Formal_Subt : Entity_Id;
11955 begin
11956 if Has_Discriminants (A_Gen_T) then
11957 if not Has_Discriminants (Act_T) then
11958 Error_Msg_NE
11959 ("actual for & must have discriminants", Actual, Gen_T);
11960 Abandon_Instantiation (Actual);
11962 elsif Is_Constrained (Act_T) then
11963 Error_Msg_NE
11964 ("actual for & must be unconstrained", Actual, Gen_T);
11965 Abandon_Instantiation (Actual);
11967 else
11968 Formal_Discr := First_Discriminant (A_Gen_T);
11969 Actual_Discr := First_Discriminant (Act_T);
11970 while Formal_Discr /= Empty loop
11971 if Actual_Discr = Empty then
11972 Error_Msg_NE
11973 ("discriminants on actual do not match formal",
11974 Actual, Gen_T);
11975 Abandon_Instantiation (Actual);
11976 end if;
11978 Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
11980 -- Access discriminants match if designated types do
11982 if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
11983 and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
11984 E_Anonymous_Access_Type
11985 and then
11986 Get_Instance_Of
11987 (Designated_Type (Base_Type (Formal_Subt))) =
11988 Designated_Type (Base_Type (Etype (Actual_Discr)))
11989 then
11990 null;
11992 elsif Base_Type (Formal_Subt) /=
11993 Base_Type (Etype (Actual_Discr))
11994 then
11995 Error_Msg_NE
11996 ("types of actual discriminants must match formal",
11997 Actual, Gen_T);
11998 Abandon_Instantiation (Actual);
12000 elsif not Subtypes_Statically_Match
12001 (Formal_Subt, Etype (Actual_Discr))
12002 and then Ada_Version >= Ada_95
12003 then
12004 Error_Msg_NE
12005 ("subtypes of actual discriminants must match formal",
12006 Actual, Gen_T);
12007 Abandon_Instantiation (Actual);
12008 end if;
12010 Next_Discriminant (Formal_Discr);
12011 Next_Discriminant (Actual_Discr);
12012 end loop;
12014 if Actual_Discr /= Empty then
12015 Error_Msg_NE
12016 ("discriminants on actual do not match formal",
12017 Actual, Gen_T);
12018 Abandon_Instantiation (Actual);
12019 end if;
12020 end if;
12021 end if;
12022 end Validate_Discriminated_Formal_Type;
12024 ---------------------------------------
12025 -- Validate_Incomplete_Type_Instance --
12026 ---------------------------------------
12028 procedure Validate_Incomplete_Type_Instance is
12029 begin
12030 if not Is_Tagged_Type (Act_T)
12031 and then Is_Tagged_Type (A_Gen_T)
12032 then
12033 Error_Msg_NE
12034 ("actual for & must be a tagged type", Actual, Gen_T);
12035 end if;
12037 Validate_Discriminated_Formal_Type;
12038 end Validate_Incomplete_Type_Instance;
12040 --------------------------------------
12041 -- Validate_Interface_Type_Instance --
12042 --------------------------------------
12044 procedure Validate_Interface_Type_Instance is
12045 begin
12046 if not Is_Interface (Act_T) then
12047 Error_Msg_NE
12048 ("actual for formal interface type must be an interface",
12049 Actual, Gen_T);
12051 elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
12052 or else Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
12053 or else Is_Protected_Interface (A_Gen_T) /=
12054 Is_Protected_Interface (Act_T)
12055 or else Is_Synchronized_Interface (A_Gen_T) /=
12056 Is_Synchronized_Interface (Act_T)
12057 then
12058 Error_Msg_NE
12059 ("actual for interface& does not match (RM 12.5.5(4))",
12060 Actual, Gen_T);
12061 end if;
12062 end Validate_Interface_Type_Instance;
12064 ------------------------------------
12065 -- Validate_Private_Type_Instance --
12066 ------------------------------------
12068 procedure Validate_Private_Type_Instance is
12069 begin
12070 if Is_Limited_Type (Act_T)
12071 and then not Is_Limited_Type (A_Gen_T)
12072 then
12073 if In_Instance then
12074 null;
12075 else
12076 Error_Msg_NE
12077 ("actual for non-limited & cannot be a limited type", Actual,
12078 Gen_T);
12079 Explain_Limited_Type (Act_T, Actual);
12080 Abandon_Instantiation (Actual);
12081 end if;
12083 elsif Known_To_Have_Preelab_Init (A_Gen_T)
12084 and then not Has_Preelaborable_Initialization (Act_T)
12085 then
12086 Error_Msg_NE
12087 ("actual for & must have preelaborable initialization", Actual,
12088 Gen_T);
12090 elsif Is_Indefinite_Subtype (Act_T)
12091 and then not Is_Indefinite_Subtype (A_Gen_T)
12092 and then Ada_Version >= Ada_95
12093 then
12094 Error_Msg_NE
12095 ("actual for & must be a definite subtype", Actual, Gen_T);
12097 elsif not Is_Tagged_Type (Act_T)
12098 and then Is_Tagged_Type (A_Gen_T)
12099 then
12100 Error_Msg_NE
12101 ("actual for & must be a tagged type", Actual, Gen_T);
12102 end if;
12104 Validate_Discriminated_Formal_Type;
12105 Ancestor := Gen_T;
12106 end Validate_Private_Type_Instance;
12108 -- Start of processing for Instantiate_Type
12110 begin
12111 if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
12112 Error_Msg_N ("duplicate instantiation of generic type", Actual);
12113 return New_List (Error);
12115 elsif not Is_Entity_Name (Actual)
12116 or else not Is_Type (Entity (Actual))
12117 then
12118 Error_Msg_NE
12119 ("expect valid subtype mark to instantiate &", Actual, Gen_T);
12120 Abandon_Instantiation (Actual);
12122 else
12123 Act_T := Entity (Actual);
12125 -- Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
12126 -- as a generic actual parameter if the corresponding formal type
12127 -- does not have a known_discriminant_part, or is a formal derived
12128 -- type that is an Unchecked_Union type.
12130 if Is_Unchecked_Union (Base_Type (Act_T)) then
12131 if not Has_Discriminants (A_Gen_T)
12132 or else (Is_Derived_Type (A_Gen_T)
12133 and then Is_Unchecked_Union (A_Gen_T))
12134 then
12135 null;
12136 else
12137 Error_Msg_N ("unchecked union cannot be the actual for a "
12138 & "discriminated formal type", Act_T);
12140 end if;
12141 end if;
12143 -- Deal with fixed/floating restrictions
12145 if Is_Floating_Point_Type (Act_T) then
12146 Check_Restriction (No_Floating_Point, Actual);
12147 elsif Is_Fixed_Point_Type (Act_T) then
12148 Check_Restriction (No_Fixed_Point, Actual);
12149 end if;
12151 -- Deal with error of using incomplete type as generic actual.
12152 -- This includes limited views of a type, even if the non-limited
12153 -- view may be available.
12155 if Ekind (Act_T) = E_Incomplete_Type
12156 or else (Is_Class_Wide_Type (Act_T)
12157 and then Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
12158 then
12159 -- If the formal is an incomplete type, the actual can be
12160 -- incomplete as well.
12162 if Ekind (A_Gen_T) = E_Incomplete_Type then
12163 null;
12165 elsif Is_Class_Wide_Type (Act_T)
12166 or else No (Full_View (Act_T))
12167 then
12168 Error_Msg_N ("premature use of incomplete type", Actual);
12169 Abandon_Instantiation (Actual);
12170 else
12171 Act_T := Full_View (Act_T);
12172 Set_Entity (Actual, Act_T);
12174 if Has_Private_Component (Act_T) then
12175 Error_Msg_N
12176 ("premature use of type with private component", Actual);
12177 end if;
12178 end if;
12180 -- Deal with error of premature use of private type as generic actual
12182 elsif Is_Private_Type (Act_T)
12183 and then Is_Private_Type (Base_Type (Act_T))
12184 and then not Is_Generic_Type (Act_T)
12185 and then not Is_Derived_Type (Act_T)
12186 and then No (Full_View (Root_Type (Act_T)))
12187 then
12188 -- If the formal is an incomplete type, the actual can be
12189 -- private or incomplete as well.
12191 if Ekind (A_Gen_T) = E_Incomplete_Type then
12192 null;
12193 else
12194 Error_Msg_N ("premature use of private type", Actual);
12195 end if;
12197 elsif Has_Private_Component (Act_T) then
12198 Error_Msg_N
12199 ("premature use of type with private component", Actual);
12200 end if;
12202 Set_Instance_Of (A_Gen_T, Act_T);
12204 -- If the type is generic, the class-wide type may also be used
12206 if Is_Tagged_Type (A_Gen_T)
12207 and then Is_Tagged_Type (Act_T)
12208 and then not Is_Class_Wide_Type (A_Gen_T)
12209 then
12210 Set_Instance_Of (Class_Wide_Type (A_Gen_T),
12211 Class_Wide_Type (Act_T));
12212 end if;
12214 if not Is_Abstract_Type (A_Gen_T)
12215 and then Is_Abstract_Type (Act_T)
12216 then
12217 Error_Msg_N
12218 ("actual of non-abstract formal cannot be abstract", Actual);
12219 end if;
12221 -- A generic scalar type is a first subtype for which we generate
12222 -- an anonymous base type. Indicate that the instance of this base
12223 -- is the base type of the actual.
12225 if Is_Scalar_Type (A_Gen_T) then
12226 Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
12227 end if;
12228 end if;
12230 if Error_Posted (Act_T) then
12231 null;
12232 else
12233 case Nkind (Def) is
12234 when N_Formal_Private_Type_Definition =>
12235 Validate_Private_Type_Instance;
12237 when N_Formal_Incomplete_Type_Definition =>
12238 Validate_Incomplete_Type_Instance;
12240 when N_Formal_Derived_Type_Definition =>
12241 Validate_Derived_Type_Instance;
12243 when N_Formal_Discrete_Type_Definition =>
12244 if not Is_Discrete_Type (Act_T) then
12245 Error_Msg_NE
12246 ("expect discrete type in instantiation of&",
12247 Actual, Gen_T);
12248 Abandon_Instantiation (Actual);
12249 end if;
12251 Diagnose_Predicated_Actual;
12253 when N_Formal_Signed_Integer_Type_Definition =>
12254 if not Is_Signed_Integer_Type (Act_T) then
12255 Error_Msg_NE
12256 ("expect signed integer type in instantiation of&",
12257 Actual, Gen_T);
12258 Abandon_Instantiation (Actual);
12259 end if;
12261 Diagnose_Predicated_Actual;
12263 when N_Formal_Modular_Type_Definition =>
12264 if not Is_Modular_Integer_Type (Act_T) then
12265 Error_Msg_NE
12266 ("expect modular type in instantiation of &",
12267 Actual, Gen_T);
12268 Abandon_Instantiation (Actual);
12269 end if;
12271 Diagnose_Predicated_Actual;
12273 when N_Formal_Floating_Point_Definition =>
12274 if not Is_Floating_Point_Type (Act_T) then
12275 Error_Msg_NE
12276 ("expect float type in instantiation of &", Actual, Gen_T);
12277 Abandon_Instantiation (Actual);
12278 end if;
12280 when N_Formal_Ordinary_Fixed_Point_Definition =>
12281 if not Is_Ordinary_Fixed_Point_Type (Act_T) then
12282 Error_Msg_NE
12283 ("expect ordinary fixed point type in instantiation of &",
12284 Actual, Gen_T);
12285 Abandon_Instantiation (Actual);
12286 end if;
12288 when N_Formal_Decimal_Fixed_Point_Definition =>
12289 if not Is_Decimal_Fixed_Point_Type (Act_T) then
12290 Error_Msg_NE
12291 ("expect decimal type in instantiation of &",
12292 Actual, Gen_T);
12293 Abandon_Instantiation (Actual);
12294 end if;
12296 when N_Array_Type_Definition =>
12297 Validate_Array_Type_Instance;
12299 when N_Access_To_Object_Definition =>
12300 Validate_Access_Type_Instance;
12302 when N_Access_Function_Definition |
12303 N_Access_Procedure_Definition =>
12304 Validate_Access_Subprogram_Instance;
12306 when N_Record_Definition =>
12307 Validate_Interface_Type_Instance;
12309 when N_Derived_Type_Definition =>
12310 Validate_Derived_Interface_Type_Instance;
12312 when others =>
12313 raise Program_Error;
12315 end case;
12316 end if;
12318 Subt := New_Copy (Gen_T);
12320 -- Use adjusted sloc of subtype name as the location for other nodes in
12321 -- the subtype declaration.
12323 Loc := Sloc (Subt);
12325 Decl_Node :=
12326 Make_Subtype_Declaration (Loc,
12327 Defining_Identifier => Subt,
12328 Subtype_Indication => New_Occurrence_Of (Act_T, Loc));
12330 if Is_Private_Type (Act_T) then
12331 Set_Has_Private_View (Subtype_Indication (Decl_Node));
12333 elsif Is_Access_Type (Act_T)
12334 and then Is_Private_Type (Designated_Type (Act_T))
12335 then
12336 Set_Has_Private_View (Subtype_Indication (Decl_Node));
12337 end if;
12339 Decl_Nodes := New_List (Decl_Node);
12341 -- Flag actual derived types so their elaboration produces the
12342 -- appropriate renamings for the primitive operations of the ancestor.
12343 -- Flag actual for formal private types as well, to determine whether
12344 -- operations in the private part may override inherited operations.
12345 -- If the formal has an interface list, the ancestor is not the
12346 -- parent, but the analyzed formal that includes the interface
12347 -- operations of all its progenitors.
12349 -- Same treatment for formal private types, so we can check whether the
12350 -- type is tagged limited when validating derivations in the private
12351 -- part. (See AI05-096).
12353 if Nkind (Def) = N_Formal_Derived_Type_Definition then
12354 if Present (Interface_List (Def)) then
12355 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
12356 else
12357 Set_Generic_Parent_Type (Decl_Node, Ancestor);
12358 end if;
12360 elsif Nkind_In (Def,
12361 N_Formal_Private_Type_Definition,
12362 N_Formal_Incomplete_Type_Definition)
12363 then
12364 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
12365 end if;
12367 -- If the actual is a synchronized type that implements an interface,
12368 -- the primitive operations are attached to the corresponding record,
12369 -- and we have to treat it as an additional generic actual, so that its
12370 -- primitive operations become visible in the instance. The task or
12371 -- protected type itself does not carry primitive operations.
12373 if Is_Concurrent_Type (Act_T)
12374 and then Is_Tagged_Type (Act_T)
12375 and then Present (Corresponding_Record_Type (Act_T))
12376 and then Present (Ancestor)
12377 and then Is_Interface (Ancestor)
12378 then
12379 declare
12380 Corr_Rec : constant Entity_Id :=
12381 Corresponding_Record_Type (Act_T);
12382 New_Corr : Entity_Id;
12383 Corr_Decl : Node_Id;
12385 begin
12386 New_Corr := Make_Temporary (Loc, 'S');
12387 Corr_Decl :=
12388 Make_Subtype_Declaration (Loc,
12389 Defining_Identifier => New_Corr,
12390 Subtype_Indication =>
12391 New_Occurrence_Of (Corr_Rec, Loc));
12392 Append_To (Decl_Nodes, Corr_Decl);
12394 if Ekind (Act_T) = E_Task_Type then
12395 Set_Ekind (Subt, E_Task_Subtype);
12396 else
12397 Set_Ekind (Subt, E_Protected_Subtype);
12398 end if;
12400 Set_Corresponding_Record_Type (Subt, Corr_Rec);
12401 Set_Generic_Parent_Type (Corr_Decl, Ancestor);
12402 Set_Generic_Parent_Type (Decl_Node, Empty);
12403 end;
12404 end if;
12406 return Decl_Nodes;
12407 end Instantiate_Type;
12409 ---------------------
12410 -- Is_In_Main_Unit --
12411 ---------------------
12413 function Is_In_Main_Unit (N : Node_Id) return Boolean is
12414 Unum : constant Unit_Number_Type := Get_Source_Unit (N);
12415 Current_Unit : Node_Id;
12417 begin
12418 if Unum = Main_Unit then
12419 return True;
12421 -- If the current unit is a subunit then it is either the main unit or
12422 -- is being compiled as part of the main unit.
12424 elsif Nkind (N) = N_Compilation_Unit then
12425 return Nkind (Unit (N)) = N_Subunit;
12426 end if;
12428 Current_Unit := Parent (N);
12429 while Present (Current_Unit)
12430 and then Nkind (Current_Unit) /= N_Compilation_Unit
12431 loop
12432 Current_Unit := Parent (Current_Unit);
12433 end loop;
12435 -- The instantiation node is in the main unit, or else the current node
12436 -- (perhaps as the result of nested instantiations) is in the main unit,
12437 -- or in the declaration of the main unit, which in this last case must
12438 -- be a body.
12440 return Unum = Main_Unit
12441 or else Current_Unit = Cunit (Main_Unit)
12442 or else Current_Unit = Library_Unit (Cunit (Main_Unit))
12443 or else (Present (Library_Unit (Current_Unit))
12444 and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
12445 end Is_In_Main_Unit;
12447 ----------------------------
12448 -- Load_Parent_Of_Generic --
12449 ----------------------------
12451 procedure Load_Parent_Of_Generic
12452 (N : Node_Id;
12453 Spec : Node_Id;
12454 Body_Optional : Boolean := False)
12456 Comp_Unit : constant Node_Id := Cunit (Get_Source_Unit (Spec));
12457 Saved_Style_Check : constant Boolean := Style_Check;
12458 Saved_Warnings : constant Warning_Record := Save_Warnings;
12459 True_Parent : Node_Id;
12460 Inst_Node : Node_Id;
12461 OK : Boolean;
12462 Previous_Instances : constant Elist_Id := New_Elmt_List;
12464 procedure Collect_Previous_Instances (Decls : List_Id);
12465 -- Collect all instantiations in the given list of declarations, that
12466 -- precede the generic that we need to load. If the bodies of these
12467 -- instantiations are available, we must analyze them, to ensure that
12468 -- the public symbols generated are the same when the unit is compiled
12469 -- to generate code, and when it is compiled in the context of a unit
12470 -- that needs a particular nested instance. This process is applied to
12471 -- both package and subprogram instances.
12473 --------------------------------
12474 -- Collect_Previous_Instances --
12475 --------------------------------
12477 procedure Collect_Previous_Instances (Decls : List_Id) is
12478 Decl : Node_Id;
12480 begin
12481 Decl := First (Decls);
12482 while Present (Decl) loop
12483 if Sloc (Decl) >= Sloc (Inst_Node) then
12484 return;
12486 -- If Decl is an instantiation, then record it as requiring
12487 -- instantiation of the corresponding body, except if it is an
12488 -- abbreviated instantiation generated internally for conformance
12489 -- checking purposes only for the case of a formal package
12490 -- declared without a box (see Instantiate_Formal_Package). Such
12491 -- an instantiation does not generate any code (the actual code
12492 -- comes from actual) and thus does not need to be analyzed here.
12493 -- If the instantiation appears with a generic package body it is
12494 -- not analyzed here either.
12496 elsif Nkind (Decl) = N_Package_Instantiation
12497 and then not Is_Internal (Defining_Entity (Decl))
12498 then
12499 Append_Elmt (Decl, Previous_Instances);
12501 -- For a subprogram instantiation, omit instantiations intrinsic
12502 -- operations (Unchecked_Conversions, etc.) that have no bodies.
12504 elsif Nkind_In (Decl, N_Function_Instantiation,
12505 N_Procedure_Instantiation)
12506 and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
12507 then
12508 Append_Elmt (Decl, Previous_Instances);
12510 elsif Nkind (Decl) = N_Package_Declaration then
12511 Collect_Previous_Instances
12512 (Visible_Declarations (Specification (Decl)));
12513 Collect_Previous_Instances
12514 (Private_Declarations (Specification (Decl)));
12516 -- Previous non-generic bodies may contain instances as well
12518 elsif Nkind (Decl) = N_Package_Body
12519 and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
12520 then
12521 Collect_Previous_Instances (Declarations (Decl));
12523 elsif Nkind (Decl) = N_Subprogram_Body
12524 and then not Acts_As_Spec (Decl)
12525 and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
12526 then
12527 Collect_Previous_Instances (Declarations (Decl));
12528 end if;
12530 Next (Decl);
12531 end loop;
12532 end Collect_Previous_Instances;
12534 -- Start of processing for Load_Parent_Of_Generic
12536 begin
12537 if not In_Same_Source_Unit (N, Spec)
12538 or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
12539 or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
12540 and then not Is_In_Main_Unit (Spec))
12541 then
12542 -- Find body of parent of spec, and analyze it. A special case arises
12543 -- when the parent is an instantiation, that is to say when we are
12544 -- currently instantiating a nested generic. In that case, there is
12545 -- no separate file for the body of the enclosing instance. Instead,
12546 -- the enclosing body must be instantiated as if it were a pending
12547 -- instantiation, in order to produce the body for the nested generic
12548 -- we require now. Note that in that case the generic may be defined
12549 -- in a package body, the instance defined in the same package body,
12550 -- and the original enclosing body may not be in the main unit.
12552 Inst_Node := Empty;
12554 True_Parent := Parent (Spec);
12555 while Present (True_Parent)
12556 and then Nkind (True_Parent) /= N_Compilation_Unit
12557 loop
12558 if Nkind (True_Parent) = N_Package_Declaration
12559 and then
12560 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
12561 then
12562 -- Parent is a compilation unit that is an instantiation.
12563 -- Instantiation node has been replaced with package decl.
12565 Inst_Node := Original_Node (True_Parent);
12566 exit;
12568 elsif Nkind (True_Parent) = N_Package_Declaration
12569 and then Present (Generic_Parent (Specification (True_Parent)))
12570 and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12571 then
12572 -- Parent is an instantiation within another specification.
12573 -- Declaration for instance has been inserted before original
12574 -- instantiation node. A direct link would be preferable?
12576 Inst_Node := Next (True_Parent);
12577 while Present (Inst_Node)
12578 and then Nkind (Inst_Node) /= N_Package_Instantiation
12579 loop
12580 Next (Inst_Node);
12581 end loop;
12583 -- If the instance appears within a generic, and the generic
12584 -- unit is defined within a formal package of the enclosing
12585 -- generic, there is no generic body available, and none
12586 -- needed. A more precise test should be used ???
12588 if No (Inst_Node) then
12589 return;
12590 end if;
12592 exit;
12594 else
12595 True_Parent := Parent (True_Parent);
12596 end if;
12597 end loop;
12599 -- Case where we are currently instantiating a nested generic
12601 if Present (Inst_Node) then
12602 if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
12604 -- Instantiation node and declaration of instantiated package
12605 -- were exchanged when only the declaration was needed.
12606 -- Restore instantiation node before proceeding with body.
12608 Set_Unit (Parent (True_Parent), Inst_Node);
12609 end if;
12611 -- Now complete instantiation of enclosing body, if it appears in
12612 -- some other unit. If it appears in the current unit, the body
12613 -- will have been instantiated already.
12615 if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
12617 -- We need to determine the expander mode to instantiate the
12618 -- enclosing body. Because the generic body we need may use
12619 -- global entities declared in the enclosing package (including
12620 -- aggregates) it is in general necessary to compile this body
12621 -- with expansion enabled, except if we are within a generic
12622 -- package, in which case the usual generic rule applies.
12624 declare
12625 Exp_Status : Boolean := True;
12626 Scop : Entity_Id;
12628 begin
12629 -- Loop through scopes looking for generic package
12631 Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
12632 while Present (Scop)
12633 and then Scop /= Standard_Standard
12634 loop
12635 if Ekind (Scop) = E_Generic_Package then
12636 Exp_Status := False;
12637 exit;
12638 end if;
12640 Scop := Scope (Scop);
12641 end loop;
12643 -- Collect previous instantiations in the unit that contains
12644 -- the desired generic.
12646 if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12647 and then not Body_Optional
12648 then
12649 declare
12650 Decl : Elmt_Id;
12651 Info : Pending_Body_Info;
12652 Par : Node_Id;
12654 begin
12655 Par := Parent (Inst_Node);
12656 while Present (Par) loop
12657 exit when Nkind (Parent (Par)) = N_Compilation_Unit;
12658 Par := Parent (Par);
12659 end loop;
12661 pragma Assert (Present (Par));
12663 if Nkind (Par) = N_Package_Body then
12664 Collect_Previous_Instances (Declarations (Par));
12666 elsif Nkind (Par) = N_Package_Declaration then
12667 Collect_Previous_Instances
12668 (Visible_Declarations (Specification (Par)));
12669 Collect_Previous_Instances
12670 (Private_Declarations (Specification (Par)));
12672 else
12673 -- Enclosing unit is a subprogram body. In this
12674 -- case all instance bodies are processed in order
12675 -- and there is no need to collect them separately.
12677 null;
12678 end if;
12680 Decl := First_Elmt (Previous_Instances);
12681 while Present (Decl) loop
12682 Info :=
12683 (Inst_Node => Node (Decl),
12684 Act_Decl =>
12685 Instance_Spec (Node (Decl)),
12686 Expander_Status => Exp_Status,
12687 Current_Sem_Unit =>
12688 Get_Code_Unit (Sloc (Node (Decl))),
12689 Scope_Suppress => Scope_Suppress,
12690 Local_Suppress_Stack_Top =>
12691 Local_Suppress_Stack_Top,
12692 Version => Ada_Version,
12693 Version_Pragma => Ada_Version_Pragma,
12694 Warnings => Save_Warnings,
12695 SPARK_Mode => SPARK_Mode,
12696 SPARK_Mode_Pragma => SPARK_Mode_Pragma);
12698 -- Package instance
12701 Nkind (Node (Decl)) = N_Package_Instantiation
12702 then
12703 Instantiate_Package_Body
12704 (Info, Body_Optional => True);
12706 -- Subprogram instance
12708 else
12709 -- The instance_spec is the wrapper package,
12710 -- and the subprogram declaration is the last
12711 -- declaration in the wrapper.
12713 Info.Act_Decl :=
12714 Last
12715 (Visible_Declarations
12716 (Specification (Info.Act_Decl)));
12718 Instantiate_Subprogram_Body
12719 (Info, Body_Optional => True);
12720 end if;
12722 Next_Elmt (Decl);
12723 end loop;
12724 end;
12725 end if;
12727 Instantiate_Package_Body
12728 (Body_Info =>
12729 ((Inst_Node => Inst_Node,
12730 Act_Decl => True_Parent,
12731 Expander_Status => Exp_Status,
12732 Current_Sem_Unit => Get_Code_Unit
12733 (Sloc (Inst_Node)),
12734 Scope_Suppress => Scope_Suppress,
12735 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
12736 Version => Ada_Version,
12737 Version_Pragma => Ada_Version_Pragma,
12738 Warnings => Save_Warnings,
12739 SPARK_Mode => SPARK_Mode,
12740 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
12741 Body_Optional => Body_Optional);
12742 end;
12743 end if;
12745 -- Case where we are not instantiating a nested generic
12747 else
12748 Opt.Style_Check := False;
12749 Expander_Mode_Save_And_Set (True);
12750 Load_Needed_Body (Comp_Unit, OK);
12751 Opt.Style_Check := Saved_Style_Check;
12752 Restore_Warnings (Saved_Warnings);
12753 Expander_Mode_Restore;
12755 if not OK
12756 and then Unit_Requires_Body (Defining_Entity (Spec))
12757 and then not Body_Optional
12758 then
12759 declare
12760 Bname : constant Unit_Name_Type :=
12761 Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
12763 begin
12764 -- In CodePeer mode, the missing body may make the analysis
12765 -- incomplete, but we do not treat it as fatal.
12767 if CodePeer_Mode then
12768 return;
12770 else
12771 Error_Msg_Unit_1 := Bname;
12772 Error_Msg_N ("this instantiation requires$!", N);
12773 Error_Msg_File_1 :=
12774 Get_File_Name (Bname, Subunit => False);
12775 Error_Msg_N ("\but file{ was not found!", N);
12776 raise Unrecoverable_Error;
12777 end if;
12778 end;
12779 end if;
12780 end if;
12781 end if;
12783 -- If loading parent of the generic caused an instantiation circularity,
12784 -- we abandon compilation at this point, because otherwise in some cases
12785 -- we get into trouble with infinite recursions after this point.
12787 if Circularity_Detected then
12788 raise Unrecoverable_Error;
12789 end if;
12790 end Load_Parent_Of_Generic;
12792 ---------------------------------
12793 -- Map_Formal_Package_Entities --
12794 ---------------------------------
12796 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
12797 E1 : Entity_Id;
12798 E2 : Entity_Id;
12800 begin
12801 Set_Instance_Of (Form, Act);
12803 -- Traverse formal and actual package to map the corresponding entities.
12804 -- We skip over internal entities that may be generated during semantic
12805 -- analysis, and find the matching entities by name, given that they
12806 -- must appear in the same order.
12808 E1 := First_Entity (Form);
12809 E2 := First_Entity (Act);
12810 while Present (E1) and then E1 /= First_Private_Entity (Form) loop
12811 -- Could this test be a single condition??? Seems like it could, and
12812 -- isn't FPE (Form) a constant anyway???
12814 if not Is_Internal (E1)
12815 and then Present (Parent (E1))
12816 and then not Is_Class_Wide_Type (E1)
12817 and then not Is_Internal_Name (Chars (E1))
12818 then
12819 while Present (E2) and then Chars (E2) /= Chars (E1) loop
12820 Next_Entity (E2);
12821 end loop;
12823 if No (E2) then
12824 exit;
12825 else
12826 Set_Instance_Of (E1, E2);
12828 if Is_Type (E1) and then Is_Tagged_Type (E2) then
12829 Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
12830 end if;
12832 if Is_Constrained (E1) then
12833 Set_Instance_Of (Base_Type (E1), Base_Type (E2));
12834 end if;
12836 if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
12837 Map_Formal_Package_Entities (E1, E2);
12838 end if;
12839 end if;
12840 end if;
12842 Next_Entity (E1);
12843 end loop;
12844 end Map_Formal_Package_Entities;
12846 -----------------------
12847 -- Move_Freeze_Nodes --
12848 -----------------------
12850 procedure Move_Freeze_Nodes
12851 (Out_Of : Entity_Id;
12852 After : Node_Id;
12853 L : List_Id)
12855 Decl : Node_Id;
12856 Next_Decl : Node_Id;
12857 Next_Node : Node_Id := After;
12858 Spec : Node_Id;
12860 function Is_Outer_Type (T : Entity_Id) return Boolean;
12861 -- Check whether entity is declared in a scope external to that of the
12862 -- generic unit.
12864 -------------------
12865 -- Is_Outer_Type --
12866 -------------------
12868 function Is_Outer_Type (T : Entity_Id) return Boolean is
12869 Scop : Entity_Id := Scope (T);
12871 begin
12872 if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12873 return True;
12875 else
12876 while Scop /= Standard_Standard loop
12877 if Scop = Out_Of then
12878 return False;
12879 else
12880 Scop := Scope (Scop);
12881 end if;
12882 end loop;
12884 return True;
12885 end if;
12886 end Is_Outer_Type;
12888 -- Start of processing for Move_Freeze_Nodes
12890 begin
12891 if No (L) then
12892 return;
12893 end if;
12895 -- First remove the freeze nodes that may appear before all other
12896 -- declarations.
12898 Decl := First (L);
12899 while Present (Decl)
12900 and then Nkind (Decl) = N_Freeze_Entity
12901 and then Is_Outer_Type (Entity (Decl))
12902 loop
12903 Decl := Remove_Head (L);
12904 Insert_After (Next_Node, Decl);
12905 Set_Analyzed (Decl, False);
12906 Next_Node := Decl;
12907 Decl := First (L);
12908 end loop;
12910 -- Next scan the list of declarations and remove each freeze node that
12911 -- appears ahead of the current node.
12913 while Present (Decl) loop
12914 while Present (Next (Decl))
12915 and then Nkind (Next (Decl)) = N_Freeze_Entity
12916 and then Is_Outer_Type (Entity (Next (Decl)))
12917 loop
12918 Next_Decl := Remove_Next (Decl);
12919 Insert_After (Next_Node, Next_Decl);
12920 Set_Analyzed (Next_Decl, False);
12921 Next_Node := Next_Decl;
12922 end loop;
12924 -- If the declaration is a nested package or concurrent type, then
12925 -- recurse. Nested generic packages will have been processed from the
12926 -- inside out.
12928 case Nkind (Decl) is
12929 when N_Package_Declaration =>
12930 Spec := Specification (Decl);
12932 when N_Task_Type_Declaration =>
12933 Spec := Task_Definition (Decl);
12935 when N_Protected_Type_Declaration =>
12936 Spec := Protected_Definition (Decl);
12938 when others =>
12939 Spec := Empty;
12940 end case;
12942 if Present (Spec) then
12943 Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
12944 Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
12945 end if;
12947 Next (Decl);
12948 end loop;
12949 end Move_Freeze_Nodes;
12951 ----------------
12952 -- Next_Assoc --
12953 ----------------
12955 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
12956 begin
12957 return Generic_Renamings.Table (E).Next_In_HTable;
12958 end Next_Assoc;
12960 ------------------------
12961 -- Preanalyze_Actuals --
12962 ------------------------
12964 procedure Preanalyze_Actuals (N : Node_Id) is
12965 Assoc : Node_Id;
12966 Act : Node_Id;
12967 Errs : constant Int := Serious_Errors_Detected;
12969 Cur : Entity_Id := Empty;
12970 -- Current homograph of the instance name
12972 Vis : Boolean;
12973 -- Saved visibility status of the current homograph
12975 begin
12976 Assoc := First (Generic_Associations (N));
12978 -- If the instance is a child unit, its name may hide an outer homonym,
12979 -- so make it invisible to perform name resolution on the actuals.
12981 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
12982 and then Present
12983 (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
12984 then
12985 Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
12987 if Is_Compilation_Unit (Cur) then
12988 Vis := Is_Immediately_Visible (Cur);
12989 Set_Is_Immediately_Visible (Cur, False);
12990 else
12991 Cur := Empty;
12992 end if;
12993 end if;
12995 while Present (Assoc) loop
12996 if Nkind (Assoc) /= N_Others_Choice then
12997 Act := Explicit_Generic_Actual_Parameter (Assoc);
12999 -- Within a nested instantiation, a defaulted actual is an empty
13000 -- association, so nothing to analyze. If the subprogram actual
13001 -- is an attribute, analyze prefix only, because actual is not a
13002 -- complete attribute reference.
13004 -- If actual is an allocator, analyze expression only. The full
13005 -- analysis can generate code, and if instance is a compilation
13006 -- unit we have to wait until the package instance is installed
13007 -- to have a proper place to insert this code.
13009 -- String literals may be operators, but at this point we do not
13010 -- know whether the actual is a formal subprogram or a string.
13012 if No (Act) then
13013 null;
13015 elsif Nkind (Act) = N_Attribute_Reference then
13016 Analyze (Prefix (Act));
13018 elsif Nkind (Act) = N_Explicit_Dereference then
13019 Analyze (Prefix (Act));
13021 elsif Nkind (Act) = N_Allocator then
13022 declare
13023 Expr : constant Node_Id := Expression (Act);
13025 begin
13026 if Nkind (Expr) = N_Subtype_Indication then
13027 Analyze (Subtype_Mark (Expr));
13029 -- Analyze separately each discriminant constraint, when
13030 -- given with a named association.
13032 declare
13033 Constr : Node_Id;
13035 begin
13036 Constr := First (Constraints (Constraint (Expr)));
13037 while Present (Constr) loop
13038 if Nkind (Constr) = N_Discriminant_Association then
13039 Analyze (Expression (Constr));
13040 else
13041 Analyze (Constr);
13042 end if;
13044 Next (Constr);
13045 end loop;
13046 end;
13048 else
13049 Analyze (Expr);
13050 end if;
13051 end;
13053 elsif Nkind (Act) /= N_Operator_Symbol then
13054 Analyze (Act);
13055 end if;
13057 if Errs /= Serious_Errors_Detected then
13059 -- Do a minimal analysis of the generic, to prevent spurious
13060 -- warnings complaining about the generic being unreferenced,
13061 -- before abandoning the instantiation.
13063 Analyze (Name (N));
13065 if Is_Entity_Name (Name (N))
13066 and then Etype (Name (N)) /= Any_Type
13067 then
13068 Generate_Reference (Entity (Name (N)), Name (N));
13069 Set_Is_Instantiated (Entity (Name (N)));
13070 end if;
13072 if Present (Cur) then
13074 -- For the case of a child instance hiding an outer homonym,
13075 -- provide additional warning which might explain the error.
13077 Set_Is_Immediately_Visible (Cur, Vis);
13078 Error_Msg_NE ("& hides outer unit with the same name??",
13079 N, Defining_Unit_Name (N));
13080 end if;
13082 Abandon_Instantiation (Act);
13083 end if;
13084 end if;
13086 Next (Assoc);
13087 end loop;
13089 if Present (Cur) then
13090 Set_Is_Immediately_Visible (Cur, Vis);
13091 end if;
13092 end Preanalyze_Actuals;
13094 -------------------
13095 -- Remove_Parent --
13096 -------------------
13098 procedure Remove_Parent (In_Body : Boolean := False) is
13099 S : Entity_Id := Current_Scope;
13100 -- S is the scope containing the instantiation just completed. The scope
13101 -- stack contains the parent instances of the instantiation, followed by
13102 -- the original S.
13104 Cur_P : Entity_Id;
13105 E : Entity_Id;
13106 P : Entity_Id;
13107 Hidden : Elmt_Id;
13109 begin
13110 -- After child instantiation is complete, remove from scope stack the
13111 -- extra copy of the current scope, and then remove parent instances.
13113 if not In_Body then
13114 Pop_Scope;
13116 while Current_Scope /= S loop
13117 P := Current_Scope;
13118 End_Package_Scope (Current_Scope);
13120 if In_Open_Scopes (P) then
13121 E := First_Entity (P);
13122 while Present (E) loop
13123 Set_Is_Immediately_Visible (E, True);
13124 Next_Entity (E);
13125 end loop;
13127 -- If instantiation is declared in a block, it is the enclosing
13128 -- scope that might be a parent instance. Note that only one
13129 -- block can be involved, because the parent instances have
13130 -- been installed within it.
13132 if Ekind (P) = E_Block then
13133 Cur_P := Scope (P);
13134 else
13135 Cur_P := P;
13136 end if;
13138 if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
13139 -- We are within an instance of some sibling. Retain
13140 -- visibility of parent, for proper subsequent cleanup, and
13141 -- reinstall private declarations as well.
13143 Set_In_Private_Part (P);
13144 Install_Private_Declarations (P);
13145 end if;
13147 -- If the ultimate parent is a top-level unit recorded in
13148 -- Instance_Parent_Unit, then reset its visibility to what it was
13149 -- before instantiation. (It's not clear what the purpose is of
13150 -- testing whether Scope (P) is In_Open_Scopes, but that test was
13151 -- present before the ultimate parent test was added.???)
13153 elsif not In_Open_Scopes (Scope (P))
13154 or else (P = Instance_Parent_Unit
13155 and then not Parent_Unit_Visible)
13156 then
13157 Set_Is_Immediately_Visible (P, False);
13159 -- If the current scope is itself an instantiation of a generic
13160 -- nested within P, and we are in the private part of body of this
13161 -- instantiation, restore the full views of P, that were removed
13162 -- in End_Package_Scope above. This obscure case can occur when a
13163 -- subunit of a generic contains an instance of a child unit of
13164 -- its generic parent unit.
13166 elsif S = Current_Scope and then Is_Generic_Instance (S) then
13167 declare
13168 Par : constant Entity_Id :=
13169 Generic_Parent (Package_Specification (S));
13170 begin
13171 if Present (Par)
13172 and then P = Scope (Par)
13173 and then (In_Package_Body (S) or else In_Private_Part (S))
13174 then
13175 Set_In_Private_Part (P);
13176 Install_Private_Declarations (P);
13177 end if;
13178 end;
13179 end if;
13180 end loop;
13182 -- Reset visibility of entities in the enclosing scope
13184 Set_Is_Hidden_Open_Scope (Current_Scope, False);
13186 Hidden := First_Elmt (Hidden_Entities);
13187 while Present (Hidden) loop
13188 Set_Is_Immediately_Visible (Node (Hidden), True);
13189 Next_Elmt (Hidden);
13190 end loop;
13192 else
13193 -- Each body is analyzed separately, and there is no context that
13194 -- needs preserving from one body instance to the next, so remove all
13195 -- parent scopes that have been installed.
13197 while Present (S) loop
13198 End_Package_Scope (S);
13199 Set_Is_Immediately_Visible (S, False);
13200 S := Current_Scope;
13201 exit when S = Standard_Standard;
13202 end loop;
13203 end if;
13204 end Remove_Parent;
13206 -----------------
13207 -- Restore_Env --
13208 -----------------
13210 procedure Restore_Env is
13211 Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
13213 begin
13214 if No (Current_Instantiated_Parent.Act_Id) then
13215 -- Restore environment after subprogram inlining
13217 Restore_Private_Views (Empty);
13218 end if;
13220 Current_Instantiated_Parent := Saved.Instantiated_Parent;
13221 Exchanged_Views := Saved.Exchanged_Views;
13222 Hidden_Entities := Saved.Hidden_Entities;
13223 Current_Sem_Unit := Saved.Current_Sem_Unit;
13224 Parent_Unit_Visible := Saved.Parent_Unit_Visible;
13225 Instance_Parent_Unit := Saved.Instance_Parent_Unit;
13227 Restore_Opt_Config_Switches (Saved.Switches);
13229 Instance_Envs.Decrement_Last;
13230 end Restore_Env;
13232 ---------------------------
13233 -- Restore_Private_Views --
13234 ---------------------------
13236 procedure Restore_Private_Views
13237 (Pack_Id : Entity_Id;
13238 Is_Package : Boolean := True)
13240 M : Elmt_Id;
13241 E : Entity_Id;
13242 Typ : Entity_Id;
13243 Dep_Elmt : Elmt_Id;
13244 Dep_Typ : Node_Id;
13246 procedure Restore_Nested_Formal (Formal : Entity_Id);
13247 -- Hide the generic formals of formal packages declared with box which
13248 -- were reachable in the current instantiation.
13250 ---------------------------
13251 -- Restore_Nested_Formal --
13252 ---------------------------
13254 procedure Restore_Nested_Formal (Formal : Entity_Id) is
13255 Ent : Entity_Id;
13257 begin
13258 if Present (Renamed_Object (Formal))
13259 and then Denotes_Formal_Package (Renamed_Object (Formal), True)
13260 then
13261 return;
13263 elsif Present (Associated_Formal_Package (Formal)) then
13264 Ent := First_Entity (Formal);
13265 while Present (Ent) loop
13266 exit when Ekind (Ent) = E_Package
13267 and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
13269 Set_Is_Hidden (Ent);
13270 Set_Is_Potentially_Use_Visible (Ent, False);
13272 -- If package, then recurse
13274 if Ekind (Ent) = E_Package then
13275 Restore_Nested_Formal (Ent);
13276 end if;
13278 Next_Entity (Ent);
13279 end loop;
13280 end if;
13281 end Restore_Nested_Formal;
13283 -- Start of processing for Restore_Private_Views
13285 begin
13286 M := First_Elmt (Exchanged_Views);
13287 while Present (M) loop
13288 Typ := Node (M);
13290 -- Subtypes of types whose views have been exchanged, and that are
13291 -- defined within the instance, were not on the Private_Dependents
13292 -- list on entry to the instance, so they have to be exchanged
13293 -- explicitly now, in order to remain consistent with the view of the
13294 -- parent type.
13296 if Ekind_In (Typ, E_Private_Type,
13297 E_Limited_Private_Type,
13298 E_Record_Type_With_Private)
13299 then
13300 Dep_Elmt := First_Elmt (Private_Dependents (Typ));
13301 while Present (Dep_Elmt) loop
13302 Dep_Typ := Node (Dep_Elmt);
13304 if Scope (Dep_Typ) = Pack_Id
13305 and then Present (Full_View (Dep_Typ))
13306 then
13307 Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
13308 Exchange_Declarations (Dep_Typ);
13309 end if;
13311 Next_Elmt (Dep_Elmt);
13312 end loop;
13313 end if;
13315 Exchange_Declarations (Node (M));
13316 Next_Elmt (M);
13317 end loop;
13319 if No (Pack_Id) then
13320 return;
13321 end if;
13323 -- Make the generic formal parameters private, and make the formal types
13324 -- into subtypes of the actuals again.
13326 E := First_Entity (Pack_Id);
13327 while Present (E) loop
13328 Set_Is_Hidden (E, True);
13330 if Is_Type (E)
13331 and then Nkind (Parent (E)) = N_Subtype_Declaration
13332 then
13333 -- If the actual for E is itself a generic actual type from
13334 -- an enclosing instance, E is still a generic actual type
13335 -- outside of the current instance. This matter when resolving
13336 -- an overloaded call that may be ambiguous in the enclosing
13337 -- instance, when two of its actuals coincide.
13339 if Is_Entity_Name (Subtype_Indication (Parent (E)))
13340 and then Is_Generic_Actual_Type
13341 (Entity (Subtype_Indication (Parent (E))))
13342 then
13343 null;
13344 else
13345 Set_Is_Generic_Actual_Type (E, False);
13346 end if;
13348 -- An unusual case of aliasing: the actual may also be directly
13349 -- visible in the generic, and be private there, while it is fully
13350 -- visible in the context of the instance. The internal subtype
13351 -- is private in the instance but has full visibility like its
13352 -- parent in the enclosing scope. This enforces the invariant that
13353 -- the privacy status of all private dependents of a type coincide
13354 -- with that of the parent type. This can only happen when a
13355 -- generic child unit is instantiated within a sibling.
13357 if Is_Private_Type (E)
13358 and then not Is_Private_Type (Etype (E))
13359 then
13360 Exchange_Declarations (E);
13361 end if;
13363 elsif Ekind (E) = E_Package then
13365 -- The end of the renaming list is the renaming of the generic
13366 -- package itself. If the instance is a subprogram, all entities
13367 -- in the corresponding package are renamings. If this entity is
13368 -- a formal package, make its own formals private as well. The
13369 -- actual in this case is itself the renaming of an instantiation.
13370 -- If the entity is not a package renaming, it is the entity
13371 -- created to validate formal package actuals: ignore it.
13373 -- If the actual is itself a formal package for the enclosing
13374 -- generic, or the actual for such a formal package, it remains
13375 -- visible on exit from the instance, and therefore nothing needs
13376 -- to be done either, except to keep it accessible.
13378 if Is_Package and then Renamed_Object (E) = Pack_Id then
13379 exit;
13381 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
13382 null;
13384 elsif
13385 Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
13386 then
13387 Set_Is_Hidden (E, False);
13389 else
13390 declare
13391 Act_P : constant Entity_Id := Renamed_Object (E);
13392 Id : Entity_Id;
13394 begin
13395 Id := First_Entity (Act_P);
13396 while Present (Id)
13397 and then Id /= First_Private_Entity (Act_P)
13398 loop
13399 exit when Ekind (Id) = E_Package
13400 and then Renamed_Object (Id) = Act_P;
13402 Set_Is_Hidden (Id, True);
13403 Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
13405 if Ekind (Id) = E_Package then
13406 Restore_Nested_Formal (Id);
13407 end if;
13409 Next_Entity (Id);
13410 end loop;
13411 end;
13412 end if;
13413 end if;
13415 Next_Entity (E);
13416 end loop;
13417 end Restore_Private_Views;
13419 --------------
13420 -- Save_Env --
13421 --------------
13423 procedure Save_Env
13424 (Gen_Unit : Entity_Id;
13425 Act_Unit : Entity_Id)
13427 begin
13428 Init_Env;
13429 Set_Instance_Env (Gen_Unit, Act_Unit);
13430 end Save_Env;
13432 ----------------------------
13433 -- Save_Global_References --
13434 ----------------------------
13436 procedure Save_Global_References (N : Node_Id) is
13437 Gen_Scope : Entity_Id;
13438 E : Entity_Id;
13439 N2 : Node_Id;
13441 function Is_Global (E : Entity_Id) return Boolean;
13442 -- Check whether entity is defined outside of generic unit. Examine the
13443 -- scope of an entity, and the scope of the scope, etc, until we find
13444 -- either Standard, in which case the entity is global, or the generic
13445 -- unit itself, which indicates that the entity is local. If the entity
13446 -- is the generic unit itself, as in the case of a recursive call, or
13447 -- the enclosing generic unit, if different from the current scope, then
13448 -- it is local as well, because it will be replaced at the point of
13449 -- instantiation. On the other hand, if it is a reference to a child
13450 -- unit of a common ancestor, which appears in an instantiation, it is
13451 -- global because it is used to denote a specific compilation unit at
13452 -- the time the instantiations will be analyzed.
13454 procedure Reset_Entity (N : Node_Id);
13455 -- Save semantic information on global entity so that it is not resolved
13456 -- again at instantiation time.
13458 procedure Save_Entity_Descendants (N : Node_Id);
13459 -- Apply Save_Global_References to the two syntactic descendants of
13460 -- non-terminal nodes that carry an Associated_Node and are processed
13461 -- through Reset_Entity. Once the global entity (if any) has been
13462 -- captured together with its type, only two syntactic descendants need
13463 -- to be traversed to complete the processing of the tree rooted at N.
13464 -- This applies to Selected_Components, Expanded_Names, and to Operator
13465 -- nodes. N can also be a character literal, identifier, or operator
13466 -- symbol node, but the call has no effect in these cases.
13468 procedure Save_Global_Defaults (N1, N2 : Node_Id);
13469 -- Default actuals in nested instances must be handled specially
13470 -- because there is no link to them from the original tree. When an
13471 -- actual subprogram is given by a default, we add an explicit generic
13472 -- association for it in the instantiation node. When we save the
13473 -- global references on the name of the instance, we recover the list
13474 -- of generic associations, and add an explicit one to the original
13475 -- generic tree, through which a global actual can be preserved.
13476 -- Similarly, if a child unit is instantiated within a sibling, in the
13477 -- context of the parent, we must preserve the identifier of the parent
13478 -- so that it can be properly resolved in a subsequent instantiation.
13480 procedure Save_Global_Descendant (D : Union_Id);
13481 -- Apply Save_Global_References recursively to the descendents of the
13482 -- current node.
13484 procedure Save_References (N : Node_Id);
13485 -- This is the recursive procedure that does the work, once the
13486 -- enclosing generic scope has been established.
13488 ---------------
13489 -- Is_Global --
13490 ---------------
13492 function Is_Global (E : Entity_Id) return Boolean is
13493 Se : Entity_Id;
13495 function Is_Instance_Node (Decl : Node_Id) return Boolean;
13496 -- Determine whether the parent node of a reference to a child unit
13497 -- denotes an instantiation or a formal package, in which case the
13498 -- reference to the child unit is global, even if it appears within
13499 -- the current scope (e.g. when the instance appears within the body
13500 -- of an ancestor).
13502 ----------------------
13503 -- Is_Instance_Node --
13504 ----------------------
13506 function Is_Instance_Node (Decl : Node_Id) return Boolean is
13507 begin
13508 return Nkind (Decl) in N_Generic_Instantiation
13509 or else
13510 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
13511 end Is_Instance_Node;
13513 -- Start of processing for Is_Global
13515 begin
13516 if E = Gen_Scope then
13517 return False;
13519 elsif E = Standard_Standard then
13520 return True;
13522 elsif Is_Child_Unit (E)
13523 and then (Is_Instance_Node (Parent (N2))
13524 or else (Nkind (Parent (N2)) = N_Expanded_Name
13525 and then N2 = Selector_Name (Parent (N2))
13526 and then
13527 Is_Instance_Node (Parent (Parent (N2)))))
13528 then
13529 return True;
13531 else
13532 Se := Scope (E);
13533 while Se /= Gen_Scope loop
13534 if Se = Standard_Standard then
13535 return True;
13536 else
13537 Se := Scope (Se);
13538 end if;
13539 end loop;
13541 return False;
13542 end if;
13543 end Is_Global;
13545 ------------------
13546 -- Reset_Entity --
13547 ------------------
13549 procedure Reset_Entity (N : Node_Id) is
13551 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
13552 -- If the type of N2 is global to the generic unit, save the type in
13553 -- the generic node. Just as we perform name capture for explicit
13554 -- references within the generic, we must capture the global types
13555 -- of local entities because they may participate in resolution in
13556 -- the instance.
13558 function Top_Ancestor (E : Entity_Id) return Entity_Id;
13559 -- Find the ultimate ancestor of the current unit. If it is not a
13560 -- generic unit, then the name of the current unit in the prefix of
13561 -- an expanded name must be replaced with its generic homonym to
13562 -- ensure that it will be properly resolved in an instance.
13564 ---------------------
13565 -- Set_Global_Type --
13566 ---------------------
13568 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
13569 Typ : constant Entity_Id := Etype (N2);
13571 begin
13572 Set_Etype (N, Typ);
13574 if Entity (N) /= N2
13575 and then Has_Private_View (Entity (N))
13576 then
13577 -- If the entity of N is not the associated node, this is a
13578 -- nested generic and it has an associated node as well, whose
13579 -- type is already the full view (see below). Indicate that the
13580 -- original node has a private view.
13582 Set_Has_Private_View (N);
13583 end if;
13585 -- If not a private type, nothing else to do
13587 if not Is_Private_Type (Typ) then
13588 if Is_Array_Type (Typ)
13589 and then Is_Private_Type (Component_Type (Typ))
13590 then
13591 Set_Has_Private_View (N);
13592 end if;
13594 -- If it is a derivation of a private type in a context where no
13595 -- full view is needed, nothing to do either.
13597 elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
13598 null;
13600 -- Otherwise mark the type for flipping and use the full view when
13601 -- available.
13603 else
13604 Set_Has_Private_View (N);
13606 if Present (Full_View (Typ)) then
13607 Set_Etype (N2, Full_View (Typ));
13608 end if;
13609 end if;
13610 end Set_Global_Type;
13612 ------------------
13613 -- Top_Ancestor --
13614 ------------------
13616 function Top_Ancestor (E : Entity_Id) return Entity_Id is
13617 Par : Entity_Id;
13619 begin
13620 Par := E;
13621 while Is_Child_Unit (Par) loop
13622 Par := Scope (Par);
13623 end loop;
13625 return Par;
13626 end Top_Ancestor;
13628 -- Start of processing for Reset_Entity
13630 begin
13631 N2 := Get_Associated_Node (N);
13632 E := Entity (N2);
13634 if Present (E) then
13636 -- If the node is an entry call to an entry in an enclosing task,
13637 -- it is rewritten as a selected component. No global entity to
13638 -- preserve in this case, since the expansion will be redone in
13639 -- the instance.
13641 if not Nkind_In (E, N_Defining_Identifier,
13642 N_Defining_Character_Literal,
13643 N_Defining_Operator_Symbol)
13644 then
13645 Set_Associated_Node (N, Empty);
13646 Set_Etype (N, Empty);
13647 return;
13648 end if;
13650 -- If the entity is an itype created as a subtype of an access
13651 -- type with a null exclusion restore source entity for proper
13652 -- visibility. The itype will be created anew in the instance.
13654 if Is_Itype (E)
13655 and then Ekind (E) = E_Access_Subtype
13656 and then Is_Entity_Name (N)
13657 and then Chars (Etype (E)) = Chars (N)
13658 then
13659 E := Etype (E);
13660 Set_Entity (N2, E);
13661 Set_Etype (N2, E);
13662 end if;
13664 if Is_Global (E) then
13666 -- If the entity is a package renaming that is the prefix of
13667 -- an expanded name, it has been rewritten as the renamed
13668 -- package, which is necessary semantically but complicates
13669 -- ASIS tree traversal, so we recover the original entity to
13670 -- expose the renaming. Take into account that the context may
13671 -- be a nested generic, that the original node may itself have
13672 -- an associated node that had better be an entity, and that
13673 -- the current node is still a selected component.
13675 if Ekind (E) = E_Package
13676 and then Nkind (N) = N_Selected_Component
13677 and then Nkind (Parent (N)) = N_Expanded_Name
13678 and then Present (Original_Node (N2))
13679 and then Is_Entity_Name (Original_Node (N2))
13680 and then Present (Entity (Original_Node (N2)))
13681 then
13682 if Is_Global (Entity (Original_Node (N2))) then
13683 N2 := Original_Node (N2);
13684 Set_Associated_Node (N, N2);
13685 Set_Global_Type (N, N2);
13687 else
13688 -- Renaming is local, and will be resolved in instance
13690 Set_Associated_Node (N, Empty);
13691 Set_Etype (N, Empty);
13692 end if;
13694 else
13695 Set_Global_Type (N, N2);
13696 end if;
13698 elsif Nkind (N) = N_Op_Concat
13699 and then Is_Generic_Type (Etype (N2))
13700 and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
13701 or else
13702 Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
13703 and then Is_Intrinsic_Subprogram (E)
13704 then
13705 null;
13707 else
13708 -- Entity is local. Mark generic node as unresolved.
13709 -- Note that now it does not have an entity.
13711 Set_Associated_Node (N, Empty);
13712 Set_Etype (N, Empty);
13713 end if;
13715 if Nkind (Parent (N)) in N_Generic_Instantiation
13716 and then N = Name (Parent (N))
13717 then
13718 Save_Global_Defaults (Parent (N), Parent (N2));
13719 end if;
13721 elsif Nkind (Parent (N)) = N_Selected_Component
13722 and then Nkind (Parent (N2)) = N_Expanded_Name
13723 then
13724 if Is_Global (Entity (Parent (N2))) then
13725 Change_Selected_Component_To_Expanded_Name (Parent (N));
13726 Set_Associated_Node (Parent (N), Parent (N2));
13727 Set_Global_Type (Parent (N), Parent (N2));
13728 Save_Entity_Descendants (N);
13730 -- If this is a reference to the current generic entity, replace
13731 -- by the name of the generic homonym of the current package. This
13732 -- is because in an instantiation Par.P.Q will not resolve to the
13733 -- name of the instance, whose enclosing scope is not necessarily
13734 -- Par. We use the generic homonym rather that the name of the
13735 -- generic itself because it may be hidden by a local declaration.
13737 elsif In_Open_Scopes (Entity (Parent (N2)))
13738 and then not
13739 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
13740 then
13741 if Ekind (Entity (Parent (N2))) = E_Generic_Package then
13742 Rewrite (Parent (N),
13743 Make_Identifier (Sloc (N),
13744 Chars =>
13745 Chars (Generic_Homonym (Entity (Parent (N2))))));
13746 else
13747 Rewrite (Parent (N),
13748 Make_Identifier (Sloc (N),
13749 Chars => Chars (Selector_Name (Parent (N2)))));
13750 end if;
13751 end if;
13753 if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
13754 and then Parent (N) = Name (Parent (Parent (N)))
13755 then
13756 Save_Global_Defaults
13757 (Parent (Parent (N)), Parent (Parent ((N2))));
13758 end if;
13760 -- A selected component may denote a static constant that has been
13761 -- folded. If the static constant is global to the generic, capture
13762 -- its value. Otherwise the folding will happen in any instantiation.
13764 elsif Nkind (Parent (N)) = N_Selected_Component
13765 and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
13766 then
13767 if Present (Entity (Original_Node (Parent (N2))))
13768 and then Is_Global (Entity (Original_Node (Parent (N2))))
13769 then
13770 Rewrite (Parent (N), New_Copy (Parent (N2)));
13771 Set_Analyzed (Parent (N), False);
13773 else
13774 null;
13775 end if;
13777 -- A selected component may be transformed into a parameterless
13778 -- function call. If the called entity is global, rewrite the node
13779 -- appropriately, i.e. as an extended name for the global entity.
13781 elsif Nkind (Parent (N)) = N_Selected_Component
13782 and then Nkind (Parent (N2)) = N_Function_Call
13783 and then N = Selector_Name (Parent (N))
13784 then
13785 if No (Parameter_Associations (Parent (N2))) then
13786 if Is_Global (Entity (Name (Parent (N2)))) then
13787 Change_Selected_Component_To_Expanded_Name (Parent (N));
13788 Set_Associated_Node (Parent (N), Name (Parent (N2)));
13789 Set_Global_Type (Parent (N), Name (Parent (N2)));
13790 Save_Entity_Descendants (N);
13792 else
13793 Set_Is_Prefixed_Call (Parent (N));
13794 Set_Associated_Node (N, Empty);
13795 Set_Etype (N, Empty);
13796 end if;
13798 -- In Ada 2005, X.F may be a call to a primitive operation,
13799 -- rewritten as F (X). This rewriting will be done again in an
13800 -- instance, so keep the original node. Global entities will be
13801 -- captured as for other constructs. Indicate that this must
13802 -- resolve as a call, to prevent accidental overloading in the
13803 -- instance, if both a component and a primitive operation appear
13804 -- as candidates.
13806 else
13807 Set_Is_Prefixed_Call (Parent (N));
13808 end if;
13810 -- Entity is local. Reset in generic unit, so that node is resolved
13811 -- anew at the point of instantiation.
13813 else
13814 Set_Associated_Node (N, Empty);
13815 Set_Etype (N, Empty);
13816 end if;
13817 end Reset_Entity;
13819 -----------------------------
13820 -- Save_Entity_Descendants --
13821 -----------------------------
13823 procedure Save_Entity_Descendants (N : Node_Id) is
13824 begin
13825 case Nkind (N) is
13826 when N_Binary_Op =>
13827 Save_Global_Descendant (Union_Id (Left_Opnd (N)));
13828 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13830 when N_Unary_Op =>
13831 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13833 when N_Expanded_Name | N_Selected_Component =>
13834 Save_Global_Descendant (Union_Id (Prefix (N)));
13835 Save_Global_Descendant (Union_Id (Selector_Name (N)));
13837 when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
13838 null;
13840 when others =>
13841 raise Program_Error;
13842 end case;
13843 end Save_Entity_Descendants;
13845 --------------------------
13846 -- Save_Global_Defaults --
13847 --------------------------
13849 procedure Save_Global_Defaults (N1, N2 : Node_Id) is
13850 Loc : constant Source_Ptr := Sloc (N1);
13851 Assoc2 : constant List_Id := Generic_Associations (N2);
13852 Gen_Id : constant Entity_Id := Get_Generic_Entity (N2);
13853 Assoc1 : List_Id;
13854 Act1 : Node_Id;
13855 Act2 : Node_Id;
13856 Def : Node_Id;
13857 Ndec : Node_Id;
13858 Subp : Entity_Id;
13859 Actual : Entity_Id;
13861 begin
13862 Assoc1 := Generic_Associations (N1);
13864 if Present (Assoc1) then
13865 Act1 := First (Assoc1);
13866 else
13867 Act1 := Empty;
13868 Set_Generic_Associations (N1, New_List);
13869 Assoc1 := Generic_Associations (N1);
13870 end if;
13872 if Present (Assoc2) then
13873 Act2 := First (Assoc2);
13874 else
13875 return;
13876 end if;
13878 while Present (Act1) and then Present (Act2) loop
13879 Next (Act1);
13880 Next (Act2);
13881 end loop;
13883 -- Find the associations added for default subprograms
13885 if Present (Act2) then
13886 while Nkind (Act2) /= N_Generic_Association
13887 or else No (Entity (Selector_Name (Act2)))
13888 or else not Is_Overloadable (Entity (Selector_Name (Act2)))
13889 loop
13890 Next (Act2);
13891 end loop;
13893 -- Add a similar association if the default is global. The
13894 -- renaming declaration for the actual has been analyzed, and
13895 -- its alias is the program it renames. Link the actual in the
13896 -- original generic tree with the node in the analyzed tree.
13898 while Present (Act2) loop
13899 Subp := Entity (Selector_Name (Act2));
13900 Def := Explicit_Generic_Actual_Parameter (Act2);
13902 -- Following test is defence against rubbish errors
13904 if No (Alias (Subp)) then
13905 return;
13906 end if;
13908 -- Retrieve the resolved actual from the renaming declaration
13909 -- created for the instantiated formal.
13911 Actual := Entity (Name (Parent (Parent (Subp))));
13912 Set_Entity (Def, Actual);
13913 Set_Etype (Def, Etype (Actual));
13915 if Is_Global (Actual) then
13916 Ndec :=
13917 Make_Generic_Association (Loc,
13918 Selector_Name => New_Occurrence_Of (Subp, Loc),
13919 Explicit_Generic_Actual_Parameter =>
13920 New_Occurrence_Of (Actual, Loc));
13922 Set_Associated_Node
13923 (Explicit_Generic_Actual_Parameter (Ndec), Def);
13925 Append (Ndec, Assoc1);
13927 -- If there are other defaults, add a dummy association in case
13928 -- there are other defaulted formals with the same name.
13930 elsif Present (Next (Act2)) then
13931 Ndec :=
13932 Make_Generic_Association (Loc,
13933 Selector_Name => New_Occurrence_Of (Subp, Loc),
13934 Explicit_Generic_Actual_Parameter => Empty);
13936 Append (Ndec, Assoc1);
13937 end if;
13939 Next (Act2);
13940 end loop;
13941 end if;
13943 if Nkind (Name (N1)) = N_Identifier
13944 and then Is_Child_Unit (Gen_Id)
13945 and then Is_Global (Gen_Id)
13946 and then Is_Generic_Unit (Scope (Gen_Id))
13947 and then In_Open_Scopes (Scope (Gen_Id))
13948 then
13949 -- This is an instantiation of a child unit within a sibling, so
13950 -- that the generic parent is in scope. An eventual instance must
13951 -- occur within the scope of an instance of the parent. Make name
13952 -- in instance into an expanded name, to preserve the identifier
13953 -- of the parent, so it can be resolved subsequently.
13955 Rewrite (Name (N2),
13956 Make_Expanded_Name (Loc,
13957 Chars => Chars (Gen_Id),
13958 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13959 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13960 Set_Entity (Name (N2), Gen_Id);
13962 Rewrite (Name (N1),
13963 Make_Expanded_Name (Loc,
13964 Chars => Chars (Gen_Id),
13965 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13966 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13968 Set_Associated_Node (Name (N1), Name (N2));
13969 Set_Associated_Node (Prefix (Name (N1)), Empty);
13970 Set_Associated_Node
13971 (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
13972 Set_Etype (Name (N1), Etype (Gen_Id));
13973 end if;
13975 end Save_Global_Defaults;
13977 ----------------------------
13978 -- Save_Global_Descendant --
13979 ----------------------------
13981 procedure Save_Global_Descendant (D : Union_Id) is
13982 N1 : Node_Id;
13984 begin
13985 if D in Node_Range then
13986 if D = Union_Id (Empty) then
13987 null;
13989 elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
13990 Save_References (Node_Id (D));
13991 end if;
13993 elsif D in List_Range then
13994 if D = Union_Id (No_List) or else Is_Empty_List (List_Id (D)) then
13995 null;
13997 else
13998 N1 := First (List_Id (D));
13999 while Present (N1) loop
14000 Save_References (N1);
14001 Next (N1);
14002 end loop;
14003 end if;
14005 -- Element list or other non-node field, nothing to do
14007 else
14008 null;
14009 end if;
14010 end Save_Global_Descendant;
14012 ---------------------
14013 -- Save_References --
14014 ---------------------
14016 -- This is the recursive procedure that does the work once the enclosing
14017 -- generic scope has been established. We have to treat specially a
14018 -- number of node rewritings that are required by semantic processing
14019 -- and which change the kind of nodes in the generic copy: typically
14020 -- constant-folding, replacing an operator node by a string literal, or
14021 -- a selected component by an expanded name. In each of those cases, the
14022 -- transformation is propagated to the generic unit.
14024 procedure Save_References (N : Node_Id) is
14025 Loc : constant Source_Ptr := Sloc (N);
14027 begin
14028 if N = Empty then
14029 null;
14031 elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
14032 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14033 Reset_Entity (N);
14035 elsif Nkind (N) = N_Operator_Symbol
14036 and then Nkind (Get_Associated_Node (N)) = N_String_Literal
14037 then
14038 Change_Operator_Symbol_To_String_Literal (N);
14039 end if;
14041 elsif Nkind (N) in N_Op then
14042 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14043 if Nkind (N) = N_Op_Concat then
14044 Set_Is_Component_Left_Opnd (N,
14045 Is_Component_Left_Opnd (Get_Associated_Node (N)));
14047 Set_Is_Component_Right_Opnd (N,
14048 Is_Component_Right_Opnd (Get_Associated_Node (N)));
14049 end if;
14051 Reset_Entity (N);
14053 else
14054 -- Node may be transformed into call to a user-defined operator
14056 N2 := Get_Associated_Node (N);
14058 if Nkind (N2) = N_Function_Call then
14059 E := Entity (Name (N2));
14061 if Present (E)
14062 and then Is_Global (E)
14063 then
14064 Set_Etype (N, Etype (N2));
14065 else
14066 Set_Associated_Node (N, Empty);
14067 Set_Etype (N, Empty);
14068 end if;
14070 elsif Nkind_In (N2, N_Integer_Literal,
14071 N_Real_Literal,
14072 N_String_Literal)
14073 then
14074 if Present (Original_Node (N2))
14075 and then Nkind (Original_Node (N2)) = Nkind (N)
14076 then
14078 -- Operation was constant-folded. Whenever possible,
14079 -- recover semantic information from unfolded node,
14080 -- for ASIS use.
14082 Set_Associated_Node (N, Original_Node (N2));
14084 if Nkind (N) = N_Op_Concat then
14085 Set_Is_Component_Left_Opnd (N,
14086 Is_Component_Left_Opnd (Get_Associated_Node (N)));
14087 Set_Is_Component_Right_Opnd (N,
14088 Is_Component_Right_Opnd (Get_Associated_Node (N)));
14089 end if;
14091 Reset_Entity (N);
14093 else
14094 -- If original node is already modified, propagate
14095 -- constant-folding to template.
14097 Rewrite (N, New_Copy (N2));
14098 Set_Analyzed (N, False);
14099 end if;
14101 elsif Nkind (N2) = N_Identifier
14102 and then Ekind (Entity (N2)) = E_Enumeration_Literal
14103 then
14104 -- Same if call was folded into a literal, but in this case
14105 -- retain the entity to avoid spurious ambiguities if it is
14106 -- overloaded at the point of instantiation or inlining.
14108 Rewrite (N, New_Copy (N2));
14109 Set_Analyzed (N, False);
14110 end if;
14111 end if;
14113 -- Complete operands check if node has not been constant-folded
14115 if Nkind (N) in N_Op then
14116 Save_Entity_Descendants (N);
14117 end if;
14119 elsif Nkind (N) = N_Identifier then
14120 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
14122 -- If this is a discriminant reference, always save it. It is
14123 -- used in the instance to find the corresponding discriminant
14124 -- positionally rather than by name.
14126 Set_Original_Discriminant
14127 (N, Original_Discriminant (Get_Associated_Node (N)));
14128 Reset_Entity (N);
14130 else
14131 N2 := Get_Associated_Node (N);
14133 if Nkind (N2) = N_Function_Call then
14134 E := Entity (Name (N2));
14136 -- Name resolves to a call to parameterless function. If
14137 -- original entity is global, mark node as resolved.
14139 if Present (E)
14140 and then Is_Global (E)
14141 then
14142 Set_Etype (N, Etype (N2));
14143 else
14144 Set_Associated_Node (N, Empty);
14145 Set_Etype (N, Empty);
14146 end if;
14148 elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
14149 and then Is_Entity_Name (Original_Node (N2))
14150 then
14151 -- Name resolves to named number that is constant-folded,
14152 -- We must preserve the original name for ASIS use, and
14153 -- undo the constant-folding, which will be repeated in
14154 -- each instance.
14156 Set_Associated_Node (N, Original_Node (N2));
14157 Reset_Entity (N);
14159 elsif Nkind (N2) = N_String_Literal then
14161 -- Name resolves to string literal. Perform the same
14162 -- replacement in generic.
14164 Rewrite (N, New_Copy (N2));
14166 elsif Nkind (N2) = N_Explicit_Dereference then
14168 -- An identifier is rewritten as a dereference if it is the
14169 -- prefix in an implicit dereference (call or attribute).
14170 -- The analysis of an instantiation will expand the node
14171 -- again, so we preserve the original tree but link it to
14172 -- the resolved entity in case it is global.
14174 if Is_Entity_Name (Prefix (N2))
14175 and then Present (Entity (Prefix (N2)))
14176 and then Is_Global (Entity (Prefix (N2)))
14177 then
14178 Set_Associated_Node (N, Prefix (N2));
14180 elsif Nkind (Prefix (N2)) = N_Function_Call
14181 and then Is_Global (Entity (Name (Prefix (N2))))
14182 then
14183 Rewrite (N,
14184 Make_Explicit_Dereference (Loc,
14185 Prefix => Make_Function_Call (Loc,
14186 Name =>
14187 New_Occurrence_Of (Entity (Name (Prefix (N2))),
14188 Loc))));
14190 else
14191 Set_Associated_Node (N, Empty);
14192 Set_Etype (N, Empty);
14193 end if;
14195 -- The subtype mark of a nominally unconstrained object is
14196 -- rewritten as a subtype indication using the bounds of the
14197 -- expression. Recover the original subtype mark.
14199 elsif Nkind (N2) = N_Subtype_Indication
14200 and then Is_Entity_Name (Original_Node (N2))
14201 then
14202 Set_Associated_Node (N, Original_Node (N2));
14203 Reset_Entity (N);
14205 else
14206 null;
14207 end if;
14208 end if;
14210 elsif Nkind (N) in N_Entity then
14211 null;
14213 else
14214 declare
14215 Qual : Node_Id := Empty;
14216 Typ : Entity_Id := Empty;
14217 Nam : Node_Id;
14219 use Atree.Unchecked_Access;
14220 -- This code section is part of implementing an untyped tree
14221 -- traversal, so it needs direct access to node fields.
14223 begin
14224 if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
14225 N2 := Get_Associated_Node (N);
14227 if No (N2) then
14228 Typ := Empty;
14229 else
14230 Typ := Etype (N2);
14232 -- In an instance within a generic, use the name of the
14233 -- actual and not the original generic parameter. If the
14234 -- actual is global in the current generic it must be
14235 -- preserved for its instantiation.
14237 if Nkind (Parent (Typ)) = N_Subtype_Declaration
14238 and then
14239 Present (Generic_Parent_Type (Parent (Typ)))
14240 then
14241 Typ := Base_Type (Typ);
14242 Set_Etype (N2, Typ);
14243 end if;
14244 end if;
14246 if No (N2) or else No (Typ) or else not Is_Global (Typ) then
14247 Set_Associated_Node (N, Empty);
14249 -- If the aggregate is an actual in a call, it has been
14250 -- resolved in the current context, to some local type.
14251 -- The enclosing call may have been disambiguated by the
14252 -- aggregate, and this disambiguation might fail at
14253 -- instantiation time because the type to which the
14254 -- aggregate did resolve is not preserved. In order to
14255 -- preserve some of this information, we wrap the
14256 -- aggregate in a qualified expression, using the id of
14257 -- its type. For further disambiguation we qualify the
14258 -- type name with its scope (if visible) because both
14259 -- id's will have corresponding entities in an instance.
14260 -- This resolves most of the problems with missing type
14261 -- information on aggregates in instances.
14263 if Nkind (N2) = Nkind (N)
14264 and then Nkind (Parent (N2)) in N_Subprogram_Call
14265 and then Comes_From_Source (Typ)
14266 then
14267 if Is_Immediately_Visible (Scope (Typ)) then
14268 Nam := Make_Selected_Component (Loc,
14269 Prefix =>
14270 Make_Identifier (Loc, Chars (Scope (Typ))),
14271 Selector_Name =>
14272 Make_Identifier (Loc, Chars (Typ)));
14273 else
14274 Nam := Make_Identifier (Loc, Chars (Typ));
14275 end if;
14277 Qual :=
14278 Make_Qualified_Expression (Loc,
14279 Subtype_Mark => Nam,
14280 Expression => Relocate_Node (N));
14281 end if;
14282 end if;
14284 Save_Global_Descendant (Field1 (N));
14285 Save_Global_Descendant (Field2 (N));
14286 Save_Global_Descendant (Field3 (N));
14287 Save_Global_Descendant (Field5 (N));
14289 if Present (Qual) then
14290 Rewrite (N, Qual);
14291 end if;
14293 -- All other cases than aggregates
14295 else
14296 Save_Global_Descendant (Field1 (N));
14297 Save_Global_Descendant (Field2 (N));
14298 Save_Global_Descendant (Field3 (N));
14299 Save_Global_Descendant (Field4 (N));
14300 Save_Global_Descendant (Field5 (N));
14301 end if;
14302 end;
14303 end if;
14305 -- If a node has aspects, references within their expressions must
14306 -- be saved separately, given they are not directly in the tree.
14308 if Has_Aspects (N) then
14309 declare
14310 Aspect : Node_Id;
14312 begin
14313 Aspect := First (Aspect_Specifications (N));
14314 while Present (Aspect) loop
14315 if Present (Expression (Aspect)) then
14316 Save_Global_References (Expression (Aspect));
14317 end if;
14319 Next (Aspect);
14320 end loop;
14321 end;
14322 end if;
14323 end Save_References;
14325 -- Start of processing for Save_Global_References
14327 begin
14328 Gen_Scope := Current_Scope;
14330 -- If the generic unit is a child unit, references to entities in the
14331 -- parent are treated as local, because they will be resolved anew in
14332 -- the context of the instance of the parent.
14334 while Is_Child_Unit (Gen_Scope)
14335 and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
14336 loop
14337 Gen_Scope := Scope (Gen_Scope);
14338 end loop;
14340 Save_References (N);
14341 end Save_Global_References;
14343 --------------------------------------
14344 -- Set_Copied_Sloc_For_Inlined_Body --
14345 --------------------------------------
14347 procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
14348 begin
14349 Create_Instantiation_Source (N, E, True, S_Adjustment);
14350 end Set_Copied_Sloc_For_Inlined_Body;
14352 ---------------------
14353 -- Set_Instance_Of --
14354 ---------------------
14356 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
14357 begin
14358 Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
14359 Generic_Renamings_HTable.Set (Generic_Renamings.Last);
14360 Generic_Renamings.Increment_Last;
14361 end Set_Instance_Of;
14363 --------------------
14364 -- Set_Next_Assoc --
14365 --------------------
14367 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
14368 begin
14369 Generic_Renamings.Table (E).Next_In_HTable := Next;
14370 end Set_Next_Assoc;
14372 -------------------
14373 -- Start_Generic --
14374 -------------------
14376 procedure Start_Generic is
14377 begin
14378 -- ??? More things could be factored out in this routine.
14379 -- Should probably be done at a later stage.
14381 Generic_Flags.Append (Inside_A_Generic);
14382 Inside_A_Generic := True;
14384 Expander_Mode_Save_And_Set (False);
14385 end Start_Generic;
14387 ----------------------
14388 -- Set_Instance_Env --
14389 ----------------------
14391 procedure Set_Instance_Env
14392 (Gen_Unit : Entity_Id;
14393 Act_Unit : Entity_Id)
14395 Assertion_Status : constant Boolean := Assertions_Enabled;
14396 Save_SPARK_Mode : constant SPARK_Mode_Type := SPARK_Mode;
14397 Save_SPARK_Mode_Pragma : constant Node_Id := SPARK_Mode_Pragma;
14399 begin
14400 -- Regardless of the current mode, predefined units are analyzed in the
14401 -- most current Ada mode, and earlier version Ada checks do not apply
14402 -- to predefined units. Nothing needs to be done for non-internal units.
14403 -- These are always analyzed in the current mode.
14405 if Is_Internal_File_Name
14406 (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
14407 Renamings_Included => True)
14408 then
14409 Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
14411 -- In Ada2012 we may want to enable assertions in an instance of a
14412 -- predefined unit, in which case we need to preserve the current
14413 -- setting for the Assertions_Enabled flag. This will become more
14414 -- critical when pre/postconditions are added to predefined units,
14415 -- as is already the case for some numeric libraries.
14417 if Ada_Version >= Ada_2012 then
14418 Assertions_Enabled := Assertion_Status;
14419 end if;
14421 -- SPARK_Mode for an instance is the one applicable at the point of
14422 -- instantiation.
14424 SPARK_Mode := Save_SPARK_Mode;
14425 SPARK_Mode_Pragma := Save_SPARK_Mode_Pragma;
14426 end if;
14428 Current_Instantiated_Parent :=
14429 (Gen_Id => Gen_Unit,
14430 Act_Id => Act_Unit,
14431 Next_In_HTable => Assoc_Null);
14432 end Set_Instance_Env;
14434 -----------------
14435 -- Switch_View --
14436 -----------------
14438 procedure Switch_View (T : Entity_Id) is
14439 BT : constant Entity_Id := Base_Type (T);
14440 Priv_Elmt : Elmt_Id := No_Elmt;
14441 Priv_Sub : Entity_Id;
14443 begin
14444 -- T may be private but its base type may have been exchanged through
14445 -- some other occurrence, in which case there is nothing to switch
14446 -- besides T itself. Note that a private dependent subtype of a private
14447 -- type might not have been switched even if the base type has been,
14448 -- because of the last branch of Check_Private_View (see comment there).
14450 if not Is_Private_Type (BT) then
14451 Prepend_Elmt (Full_View (T), Exchanged_Views);
14452 Exchange_Declarations (T);
14453 return;
14454 end if;
14456 Priv_Elmt := First_Elmt (Private_Dependents (BT));
14458 if Present (Full_View (BT)) then
14459 Prepend_Elmt (Full_View (BT), Exchanged_Views);
14460 Exchange_Declarations (BT);
14461 end if;
14463 while Present (Priv_Elmt) loop
14464 Priv_Sub := (Node (Priv_Elmt));
14466 -- We avoid flipping the subtype if the Etype of its full view is
14467 -- private because this would result in a malformed subtype. This
14468 -- occurs when the Etype of the subtype full view is the full view of
14469 -- the base type (and since the base types were just switched, the
14470 -- subtype is pointing to the wrong view). This is currently the case
14471 -- for tagged record types, access types (maybe more?) and needs to
14472 -- be resolved. ???
14474 if Present (Full_View (Priv_Sub))
14475 and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
14476 then
14477 Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
14478 Exchange_Declarations (Priv_Sub);
14479 end if;
14481 Next_Elmt (Priv_Elmt);
14482 end loop;
14483 end Switch_View;
14485 -----------------
14486 -- True_Parent --
14487 -----------------
14489 function True_Parent (N : Node_Id) return Node_Id is
14490 begin
14491 if Nkind (Parent (N)) = N_Subunit then
14492 return Parent (Corresponding_Stub (Parent (N)));
14493 else
14494 return Parent (N);
14495 end if;
14496 end True_Parent;
14498 -----------------------------
14499 -- Valid_Default_Attribute --
14500 -----------------------------
14502 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
14503 Attr_Id : constant Attribute_Id :=
14504 Get_Attribute_Id (Attribute_Name (Def));
14505 T : constant Entity_Id := Entity (Prefix (Def));
14506 Is_Fun : constant Boolean := (Ekind (Nam) = E_Function);
14507 F : Entity_Id;
14508 Num_F : Int;
14509 OK : Boolean;
14511 begin
14512 if No (T) or else T = Any_Id then
14513 return;
14514 end if;
14516 Num_F := 0;
14517 F := First_Formal (Nam);
14518 while Present (F) loop
14519 Num_F := Num_F + 1;
14520 Next_Formal (F);
14521 end loop;
14523 case Attr_Id is
14524 when Attribute_Adjacent | Attribute_Ceiling | Attribute_Copy_Sign |
14525 Attribute_Floor | Attribute_Fraction | Attribute_Machine |
14526 Attribute_Model | Attribute_Remainder | Attribute_Rounding |
14527 Attribute_Unbiased_Rounding =>
14528 OK := Is_Fun
14529 and then Num_F = 1
14530 and then Is_Floating_Point_Type (T);
14532 when Attribute_Image | Attribute_Pred | Attribute_Succ |
14533 Attribute_Value | Attribute_Wide_Image |
14534 Attribute_Wide_Value =>
14535 OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
14537 when Attribute_Max | Attribute_Min =>
14538 OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
14540 when Attribute_Input =>
14541 OK := (Is_Fun and then Num_F = 1);
14543 when Attribute_Output | Attribute_Read | Attribute_Write =>
14544 OK := (not Is_Fun and then Num_F = 2);
14546 when others =>
14547 OK := False;
14548 end case;
14550 if not OK then
14551 Error_Msg_N ("attribute reference has wrong profile for subprogram",
14552 Def);
14553 end if;
14554 end Valid_Default_Attribute;
14556 end Sem_Ch12;