[multiple changes]
[gcc.git] / gcc / ada / sem_ch12.adb
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 ------------------------------------------------------------------------------
25
26 with Aspects; use Aspects;
27 with Atree; use Atree;
28 with Debug; use Debug;
29 with Einfo; use Einfo;
30 with Elists; use Elists;
31 with Errout; use Errout;
32 with Expander; use Expander;
33 with Exp_Disp; use Exp_Disp;
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;
80
81 with GNAT.HTable;
82
83 package body Sem_Ch12 is
84
85 ----------------------------------------------------------
86 -- Implementation of Generic Analysis and Instantiation --
87 ----------------------------------------------------------
88
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:
94 --
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:
102
103 -- .-----------. .----------.
104 -- | semantic |<--------------| generic |
105 -- | copy | | unit |
106 -- | |==============>| |
107 -- |___________| global |__________|
108 -- references | | |
109 -- | | |
110 -- .-----|--|.
111 -- | .-----|---.
112 -- | | .----------.
113 -- | | | generic |
114 -- |__| | |
115 -- |__| instance |
116 -- |__________|
117
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.
123
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.
132
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.
139
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.
144
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.
160
161 -- Visibility within nested generic units requires special handling.
162 -- Consider the following scheme:
163
164 -- type Global is ... -- outside of generic unit.
165 -- generic ...
166 -- package Outer is
167 -- ...
168 -- type Semi_Global is ... -- global to inner.
169
170 -- generic ... -- 1
171 -- procedure inner (X1 : Global; X2 : Semi_Global);
172
173 -- procedure in2 is new inner (...); -- 4
174 -- end Outer;
175
176 -- package New_Outer is new Outer (...); -- 2
177 -- procedure New_Inner is new New_Outer.Inner (...); -- 3
178
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.
182
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).
186
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.
197
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.
202
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.
208
209 -- For example, it is possible to compile two packages A and B that
210 -- have the following structure:
211
212 -- package A is package B is
213 -- generic ... generic ...
214 -- package G_A is package G_B is
215
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 (..)
219
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.
225
226 ----------------------------------------------
227 -- Detection of Instantiation Circularities --
228 ----------------------------------------------
229
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.
237
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.
242
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.
246
247 --------------------------------------------------
248 -- Formal packages and partial parameterization --
249 --------------------------------------------------
250
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.
257
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.
263
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.
276
277 -- The list of declarations (renamings and copies of formals) is built
278 -- by Analyze_Associations, just as for regular instantiations.
279
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.
289
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.
293
294 -----------------------
295 -- Local subprograms --
296 -----------------------
297
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.
302
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.
310
311 -- The following procedures treat other kinds of formal parameters
312
313 procedure Analyze_Formal_Derived_Interface_Type
314 (N : Node_Id;
315 T : Entity_Id;
316 Def : Node_Id);
317
318 procedure Analyze_Formal_Derived_Type
319 (N : Node_Id;
320 T : Entity_Id;
321 Def : Node_Id);
322
323 procedure Analyze_Formal_Interface_Type
324 (N : Node_Id;
325 T : Entity_Id;
326 Def : Node_Id);
327
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.
333
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);
342
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
348
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
351
352 procedure Analyze_Generic_Formal_Part (N : Node_Id);
353 -- Analyze generic formal part
354
355 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
356 -- Create a new access type with the given designated type
357
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.
367
368 procedure Analyze_Subprogram_Instantiation
369 (N : Node_Id;
370 K : Entity_Kind);
371
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.
385
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.
389
390 procedure Check_Formal_Packages (P_Id : Entity_Id);
391 -- Apply the following to all formal packages in generic associations
392
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.
398
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.
405
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.
412
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.
420
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.
430
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.
441
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.
456
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.
462
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 ???
479
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.
490
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.
495
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.
505
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.
509
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.
513
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.
522
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.
537
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.
546
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.
557
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.
562
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)).
567
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.
574
575 procedure Remove_Parent (In_Body : Boolean := False);
576 -- Reverse effect after instantiation of child is complete
577
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.
585
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.
589
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.
597
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.
604
605 function Instantiate_Object
606 (Formal : Node_Id;
607 Actual : Node_Id;
608 Analyzed_Formal : Node_Id) return List_Id;
609
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;
615
616 function Instantiate_Formal_Subprogram
617 (Formal : Node_Id;
618 Actual : Node_Id;
619 Analyzed_Formal : Node_Id) return Node_Id;
620
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.
633
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.
643
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.
649
650 function Is_In_Main_Unit (N : Node_Id) return Boolean;
651 -- Test if given node is in the main unit
652
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.
660 --
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.
665
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.
669
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.
679 --
680 -- Three kinds of source nodes have associated nodes:
681 --
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.
686 --
687 -- b) aggregates (N_Aggregate and N_Extension_Aggregate)
688 --
689 -- c) selected components (N_Selected_Component)
690 --
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.
694 --
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.
702 --
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.
706 --
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.
709 --
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.
713
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.
726
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.
736
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.
742
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.
746
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.
750
751 -------------------------------------------
752 -- Data Structures for Generic Renamings --
753 -------------------------------------------
754
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.
759
760 type Assoc_Ptr is new Int;
761
762 Assoc_Null : constant Assoc_Ptr := -1;
763
764 type Assoc is record
765 Gen_Id : Entity_Id;
766 Act_Id : Entity_Id;
767 Next_In_HTable : Assoc_Ptr;
768 end record;
769
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");
777
778 -- Variable to hold enclosing instantiation. When the environment is
779 -- saved for a subprogram inlining, the corresponding Act_Id is empty.
780
781 Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
782
783 -- Hash table for associations
784
785 HTable_Size : constant := 37;
786 type HTable_Range is range 0 .. HTable_Size - 1;
787
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;
792
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 => "=");
804
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.
810
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.
815
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.
824
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).
830
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.
835
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;
845
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");
853
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.
861
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).
865
866 ------------------------------------
867 -- Structures for Error Reporting --
868 ------------------------------------
869
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.
874
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.
880
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.
887
888 ------------------------------------------------------------
889 -- Data structure for keeping track when inside a Generic --
890 ------------------------------------------------------------
891
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.
894
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");
902
903 ---------------------------
904 -- Abandon_Instantiation --
905 ---------------------------
906
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;
912
913 --------------------------
914 -- Analyze_Associations --
915 --------------------------
916
917 function Analyze_Associations
918 (I_Node : Node_Id;
919 Formals : List_Id;
920 F_Copy : List_Id) return List_Id
921 is
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));
927
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;
936
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.
942
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.
947
948 Is_Named_Assoc : Boolean;
949 Num_Matched : Int := 0;
950 Num_Actuals : Int := 0;
951
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.
956
957 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id);
958 -- Apply RM 12.3 (9): if a formal subprogram is overloaded, the instance
959 -- cannot have a named association for it. AI05-0025 extends this rule
960 -- to formals of formal packages by AI05-0025, and it also applies to
961 -- box-initialized formals.
962
963 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean;
964 -- Determine whether the parameter types and the return type of Subp
965 -- are fully defined at the point of instantiation.
966
967 function Matching_Actual
968 (F : Entity_Id;
969 A_F : Entity_Id) return Node_Id;
970 -- Find actual that corresponds to a given a formal parameter. If the
971 -- actuals are positional, return the next one, if any. If the actuals
972 -- are named, scan the parameter associations to find the right one.
973 -- A_F is the corresponding entity in the analyzed generic,which is
974 -- placed on the selector name for ASIS use.
975 --
976 -- In Ada 2005, a named association may be given with a box, in which
977 -- case Matching_Actual sets Found_Assoc to the generic association,
978 -- but return Empty for the actual itself. In this case the code below
979 -- creates a corresponding declaration for the formal.
980
981 function Partial_Parameterization return Boolean;
982 -- Ada 2005: if no match is found for a given formal, check if the
983 -- association for it includes a box, or whether the associations
984 -- include an Others clause.
985
986 procedure Process_Default (F : Entity_Id);
987 -- Add a copy of the declaration of generic formal F to the list of
988 -- associations, and add an explicit box association for F if there
989 -- is none yet, and the default comes from an Others_Choice.
990
991 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean;
992 -- Determine whether Subp renames one of the subprograms defined in the
993 -- generated package Standard.
994
995 procedure Set_Analyzed_Formal;
996 -- Find the node in the generic copy that corresponds to a given formal.
997 -- The semantic information on this node is used to perform legality
998 -- checks on the actuals. Because semantic analysis can introduce some
999 -- anonymous entities or modify the declaration node itself, the
1000 -- correspondence between the two lists is not one-one. In addition to
1001 -- anonymous types, the presence a formal equality will introduce an
1002 -- implicit declaration for the corresponding inequality.
1003
1004 ----------------------------------------
1005 -- Check_Overloaded_Formal_Subprogram --
1006 ----------------------------------------
1007
1008 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id) is
1009 Temp_Formal : Entity_Id;
1010
1011 begin
1012 Temp_Formal := First (Formals);
1013 while Present (Temp_Formal) loop
1014 if Nkind (Temp_Formal) in N_Formal_Subprogram_Declaration
1015 and then Temp_Formal /= Formal
1016 and then
1017 Chars (Defining_Unit_Name (Specification (Formal))) =
1018 Chars (Defining_Unit_Name (Specification (Temp_Formal)))
1019 then
1020 if Present (Found_Assoc) then
1021 Error_Msg_N
1022 ("named association not allowed for overloaded formal",
1023 Found_Assoc);
1024
1025 else
1026 Error_Msg_N
1027 ("named association not allowed for overloaded formal",
1028 Others_Choice);
1029 end if;
1030
1031 Abandon_Instantiation (Instantiation_Node);
1032 end if;
1033
1034 Next (Temp_Formal);
1035 end loop;
1036 end Check_Overloaded_Formal_Subprogram;
1037
1038 -------------------------------
1039 -- Has_Fully_Defined_Profile --
1040 -------------------------------
1041
1042 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean is
1043 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean;
1044 -- Determine whethet type Typ is fully defined
1045
1046 ---------------------------
1047 -- Is_Fully_Defined_Type --
1048 ---------------------------
1049
1050 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean is
1051 begin
1052 -- A private type without a full view is not fully defined
1053
1054 if Is_Private_Type (Typ)
1055 and then No (Full_View (Typ))
1056 then
1057 return False;
1058
1059 -- An incomplete type is never fully defined
1060
1061 elsif Is_Incomplete_Type (Typ) then
1062 return False;
1063
1064 -- All other types are fully defined
1065
1066 else
1067 return True;
1068 end if;
1069 end Is_Fully_Defined_Type;
1070
1071 -- Local declarations
1072
1073 Param : Entity_Id;
1074
1075 -- Start of processing for Has_Fully_Defined_Profile
1076
1077 begin
1078 -- Check the parameters
1079
1080 Param := First_Formal (Subp);
1081 while Present (Param) loop
1082 if not Is_Fully_Defined_Type (Etype (Param)) then
1083 return False;
1084 end if;
1085
1086 Next_Formal (Param);
1087 end loop;
1088
1089 -- Check the return type
1090
1091 return Is_Fully_Defined_Type (Etype (Subp));
1092 end Has_Fully_Defined_Profile;
1093
1094 ---------------------
1095 -- Matching_Actual --
1096 ---------------------
1097
1098 function Matching_Actual
1099 (F : Entity_Id;
1100 A_F : Entity_Id) return Node_Id
1101 is
1102 Prev : Node_Id;
1103 Act : Node_Id;
1104
1105 begin
1106 Is_Named_Assoc := False;
1107
1108 -- End of list of purely positional parameters
1109
1110 if No (Actual) or else Nkind (Actual) = N_Others_Choice then
1111 Found_Assoc := Empty;
1112 Act := Empty;
1113
1114 -- Case of positional parameter corresponding to current formal
1115
1116 elsif No (Selector_Name (Actual)) then
1117 Found_Assoc := Actual;
1118 Act := Explicit_Generic_Actual_Parameter (Actual);
1119 Num_Matched := Num_Matched + 1;
1120 Next (Actual);
1121
1122 -- Otherwise scan list of named actuals to find the one with the
1123 -- desired name. All remaining actuals have explicit names.
1124
1125 else
1126 Is_Named_Assoc := True;
1127 Found_Assoc := Empty;
1128 Act := Empty;
1129 Prev := Empty;
1130
1131 while Present (Actual) loop
1132 if Chars (Selector_Name (Actual)) = Chars (F) then
1133 Set_Entity (Selector_Name (Actual), A_F);
1134 Set_Etype (Selector_Name (Actual), Etype (A_F));
1135 Generate_Reference (A_F, Selector_Name (Actual));
1136 Found_Assoc := Actual;
1137 Act := Explicit_Generic_Actual_Parameter (Actual);
1138 Num_Matched := Num_Matched + 1;
1139 exit;
1140 end if;
1141
1142 Prev := Actual;
1143 Next (Actual);
1144 end loop;
1145
1146 -- Reset for subsequent searches. In most cases the named
1147 -- associations are in order. If they are not, we reorder them
1148 -- to avoid scanning twice the same actual. This is not just a
1149 -- question of efficiency: there may be multiple defaults with
1150 -- boxes that have the same name. In a nested instantiation we
1151 -- insert actuals for those defaults, and cannot rely on their
1152 -- names to disambiguate them.
1153
1154 if Actual = First_Named then
1155 Next (First_Named);
1156
1157 elsif Present (Actual) then
1158 Insert_Before (First_Named, Remove_Next (Prev));
1159 end if;
1160
1161 Actual := First_Named;
1162 end if;
1163
1164 if Is_Entity_Name (Act) and then Present (Entity (Act)) then
1165 Set_Used_As_Generic_Actual (Entity (Act));
1166 end if;
1167
1168 return Act;
1169 end Matching_Actual;
1170
1171 ------------------------------
1172 -- Partial_Parameterization --
1173 ------------------------------
1174
1175 function Partial_Parameterization return Boolean is
1176 begin
1177 return Others_Present
1178 or else (Present (Found_Assoc) and then Box_Present (Found_Assoc));
1179 end Partial_Parameterization;
1180
1181 ---------------------
1182 -- Process_Default --
1183 ---------------------
1184
1185 procedure Process_Default (F : Entity_Id) is
1186 Loc : constant Source_Ptr := Sloc (I_Node);
1187 F_Id : constant Entity_Id := Defining_Entity (F);
1188 Decl : Node_Id;
1189 Default : Node_Id;
1190 Id : Entity_Id;
1191
1192 begin
1193 -- Append copy of formal declaration to associations, and create new
1194 -- defining identifier for it.
1195
1196 Decl := New_Copy_Tree (F);
1197 Id := Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id));
1198
1199 if Nkind (F) in N_Formal_Subprogram_Declaration then
1200 Set_Defining_Unit_Name (Specification (Decl), Id);
1201
1202 else
1203 Set_Defining_Identifier (Decl, Id);
1204 end if;
1205
1206 Append (Decl, Assoc);
1207
1208 if No (Found_Assoc) then
1209 Default :=
1210 Make_Generic_Association (Loc,
1211 Selector_Name => New_Occurrence_Of (Id, Loc),
1212 Explicit_Generic_Actual_Parameter => Empty);
1213 Set_Box_Present (Default);
1214 Append (Default, Default_Formals);
1215 end if;
1216 end Process_Default;
1217
1218 ---------------------------------
1219 -- Renames_Standard_Subprogram --
1220 ---------------------------------
1221
1222 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean is
1223 Id : Entity_Id;
1224
1225 begin
1226 Id := Alias (Subp);
1227 while Present (Id) loop
1228 if Scope (Id) = Standard_Standard then
1229 return True;
1230 end if;
1231
1232 Id := Alias (Id);
1233 end loop;
1234
1235 return False;
1236 end Renames_Standard_Subprogram;
1237
1238 -------------------------
1239 -- Set_Analyzed_Formal --
1240 -------------------------
1241
1242 procedure Set_Analyzed_Formal is
1243 Kind : Node_Kind;
1244
1245 begin
1246 while Present (Analyzed_Formal) loop
1247 Kind := Nkind (Analyzed_Formal);
1248
1249 case Nkind (Formal) is
1250
1251 when N_Formal_Subprogram_Declaration =>
1252 exit when Kind in N_Formal_Subprogram_Declaration
1253 and then
1254 Chars
1255 (Defining_Unit_Name (Specification (Formal))) =
1256 Chars
1257 (Defining_Unit_Name (Specification (Analyzed_Formal)));
1258
1259 when N_Formal_Package_Declaration =>
1260 exit when Nkind_In (Kind, N_Formal_Package_Declaration,
1261 N_Generic_Package_Declaration,
1262 N_Package_Declaration);
1263
1264 when N_Use_Package_Clause | N_Use_Type_Clause => exit;
1265
1266 when others =>
1267
1268 -- Skip freeze nodes, and nodes inserted to replace
1269 -- unrecognized pragmas.
1270
1271 exit when
1272 Kind not in N_Formal_Subprogram_Declaration
1273 and then not Nkind_In (Kind, N_Subprogram_Declaration,
1274 N_Freeze_Entity,
1275 N_Null_Statement,
1276 N_Itype_Reference)
1277 and then Chars (Defining_Identifier (Formal)) =
1278 Chars (Defining_Identifier (Analyzed_Formal));
1279 end case;
1280
1281 Next (Analyzed_Formal);
1282 end loop;
1283 end Set_Analyzed_Formal;
1284
1285 -- Start of processing for Analyze_Associations
1286
1287 begin
1288 Actuals := Generic_Associations (I_Node);
1289
1290 if Present (Actuals) then
1291
1292 -- Check for an Others choice, indicating a partial parameterization
1293 -- for a formal package.
1294
1295 Actual := First (Actuals);
1296 while Present (Actual) loop
1297 if Nkind (Actual) = N_Others_Choice then
1298 Others_Present := True;
1299 Others_Choice := Actual;
1300
1301 if Present (Next (Actual)) then
1302 Error_Msg_N ("others must be last association", Actual);
1303 end if;
1304
1305 -- This subprogram is used both for formal packages and for
1306 -- instantiations. For the latter, associations must all be
1307 -- explicit.
1308
1309 if Nkind (I_Node) /= N_Formal_Package_Declaration
1310 and then Comes_From_Source (I_Node)
1311 then
1312 Error_Msg_N
1313 ("others association not allowed in an instance",
1314 Actual);
1315 end if;
1316
1317 -- In any case, nothing to do after the others association
1318
1319 exit;
1320
1321 elsif Box_Present (Actual)
1322 and then Comes_From_Source (I_Node)
1323 and then Nkind (I_Node) /= N_Formal_Package_Declaration
1324 then
1325 Error_Msg_N
1326 ("box association not allowed in an instance", Actual);
1327 end if;
1328
1329 Next (Actual);
1330 end loop;
1331
1332 -- If named associations are present, save first named association
1333 -- (it may of course be Empty) to facilitate subsequent name search.
1334
1335 First_Named := First (Actuals);
1336 while Present (First_Named)
1337 and then Nkind (First_Named) /= N_Others_Choice
1338 and then No (Selector_Name (First_Named))
1339 loop
1340 Num_Actuals := Num_Actuals + 1;
1341 Next (First_Named);
1342 end loop;
1343 end if;
1344
1345 Named := First_Named;
1346 while Present (Named) loop
1347 if Nkind (Named) /= N_Others_Choice
1348 and then No (Selector_Name (Named))
1349 then
1350 Error_Msg_N ("invalid positional actual after named one", Named);
1351 Abandon_Instantiation (Named);
1352 end if;
1353
1354 -- A named association may lack an actual parameter, if it was
1355 -- introduced for a default subprogram that turns out to be local
1356 -- to the outer instantiation.
1357
1358 if Nkind (Named) /= N_Others_Choice
1359 and then Present (Explicit_Generic_Actual_Parameter (Named))
1360 then
1361 Num_Actuals := Num_Actuals + 1;
1362 end if;
1363
1364 Next (Named);
1365 end loop;
1366
1367 if Present (Formals) then
1368 Formal := First_Non_Pragma (Formals);
1369 Analyzed_Formal := First_Non_Pragma (F_Copy);
1370
1371 if Present (Actuals) then
1372 Actual := First (Actuals);
1373
1374 -- All formals should have default values
1375
1376 else
1377 Actual := Empty;
1378 end if;
1379
1380 while Present (Formal) loop
1381 Set_Analyzed_Formal;
1382 Saved_Formal := Next_Non_Pragma (Formal);
1383
1384 case Nkind (Formal) is
1385 when N_Formal_Object_Declaration =>
1386 Match :=
1387 Matching_Actual (
1388 Defining_Identifier (Formal),
1389 Defining_Identifier (Analyzed_Formal));
1390
1391 if No (Match) and then Partial_Parameterization then
1392 Process_Default (Formal);
1393 else
1394 Append_List
1395 (Instantiate_Object (Formal, Match, Analyzed_Formal),
1396 Assoc);
1397 end if;
1398
1399 when N_Formal_Type_Declaration =>
1400 Match :=
1401 Matching_Actual (
1402 Defining_Identifier (Formal),
1403 Defining_Identifier (Analyzed_Formal));
1404
1405 if No (Match) then
1406 if Partial_Parameterization then
1407 Process_Default (Formal);
1408
1409 else
1410 Error_Msg_Sloc := Sloc (Gen_Unit);
1411 Error_Msg_NE
1412 ("missing actual&",
1413 Instantiation_Node,
1414 Defining_Identifier (Formal));
1415 Error_Msg_NE ("\in instantiation of & declared#",
1416 Instantiation_Node, Gen_Unit);
1417 Abandon_Instantiation (Instantiation_Node);
1418 end if;
1419
1420 else
1421 Analyze (Match);
1422 Append_List
1423 (Instantiate_Type
1424 (Formal, Match, Analyzed_Formal, Assoc),
1425 Assoc);
1426
1427 -- An instantiation is a freeze point for the actuals,
1428 -- unless this is a rewritten formal package, or the
1429 -- formal is an Ada 2012 formal incomplete type.
1430
1431 if Nkind (I_Node) = N_Formal_Package_Declaration
1432 or else
1433 (Ada_Version >= Ada_2012
1434 and then
1435 Ekind (Defining_Identifier (Analyzed_Formal)) =
1436 E_Incomplete_Type)
1437 then
1438 null;
1439
1440 else
1441 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1442 end if;
1443 end if;
1444
1445 -- A remote access-to-class-wide type is not a legal actual
1446 -- for a generic formal of an access type (E.2.2(17/2)).
1447 -- In GNAT an exception to this rule is introduced when
1448 -- the formal is marked as remote using implementation
1449 -- defined aspect/pragma Remote_Access_Type. In that case
1450 -- the actual must be remote as well.
1451
1452 -- If the current instantiation is the construction of a
1453 -- local copy for a formal package the actuals may be
1454 -- defaulted, and there is no matching actual to check.
1455
1456 if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1457 and then
1458 Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1459 N_Access_To_Object_Definition
1460 and then Present (Match)
1461 then
1462 declare
1463 Formal_Ent : constant Entity_Id :=
1464 Defining_Identifier (Analyzed_Formal);
1465 begin
1466 if Is_Remote_Access_To_Class_Wide_Type (Entity (Match))
1467 = Is_Remote_Types (Formal_Ent)
1468 then
1469 -- Remoteness of formal and actual match
1470
1471 null;
1472
1473 elsif Is_Remote_Types (Formal_Ent) then
1474
1475 -- Remote formal, non-remote actual
1476
1477 Error_Msg_NE
1478 ("actual for& must be remote", Match, Formal_Ent);
1479
1480 else
1481 -- Non-remote formal, remote actual
1482
1483 Error_Msg_NE
1484 ("actual for& may not be remote",
1485 Match, Formal_Ent);
1486 end if;
1487 end;
1488 end if;
1489
1490 when N_Formal_Subprogram_Declaration =>
1491 Match :=
1492 Matching_Actual
1493 (Defining_Unit_Name (Specification (Formal)),
1494 Defining_Unit_Name (Specification (Analyzed_Formal)));
1495
1496 -- If the formal subprogram has the same name as another
1497 -- formal subprogram of the generic, then a named
1498 -- association is illegal (12.3(9)). Exclude named
1499 -- associations that are generated for a nested instance.
1500
1501 if Present (Match)
1502 and then Is_Named_Assoc
1503 and then Comes_From_Source (Found_Assoc)
1504 then
1505 Check_Overloaded_Formal_Subprogram (Formal);
1506 end if;
1507
1508 -- If there is no corresponding actual, this may be case
1509 -- of partial parameterization, or else the formal has a
1510 -- default or a box.
1511
1512 if No (Match) and then Partial_Parameterization then
1513 Process_Default (Formal);
1514
1515 if Nkind (I_Node) = N_Formal_Package_Declaration then
1516 Check_Overloaded_Formal_Subprogram (Formal);
1517 end if;
1518
1519 else
1520 Append_To (Assoc,
1521 Instantiate_Formal_Subprogram
1522 (Formal, Match, Analyzed_Formal));
1523
1524 -- An instantiation is a freeze point for the actuals,
1525 -- unless this is a rewritten formal package.
1526
1527 if Nkind (I_Node) /= N_Formal_Package_Declaration
1528 and then Nkind (Match) = N_Identifier
1529 and then Is_Subprogram (Entity (Match))
1530
1531 -- The actual subprogram may rename a routine defined
1532 -- in Standard. Avoid freezing such renamings because
1533 -- subprograms coming from Standard cannot be frozen.
1534
1535 and then
1536 not Renames_Standard_Subprogram (Entity (Match))
1537
1538 -- If the actual subprogram comes from a different
1539 -- unit, it is already frozen, either by a body in
1540 -- that unit or by the end of the declarative part
1541 -- of the unit. This check avoids the freezing of
1542 -- subprograms defined in Standard which are used
1543 -- as generic actuals.
1544
1545 and then In_Same_Code_Unit (Entity (Match), I_Node)
1546 and then Has_Fully_Defined_Profile (Entity (Match))
1547 then
1548 -- Mark the subprogram as having a delayed freeze
1549 -- since this may be an out-of-order action.
1550
1551 Set_Has_Delayed_Freeze (Entity (Match));
1552 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1553 end if;
1554 end if;
1555
1556 -- If this is a nested generic, preserve default for later
1557 -- instantiations.
1558
1559 if No (Match)
1560 and then Box_Present (Formal)
1561 then
1562 Append_Elmt
1563 (Defining_Unit_Name (Specification (Last (Assoc))),
1564 Default_Actuals);
1565 end if;
1566
1567 when N_Formal_Package_Declaration =>
1568 Match :=
1569 Matching_Actual (
1570 Defining_Identifier (Formal),
1571 Defining_Identifier (Original_Node (Analyzed_Formal)));
1572
1573 if No (Match) then
1574 if Partial_Parameterization then
1575 Process_Default (Formal);
1576
1577 else
1578 Error_Msg_Sloc := Sloc (Gen_Unit);
1579 Error_Msg_NE
1580 ("missing actual&",
1581 Instantiation_Node, Defining_Identifier (Formal));
1582 Error_Msg_NE ("\in instantiation of & declared#",
1583 Instantiation_Node, Gen_Unit);
1584
1585 Abandon_Instantiation (Instantiation_Node);
1586 end if;
1587
1588 else
1589 Analyze (Match);
1590 Append_List
1591 (Instantiate_Formal_Package
1592 (Formal, Match, Analyzed_Formal),
1593 Assoc);
1594 end if;
1595
1596 -- For use type and use package appearing in the generic part,
1597 -- we have already copied them, so we can just move them where
1598 -- they belong (we mustn't recopy them since this would mess up
1599 -- the Sloc values).
1600
1601 when N_Use_Package_Clause |
1602 N_Use_Type_Clause =>
1603 if Nkind (Original_Node (I_Node)) =
1604 N_Formal_Package_Declaration
1605 then
1606 Append (New_Copy_Tree (Formal), Assoc);
1607 else
1608 Remove (Formal);
1609 Append (Formal, Assoc);
1610 end if;
1611
1612 when others =>
1613 raise Program_Error;
1614
1615 end case;
1616
1617 Formal := Saved_Formal;
1618 Next_Non_Pragma (Analyzed_Formal);
1619 end loop;
1620
1621 if Num_Actuals > Num_Matched then
1622 Error_Msg_Sloc := Sloc (Gen_Unit);
1623
1624 if Present (Selector_Name (Actual)) then
1625 Error_Msg_NE
1626 ("unmatched actual&",
1627 Actual, Selector_Name (Actual));
1628 Error_Msg_NE ("\in instantiation of& declared#",
1629 Actual, Gen_Unit);
1630 else
1631 Error_Msg_NE
1632 ("unmatched actual in instantiation of& declared#",
1633 Actual, Gen_Unit);
1634 end if;
1635 end if;
1636
1637 elsif Present (Actuals) then
1638 Error_Msg_N
1639 ("too many actuals in generic instantiation", Instantiation_Node);
1640 end if;
1641
1642 -- An instantiation freezes all generic actuals. The only exceptions
1643 -- to this are incomplete types and subprograms which are not fully
1644 -- defined at the point of instantiation.
1645
1646 declare
1647 Elmt : Elmt_Id := First_Elmt (Actuals_To_Freeze);
1648 begin
1649 while Present (Elmt) loop
1650 Freeze_Before (I_Node, Node (Elmt));
1651 Next_Elmt (Elmt);
1652 end loop;
1653 end;
1654
1655 -- If there are default subprograms, normalize the tree by adding
1656 -- explicit associations for them. This is required if the instance
1657 -- appears within a generic.
1658
1659 declare
1660 Elmt : Elmt_Id;
1661 Subp : Entity_Id;
1662 New_D : Node_Id;
1663
1664 begin
1665 Elmt := First_Elmt (Default_Actuals);
1666 while Present (Elmt) loop
1667 if No (Actuals) then
1668 Actuals := New_List;
1669 Set_Generic_Associations (I_Node, Actuals);
1670 end if;
1671
1672 Subp := Node (Elmt);
1673 New_D :=
1674 Make_Generic_Association (Sloc (Subp),
1675 Selector_Name => New_Occurrence_Of (Subp, Sloc (Subp)),
1676 Explicit_Generic_Actual_Parameter =>
1677 New_Occurrence_Of (Subp, Sloc (Subp)));
1678 Mark_Rewrite_Insertion (New_D);
1679 Append_To (Actuals, New_D);
1680 Next_Elmt (Elmt);
1681 end loop;
1682 end;
1683
1684 -- If this is a formal package, normalize the parameter list by adding
1685 -- explicit box associations for the formals that are covered by an
1686 -- Others_Choice.
1687
1688 if not Is_Empty_List (Default_Formals) then
1689 Append_List (Default_Formals, Formals);
1690 end if;
1691
1692 return Assoc;
1693 end Analyze_Associations;
1694
1695 -------------------------------
1696 -- Analyze_Formal_Array_Type --
1697 -------------------------------
1698
1699 procedure Analyze_Formal_Array_Type
1700 (T : in out Entity_Id;
1701 Def : Node_Id)
1702 is
1703 DSS : Node_Id;
1704
1705 begin
1706 -- Treated like a non-generic array declaration, with additional
1707 -- semantic checks.
1708
1709 Enter_Name (T);
1710
1711 if Nkind (Def) = N_Constrained_Array_Definition then
1712 DSS := First (Discrete_Subtype_Definitions (Def));
1713 while Present (DSS) loop
1714 if Nkind_In (DSS, N_Subtype_Indication,
1715 N_Range,
1716 N_Attribute_Reference)
1717 then
1718 Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
1719 end if;
1720
1721 Next (DSS);
1722 end loop;
1723 end if;
1724
1725 Array_Type_Declaration (T, Def);
1726 Set_Is_Generic_Type (Base_Type (T));
1727
1728 if Ekind (Component_Type (T)) = E_Incomplete_Type
1729 and then No (Full_View (Component_Type (T)))
1730 then
1731 Error_Msg_N ("premature usage of incomplete type", Def);
1732
1733 -- Check that range constraint is not allowed on the component type
1734 -- of a generic formal array type (AARM 12.5.3(3))
1735
1736 elsif Is_Internal (Component_Type (T))
1737 and then Present (Subtype_Indication (Component_Definition (Def)))
1738 and then Nkind (Original_Node
1739 (Subtype_Indication (Component_Definition (Def)))) =
1740 N_Subtype_Indication
1741 then
1742 Error_Msg_N
1743 ("in a formal, a subtype indication can only be "
1744 & "a subtype mark (RM 12.5.3(3))",
1745 Subtype_Indication (Component_Definition (Def)));
1746 end if;
1747
1748 end Analyze_Formal_Array_Type;
1749
1750 ---------------------------------------------
1751 -- Analyze_Formal_Decimal_Fixed_Point_Type --
1752 ---------------------------------------------
1753
1754 -- As for other generic types, we create a valid type representation with
1755 -- legal but arbitrary attributes, whose values are never considered
1756 -- static. For all scalar types we introduce an anonymous base type, with
1757 -- the same attributes. We choose the corresponding integer type to be
1758 -- Standard_Integer.
1759 -- Here and in other similar routines, the Sloc of the generated internal
1760 -- type must be the same as the sloc of the defining identifier of the
1761 -- formal type declaration, to provide proper source navigation.
1762
1763 procedure Analyze_Formal_Decimal_Fixed_Point_Type
1764 (T : Entity_Id;
1765 Def : Node_Id)
1766 is
1767 Loc : constant Source_Ptr := Sloc (Def);
1768
1769 Base : constant Entity_Id :=
1770 New_Internal_Entity
1771 (E_Decimal_Fixed_Point_Type,
1772 Current_Scope,
1773 Sloc (Defining_Identifier (Parent (Def))), 'G');
1774
1775 Int_Base : constant Entity_Id := Standard_Integer;
1776 Delta_Val : constant Ureal := Ureal_1;
1777 Digs_Val : constant Uint := Uint_6;
1778
1779 begin
1780 Enter_Name (T);
1781
1782 Set_Etype (Base, Base);
1783 Set_Size_Info (Base, Int_Base);
1784 Set_RM_Size (Base, RM_Size (Int_Base));
1785 Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
1786 Set_Digits_Value (Base, Digs_Val);
1787 Set_Delta_Value (Base, Delta_Val);
1788 Set_Small_Value (Base, Delta_Val);
1789 Set_Scalar_Range (Base,
1790 Make_Range (Loc,
1791 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
1792 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
1793
1794 Set_Is_Generic_Type (Base);
1795 Set_Parent (Base, Parent (Def));
1796
1797 Set_Ekind (T, E_Decimal_Fixed_Point_Subtype);
1798 Set_Etype (T, Base);
1799 Set_Size_Info (T, Int_Base);
1800 Set_RM_Size (T, RM_Size (Int_Base));
1801 Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
1802 Set_Digits_Value (T, Digs_Val);
1803 Set_Delta_Value (T, Delta_Val);
1804 Set_Small_Value (T, Delta_Val);
1805 Set_Scalar_Range (T, Scalar_Range (Base));
1806 Set_Is_Constrained (T);
1807
1808 Check_Restriction (No_Fixed_Point, Def);
1809 end Analyze_Formal_Decimal_Fixed_Point_Type;
1810
1811 -------------------------------------------
1812 -- Analyze_Formal_Derived_Interface_Type --
1813 -------------------------------------------
1814
1815 procedure Analyze_Formal_Derived_Interface_Type
1816 (N : Node_Id;
1817 T : Entity_Id;
1818 Def : Node_Id)
1819 is
1820 Loc : constant Source_Ptr := Sloc (Def);
1821
1822 begin
1823 -- Rewrite as a type declaration of a derived type. This ensures that
1824 -- the interface list and primitive operations are properly captured.
1825
1826 Rewrite (N,
1827 Make_Full_Type_Declaration (Loc,
1828 Defining_Identifier => T,
1829 Type_Definition => Def));
1830 Analyze (N);
1831 Set_Is_Generic_Type (T);
1832 end Analyze_Formal_Derived_Interface_Type;
1833
1834 ---------------------------------
1835 -- Analyze_Formal_Derived_Type --
1836 ---------------------------------
1837
1838 procedure Analyze_Formal_Derived_Type
1839 (N : Node_Id;
1840 T : Entity_Id;
1841 Def : Node_Id)
1842 is
1843 Loc : constant Source_Ptr := Sloc (Def);
1844 Unk_Disc : constant Boolean := Unknown_Discriminants_Present (N);
1845 New_N : Node_Id;
1846
1847 begin
1848 Set_Is_Generic_Type (T);
1849
1850 if Private_Present (Def) then
1851 New_N :=
1852 Make_Private_Extension_Declaration (Loc,
1853 Defining_Identifier => T,
1854 Discriminant_Specifications => Discriminant_Specifications (N),
1855 Unknown_Discriminants_Present => Unk_Disc,
1856 Subtype_Indication => Subtype_Mark (Def),
1857 Interface_List => Interface_List (Def));
1858
1859 Set_Abstract_Present (New_N, Abstract_Present (Def));
1860 Set_Limited_Present (New_N, Limited_Present (Def));
1861 Set_Synchronized_Present (New_N, Synchronized_Present (Def));
1862
1863 else
1864 New_N :=
1865 Make_Full_Type_Declaration (Loc,
1866 Defining_Identifier => T,
1867 Discriminant_Specifications =>
1868 Discriminant_Specifications (Parent (T)),
1869 Type_Definition =>
1870 Make_Derived_Type_Definition (Loc,
1871 Subtype_Indication => Subtype_Mark (Def)));
1872
1873 Set_Abstract_Present
1874 (Type_Definition (New_N), Abstract_Present (Def));
1875 Set_Limited_Present
1876 (Type_Definition (New_N), Limited_Present (Def));
1877 end if;
1878
1879 Rewrite (N, New_N);
1880 Analyze (N);
1881
1882 if Unk_Disc then
1883 if not Is_Composite_Type (T) then
1884 Error_Msg_N
1885 ("unknown discriminants not allowed for elementary types", N);
1886 else
1887 Set_Has_Unknown_Discriminants (T);
1888 Set_Is_Constrained (T, False);
1889 end if;
1890 end if;
1891
1892 -- If the parent type has a known size, so does the formal, which makes
1893 -- legal representation clauses that involve the formal.
1894
1895 Set_Size_Known_At_Compile_Time
1896 (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
1897 end Analyze_Formal_Derived_Type;
1898
1899 ----------------------------------
1900 -- Analyze_Formal_Discrete_Type --
1901 ----------------------------------
1902
1903 -- The operations defined for a discrete types are those of an enumeration
1904 -- type. The size is set to an arbitrary value, for use in analyzing the
1905 -- generic unit.
1906
1907 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
1908 Loc : constant Source_Ptr := Sloc (Def);
1909 Lo : Node_Id;
1910 Hi : Node_Id;
1911
1912 Base : constant Entity_Id :=
1913 New_Internal_Entity
1914 (E_Floating_Point_Type, Current_Scope,
1915 Sloc (Defining_Identifier (Parent (Def))), 'G');
1916
1917 begin
1918 Enter_Name (T);
1919 Set_Ekind (T, E_Enumeration_Subtype);
1920 Set_Etype (T, Base);
1921 Init_Size (T, 8);
1922 Init_Alignment (T);
1923 Set_Is_Generic_Type (T);
1924 Set_Is_Constrained (T);
1925
1926 -- For semantic analysis, the bounds of the type must be set to some
1927 -- non-static value. The simplest is to create attribute nodes for those
1928 -- bounds, that refer to the type itself. These bounds are never
1929 -- analyzed but serve as place-holders.
1930
1931 Lo :=
1932 Make_Attribute_Reference (Loc,
1933 Attribute_Name => Name_First,
1934 Prefix => New_Occurrence_Of (T, Loc));
1935 Set_Etype (Lo, T);
1936
1937 Hi :=
1938 Make_Attribute_Reference (Loc,
1939 Attribute_Name => Name_Last,
1940 Prefix => New_Occurrence_Of (T, Loc));
1941 Set_Etype (Hi, T);
1942
1943 Set_Scalar_Range (T,
1944 Make_Range (Loc,
1945 Low_Bound => Lo,
1946 High_Bound => Hi));
1947
1948 Set_Ekind (Base, E_Enumeration_Type);
1949 Set_Etype (Base, Base);
1950 Init_Size (Base, 8);
1951 Init_Alignment (Base);
1952 Set_Is_Generic_Type (Base);
1953 Set_Scalar_Range (Base, Scalar_Range (T));
1954 Set_Parent (Base, Parent (Def));
1955 end Analyze_Formal_Discrete_Type;
1956
1957 ----------------------------------
1958 -- Analyze_Formal_Floating_Type --
1959 ---------------------------------
1960
1961 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
1962 Base : constant Entity_Id :=
1963 New_Internal_Entity
1964 (E_Floating_Point_Type, Current_Scope,
1965 Sloc (Defining_Identifier (Parent (Def))), 'G');
1966
1967 begin
1968 -- The various semantic attributes are taken from the predefined type
1969 -- Float, just so that all of them are initialized. Their values are
1970 -- never used because no constant folding or expansion takes place in
1971 -- the generic itself.
1972
1973 Enter_Name (T);
1974 Set_Ekind (T, E_Floating_Point_Subtype);
1975 Set_Etype (T, Base);
1976 Set_Size_Info (T, (Standard_Float));
1977 Set_RM_Size (T, RM_Size (Standard_Float));
1978 Set_Digits_Value (T, Digits_Value (Standard_Float));
1979 Set_Scalar_Range (T, Scalar_Range (Standard_Float));
1980 Set_Is_Constrained (T);
1981
1982 Set_Is_Generic_Type (Base);
1983 Set_Etype (Base, Base);
1984 Set_Size_Info (Base, (Standard_Float));
1985 Set_RM_Size (Base, RM_Size (Standard_Float));
1986 Set_Digits_Value (Base, Digits_Value (Standard_Float));
1987 Set_Scalar_Range (Base, Scalar_Range (Standard_Float));
1988 Set_Parent (Base, Parent (Def));
1989
1990 Check_Restriction (No_Floating_Point, Def);
1991 end Analyze_Formal_Floating_Type;
1992
1993 -----------------------------------
1994 -- Analyze_Formal_Interface_Type;--
1995 -----------------------------------
1996
1997 procedure Analyze_Formal_Interface_Type
1998 (N : Node_Id;
1999 T : Entity_Id;
2000 Def : Node_Id)
2001 is
2002 Loc : constant Source_Ptr := Sloc (N);
2003 New_N : Node_Id;
2004
2005 begin
2006 New_N :=
2007 Make_Full_Type_Declaration (Loc,
2008 Defining_Identifier => T,
2009 Type_Definition => Def);
2010
2011 Rewrite (N, New_N);
2012 Analyze (N);
2013 Set_Is_Generic_Type (T);
2014 end Analyze_Formal_Interface_Type;
2015
2016 ---------------------------------
2017 -- Analyze_Formal_Modular_Type --
2018 ---------------------------------
2019
2020 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
2021 begin
2022 -- Apart from their entity kind, generic modular types are treated like
2023 -- signed integer types, and have the same attributes.
2024
2025 Analyze_Formal_Signed_Integer_Type (T, Def);
2026 Set_Ekind (T, E_Modular_Integer_Subtype);
2027 Set_Ekind (Etype (T), E_Modular_Integer_Type);
2028
2029 end Analyze_Formal_Modular_Type;
2030
2031 ---------------------------------------
2032 -- Analyze_Formal_Object_Declaration --
2033 ---------------------------------------
2034
2035 procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
2036 E : constant Node_Id := Default_Expression (N);
2037 Id : constant Node_Id := Defining_Identifier (N);
2038 K : Entity_Kind;
2039 T : Node_Id;
2040
2041 begin
2042 Enter_Name (Id);
2043
2044 -- Determine the mode of the formal object
2045
2046 if Out_Present (N) then
2047 K := E_Generic_In_Out_Parameter;
2048
2049 if not In_Present (N) then
2050 Error_Msg_N ("formal generic objects cannot have mode OUT", N);
2051 end if;
2052
2053 else
2054 K := E_Generic_In_Parameter;
2055 end if;
2056
2057 if Present (Subtype_Mark (N)) then
2058 Find_Type (Subtype_Mark (N));
2059 T := Entity (Subtype_Mark (N));
2060
2061 -- Verify that there is no redundant null exclusion
2062
2063 if Null_Exclusion_Present (N) then
2064 if not Is_Access_Type (T) then
2065 Error_Msg_N
2066 ("null exclusion can only apply to an access type", N);
2067
2068 elsif Can_Never_Be_Null (T) then
2069 Error_Msg_NE
2070 ("`NOT NULL` not allowed (& already excludes null)",
2071 N, T);
2072 end if;
2073 end if;
2074
2075 -- Ada 2005 (AI-423): Formal object with an access definition
2076
2077 else
2078 Check_Access_Definition (N);
2079 T := Access_Definition
2080 (Related_Nod => N,
2081 N => Access_Definition (N));
2082 end if;
2083
2084 if Ekind (T) = E_Incomplete_Type then
2085 declare
2086 Error_Node : Node_Id;
2087
2088 begin
2089 if Present (Subtype_Mark (N)) then
2090 Error_Node := Subtype_Mark (N);
2091 else
2092 Check_Access_Definition (N);
2093 Error_Node := Access_Definition (N);
2094 end if;
2095
2096 Error_Msg_N ("premature usage of incomplete type", Error_Node);
2097 end;
2098 end if;
2099
2100 if K = E_Generic_In_Parameter then
2101
2102 -- Ada 2005 (AI-287): Limited aggregates allowed in generic formals
2103
2104 if Ada_Version < Ada_2005 and then Is_Limited_Type (T) then
2105 Error_Msg_N
2106 ("generic formal of mode IN must not be of limited type", N);
2107 Explain_Limited_Type (T, N);
2108 end if;
2109
2110 if Is_Abstract_Type (T) then
2111 Error_Msg_N
2112 ("generic formal of mode IN must not be of abstract type", N);
2113 end if;
2114
2115 if Present (E) then
2116 Preanalyze_Spec_Expression (E, T);
2117
2118 if Is_Limited_Type (T) and then not OK_For_Limited_Init (T, E) then
2119 Error_Msg_N
2120 ("initialization not allowed for limited types", E);
2121 Explain_Limited_Type (T, E);
2122 end if;
2123 end if;
2124
2125 Set_Ekind (Id, K);
2126 Set_Etype (Id, T);
2127
2128 -- Case of generic IN OUT parameter
2129
2130 else
2131 -- If the formal has an unconstrained type, construct its actual
2132 -- subtype, as is done for subprogram formals. In this fashion, all
2133 -- its uses can refer to specific bounds.
2134
2135 Set_Ekind (Id, K);
2136 Set_Etype (Id, T);
2137
2138 if (Is_Array_Type (T)
2139 and then not Is_Constrained (T))
2140 or else
2141 (Ekind (T) = E_Record_Type
2142 and then Has_Discriminants (T))
2143 then
2144 declare
2145 Non_Freezing_Ref : constant Node_Id :=
2146 New_Occurrence_Of (Id, Sloc (Id));
2147 Decl : Node_Id;
2148
2149 begin
2150 -- Make sure the actual subtype doesn't generate bogus freezing
2151
2152 Set_Must_Not_Freeze (Non_Freezing_Ref);
2153 Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
2154 Insert_Before_And_Analyze (N, Decl);
2155 Set_Actual_Subtype (Id, Defining_Identifier (Decl));
2156 end;
2157 else
2158 Set_Actual_Subtype (Id, T);
2159 end if;
2160
2161 if Present (E) then
2162 Error_Msg_N
2163 ("initialization not allowed for `IN OUT` formals", N);
2164 end if;
2165 end if;
2166
2167 if Has_Aspects (N) then
2168 Analyze_Aspect_Specifications (N, Id);
2169 end if;
2170 end Analyze_Formal_Object_Declaration;
2171
2172 ----------------------------------------------
2173 -- Analyze_Formal_Ordinary_Fixed_Point_Type --
2174 ----------------------------------------------
2175
2176 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
2177 (T : Entity_Id;
2178 Def : Node_Id)
2179 is
2180 Loc : constant Source_Ptr := Sloc (Def);
2181 Base : constant Entity_Id :=
2182 New_Internal_Entity
2183 (E_Ordinary_Fixed_Point_Type, Current_Scope,
2184 Sloc (Defining_Identifier (Parent (Def))), 'G');
2185
2186 begin
2187 -- The semantic attributes are set for completeness only, their values
2188 -- will never be used, since all properties of the type are non-static.
2189
2190 Enter_Name (T);
2191 Set_Ekind (T, E_Ordinary_Fixed_Point_Subtype);
2192 Set_Etype (T, Base);
2193 Set_Size_Info (T, Standard_Integer);
2194 Set_RM_Size (T, RM_Size (Standard_Integer));
2195 Set_Small_Value (T, Ureal_1);
2196 Set_Delta_Value (T, Ureal_1);
2197 Set_Scalar_Range (T,
2198 Make_Range (Loc,
2199 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
2200 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
2201 Set_Is_Constrained (T);
2202
2203 Set_Is_Generic_Type (Base);
2204 Set_Etype (Base, Base);
2205 Set_Size_Info (Base, Standard_Integer);
2206 Set_RM_Size (Base, RM_Size (Standard_Integer));
2207 Set_Small_Value (Base, Ureal_1);
2208 Set_Delta_Value (Base, Ureal_1);
2209 Set_Scalar_Range (Base, Scalar_Range (T));
2210 Set_Parent (Base, Parent (Def));
2211
2212 Check_Restriction (No_Fixed_Point, Def);
2213 end Analyze_Formal_Ordinary_Fixed_Point_Type;
2214
2215 ----------------------------------------
2216 -- Analyze_Formal_Package_Declaration --
2217 ----------------------------------------
2218
2219 procedure Analyze_Formal_Package_Declaration (N : Node_Id) is
2220 Loc : constant Source_Ptr := Sloc (N);
2221 Pack_Id : constant Entity_Id := Defining_Identifier (N);
2222 Formal : Entity_Id;
2223 Gen_Id : constant Node_Id := Name (N);
2224 Gen_Decl : Node_Id;
2225 Gen_Unit : Entity_Id;
2226 New_N : Node_Id;
2227 Parent_Installed : Boolean := False;
2228 Renaming : Node_Id;
2229 Parent_Instance : Entity_Id;
2230 Renaming_In_Par : Entity_Id;
2231 Associations : Boolean := True;
2232
2233 Vis_Prims_List : Elist_Id := No_Elist;
2234 -- List of primitives made temporarily visible in the instantiation
2235 -- to match the visibility of the formal type
2236
2237 function Build_Local_Package return Node_Id;
2238 -- The formal package is rewritten so that its parameters are replaced
2239 -- with corresponding declarations. For parameters with bona fide
2240 -- associations these declarations are created by Analyze_Associations
2241 -- as for a regular instantiation. For boxed parameters, we preserve
2242 -- the formal declarations and analyze them, in order to introduce
2243 -- entities of the right kind in the environment of the formal.
2244
2245 -------------------------
2246 -- Build_Local_Package --
2247 -------------------------
2248
2249 function Build_Local_Package return Node_Id is
2250 Decls : List_Id;
2251 Pack_Decl : Node_Id;
2252
2253 begin
2254 -- Within the formal, the name of the generic package is a renaming
2255 -- of the formal (as for a regular instantiation).
2256
2257 Pack_Decl :=
2258 Make_Package_Declaration (Loc,
2259 Specification =>
2260 Copy_Generic_Node
2261 (Specification (Original_Node (Gen_Decl)),
2262 Empty, Instantiating => True));
2263
2264 Renaming := Make_Package_Renaming_Declaration (Loc,
2265 Defining_Unit_Name =>
2266 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2267 Name => New_Occurrence_Of (Formal, Loc));
2268
2269 if Nkind (Gen_Id) = N_Identifier
2270 and then Chars (Gen_Id) = Chars (Pack_Id)
2271 then
2272 Error_Msg_NE
2273 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2274 end if;
2275
2276 -- If the formal is declared with a box, or with an others choice,
2277 -- create corresponding declarations for all entities in the formal
2278 -- part, so that names with the proper types are available in the
2279 -- specification of the formal package.
2280
2281 -- On the other hand, if there are no associations, then all the
2282 -- formals must have defaults, and this will be checked by the
2283 -- call to Analyze_Associations.
2284
2285 if Box_Present (N)
2286 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2287 then
2288 declare
2289 Formal_Decl : Node_Id;
2290
2291 begin
2292 -- TBA : for a formal package, need to recurse ???
2293
2294 Decls := New_List;
2295 Formal_Decl :=
2296 First
2297 (Generic_Formal_Declarations (Original_Node (Gen_Decl)));
2298 while Present (Formal_Decl) loop
2299 Append_To
2300 (Decls, Copy_Generic_Node (Formal_Decl, Empty, True));
2301 Next (Formal_Decl);
2302 end loop;
2303 end;
2304
2305 -- If generic associations are present, use Analyze_Associations to
2306 -- create the proper renaming declarations.
2307
2308 else
2309 declare
2310 Act_Tree : constant Node_Id :=
2311 Copy_Generic_Node
2312 (Original_Node (Gen_Decl), Empty,
2313 Instantiating => True);
2314
2315 begin
2316 Generic_Renamings.Set_Last (0);
2317 Generic_Renamings_HTable.Reset;
2318 Instantiation_Node := N;
2319
2320 Decls :=
2321 Analyze_Associations
2322 (I_Node => Original_Node (N),
2323 Formals => Generic_Formal_Declarations (Act_Tree),
2324 F_Copy => Generic_Formal_Declarations (Gen_Decl));
2325
2326 Vis_Prims_List := Check_Hidden_Primitives (Decls);
2327 end;
2328 end if;
2329
2330 Append (Renaming, To => Decls);
2331
2332 -- Add generated declarations ahead of local declarations in
2333 -- the package.
2334
2335 if No (Visible_Declarations (Specification (Pack_Decl))) then
2336 Set_Visible_Declarations (Specification (Pack_Decl), Decls);
2337 else
2338 Insert_List_Before
2339 (First (Visible_Declarations (Specification (Pack_Decl))),
2340 Decls);
2341 end if;
2342
2343 return Pack_Decl;
2344 end Build_Local_Package;
2345
2346 -- Start of processing for Analyze_Formal_Package_Declaration
2347
2348 begin
2349 Text_IO_Kludge (Gen_Id);
2350
2351 Init_Env;
2352 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2353 Gen_Unit := Entity (Gen_Id);
2354
2355 -- Check for a formal package that is a package renaming
2356
2357 if Present (Renamed_Object (Gen_Unit)) then
2358
2359 -- Indicate that unit is used, before replacing it with renamed
2360 -- entity for use below.
2361
2362 if In_Extended_Main_Source_Unit (N) then
2363 Set_Is_Instantiated (Gen_Unit);
2364 Generate_Reference (Gen_Unit, N);
2365 end if;
2366
2367 Gen_Unit := Renamed_Object (Gen_Unit);
2368 end if;
2369
2370 if Ekind (Gen_Unit) /= E_Generic_Package then
2371 Error_Msg_N ("expect generic package name", Gen_Id);
2372 Restore_Env;
2373 goto Leave;
2374
2375 elsif Gen_Unit = Current_Scope then
2376 Error_Msg_N
2377 ("generic package cannot be used as a formal package of itself",
2378 Gen_Id);
2379 Restore_Env;
2380 goto Leave;
2381
2382 elsif In_Open_Scopes (Gen_Unit) then
2383 if Is_Compilation_Unit (Gen_Unit)
2384 and then Is_Child_Unit (Current_Scope)
2385 then
2386 -- Special-case the error when the formal is a parent, and
2387 -- continue analysis to minimize cascaded errors.
2388
2389 Error_Msg_N
2390 ("generic parent cannot be used as formal package "
2391 & "of a child unit",
2392 Gen_Id);
2393
2394 else
2395 Error_Msg_N
2396 ("generic package cannot be used as a formal package "
2397 & "within itself",
2398 Gen_Id);
2399 Restore_Env;
2400 goto Leave;
2401 end if;
2402 end if;
2403
2404 -- Check that name of formal package does not hide name of generic,
2405 -- or its leading prefix. This check must be done separately because
2406 -- the name of the generic has already been analyzed.
2407
2408 declare
2409 Gen_Name : Entity_Id;
2410
2411 begin
2412 Gen_Name := Gen_Id;
2413 while Nkind (Gen_Name) = N_Expanded_Name loop
2414 Gen_Name := Prefix (Gen_Name);
2415 end loop;
2416
2417 if Chars (Gen_Name) = Chars (Pack_Id) then
2418 Error_Msg_NE
2419 ("& is hidden within declaration of formal package",
2420 Gen_Id, Gen_Name);
2421 end if;
2422 end;
2423
2424 if Box_Present (N)
2425 or else No (Generic_Associations (N))
2426 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2427 then
2428 Associations := False;
2429 end if;
2430
2431 -- If there are no generic associations, the generic parameters appear
2432 -- as local entities and are instantiated like them. We copy the generic
2433 -- package declaration as if it were an instantiation, and analyze it
2434 -- like a regular package, except that we treat the formals as
2435 -- additional visible components.
2436
2437 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2438
2439 if In_Extended_Main_Source_Unit (N) then
2440 Set_Is_Instantiated (Gen_Unit);
2441 Generate_Reference (Gen_Unit, N);
2442 end if;
2443
2444 Formal := New_Copy (Pack_Id);
2445 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2446
2447 begin
2448 -- Make local generic without formals. The formals will be replaced
2449 -- with internal declarations.
2450
2451 New_N := Build_Local_Package;
2452
2453 -- If there are errors in the parameter list, Analyze_Associations
2454 -- raises Instantiation_Error. Patch the declaration to prevent
2455 -- further exception propagation.
2456
2457 exception
2458 when Instantiation_Error =>
2459
2460 Enter_Name (Formal);
2461 Set_Ekind (Formal, E_Variable);
2462 Set_Etype (Formal, Any_Type);
2463 Restore_Hidden_Primitives (Vis_Prims_List);
2464
2465 if Parent_Installed then
2466 Remove_Parent;
2467 end if;
2468
2469 goto Leave;
2470 end;
2471
2472 Rewrite (N, New_N);
2473 Set_Defining_Unit_Name (Specification (New_N), Formal);
2474 Set_Generic_Parent (Specification (N), Gen_Unit);
2475 Set_Instance_Env (Gen_Unit, Formal);
2476 Set_Is_Generic_Instance (Formal);
2477
2478 Enter_Name (Formal);
2479 Set_Ekind (Formal, E_Package);
2480 Set_Etype (Formal, Standard_Void_Type);
2481 Set_Inner_Instances (Formal, New_Elmt_List);
2482 Push_Scope (Formal);
2483
2484 if Is_Child_Unit (Gen_Unit)
2485 and then Parent_Installed
2486 then
2487 -- Similarly, we have to make the name of the formal visible in the
2488 -- parent instance, to resolve properly fully qualified names that
2489 -- may appear in the generic unit. The parent instance has been
2490 -- placed on the scope stack ahead of the current scope.
2491
2492 Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
2493
2494 Renaming_In_Par :=
2495 Make_Defining_Identifier (Loc, Chars (Gen_Unit));
2496 Set_Ekind (Renaming_In_Par, E_Package);
2497 Set_Etype (Renaming_In_Par, Standard_Void_Type);
2498 Set_Scope (Renaming_In_Par, Parent_Instance);
2499 Set_Parent (Renaming_In_Par, Parent (Formal));
2500 Set_Renamed_Object (Renaming_In_Par, Formal);
2501 Append_Entity (Renaming_In_Par, Parent_Instance);
2502 end if;
2503
2504 Analyze (Specification (N));
2505
2506 -- The formals for which associations are provided are not visible
2507 -- outside of the formal package. The others are still declared by a
2508 -- formal parameter declaration.
2509
2510 -- If there are no associations, the only local entity to hide is the
2511 -- generated package renaming itself.
2512
2513 declare
2514 E : Entity_Id;
2515
2516 begin
2517 E := First_Entity (Formal);
2518 while Present (E) loop
2519 if Associations
2520 and then not Is_Generic_Formal (E)
2521 then
2522 Set_Is_Hidden (E);
2523 end if;
2524
2525 if Ekind (E) = E_Package
2526 and then Renamed_Entity (E) = Formal
2527 then
2528 Set_Is_Hidden (E);
2529 exit;
2530 end if;
2531
2532 Next_Entity (E);
2533 end loop;
2534 end;
2535
2536 End_Package_Scope (Formal);
2537 Restore_Hidden_Primitives (Vis_Prims_List);
2538
2539 if Parent_Installed then
2540 Remove_Parent;
2541 end if;
2542
2543 Restore_Env;
2544
2545 -- Inside the generic unit, the formal package is a regular package, but
2546 -- no body is needed for it. Note that after instantiation, the defining
2547 -- unit name we need is in the new tree and not in the original (see
2548 -- Package_Instantiation). A generic formal package is an instance, and
2549 -- can be used as an actual for an inner instance.
2550
2551 Set_Has_Completion (Formal, True);
2552
2553 -- Add semantic information to the original defining identifier.
2554 -- for ASIS use.
2555
2556 Set_Ekind (Pack_Id, E_Package);
2557 Set_Etype (Pack_Id, Standard_Void_Type);
2558 Set_Scope (Pack_Id, Scope (Formal));
2559 Set_Has_Completion (Pack_Id, True);
2560
2561 <<Leave>>
2562 if Has_Aspects (N) then
2563 Analyze_Aspect_Specifications (N, Pack_Id);
2564 end if;
2565 end Analyze_Formal_Package_Declaration;
2566
2567 ---------------------------------
2568 -- Analyze_Formal_Private_Type --
2569 ---------------------------------
2570
2571 procedure Analyze_Formal_Private_Type
2572 (N : Node_Id;
2573 T : Entity_Id;
2574 Def : Node_Id)
2575 is
2576 begin
2577 New_Private_Type (N, T, Def);
2578
2579 -- Set the size to an arbitrary but legal value
2580
2581 Set_Size_Info (T, Standard_Integer);
2582 Set_RM_Size (T, RM_Size (Standard_Integer));
2583 end Analyze_Formal_Private_Type;
2584
2585 ------------------------------------
2586 -- Analyze_Formal_Incomplete_Type --
2587 ------------------------------------
2588
2589 procedure Analyze_Formal_Incomplete_Type
2590 (T : Entity_Id;
2591 Def : Node_Id)
2592 is
2593 begin
2594 Enter_Name (T);
2595 Set_Ekind (T, E_Incomplete_Type);
2596 Set_Etype (T, T);
2597 Set_Private_Dependents (T, New_Elmt_List);
2598
2599 if Tagged_Present (Def) then
2600 Set_Is_Tagged_Type (T);
2601 Make_Class_Wide_Type (T);
2602 Set_Direct_Primitive_Operations (T, New_Elmt_List);
2603 end if;
2604 end Analyze_Formal_Incomplete_Type;
2605
2606 ----------------------------------------
2607 -- Analyze_Formal_Signed_Integer_Type --
2608 ----------------------------------------
2609
2610 procedure Analyze_Formal_Signed_Integer_Type
2611 (T : Entity_Id;
2612 Def : Node_Id)
2613 is
2614 Base : constant Entity_Id :=
2615 New_Internal_Entity
2616 (E_Signed_Integer_Type,
2617 Current_Scope,
2618 Sloc (Defining_Identifier (Parent (Def))), 'G');
2619
2620 begin
2621 Enter_Name (T);
2622
2623 Set_Ekind (T, E_Signed_Integer_Subtype);
2624 Set_Etype (T, Base);
2625 Set_Size_Info (T, Standard_Integer);
2626 Set_RM_Size (T, RM_Size (Standard_Integer));
2627 Set_Scalar_Range (T, Scalar_Range (Standard_Integer));
2628 Set_Is_Constrained (T);
2629
2630 Set_Is_Generic_Type (Base);
2631 Set_Size_Info (Base, Standard_Integer);
2632 Set_RM_Size (Base, RM_Size (Standard_Integer));
2633 Set_Etype (Base, Base);
2634 Set_Scalar_Range (Base, Scalar_Range (Standard_Integer));
2635 Set_Parent (Base, Parent (Def));
2636 end Analyze_Formal_Signed_Integer_Type;
2637
2638 -------------------------------------------
2639 -- Analyze_Formal_Subprogram_Declaration --
2640 -------------------------------------------
2641
2642 procedure Analyze_Formal_Subprogram_Declaration (N : Node_Id) is
2643 Spec : constant Node_Id := Specification (N);
2644 Def : constant Node_Id := Default_Name (N);
2645 Nam : constant Entity_Id := Defining_Unit_Name (Spec);
2646 Subp : Entity_Id;
2647
2648 begin
2649 if Nam = Error then
2650 return;
2651 end if;
2652
2653 if Nkind (Nam) = N_Defining_Program_Unit_Name then
2654 Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
2655 goto Leave;
2656 end if;
2657
2658 Analyze_Subprogram_Declaration (N);
2659 Set_Is_Formal_Subprogram (Nam);
2660 Set_Has_Completion (Nam);
2661
2662 if Nkind (N) = N_Formal_Abstract_Subprogram_Declaration then
2663 Set_Is_Abstract_Subprogram (Nam);
2664 Set_Is_Dispatching_Operation (Nam);
2665
2666 declare
2667 Ctrl_Type : constant Entity_Id := Find_Dispatching_Type (Nam);
2668 begin
2669 if No (Ctrl_Type) then
2670 Error_Msg_N
2671 ("abstract formal subprogram must have a controlling type",
2672 N);
2673
2674 elsif Ada_Version >= Ada_2012
2675 and then Is_Incomplete_Type (Ctrl_Type)
2676 then
2677 Error_Msg_NE
2678 ("controlling type of abstract formal subprogram cannot " &
2679 "be incomplete type", N, Ctrl_Type);
2680
2681 else
2682 Check_Controlling_Formals (Ctrl_Type, Nam);
2683 end if;
2684 end;
2685 end if;
2686
2687 -- Default name is resolved at the point of instantiation
2688
2689 if Box_Present (N) then
2690 null;
2691
2692 -- Else default is bound at the point of generic declaration
2693
2694 elsif Present (Def) then
2695 if Nkind (Def) = N_Operator_Symbol then
2696 Find_Direct_Name (Def);
2697
2698 elsif Nkind (Def) /= N_Attribute_Reference then
2699 Analyze (Def);
2700
2701 else
2702 -- For an attribute reference, analyze the prefix and verify
2703 -- that it has the proper profile for the subprogram.
2704
2705 Analyze (Prefix (Def));
2706 Valid_Default_Attribute (Nam, Def);
2707 goto Leave;
2708 end if;
2709
2710 -- Default name may be overloaded, in which case the interpretation
2711 -- with the correct profile must be selected, as for a renaming.
2712 -- If the definition is an indexed component, it must denote a
2713 -- member of an entry family. If it is a selected component, it
2714 -- can be a protected operation.
2715
2716 if Etype (Def) = Any_Type then
2717 goto Leave;
2718
2719 elsif Nkind (Def) = N_Selected_Component then
2720 if not Is_Overloadable (Entity (Selector_Name (Def))) then
2721 Error_Msg_N ("expect valid subprogram name as default", Def);
2722 end if;
2723
2724 elsif Nkind (Def) = N_Indexed_Component then
2725 if Is_Entity_Name (Prefix (Def)) then
2726 if Ekind (Entity (Prefix (Def))) /= E_Entry_Family then
2727 Error_Msg_N ("expect valid subprogram name as default", Def);
2728 end if;
2729
2730 elsif Nkind (Prefix (Def)) = N_Selected_Component then
2731 if Ekind (Entity (Selector_Name (Prefix (Def)))) /=
2732 E_Entry_Family
2733 then
2734 Error_Msg_N ("expect valid subprogram name as default", Def);
2735 end if;
2736
2737 else
2738 Error_Msg_N ("expect valid subprogram name as default", Def);
2739 goto Leave;
2740 end if;
2741
2742 elsif Nkind (Def) = N_Character_Literal then
2743
2744 -- Needs some type checks: subprogram should be parameterless???
2745
2746 Resolve (Def, (Etype (Nam)));
2747
2748 elsif not Is_Entity_Name (Def)
2749 or else not Is_Overloadable (Entity (Def))
2750 then
2751 Error_Msg_N ("expect valid subprogram name as default", Def);
2752 goto Leave;
2753
2754 elsif not Is_Overloaded (Def) then
2755 Subp := Entity (Def);
2756
2757 if Subp = Nam then
2758 Error_Msg_N ("premature usage of formal subprogram", Def);
2759
2760 elsif not Entity_Matches_Spec (Subp, Nam) then
2761 Error_Msg_N ("no visible entity matches specification", Def);
2762 end if;
2763
2764 -- More than one interpretation, so disambiguate as for a renaming
2765
2766 else
2767 declare
2768 I : Interp_Index;
2769 I1 : Interp_Index := 0;
2770 It : Interp;
2771 It1 : Interp;
2772
2773 begin
2774 Subp := Any_Id;
2775 Get_First_Interp (Def, I, It);
2776 while Present (It.Nam) loop
2777 if Entity_Matches_Spec (It.Nam, Nam) then
2778 if Subp /= Any_Id then
2779 It1 := Disambiguate (Def, I1, I, Etype (Subp));
2780
2781 if It1 = No_Interp then
2782 Error_Msg_N ("ambiguous default subprogram", Def);
2783 else
2784 Subp := It1.Nam;
2785 end if;
2786
2787 exit;
2788
2789 else
2790 I1 := I;
2791 Subp := It.Nam;
2792 end if;
2793 end if;
2794
2795 Get_Next_Interp (I, It);
2796 end loop;
2797 end;
2798
2799 if Subp /= Any_Id then
2800
2801 -- Subprogram found, generate reference to it
2802
2803 Set_Entity (Def, Subp);
2804 Generate_Reference (Subp, Def);
2805
2806 if Subp = Nam then
2807 Error_Msg_N ("premature usage of formal subprogram", Def);
2808
2809 elsif Ekind (Subp) /= E_Operator then
2810 Check_Mode_Conformant (Subp, Nam);
2811 end if;
2812
2813 else
2814 Error_Msg_N ("no visible subprogram matches specification", N);
2815 end if;
2816 end if;
2817 end if;
2818
2819 <<Leave>>
2820 if Has_Aspects (N) then
2821 Analyze_Aspect_Specifications (N, Nam);
2822 end if;
2823
2824 end Analyze_Formal_Subprogram_Declaration;
2825
2826 -------------------------------------
2827 -- Analyze_Formal_Type_Declaration --
2828 -------------------------------------
2829
2830 procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
2831 Def : constant Node_Id := Formal_Type_Definition (N);
2832 T : Entity_Id;
2833
2834 begin
2835 T := Defining_Identifier (N);
2836
2837 if Present (Discriminant_Specifications (N))
2838 and then Nkind (Def) /= N_Formal_Private_Type_Definition
2839 then
2840 Error_Msg_N
2841 ("discriminants not allowed for this formal type", T);
2842 end if;
2843
2844 -- Enter the new name, and branch to specific routine
2845
2846 case Nkind (Def) is
2847 when N_Formal_Private_Type_Definition =>
2848 Analyze_Formal_Private_Type (N, T, Def);
2849
2850 when N_Formal_Derived_Type_Definition =>
2851 Analyze_Formal_Derived_Type (N, T, Def);
2852
2853 when N_Formal_Incomplete_Type_Definition =>
2854 Analyze_Formal_Incomplete_Type (T, Def);
2855
2856 when N_Formal_Discrete_Type_Definition =>
2857 Analyze_Formal_Discrete_Type (T, Def);
2858
2859 when N_Formal_Signed_Integer_Type_Definition =>
2860 Analyze_Formal_Signed_Integer_Type (T, Def);
2861
2862 when N_Formal_Modular_Type_Definition =>
2863 Analyze_Formal_Modular_Type (T, Def);
2864
2865 when N_Formal_Floating_Point_Definition =>
2866 Analyze_Formal_Floating_Type (T, Def);
2867
2868 when N_Formal_Ordinary_Fixed_Point_Definition =>
2869 Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
2870
2871 when N_Formal_Decimal_Fixed_Point_Definition =>
2872 Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
2873
2874 when N_Array_Type_Definition =>
2875 Analyze_Formal_Array_Type (T, Def);
2876
2877 when N_Access_To_Object_Definition |
2878 N_Access_Function_Definition |
2879 N_Access_Procedure_Definition =>
2880 Analyze_Generic_Access_Type (T, Def);
2881
2882 -- Ada 2005: a interface declaration is encoded as an abstract
2883 -- record declaration or a abstract type derivation.
2884
2885 when N_Record_Definition =>
2886 Analyze_Formal_Interface_Type (N, T, Def);
2887
2888 when N_Derived_Type_Definition =>
2889 Analyze_Formal_Derived_Interface_Type (N, T, Def);
2890
2891 when N_Error =>
2892 null;
2893
2894 when others =>
2895 raise Program_Error;
2896
2897 end case;
2898
2899 Set_Is_Generic_Type (T);
2900
2901 if Has_Aspects (N) then
2902 Analyze_Aspect_Specifications (N, T);
2903 end if;
2904 end Analyze_Formal_Type_Declaration;
2905
2906 ------------------------------------
2907 -- Analyze_Function_Instantiation --
2908 ------------------------------------
2909
2910 procedure Analyze_Function_Instantiation (N : Node_Id) is
2911 begin
2912 Analyze_Subprogram_Instantiation (N, E_Function);
2913 end Analyze_Function_Instantiation;
2914
2915 ---------------------------------
2916 -- Analyze_Generic_Access_Type --
2917 ---------------------------------
2918
2919 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
2920 begin
2921 Enter_Name (T);
2922
2923 if Nkind (Def) = N_Access_To_Object_Definition then
2924 Access_Type_Declaration (T, Def);
2925
2926 if Is_Incomplete_Or_Private_Type (Designated_Type (T))
2927 and then No (Full_View (Designated_Type (T)))
2928 and then not Is_Generic_Type (Designated_Type (T))
2929 then
2930 Error_Msg_N ("premature usage of incomplete type", Def);
2931
2932 elsif not Is_Entity_Name (Subtype_Indication (Def)) then
2933 Error_Msg_N
2934 ("only a subtype mark is allowed in a formal", Def);
2935 end if;
2936
2937 else
2938 Access_Subprogram_Declaration (T, Def);
2939 end if;
2940 end Analyze_Generic_Access_Type;
2941
2942 ---------------------------------
2943 -- Analyze_Generic_Formal_Part --
2944 ---------------------------------
2945
2946 procedure Analyze_Generic_Formal_Part (N : Node_Id) is
2947 Gen_Parm_Decl : Node_Id;
2948
2949 begin
2950 -- The generic formals are processed in the scope of the generic unit,
2951 -- where they are immediately visible. The scope is installed by the
2952 -- caller.
2953
2954 Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
2955
2956 while Present (Gen_Parm_Decl) loop
2957 Analyze (Gen_Parm_Decl);
2958 Next (Gen_Parm_Decl);
2959 end loop;
2960
2961 Generate_Reference_To_Generic_Formals (Current_Scope);
2962 end Analyze_Generic_Formal_Part;
2963
2964 ------------------------------------------
2965 -- Analyze_Generic_Package_Declaration --
2966 ------------------------------------------
2967
2968 procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
2969 Loc : constant Source_Ptr := Sloc (N);
2970 Id : Entity_Id;
2971 New_N : Node_Id;
2972 Save_Parent : Node_Id;
2973 Renaming : Node_Id;
2974 Decls : constant List_Id :=
2975 Visible_Declarations (Specification (N));
2976 Decl : Node_Id;
2977
2978 begin
2979 Check_SPARK_Restriction ("generic is not allowed", N);
2980
2981 -- We introduce a renaming of the enclosing package, to have a usable
2982 -- entity as the prefix of an expanded name for a local entity of the
2983 -- form Par.P.Q, where P is the generic package. This is because a local
2984 -- entity named P may hide it, so that the usual visibility rules in
2985 -- the instance will not resolve properly.
2986
2987 Renaming :=
2988 Make_Package_Renaming_Declaration (Loc,
2989 Defining_Unit_Name =>
2990 Make_Defining_Identifier (Loc,
2991 Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
2992 Name => Make_Identifier (Loc, Chars (Defining_Entity (N))));
2993
2994 if Present (Decls) then
2995 Decl := First (Decls);
2996 while Present (Decl)
2997 and then Nkind (Decl) = N_Pragma
2998 loop
2999 Next (Decl);
3000 end loop;
3001
3002 if Present (Decl) then
3003 Insert_Before (Decl, Renaming);
3004 else
3005 Append (Renaming, Visible_Declarations (Specification (N)));
3006 end if;
3007
3008 else
3009 Set_Visible_Declarations (Specification (N), New_List (Renaming));
3010 end if;
3011
3012 -- Create copy of generic unit, and save for instantiation. If the unit
3013 -- is a child unit, do not copy the specifications for the parent, which
3014 -- are not part of the generic tree.
3015
3016 Save_Parent := Parent_Spec (N);
3017 Set_Parent_Spec (N, Empty);
3018
3019 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3020 Set_Parent_Spec (New_N, Save_Parent);
3021 Rewrite (N, New_N);
3022
3023 -- Once the contents of the generic copy and the template are swapped,
3024 -- do the same for their respective aspect specifications.
3025
3026 Exchange_Aspects (N, New_N);
3027 Id := Defining_Entity (N);
3028 Generate_Definition (Id);
3029
3030 -- Expansion is not applied to generic units
3031
3032 Start_Generic;
3033
3034 Enter_Name (Id);
3035 Set_Ekind (Id, E_Generic_Package);
3036 Set_Etype (Id, Standard_Void_Type);
3037 Set_Contract (Id, Make_Contract (Sloc (Id)));
3038
3039 -- Analyze aspects now, so that generated pragmas appear in the
3040 -- declarations before building and analyzing the generic copy.
3041
3042 if Has_Aspects (N) then
3043 Analyze_Aspect_Specifications (N, Id);
3044 end if;
3045
3046 Push_Scope (Id);
3047 Enter_Generic_Scope (Id);
3048 Set_Inner_Instances (Id, New_Elmt_List);
3049
3050 Set_Categorization_From_Pragmas (N);
3051 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3052
3053 -- Link the declaration of the generic homonym in the generic copy to
3054 -- the package it renames, so that it is always resolved properly.
3055
3056 Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
3057 Set_Entity (Associated_Node (Name (Renaming)), Id);
3058
3059 -- For a library unit, we have reconstructed the entity for the unit,
3060 -- and must reset it in the library tables.
3061
3062 if Nkind (Parent (N)) = N_Compilation_Unit then
3063 Set_Cunit_Entity (Current_Sem_Unit, Id);
3064 end if;
3065
3066 Analyze_Generic_Formal_Part (N);
3067
3068 -- After processing the generic formals, analysis proceeds as for a
3069 -- non-generic package.
3070
3071 Analyze (Specification (N));
3072
3073 Validate_Categorization_Dependency (N, Id);
3074
3075 End_Generic;
3076
3077 End_Package_Scope (Id);
3078 Exit_Generic_Scope (Id);
3079
3080 if Nkind (Parent (N)) /= N_Compilation_Unit then
3081 Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
3082 Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
3083 Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
3084
3085 else
3086 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3087 Validate_RT_RAT_Component (N);
3088
3089 -- If this is a spec without a body, check that generic parameters
3090 -- are referenced.
3091
3092 if not Body_Required (Parent (N)) then
3093 Check_References (Id);
3094 end if;
3095 end if;
3096 end Analyze_Generic_Package_Declaration;
3097
3098 --------------------------------------------
3099 -- Analyze_Generic_Subprogram_Declaration --
3100 --------------------------------------------
3101
3102 procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
3103 Spec : Node_Id;
3104 Id : Entity_Id;
3105 Formals : List_Id;
3106 New_N : Node_Id;
3107 Result_Type : Entity_Id;
3108 Save_Parent : Node_Id;
3109 Typ : Entity_Id;
3110
3111 begin
3112 Check_SPARK_Restriction ("generic is not allowed", N);
3113
3114 -- Create copy of generic unit, and save for instantiation. If the unit
3115 -- is a child unit, do not copy the specifications for the parent, which
3116 -- are not part of the generic tree.
3117
3118 Save_Parent := Parent_Spec (N);
3119 Set_Parent_Spec (N, Empty);
3120
3121 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3122 Set_Parent_Spec (New_N, Save_Parent);
3123 Rewrite (N, New_N);
3124
3125 Check_SPARK_Mode_In_Generic (N);
3126
3127 -- The aspect specifications are not attached to the tree, and must
3128 -- be copied and attached to the generic copy explicitly.
3129
3130 if Present (Aspect_Specifications (New_N)) then
3131 declare
3132 Aspects : constant List_Id := Aspect_Specifications (N);
3133 begin
3134 Set_Has_Aspects (N, False);
3135 Move_Aspects (New_N, To => N);
3136 Set_Has_Aspects (Original_Node (N), False);
3137 Set_Aspect_Specifications (Original_Node (N), Aspects);
3138 end;
3139 end if;
3140
3141 Spec := Specification (N);
3142 Id := Defining_Entity (Spec);
3143 Generate_Definition (Id);
3144 Set_Contract (Id, Make_Contract (Sloc (Id)));
3145
3146 if Nkind (Id) = N_Defining_Operator_Symbol then
3147 Error_Msg_N
3148 ("operator symbol not allowed for generic subprogram", Id);
3149 end if;
3150
3151 Start_Generic;
3152
3153 Enter_Name (Id);
3154
3155 Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
3156 Push_Scope (Id);
3157 Enter_Generic_Scope (Id);
3158 Set_Inner_Instances (Id, New_Elmt_List);
3159 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3160
3161 Analyze_Generic_Formal_Part (N);
3162
3163 Formals := Parameter_Specifications (Spec);
3164
3165 if Present (Formals) then
3166 Process_Formals (Formals, Spec);
3167 end if;
3168
3169 if Nkind (Spec) = N_Function_Specification then
3170 Set_Ekind (Id, E_Generic_Function);
3171
3172 if Nkind (Result_Definition (Spec)) = N_Access_Definition then
3173 Result_Type := Access_Definition (Spec, Result_Definition (Spec));
3174 Set_Etype (Id, Result_Type);
3175
3176 -- Check restriction imposed by AI05-073: a generic function
3177 -- cannot return an abstract type or an access to such.
3178
3179 -- This is a binding interpretation should it apply to earlier
3180 -- versions of Ada as well as Ada 2012???
3181
3182 if Is_Abstract_Type (Designated_Type (Result_Type))
3183 and then Ada_Version >= Ada_2012
3184 then
3185 Error_Msg_N ("generic function cannot have an access result"
3186 & " that designates an abstract type", Spec);
3187 end if;
3188
3189 else
3190 Find_Type (Result_Definition (Spec));
3191 Typ := Entity (Result_Definition (Spec));
3192
3193 if Is_Abstract_Type (Typ)
3194 and then Ada_Version >= Ada_2012
3195 then
3196 Error_Msg_N
3197 ("generic function cannot have abstract result type", Spec);
3198 end if;
3199
3200 -- If a null exclusion is imposed on the result type, then create
3201 -- a null-excluding itype (an access subtype) and use it as the
3202 -- function's Etype.
3203
3204 if Is_Access_Type (Typ)
3205 and then Null_Exclusion_Present (Spec)
3206 then
3207 Set_Etype (Id,
3208 Create_Null_Excluding_Itype
3209 (T => Typ,
3210 Related_Nod => Spec,
3211 Scope_Id => Defining_Unit_Name (Spec)));
3212 else
3213 Set_Etype (Id, Typ);
3214 end if;
3215 end if;
3216
3217 else
3218 Set_Ekind (Id, E_Generic_Procedure);
3219 Set_Etype (Id, Standard_Void_Type);
3220 end if;
3221
3222 -- For a library unit, we have reconstructed the entity for the unit,
3223 -- and must reset it in the library tables. We also make sure that
3224 -- Body_Required is set properly in the original compilation unit node.
3225
3226 if Nkind (Parent (N)) = N_Compilation_Unit then
3227 Set_Cunit_Entity (Current_Sem_Unit, Id);
3228 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3229 end if;
3230
3231 Set_Categorization_From_Pragmas (N);
3232 Validate_Categorization_Dependency (N, Id);
3233
3234 Save_Global_References (Original_Node (N));
3235
3236 -- For ASIS purposes, convert any postcondition, precondition pragmas
3237 -- into aspects, if N is not a compilation unit by itself, in order to
3238 -- enable the analysis of expressions inside the corresponding PPC
3239 -- pragmas.
3240
3241 if ASIS_Mode and then Is_List_Member (N) then
3242 Make_Aspect_For_PPC_In_Gen_Sub_Decl (N);
3243 end if;
3244
3245 -- To capture global references, analyze the expressions of aspects,
3246 -- and propagate information to original tree. Note that in this case
3247 -- analysis of attributes is not delayed until the freeze point.
3248
3249 -- It seems very hard to recreate the proper visibility of the generic
3250 -- subprogram at a later point because the analysis of an aspect may
3251 -- create pragmas after the generic copies have been made ???
3252
3253 if Has_Aspects (N) then
3254 declare
3255 Aspect : Node_Id;
3256
3257 begin
3258 Aspect := First (Aspect_Specifications (N));
3259 while Present (Aspect) loop
3260 if Get_Aspect_Id (Aspect) /= Aspect_Warnings
3261 and then Present (Expression (Aspect))
3262 then
3263 Analyze (Expression (Aspect));
3264 end if;
3265
3266 Next (Aspect);
3267 end loop;
3268
3269 Aspect := First (Aspect_Specifications (Original_Node (N)));
3270 while Present (Aspect) loop
3271 if Present (Expression (Aspect)) then
3272 Save_Global_References (Expression (Aspect));
3273 end if;
3274
3275 Next (Aspect);
3276 end loop;
3277 end;
3278 end if;
3279
3280 End_Generic;
3281 End_Scope;
3282 Exit_Generic_Scope (Id);
3283 Generate_Reference_To_Formals (Id);
3284
3285 List_Inherited_Pre_Post_Aspects (Id);
3286 end Analyze_Generic_Subprogram_Declaration;
3287
3288 -----------------------------------
3289 -- Analyze_Package_Instantiation --
3290 -----------------------------------
3291
3292 procedure Analyze_Package_Instantiation (N : Node_Id) is
3293 Loc : constant Source_Ptr := Sloc (N);
3294 Gen_Id : constant Node_Id := Name (N);
3295
3296 Act_Decl : Node_Id;
3297 Act_Decl_Name : Node_Id;
3298 Act_Decl_Id : Entity_Id;
3299 Act_Spec : Node_Id;
3300 Act_Tree : Node_Id;
3301
3302 Gen_Decl : Node_Id;
3303 Gen_Unit : Entity_Id;
3304
3305 Is_Actual_Pack : constant Boolean :=
3306 Is_Internal (Defining_Entity (N));
3307
3308 Env_Installed : Boolean := False;
3309 Parent_Installed : Boolean := False;
3310 Renaming_List : List_Id;
3311 Unit_Renaming : Node_Id;
3312 Needs_Body : Boolean;
3313 Inline_Now : Boolean := False;
3314
3315 Save_Style_Check : constant Boolean := Style_Check;
3316 -- Save style check mode for restore on exit
3317
3318 procedure Delay_Descriptors (E : Entity_Id);
3319 -- Delay generation of subprogram descriptors for given entity
3320
3321 function Might_Inline_Subp return Boolean;
3322 -- If inlining is active and the generic contains inlined subprograms,
3323 -- we instantiate the body. This may cause superfluous instantiations,
3324 -- but it is simpler than detecting the need for the body at the point
3325 -- of inlining, when the context of the instance is not available.
3326
3327 function Must_Inline_Subp return Boolean;
3328 -- If inlining is active and the generic contains inlined subprograms,
3329 -- return True if some of the inlined subprograms must be inlined by
3330 -- the frontend.
3331
3332 -----------------------
3333 -- Delay_Descriptors --
3334 -----------------------
3335
3336 procedure Delay_Descriptors (E : Entity_Id) is
3337 begin
3338 if not Delay_Subprogram_Descriptors (E) then
3339 Set_Delay_Subprogram_Descriptors (E);
3340 Pending_Descriptor.Append (E);
3341 end if;
3342 end Delay_Descriptors;
3343
3344 -----------------------
3345 -- Might_Inline_Subp --
3346 -----------------------
3347
3348 function Might_Inline_Subp return Boolean is
3349 E : Entity_Id;
3350
3351 begin
3352 if not Inline_Processing_Required then
3353 return False;
3354
3355 else
3356 E := First_Entity (Gen_Unit);
3357 while Present (E) loop
3358 if Is_Subprogram (E)
3359 and then Is_Inlined (E)
3360 then
3361 return True;
3362 end if;
3363
3364 Next_Entity (E);
3365 end loop;
3366 end if;
3367
3368 return False;
3369 end Might_Inline_Subp;
3370
3371 ----------------------
3372 -- Must_Inline_Subp --
3373 ----------------------
3374
3375 function Must_Inline_Subp return Boolean is
3376 E : Entity_Id;
3377
3378 begin
3379 if not Inline_Processing_Required then
3380 return False;
3381
3382 else
3383 E := First_Entity (Gen_Unit);
3384 while Present (E) loop
3385 if Is_Subprogram (E)
3386 and then Is_Inlined (E)
3387 and then Must_Inline (E)
3388 then
3389 return True;
3390 end if;
3391
3392 Next_Entity (E);
3393 end loop;
3394 end if;
3395
3396 return False;
3397 end Must_Inline_Subp;
3398
3399 -- Local declarations
3400
3401 Vis_Prims_List : Elist_Id := No_Elist;
3402 -- List of primitives made temporarily visible in the instantiation
3403 -- to match the visibility of the formal type
3404
3405 -- Start of processing for Analyze_Package_Instantiation
3406
3407 begin
3408 Check_SPARK_Restriction ("generic is not allowed", N);
3409
3410 -- Very first thing: apply the special kludge for Text_IO processing
3411 -- in case we are instantiating one of the children of [Wide_]Text_IO.
3412
3413 Text_IO_Kludge (Name (N));
3414
3415 -- Make node global for error reporting
3416
3417 Instantiation_Node := N;
3418
3419 -- Turn off style checking in instances. If the check is enabled on the
3420 -- generic unit, a warning in an instance would just be noise. If not
3421 -- enabled on the generic, then a warning in an instance is just wrong.
3422
3423 Style_Check := False;
3424
3425 -- Case of instantiation of a generic package
3426
3427 if Nkind (N) = N_Package_Instantiation then
3428 Act_Decl_Id := New_Copy (Defining_Entity (N));
3429 Set_Comes_From_Source (Act_Decl_Id, True);
3430
3431 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3432 Act_Decl_Name :=
3433 Make_Defining_Program_Unit_Name (Loc,
3434 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
3435 Defining_Identifier => Act_Decl_Id);
3436 else
3437 Act_Decl_Name := Act_Decl_Id;
3438 end if;
3439
3440 -- Case of instantiation of a formal package
3441
3442 else
3443 Act_Decl_Id := Defining_Identifier (N);
3444 Act_Decl_Name := Act_Decl_Id;
3445 end if;
3446
3447 Generate_Definition (Act_Decl_Id);
3448 Preanalyze_Actuals (N);
3449
3450 Init_Env;
3451 Env_Installed := True;
3452
3453 -- Reset renaming map for formal types. The mapping is established
3454 -- when analyzing the generic associations, but some mappings are
3455 -- inherited from formal packages of parent units, and these are
3456 -- constructed when the parents are installed.
3457
3458 Generic_Renamings.Set_Last (0);
3459 Generic_Renamings_HTable.Reset;
3460
3461 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3462 Gen_Unit := Entity (Gen_Id);
3463
3464 -- Verify that it is the name of a generic package
3465
3466 -- A visibility glitch: if the instance is a child unit and the generic
3467 -- is the generic unit of a parent instance (i.e. both the parent and
3468 -- the child units are instances of the same package) the name now
3469 -- denotes the renaming within the parent, not the intended generic
3470 -- unit. See if there is a homonym that is the desired generic. The
3471 -- renaming declaration must be visible inside the instance of the
3472 -- child, but not when analyzing the name in the instantiation itself.
3473
3474 if Ekind (Gen_Unit) = E_Package
3475 and then Present (Renamed_Entity (Gen_Unit))
3476 and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3477 and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3478 and then Present (Homonym (Gen_Unit))
3479 then
3480 Gen_Unit := Homonym (Gen_Unit);
3481 end if;
3482
3483 if Etype (Gen_Unit) = Any_Type then
3484 Restore_Env;
3485 goto Leave;
3486
3487 elsif Ekind (Gen_Unit) /= E_Generic_Package then
3488
3489 -- Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3490
3491 if From_Limited_With (Gen_Unit) then
3492 Error_Msg_N
3493 ("cannot instantiate a limited withed package", Gen_Id);
3494 else
3495 Error_Msg_NE
3496 ("& is not the name of a generic package", Gen_Id, Gen_Unit);
3497 end if;
3498
3499 Restore_Env;
3500 goto Leave;
3501 end if;
3502
3503 if In_Extended_Main_Source_Unit (N) then
3504 Set_Is_Instantiated (Gen_Unit);
3505 Generate_Reference (Gen_Unit, N);
3506
3507 if Present (Renamed_Object (Gen_Unit)) then
3508 Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3509 Generate_Reference (Renamed_Object (Gen_Unit), N);
3510 end if;
3511 end if;
3512
3513 if Nkind (Gen_Id) = N_Identifier
3514 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3515 then
3516 Error_Msg_NE
3517 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3518
3519 elsif Nkind (Gen_Id) = N_Expanded_Name
3520 and then Is_Child_Unit (Gen_Unit)
3521 and then Nkind (Prefix (Gen_Id)) = N_Identifier
3522 and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3523 then
3524 Error_Msg_N
3525 ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3526 end if;
3527
3528 Set_Entity (Gen_Id, Gen_Unit);
3529
3530 -- If generic is a renaming, get original generic unit
3531
3532 if Present (Renamed_Object (Gen_Unit))
3533 and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3534 then
3535 Gen_Unit := Renamed_Object (Gen_Unit);
3536 end if;
3537
3538 -- Verify that there are no circular instantiations
3539
3540 if In_Open_Scopes (Gen_Unit) then
3541 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3542 Restore_Env;
3543 goto Leave;
3544
3545 elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3546 Error_Msg_Node_2 := Current_Scope;
3547 Error_Msg_NE
3548 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3549 Circularity_Detected := True;
3550 Restore_Env;
3551 goto Leave;
3552
3553 else
3554 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3555
3556 -- Initialize renamings map, for error checking, and the list that
3557 -- holds private entities whose views have changed between generic
3558 -- definition and instantiation. If this is the instance created to
3559 -- validate an actual package, the instantiation environment is that
3560 -- of the enclosing instance.
3561
3562 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3563
3564 -- Copy original generic tree, to produce text for instantiation
3565
3566 Act_Tree :=
3567 Copy_Generic_Node
3568 (Original_Node (Gen_Decl), Empty, Instantiating => True);
3569
3570 Act_Spec := Specification (Act_Tree);
3571
3572 -- If this is the instance created to validate an actual package,
3573 -- only the formals matter, do not examine the package spec itself.
3574
3575 if Is_Actual_Pack then
3576 Set_Visible_Declarations (Act_Spec, New_List);
3577 Set_Private_Declarations (Act_Spec, New_List);
3578 end if;
3579
3580 Renaming_List :=
3581 Analyze_Associations
3582 (I_Node => N,
3583 Formals => Generic_Formal_Declarations (Act_Tree),
3584 F_Copy => Generic_Formal_Declarations (Gen_Decl));
3585
3586 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
3587
3588 Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3589 Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3590 Set_Is_Generic_Instance (Act_Decl_Id);
3591 Set_Generic_Parent (Act_Spec, Gen_Unit);
3592
3593 -- References to the generic in its own declaration or its body are
3594 -- references to the instance. Add a renaming declaration for the
3595 -- generic unit itself. This declaration, as well as the renaming
3596 -- declarations for the generic formals, must remain private to the
3597 -- unit: the formals, because this is the language semantics, and
3598 -- the unit because its use is an artifact of the implementation.
3599
3600 Unit_Renaming :=
3601 Make_Package_Renaming_Declaration (Loc,
3602 Defining_Unit_Name =>
3603 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3604 Name => New_Occurrence_Of (Act_Decl_Id, Loc));
3605
3606 Append (Unit_Renaming, Renaming_List);
3607
3608 -- The renaming declarations are the first local declarations of the
3609 -- new unit.
3610
3611 if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3612 Insert_List_Before
3613 (First (Visible_Declarations (Act_Spec)), Renaming_List);
3614 else
3615 Set_Visible_Declarations (Act_Spec, Renaming_List);
3616 end if;
3617
3618 Act_Decl :=
3619 Make_Package_Declaration (Loc,
3620 Specification => Act_Spec);
3621
3622 -- Propagate the aspect specifications from the package declaration
3623 -- template to the instantiated version of the package declaration.
3624
3625 if Has_Aspects (Act_Tree) then
3626 Set_Aspect_Specifications (Act_Decl,
3627 New_Copy_List_Tree (Aspect_Specifications (Act_Tree)));
3628 end if;
3629
3630 -- Save the instantiation node, for subsequent instantiation of the
3631 -- body, if there is one and we are generating code for the current
3632 -- unit. Mark unit as having a body (avoids premature error message).
3633
3634 -- We instantiate the body if we are generating code, if we are
3635 -- generating cross-reference information, or if we are building
3636 -- trees for ASIS use or GNATprove use.
3637
3638 declare
3639 Enclosing_Body_Present : Boolean := False;
3640 -- If the generic unit is not a compilation unit, then a body may
3641 -- be present in its parent even if none is required. We create a
3642 -- tentative pending instantiation for the body, which will be
3643 -- discarded if none is actually present.
3644
3645 Scop : Entity_Id;
3646
3647 begin
3648 if Scope (Gen_Unit) /= Standard_Standard
3649 and then not Is_Child_Unit (Gen_Unit)
3650 then
3651 Scop := Scope (Gen_Unit);
3652
3653 while Present (Scop)
3654 and then Scop /= Standard_Standard
3655 loop
3656 if Unit_Requires_Body (Scop) then
3657 Enclosing_Body_Present := True;
3658 exit;
3659
3660 elsif In_Open_Scopes (Scop)
3661 and then In_Package_Body (Scop)
3662 then
3663 Enclosing_Body_Present := True;
3664 exit;
3665 end if;
3666
3667 exit when Is_Compilation_Unit (Scop);
3668 Scop := Scope (Scop);
3669 end loop;
3670 end if;
3671
3672 -- If front-end inlining is enabled, and this is a unit for which
3673 -- code will be generated, we instantiate the body at once.
3674
3675 -- This is done if the instance is not the main unit, and if the
3676 -- generic is not a child unit of another generic, to avoid scope
3677 -- problems and the reinstallation of parent instances.
3678
3679 if Expander_Active
3680 and then (not Is_Child_Unit (Gen_Unit)
3681 or else not Is_Generic_Unit (Scope (Gen_Unit)))
3682 and then Might_Inline_Subp
3683 and then not Is_Actual_Pack
3684 then
3685 if not Debug_Flag_Dot_K
3686 and then Front_End_Inlining
3687 and then (Is_In_Main_Unit (N)
3688 or else In_Main_Context (Current_Scope))
3689 and then Nkind (Parent (N)) /= N_Compilation_Unit
3690 then
3691 Inline_Now := True;
3692
3693 elsif Debug_Flag_Dot_K
3694 and then Must_Inline_Subp
3695 and then (Is_In_Main_Unit (N)
3696 or else In_Main_Context (Current_Scope))
3697 and then Nkind (Parent (N)) /= N_Compilation_Unit
3698 then
3699 Inline_Now := True;
3700
3701 -- In configurable_run_time mode we force the inlining of
3702 -- predefined subprograms marked Inline_Always, to minimize
3703 -- the use of the run-time library.
3704
3705 elsif Is_Predefined_File_Name
3706 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
3707 and then Configurable_Run_Time_Mode
3708 and then Nkind (Parent (N)) /= N_Compilation_Unit
3709 then
3710 Inline_Now := True;
3711 end if;
3712
3713 -- If the current scope is itself an instance within a child
3714 -- unit, there will be duplications in the scope stack, and the
3715 -- unstacking mechanism in Inline_Instance_Body will fail.
3716 -- This loses some rare cases of optimization, and might be
3717 -- improved some day, if we can find a proper abstraction for
3718 -- "the complete compilation context" that can be saved and
3719 -- restored. ???
3720
3721 if Is_Generic_Instance (Current_Scope) then
3722 declare
3723 Curr_Unit : constant Entity_Id :=
3724 Cunit_Entity (Current_Sem_Unit);
3725 begin
3726 if Curr_Unit /= Current_Scope
3727 and then Is_Child_Unit (Curr_Unit)
3728 then
3729 Inline_Now := False;
3730 end if;
3731 end;
3732 end if;
3733 end if;
3734
3735 Needs_Body :=
3736 (Unit_Requires_Body (Gen_Unit)
3737 or else Enclosing_Body_Present
3738 or else Present (Corresponding_Body (Gen_Decl)))
3739 and then (Is_In_Main_Unit (N) or else Might_Inline_Subp)
3740 and then not Is_Actual_Pack
3741 and then not Inline_Now
3742 and then (Operating_Mode = Generate_Code
3743
3744 -- Need comment for this check ???
3745
3746 or else (Operating_Mode = Check_Semantics
3747 and then (ASIS_Mode or GNATprove_Mode)));
3748
3749 -- If front_end_inlining is enabled, do not instantiate body if
3750 -- within a generic context.
3751
3752 if (Front_End_Inlining and then not Expander_Active)
3753 or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
3754 then
3755 Needs_Body := False;
3756 end if;
3757
3758 -- If the current context is generic, and the package being
3759 -- instantiated is declared within a formal package, there is no
3760 -- body to instantiate until the enclosing generic is instantiated
3761 -- and there is an actual for the formal package. If the formal
3762 -- package has parameters, we build a regular package instance for
3763 -- it, that precedes the original formal package declaration.
3764
3765 if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
3766 declare
3767 Decl : constant Node_Id :=
3768 Original_Node
3769 (Unit_Declaration_Node (Scope (Gen_Unit)));
3770 begin
3771 if Nkind (Decl) = N_Formal_Package_Declaration
3772 or else (Nkind (Decl) = N_Package_Declaration
3773 and then Is_List_Member (Decl)
3774 and then Present (Next (Decl))
3775 and then
3776 Nkind (Next (Decl)) =
3777 N_Formal_Package_Declaration)
3778 then
3779 Needs_Body := False;
3780 end if;
3781 end;
3782 end if;
3783 end;
3784
3785 -- For RCI unit calling stubs, we omit the instance body if the
3786 -- instance is the RCI library unit itself.
3787
3788 -- However there is a special case for nested instances: in this case
3789 -- we do generate the instance body, as it might be required, e.g.
3790 -- because it provides stream attributes for some type used in the
3791 -- profile of a remote subprogram. This is consistent with 12.3(12),
3792 -- which indicates that the instance body occurs at the place of the
3793 -- instantiation, and thus is part of the RCI declaration, which is
3794 -- present on all client partitions (this is E.2.3(18)).
3795
3796 -- Note that AI12-0002 may make it illegal at some point to have
3797 -- stream attributes defined in an RCI unit, in which case this
3798 -- special case will become unnecessary. In the meantime, there
3799 -- is known application code in production that depends on this
3800 -- being possible, so we definitely cannot eliminate the body in
3801 -- the case of nested instances for the time being.
3802
3803 -- When we generate a nested instance body, calling stubs for any
3804 -- relevant subprogram will be be inserted immediately after the
3805 -- subprogram declarations, and will take precedence over the
3806 -- subsequent (original) body. (The stub and original body will be
3807 -- complete homographs, but this is permitted in an instance).
3808 -- (Could we do better and remove the original body???)
3809
3810 if Distribution_Stub_Mode = Generate_Caller_Stub_Body
3811 and then Comes_From_Source (N)
3812 and then Nkind (Parent (N)) = N_Compilation_Unit
3813 then
3814 Needs_Body := False;
3815 end if;
3816
3817 if Needs_Body then
3818
3819 -- Here is a defence against a ludicrous number of instantiations
3820 -- caused by a circular set of instantiation attempts.
3821
3822 if Pending_Instantiations.Last > Maximum_Instantiations then
3823 Error_Msg_Uint_1 := UI_From_Int (Maximum_Instantiations);
3824 Error_Msg_N ("too many instantiations, exceeds max of^", N);
3825 Error_Msg_N ("\limit can be changed using -gnateinn switch", N);
3826 raise Unrecoverable_Error;
3827 end if;
3828
3829 -- Indicate that the enclosing scopes contain an instantiation,
3830 -- and that cleanup actions should be delayed until after the
3831 -- instance body is expanded.
3832
3833 Check_Forward_Instantiation (Gen_Decl);
3834 if Nkind (N) = N_Package_Instantiation then
3835 declare
3836 Enclosing_Master : Entity_Id;
3837
3838 begin
3839 -- Loop to search enclosing masters
3840
3841 Enclosing_Master := Current_Scope;
3842 Scope_Loop : while Enclosing_Master /= Standard_Standard loop
3843 if Ekind (Enclosing_Master) = E_Package then
3844 if Is_Compilation_Unit (Enclosing_Master) then
3845 if In_Package_Body (Enclosing_Master) then
3846 Delay_Descriptors
3847 (Body_Entity (Enclosing_Master));
3848 else
3849 Delay_Descriptors
3850 (Enclosing_Master);
3851 end if;
3852
3853 exit Scope_Loop;
3854
3855 else
3856 Enclosing_Master := Scope (Enclosing_Master);
3857 end if;
3858
3859 elsif Is_Generic_Unit (Enclosing_Master)
3860 or else Ekind (Enclosing_Master) = E_Void
3861 then
3862 -- Cleanup actions will eventually be performed on the
3863 -- enclosing subprogram or package instance, if any.
3864 -- Enclosing scope is void in the formal part of a
3865 -- generic subprogram.
3866
3867 exit Scope_Loop;
3868
3869 else
3870 if Ekind (Enclosing_Master) = E_Entry
3871 and then
3872 Ekind (Scope (Enclosing_Master)) = E_Protected_Type
3873 then
3874 if not Expander_Active then
3875 exit Scope_Loop;
3876 else
3877 Enclosing_Master :=
3878 Protected_Body_Subprogram (Enclosing_Master);
3879 end if;
3880 end if;
3881
3882 Set_Delay_Cleanups (Enclosing_Master);
3883
3884 while Ekind (Enclosing_Master) = E_Block loop
3885 Enclosing_Master := Scope (Enclosing_Master);
3886 end loop;
3887
3888 if Is_Subprogram (Enclosing_Master) then
3889 Delay_Descriptors (Enclosing_Master);
3890
3891 elsif Is_Task_Type (Enclosing_Master) then
3892 declare
3893 TBP : constant Node_Id :=
3894 Get_Task_Body_Procedure
3895 (Enclosing_Master);
3896 begin
3897 if Present (TBP) then
3898 Delay_Descriptors (TBP);
3899 Set_Delay_Cleanups (TBP);
3900 end if;
3901 end;
3902 end if;
3903
3904 exit Scope_Loop;
3905 end if;
3906 end loop Scope_Loop;
3907 end;
3908
3909 -- Make entry in table
3910
3911 Pending_Instantiations.Append
3912 ((Inst_Node => N,
3913 Act_Decl => Act_Decl,
3914 Expander_Status => Expander_Active,
3915 Current_Sem_Unit => Current_Sem_Unit,
3916 Scope_Suppress => Scope_Suppress,
3917 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
3918 Version => Ada_Version,
3919 Version_Pragma => Ada_Version_Pragma,
3920 Warnings => Save_Warnings,
3921 SPARK_Mode => SPARK_Mode,
3922 SPARK_Mode_Pragma => SPARK_Mode_Pragma));
3923 end if;
3924 end if;
3925
3926 Set_Categorization_From_Pragmas (Act_Decl);
3927
3928 if Parent_Installed then
3929 Hide_Current_Scope;
3930 end if;
3931
3932 Set_Instance_Spec (N, Act_Decl);
3933
3934 -- If not a compilation unit, insert the package declaration before
3935 -- the original instantiation node.
3936
3937 if Nkind (Parent (N)) /= N_Compilation_Unit then
3938 Mark_Rewrite_Insertion (Act_Decl);
3939 Insert_Before (N, Act_Decl);
3940 Analyze (Act_Decl);
3941
3942 -- For an instantiation that is a compilation unit, place
3943 -- declaration on current node so context is complete for analysis
3944 -- (including nested instantiations). If this is the main unit,
3945 -- the declaration eventually replaces the instantiation node.
3946 -- If the instance body is created later, it replaces the
3947 -- instance node, and the declaration is attached to it
3948 -- (see Build_Instance_Compilation_Unit_Nodes).
3949
3950 else
3951 if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
3952
3953 -- The entity for the current unit is the newly created one,
3954 -- and all semantic information is attached to it.
3955
3956 Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
3957
3958 -- If this is the main unit, replace the main entity as well
3959
3960 if Current_Sem_Unit = Main_Unit then
3961 Main_Unit_Entity := Act_Decl_Id;
3962 end if;
3963 end if;
3964
3965 Set_Unit (Parent (N), Act_Decl);
3966 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
3967 Set_Package_Instantiation (Act_Decl_Id, N);
3968
3969 -- Process aspect specifications of the instance node, if any, to
3970 -- take into account categorization pragmas before analyzing the
3971 -- instance.
3972
3973 if Has_Aspects (N) then
3974 Analyze_Aspect_Specifications (N, Act_Decl_Id);
3975 end if;
3976
3977 Analyze (Act_Decl);
3978 Set_Unit (Parent (N), N);
3979 Set_Body_Required (Parent (N), False);
3980
3981 -- We never need elaboration checks on instantiations, since by
3982 -- definition, the body instantiation is elaborated at the same
3983 -- time as the spec instantiation.
3984
3985 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
3986 Set_Kill_Elaboration_Checks (Act_Decl_Id);
3987 end if;
3988
3989 Check_Elab_Instantiation (N);
3990
3991 if ABE_Is_Certain (N) and then Needs_Body then
3992 Pending_Instantiations.Decrement_Last;
3993 end if;
3994
3995 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
3996
3997 Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
3998 First_Private_Entity (Act_Decl_Id));
3999
4000 -- If the instantiation will receive a body, the unit will be
4001 -- transformed into a package body, and receive its own elaboration
4002 -- entity. Otherwise, the nature of the unit is now a package
4003 -- declaration.
4004
4005 if Nkind (Parent (N)) = N_Compilation_Unit
4006 and then not Needs_Body
4007 then
4008 Rewrite (N, Act_Decl);
4009 end if;
4010
4011 if Present (Corresponding_Body (Gen_Decl))
4012 or else Unit_Requires_Body (Gen_Unit)
4013 then
4014 Set_Has_Completion (Act_Decl_Id);
4015 end if;
4016
4017 Check_Formal_Packages (Act_Decl_Id);
4018
4019 Restore_Hidden_Primitives (Vis_Prims_List);
4020 Restore_Private_Views (Act_Decl_Id);
4021
4022 Inherit_Context (Gen_Decl, N);
4023
4024 if Parent_Installed then
4025 Remove_Parent;
4026 end if;
4027
4028 Restore_Env;
4029 Env_Installed := False;
4030 end if;
4031
4032 Validate_Categorization_Dependency (N, Act_Decl_Id);
4033
4034 -- There used to be a check here to prevent instantiations in local
4035 -- contexts if the No_Local_Allocators restriction was active. This
4036 -- check was removed by a binding interpretation in AI-95-00130/07,
4037 -- but we retain the code for documentation purposes.
4038
4039 -- if Ekind (Act_Decl_Id) /= E_Void
4040 -- and then not Is_Library_Level_Entity (Act_Decl_Id)
4041 -- then
4042 -- Check_Restriction (No_Local_Allocators, N);
4043 -- end if;
4044
4045 if Inline_Now then
4046 Inline_Instance_Body (N, Gen_Unit, Act_Decl);
4047 end if;
4048
4049 -- The following is a tree patch for ASIS: ASIS needs separate nodes to
4050 -- be used as defining identifiers for a formal package and for the
4051 -- corresponding expanded package.
4052
4053 if Nkind (N) = N_Formal_Package_Declaration then
4054 Act_Decl_Id := New_Copy (Defining_Entity (N));
4055 Set_Comes_From_Source (Act_Decl_Id, True);
4056 Set_Is_Generic_Instance (Act_Decl_Id, False);
4057 Set_Defining_Identifier (N, Act_Decl_Id);
4058 end if;
4059
4060 Style_Check := Save_Style_Check;
4061
4062 -- Check that if N is an instantiation of System.Dim_Float_IO or
4063 -- System.Dim_Integer_IO, the formal type has a dimension system.
4064
4065 if Nkind (N) = N_Package_Instantiation
4066 and then Is_Dim_IO_Package_Instantiation (N)
4067 then
4068 declare
4069 Assoc : constant Node_Id := First (Generic_Associations (N));
4070 begin
4071 if not Has_Dimension_System
4072 (Etype (Explicit_Generic_Actual_Parameter (Assoc)))
4073 then
4074 Error_Msg_N ("type with a dimension system expected", Assoc);
4075 end if;
4076 end;
4077 end if;
4078
4079 <<Leave>>
4080 if Has_Aspects (N) and then Nkind (Parent (N)) /= N_Compilation_Unit then
4081 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4082 end if;
4083
4084 exception
4085 when Instantiation_Error =>
4086 if Parent_Installed then
4087 Remove_Parent;
4088 end if;
4089
4090 if Env_Installed then
4091 Restore_Env;
4092 end if;
4093
4094 Style_Check := Save_Style_Check;
4095 end Analyze_Package_Instantiation;
4096
4097 --------------------------
4098 -- Inline_Instance_Body --
4099 --------------------------
4100
4101 procedure Inline_Instance_Body
4102 (N : Node_Id;
4103 Gen_Unit : Entity_Id;
4104 Act_Decl : Node_Id)
4105 is
4106 Vis : Boolean;
4107 Gen_Comp : constant Entity_Id :=
4108 Cunit_Entity (Get_Source_Unit (Gen_Unit));
4109 Curr_Comp : constant Node_Id := Cunit (Current_Sem_Unit);
4110 Curr_Scope : Entity_Id := Empty;
4111 Curr_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
4112 Removed : Boolean := False;
4113 Num_Scopes : Int := 0;
4114
4115 Scope_Stack_Depth : constant Int :=
4116 Scope_Stack.Last - Scope_Stack.First + 1;
4117
4118 Use_Clauses : array (1 .. Scope_Stack_Depth) of Node_Id;
4119 Instances : array (1 .. Scope_Stack_Depth) of Entity_Id;
4120 Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
4121 List : Elist_Id;
4122 Num_Inner : Int := 0;
4123 N_Instances : Int := 0;
4124 S : Entity_Id;
4125
4126 begin
4127 -- Case of generic unit defined in another unit. We must remove the
4128 -- complete context of the current unit to install that of the generic.
4129
4130 if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
4131
4132 -- Add some comments for the following two loops ???
4133
4134 S := Current_Scope;
4135 while Present (S) and then S /= Standard_Standard loop
4136 loop
4137 Num_Scopes := Num_Scopes + 1;
4138
4139 Use_Clauses (Num_Scopes) :=
4140 (Scope_Stack.Table
4141 (Scope_Stack.Last - Num_Scopes + 1).
4142 First_Use_Clause);
4143 End_Use_Clauses (Use_Clauses (Num_Scopes));
4144
4145 exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
4146 or else Scope_Stack.Table
4147 (Scope_Stack.Last - Num_Scopes).Entity
4148 = Scope (S);
4149 end loop;
4150
4151 exit when Is_Generic_Instance (S)
4152 and then (In_Package_Body (S)
4153 or else Ekind (S) = E_Procedure
4154 or else Ekind (S) = E_Function);
4155 S := Scope (S);
4156 end loop;
4157
4158 Vis := Is_Immediately_Visible (Gen_Comp);
4159
4160 -- Find and save all enclosing instances
4161
4162 S := Current_Scope;
4163
4164 while Present (S)
4165 and then S /= Standard_Standard
4166 loop
4167 if Is_Generic_Instance (S) then
4168 N_Instances := N_Instances + 1;
4169 Instances (N_Instances) := S;
4170
4171 exit when In_Package_Body (S);
4172 end if;
4173
4174 S := Scope (S);
4175 end loop;
4176
4177 -- Remove context of current compilation unit, unless we are within a
4178 -- nested package instantiation, in which case the context has been
4179 -- removed previously.
4180
4181 -- If current scope is the body of a child unit, remove context of
4182 -- spec as well. If an enclosing scope is an instance body, the
4183 -- context has already been removed, but the entities in the body
4184 -- must be made invisible as well.
4185
4186 S := Current_Scope;
4187
4188 while Present (S)
4189 and then S /= Standard_Standard
4190 loop
4191 if Is_Generic_Instance (S)
4192 and then (In_Package_Body (S)
4193 or else Ekind (S) = E_Procedure
4194 or else Ekind (S) = E_Function)
4195 then
4196 -- We still have to remove the entities of the enclosing
4197 -- instance from direct visibility.
4198
4199 declare
4200 E : Entity_Id;
4201 begin
4202 E := First_Entity (S);
4203 while Present (E) loop
4204 Set_Is_Immediately_Visible (E, False);
4205 Next_Entity (E);
4206 end loop;
4207 end;
4208
4209 exit;
4210 end if;
4211
4212 if S = Curr_Unit
4213 or else (Ekind (Curr_Unit) = E_Package_Body
4214 and then S = Spec_Entity (Curr_Unit))
4215 or else (Ekind (Curr_Unit) = E_Subprogram_Body
4216 and then S =
4217 Corresponding_Spec
4218 (Unit_Declaration_Node (Curr_Unit)))
4219 then
4220 Removed := True;
4221
4222 -- Remove entities in current scopes from visibility, so that
4223 -- instance body is compiled in a clean environment.
4224
4225 List := Save_Scope_Stack (Handle_Use => False);
4226
4227 if Is_Child_Unit (S) then
4228
4229 -- Remove child unit from stack, as well as inner scopes.
4230 -- Removing the context of a child unit removes parent units
4231 -- as well.
4232
4233 while Current_Scope /= S loop
4234 Num_Inner := Num_Inner + 1;
4235 Inner_Scopes (Num_Inner) := Current_Scope;
4236 Pop_Scope;
4237 end loop;
4238
4239 Pop_Scope;
4240 Remove_Context (Curr_Comp);
4241 Curr_Scope := S;
4242
4243 else
4244 Remove_Context (Curr_Comp);
4245 end if;
4246
4247 if Ekind (Curr_Unit) = E_Package_Body then
4248 Remove_Context (Library_Unit (Curr_Comp));
4249 end if;
4250 end if;
4251
4252 S := Scope (S);
4253 end loop;
4254 pragma Assert (Num_Inner < Num_Scopes);
4255
4256 Push_Scope (Standard_Standard);
4257 Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4258 Instantiate_Package_Body
4259 (Body_Info =>
4260 ((Inst_Node => N,
4261 Act_Decl => Act_Decl,
4262 Expander_Status => Expander_Active,
4263 Current_Sem_Unit => Current_Sem_Unit,
4264 Scope_Suppress => Scope_Suppress,
4265 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4266 Version => Ada_Version,
4267 Version_Pragma => Ada_Version_Pragma,
4268 Warnings => Save_Warnings,
4269 SPARK_Mode => SPARK_Mode,
4270 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
4271 Inlined_Body => True);
4272
4273 Pop_Scope;
4274
4275 -- Restore context
4276
4277 Set_Is_Immediately_Visible (Gen_Comp, Vis);
4278
4279 -- Reset Generic_Instance flag so that use clauses can be installed
4280 -- in the proper order. (See Use_One_Package for effect of enclosing
4281 -- instances on processing of use clauses).
4282
4283 for J in 1 .. N_Instances loop
4284 Set_Is_Generic_Instance (Instances (J), False);
4285 end loop;
4286
4287 if Removed then
4288 Install_Context (Curr_Comp);
4289
4290 if Present (Curr_Scope)
4291 and then Is_Child_Unit (Curr_Scope)
4292 then
4293 Push_Scope (Curr_Scope);
4294 Set_Is_Immediately_Visible (Curr_Scope);
4295
4296 -- Finally, restore inner scopes as well
4297
4298 for J in reverse 1 .. Num_Inner loop
4299 Push_Scope (Inner_Scopes (J));
4300 end loop;
4301 end if;
4302
4303 Restore_Scope_Stack (List, Handle_Use => False);
4304
4305 if Present (Curr_Scope)
4306 and then
4307 (In_Private_Part (Curr_Scope)
4308 or else In_Package_Body (Curr_Scope))
4309 then
4310 -- Install private declaration of ancestor units, which are
4311 -- currently available. Restore_Scope_Stack and Install_Context
4312 -- only install the visible part of parents.
4313
4314 declare
4315 Par : Entity_Id;
4316 begin
4317 Par := Scope (Curr_Scope);
4318 while (Present (Par))
4319 and then Par /= Standard_Standard
4320 loop
4321 Install_Private_Declarations (Par);
4322 Par := Scope (Par);
4323 end loop;
4324 end;
4325 end if;
4326 end if;
4327
4328 -- Restore use clauses. For a child unit, use clauses in the parents
4329 -- are restored when installing the context, so only those in inner
4330 -- scopes (and those local to the child unit itself) need to be
4331 -- installed explicitly.
4332
4333 if Is_Child_Unit (Curr_Unit)
4334 and then Removed
4335 then
4336 for J in reverse 1 .. Num_Inner + 1 loop
4337 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4338 Use_Clauses (J);
4339 Install_Use_Clauses (Use_Clauses (J));
4340 end loop;
4341
4342 else
4343 for J in reverse 1 .. Num_Scopes loop
4344 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4345 Use_Clauses (J);
4346 Install_Use_Clauses (Use_Clauses (J));
4347 end loop;
4348 end if;
4349
4350 -- Restore status of instances. If one of them is a body, make its
4351 -- local entities visible again.
4352
4353 declare
4354 E : Entity_Id;
4355 Inst : Entity_Id;
4356
4357 begin
4358 for J in 1 .. N_Instances loop
4359 Inst := Instances (J);
4360 Set_Is_Generic_Instance (Inst, True);
4361
4362 if In_Package_Body (Inst)
4363 or else Ekind (S) = E_Procedure
4364 or else Ekind (S) = E_Function
4365 then
4366 E := First_Entity (Instances (J));
4367 while Present (E) loop
4368 Set_Is_Immediately_Visible (E);
4369 Next_Entity (E);
4370 end loop;
4371 end if;
4372 end loop;
4373 end;
4374
4375 -- If generic unit is in current unit, current context is correct
4376
4377 else
4378 Instantiate_Package_Body
4379 (Body_Info =>
4380 ((Inst_Node => N,
4381 Act_Decl => Act_Decl,
4382 Expander_Status => Expander_Active,
4383 Current_Sem_Unit => Current_Sem_Unit,
4384 Scope_Suppress => Scope_Suppress,
4385 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4386 Version => Ada_Version,
4387 Version_Pragma => Ada_Version_Pragma,
4388 Warnings => Save_Warnings,
4389 SPARK_Mode => SPARK_Mode,
4390 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
4391 Inlined_Body => True);
4392 end if;
4393 end Inline_Instance_Body;
4394
4395 -------------------------------------
4396 -- Analyze_Procedure_Instantiation --
4397 -------------------------------------
4398
4399 procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4400 begin
4401 Analyze_Subprogram_Instantiation (N, E_Procedure);
4402 end Analyze_Procedure_Instantiation;
4403
4404 -----------------------------------
4405 -- Need_Subprogram_Instance_Body --
4406 -----------------------------------
4407
4408 function Need_Subprogram_Instance_Body
4409 (N : Node_Id;
4410 Subp : Entity_Id) return Boolean
4411 is
4412 begin
4413 -- Must be inlined (or inlined renaming)
4414
4415 if (Is_In_Main_Unit (N)
4416 or else Is_Inlined (Subp)
4417 or else Is_Inlined (Alias (Subp)))
4418
4419 -- Must be generating code or analyzing code in ASIS/GNATprove mode
4420
4421 and then (Operating_Mode = Generate_Code
4422 or else (Operating_Mode = Check_Semantics
4423 and then (ASIS_Mode or GNATprove_Mode)))
4424
4425 -- The body is needed when generating code (full expansion), in ASIS
4426 -- mode for other tools, and in GNATprove mode (special expansion) for
4427 -- formal verification of the body itself.
4428
4429 and then (Expander_Active or ASIS_Mode or GNATprove_Mode)
4430
4431 -- No point in inlining if ABE is inevitable
4432
4433 and then not ABE_Is_Certain (N)
4434
4435 -- Or if subprogram is eliminated
4436
4437 and then not Is_Eliminated (Subp)
4438 then
4439 Pending_Instantiations.Append
4440 ((Inst_Node => N,
4441 Act_Decl => Unit_Declaration_Node (Subp),
4442 Expander_Status => Expander_Active,
4443 Current_Sem_Unit => Current_Sem_Unit,
4444 Scope_Suppress => Scope_Suppress,
4445 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4446 Version => Ada_Version,
4447 Version_Pragma => Ada_Version_Pragma,
4448 Warnings => Save_Warnings,
4449 SPARK_Mode => SPARK_Mode,
4450 SPARK_Mode_Pragma => SPARK_Mode_Pragma));
4451 return True;
4452
4453 -- Here if not inlined, or we ignore the inlining
4454
4455 else
4456 return False;
4457 end if;
4458 end Need_Subprogram_Instance_Body;
4459
4460 --------------------------------------
4461 -- Analyze_Subprogram_Instantiation --
4462 --------------------------------------
4463
4464 procedure Analyze_Subprogram_Instantiation
4465 (N : Node_Id;
4466 K : Entity_Kind)
4467 is
4468 Loc : constant Source_Ptr := Sloc (N);
4469 Gen_Id : constant Node_Id := Name (N);
4470
4471 Anon_Id : constant Entity_Id :=
4472 Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4473 Chars => New_External_Name
4474 (Chars (Defining_Entity (N)), 'R'));
4475
4476 Act_Decl_Id : Entity_Id;
4477 Act_Decl : Node_Id;
4478 Act_Spec : Node_Id;
4479 Act_Tree : Node_Id;
4480
4481 Env_Installed : Boolean := False;
4482 Gen_Unit : Entity_Id;
4483 Gen_Decl : Node_Id;
4484 Pack_Id : Entity_Id;
4485 Parent_Installed : Boolean := False;
4486 Renaming_List : List_Id;
4487
4488 procedure Analyze_Instance_And_Renamings;
4489 -- The instance must be analyzed in a context that includes the mappings
4490 -- of generic parameters into actuals. We create a package declaration
4491 -- for this purpose, and a subprogram with an internal name within the
4492 -- package. The subprogram instance is simply an alias for the internal
4493 -- subprogram, declared in the current scope.
4494
4495 ------------------------------------
4496 -- Analyze_Instance_And_Renamings --
4497 ------------------------------------
4498
4499 procedure Analyze_Instance_And_Renamings is
4500 Def_Ent : constant Entity_Id := Defining_Entity (N);
4501 Pack_Decl : Node_Id;
4502
4503 begin
4504 if Nkind (Parent (N)) = N_Compilation_Unit then
4505
4506 -- For the case of a compilation unit, the container package has
4507 -- the same name as the instantiation, to insure that the binder
4508 -- calls the elaboration procedure with the right name. Copy the
4509 -- entity of the instance, which may have compilation level flags
4510 -- (e.g. Is_Child_Unit) set.
4511
4512 Pack_Id := New_Copy (Def_Ent);
4513
4514 else
4515 -- Otherwise we use the name of the instantiation concatenated
4516 -- with its source position to ensure uniqueness if there are
4517 -- several instantiations with the same name.
4518
4519 Pack_Id :=
4520 Make_Defining_Identifier (Loc,
4521 Chars => New_External_Name
4522 (Related_Id => Chars (Def_Ent),
4523 Suffix => "GP",
4524 Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4525 end if;
4526
4527 Pack_Decl := Make_Package_Declaration (Loc,
4528 Specification => Make_Package_Specification (Loc,
4529 Defining_Unit_Name => Pack_Id,
4530 Visible_Declarations => Renaming_List,
4531 End_Label => Empty));
4532
4533 Set_Instance_Spec (N, Pack_Decl);
4534 Set_Is_Generic_Instance (Pack_Id);
4535 Set_Debug_Info_Needed (Pack_Id);
4536
4537 -- Case of not a compilation unit
4538
4539 if Nkind (Parent (N)) /= N_Compilation_Unit then
4540 Mark_Rewrite_Insertion (Pack_Decl);
4541 Insert_Before (N, Pack_Decl);
4542 Set_Has_Completion (Pack_Id);
4543
4544 -- Case of an instantiation that is a compilation unit
4545
4546 -- Place declaration on current node so context is complete for
4547 -- analysis (including nested instantiations), and for use in a
4548 -- context_clause (see Analyze_With_Clause).
4549
4550 else
4551 Set_Unit (Parent (N), Pack_Decl);
4552 Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4553 end if;
4554
4555 Analyze (Pack_Decl);
4556 Check_Formal_Packages (Pack_Id);
4557 Set_Is_Generic_Instance (Pack_Id, False);
4558
4559 -- Why do we clear Is_Generic_Instance??? We set it 20 lines
4560 -- above???
4561
4562 -- Body of the enclosing package is supplied when instantiating the
4563 -- subprogram body, after semantic analysis is completed.
4564
4565 if Nkind (Parent (N)) = N_Compilation_Unit then
4566
4567 -- Remove package itself from visibility, so it does not
4568 -- conflict with subprogram.
4569
4570 Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4571
4572 -- Set name and scope of internal subprogram so that the proper
4573 -- external name will be generated. The proper scope is the scope
4574 -- of the wrapper package. We need to generate debugging info for
4575 -- the internal subprogram, so set flag accordingly.
4576
4577 Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4578 Set_Scope (Anon_Id, Scope (Pack_Id));
4579
4580 -- Mark wrapper package as referenced, to avoid spurious warnings
4581 -- if the instantiation appears in various with_ clauses of
4582 -- subunits of the main unit.
4583
4584 Set_Referenced (Pack_Id);
4585 end if;
4586
4587 Set_Is_Generic_Instance (Anon_Id);
4588 Set_Debug_Info_Needed (Anon_Id);
4589 Act_Decl_Id := New_Copy (Anon_Id);
4590
4591 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4592 Set_Chars (Act_Decl_Id, Chars (Defining_Entity (N)));
4593 Set_Sloc (Act_Decl_Id, Sloc (Defining_Entity (N)));
4594 Set_Comes_From_Source (Act_Decl_Id, True);
4595
4596 -- The signature may involve types that are not frozen yet, but the
4597 -- subprogram will be frozen at the point the wrapper package is
4598 -- frozen, so it does not need its own freeze node. In fact, if one
4599 -- is created, it might conflict with the freezing actions from the
4600 -- wrapper package.
4601
4602 Set_Has_Delayed_Freeze (Anon_Id, False);
4603
4604 -- If the instance is a child unit, mark the Id accordingly. Mark
4605 -- the anonymous entity as well, which is the real subprogram and
4606 -- which is used when the instance appears in a context clause.
4607 -- Similarly, propagate the Is_Eliminated flag to handle properly
4608 -- nested eliminated subprograms.
4609
4610 Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
4611 Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
4612 New_Overloaded_Entity (Act_Decl_Id);
4613 Check_Eliminated (Act_Decl_Id);
4614 Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
4615
4616 -- In compilation unit case, kill elaboration checks on the
4617 -- instantiation, since they are never needed -- the body is
4618 -- instantiated at the same point as the spec.
4619
4620 if Nkind (Parent (N)) = N_Compilation_Unit then
4621 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4622 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4623 Set_Is_Compilation_Unit (Anon_Id);
4624
4625 Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
4626 end if;
4627
4628 -- The instance is not a freezing point for the new subprogram
4629
4630 Set_Is_Frozen (Act_Decl_Id, False);
4631
4632 if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
4633 Valid_Operator_Definition (Act_Decl_Id);
4634 end if;
4635
4636 Set_Alias (Act_Decl_Id, Anon_Id);
4637 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4638 Set_Has_Completion (Act_Decl_Id);
4639 Set_Related_Instance (Pack_Id, Act_Decl_Id);
4640
4641 if Nkind (Parent (N)) = N_Compilation_Unit then
4642 Set_Body_Required (Parent (N), False);
4643 end if;
4644 end Analyze_Instance_And_Renamings;
4645
4646 -- Local variables
4647
4648 Vis_Prims_List : Elist_Id := No_Elist;
4649 -- List of primitives made temporarily visible in the instantiation
4650 -- to match the visibility of the formal type
4651
4652 -- Start of processing for Analyze_Subprogram_Instantiation
4653
4654 begin
4655 Check_SPARK_Restriction ("generic is not allowed", N);
4656
4657 -- Very first thing: apply the special kludge for Text_IO processing
4658 -- in case we are instantiating one of the children of [Wide_]Text_IO.
4659 -- Of course such an instantiation is bogus (these are packages, not
4660 -- subprograms), but we get a better error message if we do this.
4661
4662 Text_IO_Kludge (Gen_Id);
4663
4664 -- Make node global for error reporting
4665
4666 Instantiation_Node := N;
4667
4668 -- For package instantiations we turn off style checks, because they
4669 -- will have been emitted in the generic. For subprogram instantiations
4670 -- we want to apply at least the check on overriding indicators so we
4671 -- do not modify the style check status.
4672
4673 -- The renaming declarations for the actuals do not come from source and
4674 -- will not generate spurious warnings.
4675
4676 Preanalyze_Actuals (N);
4677
4678 Init_Env;
4679 Env_Installed := True;
4680 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
4681 Gen_Unit := Entity (Gen_Id);
4682
4683 Generate_Reference (Gen_Unit, Gen_Id);
4684
4685 if Nkind (Gen_Id) = N_Identifier
4686 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
4687 then
4688 Error_Msg_NE
4689 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
4690 end if;
4691
4692 if Etype (Gen_Unit) = Any_Type then
4693 Restore_Env;
4694 return;
4695 end if;
4696
4697 -- Verify that it is a generic subprogram of the right kind, and that
4698 -- it does not lead to a circular instantiation.
4699
4700 if K = E_Procedure and then Ekind (Gen_Unit) /= E_Generic_Procedure then
4701 Error_Msg_NE
4702 ("& is not the name of a generic procedure", Gen_Id, Gen_Unit);
4703
4704 elsif K = E_Function and then Ekind (Gen_Unit) /= E_Generic_Function then
4705 Error_Msg_NE
4706 ("& is not the name of a generic function", Gen_Id, Gen_Unit);
4707
4708 elsif In_Open_Scopes (Gen_Unit) then
4709 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
4710
4711 else
4712 Set_Entity (Gen_Id, Gen_Unit);
4713 Set_Is_Instantiated (Gen_Unit);
4714
4715 if In_Extended_Main_Source_Unit (N) then
4716 Generate_Reference (Gen_Unit, N);
4717 end if;
4718
4719 -- If renaming, get original unit
4720
4721 if Present (Renamed_Object (Gen_Unit))
4722 and then (Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Procedure
4723 or else
4724 Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Function)
4725 then
4726 Gen_Unit := Renamed_Object (Gen_Unit);
4727 Set_Is_Instantiated (Gen_Unit);
4728 Generate_Reference (Gen_Unit, N);
4729 end if;
4730
4731 if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
4732 Error_Msg_Node_2 := Current_Scope;
4733 Error_Msg_NE
4734 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
4735 Circularity_Detected := True;
4736 Restore_Hidden_Primitives (Vis_Prims_List);
4737 goto Leave;
4738 end if;
4739
4740 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
4741
4742 -- Initialize renamings map, for error checking
4743
4744 Generic_Renamings.Set_Last (0);
4745 Generic_Renamings_HTable.Reset;
4746
4747 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
4748
4749 -- Copy original generic tree, to produce text for instantiation
4750
4751 Act_Tree :=
4752 Copy_Generic_Node
4753 (Original_Node (Gen_Decl), Empty, Instantiating => True);
4754
4755 -- Inherit overriding indicator from instance node
4756
4757 Act_Spec := Specification (Act_Tree);
4758 Set_Must_Override (Act_Spec, Must_Override (N));
4759 Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
4760
4761 Renaming_List :=
4762 Analyze_Associations
4763 (I_Node => N,
4764 Formals => Generic_Formal_Declarations (Act_Tree),
4765 F_Copy => Generic_Formal_Declarations (Gen_Decl));
4766
4767 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
4768
4769 -- The subprogram itself cannot contain a nested instance, so the
4770 -- current parent is left empty.
4771
4772 Set_Instance_Env (Gen_Unit, Empty);
4773
4774 -- Build the subprogram declaration, which does not appear in the
4775 -- generic template, and give it a sloc consistent with that of the
4776 -- template.
4777
4778 Set_Defining_Unit_Name (Act_Spec, Anon_Id);
4779 Set_Generic_Parent (Act_Spec, Gen_Unit);
4780 Act_Decl :=
4781 Make_Subprogram_Declaration (Sloc (Act_Spec),
4782 Specification => Act_Spec);
4783
4784 -- The aspects have been copied previously, but they have to be
4785 -- linked explicitly to the new subprogram declaration. Explicit
4786 -- pre/postconditions on the instance are analyzed below, in a
4787 -- separate step.
4788
4789 Move_Aspects (Act_Tree, To => Act_Decl);
4790 Set_Categorization_From_Pragmas (Act_Decl);
4791
4792 if Parent_Installed then
4793 Hide_Current_Scope;
4794 end if;
4795
4796 Append (Act_Decl, Renaming_List);
4797 Analyze_Instance_And_Renamings;
4798
4799 -- If the generic is marked Import (Intrinsic), then so is the
4800 -- instance. This indicates that there is no body to instantiate. If
4801 -- generic is marked inline, so it the instance, and the anonymous
4802 -- subprogram it renames. If inlined, or else if inlining is enabled
4803 -- for the compilation, we generate the instance body even if it is
4804 -- not within the main unit.
4805
4806 if Is_Intrinsic_Subprogram (Gen_Unit) then
4807 Set_Is_Intrinsic_Subprogram (Anon_Id);
4808 Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
4809
4810 if Chars (Gen_Unit) = Name_Unchecked_Conversion then
4811 Validate_Unchecked_Conversion (N, Act_Decl_Id);
4812 end if;
4813 end if;
4814
4815 -- Inherit convention from generic unit. Intrinsic convention, as for
4816 -- an instance of unchecked conversion, is not inherited because an
4817 -- explicit Ada instance has been created.
4818
4819 if Has_Convention_Pragma (Gen_Unit)
4820 and then Convention (Gen_Unit) /= Convention_Intrinsic
4821 then
4822 Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
4823 Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
4824 end if;
4825
4826 Generate_Definition (Act_Decl_Id);
4827 -- Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id)));
4828 -- ??? needed?
4829 Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
4830
4831 -- Inherit all inlining-related flags which apply to the generic in
4832 -- the subprogram and its declaration.
4833
4834 Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
4835 Set_Is_Inlined (Anon_Id, Is_Inlined (Gen_Unit));
4836
4837 Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
4838 Set_Has_Pragma_Inline (Anon_Id, Has_Pragma_Inline (Gen_Unit));
4839
4840 Set_Has_Pragma_Inline_Always
4841 (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
4842 Set_Has_Pragma_Inline_Always
4843 (Anon_Id, Has_Pragma_Inline_Always (Gen_Unit));
4844
4845 if not Is_Intrinsic_Subprogram (Gen_Unit) then
4846 Check_Elab_Instantiation (N);
4847 end if;
4848
4849 if Is_Dispatching_Operation (Act_Decl_Id)
4850 and then Ada_Version >= Ada_2005
4851 then
4852 declare
4853 Formal : Entity_Id;
4854
4855 begin
4856 Formal := First_Formal (Act_Decl_Id);
4857 while Present (Formal) loop
4858 if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
4859 and then Is_Controlling_Formal (Formal)
4860 and then not Can_Never_Be_Null (Formal)
4861 then
4862 Error_Msg_NE ("access parameter& is controlling,",
4863 N, Formal);
4864 Error_Msg_NE
4865 ("\corresponding parameter of & must be"
4866 & " explicitly null-excluding", N, Gen_Id);
4867 end if;
4868
4869 Next_Formal (Formal);
4870 end loop;
4871 end;
4872 end if;
4873
4874 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4875
4876 Validate_Categorization_Dependency (N, Act_Decl_Id);
4877
4878 if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
4879 Inherit_Context (Gen_Decl, N);
4880
4881 Restore_Private_Views (Pack_Id, False);
4882
4883 -- If the context requires a full instantiation, mark node for
4884 -- subsequent construction of the body.
4885
4886 if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
4887 Check_Forward_Instantiation (Gen_Decl);
4888
4889 -- The wrapper package is always delayed, because it does not
4890 -- constitute a freeze point, but to insure that the freeze
4891 -- node is placed properly, it is created directly when
4892 -- instantiating the body (otherwise the freeze node might
4893 -- appear to early for nested instantiations).
4894
4895 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4896
4897 -- For ASIS purposes, indicate that the wrapper package has
4898 -- replaced the instantiation node.
4899
4900 Rewrite (N, Unit (Parent (N)));
4901 Set_Unit (Parent (N), N);
4902 end if;
4903
4904 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4905
4906 -- Replace instance node for library-level instantiations of
4907 -- intrinsic subprograms, for ASIS use.
4908
4909 Rewrite (N, Unit (Parent (N)));
4910 Set_Unit (Parent (N), N);
4911 end if;
4912
4913 if Parent_Installed then
4914 Remove_Parent;
4915 end if;
4916
4917 Restore_Hidden_Primitives (Vis_Prims_List);
4918 Restore_Env;
4919 Env_Installed := False;
4920 Generic_Renamings.Set_Last (0);
4921 Generic_Renamings_HTable.Reset;
4922 end if;
4923
4924 <<Leave>>
4925 if Has_Aspects (N) then
4926 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4927 end if;
4928
4929 exception
4930 when Instantiation_Error =>
4931 if Parent_Installed then
4932 Remove_Parent;
4933 end if;
4934
4935 if Env_Installed then
4936 Restore_Env;
4937 end if;
4938 end Analyze_Subprogram_Instantiation;
4939
4940 -------------------------
4941 -- Get_Associated_Node --
4942 -------------------------
4943
4944 function Get_Associated_Node (N : Node_Id) return Node_Id is
4945 Assoc : Node_Id;
4946
4947 begin
4948 Assoc := Associated_Node (N);
4949
4950 if Nkind (Assoc) /= Nkind (N) then
4951 return Assoc;
4952
4953 elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
4954 return Assoc;
4955
4956 else
4957 -- If the node is part of an inner generic, it may itself have been
4958 -- remapped into a further generic copy. Associated_Node is otherwise
4959 -- used for the entity of the node, and will be of a different node
4960 -- kind, or else N has been rewritten as a literal or function call.
4961
4962 while Present (Associated_Node (Assoc))
4963 and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
4964 loop
4965 Assoc := Associated_Node (Assoc);
4966 end loop;
4967
4968 -- Follow and additional link in case the final node was rewritten.
4969 -- This can only happen with nested generic units.
4970
4971 if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
4972 and then Present (Associated_Node (Assoc))
4973 and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
4974 N_Explicit_Dereference,
4975 N_Integer_Literal,
4976 N_Real_Literal,
4977 N_String_Literal))
4978 then
4979 Assoc := Associated_Node (Assoc);
4980 end if;
4981
4982 -- An additional special case: an unconstrained type in an object
4983 -- declaration may have been rewritten as a local subtype constrained
4984 -- by the expression in the declaration. We need to recover the
4985 -- original entity which may be global.
4986
4987 if Present (Original_Node (Assoc))
4988 and then Nkind (Parent (N)) = N_Object_Declaration
4989 then
4990 Assoc := Original_Node (Assoc);
4991 end if;
4992
4993 return Assoc;
4994 end if;
4995 end Get_Associated_Node;
4996
4997 -------------------------------------------
4998 -- Build_Instance_Compilation_Unit_Nodes --
4999 -------------------------------------------
5000
5001 procedure Build_Instance_Compilation_Unit_Nodes
5002 (N : Node_Id;
5003 Act_Body : Node_Id;
5004 Act_Decl : Node_Id)
5005 is
5006 Decl_Cunit : Node_Id;
5007 Body_Cunit : Node_Id;
5008 Citem : Node_Id;
5009 New_Main : constant Entity_Id := Defining_Entity (Act_Decl);
5010 Old_Main : constant Entity_Id := Cunit_Entity (Main_Unit);
5011
5012 begin
5013 -- A new compilation unit node is built for the instance declaration
5014
5015 Decl_Cunit :=
5016 Make_Compilation_Unit (Sloc (N),
5017 Context_Items => Empty_List,
5018 Unit => Act_Decl,
5019 Aux_Decls_Node => Make_Compilation_Unit_Aux (Sloc (N)));
5020
5021 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
5022
5023 -- The new compilation unit is linked to its body, but both share the
5024 -- same file, so we do not set Body_Required on the new unit so as not
5025 -- to create a spurious dependency on a non-existent body in the ali.
5026 -- This simplifies CodePeer unit traversal.
5027
5028 -- We use the original instantiation compilation unit as the resulting
5029 -- compilation unit of the instance, since this is the main unit.
5030
5031 Rewrite (N, Act_Body);
5032
5033 -- Propagate the aspect specifications from the package body template to
5034 -- the instantiated version of the package body.
5035
5036 if Has_Aspects (Act_Body) then
5037 Set_Aspect_Specifications
5038 (N, New_Copy_List_Tree (Aspect_Specifications (Act_Body)));
5039 end if;
5040
5041 Body_Cunit := Parent (N);
5042
5043 -- The two compilation unit nodes are linked by the Library_Unit field
5044
5045 Set_Library_Unit (Decl_Cunit, Body_Cunit);
5046 Set_Library_Unit (Body_Cunit, Decl_Cunit);
5047
5048 -- Preserve the private nature of the package if needed
5049
5050 Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
5051
5052 -- If the instance is not the main unit, its context, categorization
5053 -- and elaboration entity are not relevant to the compilation.
5054
5055 if Body_Cunit /= Cunit (Main_Unit) then
5056 Make_Instance_Unit (Body_Cunit, In_Main => False);
5057 return;
5058 end if;
5059
5060 -- The context clause items on the instantiation, which are now attached
5061 -- to the body compilation unit (since the body overwrote the original
5062 -- instantiation node), semantically belong on the spec, so copy them
5063 -- there. It's harmless to leave them on the body as well. In fact one
5064 -- could argue that they belong in both places.
5065
5066 Citem := First (Context_Items (Body_Cunit));
5067 while Present (Citem) loop
5068 Append (New_Copy (Citem), Context_Items (Decl_Cunit));
5069 Next (Citem);
5070 end loop;
5071
5072 -- Propagate categorization flags on packages, so that they appear in
5073 -- the ali file for the spec of the unit.
5074
5075 if Ekind (New_Main) = E_Package then
5076 Set_Is_Pure (Old_Main, Is_Pure (New_Main));
5077 Set_Is_Preelaborated (Old_Main, Is_Preelaborated (New_Main));
5078 Set_Is_Remote_Types (Old_Main, Is_Remote_Types (New_Main));
5079 Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
5080 Set_Is_Remote_Call_Interface
5081 (Old_Main, Is_Remote_Call_Interface (New_Main));
5082 end if;
5083
5084 -- Make entry in Units table, so that binder can generate call to
5085 -- elaboration procedure for body, if any.
5086
5087 Make_Instance_Unit (Body_Cunit, In_Main => True);
5088 Main_Unit_Entity := New_Main;
5089 Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
5090
5091 -- Build elaboration entity, since the instance may certainly generate
5092 -- elaboration code requiring a flag for protection.
5093
5094 Build_Elaboration_Entity (Decl_Cunit, New_Main);
5095 end Build_Instance_Compilation_Unit_Nodes;
5096
5097 -----------------------------
5098 -- Check_Access_Definition --
5099 -----------------------------
5100
5101 procedure Check_Access_Definition (N : Node_Id) is
5102 begin
5103 pragma Assert
5104 (Ada_Version >= Ada_2005 and then Present (Access_Definition (N)));
5105 null;
5106 end Check_Access_Definition;
5107
5108 -----------------------------------
5109 -- Check_Formal_Package_Instance --
5110 -----------------------------------
5111
5112 -- If the formal has specific parameters, they must match those of the
5113 -- actual. Both of them are instances, and the renaming declarations for
5114 -- their formal parameters appear in the same order in both. The analyzed
5115 -- formal has been analyzed in the context of the current instance.
5116
5117 procedure Check_Formal_Package_Instance
5118 (Formal_Pack : Entity_Id;
5119 Actual_Pack : Entity_Id)
5120 is
5121 E1 : Entity_Id := First_Entity (Actual_Pack);
5122 E2 : Entity_Id := First_Entity (Formal_Pack);
5123
5124 Expr1 : Node_Id;
5125 Expr2 : Node_Id;
5126
5127 procedure Check_Mismatch (B : Boolean);
5128 -- Common error routine for mismatch between the parameters of the
5129 -- actual instance and those of the formal package.
5130
5131 function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
5132 -- The formal may come from a nested formal package, and the actual may
5133 -- have been constant-folded. To determine whether the two denote the
5134 -- same entity we may have to traverse several definitions to recover
5135 -- the ultimate entity that they refer to.
5136
5137 function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
5138 -- Similarly, if the formal comes from a nested formal package, the
5139 -- actual may designate the formal through multiple renamings, which
5140 -- have to be followed to determine the original variable in question.
5141
5142 --------------------
5143 -- Check_Mismatch --
5144 --------------------
5145
5146 procedure Check_Mismatch (B : Boolean) is
5147 Kind : constant Node_Kind := Nkind (Parent (E2));
5148
5149 begin
5150 if Kind = N_Formal_Type_Declaration then
5151 return;
5152
5153 elsif Nkind_In (Kind, N_Formal_Object_Declaration,
5154 N_Formal_Package_Declaration)
5155 or else Kind in N_Formal_Subprogram_Declaration
5156 then
5157 null;
5158
5159 elsif B then
5160 Error_Msg_NE
5161 ("actual for & in actual instance does not match formal",
5162 Parent (Actual_Pack), E1);
5163 end if;
5164 end Check_Mismatch;
5165
5166 --------------------------------
5167 -- Same_Instantiated_Constant --
5168 --------------------------------
5169
5170 function Same_Instantiated_Constant
5171 (E1, E2 : Entity_Id) return Boolean
5172 is
5173 Ent : Entity_Id;
5174
5175 begin
5176 Ent := E2;
5177 while Present (Ent) loop
5178 if E1 = Ent then
5179 return True;
5180
5181 elsif Ekind (Ent) /= E_Constant then
5182 return False;
5183
5184 elsif Is_Entity_Name (Constant_Value (Ent)) then
5185 if Entity (Constant_Value (Ent)) = E1 then
5186 return True;
5187 else
5188 Ent := Entity (Constant_Value (Ent));
5189 end if;
5190
5191 -- The actual may be a constant that has been folded. Recover
5192 -- original name.
5193
5194 elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5195 Ent := Entity (Original_Node (Constant_Value (Ent)));
5196 else
5197 return False;
5198 end if;
5199 end loop;
5200
5201 return False;
5202 end Same_Instantiated_Constant;
5203
5204 --------------------------------
5205 -- Same_Instantiated_Variable --
5206 --------------------------------
5207
5208 function Same_Instantiated_Variable
5209 (E1, E2 : Entity_Id) return Boolean
5210 is
5211 function Original_Entity (E : Entity_Id) return Entity_Id;
5212 -- Follow chain of renamings to the ultimate ancestor
5213
5214 ---------------------
5215 -- Original_Entity --
5216 ---------------------
5217
5218 function Original_Entity (E : Entity_Id) return Entity_Id is
5219 Orig : Entity_Id;
5220
5221 begin
5222 Orig := E;
5223 while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5224 and then Present (Renamed_Object (Orig))
5225 and then Is_Entity_Name (Renamed_Object (Orig))
5226 loop
5227 Orig := Entity (Renamed_Object (Orig));
5228 end loop;
5229
5230 return Orig;
5231 end Original_Entity;
5232
5233 -- Start of processing for Same_Instantiated_Variable
5234
5235 begin
5236 return Ekind (E1) = Ekind (E2)
5237 and then Original_Entity (E1) = Original_Entity (E2);
5238 end Same_Instantiated_Variable;
5239
5240 -- Start of processing for Check_Formal_Package_Instance
5241
5242 begin
5243 while Present (E1)
5244 and then Present (E2)
5245 loop
5246 exit when Ekind (E1) = E_Package
5247 and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5248
5249 -- If the formal is the renaming of the formal package, this
5250 -- is the end of its formal part, which may occur before the
5251 -- end of the formal part in the actual in the presence of
5252 -- defaulted parameters in the formal package.
5253
5254 exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5255 and then Renamed_Entity (E2) = Scope (E2);
5256
5257 -- The analysis of the actual may generate additional internal
5258 -- entities. If the formal is defaulted, there is no corresponding
5259 -- analysis and the internal entities must be skipped, until we
5260 -- find corresponding entities again.
5261
5262 if Comes_From_Source (E2)
5263 and then not Comes_From_Source (E1)
5264 and then Chars (E1) /= Chars (E2)
5265 then
5266 while Present (E1)
5267 and then Chars (E1) /= Chars (E2)
5268 loop
5269 Next_Entity (E1);
5270 end loop;
5271 end if;
5272
5273 if No (E1) then
5274 return;
5275
5276 -- If the formal entity comes from a formal declaration, it was
5277 -- defaulted in the formal package, and no check is needed on it.
5278
5279 elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
5280 goto Next_E;
5281
5282 -- Ditto for defaulted formal subprograms.
5283
5284 elsif Is_Overloadable (E1)
5285 and then Nkind (Unit_Declaration_Node (E2)) in
5286 N_Formal_Subprogram_Declaration
5287 then
5288 goto Next_E;
5289
5290 elsif Is_Type (E1) then
5291
5292 -- Subtypes must statically match. E1, E2 are the local entities
5293 -- that are subtypes of the actuals. Itypes generated for other
5294 -- parameters need not be checked, the check will be performed
5295 -- on the parameters themselves.
5296
5297 -- If E2 is a formal type declaration, it is a defaulted parameter
5298 -- and needs no checking.
5299
5300 if not Is_Itype (E1)
5301 and then not Is_Itype (E2)
5302 then
5303 Check_Mismatch
5304 (not Is_Type (E2)
5305 or else Etype (E1) /= Etype (E2)
5306 or else not Subtypes_Statically_Match (E1, E2));
5307 end if;
5308
5309 elsif Ekind (E1) = E_Constant then
5310
5311 -- IN parameters must denote the same static value, or the same
5312 -- constant, or the literal null.
5313
5314 Expr1 := Expression (Parent (E1));
5315
5316 if Ekind (E2) /= E_Constant then
5317 Check_Mismatch (True);
5318 goto Next_E;
5319 else
5320 Expr2 := Expression (Parent (E2));
5321 end if;
5322
5323 if Is_Static_Expression (Expr1) then
5324
5325 if not Is_Static_Expression (Expr2) then
5326 Check_Mismatch (True);
5327
5328 elsif Is_Discrete_Type (Etype (E1)) then
5329 declare
5330 V1 : constant Uint := Expr_Value (Expr1);
5331 V2 : constant Uint := Expr_Value (Expr2);
5332 begin
5333 Check_Mismatch (V1 /= V2);
5334 end;
5335
5336 elsif Is_Real_Type (Etype (E1)) then
5337 declare
5338 V1 : constant Ureal := Expr_Value_R (Expr1);
5339 V2 : constant Ureal := Expr_Value_R (Expr2);
5340 begin
5341 Check_Mismatch (V1 /= V2);
5342 end;
5343
5344 elsif Is_String_Type (Etype (E1))
5345 and then Nkind (Expr1) = N_String_Literal
5346 then
5347 if Nkind (Expr2) /= N_String_Literal then
5348 Check_Mismatch (True);
5349 else
5350 Check_Mismatch
5351 (not String_Equal (Strval (Expr1), Strval (Expr2)));
5352 end if;
5353 end if;
5354
5355 elsif Is_Entity_Name (Expr1) then
5356 if Is_Entity_Name (Expr2) then
5357 if Entity (Expr1) = Entity (Expr2) then
5358 null;
5359 else
5360 Check_Mismatch
5361 (not Same_Instantiated_Constant
5362 (Entity (Expr1), Entity (Expr2)));
5363 end if;
5364 else
5365 Check_Mismatch (True);
5366 end if;
5367
5368 elsif Is_Entity_Name (Original_Node (Expr1))
5369 and then Is_Entity_Name (Expr2)
5370 and then
5371 Same_Instantiated_Constant
5372 (Entity (Original_Node (Expr1)), Entity (Expr2))
5373 then
5374 null;
5375
5376 elsif Nkind (Expr1) = N_Null then
5377 Check_Mismatch (Nkind (Expr1) /= N_Null);
5378
5379 else
5380 Check_Mismatch (True);
5381 end if;
5382
5383 elsif Ekind (E1) = E_Variable then
5384 Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5385
5386 elsif Ekind (E1) = E_Package then
5387 Check_Mismatch
5388 (Ekind (E1) /= Ekind (E2)
5389 or else Renamed_Object (E1) /= Renamed_Object (E2));
5390
5391 elsif Is_Overloadable (E1) then
5392
5393 -- Verify that the actual subprograms match. Note that actuals
5394 -- that are attributes are rewritten as subprograms. If the
5395 -- subprogram in the formal package is defaulted, no check is
5396 -- needed. Note that this can only happen in Ada 2005 when the
5397 -- formal package can be partially parameterized.
5398
5399 if Nkind (Unit_Declaration_Node (E1)) =
5400 N_Subprogram_Renaming_Declaration
5401 and then From_Default (Unit_Declaration_Node (E1))
5402 then
5403 null;
5404
5405 -- If the formal package has an "others" box association that
5406 -- covers this formal, there is no need for a check either.
5407
5408 elsif Nkind (Unit_Declaration_Node (E2)) in
5409 N_Formal_Subprogram_Declaration
5410 and then Box_Present (Unit_Declaration_Node (E2))
5411 then
5412 null;
5413
5414 -- No check needed if subprogram is a defaulted null procedure
5415
5416 elsif No (Alias (E2))
5417 and then Ekind (E2) = E_Procedure
5418 and then
5419 Null_Present (Specification (Unit_Declaration_Node (E2)))
5420 then
5421 null;
5422
5423 -- Otherwise the actual in the formal and the actual in the
5424 -- instantiation of the formal must match, up to renamings.
5425
5426 else
5427 Check_Mismatch
5428 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5429 end if;
5430
5431 else
5432 raise Program_Error;
5433 end if;
5434
5435 <<Next_E>>
5436 Next_Entity (E1);
5437 Next_Entity (E2);
5438 end loop;
5439 end Check_Formal_Package_Instance;
5440
5441 ---------------------------
5442 -- Check_Formal_Packages --
5443 ---------------------------
5444
5445 procedure Check_Formal_Packages (P_Id : Entity_Id) is
5446 E : Entity_Id;
5447 Formal_P : Entity_Id;
5448
5449 begin
5450 -- Iterate through the declarations in the instance, looking for package
5451 -- renaming declarations that denote instances of formal packages. Stop
5452 -- when we find the renaming of the current package itself. The
5453 -- declaration for a formal package without a box is followed by an
5454 -- internal entity that repeats the instantiation.
5455
5456 E := First_Entity (P_Id);
5457 while Present (E) loop
5458 if Ekind (E) = E_Package then
5459 if Renamed_Object (E) = P_Id then
5460 exit;
5461
5462 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5463 null;
5464
5465 elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5466 Formal_P := Next_Entity (E);
5467 Check_Formal_Package_Instance (Formal_P, E);
5468
5469 -- After checking, remove the internal validating package. It
5470 -- is only needed for semantic checks, and as it may contain
5471 -- generic formal declarations it should not reach gigi.
5472
5473 Remove (Unit_Declaration_Node (Formal_P));
5474 end if;
5475 end if;
5476
5477 Next_Entity (E);
5478 end loop;
5479 end Check_Formal_Packages;
5480
5481 ---------------------------------
5482 -- Check_Forward_Instantiation --
5483 ---------------------------------
5484
5485 procedure Check_Forward_Instantiation (Decl : Node_Id) is
5486 S : Entity_Id;
5487 Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5488
5489 begin
5490 -- The instantiation appears before the generic body if we are in the
5491 -- scope of the unit containing the generic, either in its spec or in
5492 -- the package body, and before the generic body.
5493
5494 if Ekind (Gen_Comp) = E_Package_Body then
5495 Gen_Comp := Spec_Entity (Gen_Comp);
5496 end if;
5497
5498 if In_Open_Scopes (Gen_Comp)
5499 and then No (Corresponding_Body (Decl))
5500 then
5501 S := Current_Scope;
5502
5503 while Present (S)
5504 and then not Is_Compilation_Unit (S)
5505 and then not Is_Child_Unit (S)
5506 loop
5507 if Ekind (S) = E_Package then
5508 Set_Has_Forward_Instantiation (S);
5509 end if;
5510
5511 S := Scope (S);
5512 end loop;
5513 end if;
5514 end Check_Forward_Instantiation;
5515
5516 ---------------------------
5517 -- Check_Generic_Actuals --
5518 ---------------------------
5519
5520 -- The visibility of the actuals may be different between the point of
5521 -- generic instantiation and the instantiation of the body.
5522
5523 procedure Check_Generic_Actuals
5524 (Instance : Entity_Id;
5525 Is_Formal_Box : Boolean)
5526 is
5527 E : Entity_Id;
5528 Astype : Entity_Id;
5529
5530 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5531 -- For a formal that is an array type, the component type is often a
5532 -- previous formal in the same unit. The privacy status of the component
5533 -- type will have been examined earlier in the traversal of the
5534 -- corresponding actuals, and this status should not be modified for
5535 -- the array (sub)type itself. However, if the base type of the array
5536 -- (sub)type is private, its full view must be restored in the body to
5537 -- be consistent with subsequent index subtypes, etc.
5538 --
5539 -- To detect this case we have to rescan the list of formals, which is
5540 -- usually short enough to ignore the resulting inefficiency.
5541
5542 -----------------------------
5543 -- Denotes_Previous_Actual --
5544 -----------------------------
5545
5546 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5547 Prev : Entity_Id;
5548
5549 begin
5550 Prev := First_Entity (Instance);
5551 while Present (Prev) loop
5552 if Is_Type (Prev)
5553 and then Nkind (Parent (Prev)) = N_Subtype_Declaration
5554 and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
5555 and then Entity (Subtype_Indication (Parent (Prev))) = Typ
5556 then
5557 return True;
5558
5559 elsif Prev = E then
5560 return False;
5561
5562 else
5563 Next_Entity (Prev);
5564 end if;
5565 end loop;
5566
5567 return False;
5568 end Denotes_Previous_Actual;
5569
5570 -- Start of processing for Check_Generic_Actuals
5571
5572 begin
5573 E := First_Entity (Instance);
5574 while Present (E) loop
5575 if Is_Type (E)
5576 and then Nkind (Parent (E)) = N_Subtype_Declaration
5577 and then Scope (Etype (E)) /= Instance
5578 and then Is_Entity_Name (Subtype_Indication (Parent (E)))
5579 then
5580 if Is_Array_Type (E)
5581 and then not Is_Private_Type (Etype (E))
5582 and then Denotes_Previous_Actual (Component_Type (E))
5583 then
5584 null;
5585 else
5586 Check_Private_View (Subtype_Indication (Parent (E)));
5587 end if;
5588
5589 Set_Is_Generic_Actual_Type (E, True);
5590 Set_Is_Hidden (E, False);
5591 Set_Is_Potentially_Use_Visible (E,
5592 In_Use (Instance));
5593
5594 -- We constructed the generic actual type as a subtype of the
5595 -- supplied type. This means that it normally would not inherit
5596 -- subtype specific attributes of the actual, which is wrong for
5597 -- the generic case.
5598
5599 Astype := Ancestor_Subtype (E);
5600
5601 if No (Astype) then
5602
5603 -- This can happen when E is an itype that is the full view of
5604 -- a private type completed, e.g. with a constrained array. In
5605 -- that case, use the first subtype, which will carry size
5606 -- information. The base type itself is unconstrained and will
5607 -- not carry it.
5608
5609 Astype := First_Subtype (E);
5610 end if;
5611
5612 Set_Size_Info (E, (Astype));
5613 Set_RM_Size (E, RM_Size (Astype));
5614 Set_First_Rep_Item (E, First_Rep_Item (Astype));
5615
5616 if Is_Discrete_Or_Fixed_Point_Type (E) then
5617 Set_RM_Size (E, RM_Size (Astype));
5618
5619 -- In nested instances, the base type of an access actual may
5620 -- itself be private, and need to be exchanged.
5621
5622 elsif Is_Access_Type (E)
5623 and then Is_Private_Type (Etype (E))
5624 then
5625 Check_Private_View
5626 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
5627 end if;
5628
5629 elsif Ekind (E) = E_Package then
5630
5631 -- If this is the renaming for the current instance, we're done.
5632 -- Otherwise it is a formal package. If the corresponding formal
5633 -- was declared with a box, the (instantiations of the) generic
5634 -- formal part are also visible. Otherwise, ignore the entity
5635 -- created to validate the actuals.
5636
5637 if Renamed_Object (E) = Instance then
5638 exit;
5639
5640 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5641 null;
5642
5643 -- The visibility of a formal of an enclosing generic is already
5644 -- correct.
5645
5646 elsif Denotes_Formal_Package (E) then
5647 null;
5648
5649 elsif Present (Associated_Formal_Package (E))
5650 and then not Is_Generic_Formal (E)
5651 then
5652 if Box_Present (Parent (Associated_Formal_Package (E))) then
5653 Check_Generic_Actuals (Renamed_Object (E), True);
5654
5655 else
5656 Check_Generic_Actuals (Renamed_Object (E), False);
5657 end if;
5658
5659 Set_Is_Hidden (E, False);
5660 end if;
5661
5662 -- If this is a subprogram instance (in a wrapper package) the
5663 -- actual is fully visible.
5664
5665 elsif Is_Wrapper_Package (Instance) then
5666 Set_Is_Hidden (E, False);
5667
5668 -- If the formal package is declared with a box, or if the formal
5669 -- parameter is defaulted, it is visible in the body.
5670
5671 elsif Is_Formal_Box
5672 or else Is_Visible_Formal (E)
5673 then
5674 Set_Is_Hidden (E, False);
5675 end if;
5676
5677 if Ekind (E) = E_Constant then
5678
5679 -- If the type of the actual is a private type declared in the
5680 -- enclosing scope of the generic unit, the body of the generic
5681 -- sees the full view of the type (because it has to appear in
5682 -- the corresponding package body). If the type is private now,
5683 -- exchange views to restore the proper visiblity in the instance.
5684
5685 declare
5686 Typ : constant Entity_Id := Base_Type (Etype (E));
5687 -- The type of the actual
5688
5689 Gen_Id : Entity_Id;
5690 -- The generic unit
5691
5692 Parent_Scope : Entity_Id;
5693 -- The enclosing scope of the generic unit
5694
5695 begin
5696 if Is_Wrapper_Package (Instance) then
5697 Gen_Id :=
5698 Generic_Parent
5699 (Specification
5700 (Unit_Declaration_Node
5701 (Related_Instance (Instance))));
5702 else
5703 Gen_Id :=
5704 Generic_Parent (Package_Specification (Instance));
5705 end if;
5706
5707 Parent_Scope := Scope (Gen_Id);
5708
5709 -- The exchange is only needed if the generic is defined
5710 -- within a package which is not a common ancestor of the
5711 -- scope of the instance, and is not already in scope.
5712
5713 if Is_Private_Type (Typ)
5714 and then Scope (Typ) = Parent_Scope
5715 and then Scope (Instance) /= Parent_Scope
5716 and then Ekind (Parent_Scope) = E_Package
5717 and then not Is_Child_Unit (Gen_Id)
5718 then
5719 Switch_View (Typ);
5720
5721 -- If the type of the entity is a subtype, it may also have
5722 -- to be made visible, together with the base type of its
5723 -- full view, after exchange.
5724
5725 if Is_Private_Type (Etype (E)) then
5726 Switch_View (Etype (E));
5727 Switch_View (Base_Type (Etype (E)));
5728 end if;
5729 end if;
5730 end;
5731 end if;
5732
5733 Next_Entity (E);
5734 end loop;
5735 end Check_Generic_Actuals;
5736
5737 ------------------------------
5738 -- Check_Generic_Child_Unit --
5739 ------------------------------
5740
5741 procedure Check_Generic_Child_Unit
5742 (Gen_Id : Node_Id;
5743 Parent_Installed : in out Boolean)
5744 is
5745 Loc : constant Source_Ptr := Sloc (Gen_Id);
5746 Gen_Par : Entity_Id := Empty;
5747 E : Entity_Id;
5748 Inst_Par : Entity_Id;
5749 S : Node_Id;
5750
5751 function Find_Generic_Child
5752 (Scop : Entity_Id;
5753 Id : Node_Id) return Entity_Id;
5754 -- Search generic parent for possible child unit with the given name
5755
5756 function In_Enclosing_Instance return Boolean;
5757 -- Within an instance of the parent, the child unit may be denoted by
5758 -- a simple name, or an abbreviated expanded name. Examine enclosing
5759 -- scopes to locate a possible parent instantiation.
5760
5761 ------------------------
5762 -- Find_Generic_Child --
5763 ------------------------
5764
5765 function Find_Generic_Child
5766 (Scop : Entity_Id;
5767 Id : Node_Id) return Entity_Id
5768 is
5769 E : Entity_Id;
5770
5771 begin
5772 -- If entity of name is already set, instance has already been
5773 -- resolved, e.g. in an enclosing instantiation.
5774
5775 if Present (Entity (Id)) then
5776 if Scope (Entity (Id)) = Scop then
5777 return Entity (Id);
5778 else
5779 return Empty;
5780 end if;
5781
5782 else
5783 E := First_Entity (Scop);
5784 while Present (E) loop
5785 if Chars (E) = Chars (Id)
5786 and then Is_Child_Unit (E)
5787 then
5788 if Is_Child_Unit (E)
5789 and then not Is_Visible_Lib_Unit (E)
5790 then
5791 Error_Msg_NE
5792 ("generic child unit& is not visible", Gen_Id, E);
5793 end if;
5794
5795 Set_Entity (Id, E);
5796 return E;
5797 end if;
5798
5799 Next_Entity (E);
5800 end loop;
5801
5802 return Empty;
5803 end if;
5804 end Find_Generic_Child;
5805
5806 ---------------------------
5807 -- In_Enclosing_Instance --
5808 ---------------------------
5809
5810 function In_Enclosing_Instance return Boolean is
5811 Enclosing_Instance : Node_Id;
5812 Instance_Decl : Node_Id;
5813
5814 begin
5815 -- We do not inline any call that contains instantiations, except
5816 -- for instantiations of Unchecked_Conversion, so if we are within
5817 -- an inlined body the current instance does not require parents.
5818
5819 if In_Inlined_Body then
5820 pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
5821 return False;
5822 end if;
5823
5824 -- Loop to check enclosing scopes
5825
5826 Enclosing_Instance := Current_Scope;
5827 while Present (Enclosing_Instance) loop
5828 Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
5829
5830 if Ekind (Enclosing_Instance) = E_Package
5831 and then Is_Generic_Instance (Enclosing_Instance)
5832 and then Present
5833 (Generic_Parent (Specification (Instance_Decl)))
5834 then
5835 -- Check whether the generic we are looking for is a child of
5836 -- this instance.
5837
5838 E := Find_Generic_Child
5839 (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
5840 exit when Present (E);
5841
5842 else
5843 E := Empty;
5844 end if;
5845
5846 Enclosing_Instance := Scope (Enclosing_Instance);
5847 end loop;
5848
5849 if No (E) then
5850
5851 -- Not a child unit
5852
5853 Analyze (Gen_Id);
5854 return False;
5855
5856 else
5857 Rewrite (Gen_Id,
5858 Make_Expanded_Name (Loc,
5859 Chars => Chars (E),
5860 Prefix => New_Occurrence_Of (Enclosing_Instance, Loc),
5861 Selector_Name => New_Occurrence_Of (E, Loc)));
5862
5863 Set_Entity (Gen_Id, E);
5864 Set_Etype (Gen_Id, Etype (E));
5865 Parent_Installed := False; -- Already in scope.
5866 return True;
5867 end if;
5868 end In_Enclosing_Instance;
5869
5870 -- Start of processing for Check_Generic_Child_Unit
5871
5872 begin
5873 -- If the name of the generic is given by a selected component, it may
5874 -- be the name of a generic child unit, and the prefix is the name of an
5875 -- instance of the parent, in which case the child unit must be visible.
5876 -- If this instance is not in scope, it must be placed there and removed
5877 -- after instantiation, because what is being instantiated is not the
5878 -- original child, but the corresponding child present in the instance
5879 -- of the parent.
5880
5881 -- If the child is instantiated within the parent, it can be given by
5882 -- a simple name. In this case the instance is already in scope, but
5883 -- the child generic must be recovered from the generic parent as well.
5884
5885 if Nkind (Gen_Id) = N_Selected_Component then
5886 S := Selector_Name (Gen_Id);
5887 Analyze (Prefix (Gen_Id));
5888 Inst_Par := Entity (Prefix (Gen_Id));
5889
5890 if Ekind (Inst_Par) = E_Package
5891 and then Present (Renamed_Object (Inst_Par))
5892 then
5893 Inst_Par := Renamed_Object (Inst_Par);
5894 end if;
5895
5896 if Ekind (Inst_Par) = E_Package then
5897 if Nkind (Parent (Inst_Par)) = N_Package_Specification then
5898 Gen_Par := Generic_Parent (Parent (Inst_Par));
5899
5900 elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
5901 and then
5902 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
5903 then
5904 Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
5905 end if;
5906
5907 elsif Ekind (Inst_Par) = E_Generic_Package
5908 and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
5909 then
5910 -- A formal package may be a real child package, and not the
5911 -- implicit instance within a parent. In this case the child is
5912 -- not visible and has to be retrieved explicitly as well.
5913
5914 Gen_Par := Inst_Par;
5915 end if;
5916
5917 if Present (Gen_Par) then
5918
5919 -- The prefix denotes an instantiation. The entity itself may be a
5920 -- nested generic, or a child unit.
5921
5922 E := Find_Generic_Child (Gen_Par, S);
5923
5924 if Present (E) then
5925 Change_Selected_Component_To_Expanded_Name (Gen_Id);
5926 Set_Entity (Gen_Id, E);
5927 Set_Etype (Gen_Id, Etype (E));
5928 Set_Entity (S, E);
5929 Set_Etype (S, Etype (E));
5930
5931 -- Indicate that this is a reference to the parent
5932
5933 if In_Extended_Main_Source_Unit (Gen_Id) then
5934 Set_Is_Instantiated (Inst_Par);
5935 end if;
5936
5937 -- A common mistake is to replicate the naming scheme of a
5938 -- hierarchy by instantiating a generic child directly, rather
5939 -- than the implicit child in a parent instance:
5940
5941 -- generic .. package Gpar is ..
5942 -- generic .. package Gpar.Child is ..
5943 -- package Par is new Gpar ();
5944
5945 -- with Gpar.Child;
5946 -- package Par.Child is new Gpar.Child ();
5947 -- rather than Par.Child
5948
5949 -- In this case the instantiation is within Par, which is an
5950 -- instance, but Gpar does not denote Par because we are not IN
5951 -- the instance of Gpar, so this is illegal. The test below
5952 -- recognizes this particular case.
5953
5954 if Is_Child_Unit (E)
5955 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
5956 and then (not In_Instance
5957 or else Nkind (Parent (Parent (Gen_Id))) =
5958 N_Compilation_Unit)
5959 then
5960 Error_Msg_N
5961 ("prefix of generic child unit must be instance of parent",
5962 Gen_Id);
5963 end if;
5964
5965 if not In_Open_Scopes (Inst_Par)
5966 and then Nkind (Parent (Gen_Id)) not in
5967 N_Generic_Renaming_Declaration
5968 then
5969 Install_Parent (Inst_Par);
5970 Parent_Installed := True;
5971
5972 elsif In_Open_Scopes (Inst_Par) then
5973
5974 -- If the parent is already installed, install the actuals
5975 -- for its formal packages. This is necessary when the child
5976 -- instance is a child of the parent instance: in this case,
5977 -- the parent is placed on the scope stack but the formal
5978 -- packages are not made visible.
5979
5980 Install_Formal_Packages (Inst_Par);
5981 end if;
5982
5983 else
5984 -- If the generic parent does not contain an entity that
5985 -- corresponds to the selector, the instance doesn't either.
5986 -- Analyzing the node will yield the appropriate error message.
5987 -- If the entity is not a child unit, then it is an inner
5988 -- generic in the parent.
5989
5990 Analyze (Gen_Id);
5991 end if;
5992
5993 else
5994 Analyze (Gen_Id);
5995
5996 if Is_Child_Unit (Entity (Gen_Id))
5997 and then
5998 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
5999 and then not In_Open_Scopes (Inst_Par)
6000 then
6001 Install_Parent (Inst_Par);
6002 Parent_Installed := True;
6003
6004 -- The generic unit may be the renaming of the implicit child
6005 -- present in an instance. In that case the parent instance is
6006 -- obtained from the name of the renamed entity.
6007
6008 elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
6009 and then Present (Renamed_Entity (Entity (Gen_Id)))
6010 and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
6011 then
6012 declare
6013 Renamed_Package : constant Node_Id :=
6014 Name (Parent (Entity (Gen_Id)));
6015 begin
6016 if Nkind (Renamed_Package) = N_Expanded_Name then
6017 Inst_Par := Entity (Prefix (Renamed_Package));
6018 Install_Parent (Inst_Par);
6019 Parent_Installed := True;
6020 end if;
6021 end;
6022 end if;
6023 end if;
6024
6025 elsif Nkind (Gen_Id) = N_Expanded_Name then
6026
6027 -- Entity already present, analyze prefix, whose meaning may be
6028 -- an instance in the current context. If it is an instance of
6029 -- a relative within another, the proper parent may still have
6030 -- to be installed, if they are not of the same generation.
6031
6032 Analyze (Prefix (Gen_Id));
6033
6034 -- In the unlikely case that a local declaration hides the name
6035 -- of the parent package, locate it on the homonym chain. If the
6036 -- context is an instance of the parent, the renaming entity is
6037 -- flagged as such.
6038
6039 Inst_Par := Entity (Prefix (Gen_Id));
6040 while Present (Inst_Par)
6041 and then not Is_Package_Or_Generic_Package (Inst_Par)
6042 loop
6043 Inst_Par := Homonym (Inst_Par);
6044 end loop;
6045
6046 pragma Assert (Present (Inst_Par));
6047 Set_Entity (Prefix (Gen_Id), Inst_Par);
6048
6049 if In_Enclosing_Instance then
6050 null;
6051
6052 elsif Present (Entity (Gen_Id))
6053 and then Is_Child_Unit (Entity (Gen_Id))
6054 and then not In_Open_Scopes (Inst_Par)
6055 then
6056 Install_Parent (Inst_Par);
6057 Parent_Installed := True;
6058 end if;
6059
6060 elsif In_Enclosing_Instance then
6061
6062 -- The child unit is found in some enclosing scope
6063
6064 null;
6065
6066 else
6067 Analyze (Gen_Id);
6068
6069 -- If this is the renaming of the implicit child in a parent
6070 -- instance, recover the parent name and install it.
6071
6072 if Is_Entity_Name (Gen_Id) then
6073 E := Entity (Gen_Id);
6074
6075 if Is_Generic_Unit (E)
6076 and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
6077 and then Is_Child_Unit (Renamed_Object (E))
6078 and then Is_Generic_Unit (Scope (Renamed_Object (E)))
6079 and then Nkind (Name (Parent (E))) = N_Expanded_Name
6080 then
6081 Rewrite (Gen_Id,
6082 New_Copy_Tree (Name (Parent (E))));
6083 Inst_Par := Entity (Prefix (Gen_Id));
6084
6085 if not In_Open_Scopes (Inst_Par) then
6086 Install_Parent (Inst_Par);
6087 Parent_Installed := True;
6088 end if;
6089
6090 -- If it is a child unit of a non-generic parent, it may be
6091 -- use-visible and given by a direct name. Install parent as
6092 -- for other cases.
6093
6094 elsif Is_Generic_Unit (E)
6095 and then Is_Child_Unit (E)
6096 and then
6097 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6098 and then not Is_Generic_Unit (Scope (E))
6099 then
6100 if not In_Open_Scopes (Scope (E)) then
6101 Install_Parent (Scope (E));
6102 Parent_Installed := True;
6103 end if;
6104 end if;
6105 end if;
6106 end if;
6107 end Check_Generic_Child_Unit;
6108
6109 -----------------------------
6110 -- Check_Hidden_Child_Unit --
6111 -----------------------------
6112
6113 procedure Check_Hidden_Child_Unit
6114 (N : Node_Id;
6115 Gen_Unit : Entity_Id;
6116 Act_Decl_Id : Entity_Id)
6117 is
6118 Gen_Id : constant Node_Id := Name (N);
6119
6120 begin
6121 if Is_Child_Unit (Gen_Unit)
6122 and then Is_Child_Unit (Act_Decl_Id)
6123 and then Nkind (Gen_Id) = N_Expanded_Name
6124 and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
6125 and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
6126 then
6127 Error_Msg_Node_2 := Scope (Act_Decl_Id);
6128 Error_Msg_NE
6129 ("generic unit & is implicitly declared in &",
6130 Defining_Unit_Name (N), Gen_Unit);
6131 Error_Msg_N ("\instance must have different name",
6132 Defining_Unit_Name (N));
6133 end if;
6134 end Check_Hidden_Child_Unit;
6135
6136 ------------------------
6137 -- Check_Private_View --
6138 ------------------------
6139
6140 procedure Check_Private_View (N : Node_Id) is
6141 T : constant Entity_Id := Etype (N);
6142 BT : Entity_Id;
6143
6144 begin
6145 -- Exchange views if the type was not private in the generic but is
6146 -- private at the point of instantiation. Do not exchange views if
6147 -- the scope of the type is in scope. This can happen if both generic
6148 -- and instance are sibling units, or if type is defined in a parent.
6149 -- In this case the visibility of the type will be correct for all
6150 -- semantic checks.
6151
6152 if Present (T) then
6153 BT := Base_Type (T);
6154
6155 if Is_Private_Type (T)
6156 and then not Has_Private_View (N)
6157 and then Present (Full_View (T))
6158 and then not In_Open_Scopes (Scope (T))
6159 then
6160 -- In the generic, the full type was visible. Save the private
6161 -- entity, for subsequent exchange.
6162
6163 Switch_View (T);
6164
6165 elsif Has_Private_View (N)
6166 and then not Is_Private_Type (T)
6167 and then not Has_Been_Exchanged (T)
6168 and then Etype (Get_Associated_Node (N)) /= T
6169 then
6170 -- Only the private declaration was visible in the generic. If
6171 -- the type appears in a subtype declaration, the subtype in the
6172 -- instance must have a view compatible with that of its parent,
6173 -- which must be exchanged (see corresponding code in Restore_
6174 -- Private_Views). Otherwise, if the type is defined in a parent
6175 -- unit, leave full visibility within instance, which is safe.
6176
6177 if In_Open_Scopes (Scope (Base_Type (T)))
6178 and then not Is_Private_Type (Base_Type (T))
6179 and then Comes_From_Source (Base_Type (T))
6180 then
6181 null;
6182
6183 elsif Nkind (Parent (N)) = N_Subtype_Declaration
6184 or else not In_Private_Part (Scope (Base_Type (T)))
6185 then
6186 Prepend_Elmt (T, Exchanged_Views);
6187 Exchange_Declarations (Etype (Get_Associated_Node (N)));
6188 end if;
6189
6190 -- For composite types with inconsistent representation exchange
6191 -- component types accordingly.
6192
6193 elsif Is_Access_Type (T)
6194 and then Is_Private_Type (Designated_Type (T))
6195 and then not Has_Private_View (N)
6196 and then Present (Full_View (Designated_Type (T)))
6197 then
6198 Switch_View (Designated_Type (T));
6199
6200 elsif Is_Array_Type (T) then
6201 if Is_Private_Type (Component_Type (T))
6202 and then not Has_Private_View (N)
6203 and then Present (Full_View (Component_Type (T)))
6204 then
6205 Switch_View (Component_Type (T));
6206 end if;
6207
6208 -- The normal exchange mechanism relies on the setting of a
6209 -- flag on the reference in the generic. However, an additional
6210 -- mechanism is needed for types that are not explicitly
6211 -- mentioned in the generic, but may be needed in expanded code
6212 -- in the instance. This includes component types of arrays and
6213 -- designated types of access types. This processing must also
6214 -- include the index types of arrays which we take care of here.
6215
6216 declare
6217 Indx : Node_Id;
6218 Typ : Entity_Id;
6219
6220 begin
6221 Indx := First_Index (T);
6222 while Present (Indx) loop
6223 Typ := Base_Type (Etype (Indx));
6224
6225 if Is_Private_Type (Typ)
6226 and then Present (Full_View (Typ))
6227 then
6228 Switch_View (Typ);
6229 end if;
6230
6231 Next_Index (Indx);
6232 end loop;
6233 end;
6234
6235 elsif Is_Private_Type (T)
6236 and then Present (Full_View (T))
6237 and then Is_Array_Type (Full_View (T))
6238 and then Is_Private_Type (Component_Type (Full_View (T)))
6239 then
6240 Switch_View (T);
6241
6242 -- Finally, a non-private subtype may have a private base type, which
6243 -- must be exchanged for consistency. This can happen when a package
6244 -- body is instantiated, when the scope stack is empty but in fact
6245 -- the subtype and the base type are declared in an enclosing scope.
6246
6247 -- Note that in this case we introduce an inconsistency in the view
6248 -- set, because we switch the base type BT, but there could be some
6249 -- private dependent subtypes of BT which remain unswitched. Such
6250 -- subtypes might need to be switched at a later point (see specific
6251 -- provision for that case in Switch_View).
6252
6253 elsif not Is_Private_Type (T)
6254 and then not Has_Private_View (N)
6255 and then Is_Private_Type (BT)
6256 and then Present (Full_View (BT))
6257 and then not Is_Generic_Type (BT)
6258 and then not In_Open_Scopes (BT)
6259 then
6260 Prepend_Elmt (Full_View (BT), Exchanged_Views);
6261 Exchange_Declarations (BT);
6262 end if;
6263 end if;
6264 end Check_Private_View;
6265
6266 -----------------------------
6267 -- Check_Hidden_Primitives --
6268 -----------------------------
6269
6270 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6271 Actual : Node_Id;
6272 Gen_T : Entity_Id;
6273 Result : Elist_Id := No_Elist;
6274
6275 begin
6276 if No (Assoc_List) then
6277 return No_Elist;
6278 end if;
6279
6280 -- Traverse the list of associations between formals and actuals
6281 -- searching for renamings of tagged types
6282
6283 Actual := First (Assoc_List);
6284 while Present (Actual) loop
6285 if Nkind (Actual) = N_Subtype_Declaration then
6286 Gen_T := Generic_Parent_Type (Actual);
6287
6288 if Present (Gen_T)
6289 and then Is_Tagged_Type (Gen_T)
6290 then
6291 -- Traverse the list of primitives of the actual types
6292 -- searching for hidden primitives that are visible in the
6293 -- corresponding generic formal; leave them visible and
6294 -- append them to Result to restore their decoration later.
6295
6296 Install_Hidden_Primitives
6297 (Prims_List => Result,
6298 Gen_T => Gen_T,
6299 Act_T => Entity (Subtype_Indication (Actual)));
6300 end if;
6301 end if;
6302
6303 Next (Actual);
6304 end loop;
6305
6306 return Result;
6307 end Check_Hidden_Primitives;
6308
6309 --------------------------
6310 -- Contains_Instance_Of --
6311 --------------------------
6312
6313 function Contains_Instance_Of
6314 (Inner : Entity_Id;
6315 Outer : Entity_Id;
6316 N : Node_Id) return Boolean
6317 is
6318 Elmt : Elmt_Id;
6319 Scop : Entity_Id;
6320
6321 begin
6322 Scop := Outer;
6323
6324 -- Verify that there are no circular instantiations. We check whether
6325 -- the unit contains an instance of the current scope or some enclosing
6326 -- scope (in case one of the instances appears in a subunit). Longer
6327 -- circularities involving subunits might seem too pathological to
6328 -- consider, but they were not too pathological for the authors of
6329 -- DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6330 -- enclosing generic scopes as containing an instance.
6331
6332 loop
6333 -- Within a generic subprogram body, the scope is not generic, to
6334 -- allow for recursive subprograms. Use the declaration to determine
6335 -- whether this is a generic unit.
6336
6337 if Ekind (Scop) = E_Generic_Package
6338 or else (Is_Subprogram (Scop)
6339 and then Nkind (Unit_Declaration_Node (Scop)) =
6340 N_Generic_Subprogram_Declaration)
6341 then
6342 Elmt := First_Elmt (Inner_Instances (Inner));
6343
6344 while Present (Elmt) loop
6345 if Node (Elmt) = Scop then
6346 Error_Msg_Node_2 := Inner;
6347 Error_Msg_NE
6348 ("circular Instantiation: & instantiated within &!",
6349 N, Scop);
6350 return True;
6351
6352 elsif Node (Elmt) = Inner then
6353 return True;
6354
6355 elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6356 Error_Msg_Node_2 := Inner;
6357 Error_Msg_NE
6358 ("circular Instantiation: & instantiated within &!",
6359 N, Node (Elmt));
6360 return True;
6361 end if;
6362
6363 Next_Elmt (Elmt);
6364 end loop;
6365
6366 -- Indicate that Inner is being instantiated within Scop
6367
6368 Append_Elmt (Inner, Inner_Instances (Scop));
6369 end if;
6370
6371 if Scop = Standard_Standard then
6372 exit;
6373 else
6374 Scop := Scope (Scop);
6375 end if;
6376 end loop;
6377
6378 return False;
6379 end Contains_Instance_Of;
6380
6381 -----------------------
6382 -- Copy_Generic_Node --
6383 -----------------------
6384
6385 function Copy_Generic_Node
6386 (N : Node_Id;
6387 Parent_Id : Node_Id;
6388 Instantiating : Boolean) return Node_Id
6389 is
6390 Ent : Entity_Id;
6391 New_N : Node_Id;
6392
6393 function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6394 -- Check the given value of one of the Fields referenced by the current
6395 -- node to determine whether to copy it recursively. The field may hold
6396 -- a Node_Id, a List_Id, or an Elist_Id, or a plain value (Sloc, Uint,
6397 -- Char) in which case it need not be copied.
6398
6399 procedure Copy_Descendants;
6400 -- Common utility for various nodes
6401
6402 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6403 -- Make copy of element list
6404
6405 function Copy_Generic_List
6406 (L : List_Id;
6407 Parent_Id : Node_Id) return List_Id;
6408 -- Apply Copy_Node recursively to the members of a node list
6409
6410 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6411 -- True if an identifier is part of the defining program unit name of
6412 -- a child unit. The entity of such an identifier must be kept (for
6413 -- ASIS use) even though as the name of an enclosing generic it would
6414 -- otherwise not be preserved in the generic tree.
6415
6416 ----------------------
6417 -- Copy_Descendants --
6418 ----------------------
6419
6420 procedure Copy_Descendants is
6421
6422 use Atree.Unchecked_Access;
6423 -- This code section is part of the implementation of an untyped
6424 -- tree traversal, so it needs direct access to node fields.
6425
6426 begin
6427 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6428 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6429 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6430 Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6431 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6432 end Copy_Descendants;
6433
6434 -----------------------------
6435 -- Copy_Generic_Descendant --
6436 -----------------------------
6437
6438 function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6439 begin
6440 if D = Union_Id (Empty) then
6441 return D;
6442
6443 elsif D in Node_Range then
6444 return Union_Id
6445 (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6446
6447 elsif D in List_Range then
6448 return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6449
6450 elsif D in Elist_Range then
6451 return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6452
6453 -- Nothing else is copyable (e.g. Uint values), return as is
6454
6455 else
6456 return D;
6457 end if;
6458 end Copy_Generic_Descendant;
6459
6460 ------------------------
6461 -- Copy_Generic_Elist --
6462 ------------------------
6463
6464 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6465 M : Elmt_Id;
6466 L : Elist_Id;
6467
6468 begin
6469 if Present (E) then
6470 L := New_Elmt_List;
6471 M := First_Elmt (E);
6472 while Present (M) loop
6473 Append_Elmt
6474 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6475 Next_Elmt (M);
6476 end loop;
6477
6478 return L;
6479
6480 else
6481 return No_Elist;
6482 end if;
6483 end Copy_Generic_Elist;
6484
6485 -----------------------
6486 -- Copy_Generic_List --
6487 -----------------------
6488
6489 function Copy_Generic_List
6490 (L : List_Id;
6491 Parent_Id : Node_Id) return List_Id
6492 is
6493 N : Node_Id;
6494 New_L : List_Id;
6495
6496 begin
6497 if Present (L) then
6498 New_L := New_List;
6499 Set_Parent (New_L, Parent_Id);
6500
6501 N := First (L);
6502 while Present (N) loop
6503 Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6504 Next (N);
6505 end loop;
6506
6507 return New_L;
6508
6509 else
6510 return No_List;
6511 end if;
6512 end Copy_Generic_List;
6513
6514 ---------------------------
6515 -- In_Defining_Unit_Name --
6516 ---------------------------
6517
6518 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6519 begin
6520 return Present (Parent (Nam))
6521 and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6522 or else
6523 (Nkind (Parent (Nam)) = N_Expanded_Name
6524 and then In_Defining_Unit_Name (Parent (Nam))));
6525 end In_Defining_Unit_Name;
6526
6527 -- Start of processing for Copy_Generic_Node
6528
6529 begin
6530 if N = Empty then
6531 return N;
6532 end if;
6533
6534 New_N := New_Copy (N);
6535
6536 -- Copy aspects if present
6537
6538 if Has_Aspects (N) then
6539 Set_Has_Aspects (New_N, False);
6540 Set_Aspect_Specifications
6541 (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6542 end if;
6543
6544 if Instantiating then
6545 Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6546 end if;
6547
6548 if not Is_List_Member (N) then
6549 Set_Parent (New_N, Parent_Id);
6550 end if;
6551
6552 -- If defining identifier, then all fields have been copied already
6553
6554 if Nkind (New_N) in N_Entity then
6555 null;
6556
6557 -- Special casing for identifiers and other entity names and operators
6558
6559 elsif Nkind_In (New_N, N_Identifier,
6560 N_Character_Literal,
6561 N_Expanded_Name,
6562 N_Operator_Symbol)
6563 or else Nkind (New_N) in N_Op
6564 then
6565 if not Instantiating then
6566
6567 -- Link both nodes in order to assign subsequently the entity of
6568 -- the copy to the original node, in case this is a global
6569 -- reference.
6570
6571 Set_Associated_Node (N, New_N);
6572
6573 -- If we are within an instantiation, this is a nested generic
6574 -- that has already been analyzed at the point of definition.
6575 -- We must preserve references that were global to the enclosing
6576 -- parent at that point. Other occurrences, whether global or
6577 -- local to the current generic, must be resolved anew, so we
6578 -- reset the entity in the generic copy. A global reference has a
6579 -- smaller depth than the parent, or else the same depth in case
6580 -- both are distinct compilation units.
6581
6582 -- A child unit is implicitly declared within the enclosing parent
6583 -- but is in fact global to it, and must be preserved.
6584
6585 -- It is also possible for Current_Instantiated_Parent to be
6586 -- defined, and for this not to be a nested generic, namely if
6587 -- the unit is loaded through Rtsfind. In that case, the entity of
6588 -- New_N is only a link to the associated node, and not a defining
6589 -- occurrence.
6590
6591 -- The entities for parent units in the defining_program_unit of a
6592 -- generic child unit are established when the context of the unit
6593 -- is first analyzed, before the generic copy is made. They are
6594 -- preserved in the copy for use in ASIS queries.
6595
6596 Ent := Entity (New_N);
6597
6598 if No (Current_Instantiated_Parent.Gen_Id) then
6599 if No (Ent)
6600 or else Nkind (Ent) /= N_Defining_Identifier
6601 or else not In_Defining_Unit_Name (N)
6602 then
6603 Set_Associated_Node (New_N, Empty);
6604 end if;
6605
6606 elsif No (Ent)
6607 or else
6608 not Nkind_In (Ent, N_Defining_Identifier,
6609 N_Defining_Character_Literal,
6610 N_Defining_Operator_Symbol)
6611 or else No (Scope (Ent))
6612 or else
6613 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
6614 and then not Is_Child_Unit (Ent))
6615 or else
6616 (Scope_Depth (Scope (Ent)) >
6617 Scope_Depth (Current_Instantiated_Parent.Gen_Id)
6618 and then
6619 Get_Source_Unit (Ent) =
6620 Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
6621 then
6622 Set_Associated_Node (New_N, Empty);
6623 end if;
6624
6625 -- Case of instantiating identifier or some other name or operator
6626
6627 else
6628 -- If the associated node is still defined, the entity in it
6629 -- is global, and must be copied to the instance. If this copy
6630 -- is being made for a body to inline, it is applied to an
6631 -- instantiated tree, and the entity is already present and
6632 -- must be also preserved.
6633
6634 declare
6635 Assoc : constant Node_Id := Get_Associated_Node (N);
6636
6637 begin
6638 if Present (Assoc) then
6639 if Nkind (Assoc) = Nkind (N) then
6640 Set_Entity (New_N, Entity (Assoc));
6641 Check_Private_View (N);
6642
6643 -- The name in the call may be a selected component if the
6644 -- call has not been analyzed yet, as may be the case for
6645 -- pre/post conditions in a generic unit.
6646
6647 elsif Nkind (Assoc) = N_Function_Call
6648 and then Is_Entity_Name (Name (Assoc))
6649 then
6650 Set_Entity (New_N, Entity (Name (Assoc)));
6651
6652 elsif Nkind_In (Assoc, N_Defining_Identifier,
6653 N_Defining_Character_Literal,
6654 N_Defining_Operator_Symbol)
6655 and then Expander_Active
6656 then
6657 -- Inlining case: we are copying a tree that contains
6658 -- global entities, which are preserved in the copy to be
6659 -- used for subsequent inlining.
6660
6661 null;
6662
6663 else
6664 Set_Entity (New_N, Empty);
6665 end if;
6666 end if;
6667 end;
6668 end if;
6669
6670 -- For expanded name, we must copy the Prefix and Selector_Name
6671
6672 if Nkind (N) = N_Expanded_Name then
6673 Set_Prefix
6674 (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
6675
6676 Set_Selector_Name (New_N,
6677 Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
6678
6679 -- For operators, we must copy the right operand
6680
6681 elsif Nkind (N) in N_Op then
6682 Set_Right_Opnd (New_N,
6683 Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
6684
6685 -- And for binary operators, the left operand as well
6686
6687 if Nkind (N) in N_Binary_Op then
6688 Set_Left_Opnd (New_N,
6689 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
6690 end if;
6691 end if;
6692
6693 -- Special casing for stubs
6694
6695 elsif Nkind (N) in N_Body_Stub then
6696
6697 -- In any case, we must copy the specification or defining
6698 -- identifier as appropriate.
6699
6700 if Nkind (N) = N_Subprogram_Body_Stub then
6701 Set_Specification (New_N,
6702 Copy_Generic_Node (Specification (N), New_N, Instantiating));
6703
6704 else
6705 Set_Defining_Identifier (New_N,
6706 Copy_Generic_Node
6707 (Defining_Identifier (N), New_N, Instantiating));
6708 end if;
6709
6710 -- If we are not instantiating, then this is where we load and
6711 -- analyze subunits, i.e. at the point where the stub occurs. A
6712 -- more permissive system might defer this analysis to the point
6713 -- of instantiation, but this seems too complicated for now.
6714
6715 if not Instantiating then
6716 declare
6717 Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
6718 Subunit : Node_Id;
6719 Unum : Unit_Number_Type;
6720 New_Body : Node_Id;
6721
6722 begin
6723 -- Make sure that, if it is a subunit of the main unit that is
6724 -- preprocessed and if -gnateG is specified, the preprocessed
6725 -- file will be written.
6726
6727 Lib.Analysing_Subunit_Of_Main :=
6728 Lib.In_Extended_Main_Source_Unit (N);
6729 Unum :=
6730 Load_Unit
6731 (Load_Name => Subunit_Name,
6732 Required => False,
6733 Subunit => True,
6734 Error_Node => N);
6735 Lib.Analysing_Subunit_Of_Main := False;
6736
6737 -- If the proper body is not found, a warning message will be
6738 -- emitted when analyzing the stub, or later at the point of
6739 -- instantiation. Here we just leave the stub as is.
6740
6741 if Unum = No_Unit then
6742 Subunits_Missing := True;
6743 goto Subunit_Not_Found;
6744 end if;
6745
6746 Subunit := Cunit (Unum);
6747
6748 if Nkind (Unit (Subunit)) /= N_Subunit then
6749 Error_Msg_N
6750 ("found child unit instead of expected SEPARATE subunit",
6751 Subunit);
6752 Error_Msg_Sloc := Sloc (N);
6753 Error_Msg_N ("\to complete stub #", Subunit);
6754 goto Subunit_Not_Found;
6755 end if;
6756
6757 -- We must create a generic copy of the subunit, in order to
6758 -- perform semantic analysis on it, and we must replace the
6759 -- stub in the original generic unit with the subunit, in order
6760 -- to preserve non-local references within.
6761
6762 -- Only the proper body needs to be copied. Library_Unit and
6763 -- context clause are simply inherited by the generic copy.
6764 -- Note that the copy (which may be recursive if there are
6765 -- nested subunits) must be done first, before attaching it to
6766 -- the enclosing generic.
6767
6768 New_Body :=
6769 Copy_Generic_Node
6770 (Proper_Body (Unit (Subunit)),
6771 Empty, Instantiating => False);
6772
6773 -- Now place the original proper body in the original generic
6774 -- unit. This is a body, not a compilation unit.
6775
6776 Rewrite (N, Proper_Body (Unit (Subunit)));
6777 Set_Is_Compilation_Unit (Defining_Entity (N), False);
6778 Set_Was_Originally_Stub (N);
6779
6780 -- Finally replace the body of the subunit with its copy, and
6781 -- make this new subunit into the library unit of the generic
6782 -- copy, which does not have stubs any longer.
6783
6784 Set_Proper_Body (Unit (Subunit), New_Body);
6785 Set_Library_Unit (New_N, Subunit);
6786 Inherit_Context (Unit (Subunit), N);
6787 end;
6788
6789 -- If we are instantiating, this must be an error case, since
6790 -- otherwise we would have replaced the stub node by the proper body
6791 -- that corresponds. So just ignore it in the copy (i.e. we have
6792 -- copied it, and that is good enough).
6793
6794 else
6795 null;
6796 end if;
6797
6798 <<Subunit_Not_Found>> null;
6799
6800 -- If the node is a compilation unit, it is the subunit of a stub, which
6801 -- has been loaded already (see code below). In this case, the library
6802 -- unit field of N points to the parent unit (which is a compilation
6803 -- unit) and need not (and cannot) be copied.
6804
6805 -- When the proper body of the stub is analyzed, the library_unit link
6806 -- is used to establish the proper context (see sem_ch10).
6807
6808 -- The other fields of a compilation unit are copied as usual
6809
6810 elsif Nkind (N) = N_Compilation_Unit then
6811
6812 -- This code can only be executed when not instantiating, because in
6813 -- the copy made for an instantiation, the compilation unit node has
6814 -- disappeared at the point that a stub is replaced by its proper
6815 -- body.
6816
6817 pragma Assert (not Instantiating);
6818
6819 Set_Context_Items (New_N,
6820 Copy_Generic_List (Context_Items (N), New_N));
6821
6822 Set_Unit (New_N,
6823 Copy_Generic_Node (Unit (N), New_N, False));
6824
6825 Set_First_Inlined_Subprogram (New_N,
6826 Copy_Generic_Node
6827 (First_Inlined_Subprogram (N), New_N, False));
6828
6829 Set_Aux_Decls_Node (New_N,
6830 Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
6831
6832 -- For an assignment node, the assignment is known to be semantically
6833 -- legal if we are instantiating the template. This avoids incorrect
6834 -- diagnostics in generated code.
6835
6836 elsif Nkind (N) = N_Assignment_Statement then
6837
6838 -- Copy name and expression fields in usual manner
6839
6840 Set_Name (New_N,
6841 Copy_Generic_Node (Name (N), New_N, Instantiating));
6842
6843 Set_Expression (New_N,
6844 Copy_Generic_Node (Expression (N), New_N, Instantiating));
6845
6846 if Instantiating then
6847 Set_Assignment_OK (Name (New_N), True);
6848 end if;
6849
6850 elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
6851 if not Instantiating then
6852 Set_Associated_Node (N, New_N);
6853
6854 else
6855 if Present (Get_Associated_Node (N))
6856 and then Nkind (Get_Associated_Node (N)) = Nkind (N)
6857 then
6858 -- In the generic the aggregate has some composite type. If at
6859 -- the point of instantiation the type has a private view,
6860 -- install the full view (and that of its ancestors, if any).
6861
6862 declare
6863 T : Entity_Id := (Etype (Get_Associated_Node (New_N)));
6864 Rt : Entity_Id;
6865
6866 begin
6867 if Present (T)
6868 and then Is_Private_Type (T)
6869 then
6870 Switch_View (T);
6871 end if;
6872
6873 if Present (T)
6874 and then Is_Tagged_Type (T)
6875 and then Is_Derived_Type (T)
6876 then
6877 Rt := Root_Type (T);
6878
6879 loop
6880 T := Etype (T);
6881
6882 if Is_Private_Type (T) then
6883 Switch_View (T);
6884 end if;
6885
6886 exit when T = Rt;
6887 end loop;
6888 end if;
6889 end;
6890 end if;
6891 end if;
6892
6893 -- Do not copy the associated node, which points to the generic copy
6894 -- of the aggregate.
6895
6896 declare
6897 use Atree.Unchecked_Access;
6898 -- This code section is part of the implementation of an untyped
6899 -- tree traversal, so it needs direct access to node fields.
6900
6901 begin
6902 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6903 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6904 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6905 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6906 end;
6907
6908 -- Allocators do not have an identifier denoting the access type, so we
6909 -- must locate it through the expression to check whether the views are
6910 -- consistent.
6911
6912 elsif Nkind (N) = N_Allocator
6913 and then Nkind (Expression (N)) = N_Qualified_Expression
6914 and then Is_Entity_Name (Subtype_Mark (Expression (N)))
6915 and then Instantiating
6916 then
6917 declare
6918 T : constant Node_Id :=
6919 Get_Associated_Node (Subtype_Mark (Expression (N)));
6920 Acc_T : Entity_Id;
6921
6922 begin
6923 if Present (T) then
6924
6925 -- Retrieve the allocator node in the generic copy
6926
6927 Acc_T := Etype (Parent (Parent (T)));
6928 if Present (Acc_T)
6929 and then Is_Private_Type (Acc_T)
6930 then
6931 Switch_View (Acc_T);
6932 end if;
6933 end if;
6934
6935 Copy_Descendants;
6936 end;
6937
6938 -- For a proper body, we must catch the case of a proper body that
6939 -- replaces a stub. This represents the point at which a separate
6940 -- compilation unit, and hence template file, may be referenced, so we
6941 -- must make a new source instantiation entry for the template of the
6942 -- subunit, and ensure that all nodes in the subunit are adjusted using
6943 -- this new source instantiation entry.
6944
6945 elsif Nkind (N) in N_Proper_Body then
6946 declare
6947 Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
6948
6949 begin
6950 if Instantiating and then Was_Originally_Stub (N) then
6951 Create_Instantiation_Source
6952 (Instantiation_Node,
6953 Defining_Entity (N),
6954 False,
6955 S_Adjustment);
6956 end if;
6957
6958 -- Now copy the fields of the proper body, using the new
6959 -- adjustment factor if one was needed as per test above.
6960
6961 Copy_Descendants;
6962
6963 -- Restore the original adjustment factor in case changed
6964
6965 S_Adjustment := Save_Adjustment;
6966 end;
6967
6968 -- Don't copy Ident or Comment pragmas, since the comment belongs to the
6969 -- generic unit, not to the instantiating unit.
6970
6971 elsif Nkind (N) = N_Pragma and then Instantiating then
6972 declare
6973 Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
6974 begin
6975 if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
6976 New_N := Make_Null_Statement (Sloc (N));
6977 else
6978 Copy_Descendants;
6979 end if;
6980 end;
6981
6982 elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
6983
6984 -- No descendant fields need traversing
6985
6986 null;
6987
6988 elsif Nkind (N) = N_String_Literal
6989 and then Present (Etype (N))
6990 and then Instantiating
6991 then
6992 -- If the string is declared in an outer scope, the string_literal
6993 -- subtype created for it may have the wrong scope. We force the
6994 -- reanalysis of the constant to generate a new itype in the proper
6995 -- context.
6996
6997 Set_Etype (New_N, Empty);
6998 Set_Analyzed (New_N, False);
6999
7000 -- For the remaining nodes, copy their descendants recursively
7001
7002 else
7003 Copy_Descendants;
7004
7005 if Instantiating and then Nkind (N) = N_Subprogram_Body then
7006 Set_Generic_Parent (Specification (New_N), N);
7007
7008 -- Should preserve Corresponding_Spec??? (12.3(14))
7009 end if;
7010 end if;
7011
7012 return New_N;
7013 end Copy_Generic_Node;
7014
7015 ----------------------------
7016 -- Denotes_Formal_Package --
7017 ----------------------------
7018
7019 function Denotes_Formal_Package
7020 (Pack : Entity_Id;
7021 On_Exit : Boolean := False;
7022 Instance : Entity_Id := Empty) return Boolean
7023 is
7024 Par : Entity_Id;
7025 Scop : constant Entity_Id := Scope (Pack);
7026 E : Entity_Id;
7027
7028 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
7029 -- The package in question may be an actual for a previous formal
7030 -- package P of the current instance, so examine its actuals as well.
7031 -- This must be recursive over other formal packages.
7032
7033 ----------------------------------
7034 -- Is_Actual_Of_Previous_Formal --
7035 ----------------------------------
7036
7037 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
7038 E1 : Entity_Id;
7039
7040 begin
7041 E1 := First_Entity (P);
7042 while Present (E1) and then E1 /= Instance loop
7043 if Ekind (E1) = E_Package
7044 and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
7045 then
7046 if Renamed_Object (E1) = Pack then
7047 return True;
7048
7049 elsif E1 = P or else Renamed_Object (E1) = P then
7050 return False;
7051
7052 elsif Is_Actual_Of_Previous_Formal (E1) then
7053 return True;
7054 end if;
7055 end if;
7056
7057 Next_Entity (E1);
7058 end loop;
7059
7060 return False;
7061 end Is_Actual_Of_Previous_Formal;
7062
7063 -- Start of processing for Denotes_Formal_Package
7064
7065 begin
7066 if On_Exit then
7067 Par :=
7068 Instance_Envs.Table
7069 (Instance_Envs.Last).Instantiated_Parent.Act_Id;
7070 else
7071 Par := Current_Instantiated_Parent.Act_Id;
7072 end if;
7073
7074 if Ekind (Scop) = E_Generic_Package
7075 or else Nkind (Unit_Declaration_Node (Scop)) =
7076 N_Generic_Subprogram_Declaration
7077 then
7078 return True;
7079
7080 elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
7081 N_Formal_Package_Declaration
7082 then
7083 return True;
7084
7085 elsif No (Par) then
7086 return False;
7087
7088 else
7089 -- Check whether this package is associated with a formal package of
7090 -- the enclosing instantiation. Iterate over the list of renamings.
7091
7092 E := First_Entity (Par);
7093 while Present (E) loop
7094 if Ekind (E) /= E_Package
7095 or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
7096 then
7097 null;
7098
7099 elsif Renamed_Object (E) = Par then
7100 return False;
7101
7102 elsif Renamed_Object (E) = Pack then
7103 return True;
7104
7105 elsif Is_Actual_Of_Previous_Formal (E) then
7106 return True;
7107
7108 end if;
7109
7110 Next_Entity (E);
7111 end loop;
7112
7113 return False;
7114 end if;
7115 end Denotes_Formal_Package;
7116
7117 -----------------
7118 -- End_Generic --
7119 -----------------
7120
7121 procedure End_Generic is
7122 begin
7123 -- ??? More things could be factored out in this routine. Should
7124 -- probably be done at a later stage.
7125
7126 Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
7127 Generic_Flags.Decrement_Last;
7128
7129 Expander_Mode_Restore;
7130 end End_Generic;
7131
7132 -------------
7133 -- Earlier --
7134 -------------
7135
7136 function Earlier (N1, N2 : Node_Id) return Boolean is
7137 procedure Find_Depth (P : in out Node_Id; D : in out Integer);
7138 -- Find distance from given node to enclosing compilation unit
7139
7140 ----------------
7141 -- Find_Depth --
7142 ----------------
7143
7144 procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
7145 begin
7146 while Present (P)
7147 and then Nkind (P) /= N_Compilation_Unit
7148 loop
7149 P := True_Parent (P);
7150 D := D + 1;
7151 end loop;
7152 end Find_Depth;
7153
7154 -- Local declarations
7155
7156 D1 : Integer := 0;
7157 D2 : Integer := 0;
7158 P1 : Node_Id := N1;
7159 P2 : Node_Id := N2;
7160 T1 : Source_Ptr;
7161 T2 : Source_Ptr;
7162
7163 -- Start of processing for Earlier
7164
7165 begin
7166 Find_Depth (P1, D1);
7167 Find_Depth (P2, D2);
7168
7169 if P1 /= P2 then
7170 return False;
7171 else
7172 P1 := N1;
7173 P2 := N2;
7174 end if;
7175
7176 while D1 > D2 loop
7177 P1 := True_Parent (P1);
7178 D1 := D1 - 1;
7179 end loop;
7180
7181 while D2 > D1 loop
7182 P2 := True_Parent (P2);
7183 D2 := D2 - 1;
7184 end loop;
7185
7186 -- At this point P1 and P2 are at the same distance from the root.
7187 -- We examine their parents until we find a common declarative list.
7188 -- If we reach the root, N1 and N2 do not descend from the same
7189 -- declarative list (e.g. one is nested in the declarative part and
7190 -- the other is in a block in the statement part) and the earlier
7191 -- one is already frozen.
7192
7193 while not Is_List_Member (P1)
7194 or else not Is_List_Member (P2)
7195 or else List_Containing (P1) /= List_Containing (P2)
7196 loop
7197 P1 := True_Parent (P1);
7198 P2 := True_Parent (P2);
7199
7200 if Nkind (Parent (P1)) = N_Subunit then
7201 P1 := Corresponding_Stub (Parent (P1));
7202 end if;
7203
7204 if Nkind (Parent (P2)) = N_Subunit then
7205 P2 := Corresponding_Stub (Parent (P2));
7206 end if;
7207
7208 if P1 = P2 then
7209 return False;
7210 end if;
7211 end loop;
7212
7213 -- Expanded code usually shares the source location of the original
7214 -- construct it was generated for. This however may not necessarely
7215 -- reflect the true location of the code within the tree.
7216
7217 -- Before comparing the slocs of the two nodes, make sure that we are
7218 -- working with correct source locations. Assume that P1 is to the left
7219 -- of P2. If either one does not come from source, traverse the common
7220 -- list heading towards the other node and locate the first source
7221 -- statement.
7222
7223 -- P1 P2
7224 -- ----+===+===+--------------+===+===+----
7225 -- expanded code expanded code
7226
7227 if not Comes_From_Source (P1) then
7228 while Present (P1) loop
7229
7230 -- Neither P2 nor a source statement were located during the
7231 -- search. If we reach the end of the list, then P1 does not
7232 -- occur earlier than P2.
7233
7234 -- ---->
7235 -- start --- P2 ----- P1 --- end
7236
7237 if No (Next (P1)) then
7238 return False;
7239
7240 -- We encounter P2 while going to the right of the list. This
7241 -- means that P1 does indeed appear earlier.
7242
7243 -- ---->
7244 -- start --- P1 ===== P2 --- end
7245 -- expanded code in between
7246
7247 elsif P1 = P2 then
7248 return True;
7249
7250 -- No need to look any further since we have located a source
7251 -- statement.
7252
7253 elsif Comes_From_Source (P1) then
7254 exit;
7255 end if;
7256
7257 -- Keep going right
7258
7259 Next (P1);
7260 end loop;
7261 end if;
7262
7263 if not Comes_From_Source (P2) then
7264 while Present (P2) loop
7265
7266 -- Neither P1 nor a source statement were located during the
7267 -- search. If we reach the start of the list, then P1 does not
7268 -- occur earlier than P2.
7269
7270 -- <----
7271 -- start --- P2 --- P1 --- end
7272
7273 if No (Prev (P2)) then
7274 return False;
7275
7276 -- We encounter P1 while going to the left of the list. This
7277 -- means that P1 does indeed appear earlier.
7278
7279 -- <----
7280 -- start --- P1 ===== P2 --- end
7281 -- expanded code in between
7282
7283 elsif P2 = P1 then
7284 return True;
7285
7286 -- No need to look any further since we have located a source
7287 -- statement.
7288
7289 elsif Comes_From_Source (P2) then
7290 exit;
7291 end if;
7292
7293 -- Keep going left
7294
7295 Prev (P2);
7296 end loop;
7297 end if;
7298
7299 -- At this point either both nodes came from source or we approximated
7300 -- their source locations through neighbouring source statements.
7301
7302 T1 := Top_Level_Location (Sloc (P1));
7303 T2 := Top_Level_Location (Sloc (P2));
7304
7305 -- When two nodes come from the same instance, they have identical top
7306 -- level locations. To determine proper relation within the tree, check
7307 -- their locations within the template.
7308
7309 if T1 = T2 then
7310 return Sloc (P1) < Sloc (P2);
7311
7312 -- The two nodes either come from unrelated instances or do not come
7313 -- from instantiated code at all.
7314
7315 else
7316 return T1 < T2;
7317 end if;
7318 end Earlier;
7319
7320 ----------------------
7321 -- Find_Actual_Type --
7322 ----------------------
7323
7324 function Find_Actual_Type
7325 (Typ : Entity_Id;
7326 Gen_Type : Entity_Id) return Entity_Id
7327 is
7328 Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7329 T : Entity_Id;
7330
7331 begin
7332 -- Special processing only applies to child units
7333
7334 if not Is_Child_Unit (Gen_Scope) then
7335 return Get_Instance_Of (Typ);
7336
7337 -- If designated or component type is itself a formal of the child unit,
7338 -- its instance is available.
7339
7340 elsif Scope (Typ) = Gen_Scope then
7341 return Get_Instance_Of (Typ);
7342
7343 -- If the array or access type is not declared in the parent unit,
7344 -- no special processing needed.
7345
7346 elsif not Is_Generic_Type (Typ)
7347 and then Scope (Gen_Scope) /= Scope (Typ)
7348 then
7349 return Get_Instance_Of (Typ);
7350
7351 -- Otherwise, retrieve designated or component type by visibility
7352
7353 else
7354 T := Current_Entity (Typ);
7355 while Present (T) loop
7356 if In_Open_Scopes (Scope (T)) then
7357 return T;
7358
7359 elsif Is_Generic_Actual_Type (T) then
7360 return T;
7361 end if;
7362
7363 T := Homonym (T);
7364 end loop;
7365
7366 return Typ;
7367 end if;
7368 end Find_Actual_Type;
7369
7370 ----------------------------
7371 -- Freeze_Subprogram_Body --
7372 ----------------------------
7373
7374 procedure Freeze_Subprogram_Body
7375 (Inst_Node : Node_Id;
7376 Gen_Body : Node_Id;
7377 Pack_Id : Entity_Id)
7378 is
7379 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7380 Par : constant Entity_Id := Scope (Gen_Unit);
7381 E_G_Id : Entity_Id;
7382 Enc_G : Entity_Id;
7383 Enc_I : Node_Id;
7384 F_Node : Node_Id;
7385
7386 function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7387 -- Find innermost package body that encloses the given node, and which
7388 -- is not a compilation unit. Freeze nodes for the instance, or for its
7389 -- enclosing body, may be inserted after the enclosing_body of the
7390 -- generic unit. Used to determine proper placement of freeze node for
7391 -- both package and subprogram instances.
7392
7393 function Package_Freeze_Node (B : Node_Id) return Node_Id;
7394 -- Find entity for given package body, and locate or create a freeze
7395 -- node for it.
7396
7397 ----------------------------
7398 -- Enclosing_Package_Body --
7399 ----------------------------
7400
7401 function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7402 P : Node_Id;
7403
7404 begin
7405 P := Parent (N);
7406 while Present (P)
7407 and then Nkind (Parent (P)) /= N_Compilation_Unit
7408 loop
7409 if Nkind (P) = N_Package_Body then
7410 if Nkind (Parent (P)) = N_Subunit then
7411 return Corresponding_Stub (Parent (P));
7412 else
7413 return P;
7414 end if;
7415 end if;
7416
7417 P := True_Parent (P);
7418 end loop;
7419
7420 return Empty;
7421 end Enclosing_Package_Body;
7422
7423 -------------------------
7424 -- Package_Freeze_Node --
7425 -------------------------
7426
7427 function Package_Freeze_Node (B : Node_Id) return Node_Id is
7428 Id : Entity_Id;
7429
7430 begin
7431 if Nkind (B) = N_Package_Body then
7432 Id := Corresponding_Spec (B);
7433 else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7434 Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7435 end if;
7436
7437 Ensure_Freeze_Node (Id);
7438 return Freeze_Node (Id);
7439 end Package_Freeze_Node;
7440
7441 -- Start of processing of Freeze_Subprogram_Body
7442
7443 begin
7444 -- If the instance and the generic body appear within the same unit, and
7445 -- the instance precedes the generic, the freeze node for the instance
7446 -- must appear after that of the generic. If the generic is nested
7447 -- within another instance I2, then current instance must be frozen
7448 -- after I2. In both cases, the freeze nodes are those of enclosing
7449 -- packages. Otherwise, the freeze node is placed at the end of the
7450 -- current declarative part.
7451
7452 Enc_G := Enclosing_Package_Body (Gen_Body);
7453 Enc_I := Enclosing_Package_Body (Inst_Node);
7454 Ensure_Freeze_Node (Pack_Id);
7455 F_Node := Freeze_Node (Pack_Id);
7456
7457 if Is_Generic_Instance (Par)
7458 and then Present (Freeze_Node (Par))
7459 and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7460 then
7461 -- The parent was a premature instantiation. Insert freeze node at
7462 -- the end the current declarative part.
7463
7464 if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7465 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7466
7467 -- Handle the following case:
7468 --
7469 -- package Parent_Inst is new ...
7470 -- Parent_Inst []
7471 --
7472 -- procedure P ... -- this body freezes Parent_Inst
7473 --
7474 -- package Inst is new ...
7475 --
7476 -- In this particular scenario, the freeze node for Inst must be
7477 -- inserted in the same manner as that of Parent_Inst - before the
7478 -- next source body or at the end of the declarative list (body not
7479 -- available). If body P did not exist and Parent_Inst was frozen
7480 -- after Inst, either by a body following Inst or at the end of the
7481 -- declarative region, the freeze node for Inst must be inserted
7482 -- after that of Parent_Inst. This relation is established by
7483 -- comparing the Slocs of Parent_Inst freeze node and Inst.
7484
7485 elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7486 List_Containing (Inst_Node)
7487 and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7488 then
7489 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7490
7491 else
7492 Insert_After (Freeze_Node (Par), F_Node);
7493 end if;
7494
7495 -- The body enclosing the instance should be frozen after the body that
7496 -- includes the generic, because the body of the instance may make
7497 -- references to entities therein. If the two are not in the same
7498 -- declarative part, or if the one enclosing the instance is frozen
7499 -- already, freeze the instance at the end of the current declarative
7500 -- part.
7501
7502 elsif Is_Generic_Instance (Par)
7503 and then Present (Freeze_Node (Par))
7504 and then Present (Enc_I)
7505 then
7506 if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7507 or else
7508 (Nkind (Enc_I) = N_Package_Body
7509 and then
7510 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7511 then
7512 -- The enclosing package may contain several instances. Rather
7513 -- than computing the earliest point at which to insert its freeze
7514 -- node, we place it at the end of the declarative part of the
7515 -- parent of the generic.
7516
7517 Insert_Freeze_Node_For_Instance
7518 (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7519 end if;
7520
7521 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7522
7523 elsif Present (Enc_G)
7524 and then Present (Enc_I)
7525 and then Enc_G /= Enc_I
7526 and then Earlier (Inst_Node, Gen_Body)
7527 then
7528 if Nkind (Enc_G) = N_Package_Body then
7529 E_G_Id := Corresponding_Spec (Enc_G);
7530 else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7531 E_G_Id :=
7532 Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7533 end if;
7534
7535 -- Freeze package that encloses instance, and place node after the
7536 -- package that encloses generic. If enclosing package is already
7537 -- frozen we have to assume it is at the proper place. This may be a
7538 -- potential ABE that requires dynamic checking. Do not add a freeze
7539 -- node if the package that encloses the generic is inside the body
7540 -- that encloses the instance, because the freeze node would be in
7541 -- the wrong scope. Additional contortions needed if the bodies are
7542 -- within a subunit.
7543
7544 declare
7545 Enclosing_Body : Node_Id;
7546
7547 begin
7548 if Nkind (Enc_I) = N_Package_Body_Stub then
7549 Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7550 else
7551 Enclosing_Body := Enc_I;
7552 end if;
7553
7554 if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
7555 Insert_Freeze_Node_For_Instance
7556 (Enc_G, Package_Freeze_Node (Enc_I));
7557 end if;
7558 end;
7559
7560 -- Freeze enclosing subunit before instance
7561
7562 Ensure_Freeze_Node (E_G_Id);
7563
7564 if not Is_List_Member (Freeze_Node (E_G_Id)) then
7565 Insert_After (Enc_G, Freeze_Node (E_G_Id));
7566 end if;
7567
7568 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7569
7570 else
7571 -- If none of the above, insert freeze node at the end of the current
7572 -- declarative part.
7573
7574 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7575 end if;
7576 end Freeze_Subprogram_Body;
7577
7578 ----------------
7579 -- Get_Gen_Id --
7580 ----------------
7581
7582 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
7583 begin
7584 return Generic_Renamings.Table (E).Gen_Id;
7585 end Get_Gen_Id;
7586
7587 ---------------------
7588 -- Get_Instance_Of --
7589 ---------------------
7590
7591 function Get_Instance_Of (A : Entity_Id) return Entity_Id is
7592 Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
7593
7594 begin
7595 if Res /= Assoc_Null then
7596 return Generic_Renamings.Table (Res).Act_Id;
7597 else
7598 -- On exit, entity is not instantiated: not a generic parameter, or
7599 -- else parameter of an inner generic unit.
7600
7601 return A;
7602 end if;
7603 end Get_Instance_Of;
7604
7605 ------------------------------------
7606 -- Get_Package_Instantiation_Node --
7607 ------------------------------------
7608
7609 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
7610 Decl : Node_Id := Unit_Declaration_Node (A);
7611 Inst : Node_Id;
7612
7613 begin
7614 -- If the Package_Instantiation attribute has been set on the package
7615 -- entity, then use it directly when it (or its Original_Node) refers
7616 -- to an N_Package_Instantiation node. In principle it should be
7617 -- possible to have this field set in all cases, which should be
7618 -- investigated, and would allow this function to be significantly
7619 -- simplified. ???
7620
7621 Inst := Package_Instantiation (A);
7622
7623 if Present (Inst) then
7624 if Nkind (Inst) = N_Package_Instantiation then
7625 return Inst;
7626
7627 elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
7628 return Original_Node (Inst);
7629 end if;
7630 end if;
7631
7632 -- If the instantiation is a compilation unit that does not need body
7633 -- then the instantiation node has been rewritten as a package
7634 -- declaration for the instance, and we return the original node.
7635
7636 -- If it is a compilation unit and the instance node has not been
7637 -- rewritten, then it is still the unit of the compilation. Finally, if
7638 -- a body is present, this is a parent of the main unit whose body has
7639 -- been compiled for inlining purposes, and the instantiation node has
7640 -- been rewritten with the instance body.
7641
7642 -- Otherwise the instantiation node appears after the declaration. If
7643 -- the entity is a formal package, the declaration may have been
7644 -- rewritten as a generic declaration (in the case of a formal with box)
7645 -- or left as a formal package declaration if it has actuals, and is
7646 -- found with a forward search.
7647
7648 if Nkind (Parent (Decl)) = N_Compilation_Unit then
7649 if Nkind (Decl) = N_Package_Declaration
7650 and then Present (Corresponding_Body (Decl))
7651 then
7652 Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
7653 end if;
7654
7655 if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
7656 return Original_Node (Decl);
7657 else
7658 return Unit (Parent (Decl));
7659 end if;
7660
7661 elsif Nkind (Decl) = N_Package_Declaration
7662 and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
7663 then
7664 return Original_Node (Decl);
7665
7666 else
7667 Inst := Next (Decl);
7668 while not Nkind_In (Inst, N_Package_Instantiation,
7669 N_Formal_Package_Declaration)
7670 loop
7671 Next (Inst);
7672 end loop;
7673
7674 return Inst;
7675 end if;
7676 end Get_Package_Instantiation_Node;
7677
7678 ------------------------
7679 -- Has_Been_Exchanged --
7680 ------------------------
7681
7682 function Has_Been_Exchanged (E : Entity_Id) return Boolean is
7683 Next : Elmt_Id;
7684
7685 begin
7686 Next := First_Elmt (Exchanged_Views);
7687 while Present (Next) loop
7688 if Full_View (Node (Next)) = E then
7689 return True;
7690 end if;
7691
7692 Next_Elmt (Next);
7693 end loop;
7694
7695 return False;
7696 end Has_Been_Exchanged;
7697
7698 ----------
7699 -- Hash --
7700 ----------
7701
7702 function Hash (F : Entity_Id) return HTable_Range is
7703 begin
7704 return HTable_Range (F mod HTable_Size);
7705 end Hash;
7706
7707 ------------------------
7708 -- Hide_Current_Scope --
7709 ------------------------
7710
7711 procedure Hide_Current_Scope is
7712 C : constant Entity_Id := Current_Scope;
7713 E : Entity_Id;
7714
7715 begin
7716 Set_Is_Hidden_Open_Scope (C);
7717
7718 E := First_Entity (C);
7719 while Present (E) loop
7720 if Is_Immediately_Visible (E) then
7721 Set_Is_Immediately_Visible (E, False);
7722 Append_Elmt (E, Hidden_Entities);
7723 end if;
7724
7725 Next_Entity (E);
7726 end loop;
7727
7728 -- Make the scope name invisible as well. This is necessary, but might
7729 -- conflict with calls to Rtsfind later on, in case the scope is a
7730 -- predefined one. There is no clean solution to this problem, so for
7731 -- now we depend on the user not redefining Standard itself in one of
7732 -- the parent units.
7733
7734 if Is_Immediately_Visible (C) and then C /= Standard_Standard then
7735 Set_Is_Immediately_Visible (C, False);
7736 Append_Elmt (C, Hidden_Entities);
7737 end if;
7738
7739 end Hide_Current_Scope;
7740
7741 --------------
7742 -- Init_Env --
7743 --------------
7744
7745 procedure Init_Env is
7746 Saved : Instance_Env;
7747
7748 begin
7749 Saved.Instantiated_Parent := Current_Instantiated_Parent;
7750 Saved.Exchanged_Views := Exchanged_Views;
7751 Saved.Hidden_Entities := Hidden_Entities;
7752 Saved.Current_Sem_Unit := Current_Sem_Unit;
7753 Saved.Parent_Unit_Visible := Parent_Unit_Visible;
7754 Saved.Instance_Parent_Unit := Instance_Parent_Unit;
7755
7756 -- Save configuration switches. These may be reset if the unit is a
7757 -- predefined unit, and the current mode is not Ada 2005.
7758
7759 Save_Opt_Config_Switches (Saved.Switches);
7760
7761 Instance_Envs.Append (Saved);
7762
7763 Exchanged_Views := New_Elmt_List;
7764 Hidden_Entities := New_Elmt_List;
7765
7766 -- Make dummy entry for Instantiated parent. If generic unit is legal,
7767 -- this is set properly in Set_Instance_Env.
7768
7769 Current_Instantiated_Parent :=
7770 (Current_Scope, Current_Scope, Assoc_Null);
7771 end Init_Env;
7772
7773 ------------------------------
7774 -- In_Same_Declarative_Part --
7775 ------------------------------
7776
7777 function In_Same_Declarative_Part
7778 (F_Node : Node_Id;
7779 Inst : Node_Id) return Boolean
7780 is
7781 Decls : constant Node_Id := Parent (F_Node);
7782 Nod : Node_Id := Parent (Inst);
7783
7784 begin
7785 while Present (Nod) loop
7786 if Nod = Decls then
7787 return True;
7788
7789 elsif Nkind_In (Nod, N_Subprogram_Body,
7790 N_Package_Body,
7791 N_Package_Declaration,
7792 N_Task_Body,
7793 N_Protected_Body,
7794 N_Block_Statement)
7795 then
7796 return False;
7797
7798 elsif Nkind (Nod) = N_Subunit then
7799 Nod := Corresponding_Stub (Nod);
7800
7801 elsif Nkind (Nod) = N_Compilation_Unit then
7802 return False;
7803
7804 else
7805 Nod := Parent (Nod);
7806 end if;
7807 end loop;
7808
7809 return False;
7810 end In_Same_Declarative_Part;
7811
7812 ---------------------
7813 -- In_Main_Context --
7814 ---------------------
7815
7816 function In_Main_Context (E : Entity_Id) return Boolean is
7817 Context : List_Id;
7818 Clause : Node_Id;
7819 Nam : Node_Id;
7820
7821 begin
7822 if not Is_Compilation_Unit (E)
7823 or else Ekind (E) /= E_Package
7824 or else In_Private_Part (E)
7825 then
7826 return False;
7827 end if;
7828
7829 Context := Context_Items (Cunit (Main_Unit));
7830
7831 Clause := First (Context);
7832 while Present (Clause) loop
7833 if Nkind (Clause) = N_With_Clause then
7834 Nam := Name (Clause);
7835
7836 -- If the current scope is part of the context of the main unit,
7837 -- analysis of the corresponding with_clause is not complete, and
7838 -- the entity is not set. We use the Chars field directly, which
7839 -- might produce false positives in rare cases, but guarantees
7840 -- that we produce all the instance bodies we will need.
7841
7842 if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
7843 or else (Nkind (Nam) = N_Selected_Component
7844 and then Chars (Selector_Name (Nam)) = Chars (E))
7845 then
7846 return True;
7847 end if;
7848 end if;
7849
7850 Next (Clause);
7851 end loop;
7852
7853 return False;
7854 end In_Main_Context;
7855
7856 ---------------------
7857 -- Inherit_Context --
7858 ---------------------
7859
7860 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
7861 Current_Context : List_Id;
7862 Current_Unit : Node_Id;
7863 Item : Node_Id;
7864 New_I : Node_Id;
7865
7866 Clause : Node_Id;
7867 OK : Boolean;
7868 Lib_Unit : Node_Id;
7869
7870 begin
7871 if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
7872
7873 -- The inherited context is attached to the enclosing compilation
7874 -- unit. This is either the main unit, or the declaration for the
7875 -- main unit (in case the instantiation appears within the package
7876 -- declaration and the main unit is its body).
7877
7878 Current_Unit := Parent (Inst);
7879 while Present (Current_Unit)
7880 and then Nkind (Current_Unit) /= N_Compilation_Unit
7881 loop
7882 Current_Unit := Parent (Current_Unit);
7883 end loop;
7884
7885 Current_Context := Context_Items (Current_Unit);
7886
7887 Item := First (Context_Items (Parent (Gen_Decl)));
7888 while Present (Item) loop
7889 if Nkind (Item) = N_With_Clause then
7890 Lib_Unit := Library_Unit (Item);
7891
7892 -- Take care to prevent direct cyclic with's
7893
7894 if Lib_Unit /= Current_Unit then
7895
7896 -- Do not add a unit if it is already in the context
7897
7898 Clause := First (Current_Context);
7899 OK := True;
7900 while Present (Clause) loop
7901 if Nkind (Clause) = N_With_Clause and then
7902 Library_Unit (Clause) = Lib_Unit
7903 then
7904 OK := False;
7905 exit;
7906 end if;
7907
7908 Next (Clause);
7909 end loop;
7910
7911 if OK then
7912 New_I := New_Copy (Item);
7913 Set_Implicit_With (New_I, True);
7914 Set_Implicit_With_From_Instantiation (New_I, True);
7915 Append (New_I, Current_Context);
7916 end if;
7917 end if;
7918 end if;
7919
7920 Next (Item);
7921 end loop;
7922 end if;
7923 end Inherit_Context;
7924
7925 ----------------
7926 -- Initialize --
7927 ----------------
7928
7929 procedure Initialize is
7930 begin
7931 Generic_Renamings.Init;
7932 Instance_Envs.Init;
7933 Generic_Flags.Init;
7934 Generic_Renamings_HTable.Reset;
7935 Circularity_Detected := False;
7936 Exchanged_Views := No_Elist;
7937 Hidden_Entities := No_Elist;
7938 end Initialize;
7939
7940 -------------------------------------
7941 -- Insert_Freeze_Node_For_Instance --
7942 -------------------------------------
7943
7944 procedure Insert_Freeze_Node_For_Instance
7945 (N : Node_Id;
7946 F_Node : Node_Id)
7947 is
7948 Decl : Node_Id;
7949 Decls : List_Id;
7950 Inst : Entity_Id;
7951 Par_N : Node_Id;
7952
7953 function Enclosing_Body (N : Node_Id) return Node_Id;
7954 -- Find enclosing package or subprogram body, if any. Freeze node may
7955 -- be placed at end of current declarative list if previous instance
7956 -- and current one have different enclosing bodies.
7957
7958 function Previous_Instance (Gen : Entity_Id) return Entity_Id;
7959 -- Find the local instance, if any, that declares the generic that is
7960 -- being instantiated. If present, the freeze node for this instance
7961 -- must follow the freeze node for the previous instance.
7962
7963 --------------------
7964 -- Enclosing_Body --
7965 --------------------
7966
7967 function Enclosing_Body (N : Node_Id) return Node_Id is
7968 P : Node_Id;
7969
7970 begin
7971 P := Parent (N);
7972 while Present (P)
7973 and then Nkind (Parent (P)) /= N_Compilation_Unit
7974 loop
7975 if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
7976 if Nkind (Parent (P)) = N_Subunit then
7977 return Corresponding_Stub (Parent (P));
7978 else
7979 return P;
7980 end if;
7981 end if;
7982
7983 P := True_Parent (P);
7984 end loop;
7985
7986 return Empty;
7987 end Enclosing_Body;
7988
7989 -----------------------
7990 -- Previous_Instance --
7991 -----------------------
7992
7993 function Previous_Instance (Gen : Entity_Id) return Entity_Id is
7994 S : Entity_Id;
7995
7996 begin
7997 S := Scope (Gen);
7998 while Present (S)
7999 and then S /= Standard_Standard
8000 loop
8001 if Is_Generic_Instance (S)
8002 and then In_Same_Source_Unit (S, N)
8003 then
8004 return S;
8005 end if;
8006
8007 S := Scope (S);
8008 end loop;
8009
8010 return Empty;
8011 end Previous_Instance;
8012
8013 -- Start of processing for Insert_Freeze_Node_For_Instance
8014
8015 begin
8016 if not Is_List_Member (F_Node) then
8017 Decl := N;
8018 Decls := List_Containing (N);
8019 Inst := Entity (F_Node);
8020 Par_N := Parent (Decls);
8021
8022 -- When processing a subprogram instantiation, utilize the actual
8023 -- subprogram instantiation rather than its package wrapper as it
8024 -- carries all the context information.
8025
8026 if Is_Wrapper_Package (Inst) then
8027 Inst := Related_Instance (Inst);
8028 end if;
8029
8030 -- If this is a package instance, check whether the generic is
8031 -- declared in a previous instance and the current instance is
8032 -- not within the previous one.
8033
8034 if Present (Generic_Parent (Parent (Inst)))
8035 and then Is_In_Main_Unit (N)
8036 then
8037 declare
8038 Enclosing_N : constant Node_Id := Enclosing_Body (N);
8039 Par_I : constant Entity_Id :=
8040 Previous_Instance
8041 (Generic_Parent (Parent (Inst)));
8042 Scop : Entity_Id;
8043
8044 begin
8045 if Present (Par_I)
8046 and then Earlier (N, Freeze_Node (Par_I))
8047 then
8048 Scop := Scope (Inst);
8049
8050 -- If the current instance is within the one that contains
8051 -- the generic, the freeze node for the current one must
8052 -- appear in the current declarative part. Ditto, if the
8053 -- current instance is within another package instance or
8054 -- within a body that does not enclose the current instance.
8055 -- In these three cases the freeze node of the previous
8056 -- instance is not relevant.
8057
8058 while Present (Scop)
8059 and then Scop /= Standard_Standard
8060 loop
8061 exit when Scop = Par_I
8062 or else
8063 (Is_Generic_Instance (Scop)
8064 and then Scope_Depth (Scop) > Scope_Depth (Par_I));
8065 Scop := Scope (Scop);
8066 end loop;
8067
8068 -- Previous instance encloses current instance
8069
8070 if Scop = Par_I then
8071 null;
8072
8073 -- If the next node is a source body we must freeze in
8074 -- the current scope as well.
8075
8076 elsif Present (Next (N))
8077 and then Nkind_In (Next (N),
8078 N_Subprogram_Body, N_Package_Body)
8079 and then Comes_From_Source (Next (N))
8080 then
8081 null;
8082
8083 -- Current instance is within an unrelated instance
8084
8085 elsif Is_Generic_Instance (Scop) then
8086 null;
8087
8088 -- Current instance is within an unrelated body
8089
8090 elsif Present (Enclosing_N)
8091 and then Enclosing_N /= Enclosing_Body (Par_I)
8092 then
8093 null;
8094
8095 else
8096 Insert_After (Freeze_Node (Par_I), F_Node);
8097 return;
8098 end if;
8099 end if;
8100 end;
8101 end if;
8102
8103 -- When the instantiation occurs in a package declaration, append the
8104 -- freeze node to the private declarations (if any).
8105
8106 if Nkind (Par_N) = N_Package_Specification
8107 and then Decls = Visible_Declarations (Par_N)
8108 and then Present (Private_Declarations (Par_N))
8109 and then not Is_Empty_List (Private_Declarations (Par_N))
8110 then
8111 Decls := Private_Declarations (Par_N);
8112 Decl := First (Decls);
8113 end if;
8114
8115 -- Determine the proper freeze point of a package instantiation. We
8116 -- adhere to the general rule of a package or subprogram body causing
8117 -- freezing of anything before it in the same declarative region. In
8118 -- this case, the proper freeze point of a package instantiation is
8119 -- before the first source body which follows, or before a stub. This
8120 -- ensures that entities coming from the instance are already frozen
8121 -- and usable in source bodies.
8122
8123 if Nkind (Par_N) /= N_Package_Declaration
8124 and then Ekind (Inst) = E_Package
8125 and then Is_Generic_Instance (Inst)
8126 and then
8127 not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
8128 then
8129 while Present (Decl) loop
8130 if (Nkind (Decl) in N_Unit_Body
8131 or else
8132 Nkind (Decl) in N_Body_Stub)
8133 and then Comes_From_Source (Decl)
8134 then
8135 Insert_Before (Decl, F_Node);
8136 return;
8137 end if;
8138
8139 Next (Decl);
8140 end loop;
8141 end if;
8142
8143 -- In a package declaration, or if no previous body, insert at end
8144 -- of list.
8145
8146 Set_Sloc (F_Node, Sloc (Last (Decls)));
8147 Insert_After (Last (Decls), F_Node);
8148 end if;
8149 end Insert_Freeze_Node_For_Instance;
8150
8151 ------------------
8152 -- Install_Body --
8153 ------------------
8154
8155 procedure Install_Body
8156 (Act_Body : Node_Id;
8157 N : Node_Id;
8158 Gen_Body : Node_Id;
8159 Gen_Decl : Node_Id)
8160 is
8161 Act_Id : constant Entity_Id := Corresponding_Spec (Act_Body);
8162 Act_Unit : constant Node_Id := Unit (Cunit (Get_Source_Unit (N)));
8163 Gen_Id : constant Entity_Id := Corresponding_Spec (Gen_Body);
8164 Par : constant Entity_Id := Scope (Gen_Id);
8165 Gen_Unit : constant Node_Id :=
8166 Unit (Cunit (Get_Source_Unit (Gen_Decl)));
8167 Orig_Body : Node_Id := Gen_Body;
8168 F_Node : Node_Id;
8169 Body_Unit : Node_Id;
8170
8171 Must_Delay : Boolean;
8172
8173 function In_Same_Enclosing_Subp return Boolean;
8174 -- Check whether instance and generic body are within same subprogram.
8175
8176 function True_Sloc (N : Node_Id) return Source_Ptr;
8177 -- If the instance is nested inside a generic unit, the Sloc of the
8178 -- instance indicates the place of the original definition, not the
8179 -- point of the current enclosing instance. Pending a better usage of
8180 -- Slocs to indicate instantiation places, we determine the place of
8181 -- origin of a node by finding the maximum sloc of any ancestor node.
8182 -- Why is this not equivalent to Top_Level_Location ???
8183
8184 ----------------------------
8185 -- In_Same_Enclosing_Subp --
8186 ----------------------------
8187
8188 function In_Same_Enclosing_Subp return Boolean is
8189 Scop : Entity_Id;
8190 Subp : Entity_Id;
8191
8192 begin
8193 Scop := Scope (Act_Id);
8194 while Scop /= Standard_Standard
8195 and then not Is_Overloadable (Scop)
8196 loop
8197 Scop := Scope (Scop);
8198 end loop;
8199
8200 if Scop = Standard_Standard then
8201 return False;
8202 else
8203 Subp := Scop;
8204 end if;
8205
8206 Scop := Scope (Gen_Id);
8207 while Scop /= Standard_Standard loop
8208 if Scop = Subp then
8209 return True;
8210 else
8211 Scop := Scope (Scop);
8212 end if;
8213 end loop;
8214
8215 return False;
8216 end In_Same_Enclosing_Subp;
8217
8218 ---------------
8219 -- True_Sloc --
8220 ---------------
8221
8222 function True_Sloc (N : Node_Id) return Source_Ptr is
8223 Res : Source_Ptr;
8224 N1 : Node_Id;
8225
8226 begin
8227 Res := Sloc (N);
8228 N1 := N;
8229 while Present (N1) and then N1 /= Act_Unit loop
8230 if Sloc (N1) > Res then
8231 Res := Sloc (N1);
8232 end if;
8233
8234 N1 := Parent (N1);
8235 end loop;
8236
8237 return Res;
8238 end True_Sloc;
8239
8240 -- Start of processing for Install_Body
8241
8242 begin
8243 -- If the body is a subunit, the freeze point is the corresponding stub
8244 -- in the current compilation, not the subunit itself.
8245
8246 if Nkind (Parent (Gen_Body)) = N_Subunit then
8247 Orig_Body := Corresponding_Stub (Parent (Gen_Body));
8248 else
8249 Orig_Body := Gen_Body;
8250 end if;
8251
8252 Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8253
8254 -- If the instantiation and the generic definition appear in the same
8255 -- package declaration, this is an early instantiation. If they appear
8256 -- in the same declarative part, it is an early instantiation only if
8257 -- the generic body appears textually later, and the generic body is
8258 -- also in the main unit.
8259
8260 -- If instance is nested within a subprogram, and the generic body
8261 -- is not, the instance is delayed because the enclosing body is. If
8262 -- instance and body are within the same scope, or the same subprogram
8263 -- body, indicate explicitly that the instance is delayed.
8264
8265 Must_Delay :=
8266 (Gen_Unit = Act_Unit
8267 and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8268 N_Generic_Package_Declaration)
8269 or else (Gen_Unit = Body_Unit
8270 and then True_Sloc (N) < Sloc (Orig_Body)))
8271 and then Is_In_Main_Unit (Gen_Unit)
8272 and then (Scope (Act_Id) = Scope (Gen_Id)
8273 or else In_Same_Enclosing_Subp));
8274
8275 -- If this is an early instantiation, the freeze node is placed after
8276 -- the generic body. Otherwise, if the generic appears in an instance,
8277 -- we cannot freeze the current instance until the outer one is frozen.
8278 -- This is only relevant if the current instance is nested within some
8279 -- inner scope not itself within the outer instance. If this scope is
8280 -- a package body in the same declarative part as the outer instance,
8281 -- then that body needs to be frozen after the outer instance. Finally,
8282 -- if no delay is needed, we place the freeze node at the end of the
8283 -- current declarative part.
8284
8285 if Expander_Active then
8286 Ensure_Freeze_Node (Act_Id);
8287 F_Node := Freeze_Node (Act_Id);
8288
8289 if Must_Delay then
8290 Insert_After (Orig_Body, F_Node);
8291
8292 elsif Is_Generic_Instance (Par)
8293 and then Present (Freeze_Node (Par))
8294 and then Scope (Act_Id) /= Par
8295 then
8296 -- Freeze instance of inner generic after instance of enclosing
8297 -- generic.
8298
8299 if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8300
8301 -- Handle the following case:
8302
8303 -- package Parent_Inst is new ...
8304 -- Parent_Inst []
8305
8306 -- procedure P ... -- this body freezes Parent_Inst
8307
8308 -- package Inst is new ...
8309
8310 -- In this particular scenario, the freeze node for Inst must
8311 -- be inserted in the same manner as that of Parent_Inst,
8312 -- before the next source body or at the end of the declarative
8313 -- list (body not available). If body P did not exist and
8314 -- Parent_Inst was frozen after Inst, either by a body
8315 -- following Inst or at the end of the declarative region,
8316 -- the freeze node for Inst must be inserted after that of
8317 -- Parent_Inst. This relation is established by comparing
8318 -- the Slocs of Parent_Inst freeze node and Inst.
8319
8320 if List_Containing (Get_Package_Instantiation_Node (Par)) =
8321 List_Containing (N)
8322 and then Sloc (Freeze_Node (Par)) < Sloc (N)
8323 then
8324 Insert_Freeze_Node_For_Instance (N, F_Node);
8325 else
8326 Insert_After (Freeze_Node (Par), F_Node);
8327 end if;
8328
8329 -- Freeze package enclosing instance of inner generic after
8330 -- instance of enclosing generic.
8331
8332 elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8333 and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8334 then
8335 declare
8336 Enclosing : Entity_Id;
8337
8338 begin
8339 Enclosing := Corresponding_Spec (Parent (N));
8340
8341 if No (Enclosing) then
8342 Enclosing := Defining_Entity (Parent (N));
8343 end if;
8344
8345 Insert_Freeze_Node_For_Instance (N, F_Node);
8346 Ensure_Freeze_Node (Enclosing);
8347
8348 if not Is_List_Member (Freeze_Node (Enclosing)) then
8349
8350 -- The enclosing context is a subunit, insert the freeze
8351 -- node after the stub.
8352
8353 if Nkind (Parent (Parent (N))) = N_Subunit then
8354 Insert_Freeze_Node_For_Instance
8355 (Corresponding_Stub (Parent (Parent (N))),
8356 Freeze_Node (Enclosing));
8357
8358 -- The enclosing context is a package with a stub body
8359 -- which has already been replaced by the real body.
8360 -- Insert the freeze node after the actual body.
8361
8362 elsif Ekind (Enclosing) = E_Package
8363 and then Present (Body_Entity (Enclosing))
8364 and then Was_Originally_Stub
8365 (Parent (Body_Entity (Enclosing)))
8366 then
8367 Insert_Freeze_Node_For_Instance
8368 (Parent (Body_Entity (Enclosing)),
8369 Freeze_Node (Enclosing));
8370
8371 -- The parent instance has been frozen before the body of
8372 -- the enclosing package, insert the freeze node after
8373 -- the body.
8374
8375 elsif List_Containing (Freeze_Node (Par)) =
8376 List_Containing (Parent (N))
8377 and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8378 then
8379 Insert_Freeze_Node_For_Instance
8380 (Parent (N), Freeze_Node (Enclosing));
8381
8382 else
8383 Insert_After
8384 (Freeze_Node (Par), Freeze_Node (Enclosing));
8385 end if;
8386 end if;
8387 end;
8388
8389 else
8390 Insert_Freeze_Node_For_Instance (N, F_Node);
8391 end if;
8392
8393 else
8394 Insert_Freeze_Node_For_Instance (N, F_Node);
8395 end if;
8396 end if;
8397
8398 Set_Is_Frozen (Act_Id);
8399 Insert_Before (N, Act_Body);
8400 Mark_Rewrite_Insertion (Act_Body);
8401 end Install_Body;
8402
8403 -----------------------------
8404 -- Install_Formal_Packages --
8405 -----------------------------
8406
8407 procedure Install_Formal_Packages (Par : Entity_Id) is
8408 E : Entity_Id;
8409 Gen : Entity_Id;
8410 Gen_E : Entity_Id := Empty;
8411
8412 begin
8413 E := First_Entity (Par);
8414
8415 -- If we are installing an instance parent, locate the formal packages
8416 -- of its generic parent.
8417
8418 if Is_Generic_Instance (Par) then
8419 Gen := Generic_Parent (Package_Specification (Par));
8420 Gen_E := First_Entity (Gen);
8421 end if;
8422
8423 while Present (E) loop
8424 if Ekind (E) = E_Package
8425 and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8426 then
8427 -- If this is the renaming for the parent instance, done
8428
8429 if Renamed_Object (E) = Par then
8430 exit;
8431
8432 -- The visibility of a formal of an enclosing generic is already
8433 -- correct.
8434
8435 elsif Denotes_Formal_Package (E) then
8436 null;
8437
8438 elsif Present (Associated_Formal_Package (E)) then
8439 Check_Generic_Actuals (Renamed_Object (E), True);
8440 Set_Is_Hidden (E, False);
8441
8442 -- Find formal package in generic unit that corresponds to
8443 -- (instance of) formal package in instance.
8444
8445 while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8446 Next_Entity (Gen_E);
8447 end loop;
8448
8449 if Present (Gen_E) then
8450 Map_Formal_Package_Entities (Gen_E, E);
8451 end if;
8452 end if;
8453 end if;
8454
8455 Next_Entity (E);
8456 if Present (Gen_E) then
8457 Next_Entity (Gen_E);
8458 end if;
8459 end loop;
8460 end Install_Formal_Packages;
8461
8462 --------------------
8463 -- Install_Parent --
8464 --------------------
8465
8466 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8467 Ancestors : constant Elist_Id := New_Elmt_List;
8468 S : constant Entity_Id := Current_Scope;
8469 Inst_Par : Entity_Id;
8470 First_Par : Entity_Id;
8471 Inst_Node : Node_Id;
8472 Gen_Par : Entity_Id;
8473 First_Gen : Entity_Id;
8474 Elmt : Elmt_Id;
8475
8476 procedure Install_Noninstance_Specs (Par : Entity_Id);
8477 -- Install the scopes of noninstance parent units ending with Par
8478
8479 procedure Install_Spec (Par : Entity_Id);
8480 -- The child unit is within the declarative part of the parent, so the
8481 -- declarations within the parent are immediately visible.
8482
8483 -------------------------------
8484 -- Install_Noninstance_Specs --
8485 -------------------------------
8486
8487 procedure Install_Noninstance_Specs (Par : Entity_Id) is
8488 begin
8489 if Present (Par)
8490 and then Par /= Standard_Standard
8491 and then not In_Open_Scopes (Par)
8492 then
8493 Install_Noninstance_Specs (Scope (Par));
8494 Install_Spec (Par);
8495 end if;
8496 end Install_Noninstance_Specs;
8497
8498 ------------------
8499 -- Install_Spec --
8500 ------------------
8501
8502 procedure Install_Spec (Par : Entity_Id) is
8503 Spec : constant Node_Id := Package_Specification (Par);
8504
8505 begin
8506 -- If this parent of the child instance is a top-level unit,
8507 -- then record the unit and its visibility for later resetting in
8508 -- Remove_Parent. We exclude units that are generic instances, as we
8509 -- only want to record this information for the ultimate top-level
8510 -- noninstance parent (is that always correct???).
8511
8512 if Scope (Par) = Standard_Standard
8513 and then not Is_Generic_Instance (Par)
8514 then
8515 Parent_Unit_Visible := Is_Immediately_Visible (Par);
8516 Instance_Parent_Unit := Par;
8517 end if;
8518
8519 -- Open the parent scope and make it and its declarations visible.
8520 -- If this point is not within a body, then only the visible
8521 -- declarations should be made visible, and installation of the
8522 -- private declarations is deferred until the appropriate point
8523 -- within analysis of the spec being instantiated (see the handling
8524 -- of parent visibility in Analyze_Package_Specification). This is
8525 -- relaxed in the case where the parent unit is Ada.Tags, to avoid
8526 -- private view problems that occur when compiling instantiations of
8527 -- a generic child of that package (Generic_Dispatching_Constructor).
8528 -- If the instance freezes a tagged type, inlinings of operations
8529 -- from Ada.Tags may need the full view of type Tag. If inlining took
8530 -- proper account of establishing visibility of inlined subprograms'
8531 -- parents then it should be possible to remove this
8532 -- special check. ???
8533
8534 Push_Scope (Par);
8535 Set_Is_Immediately_Visible (Par);
8536 Install_Visible_Declarations (Par);
8537 Set_Use (Visible_Declarations (Spec));
8538
8539 if In_Body or else Is_RTU (Par, Ada_Tags) then
8540 Install_Private_Declarations (Par);
8541 Set_Use (Private_Declarations (Spec));
8542 end if;
8543 end Install_Spec;
8544
8545 -- Start of processing for Install_Parent
8546
8547 begin
8548 -- We need to install the parent instance to compile the instantiation
8549 -- of the child, but the child instance must appear in the current
8550 -- scope. Given that we cannot place the parent above the current scope
8551 -- in the scope stack, we duplicate the current scope and unstack both
8552 -- after the instantiation is complete.
8553
8554 -- If the parent is itself the instantiation of a child unit, we must
8555 -- also stack the instantiation of its parent, and so on. Each such
8556 -- ancestor is the prefix of the name in a prior instantiation.
8557
8558 -- If this is a nested instance, the parent unit itself resolves to
8559 -- a renaming of the parent instance, whose declaration we need.
8560
8561 -- Finally, the parent may be a generic (not an instance) when the
8562 -- child unit appears as a formal package.
8563
8564 Inst_Par := P;
8565
8566 if Present (Renamed_Entity (Inst_Par)) then
8567 Inst_Par := Renamed_Entity (Inst_Par);
8568 end if;
8569
8570 First_Par := Inst_Par;
8571
8572 Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
8573
8574 First_Gen := Gen_Par;
8575
8576 while Present (Gen_Par)
8577 and then Is_Child_Unit (Gen_Par)
8578 loop
8579 -- Load grandparent instance as well
8580
8581 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
8582
8583 if Nkind (Name (Inst_Node)) = N_Expanded_Name then
8584 Inst_Par := Entity (Prefix (Name (Inst_Node)));
8585
8586 if Present (Renamed_Entity (Inst_Par)) then
8587 Inst_Par := Renamed_Entity (Inst_Par);
8588 end if;
8589
8590 Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
8591
8592 if Present (Gen_Par) then
8593 Prepend_Elmt (Inst_Par, Ancestors);
8594
8595 else
8596 -- Parent is not the name of an instantiation
8597
8598 Install_Noninstance_Specs (Inst_Par);
8599 exit;
8600 end if;
8601
8602 else
8603 -- Previous error
8604
8605 exit;
8606 end if;
8607 end loop;
8608
8609 if Present (First_Gen) then
8610 Append_Elmt (First_Par, Ancestors);
8611 else
8612 Install_Noninstance_Specs (First_Par);
8613 end if;
8614
8615 if not Is_Empty_Elmt_List (Ancestors) then
8616 Elmt := First_Elmt (Ancestors);
8617 while Present (Elmt) loop
8618 Install_Spec (Node (Elmt));
8619 Install_Formal_Packages (Node (Elmt));
8620 Next_Elmt (Elmt);
8621 end loop;
8622 end if;
8623
8624 if not In_Body then
8625 Push_Scope (S);
8626 end if;
8627 end Install_Parent;
8628
8629 -------------------------------
8630 -- Install_Hidden_Primitives --
8631 -------------------------------
8632
8633 procedure Install_Hidden_Primitives
8634 (Prims_List : in out Elist_Id;
8635 Gen_T : Entity_Id;
8636 Act_T : Entity_Id)
8637 is
8638 Elmt : Elmt_Id;
8639 List : Elist_Id := No_Elist;
8640 Prim_G_Elmt : Elmt_Id;
8641 Prim_A_Elmt : Elmt_Id;
8642 Prim_G : Node_Id;
8643 Prim_A : Node_Id;
8644
8645 begin
8646 -- No action needed in case of serious errors because we cannot trust
8647 -- in the order of primitives
8648
8649 if Serious_Errors_Detected > 0 then
8650 return;
8651
8652 -- No action possible if we don't have available the list of primitive
8653 -- operations
8654
8655 elsif No (Gen_T)
8656 or else not Is_Record_Type (Gen_T)
8657 or else not Is_Tagged_Type (Gen_T)
8658 or else not Is_Record_Type (Act_T)
8659 or else not Is_Tagged_Type (Act_T)
8660 then
8661 return;
8662
8663 -- There is no need to handle interface types since their primitives
8664 -- cannot be hidden
8665
8666 elsif Is_Interface (Gen_T) then
8667 return;
8668 end if;
8669
8670 Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
8671
8672 if not Is_Class_Wide_Type (Act_T) then
8673 Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
8674 else
8675 Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
8676 end if;
8677
8678 loop
8679 -- Skip predefined primitives in the generic formal
8680
8681 while Present (Prim_G_Elmt)
8682 and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
8683 loop
8684 Next_Elmt (Prim_G_Elmt);
8685 end loop;
8686
8687 -- Skip predefined primitives in the generic actual
8688
8689 while Present (Prim_A_Elmt)
8690 and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
8691 loop
8692 Next_Elmt (Prim_A_Elmt);
8693 end loop;
8694
8695 exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
8696
8697 Prim_G := Node (Prim_G_Elmt);
8698 Prim_A := Node (Prim_A_Elmt);
8699
8700 -- There is no need to handle interface primitives because their
8701 -- primitives are not hidden
8702
8703 exit when Present (Interface_Alias (Prim_G));
8704
8705 -- Here we install one hidden primitive
8706
8707 if Chars (Prim_G) /= Chars (Prim_A)
8708 and then Has_Suffix (Prim_A, 'P')
8709 and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
8710 then
8711 Set_Chars (Prim_A, Chars (Prim_G));
8712
8713 if List = No_Elist then
8714 List := New_Elmt_List;
8715 end if;
8716
8717 Append_Elmt (Prim_A, List);
8718 end if;
8719
8720 Next_Elmt (Prim_A_Elmt);
8721 Next_Elmt (Prim_G_Elmt);
8722 end loop;
8723
8724 -- Append the elements to the list of temporarily visible primitives
8725 -- avoiding duplicates.
8726
8727 if Present (List) then
8728 if No (Prims_List) then
8729 Prims_List := New_Elmt_List;
8730 end if;
8731
8732 Elmt := First_Elmt (List);
8733 while Present (Elmt) loop
8734 Append_Unique_Elmt (Node (Elmt), Prims_List);
8735 Next_Elmt (Elmt);
8736 end loop;
8737 end if;
8738 end Install_Hidden_Primitives;
8739
8740 -------------------------------
8741 -- Restore_Hidden_Primitives --
8742 -------------------------------
8743
8744 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
8745 Prim_Elmt : Elmt_Id;
8746 Prim : Node_Id;
8747
8748 begin
8749 if Prims_List /= No_Elist then
8750 Prim_Elmt := First_Elmt (Prims_List);
8751 while Present (Prim_Elmt) loop
8752 Prim := Node (Prim_Elmt);
8753 Set_Chars (Prim, Add_Suffix (Prim, 'P'));
8754 Next_Elmt (Prim_Elmt);
8755 end loop;
8756
8757 Prims_List := No_Elist;
8758 end if;
8759 end Restore_Hidden_Primitives;
8760
8761 --------------------------------
8762 -- Instantiate_Formal_Package --
8763 --------------------------------
8764
8765 function Instantiate_Formal_Package
8766 (Formal : Node_Id;
8767 Actual : Node_Id;
8768 Analyzed_Formal : Node_Id) return List_Id
8769 is
8770 Loc : constant Source_Ptr := Sloc (Actual);
8771 Actual_Pack : Entity_Id;
8772 Formal_Pack : Entity_Id;
8773 Gen_Parent : Entity_Id;
8774 Decls : List_Id;
8775 Nod : Node_Id;
8776 Parent_Spec : Node_Id;
8777
8778 procedure Find_Matching_Actual
8779 (F : Node_Id;
8780 Act : in out Entity_Id);
8781 -- We need to associate each formal entity in the formal package with
8782 -- the corresponding entity in the actual package. The actual package
8783 -- has been analyzed and possibly expanded, and as a result there is
8784 -- no one-to-one correspondence between the two lists (for example,
8785 -- the actual may include subtypes, itypes, and inherited primitive
8786 -- operations, interspersed among the renaming declarations for the
8787 -- actuals) . We retrieve the corresponding actual by name because each
8788 -- actual has the same name as the formal, and they do appear in the
8789 -- same order.
8790
8791 function Get_Formal_Entity (N : Node_Id) return Entity_Id;
8792 -- Retrieve entity of defining entity of generic formal parameter.
8793 -- Only the declarations of formals need to be considered when
8794 -- linking them to actuals, but the declarative list may include
8795 -- internal entities generated during analysis, and those are ignored.
8796
8797 procedure Match_Formal_Entity
8798 (Formal_Node : Node_Id;
8799 Formal_Ent : Entity_Id;
8800 Actual_Ent : Entity_Id);
8801 -- Associates the formal entity with the actual. In the case where
8802 -- Formal_Ent is a formal package, this procedure iterates through all
8803 -- of its formals and enters associations between the actuals occurring
8804 -- in the formal package's corresponding actual package (given by
8805 -- Actual_Ent) and the formal package's formal parameters. This
8806 -- procedure recurses if any of the parameters is itself a package.
8807
8808 function Is_Instance_Of
8809 (Act_Spec : Entity_Id;
8810 Gen_Anc : Entity_Id) return Boolean;
8811 -- The actual can be an instantiation of a generic within another
8812 -- instance, in which case there is no direct link from it to the
8813 -- original generic ancestor. In that case, we recognize that the
8814 -- ultimate ancestor is the same by examining names and scopes.
8815
8816 procedure Process_Nested_Formal (Formal : Entity_Id);
8817 -- If the current formal is declared with a box, its own formals are
8818 -- visible in the instance, as they were in the generic, and their
8819 -- Hidden flag must be reset. If some of these formals are themselves
8820 -- packages declared with a box, the processing must be recursive.
8821
8822 --------------------------
8823 -- Find_Matching_Actual --
8824 --------------------------
8825
8826 procedure Find_Matching_Actual
8827 (F : Node_Id;
8828 Act : in out Entity_Id)
8829 is
8830 Formal_Ent : Entity_Id;
8831
8832 begin
8833 case Nkind (Original_Node (F)) is
8834 when N_Formal_Object_Declaration |
8835 N_Formal_Type_Declaration =>
8836 Formal_Ent := Defining_Identifier (F);
8837
8838 while Chars (Act) /= Chars (Formal_Ent) loop
8839 Next_Entity (Act);
8840 end loop;
8841
8842 when N_Formal_Subprogram_Declaration |
8843 N_Formal_Package_Declaration |
8844 N_Package_Declaration |
8845 N_Generic_Package_Declaration =>
8846 Formal_Ent := Defining_Entity (F);
8847
8848 while Chars (Act) /= Chars (Formal_Ent) loop
8849 Next_Entity (Act);
8850 end loop;
8851
8852 when others =>
8853 raise Program_Error;
8854 end case;
8855 end Find_Matching_Actual;
8856
8857 -------------------------
8858 -- Match_Formal_Entity --
8859 -------------------------
8860
8861 procedure Match_Formal_Entity
8862 (Formal_Node : Node_Id;
8863 Formal_Ent : Entity_Id;
8864 Actual_Ent : Entity_Id)
8865 is
8866 Act_Pkg : Entity_Id;
8867
8868 begin
8869 Set_Instance_Of (Formal_Ent, Actual_Ent);
8870
8871 if Ekind (Actual_Ent) = E_Package then
8872
8873 -- Record associations for each parameter
8874
8875 Act_Pkg := Actual_Ent;
8876
8877 declare
8878 A_Ent : Entity_Id := First_Entity (Act_Pkg);
8879 F_Ent : Entity_Id;
8880 F_Node : Node_Id;
8881
8882 Gen_Decl : Node_Id;
8883 Formals : List_Id;
8884 Actual : Entity_Id;
8885
8886 begin
8887 -- Retrieve the actual given in the formal package declaration
8888
8889 Actual := Entity (Name (Original_Node (Formal_Node)));
8890
8891 -- The actual in the formal package declaration may be a
8892 -- renamed generic package, in which case we want to retrieve
8893 -- the original generic in order to traverse its formal part.
8894
8895 if Present (Renamed_Entity (Actual)) then
8896 Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
8897 else
8898 Gen_Decl := Unit_Declaration_Node (Actual);
8899 end if;
8900
8901 Formals := Generic_Formal_Declarations (Gen_Decl);
8902
8903 if Present (Formals) then
8904 F_Node := First_Non_Pragma (Formals);
8905 else
8906 F_Node := Empty;
8907 end if;
8908
8909 while Present (A_Ent)
8910 and then Present (F_Node)
8911 and then A_Ent /= First_Private_Entity (Act_Pkg)
8912 loop
8913 F_Ent := Get_Formal_Entity (F_Node);
8914
8915 if Present (F_Ent) then
8916
8917 -- This is a formal of the original package. Record
8918 -- association and recurse.
8919
8920 Find_Matching_Actual (F_Node, A_Ent);
8921 Match_Formal_Entity (F_Node, F_Ent, A_Ent);
8922 Next_Entity (A_Ent);
8923 end if;
8924
8925 Next_Non_Pragma (F_Node);
8926 end loop;
8927 end;
8928 end if;
8929 end Match_Formal_Entity;
8930
8931 -----------------------
8932 -- Get_Formal_Entity --
8933 -----------------------
8934
8935 function Get_Formal_Entity (N : Node_Id) return Entity_Id is
8936 Kind : constant Node_Kind := Nkind (Original_Node (N));
8937 begin
8938 case Kind is
8939 when N_Formal_Object_Declaration =>
8940 return Defining_Identifier (N);
8941
8942 when N_Formal_Type_Declaration =>
8943 return Defining_Identifier (N);
8944
8945 when N_Formal_Subprogram_Declaration =>
8946 return Defining_Unit_Name (Specification (N));
8947
8948 when N_Formal_Package_Declaration =>
8949 return Defining_Identifier (Original_Node (N));
8950
8951 when N_Generic_Package_Declaration =>
8952 return Defining_Identifier (Original_Node (N));
8953
8954 -- All other declarations are introduced by semantic analysis and
8955 -- have no match in the actual.
8956
8957 when others =>
8958 return Empty;
8959 end case;
8960 end Get_Formal_Entity;
8961
8962 --------------------
8963 -- Is_Instance_Of --
8964 --------------------
8965
8966 function Is_Instance_Of
8967 (Act_Spec : Entity_Id;
8968 Gen_Anc : Entity_Id) return Boolean
8969 is
8970 Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
8971
8972 begin
8973 if No (Gen_Par) then
8974 return False;
8975
8976 -- Simplest case: the generic parent of the actual is the formal
8977
8978 elsif Gen_Par = Gen_Anc then
8979 return True;
8980
8981 elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
8982 return False;
8983
8984 -- The actual may be obtained through several instantiations. Its
8985 -- scope must itself be an instance of a generic declared in the
8986 -- same scope as the formal. Any other case is detected above.
8987
8988 elsif not Is_Generic_Instance (Scope (Gen_Par)) then
8989 return False;
8990
8991 else
8992 return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
8993 end if;
8994 end Is_Instance_Of;
8995
8996 ---------------------------
8997 -- Process_Nested_Formal --
8998 ---------------------------
8999
9000 procedure Process_Nested_Formal (Formal : Entity_Id) is
9001 Ent : Entity_Id;
9002
9003 begin
9004 if Present (Associated_Formal_Package (Formal))
9005 and then Box_Present (Parent (Associated_Formal_Package (Formal)))
9006 then
9007 Ent := First_Entity (Formal);
9008 while Present (Ent) loop
9009 Set_Is_Hidden (Ent, False);
9010 Set_Is_Visible_Formal (Ent);
9011 Set_Is_Potentially_Use_Visible
9012 (Ent, Is_Potentially_Use_Visible (Formal));
9013
9014 if Ekind (Ent) = E_Package then
9015 exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
9016 Process_Nested_Formal (Ent);
9017 end if;
9018
9019 Next_Entity (Ent);
9020 end loop;
9021 end if;
9022 end Process_Nested_Formal;
9023
9024 -- Start of processing for Instantiate_Formal_Package
9025
9026 begin
9027 Analyze (Actual);
9028
9029 if not Is_Entity_Name (Actual)
9030 or else Ekind (Entity (Actual)) /= E_Package
9031 then
9032 Error_Msg_N
9033 ("expect package instance to instantiate formal", Actual);
9034 Abandon_Instantiation (Actual);
9035 raise Program_Error;
9036
9037 else
9038 Actual_Pack := Entity (Actual);
9039 Set_Is_Instantiated (Actual_Pack);
9040
9041 -- The actual may be a renamed package, or an outer generic formal
9042 -- package whose instantiation is converted into a renaming.
9043
9044 if Present (Renamed_Object (Actual_Pack)) then
9045 Actual_Pack := Renamed_Object (Actual_Pack);
9046 end if;
9047
9048 if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
9049 Gen_Parent := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
9050 Formal_Pack := Defining_Identifier (Analyzed_Formal);
9051 else
9052 Gen_Parent :=
9053 Generic_Parent (Specification (Analyzed_Formal));
9054 Formal_Pack :=
9055 Defining_Unit_Name (Specification (Analyzed_Formal));
9056 end if;
9057
9058 if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
9059 Parent_Spec := Package_Specification (Actual_Pack);
9060 else
9061 Parent_Spec := Parent (Actual_Pack);
9062 end if;
9063
9064 if Gen_Parent = Any_Id then
9065 Error_Msg_N
9066 ("previous error in declaration of formal package", Actual);
9067 Abandon_Instantiation (Actual);
9068
9069 elsif
9070 Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
9071 then
9072 null;
9073
9074 else
9075 Error_Msg_NE
9076 ("actual parameter must be instance of&", Actual, Gen_Parent);
9077 Abandon_Instantiation (Actual);
9078 end if;
9079
9080 Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
9081 Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
9082
9083 Nod :=
9084 Make_Package_Renaming_Declaration (Loc,
9085 Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
9086 Name => New_Occurrence_Of (Actual_Pack, Loc));
9087
9088 Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
9089 Defining_Identifier (Formal));
9090 Decls := New_List (Nod);
9091
9092 -- If the formal F has a box, then the generic declarations are
9093 -- visible in the generic G. In an instance of G, the corresponding
9094 -- entities in the actual for F (which are the actuals for the
9095 -- instantiation of the generic that F denotes) must also be made
9096 -- visible for analysis of the current instance. On exit from the
9097 -- current instance, those entities are made private again. If the
9098 -- actual is currently in use, these entities are also use-visible.
9099
9100 -- The loop through the actual entities also steps through the formal
9101 -- entities and enters associations from formals to actuals into the
9102 -- renaming map. This is necessary to properly handle checking of
9103 -- actual parameter associations for later formals that depend on
9104 -- actuals declared in the formal package.
9105
9106 -- In Ada 2005, partial parameterization requires that we make
9107 -- visible the actuals corresponding to formals that were defaulted
9108 -- in the formal package. There formals are identified because they
9109 -- remain formal generics within the formal package, rather than
9110 -- being renamings of the actuals supplied.
9111
9112 declare
9113 Gen_Decl : constant Node_Id :=
9114 Unit_Declaration_Node (Gen_Parent);
9115 Formals : constant List_Id :=
9116 Generic_Formal_Declarations (Gen_Decl);
9117
9118 Actual_Ent : Entity_Id;
9119 Actual_Of_Formal : Node_Id;
9120 Formal_Node : Node_Id;
9121 Formal_Ent : Entity_Id;
9122
9123 begin
9124 if Present (Formals) then
9125 Formal_Node := First_Non_Pragma (Formals);
9126 else
9127 Formal_Node := Empty;
9128 end if;
9129
9130 Actual_Ent := First_Entity (Actual_Pack);
9131 Actual_Of_Formal :=
9132 First (Visible_Declarations (Specification (Analyzed_Formal)));
9133 while Present (Actual_Ent)
9134 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9135 loop
9136 if Present (Formal_Node) then
9137 Formal_Ent := Get_Formal_Entity (Formal_Node);
9138
9139 if Present (Formal_Ent) then
9140 Find_Matching_Actual (Formal_Node, Actual_Ent);
9141 Match_Formal_Entity
9142 (Formal_Node, Formal_Ent, Actual_Ent);
9143
9144 -- We iterate at the same time over the actuals of the
9145 -- local package created for the formal, to determine
9146 -- which one of the formals of the original generic were
9147 -- defaulted in the formal. The corresponding actual
9148 -- entities are visible in the enclosing instance.
9149
9150 if Box_Present (Formal)
9151 or else
9152 (Present (Actual_Of_Formal)
9153 and then
9154 Is_Generic_Formal
9155 (Get_Formal_Entity (Actual_Of_Formal)))
9156 then
9157 Set_Is_Hidden (Actual_Ent, False);
9158 Set_Is_Visible_Formal (Actual_Ent);
9159 Set_Is_Potentially_Use_Visible
9160 (Actual_Ent, In_Use (Actual_Pack));
9161
9162 if Ekind (Actual_Ent) = E_Package then
9163 Process_Nested_Formal (Actual_Ent);
9164 end if;
9165
9166 else
9167 Set_Is_Hidden (Actual_Ent);
9168 Set_Is_Potentially_Use_Visible (Actual_Ent, False);
9169 end if;
9170 end if;
9171
9172 Next_Non_Pragma (Formal_Node);
9173 Next (Actual_Of_Formal);
9174
9175 else
9176 -- No further formals to match, but the generic part may
9177 -- contain inherited operation that are not hidden in the
9178 -- enclosing instance.
9179
9180 Next_Entity (Actual_Ent);
9181 end if;
9182 end loop;
9183
9184 -- Inherited subprograms generated by formal derived types are
9185 -- also visible if the types are.
9186
9187 Actual_Ent := First_Entity (Actual_Pack);
9188 while Present (Actual_Ent)
9189 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9190 loop
9191 if Is_Overloadable (Actual_Ent)
9192 and then
9193 Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
9194 and then
9195 not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
9196 then
9197 Set_Is_Hidden (Actual_Ent, False);
9198 Set_Is_Potentially_Use_Visible
9199 (Actual_Ent, In_Use (Actual_Pack));
9200 end if;
9201
9202 Next_Entity (Actual_Ent);
9203 end loop;
9204 end;
9205
9206 -- If the formal is not declared with a box, reanalyze it as an
9207 -- abbreviated instantiation, to verify the matching rules of 12.7.
9208 -- The actual checks are performed after the generic associations
9209 -- have been analyzed, to guarantee the same visibility for this
9210 -- instantiation and for the actuals.
9211
9212 -- In Ada 2005, the generic associations for the formal can include
9213 -- defaulted parameters. These are ignored during check. This
9214 -- internal instantiation is removed from the tree after conformance
9215 -- checking, because it contains formal declarations for those
9216 -- defaulted parameters, and those should not reach the back-end.
9217
9218 if not Box_Present (Formal) then
9219 declare
9220 I_Pack : constant Entity_Id :=
9221 Make_Temporary (Sloc (Actual), 'P');
9222
9223 begin
9224 Set_Is_Internal (I_Pack);
9225
9226 Append_To (Decls,
9227 Make_Package_Instantiation (Sloc (Actual),
9228 Defining_Unit_Name => I_Pack,
9229 Name =>
9230 New_Occurrence_Of
9231 (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
9232 Generic_Associations =>
9233 Generic_Associations (Formal)));
9234 end;
9235 end if;
9236
9237 return Decls;
9238 end if;
9239 end Instantiate_Formal_Package;
9240
9241 -----------------------------------
9242 -- Instantiate_Formal_Subprogram --
9243 -----------------------------------
9244
9245 function Instantiate_Formal_Subprogram
9246 (Formal : Node_Id;
9247 Actual : Node_Id;
9248 Analyzed_Formal : Node_Id) return Node_Id
9249 is
9250 Loc : Source_Ptr;
9251 Formal_Sub : constant Entity_Id :=
9252 Defining_Unit_Name (Specification (Formal));
9253 Analyzed_S : constant Entity_Id :=
9254 Defining_Unit_Name (Specification (Analyzed_Formal));
9255 Decl_Node : Node_Id;
9256 Nam : Node_Id;
9257 New_Spec : Node_Id;
9258
9259 function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9260 -- If the generic is a child unit, the parent has been installed on the
9261 -- scope stack, but a default subprogram cannot resolve to something
9262 -- on the parent because that parent is not really part of the visible
9263 -- context (it is there to resolve explicit local entities). If the
9264 -- default has resolved in this way, we remove the entity from immediate
9265 -- visibility and analyze the node again to emit an error message or
9266 -- find another visible candidate.
9267
9268 procedure Valid_Actual_Subprogram (Act : Node_Id);
9269 -- Perform legality check and raise exception on failure
9270
9271 -----------------------
9272 -- From_Parent_Scope --
9273 -----------------------
9274
9275 function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9276 Gen_Scope : Node_Id;
9277
9278 begin
9279 Gen_Scope := Scope (Analyzed_S);
9280 while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9281 if Scope (Subp) = Scope (Gen_Scope) then
9282 return True;
9283 end if;
9284
9285 Gen_Scope := Scope (Gen_Scope);
9286 end loop;
9287
9288 return False;
9289 end From_Parent_Scope;
9290
9291 -----------------------------
9292 -- Valid_Actual_Subprogram --
9293 -----------------------------
9294
9295 procedure Valid_Actual_Subprogram (Act : Node_Id) is
9296 Act_E : Entity_Id;
9297
9298 begin
9299 if Is_Entity_Name (Act) then
9300 Act_E := Entity (Act);
9301
9302 elsif Nkind (Act) = N_Selected_Component
9303 and then Is_Entity_Name (Selector_Name (Act))
9304 then
9305 Act_E := Entity (Selector_Name (Act));
9306
9307 else
9308 Act_E := Empty;
9309 end if;
9310
9311 if (Present (Act_E) and then Is_Overloadable (Act_E))
9312 or else Nkind_In (Act, N_Attribute_Reference,
9313 N_Indexed_Component,
9314 N_Character_Literal,
9315 N_Explicit_Dereference)
9316 then
9317 return;
9318 end if;
9319
9320 Error_Msg_NE
9321 ("expect subprogram or entry name in instantiation of&",
9322 Instantiation_Node, Formal_Sub);
9323 Abandon_Instantiation (Instantiation_Node);
9324
9325 end Valid_Actual_Subprogram;
9326
9327 -- Start of processing for Instantiate_Formal_Subprogram
9328
9329 begin
9330 New_Spec := New_Copy_Tree (Specification (Formal));
9331
9332 -- The tree copy has created the proper instantiation sloc for the
9333 -- new specification. Use this location for all other constructed
9334 -- declarations.
9335
9336 Loc := Sloc (Defining_Unit_Name (New_Spec));
9337
9338 -- Create new entity for the actual (New_Copy_Tree does not)
9339
9340 Set_Defining_Unit_Name
9341 (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9342
9343 -- Create new entities for the each of the formals in the
9344 -- specification of the renaming declaration built for the actual.
9345
9346 if Present (Parameter_Specifications (New_Spec)) then
9347 declare
9348 F : Node_Id;
9349 begin
9350 F := First (Parameter_Specifications (New_Spec));
9351 while Present (F) loop
9352 Set_Defining_Identifier (F,
9353 Make_Defining_Identifier (Sloc (F),
9354 Chars => Chars (Defining_Identifier (F))));
9355 Next (F);
9356 end loop;
9357 end;
9358 end if;
9359
9360 -- Find entity of actual. If the actual is an attribute reference, it
9361 -- cannot be resolved here (its formal is missing) but is handled
9362 -- instead in Attribute_Renaming. If the actual is overloaded, it is
9363 -- fully resolved subsequently, when the renaming declaration for the
9364 -- formal is analyzed. If it is an explicit dereference, resolve the
9365 -- prefix but not the actual itself, to prevent interpretation as call.
9366
9367 if Present (Actual) then
9368 Loc := Sloc (Actual);
9369 Set_Sloc (New_Spec, Loc);
9370
9371 if Nkind (Actual) = N_Operator_Symbol then
9372 Find_Direct_Name (Actual);
9373
9374 elsif Nkind (Actual) = N_Explicit_Dereference then
9375 Analyze (Prefix (Actual));
9376
9377 elsif Nkind (Actual) /= N_Attribute_Reference then
9378 Analyze (Actual);
9379 end if;
9380
9381 Valid_Actual_Subprogram (Actual);
9382 Nam := Actual;
9383
9384 elsif Present (Default_Name (Formal)) then
9385 if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9386 N_Selected_Component,
9387 N_Indexed_Component,
9388 N_Character_Literal)
9389 and then Present (Entity (Default_Name (Formal)))
9390 then
9391 Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9392 else
9393 Nam := New_Copy (Default_Name (Formal));
9394 Set_Sloc (Nam, Loc);
9395 end if;
9396
9397 elsif Box_Present (Formal) then
9398
9399 -- Actual is resolved at the point of instantiation. Create an
9400 -- identifier or operator with the same name as the formal.
9401
9402 if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9403 Nam := Make_Operator_Symbol (Loc,
9404 Chars => Chars (Formal_Sub),
9405 Strval => No_String);
9406 else
9407 Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9408 end if;
9409
9410 elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9411 and then Null_Present (Specification (Formal))
9412 then
9413 -- Generate null body for procedure, for use in the instance
9414
9415 Decl_Node :=
9416 Make_Subprogram_Body (Loc,
9417 Specification => New_Spec,
9418 Declarations => New_List,
9419 Handled_Statement_Sequence =>
9420 Make_Handled_Sequence_Of_Statements (Loc,
9421 Statements => New_List (Make_Null_Statement (Loc))));
9422
9423 Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9424 return Decl_Node;
9425
9426 else
9427 Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9428 Error_Msg_NE
9429 ("missing actual&", Instantiation_Node, Formal_Sub);
9430 Error_Msg_NE
9431 ("\in instantiation of & declared#",
9432 Instantiation_Node, Scope (Analyzed_S));
9433 Abandon_Instantiation (Instantiation_Node);
9434 end if;
9435
9436 Decl_Node :=
9437 Make_Subprogram_Renaming_Declaration (Loc,
9438 Specification => New_Spec,
9439 Name => Nam);
9440
9441 -- If we do not have an actual and the formal specified <> then set to
9442 -- get proper default.
9443
9444 if No (Actual) and then Box_Present (Formal) then
9445 Set_From_Default (Decl_Node);
9446 end if;
9447
9448 -- Gather possible interpretations for the actual before analyzing the
9449 -- instance. If overloaded, it will be resolved when analyzing the
9450 -- renaming declaration.
9451
9452 if Box_Present (Formal)
9453 and then No (Actual)
9454 then
9455 Analyze (Nam);
9456
9457 if Is_Child_Unit (Scope (Analyzed_S))
9458 and then Present (Entity (Nam))
9459 then
9460 if not Is_Overloaded (Nam) then
9461 if From_Parent_Scope (Entity (Nam)) then
9462 Set_Is_Immediately_Visible (Entity (Nam), False);
9463 Set_Entity (Nam, Empty);
9464 Set_Etype (Nam, Empty);
9465
9466 Analyze (Nam);
9467 Set_Is_Immediately_Visible (Entity (Nam));
9468 end if;
9469
9470 else
9471 declare
9472 I : Interp_Index;
9473 It : Interp;
9474
9475 begin
9476 Get_First_Interp (Nam, I, It);
9477 while Present (It.Nam) loop
9478 if From_Parent_Scope (It.Nam) then
9479 Remove_Interp (I);
9480 end if;
9481
9482 Get_Next_Interp (I, It);
9483 end loop;
9484 end;
9485 end if;
9486 end if;
9487 end if;
9488
9489 -- The generic instantiation freezes the actual. This can only be done
9490 -- once the actual is resolved, in the analysis of the renaming
9491 -- declaration. To make the formal subprogram entity available, we set
9492 -- Corresponding_Formal_Spec to point to the formal subprogram entity.
9493 -- This is also needed in Analyze_Subprogram_Renaming for the processing
9494 -- of formal abstract subprograms.
9495
9496 Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9497
9498 -- We cannot analyze the renaming declaration, and thus find the actual,
9499 -- until all the actuals are assembled in the instance. For subsequent
9500 -- checks of other actuals, indicate the node that will hold the
9501 -- instance of this formal.
9502
9503 Set_Instance_Of (Analyzed_S, Nam);
9504
9505 if Nkind (Actual) = N_Selected_Component
9506 and then Is_Task_Type (Etype (Prefix (Actual)))
9507 and then not Is_Frozen (Etype (Prefix (Actual)))
9508 then
9509 -- The renaming declaration will create a body, which must appear
9510 -- outside of the instantiation, We move the renaming declaration
9511 -- out of the instance, and create an additional renaming inside,
9512 -- to prevent freezing anomalies.
9513
9514 declare
9515 Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9516
9517 begin
9518 Set_Defining_Unit_Name (New_Spec, Anon_Id);
9519 Insert_Before (Instantiation_Node, Decl_Node);
9520 Analyze (Decl_Node);
9521
9522 -- Now create renaming within the instance
9523
9524 Decl_Node :=
9525 Make_Subprogram_Renaming_Declaration (Loc,
9526 Specification => New_Copy_Tree (New_Spec),
9527 Name => New_Occurrence_Of (Anon_Id, Loc));
9528
9529 Set_Defining_Unit_Name (Specification (Decl_Node),
9530 Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9531 end;
9532 end if;
9533
9534 return Decl_Node;
9535 end Instantiate_Formal_Subprogram;
9536
9537 ------------------------
9538 -- Instantiate_Object --
9539 ------------------------
9540
9541 function Instantiate_Object
9542 (Formal : Node_Id;
9543 Actual : Node_Id;
9544 Analyzed_Formal : Node_Id) return List_Id
9545 is
9546 Gen_Obj : constant Entity_Id := Defining_Identifier (Formal);
9547 A_Gen_Obj : constant Entity_Id :=
9548 Defining_Identifier (Analyzed_Formal);
9549 Acc_Def : Node_Id := Empty;
9550 Act_Assoc : constant Node_Id := Parent (Actual);
9551 Actual_Decl : Node_Id := Empty;
9552 Decl_Node : Node_Id;
9553 Def : Node_Id;
9554 Ftyp : Entity_Id;
9555 List : constant List_Id := New_List;
9556 Loc : constant Source_Ptr := Sloc (Actual);
9557 Orig_Ftyp : constant Entity_Id := Etype (A_Gen_Obj);
9558 Subt_Decl : Node_Id := Empty;
9559 Subt_Mark : Node_Id := Empty;
9560
9561 begin
9562 if Present (Subtype_Mark (Formal)) then
9563 Subt_Mark := Subtype_Mark (Formal);
9564 else
9565 Check_Access_Definition (Formal);
9566 Acc_Def := Access_Definition (Formal);
9567 end if;
9568
9569 -- Sloc for error message on missing actual
9570
9571 Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
9572
9573 if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
9574 Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
9575 end if;
9576
9577 Set_Parent (List, Parent (Actual));
9578
9579 -- OUT present
9580
9581 if Out_Present (Formal) then
9582
9583 -- An IN OUT generic actual must be a name. The instantiation is a
9584 -- renaming declaration. The actual is the name being renamed. We
9585 -- use the actual directly, rather than a copy, because it is not
9586 -- used further in the list of actuals, and because a copy or a use
9587 -- of relocate_node is incorrect if the instance is nested within a
9588 -- generic. In order to simplify ASIS searches, the Generic_Parent
9589 -- field links the declaration to the generic association.
9590
9591 if No (Actual) then
9592 Error_Msg_NE
9593 ("missing actual&",
9594 Instantiation_Node, Gen_Obj);
9595 Error_Msg_NE
9596 ("\in instantiation of & declared#",
9597 Instantiation_Node, Scope (A_Gen_Obj));
9598 Abandon_Instantiation (Instantiation_Node);
9599 end if;
9600
9601 if Present (Subt_Mark) then
9602 Decl_Node :=
9603 Make_Object_Renaming_Declaration (Loc,
9604 Defining_Identifier => New_Copy (Gen_Obj),
9605 Subtype_Mark => New_Copy_Tree (Subt_Mark),
9606 Name => Actual);
9607
9608 else pragma Assert (Present (Acc_Def));
9609 Decl_Node :=
9610 Make_Object_Renaming_Declaration (Loc,
9611 Defining_Identifier => New_Copy (Gen_Obj),
9612 Access_Definition => New_Copy_Tree (Acc_Def),
9613 Name => Actual);
9614 end if;
9615
9616 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9617
9618 -- The analysis of the actual may produce Insert_Action nodes, so
9619 -- the declaration must have a context in which to attach them.
9620
9621 Append (Decl_Node, List);
9622 Analyze (Actual);
9623
9624 -- Return if the analysis of the actual reported some error
9625
9626 if Etype (Actual) = Any_Type then
9627 return List;
9628 end if;
9629
9630 -- This check is performed here because Analyze_Object_Renaming will
9631 -- not check it when Comes_From_Source is False. Note though that the
9632 -- check for the actual being the name of an object will be performed
9633 -- in Analyze_Object_Renaming.
9634
9635 if Is_Object_Reference (Actual)
9636 and then Is_Dependent_Component_Of_Mutable_Object (Actual)
9637 then
9638 Error_Msg_N
9639 ("illegal discriminant-dependent component for in out parameter",
9640 Actual);
9641 end if;
9642
9643 -- The actual has to be resolved in order to check that it is a
9644 -- variable (due to cases such as F (1), where F returns access to
9645 -- an array, and for overloaded prefixes).
9646
9647 Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
9648
9649 -- If the type of the formal is not itself a formal, and the current
9650 -- unit is a child unit, the formal type must be declared in a
9651 -- parent, and must be retrieved by visibility.
9652
9653 if Ftyp = Orig_Ftyp
9654 and then Is_Generic_Unit (Scope (Ftyp))
9655 and then Is_Child_Unit (Scope (A_Gen_Obj))
9656 then
9657 declare
9658 Temp : constant Node_Id :=
9659 New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
9660 begin
9661 Set_Entity (Temp, Empty);
9662 Find_Type (Temp);
9663 Ftyp := Entity (Temp);
9664 end;
9665 end if;
9666
9667 if Is_Private_Type (Ftyp)
9668 and then not Is_Private_Type (Etype (Actual))
9669 and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
9670 or else Base_Type (Etype (Actual)) = Ftyp)
9671 then
9672 -- If the actual has the type of the full view of the formal, or
9673 -- else a non-private subtype of the formal, then the visibility
9674 -- of the formal type has changed. Add to the actuals a subtype
9675 -- declaration that will force the exchange of views in the body
9676 -- of the instance as well.
9677
9678 Subt_Decl :=
9679 Make_Subtype_Declaration (Loc,
9680 Defining_Identifier => Make_Temporary (Loc, 'P'),
9681 Subtype_Indication => New_Occurrence_Of (Ftyp, Loc));
9682
9683 Prepend (Subt_Decl, List);
9684
9685 Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
9686 Exchange_Declarations (Ftyp);
9687 end if;
9688
9689 Resolve (Actual, Ftyp);
9690
9691 if not Denotes_Variable (Actual) then
9692 Error_Msg_NE
9693 ("actual for& must be a variable", Actual, Gen_Obj);
9694
9695 elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
9696
9697 -- Ada 2005 (AI-423): For a generic formal object of mode in out,
9698 -- the type of the actual shall resolve to a specific anonymous
9699 -- access type.
9700
9701 if Ada_Version < Ada_2005
9702 or else
9703 Ekind (Base_Type (Ftyp)) /=
9704 E_Anonymous_Access_Type
9705 or else
9706 Ekind (Base_Type (Etype (Actual))) /=
9707 E_Anonymous_Access_Type
9708 then
9709 Error_Msg_NE ("type of actual does not match type of&",
9710 Actual, Gen_Obj);
9711 end if;
9712 end if;
9713
9714 Note_Possible_Modification (Actual, Sure => True);
9715
9716 -- Check for instantiation of atomic/volatile actual for
9717 -- non-atomic/volatile formal (RM C.6 (12)).
9718
9719 if Is_Atomic_Object (Actual)
9720 and then not Is_Atomic (Orig_Ftyp)
9721 then
9722 Error_Msg_N
9723 ("cannot instantiate non-atomic formal object " &
9724 "with atomic actual", Actual);
9725
9726 elsif Is_Volatile_Object (Actual)
9727 and then not Is_Volatile (Orig_Ftyp)
9728 then
9729 Error_Msg_N
9730 ("cannot instantiate non-volatile formal object " &
9731 "with volatile actual", Actual);
9732 end if;
9733
9734 -- Formal in-parameter
9735
9736 else
9737 -- The instantiation of a generic formal in-parameter is constant
9738 -- declaration. The actual is the expression for that declaration.
9739
9740 if Present (Actual) then
9741 if Present (Subt_Mark) then
9742 Def := Subt_Mark;
9743 else pragma Assert (Present (Acc_Def));
9744 Def := Acc_Def;
9745 end if;
9746
9747 Decl_Node :=
9748 Make_Object_Declaration (Loc,
9749 Defining_Identifier => New_Copy (Gen_Obj),
9750 Constant_Present => True,
9751 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9752 Object_Definition => New_Copy_Tree (Def),
9753 Expression => Actual);
9754
9755 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9756
9757 -- A generic formal object of a tagged type is defined to be
9758 -- aliased so the new constant must also be treated as aliased.
9759
9760 if Is_Tagged_Type (Etype (A_Gen_Obj)) then
9761 Set_Aliased_Present (Decl_Node);
9762 end if;
9763
9764 Append (Decl_Node, List);
9765
9766 -- No need to repeat (pre-)analysis of some expression nodes
9767 -- already handled in Preanalyze_Actuals.
9768
9769 if Nkind (Actual) /= N_Allocator then
9770 Analyze (Actual);
9771
9772 -- Return if the analysis of the actual reported some error
9773
9774 if Etype (Actual) = Any_Type then
9775 return List;
9776 end if;
9777 end if;
9778
9779 declare
9780 Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
9781 Typ : Entity_Id;
9782
9783 begin
9784 Typ := Get_Instance_Of (Formal_Type);
9785
9786 Freeze_Before (Instantiation_Node, Typ);
9787
9788 -- If the actual is an aggregate, perform name resolution on
9789 -- its components (the analysis of an aggregate does not do it)
9790 -- to capture local names that may be hidden if the generic is
9791 -- a child unit.
9792
9793 if Nkind (Actual) = N_Aggregate then
9794 Preanalyze_And_Resolve (Actual, Typ);
9795 end if;
9796
9797 if Is_Limited_Type (Typ)
9798 and then not OK_For_Limited_Init (Typ, Actual)
9799 then
9800 Error_Msg_N
9801 ("initialization not allowed for limited types", Actual);
9802 Explain_Limited_Type (Typ, Actual);
9803 end if;
9804 end;
9805
9806 elsif Present (Default_Expression (Formal)) then
9807
9808 -- Use default to construct declaration
9809
9810 if Present (Subt_Mark) then
9811 Def := Subt_Mark;
9812 else pragma Assert (Present (Acc_Def));
9813 Def := Acc_Def;
9814 end if;
9815
9816 Decl_Node :=
9817 Make_Object_Declaration (Sloc (Formal),
9818 Defining_Identifier => New_Copy (Gen_Obj),
9819 Constant_Present => True,
9820 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9821 Object_Definition => New_Copy (Def),
9822 Expression => New_Copy_Tree
9823 (Default_Expression (Formal)));
9824
9825 Append (Decl_Node, List);
9826 Set_Analyzed (Expression (Decl_Node), False);
9827
9828 else
9829 Error_Msg_NE
9830 ("missing actual&",
9831 Instantiation_Node, Gen_Obj);
9832 Error_Msg_NE ("\in instantiation of & declared#",
9833 Instantiation_Node, Scope (A_Gen_Obj));
9834
9835 if Is_Scalar_Type (Etype (A_Gen_Obj)) then
9836
9837 -- Create dummy constant declaration so that instance can be
9838 -- analyzed, to minimize cascaded visibility errors.
9839
9840 if Present (Subt_Mark) then
9841 Def := Subt_Mark;
9842 else pragma Assert (Present (Acc_Def));
9843 Def := Acc_Def;
9844 end if;
9845
9846 Decl_Node :=
9847 Make_Object_Declaration (Loc,
9848 Defining_Identifier => New_Copy (Gen_Obj),
9849 Constant_Present => True,
9850 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9851 Object_Definition => New_Copy (Def),
9852 Expression =>
9853 Make_Attribute_Reference (Sloc (Gen_Obj),
9854 Attribute_Name => Name_First,
9855 Prefix => New_Copy (Def)));
9856
9857 Append (Decl_Node, List);
9858
9859 else
9860 Abandon_Instantiation (Instantiation_Node);
9861 end if;
9862 end if;
9863 end if;
9864
9865 if Nkind (Actual) in N_Has_Entity then
9866 Actual_Decl := Parent (Entity (Actual));
9867 end if;
9868
9869 -- Ada 2005 (AI-423): For a formal object declaration with a null
9870 -- exclusion or an access definition that has a null exclusion: If the
9871 -- actual matching the formal object declaration denotes a generic
9872 -- formal object of another generic unit G, and the instantiation
9873 -- containing the actual occurs within the body of G or within the body
9874 -- of a generic unit declared within the declarative region of G, then
9875 -- the declaration of the formal object of G must have a null exclusion.
9876 -- Otherwise, the subtype of the actual matching the formal object
9877 -- declaration shall exclude null.
9878
9879 if Ada_Version >= Ada_2005
9880 and then Present (Actual_Decl)
9881 and then
9882 Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
9883 N_Object_Declaration)
9884 and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
9885 and then not Has_Null_Exclusion (Actual_Decl)
9886 and then Has_Null_Exclusion (Analyzed_Formal)
9887 then
9888 Error_Msg_Sloc := Sloc (Analyzed_Formal);
9889 Error_Msg_N
9890 ("actual must exclude null to match generic formal#", Actual);
9891 end if;
9892
9893 -- A volatile object cannot be used as an actual in a generic instance.
9894 -- The following check is only relevant when SPARK_Mode is on as it is
9895 -- not a standard Ada legality rule.
9896
9897 if SPARK_Mode = On
9898 and then Present (Actual)
9899 and then Is_SPARK_Volatile_Object (Actual)
9900 then
9901 Error_Msg_N
9902 ("volatile object cannot act as actual in generic instantiation "
9903 & "(SPARK RM 7.1.3(8))", Actual);
9904 end if;
9905
9906 return List;
9907 end Instantiate_Object;
9908
9909 ------------------------------
9910 -- Instantiate_Package_Body --
9911 ------------------------------
9912
9913 procedure Instantiate_Package_Body
9914 (Body_Info : Pending_Body_Info;
9915 Inlined_Body : Boolean := False;
9916 Body_Optional : Boolean := False)
9917 is
9918 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
9919 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
9920 Loc : constant Source_Ptr := Sloc (Inst_Node);
9921
9922 Gen_Id : constant Node_Id := Name (Inst_Node);
9923 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
9924 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
9925 Act_Spec : constant Node_Id := Specification (Act_Decl);
9926 Act_Decl_Id : constant Entity_Id := Defining_Entity (Act_Spec);
9927
9928 Act_Body_Name : Node_Id;
9929 Gen_Body : Node_Id;
9930 Gen_Body_Id : Node_Id;
9931 Act_Body : Node_Id;
9932 Act_Body_Id : Entity_Id;
9933
9934 Parent_Installed : Boolean := False;
9935 Save_Style_Check : constant Boolean := Style_Check;
9936
9937 Par_Ent : Entity_Id := Empty;
9938 Par_Vis : Boolean := False;
9939
9940 Vis_Prims_List : Elist_Id := No_Elist;
9941 -- List of primitives made temporarily visible in the instantiation
9942 -- to match the visibility of the formal type
9943
9944 procedure Check_Initialized_Types;
9945 -- In a generic package body, an entity of a generic private type may
9946 -- appear uninitialized. This is suspicious, unless the actual is a
9947 -- fully initialized type.
9948
9949 procedure Check_Initialized_Types is
9950 Decl : Node_Id;
9951 Formal : Entity_Id;
9952 Actual : Entity_Id;
9953
9954 begin
9955 Decl := First (Generic_Formal_Declarations (Gen_Decl));
9956 while Present (Decl) loop
9957 if (Nkind (Decl) = N_Private_Extension_Declaration
9958 and then Needs_Initialized_Actual (Decl))
9959
9960 or else (Nkind (Decl) = N_Formal_Type_Declaration
9961 and then
9962 Nkind (Formal_Type_Definition (Decl)) =
9963 N_Formal_Private_Type_Definition
9964 and then Needs_Initialized_Actual
9965 (Formal_Type_Definition (Decl)))
9966 then
9967 Formal := Defining_Identifier (Decl);
9968 Actual := First_Entity (Act_Decl_Id);
9969
9970 -- For each formal there is a subtype declaration that renames
9971 -- the actual and has the same name as the formal.
9972
9973 while Present (Actual) loop
9974 exit when Ekind (Actual) = E_Package
9975 and then Present (Renamed_Object (Actual));
9976
9977 if Chars (Actual) = Chars (Formal)
9978 and then not Is_Scalar_Type (Actual)
9979 and then not Is_Fully_Initialized_Type (Actual)
9980 and then Warn_On_No_Value_Assigned
9981 then
9982 Error_Msg_NE
9983 ("from its use in generic unit, actual for&"
9984 & " should be fully initialized type?",
9985 Actual, Formal);
9986 exit;
9987 end if;
9988
9989 Next_Entity (Actual);
9990 end loop;
9991 end if;
9992
9993 Next (Decl);
9994 end loop;
9995 end Check_Initialized_Types;
9996 begin
9997 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9998
9999 -- The instance body may already have been processed, as the parent of
10000 -- another instance that is inlined (Load_Parent_Of_Generic).
10001
10002 if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
10003 return;
10004 end if;
10005
10006 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10007
10008 -- Re-establish the state of information on which checks are suppressed.
10009 -- This information was set in Body_Info at the point of instantiation,
10010 -- and now we restore it so that the instance is compiled using the
10011 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10012
10013 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10014 Scope_Suppress := Body_Info.Scope_Suppress;
10015 Opt.Ada_Version := Body_Info.Version;
10016 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10017 Restore_Warnings (Body_Info.Warnings);
10018 Opt.SPARK_Mode := Body_Info.SPARK_Mode;
10019 Opt.SPARK_Mode_Pragma := Body_Info.SPARK_Mode_Pragma;
10020
10021 if No (Gen_Body_Id) then
10022 Load_Parent_Of_Generic
10023 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10024 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10025 end if;
10026
10027 -- Establish global variable for sloc adjustment and for error recovery
10028
10029 Instantiation_Node := Inst_Node;
10030
10031 if Present (Gen_Body_Id) then
10032 Save_Env (Gen_Unit, Act_Decl_Id);
10033 Style_Check := False;
10034 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10035
10036 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10037
10038 Create_Instantiation_Source
10039 (Inst_Node, Gen_Body_Id, False, S_Adjustment);
10040
10041 Act_Body :=
10042 Copy_Generic_Node
10043 (Original_Node (Gen_Body), Empty, Instantiating => True);
10044
10045 -- Build new name (possibly qualified) for body declaration
10046
10047 Act_Body_Id := New_Copy (Act_Decl_Id);
10048
10049 -- Some attributes of spec entity are not inherited by body entity
10050
10051 Set_Handler_Records (Act_Body_Id, No_List);
10052
10053 if Nkind (Defining_Unit_Name (Act_Spec)) =
10054 N_Defining_Program_Unit_Name
10055 then
10056 Act_Body_Name :=
10057 Make_Defining_Program_Unit_Name (Loc,
10058 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
10059 Defining_Identifier => Act_Body_Id);
10060 else
10061 Act_Body_Name := Act_Body_Id;
10062 end if;
10063
10064 Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
10065
10066 Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
10067 Check_Generic_Actuals (Act_Decl_Id, False);
10068 Check_Initialized_Types;
10069
10070 -- Install primitives hidden at the point of the instantiation but
10071 -- visible when processing the generic formals
10072
10073 declare
10074 E : Entity_Id;
10075
10076 begin
10077 E := First_Entity (Act_Decl_Id);
10078 while Present (E) loop
10079 if Is_Type (E)
10080 and then Is_Generic_Actual_Type (E)
10081 and then Is_Tagged_Type (E)
10082 then
10083 Install_Hidden_Primitives
10084 (Prims_List => Vis_Prims_List,
10085 Gen_T => Generic_Parent_Type (Parent (E)),
10086 Act_T => E);
10087 end if;
10088
10089 Next_Entity (E);
10090 end loop;
10091 end;
10092
10093 -- If it is a child unit, make the parent instance (which is an
10094 -- instance of the parent of the generic) visible. The parent
10095 -- instance is the prefix of the name of the generic unit.
10096
10097 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10098 and then Nkind (Gen_Id) = N_Expanded_Name
10099 then
10100 Par_Ent := Entity (Prefix (Gen_Id));
10101 Par_Vis := Is_Immediately_Visible (Par_Ent);
10102 Install_Parent (Par_Ent, In_Body => True);
10103 Parent_Installed := True;
10104
10105 elsif Is_Child_Unit (Gen_Unit) then
10106 Par_Ent := Scope (Gen_Unit);
10107 Par_Vis := Is_Immediately_Visible (Par_Ent);
10108 Install_Parent (Par_Ent, In_Body => True);
10109 Parent_Installed := True;
10110 end if;
10111
10112 -- If the instantiation is a library unit, and this is the main unit,
10113 -- then build the resulting compilation unit nodes for the instance.
10114 -- If this is a compilation unit but it is not the main unit, then it
10115 -- is the body of a unit in the context, that is being compiled
10116 -- because it is encloses some inlined unit or another generic unit
10117 -- being instantiated. In that case, this body is not part of the
10118 -- current compilation, and is not attached to the tree, but its
10119 -- parent must be set for analysis.
10120
10121 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10122
10123 -- Replace instance node with body of instance, and create new
10124 -- node for corresponding instance declaration.
10125
10126 Build_Instance_Compilation_Unit_Nodes
10127 (Inst_Node, Act_Body, Act_Decl);
10128 Analyze (Inst_Node);
10129
10130 if Parent (Inst_Node) = Cunit (Main_Unit) then
10131
10132 -- If the instance is a child unit itself, then set the scope
10133 -- of the expanded body to be the parent of the instantiation
10134 -- (ensuring that the fully qualified name will be generated
10135 -- for the elaboration subprogram).
10136
10137 if Nkind (Defining_Unit_Name (Act_Spec)) =
10138 N_Defining_Program_Unit_Name
10139 then
10140 Set_Scope
10141 (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
10142 end if;
10143 end if;
10144
10145 -- Case where instantiation is not a library unit
10146
10147 else
10148 -- If this is an early instantiation, i.e. appears textually
10149 -- before the corresponding body and must be elaborated first,
10150 -- indicate that the body instance is to be delayed.
10151
10152 Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
10153
10154 -- Now analyze the body. We turn off all checks if this is an
10155 -- internal unit, since there is no reason to have checks on for
10156 -- any predefined run-time library code. All such code is designed
10157 -- to be compiled with checks off.
10158
10159 -- Note that we do NOT apply this criterion to children of GNAT
10160 -- (or on VMS, children of DEC). The latter units must suppress
10161 -- checks explicitly if this is needed.
10162
10163 if Is_Predefined_File_Name
10164 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
10165 then
10166 Analyze (Act_Body, Suppress => All_Checks);
10167 else
10168 Analyze (Act_Body);
10169 end if;
10170 end if;
10171
10172 Inherit_Context (Gen_Body, Inst_Node);
10173
10174 -- Remove the parent instances if they have been placed on the scope
10175 -- stack to compile the body.
10176
10177 if Parent_Installed then
10178 Remove_Parent (In_Body => True);
10179
10180 -- Restore the previous visibility of the parent
10181
10182 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10183 end if;
10184
10185 Restore_Hidden_Primitives (Vis_Prims_List);
10186 Restore_Private_Views (Act_Decl_Id);
10187
10188 -- Remove the current unit from visibility if this is an instance
10189 -- that is not elaborated on the fly for inlining purposes.
10190
10191 if not Inlined_Body then
10192 Set_Is_Immediately_Visible (Act_Decl_Id, False);
10193 end if;
10194
10195 Restore_Env;
10196 Style_Check := Save_Style_Check;
10197
10198 -- If we have no body, and the unit requires a body, then complain. This
10199 -- complaint is suppressed if we have detected other errors (since a
10200 -- common reason for missing the body is that it had errors).
10201 -- In CodePeer mode, a warning has been emitted already, no need for
10202 -- further messages.
10203
10204 elsif Unit_Requires_Body (Gen_Unit)
10205 and then not Body_Optional
10206 then
10207 if CodePeer_Mode then
10208 null;
10209
10210 elsif Serious_Errors_Detected = 0 then
10211 Error_Msg_NE
10212 ("cannot find body of generic package &", Inst_Node, Gen_Unit);
10213
10214 -- Don't attempt to perform any cleanup actions if some other error
10215 -- was already detected, since this can cause blowups.
10216
10217 else
10218 return;
10219 end if;
10220
10221 -- Case of package that does not need a body
10222
10223 else
10224 -- If the instantiation of the declaration is a library unit, rewrite
10225 -- the original package instantiation as a package declaration in the
10226 -- compilation unit node.
10227
10228 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10229 Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
10230 Rewrite (Inst_Node, Act_Decl);
10231
10232 -- Generate elaboration entity, in case spec has elaboration code.
10233 -- This cannot be done when the instance is analyzed, because it
10234 -- is not known yet whether the body exists.
10235
10236 Set_Elaboration_Entity_Required (Act_Decl_Id, False);
10237 Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
10238
10239 -- If the instantiation is not a library unit, then append the
10240 -- declaration to the list of implicitly generated entities, unless
10241 -- it is already a list member which means that it was already
10242 -- processed
10243
10244 elsif not Is_List_Member (Act_Decl) then
10245 Mark_Rewrite_Insertion (Act_Decl);
10246 Insert_Before (Inst_Node, Act_Decl);
10247 end if;
10248 end if;
10249
10250 Expander_Mode_Restore;
10251 end Instantiate_Package_Body;
10252
10253 ---------------------------------
10254 -- Instantiate_Subprogram_Body --
10255 ---------------------------------
10256
10257 procedure Instantiate_Subprogram_Body
10258 (Body_Info : Pending_Body_Info;
10259 Body_Optional : Boolean := False)
10260 is
10261 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10262 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10263 Loc : constant Source_Ptr := Sloc (Inst_Node);
10264 Gen_Id : constant Node_Id := Name (Inst_Node);
10265 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10266 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10267 Anon_Id : constant Entity_Id :=
10268 Defining_Unit_Name (Specification (Act_Decl));
10269 Pack_Id : constant Entity_Id :=
10270 Defining_Unit_Name (Parent (Act_Decl));
10271 Decls : List_Id;
10272 Gen_Body : Node_Id;
10273 Gen_Body_Id : Node_Id;
10274 Act_Body : Node_Id;
10275 Pack_Body : Node_Id;
10276 Prev_Formal : Entity_Id;
10277 Ret_Expr : Node_Id;
10278 Unit_Renaming : Node_Id;
10279
10280 Parent_Installed : Boolean := False;
10281
10282 Saved_Style_Check : constant Boolean := Style_Check;
10283 Saved_Warnings : constant Warning_Record := Save_Warnings;
10284
10285 Par_Ent : Entity_Id := Empty;
10286 Par_Vis : Boolean := False;
10287
10288 begin
10289 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10290
10291 -- Subprogram body may have been created already because of an inline
10292 -- pragma, or because of multiple elaborations of the enclosing package
10293 -- when several instances of the subprogram appear in the main unit.
10294
10295 if Present (Corresponding_Body (Act_Decl)) then
10296 return;
10297 end if;
10298
10299 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10300
10301 -- Re-establish the state of information on which checks are suppressed.
10302 -- This information was set in Body_Info at the point of instantiation,
10303 -- and now we restore it so that the instance is compiled using the
10304 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10305
10306 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10307 Scope_Suppress := Body_Info.Scope_Suppress;
10308 Opt.Ada_Version := Body_Info.Version;
10309 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10310 Restore_Warnings (Body_Info.Warnings);
10311 Opt.SPARK_Mode := Body_Info.SPARK_Mode;
10312 Opt.SPARK_Mode_Pragma := Body_Info.SPARK_Mode_Pragma;
10313
10314 if No (Gen_Body_Id) then
10315
10316 -- For imported generic subprogram, no body to compile, complete
10317 -- the spec entity appropriately.
10318
10319 if Is_Imported (Gen_Unit) then
10320 Set_Is_Imported (Anon_Id);
10321 Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10322 Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10323 Set_Convention (Anon_Id, Convention (Gen_Unit));
10324 Set_Has_Completion (Anon_Id);
10325 return;
10326
10327 -- For other cases, compile the body
10328
10329 else
10330 Load_Parent_Of_Generic
10331 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10332 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10333 end if;
10334 end if;
10335
10336 Instantiation_Node := Inst_Node;
10337
10338 if Present (Gen_Body_Id) then
10339 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10340
10341 if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10342
10343 -- Either body is not present, or context is non-expanding, as
10344 -- when compiling a subunit. Mark the instance as completed, and
10345 -- diagnose a missing body when needed.
10346
10347 if Expander_Active
10348 and then Operating_Mode = Generate_Code
10349 then
10350 Error_Msg_N
10351 ("missing proper body for instantiation", Gen_Body);
10352 end if;
10353
10354 Set_Has_Completion (Anon_Id);
10355 return;
10356 end if;
10357
10358 Save_Env (Gen_Unit, Anon_Id);
10359 Style_Check := False;
10360 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10361 Create_Instantiation_Source
10362 (Inst_Node,
10363 Gen_Body_Id,
10364 False,
10365 S_Adjustment);
10366
10367 Act_Body :=
10368 Copy_Generic_Node
10369 (Original_Node (Gen_Body), Empty, Instantiating => True);
10370
10371 -- Create proper defining name for the body, to correspond to
10372 -- the one in the spec.
10373
10374 Set_Defining_Unit_Name (Specification (Act_Body),
10375 Make_Defining_Identifier
10376 (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10377 Set_Corresponding_Spec (Act_Body, Anon_Id);
10378 Set_Has_Completion (Anon_Id);
10379 Check_Generic_Actuals (Pack_Id, False);
10380
10381 -- Generate a reference to link the visible subprogram instance to
10382 -- the generic body, which for navigation purposes is the only
10383 -- available source for the instance.
10384
10385 Generate_Reference
10386 (Related_Instance (Pack_Id),
10387 Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10388
10389 -- If it is a child unit, make the parent instance (which is an
10390 -- instance of the parent of the generic) visible. The parent
10391 -- instance is the prefix of the name of the generic unit.
10392
10393 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10394 and then Nkind (Gen_Id) = N_Expanded_Name
10395 then
10396 Par_Ent := Entity (Prefix (Gen_Id));
10397 Par_Vis := Is_Immediately_Visible (Par_Ent);
10398 Install_Parent (Par_Ent, In_Body => True);
10399 Parent_Installed := True;
10400
10401 elsif Is_Child_Unit (Gen_Unit) then
10402 Par_Ent := Scope (Gen_Unit);
10403 Par_Vis := Is_Immediately_Visible (Par_Ent);
10404 Install_Parent (Par_Ent, In_Body => True);
10405 Parent_Installed := True;
10406 end if;
10407
10408 -- Inside its body, a reference to the generic unit is a reference
10409 -- to the instance. The corresponding renaming is the first
10410 -- declaration in the body.
10411
10412 Unit_Renaming :=
10413 Make_Subprogram_Renaming_Declaration (Loc,
10414 Specification =>
10415 Copy_Generic_Node (
10416 Specification (Original_Node (Gen_Body)),
10417 Empty,
10418 Instantiating => True),
10419 Name => New_Occurrence_Of (Anon_Id, Loc));
10420
10421 -- If there is a formal subprogram with the same name as the unit
10422 -- itself, do not add this renaming declaration. This is a temporary
10423 -- fix for one ACVC test. ???
10424
10425 Prev_Formal := First_Entity (Pack_Id);
10426 while Present (Prev_Formal) loop
10427 if Chars (Prev_Formal) = Chars (Gen_Unit)
10428 and then Is_Overloadable (Prev_Formal)
10429 then
10430 exit;
10431 end if;
10432
10433 Next_Entity (Prev_Formal);
10434 end loop;
10435
10436 if Present (Prev_Formal) then
10437 Decls := New_List (Act_Body);
10438 else
10439 Decls := New_List (Unit_Renaming, Act_Body);
10440 end if;
10441
10442 -- The subprogram body is placed in the body of a dummy package body,
10443 -- whose spec contains the subprogram declaration as well as the
10444 -- renaming declarations for the generic parameters.
10445
10446 Pack_Body := Make_Package_Body (Loc,
10447 Defining_Unit_Name => New_Copy (Pack_Id),
10448 Declarations => Decls);
10449
10450 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10451
10452 -- If the instantiation is a library unit, then build resulting
10453 -- compilation unit nodes for the instance. The declaration of
10454 -- the enclosing package is the grandparent of the subprogram
10455 -- declaration. First replace the instantiation node as the unit
10456 -- of the corresponding compilation.
10457
10458 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10459 if Parent (Inst_Node) = Cunit (Main_Unit) then
10460 Set_Unit (Parent (Inst_Node), Inst_Node);
10461 Build_Instance_Compilation_Unit_Nodes
10462 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10463 Analyze (Inst_Node);
10464 else
10465 Set_Parent (Pack_Body, Parent (Inst_Node));
10466 Analyze (Pack_Body);
10467 end if;
10468
10469 else
10470 Insert_Before (Inst_Node, Pack_Body);
10471 Mark_Rewrite_Insertion (Pack_Body);
10472 Analyze (Pack_Body);
10473
10474 if Expander_Active then
10475 Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10476 end if;
10477 end if;
10478
10479 Inherit_Context (Gen_Body, Inst_Node);
10480
10481 Restore_Private_Views (Pack_Id, False);
10482
10483 if Parent_Installed then
10484 Remove_Parent (In_Body => True);
10485
10486 -- Restore the previous visibility of the parent
10487
10488 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10489 end if;
10490
10491 Restore_Env;
10492 Style_Check := Saved_Style_Check;
10493 Restore_Warnings (Saved_Warnings);
10494
10495 -- Body not found. Error was emitted already. If there were no previous
10496 -- errors, this may be an instance whose scope is a premature instance.
10497 -- In that case we must insure that the (legal) program does raise
10498 -- program error if executed. We generate a subprogram body for this
10499 -- purpose. See DEC ac30vso.
10500
10501 -- Should not reference proprietary DEC tests in comments ???
10502
10503 elsif Serious_Errors_Detected = 0
10504 and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
10505 then
10506 if Body_Optional then
10507 return;
10508
10509 elsif Ekind (Anon_Id) = E_Procedure then
10510 Act_Body :=
10511 Make_Subprogram_Body (Loc,
10512 Specification =>
10513 Make_Procedure_Specification (Loc,
10514 Defining_Unit_Name =>
10515 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10516 Parameter_Specifications =>
10517 New_Copy_List
10518 (Parameter_Specifications (Parent (Anon_Id)))),
10519
10520 Declarations => Empty_List,
10521 Handled_Statement_Sequence =>
10522 Make_Handled_Sequence_Of_Statements (Loc,
10523 Statements =>
10524 New_List (
10525 Make_Raise_Program_Error (Loc,
10526 Reason =>
10527 PE_Access_Before_Elaboration))));
10528
10529 else
10530 Ret_Expr :=
10531 Make_Raise_Program_Error (Loc,
10532 Reason => PE_Access_Before_Elaboration);
10533
10534 Set_Etype (Ret_Expr, (Etype (Anon_Id)));
10535 Set_Analyzed (Ret_Expr);
10536
10537 Act_Body :=
10538 Make_Subprogram_Body (Loc,
10539 Specification =>
10540 Make_Function_Specification (Loc,
10541 Defining_Unit_Name =>
10542 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10543 Parameter_Specifications =>
10544 New_Copy_List
10545 (Parameter_Specifications (Parent (Anon_Id))),
10546 Result_Definition =>
10547 New_Occurrence_Of (Etype (Anon_Id), Loc)),
10548
10549 Declarations => Empty_List,
10550 Handled_Statement_Sequence =>
10551 Make_Handled_Sequence_Of_Statements (Loc,
10552 Statements =>
10553 New_List
10554 (Make_Simple_Return_Statement (Loc, Ret_Expr))));
10555 end if;
10556
10557 Pack_Body := Make_Package_Body (Loc,
10558 Defining_Unit_Name => New_Copy (Pack_Id),
10559 Declarations => New_List (Act_Body));
10560
10561 Insert_After (Inst_Node, Pack_Body);
10562 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10563 Analyze (Pack_Body);
10564 end if;
10565
10566 Expander_Mode_Restore;
10567 end Instantiate_Subprogram_Body;
10568
10569 ----------------------
10570 -- Instantiate_Type --
10571 ----------------------
10572
10573 function Instantiate_Type
10574 (Formal : Node_Id;
10575 Actual : Node_Id;
10576 Analyzed_Formal : Node_Id;
10577 Actual_Decls : List_Id) return List_Id
10578 is
10579 Gen_T : constant Entity_Id := Defining_Identifier (Formal);
10580 A_Gen_T : constant Entity_Id :=
10581 Defining_Identifier (Analyzed_Formal);
10582 Ancestor : Entity_Id := Empty;
10583 Def : constant Node_Id := Formal_Type_Definition (Formal);
10584 Act_T : Entity_Id;
10585 Decl_Node : Node_Id;
10586 Decl_Nodes : List_Id;
10587 Loc : Source_Ptr;
10588 Subt : Entity_Id;
10589
10590 procedure Validate_Array_Type_Instance;
10591 procedure Validate_Access_Subprogram_Instance;
10592 procedure Validate_Access_Type_Instance;
10593 procedure Validate_Derived_Type_Instance;
10594 procedure Validate_Derived_Interface_Type_Instance;
10595 procedure Validate_Discriminated_Formal_Type;
10596 procedure Validate_Interface_Type_Instance;
10597 procedure Validate_Private_Type_Instance;
10598 procedure Validate_Incomplete_Type_Instance;
10599 -- These procedures perform validation tests for the named case.
10600 -- Validate_Discriminated_Formal_Type is shared by formal private
10601 -- types and Ada 2012 formal incomplete types.
10602
10603 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
10604 -- Check that base types are the same and that the subtypes match
10605 -- statically. Used in several of the above.
10606
10607 --------------------
10608 -- Subtypes_Match --
10609 --------------------
10610
10611 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
10612 T : constant Entity_Id := Get_Instance_Of (Gen_T);
10613
10614 begin
10615 -- Some detailed comments would be useful here ???
10616
10617 return ((Base_Type (T) = Act_T
10618 or else Base_Type (T) = Base_Type (Act_T))
10619 and then Subtypes_Statically_Match (T, Act_T))
10620
10621 or else (Is_Class_Wide_Type (Gen_T)
10622 and then Is_Class_Wide_Type (Act_T)
10623 and then Subtypes_Match
10624 (Get_Instance_Of (Root_Type (Gen_T)),
10625 Root_Type (Act_T)))
10626
10627 or else
10628 (Ekind_In (Gen_T, E_Anonymous_Access_Subprogram_Type,
10629 E_Anonymous_Access_Type)
10630 and then Ekind (Act_T) = Ekind (Gen_T)
10631 and then Subtypes_Statically_Match
10632 (Designated_Type (Gen_T), Designated_Type (Act_T)));
10633 end Subtypes_Match;
10634
10635 -----------------------------------------
10636 -- Validate_Access_Subprogram_Instance --
10637 -----------------------------------------
10638
10639 procedure Validate_Access_Subprogram_Instance is
10640 begin
10641 if not Is_Access_Type (Act_T)
10642 or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
10643 then
10644 Error_Msg_NE
10645 ("expect access type in instantiation of &", Actual, Gen_T);
10646 Abandon_Instantiation (Actual);
10647 end if;
10648
10649 -- According to AI05-288, actuals for access_to_subprograms must be
10650 -- subtype conformant with the generic formal. Previous to AI05-288
10651 -- only mode conformance was required.
10652
10653 -- This is a binding interpretation that applies to previous versions
10654 -- of the language, no need to maintain previous weaker checks.
10655
10656 Check_Subtype_Conformant
10657 (Designated_Type (Act_T),
10658 Designated_Type (A_Gen_T),
10659 Actual,
10660 Get_Inst => True);
10661
10662 if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
10663 if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
10664 Error_Msg_NE
10665 ("protected access type not allowed for formal &",
10666 Actual, Gen_T);
10667 end if;
10668
10669 elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
10670 Error_Msg_NE
10671 ("expect protected access type for formal &",
10672 Actual, Gen_T);
10673 end if;
10674 end Validate_Access_Subprogram_Instance;
10675
10676 -----------------------------------
10677 -- Validate_Access_Type_Instance --
10678 -----------------------------------
10679
10680 procedure Validate_Access_Type_Instance is
10681 Desig_Type : constant Entity_Id :=
10682 Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
10683 Desig_Act : Entity_Id;
10684
10685 begin
10686 if not Is_Access_Type (Act_T) then
10687 Error_Msg_NE
10688 ("expect access type in instantiation of &", Actual, Gen_T);
10689 Abandon_Instantiation (Actual);
10690 end if;
10691
10692 if Is_Access_Constant (A_Gen_T) then
10693 if not Is_Access_Constant (Act_T) then
10694 Error_Msg_N
10695 ("actual type must be access-to-constant type", Actual);
10696 Abandon_Instantiation (Actual);
10697 end if;
10698 else
10699 if Is_Access_Constant (Act_T) then
10700 Error_Msg_N
10701 ("actual type must be access-to-variable type", Actual);
10702 Abandon_Instantiation (Actual);
10703
10704 elsif Ekind (A_Gen_T) = E_General_Access_Type
10705 and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
10706 then
10707 Error_Msg_N -- CODEFIX
10708 ("actual must be general access type!", Actual);
10709 Error_Msg_NE -- CODEFIX
10710 ("add ALL to }!", Actual, Act_T);
10711 Abandon_Instantiation (Actual);
10712 end if;
10713 end if;
10714
10715 -- The designated subtypes, that is to say the subtypes introduced
10716 -- by an access type declaration (and not by a subtype declaration)
10717 -- must match.
10718
10719 Desig_Act := Designated_Type (Base_Type (Act_T));
10720
10721 -- The designated type may have been introduced through a limited_
10722 -- with clause, in which case retrieve the non-limited view. This
10723 -- applies to incomplete types as well as to class-wide types.
10724
10725 if From_Limited_With (Desig_Act) then
10726 Desig_Act := Available_View (Desig_Act);
10727 end if;
10728
10729 if not Subtypes_Match (Desig_Type, Desig_Act) then
10730 Error_Msg_NE
10731 ("designated type of actual does not match that of formal &",
10732 Actual, Gen_T);
10733
10734 if not Predicates_Match (Desig_Type, Desig_Act) then
10735 Error_Msg_N ("\predicates do not match", Actual);
10736 end if;
10737
10738 Abandon_Instantiation (Actual);
10739
10740 elsif Is_Access_Type (Designated_Type (Act_T))
10741 and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
10742 /=
10743 Is_Constrained (Designated_Type (Desig_Type))
10744 then
10745 Error_Msg_NE
10746 ("designated type of actual does not match that of formal &",
10747 Actual, Gen_T);
10748
10749 if not Predicates_Match (Desig_Type, Desig_Act) then
10750 Error_Msg_N ("\predicates do not match", Actual);
10751 end if;
10752
10753 Abandon_Instantiation (Actual);
10754 end if;
10755
10756 -- Ada 2005: null-exclusion indicators of the two types must agree
10757
10758 if Can_Never_Be_Null (A_Gen_T) /= Can_Never_Be_Null (Act_T) then
10759 Error_Msg_NE
10760 ("non null exclusion of actual and formal & do not match",
10761 Actual, Gen_T);
10762 end if;
10763 end Validate_Access_Type_Instance;
10764
10765 ----------------------------------
10766 -- Validate_Array_Type_Instance --
10767 ----------------------------------
10768
10769 procedure Validate_Array_Type_Instance is
10770 I1 : Node_Id;
10771 I2 : Node_Id;
10772 T2 : Entity_Id;
10773
10774 function Formal_Dimensions return Int;
10775 -- Count number of dimensions in array type formal
10776
10777 -----------------------
10778 -- Formal_Dimensions --
10779 -----------------------
10780
10781 function Formal_Dimensions return Int is
10782 Num : Int := 0;
10783 Index : Node_Id;
10784
10785 begin
10786 if Nkind (Def) = N_Constrained_Array_Definition then
10787 Index := First (Discrete_Subtype_Definitions (Def));
10788 else
10789 Index := First (Subtype_Marks (Def));
10790 end if;
10791
10792 while Present (Index) loop
10793 Num := Num + 1;
10794 Next_Index (Index);
10795 end loop;
10796
10797 return Num;
10798 end Formal_Dimensions;
10799
10800 -- Start of processing for Validate_Array_Type_Instance
10801
10802 begin
10803 if not Is_Array_Type (Act_T) then
10804 Error_Msg_NE
10805 ("expect array type in instantiation of &", Actual, Gen_T);
10806 Abandon_Instantiation (Actual);
10807
10808 elsif Nkind (Def) = N_Constrained_Array_Definition then
10809 if not (Is_Constrained (Act_T)) then
10810 Error_Msg_NE
10811 ("expect constrained array in instantiation of &",
10812 Actual, Gen_T);
10813 Abandon_Instantiation (Actual);
10814 end if;
10815
10816 else
10817 if Is_Constrained (Act_T) then
10818 Error_Msg_NE
10819 ("expect unconstrained array in instantiation of &",
10820 Actual, Gen_T);
10821 Abandon_Instantiation (Actual);
10822 end if;
10823 end if;
10824
10825 if Formal_Dimensions /= Number_Dimensions (Act_T) then
10826 Error_Msg_NE
10827 ("dimensions of actual do not match formal &", Actual, Gen_T);
10828 Abandon_Instantiation (Actual);
10829 end if;
10830
10831 I1 := First_Index (A_Gen_T);
10832 I2 := First_Index (Act_T);
10833 for J in 1 .. Formal_Dimensions loop
10834
10835 -- If the indexes of the actual were given by a subtype_mark,
10836 -- the index was transformed into a range attribute. Retrieve
10837 -- the original type mark for checking.
10838
10839 if Is_Entity_Name (Original_Node (I2)) then
10840 T2 := Entity (Original_Node (I2));
10841 else
10842 T2 := Etype (I2);
10843 end if;
10844
10845 if not Subtypes_Match
10846 (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
10847 then
10848 Error_Msg_NE
10849 ("index types of actual do not match those of formal &",
10850 Actual, Gen_T);
10851 Abandon_Instantiation (Actual);
10852 end if;
10853
10854 Next_Index (I1);
10855 Next_Index (I2);
10856 end loop;
10857
10858 -- Check matching subtypes. Note that there are complex visibility
10859 -- issues when the generic is a child unit and some aspect of the
10860 -- generic type is declared in a parent unit of the generic. We do
10861 -- the test to handle this special case only after a direct check
10862 -- for static matching has failed. The case where both the component
10863 -- type and the array type are separate formals, and the component
10864 -- type is a private view may also require special checking in
10865 -- Subtypes_Match.
10866
10867 if Subtypes_Match
10868 (Component_Type (A_Gen_T), Component_Type (Act_T))
10869 or else Subtypes_Match
10870 (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
10871 Component_Type (Act_T))
10872 then
10873 null;
10874 else
10875 Error_Msg_NE
10876 ("component subtype of actual does not match that of formal &",
10877 Actual, Gen_T);
10878 Abandon_Instantiation (Actual);
10879 end if;
10880
10881 if Has_Aliased_Components (A_Gen_T)
10882 and then not Has_Aliased_Components (Act_T)
10883 then
10884 Error_Msg_NE
10885 ("actual must have aliased components to match formal type &",
10886 Actual, Gen_T);
10887 end if;
10888 end Validate_Array_Type_Instance;
10889
10890 -----------------------------------------------
10891 -- Validate_Derived_Interface_Type_Instance --
10892 -----------------------------------------------
10893
10894 procedure Validate_Derived_Interface_Type_Instance is
10895 Par : constant Entity_Id := Entity (Subtype_Indication (Def));
10896 Elmt : Elmt_Id;
10897
10898 begin
10899 -- First apply interface instance checks
10900
10901 Validate_Interface_Type_Instance;
10902
10903 -- Verify that immediate parent interface is an ancestor of
10904 -- the actual.
10905
10906 if Present (Par)
10907 and then not Interface_Present_In_Ancestor (Act_T, Par)
10908 then
10909 Error_Msg_NE
10910 ("interface actual must include progenitor&", Actual, Par);
10911 end if;
10912
10913 -- Now verify that the actual includes all other ancestors of
10914 -- the formal.
10915
10916 Elmt := First_Elmt (Interfaces (A_Gen_T));
10917 while Present (Elmt) loop
10918 if not Interface_Present_In_Ancestor
10919 (Act_T, Get_Instance_Of (Node (Elmt)))
10920 then
10921 Error_Msg_NE
10922 ("interface actual must include progenitor&",
10923 Actual, Node (Elmt));
10924 end if;
10925
10926 Next_Elmt (Elmt);
10927 end loop;
10928 end Validate_Derived_Interface_Type_Instance;
10929
10930 ------------------------------------
10931 -- Validate_Derived_Type_Instance --
10932 ------------------------------------
10933
10934 procedure Validate_Derived_Type_Instance is
10935 Actual_Discr : Entity_Id;
10936 Ancestor_Discr : Entity_Id;
10937
10938 begin
10939 -- If the parent type in the generic declaration is itself a previous
10940 -- formal type, then it is local to the generic and absent from the
10941 -- analyzed generic definition. In that case the ancestor is the
10942 -- instance of the formal (which must have been instantiated
10943 -- previously), unless the ancestor is itself a formal derived type.
10944 -- In this latter case (which is the subject of Corrigendum 8652/0038
10945 -- (AI-202) the ancestor of the formals is the ancestor of its
10946 -- parent. Otherwise, the analyzed generic carries the parent type.
10947 -- If the parent type is defined in a previous formal package, then
10948 -- the scope of that formal package is that of the generic type
10949 -- itself, and it has already been mapped into the corresponding type
10950 -- in the actual package.
10951
10952 -- Common case: parent type defined outside of the generic
10953
10954 if Is_Entity_Name (Subtype_Mark (Def))
10955 and then Present (Entity (Subtype_Mark (Def)))
10956 then
10957 Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
10958
10959 -- Check whether parent is defined in a previous formal package
10960
10961 elsif
10962 Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
10963 then
10964 Ancestor :=
10965 Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
10966
10967 -- The type may be a local derivation, or a type extension of a
10968 -- previous formal, or of a formal of a parent package.
10969
10970 elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
10971 or else
10972 Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
10973 then
10974 -- Check whether the parent is another derived formal type in the
10975 -- same generic unit.
10976
10977 if Etype (A_Gen_T) /= A_Gen_T
10978 and then Is_Generic_Type (Etype (A_Gen_T))
10979 and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
10980 and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
10981 then
10982 -- Locate ancestor of parent from the subtype declaration
10983 -- created for the actual.
10984
10985 declare
10986 Decl : Node_Id;
10987
10988 begin
10989 Decl := First (Actual_Decls);
10990 while Present (Decl) loop
10991 if Nkind (Decl) = N_Subtype_Declaration
10992 and then Chars (Defining_Identifier (Decl)) =
10993 Chars (Etype (A_Gen_T))
10994 then
10995 Ancestor := Generic_Parent_Type (Decl);
10996 exit;
10997 else
10998 Next (Decl);
10999 end if;
11000 end loop;
11001 end;
11002
11003 pragma Assert (Present (Ancestor));
11004
11005 -- The ancestor itself may be a previous formal that has been
11006 -- instantiated.
11007
11008 Ancestor := Get_Instance_Of (Ancestor);
11009
11010 else
11011 Ancestor :=
11012 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
11013 end if;
11014
11015 -- An unusual case: the actual is a type declared in a parent unit,
11016 -- but is not a formal type so there is no instance_of for it.
11017 -- Retrieve it by analyzing the record extension.
11018
11019 elsif Is_Child_Unit (Scope (A_Gen_T))
11020 and then In_Open_Scopes (Scope (Act_T))
11021 and then Is_Generic_Instance (Scope (Act_T))
11022 then
11023 Analyze (Subtype_Mark (Def));
11024 Ancestor := Entity (Subtype_Mark (Def));
11025
11026 else
11027 Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
11028 end if;
11029
11030 -- If the formal derived type has pragma Preelaborable_Initialization
11031 -- then the actual type must have preelaborable initialization.
11032
11033 if Known_To_Have_Preelab_Init (A_Gen_T)
11034 and then not Has_Preelaborable_Initialization (Act_T)
11035 then
11036 Error_Msg_NE
11037 ("actual for & must have preelaborable initialization",
11038 Actual, Gen_T);
11039 end if;
11040
11041 -- Ada 2005 (AI-251)
11042
11043 if Ada_Version >= Ada_2005 and then Is_Interface (Ancestor) then
11044 if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
11045 Error_Msg_NE
11046 ("(Ada 2005) expected type implementing & in instantiation",
11047 Actual, Ancestor);
11048 end if;
11049
11050 elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
11051 Error_Msg_NE
11052 ("expect type derived from & in instantiation",
11053 Actual, First_Subtype (Ancestor));
11054 Abandon_Instantiation (Actual);
11055 end if;
11056
11057 -- Ada 2005 (AI-443): Synchronized formal derived type checks. Note
11058 -- that the formal type declaration has been rewritten as a private
11059 -- extension.
11060
11061 if Ada_Version >= Ada_2005
11062 and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
11063 and then Synchronized_Present (Parent (A_Gen_T))
11064 then
11065 -- The actual must be a synchronized tagged type
11066
11067 if not Is_Tagged_Type (Act_T) then
11068 Error_Msg_N
11069 ("actual of synchronized type must be tagged", Actual);
11070 Abandon_Instantiation (Actual);
11071
11072 elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
11073 and then Nkind (Type_Definition (Parent (Act_T))) =
11074 N_Derived_Type_Definition
11075 and then not Synchronized_Present (Type_Definition
11076 (Parent (Act_T)))
11077 then
11078 Error_Msg_N
11079 ("actual of synchronized type must be synchronized", Actual);
11080 Abandon_Instantiation (Actual);
11081 end if;
11082 end if;
11083
11084 -- Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
11085 -- removes the second instance of the phrase "or allow pass by copy".
11086
11087 if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
11088 Error_Msg_N
11089 ("cannot have atomic actual type for non-atomic formal type",
11090 Actual);
11091
11092 elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
11093 Error_Msg_N
11094 ("cannot have volatile actual type for non-volatile formal type",
11095 Actual);
11096 end if;
11097
11098 -- It should not be necessary to check for unknown discriminants on
11099 -- Formal, but for some reason Has_Unknown_Discriminants is false for
11100 -- A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
11101 -- needs fixing. ???
11102
11103 if not Is_Indefinite_Subtype (A_Gen_T)
11104 and then not Unknown_Discriminants_Present (Formal)
11105 and then Is_Indefinite_Subtype (Act_T)
11106 then
11107 Error_Msg_N
11108 ("actual subtype must be constrained", Actual);
11109 Abandon_Instantiation (Actual);
11110 end if;
11111
11112 if not Unknown_Discriminants_Present (Formal) then
11113 if Is_Constrained (Ancestor) then
11114 if not Is_Constrained (Act_T) then
11115 Error_Msg_N
11116 ("actual subtype must be constrained", Actual);
11117 Abandon_Instantiation (Actual);
11118 end if;
11119
11120 -- Ancestor is unconstrained, Check if generic formal and actual
11121 -- agree on constrainedness. The check only applies to array types
11122 -- and discriminated types.
11123
11124 elsif Is_Constrained (Act_T) then
11125 if Ekind (Ancestor) = E_Access_Type
11126 or else
11127 (not Is_Constrained (A_Gen_T)
11128 and then Is_Composite_Type (A_Gen_T))
11129 then
11130 Error_Msg_N
11131 ("actual subtype must be unconstrained", Actual);
11132 Abandon_Instantiation (Actual);
11133 end if;
11134
11135 -- A class-wide type is only allowed if the formal has unknown
11136 -- discriminants.
11137
11138 elsif Is_Class_Wide_Type (Act_T)
11139 and then not Has_Unknown_Discriminants (Ancestor)
11140 then
11141 Error_Msg_NE
11142 ("actual for & cannot be a class-wide type", Actual, Gen_T);
11143 Abandon_Instantiation (Actual);
11144
11145 -- Otherwise, the formal and actual shall have the same number
11146 -- of discriminants and each discriminant of the actual must
11147 -- correspond to a discriminant of the formal.
11148
11149 elsif Has_Discriminants (Act_T)
11150 and then not Has_Unknown_Discriminants (Act_T)
11151 and then Has_Discriminants (Ancestor)
11152 then
11153 Actual_Discr := First_Discriminant (Act_T);
11154 Ancestor_Discr := First_Discriminant (Ancestor);
11155 while Present (Actual_Discr)
11156 and then Present (Ancestor_Discr)
11157 loop
11158 if Base_Type (Act_T) /= Base_Type (Ancestor) and then
11159 No (Corresponding_Discriminant (Actual_Discr))
11160 then
11161 Error_Msg_NE
11162 ("discriminant & does not correspond " &
11163 "to ancestor discriminant", Actual, Actual_Discr);
11164 Abandon_Instantiation (Actual);
11165 end if;
11166
11167 Next_Discriminant (Actual_Discr);
11168 Next_Discriminant (Ancestor_Discr);
11169 end loop;
11170
11171 if Present (Actual_Discr) or else Present (Ancestor_Discr) then
11172 Error_Msg_NE
11173 ("actual for & must have same number of discriminants",
11174 Actual, Gen_T);
11175 Abandon_Instantiation (Actual);
11176 end if;
11177
11178 -- This case should be caught by the earlier check for
11179 -- constrainedness, but the check here is added for completeness.
11180
11181 elsif Has_Discriminants (Act_T)
11182 and then not Has_Unknown_Discriminants (Act_T)
11183 then
11184 Error_Msg_NE
11185 ("actual for & must not have discriminants", Actual, Gen_T);
11186 Abandon_Instantiation (Actual);
11187
11188 elsif Has_Discriminants (Ancestor) then
11189 Error_Msg_NE
11190 ("actual for & must have known discriminants", Actual, Gen_T);
11191 Abandon_Instantiation (Actual);
11192 end if;
11193
11194 if not Subtypes_Statically_Compatible
11195 (Act_T, Ancestor, Formal_Derived_Matching => True)
11196 then
11197 Error_Msg_N
11198 ("constraint on actual is incompatible with formal", Actual);
11199 Abandon_Instantiation (Actual);
11200 end if;
11201 end if;
11202
11203 -- If the formal and actual types are abstract, check that there
11204 -- are no abstract primitives of the actual type that correspond to
11205 -- nonabstract primitives of the formal type (second sentence of
11206 -- RM95-3.9.3(9)).
11207
11208 if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
11209 Check_Abstract_Primitives : declare
11210 Gen_Prims : constant Elist_Id :=
11211 Primitive_Operations (A_Gen_T);
11212 Gen_Elmt : Elmt_Id;
11213 Gen_Subp : Entity_Id;
11214 Anc_Subp : Entity_Id;
11215 Anc_Formal : Entity_Id;
11216 Anc_F_Type : Entity_Id;
11217
11218 Act_Prims : constant Elist_Id := Primitive_Operations (Act_T);
11219 Act_Elmt : Elmt_Id;
11220 Act_Subp : Entity_Id;
11221 Act_Formal : Entity_Id;
11222 Act_F_Type : Entity_Id;
11223
11224 Subprograms_Correspond : Boolean;
11225
11226 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
11227 -- Returns true if T2 is derived directly or indirectly from
11228 -- T1, including derivations from interfaces. T1 and T2 are
11229 -- required to be specific tagged base types.
11230
11231 ------------------------
11232 -- Is_Tagged_Ancestor --
11233 ------------------------
11234
11235 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
11236 is
11237 Intfc_Elmt : Elmt_Id;
11238
11239 begin
11240 -- The predicate is satisfied if the types are the same
11241
11242 if T1 = T2 then
11243 return True;
11244
11245 -- If we've reached the top of the derivation chain then
11246 -- we know that T1 is not an ancestor of T2.
11247
11248 elsif Etype (T2) = T2 then
11249 return False;
11250
11251 -- Proceed to check T2's immediate parent
11252
11253 elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
11254 return True;
11255
11256 -- Finally, check to see if T1 is an ancestor of any of T2's
11257 -- progenitors.
11258
11259 else
11260 Intfc_Elmt := First_Elmt (Interfaces (T2));
11261 while Present (Intfc_Elmt) loop
11262 if Is_Ancestor (T1, Node (Intfc_Elmt)) then
11263 return True;
11264 end if;
11265
11266 Next_Elmt (Intfc_Elmt);
11267 end loop;
11268 end if;
11269
11270 return False;
11271 end Is_Tagged_Ancestor;
11272
11273 -- Start of processing for Check_Abstract_Primitives
11274
11275 begin
11276 -- Loop over all of the formal derived type's primitives
11277
11278 Gen_Elmt := First_Elmt (Gen_Prims);
11279 while Present (Gen_Elmt) loop
11280 Gen_Subp := Node (Gen_Elmt);
11281
11282 -- If the primitive of the formal is not abstract, then
11283 -- determine whether there is a corresponding primitive of
11284 -- the actual type that's abstract.
11285
11286 if not Is_Abstract_Subprogram (Gen_Subp) then
11287 Act_Elmt := First_Elmt (Act_Prims);
11288 while Present (Act_Elmt) loop
11289 Act_Subp := Node (Act_Elmt);
11290
11291 -- If we find an abstract primitive of the actual,
11292 -- then we need to test whether it corresponds to the
11293 -- subprogram from which the generic formal primitive
11294 -- is inherited.
11295
11296 if Is_Abstract_Subprogram (Act_Subp) then
11297 Anc_Subp := Alias (Gen_Subp);
11298
11299 -- Test whether we have a corresponding primitive
11300 -- by comparing names, kinds, formal types, and
11301 -- result types.
11302
11303 if Chars (Anc_Subp) = Chars (Act_Subp)
11304 and then Ekind (Anc_Subp) = Ekind (Act_Subp)
11305 then
11306 Anc_Formal := First_Formal (Anc_Subp);
11307 Act_Formal := First_Formal (Act_Subp);
11308 while Present (Anc_Formal)
11309 and then Present (Act_Formal)
11310 loop
11311 Anc_F_Type := Etype (Anc_Formal);
11312 Act_F_Type := Etype (Act_Formal);
11313
11314 if Ekind (Anc_F_Type)
11315 = E_Anonymous_Access_Type
11316 then
11317 Anc_F_Type := Designated_Type (Anc_F_Type);
11318
11319 if Ekind (Act_F_Type)
11320 = E_Anonymous_Access_Type
11321 then
11322 Act_F_Type :=
11323 Designated_Type (Act_F_Type);
11324 else
11325 exit;
11326 end if;
11327
11328 elsif
11329 Ekind (Act_F_Type) = E_Anonymous_Access_Type
11330 then
11331 exit;
11332 end if;
11333
11334 Anc_F_Type := Base_Type (Anc_F_Type);
11335 Act_F_Type := Base_Type (Act_F_Type);
11336
11337 -- If the formal is controlling, then the
11338 -- the type of the actual primitive's formal
11339 -- must be derived directly or indirectly
11340 -- from the type of the ancestor primitive's
11341 -- formal.
11342
11343 if Is_Controlling_Formal (Anc_Formal) then
11344 if not Is_Tagged_Ancestor
11345 (Anc_F_Type, Act_F_Type)
11346 then
11347 exit;
11348 end if;
11349
11350 -- Otherwise the types of the formals must
11351 -- be the same.
11352
11353 elsif Anc_F_Type /= Act_F_Type then
11354 exit;
11355 end if;
11356
11357 Next_Entity (Anc_Formal);
11358 Next_Entity (Act_Formal);
11359 end loop;
11360
11361 -- If we traversed through all of the formals
11362 -- then so far the subprograms correspond, so
11363 -- now check that any result types correspond.
11364
11365 if No (Anc_Formal) and then No (Act_Formal) then
11366 Subprograms_Correspond := True;
11367
11368 if Ekind (Act_Subp) = E_Function then
11369 Anc_F_Type := Etype (Anc_Subp);
11370 Act_F_Type := Etype (Act_Subp);
11371
11372 if Ekind (Anc_F_Type)
11373 = E_Anonymous_Access_Type
11374 then
11375 Anc_F_Type :=
11376 Designated_Type (Anc_F_Type);
11377
11378 if Ekind (Act_F_Type)
11379 = E_Anonymous_Access_Type
11380 then
11381 Act_F_Type :=
11382 Designated_Type (Act_F_Type);
11383 else
11384 Subprograms_Correspond := False;
11385 end if;
11386
11387 elsif
11388 Ekind (Act_F_Type)
11389 = E_Anonymous_Access_Type
11390 then
11391 Subprograms_Correspond := False;
11392 end if;
11393
11394 Anc_F_Type := Base_Type (Anc_F_Type);
11395 Act_F_Type := Base_Type (Act_F_Type);
11396
11397 -- Now either the result types must be
11398 -- the same or, if the result type is
11399 -- controlling, the result type of the
11400 -- actual primitive must descend from the
11401 -- result type of the ancestor primitive.
11402
11403 if Subprograms_Correspond
11404 and then Anc_F_Type /= Act_F_Type
11405 and then
11406 Has_Controlling_Result (Anc_Subp)
11407 and then
11408 not Is_Tagged_Ancestor
11409 (Anc_F_Type, Act_F_Type)
11410 then
11411 Subprograms_Correspond := False;
11412 end if;
11413 end if;
11414
11415 -- Found a matching subprogram belonging to
11416 -- formal ancestor type, so actual subprogram
11417 -- corresponds and this violates 3.9.3(9).
11418
11419 if Subprograms_Correspond then
11420 Error_Msg_NE
11421 ("abstract subprogram & overrides " &
11422 "nonabstract subprogram of ancestor",
11423 Actual,
11424 Act_Subp);
11425 end if;
11426 end if;
11427 end if;
11428 end if;
11429
11430 Next_Elmt (Act_Elmt);
11431 end loop;
11432 end if;
11433
11434 Next_Elmt (Gen_Elmt);
11435 end loop;
11436 end Check_Abstract_Primitives;
11437 end if;
11438
11439 -- Verify that limitedness matches. If parent is a limited
11440 -- interface then the generic formal is not unless declared
11441 -- explicitly so. If not declared limited, the actual cannot be
11442 -- limited (see AI05-0087).
11443
11444 -- Even though this AI is a binding interpretation, we enable the
11445 -- check only in Ada 2012 mode, because this improper construct
11446 -- shows up in user code and in existing B-tests.
11447
11448 if Is_Limited_Type (Act_T)
11449 and then not Is_Limited_Type (A_Gen_T)
11450 and then Ada_Version >= Ada_2012
11451 then
11452 if In_Instance then
11453 null;
11454 else
11455 Error_Msg_NE
11456 ("actual for non-limited & cannot be a limited type", Actual,
11457 Gen_T);
11458 Explain_Limited_Type (Act_T, Actual);
11459 Abandon_Instantiation (Actual);
11460 end if;
11461 end if;
11462 end Validate_Derived_Type_Instance;
11463
11464 ----------------------------------------
11465 -- Validate_Discriminated_Formal_Type --
11466 ----------------------------------------
11467
11468 procedure Validate_Discriminated_Formal_Type is
11469 Formal_Discr : Entity_Id;
11470 Actual_Discr : Entity_Id;
11471 Formal_Subt : Entity_Id;
11472
11473 begin
11474 if Has_Discriminants (A_Gen_T) then
11475 if not Has_Discriminants (Act_T) then
11476 Error_Msg_NE
11477 ("actual for & must have discriminants", Actual, Gen_T);
11478 Abandon_Instantiation (Actual);
11479
11480 elsif Is_Constrained (Act_T) then
11481 Error_Msg_NE
11482 ("actual for & must be unconstrained", Actual, Gen_T);
11483 Abandon_Instantiation (Actual);
11484
11485 else
11486 Formal_Discr := First_Discriminant (A_Gen_T);
11487 Actual_Discr := First_Discriminant (Act_T);
11488 while Formal_Discr /= Empty loop
11489 if Actual_Discr = Empty then
11490 Error_Msg_NE
11491 ("discriminants on actual do not match formal",
11492 Actual, Gen_T);
11493 Abandon_Instantiation (Actual);
11494 end if;
11495
11496 Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
11497
11498 -- Access discriminants match if designated types do
11499
11500 if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
11501 and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
11502 E_Anonymous_Access_Type
11503 and then
11504 Get_Instance_Of
11505 (Designated_Type (Base_Type (Formal_Subt))) =
11506 Designated_Type (Base_Type (Etype (Actual_Discr)))
11507 then
11508 null;
11509
11510 elsif Base_Type (Formal_Subt) /=
11511 Base_Type (Etype (Actual_Discr))
11512 then
11513 Error_Msg_NE
11514 ("types of actual discriminants must match formal",
11515 Actual, Gen_T);
11516 Abandon_Instantiation (Actual);
11517
11518 elsif not Subtypes_Statically_Match
11519 (Formal_Subt, Etype (Actual_Discr))
11520 and then Ada_Version >= Ada_95
11521 then
11522 Error_Msg_NE
11523 ("subtypes of actual discriminants must match formal",
11524 Actual, Gen_T);
11525 Abandon_Instantiation (Actual);
11526 end if;
11527
11528 Next_Discriminant (Formal_Discr);
11529 Next_Discriminant (Actual_Discr);
11530 end loop;
11531
11532 if Actual_Discr /= Empty then
11533 Error_Msg_NE
11534 ("discriminants on actual do not match formal",
11535 Actual, Gen_T);
11536 Abandon_Instantiation (Actual);
11537 end if;
11538 end if;
11539 end if;
11540 end Validate_Discriminated_Formal_Type;
11541
11542 ---------------------------------------
11543 -- Validate_Incomplete_Type_Instance --
11544 ---------------------------------------
11545
11546 procedure Validate_Incomplete_Type_Instance is
11547 begin
11548 if not Is_Tagged_Type (Act_T)
11549 and then Is_Tagged_Type (A_Gen_T)
11550 then
11551 Error_Msg_NE
11552 ("actual for & must be a tagged type", Actual, Gen_T);
11553 end if;
11554
11555 Validate_Discriminated_Formal_Type;
11556 end Validate_Incomplete_Type_Instance;
11557
11558 --------------------------------------
11559 -- Validate_Interface_Type_Instance --
11560 --------------------------------------
11561
11562 procedure Validate_Interface_Type_Instance is
11563 begin
11564 if not Is_Interface (Act_T) then
11565 Error_Msg_NE
11566 ("actual for formal interface type must be an interface",
11567 Actual, Gen_T);
11568
11569 elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
11570 or else
11571 Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
11572 or else
11573 Is_Protected_Interface (A_Gen_T) /=
11574 Is_Protected_Interface (Act_T)
11575 or else
11576 Is_Synchronized_Interface (A_Gen_T) /=
11577 Is_Synchronized_Interface (Act_T)
11578 then
11579 Error_Msg_NE
11580 ("actual for interface& does not match (RM 12.5.5(4))",
11581 Actual, Gen_T);
11582 end if;
11583 end Validate_Interface_Type_Instance;
11584
11585 ------------------------------------
11586 -- Validate_Private_Type_Instance --
11587 ------------------------------------
11588
11589 procedure Validate_Private_Type_Instance is
11590 begin
11591 if Is_Limited_Type (Act_T)
11592 and then not Is_Limited_Type (A_Gen_T)
11593 then
11594 if In_Instance then
11595 null;
11596 else
11597 Error_Msg_NE
11598 ("actual for non-limited & cannot be a limited type", Actual,
11599 Gen_T);
11600 Explain_Limited_Type (Act_T, Actual);
11601 Abandon_Instantiation (Actual);
11602 end if;
11603
11604 elsif Known_To_Have_Preelab_Init (A_Gen_T)
11605 and then not Has_Preelaborable_Initialization (Act_T)
11606 then
11607 Error_Msg_NE
11608 ("actual for & must have preelaborable initialization", Actual,
11609 Gen_T);
11610
11611 elsif Is_Indefinite_Subtype (Act_T)
11612 and then not Is_Indefinite_Subtype (A_Gen_T)
11613 and then Ada_Version >= Ada_95
11614 then
11615 Error_Msg_NE
11616 ("actual for & must be a definite subtype", Actual, Gen_T);
11617
11618 elsif not Is_Tagged_Type (Act_T)
11619 and then Is_Tagged_Type (A_Gen_T)
11620 then
11621 Error_Msg_NE
11622 ("actual for & must be a tagged type", Actual, Gen_T);
11623 end if;
11624
11625 Validate_Discriminated_Formal_Type;
11626 Ancestor := Gen_T;
11627 end Validate_Private_Type_Instance;
11628
11629 -- Start of processing for Instantiate_Type
11630
11631 begin
11632 if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
11633 Error_Msg_N ("duplicate instantiation of generic type", Actual);
11634 return New_List (Error);
11635
11636 elsif not Is_Entity_Name (Actual)
11637 or else not Is_Type (Entity (Actual))
11638 then
11639 Error_Msg_NE
11640 ("expect valid subtype mark to instantiate &", Actual, Gen_T);
11641 Abandon_Instantiation (Actual);
11642
11643 else
11644 Act_T := Entity (Actual);
11645
11646 -- Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
11647 -- as a generic actual parameter if the corresponding formal type
11648 -- does not have a known_discriminant_part, or is a formal derived
11649 -- type that is an Unchecked_Union type.
11650
11651 if Is_Unchecked_Union (Base_Type (Act_T)) then
11652 if not Has_Discriminants (A_Gen_T)
11653 or else
11654 (Is_Derived_Type (A_Gen_T)
11655 and then
11656 Is_Unchecked_Union (A_Gen_T))
11657 then
11658 null;
11659 else
11660 Error_Msg_N ("unchecked union cannot be the actual for a" &
11661 " discriminated formal type", Act_T);
11662
11663 end if;
11664 end if;
11665
11666 -- Deal with fixed/floating restrictions
11667
11668 if Is_Floating_Point_Type (Act_T) then
11669 Check_Restriction (No_Floating_Point, Actual);
11670 elsif Is_Fixed_Point_Type (Act_T) then
11671 Check_Restriction (No_Fixed_Point, Actual);
11672 end if;
11673
11674 -- Deal with error of using incomplete type as generic actual.
11675 -- This includes limited views of a type, even if the non-limited
11676 -- view may be available.
11677
11678 if Ekind (Act_T) = E_Incomplete_Type
11679 or else (Is_Class_Wide_Type (Act_T)
11680 and then
11681 Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
11682 then
11683 -- If the formal is an incomplete type, the actual can be
11684 -- incomplete as well.
11685
11686 if Ekind (A_Gen_T) = E_Incomplete_Type then
11687 null;
11688
11689 elsif Is_Class_Wide_Type (Act_T)
11690 or else No (Full_View (Act_T))
11691 then
11692 Error_Msg_N ("premature use of incomplete type", Actual);
11693 Abandon_Instantiation (Actual);
11694 else
11695 Act_T := Full_View (Act_T);
11696 Set_Entity (Actual, Act_T);
11697
11698 if Has_Private_Component (Act_T) then
11699 Error_Msg_N
11700 ("premature use of type with private component", Actual);
11701 end if;
11702 end if;
11703
11704 -- Deal with error of premature use of private type as generic actual
11705
11706 elsif Is_Private_Type (Act_T)
11707 and then Is_Private_Type (Base_Type (Act_T))
11708 and then not Is_Generic_Type (Act_T)
11709 and then not Is_Derived_Type (Act_T)
11710 and then No (Full_View (Root_Type (Act_T)))
11711 then
11712 -- If the formal is an incomplete type, the actual can be
11713 -- private or incomplete as well.
11714
11715 if Ekind (A_Gen_T) = E_Incomplete_Type then
11716 null;
11717 else
11718 Error_Msg_N ("premature use of private type", Actual);
11719 end if;
11720
11721 elsif Has_Private_Component (Act_T) then
11722 Error_Msg_N
11723 ("premature use of type with private component", Actual);
11724 end if;
11725
11726 Set_Instance_Of (A_Gen_T, Act_T);
11727
11728 -- If the type is generic, the class-wide type may also be used
11729
11730 if Is_Tagged_Type (A_Gen_T)
11731 and then Is_Tagged_Type (Act_T)
11732 and then not Is_Class_Wide_Type (A_Gen_T)
11733 then
11734 Set_Instance_Of (Class_Wide_Type (A_Gen_T),
11735 Class_Wide_Type (Act_T));
11736 end if;
11737
11738 if not Is_Abstract_Type (A_Gen_T)
11739 and then Is_Abstract_Type (Act_T)
11740 then
11741 Error_Msg_N
11742 ("actual of non-abstract formal cannot be abstract", Actual);
11743 end if;
11744
11745 -- A generic scalar type is a first subtype for which we generate
11746 -- an anonymous base type. Indicate that the instance of this base
11747 -- is the base type of the actual.
11748
11749 if Is_Scalar_Type (A_Gen_T) then
11750 Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
11751 end if;
11752 end if;
11753
11754 if Error_Posted (Act_T) then
11755 null;
11756 else
11757 case Nkind (Def) is
11758 when N_Formal_Private_Type_Definition =>
11759 Validate_Private_Type_Instance;
11760
11761 when N_Formal_Incomplete_Type_Definition =>
11762 Validate_Incomplete_Type_Instance;
11763
11764 when N_Formal_Derived_Type_Definition =>
11765 Validate_Derived_Type_Instance;
11766
11767 when N_Formal_Discrete_Type_Definition =>
11768 if not Is_Discrete_Type (Act_T) then
11769 Error_Msg_NE
11770 ("expect discrete type in instantiation of&",
11771 Actual, Gen_T);
11772 Abandon_Instantiation (Actual);
11773 end if;
11774
11775 when N_Formal_Signed_Integer_Type_Definition =>
11776 if not Is_Signed_Integer_Type (Act_T) then
11777 Error_Msg_NE
11778 ("expect signed integer type in instantiation of&",
11779 Actual, Gen_T);
11780 Abandon_Instantiation (Actual);
11781 end if;
11782
11783 when N_Formal_Modular_Type_Definition =>
11784 if not Is_Modular_Integer_Type (Act_T) then
11785 Error_Msg_NE
11786 ("expect modular type in instantiation of &",
11787 Actual, Gen_T);
11788 Abandon_Instantiation (Actual);
11789 end if;
11790
11791 when N_Formal_Floating_Point_Definition =>
11792 if not Is_Floating_Point_Type (Act_T) then
11793 Error_Msg_NE
11794 ("expect float type in instantiation of &", Actual, Gen_T);
11795 Abandon_Instantiation (Actual);
11796 end if;
11797
11798 when N_Formal_Ordinary_Fixed_Point_Definition =>
11799 if not Is_Ordinary_Fixed_Point_Type (Act_T) then
11800 Error_Msg_NE
11801 ("expect ordinary fixed point type in instantiation of &",
11802 Actual, Gen_T);
11803 Abandon_Instantiation (Actual);
11804 end if;
11805
11806 when N_Formal_Decimal_Fixed_Point_Definition =>
11807 if not Is_Decimal_Fixed_Point_Type (Act_T) then
11808 Error_Msg_NE
11809 ("expect decimal type in instantiation of &",
11810 Actual, Gen_T);
11811 Abandon_Instantiation (Actual);
11812 end if;
11813
11814 when N_Array_Type_Definition =>
11815 Validate_Array_Type_Instance;
11816
11817 when N_Access_To_Object_Definition =>
11818 Validate_Access_Type_Instance;
11819
11820 when N_Access_Function_Definition |
11821 N_Access_Procedure_Definition =>
11822 Validate_Access_Subprogram_Instance;
11823
11824 when N_Record_Definition =>
11825 Validate_Interface_Type_Instance;
11826
11827 when N_Derived_Type_Definition =>
11828 Validate_Derived_Interface_Type_Instance;
11829
11830 when others =>
11831 raise Program_Error;
11832
11833 end case;
11834 end if;
11835
11836 Subt := New_Copy (Gen_T);
11837
11838 -- Use adjusted sloc of subtype name as the location for other nodes in
11839 -- the subtype declaration.
11840
11841 Loc := Sloc (Subt);
11842
11843 Decl_Node :=
11844 Make_Subtype_Declaration (Loc,
11845 Defining_Identifier => Subt,
11846 Subtype_Indication => New_Occurrence_Of (Act_T, Loc));
11847
11848 if Is_Private_Type (Act_T) then
11849 Set_Has_Private_View (Subtype_Indication (Decl_Node));
11850
11851 elsif Is_Access_Type (Act_T)
11852 and then Is_Private_Type (Designated_Type (Act_T))
11853 then
11854 Set_Has_Private_View (Subtype_Indication (Decl_Node));
11855 end if;
11856
11857 Decl_Nodes := New_List (Decl_Node);
11858
11859 -- Flag actual derived types so their elaboration produces the
11860 -- appropriate renamings for the primitive operations of the ancestor.
11861 -- Flag actual for formal private types as well, to determine whether
11862 -- operations in the private part may override inherited operations.
11863 -- If the formal has an interface list, the ancestor is not the
11864 -- parent, but the analyzed formal that includes the interface
11865 -- operations of all its progenitors.
11866
11867 -- Same treatment for formal private types, so we can check whether the
11868 -- type is tagged limited when validating derivations in the private
11869 -- part. (See AI05-096).
11870
11871 if Nkind (Def) = N_Formal_Derived_Type_Definition then
11872 if Present (Interface_List (Def)) then
11873 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11874 else
11875 Set_Generic_Parent_Type (Decl_Node, Ancestor);
11876 end if;
11877
11878 elsif Nkind_In (Def,
11879 N_Formal_Private_Type_Definition,
11880 N_Formal_Incomplete_Type_Definition)
11881 then
11882 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11883 end if;
11884
11885 -- If the actual is a synchronized type that implements an interface,
11886 -- the primitive operations are attached to the corresponding record,
11887 -- and we have to treat it as an additional generic actual, so that its
11888 -- primitive operations become visible in the instance. The task or
11889 -- protected type itself does not carry primitive operations.
11890
11891 if Is_Concurrent_Type (Act_T)
11892 and then Is_Tagged_Type (Act_T)
11893 and then Present (Corresponding_Record_Type (Act_T))
11894 and then Present (Ancestor)
11895 and then Is_Interface (Ancestor)
11896 then
11897 declare
11898 Corr_Rec : constant Entity_Id :=
11899 Corresponding_Record_Type (Act_T);
11900 New_Corr : Entity_Id;
11901 Corr_Decl : Node_Id;
11902
11903 begin
11904 New_Corr := Make_Temporary (Loc, 'S');
11905 Corr_Decl :=
11906 Make_Subtype_Declaration (Loc,
11907 Defining_Identifier => New_Corr,
11908 Subtype_Indication =>
11909 New_Occurrence_Of (Corr_Rec, Loc));
11910 Append_To (Decl_Nodes, Corr_Decl);
11911
11912 if Ekind (Act_T) = E_Task_Type then
11913 Set_Ekind (Subt, E_Task_Subtype);
11914 else
11915 Set_Ekind (Subt, E_Protected_Subtype);
11916 end if;
11917
11918 Set_Corresponding_Record_Type (Subt, Corr_Rec);
11919 Set_Generic_Parent_Type (Corr_Decl, Ancestor);
11920 Set_Generic_Parent_Type (Decl_Node, Empty);
11921 end;
11922 end if;
11923
11924 return Decl_Nodes;
11925 end Instantiate_Type;
11926
11927 ---------------------
11928 -- Is_In_Main_Unit --
11929 ---------------------
11930
11931 function Is_In_Main_Unit (N : Node_Id) return Boolean is
11932 Unum : constant Unit_Number_Type := Get_Source_Unit (N);
11933 Current_Unit : Node_Id;
11934
11935 begin
11936 if Unum = Main_Unit then
11937 return True;
11938
11939 -- If the current unit is a subunit then it is either the main unit or
11940 -- is being compiled as part of the main unit.
11941
11942 elsif Nkind (N) = N_Compilation_Unit then
11943 return Nkind (Unit (N)) = N_Subunit;
11944 end if;
11945
11946 Current_Unit := Parent (N);
11947 while Present (Current_Unit)
11948 and then Nkind (Current_Unit) /= N_Compilation_Unit
11949 loop
11950 Current_Unit := Parent (Current_Unit);
11951 end loop;
11952
11953 -- The instantiation node is in the main unit, or else the current node
11954 -- (perhaps as the result of nested instantiations) is in the main unit,
11955 -- or in the declaration of the main unit, which in this last case must
11956 -- be a body.
11957
11958 return Unum = Main_Unit
11959 or else Current_Unit = Cunit (Main_Unit)
11960 or else Current_Unit = Library_Unit (Cunit (Main_Unit))
11961 or else (Present (Library_Unit (Current_Unit))
11962 and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
11963 end Is_In_Main_Unit;
11964
11965 ----------------------------
11966 -- Load_Parent_Of_Generic --
11967 ----------------------------
11968
11969 procedure Load_Parent_Of_Generic
11970 (N : Node_Id;
11971 Spec : Node_Id;
11972 Body_Optional : Boolean := False)
11973 is
11974 Comp_Unit : constant Node_Id := Cunit (Get_Source_Unit (Spec));
11975 Saved_Style_Check : constant Boolean := Style_Check;
11976 Saved_Warnings : constant Warning_Record := Save_Warnings;
11977 True_Parent : Node_Id;
11978 Inst_Node : Node_Id;
11979 OK : Boolean;
11980 Previous_Instances : constant Elist_Id := New_Elmt_List;
11981
11982 procedure Collect_Previous_Instances (Decls : List_Id);
11983 -- Collect all instantiations in the given list of declarations, that
11984 -- precede the generic that we need to load. If the bodies of these
11985 -- instantiations are available, we must analyze them, to ensure that
11986 -- the public symbols generated are the same when the unit is compiled
11987 -- to generate code, and when it is compiled in the context of a unit
11988 -- that needs a particular nested instance. This process is applied to
11989 -- both package and subprogram instances.
11990
11991 --------------------------------
11992 -- Collect_Previous_Instances --
11993 --------------------------------
11994
11995 procedure Collect_Previous_Instances (Decls : List_Id) is
11996 Decl : Node_Id;
11997
11998 begin
11999 Decl := First (Decls);
12000 while Present (Decl) loop
12001 if Sloc (Decl) >= Sloc (Inst_Node) then
12002 return;
12003
12004 -- If Decl is an instantiation, then record it as requiring
12005 -- instantiation of the corresponding body, except if it is an
12006 -- abbreviated instantiation generated internally for conformance
12007 -- checking purposes only for the case of a formal package
12008 -- declared without a box (see Instantiate_Formal_Package). Such
12009 -- an instantiation does not generate any code (the actual code
12010 -- comes from actual) and thus does not need to be analyzed here.
12011 -- If the instantiation appears with a generic package body it is
12012 -- not analyzed here either.
12013
12014 elsif Nkind (Decl) = N_Package_Instantiation
12015 and then not Is_Internal (Defining_Entity (Decl))
12016 then
12017 Append_Elmt (Decl, Previous_Instances);
12018
12019 -- For a subprogram instantiation, omit instantiations intrinsic
12020 -- operations (Unchecked_Conversions, etc.) that have no bodies.
12021
12022 elsif Nkind_In (Decl, N_Function_Instantiation,
12023 N_Procedure_Instantiation)
12024 and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
12025 then
12026 Append_Elmt (Decl, Previous_Instances);
12027
12028 elsif Nkind (Decl) = N_Package_Declaration then
12029 Collect_Previous_Instances
12030 (Visible_Declarations (Specification (Decl)));
12031 Collect_Previous_Instances
12032 (Private_Declarations (Specification (Decl)));
12033
12034 -- Previous non-generic bodies may contain instances as well
12035
12036 elsif Nkind (Decl) = N_Package_Body
12037 and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
12038 then
12039 Collect_Previous_Instances (Declarations (Decl));
12040
12041 elsif Nkind (Decl) = N_Subprogram_Body
12042 and then not Acts_As_Spec (Decl)
12043 and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
12044 then
12045 Collect_Previous_Instances (Declarations (Decl));
12046 end if;
12047
12048 Next (Decl);
12049 end loop;
12050 end Collect_Previous_Instances;
12051
12052 -- Start of processing for Load_Parent_Of_Generic
12053
12054 begin
12055 if not In_Same_Source_Unit (N, Spec)
12056 or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
12057 or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
12058 and then not Is_In_Main_Unit (Spec))
12059 then
12060 -- Find body of parent of spec, and analyze it. A special case arises
12061 -- when the parent is an instantiation, that is to say when we are
12062 -- currently instantiating a nested generic. In that case, there is
12063 -- no separate file for the body of the enclosing instance. Instead,
12064 -- the enclosing body must be instantiated as if it were a pending
12065 -- instantiation, in order to produce the body for the nested generic
12066 -- we require now. Note that in that case the generic may be defined
12067 -- in a package body, the instance defined in the same package body,
12068 -- and the original enclosing body may not be in the main unit.
12069
12070 Inst_Node := Empty;
12071
12072 True_Parent := Parent (Spec);
12073 while Present (True_Parent)
12074 and then Nkind (True_Parent) /= N_Compilation_Unit
12075 loop
12076 if Nkind (True_Parent) = N_Package_Declaration
12077 and then
12078 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
12079 then
12080 -- Parent is a compilation unit that is an instantiation.
12081 -- Instantiation node has been replaced with package decl.
12082
12083 Inst_Node := Original_Node (True_Parent);
12084 exit;
12085
12086 elsif Nkind (True_Parent) = N_Package_Declaration
12087 and then Present (Generic_Parent (Specification (True_Parent)))
12088 and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12089 then
12090 -- Parent is an instantiation within another specification.
12091 -- Declaration for instance has been inserted before original
12092 -- instantiation node. A direct link would be preferable?
12093
12094 Inst_Node := Next (True_Parent);
12095 while Present (Inst_Node)
12096 and then Nkind (Inst_Node) /= N_Package_Instantiation
12097 loop
12098 Next (Inst_Node);
12099 end loop;
12100
12101 -- If the instance appears within a generic, and the generic
12102 -- unit is defined within a formal package of the enclosing
12103 -- generic, there is no generic body available, and none
12104 -- needed. A more precise test should be used ???
12105
12106 if No (Inst_Node) then
12107 return;
12108 end if;
12109
12110 exit;
12111
12112 else
12113 True_Parent := Parent (True_Parent);
12114 end if;
12115 end loop;
12116
12117 -- Case where we are currently instantiating a nested generic
12118
12119 if Present (Inst_Node) then
12120 if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
12121
12122 -- Instantiation node and declaration of instantiated package
12123 -- were exchanged when only the declaration was needed.
12124 -- Restore instantiation node before proceeding with body.
12125
12126 Set_Unit (Parent (True_Parent), Inst_Node);
12127 end if;
12128
12129 -- Now complete instantiation of enclosing body, if it appears in
12130 -- some other unit. If it appears in the current unit, the body
12131 -- will have been instantiated already.
12132
12133 if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
12134
12135 -- We need to determine the expander mode to instantiate the
12136 -- enclosing body. Because the generic body we need may use
12137 -- global entities declared in the enclosing package (including
12138 -- aggregates) it is in general necessary to compile this body
12139 -- with expansion enabled, except if we are within a generic
12140 -- package, in which case the usual generic rule applies.
12141
12142 declare
12143 Exp_Status : Boolean := True;
12144 Scop : Entity_Id;
12145
12146 begin
12147 -- Loop through scopes looking for generic package
12148
12149 Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
12150 while Present (Scop)
12151 and then Scop /= Standard_Standard
12152 loop
12153 if Ekind (Scop) = E_Generic_Package then
12154 Exp_Status := False;
12155 exit;
12156 end if;
12157
12158 Scop := Scope (Scop);
12159 end loop;
12160
12161 -- Collect previous instantiations in the unit that contains
12162 -- the desired generic.
12163
12164 if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12165 and then not Body_Optional
12166 then
12167 declare
12168 Decl : Elmt_Id;
12169 Info : Pending_Body_Info;
12170 Par : Node_Id;
12171
12172 begin
12173 Par := Parent (Inst_Node);
12174 while Present (Par) loop
12175 exit when Nkind (Parent (Par)) = N_Compilation_Unit;
12176 Par := Parent (Par);
12177 end loop;
12178
12179 pragma Assert (Present (Par));
12180
12181 if Nkind (Par) = N_Package_Body then
12182 Collect_Previous_Instances (Declarations (Par));
12183
12184 elsif Nkind (Par) = N_Package_Declaration then
12185 Collect_Previous_Instances
12186 (Visible_Declarations (Specification (Par)));
12187 Collect_Previous_Instances
12188 (Private_Declarations (Specification (Par)));
12189
12190 else
12191 -- Enclosing unit is a subprogram body. In this
12192 -- case all instance bodies are processed in order
12193 -- and there is no need to collect them separately.
12194
12195 null;
12196 end if;
12197
12198 Decl := First_Elmt (Previous_Instances);
12199 while Present (Decl) loop
12200 Info :=
12201 (Inst_Node => Node (Decl),
12202 Act_Decl =>
12203 Instance_Spec (Node (Decl)),
12204 Expander_Status => Exp_Status,
12205 Current_Sem_Unit =>
12206 Get_Code_Unit (Sloc (Node (Decl))),
12207 Scope_Suppress => Scope_Suppress,
12208 Local_Suppress_Stack_Top =>
12209 Local_Suppress_Stack_Top,
12210 Version => Ada_Version,
12211 Version_Pragma => Ada_Version_Pragma,
12212 Warnings => Save_Warnings,
12213 SPARK_Mode => SPARK_Mode,
12214 SPARK_Mode_Pragma => SPARK_Mode_Pragma);
12215
12216 -- Package instance
12217
12218 if
12219 Nkind (Node (Decl)) = N_Package_Instantiation
12220 then
12221 Instantiate_Package_Body
12222 (Info, Body_Optional => True);
12223
12224 -- Subprogram instance
12225
12226 else
12227 -- The instance_spec is the wrapper package,
12228 -- and the subprogram declaration is the last
12229 -- declaration in the wrapper.
12230
12231 Info.Act_Decl :=
12232 Last
12233 (Visible_Declarations
12234 (Specification (Info.Act_Decl)));
12235
12236 Instantiate_Subprogram_Body
12237 (Info, Body_Optional => True);
12238 end if;
12239
12240 Next_Elmt (Decl);
12241 end loop;
12242 end;
12243 end if;
12244
12245 Instantiate_Package_Body
12246 (Body_Info =>
12247 ((Inst_Node => Inst_Node,
12248 Act_Decl => True_Parent,
12249 Expander_Status => Exp_Status,
12250 Current_Sem_Unit => Get_Code_Unit
12251 (Sloc (Inst_Node)),
12252 Scope_Suppress => Scope_Suppress,
12253 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
12254 Version => Ada_Version,
12255 Version_Pragma => Ada_Version_Pragma,
12256 Warnings => Save_Warnings,
12257 SPARK_Mode => SPARK_Mode,
12258 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
12259 Body_Optional => Body_Optional);
12260 end;
12261 end if;
12262
12263 -- Case where we are not instantiating a nested generic
12264
12265 else
12266 Opt.Style_Check := False;
12267 Expander_Mode_Save_And_Set (True);
12268 Load_Needed_Body (Comp_Unit, OK);
12269 Opt.Style_Check := Saved_Style_Check;
12270 Restore_Warnings (Saved_Warnings);
12271 Expander_Mode_Restore;
12272
12273 if not OK
12274 and then Unit_Requires_Body (Defining_Entity (Spec))
12275 and then not Body_Optional
12276 then
12277 declare
12278 Bname : constant Unit_Name_Type :=
12279 Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
12280
12281 begin
12282 -- In CodePeer mode, the missing body may make the analysis
12283 -- incomplete, but we do not treat it as fatal.
12284
12285 if CodePeer_Mode then
12286 return;
12287
12288 else
12289 Error_Msg_Unit_1 := Bname;
12290 Error_Msg_N ("this instantiation requires$!", N);
12291 Error_Msg_File_1 :=
12292 Get_File_Name (Bname, Subunit => False);
12293 Error_Msg_N ("\but file{ was not found!", N);
12294 raise Unrecoverable_Error;
12295 end if;
12296 end;
12297 end if;
12298 end if;
12299 end if;
12300
12301 -- If loading parent of the generic caused an instantiation circularity,
12302 -- we abandon compilation at this point, because otherwise in some cases
12303 -- we get into trouble with infinite recursions after this point.
12304
12305 if Circularity_Detected then
12306 raise Unrecoverable_Error;
12307 end if;
12308 end Load_Parent_Of_Generic;
12309
12310 ---------------------------------
12311 -- Map_Formal_Package_Entities --
12312 ---------------------------------
12313
12314 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
12315 E1 : Entity_Id;
12316 E2 : Entity_Id;
12317
12318 begin
12319 Set_Instance_Of (Form, Act);
12320
12321 -- Traverse formal and actual package to map the corresponding entities.
12322 -- We skip over internal entities that may be generated during semantic
12323 -- analysis, and find the matching entities by name, given that they
12324 -- must appear in the same order.
12325
12326 E1 := First_Entity (Form);
12327 E2 := First_Entity (Act);
12328 while Present (E1) and then E1 /= First_Private_Entity (Form) loop
12329 -- Could this test be a single condition??? Seems like it could, and
12330 -- isn't FPE (Form) a constant anyway???
12331
12332 if not Is_Internal (E1)
12333 and then Present (Parent (E1))
12334 and then not Is_Class_Wide_Type (E1)
12335 and then not Is_Internal_Name (Chars (E1))
12336 then
12337 while Present (E2) and then Chars (E2) /= Chars (E1) loop
12338 Next_Entity (E2);
12339 end loop;
12340
12341 if No (E2) then
12342 exit;
12343 else
12344 Set_Instance_Of (E1, E2);
12345
12346 if Is_Type (E1) and then Is_Tagged_Type (E2) then
12347 Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
12348 end if;
12349
12350 if Is_Constrained (E1) then
12351 Set_Instance_Of (Base_Type (E1), Base_Type (E2));
12352 end if;
12353
12354 if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
12355 Map_Formal_Package_Entities (E1, E2);
12356 end if;
12357 end if;
12358 end if;
12359
12360 Next_Entity (E1);
12361 end loop;
12362 end Map_Formal_Package_Entities;
12363
12364 -----------------------
12365 -- Move_Freeze_Nodes --
12366 -----------------------
12367
12368 procedure Move_Freeze_Nodes
12369 (Out_Of : Entity_Id;
12370 After : Node_Id;
12371 L : List_Id)
12372 is
12373 Decl : Node_Id;
12374 Next_Decl : Node_Id;
12375 Next_Node : Node_Id := After;
12376 Spec : Node_Id;
12377
12378 function Is_Outer_Type (T : Entity_Id) return Boolean;
12379 -- Check whether entity is declared in a scope external to that of the
12380 -- generic unit.
12381
12382 -------------------
12383 -- Is_Outer_Type --
12384 -------------------
12385
12386 function Is_Outer_Type (T : Entity_Id) return Boolean is
12387 Scop : Entity_Id := Scope (T);
12388
12389 begin
12390 if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12391 return True;
12392
12393 else
12394 while Scop /= Standard_Standard loop
12395 if Scop = Out_Of then
12396 return False;
12397 else
12398 Scop := Scope (Scop);
12399 end if;
12400 end loop;
12401
12402 return True;
12403 end if;
12404 end Is_Outer_Type;
12405
12406 -- Start of processing for Move_Freeze_Nodes
12407
12408 begin
12409 if No (L) then
12410 return;
12411 end if;
12412
12413 -- First remove the freeze nodes that may appear before all other
12414 -- declarations.
12415
12416 Decl := First (L);
12417 while Present (Decl)
12418 and then Nkind (Decl) = N_Freeze_Entity
12419 and then Is_Outer_Type (Entity (Decl))
12420 loop
12421 Decl := Remove_Head (L);
12422 Insert_After (Next_Node, Decl);
12423 Set_Analyzed (Decl, False);
12424 Next_Node := Decl;
12425 Decl := First (L);
12426 end loop;
12427
12428 -- Next scan the list of declarations and remove each freeze node that
12429 -- appears ahead of the current node.
12430
12431 while Present (Decl) loop
12432 while Present (Next (Decl))
12433 and then Nkind (Next (Decl)) = N_Freeze_Entity
12434 and then Is_Outer_Type (Entity (Next (Decl)))
12435 loop
12436 Next_Decl := Remove_Next (Decl);
12437 Insert_After (Next_Node, Next_Decl);
12438 Set_Analyzed (Next_Decl, False);
12439 Next_Node := Next_Decl;
12440 end loop;
12441
12442 -- If the declaration is a nested package or concurrent type, then
12443 -- recurse. Nested generic packages will have been processed from the
12444 -- inside out.
12445
12446 case Nkind (Decl) is
12447 when N_Package_Declaration =>
12448 Spec := Specification (Decl);
12449
12450 when N_Task_Type_Declaration =>
12451 Spec := Task_Definition (Decl);
12452
12453 when N_Protected_Type_Declaration =>
12454 Spec := Protected_Definition (Decl);
12455
12456 when others =>
12457 Spec := Empty;
12458 end case;
12459
12460 if Present (Spec) then
12461 Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
12462 Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
12463 end if;
12464
12465 Next (Decl);
12466 end loop;
12467 end Move_Freeze_Nodes;
12468
12469 ----------------
12470 -- Next_Assoc --
12471 ----------------
12472
12473 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
12474 begin
12475 return Generic_Renamings.Table (E).Next_In_HTable;
12476 end Next_Assoc;
12477
12478 ------------------------
12479 -- Preanalyze_Actuals --
12480 ------------------------
12481
12482 procedure Preanalyze_Actuals (N : Node_Id) is
12483 Assoc : Node_Id;
12484 Act : Node_Id;
12485 Errs : constant Int := Serious_Errors_Detected;
12486
12487 Cur : Entity_Id := Empty;
12488 -- Current homograph of the instance name
12489
12490 Vis : Boolean;
12491 -- Saved visibility status of the current homograph
12492
12493 begin
12494 Assoc := First (Generic_Associations (N));
12495
12496 -- If the instance is a child unit, its name may hide an outer homonym,
12497 -- so make it invisible to perform name resolution on the actuals.
12498
12499 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
12500 and then Present
12501 (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
12502 then
12503 Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
12504
12505 if Is_Compilation_Unit (Cur) then
12506 Vis := Is_Immediately_Visible (Cur);
12507 Set_Is_Immediately_Visible (Cur, False);
12508 else
12509 Cur := Empty;
12510 end if;
12511 end if;
12512
12513 while Present (Assoc) loop
12514 if Nkind (Assoc) /= N_Others_Choice then
12515 Act := Explicit_Generic_Actual_Parameter (Assoc);
12516
12517 -- Within a nested instantiation, a defaulted actual is an empty
12518 -- association, so nothing to analyze. If the subprogram actual
12519 -- is an attribute, analyze prefix only, because actual is not a
12520 -- complete attribute reference.
12521
12522 -- If actual is an allocator, analyze expression only. The full
12523 -- analysis can generate code, and if instance is a compilation
12524 -- unit we have to wait until the package instance is installed
12525 -- to have a proper place to insert this code.
12526
12527 -- String literals may be operators, but at this point we do not
12528 -- know whether the actual is a formal subprogram or a string.
12529
12530 if No (Act) then
12531 null;
12532
12533 elsif Nkind (Act) = N_Attribute_Reference then
12534 Analyze (Prefix (Act));
12535
12536 elsif Nkind (Act) = N_Explicit_Dereference then
12537 Analyze (Prefix (Act));
12538
12539 elsif Nkind (Act) = N_Allocator then
12540 declare
12541 Expr : constant Node_Id := Expression (Act);
12542
12543 begin
12544 if Nkind (Expr) = N_Subtype_Indication then
12545 Analyze (Subtype_Mark (Expr));
12546
12547 -- Analyze separately each discriminant constraint, when
12548 -- given with a named association.
12549
12550 declare
12551 Constr : Node_Id;
12552
12553 begin
12554 Constr := First (Constraints (Constraint (Expr)));
12555 while Present (Constr) loop
12556 if Nkind (Constr) = N_Discriminant_Association then
12557 Analyze (Expression (Constr));
12558 else
12559 Analyze (Constr);
12560 end if;
12561
12562 Next (Constr);
12563 end loop;
12564 end;
12565
12566 else
12567 Analyze (Expr);
12568 end if;
12569 end;
12570
12571 elsif Nkind (Act) /= N_Operator_Symbol then
12572 Analyze (Act);
12573 end if;
12574
12575 -- Ensure that a ghost subprogram does not act as generic actual
12576
12577 if Is_Entity_Name (Act)
12578 and then Is_Ghost_Subprogram (Entity (Act))
12579 then
12580 Error_Msg_N
12581 ("ghost subprogram & cannot act as generic actual", Act);
12582 Abandon_Instantiation (Act);
12583
12584 elsif Errs /= Serious_Errors_Detected then
12585
12586 -- Do a minimal analysis of the generic, to prevent spurious
12587 -- warnings complaining about the generic being unreferenced,
12588 -- before abandoning the instantiation.
12589
12590 Analyze (Name (N));
12591
12592 if Is_Entity_Name (Name (N))
12593 and then Etype (Name (N)) /= Any_Type
12594 then
12595 Generate_Reference (Entity (Name (N)), Name (N));
12596 Set_Is_Instantiated (Entity (Name (N)));
12597 end if;
12598
12599 if Present (Cur) then
12600
12601 -- For the case of a child instance hiding an outer homonym,
12602 -- provide additional warning which might explain the error.
12603
12604 Set_Is_Immediately_Visible (Cur, Vis);
12605 Error_Msg_NE ("& hides outer unit with the same name??",
12606 N, Defining_Unit_Name (N));
12607 end if;
12608
12609 Abandon_Instantiation (Act);
12610 end if;
12611 end if;
12612
12613 Next (Assoc);
12614 end loop;
12615
12616 if Present (Cur) then
12617 Set_Is_Immediately_Visible (Cur, Vis);
12618 end if;
12619 end Preanalyze_Actuals;
12620
12621 -------------------
12622 -- Remove_Parent --
12623 -------------------
12624
12625 procedure Remove_Parent (In_Body : Boolean := False) is
12626 S : Entity_Id := Current_Scope;
12627 -- S is the scope containing the instantiation just completed. The scope
12628 -- stack contains the parent instances of the instantiation, followed by
12629 -- the original S.
12630
12631 Cur_P : Entity_Id;
12632 E : Entity_Id;
12633 P : Entity_Id;
12634 Hidden : Elmt_Id;
12635
12636 begin
12637 -- After child instantiation is complete, remove from scope stack the
12638 -- extra copy of the current scope, and then remove parent instances.
12639
12640 if not In_Body then
12641 Pop_Scope;
12642
12643 while Current_Scope /= S loop
12644 P := Current_Scope;
12645 End_Package_Scope (Current_Scope);
12646
12647 if In_Open_Scopes (P) then
12648 E := First_Entity (P);
12649 while Present (E) loop
12650 Set_Is_Immediately_Visible (E, True);
12651 Next_Entity (E);
12652 end loop;
12653
12654 -- If instantiation is declared in a block, it is the enclosing
12655 -- scope that might be a parent instance. Note that only one
12656 -- block can be involved, because the parent instances have
12657 -- been installed within it.
12658
12659 if Ekind (P) = E_Block then
12660 Cur_P := Scope (P);
12661 else
12662 Cur_P := P;
12663 end if;
12664
12665 if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
12666 -- We are within an instance of some sibling. Retain
12667 -- visibility of parent, for proper subsequent cleanup, and
12668 -- reinstall private declarations as well.
12669
12670 Set_In_Private_Part (P);
12671 Install_Private_Declarations (P);
12672 end if;
12673
12674 -- If the ultimate parent is a top-level unit recorded in
12675 -- Instance_Parent_Unit, then reset its visibility to what it was
12676 -- before instantiation. (It's not clear what the purpose is of
12677 -- testing whether Scope (P) is In_Open_Scopes, but that test was
12678 -- present before the ultimate parent test was added.???)
12679
12680 elsif not In_Open_Scopes (Scope (P))
12681 or else (P = Instance_Parent_Unit
12682 and then not Parent_Unit_Visible)
12683 then
12684 Set_Is_Immediately_Visible (P, False);
12685
12686 -- If the current scope is itself an instantiation of a generic
12687 -- nested within P, and we are in the private part of body of this
12688 -- instantiation, restore the full views of P, that were removed
12689 -- in End_Package_Scope above. This obscure case can occur when a
12690 -- subunit of a generic contains an instance of a child unit of
12691 -- its generic parent unit.
12692
12693 elsif S = Current_Scope and then Is_Generic_Instance (S) then
12694 declare
12695 Par : constant Entity_Id :=
12696 Generic_Parent (Package_Specification (S));
12697 begin
12698 if Present (Par)
12699 and then P = Scope (Par)
12700 and then (In_Package_Body (S) or else In_Private_Part (S))
12701 then
12702 Set_In_Private_Part (P);
12703 Install_Private_Declarations (P);
12704 end if;
12705 end;
12706 end if;
12707 end loop;
12708
12709 -- Reset visibility of entities in the enclosing scope
12710
12711 Set_Is_Hidden_Open_Scope (Current_Scope, False);
12712
12713 Hidden := First_Elmt (Hidden_Entities);
12714 while Present (Hidden) loop
12715 Set_Is_Immediately_Visible (Node (Hidden), True);
12716 Next_Elmt (Hidden);
12717 end loop;
12718
12719 else
12720 -- Each body is analyzed separately, and there is no context that
12721 -- needs preserving from one body instance to the next, so remove all
12722 -- parent scopes that have been installed.
12723
12724 while Present (S) loop
12725 End_Package_Scope (S);
12726 Set_Is_Immediately_Visible (S, False);
12727 S := Current_Scope;
12728 exit when S = Standard_Standard;
12729 end loop;
12730 end if;
12731 end Remove_Parent;
12732
12733 -----------------
12734 -- Restore_Env --
12735 -----------------
12736
12737 procedure Restore_Env is
12738 Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
12739
12740 begin
12741 if No (Current_Instantiated_Parent.Act_Id) then
12742 -- Restore environment after subprogram inlining
12743
12744 Restore_Private_Views (Empty);
12745 end if;
12746
12747 Current_Instantiated_Parent := Saved.Instantiated_Parent;
12748 Exchanged_Views := Saved.Exchanged_Views;
12749 Hidden_Entities := Saved.Hidden_Entities;
12750 Current_Sem_Unit := Saved.Current_Sem_Unit;
12751 Parent_Unit_Visible := Saved.Parent_Unit_Visible;
12752 Instance_Parent_Unit := Saved.Instance_Parent_Unit;
12753
12754 Restore_Opt_Config_Switches (Saved.Switches);
12755
12756 Instance_Envs.Decrement_Last;
12757 end Restore_Env;
12758
12759 ---------------------------
12760 -- Restore_Private_Views --
12761 ---------------------------
12762
12763 procedure Restore_Private_Views
12764 (Pack_Id : Entity_Id;
12765 Is_Package : Boolean := True)
12766 is
12767 M : Elmt_Id;
12768 E : Entity_Id;
12769 Typ : Entity_Id;
12770 Dep_Elmt : Elmt_Id;
12771 Dep_Typ : Node_Id;
12772
12773 procedure Restore_Nested_Formal (Formal : Entity_Id);
12774 -- Hide the generic formals of formal packages declared with box which
12775 -- were reachable in the current instantiation.
12776
12777 ---------------------------
12778 -- Restore_Nested_Formal --
12779 ---------------------------
12780
12781 procedure Restore_Nested_Formal (Formal : Entity_Id) is
12782 Ent : Entity_Id;
12783
12784 begin
12785 if Present (Renamed_Object (Formal))
12786 and then Denotes_Formal_Package (Renamed_Object (Formal), True)
12787 then
12788 return;
12789
12790 elsif Present (Associated_Formal_Package (Formal)) then
12791 Ent := First_Entity (Formal);
12792 while Present (Ent) loop
12793 exit when Ekind (Ent) = E_Package
12794 and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
12795
12796 Set_Is_Hidden (Ent);
12797 Set_Is_Potentially_Use_Visible (Ent, False);
12798
12799 -- If package, then recurse
12800
12801 if Ekind (Ent) = E_Package then
12802 Restore_Nested_Formal (Ent);
12803 end if;
12804
12805 Next_Entity (Ent);
12806 end loop;
12807 end if;
12808 end Restore_Nested_Formal;
12809
12810 -- Start of processing for Restore_Private_Views
12811
12812 begin
12813 M := First_Elmt (Exchanged_Views);
12814 while Present (M) loop
12815 Typ := Node (M);
12816
12817 -- Subtypes of types whose views have been exchanged, and that are
12818 -- defined within the instance, were not on the Private_Dependents
12819 -- list on entry to the instance, so they have to be exchanged
12820 -- explicitly now, in order to remain consistent with the view of the
12821 -- parent type.
12822
12823 if Ekind_In (Typ, E_Private_Type,
12824 E_Limited_Private_Type,
12825 E_Record_Type_With_Private)
12826 then
12827 Dep_Elmt := First_Elmt (Private_Dependents (Typ));
12828 while Present (Dep_Elmt) loop
12829 Dep_Typ := Node (Dep_Elmt);
12830
12831 if Scope (Dep_Typ) = Pack_Id
12832 and then Present (Full_View (Dep_Typ))
12833 then
12834 Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
12835 Exchange_Declarations (Dep_Typ);
12836 end if;
12837
12838 Next_Elmt (Dep_Elmt);
12839 end loop;
12840 end if;
12841
12842 Exchange_Declarations (Node (M));
12843 Next_Elmt (M);
12844 end loop;
12845
12846 if No (Pack_Id) then
12847 return;
12848 end if;
12849
12850 -- Make the generic formal parameters private, and make the formal types
12851 -- into subtypes of the actuals again.
12852
12853 E := First_Entity (Pack_Id);
12854 while Present (E) loop
12855 Set_Is_Hidden (E, True);
12856
12857 if Is_Type (E)
12858 and then Nkind (Parent (E)) = N_Subtype_Declaration
12859 then
12860 -- If the actual for E is itself a generic actual type from
12861 -- an enclosing instance, E is still a generic actual type
12862 -- outside of the current instance. This matter when resolving
12863 -- an overloaded call that may be ambiguous in the enclosing
12864 -- instance, when two of its actuals coincide.
12865
12866 if Is_Entity_Name (Subtype_Indication (Parent (E)))
12867 and then Is_Generic_Actual_Type
12868 (Entity (Subtype_Indication (Parent (E))))
12869 then
12870 null;
12871 else
12872 Set_Is_Generic_Actual_Type (E, False);
12873 end if;
12874
12875 -- An unusual case of aliasing: the actual may also be directly
12876 -- visible in the generic, and be private there, while it is fully
12877 -- visible in the context of the instance. The internal subtype
12878 -- is private in the instance but has full visibility like its
12879 -- parent in the enclosing scope. This enforces the invariant that
12880 -- the privacy status of all private dependents of a type coincide
12881 -- with that of the parent type. This can only happen when a
12882 -- generic child unit is instantiated within a sibling.
12883
12884 if Is_Private_Type (E)
12885 and then not Is_Private_Type (Etype (E))
12886 then
12887 Exchange_Declarations (E);
12888 end if;
12889
12890 elsif Ekind (E) = E_Package then
12891
12892 -- The end of the renaming list is the renaming of the generic
12893 -- package itself. If the instance is a subprogram, all entities
12894 -- in the corresponding package are renamings. If this entity is
12895 -- a formal package, make its own formals private as well. The
12896 -- actual in this case is itself the renaming of an instantiation.
12897 -- If the entity is not a package renaming, it is the entity
12898 -- created to validate formal package actuals: ignore it.
12899
12900 -- If the actual is itself a formal package for the enclosing
12901 -- generic, or the actual for such a formal package, it remains
12902 -- visible on exit from the instance, and therefore nothing needs
12903 -- to be done either, except to keep it accessible.
12904
12905 if Is_Package and then Renamed_Object (E) = Pack_Id then
12906 exit;
12907
12908 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
12909 null;
12910
12911 elsif
12912 Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
12913 then
12914 Set_Is_Hidden (E, False);
12915
12916 else
12917 declare
12918 Act_P : constant Entity_Id := Renamed_Object (E);
12919 Id : Entity_Id;
12920
12921 begin
12922 Id := First_Entity (Act_P);
12923 while Present (Id)
12924 and then Id /= First_Private_Entity (Act_P)
12925 loop
12926 exit when Ekind (Id) = E_Package
12927 and then Renamed_Object (Id) = Act_P;
12928
12929 Set_Is_Hidden (Id, True);
12930 Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
12931
12932 if Ekind (Id) = E_Package then
12933 Restore_Nested_Formal (Id);
12934 end if;
12935
12936 Next_Entity (Id);
12937 end loop;
12938 end;
12939 end if;
12940 end if;
12941
12942 Next_Entity (E);
12943 end loop;
12944 end Restore_Private_Views;
12945
12946 --------------
12947 -- Save_Env --
12948 --------------
12949
12950 procedure Save_Env
12951 (Gen_Unit : Entity_Id;
12952 Act_Unit : Entity_Id)
12953 is
12954 begin
12955 Init_Env;
12956 Set_Instance_Env (Gen_Unit, Act_Unit);
12957 end Save_Env;
12958
12959 ----------------------------
12960 -- Save_Global_References --
12961 ----------------------------
12962
12963 procedure Save_Global_References (N : Node_Id) is
12964 Gen_Scope : Entity_Id;
12965 E : Entity_Id;
12966 N2 : Node_Id;
12967
12968 function Is_Global (E : Entity_Id) return Boolean;
12969 -- Check whether entity is defined outside of generic unit. Examine the
12970 -- scope of an entity, and the scope of the scope, etc, until we find
12971 -- either Standard, in which case the entity is global, or the generic
12972 -- unit itself, which indicates that the entity is local. If the entity
12973 -- is the generic unit itself, as in the case of a recursive call, or
12974 -- the enclosing generic unit, if different from the current scope, then
12975 -- it is local as well, because it will be replaced at the point of
12976 -- instantiation. On the other hand, if it is a reference to a child
12977 -- unit of a common ancestor, which appears in an instantiation, it is
12978 -- global because it is used to denote a specific compilation unit at
12979 -- the time the instantiations will be analyzed.
12980
12981 procedure Reset_Entity (N : Node_Id);
12982 -- Save semantic information on global entity so that it is not resolved
12983 -- again at instantiation time.
12984
12985 procedure Save_Entity_Descendants (N : Node_Id);
12986 -- Apply Save_Global_References to the two syntactic descendants of
12987 -- non-terminal nodes that carry an Associated_Node and are processed
12988 -- through Reset_Entity. Once the global entity (if any) has been
12989 -- captured together with its type, only two syntactic descendants need
12990 -- to be traversed to complete the processing of the tree rooted at N.
12991 -- This applies to Selected_Components, Expanded_Names, and to Operator
12992 -- nodes. N can also be a character literal, identifier, or operator
12993 -- symbol node, but the call has no effect in these cases.
12994
12995 procedure Save_Global_Defaults (N1, N2 : Node_Id);
12996 -- Default actuals in nested instances must be handled specially
12997 -- because there is no link to them from the original tree. When an
12998 -- actual subprogram is given by a default, we add an explicit generic
12999 -- association for it in the instantiation node. When we save the
13000 -- global references on the name of the instance, we recover the list
13001 -- of generic associations, and add an explicit one to the original
13002 -- generic tree, through which a global actual can be preserved.
13003 -- Similarly, if a child unit is instantiated within a sibling, in the
13004 -- context of the parent, we must preserve the identifier of the parent
13005 -- so that it can be properly resolved in a subsequent instantiation.
13006
13007 procedure Save_Global_Descendant (D : Union_Id);
13008 -- Apply Save_Global_References recursively to the descendents of the
13009 -- current node.
13010
13011 procedure Save_References (N : Node_Id);
13012 -- This is the recursive procedure that does the work, once the
13013 -- enclosing generic scope has been established.
13014
13015 ---------------
13016 -- Is_Global --
13017 ---------------
13018
13019 function Is_Global (E : Entity_Id) return Boolean is
13020 Se : Entity_Id;
13021
13022 function Is_Instance_Node (Decl : Node_Id) return Boolean;
13023 -- Determine whether the parent node of a reference to a child unit
13024 -- denotes an instantiation or a formal package, in which case the
13025 -- reference to the child unit is global, even if it appears within
13026 -- the current scope (e.g. when the instance appears within the body
13027 -- of an ancestor).
13028
13029 ----------------------
13030 -- Is_Instance_Node --
13031 ----------------------
13032
13033 function Is_Instance_Node (Decl : Node_Id) return Boolean is
13034 begin
13035 return Nkind (Decl) in N_Generic_Instantiation
13036 or else
13037 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
13038 end Is_Instance_Node;
13039
13040 -- Start of processing for Is_Global
13041
13042 begin
13043 if E = Gen_Scope then
13044 return False;
13045
13046 elsif E = Standard_Standard then
13047 return True;
13048
13049 elsif Is_Child_Unit (E)
13050 and then (Is_Instance_Node (Parent (N2))
13051 or else (Nkind (Parent (N2)) = N_Expanded_Name
13052 and then N2 = Selector_Name (Parent (N2))
13053 and then
13054 Is_Instance_Node (Parent (Parent (N2)))))
13055 then
13056 return True;
13057
13058 else
13059 Se := Scope (E);
13060 while Se /= Gen_Scope loop
13061 if Se = Standard_Standard then
13062 return True;
13063 else
13064 Se := Scope (Se);
13065 end if;
13066 end loop;
13067
13068 return False;
13069 end if;
13070 end Is_Global;
13071
13072 ------------------
13073 -- Reset_Entity --
13074 ------------------
13075
13076 procedure Reset_Entity (N : Node_Id) is
13077
13078 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
13079 -- If the type of N2 is global to the generic unit, save the type in
13080 -- the generic node. Just as we perform name capture for explicit
13081 -- references within the generic, we must capture the global types
13082 -- of local entities because they may participate in resolution in
13083 -- the instance.
13084
13085 function Top_Ancestor (E : Entity_Id) return Entity_Id;
13086 -- Find the ultimate ancestor of the current unit. If it is not a
13087 -- generic unit, then the name of the current unit in the prefix of
13088 -- an expanded name must be replaced with its generic homonym to
13089 -- ensure that it will be properly resolved in an instance.
13090
13091 ---------------------
13092 -- Set_Global_Type --
13093 ---------------------
13094
13095 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
13096 Typ : constant Entity_Id := Etype (N2);
13097
13098 begin
13099 Set_Etype (N, Typ);
13100
13101 if Entity (N) /= N2
13102 and then Has_Private_View (Entity (N))
13103 then
13104 -- If the entity of N is not the associated node, this is a
13105 -- nested generic and it has an associated node as well, whose
13106 -- type is already the full view (see below). Indicate that the
13107 -- original node has a private view.
13108
13109 Set_Has_Private_View (N);
13110 end if;
13111
13112 -- If not a private type, nothing else to do
13113
13114 if not Is_Private_Type (Typ) then
13115 if Is_Array_Type (Typ)
13116 and then Is_Private_Type (Component_Type (Typ))
13117 then
13118 Set_Has_Private_View (N);
13119 end if;
13120
13121 -- If it is a derivation of a private type in a context where no
13122 -- full view is needed, nothing to do either.
13123
13124 elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
13125 null;
13126
13127 -- Otherwise mark the type for flipping and use the full view when
13128 -- available.
13129
13130 else
13131 Set_Has_Private_View (N);
13132
13133 if Present (Full_View (Typ)) then
13134 Set_Etype (N2, Full_View (Typ));
13135 end if;
13136 end if;
13137 end Set_Global_Type;
13138
13139 ------------------
13140 -- Top_Ancestor --
13141 ------------------
13142
13143 function Top_Ancestor (E : Entity_Id) return Entity_Id is
13144 Par : Entity_Id;
13145
13146 begin
13147 Par := E;
13148 while Is_Child_Unit (Par) loop
13149 Par := Scope (Par);
13150 end loop;
13151
13152 return Par;
13153 end Top_Ancestor;
13154
13155 -- Start of processing for Reset_Entity
13156
13157 begin
13158 N2 := Get_Associated_Node (N);
13159 E := Entity (N2);
13160
13161 if Present (E) then
13162
13163 -- If the node is an entry call to an entry in an enclosing task,
13164 -- it is rewritten as a selected component. No global entity to
13165 -- preserve in this case, since the expansion will be redone in
13166 -- the instance.
13167
13168 if not Nkind_In (E, N_Defining_Identifier,
13169 N_Defining_Character_Literal,
13170 N_Defining_Operator_Symbol)
13171 then
13172 Set_Associated_Node (N, Empty);
13173 Set_Etype (N, Empty);
13174 return;
13175 end if;
13176
13177 -- If the entity is an itype created as a subtype of an access
13178 -- type with a null exclusion restore source entity for proper
13179 -- visibility. The itype will be created anew in the instance.
13180
13181 if Is_Itype (E)
13182 and then Ekind (E) = E_Access_Subtype
13183 and then Is_Entity_Name (N)
13184 and then Chars (Etype (E)) = Chars (N)
13185 then
13186 E := Etype (E);
13187 Set_Entity (N2, E);
13188 Set_Etype (N2, E);
13189 end if;
13190
13191 if Is_Global (E) then
13192
13193 -- If the entity is a package renaming that is the prefix of
13194 -- an expanded name, it has been rewritten as the renamed
13195 -- package, which is necessary semantically but complicates
13196 -- ASIS tree traversal, so we recover the original entity to
13197 -- expose the renaming. Take into account that the context may
13198 -- be a nested generic, that the original node may itself have
13199 -- an associated node that had better be an entity, and that
13200 -- the current node is still a selected component.
13201
13202 if Ekind (E) = E_Package
13203 and then Nkind (N) = N_Selected_Component
13204 and then Nkind (Parent (N)) = N_Expanded_Name
13205 and then Present (Original_Node (N2))
13206 and then Is_Entity_Name (Original_Node (N2))
13207 and then Present (Entity (Original_Node (N2)))
13208 then
13209 if Is_Global (Entity (Original_Node (N2))) then
13210 N2 := Original_Node (N2);
13211 Set_Associated_Node (N, N2);
13212 Set_Global_Type (N, N2);
13213
13214 else
13215 -- Renaming is local, and will be resolved in instance
13216
13217 Set_Associated_Node (N, Empty);
13218 Set_Etype (N, Empty);
13219 end if;
13220
13221 else
13222 Set_Global_Type (N, N2);
13223 end if;
13224
13225 elsif Nkind (N) = N_Op_Concat
13226 and then Is_Generic_Type (Etype (N2))
13227 and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
13228 or else
13229 Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
13230 and then Is_Intrinsic_Subprogram (E)
13231 then
13232 null;
13233
13234 else
13235 -- Entity is local. Mark generic node as unresolved.
13236 -- Note that now it does not have an entity.
13237
13238 Set_Associated_Node (N, Empty);
13239 Set_Etype (N, Empty);
13240 end if;
13241
13242 if Nkind (Parent (N)) in N_Generic_Instantiation
13243 and then N = Name (Parent (N))
13244 then
13245 Save_Global_Defaults (Parent (N), Parent (N2));
13246 end if;
13247
13248 elsif Nkind (Parent (N)) = N_Selected_Component
13249 and then Nkind (Parent (N2)) = N_Expanded_Name
13250 then
13251 if Is_Global (Entity (Parent (N2))) then
13252 Change_Selected_Component_To_Expanded_Name (Parent (N));
13253 Set_Associated_Node (Parent (N), Parent (N2));
13254 Set_Global_Type (Parent (N), Parent (N2));
13255 Save_Entity_Descendants (N);
13256
13257 -- If this is a reference to the current generic entity, replace
13258 -- by the name of the generic homonym of the current package. This
13259 -- is because in an instantiation Par.P.Q will not resolve to the
13260 -- name of the instance, whose enclosing scope is not necessarily
13261 -- Par. We use the generic homonym rather that the name of the
13262 -- generic itself because it may be hidden by a local declaration.
13263
13264 elsif In_Open_Scopes (Entity (Parent (N2)))
13265 and then not
13266 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
13267 then
13268 if Ekind (Entity (Parent (N2))) = E_Generic_Package then
13269 Rewrite (Parent (N),
13270 Make_Identifier (Sloc (N),
13271 Chars =>
13272 Chars (Generic_Homonym (Entity (Parent (N2))))));
13273 else
13274 Rewrite (Parent (N),
13275 Make_Identifier (Sloc (N),
13276 Chars => Chars (Selector_Name (Parent (N2)))));
13277 end if;
13278 end if;
13279
13280 if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
13281 and then Parent (N) = Name (Parent (Parent (N)))
13282 then
13283 Save_Global_Defaults
13284 (Parent (Parent (N)), Parent (Parent ((N2))));
13285 end if;
13286
13287 -- A selected component may denote a static constant that has been
13288 -- folded. If the static constant is global to the generic, capture
13289 -- its value. Otherwise the folding will happen in any instantiation.
13290
13291 elsif Nkind (Parent (N)) = N_Selected_Component
13292 and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
13293 then
13294 if Present (Entity (Original_Node (Parent (N2))))
13295 and then Is_Global (Entity (Original_Node (Parent (N2))))
13296 then
13297 Rewrite (Parent (N), New_Copy (Parent (N2)));
13298 Set_Analyzed (Parent (N), False);
13299
13300 else
13301 null;
13302 end if;
13303
13304 -- A selected component may be transformed into a parameterless
13305 -- function call. If the called entity is global, rewrite the node
13306 -- appropriately, i.e. as an extended name for the global entity.
13307
13308 elsif Nkind (Parent (N)) = N_Selected_Component
13309 and then Nkind (Parent (N2)) = N_Function_Call
13310 and then N = Selector_Name (Parent (N))
13311 then
13312 if No (Parameter_Associations (Parent (N2))) then
13313 if Is_Global (Entity (Name (Parent (N2)))) then
13314 Change_Selected_Component_To_Expanded_Name (Parent (N));
13315 Set_Associated_Node (Parent (N), Name (Parent (N2)));
13316 Set_Global_Type (Parent (N), Name (Parent (N2)));
13317 Save_Entity_Descendants (N);
13318
13319 else
13320 Set_Is_Prefixed_Call (Parent (N));
13321 Set_Associated_Node (N, Empty);
13322 Set_Etype (N, Empty);
13323 end if;
13324
13325 -- In Ada 2005, X.F may be a call to a primitive operation,
13326 -- rewritten as F (X). This rewriting will be done again in an
13327 -- instance, so keep the original node. Global entities will be
13328 -- captured as for other constructs. Indicate that this must
13329 -- resolve as a call, to prevent accidental overloading in the
13330 -- instance, if both a component and a primitive operation appear
13331 -- as candidates.
13332
13333 else
13334 Set_Is_Prefixed_Call (Parent (N));
13335 end if;
13336
13337 -- Entity is local. Reset in generic unit, so that node is resolved
13338 -- anew at the point of instantiation.
13339
13340 else
13341 Set_Associated_Node (N, Empty);
13342 Set_Etype (N, Empty);
13343 end if;
13344 end Reset_Entity;
13345
13346 -----------------------------
13347 -- Save_Entity_Descendants --
13348 -----------------------------
13349
13350 procedure Save_Entity_Descendants (N : Node_Id) is
13351 begin
13352 case Nkind (N) is
13353 when N_Binary_Op =>
13354 Save_Global_Descendant (Union_Id (Left_Opnd (N)));
13355 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13356
13357 when N_Unary_Op =>
13358 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13359
13360 when N_Expanded_Name | N_Selected_Component =>
13361 Save_Global_Descendant (Union_Id (Prefix (N)));
13362 Save_Global_Descendant (Union_Id (Selector_Name (N)));
13363
13364 when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
13365 null;
13366
13367 when others =>
13368 raise Program_Error;
13369 end case;
13370 end Save_Entity_Descendants;
13371
13372 --------------------------
13373 -- Save_Global_Defaults --
13374 --------------------------
13375
13376 procedure Save_Global_Defaults (N1, N2 : Node_Id) is
13377 Loc : constant Source_Ptr := Sloc (N1);
13378 Assoc2 : constant List_Id := Generic_Associations (N2);
13379 Gen_Id : constant Entity_Id := Get_Generic_Entity (N2);
13380 Assoc1 : List_Id;
13381 Act1 : Node_Id;
13382 Act2 : Node_Id;
13383 Def : Node_Id;
13384 Ndec : Node_Id;
13385 Subp : Entity_Id;
13386 Actual : Entity_Id;
13387
13388 begin
13389 Assoc1 := Generic_Associations (N1);
13390
13391 if Present (Assoc1) then
13392 Act1 := First (Assoc1);
13393 else
13394 Act1 := Empty;
13395 Set_Generic_Associations (N1, New_List);
13396 Assoc1 := Generic_Associations (N1);
13397 end if;
13398
13399 if Present (Assoc2) then
13400 Act2 := First (Assoc2);
13401 else
13402 return;
13403 end if;
13404
13405 while Present (Act1) and then Present (Act2) loop
13406 Next (Act1);
13407 Next (Act2);
13408 end loop;
13409
13410 -- Find the associations added for default subprograms
13411
13412 if Present (Act2) then
13413 while Nkind (Act2) /= N_Generic_Association
13414 or else No (Entity (Selector_Name (Act2)))
13415 or else not Is_Overloadable (Entity (Selector_Name (Act2)))
13416 loop
13417 Next (Act2);
13418 end loop;
13419
13420 -- Add a similar association if the default is global. The
13421 -- renaming declaration for the actual has been analyzed, and
13422 -- its alias is the program it renames. Link the actual in the
13423 -- original generic tree with the node in the analyzed tree.
13424
13425 while Present (Act2) loop
13426 Subp := Entity (Selector_Name (Act2));
13427 Def := Explicit_Generic_Actual_Parameter (Act2);
13428
13429 -- Following test is defence against rubbish errors
13430
13431 if No (Alias (Subp)) then
13432 return;
13433 end if;
13434
13435 -- Retrieve the resolved actual from the renaming declaration
13436 -- created for the instantiated formal.
13437
13438 Actual := Entity (Name (Parent (Parent (Subp))));
13439 Set_Entity (Def, Actual);
13440 Set_Etype (Def, Etype (Actual));
13441
13442 if Is_Global (Actual) then
13443 Ndec :=
13444 Make_Generic_Association (Loc,
13445 Selector_Name => New_Occurrence_Of (Subp, Loc),
13446 Explicit_Generic_Actual_Parameter =>
13447 New_Occurrence_Of (Actual, Loc));
13448
13449 Set_Associated_Node
13450 (Explicit_Generic_Actual_Parameter (Ndec), Def);
13451
13452 Append (Ndec, Assoc1);
13453
13454 -- If there are other defaults, add a dummy association in case
13455 -- there are other defaulted formals with the same name.
13456
13457 elsif Present (Next (Act2)) then
13458 Ndec :=
13459 Make_Generic_Association (Loc,
13460 Selector_Name => New_Occurrence_Of (Subp, Loc),
13461 Explicit_Generic_Actual_Parameter => Empty);
13462
13463 Append (Ndec, Assoc1);
13464 end if;
13465
13466 Next (Act2);
13467 end loop;
13468 end if;
13469
13470 if Nkind (Name (N1)) = N_Identifier
13471 and then Is_Child_Unit (Gen_Id)
13472 and then Is_Global (Gen_Id)
13473 and then Is_Generic_Unit (Scope (Gen_Id))
13474 and then In_Open_Scopes (Scope (Gen_Id))
13475 then
13476 -- This is an instantiation of a child unit within a sibling, so
13477 -- that the generic parent is in scope. An eventual instance must
13478 -- occur within the scope of an instance of the parent. Make name
13479 -- in instance into an expanded name, to preserve the identifier
13480 -- of the parent, so it can be resolved subsequently.
13481
13482 Rewrite (Name (N2),
13483 Make_Expanded_Name (Loc,
13484 Chars => Chars (Gen_Id),
13485 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13486 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13487 Set_Entity (Name (N2), Gen_Id);
13488
13489 Rewrite (Name (N1),
13490 Make_Expanded_Name (Loc,
13491 Chars => Chars (Gen_Id),
13492 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13493 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13494
13495 Set_Associated_Node (Name (N1), Name (N2));
13496 Set_Associated_Node (Prefix (Name (N1)), Empty);
13497 Set_Associated_Node
13498 (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
13499 Set_Etype (Name (N1), Etype (Gen_Id));
13500 end if;
13501
13502 end Save_Global_Defaults;
13503
13504 ----------------------------
13505 -- Save_Global_Descendant --
13506 ----------------------------
13507
13508 procedure Save_Global_Descendant (D : Union_Id) is
13509 N1 : Node_Id;
13510
13511 begin
13512 if D in Node_Range then
13513 if D = Union_Id (Empty) then
13514 null;
13515
13516 elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
13517 Save_References (Node_Id (D));
13518 end if;
13519
13520 elsif D in List_Range then
13521 if D = Union_Id (No_List)
13522 or else Is_Empty_List (List_Id (D))
13523 then
13524 null;
13525
13526 else
13527 N1 := First (List_Id (D));
13528 while Present (N1) loop
13529 Save_References (N1);
13530 Next (N1);
13531 end loop;
13532 end if;
13533
13534 -- Element list or other non-node field, nothing to do
13535
13536 else
13537 null;
13538 end if;
13539 end Save_Global_Descendant;
13540
13541 ---------------------
13542 -- Save_References --
13543 ---------------------
13544
13545 -- This is the recursive procedure that does the work once the enclosing
13546 -- generic scope has been established. We have to treat specially a
13547 -- number of node rewritings that are required by semantic processing
13548 -- and which change the kind of nodes in the generic copy: typically
13549 -- constant-folding, replacing an operator node by a string literal, or
13550 -- a selected component by an expanded name. In each of those cases, the
13551 -- transformation is propagated to the generic unit.
13552
13553 procedure Save_References (N : Node_Id) is
13554 Loc : constant Source_Ptr := Sloc (N);
13555
13556 begin
13557 if N = Empty then
13558 null;
13559
13560 elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
13561 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13562 Reset_Entity (N);
13563
13564 elsif Nkind (N) = N_Operator_Symbol
13565 and then Nkind (Get_Associated_Node (N)) = N_String_Literal
13566 then
13567 Change_Operator_Symbol_To_String_Literal (N);
13568 end if;
13569
13570 elsif Nkind (N) in N_Op then
13571 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13572 if Nkind (N) = N_Op_Concat then
13573 Set_Is_Component_Left_Opnd (N,
13574 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13575
13576 Set_Is_Component_Right_Opnd (N,
13577 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13578 end if;
13579
13580 Reset_Entity (N);
13581
13582 else
13583 -- Node may be transformed into call to a user-defined operator
13584
13585 N2 := Get_Associated_Node (N);
13586
13587 if Nkind (N2) = N_Function_Call then
13588 E := Entity (Name (N2));
13589
13590 if Present (E)
13591 and then Is_Global (E)
13592 then
13593 Set_Etype (N, Etype (N2));
13594 else
13595 Set_Associated_Node (N, Empty);
13596 Set_Etype (N, Empty);
13597 end if;
13598
13599 elsif Nkind_In (N2, N_Integer_Literal,
13600 N_Real_Literal,
13601 N_String_Literal)
13602 then
13603 if Present (Original_Node (N2))
13604 and then Nkind (Original_Node (N2)) = Nkind (N)
13605 then
13606
13607 -- Operation was constant-folded. Whenever possible,
13608 -- recover semantic information from unfolded node,
13609 -- for ASIS use.
13610
13611 Set_Associated_Node (N, Original_Node (N2));
13612
13613 if Nkind (N) = N_Op_Concat then
13614 Set_Is_Component_Left_Opnd (N,
13615 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13616 Set_Is_Component_Right_Opnd (N,
13617 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13618 end if;
13619
13620 Reset_Entity (N);
13621
13622 else
13623 -- If original node is already modified, propagate
13624 -- constant-folding to template.
13625
13626 Rewrite (N, New_Copy (N2));
13627 Set_Analyzed (N, False);
13628 end if;
13629
13630 elsif Nkind (N2) = N_Identifier
13631 and then Ekind (Entity (N2)) = E_Enumeration_Literal
13632 then
13633 -- Same if call was folded into a literal, but in this case
13634 -- retain the entity to avoid spurious ambiguities if it is
13635 -- overloaded at the point of instantiation or inlining.
13636
13637 Rewrite (N, New_Copy (N2));
13638 Set_Analyzed (N, False);
13639 end if;
13640 end if;
13641
13642 -- Complete operands check if node has not been constant-folded
13643
13644 if Nkind (N) in N_Op then
13645 Save_Entity_Descendants (N);
13646 end if;
13647
13648 elsif Nkind (N) = N_Identifier then
13649 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13650
13651 -- If this is a discriminant reference, always save it. It is
13652 -- used in the instance to find the corresponding discriminant
13653 -- positionally rather than by name.
13654
13655 Set_Original_Discriminant
13656 (N, Original_Discriminant (Get_Associated_Node (N)));
13657 Reset_Entity (N);
13658
13659 else
13660 N2 := Get_Associated_Node (N);
13661
13662 if Nkind (N2) = N_Function_Call then
13663 E := Entity (Name (N2));
13664
13665 -- Name resolves to a call to parameterless function. If
13666 -- original entity is global, mark node as resolved.
13667
13668 if Present (E)
13669 and then Is_Global (E)
13670 then
13671 Set_Etype (N, Etype (N2));
13672 else
13673 Set_Associated_Node (N, Empty);
13674 Set_Etype (N, Empty);
13675 end if;
13676
13677 elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
13678 and then Is_Entity_Name (Original_Node (N2))
13679 then
13680 -- Name resolves to named number that is constant-folded,
13681 -- We must preserve the original name for ASIS use, and
13682 -- undo the constant-folding, which will be repeated in
13683 -- each instance.
13684
13685 Set_Associated_Node (N, Original_Node (N2));
13686 Reset_Entity (N);
13687
13688 elsif Nkind (N2) = N_String_Literal then
13689
13690 -- Name resolves to string literal. Perform the same
13691 -- replacement in generic.
13692
13693 Rewrite (N, New_Copy (N2));
13694
13695 elsif Nkind (N2) = N_Explicit_Dereference then
13696
13697 -- An identifier is rewritten as a dereference if it is the
13698 -- prefix in an implicit dereference (call or attribute).
13699 -- The analysis of an instantiation will expand the node
13700 -- again, so we preserve the original tree but link it to
13701 -- the resolved entity in case it is global.
13702
13703 if Is_Entity_Name (Prefix (N2))
13704 and then Present (Entity (Prefix (N2)))
13705 and then Is_Global (Entity (Prefix (N2)))
13706 then
13707 Set_Associated_Node (N, Prefix (N2));
13708
13709 elsif Nkind (Prefix (N2)) = N_Function_Call
13710 and then Is_Global (Entity (Name (Prefix (N2))))
13711 then
13712 Rewrite (N,
13713 Make_Explicit_Dereference (Loc,
13714 Prefix => Make_Function_Call (Loc,
13715 Name =>
13716 New_Occurrence_Of (Entity (Name (Prefix (N2))),
13717 Loc))));
13718
13719 else
13720 Set_Associated_Node (N, Empty);
13721 Set_Etype (N, Empty);
13722 end if;
13723
13724 -- The subtype mark of a nominally unconstrained object is
13725 -- rewritten as a subtype indication using the bounds of the
13726 -- expression. Recover the original subtype mark.
13727
13728 elsif Nkind (N2) = N_Subtype_Indication
13729 and then Is_Entity_Name (Original_Node (N2))
13730 then
13731 Set_Associated_Node (N, Original_Node (N2));
13732 Reset_Entity (N);
13733
13734 else
13735 null;
13736 end if;
13737 end if;
13738
13739 elsif Nkind (N) in N_Entity then
13740 null;
13741
13742 else
13743 declare
13744 Qual : Node_Id := Empty;
13745 Typ : Entity_Id := Empty;
13746 Nam : Node_Id;
13747
13748 use Atree.Unchecked_Access;
13749 -- This code section is part of implementing an untyped tree
13750 -- traversal, so it needs direct access to node fields.
13751
13752 begin
13753 if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
13754 N2 := Get_Associated_Node (N);
13755
13756 if No (N2) then
13757 Typ := Empty;
13758 else
13759 Typ := Etype (N2);
13760
13761 -- In an instance within a generic, use the name of the
13762 -- actual and not the original generic parameter. If the
13763 -- actual is global in the current generic it must be
13764 -- preserved for its instantiation.
13765
13766 if Nkind (Parent (Typ)) = N_Subtype_Declaration
13767 and then
13768 Present (Generic_Parent_Type (Parent (Typ)))
13769 then
13770 Typ := Base_Type (Typ);
13771 Set_Etype (N2, Typ);
13772 end if;
13773 end if;
13774
13775 if No (N2)
13776 or else No (Typ)
13777 or else not Is_Global (Typ)
13778 then
13779 Set_Associated_Node (N, Empty);
13780
13781 -- If the aggregate is an actual in a call, it has been
13782 -- resolved in the current context, to some local type.
13783 -- The enclosing call may have been disambiguated by the
13784 -- aggregate, and this disambiguation might fail at
13785 -- instantiation time because the type to which the
13786 -- aggregate did resolve is not preserved. In order to
13787 -- preserve some of this information, we wrap the
13788 -- aggregate in a qualified expression, using the id of
13789 -- its type. For further disambiguation we qualify the
13790 -- type name with its scope (if visible) because both
13791 -- id's will have corresponding entities in an instance.
13792 -- This resolves most of the problems with missing type
13793 -- information on aggregates in instances.
13794
13795 if Nkind (N2) = Nkind (N)
13796 and then Nkind (Parent (N2)) in N_Subprogram_Call
13797 and then Comes_From_Source (Typ)
13798 then
13799 if Is_Immediately_Visible (Scope (Typ)) then
13800 Nam := Make_Selected_Component (Loc,
13801 Prefix =>
13802 Make_Identifier (Loc, Chars (Scope (Typ))),
13803 Selector_Name =>
13804 Make_Identifier (Loc, Chars (Typ)));
13805 else
13806 Nam := Make_Identifier (Loc, Chars (Typ));
13807 end if;
13808
13809 Qual :=
13810 Make_Qualified_Expression (Loc,
13811 Subtype_Mark => Nam,
13812 Expression => Relocate_Node (N));
13813 end if;
13814 end if;
13815
13816 Save_Global_Descendant (Field1 (N));
13817 Save_Global_Descendant (Field2 (N));
13818 Save_Global_Descendant (Field3 (N));
13819 Save_Global_Descendant (Field5 (N));
13820
13821 if Present (Qual) then
13822 Rewrite (N, Qual);
13823 end if;
13824
13825 -- All other cases than aggregates
13826
13827 else
13828 Save_Global_Descendant (Field1 (N));
13829 Save_Global_Descendant (Field2 (N));
13830 Save_Global_Descendant (Field3 (N));
13831 Save_Global_Descendant (Field4 (N));
13832 Save_Global_Descendant (Field5 (N));
13833 end if;
13834 end;
13835 end if;
13836
13837 -- If a node has aspects, references within their expressions must
13838 -- be saved separately, given they are not directly in the tree.
13839
13840 if Has_Aspects (N) then
13841 declare
13842 Aspect : Node_Id;
13843
13844 begin
13845 Aspect := First (Aspect_Specifications (N));
13846 while Present (Aspect) loop
13847 if Present (Expression (Aspect)) then
13848 Save_Global_References (Expression (Aspect));
13849 end if;
13850
13851 Next (Aspect);
13852 end loop;
13853 end;
13854 end if;
13855 end Save_References;
13856
13857 -- Start of processing for Save_Global_References
13858
13859 begin
13860 Gen_Scope := Current_Scope;
13861
13862 -- If the generic unit is a child unit, references to entities in the
13863 -- parent are treated as local, because they will be resolved anew in
13864 -- the context of the instance of the parent.
13865
13866 while Is_Child_Unit (Gen_Scope)
13867 and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
13868 loop
13869 Gen_Scope := Scope (Gen_Scope);
13870 end loop;
13871
13872 Save_References (N);
13873 end Save_Global_References;
13874
13875 --------------------------------------
13876 -- Set_Copied_Sloc_For_Inlined_Body --
13877 --------------------------------------
13878
13879 procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
13880 begin
13881 Create_Instantiation_Source (N, E, True, S_Adjustment);
13882 end Set_Copied_Sloc_For_Inlined_Body;
13883
13884 ---------------------
13885 -- Set_Instance_Of --
13886 ---------------------
13887
13888 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
13889 begin
13890 Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
13891 Generic_Renamings_HTable.Set (Generic_Renamings.Last);
13892 Generic_Renamings.Increment_Last;
13893 end Set_Instance_Of;
13894
13895 --------------------
13896 -- Set_Next_Assoc --
13897 --------------------
13898
13899 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
13900 begin
13901 Generic_Renamings.Table (E).Next_In_HTable := Next;
13902 end Set_Next_Assoc;
13903
13904 -------------------
13905 -- Start_Generic --
13906 -------------------
13907
13908 procedure Start_Generic is
13909 begin
13910 -- ??? More things could be factored out in this routine.
13911 -- Should probably be done at a later stage.
13912
13913 Generic_Flags.Append (Inside_A_Generic);
13914 Inside_A_Generic := True;
13915
13916 Expander_Mode_Save_And_Set (False);
13917 end Start_Generic;
13918
13919 ----------------------
13920 -- Set_Instance_Env --
13921 ----------------------
13922
13923 procedure Set_Instance_Env
13924 (Gen_Unit : Entity_Id;
13925 Act_Unit : Entity_Id)
13926 is
13927 Assertion_Status : constant Boolean := Assertions_Enabled;
13928 Save_SPARK_Mode : constant SPARK_Mode_Type := SPARK_Mode;
13929 Save_SPARK_Mode_Pragma : constant Node_Id := SPARK_Mode_Pragma;
13930
13931 begin
13932 -- Regardless of the current mode, predefined units are analyzed in the
13933 -- most current Ada mode, and earlier version Ada checks do not apply
13934 -- to predefined units. Nothing needs to be done for non-internal units.
13935 -- These are always analyzed in the current mode.
13936
13937 if Is_Internal_File_Name
13938 (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
13939 Renamings_Included => True)
13940 then
13941 Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
13942
13943 -- In Ada2012 we may want to enable assertions in an instance of a
13944 -- predefined unit, in which case we need to preserve the current
13945 -- setting for the Assertions_Enabled flag. This will become more
13946 -- critical when pre/postconditions are added to predefined units,
13947 -- as is already the case for some numeric libraries.
13948
13949 if Ada_Version >= Ada_2012 then
13950 Assertions_Enabled := Assertion_Status;
13951 end if;
13952
13953 -- SPARK_Mode for an instance is the one applicable at the point of
13954 -- instantiation.
13955
13956 SPARK_Mode := Save_SPARK_Mode;
13957 SPARK_Mode_Pragma := Save_SPARK_Mode_Pragma;
13958 end if;
13959
13960 Current_Instantiated_Parent :=
13961 (Gen_Id => Gen_Unit,
13962 Act_Id => Act_Unit,
13963 Next_In_HTable => Assoc_Null);
13964 end Set_Instance_Env;
13965
13966 -----------------
13967 -- Switch_View --
13968 -----------------
13969
13970 procedure Switch_View (T : Entity_Id) is
13971 BT : constant Entity_Id := Base_Type (T);
13972 Priv_Elmt : Elmt_Id := No_Elmt;
13973 Priv_Sub : Entity_Id;
13974
13975 begin
13976 -- T may be private but its base type may have been exchanged through
13977 -- some other occurrence, in which case there is nothing to switch
13978 -- besides T itself. Note that a private dependent subtype of a private
13979 -- type might not have been switched even if the base type has been,
13980 -- because of the last branch of Check_Private_View (see comment there).
13981
13982 if not Is_Private_Type (BT) then
13983 Prepend_Elmt (Full_View (T), Exchanged_Views);
13984 Exchange_Declarations (T);
13985 return;
13986 end if;
13987
13988 Priv_Elmt := First_Elmt (Private_Dependents (BT));
13989
13990 if Present (Full_View (BT)) then
13991 Prepend_Elmt (Full_View (BT), Exchanged_Views);
13992 Exchange_Declarations (BT);
13993 end if;
13994
13995 while Present (Priv_Elmt) loop
13996 Priv_Sub := (Node (Priv_Elmt));
13997
13998 -- We avoid flipping the subtype if the Etype of its full view is
13999 -- private because this would result in a malformed subtype. This
14000 -- occurs when the Etype of the subtype full view is the full view of
14001 -- the base type (and since the base types were just switched, the
14002 -- subtype is pointing to the wrong view). This is currently the case
14003 -- for tagged record types, access types (maybe more?) and needs to
14004 -- be resolved. ???
14005
14006 if Present (Full_View (Priv_Sub))
14007 and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
14008 then
14009 Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
14010 Exchange_Declarations (Priv_Sub);
14011 end if;
14012
14013 Next_Elmt (Priv_Elmt);
14014 end loop;
14015 end Switch_View;
14016
14017 -----------------
14018 -- True_Parent --
14019 -----------------
14020
14021 function True_Parent (N : Node_Id) return Node_Id is
14022 begin
14023 if Nkind (Parent (N)) = N_Subunit then
14024 return Parent (Corresponding_Stub (Parent (N)));
14025 else
14026 return Parent (N);
14027 end if;
14028 end True_Parent;
14029
14030 -----------------------------
14031 -- Valid_Default_Attribute --
14032 -----------------------------
14033
14034 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
14035 Attr_Id : constant Attribute_Id :=
14036 Get_Attribute_Id (Attribute_Name (Def));
14037 T : constant Entity_Id := Entity (Prefix (Def));
14038 Is_Fun : constant Boolean := (Ekind (Nam) = E_Function);
14039 F : Entity_Id;
14040 Num_F : Int;
14041 OK : Boolean;
14042
14043 begin
14044 if No (T)
14045 or else T = Any_Id
14046 then
14047 return;
14048 end if;
14049
14050 Num_F := 0;
14051 F := First_Formal (Nam);
14052 while Present (F) loop
14053 Num_F := Num_F + 1;
14054 Next_Formal (F);
14055 end loop;
14056
14057 case Attr_Id is
14058 when Attribute_Adjacent | Attribute_Ceiling | Attribute_Copy_Sign |
14059 Attribute_Floor | Attribute_Fraction | Attribute_Machine |
14060 Attribute_Model | Attribute_Remainder | Attribute_Rounding |
14061 Attribute_Unbiased_Rounding =>
14062 OK := Is_Fun
14063 and then Num_F = 1
14064 and then Is_Floating_Point_Type (T);
14065
14066 when Attribute_Image | Attribute_Pred | Attribute_Succ |
14067 Attribute_Value | Attribute_Wide_Image |
14068 Attribute_Wide_Value =>
14069 OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
14070
14071 when Attribute_Max | Attribute_Min =>
14072 OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
14073
14074 when Attribute_Input =>
14075 OK := (Is_Fun and then Num_F = 1);
14076
14077 when Attribute_Output | Attribute_Read | Attribute_Write =>
14078 OK := (not Is_Fun and then Num_F = 2);
14079
14080 when others =>
14081 OK := False;
14082 end case;
14083
14084 if not OK then
14085 Error_Msg_N ("attribute reference has wrong profile for subprogram",
14086 Def);
14087 end if;
14088 end Valid_Default_Attribute;
14089
14090 end Sem_Ch12;