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