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