[multiple changes]
[gcc.git] / gcc / ada / sem_ch12.adb
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- S E M _ C H 1 2 --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1992-2014, Free Software Foundation, Inc. --
10 -- --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
24 ------------------------------------------------------------------------------
25
26 with Aspects; use Aspects;
27 with Atree; use Atree;
28 with Debug; use Debug;
29 with Einfo; use Einfo;
30 with Elists; use Elists;
31 with Errout; use Errout;
32 with Expander; use Expander;
33 with Exp_Disp; use Exp_Disp;
34 with Fname; use Fname;
35 with Fname.UF; use Fname.UF;
36 with Freeze; use Freeze;
37 with Itypes; use Itypes;
38 with Lib; use Lib;
39 with Lib.Load; use Lib.Load;
40 with Lib.Xref; use Lib.Xref;
41 with Nlists; use Nlists;
42 with Namet; use Namet;
43 with Nmake; use Nmake;
44 with Opt; use Opt;
45 with Rident; use Rident;
46 with Restrict; use Restrict;
47 with Rtsfind; use Rtsfind;
48 with Sem; use Sem;
49 with Sem_Aux; use Sem_Aux;
50 with Sem_Cat; use Sem_Cat;
51 with Sem_Ch3; use Sem_Ch3;
52 with Sem_Ch6; use Sem_Ch6;
53 with Sem_Ch7; use Sem_Ch7;
54 with Sem_Ch8; use Sem_Ch8;
55 with Sem_Ch10; use Sem_Ch10;
56 with Sem_Ch13; use Sem_Ch13;
57 with Sem_Dim; use Sem_Dim;
58 with Sem_Disp; use Sem_Disp;
59 with Sem_Elab; use Sem_Elab;
60 with Sem_Elim; use Sem_Elim;
61 with Sem_Eval; use Sem_Eval;
62 with Sem_Prag; use Sem_Prag;
63 with Sem_Res; use Sem_Res;
64 with Sem_Type; use Sem_Type;
65 with Sem_Util; use Sem_Util;
66 with Sem_Warn; use Sem_Warn;
67 with Stand; use Stand;
68 with Sinfo; use Sinfo;
69 with Sinfo.CN; use Sinfo.CN;
70 with Sinput; use Sinput;
71 with Sinput.L; use Sinput.L;
72 with Snames; use Snames;
73 with Stringt; use Stringt;
74 with Uname; use Uname;
75 with Table;
76 with Tbuild; use Tbuild;
77 with Uintp; use Uintp;
78 with Urealp; use Urealp;
79 with Warnsw; use Warnsw;
80
81 with GNAT.HTable;
82
83 package body Sem_Ch12 is
84
85 ----------------------------------------------------------
86 -- Implementation of Generic Analysis and Instantiation --
87 ----------------------------------------------------------
88
89 -- GNAT implements generics by macro expansion. No attempt is made to share
90 -- generic instantiations (for now). Analysis of a generic definition does
91 -- not perform any expansion action, but the expander must be called on the
92 -- tree for each instantiation, because the expansion may of course depend
93 -- on the generic actuals. All of this is best achieved as follows:
94 --
95 -- a) Semantic analysis of a generic unit is performed on a copy of the
96 -- tree for the generic unit. All tree modifications that follow analysis
97 -- do not affect the original tree. Links are kept between the original
98 -- tree and the copy, in order to recognize non-local references within
99 -- the generic, and propagate them to each instance (recall that name
100 -- resolution is done on the generic declaration: generics are not really
101 -- macros). This is summarized in the following diagram:
102
103 -- .-----------. .----------.
104 -- | semantic |<--------------| generic |
105 -- | copy | | unit |
106 -- | |==============>| |
107 -- |___________| global |__________|
108 -- references | | |
109 -- | | |
110 -- .-----|--|.
111 -- | .-----|---.
112 -- | | .----------.
113 -- | | | generic |
114 -- |__| | |
115 -- |__| instance |
116 -- |__________|
117
118 -- b) Each instantiation copies the original tree, and inserts into it a
119 -- series of declarations that describe the mapping between generic formals
120 -- and actuals. For example, a generic In OUT parameter is an object
121 -- renaming of the corresponding actual, etc. Generic IN parameters are
122 -- constant declarations.
123
124 -- c) In order to give the right visibility for these renamings, we use
125 -- a different scheme for package and subprogram instantiations. For
126 -- packages, the list of renamings is inserted into the package
127 -- specification, before the visible declarations of the package. The
128 -- renamings are analyzed before any of the text of the instance, and are
129 -- thus visible at the right place. Furthermore, outside of the instance,
130 -- the generic parameters are visible and denote their corresponding
131 -- actuals.
132
133 -- For subprograms, we create a container package to hold the renamings
134 -- and the subprogram instance itself. Analysis of the package makes the
135 -- renaming declarations visible to the subprogram. After analyzing the
136 -- package, the defining entity for the subprogram is touched-up so that
137 -- it appears declared in the current scope, and not inside the container
138 -- package.
139
140 -- If the instantiation is a compilation unit, the container package is
141 -- given the same name as the subprogram instance. This ensures that
142 -- the elaboration procedure called by the binder, using the compilation
143 -- unit name, calls in fact the elaboration procedure for the package.
144
145 -- Not surprisingly, private types complicate this approach. By saving in
146 -- the original generic object the non-local references, we guarantee that
147 -- the proper entities are referenced at the point of instantiation.
148 -- However, for private types, this by itself does not insure that the
149 -- proper VIEW of the entity is used (the full type may be visible at the
150 -- point of generic definition, but not at instantiation, or vice-versa).
151 -- In order to reference the proper view, we special-case any reference
152 -- to private types in the generic object, by saving both views, one in
153 -- the generic and one in the semantic copy. At time of instantiation, we
154 -- check whether the two views are consistent, and exchange declarations if
155 -- necessary, in order to restore the correct visibility. Similarly, if
156 -- the instance view is private when the generic view was not, we perform
157 -- the exchange. After completing the instantiation, we restore the
158 -- current visibility. The flag Has_Private_View marks identifiers in the
159 -- the generic unit that require checking.
160
161 -- Visibility within nested generic units requires special handling.
162 -- Consider the following scheme:
163
164 -- type Global is ... -- outside of generic unit.
165 -- generic ...
166 -- package Outer is
167 -- ...
168 -- type Semi_Global is ... -- global to inner.
169
170 -- generic ... -- 1
171 -- procedure inner (X1 : Global; X2 : Semi_Global);
172
173 -- procedure in2 is new inner (...); -- 4
174 -- end Outer;
175
176 -- package New_Outer is new Outer (...); -- 2
177 -- procedure New_Inner is new New_Outer.Inner (...); -- 3
178
179 -- The semantic analysis of Outer captures all occurrences of Global.
180 -- The semantic analysis of Inner (at 1) captures both occurrences of
181 -- Global and Semi_Global.
182
183 -- At point 2 (instantiation of Outer), we also produce a generic copy
184 -- of Inner, even though Inner is, at that point, not being instantiated.
185 -- (This is just part of the semantic analysis of New_Outer).
186
187 -- Critically, references to Global within Inner must be preserved, while
188 -- references to Semi_Global should not preserved, because they must now
189 -- resolve to an entity within New_Outer. To distinguish between these, we
190 -- use a global variable, Current_Instantiated_Parent, which is set when
191 -- performing a generic copy during instantiation (at 2). This variable is
192 -- used when performing a generic copy that is not an instantiation, but
193 -- that is nested within one, as the occurrence of 1 within 2. The analysis
194 -- of a nested generic only preserves references that are global to the
195 -- enclosing Current_Instantiated_Parent. We use the Scope_Depth value to
196 -- determine whether a reference is external to the given parent.
197
198 -- The instantiation at point 3 requires no special treatment. The method
199 -- works as well for further nestings of generic units, but of course the
200 -- variable Current_Instantiated_Parent must be stacked because nested
201 -- instantiations can occur, e.g. the occurrence of 4 within 2.
202
203 -- The instantiation of package and subprogram bodies is handled in a
204 -- similar manner, except that it is delayed until after semantic
205 -- analysis is complete. In this fashion complex cross-dependencies
206 -- between several package declarations and bodies containing generics
207 -- can be compiled which otherwise would diagnose spurious circularities.
208
209 -- For example, it is possible to compile two packages A and B that
210 -- have the following structure:
211
212 -- package A is package B is
213 -- generic ... generic ...
214 -- package G_A is package G_B is
215
216 -- with B; with A;
217 -- package body A is package body B is
218 -- package N_B is new G_B (..) package N_A is new G_A (..)
219
220 -- The table Pending_Instantiations in package Inline is used to keep
221 -- track of body instantiations that are delayed in this manner. Inline
222 -- handles the actual calls to do the body instantiations. This activity
223 -- is part of Inline, since the processing occurs at the same point, and
224 -- for essentially the same reason, as the handling of inlined routines.
225
226 ----------------------------------------------
227 -- Detection of Instantiation Circularities --
228 ----------------------------------------------
229
230 -- If we have a chain of instantiations that is circular, this is static
231 -- error which must be detected at compile time. The detection of these
232 -- circularities is carried out at the point that we insert a generic
233 -- instance spec or body. If there is a circularity, then the analysis of
234 -- the offending spec or body will eventually result in trying to load the
235 -- same unit again, and we detect this problem as we analyze the package
236 -- instantiation for the second time.
237
238 -- At least in some cases after we have detected the circularity, we get
239 -- into trouble if we try to keep going. The following flag is set if a
240 -- circularity is detected, and used to abandon compilation after the
241 -- messages have been posted.
242
243 Circularity_Detected : Boolean := False;
244 -- This should really be reset on encountering a new main unit, but in
245 -- practice we are not using multiple main units so it is not critical.
246
247 --------------------------------------------------
248 -- Formal packages and partial parameterization --
249 --------------------------------------------------
250
251 -- When compiling a generic, a formal package is a local instantiation. If
252 -- declared with a box, its generic formals are visible in the enclosing
253 -- generic. If declared with a partial list of actuals, those actuals that
254 -- are defaulted (covered by an Others clause, or given an explicit box
255 -- initialization) are also visible in the enclosing generic, while those
256 -- that have a corresponding actual are not.
257
258 -- In our source model of instantiation, the same visibility must be
259 -- present in the spec and body of an instance: the names of the formals
260 -- that are defaulted must be made visible within the instance, and made
261 -- invisible (hidden) after the instantiation is complete, so that they
262 -- are not accessible outside of the instance.
263
264 -- In a generic, a formal package is treated like a special instantiation.
265 -- Our Ada 95 compiler handled formals with and without box in different
266 -- ways. With partial parameterization, we use a single model for both.
267 -- We create a package declaration that consists of the specification of
268 -- the generic package, and a set of declarations that map the actuals
269 -- into local renamings, just as we do for bona fide instantiations. For
270 -- defaulted parameters and formals with a box, we copy directly the
271 -- declarations of the formal into this local package. The result is a
272 -- a package whose visible declarations may include generic formals. This
273 -- package is only used for type checking and visibility analysis, and
274 -- never reaches the back-end, so it can freely violate the placement
275 -- rules for generic formal declarations.
276
277 -- The list of declarations (renamings and copies of formals) is built
278 -- by Analyze_Associations, just as for regular instantiations.
279
280 -- At the point of instantiation, conformance checking must be applied only
281 -- to those parameters that were specified in the formal. We perform this
282 -- checking by creating another internal instantiation, this one including
283 -- only the renamings and the formals (the rest of the package spec is not
284 -- relevant to conformance checking). We can then traverse two lists: the
285 -- list of actuals in the instance that corresponds to the formal package,
286 -- and the list of actuals produced for this bogus instantiation. We apply
287 -- the conformance rules to those actuals that are not defaulted (i.e.
288 -- which still appear as generic formals.
289
290 -- When we compile an instance body we must make the right parameters
291 -- visible again. The predicate Is_Generic_Formal indicates which of the
292 -- formals should have its Is_Hidden flag reset.
293
294 -----------------------
295 -- Local subprograms --
296 -----------------------
297
298 procedure Abandon_Instantiation (N : Node_Id);
299 pragma No_Return (Abandon_Instantiation);
300 -- Posts an error message "instantiation abandoned" at the indicated node
301 -- and then raises the exception Instantiation_Error to do it.
302
303 procedure Analyze_Formal_Array_Type
304 (T : in out Entity_Id;
305 Def : Node_Id);
306 -- A formal array type is treated like an array type declaration, and
307 -- invokes Array_Type_Declaration (sem_ch3) whose first parameter is
308 -- in-out, because in the case of an anonymous type the entity is
309 -- actually created in the procedure.
310
311 -- The following procedures treat other kinds of formal parameters
312
313 procedure Analyze_Formal_Derived_Interface_Type
314 (N : Node_Id;
315 T : Entity_Id;
316 Def : Node_Id);
317
318 procedure Analyze_Formal_Derived_Type
319 (N : Node_Id;
320 T : Entity_Id;
321 Def : Node_Id);
322
323 procedure Analyze_Formal_Interface_Type
324 (N : Node_Id;
325 T : Entity_Id;
326 Def : Node_Id);
327
328 -- The following subprograms create abbreviated declarations for formal
329 -- scalar types. We introduce an anonymous base of the proper class for
330 -- each of them, and define the formals as constrained first subtypes of
331 -- their bases. The bounds are expressions that are non-static in the
332 -- generic.
333
334 procedure Analyze_Formal_Decimal_Fixed_Point_Type
335 (T : Entity_Id; Def : Node_Id);
336 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id);
337 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id);
338 procedure Analyze_Formal_Signed_Integer_Type (T : Entity_Id; Def : Node_Id);
339 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id);
340 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
341 (T : Entity_Id; Def : Node_Id);
342
343 procedure Analyze_Formal_Private_Type
344 (N : Node_Id;
345 T : Entity_Id;
346 Def : Node_Id);
347 -- Creates a new private type, which does not require completion
348
349 procedure Analyze_Formal_Incomplete_Type (T : Entity_Id; Def : Node_Id);
350 -- Ada 2012: Creates a new incomplete type whose actual does not freeze
351
352 procedure Analyze_Generic_Formal_Part (N : Node_Id);
353 -- Analyze generic formal part
354
355 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
356 -- Create a new access type with the given designated type
357
358 function Analyze_Associations
359 (I_Node : Node_Id;
360 Formals : List_Id;
361 F_Copy : List_Id) return List_Id;
362 -- At instantiation time, build the list of associations between formals
363 -- and actuals. Each association becomes a renaming declaration for the
364 -- formal entity. F_Copy is the analyzed list of formals in the generic
365 -- copy. It is used to apply legality checks to the actuals. I_Node is the
366 -- instantiation node itself.
367
368 procedure Analyze_Subprogram_Instantiation
369 (N : Node_Id;
370 K : Entity_Kind);
371
372 procedure Build_Instance_Compilation_Unit_Nodes
373 (N : Node_Id;
374 Act_Body : Node_Id;
375 Act_Decl : Node_Id);
376 -- This procedure is used in the case where the generic instance of a
377 -- subprogram body or package body is a library unit. In this case, the
378 -- original library unit node for the generic instantiation must be
379 -- replaced by the resulting generic body, and a link made to a new
380 -- compilation unit node for the generic declaration. The argument N is
381 -- the original generic instantiation. Act_Body and Act_Decl are the body
382 -- and declaration of the instance (either package body and declaration
383 -- nodes or subprogram body and declaration nodes depending on the case).
384 -- On return, the node N has been rewritten with the actual body.
385
386 procedure Check_Access_Definition (N : Node_Id);
387 -- Subsidiary routine to null exclusion processing. Perform an assertion
388 -- check on Ada version and the presence of an access definition in N.
389
390 procedure Check_Formal_Packages (P_Id : Entity_Id);
391 -- Apply the following to all formal packages in generic associations
392
393 procedure Check_Formal_Package_Instance
394 (Formal_Pack : Entity_Id;
395 Actual_Pack : Entity_Id);
396 -- Verify that the actuals of the actual instance match the actuals of
397 -- the template for a formal package that is not declared with a box.
398
399 procedure Check_Forward_Instantiation (Decl : Node_Id);
400 -- If the generic is a local entity and the corresponding body has not
401 -- been seen yet, flag enclosing packages to indicate that it will be
402 -- elaborated after the generic body. Subprograms declared in the same
403 -- package cannot be inlined by the front-end because front-end inlining
404 -- requires a strict linear order of elaboration.
405
406 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id;
407 -- Check if some association between formals and actuals requires to make
408 -- visible primitives of a tagged type, and make those primitives visible.
409 -- Return the list of primitives whose visibility is modified (to restore
410 -- their visibility later through Restore_Hidden_Primitives). If no
411 -- candidate is found then return No_Elist.
412
413 procedure Check_Hidden_Child_Unit
414 (N : Node_Id;
415 Gen_Unit : Entity_Id;
416 Act_Decl_Id : Entity_Id);
417 -- If the generic unit is an implicit child instance within a parent
418 -- instance, we need to make an explicit test that it is not hidden by
419 -- a child instance of the same name and parent.
420
421 procedure Check_Generic_Actuals
422 (Instance : Entity_Id;
423 Is_Formal_Box : Boolean);
424 -- Similar to previous one. Check the actuals in the instantiation,
425 -- whose views can change between the point of instantiation and the point
426 -- of instantiation of the body. In addition, mark the generic renamings
427 -- as generic actuals, so that they are not compatible with other actuals.
428 -- Recurse on an actual that is a formal package whose declaration has
429 -- a box.
430
431 function Contains_Instance_Of
432 (Inner : Entity_Id;
433 Outer : Entity_Id;
434 N : Node_Id) return Boolean;
435 -- Inner is instantiated within the generic Outer. Check whether Inner
436 -- directly or indirectly contains an instance of Outer or of one of its
437 -- parents, in the case of a subunit. Each generic unit holds a list of
438 -- the entities instantiated within (at any depth). This procedure
439 -- determines whether the set of such lists contains a cycle, i.e. an
440 -- illegal circular instantiation.
441
442 function Denotes_Formal_Package
443 (Pack : Entity_Id;
444 On_Exit : Boolean := False;
445 Instance : Entity_Id := Empty) return Boolean;
446 -- Returns True if E is a formal package of an enclosing generic, or
447 -- the actual for such a formal in an enclosing instantiation. If such
448 -- a package is used as a formal in an nested generic, or as an actual
449 -- in a nested instantiation, the visibility of ITS formals should not
450 -- be modified. When called from within Restore_Private_Views, the flag
451 -- On_Exit is true, to indicate that the search for a possible enclosing
452 -- instance should ignore the current one. In that case Instance denotes
453 -- the declaration for which this is an actual. This declaration may be
454 -- an instantiation in the source, or the internal instantiation that
455 -- corresponds to the actual for a formal package.
456
457 function Earlier (N1, N2 : Node_Id) return Boolean;
458 -- Yields True if N1 and N2 appear in the same compilation unit,
459 -- ignoring subunits, and if N1 is to the left of N2 in a left-to-right
460 -- traversal of the tree for the unit. Used to determine the placement
461 -- of freeze nodes for instance bodies that may depend on other instances.
462
463 function Find_Actual_Type
464 (Typ : Entity_Id;
465 Gen_Type : Entity_Id) return Entity_Id;
466 -- When validating the actual types of a child instance, check whether
467 -- the formal is a formal type of the parent unit, and retrieve the current
468 -- actual for it. Typ is the entity in the analyzed formal type declaration
469 -- (component or index type of an array type, or designated type of an
470 -- access formal) and Gen_Type is the enclosing analyzed formal array
471 -- or access type. The desired actual may be a formal of a parent, or may
472 -- be declared in a formal package of a parent. In both cases it is a
473 -- generic actual type because it appears within a visible instance.
474 -- Finally, it may be declared in a parent unit without being a formal
475 -- of that unit, in which case it must be retrieved by visibility.
476 -- Ambiguities may still arise if two homonyms are declared in two formal
477 -- packages, and the prefix of the formal type may be needed to resolve
478 -- the ambiguity in the instance ???
479
480 function In_Same_Declarative_Part
481 (F_Node : Node_Id;
482 Inst : Node_Id) return Boolean;
483 -- True if the instantiation Inst and the given freeze_node F_Node appear
484 -- within the same declarative part, ignoring subunits, but with no inter-
485 -- vening subprograms or concurrent units. Used to find the proper plave
486 -- for the freeze node of an instance, when the generic is declared in a
487 -- previous instance. If predicate is true, the freeze node of the instance
488 -- can be placed after the freeze node of the previous instance, Otherwise
489 -- it has to be placed at the end of the current declarative part.
490
491 function In_Main_Context (E : Entity_Id) return Boolean;
492 -- Check whether an instantiation is in the context of the main unit.
493 -- Used to determine whether its body should be elaborated to allow
494 -- front-end inlining.
495
496 procedure Set_Instance_Env
497 (Gen_Unit : Entity_Id;
498 Act_Unit : Entity_Id);
499 -- Save current instance on saved environment, to be used to determine
500 -- the global status of entities in nested instances. Part of Save_Env.
501 -- called after verifying that the generic unit is legal for the instance,
502 -- The procedure also examines whether the generic unit is a predefined
503 -- unit, in order to set configuration switches accordingly. As a result
504 -- the procedure must be called after analyzing and freezing the actuals.
505
506 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id);
507 -- Associate analyzed generic parameter with corresponding
508 -- instance. Used for semantic checks at instantiation time.
509
510 function Has_Been_Exchanged (E : Entity_Id) return Boolean;
511 -- Traverse the Exchanged_Views list to see if a type was private
512 -- and has already been flipped during this phase of instantiation.
513
514 procedure Hide_Current_Scope;
515 -- When instantiating a generic child unit, the parent context must be
516 -- present, but the instance and all entities that may be generated
517 -- must be inserted in the current scope. We leave the current scope
518 -- on the stack, but make its entities invisible to avoid visibility
519 -- problems. This is reversed at the end of the instantiation. This is
520 -- not done for the instantiation of the bodies, which only require the
521 -- instances of the generic parents to be in scope.
522
523 procedure Install_Body
524 (Act_Body : Node_Id;
525 N : Node_Id;
526 Gen_Body : Node_Id;
527 Gen_Decl : Node_Id);
528 -- If the instantiation happens textually before the body of the generic,
529 -- the instantiation of the body must be analyzed after the generic body,
530 -- and not at the point of instantiation. Such early instantiations can
531 -- happen if the generic and the instance appear in a package declaration
532 -- because the generic body can only appear in the corresponding package
533 -- body. Early instantiations can also appear if generic, instance and
534 -- body are all in the declarative part of a subprogram or entry. Entities
535 -- of packages that are early instantiations are delayed, and their freeze
536 -- node appears after the generic body.
537
538 procedure Insert_Freeze_Node_For_Instance
539 (N : Node_Id;
540 F_Node : Node_Id);
541 -- N denotes a package or a subprogram instantiation and F_Node is the
542 -- associated freeze node. Insert the freeze node before the first source
543 -- body which follows immediately after N. If no such body is found, the
544 -- freeze node is inserted at the end of the declarative region which
545 -- contains N.
546
547 procedure Freeze_Subprogram_Body
548 (Inst_Node : Node_Id;
549 Gen_Body : Node_Id;
550 Pack_Id : Entity_Id);
551 -- The generic body may appear textually after the instance, including
552 -- in the proper body of a stub, or within a different package instance.
553 -- Given that the instance can only be elaborated after the generic, we
554 -- place freeze_nodes for the instance and/or for packages that may enclose
555 -- the instance and the generic, so that the back-end can establish the
556 -- proper order of elaboration.
557
558 procedure Init_Env;
559 -- Establish environment for subsequent instantiation. Separated from
560 -- Save_Env because data-structures for visibility handling must be
561 -- initialized before call to Check_Generic_Child_Unit.
562
563 procedure Install_Formal_Packages (Par : Entity_Id);
564 -- Install the visible part of any formal of the parent that is a formal
565 -- package. Note that for the case of a formal package with a box, this
566 -- includes the formal part of the formal package (12.7(10/2)).
567
568 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False);
569 -- When compiling an instance of a child unit the parent (which is
570 -- itself an instance) is an enclosing scope that must be made
571 -- immediately visible. This procedure is also used to install the non-
572 -- generic parent of a generic child unit when compiling its body, so
573 -- that full views of types in the parent are made visible.
574
575 procedure Remove_Parent (In_Body : Boolean := False);
576 -- Reverse effect after instantiation of child is complete
577
578 procedure Install_Hidden_Primitives
579 (Prims_List : in out Elist_Id;
580 Gen_T : Entity_Id;
581 Act_T : Entity_Id);
582 -- Remove suffix 'P' from hidden primitives of Act_T to match the
583 -- visibility of primitives of Gen_T. The list of primitives to which
584 -- the suffix is removed is added to Prims_List to restore them later.
585
586 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id);
587 -- Restore suffix 'P' to primitives of Prims_List and leave Prims_List
588 -- set to No_Elist.
589
590 procedure Inline_Instance_Body
591 (N : Node_Id;
592 Gen_Unit : Entity_Id;
593 Act_Decl : Node_Id);
594 -- If front-end inlining is requested, instantiate the package body,
595 -- and preserve the visibility of its compilation unit, to insure
596 -- that successive instantiations succeed.
597
598 -- The functions Instantiate_XXX perform various legality checks and build
599 -- the declarations for instantiated generic parameters. In all of these
600 -- Formal is the entity in the generic unit, Actual is the entity of
601 -- expression in the generic associations, and Analyzed_Formal is the
602 -- formal in the generic copy, which contains the semantic information to
603 -- be used to validate the actual.
604
605 function Instantiate_Object
606 (Formal : Node_Id;
607 Actual : Node_Id;
608 Analyzed_Formal : Node_Id) return List_Id;
609
610 function Instantiate_Type
611 (Formal : Node_Id;
612 Actual : Node_Id;
613 Analyzed_Formal : Node_Id;
614 Actual_Decls : List_Id) return List_Id;
615
616 function Instantiate_Formal_Subprogram
617 (Formal : Node_Id;
618 Actual : Node_Id;
619 Analyzed_Formal : Node_Id) return Node_Id;
620
621 function Instantiate_Formal_Package
622 (Formal : Node_Id;
623 Actual : Node_Id;
624 Analyzed_Formal : Node_Id) return List_Id;
625 -- If the formal package is declared with a box, special visibility rules
626 -- apply to its formals: they are in the visible part of the package. This
627 -- is true in the declarative region of the formal package, that is to say
628 -- in the enclosing generic or instantiation. For an instantiation, the
629 -- parameters of the formal package are made visible in an explicit step.
630 -- Furthermore, if the actual has a visible USE clause, these formals must
631 -- be made potentially use-visible as well. On exit from the enclosing
632 -- instantiation, the reverse must be done.
633
634 -- For a formal package declared without a box, there are conformance rules
635 -- that apply to the actuals in the generic declaration and the actuals of
636 -- the actual package in the enclosing instantiation. The simplest way to
637 -- apply these rules is to repeat the instantiation of the formal package
638 -- in the context of the enclosing instance, and compare the generic
639 -- associations of this instantiation with those of the actual package.
640 -- This internal instantiation only needs to contain the renamings of the
641 -- formals: the visible and private declarations themselves need not be
642 -- created.
643
644 -- In Ada 2005, the formal package may be only partially parameterized.
645 -- In that case the visibility step must make visible those actuals whose
646 -- corresponding formals were given with a box. A final complication
647 -- involves inherited operations from formal derived types, which must
648 -- be visible if the type is.
649
650 function Is_In_Main_Unit (N : Node_Id) return Boolean;
651 -- Test if given node is in the main unit
652
653 procedure Load_Parent_Of_Generic
654 (N : Node_Id;
655 Spec : Node_Id;
656 Body_Optional : Boolean := False);
657 -- If the generic appears in a separate non-generic library unit, load the
658 -- corresponding body to retrieve the body of the generic. N is the node
659 -- for the generic instantiation, Spec is the generic package declaration.
660 --
661 -- Body_Optional is a flag that indicates that the body is being loaded to
662 -- ensure that temporaries are generated consistently when there are other
663 -- instances in the current declarative part that precede the one being
664 -- loaded. In that case a missing body is acceptable.
665
666 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id);
667 -- Add the context clause of the unit containing a generic unit to a
668 -- compilation unit that is, or contains, an instantiation.
669
670 function Get_Associated_Node (N : Node_Id) return Node_Id;
671 -- In order to propagate semantic information back from the analyzed copy
672 -- to the original generic, we maintain links between selected nodes in the
673 -- generic and their corresponding copies. At the end of generic analysis,
674 -- the routine Save_Global_References traverses the generic tree, examines
675 -- the semantic information, and preserves the links to those nodes that
676 -- contain global information. At instantiation, the information from the
677 -- associated node is placed on the new copy, so that name resolution is
678 -- not repeated.
679 --
680 -- Three kinds of source nodes have associated nodes:
681 --
682 -- a) those that can reference (denote) entities, that is identifiers,
683 -- character literals, expanded_names, operator symbols, operators,
684 -- and attribute reference nodes. These nodes have an Entity field
685 -- and are the set of nodes that are in N_Has_Entity.
686 --
687 -- b) aggregates (N_Aggregate and N_Extension_Aggregate)
688 --
689 -- c) selected components (N_Selected_Component)
690 --
691 -- For the first class, the associated node preserves the entity if it is
692 -- global. If the generic contains nested instantiations, the associated
693 -- node itself has been recopied, and a chain of them must be followed.
694 --
695 -- For aggregates, the associated node allows retrieval of the type, which
696 -- may otherwise not appear in the generic. The view of this type may be
697 -- different between generic and instantiation, and the full view can be
698 -- installed before the instantiation is analyzed. For aggregates of type
699 -- extensions, the same view exchange may have to be performed for some of
700 -- the ancestor types, if their view is private at the point of
701 -- instantiation.
702 --
703 -- Nodes that are selected components in the parse tree may be rewritten
704 -- as expanded names after resolution, and must be treated as potential
705 -- entity holders, which is why they also have an Associated_Node.
706 --
707 -- Nodes that do not come from source, such as freeze nodes, do not appear
708 -- in the generic tree, and need not have an associated node.
709 --
710 -- The associated node is stored in the Associated_Node field. Note that
711 -- this field overlaps Entity, which is fine, because the whole point is
712 -- that we don't need or want the normal Entity field in this situation.
713
714 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id);
715 -- Within the generic part, entities in the formal package are
716 -- visible. To validate subsequent type declarations, indicate
717 -- the correspondence between the entities in the analyzed formal,
718 -- and the entities in the actual package. There are three packages
719 -- involved in the instantiation of a formal package: the parent
720 -- generic P1 which appears in the generic declaration, the fake
721 -- instantiation P2 which appears in the analyzed generic, and whose
722 -- visible entities may be used in subsequent formals, and the actual
723 -- P3 in the instance. To validate subsequent formals, me indicate
724 -- that the entities in P2 are mapped into those of P3. The mapping of
725 -- entities has to be done recursively for nested packages.
726
727 procedure Move_Freeze_Nodes
728 (Out_Of : Entity_Id;
729 After : Node_Id;
730 L : List_Id);
731 -- Freeze nodes can be generated in the analysis of a generic unit, but
732 -- will not be seen by the back-end. It is necessary to move those nodes
733 -- to the enclosing scope if they freeze an outer entity. We place them
734 -- at the end of the enclosing generic package, which is semantically
735 -- neutral.
736
737 procedure Preanalyze_Actuals (N : Node_Id);
738 -- Analyze actuals to perform name resolution. Full resolution is done
739 -- later, when the expected types are known, but names have to be captured
740 -- before installing parents of generics, that are not visible for the
741 -- actuals themselves.
742
743 function True_Parent (N : Node_Id) return Node_Id;
744 -- For a subunit, return parent of corresponding stub, else return
745 -- parent of node.
746
747 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id);
748 -- Verify that an attribute that appears as the default for a formal
749 -- subprogram is a function or procedure with the correct profile.
750
751 -------------------------------------------
752 -- Data Structures for Generic Renamings --
753 -------------------------------------------
754
755 -- The map Generic_Renamings associates generic entities with their
756 -- corresponding actuals. Currently used to validate type instances. It
757 -- will eventually be used for all generic parameters to eliminate the
758 -- need for overload resolution in the instance.
759
760 type Assoc_Ptr is new Int;
761
762 Assoc_Null : constant Assoc_Ptr := -1;
763
764 type Assoc is record
765 Gen_Id : Entity_Id;
766 Act_Id : Entity_Id;
767 Next_In_HTable : Assoc_Ptr;
768 end record;
769
770 package Generic_Renamings is new Table.Table
771 (Table_Component_Type => Assoc,
772 Table_Index_Type => Assoc_Ptr,
773 Table_Low_Bound => 0,
774 Table_Initial => 10,
775 Table_Increment => 100,
776 Table_Name => "Generic_Renamings");
777
778 -- Variable to hold enclosing instantiation. When the environment is
779 -- saved for a subprogram inlining, the corresponding Act_Id is empty.
780
781 Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
782
783 -- Hash table for associations
784
785 HTable_Size : constant := 37;
786 type HTable_Range is range 0 .. HTable_Size - 1;
787
788 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr);
789 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr;
790 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id;
791 function Hash (F : Entity_Id) return HTable_Range;
792
793 package Generic_Renamings_HTable is new GNAT.HTable.Static_HTable (
794 Header_Num => HTable_Range,
795 Element => Assoc,
796 Elmt_Ptr => Assoc_Ptr,
797 Null_Ptr => Assoc_Null,
798 Set_Next => Set_Next_Assoc,
799 Next => Next_Assoc,
800 Key => Entity_Id,
801 Get_Key => Get_Gen_Id,
802 Hash => Hash,
803 Equal => "=");
804
805 Exchanged_Views : Elist_Id;
806 -- This list holds the private views that have been exchanged during
807 -- instantiation to restore the visibility of the generic declaration.
808 -- (see comments above). After instantiation, the current visibility is
809 -- reestablished by means of a traversal of this list.
810
811 Hidden_Entities : Elist_Id;
812 -- This list holds the entities of the current scope that are removed
813 -- from immediate visibility when instantiating a child unit. Their
814 -- visibility is restored in Remove_Parent.
815
816 -- Because instantiations can be recursive, the following must be saved
817 -- on entry and restored on exit from an instantiation (spec or body).
818 -- This is done by the two procedures Save_Env and Restore_Env. For
819 -- package and subprogram instantiations (but not for the body instances)
820 -- the action of Save_Env is done in two steps: Init_Env is called before
821 -- Check_Generic_Child_Unit, because setting the parent instances requires
822 -- that the visibility data structures be properly initialized. Once the
823 -- generic is unit is validated, Set_Instance_Env completes Save_Env.
824
825 Parent_Unit_Visible : Boolean := False;
826 -- Parent_Unit_Visible is used when the generic is a child unit, and
827 -- indicates whether the ultimate parent of the generic is visible in the
828 -- instantiation environment. It is used to reset the visibility of the
829 -- parent at the end of the instantiation (see Remove_Parent).
830
831 Instance_Parent_Unit : Entity_Id := Empty;
832 -- This records the ultimate parent unit of an instance of a generic
833 -- child unit and is used in conjunction with Parent_Unit_Visible to
834 -- indicate the unit to which the Parent_Unit_Visible flag corresponds.
835
836 type Instance_Env is record
837 Instantiated_Parent : Assoc;
838 Exchanged_Views : Elist_Id;
839 Hidden_Entities : Elist_Id;
840 Current_Sem_Unit : Unit_Number_Type;
841 Parent_Unit_Visible : Boolean := False;
842 Instance_Parent_Unit : Entity_Id := Empty;
843 Switches : Config_Switches_Type;
844 end record;
845
846 package Instance_Envs is new Table.Table (
847 Table_Component_Type => Instance_Env,
848 Table_Index_Type => Int,
849 Table_Low_Bound => 0,
850 Table_Initial => 32,
851 Table_Increment => 100,
852 Table_Name => "Instance_Envs");
853
854 procedure Restore_Private_Views
855 (Pack_Id : Entity_Id;
856 Is_Package : Boolean := True);
857 -- Restore the private views of external types, and unmark the generic
858 -- renamings of actuals, so that they become compatible subtypes again.
859 -- For subprograms, Pack_Id is the package constructed to hold the
860 -- renamings.
861
862 procedure Switch_View (T : Entity_Id);
863 -- Switch the partial and full views of a type and its private
864 -- dependents (i.e. its subtypes and derived types).
865
866 ------------------------------------
867 -- Structures for Error Reporting --
868 ------------------------------------
869
870 Instantiation_Node : Node_Id;
871 -- Used by subprograms that validate instantiation of formal parameters
872 -- where there might be no actual on which to place the error message.
873 -- Also used to locate the instantiation node for generic subunits.
874
875 Instantiation_Error : exception;
876 -- When there is a semantic error in the generic parameter matching,
877 -- there is no point in continuing the instantiation, because the
878 -- number of cascaded errors is unpredictable. This exception aborts
879 -- the instantiation process altogether.
880
881 S_Adjustment : Sloc_Adjustment;
882 -- Offset created for each node in an instantiation, in order to keep
883 -- track of the source position of the instantiation in each of its nodes.
884 -- A subsequent semantic error or warning on a construct of the instance
885 -- points to both places: the original generic node, and the point of
886 -- instantiation. See Sinput and Sinput.L for additional details.
887
888 ------------------------------------------------------------
889 -- Data structure for keeping track when inside a Generic --
890 ------------------------------------------------------------
891
892 -- The following table is used to save values of the Inside_A_Generic
893 -- flag (see spec of Sem) when they are saved by Start_Generic.
894
895 package Generic_Flags is new Table.Table (
896 Table_Component_Type => Boolean,
897 Table_Index_Type => Int,
898 Table_Low_Bound => 0,
899 Table_Initial => 32,
900 Table_Increment => 200,
901 Table_Name => "Generic_Flags");
902
903 ---------------------------
904 -- Abandon_Instantiation --
905 ---------------------------
906
907 procedure Abandon_Instantiation (N : Node_Id) is
908 begin
909 Error_Msg_N ("\instantiation abandoned!", N);
910 raise Instantiation_Error;
911 end Abandon_Instantiation;
912
913 --------------------------
914 -- Analyze_Associations --
915 --------------------------
916
917 function Analyze_Associations
918 (I_Node : Node_Id;
919 Formals : List_Id;
920 F_Copy : List_Id) return List_Id
921 is
922 Actuals_To_Freeze : constant Elist_Id := New_Elmt_List;
923 Assoc : constant List_Id := New_List;
924 Default_Actuals : constant Elist_Id := New_Elmt_List;
925 Gen_Unit : constant Entity_Id :=
926 Defining_Entity (Parent (F_Copy));
927
928 Actuals : List_Id;
929 Actual : Node_Id;
930 Analyzed_Formal : Node_Id;
931 First_Named : Node_Id := Empty;
932 Formal : Node_Id;
933 Match : Node_Id;
934 Named : Node_Id;
935 Saved_Formal : Node_Id;
936
937 Default_Formals : constant List_Id := New_List;
938 -- If an Others_Choice is present, some of the formals may be defaulted.
939 -- To simplify the treatment of visibility in an instance, we introduce
940 -- individual defaults for each such formal. These defaults are
941 -- appended to the list of associations and replace the Others_Choice.
942
943 Found_Assoc : Node_Id;
944 -- Association for the current formal being match. Empty if there are
945 -- no remaining actuals, or if there is no named association with the
946 -- name of the formal.
947
948 Is_Named_Assoc : Boolean;
949 Num_Matched : Int := 0;
950 Num_Actuals : Int := 0;
951
952 Others_Present : Boolean := False;
953 Others_Choice : Node_Id := Empty;
954 -- In Ada 2005, indicates partial parameterization of a formal
955 -- package. As usual an other association must be last in the list.
956
957 function Build_Wrapper (Formal : Entity_Id) return Node_Id;
958 -- In GNATProve mode, create a wrapper function for actuals that are
959 -- operators, in order to propagate their contract to the renaming
960 -- declarations generated for them.
961
962 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id);
963 -- Apply RM 12.3 (9): if a formal subprogram is overloaded, the instance
964 -- cannot have a named association for it. AI05-0025 extends this rule
965 -- to formals of formal packages by AI05-0025, and it also applies to
966 -- box-initialized formals.
967
968 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean;
969 -- Determine whether the parameter types and the return type of Subp
970 -- are fully defined at the point of instantiation.
971
972 function Matching_Actual
973 (F : Entity_Id;
974 A_F : Entity_Id) return Node_Id;
975 -- Find actual that corresponds to a given a formal parameter. If the
976 -- actuals are positional, return the next one, if any. If the actuals
977 -- are named, scan the parameter associations to find the right one.
978 -- A_F is the corresponding entity in the analyzed generic,which is
979 -- placed on the selector name for ASIS use.
980 --
981 -- In Ada 2005, a named association may be given with a box, in which
982 -- case Matching_Actual sets Found_Assoc to the generic association,
983 -- but return Empty for the actual itself. In this case the code below
984 -- creates a corresponding declaration for the formal.
985
986 function Partial_Parameterization return Boolean;
987 -- Ada 2005: if no match is found for a given formal, check if the
988 -- association for it includes a box, or whether the associations
989 -- include an Others clause.
990
991 procedure Process_Default (F : Entity_Id);
992 -- Add a copy of the declaration of generic formal F to the list of
993 -- associations, and add an explicit box association for F if there
994 -- is none yet, and the default comes from an Others_Choice.
995
996 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean;
997 -- Determine whether Subp renames one of the subprograms defined in the
998 -- generated package Standard.
999
1000 procedure Set_Analyzed_Formal;
1001 -- Find the node in the generic copy that corresponds to a given formal.
1002 -- The semantic information on this node is used to perform legality
1003 -- checks on the actuals. Because semantic analysis can introduce some
1004 -- anonymous entities or modify the declaration node itself, the
1005 -- correspondence between the two lists is not one-one. In addition to
1006 -- anonymous types, the presence a formal equality will introduce an
1007 -- implicit declaration for the corresponding inequality.
1008
1009 -------------------
1010 -- Build_Wrapper --
1011 -------------------
1012
1013 function Build_Wrapper (Formal : Entity_Id) return Node_Id is
1014 Loc : constant Source_Ptr := Sloc (I_Node);
1015 Op_Name : constant Name_Id := Chars (Formal);
1016 Typ : constant Entity_Id := Etype (Formal);
1017
1018 Decl : Node_Id;
1019 Expr : Node_Id;
1020 F1, F2 : Entity_Id;
1021 Func : Entity_Id;
1022 Spec : Node_Id;
1023
1024 L, R : Node_Id;
1025
1026 begin
1027 -- Create entities for wrapper function and its formals
1028
1029 F1 := Make_Temporary (Loc, 'A');
1030 F2 := Make_Temporary (Loc, 'B');
1031 L := New_Occurrence_Of (F1, Loc);
1032 R := New_Occurrence_Of (F2, Loc);
1033
1034 Func := Make_Temporary (Loc, 'F');
1035
1036 Spec := Make_Function_Specification (Loc,
1037 Defining_Unit_Name => Func,
1038
1039 Parameter_Specifications => New_List (
1040 Make_Parameter_Specification (Loc,
1041 Defining_Identifier => F1,
1042 Parameter_Type => Make_Identifier (Loc, Chars (Typ))),
1043 Make_Parameter_Specification (Loc,
1044 Defining_Identifier => F2,
1045 Parameter_Type => Make_Identifier (Loc, Chars (Typ)))),
1046
1047 Result_Definition => Make_Identifier (Loc, Chars (Typ)));
1048
1049 -- Build expression as an operator node that corresponds to the
1050 -- name of the actual, starting with binary operators.
1051
1052 if Op_Name = Name_Op_And then
1053 Expr := Make_Op_And (Loc, Left_Opnd => L, Right_Opnd => R);
1054
1055 elsif Op_Name = Name_Op_Or then
1056 Expr := Make_Op_Or (Loc, Left_Opnd => L, Right_Opnd => R);
1057
1058 elsif Op_Name = Name_Op_Xor then
1059 Expr := Make_Op_Xor (Loc, Left_Opnd => L, Right_Opnd => R);
1060
1061 elsif Op_Name = Name_Op_Eq then
1062 Expr := Make_Op_Eq (Loc, Left_Opnd => L, Right_Opnd => R);
1063
1064 elsif Op_Name = Name_Op_Ne then
1065 Expr := Make_Op_Ne (Loc, Left_Opnd => L, Right_Opnd => R);
1066
1067 elsif Op_Name = Name_Op_Le then
1068 Expr := Make_Op_Le (Loc, Left_Opnd => L, Right_Opnd => R);
1069
1070 elsif Op_Name = Name_Op_Gt then
1071 Expr := Make_Op_Gt (Loc, Left_Opnd => L, Right_Opnd => R);
1072
1073 elsif Op_Name = Name_Op_Ge then
1074 Expr := Make_Op_Ge (Loc, Left_Opnd => L, Right_Opnd => R);
1075
1076 elsif Op_Name = Name_Op_Lt then
1077 Expr := Make_Op_Lt (Loc, Left_Opnd => L, Right_Opnd => R);
1078
1079 elsif Op_Name = Name_Op_Add then
1080 Expr := Make_Op_Add (Loc, Left_Opnd => L, Right_Opnd => R);
1081
1082 elsif Op_Name = Name_Op_Subtract then
1083 Expr := Make_Op_Subtract (Loc, Left_Opnd => L, Right_Opnd => R);
1084
1085 elsif Op_Name = Name_Op_Concat then
1086 Expr := Make_Op_Concat (Loc, Left_Opnd => L, Right_Opnd => R);
1087
1088 elsif Op_Name = Name_Op_Multiply then
1089 Expr := Make_Op_Multiply (Loc, Left_Opnd => L, Right_Opnd => R);
1090
1091 elsif Op_Name = Name_Op_Divide then
1092 Expr := Make_Op_Divide (Loc, Left_Opnd => L, Right_Opnd => R);
1093
1094 elsif Op_Name = Name_Op_Mod then
1095 Expr := Make_Op_Mod (Loc, Left_Opnd => L, Right_Opnd => R);
1096
1097 elsif Op_Name = Name_Op_Rem then
1098 Expr := Make_Op_Rem (Loc, Left_Opnd => L, Right_Opnd => R);
1099
1100 elsif Op_Name = Name_Op_Expon then
1101 Expr := Make_Op_Expon (Loc, Left_Opnd => L, Right_Opnd => R);
1102
1103 -- Unary operators.
1104
1105 elsif Op_Name = Name_Op_Add
1106 and then No (Next_Formal (First_Formal (Actual)))
1107 then
1108 Expr := Make_Op_Plus (Loc, Right_Opnd => R);
1109
1110 elsif Op_Name = Name_Op_Subtract
1111 and then No (Next_Formal (First_Formal (Actual)))
1112 then
1113 Expr := Make_Op_Minus (Loc, Right_Opnd => R);
1114
1115 elsif Op_Name = Name_Op_Abs then
1116 Expr := Make_Op_Abs (Loc, Right_Opnd => R);
1117
1118 elsif Op_Name = Name_Op_Not then
1119 Expr := Make_Op_Not (Loc, Right_Opnd => R);
1120 end if;
1121
1122 Decl := Make_Expression_Function (Loc,
1123 Specification => Spec,
1124 Expression => Expr);
1125
1126 return Decl;
1127 end Build_Wrapper;
1128
1129 ----------------------------------------
1130 -- Check_Overloaded_Formal_Subprogram --
1131 ----------------------------------------
1132
1133 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id) is
1134 Temp_Formal : Entity_Id;
1135
1136 begin
1137 Temp_Formal := First (Formals);
1138 while Present (Temp_Formal) loop
1139 if Nkind (Temp_Formal) in N_Formal_Subprogram_Declaration
1140 and then Temp_Formal /= Formal
1141 and then
1142 Chars (Defining_Unit_Name (Specification (Formal))) =
1143 Chars (Defining_Unit_Name (Specification (Temp_Formal)))
1144 then
1145 if Present (Found_Assoc) then
1146 Error_Msg_N
1147 ("named association not allowed for overloaded formal",
1148 Found_Assoc);
1149
1150 else
1151 Error_Msg_N
1152 ("named association not allowed for overloaded formal",
1153 Others_Choice);
1154 end if;
1155
1156 Abandon_Instantiation (Instantiation_Node);
1157 end if;
1158
1159 Next (Temp_Formal);
1160 end loop;
1161 end Check_Overloaded_Formal_Subprogram;
1162
1163 -------------------------------
1164 -- Has_Fully_Defined_Profile --
1165 -------------------------------
1166
1167 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean is
1168 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean;
1169 -- Determine whethet type Typ is fully defined
1170
1171 ---------------------------
1172 -- Is_Fully_Defined_Type --
1173 ---------------------------
1174
1175 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean is
1176 begin
1177 -- A private type without a full view is not fully defined
1178
1179 if Is_Private_Type (Typ)
1180 and then No (Full_View (Typ))
1181 then
1182 return False;
1183
1184 -- An incomplete type is never fully defined
1185
1186 elsif Is_Incomplete_Type (Typ) then
1187 return False;
1188
1189 -- All other types are fully defined
1190
1191 else
1192 return True;
1193 end if;
1194 end Is_Fully_Defined_Type;
1195
1196 -- Local declarations
1197
1198 Param : Entity_Id;
1199
1200 -- Start of processing for Has_Fully_Defined_Profile
1201
1202 begin
1203 -- Check the parameters
1204
1205 Param := First_Formal (Subp);
1206 while Present (Param) loop
1207 if not Is_Fully_Defined_Type (Etype (Param)) then
1208 return False;
1209 end if;
1210
1211 Next_Formal (Param);
1212 end loop;
1213
1214 -- Check the return type
1215
1216 return Is_Fully_Defined_Type (Etype (Subp));
1217 end Has_Fully_Defined_Profile;
1218
1219 ---------------------
1220 -- Matching_Actual --
1221 ---------------------
1222
1223 function Matching_Actual
1224 (F : Entity_Id;
1225 A_F : Entity_Id) return Node_Id
1226 is
1227 Prev : Node_Id;
1228 Act : Node_Id;
1229
1230 begin
1231 Is_Named_Assoc := False;
1232
1233 -- End of list of purely positional parameters
1234
1235 if No (Actual) or else Nkind (Actual) = N_Others_Choice then
1236 Found_Assoc := Empty;
1237 Act := Empty;
1238
1239 -- Case of positional parameter corresponding to current formal
1240
1241 elsif No (Selector_Name (Actual)) then
1242 Found_Assoc := Actual;
1243 Act := Explicit_Generic_Actual_Parameter (Actual);
1244 Num_Matched := Num_Matched + 1;
1245 Next (Actual);
1246
1247 -- Otherwise scan list of named actuals to find the one with the
1248 -- desired name. All remaining actuals have explicit names.
1249
1250 else
1251 Is_Named_Assoc := True;
1252 Found_Assoc := Empty;
1253 Act := Empty;
1254 Prev := Empty;
1255
1256 while Present (Actual) loop
1257 if Chars (Selector_Name (Actual)) = Chars (F) then
1258 Set_Entity (Selector_Name (Actual), A_F);
1259 Set_Etype (Selector_Name (Actual), Etype (A_F));
1260 Generate_Reference (A_F, Selector_Name (Actual));
1261 Found_Assoc := Actual;
1262 Act := Explicit_Generic_Actual_Parameter (Actual);
1263 Num_Matched := Num_Matched + 1;
1264 exit;
1265 end if;
1266
1267 Prev := Actual;
1268 Next (Actual);
1269 end loop;
1270
1271 -- Reset for subsequent searches. In most cases the named
1272 -- associations are in order. If they are not, we reorder them
1273 -- to avoid scanning twice the same actual. This is not just a
1274 -- question of efficiency: there may be multiple defaults with
1275 -- boxes that have the same name. In a nested instantiation we
1276 -- insert actuals for those defaults, and cannot rely on their
1277 -- names to disambiguate them.
1278
1279 if Actual = First_Named then
1280 Next (First_Named);
1281
1282 elsif Present (Actual) then
1283 Insert_Before (First_Named, Remove_Next (Prev));
1284 end if;
1285
1286 Actual := First_Named;
1287 end if;
1288
1289 if Is_Entity_Name (Act) and then Present (Entity (Act)) then
1290 Set_Used_As_Generic_Actual (Entity (Act));
1291 end if;
1292
1293 return Act;
1294 end Matching_Actual;
1295
1296 ------------------------------
1297 -- Partial_Parameterization --
1298 ------------------------------
1299
1300 function Partial_Parameterization return Boolean is
1301 begin
1302 return Others_Present
1303 or else (Present (Found_Assoc) and then Box_Present (Found_Assoc));
1304 end Partial_Parameterization;
1305
1306 ---------------------
1307 -- Process_Default --
1308 ---------------------
1309
1310 procedure Process_Default (F : Entity_Id) is
1311 Loc : constant Source_Ptr := Sloc (I_Node);
1312 F_Id : constant Entity_Id := Defining_Entity (F);
1313 Decl : Node_Id;
1314 Default : Node_Id;
1315 Id : Entity_Id;
1316
1317 begin
1318 -- Append copy of formal declaration to associations, and create new
1319 -- defining identifier for it.
1320
1321 Decl := New_Copy_Tree (F);
1322 Id := Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id));
1323
1324 if Nkind (F) in N_Formal_Subprogram_Declaration then
1325 Set_Defining_Unit_Name (Specification (Decl), Id);
1326
1327 else
1328 Set_Defining_Identifier (Decl, Id);
1329 end if;
1330
1331 Append (Decl, Assoc);
1332
1333 if No (Found_Assoc) then
1334 Default :=
1335 Make_Generic_Association (Loc,
1336 Selector_Name => New_Occurrence_Of (Id, Loc),
1337 Explicit_Generic_Actual_Parameter => Empty);
1338 Set_Box_Present (Default);
1339 Append (Default, Default_Formals);
1340 end if;
1341 end Process_Default;
1342
1343 ---------------------------------
1344 -- Renames_Standard_Subprogram --
1345 ---------------------------------
1346
1347 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean is
1348 Id : Entity_Id;
1349
1350 begin
1351 Id := Alias (Subp);
1352 while Present (Id) loop
1353 if Scope (Id) = Standard_Standard then
1354 return True;
1355 end if;
1356
1357 Id := Alias (Id);
1358 end loop;
1359
1360 return False;
1361 end Renames_Standard_Subprogram;
1362
1363 -------------------------
1364 -- Set_Analyzed_Formal --
1365 -------------------------
1366
1367 procedure Set_Analyzed_Formal is
1368 Kind : Node_Kind;
1369
1370 begin
1371 while Present (Analyzed_Formal) loop
1372 Kind := Nkind (Analyzed_Formal);
1373
1374 case Nkind (Formal) is
1375
1376 when N_Formal_Subprogram_Declaration =>
1377 exit when Kind in N_Formal_Subprogram_Declaration
1378 and then
1379 Chars
1380 (Defining_Unit_Name (Specification (Formal))) =
1381 Chars
1382 (Defining_Unit_Name (Specification (Analyzed_Formal)));
1383
1384 when N_Formal_Package_Declaration =>
1385 exit when Nkind_In (Kind, N_Formal_Package_Declaration,
1386 N_Generic_Package_Declaration,
1387 N_Package_Declaration);
1388
1389 when N_Use_Package_Clause | N_Use_Type_Clause => exit;
1390
1391 when others =>
1392
1393 -- Skip freeze nodes, and nodes inserted to replace
1394 -- unrecognized pragmas.
1395
1396 exit when
1397 Kind not in N_Formal_Subprogram_Declaration
1398 and then not Nkind_In (Kind, N_Subprogram_Declaration,
1399 N_Freeze_Entity,
1400 N_Null_Statement,
1401 N_Itype_Reference)
1402 and then Chars (Defining_Identifier (Formal)) =
1403 Chars (Defining_Identifier (Analyzed_Formal));
1404 end case;
1405
1406 Next (Analyzed_Formal);
1407 end loop;
1408 end Set_Analyzed_Formal;
1409
1410 -- Start of processing for Analyze_Associations
1411
1412 begin
1413 Actuals := Generic_Associations (I_Node);
1414
1415 if Present (Actuals) then
1416
1417 -- Check for an Others choice, indicating a partial parameterization
1418 -- for a formal package.
1419
1420 Actual := First (Actuals);
1421 while Present (Actual) loop
1422 if Nkind (Actual) = N_Others_Choice then
1423 Others_Present := True;
1424 Others_Choice := Actual;
1425
1426 if Present (Next (Actual)) then
1427 Error_Msg_N ("others must be last association", Actual);
1428 end if;
1429
1430 -- This subprogram is used both for formal packages and for
1431 -- instantiations. For the latter, associations must all be
1432 -- explicit.
1433
1434 if Nkind (I_Node) /= N_Formal_Package_Declaration
1435 and then Comes_From_Source (I_Node)
1436 then
1437 Error_Msg_N
1438 ("others association not allowed in an instance",
1439 Actual);
1440 end if;
1441
1442 -- In any case, nothing to do after the others association
1443
1444 exit;
1445
1446 elsif Box_Present (Actual)
1447 and then Comes_From_Source (I_Node)
1448 and then Nkind (I_Node) /= N_Formal_Package_Declaration
1449 then
1450 Error_Msg_N
1451 ("box association not allowed in an instance", Actual);
1452 end if;
1453
1454 Next (Actual);
1455 end loop;
1456
1457 -- If named associations are present, save first named association
1458 -- (it may of course be Empty) to facilitate subsequent name search.
1459
1460 First_Named := First (Actuals);
1461 while Present (First_Named)
1462 and then Nkind (First_Named) /= N_Others_Choice
1463 and then No (Selector_Name (First_Named))
1464 loop
1465 Num_Actuals := Num_Actuals + 1;
1466 Next (First_Named);
1467 end loop;
1468 end if;
1469
1470 Named := First_Named;
1471 while Present (Named) loop
1472 if Nkind (Named) /= N_Others_Choice
1473 and then No (Selector_Name (Named))
1474 then
1475 Error_Msg_N ("invalid positional actual after named one", Named);
1476 Abandon_Instantiation (Named);
1477 end if;
1478
1479 -- A named association may lack an actual parameter, if it was
1480 -- introduced for a default subprogram that turns out to be local
1481 -- to the outer instantiation.
1482
1483 if Nkind (Named) /= N_Others_Choice
1484 and then Present (Explicit_Generic_Actual_Parameter (Named))
1485 then
1486 Num_Actuals := Num_Actuals + 1;
1487 end if;
1488
1489 Next (Named);
1490 end loop;
1491
1492 if Present (Formals) then
1493 Formal := First_Non_Pragma (Formals);
1494 Analyzed_Formal := First_Non_Pragma (F_Copy);
1495
1496 if Present (Actuals) then
1497 Actual := First (Actuals);
1498
1499 -- All formals should have default values
1500
1501 else
1502 Actual := Empty;
1503 end if;
1504
1505 while Present (Formal) loop
1506 Set_Analyzed_Formal;
1507 Saved_Formal := Next_Non_Pragma (Formal);
1508
1509 case Nkind (Formal) is
1510 when N_Formal_Object_Declaration =>
1511 Match :=
1512 Matching_Actual (
1513 Defining_Identifier (Formal),
1514 Defining_Identifier (Analyzed_Formal));
1515
1516 if No (Match) and then Partial_Parameterization then
1517 Process_Default (Formal);
1518 else
1519 Append_List
1520 (Instantiate_Object (Formal, Match, Analyzed_Formal),
1521 Assoc);
1522 end if;
1523
1524 when N_Formal_Type_Declaration =>
1525 Match :=
1526 Matching_Actual (
1527 Defining_Identifier (Formal),
1528 Defining_Identifier (Analyzed_Formal));
1529
1530 if No (Match) then
1531 if Partial_Parameterization then
1532 Process_Default (Formal);
1533
1534 else
1535 Error_Msg_Sloc := Sloc (Gen_Unit);
1536 Error_Msg_NE
1537 ("missing actual&",
1538 Instantiation_Node,
1539 Defining_Identifier (Formal));
1540 Error_Msg_NE ("\in instantiation of & declared#",
1541 Instantiation_Node, Gen_Unit);
1542 Abandon_Instantiation (Instantiation_Node);
1543 end if;
1544
1545 else
1546 Analyze (Match);
1547 Append_List
1548 (Instantiate_Type
1549 (Formal, Match, Analyzed_Formal, Assoc),
1550 Assoc);
1551
1552 -- An instantiation is a freeze point for the actuals,
1553 -- unless this is a rewritten formal package, or the
1554 -- formal is an Ada 2012 formal incomplete type.
1555
1556 if Nkind (I_Node) = N_Formal_Package_Declaration
1557 or else
1558 (Ada_Version >= Ada_2012
1559 and then
1560 Ekind (Defining_Identifier (Analyzed_Formal)) =
1561 E_Incomplete_Type)
1562 then
1563 null;
1564
1565 else
1566 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1567 end if;
1568 end if;
1569
1570 -- A remote access-to-class-wide type is not a legal actual
1571 -- for a generic formal of an access type (E.2.2(17/2)).
1572 -- In GNAT an exception to this rule is introduced when
1573 -- the formal is marked as remote using implementation
1574 -- defined aspect/pragma Remote_Access_Type. In that case
1575 -- the actual must be remote as well.
1576
1577 -- If the current instantiation is the construction of a
1578 -- local copy for a formal package the actuals may be
1579 -- defaulted, and there is no matching actual to check.
1580
1581 if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1582 and then
1583 Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1584 N_Access_To_Object_Definition
1585 and then Present (Match)
1586 then
1587 declare
1588 Formal_Ent : constant Entity_Id :=
1589 Defining_Identifier (Analyzed_Formal);
1590 begin
1591 if Is_Remote_Access_To_Class_Wide_Type (Entity (Match))
1592 = Is_Remote_Types (Formal_Ent)
1593 then
1594 -- Remoteness of formal and actual match
1595
1596 null;
1597
1598 elsif Is_Remote_Types (Formal_Ent) then
1599
1600 -- Remote formal, non-remote actual
1601
1602 Error_Msg_NE
1603 ("actual for& must be remote", Match, Formal_Ent);
1604
1605 else
1606 -- Non-remote formal, remote actual
1607
1608 Error_Msg_NE
1609 ("actual for& may not be remote",
1610 Match, Formal_Ent);
1611 end if;
1612 end;
1613 end if;
1614
1615 when N_Formal_Subprogram_Declaration =>
1616 Match :=
1617 Matching_Actual
1618 (Defining_Unit_Name (Specification (Formal)),
1619 Defining_Unit_Name (Specification (Analyzed_Formal)));
1620
1621 -- If the formal subprogram has the same name as another
1622 -- formal subprogram of the generic, then a named
1623 -- association is illegal (12.3(9)). Exclude named
1624 -- associations that are generated for a nested instance.
1625
1626 if Present (Match)
1627 and then Is_Named_Assoc
1628 and then Comes_From_Source (Found_Assoc)
1629 then
1630 Check_Overloaded_Formal_Subprogram (Formal);
1631 end if;
1632
1633 -- If there is no corresponding actual, this may be case
1634 -- of partial parameterization, or else the formal has a
1635 -- default or a box.
1636
1637 if No (Match) and then Partial_Parameterization then
1638 Process_Default (Formal);
1639
1640 if Nkind (I_Node) = N_Formal_Package_Declaration then
1641 Check_Overloaded_Formal_Subprogram (Formal);
1642 end if;
1643
1644 else
1645 Append_To (Assoc,
1646 Instantiate_Formal_Subprogram
1647 (Formal, Match, Analyzed_Formal));
1648
1649 if GNATprove_Mode then
1650 if Nkind (Match) = N_Operator_Symbol then
1651 Append_To (Assoc,
1652 Build_Wrapper
1653 (Defining_Entity (Analyzed_Formal)));
1654
1655 elsif Box_Present (Formal)
1656 and then Nkind (Defining_Entity (Analyzed_Formal))
1657 = N_Defining_Operator_Symbol
1658 then
1659 Append_To (Assoc,
1660 Build_Wrapper
1661 (Defining_Entity (Analyzed_Formal)));
1662 end if;
1663 end if;
1664
1665 -- An instantiation is a freeze point for the actuals,
1666 -- unless this is a rewritten formal package.
1667
1668 if Nkind (I_Node) /= N_Formal_Package_Declaration
1669 and then Nkind (Match) = N_Identifier
1670 and then Is_Subprogram (Entity (Match))
1671
1672 -- The actual subprogram may rename a routine defined
1673 -- in Standard. Avoid freezing such renamings because
1674 -- subprograms coming from Standard cannot be frozen.
1675
1676 and then
1677 not Renames_Standard_Subprogram (Entity (Match))
1678
1679 -- If the actual subprogram comes from a different
1680 -- unit, it is already frozen, either by a body in
1681 -- that unit or by the end of the declarative part
1682 -- of the unit. This check avoids the freezing of
1683 -- subprograms defined in Standard which are used
1684 -- as generic actuals.
1685
1686 and then In_Same_Code_Unit (Entity (Match), I_Node)
1687 and then Has_Fully_Defined_Profile (Entity (Match))
1688 then
1689 -- Mark the subprogram as having a delayed freeze
1690 -- since this may be an out-of-order action.
1691
1692 Set_Has_Delayed_Freeze (Entity (Match));
1693 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1694 end if;
1695 end if;
1696
1697 -- If this is a nested generic, preserve default for later
1698 -- instantiations.
1699
1700 if No (Match)
1701 and then Box_Present (Formal)
1702 then
1703 Append_Elmt
1704 (Defining_Unit_Name (Specification (Last (Assoc))),
1705 Default_Actuals);
1706 end if;
1707
1708 when N_Formal_Package_Declaration =>
1709 Match :=
1710 Matching_Actual (
1711 Defining_Identifier (Formal),
1712 Defining_Identifier (Original_Node (Analyzed_Formal)));
1713
1714 if No (Match) then
1715 if Partial_Parameterization then
1716 Process_Default (Formal);
1717
1718 else
1719 Error_Msg_Sloc := Sloc (Gen_Unit);
1720 Error_Msg_NE
1721 ("missing actual&",
1722 Instantiation_Node, Defining_Identifier (Formal));
1723 Error_Msg_NE ("\in instantiation of & declared#",
1724 Instantiation_Node, Gen_Unit);
1725
1726 Abandon_Instantiation (Instantiation_Node);
1727 end if;
1728
1729 else
1730 Analyze (Match);
1731 Append_List
1732 (Instantiate_Formal_Package
1733 (Formal, Match, Analyzed_Formal),
1734 Assoc);
1735 end if;
1736
1737 -- For use type and use package appearing in the generic part,
1738 -- we have already copied them, so we can just move them where
1739 -- they belong (we mustn't recopy them since this would mess up
1740 -- the Sloc values).
1741
1742 when N_Use_Package_Clause |
1743 N_Use_Type_Clause =>
1744 if Nkind (Original_Node (I_Node)) =
1745 N_Formal_Package_Declaration
1746 then
1747 Append (New_Copy_Tree (Formal), Assoc);
1748 else
1749 Remove (Formal);
1750 Append (Formal, Assoc);
1751 end if;
1752
1753 when others =>
1754 raise Program_Error;
1755
1756 end case;
1757
1758 Formal := Saved_Formal;
1759 Next_Non_Pragma (Analyzed_Formal);
1760 end loop;
1761
1762 if Num_Actuals > Num_Matched then
1763 Error_Msg_Sloc := Sloc (Gen_Unit);
1764
1765 if Present (Selector_Name (Actual)) then
1766 Error_Msg_NE
1767 ("unmatched actual&",
1768 Actual, Selector_Name (Actual));
1769 Error_Msg_NE ("\in instantiation of& declared#",
1770 Actual, Gen_Unit);
1771 else
1772 Error_Msg_NE
1773 ("unmatched actual in instantiation of& declared#",
1774 Actual, Gen_Unit);
1775 end if;
1776 end if;
1777
1778 elsif Present (Actuals) then
1779 Error_Msg_N
1780 ("too many actuals in generic instantiation", Instantiation_Node);
1781 end if;
1782
1783 -- An instantiation freezes all generic actuals. The only exceptions
1784 -- to this are incomplete types and subprograms which are not fully
1785 -- defined at the point of instantiation.
1786
1787 declare
1788 Elmt : Elmt_Id := First_Elmt (Actuals_To_Freeze);
1789 begin
1790 while Present (Elmt) loop
1791 Freeze_Before (I_Node, Node (Elmt));
1792 Next_Elmt (Elmt);
1793 end loop;
1794 end;
1795
1796 -- If there are default subprograms, normalize the tree by adding
1797 -- explicit associations for them. This is required if the instance
1798 -- appears within a generic.
1799
1800 declare
1801 Elmt : Elmt_Id;
1802 Subp : Entity_Id;
1803 New_D : Node_Id;
1804
1805 begin
1806 Elmt := First_Elmt (Default_Actuals);
1807 while Present (Elmt) loop
1808 if No (Actuals) then
1809 Actuals := New_List;
1810 Set_Generic_Associations (I_Node, Actuals);
1811 end if;
1812
1813 Subp := Node (Elmt);
1814 New_D :=
1815 Make_Generic_Association (Sloc (Subp),
1816 Selector_Name => New_Occurrence_Of (Subp, Sloc (Subp)),
1817 Explicit_Generic_Actual_Parameter =>
1818 New_Occurrence_Of (Subp, Sloc (Subp)));
1819 Mark_Rewrite_Insertion (New_D);
1820 Append_To (Actuals, New_D);
1821 Next_Elmt (Elmt);
1822 end loop;
1823 end;
1824
1825 -- If this is a formal package, normalize the parameter list by adding
1826 -- explicit box associations for the formals that are covered by an
1827 -- Others_Choice.
1828
1829 if not Is_Empty_List (Default_Formals) then
1830 Append_List (Default_Formals, Formals);
1831 end if;
1832
1833 return Assoc;
1834 end Analyze_Associations;
1835
1836 -------------------------------
1837 -- Analyze_Formal_Array_Type --
1838 -------------------------------
1839
1840 procedure Analyze_Formal_Array_Type
1841 (T : in out Entity_Id;
1842 Def : Node_Id)
1843 is
1844 DSS : Node_Id;
1845
1846 begin
1847 -- Treated like a non-generic array declaration, with additional
1848 -- semantic checks.
1849
1850 Enter_Name (T);
1851
1852 if Nkind (Def) = N_Constrained_Array_Definition then
1853 DSS := First (Discrete_Subtype_Definitions (Def));
1854 while Present (DSS) loop
1855 if Nkind_In (DSS, N_Subtype_Indication,
1856 N_Range,
1857 N_Attribute_Reference)
1858 then
1859 Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
1860 end if;
1861
1862 Next (DSS);
1863 end loop;
1864 end if;
1865
1866 Array_Type_Declaration (T, Def);
1867 Set_Is_Generic_Type (Base_Type (T));
1868
1869 if Ekind (Component_Type (T)) = E_Incomplete_Type
1870 and then No (Full_View (Component_Type (T)))
1871 then
1872 Error_Msg_N ("premature usage of incomplete type", Def);
1873
1874 -- Check that range constraint is not allowed on the component type
1875 -- of a generic formal array type (AARM 12.5.3(3))
1876
1877 elsif Is_Internal (Component_Type (T))
1878 and then Present (Subtype_Indication (Component_Definition (Def)))
1879 and then Nkind (Original_Node
1880 (Subtype_Indication (Component_Definition (Def)))) =
1881 N_Subtype_Indication
1882 then
1883 Error_Msg_N
1884 ("in a formal, a subtype indication can only be "
1885 & "a subtype mark (RM 12.5.3(3))",
1886 Subtype_Indication (Component_Definition (Def)));
1887 end if;
1888
1889 end Analyze_Formal_Array_Type;
1890
1891 ---------------------------------------------
1892 -- Analyze_Formal_Decimal_Fixed_Point_Type --
1893 ---------------------------------------------
1894
1895 -- As for other generic types, we create a valid type representation with
1896 -- legal but arbitrary attributes, whose values are never considered
1897 -- static. For all scalar types we introduce an anonymous base type, with
1898 -- the same attributes. We choose the corresponding integer type to be
1899 -- Standard_Integer.
1900 -- Here and in other similar routines, the Sloc of the generated internal
1901 -- type must be the same as the sloc of the defining identifier of the
1902 -- formal type declaration, to provide proper source navigation.
1903
1904 procedure Analyze_Formal_Decimal_Fixed_Point_Type
1905 (T : Entity_Id;
1906 Def : Node_Id)
1907 is
1908 Loc : constant Source_Ptr := Sloc (Def);
1909
1910 Base : constant Entity_Id :=
1911 New_Internal_Entity
1912 (E_Decimal_Fixed_Point_Type,
1913 Current_Scope,
1914 Sloc (Defining_Identifier (Parent (Def))), 'G');
1915
1916 Int_Base : constant Entity_Id := Standard_Integer;
1917 Delta_Val : constant Ureal := Ureal_1;
1918 Digs_Val : constant Uint := Uint_6;
1919
1920 function Make_Dummy_Bound return Node_Id;
1921 -- Return a properly typed universal real literal to use as a bound
1922
1923 ----------------------
1924 -- Make_Dummy_Bound --
1925 ----------------------
1926
1927 function Make_Dummy_Bound return Node_Id is
1928 Bound : constant Node_Id := Make_Real_Literal (Loc, Ureal_1);
1929 begin
1930 Set_Etype (Bound, Universal_Real);
1931 return Bound;
1932 end Make_Dummy_Bound;
1933
1934 -- Start of processing for Analyze_Formal_Decimal_Fixed_Point_Type
1935
1936 begin
1937 Enter_Name (T);
1938
1939 Set_Etype (Base, Base);
1940 Set_Size_Info (Base, Int_Base);
1941 Set_RM_Size (Base, RM_Size (Int_Base));
1942 Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
1943 Set_Digits_Value (Base, Digs_Val);
1944 Set_Delta_Value (Base, Delta_Val);
1945 Set_Small_Value (Base, Delta_Val);
1946 Set_Scalar_Range (Base,
1947 Make_Range (Loc,
1948 Low_Bound => Make_Dummy_Bound,
1949 High_Bound => Make_Dummy_Bound));
1950
1951 Set_Is_Generic_Type (Base);
1952 Set_Parent (Base, Parent (Def));
1953
1954 Set_Ekind (T, E_Decimal_Fixed_Point_Subtype);
1955 Set_Etype (T, Base);
1956 Set_Size_Info (T, Int_Base);
1957 Set_RM_Size (T, RM_Size (Int_Base));
1958 Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
1959 Set_Digits_Value (T, Digs_Val);
1960 Set_Delta_Value (T, Delta_Val);
1961 Set_Small_Value (T, Delta_Val);
1962 Set_Scalar_Range (T, Scalar_Range (Base));
1963 Set_Is_Constrained (T);
1964
1965 Check_Restriction (No_Fixed_Point, Def);
1966 end Analyze_Formal_Decimal_Fixed_Point_Type;
1967
1968 -------------------------------------------
1969 -- Analyze_Formal_Derived_Interface_Type --
1970 -------------------------------------------
1971
1972 procedure Analyze_Formal_Derived_Interface_Type
1973 (N : Node_Id;
1974 T : Entity_Id;
1975 Def : Node_Id)
1976 is
1977 Loc : constant Source_Ptr := Sloc (Def);
1978
1979 begin
1980 -- Rewrite as a type declaration of a derived type. This ensures that
1981 -- the interface list and primitive operations are properly captured.
1982
1983 Rewrite (N,
1984 Make_Full_Type_Declaration (Loc,
1985 Defining_Identifier => T,
1986 Type_Definition => Def));
1987 Analyze (N);
1988 Set_Is_Generic_Type (T);
1989 end Analyze_Formal_Derived_Interface_Type;
1990
1991 ---------------------------------
1992 -- Analyze_Formal_Derived_Type --
1993 ---------------------------------
1994
1995 procedure Analyze_Formal_Derived_Type
1996 (N : Node_Id;
1997 T : Entity_Id;
1998 Def : Node_Id)
1999 is
2000 Loc : constant Source_Ptr := Sloc (Def);
2001 Unk_Disc : constant Boolean := Unknown_Discriminants_Present (N);
2002 New_N : Node_Id;
2003
2004 begin
2005 Set_Is_Generic_Type (T);
2006
2007 if Private_Present (Def) then
2008 New_N :=
2009 Make_Private_Extension_Declaration (Loc,
2010 Defining_Identifier => T,
2011 Discriminant_Specifications => Discriminant_Specifications (N),
2012 Unknown_Discriminants_Present => Unk_Disc,
2013 Subtype_Indication => Subtype_Mark (Def),
2014 Interface_List => Interface_List (Def));
2015
2016 Set_Abstract_Present (New_N, Abstract_Present (Def));
2017 Set_Limited_Present (New_N, Limited_Present (Def));
2018 Set_Synchronized_Present (New_N, Synchronized_Present (Def));
2019
2020 else
2021 New_N :=
2022 Make_Full_Type_Declaration (Loc,
2023 Defining_Identifier => T,
2024 Discriminant_Specifications =>
2025 Discriminant_Specifications (Parent (T)),
2026 Type_Definition =>
2027 Make_Derived_Type_Definition (Loc,
2028 Subtype_Indication => Subtype_Mark (Def)));
2029
2030 Set_Abstract_Present
2031 (Type_Definition (New_N), Abstract_Present (Def));
2032 Set_Limited_Present
2033 (Type_Definition (New_N), Limited_Present (Def));
2034 end if;
2035
2036 Rewrite (N, New_N);
2037 Analyze (N);
2038
2039 if Unk_Disc then
2040 if not Is_Composite_Type (T) then
2041 Error_Msg_N
2042 ("unknown discriminants not allowed for elementary types", N);
2043 else
2044 Set_Has_Unknown_Discriminants (T);
2045 Set_Is_Constrained (T, False);
2046 end if;
2047 end if;
2048
2049 -- If the parent type has a known size, so does the formal, which makes
2050 -- legal representation clauses that involve the formal.
2051
2052 Set_Size_Known_At_Compile_Time
2053 (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
2054 end Analyze_Formal_Derived_Type;
2055
2056 ----------------------------------
2057 -- Analyze_Formal_Discrete_Type --
2058 ----------------------------------
2059
2060 -- The operations defined for a discrete types are those of an enumeration
2061 -- type. The size is set to an arbitrary value, for use in analyzing the
2062 -- generic unit.
2063
2064 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
2065 Loc : constant Source_Ptr := Sloc (Def);
2066 Lo : Node_Id;
2067 Hi : Node_Id;
2068
2069 Base : constant Entity_Id :=
2070 New_Internal_Entity
2071 (E_Floating_Point_Type, Current_Scope,
2072 Sloc (Defining_Identifier (Parent (Def))), 'G');
2073
2074 begin
2075 Enter_Name (T);
2076 Set_Ekind (T, E_Enumeration_Subtype);
2077 Set_Etype (T, Base);
2078 Init_Size (T, 8);
2079 Init_Alignment (T);
2080 Set_Is_Generic_Type (T);
2081 Set_Is_Constrained (T);
2082
2083 -- For semantic analysis, the bounds of the type must be set to some
2084 -- non-static value. The simplest is to create attribute nodes for those
2085 -- bounds, that refer to the type itself. These bounds are never
2086 -- analyzed but serve as place-holders.
2087
2088 Lo :=
2089 Make_Attribute_Reference (Loc,
2090 Attribute_Name => Name_First,
2091 Prefix => New_Occurrence_Of (T, Loc));
2092 Set_Etype (Lo, T);
2093
2094 Hi :=
2095 Make_Attribute_Reference (Loc,
2096 Attribute_Name => Name_Last,
2097 Prefix => New_Occurrence_Of (T, Loc));
2098 Set_Etype (Hi, T);
2099
2100 Set_Scalar_Range (T,
2101 Make_Range (Loc,
2102 Low_Bound => Lo,
2103 High_Bound => Hi));
2104
2105 Set_Ekind (Base, E_Enumeration_Type);
2106 Set_Etype (Base, Base);
2107 Init_Size (Base, 8);
2108 Init_Alignment (Base);
2109 Set_Is_Generic_Type (Base);
2110 Set_Scalar_Range (Base, Scalar_Range (T));
2111 Set_Parent (Base, Parent (Def));
2112 end Analyze_Formal_Discrete_Type;
2113
2114 ----------------------------------
2115 -- Analyze_Formal_Floating_Type --
2116 ---------------------------------
2117
2118 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
2119 Base : constant Entity_Id :=
2120 New_Internal_Entity
2121 (E_Floating_Point_Type, Current_Scope,
2122 Sloc (Defining_Identifier (Parent (Def))), 'G');
2123
2124 begin
2125 -- The various semantic attributes are taken from the predefined type
2126 -- Float, just so that all of them are initialized. Their values are
2127 -- never used because no constant folding or expansion takes place in
2128 -- the generic itself.
2129
2130 Enter_Name (T);
2131 Set_Ekind (T, E_Floating_Point_Subtype);
2132 Set_Etype (T, Base);
2133 Set_Size_Info (T, (Standard_Float));
2134 Set_RM_Size (T, RM_Size (Standard_Float));
2135 Set_Digits_Value (T, Digits_Value (Standard_Float));
2136 Set_Scalar_Range (T, Scalar_Range (Standard_Float));
2137 Set_Is_Constrained (T);
2138
2139 Set_Is_Generic_Type (Base);
2140 Set_Etype (Base, Base);
2141 Set_Size_Info (Base, (Standard_Float));
2142 Set_RM_Size (Base, RM_Size (Standard_Float));
2143 Set_Digits_Value (Base, Digits_Value (Standard_Float));
2144 Set_Scalar_Range (Base, Scalar_Range (Standard_Float));
2145 Set_Parent (Base, Parent (Def));
2146
2147 Check_Restriction (No_Floating_Point, Def);
2148 end Analyze_Formal_Floating_Type;
2149
2150 -----------------------------------
2151 -- Analyze_Formal_Interface_Type;--
2152 -----------------------------------
2153
2154 procedure Analyze_Formal_Interface_Type
2155 (N : Node_Id;
2156 T : Entity_Id;
2157 Def : Node_Id)
2158 is
2159 Loc : constant Source_Ptr := Sloc (N);
2160 New_N : Node_Id;
2161
2162 begin
2163 New_N :=
2164 Make_Full_Type_Declaration (Loc,
2165 Defining_Identifier => T,
2166 Type_Definition => Def);
2167
2168 Rewrite (N, New_N);
2169 Analyze (N);
2170 Set_Is_Generic_Type (T);
2171 end Analyze_Formal_Interface_Type;
2172
2173 ---------------------------------
2174 -- Analyze_Formal_Modular_Type --
2175 ---------------------------------
2176
2177 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
2178 begin
2179 -- Apart from their entity kind, generic modular types are treated like
2180 -- signed integer types, and have the same attributes.
2181
2182 Analyze_Formal_Signed_Integer_Type (T, Def);
2183 Set_Ekind (T, E_Modular_Integer_Subtype);
2184 Set_Ekind (Etype (T), E_Modular_Integer_Type);
2185
2186 end Analyze_Formal_Modular_Type;
2187
2188 ---------------------------------------
2189 -- Analyze_Formal_Object_Declaration --
2190 ---------------------------------------
2191
2192 procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
2193 E : constant Node_Id := Default_Expression (N);
2194 Id : constant Node_Id := Defining_Identifier (N);
2195 K : Entity_Kind;
2196 T : Node_Id;
2197
2198 begin
2199 Enter_Name (Id);
2200
2201 -- Determine the mode of the formal object
2202
2203 if Out_Present (N) then
2204 K := E_Generic_In_Out_Parameter;
2205
2206 if not In_Present (N) then
2207 Error_Msg_N ("formal generic objects cannot have mode OUT", N);
2208 end if;
2209
2210 else
2211 K := E_Generic_In_Parameter;
2212 end if;
2213
2214 if Present (Subtype_Mark (N)) then
2215 Find_Type (Subtype_Mark (N));
2216 T := Entity (Subtype_Mark (N));
2217
2218 -- Verify that there is no redundant null exclusion
2219
2220 if Null_Exclusion_Present (N) then
2221 if not Is_Access_Type (T) then
2222 Error_Msg_N
2223 ("null exclusion can only apply to an access type", N);
2224
2225 elsif Can_Never_Be_Null (T) then
2226 Error_Msg_NE
2227 ("`NOT NULL` not allowed (& already excludes null)",
2228 N, T);
2229 end if;
2230 end if;
2231
2232 -- Ada 2005 (AI-423): Formal object with an access definition
2233
2234 else
2235 Check_Access_Definition (N);
2236 T := Access_Definition
2237 (Related_Nod => N,
2238 N => Access_Definition (N));
2239 end if;
2240
2241 if Ekind (T) = E_Incomplete_Type then
2242 declare
2243 Error_Node : Node_Id;
2244
2245 begin
2246 if Present (Subtype_Mark (N)) then
2247 Error_Node := Subtype_Mark (N);
2248 else
2249 Check_Access_Definition (N);
2250 Error_Node := Access_Definition (N);
2251 end if;
2252
2253 Error_Msg_N ("premature usage of incomplete type", Error_Node);
2254 end;
2255 end if;
2256
2257 if K = E_Generic_In_Parameter then
2258
2259 -- Ada 2005 (AI-287): Limited aggregates allowed in generic formals
2260
2261 if Ada_Version < Ada_2005 and then Is_Limited_Type (T) then
2262 Error_Msg_N
2263 ("generic formal of mode IN must not be of limited type", N);
2264 Explain_Limited_Type (T, N);
2265 end if;
2266
2267 if Is_Abstract_Type (T) then
2268 Error_Msg_N
2269 ("generic formal of mode IN must not be of abstract type", N);
2270 end if;
2271
2272 if Present (E) then
2273 Preanalyze_Spec_Expression (E, T);
2274
2275 if Is_Limited_Type (T) and then not OK_For_Limited_Init (T, E) then
2276 Error_Msg_N
2277 ("initialization not allowed for limited types", E);
2278 Explain_Limited_Type (T, E);
2279 end if;
2280 end if;
2281
2282 Set_Ekind (Id, K);
2283 Set_Etype (Id, T);
2284
2285 -- Case of generic IN OUT parameter
2286
2287 else
2288 -- If the formal has an unconstrained type, construct its actual
2289 -- subtype, as is done for subprogram formals. In this fashion, all
2290 -- its uses can refer to specific bounds.
2291
2292 Set_Ekind (Id, K);
2293 Set_Etype (Id, T);
2294
2295 if (Is_Array_Type (T)
2296 and then not Is_Constrained (T))
2297 or else
2298 (Ekind (T) = E_Record_Type
2299 and then Has_Discriminants (T))
2300 then
2301 declare
2302 Non_Freezing_Ref : constant Node_Id :=
2303 New_Occurrence_Of (Id, Sloc (Id));
2304 Decl : Node_Id;
2305
2306 begin
2307 -- Make sure the actual subtype doesn't generate bogus freezing
2308
2309 Set_Must_Not_Freeze (Non_Freezing_Ref);
2310 Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
2311 Insert_Before_And_Analyze (N, Decl);
2312 Set_Actual_Subtype (Id, Defining_Identifier (Decl));
2313 end;
2314 else
2315 Set_Actual_Subtype (Id, T);
2316 end if;
2317
2318 if Present (E) then
2319 Error_Msg_N
2320 ("initialization not allowed for `IN OUT` formals", N);
2321 end if;
2322 end if;
2323
2324 if Has_Aspects (N) then
2325 Analyze_Aspect_Specifications (N, Id);
2326 end if;
2327 end Analyze_Formal_Object_Declaration;
2328
2329 ----------------------------------------------
2330 -- Analyze_Formal_Ordinary_Fixed_Point_Type --
2331 ----------------------------------------------
2332
2333 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
2334 (T : Entity_Id;
2335 Def : Node_Id)
2336 is
2337 Loc : constant Source_Ptr := Sloc (Def);
2338 Base : constant Entity_Id :=
2339 New_Internal_Entity
2340 (E_Ordinary_Fixed_Point_Type, Current_Scope,
2341 Sloc (Defining_Identifier (Parent (Def))), 'G');
2342
2343 begin
2344 -- The semantic attributes are set for completeness only, their values
2345 -- will never be used, since all properties of the type are non-static.
2346
2347 Enter_Name (T);
2348 Set_Ekind (T, E_Ordinary_Fixed_Point_Subtype);
2349 Set_Etype (T, Base);
2350 Set_Size_Info (T, Standard_Integer);
2351 Set_RM_Size (T, RM_Size (Standard_Integer));
2352 Set_Small_Value (T, Ureal_1);
2353 Set_Delta_Value (T, Ureal_1);
2354 Set_Scalar_Range (T,
2355 Make_Range (Loc,
2356 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
2357 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
2358 Set_Is_Constrained (T);
2359
2360 Set_Is_Generic_Type (Base);
2361 Set_Etype (Base, Base);
2362 Set_Size_Info (Base, Standard_Integer);
2363 Set_RM_Size (Base, RM_Size (Standard_Integer));
2364 Set_Small_Value (Base, Ureal_1);
2365 Set_Delta_Value (Base, Ureal_1);
2366 Set_Scalar_Range (Base, Scalar_Range (T));
2367 Set_Parent (Base, Parent (Def));
2368
2369 Check_Restriction (No_Fixed_Point, Def);
2370 end Analyze_Formal_Ordinary_Fixed_Point_Type;
2371
2372 ----------------------------------------
2373 -- Analyze_Formal_Package_Declaration --
2374 ----------------------------------------
2375
2376 procedure Analyze_Formal_Package_Declaration (N : Node_Id) is
2377 Loc : constant Source_Ptr := Sloc (N);
2378 Pack_Id : constant Entity_Id := Defining_Identifier (N);
2379 Formal : Entity_Id;
2380 Gen_Id : constant Node_Id := Name (N);
2381 Gen_Decl : Node_Id;
2382 Gen_Unit : Entity_Id;
2383 New_N : Node_Id;
2384 Parent_Installed : Boolean := False;
2385 Renaming : Node_Id;
2386 Parent_Instance : Entity_Id;
2387 Renaming_In_Par : Entity_Id;
2388 Associations : Boolean := True;
2389
2390 Vis_Prims_List : Elist_Id := No_Elist;
2391 -- List of primitives made temporarily visible in the instantiation
2392 -- to match the visibility of the formal type
2393
2394 function Build_Local_Package return Node_Id;
2395 -- The formal package is rewritten so that its parameters are replaced
2396 -- with corresponding declarations. For parameters with bona fide
2397 -- associations these declarations are created by Analyze_Associations
2398 -- as for a regular instantiation. For boxed parameters, we preserve
2399 -- the formal declarations and analyze them, in order to introduce
2400 -- entities of the right kind in the environment of the formal.
2401
2402 -------------------------
2403 -- Build_Local_Package --
2404 -------------------------
2405
2406 function Build_Local_Package return Node_Id is
2407 Decls : List_Id;
2408 Pack_Decl : Node_Id;
2409
2410 begin
2411 -- Within the formal, the name of the generic package is a renaming
2412 -- of the formal (as for a regular instantiation).
2413
2414 Pack_Decl :=
2415 Make_Package_Declaration (Loc,
2416 Specification =>
2417 Copy_Generic_Node
2418 (Specification (Original_Node (Gen_Decl)),
2419 Empty, Instantiating => True));
2420
2421 Renaming := Make_Package_Renaming_Declaration (Loc,
2422 Defining_Unit_Name =>
2423 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2424 Name => New_Occurrence_Of (Formal, Loc));
2425
2426 if Nkind (Gen_Id) = N_Identifier
2427 and then Chars (Gen_Id) = Chars (Pack_Id)
2428 then
2429 Error_Msg_NE
2430 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2431 end if;
2432
2433 -- If the formal is declared with a box, or with an others choice,
2434 -- create corresponding declarations for all entities in the formal
2435 -- part, so that names with the proper types are available in the
2436 -- specification of the formal package.
2437
2438 -- On the other hand, if there are no associations, then all the
2439 -- formals must have defaults, and this will be checked by the
2440 -- call to Analyze_Associations.
2441
2442 if Box_Present (N)
2443 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2444 then
2445 declare
2446 Formal_Decl : Node_Id;
2447
2448 begin
2449 -- TBA : for a formal package, need to recurse ???
2450
2451 Decls := New_List;
2452 Formal_Decl :=
2453 First
2454 (Generic_Formal_Declarations (Original_Node (Gen_Decl)));
2455 while Present (Formal_Decl) loop
2456 Append_To
2457 (Decls, Copy_Generic_Node (Formal_Decl, Empty, True));
2458 Next (Formal_Decl);
2459 end loop;
2460 end;
2461
2462 -- If generic associations are present, use Analyze_Associations to
2463 -- create the proper renaming declarations.
2464
2465 else
2466 declare
2467 Act_Tree : constant Node_Id :=
2468 Copy_Generic_Node
2469 (Original_Node (Gen_Decl), Empty,
2470 Instantiating => True);
2471
2472 begin
2473 Generic_Renamings.Set_Last (0);
2474 Generic_Renamings_HTable.Reset;
2475 Instantiation_Node := N;
2476
2477 Decls :=
2478 Analyze_Associations
2479 (I_Node => Original_Node (N),
2480 Formals => Generic_Formal_Declarations (Act_Tree),
2481 F_Copy => Generic_Formal_Declarations (Gen_Decl));
2482
2483 Vis_Prims_List := Check_Hidden_Primitives (Decls);
2484 end;
2485 end if;
2486
2487 Append (Renaming, To => Decls);
2488
2489 -- Add generated declarations ahead of local declarations in
2490 -- the package.
2491
2492 if No (Visible_Declarations (Specification (Pack_Decl))) then
2493 Set_Visible_Declarations (Specification (Pack_Decl), Decls);
2494 else
2495 Insert_List_Before
2496 (First (Visible_Declarations (Specification (Pack_Decl))),
2497 Decls);
2498 end if;
2499
2500 return Pack_Decl;
2501 end Build_Local_Package;
2502
2503 -- Start of processing for Analyze_Formal_Package_Declaration
2504
2505 begin
2506 Check_Text_IO_Special_Unit (Gen_Id);
2507
2508 Init_Env;
2509 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2510 Gen_Unit := Entity (Gen_Id);
2511
2512 -- Check for a formal package that is a package renaming
2513
2514 if Present (Renamed_Object (Gen_Unit)) then
2515
2516 -- Indicate that unit is used, before replacing it with renamed
2517 -- entity for use below.
2518
2519 if In_Extended_Main_Source_Unit (N) then
2520 Set_Is_Instantiated (Gen_Unit);
2521 Generate_Reference (Gen_Unit, N);
2522 end if;
2523
2524 Gen_Unit := Renamed_Object (Gen_Unit);
2525 end if;
2526
2527 if Ekind (Gen_Unit) /= E_Generic_Package then
2528 Error_Msg_N ("expect generic package name", Gen_Id);
2529 Restore_Env;
2530 goto Leave;
2531
2532 elsif Gen_Unit = Current_Scope then
2533 Error_Msg_N
2534 ("generic package cannot be used as a formal package of itself",
2535 Gen_Id);
2536 Restore_Env;
2537 goto Leave;
2538
2539 elsif In_Open_Scopes (Gen_Unit) then
2540 if Is_Compilation_Unit (Gen_Unit)
2541 and then Is_Child_Unit (Current_Scope)
2542 then
2543 -- Special-case the error when the formal is a parent, and
2544 -- continue analysis to minimize cascaded errors.
2545
2546 Error_Msg_N
2547 ("generic parent cannot be used as formal package "
2548 & "of a child unit",
2549 Gen_Id);
2550
2551 else
2552 Error_Msg_N
2553 ("generic package cannot be used as a formal package "
2554 & "within itself",
2555 Gen_Id);
2556 Restore_Env;
2557 goto Leave;
2558 end if;
2559 end if;
2560
2561 -- Check that name of formal package does not hide name of generic,
2562 -- or its leading prefix. This check must be done separately because
2563 -- the name of the generic has already been analyzed.
2564
2565 declare
2566 Gen_Name : Entity_Id;
2567
2568 begin
2569 Gen_Name := Gen_Id;
2570 while Nkind (Gen_Name) = N_Expanded_Name loop
2571 Gen_Name := Prefix (Gen_Name);
2572 end loop;
2573
2574 if Chars (Gen_Name) = Chars (Pack_Id) then
2575 Error_Msg_NE
2576 ("& is hidden within declaration of formal package",
2577 Gen_Id, Gen_Name);
2578 end if;
2579 end;
2580
2581 if Box_Present (N)
2582 or else No (Generic_Associations (N))
2583 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2584 then
2585 Associations := False;
2586 end if;
2587
2588 -- If there are no generic associations, the generic parameters appear
2589 -- as local entities and are instantiated like them. We copy the generic
2590 -- package declaration as if it were an instantiation, and analyze it
2591 -- like a regular package, except that we treat the formals as
2592 -- additional visible components.
2593
2594 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2595
2596 if In_Extended_Main_Source_Unit (N) then
2597 Set_Is_Instantiated (Gen_Unit);
2598 Generate_Reference (Gen_Unit, N);
2599 end if;
2600
2601 Formal := New_Copy (Pack_Id);
2602 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2603
2604 begin
2605 -- Make local generic without formals. The formals will be replaced
2606 -- with internal declarations.
2607
2608 New_N := Build_Local_Package;
2609
2610 -- If there are errors in the parameter list, Analyze_Associations
2611 -- raises Instantiation_Error. Patch the declaration to prevent
2612 -- further exception propagation.
2613
2614 exception
2615 when Instantiation_Error =>
2616
2617 Enter_Name (Formal);
2618 Set_Ekind (Formal, E_Variable);
2619 Set_Etype (Formal, Any_Type);
2620 Restore_Hidden_Primitives (Vis_Prims_List);
2621
2622 if Parent_Installed then
2623 Remove_Parent;
2624 end if;
2625
2626 goto Leave;
2627 end;
2628
2629 Rewrite (N, New_N);
2630 Set_Defining_Unit_Name (Specification (New_N), Formal);
2631 Set_Generic_Parent (Specification (N), Gen_Unit);
2632 Set_Instance_Env (Gen_Unit, Formal);
2633 Set_Is_Generic_Instance (Formal);
2634
2635 Enter_Name (Formal);
2636 Set_Ekind (Formal, E_Package);
2637 Set_Etype (Formal, Standard_Void_Type);
2638 Set_Inner_Instances (Formal, New_Elmt_List);
2639 Push_Scope (Formal);
2640
2641 if Is_Child_Unit (Gen_Unit)
2642 and then Parent_Installed
2643 then
2644 -- Similarly, we have to make the name of the formal visible in the
2645 -- parent instance, to resolve properly fully qualified names that
2646 -- may appear in the generic unit. The parent instance has been
2647 -- placed on the scope stack ahead of the current scope.
2648
2649 Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
2650
2651 Renaming_In_Par :=
2652 Make_Defining_Identifier (Loc, Chars (Gen_Unit));
2653 Set_Ekind (Renaming_In_Par, E_Package);
2654 Set_Etype (Renaming_In_Par, Standard_Void_Type);
2655 Set_Scope (Renaming_In_Par, Parent_Instance);
2656 Set_Parent (Renaming_In_Par, Parent (Formal));
2657 Set_Renamed_Object (Renaming_In_Par, Formal);
2658 Append_Entity (Renaming_In_Par, Parent_Instance);
2659 end if;
2660
2661 Analyze (Specification (N));
2662
2663 -- The formals for which associations are provided are not visible
2664 -- outside of the formal package. The others are still declared by a
2665 -- formal parameter declaration.
2666
2667 -- If there are no associations, the only local entity to hide is the
2668 -- generated package renaming itself.
2669
2670 declare
2671 E : Entity_Id;
2672
2673 begin
2674 E := First_Entity (Formal);
2675 while Present (E) loop
2676 if Associations
2677 and then not Is_Generic_Formal (E)
2678 then
2679 Set_Is_Hidden (E);
2680 end if;
2681
2682 if Ekind (E) = E_Package
2683 and then Renamed_Entity (E) = Formal
2684 then
2685 Set_Is_Hidden (E);
2686 exit;
2687 end if;
2688
2689 Next_Entity (E);
2690 end loop;
2691 end;
2692
2693 End_Package_Scope (Formal);
2694 Restore_Hidden_Primitives (Vis_Prims_List);
2695
2696 if Parent_Installed then
2697 Remove_Parent;
2698 end if;
2699
2700 Restore_Env;
2701
2702 -- Inside the generic unit, the formal package is a regular package, but
2703 -- no body is needed for it. Note that after instantiation, the defining
2704 -- unit name we need is in the new tree and not in the original (see
2705 -- Package_Instantiation). A generic formal package is an instance, and
2706 -- can be used as an actual for an inner instance.
2707
2708 Set_Has_Completion (Formal, True);
2709
2710 -- Add semantic information to the original defining identifier.
2711 -- for ASIS use.
2712
2713 Set_Ekind (Pack_Id, E_Package);
2714 Set_Etype (Pack_Id, Standard_Void_Type);
2715 Set_Scope (Pack_Id, Scope (Formal));
2716 Set_Has_Completion (Pack_Id, True);
2717
2718 <<Leave>>
2719 if Has_Aspects (N) then
2720 Analyze_Aspect_Specifications (N, Pack_Id);
2721 end if;
2722 end Analyze_Formal_Package_Declaration;
2723
2724 ---------------------------------
2725 -- Analyze_Formal_Private_Type --
2726 ---------------------------------
2727
2728 procedure Analyze_Formal_Private_Type
2729 (N : Node_Id;
2730 T : Entity_Id;
2731 Def : Node_Id)
2732 is
2733 begin
2734 New_Private_Type (N, T, Def);
2735
2736 -- Set the size to an arbitrary but legal value
2737
2738 Set_Size_Info (T, Standard_Integer);
2739 Set_RM_Size (T, RM_Size (Standard_Integer));
2740 end Analyze_Formal_Private_Type;
2741
2742 ------------------------------------
2743 -- Analyze_Formal_Incomplete_Type --
2744 ------------------------------------
2745
2746 procedure Analyze_Formal_Incomplete_Type
2747 (T : Entity_Id;
2748 Def : Node_Id)
2749 is
2750 begin
2751 Enter_Name (T);
2752 Set_Ekind (T, E_Incomplete_Type);
2753 Set_Etype (T, T);
2754 Set_Private_Dependents (T, New_Elmt_List);
2755
2756 if Tagged_Present (Def) then
2757 Set_Is_Tagged_Type (T);
2758 Make_Class_Wide_Type (T);
2759 Set_Direct_Primitive_Operations (T, New_Elmt_List);
2760 end if;
2761 end Analyze_Formal_Incomplete_Type;
2762
2763 ----------------------------------------
2764 -- Analyze_Formal_Signed_Integer_Type --
2765 ----------------------------------------
2766
2767 procedure Analyze_Formal_Signed_Integer_Type
2768 (T : Entity_Id;
2769 Def : Node_Id)
2770 is
2771 Base : constant Entity_Id :=
2772 New_Internal_Entity
2773 (E_Signed_Integer_Type,
2774 Current_Scope,
2775 Sloc (Defining_Identifier (Parent (Def))), 'G');
2776
2777 begin
2778 Enter_Name (T);
2779
2780 Set_Ekind (T, E_Signed_Integer_Subtype);
2781 Set_Etype (T, Base);
2782 Set_Size_Info (T, Standard_Integer);
2783 Set_RM_Size (T, RM_Size (Standard_Integer));
2784 Set_Scalar_Range (T, Scalar_Range (Standard_Integer));
2785 Set_Is_Constrained (T);
2786
2787 Set_Is_Generic_Type (Base);
2788 Set_Size_Info (Base, Standard_Integer);
2789 Set_RM_Size (Base, RM_Size (Standard_Integer));
2790 Set_Etype (Base, Base);
2791 Set_Scalar_Range (Base, Scalar_Range (Standard_Integer));
2792 Set_Parent (Base, Parent (Def));
2793 end Analyze_Formal_Signed_Integer_Type;
2794
2795 -------------------------------------------
2796 -- Analyze_Formal_Subprogram_Declaration --
2797 -------------------------------------------
2798
2799 procedure Analyze_Formal_Subprogram_Declaration (N : Node_Id) is
2800 Spec : constant Node_Id := Specification (N);
2801 Def : constant Node_Id := Default_Name (N);
2802 Nam : constant Entity_Id := Defining_Unit_Name (Spec);
2803 Subp : Entity_Id;
2804
2805 begin
2806 if Nam = Error then
2807 return;
2808 end if;
2809
2810 if Nkind (Nam) = N_Defining_Program_Unit_Name then
2811 Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
2812 goto Leave;
2813 end if;
2814
2815 Analyze_Subprogram_Declaration (N);
2816 Set_Is_Formal_Subprogram (Nam);
2817 Set_Has_Completion (Nam);
2818
2819 if Nkind (N) = N_Formal_Abstract_Subprogram_Declaration then
2820 Set_Is_Abstract_Subprogram (Nam);
2821 Set_Is_Dispatching_Operation (Nam);
2822
2823 declare
2824 Ctrl_Type : constant Entity_Id := Find_Dispatching_Type (Nam);
2825 begin
2826 if No (Ctrl_Type) then
2827 Error_Msg_N
2828 ("abstract formal subprogram must have a controlling type",
2829 N);
2830
2831 elsif Ada_Version >= Ada_2012
2832 and then Is_Incomplete_Type (Ctrl_Type)
2833 then
2834 Error_Msg_NE
2835 ("controlling type of abstract formal subprogram cannot " &
2836 "be incomplete type", N, Ctrl_Type);
2837
2838 else
2839 Check_Controlling_Formals (Ctrl_Type, Nam);
2840 end if;
2841 end;
2842 end if;
2843
2844 -- Default name is resolved at the point of instantiation
2845
2846 if Box_Present (N) then
2847 null;
2848
2849 -- Else default is bound at the point of generic declaration
2850
2851 elsif Present (Def) then
2852 if Nkind (Def) = N_Operator_Symbol then
2853 Find_Direct_Name (Def);
2854
2855 elsif Nkind (Def) /= N_Attribute_Reference then
2856 Analyze (Def);
2857
2858 else
2859 -- For an attribute reference, analyze the prefix and verify
2860 -- that it has the proper profile for the subprogram.
2861
2862 Analyze (Prefix (Def));
2863 Valid_Default_Attribute (Nam, Def);
2864 goto Leave;
2865 end if;
2866
2867 -- Default name may be overloaded, in which case the interpretation
2868 -- with the correct profile must be selected, as for a renaming.
2869 -- If the definition is an indexed component, it must denote a
2870 -- member of an entry family. If it is a selected component, it
2871 -- can be a protected operation.
2872
2873 if Etype (Def) = Any_Type then
2874 goto Leave;
2875
2876 elsif Nkind (Def) = N_Selected_Component then
2877 if not Is_Overloadable (Entity (Selector_Name (Def))) then
2878 Error_Msg_N ("expect valid subprogram name as default", Def);
2879 end if;
2880
2881 elsif Nkind (Def) = N_Indexed_Component then
2882 if Is_Entity_Name (Prefix (Def)) then
2883 if Ekind (Entity (Prefix (Def))) /= E_Entry_Family then
2884 Error_Msg_N ("expect valid subprogram name as default", Def);
2885 end if;
2886
2887 elsif Nkind (Prefix (Def)) = N_Selected_Component then
2888 if Ekind (Entity (Selector_Name (Prefix (Def)))) /=
2889 E_Entry_Family
2890 then
2891 Error_Msg_N ("expect valid subprogram name as default", Def);
2892 end if;
2893
2894 else
2895 Error_Msg_N ("expect valid subprogram name as default", Def);
2896 goto Leave;
2897 end if;
2898
2899 elsif Nkind (Def) = N_Character_Literal then
2900
2901 -- Needs some type checks: subprogram should be parameterless???
2902
2903 Resolve (Def, (Etype (Nam)));
2904
2905 elsif not Is_Entity_Name (Def)
2906 or else not Is_Overloadable (Entity (Def))
2907 then
2908 Error_Msg_N ("expect valid subprogram name as default", Def);
2909 goto Leave;
2910
2911 elsif not Is_Overloaded (Def) then
2912 Subp := Entity (Def);
2913
2914 if Subp = Nam then
2915 Error_Msg_N ("premature usage of formal subprogram", Def);
2916
2917 elsif not Entity_Matches_Spec (Subp, Nam) then
2918 Error_Msg_N ("no visible entity matches specification", Def);
2919 end if;
2920
2921 -- More than one interpretation, so disambiguate as for a renaming
2922
2923 else
2924 declare
2925 I : Interp_Index;
2926 I1 : Interp_Index := 0;
2927 It : Interp;
2928 It1 : Interp;
2929
2930 begin
2931 Subp := Any_Id;
2932 Get_First_Interp (Def, I, It);
2933 while Present (It.Nam) loop
2934 if Entity_Matches_Spec (It.Nam, Nam) then
2935 if Subp /= Any_Id then
2936 It1 := Disambiguate (Def, I1, I, Etype (Subp));
2937
2938 if It1 = No_Interp then
2939 Error_Msg_N ("ambiguous default subprogram", Def);
2940 else
2941 Subp := It1.Nam;
2942 end if;
2943
2944 exit;
2945
2946 else
2947 I1 := I;
2948 Subp := It.Nam;
2949 end if;
2950 end if;
2951
2952 Get_Next_Interp (I, It);
2953 end loop;
2954 end;
2955
2956 if Subp /= Any_Id then
2957
2958 -- Subprogram found, generate reference to it
2959
2960 Set_Entity (Def, Subp);
2961 Generate_Reference (Subp, Def);
2962
2963 if Subp = Nam then
2964 Error_Msg_N ("premature usage of formal subprogram", Def);
2965
2966 elsif Ekind (Subp) /= E_Operator then
2967 Check_Mode_Conformant (Subp, Nam);
2968 end if;
2969
2970 else
2971 Error_Msg_N ("no visible subprogram matches specification", N);
2972 end if;
2973 end if;
2974 end if;
2975
2976 <<Leave>>
2977 if Has_Aspects (N) then
2978 Analyze_Aspect_Specifications (N, Nam);
2979 end if;
2980
2981 end Analyze_Formal_Subprogram_Declaration;
2982
2983 -------------------------------------
2984 -- Analyze_Formal_Type_Declaration --
2985 -------------------------------------
2986
2987 procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
2988 Def : constant Node_Id := Formal_Type_Definition (N);
2989 T : Entity_Id;
2990
2991 begin
2992 T := Defining_Identifier (N);
2993
2994 if Present (Discriminant_Specifications (N))
2995 and then Nkind (Def) /= N_Formal_Private_Type_Definition
2996 then
2997 Error_Msg_N
2998 ("discriminants not allowed for this formal type", T);
2999 end if;
3000
3001 -- Enter the new name, and branch to specific routine
3002
3003 case Nkind (Def) is
3004 when N_Formal_Private_Type_Definition =>
3005 Analyze_Formal_Private_Type (N, T, Def);
3006
3007 when N_Formal_Derived_Type_Definition =>
3008 Analyze_Formal_Derived_Type (N, T, Def);
3009
3010 when N_Formal_Incomplete_Type_Definition =>
3011 Analyze_Formal_Incomplete_Type (T, Def);
3012
3013 when N_Formal_Discrete_Type_Definition =>
3014 Analyze_Formal_Discrete_Type (T, Def);
3015
3016 when N_Formal_Signed_Integer_Type_Definition =>
3017 Analyze_Formal_Signed_Integer_Type (T, Def);
3018
3019 when N_Formal_Modular_Type_Definition =>
3020 Analyze_Formal_Modular_Type (T, Def);
3021
3022 when N_Formal_Floating_Point_Definition =>
3023 Analyze_Formal_Floating_Type (T, Def);
3024
3025 when N_Formal_Ordinary_Fixed_Point_Definition =>
3026 Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
3027
3028 when N_Formal_Decimal_Fixed_Point_Definition =>
3029 Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
3030
3031 when N_Array_Type_Definition =>
3032 Analyze_Formal_Array_Type (T, Def);
3033
3034 when N_Access_To_Object_Definition |
3035 N_Access_Function_Definition |
3036 N_Access_Procedure_Definition =>
3037 Analyze_Generic_Access_Type (T, Def);
3038
3039 -- Ada 2005: a interface declaration is encoded as an abstract
3040 -- record declaration or a abstract type derivation.
3041
3042 when N_Record_Definition =>
3043 Analyze_Formal_Interface_Type (N, T, Def);
3044
3045 when N_Derived_Type_Definition =>
3046 Analyze_Formal_Derived_Interface_Type (N, T, Def);
3047
3048 when N_Error =>
3049 null;
3050
3051 when others =>
3052 raise Program_Error;
3053
3054 end case;
3055
3056 Set_Is_Generic_Type (T);
3057
3058 if Has_Aspects (N) then
3059 Analyze_Aspect_Specifications (N, T);
3060 end if;
3061 end Analyze_Formal_Type_Declaration;
3062
3063 ------------------------------------
3064 -- Analyze_Function_Instantiation --
3065 ------------------------------------
3066
3067 procedure Analyze_Function_Instantiation (N : Node_Id) is
3068 begin
3069 Analyze_Subprogram_Instantiation (N, E_Function);
3070 end Analyze_Function_Instantiation;
3071
3072 ---------------------------------
3073 -- Analyze_Generic_Access_Type --
3074 ---------------------------------
3075
3076 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
3077 begin
3078 Enter_Name (T);
3079
3080 if Nkind (Def) = N_Access_To_Object_Definition then
3081 Access_Type_Declaration (T, Def);
3082
3083 if Is_Incomplete_Or_Private_Type (Designated_Type (T))
3084 and then No (Full_View (Designated_Type (T)))
3085 and then not Is_Generic_Type (Designated_Type (T))
3086 then
3087 Error_Msg_N ("premature usage of incomplete type", Def);
3088
3089 elsif not Is_Entity_Name (Subtype_Indication (Def)) then
3090 Error_Msg_N
3091 ("only a subtype mark is allowed in a formal", Def);
3092 end if;
3093
3094 else
3095 Access_Subprogram_Declaration (T, Def);
3096 end if;
3097 end Analyze_Generic_Access_Type;
3098
3099 ---------------------------------
3100 -- Analyze_Generic_Formal_Part --
3101 ---------------------------------
3102
3103 procedure Analyze_Generic_Formal_Part (N : Node_Id) is
3104 Gen_Parm_Decl : Node_Id;
3105
3106 begin
3107 -- The generic formals are processed in the scope of the generic unit,
3108 -- where they are immediately visible. The scope is installed by the
3109 -- caller.
3110
3111 Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
3112
3113 while Present (Gen_Parm_Decl) loop
3114 Analyze (Gen_Parm_Decl);
3115 Next (Gen_Parm_Decl);
3116 end loop;
3117
3118 Generate_Reference_To_Generic_Formals (Current_Scope);
3119 end Analyze_Generic_Formal_Part;
3120
3121 ------------------------------------------
3122 -- Analyze_Generic_Package_Declaration --
3123 ------------------------------------------
3124
3125 procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
3126 Loc : constant Source_Ptr := Sloc (N);
3127 Id : Entity_Id;
3128 New_N : Node_Id;
3129 Save_Parent : Node_Id;
3130 Renaming : Node_Id;
3131 Decls : constant List_Id :=
3132 Visible_Declarations (Specification (N));
3133 Decl : Node_Id;
3134
3135 begin
3136 Check_SPARK_Restriction ("generic is not allowed", N);
3137
3138 -- We introduce a renaming of the enclosing package, to have a usable
3139 -- entity as the prefix of an expanded name for a local entity of the
3140 -- form Par.P.Q, where P is the generic package. This is because a local
3141 -- entity named P may hide it, so that the usual visibility rules in
3142 -- the instance will not resolve properly.
3143
3144 Renaming :=
3145 Make_Package_Renaming_Declaration (Loc,
3146 Defining_Unit_Name =>
3147 Make_Defining_Identifier (Loc,
3148 Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
3149 Name => Make_Identifier (Loc, Chars (Defining_Entity (N))));
3150
3151 if Present (Decls) then
3152 Decl := First (Decls);
3153 while Present (Decl)
3154 and then Nkind (Decl) = N_Pragma
3155 loop
3156 Next (Decl);
3157 end loop;
3158
3159 if Present (Decl) then
3160 Insert_Before (Decl, Renaming);
3161 else
3162 Append (Renaming, Visible_Declarations (Specification (N)));
3163 end if;
3164
3165 else
3166 Set_Visible_Declarations (Specification (N), New_List (Renaming));
3167 end if;
3168
3169 -- Create copy of generic unit, and save for instantiation. If the unit
3170 -- is a child unit, do not copy the specifications for the parent, which
3171 -- are not part of the generic tree.
3172
3173 Save_Parent := Parent_Spec (N);
3174 Set_Parent_Spec (N, Empty);
3175
3176 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3177 Set_Parent_Spec (New_N, Save_Parent);
3178 Rewrite (N, New_N);
3179
3180 -- Once the contents of the generic copy and the template are swapped,
3181 -- do the same for their respective aspect specifications.
3182
3183 Exchange_Aspects (N, New_N);
3184 Id := Defining_Entity (N);
3185 Generate_Definition (Id);
3186
3187 -- Expansion is not applied to generic units
3188
3189 Start_Generic;
3190
3191 Enter_Name (Id);
3192 Set_Ekind (Id, E_Generic_Package);
3193 Set_Etype (Id, Standard_Void_Type);
3194 Set_Contract (Id, Make_Contract (Sloc (Id)));
3195
3196 -- Analyze aspects now, so that generated pragmas appear in the
3197 -- declarations before building and analyzing the generic copy.
3198
3199 if Has_Aspects (N) then
3200 Analyze_Aspect_Specifications (N, Id);
3201 end if;
3202
3203 Push_Scope (Id);
3204 Enter_Generic_Scope (Id);
3205 Set_Inner_Instances (Id, New_Elmt_List);
3206
3207 Set_Categorization_From_Pragmas (N);
3208 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3209
3210 -- Link the declaration of the generic homonym in the generic copy to
3211 -- the package it renames, so that it is always resolved properly.
3212
3213 Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
3214 Set_Entity (Associated_Node (Name (Renaming)), Id);
3215
3216 -- For a library unit, we have reconstructed the entity for the unit,
3217 -- and must reset it in the library tables.
3218
3219 if Nkind (Parent (N)) = N_Compilation_Unit then
3220 Set_Cunit_Entity (Current_Sem_Unit, Id);
3221 end if;
3222
3223 Analyze_Generic_Formal_Part (N);
3224
3225 -- After processing the generic formals, analysis proceeds as for a
3226 -- non-generic package.
3227
3228 Analyze (Specification (N));
3229
3230 Validate_Categorization_Dependency (N, Id);
3231
3232 End_Generic;
3233
3234 End_Package_Scope (Id);
3235 Exit_Generic_Scope (Id);
3236
3237 if Nkind (Parent (N)) /= N_Compilation_Unit then
3238 Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
3239 Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
3240 Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
3241
3242 else
3243 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3244 Validate_RT_RAT_Component (N);
3245
3246 -- If this is a spec without a body, check that generic parameters
3247 -- are referenced.
3248
3249 if not Body_Required (Parent (N)) then
3250 Check_References (Id);
3251 end if;
3252 end if;
3253 end Analyze_Generic_Package_Declaration;
3254
3255 --------------------------------------------
3256 -- Analyze_Generic_Subprogram_Declaration --
3257 --------------------------------------------
3258
3259 procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
3260 Spec : Node_Id;
3261 Id : Entity_Id;
3262 Formals : List_Id;
3263 New_N : Node_Id;
3264 Result_Type : Entity_Id;
3265 Save_Parent : Node_Id;
3266 Typ : Entity_Id;
3267
3268 begin
3269 Check_SPARK_Restriction ("generic is not allowed", N);
3270
3271 -- Create copy of generic unit, and save for instantiation. If the unit
3272 -- is a child unit, do not copy the specifications for the parent, which
3273 -- are not part of the generic tree.
3274
3275 Save_Parent := Parent_Spec (N);
3276 Set_Parent_Spec (N, Empty);
3277
3278 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3279 Set_Parent_Spec (New_N, Save_Parent);
3280 Rewrite (N, New_N);
3281
3282 Check_SPARK_Mode_In_Generic (N);
3283
3284 -- The aspect specifications are not attached to the tree, and must
3285 -- be copied and attached to the generic copy explicitly.
3286
3287 if Present (Aspect_Specifications (New_N)) then
3288 declare
3289 Aspects : constant List_Id := Aspect_Specifications (N);
3290 begin
3291 Set_Has_Aspects (N, False);
3292 Move_Aspects (New_N, To => N);
3293 Set_Has_Aspects (Original_Node (N), False);
3294 Set_Aspect_Specifications (Original_Node (N), Aspects);
3295 end;
3296 end if;
3297
3298 Spec := Specification (N);
3299 Id := Defining_Entity (Spec);
3300 Generate_Definition (Id);
3301 Set_Contract (Id, Make_Contract (Sloc (Id)));
3302
3303 if Nkind (Id) = N_Defining_Operator_Symbol then
3304 Error_Msg_N
3305 ("operator symbol not allowed for generic subprogram", Id);
3306 end if;
3307
3308 Start_Generic;
3309
3310 Enter_Name (Id);
3311
3312 Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
3313 Push_Scope (Id);
3314 Enter_Generic_Scope (Id);
3315 Set_Inner_Instances (Id, New_Elmt_List);
3316 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3317
3318 Analyze_Generic_Formal_Part (N);
3319
3320 Formals := Parameter_Specifications (Spec);
3321
3322 if Present (Formals) then
3323 Process_Formals (Formals, Spec);
3324 end if;
3325
3326 if Nkind (Spec) = N_Function_Specification then
3327 Set_Ekind (Id, E_Generic_Function);
3328
3329 if Nkind (Result_Definition (Spec)) = N_Access_Definition then
3330 Result_Type := Access_Definition (Spec, Result_Definition (Spec));
3331 Set_Etype (Id, Result_Type);
3332
3333 -- Check restriction imposed by AI05-073: a generic function
3334 -- cannot return an abstract type or an access to such.
3335
3336 -- This is a binding interpretation should it apply to earlier
3337 -- versions of Ada as well as Ada 2012???
3338
3339 if Is_Abstract_Type (Designated_Type (Result_Type))
3340 and then Ada_Version >= Ada_2012
3341 then
3342 Error_Msg_N ("generic function cannot have an access result"
3343 & " that designates an abstract type", Spec);
3344 end if;
3345
3346 else
3347 Find_Type (Result_Definition (Spec));
3348 Typ := Entity (Result_Definition (Spec));
3349
3350 if Is_Abstract_Type (Typ)
3351 and then Ada_Version >= Ada_2012
3352 then
3353 Error_Msg_N
3354 ("generic function cannot have abstract result type", Spec);
3355 end if;
3356
3357 -- If a null exclusion is imposed on the result type, then create
3358 -- a null-excluding itype (an access subtype) and use it as the
3359 -- function's Etype.
3360
3361 if Is_Access_Type (Typ)
3362 and then Null_Exclusion_Present (Spec)
3363 then
3364 Set_Etype (Id,
3365 Create_Null_Excluding_Itype
3366 (T => Typ,
3367 Related_Nod => Spec,
3368 Scope_Id => Defining_Unit_Name (Spec)));
3369 else
3370 Set_Etype (Id, Typ);
3371 end if;
3372 end if;
3373
3374 else
3375 Set_Ekind (Id, E_Generic_Procedure);
3376 Set_Etype (Id, Standard_Void_Type);
3377 end if;
3378
3379 -- For a library unit, we have reconstructed the entity for the unit,
3380 -- and must reset it in the library tables. We also make sure that
3381 -- Body_Required is set properly in the original compilation unit node.
3382
3383 if Nkind (Parent (N)) = N_Compilation_Unit then
3384 Set_Cunit_Entity (Current_Sem_Unit, Id);
3385 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3386 end if;
3387
3388 Set_Categorization_From_Pragmas (N);
3389 Validate_Categorization_Dependency (N, Id);
3390
3391 Save_Global_References (Original_Node (N));
3392
3393 -- For ASIS purposes, convert any postcondition, precondition pragmas
3394 -- into aspects, if N is not a compilation unit by itself, in order to
3395 -- enable the analysis of expressions inside the corresponding PPC
3396 -- pragmas.
3397
3398 if ASIS_Mode and then Is_List_Member (N) then
3399 Make_Aspect_For_PPC_In_Gen_Sub_Decl (N);
3400 end if;
3401
3402 -- To capture global references, analyze the expressions of aspects,
3403 -- and propagate information to original tree. Note that in this case
3404 -- analysis of attributes is not delayed until the freeze point.
3405
3406 -- It seems very hard to recreate the proper visibility of the generic
3407 -- subprogram at a later point because the analysis of an aspect may
3408 -- create pragmas after the generic copies have been made ???
3409
3410 if Has_Aspects (N) then
3411 declare
3412 Aspect : Node_Id;
3413
3414 begin
3415 Aspect := First (Aspect_Specifications (N));
3416 while Present (Aspect) loop
3417 if Get_Aspect_Id (Aspect) /= Aspect_Warnings
3418 and then Present (Expression (Aspect))
3419 then
3420 Analyze (Expression (Aspect));
3421 end if;
3422
3423 Next (Aspect);
3424 end loop;
3425
3426 Aspect := First (Aspect_Specifications (Original_Node (N)));
3427 while Present (Aspect) loop
3428 if Present (Expression (Aspect)) then
3429 Save_Global_References (Expression (Aspect));
3430 end if;
3431
3432 Next (Aspect);
3433 end loop;
3434 end;
3435 end if;
3436
3437 End_Generic;
3438 End_Scope;
3439 Exit_Generic_Scope (Id);
3440 Generate_Reference_To_Formals (Id);
3441
3442 List_Inherited_Pre_Post_Aspects (Id);
3443 end Analyze_Generic_Subprogram_Declaration;
3444
3445 -----------------------------------
3446 -- Analyze_Package_Instantiation --
3447 -----------------------------------
3448
3449 procedure Analyze_Package_Instantiation (N : Node_Id) is
3450 Loc : constant Source_Ptr := Sloc (N);
3451 Gen_Id : constant Node_Id := Name (N);
3452
3453 Act_Decl : Node_Id;
3454 Act_Decl_Name : Node_Id;
3455 Act_Decl_Id : Entity_Id;
3456 Act_Spec : Node_Id;
3457 Act_Tree : Node_Id;
3458
3459 Gen_Decl : Node_Id;
3460 Gen_Unit : Entity_Id;
3461
3462 Is_Actual_Pack : constant Boolean :=
3463 Is_Internal (Defining_Entity (N));
3464
3465 Env_Installed : Boolean := False;
3466 Parent_Installed : Boolean := False;
3467 Renaming_List : List_Id;
3468 Unit_Renaming : Node_Id;
3469 Needs_Body : Boolean;
3470 Inline_Now : Boolean := False;
3471
3472 Save_Style_Check : constant Boolean := Style_Check;
3473 -- Save style check mode for restore on exit
3474
3475 procedure Delay_Descriptors (E : Entity_Id);
3476 -- Delay generation of subprogram descriptors for given entity
3477
3478 function Might_Inline_Subp return Boolean;
3479 -- If inlining is active and the generic contains inlined subprograms,
3480 -- we instantiate the body. This may cause superfluous instantiations,
3481 -- but it is simpler than detecting the need for the body at the point
3482 -- of inlining, when the context of the instance is not available.
3483
3484 function Must_Inline_Subp return Boolean;
3485 -- If inlining is active and the generic contains inlined subprograms,
3486 -- return True if some of the inlined subprograms must be inlined by
3487 -- the frontend.
3488
3489 -----------------------
3490 -- Delay_Descriptors --
3491 -----------------------
3492
3493 procedure Delay_Descriptors (E : Entity_Id) is
3494 begin
3495 if not Delay_Subprogram_Descriptors (E) then
3496 Set_Delay_Subprogram_Descriptors (E);
3497 Pending_Descriptor.Append (E);
3498 end if;
3499 end Delay_Descriptors;
3500
3501 -----------------------
3502 -- Might_Inline_Subp --
3503 -----------------------
3504
3505 function Might_Inline_Subp return Boolean is
3506 E : Entity_Id;
3507
3508 begin
3509 if not Inline_Processing_Required then
3510 return False;
3511
3512 else
3513 E := First_Entity (Gen_Unit);
3514 while Present (E) loop
3515 if Is_Subprogram (E)
3516 and then Is_Inlined (E)
3517 then
3518 return True;
3519 end if;
3520
3521 Next_Entity (E);
3522 end loop;
3523 end if;
3524
3525 return False;
3526 end Might_Inline_Subp;
3527
3528 ----------------------
3529 -- Must_Inline_Subp --
3530 ----------------------
3531
3532 function Must_Inline_Subp return Boolean is
3533 E : Entity_Id;
3534
3535 begin
3536 if not Inline_Processing_Required then
3537 return False;
3538
3539 else
3540 E := First_Entity (Gen_Unit);
3541 while Present (E) loop
3542 if Is_Subprogram (E)
3543 and then Is_Inlined (E)
3544 and then Must_Inline (E)
3545 then
3546 return True;
3547 end if;
3548
3549 Next_Entity (E);
3550 end loop;
3551 end if;
3552
3553 return False;
3554 end Must_Inline_Subp;
3555
3556 -- Local declarations
3557
3558 Vis_Prims_List : Elist_Id := No_Elist;
3559 -- List of primitives made temporarily visible in the instantiation
3560 -- to match the visibility of the formal type
3561
3562 -- Start of processing for Analyze_Package_Instantiation
3563
3564 begin
3565 Check_SPARK_Restriction ("generic is not allowed", N);
3566
3567 -- Very first thing: check for Text_IO sp[ecial unit in case we are
3568 -- instantiating one of the children of [[Wide_]Wide_]Text_IO.
3569
3570 Check_Text_IO_Special_Unit (Name (N));
3571
3572 -- Make node global for error reporting
3573
3574 Instantiation_Node := N;
3575
3576 -- Turn off style checking in instances. If the check is enabled on the
3577 -- generic unit, a warning in an instance would just be noise. If not
3578 -- enabled on the generic, then a warning in an instance is just wrong.
3579
3580 Style_Check := False;
3581
3582 -- Case of instantiation of a generic package
3583
3584 if Nkind (N) = N_Package_Instantiation then
3585 Act_Decl_Id := New_Copy (Defining_Entity (N));
3586 Set_Comes_From_Source (Act_Decl_Id, True);
3587
3588 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3589 Act_Decl_Name :=
3590 Make_Defining_Program_Unit_Name (Loc,
3591 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
3592 Defining_Identifier => Act_Decl_Id);
3593 else
3594 Act_Decl_Name := Act_Decl_Id;
3595 end if;
3596
3597 -- Case of instantiation of a formal package
3598
3599 else
3600 Act_Decl_Id := Defining_Identifier (N);
3601 Act_Decl_Name := Act_Decl_Id;
3602 end if;
3603
3604 Generate_Definition (Act_Decl_Id);
3605 Preanalyze_Actuals (N);
3606
3607 Init_Env;
3608 Env_Installed := True;
3609
3610 -- Reset renaming map for formal types. The mapping is established
3611 -- when analyzing the generic associations, but some mappings are
3612 -- inherited from formal packages of parent units, and these are
3613 -- constructed when the parents are installed.
3614
3615 Generic_Renamings.Set_Last (0);
3616 Generic_Renamings_HTable.Reset;
3617
3618 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3619 Gen_Unit := Entity (Gen_Id);
3620
3621 -- Verify that it is the name of a generic package
3622
3623 -- A visibility glitch: if the instance is a child unit and the generic
3624 -- is the generic unit of a parent instance (i.e. both the parent and
3625 -- the child units are instances of the same package) the name now
3626 -- denotes the renaming within the parent, not the intended generic
3627 -- unit. See if there is a homonym that is the desired generic. The
3628 -- renaming declaration must be visible inside the instance of the
3629 -- child, but not when analyzing the name in the instantiation itself.
3630
3631 if Ekind (Gen_Unit) = E_Package
3632 and then Present (Renamed_Entity (Gen_Unit))
3633 and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3634 and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3635 and then Present (Homonym (Gen_Unit))
3636 then
3637 Gen_Unit := Homonym (Gen_Unit);
3638 end if;
3639
3640 if Etype (Gen_Unit) = Any_Type then
3641 Restore_Env;
3642 goto Leave;
3643
3644 elsif Ekind (Gen_Unit) /= E_Generic_Package then
3645
3646 -- Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3647
3648 if From_Limited_With (Gen_Unit) then
3649 Error_Msg_N
3650 ("cannot instantiate a limited withed package", Gen_Id);
3651 else
3652 Error_Msg_NE
3653 ("& is not the name of a generic package", Gen_Id, Gen_Unit);
3654 end if;
3655
3656 Restore_Env;
3657 goto Leave;
3658 end if;
3659
3660 if In_Extended_Main_Source_Unit (N) then
3661 Set_Is_Instantiated (Gen_Unit);
3662 Generate_Reference (Gen_Unit, N);
3663
3664 if Present (Renamed_Object (Gen_Unit)) then
3665 Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3666 Generate_Reference (Renamed_Object (Gen_Unit), N);
3667 end if;
3668 end if;
3669
3670 if Nkind (Gen_Id) = N_Identifier
3671 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3672 then
3673 Error_Msg_NE
3674 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3675
3676 elsif Nkind (Gen_Id) = N_Expanded_Name
3677 and then Is_Child_Unit (Gen_Unit)
3678 and then Nkind (Prefix (Gen_Id)) = N_Identifier
3679 and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3680 then
3681 Error_Msg_N
3682 ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3683 end if;
3684
3685 Set_Entity (Gen_Id, Gen_Unit);
3686
3687 -- If generic is a renaming, get original generic unit
3688
3689 if Present (Renamed_Object (Gen_Unit))
3690 and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3691 then
3692 Gen_Unit := Renamed_Object (Gen_Unit);
3693 end if;
3694
3695 -- Verify that there are no circular instantiations
3696
3697 if In_Open_Scopes (Gen_Unit) then
3698 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3699 Restore_Env;
3700 goto Leave;
3701
3702 elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3703 Error_Msg_Node_2 := Current_Scope;
3704 Error_Msg_NE
3705 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3706 Circularity_Detected := True;
3707 Restore_Env;
3708 goto Leave;
3709
3710 else
3711 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3712
3713 -- Initialize renamings map, for error checking, and the list that
3714 -- holds private entities whose views have changed between generic
3715 -- definition and instantiation. If this is the instance created to
3716 -- validate an actual package, the instantiation environment is that
3717 -- of the enclosing instance.
3718
3719 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3720
3721 -- Copy original generic tree, to produce text for instantiation
3722
3723 Act_Tree :=
3724 Copy_Generic_Node
3725 (Original_Node (Gen_Decl), Empty, Instantiating => True);
3726
3727 Act_Spec := Specification (Act_Tree);
3728
3729 -- If this is the instance created to validate an actual package,
3730 -- only the formals matter, do not examine the package spec itself.
3731
3732 if Is_Actual_Pack then
3733 Set_Visible_Declarations (Act_Spec, New_List);
3734 Set_Private_Declarations (Act_Spec, New_List);
3735 end if;
3736
3737 Renaming_List :=
3738 Analyze_Associations
3739 (I_Node => N,
3740 Formals => Generic_Formal_Declarations (Act_Tree),
3741 F_Copy => Generic_Formal_Declarations (Gen_Decl));
3742
3743 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
3744
3745 Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3746 Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3747 Set_Is_Generic_Instance (Act_Decl_Id);
3748 Set_Generic_Parent (Act_Spec, Gen_Unit);
3749
3750 -- References to the generic in its own declaration or its body are
3751 -- references to the instance. Add a renaming declaration for the
3752 -- generic unit itself. This declaration, as well as the renaming
3753 -- declarations for the generic formals, must remain private to the
3754 -- unit: the formals, because this is the language semantics, and
3755 -- the unit because its use is an artifact of the implementation.
3756
3757 Unit_Renaming :=
3758 Make_Package_Renaming_Declaration (Loc,
3759 Defining_Unit_Name =>
3760 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3761 Name => New_Occurrence_Of (Act_Decl_Id, Loc));
3762
3763 Append (Unit_Renaming, Renaming_List);
3764
3765 -- The renaming declarations are the first local declarations of the
3766 -- new unit.
3767
3768 if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3769 Insert_List_Before
3770 (First (Visible_Declarations (Act_Spec)), Renaming_List);
3771 else
3772 Set_Visible_Declarations (Act_Spec, Renaming_List);
3773 end if;
3774
3775 Act_Decl :=
3776 Make_Package_Declaration (Loc,
3777 Specification => Act_Spec);
3778
3779 -- Propagate the aspect specifications from the package declaration
3780 -- template to the instantiated version of the package declaration.
3781
3782 if Has_Aspects (Act_Tree) then
3783 Set_Aspect_Specifications (Act_Decl,
3784 New_Copy_List_Tree (Aspect_Specifications (Act_Tree)));
3785 end if;
3786
3787 -- Save the instantiation node, for subsequent instantiation of the
3788 -- body, if there is one and we are generating code for the current
3789 -- unit. Mark unit as having a body (avoids premature error message).
3790
3791 -- We instantiate the body if we are generating code, if we are
3792 -- generating cross-reference information, or if we are building
3793 -- trees for ASIS use or GNATprove use.
3794
3795 declare
3796 Enclosing_Body_Present : Boolean := False;
3797 -- If the generic unit is not a compilation unit, then a body may
3798 -- be present in its parent even if none is required. We create a
3799 -- tentative pending instantiation for the body, which will be
3800 -- discarded if none is actually present.
3801
3802 Scop : Entity_Id;
3803
3804 begin
3805 if Scope (Gen_Unit) /= Standard_Standard
3806 and then not Is_Child_Unit (Gen_Unit)
3807 then
3808 Scop := Scope (Gen_Unit);
3809
3810 while Present (Scop)
3811 and then Scop /= Standard_Standard
3812 loop
3813 if Unit_Requires_Body (Scop) then
3814 Enclosing_Body_Present := True;
3815 exit;
3816
3817 elsif In_Open_Scopes (Scop)
3818 and then In_Package_Body (Scop)
3819 then
3820 Enclosing_Body_Present := True;
3821 exit;
3822 end if;
3823
3824 exit when Is_Compilation_Unit (Scop);
3825 Scop := Scope (Scop);
3826 end loop;
3827 end if;
3828
3829 -- If front-end inlining is enabled, and this is a unit for which
3830 -- code will be generated, we instantiate the body at once.
3831
3832 -- This is done if the instance is not the main unit, and if the
3833 -- generic is not a child unit of another generic, to avoid scope
3834 -- problems and the reinstallation of parent instances.
3835
3836 if Expander_Active
3837 and then (not Is_Child_Unit (Gen_Unit)
3838 or else not Is_Generic_Unit (Scope (Gen_Unit)))
3839 and then Might_Inline_Subp
3840 and then not Is_Actual_Pack
3841 then
3842 if not Debug_Flag_Dot_K
3843 and then Front_End_Inlining
3844 and then (Is_In_Main_Unit (N)
3845 or else In_Main_Context (Current_Scope))
3846 and then Nkind (Parent (N)) /= N_Compilation_Unit
3847 then
3848 Inline_Now := True;
3849
3850 elsif Debug_Flag_Dot_K
3851 and then Must_Inline_Subp
3852 and then (Is_In_Main_Unit (N)
3853 or else In_Main_Context (Current_Scope))
3854 and then Nkind (Parent (N)) /= N_Compilation_Unit
3855 then
3856 Inline_Now := True;
3857
3858 -- In configurable_run_time mode we force the inlining of
3859 -- predefined subprograms marked Inline_Always, to minimize
3860 -- the use of the run-time library.
3861
3862 elsif Is_Predefined_File_Name
3863 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
3864 and then Configurable_Run_Time_Mode
3865 and then Nkind (Parent (N)) /= N_Compilation_Unit
3866 then
3867 Inline_Now := True;
3868 end if;
3869
3870 -- If the current scope is itself an instance within a child
3871 -- unit, there will be duplications in the scope stack, and the
3872 -- unstacking mechanism in Inline_Instance_Body will fail.
3873 -- This loses some rare cases of optimization, and might be
3874 -- improved some day, if we can find a proper abstraction for
3875 -- "the complete compilation context" that can be saved and
3876 -- restored. ???
3877
3878 if Is_Generic_Instance (Current_Scope) then
3879 declare
3880 Curr_Unit : constant Entity_Id :=
3881 Cunit_Entity (Current_Sem_Unit);
3882 begin
3883 if Curr_Unit /= Current_Scope
3884 and then Is_Child_Unit (Curr_Unit)
3885 then
3886 Inline_Now := False;
3887 end if;
3888 end;
3889 end if;
3890 end if;
3891
3892 Needs_Body :=
3893 (Unit_Requires_Body (Gen_Unit)
3894 or else Enclosing_Body_Present
3895 or else Present (Corresponding_Body (Gen_Decl)))
3896 and then (Is_In_Main_Unit (N) or else Might_Inline_Subp)
3897 and then not Is_Actual_Pack
3898 and then not Inline_Now
3899 and then (Operating_Mode = Generate_Code
3900
3901 -- Need comment for this check ???
3902
3903 or else (Operating_Mode = Check_Semantics
3904 and then (ASIS_Mode or GNATprove_Mode)));
3905
3906 -- If front_end_inlining is enabled, do not instantiate body if
3907 -- within a generic context.
3908
3909 if (Front_End_Inlining and then not Expander_Active)
3910 or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
3911 then
3912 Needs_Body := False;
3913 end if;
3914
3915 -- If the current context is generic, and the package being
3916 -- instantiated is declared within a formal package, there is no
3917 -- body to instantiate until the enclosing generic is instantiated
3918 -- and there is an actual for the formal package. If the formal
3919 -- package has parameters, we build a regular package instance for
3920 -- it, that precedes the original formal package declaration.
3921
3922 if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
3923 declare
3924 Decl : constant Node_Id :=
3925 Original_Node
3926 (Unit_Declaration_Node (Scope (Gen_Unit)));
3927 begin
3928 if Nkind (Decl) = N_Formal_Package_Declaration
3929 or else (Nkind (Decl) = N_Package_Declaration
3930 and then Is_List_Member (Decl)
3931 and then Present (Next (Decl))
3932 and then
3933 Nkind (Next (Decl)) =
3934 N_Formal_Package_Declaration)
3935 then
3936 Needs_Body := False;
3937 end if;
3938 end;
3939 end if;
3940 end;
3941
3942 -- For RCI unit calling stubs, we omit the instance body if the
3943 -- instance is the RCI library unit itself.
3944
3945 -- However there is a special case for nested instances: in this case
3946 -- we do generate the instance body, as it might be required, e.g.
3947 -- because it provides stream attributes for some type used in the
3948 -- profile of a remote subprogram. This is consistent with 12.3(12),
3949 -- which indicates that the instance body occurs at the place of the
3950 -- instantiation, and thus is part of the RCI declaration, which is
3951 -- present on all client partitions (this is E.2.3(18)).
3952
3953 -- Note that AI12-0002 may make it illegal at some point to have
3954 -- stream attributes defined in an RCI unit, in which case this
3955 -- special case will become unnecessary. In the meantime, there
3956 -- is known application code in production that depends on this
3957 -- being possible, so we definitely cannot eliminate the body in
3958 -- the case of nested instances for the time being.
3959
3960 -- When we generate a nested instance body, calling stubs for any
3961 -- relevant subprogram will be be inserted immediately after the
3962 -- subprogram declarations, and will take precedence over the
3963 -- subsequent (original) body. (The stub and original body will be
3964 -- complete homographs, but this is permitted in an instance).
3965 -- (Could we do better and remove the original body???)
3966
3967 if Distribution_Stub_Mode = Generate_Caller_Stub_Body
3968 and then Comes_From_Source (N)
3969 and then Nkind (Parent (N)) = N_Compilation_Unit
3970 then
3971 Needs_Body := False;
3972 end if;
3973
3974 if Needs_Body then
3975
3976 -- Here is a defence against a ludicrous number of instantiations
3977 -- caused by a circular set of instantiation attempts.
3978
3979 if Pending_Instantiations.Last > Maximum_Instantiations then
3980 Error_Msg_Uint_1 := UI_From_Int (Maximum_Instantiations);
3981 Error_Msg_N ("too many instantiations, exceeds max of^", N);
3982 Error_Msg_N ("\limit can be changed using -gnateinn switch", N);
3983 raise Unrecoverable_Error;
3984 end if;
3985
3986 -- Indicate that the enclosing scopes contain an instantiation,
3987 -- and that cleanup actions should be delayed until after the
3988 -- instance body is expanded.
3989
3990 Check_Forward_Instantiation (Gen_Decl);
3991 if Nkind (N) = N_Package_Instantiation then
3992 declare
3993 Enclosing_Master : Entity_Id;
3994
3995 begin
3996 -- Loop to search enclosing masters
3997
3998 Enclosing_Master := Current_Scope;
3999 Scope_Loop : while Enclosing_Master /= Standard_Standard loop
4000 if Ekind (Enclosing_Master) = E_Package then
4001 if Is_Compilation_Unit (Enclosing_Master) then
4002 if In_Package_Body (Enclosing_Master) then
4003 Delay_Descriptors
4004 (Body_Entity (Enclosing_Master));
4005 else
4006 Delay_Descriptors
4007 (Enclosing_Master);
4008 end if;
4009
4010 exit Scope_Loop;
4011
4012 else
4013 Enclosing_Master := Scope (Enclosing_Master);
4014 end if;
4015
4016 elsif Is_Generic_Unit (Enclosing_Master)
4017 or else Ekind (Enclosing_Master) = E_Void
4018 then
4019 -- Cleanup actions will eventually be performed on the
4020 -- enclosing subprogram or package instance, if any.
4021 -- Enclosing scope is void in the formal part of a
4022 -- generic subprogram.
4023
4024 exit Scope_Loop;
4025
4026 else
4027 if Ekind (Enclosing_Master) = E_Entry
4028 and then
4029 Ekind (Scope (Enclosing_Master)) = E_Protected_Type
4030 then
4031 if not Expander_Active then
4032 exit Scope_Loop;
4033 else
4034 Enclosing_Master :=
4035 Protected_Body_Subprogram (Enclosing_Master);
4036 end if;
4037 end if;
4038
4039 Set_Delay_Cleanups (Enclosing_Master);
4040
4041 while Ekind (Enclosing_Master) = E_Block loop
4042 Enclosing_Master := Scope (Enclosing_Master);
4043 end loop;
4044
4045 if Is_Subprogram (Enclosing_Master) then
4046 Delay_Descriptors (Enclosing_Master);
4047
4048 elsif Is_Task_Type (Enclosing_Master) then
4049 declare
4050 TBP : constant Node_Id :=
4051 Get_Task_Body_Procedure
4052 (Enclosing_Master);
4053 begin
4054 if Present (TBP) then
4055 Delay_Descriptors (TBP);
4056 Set_Delay_Cleanups (TBP);
4057 end if;
4058 end;
4059 end if;
4060
4061 exit Scope_Loop;
4062 end if;
4063 end loop Scope_Loop;
4064 end;
4065
4066 -- Make entry in table
4067
4068 Pending_Instantiations.Append
4069 ((Inst_Node => N,
4070 Act_Decl => Act_Decl,
4071 Expander_Status => Expander_Active,
4072 Current_Sem_Unit => Current_Sem_Unit,
4073 Scope_Suppress => Scope_Suppress,
4074 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4075 Version => Ada_Version,
4076 Version_Pragma => Ada_Version_Pragma,
4077 Warnings => Save_Warnings,
4078 SPARK_Mode => SPARK_Mode,
4079 SPARK_Mode_Pragma => SPARK_Mode_Pragma));
4080 end if;
4081 end if;
4082
4083 Set_Categorization_From_Pragmas (Act_Decl);
4084
4085 if Parent_Installed then
4086 Hide_Current_Scope;
4087 end if;
4088
4089 Set_Instance_Spec (N, Act_Decl);
4090
4091 -- If not a compilation unit, insert the package declaration before
4092 -- the original instantiation node.
4093
4094 if Nkind (Parent (N)) /= N_Compilation_Unit then
4095 Mark_Rewrite_Insertion (Act_Decl);
4096 Insert_Before (N, Act_Decl);
4097 Analyze (Act_Decl);
4098
4099 -- For an instantiation that is a compilation unit, place
4100 -- declaration on current node so context is complete for analysis
4101 -- (including nested instantiations). If this is the main unit,
4102 -- the declaration eventually replaces the instantiation node.
4103 -- If the instance body is created later, it replaces the
4104 -- instance node, and the declaration is attached to it
4105 -- (see Build_Instance_Compilation_Unit_Nodes).
4106
4107 else
4108 if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
4109
4110 -- The entity for the current unit is the newly created one,
4111 -- and all semantic information is attached to it.
4112
4113 Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
4114
4115 -- If this is the main unit, replace the main entity as well
4116
4117 if Current_Sem_Unit = Main_Unit then
4118 Main_Unit_Entity := Act_Decl_Id;
4119 end if;
4120 end if;
4121
4122 Set_Unit (Parent (N), Act_Decl);
4123 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
4124 Set_Package_Instantiation (Act_Decl_Id, N);
4125
4126 -- Process aspect specifications of the instance node, if any, to
4127 -- take into account categorization pragmas before analyzing the
4128 -- instance.
4129
4130 if Has_Aspects (N) then
4131 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4132 end if;
4133
4134 Analyze (Act_Decl);
4135 Set_Unit (Parent (N), N);
4136 Set_Body_Required (Parent (N), False);
4137
4138 -- We never need elaboration checks on instantiations, since by
4139 -- definition, the body instantiation is elaborated at the same
4140 -- time as the spec instantiation.
4141
4142 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4143 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4144 end if;
4145
4146 Check_Elab_Instantiation (N);
4147
4148 if ABE_Is_Certain (N) and then Needs_Body then
4149 Pending_Instantiations.Decrement_Last;
4150 end if;
4151
4152 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4153
4154 Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
4155 First_Private_Entity (Act_Decl_Id));
4156
4157 -- If the instantiation will receive a body, the unit will be
4158 -- transformed into a package body, and receive its own elaboration
4159 -- entity. Otherwise, the nature of the unit is now a package
4160 -- declaration.
4161
4162 if Nkind (Parent (N)) = N_Compilation_Unit
4163 and then not Needs_Body
4164 then
4165 Rewrite (N, Act_Decl);
4166 end if;
4167
4168 if Present (Corresponding_Body (Gen_Decl))
4169 or else Unit_Requires_Body (Gen_Unit)
4170 then
4171 Set_Has_Completion (Act_Decl_Id);
4172 end if;
4173
4174 Check_Formal_Packages (Act_Decl_Id);
4175
4176 Restore_Hidden_Primitives (Vis_Prims_List);
4177 Restore_Private_Views (Act_Decl_Id);
4178
4179 Inherit_Context (Gen_Decl, N);
4180
4181 if Parent_Installed then
4182 Remove_Parent;
4183 end if;
4184
4185 Restore_Env;
4186 Env_Installed := False;
4187 end if;
4188
4189 Validate_Categorization_Dependency (N, Act_Decl_Id);
4190
4191 -- There used to be a check here to prevent instantiations in local
4192 -- contexts if the No_Local_Allocators restriction was active. This
4193 -- check was removed by a binding interpretation in AI-95-00130/07,
4194 -- but we retain the code for documentation purposes.
4195
4196 -- if Ekind (Act_Decl_Id) /= E_Void
4197 -- and then not Is_Library_Level_Entity (Act_Decl_Id)
4198 -- then
4199 -- Check_Restriction (No_Local_Allocators, N);
4200 -- end if;
4201
4202 if Inline_Now then
4203 Inline_Instance_Body (N, Gen_Unit, Act_Decl);
4204 end if;
4205
4206 -- The following is a tree patch for ASIS: ASIS needs separate nodes to
4207 -- be used as defining identifiers for a formal package and for the
4208 -- corresponding expanded package.
4209
4210 if Nkind (N) = N_Formal_Package_Declaration then
4211 Act_Decl_Id := New_Copy (Defining_Entity (N));
4212 Set_Comes_From_Source (Act_Decl_Id, True);
4213 Set_Is_Generic_Instance (Act_Decl_Id, False);
4214 Set_Defining_Identifier (N, Act_Decl_Id);
4215 end if;
4216
4217 Style_Check := Save_Style_Check;
4218
4219 -- Check that if N is an instantiation of System.Dim_Float_IO or
4220 -- System.Dim_Integer_IO, the formal type has a dimension system.
4221
4222 if Nkind (N) = N_Package_Instantiation
4223 and then Is_Dim_IO_Package_Instantiation (N)
4224 then
4225 declare
4226 Assoc : constant Node_Id := First (Generic_Associations (N));
4227 begin
4228 if not Has_Dimension_System
4229 (Etype (Explicit_Generic_Actual_Parameter (Assoc)))
4230 then
4231 Error_Msg_N ("type with a dimension system expected", Assoc);
4232 end if;
4233 end;
4234 end if;
4235
4236 <<Leave>>
4237 if Has_Aspects (N) and then Nkind (Parent (N)) /= N_Compilation_Unit then
4238 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4239 end if;
4240
4241 exception
4242 when Instantiation_Error =>
4243 if Parent_Installed then
4244 Remove_Parent;
4245 end if;
4246
4247 if Env_Installed then
4248 Restore_Env;
4249 end if;
4250
4251 Style_Check := Save_Style_Check;
4252 end Analyze_Package_Instantiation;
4253
4254 --------------------------
4255 -- Inline_Instance_Body --
4256 --------------------------
4257
4258 procedure Inline_Instance_Body
4259 (N : Node_Id;
4260 Gen_Unit : Entity_Id;
4261 Act_Decl : Node_Id)
4262 is
4263 Vis : Boolean;
4264 Gen_Comp : constant Entity_Id :=
4265 Cunit_Entity (Get_Source_Unit (Gen_Unit));
4266 Curr_Comp : constant Node_Id := Cunit (Current_Sem_Unit);
4267 Curr_Scope : Entity_Id := Empty;
4268 Curr_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
4269 Removed : Boolean := False;
4270 Num_Scopes : Int := 0;
4271
4272 Scope_Stack_Depth : constant Int :=
4273 Scope_Stack.Last - Scope_Stack.First + 1;
4274
4275 Use_Clauses : array (1 .. Scope_Stack_Depth) of Node_Id;
4276 Instances : array (1 .. Scope_Stack_Depth) of Entity_Id;
4277 Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
4278 List : Elist_Id;
4279 Num_Inner : Int := 0;
4280 N_Instances : Int := 0;
4281 S : Entity_Id;
4282
4283 begin
4284 -- Case of generic unit defined in another unit. We must remove the
4285 -- complete context of the current unit to install that of the generic.
4286
4287 if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
4288
4289 -- Add some comments for the following two loops ???
4290
4291 S := Current_Scope;
4292 while Present (S) and then S /= Standard_Standard loop
4293 loop
4294 Num_Scopes := Num_Scopes + 1;
4295
4296 Use_Clauses (Num_Scopes) :=
4297 (Scope_Stack.Table
4298 (Scope_Stack.Last - Num_Scopes + 1).
4299 First_Use_Clause);
4300 End_Use_Clauses (Use_Clauses (Num_Scopes));
4301
4302 exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
4303 or else Scope_Stack.Table
4304 (Scope_Stack.Last - Num_Scopes).Entity
4305 = Scope (S);
4306 end loop;
4307
4308 exit when Is_Generic_Instance (S)
4309 and then (In_Package_Body (S)
4310 or else Ekind (S) = E_Procedure
4311 or else Ekind (S) = E_Function);
4312 S := Scope (S);
4313 end loop;
4314
4315 Vis := Is_Immediately_Visible (Gen_Comp);
4316
4317 -- Find and save all enclosing instances
4318
4319 S := Current_Scope;
4320
4321 while Present (S)
4322 and then S /= Standard_Standard
4323 loop
4324 if Is_Generic_Instance (S) then
4325 N_Instances := N_Instances + 1;
4326 Instances (N_Instances) := S;
4327
4328 exit when In_Package_Body (S);
4329 end if;
4330
4331 S := Scope (S);
4332 end loop;
4333
4334 -- Remove context of current compilation unit, unless we are within a
4335 -- nested package instantiation, in which case the context has been
4336 -- removed previously.
4337
4338 -- If current scope is the body of a child unit, remove context of
4339 -- spec as well. If an enclosing scope is an instance body, the
4340 -- context has already been removed, but the entities in the body
4341 -- must be made invisible as well.
4342
4343 S := Current_Scope;
4344
4345 while Present (S)
4346 and then S /= Standard_Standard
4347 loop
4348 if Is_Generic_Instance (S)
4349 and then (In_Package_Body (S)
4350 or else Ekind (S) = E_Procedure
4351 or else Ekind (S) = E_Function)
4352 then
4353 -- We still have to remove the entities of the enclosing
4354 -- instance from direct visibility.
4355
4356 declare
4357 E : Entity_Id;
4358 begin
4359 E := First_Entity (S);
4360 while Present (E) loop
4361 Set_Is_Immediately_Visible (E, False);
4362 Next_Entity (E);
4363 end loop;
4364 end;
4365
4366 exit;
4367 end if;
4368
4369 if S = Curr_Unit
4370 or else (Ekind (Curr_Unit) = E_Package_Body
4371 and then S = Spec_Entity (Curr_Unit))
4372 or else (Ekind (Curr_Unit) = E_Subprogram_Body
4373 and then S =
4374 Corresponding_Spec
4375 (Unit_Declaration_Node (Curr_Unit)))
4376 then
4377 Removed := True;
4378
4379 -- Remove entities in current scopes from visibility, so that
4380 -- instance body is compiled in a clean environment.
4381
4382 List := Save_Scope_Stack (Handle_Use => False);
4383
4384 if Is_Child_Unit (S) then
4385
4386 -- Remove child unit from stack, as well as inner scopes.
4387 -- Removing the context of a child unit removes parent units
4388 -- as well.
4389
4390 while Current_Scope /= S loop
4391 Num_Inner := Num_Inner + 1;
4392 Inner_Scopes (Num_Inner) := Current_Scope;
4393 Pop_Scope;
4394 end loop;
4395
4396 Pop_Scope;
4397 Remove_Context (Curr_Comp);
4398 Curr_Scope := S;
4399
4400 else
4401 Remove_Context (Curr_Comp);
4402 end if;
4403
4404 if Ekind (Curr_Unit) = E_Package_Body then
4405 Remove_Context (Library_Unit (Curr_Comp));
4406 end if;
4407 end if;
4408
4409 S := Scope (S);
4410 end loop;
4411 pragma Assert (Num_Inner < Num_Scopes);
4412
4413 Push_Scope (Standard_Standard);
4414 Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4415 Instantiate_Package_Body
4416 (Body_Info =>
4417 ((Inst_Node => N,
4418 Act_Decl => Act_Decl,
4419 Expander_Status => Expander_Active,
4420 Current_Sem_Unit => Current_Sem_Unit,
4421 Scope_Suppress => Scope_Suppress,
4422 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4423 Version => Ada_Version,
4424 Version_Pragma => Ada_Version_Pragma,
4425 Warnings => Save_Warnings,
4426 SPARK_Mode => SPARK_Mode,
4427 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
4428 Inlined_Body => True);
4429
4430 Pop_Scope;
4431
4432 -- Restore context
4433
4434 Set_Is_Immediately_Visible (Gen_Comp, Vis);
4435
4436 -- Reset Generic_Instance flag so that use clauses can be installed
4437 -- in the proper order. (See Use_One_Package for effect of enclosing
4438 -- instances on processing of use clauses).
4439
4440 for J in 1 .. N_Instances loop
4441 Set_Is_Generic_Instance (Instances (J), False);
4442 end loop;
4443
4444 if Removed then
4445 Install_Context (Curr_Comp);
4446
4447 if Present (Curr_Scope)
4448 and then Is_Child_Unit (Curr_Scope)
4449 then
4450 Push_Scope (Curr_Scope);
4451 Set_Is_Immediately_Visible (Curr_Scope);
4452
4453 -- Finally, restore inner scopes as well
4454
4455 for J in reverse 1 .. Num_Inner loop
4456 Push_Scope (Inner_Scopes (J));
4457 end loop;
4458 end if;
4459
4460 Restore_Scope_Stack (List, Handle_Use => False);
4461
4462 if Present (Curr_Scope)
4463 and then
4464 (In_Private_Part (Curr_Scope)
4465 or else In_Package_Body (Curr_Scope))
4466 then
4467 -- Install private declaration of ancestor units, which are
4468 -- currently available. Restore_Scope_Stack and Install_Context
4469 -- only install the visible part of parents.
4470
4471 declare
4472 Par : Entity_Id;
4473 begin
4474 Par := Scope (Curr_Scope);
4475 while (Present (Par))
4476 and then Par /= Standard_Standard
4477 loop
4478 Install_Private_Declarations (Par);
4479 Par := Scope (Par);
4480 end loop;
4481 end;
4482 end if;
4483 end if;
4484
4485 -- Restore use clauses. For a child unit, use clauses in the parents
4486 -- are restored when installing the context, so only those in inner
4487 -- scopes (and those local to the child unit itself) need to be
4488 -- installed explicitly.
4489
4490 if Is_Child_Unit (Curr_Unit)
4491 and then Removed
4492 then
4493 for J in reverse 1 .. Num_Inner + 1 loop
4494 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4495 Use_Clauses (J);
4496 Install_Use_Clauses (Use_Clauses (J));
4497 end loop;
4498
4499 else
4500 for J in reverse 1 .. Num_Scopes loop
4501 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4502 Use_Clauses (J);
4503 Install_Use_Clauses (Use_Clauses (J));
4504 end loop;
4505 end if;
4506
4507 -- Restore status of instances. If one of them is a body, make its
4508 -- local entities visible again.
4509
4510 declare
4511 E : Entity_Id;
4512 Inst : Entity_Id;
4513
4514 begin
4515 for J in 1 .. N_Instances loop
4516 Inst := Instances (J);
4517 Set_Is_Generic_Instance (Inst, True);
4518
4519 if In_Package_Body (Inst)
4520 or else Ekind (S) = E_Procedure
4521 or else Ekind (S) = E_Function
4522 then
4523 E := First_Entity (Instances (J));
4524 while Present (E) loop
4525 Set_Is_Immediately_Visible (E);
4526 Next_Entity (E);
4527 end loop;
4528 end if;
4529 end loop;
4530 end;
4531
4532 -- If generic unit is in current unit, current context is correct
4533
4534 else
4535 Instantiate_Package_Body
4536 (Body_Info =>
4537 ((Inst_Node => N,
4538 Act_Decl => Act_Decl,
4539 Expander_Status => Expander_Active,
4540 Current_Sem_Unit => Current_Sem_Unit,
4541 Scope_Suppress => Scope_Suppress,
4542 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4543 Version => Ada_Version,
4544 Version_Pragma => Ada_Version_Pragma,
4545 Warnings => Save_Warnings,
4546 SPARK_Mode => SPARK_Mode,
4547 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
4548 Inlined_Body => True);
4549 end if;
4550 end Inline_Instance_Body;
4551
4552 -------------------------------------
4553 -- Analyze_Procedure_Instantiation --
4554 -------------------------------------
4555
4556 procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4557 begin
4558 Analyze_Subprogram_Instantiation (N, E_Procedure);
4559 end Analyze_Procedure_Instantiation;
4560
4561 -----------------------------------
4562 -- Need_Subprogram_Instance_Body --
4563 -----------------------------------
4564
4565 function Need_Subprogram_Instance_Body
4566 (N : Node_Id;
4567 Subp : Entity_Id) return Boolean
4568 is
4569 begin
4570 -- Must be inlined (or inlined renaming)
4571
4572 if (Is_In_Main_Unit (N)
4573 or else Is_Inlined (Subp)
4574 or else Is_Inlined (Alias (Subp)))
4575
4576 -- Must be generating code or analyzing code in ASIS/GNATprove mode
4577
4578 and then (Operating_Mode = Generate_Code
4579 or else (Operating_Mode = Check_Semantics
4580 and then (ASIS_Mode or GNATprove_Mode)))
4581
4582 -- The body is needed when generating code (full expansion), in ASIS
4583 -- mode for other tools, and in GNATprove mode (special expansion) for
4584 -- formal verification of the body itself.
4585
4586 and then (Expander_Active or ASIS_Mode or GNATprove_Mode)
4587
4588 -- No point in inlining if ABE is inevitable
4589
4590 and then not ABE_Is_Certain (N)
4591
4592 -- Or if subprogram is eliminated
4593
4594 and then not Is_Eliminated (Subp)
4595 then
4596 Pending_Instantiations.Append
4597 ((Inst_Node => N,
4598 Act_Decl => Unit_Declaration_Node (Subp),
4599 Expander_Status => Expander_Active,
4600 Current_Sem_Unit => Current_Sem_Unit,
4601 Scope_Suppress => Scope_Suppress,
4602 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4603 Version => Ada_Version,
4604 Version_Pragma => Ada_Version_Pragma,
4605 Warnings => Save_Warnings,
4606 SPARK_Mode => SPARK_Mode,
4607 SPARK_Mode_Pragma => SPARK_Mode_Pragma));
4608 return True;
4609
4610 -- Here if not inlined, or we ignore the inlining
4611
4612 else
4613 return False;
4614 end if;
4615 end Need_Subprogram_Instance_Body;
4616
4617 --------------------------------------
4618 -- Analyze_Subprogram_Instantiation --
4619 --------------------------------------
4620
4621 procedure Analyze_Subprogram_Instantiation
4622 (N : Node_Id;
4623 K : Entity_Kind)
4624 is
4625 Loc : constant Source_Ptr := Sloc (N);
4626 Gen_Id : constant Node_Id := Name (N);
4627
4628 Anon_Id : constant Entity_Id :=
4629 Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4630 Chars => New_External_Name
4631 (Chars (Defining_Entity (N)), 'R'));
4632
4633 Act_Decl_Id : Entity_Id;
4634 Act_Decl : Node_Id;
4635 Act_Spec : Node_Id;
4636 Act_Tree : Node_Id;
4637
4638 Env_Installed : Boolean := False;
4639 Gen_Unit : Entity_Id;
4640 Gen_Decl : Node_Id;
4641 Pack_Id : Entity_Id;
4642 Parent_Installed : Boolean := False;
4643 Renaming_List : List_Id;
4644
4645 procedure Analyze_Instance_And_Renamings;
4646 -- The instance must be analyzed in a context that includes the mappings
4647 -- of generic parameters into actuals. We create a package declaration
4648 -- for this purpose, and a subprogram with an internal name within the
4649 -- package. The subprogram instance is simply an alias for the internal
4650 -- subprogram, declared in the current scope.
4651
4652 ------------------------------------
4653 -- Analyze_Instance_And_Renamings --
4654 ------------------------------------
4655
4656 procedure Analyze_Instance_And_Renamings is
4657 Def_Ent : constant Entity_Id := Defining_Entity (N);
4658 Pack_Decl : Node_Id;
4659
4660 begin
4661 if Nkind (Parent (N)) = N_Compilation_Unit then
4662
4663 -- For the case of a compilation unit, the container package has
4664 -- the same name as the instantiation, to insure that the binder
4665 -- calls the elaboration procedure with the right name. Copy the
4666 -- entity of the instance, which may have compilation level flags
4667 -- (e.g. Is_Child_Unit) set.
4668
4669 Pack_Id := New_Copy (Def_Ent);
4670
4671 else
4672 -- Otherwise we use the name of the instantiation concatenated
4673 -- with its source position to ensure uniqueness if there are
4674 -- several instantiations with the same name.
4675
4676 Pack_Id :=
4677 Make_Defining_Identifier (Loc,
4678 Chars => New_External_Name
4679 (Related_Id => Chars (Def_Ent),
4680 Suffix => "GP",
4681 Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4682 end if;
4683
4684 Pack_Decl := Make_Package_Declaration (Loc,
4685 Specification => Make_Package_Specification (Loc,
4686 Defining_Unit_Name => Pack_Id,
4687 Visible_Declarations => Renaming_List,
4688 End_Label => Empty));
4689
4690 Set_Instance_Spec (N, Pack_Decl);
4691 Set_Is_Generic_Instance (Pack_Id);
4692 Set_Debug_Info_Needed (Pack_Id);
4693
4694 -- Case of not a compilation unit
4695
4696 if Nkind (Parent (N)) /= N_Compilation_Unit then
4697 Mark_Rewrite_Insertion (Pack_Decl);
4698 Insert_Before (N, Pack_Decl);
4699 Set_Has_Completion (Pack_Id);
4700
4701 -- Case of an instantiation that is a compilation unit
4702
4703 -- Place declaration on current node so context is complete for
4704 -- analysis (including nested instantiations), and for use in a
4705 -- context_clause (see Analyze_With_Clause).
4706
4707 else
4708 Set_Unit (Parent (N), Pack_Decl);
4709 Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4710 end if;
4711
4712 Analyze (Pack_Decl);
4713 Check_Formal_Packages (Pack_Id);
4714 Set_Is_Generic_Instance (Pack_Id, False);
4715
4716 -- Why do we clear Is_Generic_Instance??? We set it 20 lines
4717 -- above???
4718
4719 -- Body of the enclosing package is supplied when instantiating the
4720 -- subprogram body, after semantic analysis is completed.
4721
4722 if Nkind (Parent (N)) = N_Compilation_Unit then
4723
4724 -- Remove package itself from visibility, so it does not
4725 -- conflict with subprogram.
4726
4727 Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4728
4729 -- Set name and scope of internal subprogram so that the proper
4730 -- external name will be generated. The proper scope is the scope
4731 -- of the wrapper package. We need to generate debugging info for
4732 -- the internal subprogram, so set flag accordingly.
4733
4734 Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4735 Set_Scope (Anon_Id, Scope (Pack_Id));
4736
4737 -- Mark wrapper package as referenced, to avoid spurious warnings
4738 -- if the instantiation appears in various with_ clauses of
4739 -- subunits of the main unit.
4740
4741 Set_Referenced (Pack_Id);
4742 end if;
4743
4744 Set_Is_Generic_Instance (Anon_Id);
4745 Set_Debug_Info_Needed (Anon_Id);
4746 Act_Decl_Id := New_Copy (Anon_Id);
4747
4748 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4749 Set_Chars (Act_Decl_Id, Chars (Defining_Entity (N)));
4750 Set_Sloc (Act_Decl_Id, Sloc (Defining_Entity (N)));
4751 Set_Comes_From_Source (Act_Decl_Id, True);
4752
4753 -- The signature may involve types that are not frozen yet, but the
4754 -- subprogram will be frozen at the point the wrapper package is
4755 -- frozen, so it does not need its own freeze node. In fact, if one
4756 -- is created, it might conflict with the freezing actions from the
4757 -- wrapper package.
4758
4759 Set_Has_Delayed_Freeze (Anon_Id, False);
4760
4761 -- If the instance is a child unit, mark the Id accordingly. Mark
4762 -- the anonymous entity as well, which is the real subprogram and
4763 -- which is used when the instance appears in a context clause.
4764 -- Similarly, propagate the Is_Eliminated flag to handle properly
4765 -- nested eliminated subprograms.
4766
4767 Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
4768 Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
4769 New_Overloaded_Entity (Act_Decl_Id);
4770 Check_Eliminated (Act_Decl_Id);
4771 Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
4772
4773 -- In compilation unit case, kill elaboration checks on the
4774 -- instantiation, since they are never needed -- the body is
4775 -- instantiated at the same point as the spec.
4776
4777 if Nkind (Parent (N)) = N_Compilation_Unit then
4778 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4779 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4780 Set_Is_Compilation_Unit (Anon_Id);
4781
4782 Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
4783 end if;
4784
4785 -- The instance is not a freezing point for the new subprogram
4786
4787 Set_Is_Frozen (Act_Decl_Id, False);
4788
4789 if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
4790 Valid_Operator_Definition (Act_Decl_Id);
4791 end if;
4792
4793 Set_Alias (Act_Decl_Id, Anon_Id);
4794 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4795 Set_Has_Completion (Act_Decl_Id);
4796 Set_Related_Instance (Pack_Id, Act_Decl_Id);
4797
4798 if Nkind (Parent (N)) = N_Compilation_Unit then
4799 Set_Body_Required (Parent (N), False);
4800 end if;
4801 end Analyze_Instance_And_Renamings;
4802
4803 -- Local variables
4804
4805 Vis_Prims_List : Elist_Id := No_Elist;
4806 -- List of primitives made temporarily visible in the instantiation
4807 -- to match the visibility of the formal type
4808
4809 -- Start of processing for Analyze_Subprogram_Instantiation
4810
4811 begin
4812 Check_SPARK_Restriction ("generic is not allowed", N);
4813
4814 -- Very first thing: check for special Text_IO unit in case we are
4815 -- instantiating one of the children of [[Wide_]Wide_]Text_IO. Of course
4816 -- such an instantiation is bogus (these are packages, not subprograms),
4817 -- but we get a better error message if we do this.
4818
4819 Check_Text_IO_Special_Unit (Gen_Id);
4820
4821 -- Make node global for error reporting
4822
4823 Instantiation_Node := N;
4824
4825 -- For package instantiations we turn off style checks, because they
4826 -- will have been emitted in the generic. For subprogram instantiations
4827 -- we want to apply at least the check on overriding indicators so we
4828 -- do not modify the style check status.
4829
4830 -- The renaming declarations for the actuals do not come from source and
4831 -- will not generate spurious warnings.
4832
4833 Preanalyze_Actuals (N);
4834
4835 Init_Env;
4836 Env_Installed := True;
4837 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
4838 Gen_Unit := Entity (Gen_Id);
4839
4840 Generate_Reference (Gen_Unit, Gen_Id);
4841
4842 if Nkind (Gen_Id) = N_Identifier
4843 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
4844 then
4845 Error_Msg_NE
4846 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
4847 end if;
4848
4849 if Etype (Gen_Unit) = Any_Type then
4850 Restore_Env;
4851 return;
4852 end if;
4853
4854 -- Verify that it is a generic subprogram of the right kind, and that
4855 -- it does not lead to a circular instantiation.
4856
4857 if K = E_Procedure and then Ekind (Gen_Unit) /= E_Generic_Procedure then
4858 Error_Msg_NE
4859 ("& is not the name of a generic procedure", Gen_Id, Gen_Unit);
4860
4861 elsif K = E_Function and then Ekind (Gen_Unit) /= E_Generic_Function then
4862 Error_Msg_NE
4863 ("& is not the name of a generic function", Gen_Id, Gen_Unit);
4864
4865 elsif In_Open_Scopes (Gen_Unit) then
4866 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
4867
4868 else
4869 Set_Entity (Gen_Id, Gen_Unit);
4870 Set_Is_Instantiated (Gen_Unit);
4871
4872 if In_Extended_Main_Source_Unit (N) then
4873 Generate_Reference (Gen_Unit, N);
4874 end if;
4875
4876 -- If renaming, get original unit
4877
4878 if Present (Renamed_Object (Gen_Unit))
4879 and then (Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Procedure
4880 or else
4881 Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Function)
4882 then
4883 Gen_Unit := Renamed_Object (Gen_Unit);
4884 Set_Is_Instantiated (Gen_Unit);
4885 Generate_Reference (Gen_Unit, N);
4886 end if;
4887
4888 if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
4889 Error_Msg_Node_2 := Current_Scope;
4890 Error_Msg_NE
4891 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
4892 Circularity_Detected := True;
4893 Restore_Hidden_Primitives (Vis_Prims_List);
4894 goto Leave;
4895 end if;
4896
4897 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
4898
4899 -- Initialize renamings map, for error checking
4900
4901 Generic_Renamings.Set_Last (0);
4902 Generic_Renamings_HTable.Reset;
4903
4904 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
4905
4906 -- Copy original generic tree, to produce text for instantiation
4907
4908 Act_Tree :=
4909 Copy_Generic_Node
4910 (Original_Node (Gen_Decl), Empty, Instantiating => True);
4911
4912 -- Inherit overriding indicator from instance node
4913
4914 Act_Spec := Specification (Act_Tree);
4915 Set_Must_Override (Act_Spec, Must_Override (N));
4916 Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
4917
4918 Renaming_List :=
4919 Analyze_Associations
4920 (I_Node => N,
4921 Formals => Generic_Formal_Declarations (Act_Tree),
4922 F_Copy => Generic_Formal_Declarations (Gen_Decl));
4923
4924 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
4925
4926 -- The subprogram itself cannot contain a nested instance, so the
4927 -- current parent is left empty.
4928
4929 Set_Instance_Env (Gen_Unit, Empty);
4930
4931 -- Build the subprogram declaration, which does not appear in the
4932 -- generic template, and give it a sloc consistent with that of the
4933 -- template.
4934
4935 Set_Defining_Unit_Name (Act_Spec, Anon_Id);
4936 Set_Generic_Parent (Act_Spec, Gen_Unit);
4937 Act_Decl :=
4938 Make_Subprogram_Declaration (Sloc (Act_Spec),
4939 Specification => Act_Spec);
4940
4941 -- The aspects have been copied previously, but they have to be
4942 -- linked explicitly to the new subprogram declaration. Explicit
4943 -- pre/postconditions on the instance are analyzed below, in a
4944 -- separate step.
4945
4946 Move_Aspects (Act_Tree, To => Act_Decl);
4947 Set_Categorization_From_Pragmas (Act_Decl);
4948
4949 if Parent_Installed then
4950 Hide_Current_Scope;
4951 end if;
4952
4953 Append (Act_Decl, Renaming_List);
4954 Analyze_Instance_And_Renamings;
4955
4956 -- If the generic is marked Import (Intrinsic), then so is the
4957 -- instance. This indicates that there is no body to instantiate. If
4958 -- generic is marked inline, so it the instance, and the anonymous
4959 -- subprogram it renames. If inlined, or else if inlining is enabled
4960 -- for the compilation, we generate the instance body even if it is
4961 -- not within the main unit.
4962
4963 if Is_Intrinsic_Subprogram (Gen_Unit) then
4964 Set_Is_Intrinsic_Subprogram (Anon_Id);
4965 Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
4966
4967 if Chars (Gen_Unit) = Name_Unchecked_Conversion then
4968 Validate_Unchecked_Conversion (N, Act_Decl_Id);
4969 end if;
4970 end if;
4971
4972 -- Inherit convention from generic unit. Intrinsic convention, as for
4973 -- an instance of unchecked conversion, is not inherited because an
4974 -- explicit Ada instance has been created.
4975
4976 if Has_Convention_Pragma (Gen_Unit)
4977 and then Convention (Gen_Unit) /= Convention_Intrinsic
4978 then
4979 Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
4980 Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
4981 end if;
4982
4983 Generate_Definition (Act_Decl_Id);
4984 -- Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id)));
4985 -- ??? needed?
4986 Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
4987
4988 -- Inherit all inlining-related flags which apply to the generic in
4989 -- the subprogram and its declaration.
4990
4991 Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
4992 Set_Is_Inlined (Anon_Id, Is_Inlined (Gen_Unit));
4993
4994 Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
4995 Set_Has_Pragma_Inline (Anon_Id, Has_Pragma_Inline (Gen_Unit));
4996
4997 Set_Has_Pragma_Inline_Always
4998 (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
4999 Set_Has_Pragma_Inline_Always
5000 (Anon_Id, Has_Pragma_Inline_Always (Gen_Unit));
5001
5002 if not Is_Intrinsic_Subprogram (Gen_Unit) then
5003 Check_Elab_Instantiation (N);
5004 end if;
5005
5006 if Is_Dispatching_Operation (Act_Decl_Id)
5007 and then Ada_Version >= Ada_2005
5008 then
5009 declare
5010 Formal : Entity_Id;
5011
5012 begin
5013 Formal := First_Formal (Act_Decl_Id);
5014 while Present (Formal) loop
5015 if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
5016 and then Is_Controlling_Formal (Formal)
5017 and then not Can_Never_Be_Null (Formal)
5018 then
5019 Error_Msg_NE ("access parameter& is controlling,",
5020 N, Formal);
5021 Error_Msg_NE
5022 ("\corresponding parameter of & must be"
5023 & " explicitly null-excluding", N, Gen_Id);
5024 end if;
5025
5026 Next_Formal (Formal);
5027 end loop;
5028 end;
5029 end if;
5030
5031 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
5032
5033 Validate_Categorization_Dependency (N, Act_Decl_Id);
5034
5035 if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
5036 Inherit_Context (Gen_Decl, N);
5037
5038 Restore_Private_Views (Pack_Id, False);
5039
5040 -- If the context requires a full instantiation, mark node for
5041 -- subsequent construction of the body.
5042
5043 if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
5044 Check_Forward_Instantiation (Gen_Decl);
5045
5046 -- The wrapper package is always delayed, because it does not
5047 -- constitute a freeze point, but to insure that the freeze
5048 -- node is placed properly, it is created directly when
5049 -- instantiating the body (otherwise the freeze node might
5050 -- appear to early for nested instantiations).
5051
5052 elsif Nkind (Parent (N)) = N_Compilation_Unit then
5053
5054 -- For ASIS purposes, indicate that the wrapper package has
5055 -- replaced the instantiation node.
5056
5057 Rewrite (N, Unit (Parent (N)));
5058 Set_Unit (Parent (N), N);
5059 end if;
5060
5061 elsif Nkind (Parent (N)) = N_Compilation_Unit then
5062
5063 -- Replace instance node for library-level instantiations of
5064 -- intrinsic subprograms, for ASIS use.
5065
5066 Rewrite (N, Unit (Parent (N)));
5067 Set_Unit (Parent (N), N);
5068 end if;
5069
5070 if Parent_Installed then
5071 Remove_Parent;
5072 end if;
5073
5074 Restore_Hidden_Primitives (Vis_Prims_List);
5075 Restore_Env;
5076 Env_Installed := False;
5077 Generic_Renamings.Set_Last (0);
5078 Generic_Renamings_HTable.Reset;
5079 end if;
5080
5081 <<Leave>>
5082 if Has_Aspects (N) then
5083 Analyze_Aspect_Specifications (N, Act_Decl_Id);
5084 end if;
5085
5086 exception
5087 when Instantiation_Error =>
5088 if Parent_Installed then
5089 Remove_Parent;
5090 end if;
5091
5092 if Env_Installed then
5093 Restore_Env;
5094 end if;
5095 end Analyze_Subprogram_Instantiation;
5096
5097 -------------------------
5098 -- Get_Associated_Node --
5099 -------------------------
5100
5101 function Get_Associated_Node (N : Node_Id) return Node_Id is
5102 Assoc : Node_Id;
5103
5104 begin
5105 Assoc := Associated_Node (N);
5106
5107 if Nkind (Assoc) /= Nkind (N) then
5108 return Assoc;
5109
5110 elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
5111 return Assoc;
5112
5113 else
5114 -- If the node is part of an inner generic, it may itself have been
5115 -- remapped into a further generic copy. Associated_Node is otherwise
5116 -- used for the entity of the node, and will be of a different node
5117 -- kind, or else N has been rewritten as a literal or function call.
5118
5119 while Present (Associated_Node (Assoc))
5120 and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
5121 loop
5122 Assoc := Associated_Node (Assoc);
5123 end loop;
5124
5125 -- Follow and additional link in case the final node was rewritten.
5126 -- This can only happen with nested generic units.
5127
5128 if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
5129 and then Present (Associated_Node (Assoc))
5130 and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
5131 N_Explicit_Dereference,
5132 N_Integer_Literal,
5133 N_Real_Literal,
5134 N_String_Literal))
5135 then
5136 Assoc := Associated_Node (Assoc);
5137 end if;
5138
5139 -- An additional special case: an unconstrained type in an object
5140 -- declaration may have been rewritten as a local subtype constrained
5141 -- by the expression in the declaration. We need to recover the
5142 -- original entity which may be global.
5143
5144 if Present (Original_Node (Assoc))
5145 and then Nkind (Parent (N)) = N_Object_Declaration
5146 then
5147 Assoc := Original_Node (Assoc);
5148 end if;
5149
5150 return Assoc;
5151 end if;
5152 end Get_Associated_Node;
5153
5154 -------------------------------------------
5155 -- Build_Instance_Compilation_Unit_Nodes --
5156 -------------------------------------------
5157
5158 procedure Build_Instance_Compilation_Unit_Nodes
5159 (N : Node_Id;
5160 Act_Body : Node_Id;
5161 Act_Decl : Node_Id)
5162 is
5163 Decl_Cunit : Node_Id;
5164 Body_Cunit : Node_Id;
5165 Citem : Node_Id;
5166 New_Main : constant Entity_Id := Defining_Entity (Act_Decl);
5167 Old_Main : constant Entity_Id := Cunit_Entity (Main_Unit);
5168
5169 begin
5170 -- A new compilation unit node is built for the instance declaration
5171
5172 Decl_Cunit :=
5173 Make_Compilation_Unit (Sloc (N),
5174 Context_Items => Empty_List,
5175 Unit => Act_Decl,
5176 Aux_Decls_Node => Make_Compilation_Unit_Aux (Sloc (N)));
5177
5178 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
5179
5180 -- The new compilation unit is linked to its body, but both share the
5181 -- same file, so we do not set Body_Required on the new unit so as not
5182 -- to create a spurious dependency on a non-existent body in the ali.
5183 -- This simplifies CodePeer unit traversal.
5184
5185 -- We use the original instantiation compilation unit as the resulting
5186 -- compilation unit of the instance, since this is the main unit.
5187
5188 Rewrite (N, Act_Body);
5189
5190 -- Propagate the aspect specifications from the package body template to
5191 -- the instantiated version of the package body.
5192
5193 if Has_Aspects (Act_Body) then
5194 Set_Aspect_Specifications
5195 (N, New_Copy_List_Tree (Aspect_Specifications (Act_Body)));
5196 end if;
5197
5198 Body_Cunit := Parent (N);
5199
5200 -- The two compilation unit nodes are linked by the Library_Unit field
5201
5202 Set_Library_Unit (Decl_Cunit, Body_Cunit);
5203 Set_Library_Unit (Body_Cunit, Decl_Cunit);
5204
5205 -- Preserve the private nature of the package if needed
5206
5207 Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
5208
5209 -- If the instance is not the main unit, its context, categorization
5210 -- and elaboration entity are not relevant to the compilation.
5211
5212 if Body_Cunit /= Cunit (Main_Unit) then
5213 Make_Instance_Unit (Body_Cunit, In_Main => False);
5214 return;
5215 end if;
5216
5217 -- The context clause items on the instantiation, which are now attached
5218 -- to the body compilation unit (since the body overwrote the original
5219 -- instantiation node), semantically belong on the spec, so copy them
5220 -- there. It's harmless to leave them on the body as well. In fact one
5221 -- could argue that they belong in both places.
5222
5223 Citem := First (Context_Items (Body_Cunit));
5224 while Present (Citem) loop
5225 Append (New_Copy (Citem), Context_Items (Decl_Cunit));
5226 Next (Citem);
5227 end loop;
5228
5229 -- Propagate categorization flags on packages, so that they appear in
5230 -- the ali file for the spec of the unit.
5231
5232 if Ekind (New_Main) = E_Package then
5233 Set_Is_Pure (Old_Main, Is_Pure (New_Main));
5234 Set_Is_Preelaborated (Old_Main, Is_Preelaborated (New_Main));
5235 Set_Is_Remote_Types (Old_Main, Is_Remote_Types (New_Main));
5236 Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
5237 Set_Is_Remote_Call_Interface
5238 (Old_Main, Is_Remote_Call_Interface (New_Main));
5239 end if;
5240
5241 -- Make entry in Units table, so that binder can generate call to
5242 -- elaboration procedure for body, if any.
5243
5244 Make_Instance_Unit (Body_Cunit, In_Main => True);
5245 Main_Unit_Entity := New_Main;
5246 Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
5247
5248 -- Build elaboration entity, since the instance may certainly generate
5249 -- elaboration code requiring a flag for protection.
5250
5251 Build_Elaboration_Entity (Decl_Cunit, New_Main);
5252 end Build_Instance_Compilation_Unit_Nodes;
5253
5254 -----------------------------
5255 -- Check_Access_Definition --
5256 -----------------------------
5257
5258 procedure Check_Access_Definition (N : Node_Id) is
5259 begin
5260 pragma Assert
5261 (Ada_Version >= Ada_2005 and then Present (Access_Definition (N)));
5262 null;
5263 end Check_Access_Definition;
5264
5265 -----------------------------------
5266 -- Check_Formal_Package_Instance --
5267 -----------------------------------
5268
5269 -- If the formal has specific parameters, they must match those of the
5270 -- actual. Both of them are instances, and the renaming declarations for
5271 -- their formal parameters appear in the same order in both. The analyzed
5272 -- formal has been analyzed in the context of the current instance.
5273
5274 procedure Check_Formal_Package_Instance
5275 (Formal_Pack : Entity_Id;
5276 Actual_Pack : Entity_Id)
5277 is
5278 E1 : Entity_Id := First_Entity (Actual_Pack);
5279 E2 : Entity_Id := First_Entity (Formal_Pack);
5280
5281 Expr1 : Node_Id;
5282 Expr2 : Node_Id;
5283
5284 procedure Check_Mismatch (B : Boolean);
5285 -- Common error routine for mismatch between the parameters of the
5286 -- actual instance and those of the formal package.
5287
5288 function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
5289 -- The formal may come from a nested formal package, and the actual may
5290 -- have been constant-folded. To determine whether the two denote the
5291 -- same entity we may have to traverse several definitions to recover
5292 -- the ultimate entity that they refer to.
5293
5294 function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
5295 -- Similarly, if the formal comes from a nested formal package, the
5296 -- actual may designate the formal through multiple renamings, which
5297 -- have to be followed to determine the original variable in question.
5298
5299 --------------------
5300 -- Check_Mismatch --
5301 --------------------
5302
5303 procedure Check_Mismatch (B : Boolean) is
5304 Kind : constant Node_Kind := Nkind (Parent (E2));
5305
5306 begin
5307 if Kind = N_Formal_Type_Declaration then
5308 return;
5309
5310 elsif Nkind_In (Kind, N_Formal_Object_Declaration,
5311 N_Formal_Package_Declaration)
5312 or else Kind in N_Formal_Subprogram_Declaration
5313 then
5314 null;
5315
5316 elsif B then
5317 Error_Msg_NE
5318 ("actual for & in actual instance does not match formal",
5319 Parent (Actual_Pack), E1);
5320 end if;
5321 end Check_Mismatch;
5322
5323 --------------------------------
5324 -- Same_Instantiated_Constant --
5325 --------------------------------
5326
5327 function Same_Instantiated_Constant
5328 (E1, E2 : Entity_Id) return Boolean
5329 is
5330 Ent : Entity_Id;
5331
5332 begin
5333 Ent := E2;
5334 while Present (Ent) loop
5335 if E1 = Ent then
5336 return True;
5337
5338 elsif Ekind (Ent) /= E_Constant then
5339 return False;
5340
5341 elsif Is_Entity_Name (Constant_Value (Ent)) then
5342 if Entity (Constant_Value (Ent)) = E1 then
5343 return True;
5344 else
5345 Ent := Entity (Constant_Value (Ent));
5346 end if;
5347
5348 -- The actual may be a constant that has been folded. Recover
5349 -- original name.
5350
5351 elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5352 Ent := Entity (Original_Node (Constant_Value (Ent)));
5353 else
5354 return False;
5355 end if;
5356 end loop;
5357
5358 return False;
5359 end Same_Instantiated_Constant;
5360
5361 --------------------------------
5362 -- Same_Instantiated_Variable --
5363 --------------------------------
5364
5365 function Same_Instantiated_Variable
5366 (E1, E2 : Entity_Id) return Boolean
5367 is
5368 function Original_Entity (E : Entity_Id) return Entity_Id;
5369 -- Follow chain of renamings to the ultimate ancestor
5370
5371 ---------------------
5372 -- Original_Entity --
5373 ---------------------
5374
5375 function Original_Entity (E : Entity_Id) return Entity_Id is
5376 Orig : Entity_Id;
5377
5378 begin
5379 Orig := E;
5380 while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5381 and then Present (Renamed_Object (Orig))
5382 and then Is_Entity_Name (Renamed_Object (Orig))
5383 loop
5384 Orig := Entity (Renamed_Object (Orig));
5385 end loop;
5386
5387 return Orig;
5388 end Original_Entity;
5389
5390 -- Start of processing for Same_Instantiated_Variable
5391
5392 begin
5393 return Ekind (E1) = Ekind (E2)
5394 and then Original_Entity (E1) = Original_Entity (E2);
5395 end Same_Instantiated_Variable;
5396
5397 -- Start of processing for Check_Formal_Package_Instance
5398
5399 begin
5400 while Present (E1)
5401 and then Present (E2)
5402 loop
5403 exit when Ekind (E1) = E_Package
5404 and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5405
5406 -- If the formal is the renaming of the formal package, this
5407 -- is the end of its formal part, which may occur before the
5408 -- end of the formal part in the actual in the presence of
5409 -- defaulted parameters in the formal package.
5410
5411 exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5412 and then Renamed_Entity (E2) = Scope (E2);
5413
5414 -- The analysis of the actual may generate additional internal
5415 -- entities. If the formal is defaulted, there is no corresponding
5416 -- analysis and the internal entities must be skipped, until we
5417 -- find corresponding entities again.
5418
5419 if Comes_From_Source (E2)
5420 and then not Comes_From_Source (E1)
5421 and then Chars (E1) /= Chars (E2)
5422 then
5423 while Present (E1)
5424 and then Chars (E1) /= Chars (E2)
5425 loop
5426 Next_Entity (E1);
5427 end loop;
5428 end if;
5429
5430 if No (E1) then
5431 return;
5432
5433 -- If the formal entity comes from a formal declaration, it was
5434 -- defaulted in the formal package, and no check is needed on it.
5435
5436 elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
5437 goto Next_E;
5438
5439 -- Ditto for defaulted formal subprograms.
5440
5441 elsif Is_Overloadable (E1)
5442 and then Nkind (Unit_Declaration_Node (E2)) in
5443 N_Formal_Subprogram_Declaration
5444 then
5445 goto Next_E;
5446
5447 elsif Is_Type (E1) then
5448
5449 -- Subtypes must statically match. E1, E2 are the local entities
5450 -- that are subtypes of the actuals. Itypes generated for other
5451 -- parameters need not be checked, the check will be performed
5452 -- on the parameters themselves.
5453
5454 -- If E2 is a formal type declaration, it is a defaulted parameter
5455 -- and needs no checking.
5456
5457 if not Is_Itype (E1)
5458 and then not Is_Itype (E2)
5459 then
5460 Check_Mismatch
5461 (not Is_Type (E2)
5462 or else Etype (E1) /= Etype (E2)
5463 or else not Subtypes_Statically_Match (E1, E2));
5464 end if;
5465
5466 elsif Ekind (E1) = E_Constant then
5467
5468 -- IN parameters must denote the same static value, or the same
5469 -- constant, or the literal null.
5470
5471 Expr1 := Expression (Parent (E1));
5472
5473 if Ekind (E2) /= E_Constant then
5474 Check_Mismatch (True);
5475 goto Next_E;
5476 else
5477 Expr2 := Expression (Parent (E2));
5478 end if;
5479
5480 if Is_OK_Static_Expression (Expr1) then
5481 if not Is_OK_Static_Expression (Expr2) then
5482 Check_Mismatch (True);
5483
5484 elsif Is_Discrete_Type (Etype (E1)) then
5485 declare
5486 V1 : constant Uint := Expr_Value (Expr1);
5487 V2 : constant Uint := Expr_Value (Expr2);
5488 begin
5489 Check_Mismatch (V1 /= V2);
5490 end;
5491
5492 elsif Is_Real_Type (Etype (E1)) then
5493 declare
5494 V1 : constant Ureal := Expr_Value_R (Expr1);
5495 V2 : constant Ureal := Expr_Value_R (Expr2);
5496 begin
5497 Check_Mismatch (V1 /= V2);
5498 end;
5499
5500 elsif Is_String_Type (Etype (E1))
5501 and then Nkind (Expr1) = N_String_Literal
5502 then
5503 if Nkind (Expr2) /= N_String_Literal then
5504 Check_Mismatch (True);
5505 else
5506 Check_Mismatch
5507 (not String_Equal (Strval (Expr1), Strval (Expr2)));
5508 end if;
5509 end if;
5510
5511 elsif Is_Entity_Name (Expr1) then
5512 if Is_Entity_Name (Expr2) then
5513 if Entity (Expr1) = Entity (Expr2) then
5514 null;
5515 else
5516 Check_Mismatch
5517 (not Same_Instantiated_Constant
5518 (Entity (Expr1), Entity (Expr2)));
5519 end if;
5520 else
5521 Check_Mismatch (True);
5522 end if;
5523
5524 elsif Is_Entity_Name (Original_Node (Expr1))
5525 and then Is_Entity_Name (Expr2)
5526 and then
5527 Same_Instantiated_Constant
5528 (Entity (Original_Node (Expr1)), Entity (Expr2))
5529 then
5530 null;
5531
5532 elsif Nkind (Expr1) = N_Null then
5533 Check_Mismatch (Nkind (Expr1) /= N_Null);
5534
5535 else
5536 Check_Mismatch (True);
5537 end if;
5538
5539 elsif Ekind (E1) = E_Variable then
5540 Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5541
5542 elsif Ekind (E1) = E_Package then
5543 Check_Mismatch
5544 (Ekind (E1) /= Ekind (E2)
5545 or else Renamed_Object (E1) /= Renamed_Object (E2));
5546
5547 elsif Is_Overloadable (E1) then
5548
5549 -- Verify that the actual subprograms match. Note that actuals
5550 -- that are attributes are rewritten as subprograms. If the
5551 -- subprogram in the formal package is defaulted, no check is
5552 -- needed. Note that this can only happen in Ada 2005 when the
5553 -- formal package can be partially parameterized.
5554
5555 if Nkind (Unit_Declaration_Node (E1)) =
5556 N_Subprogram_Renaming_Declaration
5557 and then From_Default (Unit_Declaration_Node (E1))
5558 then
5559 null;
5560
5561 -- If the formal package has an "others" box association that
5562 -- covers this formal, there is no need for a check either.
5563
5564 elsif Nkind (Unit_Declaration_Node (E2)) in
5565 N_Formal_Subprogram_Declaration
5566 and then Box_Present (Unit_Declaration_Node (E2))
5567 then
5568 null;
5569
5570 -- No check needed if subprogram is a defaulted null procedure
5571
5572 elsif No (Alias (E2))
5573 and then Ekind (E2) = E_Procedure
5574 and then
5575 Null_Present (Specification (Unit_Declaration_Node (E2)))
5576 then
5577 null;
5578
5579 -- Otherwise the actual in the formal and the actual in the
5580 -- instantiation of the formal must match, up to renamings.
5581
5582 else
5583 Check_Mismatch
5584 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5585 end if;
5586
5587 else
5588 raise Program_Error;
5589 end if;
5590
5591 <<Next_E>>
5592 Next_Entity (E1);
5593 Next_Entity (E2);
5594 end loop;
5595 end Check_Formal_Package_Instance;
5596
5597 ---------------------------
5598 -- Check_Formal_Packages --
5599 ---------------------------
5600
5601 procedure Check_Formal_Packages (P_Id : Entity_Id) is
5602 E : Entity_Id;
5603 Formal_P : Entity_Id;
5604
5605 begin
5606 -- Iterate through the declarations in the instance, looking for package
5607 -- renaming declarations that denote instances of formal packages. Stop
5608 -- when we find the renaming of the current package itself. The
5609 -- declaration for a formal package without a box is followed by an
5610 -- internal entity that repeats the instantiation.
5611
5612 E := First_Entity (P_Id);
5613 while Present (E) loop
5614 if Ekind (E) = E_Package then
5615 if Renamed_Object (E) = P_Id then
5616 exit;
5617
5618 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5619 null;
5620
5621 elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5622 Formal_P := Next_Entity (E);
5623 Check_Formal_Package_Instance (Formal_P, E);
5624
5625 -- After checking, remove the internal validating package. It
5626 -- is only needed for semantic checks, and as it may contain
5627 -- generic formal declarations it should not reach gigi.
5628
5629 Remove (Unit_Declaration_Node (Formal_P));
5630 end if;
5631 end if;
5632
5633 Next_Entity (E);
5634 end loop;
5635 end Check_Formal_Packages;
5636
5637 ---------------------------------
5638 -- Check_Forward_Instantiation --
5639 ---------------------------------
5640
5641 procedure Check_Forward_Instantiation (Decl : Node_Id) is
5642 S : Entity_Id;
5643 Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5644
5645 begin
5646 -- The instantiation appears before the generic body if we are in the
5647 -- scope of the unit containing the generic, either in its spec or in
5648 -- the package body, and before the generic body.
5649
5650 if Ekind (Gen_Comp) = E_Package_Body then
5651 Gen_Comp := Spec_Entity (Gen_Comp);
5652 end if;
5653
5654 if In_Open_Scopes (Gen_Comp)
5655 and then No (Corresponding_Body (Decl))
5656 then
5657 S := Current_Scope;
5658
5659 while Present (S)
5660 and then not Is_Compilation_Unit (S)
5661 and then not Is_Child_Unit (S)
5662 loop
5663 if Ekind (S) = E_Package then
5664 Set_Has_Forward_Instantiation (S);
5665 end if;
5666
5667 S := Scope (S);
5668 end loop;
5669 end if;
5670 end Check_Forward_Instantiation;
5671
5672 ---------------------------
5673 -- Check_Generic_Actuals --
5674 ---------------------------
5675
5676 -- The visibility of the actuals may be different between the point of
5677 -- generic instantiation and the instantiation of the body.
5678
5679 procedure Check_Generic_Actuals
5680 (Instance : Entity_Id;
5681 Is_Formal_Box : Boolean)
5682 is
5683 E : Entity_Id;
5684 Astype : Entity_Id;
5685
5686 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5687 -- For a formal that is an array type, the component type is often a
5688 -- previous formal in the same unit. The privacy status of the component
5689 -- type will have been examined earlier in the traversal of the
5690 -- corresponding actuals, and this status should not be modified for
5691 -- the array (sub)type itself. However, if the base type of the array
5692 -- (sub)type is private, its full view must be restored in the body to
5693 -- be consistent with subsequent index subtypes, etc.
5694 --
5695 -- To detect this case we have to rescan the list of formals, which is
5696 -- usually short enough to ignore the resulting inefficiency.
5697
5698 -----------------------------
5699 -- Denotes_Previous_Actual --
5700 -----------------------------
5701
5702 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5703 Prev : Entity_Id;
5704
5705 begin
5706 Prev := First_Entity (Instance);
5707 while Present (Prev) loop
5708 if Is_Type (Prev)
5709 and then Nkind (Parent (Prev)) = N_Subtype_Declaration
5710 and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
5711 and then Entity (Subtype_Indication (Parent (Prev))) = Typ
5712 then
5713 return True;
5714
5715 elsif Prev = E then
5716 return False;
5717
5718 else
5719 Next_Entity (Prev);
5720 end if;
5721 end loop;
5722
5723 return False;
5724 end Denotes_Previous_Actual;
5725
5726 -- Start of processing for Check_Generic_Actuals
5727
5728 begin
5729 E := First_Entity (Instance);
5730 while Present (E) loop
5731 if Is_Type (E)
5732 and then Nkind (Parent (E)) = N_Subtype_Declaration
5733 and then Scope (Etype (E)) /= Instance
5734 and then Is_Entity_Name (Subtype_Indication (Parent (E)))
5735 then
5736 if Is_Array_Type (E)
5737 and then not Is_Private_Type (Etype (E))
5738 and then Denotes_Previous_Actual (Component_Type (E))
5739 then
5740 null;
5741 else
5742 Check_Private_View (Subtype_Indication (Parent (E)));
5743 end if;
5744
5745 Set_Is_Generic_Actual_Type (E, True);
5746 Set_Is_Hidden (E, False);
5747 Set_Is_Potentially_Use_Visible (E,
5748 In_Use (Instance));
5749
5750 -- We constructed the generic actual type as a subtype of the
5751 -- supplied type. This means that it normally would not inherit
5752 -- subtype specific attributes of the actual, which is wrong for
5753 -- the generic case.
5754
5755 Astype := Ancestor_Subtype (E);
5756
5757 if No (Astype) then
5758
5759 -- This can happen when E is an itype that is the full view of
5760 -- a private type completed, e.g. with a constrained array. In
5761 -- that case, use the first subtype, which will carry size
5762 -- information. The base type itself is unconstrained and will
5763 -- not carry it.
5764
5765 Astype := First_Subtype (E);
5766 end if;
5767
5768 Set_Size_Info (E, (Astype));
5769 Set_RM_Size (E, RM_Size (Astype));
5770 Set_First_Rep_Item (E, First_Rep_Item (Astype));
5771
5772 if Is_Discrete_Or_Fixed_Point_Type (E) then
5773 Set_RM_Size (E, RM_Size (Astype));
5774
5775 -- In nested instances, the base type of an access actual may
5776 -- itself be private, and need to be exchanged.
5777
5778 elsif Is_Access_Type (E)
5779 and then Is_Private_Type (Etype (E))
5780 then
5781 Check_Private_View
5782 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
5783 end if;
5784
5785 elsif Ekind (E) = E_Package then
5786
5787 -- If this is the renaming for the current instance, we're done.
5788 -- Otherwise it is a formal package. If the corresponding formal
5789 -- was declared with a box, the (instantiations of the) generic
5790 -- formal part are also visible. Otherwise, ignore the entity
5791 -- created to validate the actuals.
5792
5793 if Renamed_Object (E) = Instance then
5794 exit;
5795
5796 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5797 null;
5798
5799 -- The visibility of a formal of an enclosing generic is already
5800 -- correct.
5801
5802 elsif Denotes_Formal_Package (E) then
5803 null;
5804
5805 elsif Present (Associated_Formal_Package (E))
5806 and then not Is_Generic_Formal (E)
5807 then
5808 if Box_Present (Parent (Associated_Formal_Package (E))) then
5809 Check_Generic_Actuals (Renamed_Object (E), True);
5810
5811 else
5812 Check_Generic_Actuals (Renamed_Object (E), False);
5813 end if;
5814
5815 Set_Is_Hidden (E, False);
5816 end if;
5817
5818 -- If this is a subprogram instance (in a wrapper package) the
5819 -- actual is fully visible.
5820
5821 elsif Is_Wrapper_Package (Instance) then
5822 Set_Is_Hidden (E, False);
5823
5824 -- If the formal package is declared with a box, or if the formal
5825 -- parameter is defaulted, it is visible in the body.
5826
5827 elsif Is_Formal_Box
5828 or else Is_Visible_Formal (E)
5829 then
5830 Set_Is_Hidden (E, False);
5831 end if;
5832
5833 if Ekind (E) = E_Constant then
5834
5835 -- If the type of the actual is a private type declared in the
5836 -- enclosing scope of the generic unit, the body of the generic
5837 -- sees the full view of the type (because it has to appear in
5838 -- the corresponding package body). If the type is private now,
5839 -- exchange views to restore the proper visiblity in the instance.
5840
5841 declare
5842 Typ : constant Entity_Id := Base_Type (Etype (E));
5843 -- The type of the actual
5844
5845 Gen_Id : Entity_Id;
5846 -- The generic unit
5847
5848 Parent_Scope : Entity_Id;
5849 -- The enclosing scope of the generic unit
5850
5851 begin
5852 if Is_Wrapper_Package (Instance) then
5853 Gen_Id :=
5854 Generic_Parent
5855 (Specification
5856 (Unit_Declaration_Node
5857 (Related_Instance (Instance))));
5858 else
5859 Gen_Id :=
5860 Generic_Parent (Package_Specification (Instance));
5861 end if;
5862
5863 Parent_Scope := Scope (Gen_Id);
5864
5865 -- The exchange is only needed if the generic is defined
5866 -- within a package which is not a common ancestor of the
5867 -- scope of the instance, and is not already in scope.
5868
5869 if Is_Private_Type (Typ)
5870 and then Scope (Typ) = Parent_Scope
5871 and then Scope (Instance) /= Parent_Scope
5872 and then Ekind (Parent_Scope) = E_Package
5873 and then not Is_Child_Unit (Gen_Id)
5874 then
5875 Switch_View (Typ);
5876
5877 -- If the type of the entity is a subtype, it may also have
5878 -- to be made visible, together with the base type of its
5879 -- full view, after exchange.
5880
5881 if Is_Private_Type (Etype (E)) then
5882 Switch_View (Etype (E));
5883 Switch_View (Base_Type (Etype (E)));
5884 end if;
5885 end if;
5886 end;
5887 end if;
5888
5889 Next_Entity (E);
5890 end loop;
5891 end Check_Generic_Actuals;
5892
5893 ------------------------------
5894 -- Check_Generic_Child_Unit --
5895 ------------------------------
5896
5897 procedure Check_Generic_Child_Unit
5898 (Gen_Id : Node_Id;
5899 Parent_Installed : in out Boolean)
5900 is
5901 Loc : constant Source_Ptr := Sloc (Gen_Id);
5902 Gen_Par : Entity_Id := Empty;
5903 E : Entity_Id;
5904 Inst_Par : Entity_Id;
5905 S : Node_Id;
5906
5907 function Find_Generic_Child
5908 (Scop : Entity_Id;
5909 Id : Node_Id) return Entity_Id;
5910 -- Search generic parent for possible child unit with the given name
5911
5912 function In_Enclosing_Instance return Boolean;
5913 -- Within an instance of the parent, the child unit may be denoted by
5914 -- a simple name, or an abbreviated expanded name. Examine enclosing
5915 -- scopes to locate a possible parent instantiation.
5916
5917 ------------------------
5918 -- Find_Generic_Child --
5919 ------------------------
5920
5921 function Find_Generic_Child
5922 (Scop : Entity_Id;
5923 Id : Node_Id) return Entity_Id
5924 is
5925 E : Entity_Id;
5926
5927 begin
5928 -- If entity of name is already set, instance has already been
5929 -- resolved, e.g. in an enclosing instantiation.
5930
5931 if Present (Entity (Id)) then
5932 if Scope (Entity (Id)) = Scop then
5933 return Entity (Id);
5934 else
5935 return Empty;
5936 end if;
5937
5938 else
5939 E := First_Entity (Scop);
5940 while Present (E) loop
5941 if Chars (E) = Chars (Id)
5942 and then Is_Child_Unit (E)
5943 then
5944 if Is_Child_Unit (E)
5945 and then not Is_Visible_Lib_Unit (E)
5946 then
5947 Error_Msg_NE
5948 ("generic child unit& is not visible", Gen_Id, E);
5949 end if;
5950
5951 Set_Entity (Id, E);
5952 return E;
5953 end if;
5954
5955 Next_Entity (E);
5956 end loop;
5957
5958 return Empty;
5959 end if;
5960 end Find_Generic_Child;
5961
5962 ---------------------------
5963 -- In_Enclosing_Instance --
5964 ---------------------------
5965
5966 function In_Enclosing_Instance return Boolean is
5967 Enclosing_Instance : Node_Id;
5968 Instance_Decl : Node_Id;
5969
5970 begin
5971 -- We do not inline any call that contains instantiations, except
5972 -- for instantiations of Unchecked_Conversion, so if we are within
5973 -- an inlined body the current instance does not require parents.
5974
5975 if In_Inlined_Body then
5976 pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
5977 return False;
5978 end if;
5979
5980 -- Loop to check enclosing scopes
5981
5982 Enclosing_Instance := Current_Scope;
5983 while Present (Enclosing_Instance) loop
5984 Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
5985
5986 if Ekind (Enclosing_Instance) = E_Package
5987 and then Is_Generic_Instance (Enclosing_Instance)
5988 and then Present
5989 (Generic_Parent (Specification (Instance_Decl)))
5990 then
5991 -- Check whether the generic we are looking for is a child of
5992 -- this instance.
5993
5994 E := Find_Generic_Child
5995 (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
5996 exit when Present (E);
5997
5998 else
5999 E := Empty;
6000 end if;
6001
6002 Enclosing_Instance := Scope (Enclosing_Instance);
6003 end loop;
6004
6005 if No (E) then
6006
6007 -- Not a child unit
6008
6009 Analyze (Gen_Id);
6010 return False;
6011
6012 else
6013 Rewrite (Gen_Id,
6014 Make_Expanded_Name (Loc,
6015 Chars => Chars (E),
6016 Prefix => New_Occurrence_Of (Enclosing_Instance, Loc),
6017 Selector_Name => New_Occurrence_Of (E, Loc)));
6018
6019 Set_Entity (Gen_Id, E);
6020 Set_Etype (Gen_Id, Etype (E));
6021 Parent_Installed := False; -- Already in scope.
6022 return True;
6023 end if;
6024 end In_Enclosing_Instance;
6025
6026 -- Start of processing for Check_Generic_Child_Unit
6027
6028 begin
6029 -- If the name of the generic is given by a selected component, it may
6030 -- be the name of a generic child unit, and the prefix is the name of an
6031 -- instance of the parent, in which case the child unit must be visible.
6032 -- If this instance is not in scope, it must be placed there and removed
6033 -- after instantiation, because what is being instantiated is not the
6034 -- original child, but the corresponding child present in the instance
6035 -- of the parent.
6036
6037 -- If the child is instantiated within the parent, it can be given by
6038 -- a simple name. In this case the instance is already in scope, but
6039 -- the child generic must be recovered from the generic parent as well.
6040
6041 if Nkind (Gen_Id) = N_Selected_Component then
6042 S := Selector_Name (Gen_Id);
6043 Analyze (Prefix (Gen_Id));
6044 Inst_Par := Entity (Prefix (Gen_Id));
6045
6046 if Ekind (Inst_Par) = E_Package
6047 and then Present (Renamed_Object (Inst_Par))
6048 then
6049 Inst_Par := Renamed_Object (Inst_Par);
6050 end if;
6051
6052 if Ekind (Inst_Par) = E_Package then
6053 if Nkind (Parent (Inst_Par)) = N_Package_Specification then
6054 Gen_Par := Generic_Parent (Parent (Inst_Par));
6055
6056 elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
6057 and then
6058 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
6059 then
6060 Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
6061 end if;
6062
6063 elsif Ekind (Inst_Par) = E_Generic_Package
6064 and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
6065 then
6066 -- A formal package may be a real child package, and not the
6067 -- implicit instance within a parent. In this case the child is
6068 -- not visible and has to be retrieved explicitly as well.
6069
6070 Gen_Par := Inst_Par;
6071 end if;
6072
6073 if Present (Gen_Par) then
6074
6075 -- The prefix denotes an instantiation. The entity itself may be a
6076 -- nested generic, or a child unit.
6077
6078 E := Find_Generic_Child (Gen_Par, S);
6079
6080 if Present (E) then
6081 Change_Selected_Component_To_Expanded_Name (Gen_Id);
6082 Set_Entity (Gen_Id, E);
6083 Set_Etype (Gen_Id, Etype (E));
6084 Set_Entity (S, E);
6085 Set_Etype (S, Etype (E));
6086
6087 -- Indicate that this is a reference to the parent
6088
6089 if In_Extended_Main_Source_Unit (Gen_Id) then
6090 Set_Is_Instantiated (Inst_Par);
6091 end if;
6092
6093 -- A common mistake is to replicate the naming scheme of a
6094 -- hierarchy by instantiating a generic child directly, rather
6095 -- than the implicit child in a parent instance:
6096
6097 -- generic .. package Gpar is ..
6098 -- generic .. package Gpar.Child is ..
6099 -- package Par is new Gpar ();
6100
6101 -- with Gpar.Child;
6102 -- package Par.Child is new Gpar.Child ();
6103 -- rather than Par.Child
6104
6105 -- In this case the instantiation is within Par, which is an
6106 -- instance, but Gpar does not denote Par because we are not IN
6107 -- the instance of Gpar, so this is illegal. The test below
6108 -- recognizes this particular case.
6109
6110 if Is_Child_Unit (E)
6111 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
6112 and then (not In_Instance
6113 or else Nkind (Parent (Parent (Gen_Id))) =
6114 N_Compilation_Unit)
6115 then
6116 Error_Msg_N
6117 ("prefix of generic child unit must be instance of parent",
6118 Gen_Id);
6119 end if;
6120
6121 if not In_Open_Scopes (Inst_Par)
6122 and then Nkind (Parent (Gen_Id)) not in
6123 N_Generic_Renaming_Declaration
6124 then
6125 Install_Parent (Inst_Par);
6126 Parent_Installed := True;
6127
6128 elsif In_Open_Scopes (Inst_Par) then
6129
6130 -- If the parent is already installed, install the actuals
6131 -- for its formal packages. This is necessary when the child
6132 -- instance is a child of the parent instance: in this case,
6133 -- the parent is placed on the scope stack but the formal
6134 -- packages are not made visible.
6135
6136 Install_Formal_Packages (Inst_Par);
6137 end if;
6138
6139 else
6140 -- If the generic parent does not contain an entity that
6141 -- corresponds to the selector, the instance doesn't either.
6142 -- Analyzing the node will yield the appropriate error message.
6143 -- If the entity is not a child unit, then it is an inner
6144 -- generic in the parent.
6145
6146 Analyze (Gen_Id);
6147 end if;
6148
6149 else
6150 Analyze (Gen_Id);
6151
6152 if Is_Child_Unit (Entity (Gen_Id))
6153 and then
6154 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6155 and then not In_Open_Scopes (Inst_Par)
6156 then
6157 Install_Parent (Inst_Par);
6158 Parent_Installed := True;
6159
6160 -- The generic unit may be the renaming of the implicit child
6161 -- present in an instance. In that case the parent instance is
6162 -- obtained from the name of the renamed entity.
6163
6164 elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
6165 and then Present (Renamed_Entity (Entity (Gen_Id)))
6166 and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
6167 then
6168 declare
6169 Renamed_Package : constant Node_Id :=
6170 Name (Parent (Entity (Gen_Id)));
6171 begin
6172 if Nkind (Renamed_Package) = N_Expanded_Name then
6173 Inst_Par := Entity (Prefix (Renamed_Package));
6174 Install_Parent (Inst_Par);
6175 Parent_Installed := True;
6176 end if;
6177 end;
6178 end if;
6179 end if;
6180
6181 elsif Nkind (Gen_Id) = N_Expanded_Name then
6182
6183 -- Entity already present, analyze prefix, whose meaning may be
6184 -- an instance in the current context. If it is an instance of
6185 -- a relative within another, the proper parent may still have
6186 -- to be installed, if they are not of the same generation.
6187
6188 Analyze (Prefix (Gen_Id));
6189
6190 -- In the unlikely case that a local declaration hides the name
6191 -- of the parent package, locate it on the homonym chain. If the
6192 -- context is an instance of the parent, the renaming entity is
6193 -- flagged as such.
6194
6195 Inst_Par := Entity (Prefix (Gen_Id));
6196 while Present (Inst_Par)
6197 and then not Is_Package_Or_Generic_Package (Inst_Par)
6198 loop
6199 Inst_Par := Homonym (Inst_Par);
6200 end loop;
6201
6202 pragma Assert (Present (Inst_Par));
6203 Set_Entity (Prefix (Gen_Id), Inst_Par);
6204
6205 if In_Enclosing_Instance then
6206 null;
6207
6208 elsif Present (Entity (Gen_Id))
6209 and then Is_Child_Unit (Entity (Gen_Id))
6210 and then not In_Open_Scopes (Inst_Par)
6211 then
6212 Install_Parent (Inst_Par);
6213 Parent_Installed := True;
6214 end if;
6215
6216 elsif In_Enclosing_Instance then
6217
6218 -- The child unit is found in some enclosing scope
6219
6220 null;
6221
6222 else
6223 Analyze (Gen_Id);
6224
6225 -- If this is the renaming of the implicit child in a parent
6226 -- instance, recover the parent name and install it.
6227
6228 if Is_Entity_Name (Gen_Id) then
6229 E := Entity (Gen_Id);
6230
6231 if Is_Generic_Unit (E)
6232 and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
6233 and then Is_Child_Unit (Renamed_Object (E))
6234 and then Is_Generic_Unit (Scope (Renamed_Object (E)))
6235 and then Nkind (Name (Parent (E))) = N_Expanded_Name
6236 then
6237 Rewrite (Gen_Id,
6238 New_Copy_Tree (Name (Parent (E))));
6239 Inst_Par := Entity (Prefix (Gen_Id));
6240
6241 if not In_Open_Scopes (Inst_Par) then
6242 Install_Parent (Inst_Par);
6243 Parent_Installed := True;
6244 end if;
6245
6246 -- If it is a child unit of a non-generic parent, it may be
6247 -- use-visible and given by a direct name. Install parent as
6248 -- for other cases.
6249
6250 elsif Is_Generic_Unit (E)
6251 and then Is_Child_Unit (E)
6252 and then
6253 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6254 and then not Is_Generic_Unit (Scope (E))
6255 then
6256 if not In_Open_Scopes (Scope (E)) then
6257 Install_Parent (Scope (E));
6258 Parent_Installed := True;
6259 end if;
6260 end if;
6261 end if;
6262 end if;
6263 end Check_Generic_Child_Unit;
6264
6265 -----------------------------
6266 -- Check_Hidden_Child_Unit --
6267 -----------------------------
6268
6269 procedure Check_Hidden_Child_Unit
6270 (N : Node_Id;
6271 Gen_Unit : Entity_Id;
6272 Act_Decl_Id : Entity_Id)
6273 is
6274 Gen_Id : constant Node_Id := Name (N);
6275
6276 begin
6277 if Is_Child_Unit (Gen_Unit)
6278 and then Is_Child_Unit (Act_Decl_Id)
6279 and then Nkind (Gen_Id) = N_Expanded_Name
6280 and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
6281 and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
6282 then
6283 Error_Msg_Node_2 := Scope (Act_Decl_Id);
6284 Error_Msg_NE
6285 ("generic unit & is implicitly declared in &",
6286 Defining_Unit_Name (N), Gen_Unit);
6287 Error_Msg_N ("\instance must have different name",
6288 Defining_Unit_Name (N));
6289 end if;
6290 end Check_Hidden_Child_Unit;
6291
6292 ------------------------
6293 -- Check_Private_View --
6294 ------------------------
6295
6296 procedure Check_Private_View (N : Node_Id) is
6297 T : constant Entity_Id := Etype (N);
6298 BT : Entity_Id;
6299
6300 begin
6301 -- Exchange views if the type was not private in the generic but is
6302 -- private at the point of instantiation. Do not exchange views if
6303 -- the scope of the type is in scope. This can happen if both generic
6304 -- and instance are sibling units, or if type is defined in a parent.
6305 -- In this case the visibility of the type will be correct for all
6306 -- semantic checks.
6307
6308 if Present (T) then
6309 BT := Base_Type (T);
6310
6311 if Is_Private_Type (T)
6312 and then not Has_Private_View (N)
6313 and then Present (Full_View (T))
6314 and then not In_Open_Scopes (Scope (T))
6315 then
6316 -- In the generic, the full type was visible. Save the private
6317 -- entity, for subsequent exchange.
6318
6319 Switch_View (T);
6320
6321 elsif Has_Private_View (N)
6322 and then not Is_Private_Type (T)
6323 and then not Has_Been_Exchanged (T)
6324 and then Etype (Get_Associated_Node (N)) /= T
6325 then
6326 -- Only the private declaration was visible in the generic. If
6327 -- the type appears in a subtype declaration, the subtype in the
6328 -- instance must have a view compatible with that of its parent,
6329 -- which must be exchanged (see corresponding code in Restore_
6330 -- Private_Views). Otherwise, if the type is defined in a parent
6331 -- unit, leave full visibility within instance, which is safe.
6332
6333 if In_Open_Scopes (Scope (Base_Type (T)))
6334 and then not Is_Private_Type (Base_Type (T))
6335 and then Comes_From_Source (Base_Type (T))
6336 then
6337 null;
6338
6339 elsif Nkind (Parent (N)) = N_Subtype_Declaration
6340 or else not In_Private_Part (Scope (Base_Type (T)))
6341 then
6342 Prepend_Elmt (T, Exchanged_Views);
6343 Exchange_Declarations (Etype (Get_Associated_Node (N)));
6344 end if;
6345
6346 -- For composite types with inconsistent representation exchange
6347 -- component types accordingly.
6348
6349 elsif Is_Access_Type (T)
6350 and then Is_Private_Type (Designated_Type (T))
6351 and then not Has_Private_View (N)
6352 and then Present (Full_View (Designated_Type (T)))
6353 then
6354 Switch_View (Designated_Type (T));
6355
6356 elsif Is_Array_Type (T) then
6357 if Is_Private_Type (Component_Type (T))
6358 and then not Has_Private_View (N)
6359 and then Present (Full_View (Component_Type (T)))
6360 then
6361 Switch_View (Component_Type (T));
6362 end if;
6363
6364 -- The normal exchange mechanism relies on the setting of a
6365 -- flag on the reference in the generic. However, an additional
6366 -- mechanism is needed for types that are not explicitly
6367 -- mentioned in the generic, but may be needed in expanded code
6368 -- in the instance. This includes component types of arrays and
6369 -- designated types of access types. This processing must also
6370 -- include the index types of arrays which we take care of here.
6371
6372 declare
6373 Indx : Node_Id;
6374 Typ : Entity_Id;
6375
6376 begin
6377 Indx := First_Index (T);
6378 while Present (Indx) loop
6379 Typ := Base_Type (Etype (Indx));
6380
6381 if Is_Private_Type (Typ)
6382 and then Present (Full_View (Typ))
6383 then
6384 Switch_View (Typ);
6385 end if;
6386
6387 Next_Index (Indx);
6388 end loop;
6389 end;
6390
6391 elsif Is_Private_Type (T)
6392 and then Present (Full_View (T))
6393 and then Is_Array_Type (Full_View (T))
6394 and then Is_Private_Type (Component_Type (Full_View (T)))
6395 then
6396 Switch_View (T);
6397
6398 -- Finally, a non-private subtype may have a private base type, which
6399 -- must be exchanged for consistency. This can happen when a package
6400 -- body is instantiated, when the scope stack is empty but in fact
6401 -- the subtype and the base type are declared in an enclosing scope.
6402
6403 -- Note that in this case we introduce an inconsistency in the view
6404 -- set, because we switch the base type BT, but there could be some
6405 -- private dependent subtypes of BT which remain unswitched. Such
6406 -- subtypes might need to be switched at a later point (see specific
6407 -- provision for that case in Switch_View).
6408
6409 elsif not Is_Private_Type (T)
6410 and then not Has_Private_View (N)
6411 and then Is_Private_Type (BT)
6412 and then Present (Full_View (BT))
6413 and then not Is_Generic_Type (BT)
6414 and then not In_Open_Scopes (BT)
6415 then
6416 Prepend_Elmt (Full_View (BT), Exchanged_Views);
6417 Exchange_Declarations (BT);
6418 end if;
6419 end if;
6420 end Check_Private_View;
6421
6422 -----------------------------
6423 -- Check_Hidden_Primitives --
6424 -----------------------------
6425
6426 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6427 Actual : Node_Id;
6428 Gen_T : Entity_Id;
6429 Result : Elist_Id := No_Elist;
6430
6431 begin
6432 if No (Assoc_List) then
6433 return No_Elist;
6434 end if;
6435
6436 -- Traverse the list of associations between formals and actuals
6437 -- searching for renamings of tagged types
6438
6439 Actual := First (Assoc_List);
6440 while Present (Actual) loop
6441 if Nkind (Actual) = N_Subtype_Declaration then
6442 Gen_T := Generic_Parent_Type (Actual);
6443
6444 if Present (Gen_T)
6445 and then Is_Tagged_Type (Gen_T)
6446 then
6447 -- Traverse the list of primitives of the actual types
6448 -- searching for hidden primitives that are visible in the
6449 -- corresponding generic formal; leave them visible and
6450 -- append them to Result to restore their decoration later.
6451
6452 Install_Hidden_Primitives
6453 (Prims_List => Result,
6454 Gen_T => Gen_T,
6455 Act_T => Entity (Subtype_Indication (Actual)));
6456 end if;
6457 end if;
6458
6459 Next (Actual);
6460 end loop;
6461
6462 return Result;
6463 end Check_Hidden_Primitives;
6464
6465 --------------------------
6466 -- Contains_Instance_Of --
6467 --------------------------
6468
6469 function Contains_Instance_Of
6470 (Inner : Entity_Id;
6471 Outer : Entity_Id;
6472 N : Node_Id) return Boolean
6473 is
6474 Elmt : Elmt_Id;
6475 Scop : Entity_Id;
6476
6477 begin
6478 Scop := Outer;
6479
6480 -- Verify that there are no circular instantiations. We check whether
6481 -- the unit contains an instance of the current scope or some enclosing
6482 -- scope (in case one of the instances appears in a subunit). Longer
6483 -- circularities involving subunits might seem too pathological to
6484 -- consider, but they were not too pathological for the authors of
6485 -- DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6486 -- enclosing generic scopes as containing an instance.
6487
6488 loop
6489 -- Within a generic subprogram body, the scope is not generic, to
6490 -- allow for recursive subprograms. Use the declaration to determine
6491 -- whether this is a generic unit.
6492
6493 if Ekind (Scop) = E_Generic_Package
6494 or else (Is_Subprogram (Scop)
6495 and then Nkind (Unit_Declaration_Node (Scop)) =
6496 N_Generic_Subprogram_Declaration)
6497 then
6498 Elmt := First_Elmt (Inner_Instances (Inner));
6499
6500 while Present (Elmt) loop
6501 if Node (Elmt) = Scop then
6502 Error_Msg_Node_2 := Inner;
6503 Error_Msg_NE
6504 ("circular Instantiation: & instantiated within &!",
6505 N, Scop);
6506 return True;
6507
6508 elsif Node (Elmt) = Inner then
6509 return True;
6510
6511 elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6512 Error_Msg_Node_2 := Inner;
6513 Error_Msg_NE
6514 ("circular Instantiation: & instantiated within &!",
6515 N, Node (Elmt));
6516 return True;
6517 end if;
6518
6519 Next_Elmt (Elmt);
6520 end loop;
6521
6522 -- Indicate that Inner is being instantiated within Scop
6523
6524 Append_Elmt (Inner, Inner_Instances (Scop));
6525 end if;
6526
6527 if Scop = Standard_Standard then
6528 exit;
6529 else
6530 Scop := Scope (Scop);
6531 end if;
6532 end loop;
6533
6534 return False;
6535 end Contains_Instance_Of;
6536
6537 -----------------------
6538 -- Copy_Generic_Node --
6539 -----------------------
6540
6541 function Copy_Generic_Node
6542 (N : Node_Id;
6543 Parent_Id : Node_Id;
6544 Instantiating : Boolean) return Node_Id
6545 is
6546 Ent : Entity_Id;
6547 New_N : Node_Id;
6548
6549 function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6550 -- Check the given value of one of the Fields referenced by the current
6551 -- node to determine whether to copy it recursively. The field may hold
6552 -- a Node_Id, a List_Id, or an Elist_Id, or a plain value (Sloc, Uint,
6553 -- Char) in which case it need not be copied.
6554
6555 procedure Copy_Descendants;
6556 -- Common utility for various nodes
6557
6558 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6559 -- Make copy of element list
6560
6561 function Copy_Generic_List
6562 (L : List_Id;
6563 Parent_Id : Node_Id) return List_Id;
6564 -- Apply Copy_Node recursively to the members of a node list
6565
6566 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6567 -- True if an identifier is part of the defining program unit name of
6568 -- a child unit. The entity of such an identifier must be kept (for
6569 -- ASIS use) even though as the name of an enclosing generic it would
6570 -- otherwise not be preserved in the generic tree.
6571
6572 ----------------------
6573 -- Copy_Descendants --
6574 ----------------------
6575
6576 procedure Copy_Descendants is
6577
6578 use Atree.Unchecked_Access;
6579 -- This code section is part of the implementation of an untyped
6580 -- tree traversal, so it needs direct access to node fields.
6581
6582 begin
6583 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6584 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6585 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6586 Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6587 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6588 end Copy_Descendants;
6589
6590 -----------------------------
6591 -- Copy_Generic_Descendant --
6592 -----------------------------
6593
6594 function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6595 begin
6596 if D = Union_Id (Empty) then
6597 return D;
6598
6599 elsif D in Node_Range then
6600 return Union_Id
6601 (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6602
6603 elsif D in List_Range then
6604 return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6605
6606 elsif D in Elist_Range then
6607 return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6608
6609 -- Nothing else is copyable (e.g. Uint values), return as is
6610
6611 else
6612 return D;
6613 end if;
6614 end Copy_Generic_Descendant;
6615
6616 ------------------------
6617 -- Copy_Generic_Elist --
6618 ------------------------
6619
6620 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6621 M : Elmt_Id;
6622 L : Elist_Id;
6623
6624 begin
6625 if Present (E) then
6626 L := New_Elmt_List;
6627 M := First_Elmt (E);
6628 while Present (M) loop
6629 Append_Elmt
6630 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6631 Next_Elmt (M);
6632 end loop;
6633
6634 return L;
6635
6636 else
6637 return No_Elist;
6638 end if;
6639 end Copy_Generic_Elist;
6640
6641 -----------------------
6642 -- Copy_Generic_List --
6643 -----------------------
6644
6645 function Copy_Generic_List
6646 (L : List_Id;
6647 Parent_Id : Node_Id) return List_Id
6648 is
6649 N : Node_Id;
6650 New_L : List_Id;
6651
6652 begin
6653 if Present (L) then
6654 New_L := New_List;
6655 Set_Parent (New_L, Parent_Id);
6656
6657 N := First (L);
6658 while Present (N) loop
6659 Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6660 Next (N);
6661 end loop;
6662
6663 return New_L;
6664
6665 else
6666 return No_List;
6667 end if;
6668 end Copy_Generic_List;
6669
6670 ---------------------------
6671 -- In_Defining_Unit_Name --
6672 ---------------------------
6673
6674 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6675 begin
6676 return Present (Parent (Nam))
6677 and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6678 or else
6679 (Nkind (Parent (Nam)) = N_Expanded_Name
6680 and then In_Defining_Unit_Name (Parent (Nam))));
6681 end In_Defining_Unit_Name;
6682
6683 -- Start of processing for Copy_Generic_Node
6684
6685 begin
6686 if N = Empty then
6687 return N;
6688 end if;
6689
6690 New_N := New_Copy (N);
6691
6692 -- Copy aspects if present
6693
6694 if Has_Aspects (N) then
6695 Set_Has_Aspects (New_N, False);
6696 Set_Aspect_Specifications
6697 (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6698 end if;
6699
6700 if Instantiating then
6701 Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6702 end if;
6703
6704 if not Is_List_Member (N) then
6705 Set_Parent (New_N, Parent_Id);
6706 end if;
6707
6708 -- If defining identifier, then all fields have been copied already
6709
6710 if Nkind (New_N) in N_Entity then
6711 null;
6712
6713 -- Special casing for identifiers and other entity names and operators
6714
6715 elsif Nkind_In (New_N, N_Identifier,
6716 N_Character_Literal,
6717 N_Expanded_Name,
6718 N_Operator_Symbol)
6719 or else Nkind (New_N) in N_Op
6720 then
6721 if not Instantiating then
6722
6723 -- Link both nodes in order to assign subsequently the entity of
6724 -- the copy to the original node, in case this is a global
6725 -- reference.
6726
6727 Set_Associated_Node (N, New_N);
6728
6729 -- If we are within an instantiation, this is a nested generic
6730 -- that has already been analyzed at the point of definition.
6731 -- We must preserve references that were global to the enclosing
6732 -- parent at that point. Other occurrences, whether global or
6733 -- local to the current generic, must be resolved anew, so we
6734 -- reset the entity in the generic copy. A global reference has a
6735 -- smaller depth than the parent, or else the same depth in case
6736 -- both are distinct compilation units.
6737
6738 -- A child unit is implicitly declared within the enclosing parent
6739 -- but is in fact global to it, and must be preserved.
6740
6741 -- It is also possible for Current_Instantiated_Parent to be
6742 -- defined, and for this not to be a nested generic, namely if
6743 -- the unit is loaded through Rtsfind. In that case, the entity of
6744 -- New_N is only a link to the associated node, and not a defining
6745 -- occurrence.
6746
6747 -- The entities for parent units in the defining_program_unit of a
6748 -- generic child unit are established when the context of the unit
6749 -- is first analyzed, before the generic copy is made. They are
6750 -- preserved in the copy for use in ASIS queries.
6751
6752 Ent := Entity (New_N);
6753
6754 if No (Current_Instantiated_Parent.Gen_Id) then
6755 if No (Ent)
6756 or else Nkind (Ent) /= N_Defining_Identifier
6757 or else not In_Defining_Unit_Name (N)
6758 then
6759 Set_Associated_Node (New_N, Empty);
6760 end if;
6761
6762 elsif No (Ent)
6763 or else
6764 not Nkind_In (Ent, N_Defining_Identifier,
6765 N_Defining_Character_Literal,
6766 N_Defining_Operator_Symbol)
6767 or else No (Scope (Ent))
6768 or else
6769 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
6770 and then not Is_Child_Unit (Ent))
6771 or else
6772 (Scope_Depth (Scope (Ent)) >
6773 Scope_Depth (Current_Instantiated_Parent.Gen_Id)
6774 and then
6775 Get_Source_Unit (Ent) =
6776 Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
6777 then
6778 Set_Associated_Node (New_N, Empty);
6779 end if;
6780
6781 -- Case of instantiating identifier or some other name or operator
6782
6783 else
6784 -- If the associated node is still defined, the entity in it
6785 -- is global, and must be copied to the instance. If this copy
6786 -- is being made for a body to inline, it is applied to an
6787 -- instantiated tree, and the entity is already present and
6788 -- must be also preserved.
6789
6790 declare
6791 Assoc : constant Node_Id := Get_Associated_Node (N);
6792
6793 begin
6794 if Present (Assoc) then
6795 if Nkind (Assoc) = Nkind (N) then
6796 Set_Entity (New_N, Entity (Assoc));
6797 Check_Private_View (N);
6798
6799 -- The name in the call may be a selected component if the
6800 -- call has not been analyzed yet, as may be the case for
6801 -- pre/post conditions in a generic unit.
6802
6803 elsif Nkind (Assoc) = N_Function_Call
6804 and then Is_Entity_Name (Name (Assoc))
6805 then
6806 Set_Entity (New_N, Entity (Name (Assoc)));
6807
6808 elsif Nkind_In (Assoc, N_Defining_Identifier,
6809 N_Defining_Character_Literal,
6810 N_Defining_Operator_Symbol)
6811 and then Expander_Active
6812 then
6813 -- Inlining case: we are copying a tree that contains
6814 -- global entities, which are preserved in the copy to be
6815 -- used for subsequent inlining.
6816
6817 null;
6818
6819 else
6820 Set_Entity (New_N, Empty);
6821 end if;
6822 end if;
6823 end;
6824 end if;
6825
6826 -- For expanded name, we must copy the Prefix and Selector_Name
6827
6828 if Nkind (N) = N_Expanded_Name then
6829 Set_Prefix
6830 (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
6831
6832 Set_Selector_Name (New_N,
6833 Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
6834
6835 -- For operators, we must copy the right operand
6836
6837 elsif Nkind (N) in N_Op then
6838 Set_Right_Opnd (New_N,
6839 Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
6840
6841 -- And for binary operators, the left operand as well
6842
6843 if Nkind (N) in N_Binary_Op then
6844 Set_Left_Opnd (New_N,
6845 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
6846 end if;
6847 end if;
6848
6849 -- Special casing for stubs
6850
6851 elsif Nkind (N) in N_Body_Stub then
6852
6853 -- In any case, we must copy the specification or defining
6854 -- identifier as appropriate.
6855
6856 if Nkind (N) = N_Subprogram_Body_Stub then
6857 Set_Specification (New_N,
6858 Copy_Generic_Node (Specification (N), New_N, Instantiating));
6859
6860 else
6861 Set_Defining_Identifier (New_N,
6862 Copy_Generic_Node
6863 (Defining_Identifier (N), New_N, Instantiating));
6864 end if;
6865
6866 -- If we are not instantiating, then this is where we load and
6867 -- analyze subunits, i.e. at the point where the stub occurs. A
6868 -- more permissive system might defer this analysis to the point
6869 -- of instantiation, but this seems too complicated for now.
6870
6871 if not Instantiating then
6872 declare
6873 Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
6874 Subunit : Node_Id;
6875 Unum : Unit_Number_Type;
6876 New_Body : Node_Id;
6877
6878 begin
6879 -- Make sure that, if it is a subunit of the main unit that is
6880 -- preprocessed and if -gnateG is specified, the preprocessed
6881 -- file will be written.
6882
6883 Lib.Analysing_Subunit_Of_Main :=
6884 Lib.In_Extended_Main_Source_Unit (N);
6885 Unum :=
6886 Load_Unit
6887 (Load_Name => Subunit_Name,
6888 Required => False,
6889 Subunit => True,
6890 Error_Node => N);
6891 Lib.Analysing_Subunit_Of_Main := False;
6892
6893 -- If the proper body is not found, a warning message will be
6894 -- emitted when analyzing the stub, or later at the point of
6895 -- instantiation. Here we just leave the stub as is.
6896
6897 if Unum = No_Unit then
6898 Subunits_Missing := True;
6899 goto Subunit_Not_Found;
6900 end if;
6901
6902 Subunit := Cunit (Unum);
6903
6904 if Nkind (Unit (Subunit)) /= N_Subunit then
6905 Error_Msg_N
6906 ("found child unit instead of expected SEPARATE subunit",
6907 Subunit);
6908 Error_Msg_Sloc := Sloc (N);
6909 Error_Msg_N ("\to complete stub #", Subunit);
6910 goto Subunit_Not_Found;
6911 end if;
6912
6913 -- We must create a generic copy of the subunit, in order to
6914 -- perform semantic analysis on it, and we must replace the
6915 -- stub in the original generic unit with the subunit, in order
6916 -- to preserve non-local references within.
6917
6918 -- Only the proper body needs to be copied. Library_Unit and
6919 -- context clause are simply inherited by the generic copy.
6920 -- Note that the copy (which may be recursive if there are
6921 -- nested subunits) must be done first, before attaching it to
6922 -- the enclosing generic.
6923
6924 New_Body :=
6925 Copy_Generic_Node
6926 (Proper_Body (Unit (Subunit)),
6927 Empty, Instantiating => False);
6928
6929 -- Now place the original proper body in the original generic
6930 -- unit. This is a body, not a compilation unit.
6931
6932 Rewrite (N, Proper_Body (Unit (Subunit)));
6933 Set_Is_Compilation_Unit (Defining_Entity (N), False);
6934 Set_Was_Originally_Stub (N);
6935
6936 -- Finally replace the body of the subunit with its copy, and
6937 -- make this new subunit into the library unit of the generic
6938 -- copy, which does not have stubs any longer.
6939
6940 Set_Proper_Body (Unit (Subunit), New_Body);
6941 Set_Library_Unit (New_N, Subunit);
6942 Inherit_Context (Unit (Subunit), N);
6943 end;
6944
6945 -- If we are instantiating, this must be an error case, since
6946 -- otherwise we would have replaced the stub node by the proper body
6947 -- that corresponds. So just ignore it in the copy (i.e. we have
6948 -- copied it, and that is good enough).
6949
6950 else
6951 null;
6952 end if;
6953
6954 <<Subunit_Not_Found>> null;
6955
6956 -- If the node is a compilation unit, it is the subunit of a stub, which
6957 -- has been loaded already (see code below). In this case, the library
6958 -- unit field of N points to the parent unit (which is a compilation
6959 -- unit) and need not (and cannot) be copied.
6960
6961 -- When the proper body of the stub is analyzed, the library_unit link
6962 -- is used to establish the proper context (see sem_ch10).
6963
6964 -- The other fields of a compilation unit are copied as usual
6965
6966 elsif Nkind (N) = N_Compilation_Unit then
6967
6968 -- This code can only be executed when not instantiating, because in
6969 -- the copy made for an instantiation, the compilation unit node has
6970 -- disappeared at the point that a stub is replaced by its proper
6971 -- body.
6972
6973 pragma Assert (not Instantiating);
6974
6975 Set_Context_Items (New_N,
6976 Copy_Generic_List (Context_Items (N), New_N));
6977
6978 Set_Unit (New_N,
6979 Copy_Generic_Node (Unit (N), New_N, False));
6980
6981 Set_First_Inlined_Subprogram (New_N,
6982 Copy_Generic_Node
6983 (First_Inlined_Subprogram (N), New_N, False));
6984
6985 Set_Aux_Decls_Node (New_N,
6986 Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
6987
6988 -- For an assignment node, the assignment is known to be semantically
6989 -- legal if we are instantiating the template. This avoids incorrect
6990 -- diagnostics in generated code.
6991
6992 elsif Nkind (N) = N_Assignment_Statement then
6993
6994 -- Copy name and expression fields in usual manner
6995
6996 Set_Name (New_N,
6997 Copy_Generic_Node (Name (N), New_N, Instantiating));
6998
6999 Set_Expression (New_N,
7000 Copy_Generic_Node (Expression (N), New_N, Instantiating));
7001
7002 if Instantiating then
7003 Set_Assignment_OK (Name (New_N), True);
7004 end if;
7005
7006 elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
7007 if not Instantiating then
7008 Set_Associated_Node (N, New_N);
7009
7010 else
7011 if Present (Get_Associated_Node (N))
7012 and then Nkind (Get_Associated_Node (N)) = Nkind (N)
7013 then
7014 -- In the generic the aggregate has some composite type. If at
7015 -- the point of instantiation the type has a private view,
7016 -- install the full view (and that of its ancestors, if any).
7017
7018 declare
7019 T : Entity_Id := (Etype (Get_Associated_Node (New_N)));
7020 Rt : Entity_Id;
7021
7022 begin
7023 if Present (T)
7024 and then Is_Private_Type (T)
7025 then
7026 Switch_View (T);
7027 end if;
7028
7029 if Present (T)
7030 and then Is_Tagged_Type (T)
7031 and then Is_Derived_Type (T)
7032 then
7033 Rt := Root_Type (T);
7034
7035 loop
7036 T := Etype (T);
7037
7038 if Is_Private_Type (T) then
7039 Switch_View (T);
7040 end if;
7041
7042 exit when T = Rt;
7043 end loop;
7044 end if;
7045 end;
7046 end if;
7047 end if;
7048
7049 -- Do not copy the associated node, which points to the generic copy
7050 -- of the aggregate.
7051
7052 declare
7053 use Atree.Unchecked_Access;
7054 -- This code section is part of the implementation of an untyped
7055 -- tree traversal, so it needs direct access to node fields.
7056
7057 begin
7058 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
7059 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
7060 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
7061 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
7062 end;
7063
7064 -- Allocators do not have an identifier denoting the access type, so we
7065 -- must locate it through the expression to check whether the views are
7066 -- consistent.
7067
7068 elsif Nkind (N) = N_Allocator
7069 and then Nkind (Expression (N)) = N_Qualified_Expression
7070 and then Is_Entity_Name (Subtype_Mark (Expression (N)))
7071 and then Instantiating
7072 then
7073 declare
7074 T : constant Node_Id :=
7075 Get_Associated_Node (Subtype_Mark (Expression (N)));
7076 Acc_T : Entity_Id;
7077
7078 begin
7079 if Present (T) then
7080
7081 -- Retrieve the allocator node in the generic copy
7082
7083 Acc_T := Etype (Parent (Parent (T)));
7084 if Present (Acc_T)
7085 and then Is_Private_Type (Acc_T)
7086 then
7087 Switch_View (Acc_T);
7088 end if;
7089 end if;
7090
7091 Copy_Descendants;
7092 end;
7093
7094 -- For a proper body, we must catch the case of a proper body that
7095 -- replaces a stub. This represents the point at which a separate
7096 -- compilation unit, and hence template file, may be referenced, so we
7097 -- must make a new source instantiation entry for the template of the
7098 -- subunit, and ensure that all nodes in the subunit are adjusted using
7099 -- this new source instantiation entry.
7100
7101 elsif Nkind (N) in N_Proper_Body then
7102 declare
7103 Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
7104
7105 begin
7106 if Instantiating and then Was_Originally_Stub (N) then
7107 Create_Instantiation_Source
7108 (Instantiation_Node,
7109 Defining_Entity (N),
7110 False,
7111 S_Adjustment);
7112 end if;
7113
7114 -- Now copy the fields of the proper body, using the new
7115 -- adjustment factor if one was needed as per test above.
7116
7117 Copy_Descendants;
7118
7119 -- Restore the original adjustment factor in case changed
7120
7121 S_Adjustment := Save_Adjustment;
7122 end;
7123
7124 -- Don't copy Ident or Comment pragmas, since the comment belongs to the
7125 -- generic unit, not to the instantiating unit.
7126
7127 elsif Nkind (N) = N_Pragma and then Instantiating then
7128 declare
7129 Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
7130 begin
7131 if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
7132 New_N := Make_Null_Statement (Sloc (N));
7133 else
7134 Copy_Descendants;
7135 end if;
7136 end;
7137
7138 elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
7139
7140 -- No descendant fields need traversing
7141
7142 null;
7143
7144 elsif Nkind (N) = N_String_Literal
7145 and then Present (Etype (N))
7146 and then Instantiating
7147 then
7148 -- If the string is declared in an outer scope, the string_literal
7149 -- subtype created for it may have the wrong scope. We force the
7150 -- reanalysis of the constant to generate a new itype in the proper
7151 -- context.
7152
7153 Set_Etype (New_N, Empty);
7154 Set_Analyzed (New_N, False);
7155
7156 -- For the remaining nodes, copy their descendants recursively
7157
7158 else
7159 Copy_Descendants;
7160
7161 if Instantiating and then Nkind (N) = N_Subprogram_Body then
7162 Set_Generic_Parent (Specification (New_N), N);
7163
7164 -- Should preserve Corresponding_Spec??? (12.3(14))
7165 end if;
7166 end if;
7167
7168 return New_N;
7169 end Copy_Generic_Node;
7170
7171 ----------------------------
7172 -- Denotes_Formal_Package --
7173 ----------------------------
7174
7175 function Denotes_Formal_Package
7176 (Pack : Entity_Id;
7177 On_Exit : Boolean := False;
7178 Instance : Entity_Id := Empty) return Boolean
7179 is
7180 Par : Entity_Id;
7181 Scop : constant Entity_Id := Scope (Pack);
7182 E : Entity_Id;
7183
7184 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
7185 -- The package in question may be an actual for a previous formal
7186 -- package P of the current instance, so examine its actuals as well.
7187 -- This must be recursive over other formal packages.
7188
7189 ----------------------------------
7190 -- Is_Actual_Of_Previous_Formal --
7191 ----------------------------------
7192
7193 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
7194 E1 : Entity_Id;
7195
7196 begin
7197 E1 := First_Entity (P);
7198 while Present (E1) and then E1 /= Instance loop
7199 if Ekind (E1) = E_Package
7200 and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
7201 then
7202 if Renamed_Object (E1) = Pack then
7203 return True;
7204
7205 elsif E1 = P or else Renamed_Object (E1) = P then
7206 return False;
7207
7208 elsif Is_Actual_Of_Previous_Formal (E1) then
7209 return True;
7210 end if;
7211 end if;
7212
7213 Next_Entity (E1);
7214 end loop;
7215
7216 return False;
7217 end Is_Actual_Of_Previous_Formal;
7218
7219 -- Start of processing for Denotes_Formal_Package
7220
7221 begin
7222 if On_Exit then
7223 Par :=
7224 Instance_Envs.Table
7225 (Instance_Envs.Last).Instantiated_Parent.Act_Id;
7226 else
7227 Par := Current_Instantiated_Parent.Act_Id;
7228 end if;
7229
7230 if Ekind (Scop) = E_Generic_Package
7231 or else Nkind (Unit_Declaration_Node (Scop)) =
7232 N_Generic_Subprogram_Declaration
7233 then
7234 return True;
7235
7236 elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
7237 N_Formal_Package_Declaration
7238 then
7239 return True;
7240
7241 elsif No (Par) then
7242 return False;
7243
7244 else
7245 -- Check whether this package is associated with a formal package of
7246 -- the enclosing instantiation. Iterate over the list of renamings.
7247
7248 E := First_Entity (Par);
7249 while Present (E) loop
7250 if Ekind (E) /= E_Package
7251 or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
7252 then
7253 null;
7254
7255 elsif Renamed_Object (E) = Par then
7256 return False;
7257
7258 elsif Renamed_Object (E) = Pack then
7259 return True;
7260
7261 elsif Is_Actual_Of_Previous_Formal (E) then
7262 return True;
7263
7264 end if;
7265
7266 Next_Entity (E);
7267 end loop;
7268
7269 return False;
7270 end if;
7271 end Denotes_Formal_Package;
7272
7273 -----------------
7274 -- End_Generic --
7275 -----------------
7276
7277 procedure End_Generic is
7278 begin
7279 -- ??? More things could be factored out in this routine. Should
7280 -- probably be done at a later stage.
7281
7282 Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
7283 Generic_Flags.Decrement_Last;
7284
7285 Expander_Mode_Restore;
7286 end End_Generic;
7287
7288 -------------
7289 -- Earlier --
7290 -------------
7291
7292 function Earlier (N1, N2 : Node_Id) return Boolean is
7293 procedure Find_Depth (P : in out Node_Id; D : in out Integer);
7294 -- Find distance from given node to enclosing compilation unit
7295
7296 ----------------
7297 -- Find_Depth --
7298 ----------------
7299
7300 procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
7301 begin
7302 while Present (P)
7303 and then Nkind (P) /= N_Compilation_Unit
7304 loop
7305 P := True_Parent (P);
7306 D := D + 1;
7307 end loop;
7308 end Find_Depth;
7309
7310 -- Local declarations
7311
7312 D1 : Integer := 0;
7313 D2 : Integer := 0;
7314 P1 : Node_Id := N1;
7315 P2 : Node_Id := N2;
7316 T1 : Source_Ptr;
7317 T2 : Source_Ptr;
7318
7319 -- Start of processing for Earlier
7320
7321 begin
7322 Find_Depth (P1, D1);
7323 Find_Depth (P2, D2);
7324
7325 if P1 /= P2 then
7326 return False;
7327 else
7328 P1 := N1;
7329 P2 := N2;
7330 end if;
7331
7332 while D1 > D2 loop
7333 P1 := True_Parent (P1);
7334 D1 := D1 - 1;
7335 end loop;
7336
7337 while D2 > D1 loop
7338 P2 := True_Parent (P2);
7339 D2 := D2 - 1;
7340 end loop;
7341
7342 -- At this point P1 and P2 are at the same distance from the root.
7343 -- We examine their parents until we find a common declarative list.
7344 -- If we reach the root, N1 and N2 do not descend from the same
7345 -- declarative list (e.g. one is nested in the declarative part and
7346 -- the other is in a block in the statement part) and the earlier
7347 -- one is already frozen.
7348
7349 while not Is_List_Member (P1)
7350 or else not Is_List_Member (P2)
7351 or else List_Containing (P1) /= List_Containing (P2)
7352 loop
7353 P1 := True_Parent (P1);
7354 P2 := True_Parent (P2);
7355
7356 if Nkind (Parent (P1)) = N_Subunit then
7357 P1 := Corresponding_Stub (Parent (P1));
7358 end if;
7359
7360 if Nkind (Parent (P2)) = N_Subunit then
7361 P2 := Corresponding_Stub (Parent (P2));
7362 end if;
7363
7364 if P1 = P2 then
7365 return False;
7366 end if;
7367 end loop;
7368
7369 -- Expanded code usually shares the source location of the original
7370 -- construct it was generated for. This however may not necessarely
7371 -- reflect the true location of the code within the tree.
7372
7373 -- Before comparing the slocs of the two nodes, make sure that we are
7374 -- working with correct source locations. Assume that P1 is to the left
7375 -- of P2. If either one does not come from source, traverse the common
7376 -- list heading towards the other node and locate the first source
7377 -- statement.
7378
7379 -- P1 P2
7380 -- ----+===+===+--------------+===+===+----
7381 -- expanded code expanded code
7382
7383 if not Comes_From_Source (P1) then
7384 while Present (P1) loop
7385
7386 -- Neither P2 nor a source statement were located during the
7387 -- search. If we reach the end of the list, then P1 does not
7388 -- occur earlier than P2.
7389
7390 -- ---->
7391 -- start --- P2 ----- P1 --- end
7392
7393 if No (Next (P1)) then
7394 return False;
7395
7396 -- We encounter P2 while going to the right of the list. This
7397 -- means that P1 does indeed appear earlier.
7398
7399 -- ---->
7400 -- start --- P1 ===== P2 --- end
7401 -- expanded code in between
7402
7403 elsif P1 = P2 then
7404 return True;
7405
7406 -- No need to look any further since we have located a source
7407 -- statement.
7408
7409 elsif Comes_From_Source (P1) then
7410 exit;
7411 end if;
7412
7413 -- Keep going right
7414
7415 Next (P1);
7416 end loop;
7417 end if;
7418
7419 if not Comes_From_Source (P2) then
7420 while Present (P2) loop
7421
7422 -- Neither P1 nor a source statement were located during the
7423 -- search. If we reach the start of the list, then P1 does not
7424 -- occur earlier than P2.
7425
7426 -- <----
7427 -- start --- P2 --- P1 --- end
7428
7429 if No (Prev (P2)) then
7430 return False;
7431
7432 -- We encounter P1 while going to the left of the list. This
7433 -- means that P1 does indeed appear earlier.
7434
7435 -- <----
7436 -- start --- P1 ===== P2 --- end
7437 -- expanded code in between
7438
7439 elsif P2 = P1 then
7440 return True;
7441
7442 -- No need to look any further since we have located a source
7443 -- statement.
7444
7445 elsif Comes_From_Source (P2) then
7446 exit;
7447 end if;
7448
7449 -- Keep going left
7450
7451 Prev (P2);
7452 end loop;
7453 end if;
7454
7455 -- At this point either both nodes came from source or we approximated
7456 -- their source locations through neighbouring source statements.
7457
7458 T1 := Top_Level_Location (Sloc (P1));
7459 T2 := Top_Level_Location (Sloc (P2));
7460
7461 -- When two nodes come from the same instance, they have identical top
7462 -- level locations. To determine proper relation within the tree, check
7463 -- their locations within the template.
7464
7465 if T1 = T2 then
7466 return Sloc (P1) < Sloc (P2);
7467
7468 -- The two nodes either come from unrelated instances or do not come
7469 -- from instantiated code at all.
7470
7471 else
7472 return T1 < T2;
7473 end if;
7474 end Earlier;
7475
7476 ----------------------
7477 -- Find_Actual_Type --
7478 ----------------------
7479
7480 function Find_Actual_Type
7481 (Typ : Entity_Id;
7482 Gen_Type : Entity_Id) return Entity_Id
7483 is
7484 Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7485 T : Entity_Id;
7486
7487 begin
7488 -- Special processing only applies to child units
7489
7490 if not Is_Child_Unit (Gen_Scope) then
7491 return Get_Instance_Of (Typ);
7492
7493 -- If designated or component type is itself a formal of the child unit,
7494 -- its instance is available.
7495
7496 elsif Scope (Typ) = Gen_Scope then
7497 return Get_Instance_Of (Typ);
7498
7499 -- If the array or access type is not declared in the parent unit,
7500 -- no special processing needed.
7501
7502 elsif not Is_Generic_Type (Typ)
7503 and then Scope (Gen_Scope) /= Scope (Typ)
7504 then
7505 return Get_Instance_Of (Typ);
7506
7507 -- Otherwise, retrieve designated or component type by visibility
7508
7509 else
7510 T := Current_Entity (Typ);
7511 while Present (T) loop
7512 if In_Open_Scopes (Scope (T)) then
7513 return T;
7514
7515 elsif Is_Generic_Actual_Type (T) then
7516 return T;
7517 end if;
7518
7519 T := Homonym (T);
7520 end loop;
7521
7522 return Typ;
7523 end if;
7524 end Find_Actual_Type;
7525
7526 ----------------------------
7527 -- Freeze_Subprogram_Body --
7528 ----------------------------
7529
7530 procedure Freeze_Subprogram_Body
7531 (Inst_Node : Node_Id;
7532 Gen_Body : Node_Id;
7533 Pack_Id : Entity_Id)
7534 is
7535 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7536 Par : constant Entity_Id := Scope (Gen_Unit);
7537 E_G_Id : Entity_Id;
7538 Enc_G : Entity_Id;
7539 Enc_I : Node_Id;
7540 F_Node : Node_Id;
7541
7542 function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7543 -- Find innermost package body that encloses the given node, and which
7544 -- is not a compilation unit. Freeze nodes for the instance, or for its
7545 -- enclosing body, may be inserted after the enclosing_body of the
7546 -- generic unit. Used to determine proper placement of freeze node for
7547 -- both package and subprogram instances.
7548
7549 function Package_Freeze_Node (B : Node_Id) return Node_Id;
7550 -- Find entity for given package body, and locate or create a freeze
7551 -- node for it.
7552
7553 ----------------------------
7554 -- Enclosing_Package_Body --
7555 ----------------------------
7556
7557 function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7558 P : Node_Id;
7559
7560 begin
7561 P := Parent (N);
7562 while Present (P)
7563 and then Nkind (Parent (P)) /= N_Compilation_Unit
7564 loop
7565 if Nkind (P) = N_Package_Body then
7566 if Nkind (Parent (P)) = N_Subunit then
7567 return Corresponding_Stub (Parent (P));
7568 else
7569 return P;
7570 end if;
7571 end if;
7572
7573 P := True_Parent (P);
7574 end loop;
7575
7576 return Empty;
7577 end Enclosing_Package_Body;
7578
7579 -------------------------
7580 -- Package_Freeze_Node --
7581 -------------------------
7582
7583 function Package_Freeze_Node (B : Node_Id) return Node_Id is
7584 Id : Entity_Id;
7585
7586 begin
7587 if Nkind (B) = N_Package_Body then
7588 Id := Corresponding_Spec (B);
7589 else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7590 Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7591 end if;
7592
7593 Ensure_Freeze_Node (Id);
7594 return Freeze_Node (Id);
7595 end Package_Freeze_Node;
7596
7597 -- Start of processing of Freeze_Subprogram_Body
7598
7599 begin
7600 -- If the instance and the generic body appear within the same unit, and
7601 -- the instance precedes the generic, the freeze node for the instance
7602 -- must appear after that of the generic. If the generic is nested
7603 -- within another instance I2, then current instance must be frozen
7604 -- after I2. In both cases, the freeze nodes are those of enclosing
7605 -- packages. Otherwise, the freeze node is placed at the end of the
7606 -- current declarative part.
7607
7608 Enc_G := Enclosing_Package_Body (Gen_Body);
7609 Enc_I := Enclosing_Package_Body (Inst_Node);
7610 Ensure_Freeze_Node (Pack_Id);
7611 F_Node := Freeze_Node (Pack_Id);
7612
7613 if Is_Generic_Instance (Par)
7614 and then Present (Freeze_Node (Par))
7615 and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7616 then
7617 -- The parent was a premature instantiation. Insert freeze node at
7618 -- the end the current declarative part.
7619
7620 if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7621 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7622
7623 -- Handle the following case:
7624 --
7625 -- package Parent_Inst is new ...
7626 -- Parent_Inst []
7627 --
7628 -- procedure P ... -- this body freezes Parent_Inst
7629 --
7630 -- package Inst is new ...
7631 --
7632 -- In this particular scenario, the freeze node for Inst must be
7633 -- inserted in the same manner as that of Parent_Inst - before the
7634 -- next source body or at the end of the declarative list (body not
7635 -- available). If body P did not exist and Parent_Inst was frozen
7636 -- after Inst, either by a body following Inst or at the end of the
7637 -- declarative region, the freeze node for Inst must be inserted
7638 -- after that of Parent_Inst. This relation is established by
7639 -- comparing the Slocs of Parent_Inst freeze node and Inst.
7640
7641 elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7642 List_Containing (Inst_Node)
7643 and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7644 then
7645 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7646
7647 else
7648 Insert_After (Freeze_Node (Par), F_Node);
7649 end if;
7650
7651 -- The body enclosing the instance should be frozen after the body that
7652 -- includes the generic, because the body of the instance may make
7653 -- references to entities therein. If the two are not in the same
7654 -- declarative part, or if the one enclosing the instance is frozen
7655 -- already, freeze the instance at the end of the current declarative
7656 -- part.
7657
7658 elsif Is_Generic_Instance (Par)
7659 and then Present (Freeze_Node (Par))
7660 and then Present (Enc_I)
7661 then
7662 if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7663 or else
7664 (Nkind (Enc_I) = N_Package_Body
7665 and then
7666 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7667 then
7668 -- The enclosing package may contain several instances. Rather
7669 -- than computing the earliest point at which to insert its freeze
7670 -- node, we place it at the end of the declarative part of the
7671 -- parent of the generic.
7672
7673 Insert_Freeze_Node_For_Instance
7674 (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7675 end if;
7676
7677 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7678
7679 elsif Present (Enc_G)
7680 and then Present (Enc_I)
7681 and then Enc_G /= Enc_I
7682 and then Earlier (Inst_Node, Gen_Body)
7683 then
7684 if Nkind (Enc_G) = N_Package_Body then
7685 E_G_Id := Corresponding_Spec (Enc_G);
7686 else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7687 E_G_Id :=
7688 Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7689 end if;
7690
7691 -- Freeze package that encloses instance, and place node after the
7692 -- package that encloses generic. If enclosing package is already
7693 -- frozen we have to assume it is at the proper place. This may be a
7694 -- potential ABE that requires dynamic checking. Do not add a freeze
7695 -- node if the package that encloses the generic is inside the body
7696 -- that encloses the instance, because the freeze node would be in
7697 -- the wrong scope. Additional contortions needed if the bodies are
7698 -- within a subunit.
7699
7700 declare
7701 Enclosing_Body : Node_Id;
7702
7703 begin
7704 if Nkind (Enc_I) = N_Package_Body_Stub then
7705 Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7706 else
7707 Enclosing_Body := Enc_I;
7708 end if;
7709
7710 if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
7711 Insert_Freeze_Node_For_Instance
7712 (Enc_G, Package_Freeze_Node (Enc_I));
7713 end if;
7714 end;
7715
7716 -- Freeze enclosing subunit before instance
7717
7718 Ensure_Freeze_Node (E_G_Id);
7719
7720 if not Is_List_Member (Freeze_Node (E_G_Id)) then
7721 Insert_After (Enc_G, Freeze_Node (E_G_Id));
7722 end if;
7723
7724 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7725
7726 else
7727 -- If none of the above, insert freeze node at the end of the current
7728 -- declarative part.
7729
7730 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7731 end if;
7732 end Freeze_Subprogram_Body;
7733
7734 ----------------
7735 -- Get_Gen_Id --
7736 ----------------
7737
7738 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
7739 begin
7740 return Generic_Renamings.Table (E).Gen_Id;
7741 end Get_Gen_Id;
7742
7743 ---------------------
7744 -- Get_Instance_Of --
7745 ---------------------
7746
7747 function Get_Instance_Of (A : Entity_Id) return Entity_Id is
7748 Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
7749
7750 begin
7751 if Res /= Assoc_Null then
7752 return Generic_Renamings.Table (Res).Act_Id;
7753 else
7754 -- On exit, entity is not instantiated: not a generic parameter, or
7755 -- else parameter of an inner generic unit.
7756
7757 return A;
7758 end if;
7759 end Get_Instance_Of;
7760
7761 ------------------------------------
7762 -- Get_Package_Instantiation_Node --
7763 ------------------------------------
7764
7765 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
7766 Decl : Node_Id := Unit_Declaration_Node (A);
7767 Inst : Node_Id;
7768
7769 begin
7770 -- If the Package_Instantiation attribute has been set on the package
7771 -- entity, then use it directly when it (or its Original_Node) refers
7772 -- to an N_Package_Instantiation node. In principle it should be
7773 -- possible to have this field set in all cases, which should be
7774 -- investigated, and would allow this function to be significantly
7775 -- simplified. ???
7776
7777 Inst := Package_Instantiation (A);
7778
7779 if Present (Inst) then
7780 if Nkind (Inst) = N_Package_Instantiation then
7781 return Inst;
7782
7783 elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
7784 return Original_Node (Inst);
7785 end if;
7786 end if;
7787
7788 -- If the instantiation is a compilation unit that does not need body
7789 -- then the instantiation node has been rewritten as a package
7790 -- declaration for the instance, and we return the original node.
7791
7792 -- If it is a compilation unit and the instance node has not been
7793 -- rewritten, then it is still the unit of the compilation. Finally, if
7794 -- a body is present, this is a parent of the main unit whose body has
7795 -- been compiled for inlining purposes, and the instantiation node has
7796 -- been rewritten with the instance body.
7797
7798 -- Otherwise the instantiation node appears after the declaration. If
7799 -- the entity is a formal package, the declaration may have been
7800 -- rewritten as a generic declaration (in the case of a formal with box)
7801 -- or left as a formal package declaration if it has actuals, and is
7802 -- found with a forward search.
7803
7804 if Nkind (Parent (Decl)) = N_Compilation_Unit then
7805 if Nkind (Decl) = N_Package_Declaration
7806 and then Present (Corresponding_Body (Decl))
7807 then
7808 Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
7809 end if;
7810
7811 if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
7812 return Original_Node (Decl);
7813 else
7814 return Unit (Parent (Decl));
7815 end if;
7816
7817 elsif Nkind (Decl) = N_Package_Declaration
7818 and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
7819 then
7820 return Original_Node (Decl);
7821
7822 else
7823 Inst := Next (Decl);
7824 while not Nkind_In (Inst, N_Package_Instantiation,
7825 N_Formal_Package_Declaration)
7826 loop
7827 Next (Inst);
7828 end loop;
7829
7830 return Inst;
7831 end if;
7832 end Get_Package_Instantiation_Node;
7833
7834 ------------------------
7835 -- Has_Been_Exchanged --
7836 ------------------------
7837
7838 function Has_Been_Exchanged (E : Entity_Id) return Boolean is
7839 Next : Elmt_Id;
7840
7841 begin
7842 Next := First_Elmt (Exchanged_Views);
7843 while Present (Next) loop
7844 if Full_View (Node (Next)) = E then
7845 return True;
7846 end if;
7847
7848 Next_Elmt (Next);
7849 end loop;
7850
7851 return False;
7852 end Has_Been_Exchanged;
7853
7854 ----------
7855 -- Hash --
7856 ----------
7857
7858 function Hash (F : Entity_Id) return HTable_Range is
7859 begin
7860 return HTable_Range (F mod HTable_Size);
7861 end Hash;
7862
7863 ------------------------
7864 -- Hide_Current_Scope --
7865 ------------------------
7866
7867 procedure Hide_Current_Scope is
7868 C : constant Entity_Id := Current_Scope;
7869 E : Entity_Id;
7870
7871 begin
7872 Set_Is_Hidden_Open_Scope (C);
7873
7874 E := First_Entity (C);
7875 while Present (E) loop
7876 if Is_Immediately_Visible (E) then
7877 Set_Is_Immediately_Visible (E, False);
7878 Append_Elmt (E, Hidden_Entities);
7879 end if;
7880
7881 Next_Entity (E);
7882 end loop;
7883
7884 -- Make the scope name invisible as well. This is necessary, but might
7885 -- conflict with calls to Rtsfind later on, in case the scope is a
7886 -- predefined one. There is no clean solution to this problem, so for
7887 -- now we depend on the user not redefining Standard itself in one of
7888 -- the parent units.
7889
7890 if Is_Immediately_Visible (C) and then C /= Standard_Standard then
7891 Set_Is_Immediately_Visible (C, False);
7892 Append_Elmt (C, Hidden_Entities);
7893 end if;
7894
7895 end Hide_Current_Scope;
7896
7897 --------------
7898 -- Init_Env --
7899 --------------
7900
7901 procedure Init_Env is
7902 Saved : Instance_Env;
7903
7904 begin
7905 Saved.Instantiated_Parent := Current_Instantiated_Parent;
7906 Saved.Exchanged_Views := Exchanged_Views;
7907 Saved.Hidden_Entities := Hidden_Entities;
7908 Saved.Current_Sem_Unit := Current_Sem_Unit;
7909 Saved.Parent_Unit_Visible := Parent_Unit_Visible;
7910 Saved.Instance_Parent_Unit := Instance_Parent_Unit;
7911
7912 -- Save configuration switches. These may be reset if the unit is a
7913 -- predefined unit, and the current mode is not Ada 2005.
7914
7915 Save_Opt_Config_Switches (Saved.Switches);
7916
7917 Instance_Envs.Append (Saved);
7918
7919 Exchanged_Views := New_Elmt_List;
7920 Hidden_Entities := New_Elmt_List;
7921
7922 -- Make dummy entry for Instantiated parent. If generic unit is legal,
7923 -- this is set properly in Set_Instance_Env.
7924
7925 Current_Instantiated_Parent :=
7926 (Current_Scope, Current_Scope, Assoc_Null);
7927 end Init_Env;
7928
7929 ------------------------------
7930 -- In_Same_Declarative_Part --
7931 ------------------------------
7932
7933 function In_Same_Declarative_Part
7934 (F_Node : Node_Id;
7935 Inst : Node_Id) return Boolean
7936 is
7937 Decls : constant Node_Id := Parent (F_Node);
7938 Nod : Node_Id := Parent (Inst);
7939
7940 begin
7941 while Present (Nod) loop
7942 if Nod = Decls then
7943 return True;
7944
7945 elsif Nkind_In (Nod, N_Subprogram_Body,
7946 N_Package_Body,
7947 N_Package_Declaration,
7948 N_Task_Body,
7949 N_Protected_Body,
7950 N_Block_Statement)
7951 then
7952 return False;
7953
7954 elsif Nkind (Nod) = N_Subunit then
7955 Nod := Corresponding_Stub (Nod);
7956
7957 elsif Nkind (Nod) = N_Compilation_Unit then
7958 return False;
7959
7960 else
7961 Nod := Parent (Nod);
7962 end if;
7963 end loop;
7964
7965 return False;
7966 end In_Same_Declarative_Part;
7967
7968 ---------------------
7969 -- In_Main_Context --
7970 ---------------------
7971
7972 function In_Main_Context (E : Entity_Id) return Boolean is
7973 Context : List_Id;
7974 Clause : Node_Id;
7975 Nam : Node_Id;
7976
7977 begin
7978 if not Is_Compilation_Unit (E)
7979 or else Ekind (E) /= E_Package
7980 or else In_Private_Part (E)
7981 then
7982 return False;
7983 end if;
7984
7985 Context := Context_Items (Cunit (Main_Unit));
7986
7987 Clause := First (Context);
7988 while Present (Clause) loop
7989 if Nkind (Clause) = N_With_Clause then
7990 Nam := Name (Clause);
7991
7992 -- If the current scope is part of the context of the main unit,
7993 -- analysis of the corresponding with_clause is not complete, and
7994 -- the entity is not set. We use the Chars field directly, which
7995 -- might produce false positives in rare cases, but guarantees
7996 -- that we produce all the instance bodies we will need.
7997
7998 if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
7999 or else (Nkind (Nam) = N_Selected_Component
8000 and then Chars (Selector_Name (Nam)) = Chars (E))
8001 then
8002 return True;
8003 end if;
8004 end if;
8005
8006 Next (Clause);
8007 end loop;
8008
8009 return False;
8010 end In_Main_Context;
8011
8012 ---------------------
8013 -- Inherit_Context --
8014 ---------------------
8015
8016 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
8017 Current_Context : List_Id;
8018 Current_Unit : Node_Id;
8019 Item : Node_Id;
8020 New_I : Node_Id;
8021
8022 Clause : Node_Id;
8023 OK : Boolean;
8024 Lib_Unit : Node_Id;
8025
8026 begin
8027 if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
8028
8029 -- The inherited context is attached to the enclosing compilation
8030 -- unit. This is either the main unit, or the declaration for the
8031 -- main unit (in case the instantiation appears within the package
8032 -- declaration and the main unit is its body).
8033
8034 Current_Unit := Parent (Inst);
8035 while Present (Current_Unit)
8036 and then Nkind (Current_Unit) /= N_Compilation_Unit
8037 loop
8038 Current_Unit := Parent (Current_Unit);
8039 end loop;
8040
8041 Current_Context := Context_Items (Current_Unit);
8042
8043 Item := First (Context_Items (Parent (Gen_Decl)));
8044 while Present (Item) loop
8045 if Nkind (Item) = N_With_Clause then
8046 Lib_Unit := Library_Unit (Item);
8047
8048 -- Take care to prevent direct cyclic with's
8049
8050 if Lib_Unit /= Current_Unit then
8051
8052 -- Do not add a unit if it is already in the context
8053
8054 Clause := First (Current_Context);
8055 OK := True;
8056 while Present (Clause) loop
8057 if Nkind (Clause) = N_With_Clause and then
8058 Library_Unit (Clause) = Lib_Unit
8059 then
8060 OK := False;
8061 exit;
8062 end if;
8063
8064 Next (Clause);
8065 end loop;
8066
8067 if OK then
8068 New_I := New_Copy (Item);
8069 Set_Implicit_With (New_I, True);
8070 Set_Implicit_With_From_Instantiation (New_I, True);
8071 Append (New_I, Current_Context);
8072 end if;
8073 end if;
8074 end if;
8075
8076 Next (Item);
8077 end loop;
8078 end if;
8079 end Inherit_Context;
8080
8081 ----------------
8082 -- Initialize --
8083 ----------------
8084
8085 procedure Initialize is
8086 begin
8087 Generic_Renamings.Init;
8088 Instance_Envs.Init;
8089 Generic_Flags.Init;
8090 Generic_Renamings_HTable.Reset;
8091 Circularity_Detected := False;
8092 Exchanged_Views := No_Elist;
8093 Hidden_Entities := No_Elist;
8094 end Initialize;
8095
8096 -------------------------------------
8097 -- Insert_Freeze_Node_For_Instance --
8098 -------------------------------------
8099
8100 procedure Insert_Freeze_Node_For_Instance
8101 (N : Node_Id;
8102 F_Node : Node_Id)
8103 is
8104 Decl : Node_Id;
8105 Decls : List_Id;
8106 Inst : Entity_Id;
8107 Par_N : Node_Id;
8108
8109 function Enclosing_Body (N : Node_Id) return Node_Id;
8110 -- Find enclosing package or subprogram body, if any. Freeze node may
8111 -- be placed at end of current declarative list if previous instance
8112 -- and current one have different enclosing bodies.
8113
8114 function Previous_Instance (Gen : Entity_Id) return Entity_Id;
8115 -- Find the local instance, if any, that declares the generic that is
8116 -- being instantiated. If present, the freeze node for this instance
8117 -- must follow the freeze node for the previous instance.
8118
8119 --------------------
8120 -- Enclosing_Body --
8121 --------------------
8122
8123 function Enclosing_Body (N : Node_Id) return Node_Id is
8124 P : Node_Id;
8125
8126 begin
8127 P := Parent (N);
8128 while Present (P)
8129 and then Nkind (Parent (P)) /= N_Compilation_Unit
8130 loop
8131 if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
8132 if Nkind (Parent (P)) = N_Subunit then
8133 return Corresponding_Stub (Parent (P));
8134 else
8135 return P;
8136 end if;
8137 end if;
8138
8139 P := True_Parent (P);
8140 end loop;
8141
8142 return Empty;
8143 end Enclosing_Body;
8144
8145 -----------------------
8146 -- Previous_Instance --
8147 -----------------------
8148
8149 function Previous_Instance (Gen : Entity_Id) return Entity_Id is
8150 S : Entity_Id;
8151
8152 begin
8153 S := Scope (Gen);
8154 while Present (S)
8155 and then S /= Standard_Standard
8156 loop
8157 if Is_Generic_Instance (S)
8158 and then In_Same_Source_Unit (S, N)
8159 then
8160 return S;
8161 end if;
8162
8163 S := Scope (S);
8164 end loop;
8165
8166 return Empty;
8167 end Previous_Instance;
8168
8169 -- Start of processing for Insert_Freeze_Node_For_Instance
8170
8171 begin
8172 if not Is_List_Member (F_Node) then
8173 Decl := N;
8174 Decls := List_Containing (N);
8175 Inst := Entity (F_Node);
8176 Par_N := Parent (Decls);
8177
8178 -- When processing a subprogram instantiation, utilize the actual
8179 -- subprogram instantiation rather than its package wrapper as it
8180 -- carries all the context information.
8181
8182 if Is_Wrapper_Package (Inst) then
8183 Inst := Related_Instance (Inst);
8184 end if;
8185
8186 -- If this is a package instance, check whether the generic is
8187 -- declared in a previous instance and the current instance is
8188 -- not within the previous one.
8189
8190 if Present (Generic_Parent (Parent (Inst)))
8191 and then Is_In_Main_Unit (N)
8192 then
8193 declare
8194 Enclosing_N : constant Node_Id := Enclosing_Body (N);
8195 Par_I : constant Entity_Id :=
8196 Previous_Instance
8197 (Generic_Parent (Parent (Inst)));
8198 Scop : Entity_Id;
8199
8200 begin
8201 if Present (Par_I)
8202 and then Earlier (N, Freeze_Node (Par_I))
8203 then
8204 Scop := Scope (Inst);
8205
8206 -- If the current instance is within the one that contains
8207 -- the generic, the freeze node for the current one must
8208 -- appear in the current declarative part. Ditto, if the
8209 -- current instance is within another package instance or
8210 -- within a body that does not enclose the current instance.
8211 -- In these three cases the freeze node of the previous
8212 -- instance is not relevant.
8213
8214 while Present (Scop)
8215 and then Scop /= Standard_Standard
8216 loop
8217 exit when Scop = Par_I
8218 or else
8219 (Is_Generic_Instance (Scop)
8220 and then Scope_Depth (Scop) > Scope_Depth (Par_I));
8221 Scop := Scope (Scop);
8222 end loop;
8223
8224 -- Previous instance encloses current instance
8225
8226 if Scop = Par_I then
8227 null;
8228
8229 -- If the next node is a source body we must freeze in
8230 -- the current scope as well.
8231
8232 elsif Present (Next (N))
8233 and then Nkind_In (Next (N),
8234 N_Subprogram_Body, N_Package_Body)
8235 and then Comes_From_Source (Next (N))
8236 then
8237 null;
8238
8239 -- Current instance is within an unrelated instance
8240
8241 elsif Is_Generic_Instance (Scop) then
8242 null;
8243
8244 -- Current instance is within an unrelated body
8245
8246 elsif Present (Enclosing_N)
8247 and then Enclosing_N /= Enclosing_Body (Par_I)
8248 then
8249 null;
8250
8251 else
8252 Insert_After (Freeze_Node (Par_I), F_Node);
8253 return;
8254 end if;
8255 end if;
8256 end;
8257 end if;
8258
8259 -- When the instantiation occurs in a package declaration, append the
8260 -- freeze node to the private declarations (if any).
8261
8262 if Nkind (Par_N) = N_Package_Specification
8263 and then Decls = Visible_Declarations (Par_N)
8264 and then Present (Private_Declarations (Par_N))
8265 and then not Is_Empty_List (Private_Declarations (Par_N))
8266 then
8267 Decls := Private_Declarations (Par_N);
8268 Decl := First (Decls);
8269 end if;
8270
8271 -- Determine the proper freeze point of a package instantiation. We
8272 -- adhere to the general rule of a package or subprogram body causing
8273 -- freezing of anything before it in the same declarative region. In
8274 -- this case, the proper freeze point of a package instantiation is
8275 -- before the first source body which follows, or before a stub. This
8276 -- ensures that entities coming from the instance are already frozen
8277 -- and usable in source bodies.
8278
8279 if Nkind (Par_N) /= N_Package_Declaration
8280 and then Ekind (Inst) = E_Package
8281 and then Is_Generic_Instance (Inst)
8282 and then
8283 not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
8284 then
8285 while Present (Decl) loop
8286 if (Nkind (Decl) in N_Unit_Body
8287 or else
8288 Nkind (Decl) in N_Body_Stub)
8289 and then Comes_From_Source (Decl)
8290 then
8291 Insert_Before (Decl, F_Node);
8292 return;
8293 end if;
8294
8295 Next (Decl);
8296 end loop;
8297 end if;
8298
8299 -- In a package declaration, or if no previous body, insert at end
8300 -- of list.
8301
8302 Set_Sloc (F_Node, Sloc (Last (Decls)));
8303 Insert_After (Last (Decls), F_Node);
8304 end if;
8305 end Insert_Freeze_Node_For_Instance;
8306
8307 ------------------
8308 -- Install_Body --
8309 ------------------
8310
8311 procedure Install_Body
8312 (Act_Body : Node_Id;
8313 N : Node_Id;
8314 Gen_Body : Node_Id;
8315 Gen_Decl : Node_Id)
8316 is
8317 Act_Id : constant Entity_Id := Corresponding_Spec (Act_Body);
8318 Act_Unit : constant Node_Id := Unit (Cunit (Get_Source_Unit (N)));
8319 Gen_Id : constant Entity_Id := Corresponding_Spec (Gen_Body);
8320 Par : constant Entity_Id := Scope (Gen_Id);
8321 Gen_Unit : constant Node_Id :=
8322 Unit (Cunit (Get_Source_Unit (Gen_Decl)));
8323 Orig_Body : Node_Id := Gen_Body;
8324 F_Node : Node_Id;
8325 Body_Unit : Node_Id;
8326
8327 Must_Delay : Boolean;
8328
8329 function In_Same_Enclosing_Subp return Boolean;
8330 -- Check whether instance and generic body are within same subprogram.
8331
8332 function True_Sloc (N : Node_Id) return Source_Ptr;
8333 -- If the instance is nested inside a generic unit, the Sloc of the
8334 -- instance indicates the place of the original definition, not the
8335 -- point of the current enclosing instance. Pending a better usage of
8336 -- Slocs to indicate instantiation places, we determine the place of
8337 -- origin of a node by finding the maximum sloc of any ancestor node.
8338 -- Why is this not equivalent to Top_Level_Location ???
8339
8340 ----------------------------
8341 -- In_Same_Enclosing_Subp --
8342 ----------------------------
8343
8344 function In_Same_Enclosing_Subp return Boolean is
8345 Scop : Entity_Id;
8346 Subp : Entity_Id;
8347
8348 begin
8349 Scop := Scope (Act_Id);
8350 while Scop /= Standard_Standard
8351 and then not Is_Overloadable (Scop)
8352 loop
8353 Scop := Scope (Scop);
8354 end loop;
8355
8356 if Scop = Standard_Standard then
8357 return False;
8358 else
8359 Subp := Scop;
8360 end if;
8361
8362 Scop := Scope (Gen_Id);
8363 while Scop /= Standard_Standard loop
8364 if Scop = Subp then
8365 return True;
8366 else
8367 Scop := Scope (Scop);
8368 end if;
8369 end loop;
8370
8371 return False;
8372 end In_Same_Enclosing_Subp;
8373
8374 ---------------
8375 -- True_Sloc --
8376 ---------------
8377
8378 function True_Sloc (N : Node_Id) return Source_Ptr is
8379 Res : Source_Ptr;
8380 N1 : Node_Id;
8381
8382 begin
8383 Res := Sloc (N);
8384 N1 := N;
8385 while Present (N1) and then N1 /= Act_Unit loop
8386 if Sloc (N1) > Res then
8387 Res := Sloc (N1);
8388 end if;
8389
8390 N1 := Parent (N1);
8391 end loop;
8392
8393 return Res;
8394 end True_Sloc;
8395
8396 -- Start of processing for Install_Body
8397
8398 begin
8399 -- If the body is a subunit, the freeze point is the corresponding stub
8400 -- in the current compilation, not the subunit itself.
8401
8402 if Nkind (Parent (Gen_Body)) = N_Subunit then
8403 Orig_Body := Corresponding_Stub (Parent (Gen_Body));
8404 else
8405 Orig_Body := Gen_Body;
8406 end if;
8407
8408 Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8409
8410 -- If the instantiation and the generic definition appear in the same
8411 -- package declaration, this is an early instantiation. If they appear
8412 -- in the same declarative part, it is an early instantiation only if
8413 -- the generic body appears textually later, and the generic body is
8414 -- also in the main unit.
8415
8416 -- If instance is nested within a subprogram, and the generic body
8417 -- is not, the instance is delayed because the enclosing body is. If
8418 -- instance and body are within the same scope, or the same subprogram
8419 -- body, indicate explicitly that the instance is delayed.
8420
8421 Must_Delay :=
8422 (Gen_Unit = Act_Unit
8423 and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8424 N_Generic_Package_Declaration)
8425 or else (Gen_Unit = Body_Unit
8426 and then True_Sloc (N) < Sloc (Orig_Body)))
8427 and then Is_In_Main_Unit (Gen_Unit)
8428 and then (Scope (Act_Id) = Scope (Gen_Id)
8429 or else In_Same_Enclosing_Subp));
8430
8431 -- If this is an early instantiation, the freeze node is placed after
8432 -- the generic body. Otherwise, if the generic appears in an instance,
8433 -- we cannot freeze the current instance until the outer one is frozen.
8434 -- This is only relevant if the current instance is nested within some
8435 -- inner scope not itself within the outer instance. If this scope is
8436 -- a package body in the same declarative part as the outer instance,
8437 -- then that body needs to be frozen after the outer instance. Finally,
8438 -- if no delay is needed, we place the freeze node at the end of the
8439 -- current declarative part.
8440
8441 if Expander_Active then
8442 Ensure_Freeze_Node (Act_Id);
8443 F_Node := Freeze_Node (Act_Id);
8444
8445 if Must_Delay then
8446 Insert_After (Orig_Body, F_Node);
8447
8448 elsif Is_Generic_Instance (Par)
8449 and then Present (Freeze_Node (Par))
8450 and then Scope (Act_Id) /= Par
8451 then
8452 -- Freeze instance of inner generic after instance of enclosing
8453 -- generic.
8454
8455 if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8456
8457 -- Handle the following case:
8458
8459 -- package Parent_Inst is new ...
8460 -- Parent_Inst []
8461
8462 -- procedure P ... -- this body freezes Parent_Inst
8463
8464 -- package Inst is new ...
8465
8466 -- In this particular scenario, the freeze node for Inst must
8467 -- be inserted in the same manner as that of Parent_Inst,
8468 -- before the next source body or at the end of the declarative
8469 -- list (body not available). If body P did not exist and
8470 -- Parent_Inst was frozen after Inst, either by a body
8471 -- following Inst or at the end of the declarative region,
8472 -- the freeze node for Inst must be inserted after that of
8473 -- Parent_Inst. This relation is established by comparing
8474 -- the Slocs of Parent_Inst freeze node and Inst.
8475
8476 if List_Containing (Get_Package_Instantiation_Node (Par)) =
8477 List_Containing (N)
8478 and then Sloc (Freeze_Node (Par)) < Sloc (N)
8479 then
8480 Insert_Freeze_Node_For_Instance (N, F_Node);
8481 else
8482 Insert_After (Freeze_Node (Par), F_Node);
8483 end if;
8484
8485 -- Freeze package enclosing instance of inner generic after
8486 -- instance of enclosing generic.
8487
8488 elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8489 and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8490 then
8491 declare
8492 Enclosing : Entity_Id;
8493
8494 begin
8495 Enclosing := Corresponding_Spec (Parent (N));
8496
8497 if No (Enclosing) then
8498 Enclosing := Defining_Entity (Parent (N));
8499 end if;
8500
8501 Insert_Freeze_Node_For_Instance (N, F_Node);
8502 Ensure_Freeze_Node (Enclosing);
8503
8504 if not Is_List_Member (Freeze_Node (Enclosing)) then
8505
8506 -- The enclosing context is a subunit, insert the freeze
8507 -- node after the stub.
8508
8509 if Nkind (Parent (Parent (N))) = N_Subunit then
8510 Insert_Freeze_Node_For_Instance
8511 (Corresponding_Stub (Parent (Parent (N))),
8512 Freeze_Node (Enclosing));
8513
8514 -- The enclosing context is a package with a stub body
8515 -- which has already been replaced by the real body.
8516 -- Insert the freeze node after the actual body.
8517
8518 elsif Ekind (Enclosing) = E_Package
8519 and then Present (Body_Entity (Enclosing))
8520 and then Was_Originally_Stub
8521 (Parent (Body_Entity (Enclosing)))
8522 then
8523 Insert_Freeze_Node_For_Instance
8524 (Parent (Body_Entity (Enclosing)),
8525 Freeze_Node (Enclosing));
8526
8527 -- The parent instance has been frozen before the body of
8528 -- the enclosing package, insert the freeze node after
8529 -- the body.
8530
8531 elsif List_Containing (Freeze_Node (Par)) =
8532 List_Containing (Parent (N))
8533 and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8534 then
8535 Insert_Freeze_Node_For_Instance
8536 (Parent (N), Freeze_Node (Enclosing));
8537
8538 else
8539 Insert_After
8540 (Freeze_Node (Par), Freeze_Node (Enclosing));
8541 end if;
8542 end if;
8543 end;
8544
8545 else
8546 Insert_Freeze_Node_For_Instance (N, F_Node);
8547 end if;
8548
8549 else
8550 Insert_Freeze_Node_For_Instance (N, F_Node);
8551 end if;
8552 end if;
8553
8554 Set_Is_Frozen (Act_Id);
8555 Insert_Before (N, Act_Body);
8556 Mark_Rewrite_Insertion (Act_Body);
8557 end Install_Body;
8558
8559 -----------------------------
8560 -- Install_Formal_Packages --
8561 -----------------------------
8562
8563 procedure Install_Formal_Packages (Par : Entity_Id) is
8564 E : Entity_Id;
8565 Gen : Entity_Id;
8566 Gen_E : Entity_Id := Empty;
8567
8568 begin
8569 E := First_Entity (Par);
8570
8571 -- If we are installing an instance parent, locate the formal packages
8572 -- of its generic parent.
8573
8574 if Is_Generic_Instance (Par) then
8575 Gen := Generic_Parent (Package_Specification (Par));
8576 Gen_E := First_Entity (Gen);
8577 end if;
8578
8579 while Present (E) loop
8580 if Ekind (E) = E_Package
8581 and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8582 then
8583 -- If this is the renaming for the parent instance, done
8584
8585 if Renamed_Object (E) = Par then
8586 exit;
8587
8588 -- The visibility of a formal of an enclosing generic is already
8589 -- correct.
8590
8591 elsif Denotes_Formal_Package (E) then
8592 null;
8593
8594 elsif Present (Associated_Formal_Package (E)) then
8595 Check_Generic_Actuals (Renamed_Object (E), True);
8596 Set_Is_Hidden (E, False);
8597
8598 -- Find formal package in generic unit that corresponds to
8599 -- (instance of) formal package in instance.
8600
8601 while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8602 Next_Entity (Gen_E);
8603 end loop;
8604
8605 if Present (Gen_E) then
8606 Map_Formal_Package_Entities (Gen_E, E);
8607 end if;
8608 end if;
8609 end if;
8610
8611 Next_Entity (E);
8612 if Present (Gen_E) then
8613 Next_Entity (Gen_E);
8614 end if;
8615 end loop;
8616 end Install_Formal_Packages;
8617
8618 --------------------
8619 -- Install_Parent --
8620 --------------------
8621
8622 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8623 Ancestors : constant Elist_Id := New_Elmt_List;
8624 S : constant Entity_Id := Current_Scope;
8625 Inst_Par : Entity_Id;
8626 First_Par : Entity_Id;
8627 Inst_Node : Node_Id;
8628 Gen_Par : Entity_Id;
8629 First_Gen : Entity_Id;
8630 Elmt : Elmt_Id;
8631
8632 procedure Install_Noninstance_Specs (Par : Entity_Id);
8633 -- Install the scopes of noninstance parent units ending with Par
8634
8635 procedure Install_Spec (Par : Entity_Id);
8636 -- The child unit is within the declarative part of the parent, so the
8637 -- declarations within the parent are immediately visible.
8638
8639 -------------------------------
8640 -- Install_Noninstance_Specs --
8641 -------------------------------
8642
8643 procedure Install_Noninstance_Specs (Par : Entity_Id) is
8644 begin
8645 if Present (Par)
8646 and then Par /= Standard_Standard
8647 and then not In_Open_Scopes (Par)
8648 then
8649 Install_Noninstance_Specs (Scope (Par));
8650 Install_Spec (Par);
8651 end if;
8652 end Install_Noninstance_Specs;
8653
8654 ------------------
8655 -- Install_Spec --
8656 ------------------
8657
8658 procedure Install_Spec (Par : Entity_Id) is
8659 Spec : constant Node_Id := Package_Specification (Par);
8660
8661 begin
8662 -- If this parent of the child instance is a top-level unit,
8663 -- then record the unit and its visibility for later resetting in
8664 -- Remove_Parent. We exclude units that are generic instances, as we
8665 -- only want to record this information for the ultimate top-level
8666 -- noninstance parent (is that always correct???).
8667
8668 if Scope (Par) = Standard_Standard
8669 and then not Is_Generic_Instance (Par)
8670 then
8671 Parent_Unit_Visible := Is_Immediately_Visible (Par);
8672 Instance_Parent_Unit := Par;
8673 end if;
8674
8675 -- Open the parent scope and make it and its declarations visible.
8676 -- If this point is not within a body, then only the visible
8677 -- declarations should be made visible, and installation of the
8678 -- private declarations is deferred until the appropriate point
8679 -- within analysis of the spec being instantiated (see the handling
8680 -- of parent visibility in Analyze_Package_Specification). This is
8681 -- relaxed in the case where the parent unit is Ada.Tags, to avoid
8682 -- private view problems that occur when compiling instantiations of
8683 -- a generic child of that package (Generic_Dispatching_Constructor).
8684 -- If the instance freezes a tagged type, inlinings of operations
8685 -- from Ada.Tags may need the full view of type Tag. If inlining took
8686 -- proper account of establishing visibility of inlined subprograms'
8687 -- parents then it should be possible to remove this
8688 -- special check. ???
8689
8690 Push_Scope (Par);
8691 Set_Is_Immediately_Visible (Par);
8692 Install_Visible_Declarations (Par);
8693 Set_Use (Visible_Declarations (Spec));
8694
8695 if In_Body or else Is_RTU (Par, Ada_Tags) then
8696 Install_Private_Declarations (Par);
8697 Set_Use (Private_Declarations (Spec));
8698 end if;
8699 end Install_Spec;
8700
8701 -- Start of processing for Install_Parent
8702
8703 begin
8704 -- We need to install the parent instance to compile the instantiation
8705 -- of the child, but the child instance must appear in the current
8706 -- scope. Given that we cannot place the parent above the current scope
8707 -- in the scope stack, we duplicate the current scope and unstack both
8708 -- after the instantiation is complete.
8709
8710 -- If the parent is itself the instantiation of a child unit, we must
8711 -- also stack the instantiation of its parent, and so on. Each such
8712 -- ancestor is the prefix of the name in a prior instantiation.
8713
8714 -- If this is a nested instance, the parent unit itself resolves to
8715 -- a renaming of the parent instance, whose declaration we need.
8716
8717 -- Finally, the parent may be a generic (not an instance) when the
8718 -- child unit appears as a formal package.
8719
8720 Inst_Par := P;
8721
8722 if Present (Renamed_Entity (Inst_Par)) then
8723 Inst_Par := Renamed_Entity (Inst_Par);
8724 end if;
8725
8726 First_Par := Inst_Par;
8727
8728 Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
8729
8730 First_Gen := Gen_Par;
8731
8732 while Present (Gen_Par)
8733 and then Is_Child_Unit (Gen_Par)
8734 loop
8735 -- Load grandparent instance as well
8736
8737 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
8738
8739 if Nkind (Name (Inst_Node)) = N_Expanded_Name then
8740 Inst_Par := Entity (Prefix (Name (Inst_Node)));
8741
8742 if Present (Renamed_Entity (Inst_Par)) then
8743 Inst_Par := Renamed_Entity (Inst_Par);
8744 end if;
8745
8746 Gen_Par := Generic_Parent (Package_Specification (Inst_Par));
8747
8748 if Present (Gen_Par) then
8749 Prepend_Elmt (Inst_Par, Ancestors);
8750
8751 else
8752 -- Parent is not the name of an instantiation
8753
8754 Install_Noninstance_Specs (Inst_Par);
8755 exit;
8756 end if;
8757
8758 else
8759 -- Previous error
8760
8761 exit;
8762 end if;
8763 end loop;
8764
8765 if Present (First_Gen) then
8766 Append_Elmt (First_Par, Ancestors);
8767 else
8768 Install_Noninstance_Specs (First_Par);
8769 end if;
8770
8771 if not Is_Empty_Elmt_List (Ancestors) then
8772 Elmt := First_Elmt (Ancestors);
8773 while Present (Elmt) loop
8774 Install_Spec (Node (Elmt));
8775 Install_Formal_Packages (Node (Elmt));
8776 Next_Elmt (Elmt);
8777 end loop;
8778 end if;
8779
8780 if not In_Body then
8781 Push_Scope (S);
8782 end if;
8783 end Install_Parent;
8784
8785 -------------------------------
8786 -- Install_Hidden_Primitives --
8787 -------------------------------
8788
8789 procedure Install_Hidden_Primitives
8790 (Prims_List : in out Elist_Id;
8791 Gen_T : Entity_Id;
8792 Act_T : Entity_Id)
8793 is
8794 Elmt : Elmt_Id;
8795 List : Elist_Id := No_Elist;
8796 Prim_G_Elmt : Elmt_Id;
8797 Prim_A_Elmt : Elmt_Id;
8798 Prim_G : Node_Id;
8799 Prim_A : Node_Id;
8800
8801 begin
8802 -- No action needed in case of serious errors because we cannot trust
8803 -- in the order of primitives
8804
8805 if Serious_Errors_Detected > 0 then
8806 return;
8807
8808 -- No action possible if we don't have available the list of primitive
8809 -- operations
8810
8811 elsif No (Gen_T)
8812 or else not Is_Record_Type (Gen_T)
8813 or else not Is_Tagged_Type (Gen_T)
8814 or else not Is_Record_Type (Act_T)
8815 or else not Is_Tagged_Type (Act_T)
8816 then
8817 return;
8818
8819 -- There is no need to handle interface types since their primitives
8820 -- cannot be hidden
8821
8822 elsif Is_Interface (Gen_T) then
8823 return;
8824 end if;
8825
8826 Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
8827
8828 if not Is_Class_Wide_Type (Act_T) then
8829 Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
8830 else
8831 Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
8832 end if;
8833
8834 loop
8835 -- Skip predefined primitives in the generic formal
8836
8837 while Present (Prim_G_Elmt)
8838 and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
8839 loop
8840 Next_Elmt (Prim_G_Elmt);
8841 end loop;
8842
8843 -- Skip predefined primitives in the generic actual
8844
8845 while Present (Prim_A_Elmt)
8846 and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
8847 loop
8848 Next_Elmt (Prim_A_Elmt);
8849 end loop;
8850
8851 exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
8852
8853 Prim_G := Node (Prim_G_Elmt);
8854 Prim_A := Node (Prim_A_Elmt);
8855
8856 -- There is no need to handle interface primitives because their
8857 -- primitives are not hidden
8858
8859 exit when Present (Interface_Alias (Prim_G));
8860
8861 -- Here we install one hidden primitive
8862
8863 if Chars (Prim_G) /= Chars (Prim_A)
8864 and then Has_Suffix (Prim_A, 'P')
8865 and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
8866 then
8867 Set_Chars (Prim_A, Chars (Prim_G));
8868
8869 if List = No_Elist then
8870 List := New_Elmt_List;
8871 end if;
8872
8873 Append_Elmt (Prim_A, List);
8874 end if;
8875
8876 Next_Elmt (Prim_A_Elmt);
8877 Next_Elmt (Prim_G_Elmt);
8878 end loop;
8879
8880 -- Append the elements to the list of temporarily visible primitives
8881 -- avoiding duplicates.
8882
8883 if Present (List) then
8884 if No (Prims_List) then
8885 Prims_List := New_Elmt_List;
8886 end if;
8887
8888 Elmt := First_Elmt (List);
8889 while Present (Elmt) loop
8890 Append_Unique_Elmt (Node (Elmt), Prims_List);
8891 Next_Elmt (Elmt);
8892 end loop;
8893 end if;
8894 end Install_Hidden_Primitives;
8895
8896 -------------------------------
8897 -- Restore_Hidden_Primitives --
8898 -------------------------------
8899
8900 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
8901 Prim_Elmt : Elmt_Id;
8902 Prim : Node_Id;
8903
8904 begin
8905 if Prims_List /= No_Elist then
8906 Prim_Elmt := First_Elmt (Prims_List);
8907 while Present (Prim_Elmt) loop
8908 Prim := Node (Prim_Elmt);
8909 Set_Chars (Prim, Add_Suffix (Prim, 'P'));
8910 Next_Elmt (Prim_Elmt);
8911 end loop;
8912
8913 Prims_List := No_Elist;
8914 end if;
8915 end Restore_Hidden_Primitives;
8916
8917 --------------------------------
8918 -- Instantiate_Formal_Package --
8919 --------------------------------
8920
8921 function Instantiate_Formal_Package
8922 (Formal : Node_Id;
8923 Actual : Node_Id;
8924 Analyzed_Formal : Node_Id) return List_Id
8925 is
8926 Loc : constant Source_Ptr := Sloc (Actual);
8927 Actual_Pack : Entity_Id;
8928 Formal_Pack : Entity_Id;
8929 Gen_Parent : Entity_Id;
8930 Decls : List_Id;
8931 Nod : Node_Id;
8932 Parent_Spec : Node_Id;
8933
8934 procedure Find_Matching_Actual
8935 (F : Node_Id;
8936 Act : in out Entity_Id);
8937 -- We need to associate each formal entity in the formal package with
8938 -- the corresponding entity in the actual package. The actual package
8939 -- has been analyzed and possibly expanded, and as a result there is
8940 -- no one-to-one correspondence between the two lists (for example,
8941 -- the actual may include subtypes, itypes, and inherited primitive
8942 -- operations, interspersed among the renaming declarations for the
8943 -- actuals) . We retrieve the corresponding actual by name because each
8944 -- actual has the same name as the formal, and they do appear in the
8945 -- same order.
8946
8947 function Get_Formal_Entity (N : Node_Id) return Entity_Id;
8948 -- Retrieve entity of defining entity of generic formal parameter.
8949 -- Only the declarations of formals need to be considered when
8950 -- linking them to actuals, but the declarative list may include
8951 -- internal entities generated during analysis, and those are ignored.
8952
8953 procedure Match_Formal_Entity
8954 (Formal_Node : Node_Id;
8955 Formal_Ent : Entity_Id;
8956 Actual_Ent : Entity_Id);
8957 -- Associates the formal entity with the actual. In the case where
8958 -- Formal_Ent is a formal package, this procedure iterates through all
8959 -- of its formals and enters associations between the actuals occurring
8960 -- in the formal package's corresponding actual package (given by
8961 -- Actual_Ent) and the formal package's formal parameters. This
8962 -- procedure recurses if any of the parameters is itself a package.
8963
8964 function Is_Instance_Of
8965 (Act_Spec : Entity_Id;
8966 Gen_Anc : Entity_Id) return Boolean;
8967 -- The actual can be an instantiation of a generic within another
8968 -- instance, in which case there is no direct link from it to the
8969 -- original generic ancestor. In that case, we recognize that the
8970 -- ultimate ancestor is the same by examining names and scopes.
8971
8972 procedure Process_Nested_Formal (Formal : Entity_Id);
8973 -- If the current formal is declared with a box, its own formals are
8974 -- visible in the instance, as they were in the generic, and their
8975 -- Hidden flag must be reset. If some of these formals are themselves
8976 -- packages declared with a box, the processing must be recursive.
8977
8978 --------------------------
8979 -- Find_Matching_Actual --
8980 --------------------------
8981
8982 procedure Find_Matching_Actual
8983 (F : Node_Id;
8984 Act : in out Entity_Id)
8985 is
8986 Formal_Ent : Entity_Id;
8987
8988 begin
8989 case Nkind (Original_Node (F)) is
8990 when N_Formal_Object_Declaration |
8991 N_Formal_Type_Declaration =>
8992 Formal_Ent := Defining_Identifier (F);
8993
8994 while Chars (Act) /= Chars (Formal_Ent) loop
8995 Next_Entity (Act);
8996 end loop;
8997
8998 when N_Formal_Subprogram_Declaration |
8999 N_Formal_Package_Declaration |
9000 N_Package_Declaration |
9001 N_Generic_Package_Declaration =>
9002 Formal_Ent := Defining_Entity (F);
9003
9004 while Chars (Act) /= Chars (Formal_Ent) loop
9005 Next_Entity (Act);
9006 end loop;
9007
9008 when others =>
9009 raise Program_Error;
9010 end case;
9011 end Find_Matching_Actual;
9012
9013 -------------------------
9014 -- Match_Formal_Entity --
9015 -------------------------
9016
9017 procedure Match_Formal_Entity
9018 (Formal_Node : Node_Id;
9019 Formal_Ent : Entity_Id;
9020 Actual_Ent : Entity_Id)
9021 is
9022 Act_Pkg : Entity_Id;
9023
9024 begin
9025 Set_Instance_Of (Formal_Ent, Actual_Ent);
9026
9027 if Ekind (Actual_Ent) = E_Package then
9028
9029 -- Record associations for each parameter
9030
9031 Act_Pkg := Actual_Ent;
9032
9033 declare
9034 A_Ent : Entity_Id := First_Entity (Act_Pkg);
9035 F_Ent : Entity_Id;
9036 F_Node : Node_Id;
9037
9038 Gen_Decl : Node_Id;
9039 Formals : List_Id;
9040 Actual : Entity_Id;
9041
9042 begin
9043 -- Retrieve the actual given in the formal package declaration
9044
9045 Actual := Entity (Name (Original_Node (Formal_Node)));
9046
9047 -- The actual in the formal package declaration may be a
9048 -- renamed generic package, in which case we want to retrieve
9049 -- the original generic in order to traverse its formal part.
9050
9051 if Present (Renamed_Entity (Actual)) then
9052 Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
9053 else
9054 Gen_Decl := Unit_Declaration_Node (Actual);
9055 end if;
9056
9057 Formals := Generic_Formal_Declarations (Gen_Decl);
9058
9059 if Present (Formals) then
9060 F_Node := First_Non_Pragma (Formals);
9061 else
9062 F_Node := Empty;
9063 end if;
9064
9065 while Present (A_Ent)
9066 and then Present (F_Node)
9067 and then A_Ent /= First_Private_Entity (Act_Pkg)
9068 loop
9069 F_Ent := Get_Formal_Entity (F_Node);
9070
9071 if Present (F_Ent) then
9072
9073 -- This is a formal of the original package. Record
9074 -- association and recurse.
9075
9076 Find_Matching_Actual (F_Node, A_Ent);
9077 Match_Formal_Entity (F_Node, F_Ent, A_Ent);
9078 Next_Entity (A_Ent);
9079 end if;
9080
9081 Next_Non_Pragma (F_Node);
9082 end loop;
9083 end;
9084 end if;
9085 end Match_Formal_Entity;
9086
9087 -----------------------
9088 -- Get_Formal_Entity --
9089 -----------------------
9090
9091 function Get_Formal_Entity (N : Node_Id) return Entity_Id is
9092 Kind : constant Node_Kind := Nkind (Original_Node (N));
9093 begin
9094 case Kind is
9095 when N_Formal_Object_Declaration =>
9096 return Defining_Identifier (N);
9097
9098 when N_Formal_Type_Declaration =>
9099 return Defining_Identifier (N);
9100
9101 when N_Formal_Subprogram_Declaration =>
9102 return Defining_Unit_Name (Specification (N));
9103
9104 when N_Formal_Package_Declaration =>
9105 return Defining_Identifier (Original_Node (N));
9106
9107 when N_Generic_Package_Declaration =>
9108 return Defining_Identifier (Original_Node (N));
9109
9110 -- All other declarations are introduced by semantic analysis and
9111 -- have no match in the actual.
9112
9113 when others =>
9114 return Empty;
9115 end case;
9116 end Get_Formal_Entity;
9117
9118 --------------------
9119 -- Is_Instance_Of --
9120 --------------------
9121
9122 function Is_Instance_Of
9123 (Act_Spec : Entity_Id;
9124 Gen_Anc : Entity_Id) return Boolean
9125 is
9126 Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
9127
9128 begin
9129 if No (Gen_Par) then
9130 return False;
9131
9132 -- Simplest case: the generic parent of the actual is the formal
9133
9134 elsif Gen_Par = Gen_Anc then
9135 return True;
9136
9137 elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
9138 return False;
9139
9140 -- The actual may be obtained through several instantiations. Its
9141 -- scope must itself be an instance of a generic declared in the
9142 -- same scope as the formal. Any other case is detected above.
9143
9144 elsif not Is_Generic_Instance (Scope (Gen_Par)) then
9145 return False;
9146
9147 else
9148 return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
9149 end if;
9150 end Is_Instance_Of;
9151
9152 ---------------------------
9153 -- Process_Nested_Formal --
9154 ---------------------------
9155
9156 procedure Process_Nested_Formal (Formal : Entity_Id) is
9157 Ent : Entity_Id;
9158
9159 begin
9160 if Present (Associated_Formal_Package (Formal))
9161 and then Box_Present (Parent (Associated_Formal_Package (Formal)))
9162 then
9163 Ent := First_Entity (Formal);
9164 while Present (Ent) loop
9165 Set_Is_Hidden (Ent, False);
9166 Set_Is_Visible_Formal (Ent);
9167 Set_Is_Potentially_Use_Visible
9168 (Ent, Is_Potentially_Use_Visible (Formal));
9169
9170 if Ekind (Ent) = E_Package then
9171 exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
9172 Process_Nested_Formal (Ent);
9173 end if;
9174
9175 Next_Entity (Ent);
9176 end loop;
9177 end if;
9178 end Process_Nested_Formal;
9179
9180 -- Start of processing for Instantiate_Formal_Package
9181
9182 begin
9183 Analyze (Actual);
9184
9185 if not Is_Entity_Name (Actual)
9186 or else Ekind (Entity (Actual)) /= E_Package
9187 then
9188 Error_Msg_N
9189 ("expect package instance to instantiate formal", Actual);
9190 Abandon_Instantiation (Actual);
9191 raise Program_Error;
9192
9193 else
9194 Actual_Pack := Entity (Actual);
9195 Set_Is_Instantiated (Actual_Pack);
9196
9197 -- The actual may be a renamed package, or an outer generic formal
9198 -- package whose instantiation is converted into a renaming.
9199
9200 if Present (Renamed_Object (Actual_Pack)) then
9201 Actual_Pack := Renamed_Object (Actual_Pack);
9202 end if;
9203
9204 if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
9205 Gen_Parent := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
9206 Formal_Pack := Defining_Identifier (Analyzed_Formal);
9207 else
9208 Gen_Parent :=
9209 Generic_Parent (Specification (Analyzed_Formal));
9210 Formal_Pack :=
9211 Defining_Unit_Name (Specification (Analyzed_Formal));
9212 end if;
9213
9214 if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
9215 Parent_Spec := Package_Specification (Actual_Pack);
9216 else
9217 Parent_Spec := Parent (Actual_Pack);
9218 end if;
9219
9220 if Gen_Parent = Any_Id then
9221 Error_Msg_N
9222 ("previous error in declaration of formal package", Actual);
9223 Abandon_Instantiation (Actual);
9224
9225 elsif
9226 Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
9227 then
9228 null;
9229
9230 else
9231 Error_Msg_NE
9232 ("actual parameter must be instance of&", Actual, Gen_Parent);
9233 Abandon_Instantiation (Actual);
9234 end if;
9235
9236 Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
9237 Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
9238
9239 Nod :=
9240 Make_Package_Renaming_Declaration (Loc,
9241 Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
9242 Name => New_Occurrence_Of (Actual_Pack, Loc));
9243
9244 Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
9245 Defining_Identifier (Formal));
9246 Decls := New_List (Nod);
9247
9248 -- If the formal F has a box, then the generic declarations are
9249 -- visible in the generic G. In an instance of G, the corresponding
9250 -- entities in the actual for F (which are the actuals for the
9251 -- instantiation of the generic that F denotes) must also be made
9252 -- visible for analysis of the current instance. On exit from the
9253 -- current instance, those entities are made private again. If the
9254 -- actual is currently in use, these entities are also use-visible.
9255
9256 -- The loop through the actual entities also steps through the formal
9257 -- entities and enters associations from formals to actuals into the
9258 -- renaming map. This is necessary to properly handle checking of
9259 -- actual parameter associations for later formals that depend on
9260 -- actuals declared in the formal package.
9261
9262 -- In Ada 2005, partial parameterization requires that we make
9263 -- visible the actuals corresponding to formals that were defaulted
9264 -- in the formal package. There formals are identified because they
9265 -- remain formal generics within the formal package, rather than
9266 -- being renamings of the actuals supplied.
9267
9268 declare
9269 Gen_Decl : constant Node_Id :=
9270 Unit_Declaration_Node (Gen_Parent);
9271 Formals : constant List_Id :=
9272 Generic_Formal_Declarations (Gen_Decl);
9273
9274 Actual_Ent : Entity_Id;
9275 Actual_Of_Formal : Node_Id;
9276 Formal_Node : Node_Id;
9277 Formal_Ent : Entity_Id;
9278
9279 begin
9280 if Present (Formals) then
9281 Formal_Node := First_Non_Pragma (Formals);
9282 else
9283 Formal_Node := Empty;
9284 end if;
9285
9286 Actual_Ent := First_Entity (Actual_Pack);
9287 Actual_Of_Formal :=
9288 First (Visible_Declarations (Specification (Analyzed_Formal)));
9289 while Present (Actual_Ent)
9290 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9291 loop
9292 if Present (Formal_Node) then
9293 Formal_Ent := Get_Formal_Entity (Formal_Node);
9294
9295 if Present (Formal_Ent) then
9296 Find_Matching_Actual (Formal_Node, Actual_Ent);
9297 Match_Formal_Entity
9298 (Formal_Node, Formal_Ent, Actual_Ent);
9299
9300 -- We iterate at the same time over the actuals of the
9301 -- local package created for the formal, to determine
9302 -- which one of the formals of the original generic were
9303 -- defaulted in the formal. The corresponding actual
9304 -- entities are visible in the enclosing instance.
9305
9306 if Box_Present (Formal)
9307 or else
9308 (Present (Actual_Of_Formal)
9309 and then
9310 Is_Generic_Formal
9311 (Get_Formal_Entity (Actual_Of_Formal)))
9312 then
9313 Set_Is_Hidden (Actual_Ent, False);
9314 Set_Is_Visible_Formal (Actual_Ent);
9315 Set_Is_Potentially_Use_Visible
9316 (Actual_Ent, In_Use (Actual_Pack));
9317
9318 if Ekind (Actual_Ent) = E_Package then
9319 Process_Nested_Formal (Actual_Ent);
9320 end if;
9321
9322 else
9323 Set_Is_Hidden (Actual_Ent);
9324 Set_Is_Potentially_Use_Visible (Actual_Ent, False);
9325 end if;
9326 end if;
9327
9328 Next_Non_Pragma (Formal_Node);
9329 Next (Actual_Of_Formal);
9330
9331 else
9332 -- No further formals to match, but the generic part may
9333 -- contain inherited operation that are not hidden in the
9334 -- enclosing instance.
9335
9336 Next_Entity (Actual_Ent);
9337 end if;
9338 end loop;
9339
9340 -- Inherited subprograms generated by formal derived types are
9341 -- also visible if the types are.
9342
9343 Actual_Ent := First_Entity (Actual_Pack);
9344 while Present (Actual_Ent)
9345 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9346 loop
9347 if Is_Overloadable (Actual_Ent)
9348 and then
9349 Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
9350 and then
9351 not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
9352 then
9353 Set_Is_Hidden (Actual_Ent, False);
9354 Set_Is_Potentially_Use_Visible
9355 (Actual_Ent, In_Use (Actual_Pack));
9356 end if;
9357
9358 Next_Entity (Actual_Ent);
9359 end loop;
9360 end;
9361
9362 -- If the formal is not declared with a box, reanalyze it as an
9363 -- abbreviated instantiation, to verify the matching rules of 12.7.
9364 -- The actual checks are performed after the generic associations
9365 -- have been analyzed, to guarantee the same visibility for this
9366 -- instantiation and for the actuals.
9367
9368 -- In Ada 2005, the generic associations for the formal can include
9369 -- defaulted parameters. These are ignored during check. This
9370 -- internal instantiation is removed from the tree after conformance
9371 -- checking, because it contains formal declarations for those
9372 -- defaulted parameters, and those should not reach the back-end.
9373
9374 if not Box_Present (Formal) then
9375 declare
9376 I_Pack : constant Entity_Id :=
9377 Make_Temporary (Sloc (Actual), 'P');
9378
9379 begin
9380 Set_Is_Internal (I_Pack);
9381
9382 Append_To (Decls,
9383 Make_Package_Instantiation (Sloc (Actual),
9384 Defining_Unit_Name => I_Pack,
9385 Name =>
9386 New_Occurrence_Of
9387 (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
9388 Generic_Associations =>
9389 Generic_Associations (Formal)));
9390 end;
9391 end if;
9392
9393 return Decls;
9394 end if;
9395 end Instantiate_Formal_Package;
9396
9397 -----------------------------------
9398 -- Instantiate_Formal_Subprogram --
9399 -----------------------------------
9400
9401 function Instantiate_Formal_Subprogram
9402 (Formal : Node_Id;
9403 Actual : Node_Id;
9404 Analyzed_Formal : Node_Id) return Node_Id
9405 is
9406 Loc : Source_Ptr;
9407 Formal_Sub : constant Entity_Id :=
9408 Defining_Unit_Name (Specification (Formal));
9409 Analyzed_S : constant Entity_Id :=
9410 Defining_Unit_Name (Specification (Analyzed_Formal));
9411 Decl_Node : Node_Id;
9412 Nam : Node_Id;
9413 New_Spec : Node_Id;
9414
9415 function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9416 -- If the generic is a child unit, the parent has been installed on the
9417 -- scope stack, but a default subprogram cannot resolve to something
9418 -- on the parent because that parent is not really part of the visible
9419 -- context (it is there to resolve explicit local entities). If the
9420 -- default has resolved in this way, we remove the entity from immediate
9421 -- visibility and analyze the node again to emit an error message or
9422 -- find another visible candidate.
9423
9424 procedure Valid_Actual_Subprogram (Act : Node_Id);
9425 -- Perform legality check and raise exception on failure
9426
9427 -----------------------
9428 -- From_Parent_Scope --
9429 -----------------------
9430
9431 function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9432 Gen_Scope : Node_Id;
9433
9434 begin
9435 Gen_Scope := Scope (Analyzed_S);
9436 while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9437 if Scope (Subp) = Scope (Gen_Scope) then
9438 return True;
9439 end if;
9440
9441 Gen_Scope := Scope (Gen_Scope);
9442 end loop;
9443
9444 return False;
9445 end From_Parent_Scope;
9446
9447 -----------------------------
9448 -- Valid_Actual_Subprogram --
9449 -----------------------------
9450
9451 procedure Valid_Actual_Subprogram (Act : Node_Id) is
9452 Act_E : Entity_Id;
9453
9454 begin
9455 if Is_Entity_Name (Act) then
9456 Act_E := Entity (Act);
9457
9458 elsif Nkind (Act) = N_Selected_Component
9459 and then Is_Entity_Name (Selector_Name (Act))
9460 then
9461 Act_E := Entity (Selector_Name (Act));
9462
9463 else
9464 Act_E := Empty;
9465 end if;
9466
9467 if (Present (Act_E) and then Is_Overloadable (Act_E))
9468 or else Nkind_In (Act, N_Attribute_Reference,
9469 N_Indexed_Component,
9470 N_Character_Literal,
9471 N_Explicit_Dereference)
9472 then
9473 return;
9474 end if;
9475
9476 Error_Msg_NE
9477 ("expect subprogram or entry name in instantiation of&",
9478 Instantiation_Node, Formal_Sub);
9479 Abandon_Instantiation (Instantiation_Node);
9480
9481 end Valid_Actual_Subprogram;
9482
9483 -- Start of processing for Instantiate_Formal_Subprogram
9484
9485 begin
9486 New_Spec := New_Copy_Tree (Specification (Formal));
9487
9488 -- The tree copy has created the proper instantiation sloc for the
9489 -- new specification. Use this location for all other constructed
9490 -- declarations.
9491
9492 Loc := Sloc (Defining_Unit_Name (New_Spec));
9493
9494 -- Create new entity for the actual (New_Copy_Tree does not)
9495
9496 Set_Defining_Unit_Name
9497 (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9498
9499 -- Create new entities for the each of the formals in the
9500 -- specification of the renaming declaration built for the actual.
9501
9502 if Present (Parameter_Specifications (New_Spec)) then
9503 declare
9504 F : Node_Id;
9505 begin
9506 F := First (Parameter_Specifications (New_Spec));
9507 while Present (F) loop
9508 Set_Defining_Identifier (F,
9509 Make_Defining_Identifier (Sloc (F),
9510 Chars => Chars (Defining_Identifier (F))));
9511 Next (F);
9512 end loop;
9513 end;
9514 end if;
9515
9516 -- Find entity of actual. If the actual is an attribute reference, it
9517 -- cannot be resolved here (its formal is missing) but is handled
9518 -- instead in Attribute_Renaming. If the actual is overloaded, it is
9519 -- fully resolved subsequently, when the renaming declaration for the
9520 -- formal is analyzed. If it is an explicit dereference, resolve the
9521 -- prefix but not the actual itself, to prevent interpretation as call.
9522
9523 if Present (Actual) then
9524 Loc := Sloc (Actual);
9525 Set_Sloc (New_Spec, Loc);
9526
9527 if Nkind (Actual) = N_Operator_Symbol then
9528 Find_Direct_Name (Actual);
9529
9530 elsif Nkind (Actual) = N_Explicit_Dereference then
9531 Analyze (Prefix (Actual));
9532
9533 elsif Nkind (Actual) /= N_Attribute_Reference then
9534 Analyze (Actual);
9535 end if;
9536
9537 Valid_Actual_Subprogram (Actual);
9538 Nam := Actual;
9539
9540 elsif Present (Default_Name (Formal)) then
9541 if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9542 N_Selected_Component,
9543 N_Indexed_Component,
9544 N_Character_Literal)
9545 and then Present (Entity (Default_Name (Formal)))
9546 then
9547 Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9548 else
9549 Nam := New_Copy (Default_Name (Formal));
9550 Set_Sloc (Nam, Loc);
9551 end if;
9552
9553 elsif Box_Present (Formal) then
9554
9555 -- Actual is resolved at the point of instantiation. Create an
9556 -- identifier or operator with the same name as the formal.
9557
9558 if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9559 Nam := Make_Operator_Symbol (Loc,
9560 Chars => Chars (Formal_Sub),
9561 Strval => No_String);
9562 else
9563 Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9564 end if;
9565
9566 elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9567 and then Null_Present (Specification (Formal))
9568 then
9569 -- Generate null body for procedure, for use in the instance
9570
9571 Decl_Node :=
9572 Make_Subprogram_Body (Loc,
9573 Specification => New_Spec,
9574 Declarations => New_List,
9575 Handled_Statement_Sequence =>
9576 Make_Handled_Sequence_Of_Statements (Loc,
9577 Statements => New_List (Make_Null_Statement (Loc))));
9578
9579 Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9580 return Decl_Node;
9581
9582 else
9583 Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9584 Error_Msg_NE
9585 ("missing actual&", Instantiation_Node, Formal_Sub);
9586 Error_Msg_NE
9587 ("\in instantiation of & declared#",
9588 Instantiation_Node, Scope (Analyzed_S));
9589 Abandon_Instantiation (Instantiation_Node);
9590 end if;
9591
9592 Decl_Node :=
9593 Make_Subprogram_Renaming_Declaration (Loc,
9594 Specification => New_Spec,
9595 Name => Nam);
9596
9597 -- If we do not have an actual and the formal specified <> then set to
9598 -- get proper default.
9599
9600 if No (Actual) and then Box_Present (Formal) then
9601 Set_From_Default (Decl_Node);
9602 end if;
9603
9604 -- Gather possible interpretations for the actual before analyzing the
9605 -- instance. If overloaded, it will be resolved when analyzing the
9606 -- renaming declaration.
9607
9608 if Box_Present (Formal)
9609 and then No (Actual)
9610 then
9611 Analyze (Nam);
9612
9613 if Is_Child_Unit (Scope (Analyzed_S))
9614 and then Present (Entity (Nam))
9615 then
9616 if not Is_Overloaded (Nam) then
9617 if From_Parent_Scope (Entity (Nam)) then
9618 Set_Is_Immediately_Visible (Entity (Nam), False);
9619 Set_Entity (Nam, Empty);
9620 Set_Etype (Nam, Empty);
9621
9622 Analyze (Nam);
9623 Set_Is_Immediately_Visible (Entity (Nam));
9624 end if;
9625
9626 else
9627 declare
9628 I : Interp_Index;
9629 It : Interp;
9630
9631 begin
9632 Get_First_Interp (Nam, I, It);
9633 while Present (It.Nam) loop
9634 if From_Parent_Scope (It.Nam) then
9635 Remove_Interp (I);
9636 end if;
9637
9638 Get_Next_Interp (I, It);
9639 end loop;
9640 end;
9641 end if;
9642 end if;
9643 end if;
9644
9645 -- The generic instantiation freezes the actual. This can only be done
9646 -- once the actual is resolved, in the analysis of the renaming
9647 -- declaration. To make the formal subprogram entity available, we set
9648 -- Corresponding_Formal_Spec to point to the formal subprogram entity.
9649 -- This is also needed in Analyze_Subprogram_Renaming for the processing
9650 -- of formal abstract subprograms.
9651
9652 Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9653
9654 -- We cannot analyze the renaming declaration, and thus find the actual,
9655 -- until all the actuals are assembled in the instance. For subsequent
9656 -- checks of other actuals, indicate the node that will hold the
9657 -- instance of this formal.
9658
9659 Set_Instance_Of (Analyzed_S, Nam);
9660
9661 if Nkind (Actual) = N_Selected_Component
9662 and then Is_Task_Type (Etype (Prefix (Actual)))
9663 and then not Is_Frozen (Etype (Prefix (Actual)))
9664 then
9665 -- The renaming declaration will create a body, which must appear
9666 -- outside of the instantiation, We move the renaming declaration
9667 -- out of the instance, and create an additional renaming inside,
9668 -- to prevent freezing anomalies.
9669
9670 declare
9671 Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9672
9673 begin
9674 Set_Defining_Unit_Name (New_Spec, Anon_Id);
9675 Insert_Before (Instantiation_Node, Decl_Node);
9676 Analyze (Decl_Node);
9677
9678 -- Now create renaming within the instance
9679
9680 Decl_Node :=
9681 Make_Subprogram_Renaming_Declaration (Loc,
9682 Specification => New_Copy_Tree (New_Spec),
9683 Name => New_Occurrence_Of (Anon_Id, Loc));
9684
9685 Set_Defining_Unit_Name (Specification (Decl_Node),
9686 Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9687 end;
9688 end if;
9689
9690 return Decl_Node;
9691 end Instantiate_Formal_Subprogram;
9692
9693 ------------------------
9694 -- Instantiate_Object --
9695 ------------------------
9696
9697 function Instantiate_Object
9698 (Formal : Node_Id;
9699 Actual : Node_Id;
9700 Analyzed_Formal : Node_Id) return List_Id
9701 is
9702 Gen_Obj : constant Entity_Id := Defining_Identifier (Formal);
9703 A_Gen_Obj : constant Entity_Id :=
9704 Defining_Identifier (Analyzed_Formal);
9705 Acc_Def : Node_Id := Empty;
9706 Act_Assoc : constant Node_Id := Parent (Actual);
9707 Actual_Decl : Node_Id := Empty;
9708 Decl_Node : Node_Id;
9709 Def : Node_Id;
9710 Ftyp : Entity_Id;
9711 List : constant List_Id := New_List;
9712 Loc : constant Source_Ptr := Sloc (Actual);
9713 Orig_Ftyp : constant Entity_Id := Etype (A_Gen_Obj);
9714 Subt_Decl : Node_Id := Empty;
9715 Subt_Mark : Node_Id := Empty;
9716
9717 begin
9718 if Present (Subtype_Mark (Formal)) then
9719 Subt_Mark := Subtype_Mark (Formal);
9720 else
9721 Check_Access_Definition (Formal);
9722 Acc_Def := Access_Definition (Formal);
9723 end if;
9724
9725 -- Sloc for error message on missing actual
9726
9727 Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
9728
9729 if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
9730 Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
9731 end if;
9732
9733 Set_Parent (List, Parent (Actual));
9734
9735 -- OUT present
9736
9737 if Out_Present (Formal) then
9738
9739 -- An IN OUT generic actual must be a name. The instantiation is a
9740 -- renaming declaration. The actual is the name being renamed. We
9741 -- use the actual directly, rather than a copy, because it is not
9742 -- used further in the list of actuals, and because a copy or a use
9743 -- of relocate_node is incorrect if the instance is nested within a
9744 -- generic. In order to simplify ASIS searches, the Generic_Parent
9745 -- field links the declaration to the generic association.
9746
9747 if No (Actual) then
9748 Error_Msg_NE
9749 ("missing actual&",
9750 Instantiation_Node, Gen_Obj);
9751 Error_Msg_NE
9752 ("\in instantiation of & declared#",
9753 Instantiation_Node, Scope (A_Gen_Obj));
9754 Abandon_Instantiation (Instantiation_Node);
9755 end if;
9756
9757 if Present (Subt_Mark) then
9758 Decl_Node :=
9759 Make_Object_Renaming_Declaration (Loc,
9760 Defining_Identifier => New_Copy (Gen_Obj),
9761 Subtype_Mark => New_Copy_Tree (Subt_Mark),
9762 Name => Actual);
9763
9764 else pragma Assert (Present (Acc_Def));
9765 Decl_Node :=
9766 Make_Object_Renaming_Declaration (Loc,
9767 Defining_Identifier => New_Copy (Gen_Obj),
9768 Access_Definition => New_Copy_Tree (Acc_Def),
9769 Name => Actual);
9770 end if;
9771
9772 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9773
9774 -- The analysis of the actual may produce Insert_Action nodes, so
9775 -- the declaration must have a context in which to attach them.
9776
9777 Append (Decl_Node, List);
9778 Analyze (Actual);
9779
9780 -- Return if the analysis of the actual reported some error
9781
9782 if Etype (Actual) = Any_Type then
9783 return List;
9784 end if;
9785
9786 -- This check is performed here because Analyze_Object_Renaming will
9787 -- not check it when Comes_From_Source is False. Note though that the
9788 -- check for the actual being the name of an object will be performed
9789 -- in Analyze_Object_Renaming.
9790
9791 if Is_Object_Reference (Actual)
9792 and then Is_Dependent_Component_Of_Mutable_Object (Actual)
9793 then
9794 Error_Msg_N
9795 ("illegal discriminant-dependent component for in out parameter",
9796 Actual);
9797 end if;
9798
9799 -- The actual has to be resolved in order to check that it is a
9800 -- variable (due to cases such as F (1), where F returns access to
9801 -- an array, and for overloaded prefixes).
9802
9803 Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
9804
9805 -- If the type of the formal is not itself a formal, and the current
9806 -- unit is a child unit, the formal type must be declared in a
9807 -- parent, and must be retrieved by visibility.
9808
9809 if Ftyp = Orig_Ftyp
9810 and then Is_Generic_Unit (Scope (Ftyp))
9811 and then Is_Child_Unit (Scope (A_Gen_Obj))
9812 then
9813 declare
9814 Temp : constant Node_Id :=
9815 New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
9816 begin
9817 Set_Entity (Temp, Empty);
9818 Find_Type (Temp);
9819 Ftyp := Entity (Temp);
9820 end;
9821 end if;
9822
9823 if Is_Private_Type (Ftyp)
9824 and then not Is_Private_Type (Etype (Actual))
9825 and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
9826 or else Base_Type (Etype (Actual)) = Ftyp)
9827 then
9828 -- If the actual has the type of the full view of the formal, or
9829 -- else a non-private subtype of the formal, then the visibility
9830 -- of the formal type has changed. Add to the actuals a subtype
9831 -- declaration that will force the exchange of views in the body
9832 -- of the instance as well.
9833
9834 Subt_Decl :=
9835 Make_Subtype_Declaration (Loc,
9836 Defining_Identifier => Make_Temporary (Loc, 'P'),
9837 Subtype_Indication => New_Occurrence_Of (Ftyp, Loc));
9838
9839 Prepend (Subt_Decl, List);
9840
9841 Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
9842 Exchange_Declarations (Ftyp);
9843 end if;
9844
9845 Resolve (Actual, Ftyp);
9846
9847 if not Denotes_Variable (Actual) then
9848 Error_Msg_NE
9849 ("actual for& must be a variable", Actual, Gen_Obj);
9850
9851 elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
9852
9853 -- Ada 2005 (AI-423): For a generic formal object of mode in out,
9854 -- the type of the actual shall resolve to a specific anonymous
9855 -- access type.
9856
9857 if Ada_Version < Ada_2005
9858 or else
9859 Ekind (Base_Type (Ftyp)) /=
9860 E_Anonymous_Access_Type
9861 or else
9862 Ekind (Base_Type (Etype (Actual))) /=
9863 E_Anonymous_Access_Type
9864 then
9865 Error_Msg_NE ("type of actual does not match type of&",
9866 Actual, Gen_Obj);
9867 end if;
9868 end if;
9869
9870 Note_Possible_Modification (Actual, Sure => True);
9871
9872 -- Check for instantiation of atomic/volatile actual for
9873 -- non-atomic/volatile formal (RM C.6 (12)).
9874
9875 if Is_Atomic_Object (Actual)
9876 and then not Is_Atomic (Orig_Ftyp)
9877 then
9878 Error_Msg_N
9879 ("cannot instantiate non-atomic formal object " &
9880 "with atomic actual", Actual);
9881
9882 elsif Is_Volatile_Object (Actual)
9883 and then not Is_Volatile (Orig_Ftyp)
9884 then
9885 Error_Msg_N
9886 ("cannot instantiate non-volatile formal object " &
9887 "with volatile actual", Actual);
9888 end if;
9889
9890 -- Formal in-parameter
9891
9892 else
9893 -- The instantiation of a generic formal in-parameter is constant
9894 -- declaration. The actual is the expression for that declaration.
9895
9896 if Present (Actual) then
9897 if Present (Subt_Mark) then
9898 Def := Subt_Mark;
9899 else pragma Assert (Present (Acc_Def));
9900 Def := Acc_Def;
9901 end if;
9902
9903 Decl_Node :=
9904 Make_Object_Declaration (Loc,
9905 Defining_Identifier => New_Copy (Gen_Obj),
9906 Constant_Present => True,
9907 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9908 Object_Definition => New_Copy_Tree (Def),
9909 Expression => Actual);
9910
9911 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9912
9913 -- A generic formal object of a tagged type is defined to be
9914 -- aliased so the new constant must also be treated as aliased.
9915
9916 if Is_Tagged_Type (Etype (A_Gen_Obj)) then
9917 Set_Aliased_Present (Decl_Node);
9918 end if;
9919
9920 Append (Decl_Node, List);
9921
9922 -- No need to repeat (pre-)analysis of some expression nodes
9923 -- already handled in Preanalyze_Actuals.
9924
9925 if Nkind (Actual) /= N_Allocator then
9926 Analyze (Actual);
9927
9928 -- Return if the analysis of the actual reported some error
9929
9930 if Etype (Actual) = Any_Type then
9931 return List;
9932 end if;
9933 end if;
9934
9935 declare
9936 Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
9937 Typ : Entity_Id;
9938
9939 begin
9940 Typ := Get_Instance_Of (Formal_Type);
9941
9942 Freeze_Before (Instantiation_Node, Typ);
9943
9944 -- If the actual is an aggregate, perform name resolution on
9945 -- its components (the analysis of an aggregate does not do it)
9946 -- to capture local names that may be hidden if the generic is
9947 -- a child unit.
9948
9949 if Nkind (Actual) = N_Aggregate then
9950 Preanalyze_And_Resolve (Actual, Typ);
9951 end if;
9952
9953 if Is_Limited_Type (Typ)
9954 and then not OK_For_Limited_Init (Typ, Actual)
9955 then
9956 Error_Msg_N
9957 ("initialization not allowed for limited types", Actual);
9958 Explain_Limited_Type (Typ, Actual);
9959 end if;
9960 end;
9961
9962 elsif Present (Default_Expression (Formal)) then
9963
9964 -- Use default to construct declaration
9965
9966 if Present (Subt_Mark) then
9967 Def := Subt_Mark;
9968 else pragma Assert (Present (Acc_Def));
9969 Def := Acc_Def;
9970 end if;
9971
9972 Decl_Node :=
9973 Make_Object_Declaration (Sloc (Formal),
9974 Defining_Identifier => New_Copy (Gen_Obj),
9975 Constant_Present => True,
9976 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9977 Object_Definition => New_Copy (Def),
9978 Expression => New_Copy_Tree
9979 (Default_Expression (Formal)));
9980
9981 Append (Decl_Node, List);
9982 Set_Analyzed (Expression (Decl_Node), False);
9983
9984 else
9985 Error_Msg_NE
9986 ("missing actual&",
9987 Instantiation_Node, Gen_Obj);
9988 Error_Msg_NE ("\in instantiation of & declared#",
9989 Instantiation_Node, Scope (A_Gen_Obj));
9990
9991 if Is_Scalar_Type (Etype (A_Gen_Obj)) then
9992
9993 -- Create dummy constant declaration so that instance can be
9994 -- analyzed, to minimize cascaded visibility errors.
9995
9996 if Present (Subt_Mark) then
9997 Def := Subt_Mark;
9998 else pragma Assert (Present (Acc_Def));
9999 Def := Acc_Def;
10000 end if;
10001
10002 Decl_Node :=
10003 Make_Object_Declaration (Loc,
10004 Defining_Identifier => New_Copy (Gen_Obj),
10005 Constant_Present => True,
10006 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
10007 Object_Definition => New_Copy (Def),
10008 Expression =>
10009 Make_Attribute_Reference (Sloc (Gen_Obj),
10010 Attribute_Name => Name_First,
10011 Prefix => New_Copy (Def)));
10012
10013 Append (Decl_Node, List);
10014
10015 else
10016 Abandon_Instantiation (Instantiation_Node);
10017 end if;
10018 end if;
10019 end if;
10020
10021 if Nkind (Actual) in N_Has_Entity then
10022 Actual_Decl := Parent (Entity (Actual));
10023 end if;
10024
10025 -- Ada 2005 (AI-423): For a formal object declaration with a null
10026 -- exclusion or an access definition that has a null exclusion: If the
10027 -- actual matching the formal object declaration denotes a generic
10028 -- formal object of another generic unit G, and the instantiation
10029 -- containing the actual occurs within the body of G or within the body
10030 -- of a generic unit declared within the declarative region of G, then
10031 -- the declaration of the formal object of G must have a null exclusion.
10032 -- Otherwise, the subtype of the actual matching the formal object
10033 -- declaration shall exclude null.
10034
10035 if Ada_Version >= Ada_2005
10036 and then Present (Actual_Decl)
10037 and then
10038 Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
10039 N_Object_Declaration)
10040 and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
10041 and then not Has_Null_Exclusion (Actual_Decl)
10042 and then Has_Null_Exclusion (Analyzed_Formal)
10043 then
10044 Error_Msg_Sloc := Sloc (Analyzed_Formal);
10045 Error_Msg_N
10046 ("actual must exclude null to match generic formal#", Actual);
10047 end if;
10048
10049 -- An effectively volatile object cannot be used as an actual in
10050 -- a generic instance. The following check is only relevant when
10051 -- SPARK_Mode is on as it is not a standard Ada legality rule.
10052
10053 if SPARK_Mode = On
10054 and then Present (Actual)
10055 and then Is_Effectively_Volatile_Object (Actual)
10056 then
10057 Error_Msg_N
10058 ("volatile object cannot act as actual in generic instantiation "
10059 & "(SPARK RM 7.1.3(8))", Actual);
10060 end if;
10061
10062 return List;
10063 end Instantiate_Object;
10064
10065 ------------------------------
10066 -- Instantiate_Package_Body --
10067 ------------------------------
10068
10069 procedure Instantiate_Package_Body
10070 (Body_Info : Pending_Body_Info;
10071 Inlined_Body : Boolean := False;
10072 Body_Optional : Boolean := False)
10073 is
10074 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10075 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10076 Loc : constant Source_Ptr := Sloc (Inst_Node);
10077
10078 Gen_Id : constant Node_Id := Name (Inst_Node);
10079 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10080 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10081 Act_Spec : constant Node_Id := Specification (Act_Decl);
10082 Act_Decl_Id : constant Entity_Id := Defining_Entity (Act_Spec);
10083
10084 Act_Body_Name : Node_Id;
10085 Gen_Body : Node_Id;
10086 Gen_Body_Id : Node_Id;
10087 Act_Body : Node_Id;
10088 Act_Body_Id : Entity_Id;
10089
10090 Parent_Installed : Boolean := False;
10091 Save_Style_Check : constant Boolean := Style_Check;
10092
10093 Par_Ent : Entity_Id := Empty;
10094 Par_Vis : Boolean := False;
10095
10096 Vis_Prims_List : Elist_Id := No_Elist;
10097 -- List of primitives made temporarily visible in the instantiation
10098 -- to match the visibility of the formal type
10099
10100 procedure Check_Initialized_Types;
10101 -- In a generic package body, an entity of a generic private type may
10102 -- appear uninitialized. This is suspicious, unless the actual is a
10103 -- fully initialized type.
10104
10105 -----------------------------
10106 -- Check_Initialized_Types --
10107 -----------------------------
10108
10109 procedure Check_Initialized_Types is
10110 Decl : Node_Id;
10111 Formal : Entity_Id;
10112 Actual : Entity_Id;
10113 Uninit_Var : Entity_Id;
10114
10115 begin
10116 Decl := First (Generic_Formal_Declarations (Gen_Decl));
10117 while Present (Decl) loop
10118 Uninit_Var := Empty;
10119
10120 if Nkind (Decl) = N_Private_Extension_Declaration then
10121 Uninit_Var := Uninitialized_Variable (Decl);
10122
10123 elsif Nkind (Decl) = N_Formal_Type_Declaration
10124 and then Nkind (Formal_Type_Definition (Decl)) =
10125 N_Formal_Private_Type_Definition
10126 then
10127 Uninit_Var :=
10128 Uninitialized_Variable (Formal_Type_Definition (Decl));
10129 end if;
10130
10131 if Present (Uninit_Var) then
10132 Formal := Defining_Identifier (Decl);
10133 Actual := First_Entity (Act_Decl_Id);
10134
10135 -- For each formal there is a subtype declaration that renames
10136 -- the actual and has the same name as the formal. Locate the
10137 -- formal for warning message about uninitialized variables
10138 -- in the generic, for which the actual type should be a fully
10139 -- initialized type.
10140
10141 while Present (Actual) loop
10142 exit when Ekind (Actual) = E_Package
10143 and then Present (Renamed_Object (Actual));
10144
10145 if Chars (Actual) = Chars (Formal)
10146 and then not Is_Scalar_Type (Actual)
10147 and then not Is_Fully_Initialized_Type (Actual)
10148 and then Warn_On_No_Value_Assigned
10149 then
10150 Error_Msg_Node_2 := Formal;
10151 Error_Msg_NE
10152 ("generic unit has uninitialized variable& of "
10153 & "formal private type &?v?", Actual, Uninit_Var);
10154 Error_Msg_NE
10155 ("actual type for& should be fully initialized type?v?",
10156 Actual, Formal);
10157 exit;
10158 end if;
10159
10160 Next_Entity (Actual);
10161 end loop;
10162 end if;
10163
10164 Next (Decl);
10165 end loop;
10166 end Check_Initialized_Types;
10167
10168 -- Start of processing for Instantiate_Package_Body
10169
10170 begin
10171 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10172
10173 -- The instance body may already have been processed, as the parent of
10174 -- another instance that is inlined (Load_Parent_Of_Generic).
10175
10176 if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
10177 return;
10178 end if;
10179
10180 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10181
10182 -- Re-establish the state of information on which checks are suppressed.
10183 -- This information was set in Body_Info at the point of instantiation,
10184 -- and now we restore it so that the instance is compiled using the
10185 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10186
10187 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10188 Scope_Suppress := Body_Info.Scope_Suppress;
10189 Opt.Ada_Version := Body_Info.Version;
10190 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10191 Restore_Warnings (Body_Info.Warnings);
10192 Opt.SPARK_Mode := Body_Info.SPARK_Mode;
10193 Opt.SPARK_Mode_Pragma := Body_Info.SPARK_Mode_Pragma;
10194
10195 if No (Gen_Body_Id) then
10196
10197 -- Do not look for parent of generic body if none is required.
10198 -- This may happen when the routine is called as part of the
10199 -- Pending_Instantiations processing, when nested instances
10200 -- may precede the one generated from the main unit.
10201
10202 if not Unit_Requires_Body (Defining_Entity (Gen_Decl))
10203 and then Body_Optional
10204 then
10205 return;
10206 else
10207 Load_Parent_Of_Generic
10208 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10209 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10210 end if;
10211 end if;
10212
10213 -- Establish global variable for sloc adjustment and for error recovery
10214
10215 Instantiation_Node := Inst_Node;
10216
10217 if Present (Gen_Body_Id) then
10218 Save_Env (Gen_Unit, Act_Decl_Id);
10219 Style_Check := False;
10220 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10221
10222 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10223
10224 Create_Instantiation_Source
10225 (Inst_Node, Gen_Body_Id, False, S_Adjustment);
10226
10227 Act_Body :=
10228 Copy_Generic_Node
10229 (Original_Node (Gen_Body), Empty, Instantiating => True);
10230
10231 -- Build new name (possibly qualified) for body declaration
10232
10233 Act_Body_Id := New_Copy (Act_Decl_Id);
10234
10235 -- Some attributes of spec entity are not inherited by body entity
10236
10237 Set_Handler_Records (Act_Body_Id, No_List);
10238
10239 if Nkind (Defining_Unit_Name (Act_Spec)) =
10240 N_Defining_Program_Unit_Name
10241 then
10242 Act_Body_Name :=
10243 Make_Defining_Program_Unit_Name (Loc,
10244 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
10245 Defining_Identifier => Act_Body_Id);
10246 else
10247 Act_Body_Name := Act_Body_Id;
10248 end if;
10249
10250 Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
10251
10252 Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
10253 Check_Generic_Actuals (Act_Decl_Id, False);
10254 Check_Initialized_Types;
10255
10256 -- Install primitives hidden at the point of the instantiation but
10257 -- visible when processing the generic formals
10258
10259 declare
10260 E : Entity_Id;
10261
10262 begin
10263 E := First_Entity (Act_Decl_Id);
10264 while Present (E) loop
10265 if Is_Type (E)
10266 and then Is_Generic_Actual_Type (E)
10267 and then Is_Tagged_Type (E)
10268 then
10269 Install_Hidden_Primitives
10270 (Prims_List => Vis_Prims_List,
10271 Gen_T => Generic_Parent_Type (Parent (E)),
10272 Act_T => E);
10273 end if;
10274
10275 Next_Entity (E);
10276 end loop;
10277 end;
10278
10279 -- If it is a child unit, make the parent instance (which is an
10280 -- instance of the parent of the generic) visible. The parent
10281 -- instance is the prefix of the name of the generic unit.
10282
10283 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10284 and then Nkind (Gen_Id) = N_Expanded_Name
10285 then
10286 Par_Ent := Entity (Prefix (Gen_Id));
10287 Par_Vis := Is_Immediately_Visible (Par_Ent);
10288 Install_Parent (Par_Ent, In_Body => True);
10289 Parent_Installed := True;
10290
10291 elsif Is_Child_Unit (Gen_Unit) then
10292 Par_Ent := Scope (Gen_Unit);
10293 Par_Vis := Is_Immediately_Visible (Par_Ent);
10294 Install_Parent (Par_Ent, In_Body => True);
10295 Parent_Installed := True;
10296 end if;
10297
10298 -- If the instantiation is a library unit, and this is the main unit,
10299 -- then build the resulting compilation unit nodes for the instance.
10300 -- If this is a compilation unit but it is not the main unit, then it
10301 -- is the body of a unit in the context, that is being compiled
10302 -- because it is encloses some inlined unit or another generic unit
10303 -- being instantiated. In that case, this body is not part of the
10304 -- current compilation, and is not attached to the tree, but its
10305 -- parent must be set for analysis.
10306
10307 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10308
10309 -- Replace instance node with body of instance, and create new
10310 -- node for corresponding instance declaration.
10311
10312 Build_Instance_Compilation_Unit_Nodes
10313 (Inst_Node, Act_Body, Act_Decl);
10314 Analyze (Inst_Node);
10315
10316 if Parent (Inst_Node) = Cunit (Main_Unit) then
10317
10318 -- If the instance is a child unit itself, then set the scope
10319 -- of the expanded body to be the parent of the instantiation
10320 -- (ensuring that the fully qualified name will be generated
10321 -- for the elaboration subprogram).
10322
10323 if Nkind (Defining_Unit_Name (Act_Spec)) =
10324 N_Defining_Program_Unit_Name
10325 then
10326 Set_Scope
10327 (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
10328 end if;
10329 end if;
10330
10331 -- Case where instantiation is not a library unit
10332
10333 else
10334 -- If this is an early instantiation, i.e. appears textually
10335 -- before the corresponding body and must be elaborated first,
10336 -- indicate that the body instance is to be delayed.
10337
10338 Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
10339
10340 -- Now analyze the body. We turn off all checks if this is an
10341 -- internal unit, since there is no reason to have checks on for
10342 -- any predefined run-time library code. All such code is designed
10343 -- to be compiled with checks off.
10344
10345 -- Note that we do NOT apply this criterion to children of GNAT
10346 -- (or on VMS, children of DEC). The latter units must suppress
10347 -- checks explicitly if this is needed.
10348
10349 if Is_Predefined_File_Name
10350 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
10351 then
10352 Analyze (Act_Body, Suppress => All_Checks);
10353 else
10354 Analyze (Act_Body);
10355 end if;
10356 end if;
10357
10358 Inherit_Context (Gen_Body, Inst_Node);
10359
10360 -- Remove the parent instances if they have been placed on the scope
10361 -- stack to compile the body.
10362
10363 if Parent_Installed then
10364 Remove_Parent (In_Body => True);
10365
10366 -- Restore the previous visibility of the parent
10367
10368 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10369 end if;
10370
10371 Restore_Hidden_Primitives (Vis_Prims_List);
10372 Restore_Private_Views (Act_Decl_Id);
10373
10374 -- Remove the current unit from visibility if this is an instance
10375 -- that is not elaborated on the fly for inlining purposes.
10376
10377 if not Inlined_Body then
10378 Set_Is_Immediately_Visible (Act_Decl_Id, False);
10379 end if;
10380
10381 Restore_Env;
10382 Style_Check := Save_Style_Check;
10383
10384 -- If we have no body, and the unit requires a body, then complain. This
10385 -- complaint is suppressed if we have detected other errors (since a
10386 -- common reason for missing the body is that it had errors).
10387 -- In CodePeer mode, a warning has been emitted already, no need for
10388 -- further messages.
10389
10390 elsif Unit_Requires_Body (Gen_Unit)
10391 and then not Body_Optional
10392 then
10393 if CodePeer_Mode then
10394 null;
10395
10396 elsif Serious_Errors_Detected = 0 then
10397 Error_Msg_NE
10398 ("cannot find body of generic package &", Inst_Node, Gen_Unit);
10399
10400 -- Don't attempt to perform any cleanup actions if some other error
10401 -- was already detected, since this can cause blowups.
10402
10403 else
10404 return;
10405 end if;
10406
10407 -- Case of package that does not need a body
10408
10409 else
10410 -- If the instantiation of the declaration is a library unit, rewrite
10411 -- the original package instantiation as a package declaration in the
10412 -- compilation unit node.
10413
10414 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10415 Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
10416 Rewrite (Inst_Node, Act_Decl);
10417
10418 -- Generate elaboration entity, in case spec has elaboration code.
10419 -- This cannot be done when the instance is analyzed, because it
10420 -- is not known yet whether the body exists.
10421
10422 Set_Elaboration_Entity_Required (Act_Decl_Id, False);
10423 Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
10424
10425 -- If the instantiation is not a library unit, then append the
10426 -- declaration to the list of implicitly generated entities, unless
10427 -- it is already a list member which means that it was already
10428 -- processed
10429
10430 elsif not Is_List_Member (Act_Decl) then
10431 Mark_Rewrite_Insertion (Act_Decl);
10432 Insert_Before (Inst_Node, Act_Decl);
10433 end if;
10434 end if;
10435
10436 Expander_Mode_Restore;
10437 end Instantiate_Package_Body;
10438
10439 ---------------------------------
10440 -- Instantiate_Subprogram_Body --
10441 ---------------------------------
10442
10443 procedure Instantiate_Subprogram_Body
10444 (Body_Info : Pending_Body_Info;
10445 Body_Optional : Boolean := False)
10446 is
10447 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10448 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10449 Loc : constant Source_Ptr := Sloc (Inst_Node);
10450 Gen_Id : constant Node_Id := Name (Inst_Node);
10451 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10452 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10453 Anon_Id : constant Entity_Id :=
10454 Defining_Unit_Name (Specification (Act_Decl));
10455 Pack_Id : constant Entity_Id :=
10456 Defining_Unit_Name (Parent (Act_Decl));
10457 Decls : List_Id;
10458 Gen_Body : Node_Id;
10459 Gen_Body_Id : Node_Id;
10460 Act_Body : Node_Id;
10461 Pack_Body : Node_Id;
10462 Prev_Formal : Entity_Id;
10463 Ret_Expr : Node_Id;
10464 Unit_Renaming : Node_Id;
10465
10466 Parent_Installed : Boolean := False;
10467
10468 Saved_Style_Check : constant Boolean := Style_Check;
10469 Saved_Warnings : constant Warning_Record := Save_Warnings;
10470
10471 Par_Ent : Entity_Id := Empty;
10472 Par_Vis : Boolean := False;
10473
10474 begin
10475 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10476
10477 -- Subprogram body may have been created already because of an inline
10478 -- pragma, or because of multiple elaborations of the enclosing package
10479 -- when several instances of the subprogram appear in the main unit.
10480
10481 if Present (Corresponding_Body (Act_Decl)) then
10482 return;
10483 end if;
10484
10485 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10486
10487 -- Re-establish the state of information on which checks are suppressed.
10488 -- This information was set in Body_Info at the point of instantiation,
10489 -- and now we restore it so that the instance is compiled using the
10490 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10491
10492 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10493 Scope_Suppress := Body_Info.Scope_Suppress;
10494 Opt.Ada_Version := Body_Info.Version;
10495 Opt.Ada_Version_Pragma := Body_Info.Version_Pragma;
10496 Restore_Warnings (Body_Info.Warnings);
10497 Opt.SPARK_Mode := Body_Info.SPARK_Mode;
10498 Opt.SPARK_Mode_Pragma := Body_Info.SPARK_Mode_Pragma;
10499
10500 if No (Gen_Body_Id) then
10501
10502 -- For imported generic subprogram, no body to compile, complete
10503 -- the spec entity appropriately.
10504
10505 if Is_Imported (Gen_Unit) then
10506 Set_Is_Imported (Anon_Id);
10507 Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10508 Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10509 Set_Convention (Anon_Id, Convention (Gen_Unit));
10510 Set_Has_Completion (Anon_Id);
10511 return;
10512
10513 -- For other cases, compile the body
10514
10515 else
10516 Load_Parent_Of_Generic
10517 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10518 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10519 end if;
10520 end if;
10521
10522 Instantiation_Node := Inst_Node;
10523
10524 if Present (Gen_Body_Id) then
10525 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10526
10527 if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10528
10529 -- Either body is not present, or context is non-expanding, as
10530 -- when compiling a subunit. Mark the instance as completed, and
10531 -- diagnose a missing body when needed.
10532
10533 if Expander_Active
10534 and then Operating_Mode = Generate_Code
10535 then
10536 Error_Msg_N
10537 ("missing proper body for instantiation", Gen_Body);
10538 end if;
10539
10540 Set_Has_Completion (Anon_Id);
10541 return;
10542 end if;
10543
10544 Save_Env (Gen_Unit, Anon_Id);
10545 Style_Check := False;
10546 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10547 Create_Instantiation_Source
10548 (Inst_Node,
10549 Gen_Body_Id,
10550 False,
10551 S_Adjustment);
10552
10553 Act_Body :=
10554 Copy_Generic_Node
10555 (Original_Node (Gen_Body), Empty, Instantiating => True);
10556
10557 -- Create proper defining name for the body, to correspond to
10558 -- the one in the spec.
10559
10560 Set_Defining_Unit_Name (Specification (Act_Body),
10561 Make_Defining_Identifier
10562 (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10563 Set_Corresponding_Spec (Act_Body, Anon_Id);
10564 Set_Has_Completion (Anon_Id);
10565 Check_Generic_Actuals (Pack_Id, False);
10566
10567 -- Generate a reference to link the visible subprogram instance to
10568 -- the generic body, which for navigation purposes is the only
10569 -- available source for the instance.
10570
10571 Generate_Reference
10572 (Related_Instance (Pack_Id),
10573 Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10574
10575 -- If it is a child unit, make the parent instance (which is an
10576 -- instance of the parent of the generic) visible. The parent
10577 -- instance is the prefix of the name of the generic unit.
10578
10579 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10580 and then Nkind (Gen_Id) = N_Expanded_Name
10581 then
10582 Par_Ent := Entity (Prefix (Gen_Id));
10583 Par_Vis := Is_Immediately_Visible (Par_Ent);
10584 Install_Parent (Par_Ent, In_Body => True);
10585 Parent_Installed := True;
10586
10587 elsif Is_Child_Unit (Gen_Unit) then
10588 Par_Ent := Scope (Gen_Unit);
10589 Par_Vis := Is_Immediately_Visible (Par_Ent);
10590 Install_Parent (Par_Ent, In_Body => True);
10591 Parent_Installed := True;
10592 end if;
10593
10594 -- Inside its body, a reference to the generic unit is a reference
10595 -- to the instance. The corresponding renaming is the first
10596 -- declaration in the body.
10597
10598 Unit_Renaming :=
10599 Make_Subprogram_Renaming_Declaration (Loc,
10600 Specification =>
10601 Copy_Generic_Node (
10602 Specification (Original_Node (Gen_Body)),
10603 Empty,
10604 Instantiating => True),
10605 Name => New_Occurrence_Of (Anon_Id, Loc));
10606
10607 -- If there is a formal subprogram with the same name as the unit
10608 -- itself, do not add this renaming declaration. This is a temporary
10609 -- fix for one ACVC test. ???
10610
10611 Prev_Formal := First_Entity (Pack_Id);
10612 while Present (Prev_Formal) loop
10613 if Chars (Prev_Formal) = Chars (Gen_Unit)
10614 and then Is_Overloadable (Prev_Formal)
10615 then
10616 exit;
10617 end if;
10618
10619 Next_Entity (Prev_Formal);
10620 end loop;
10621
10622 if Present (Prev_Formal) then
10623 Decls := New_List (Act_Body);
10624 else
10625 Decls := New_List (Unit_Renaming, Act_Body);
10626 end if;
10627
10628 -- The subprogram body is placed in the body of a dummy package body,
10629 -- whose spec contains the subprogram declaration as well as the
10630 -- renaming declarations for the generic parameters.
10631
10632 Pack_Body := Make_Package_Body (Loc,
10633 Defining_Unit_Name => New_Copy (Pack_Id),
10634 Declarations => Decls);
10635
10636 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10637
10638 -- If the instantiation is a library unit, then build resulting
10639 -- compilation unit nodes for the instance. The declaration of
10640 -- the enclosing package is the grandparent of the subprogram
10641 -- declaration. First replace the instantiation node as the unit
10642 -- of the corresponding compilation.
10643
10644 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10645 if Parent (Inst_Node) = Cunit (Main_Unit) then
10646 Set_Unit (Parent (Inst_Node), Inst_Node);
10647 Build_Instance_Compilation_Unit_Nodes
10648 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10649 Analyze (Inst_Node);
10650 else
10651 Set_Parent (Pack_Body, Parent (Inst_Node));
10652 Analyze (Pack_Body);
10653 end if;
10654
10655 else
10656 Insert_Before (Inst_Node, Pack_Body);
10657 Mark_Rewrite_Insertion (Pack_Body);
10658 Analyze (Pack_Body);
10659
10660 if Expander_Active then
10661 Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10662 end if;
10663 end if;
10664
10665 Inherit_Context (Gen_Body, Inst_Node);
10666
10667 Restore_Private_Views (Pack_Id, False);
10668
10669 if Parent_Installed then
10670 Remove_Parent (In_Body => True);
10671
10672 -- Restore the previous visibility of the parent
10673
10674 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10675 end if;
10676
10677 Restore_Env;
10678 Style_Check := Saved_Style_Check;
10679 Restore_Warnings (Saved_Warnings);
10680
10681 -- Body not found. Error was emitted already. If there were no previous
10682 -- errors, this may be an instance whose scope is a premature instance.
10683 -- In that case we must insure that the (legal) program does raise
10684 -- program error if executed. We generate a subprogram body for this
10685 -- purpose. See DEC ac30vso.
10686
10687 -- Should not reference proprietary DEC tests in comments ???
10688
10689 elsif Serious_Errors_Detected = 0
10690 and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
10691 then
10692 if Body_Optional then
10693 return;
10694
10695 elsif Ekind (Anon_Id) = E_Procedure then
10696 Act_Body :=
10697 Make_Subprogram_Body (Loc,
10698 Specification =>
10699 Make_Procedure_Specification (Loc,
10700 Defining_Unit_Name =>
10701 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10702 Parameter_Specifications =>
10703 New_Copy_List
10704 (Parameter_Specifications (Parent (Anon_Id)))),
10705
10706 Declarations => Empty_List,
10707 Handled_Statement_Sequence =>
10708 Make_Handled_Sequence_Of_Statements (Loc,
10709 Statements =>
10710 New_List (
10711 Make_Raise_Program_Error (Loc,
10712 Reason =>
10713 PE_Access_Before_Elaboration))));
10714
10715 else
10716 Ret_Expr :=
10717 Make_Raise_Program_Error (Loc,
10718 Reason => PE_Access_Before_Elaboration);
10719
10720 Set_Etype (Ret_Expr, (Etype (Anon_Id)));
10721 Set_Analyzed (Ret_Expr);
10722
10723 Act_Body :=
10724 Make_Subprogram_Body (Loc,
10725 Specification =>
10726 Make_Function_Specification (Loc,
10727 Defining_Unit_Name =>
10728 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10729 Parameter_Specifications =>
10730 New_Copy_List
10731 (Parameter_Specifications (Parent (Anon_Id))),
10732 Result_Definition =>
10733 New_Occurrence_Of (Etype (Anon_Id), Loc)),
10734
10735 Declarations => Empty_List,
10736 Handled_Statement_Sequence =>
10737 Make_Handled_Sequence_Of_Statements (Loc,
10738 Statements =>
10739 New_List
10740 (Make_Simple_Return_Statement (Loc, Ret_Expr))));
10741 end if;
10742
10743 Pack_Body := Make_Package_Body (Loc,
10744 Defining_Unit_Name => New_Copy (Pack_Id),
10745 Declarations => New_List (Act_Body));
10746
10747 Insert_After (Inst_Node, Pack_Body);
10748 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10749 Analyze (Pack_Body);
10750 end if;
10751
10752 Expander_Mode_Restore;
10753 end Instantiate_Subprogram_Body;
10754
10755 ----------------------
10756 -- Instantiate_Type --
10757 ----------------------
10758
10759 function Instantiate_Type
10760 (Formal : Node_Id;
10761 Actual : Node_Id;
10762 Analyzed_Formal : Node_Id;
10763 Actual_Decls : List_Id) return List_Id
10764 is
10765 Gen_T : constant Entity_Id := Defining_Identifier (Formal);
10766 A_Gen_T : constant Entity_Id :=
10767 Defining_Identifier (Analyzed_Formal);
10768 Ancestor : Entity_Id := Empty;
10769 Def : constant Node_Id := Formal_Type_Definition (Formal);
10770 Act_T : Entity_Id;
10771 Decl_Node : Node_Id;
10772 Decl_Nodes : List_Id;
10773 Loc : Source_Ptr;
10774 Subt : Entity_Id;
10775
10776 procedure Validate_Array_Type_Instance;
10777 procedure Validate_Access_Subprogram_Instance;
10778 procedure Validate_Access_Type_Instance;
10779 procedure Validate_Derived_Type_Instance;
10780 procedure Validate_Derived_Interface_Type_Instance;
10781 procedure Validate_Discriminated_Formal_Type;
10782 procedure Validate_Interface_Type_Instance;
10783 procedure Validate_Private_Type_Instance;
10784 procedure Validate_Incomplete_Type_Instance;
10785 -- These procedures perform validation tests for the named case.
10786 -- Validate_Discriminated_Formal_Type is shared by formal private
10787 -- types and Ada 2012 formal incomplete types.
10788
10789 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
10790 -- Check that base types are the same and that the subtypes match
10791 -- statically. Used in several of the above.
10792
10793 --------------------
10794 -- Subtypes_Match --
10795 --------------------
10796
10797 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
10798 T : constant Entity_Id := Get_Instance_Of (Gen_T);
10799
10800 begin
10801 -- Some detailed comments would be useful here ???
10802
10803 return ((Base_Type (T) = Act_T
10804 or else Base_Type (T) = Base_Type (Act_T))
10805 and then Subtypes_Statically_Match (T, Act_T))
10806
10807 or else (Is_Class_Wide_Type (Gen_T)
10808 and then Is_Class_Wide_Type (Act_T)
10809 and then Subtypes_Match
10810 (Get_Instance_Of (Root_Type (Gen_T)),
10811 Root_Type (Act_T)))
10812
10813 or else
10814 (Ekind_In (Gen_T, E_Anonymous_Access_Subprogram_Type,
10815 E_Anonymous_Access_Type)
10816 and then Ekind (Act_T) = Ekind (Gen_T)
10817 and then Subtypes_Statically_Match
10818 (Designated_Type (Gen_T), Designated_Type (Act_T)));
10819 end Subtypes_Match;
10820
10821 -----------------------------------------
10822 -- Validate_Access_Subprogram_Instance --
10823 -----------------------------------------
10824
10825 procedure Validate_Access_Subprogram_Instance is
10826 begin
10827 if not Is_Access_Type (Act_T)
10828 or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
10829 then
10830 Error_Msg_NE
10831 ("expect access type in instantiation of &", Actual, Gen_T);
10832 Abandon_Instantiation (Actual);
10833 end if;
10834
10835 -- According to AI05-288, actuals for access_to_subprograms must be
10836 -- subtype conformant with the generic formal. Previous to AI05-288
10837 -- only mode conformance was required.
10838
10839 -- This is a binding interpretation that applies to previous versions
10840 -- of the language, no need to maintain previous weaker checks.
10841
10842 Check_Subtype_Conformant
10843 (Designated_Type (Act_T),
10844 Designated_Type (A_Gen_T),
10845 Actual,
10846 Get_Inst => True);
10847
10848 if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
10849 if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
10850 Error_Msg_NE
10851 ("protected access type not allowed for formal &",
10852 Actual, Gen_T);
10853 end if;
10854
10855 elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
10856 Error_Msg_NE
10857 ("expect protected access type for formal &",
10858 Actual, Gen_T);
10859 end if;
10860 end Validate_Access_Subprogram_Instance;
10861
10862 -----------------------------------
10863 -- Validate_Access_Type_Instance --
10864 -----------------------------------
10865
10866 procedure Validate_Access_Type_Instance is
10867 Desig_Type : constant Entity_Id :=
10868 Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
10869 Desig_Act : Entity_Id;
10870
10871 begin
10872 if not Is_Access_Type (Act_T) then
10873 Error_Msg_NE
10874 ("expect access type in instantiation of &", Actual, Gen_T);
10875 Abandon_Instantiation (Actual);
10876 end if;
10877
10878 if Is_Access_Constant (A_Gen_T) then
10879 if not Is_Access_Constant (Act_T) then
10880 Error_Msg_N
10881 ("actual type must be access-to-constant type", Actual);
10882 Abandon_Instantiation (Actual);
10883 end if;
10884 else
10885 if Is_Access_Constant (Act_T) then
10886 Error_Msg_N
10887 ("actual type must be access-to-variable type", Actual);
10888 Abandon_Instantiation (Actual);
10889
10890 elsif Ekind (A_Gen_T) = E_General_Access_Type
10891 and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
10892 then
10893 Error_Msg_N -- CODEFIX
10894 ("actual must be general access type!", Actual);
10895 Error_Msg_NE -- CODEFIX
10896 ("add ALL to }!", Actual, Act_T);
10897 Abandon_Instantiation (Actual);
10898 end if;
10899 end if;
10900
10901 -- The designated subtypes, that is to say the subtypes introduced
10902 -- by an access type declaration (and not by a subtype declaration)
10903 -- must match.
10904
10905 Desig_Act := Designated_Type (Base_Type (Act_T));
10906
10907 -- The designated type may have been introduced through a limited_
10908 -- with clause, in which case retrieve the non-limited view. This
10909 -- applies to incomplete types as well as to class-wide types.
10910
10911 if From_Limited_With (Desig_Act) then
10912 Desig_Act := Available_View (Desig_Act);
10913 end if;
10914
10915 if not Subtypes_Match (Desig_Type, Desig_Act) then
10916 Error_Msg_NE
10917 ("designated type of actual does not match that of formal &",
10918 Actual, Gen_T);
10919
10920 if not Predicates_Match (Desig_Type, Desig_Act) then
10921 Error_Msg_N ("\predicates do not match", Actual);
10922 end if;
10923
10924 Abandon_Instantiation (Actual);
10925
10926 elsif Is_Access_Type (Designated_Type (Act_T))
10927 and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
10928 /=
10929 Is_Constrained (Designated_Type (Desig_Type))
10930 then
10931 Error_Msg_NE
10932 ("designated type of actual does not match that of formal &",
10933 Actual, Gen_T);
10934
10935 if not Predicates_Match (Desig_Type, Desig_Act) then
10936 Error_Msg_N ("\predicates do not match", Actual);
10937 end if;
10938
10939 Abandon_Instantiation (Actual);
10940 end if;
10941
10942 -- Ada 2005: null-exclusion indicators of the two types must agree
10943
10944 if Can_Never_Be_Null (A_Gen_T) /= Can_Never_Be_Null (Act_T) then
10945 Error_Msg_NE
10946 ("non null exclusion of actual and formal & do not match",
10947 Actual, Gen_T);
10948 end if;
10949 end Validate_Access_Type_Instance;
10950
10951 ----------------------------------
10952 -- Validate_Array_Type_Instance --
10953 ----------------------------------
10954
10955 procedure Validate_Array_Type_Instance is
10956 I1 : Node_Id;
10957 I2 : Node_Id;
10958 T2 : Entity_Id;
10959
10960 function Formal_Dimensions return Int;
10961 -- Count number of dimensions in array type formal
10962
10963 -----------------------
10964 -- Formal_Dimensions --
10965 -----------------------
10966
10967 function Formal_Dimensions return Int is
10968 Num : Int := 0;
10969 Index : Node_Id;
10970
10971 begin
10972 if Nkind (Def) = N_Constrained_Array_Definition then
10973 Index := First (Discrete_Subtype_Definitions (Def));
10974 else
10975 Index := First (Subtype_Marks (Def));
10976 end if;
10977
10978 while Present (Index) loop
10979 Num := Num + 1;
10980 Next_Index (Index);
10981 end loop;
10982
10983 return Num;
10984 end Formal_Dimensions;
10985
10986 -- Start of processing for Validate_Array_Type_Instance
10987
10988 begin
10989 if not Is_Array_Type (Act_T) then
10990 Error_Msg_NE
10991 ("expect array type in instantiation of &", Actual, Gen_T);
10992 Abandon_Instantiation (Actual);
10993
10994 elsif Nkind (Def) = N_Constrained_Array_Definition then
10995 if not (Is_Constrained (Act_T)) then
10996 Error_Msg_NE
10997 ("expect constrained array in instantiation of &",
10998 Actual, Gen_T);
10999 Abandon_Instantiation (Actual);
11000 end if;
11001
11002 else
11003 if Is_Constrained (Act_T) then
11004 Error_Msg_NE
11005 ("expect unconstrained array in instantiation of &",
11006 Actual, Gen_T);
11007 Abandon_Instantiation (Actual);
11008 end if;
11009 end if;
11010
11011 if Formal_Dimensions /= Number_Dimensions (Act_T) then
11012 Error_Msg_NE
11013 ("dimensions of actual do not match formal &", Actual, Gen_T);
11014 Abandon_Instantiation (Actual);
11015 end if;
11016
11017 I1 := First_Index (A_Gen_T);
11018 I2 := First_Index (Act_T);
11019 for J in 1 .. Formal_Dimensions loop
11020
11021 -- If the indexes of the actual were given by a subtype_mark,
11022 -- the index was transformed into a range attribute. Retrieve
11023 -- the original type mark for checking.
11024
11025 if Is_Entity_Name (Original_Node (I2)) then
11026 T2 := Entity (Original_Node (I2));
11027 else
11028 T2 := Etype (I2);
11029 end if;
11030
11031 if not Subtypes_Match
11032 (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
11033 then
11034 Error_Msg_NE
11035 ("index types of actual do not match those of formal &",
11036 Actual, Gen_T);
11037 Abandon_Instantiation (Actual);
11038 end if;
11039
11040 Next_Index (I1);
11041 Next_Index (I2);
11042 end loop;
11043
11044 -- Check matching subtypes. Note that there are complex visibility
11045 -- issues when the generic is a child unit and some aspect of the
11046 -- generic type is declared in a parent unit of the generic. We do
11047 -- the test to handle this special case only after a direct check
11048 -- for static matching has failed. The case where both the component
11049 -- type and the array type are separate formals, and the component
11050 -- type is a private view may also require special checking in
11051 -- Subtypes_Match.
11052
11053 if Subtypes_Match
11054 (Component_Type (A_Gen_T), Component_Type (Act_T))
11055 or else Subtypes_Match
11056 (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
11057 Component_Type (Act_T))
11058 then
11059 null;
11060 else
11061 Error_Msg_NE
11062 ("component subtype of actual does not match that of formal &",
11063 Actual, Gen_T);
11064 Abandon_Instantiation (Actual);
11065 end if;
11066
11067 if Has_Aliased_Components (A_Gen_T)
11068 and then not Has_Aliased_Components (Act_T)
11069 then
11070 Error_Msg_NE
11071 ("actual must have aliased components to match formal type &",
11072 Actual, Gen_T);
11073 end if;
11074 end Validate_Array_Type_Instance;
11075
11076 -----------------------------------------------
11077 -- Validate_Derived_Interface_Type_Instance --
11078 -----------------------------------------------
11079
11080 procedure Validate_Derived_Interface_Type_Instance is
11081 Par : constant Entity_Id := Entity (Subtype_Indication (Def));
11082 Elmt : Elmt_Id;
11083
11084 begin
11085 -- First apply interface instance checks
11086
11087 Validate_Interface_Type_Instance;
11088
11089 -- Verify that immediate parent interface is an ancestor of
11090 -- the actual.
11091
11092 if Present (Par)
11093 and then not Interface_Present_In_Ancestor (Act_T, Par)
11094 then
11095 Error_Msg_NE
11096 ("interface actual must include progenitor&", Actual, Par);
11097 end if;
11098
11099 -- Now verify that the actual includes all other ancestors of
11100 -- the formal.
11101
11102 Elmt := First_Elmt (Interfaces (A_Gen_T));
11103 while Present (Elmt) loop
11104 if not Interface_Present_In_Ancestor
11105 (Act_T, Get_Instance_Of (Node (Elmt)))
11106 then
11107 Error_Msg_NE
11108 ("interface actual must include progenitor&",
11109 Actual, Node (Elmt));
11110 end if;
11111
11112 Next_Elmt (Elmt);
11113 end loop;
11114 end Validate_Derived_Interface_Type_Instance;
11115
11116 ------------------------------------
11117 -- Validate_Derived_Type_Instance --
11118 ------------------------------------
11119
11120 procedure Validate_Derived_Type_Instance is
11121 Actual_Discr : Entity_Id;
11122 Ancestor_Discr : Entity_Id;
11123
11124 begin
11125 -- If the parent type in the generic declaration is itself a previous
11126 -- formal type, then it is local to the generic and absent from the
11127 -- analyzed generic definition. In that case the ancestor is the
11128 -- instance of the formal (which must have been instantiated
11129 -- previously), unless the ancestor is itself a formal derived type.
11130 -- In this latter case (which is the subject of Corrigendum 8652/0038
11131 -- (AI-202) the ancestor of the formals is the ancestor of its
11132 -- parent. Otherwise, the analyzed generic carries the parent type.
11133 -- If the parent type is defined in a previous formal package, then
11134 -- the scope of that formal package is that of the generic type
11135 -- itself, and it has already been mapped into the corresponding type
11136 -- in the actual package.
11137
11138 -- Common case: parent type defined outside of the generic
11139
11140 if Is_Entity_Name (Subtype_Mark (Def))
11141 and then Present (Entity (Subtype_Mark (Def)))
11142 then
11143 Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
11144
11145 -- Check whether parent is defined in a previous formal package
11146
11147 elsif
11148 Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
11149 then
11150 Ancestor :=
11151 Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
11152
11153 -- The type may be a local derivation, or a type extension of a
11154 -- previous formal, or of a formal of a parent package.
11155
11156 elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
11157 or else
11158 Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
11159 then
11160 -- Check whether the parent is another derived formal type in the
11161 -- same generic unit.
11162
11163 if Etype (A_Gen_T) /= A_Gen_T
11164 and then Is_Generic_Type (Etype (A_Gen_T))
11165 and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
11166 and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
11167 then
11168 -- Locate ancestor of parent from the subtype declaration
11169 -- created for the actual.
11170
11171 declare
11172 Decl : Node_Id;
11173
11174 begin
11175 Decl := First (Actual_Decls);
11176 while Present (Decl) loop
11177 if Nkind (Decl) = N_Subtype_Declaration
11178 and then Chars (Defining_Identifier (Decl)) =
11179 Chars (Etype (A_Gen_T))
11180 then
11181 Ancestor := Generic_Parent_Type (Decl);
11182 exit;
11183 else
11184 Next (Decl);
11185 end if;
11186 end loop;
11187 end;
11188
11189 pragma Assert (Present (Ancestor));
11190
11191 -- The ancestor itself may be a previous formal that has been
11192 -- instantiated.
11193
11194 Ancestor := Get_Instance_Of (Ancestor);
11195
11196 else
11197 Ancestor :=
11198 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
11199 end if;
11200
11201 -- An unusual case: the actual is a type declared in a parent unit,
11202 -- but is not a formal type so there is no instance_of for it.
11203 -- Retrieve it by analyzing the record extension.
11204
11205 elsif Is_Child_Unit (Scope (A_Gen_T))
11206 and then In_Open_Scopes (Scope (Act_T))
11207 and then Is_Generic_Instance (Scope (Act_T))
11208 then
11209 Analyze (Subtype_Mark (Def));
11210 Ancestor := Entity (Subtype_Mark (Def));
11211
11212 else
11213 Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
11214 end if;
11215
11216 -- If the formal derived type has pragma Preelaborable_Initialization
11217 -- then the actual type must have preelaborable initialization.
11218
11219 if Known_To_Have_Preelab_Init (A_Gen_T)
11220 and then not Has_Preelaborable_Initialization (Act_T)
11221 then
11222 Error_Msg_NE
11223 ("actual for & must have preelaborable initialization",
11224 Actual, Gen_T);
11225 end if;
11226
11227 -- Ada 2005 (AI-251)
11228
11229 if Ada_Version >= Ada_2005 and then Is_Interface (Ancestor) then
11230 if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
11231 Error_Msg_NE
11232 ("(Ada 2005) expected type implementing & in instantiation",
11233 Actual, Ancestor);
11234 end if;
11235
11236 elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
11237 Error_Msg_NE
11238 ("expect type derived from & in instantiation",
11239 Actual, First_Subtype (Ancestor));
11240 Abandon_Instantiation (Actual);
11241 end if;
11242
11243 -- Ada 2005 (AI-443): Synchronized formal derived type checks. Note
11244 -- that the formal type declaration has been rewritten as a private
11245 -- extension.
11246
11247 if Ada_Version >= Ada_2005
11248 and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
11249 and then Synchronized_Present (Parent (A_Gen_T))
11250 then
11251 -- The actual must be a synchronized tagged type
11252
11253 if not Is_Tagged_Type (Act_T) then
11254 Error_Msg_N
11255 ("actual of synchronized type must be tagged", Actual);
11256 Abandon_Instantiation (Actual);
11257
11258 elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
11259 and then Nkind (Type_Definition (Parent (Act_T))) =
11260 N_Derived_Type_Definition
11261 and then not Synchronized_Present (Type_Definition
11262 (Parent (Act_T)))
11263 then
11264 Error_Msg_N
11265 ("actual of synchronized type must be synchronized", Actual);
11266 Abandon_Instantiation (Actual);
11267 end if;
11268 end if;
11269
11270 -- Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
11271 -- removes the second instance of the phrase "or allow pass by copy".
11272
11273 if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
11274 Error_Msg_N
11275 ("cannot have atomic actual type for non-atomic formal type",
11276 Actual);
11277
11278 elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
11279 Error_Msg_N
11280 ("cannot have volatile actual type for non-volatile formal type",
11281 Actual);
11282 end if;
11283
11284 -- It should not be necessary to check for unknown discriminants on
11285 -- Formal, but for some reason Has_Unknown_Discriminants is false for
11286 -- A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
11287 -- needs fixing. ???
11288
11289 if not Is_Indefinite_Subtype (A_Gen_T)
11290 and then not Unknown_Discriminants_Present (Formal)
11291 and then Is_Indefinite_Subtype (Act_T)
11292 then
11293 Error_Msg_N
11294 ("actual subtype must be constrained", Actual);
11295 Abandon_Instantiation (Actual);
11296 end if;
11297
11298 if not Unknown_Discriminants_Present (Formal) then
11299 if Is_Constrained (Ancestor) then
11300 if not Is_Constrained (Act_T) then
11301 Error_Msg_N
11302 ("actual subtype must be constrained", Actual);
11303 Abandon_Instantiation (Actual);
11304 end if;
11305
11306 -- Ancestor is unconstrained, Check if generic formal and actual
11307 -- agree on constrainedness. The check only applies to array types
11308 -- and discriminated types.
11309
11310 elsif Is_Constrained (Act_T) then
11311 if Ekind (Ancestor) = E_Access_Type
11312 or else
11313 (not Is_Constrained (A_Gen_T)
11314 and then Is_Composite_Type (A_Gen_T))
11315 then
11316 Error_Msg_N
11317 ("actual subtype must be unconstrained", Actual);
11318 Abandon_Instantiation (Actual);
11319 end if;
11320
11321 -- A class-wide type is only allowed if the formal has unknown
11322 -- discriminants.
11323
11324 elsif Is_Class_Wide_Type (Act_T)
11325 and then not Has_Unknown_Discriminants (Ancestor)
11326 then
11327 Error_Msg_NE
11328 ("actual for & cannot be a class-wide type", Actual, Gen_T);
11329 Abandon_Instantiation (Actual);
11330
11331 -- Otherwise, the formal and actual shall have the same number
11332 -- of discriminants and each discriminant of the actual must
11333 -- correspond to a discriminant of the formal.
11334
11335 elsif Has_Discriminants (Act_T)
11336 and then not Has_Unknown_Discriminants (Act_T)
11337 and then Has_Discriminants (Ancestor)
11338 then
11339 Actual_Discr := First_Discriminant (Act_T);
11340 Ancestor_Discr := First_Discriminant (Ancestor);
11341 while Present (Actual_Discr)
11342 and then Present (Ancestor_Discr)
11343 loop
11344 if Base_Type (Act_T) /= Base_Type (Ancestor) and then
11345 No (Corresponding_Discriminant (Actual_Discr))
11346 then
11347 Error_Msg_NE
11348 ("discriminant & does not correspond " &
11349 "to ancestor discriminant", Actual, Actual_Discr);
11350 Abandon_Instantiation (Actual);
11351 end if;
11352
11353 Next_Discriminant (Actual_Discr);
11354 Next_Discriminant (Ancestor_Discr);
11355 end loop;
11356
11357 if Present (Actual_Discr) or else Present (Ancestor_Discr) then
11358 Error_Msg_NE
11359 ("actual for & must have same number of discriminants",
11360 Actual, Gen_T);
11361 Abandon_Instantiation (Actual);
11362 end if;
11363
11364 -- This case should be caught by the earlier check for
11365 -- constrainedness, but the check here is added for completeness.
11366
11367 elsif Has_Discriminants (Act_T)
11368 and then not Has_Unknown_Discriminants (Act_T)
11369 then
11370 Error_Msg_NE
11371 ("actual for & must not have discriminants", Actual, Gen_T);
11372 Abandon_Instantiation (Actual);
11373
11374 elsif Has_Discriminants (Ancestor) then
11375 Error_Msg_NE
11376 ("actual for & must have known discriminants", Actual, Gen_T);
11377 Abandon_Instantiation (Actual);
11378 end if;
11379
11380 if not Subtypes_Statically_Compatible
11381 (Act_T, Ancestor, Formal_Derived_Matching => True)
11382 then
11383 Error_Msg_N
11384 ("constraint on actual is incompatible with formal", Actual);
11385 Abandon_Instantiation (Actual);
11386 end if;
11387 end if;
11388
11389 -- If the formal and actual types are abstract, check that there
11390 -- are no abstract primitives of the actual type that correspond to
11391 -- nonabstract primitives of the formal type (second sentence of
11392 -- RM95-3.9.3(9)).
11393
11394 if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
11395 Check_Abstract_Primitives : declare
11396 Gen_Prims : constant Elist_Id :=
11397 Primitive_Operations (A_Gen_T);
11398 Gen_Elmt : Elmt_Id;
11399 Gen_Subp : Entity_Id;
11400 Anc_Subp : Entity_Id;
11401 Anc_Formal : Entity_Id;
11402 Anc_F_Type : Entity_Id;
11403
11404 Act_Prims : constant Elist_Id := Primitive_Operations (Act_T);
11405 Act_Elmt : Elmt_Id;
11406 Act_Subp : Entity_Id;
11407 Act_Formal : Entity_Id;
11408 Act_F_Type : Entity_Id;
11409
11410 Subprograms_Correspond : Boolean;
11411
11412 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
11413 -- Returns true if T2 is derived directly or indirectly from
11414 -- T1, including derivations from interfaces. T1 and T2 are
11415 -- required to be specific tagged base types.
11416
11417 ------------------------
11418 -- Is_Tagged_Ancestor --
11419 ------------------------
11420
11421 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
11422 is
11423 Intfc_Elmt : Elmt_Id;
11424
11425 begin
11426 -- The predicate is satisfied if the types are the same
11427
11428 if T1 = T2 then
11429 return True;
11430
11431 -- If we've reached the top of the derivation chain then
11432 -- we know that T1 is not an ancestor of T2.
11433
11434 elsif Etype (T2) = T2 then
11435 return False;
11436
11437 -- Proceed to check T2's immediate parent
11438
11439 elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
11440 return True;
11441
11442 -- Finally, check to see if T1 is an ancestor of any of T2's
11443 -- progenitors.
11444
11445 else
11446 Intfc_Elmt := First_Elmt (Interfaces (T2));
11447 while Present (Intfc_Elmt) loop
11448 if Is_Ancestor (T1, Node (Intfc_Elmt)) then
11449 return True;
11450 end if;
11451
11452 Next_Elmt (Intfc_Elmt);
11453 end loop;
11454 end if;
11455
11456 return False;
11457 end Is_Tagged_Ancestor;
11458
11459 -- Start of processing for Check_Abstract_Primitives
11460
11461 begin
11462 -- Loop over all of the formal derived type's primitives
11463
11464 Gen_Elmt := First_Elmt (Gen_Prims);
11465 while Present (Gen_Elmt) loop
11466 Gen_Subp := Node (Gen_Elmt);
11467
11468 -- If the primitive of the formal is not abstract, then
11469 -- determine whether there is a corresponding primitive of
11470 -- the actual type that's abstract.
11471
11472 if not Is_Abstract_Subprogram (Gen_Subp) then
11473 Act_Elmt := First_Elmt (Act_Prims);
11474 while Present (Act_Elmt) loop
11475 Act_Subp := Node (Act_Elmt);
11476
11477 -- If we find an abstract primitive of the actual,
11478 -- then we need to test whether it corresponds to the
11479 -- subprogram from which the generic formal primitive
11480 -- is inherited.
11481
11482 if Is_Abstract_Subprogram (Act_Subp) then
11483 Anc_Subp := Alias (Gen_Subp);
11484
11485 -- Test whether we have a corresponding primitive
11486 -- by comparing names, kinds, formal types, and
11487 -- result types.
11488
11489 if Chars (Anc_Subp) = Chars (Act_Subp)
11490 and then Ekind (Anc_Subp) = Ekind (Act_Subp)
11491 then
11492 Anc_Formal := First_Formal (Anc_Subp);
11493 Act_Formal := First_Formal (Act_Subp);
11494 while Present (Anc_Formal)
11495 and then Present (Act_Formal)
11496 loop
11497 Anc_F_Type := Etype (Anc_Formal);
11498 Act_F_Type := Etype (Act_Formal);
11499
11500 if Ekind (Anc_F_Type)
11501 = E_Anonymous_Access_Type
11502 then
11503 Anc_F_Type := Designated_Type (Anc_F_Type);
11504
11505 if Ekind (Act_F_Type)
11506 = E_Anonymous_Access_Type
11507 then
11508 Act_F_Type :=
11509 Designated_Type (Act_F_Type);
11510 else
11511 exit;
11512 end if;
11513
11514 elsif
11515 Ekind (Act_F_Type) = E_Anonymous_Access_Type
11516 then
11517 exit;
11518 end if;
11519
11520 Anc_F_Type := Base_Type (Anc_F_Type);
11521 Act_F_Type := Base_Type (Act_F_Type);
11522
11523 -- If the formal is controlling, then the
11524 -- the type of the actual primitive's formal
11525 -- must be derived directly or indirectly
11526 -- from the type of the ancestor primitive's
11527 -- formal.
11528
11529 if Is_Controlling_Formal (Anc_Formal) then
11530 if not Is_Tagged_Ancestor
11531 (Anc_F_Type, Act_F_Type)
11532 then
11533 exit;
11534 end if;
11535
11536 -- Otherwise the types of the formals must
11537 -- be the same.
11538
11539 elsif Anc_F_Type /= Act_F_Type then
11540 exit;
11541 end if;
11542
11543 Next_Entity (Anc_Formal);
11544 Next_Entity (Act_Formal);
11545 end loop;
11546
11547 -- If we traversed through all of the formals
11548 -- then so far the subprograms correspond, so
11549 -- now check that any result types correspond.
11550
11551 if No (Anc_Formal) and then No (Act_Formal) then
11552 Subprograms_Correspond := True;
11553
11554 if Ekind (Act_Subp) = E_Function then
11555 Anc_F_Type := Etype (Anc_Subp);
11556 Act_F_Type := Etype (Act_Subp);
11557
11558 if Ekind (Anc_F_Type)
11559 = E_Anonymous_Access_Type
11560 then
11561 Anc_F_Type :=
11562 Designated_Type (Anc_F_Type);
11563
11564 if Ekind (Act_F_Type)
11565 = E_Anonymous_Access_Type
11566 then
11567 Act_F_Type :=
11568 Designated_Type (Act_F_Type);
11569 else
11570 Subprograms_Correspond := False;
11571 end if;
11572
11573 elsif
11574 Ekind (Act_F_Type)
11575 = E_Anonymous_Access_Type
11576 then
11577 Subprograms_Correspond := False;
11578 end if;
11579
11580 Anc_F_Type := Base_Type (Anc_F_Type);
11581 Act_F_Type := Base_Type (Act_F_Type);
11582
11583 -- Now either the result types must be
11584 -- the same or, if the result type is
11585 -- controlling, the result type of the
11586 -- actual primitive must descend from the
11587 -- result type of the ancestor primitive.
11588
11589 if Subprograms_Correspond
11590 and then Anc_F_Type /= Act_F_Type
11591 and then
11592 Has_Controlling_Result (Anc_Subp)
11593 and then
11594 not Is_Tagged_Ancestor
11595 (Anc_F_Type, Act_F_Type)
11596 then
11597 Subprograms_Correspond := False;
11598 end if;
11599 end if;
11600
11601 -- Found a matching subprogram belonging to
11602 -- formal ancestor type, so actual subprogram
11603 -- corresponds and this violates 3.9.3(9).
11604
11605 if Subprograms_Correspond then
11606 Error_Msg_NE
11607 ("abstract subprogram & overrides " &
11608 "nonabstract subprogram of ancestor",
11609 Actual,
11610 Act_Subp);
11611 end if;
11612 end if;
11613 end if;
11614 end if;
11615
11616 Next_Elmt (Act_Elmt);
11617 end loop;
11618 end if;
11619
11620 Next_Elmt (Gen_Elmt);
11621 end loop;
11622 end Check_Abstract_Primitives;
11623 end if;
11624
11625 -- Verify that limitedness matches. If parent is a limited
11626 -- interface then the generic formal is not unless declared
11627 -- explicitly so. If not declared limited, the actual cannot be
11628 -- limited (see AI05-0087).
11629
11630 -- Even though this AI is a binding interpretation, we enable the
11631 -- check only in Ada 2012 mode, because this improper construct
11632 -- shows up in user code and in existing B-tests.
11633
11634 if Is_Limited_Type (Act_T)
11635 and then not Is_Limited_Type (A_Gen_T)
11636 and then Ada_Version >= Ada_2012
11637 then
11638 if In_Instance then
11639 null;
11640 else
11641 Error_Msg_NE
11642 ("actual for non-limited & cannot be a limited type", Actual,
11643 Gen_T);
11644 Explain_Limited_Type (Act_T, Actual);
11645 Abandon_Instantiation (Actual);
11646 end if;
11647 end if;
11648 end Validate_Derived_Type_Instance;
11649
11650 ----------------------------------------
11651 -- Validate_Discriminated_Formal_Type --
11652 ----------------------------------------
11653
11654 procedure Validate_Discriminated_Formal_Type is
11655 Formal_Discr : Entity_Id;
11656 Actual_Discr : Entity_Id;
11657 Formal_Subt : Entity_Id;
11658
11659 begin
11660 if Has_Discriminants (A_Gen_T) then
11661 if not Has_Discriminants (Act_T) then
11662 Error_Msg_NE
11663 ("actual for & must have discriminants", Actual, Gen_T);
11664 Abandon_Instantiation (Actual);
11665
11666 elsif Is_Constrained (Act_T) then
11667 Error_Msg_NE
11668 ("actual for & must be unconstrained", Actual, Gen_T);
11669 Abandon_Instantiation (Actual);
11670
11671 else
11672 Formal_Discr := First_Discriminant (A_Gen_T);
11673 Actual_Discr := First_Discriminant (Act_T);
11674 while Formal_Discr /= Empty loop
11675 if Actual_Discr = Empty then
11676 Error_Msg_NE
11677 ("discriminants on actual do not match formal",
11678 Actual, Gen_T);
11679 Abandon_Instantiation (Actual);
11680 end if;
11681
11682 Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
11683
11684 -- Access discriminants match if designated types do
11685
11686 if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
11687 and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
11688 E_Anonymous_Access_Type
11689 and then
11690 Get_Instance_Of
11691 (Designated_Type (Base_Type (Formal_Subt))) =
11692 Designated_Type (Base_Type (Etype (Actual_Discr)))
11693 then
11694 null;
11695
11696 elsif Base_Type (Formal_Subt) /=
11697 Base_Type (Etype (Actual_Discr))
11698 then
11699 Error_Msg_NE
11700 ("types of actual discriminants must match formal",
11701 Actual, Gen_T);
11702 Abandon_Instantiation (Actual);
11703
11704 elsif not Subtypes_Statically_Match
11705 (Formal_Subt, Etype (Actual_Discr))
11706 and then Ada_Version >= Ada_95
11707 then
11708 Error_Msg_NE
11709 ("subtypes of actual discriminants must match formal",
11710 Actual, Gen_T);
11711 Abandon_Instantiation (Actual);
11712 end if;
11713
11714 Next_Discriminant (Formal_Discr);
11715 Next_Discriminant (Actual_Discr);
11716 end loop;
11717
11718 if Actual_Discr /= Empty then
11719 Error_Msg_NE
11720 ("discriminants on actual do not match formal",
11721 Actual, Gen_T);
11722 Abandon_Instantiation (Actual);
11723 end if;
11724 end if;
11725 end if;
11726 end Validate_Discriminated_Formal_Type;
11727
11728 ---------------------------------------
11729 -- Validate_Incomplete_Type_Instance --
11730 ---------------------------------------
11731
11732 procedure Validate_Incomplete_Type_Instance is
11733 begin
11734 if not Is_Tagged_Type (Act_T)
11735 and then Is_Tagged_Type (A_Gen_T)
11736 then
11737 Error_Msg_NE
11738 ("actual for & must be a tagged type", Actual, Gen_T);
11739 end if;
11740
11741 Validate_Discriminated_Formal_Type;
11742 end Validate_Incomplete_Type_Instance;
11743
11744 --------------------------------------
11745 -- Validate_Interface_Type_Instance --
11746 --------------------------------------
11747
11748 procedure Validate_Interface_Type_Instance is
11749 begin
11750 if not Is_Interface (Act_T) then
11751 Error_Msg_NE
11752 ("actual for formal interface type must be an interface",
11753 Actual, Gen_T);
11754
11755 elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
11756 or else
11757 Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
11758 or else
11759 Is_Protected_Interface (A_Gen_T) /=
11760 Is_Protected_Interface (Act_T)
11761 or else
11762 Is_Synchronized_Interface (A_Gen_T) /=
11763 Is_Synchronized_Interface (Act_T)
11764 then
11765 Error_Msg_NE
11766 ("actual for interface& does not match (RM 12.5.5(4))",
11767 Actual, Gen_T);
11768 end if;
11769 end Validate_Interface_Type_Instance;
11770
11771 ------------------------------------
11772 -- Validate_Private_Type_Instance --
11773 ------------------------------------
11774
11775 procedure Validate_Private_Type_Instance is
11776 begin
11777 if Is_Limited_Type (Act_T)
11778 and then not Is_Limited_Type (A_Gen_T)
11779 then
11780 if In_Instance then
11781 null;
11782 else
11783 Error_Msg_NE
11784 ("actual for non-limited & cannot be a limited type", Actual,
11785 Gen_T);
11786 Explain_Limited_Type (Act_T, Actual);
11787 Abandon_Instantiation (Actual);
11788 end if;
11789
11790 elsif Known_To_Have_Preelab_Init (A_Gen_T)
11791 and then not Has_Preelaborable_Initialization (Act_T)
11792 then
11793 Error_Msg_NE
11794 ("actual for & must have preelaborable initialization", Actual,
11795 Gen_T);
11796
11797 elsif Is_Indefinite_Subtype (Act_T)
11798 and then not Is_Indefinite_Subtype (A_Gen_T)
11799 and then Ada_Version >= Ada_95
11800 then
11801 Error_Msg_NE
11802 ("actual for & must be a definite subtype", Actual, Gen_T);
11803
11804 elsif not Is_Tagged_Type (Act_T)
11805 and then Is_Tagged_Type (A_Gen_T)
11806 then
11807 Error_Msg_NE
11808 ("actual for & must be a tagged type", Actual, Gen_T);
11809 end if;
11810
11811 Validate_Discriminated_Formal_Type;
11812 Ancestor := Gen_T;
11813 end Validate_Private_Type_Instance;
11814
11815 -- Start of processing for Instantiate_Type
11816
11817 begin
11818 if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
11819 Error_Msg_N ("duplicate instantiation of generic type", Actual);
11820 return New_List (Error);
11821
11822 elsif not Is_Entity_Name (Actual)
11823 or else not Is_Type (Entity (Actual))
11824 then
11825 Error_Msg_NE
11826 ("expect valid subtype mark to instantiate &", Actual, Gen_T);
11827 Abandon_Instantiation (Actual);
11828
11829 else
11830 Act_T := Entity (Actual);
11831
11832 -- Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
11833 -- as a generic actual parameter if the corresponding formal type
11834 -- does not have a known_discriminant_part, or is a formal derived
11835 -- type that is an Unchecked_Union type.
11836
11837 if Is_Unchecked_Union (Base_Type (Act_T)) then
11838 if not Has_Discriminants (A_Gen_T)
11839 or else
11840 (Is_Derived_Type (A_Gen_T)
11841 and then
11842 Is_Unchecked_Union (A_Gen_T))
11843 then
11844 null;
11845 else
11846 Error_Msg_N ("unchecked union cannot be the actual for a" &
11847 " discriminated formal type", Act_T);
11848
11849 end if;
11850 end if;
11851
11852 -- Deal with fixed/floating restrictions
11853
11854 if Is_Floating_Point_Type (Act_T) then
11855 Check_Restriction (No_Floating_Point, Actual);
11856 elsif Is_Fixed_Point_Type (Act_T) then
11857 Check_Restriction (No_Fixed_Point, Actual);
11858 end if;
11859
11860 -- Deal with error of using incomplete type as generic actual.
11861 -- This includes limited views of a type, even if the non-limited
11862 -- view may be available.
11863
11864 if Ekind (Act_T) = E_Incomplete_Type
11865 or else (Is_Class_Wide_Type (Act_T)
11866 and then
11867 Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
11868 then
11869 -- If the formal is an incomplete type, the actual can be
11870 -- incomplete as well.
11871
11872 if Ekind (A_Gen_T) = E_Incomplete_Type then
11873 null;
11874
11875 elsif Is_Class_Wide_Type (Act_T)
11876 or else No (Full_View (Act_T))
11877 then
11878 Error_Msg_N ("premature use of incomplete type", Actual);
11879 Abandon_Instantiation (Actual);
11880 else
11881 Act_T := Full_View (Act_T);
11882 Set_Entity (Actual, Act_T);
11883
11884 if Has_Private_Component (Act_T) then
11885 Error_Msg_N
11886 ("premature use of type with private component", Actual);
11887 end if;
11888 end if;
11889
11890 -- Deal with error of premature use of private type as generic actual
11891
11892 elsif Is_Private_Type (Act_T)
11893 and then Is_Private_Type (Base_Type (Act_T))
11894 and then not Is_Generic_Type (Act_T)
11895 and then not Is_Derived_Type (Act_T)
11896 and then No (Full_View (Root_Type (Act_T)))
11897 then
11898 -- If the formal is an incomplete type, the actual can be
11899 -- private or incomplete as well.
11900
11901 if Ekind (A_Gen_T) = E_Incomplete_Type then
11902 null;
11903 else
11904 Error_Msg_N ("premature use of private type", Actual);
11905 end if;
11906
11907 elsif Has_Private_Component (Act_T) then
11908 Error_Msg_N
11909 ("premature use of type with private component", Actual);
11910 end if;
11911
11912 Set_Instance_Of (A_Gen_T, Act_T);
11913
11914 -- If the type is generic, the class-wide type may also be used
11915
11916 if Is_Tagged_Type (A_Gen_T)
11917 and then Is_Tagged_Type (Act_T)
11918 and then not Is_Class_Wide_Type (A_Gen_T)
11919 then
11920 Set_Instance_Of (Class_Wide_Type (A_Gen_T),
11921 Class_Wide_Type (Act_T));
11922 end if;
11923
11924 if not Is_Abstract_Type (A_Gen_T)
11925 and then Is_Abstract_Type (Act_T)
11926 then
11927 Error_Msg_N
11928 ("actual of non-abstract formal cannot be abstract", Actual);
11929 end if;
11930
11931 -- A generic scalar type is a first subtype for which we generate
11932 -- an anonymous base type. Indicate that the instance of this base
11933 -- is the base type of the actual.
11934
11935 if Is_Scalar_Type (A_Gen_T) then
11936 Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
11937 end if;
11938 end if;
11939
11940 if Error_Posted (Act_T) then
11941 null;
11942 else
11943 case Nkind (Def) is
11944 when N_Formal_Private_Type_Definition =>
11945 Validate_Private_Type_Instance;
11946
11947 when N_Formal_Incomplete_Type_Definition =>
11948 Validate_Incomplete_Type_Instance;
11949
11950 when N_Formal_Derived_Type_Definition =>
11951 Validate_Derived_Type_Instance;
11952
11953 when N_Formal_Discrete_Type_Definition =>
11954 if not Is_Discrete_Type (Act_T) then
11955 Error_Msg_NE
11956 ("expect discrete type in instantiation of&",
11957 Actual, Gen_T);
11958 Abandon_Instantiation (Actual);
11959 end if;
11960
11961 when N_Formal_Signed_Integer_Type_Definition =>
11962 if not Is_Signed_Integer_Type (Act_T) then
11963 Error_Msg_NE
11964 ("expect signed integer type in instantiation of&",
11965 Actual, Gen_T);
11966 Abandon_Instantiation (Actual);
11967 end if;
11968
11969 when N_Formal_Modular_Type_Definition =>
11970 if not Is_Modular_Integer_Type (Act_T) then
11971 Error_Msg_NE
11972 ("expect modular type in instantiation of &",
11973 Actual, Gen_T);
11974 Abandon_Instantiation (Actual);
11975 end if;
11976
11977 when N_Formal_Floating_Point_Definition =>
11978 if not Is_Floating_Point_Type (Act_T) then
11979 Error_Msg_NE
11980 ("expect float type in instantiation of &", Actual, Gen_T);
11981 Abandon_Instantiation (Actual);
11982 end if;
11983
11984 when N_Formal_Ordinary_Fixed_Point_Definition =>
11985 if not Is_Ordinary_Fixed_Point_Type (Act_T) then
11986 Error_Msg_NE
11987 ("expect ordinary fixed point type in instantiation of &",
11988 Actual, Gen_T);
11989 Abandon_Instantiation (Actual);
11990 end if;
11991
11992 when N_Formal_Decimal_Fixed_Point_Definition =>
11993 if not Is_Decimal_Fixed_Point_Type (Act_T) then
11994 Error_Msg_NE
11995 ("expect decimal type in instantiation of &",
11996 Actual, Gen_T);
11997 Abandon_Instantiation (Actual);
11998 end if;
11999
12000 when N_Array_Type_Definition =>
12001 Validate_Array_Type_Instance;
12002
12003 when N_Access_To_Object_Definition =>
12004 Validate_Access_Type_Instance;
12005
12006 when N_Access_Function_Definition |
12007 N_Access_Procedure_Definition =>
12008 Validate_Access_Subprogram_Instance;
12009
12010 when N_Record_Definition =>
12011 Validate_Interface_Type_Instance;
12012
12013 when N_Derived_Type_Definition =>
12014 Validate_Derived_Interface_Type_Instance;
12015
12016 when others =>
12017 raise Program_Error;
12018
12019 end case;
12020 end if;
12021
12022 Subt := New_Copy (Gen_T);
12023
12024 -- Use adjusted sloc of subtype name as the location for other nodes in
12025 -- the subtype declaration.
12026
12027 Loc := Sloc (Subt);
12028
12029 Decl_Node :=
12030 Make_Subtype_Declaration (Loc,
12031 Defining_Identifier => Subt,
12032 Subtype_Indication => New_Occurrence_Of (Act_T, Loc));
12033
12034 if Is_Private_Type (Act_T) then
12035 Set_Has_Private_View (Subtype_Indication (Decl_Node));
12036
12037 elsif Is_Access_Type (Act_T)
12038 and then Is_Private_Type (Designated_Type (Act_T))
12039 then
12040 Set_Has_Private_View (Subtype_Indication (Decl_Node));
12041 end if;
12042
12043 Decl_Nodes := New_List (Decl_Node);
12044
12045 -- Flag actual derived types so their elaboration produces the
12046 -- appropriate renamings for the primitive operations of the ancestor.
12047 -- Flag actual for formal private types as well, to determine whether
12048 -- operations in the private part may override inherited operations.
12049 -- If the formal has an interface list, the ancestor is not the
12050 -- parent, but the analyzed formal that includes the interface
12051 -- operations of all its progenitors.
12052
12053 -- Same treatment for formal private types, so we can check whether the
12054 -- type is tagged limited when validating derivations in the private
12055 -- part. (See AI05-096).
12056
12057 if Nkind (Def) = N_Formal_Derived_Type_Definition then
12058 if Present (Interface_List (Def)) then
12059 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
12060 else
12061 Set_Generic_Parent_Type (Decl_Node, Ancestor);
12062 end if;
12063
12064 elsif Nkind_In (Def,
12065 N_Formal_Private_Type_Definition,
12066 N_Formal_Incomplete_Type_Definition)
12067 then
12068 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
12069 end if;
12070
12071 -- If the actual is a synchronized type that implements an interface,
12072 -- the primitive operations are attached to the corresponding record,
12073 -- and we have to treat it as an additional generic actual, so that its
12074 -- primitive operations become visible in the instance. The task or
12075 -- protected type itself does not carry primitive operations.
12076
12077 if Is_Concurrent_Type (Act_T)
12078 and then Is_Tagged_Type (Act_T)
12079 and then Present (Corresponding_Record_Type (Act_T))
12080 and then Present (Ancestor)
12081 and then Is_Interface (Ancestor)
12082 then
12083 declare
12084 Corr_Rec : constant Entity_Id :=
12085 Corresponding_Record_Type (Act_T);
12086 New_Corr : Entity_Id;
12087 Corr_Decl : Node_Id;
12088
12089 begin
12090 New_Corr := Make_Temporary (Loc, 'S');
12091 Corr_Decl :=
12092 Make_Subtype_Declaration (Loc,
12093 Defining_Identifier => New_Corr,
12094 Subtype_Indication =>
12095 New_Occurrence_Of (Corr_Rec, Loc));
12096 Append_To (Decl_Nodes, Corr_Decl);
12097
12098 if Ekind (Act_T) = E_Task_Type then
12099 Set_Ekind (Subt, E_Task_Subtype);
12100 else
12101 Set_Ekind (Subt, E_Protected_Subtype);
12102 end if;
12103
12104 Set_Corresponding_Record_Type (Subt, Corr_Rec);
12105 Set_Generic_Parent_Type (Corr_Decl, Ancestor);
12106 Set_Generic_Parent_Type (Decl_Node, Empty);
12107 end;
12108 end if;
12109
12110 return Decl_Nodes;
12111 end Instantiate_Type;
12112
12113 ---------------------
12114 -- Is_In_Main_Unit --
12115 ---------------------
12116
12117 function Is_In_Main_Unit (N : Node_Id) return Boolean is
12118 Unum : constant Unit_Number_Type := Get_Source_Unit (N);
12119 Current_Unit : Node_Id;
12120
12121 begin
12122 if Unum = Main_Unit then
12123 return True;
12124
12125 -- If the current unit is a subunit then it is either the main unit or
12126 -- is being compiled as part of the main unit.
12127
12128 elsif Nkind (N) = N_Compilation_Unit then
12129 return Nkind (Unit (N)) = N_Subunit;
12130 end if;
12131
12132 Current_Unit := Parent (N);
12133 while Present (Current_Unit)
12134 and then Nkind (Current_Unit) /= N_Compilation_Unit
12135 loop
12136 Current_Unit := Parent (Current_Unit);
12137 end loop;
12138
12139 -- The instantiation node is in the main unit, or else the current node
12140 -- (perhaps as the result of nested instantiations) is in the main unit,
12141 -- or in the declaration of the main unit, which in this last case must
12142 -- be a body.
12143
12144 return Unum = Main_Unit
12145 or else Current_Unit = Cunit (Main_Unit)
12146 or else Current_Unit = Library_Unit (Cunit (Main_Unit))
12147 or else (Present (Library_Unit (Current_Unit))
12148 and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
12149 end Is_In_Main_Unit;
12150
12151 ----------------------------
12152 -- Load_Parent_Of_Generic --
12153 ----------------------------
12154
12155 procedure Load_Parent_Of_Generic
12156 (N : Node_Id;
12157 Spec : Node_Id;
12158 Body_Optional : Boolean := False)
12159 is
12160 Comp_Unit : constant Node_Id := Cunit (Get_Source_Unit (Spec));
12161 Saved_Style_Check : constant Boolean := Style_Check;
12162 Saved_Warnings : constant Warning_Record := Save_Warnings;
12163 True_Parent : Node_Id;
12164 Inst_Node : Node_Id;
12165 OK : Boolean;
12166 Previous_Instances : constant Elist_Id := New_Elmt_List;
12167
12168 procedure Collect_Previous_Instances (Decls : List_Id);
12169 -- Collect all instantiations in the given list of declarations, that
12170 -- precede the generic that we need to load. If the bodies of these
12171 -- instantiations are available, we must analyze them, to ensure that
12172 -- the public symbols generated are the same when the unit is compiled
12173 -- to generate code, and when it is compiled in the context of a unit
12174 -- that needs a particular nested instance. This process is applied to
12175 -- both package and subprogram instances.
12176
12177 --------------------------------
12178 -- Collect_Previous_Instances --
12179 --------------------------------
12180
12181 procedure Collect_Previous_Instances (Decls : List_Id) is
12182 Decl : Node_Id;
12183
12184 begin
12185 Decl := First (Decls);
12186 while Present (Decl) loop
12187 if Sloc (Decl) >= Sloc (Inst_Node) then
12188 return;
12189
12190 -- If Decl is an instantiation, then record it as requiring
12191 -- instantiation of the corresponding body, except if it is an
12192 -- abbreviated instantiation generated internally for conformance
12193 -- checking purposes only for the case of a formal package
12194 -- declared without a box (see Instantiate_Formal_Package). Such
12195 -- an instantiation does not generate any code (the actual code
12196 -- comes from actual) and thus does not need to be analyzed here.
12197 -- If the instantiation appears with a generic package body it is
12198 -- not analyzed here either.
12199
12200 elsif Nkind (Decl) = N_Package_Instantiation
12201 and then not Is_Internal (Defining_Entity (Decl))
12202 then
12203 Append_Elmt (Decl, Previous_Instances);
12204
12205 -- For a subprogram instantiation, omit instantiations intrinsic
12206 -- operations (Unchecked_Conversions, etc.) that have no bodies.
12207
12208 elsif Nkind_In (Decl, N_Function_Instantiation,
12209 N_Procedure_Instantiation)
12210 and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
12211 then
12212 Append_Elmt (Decl, Previous_Instances);
12213
12214 elsif Nkind (Decl) = N_Package_Declaration then
12215 Collect_Previous_Instances
12216 (Visible_Declarations (Specification (Decl)));
12217 Collect_Previous_Instances
12218 (Private_Declarations (Specification (Decl)));
12219
12220 -- Previous non-generic bodies may contain instances as well
12221
12222 elsif Nkind (Decl) = N_Package_Body
12223 and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
12224 then
12225 Collect_Previous_Instances (Declarations (Decl));
12226
12227 elsif Nkind (Decl) = N_Subprogram_Body
12228 and then not Acts_As_Spec (Decl)
12229 and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
12230 then
12231 Collect_Previous_Instances (Declarations (Decl));
12232 end if;
12233
12234 Next (Decl);
12235 end loop;
12236 end Collect_Previous_Instances;
12237
12238 -- Start of processing for Load_Parent_Of_Generic
12239
12240 begin
12241 if not In_Same_Source_Unit (N, Spec)
12242 or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
12243 or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
12244 and then not Is_In_Main_Unit (Spec))
12245 then
12246 -- Find body of parent of spec, and analyze it. A special case arises
12247 -- when the parent is an instantiation, that is to say when we are
12248 -- currently instantiating a nested generic. In that case, there is
12249 -- no separate file for the body of the enclosing instance. Instead,
12250 -- the enclosing body must be instantiated as if it were a pending
12251 -- instantiation, in order to produce the body for the nested generic
12252 -- we require now. Note that in that case the generic may be defined
12253 -- in a package body, the instance defined in the same package body,
12254 -- and the original enclosing body may not be in the main unit.
12255
12256 Inst_Node := Empty;
12257
12258 True_Parent := Parent (Spec);
12259 while Present (True_Parent)
12260 and then Nkind (True_Parent) /= N_Compilation_Unit
12261 loop
12262 if Nkind (True_Parent) = N_Package_Declaration
12263 and then
12264 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
12265 then
12266 -- Parent is a compilation unit that is an instantiation.
12267 -- Instantiation node has been replaced with package decl.
12268
12269 Inst_Node := Original_Node (True_Parent);
12270 exit;
12271
12272 elsif Nkind (True_Parent) = N_Package_Declaration
12273 and then Present (Generic_Parent (Specification (True_Parent)))
12274 and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12275 then
12276 -- Parent is an instantiation within another specification.
12277 -- Declaration for instance has been inserted before original
12278 -- instantiation node. A direct link would be preferable?
12279
12280 Inst_Node := Next (True_Parent);
12281 while Present (Inst_Node)
12282 and then Nkind (Inst_Node) /= N_Package_Instantiation
12283 loop
12284 Next (Inst_Node);
12285 end loop;
12286
12287 -- If the instance appears within a generic, and the generic
12288 -- unit is defined within a formal package of the enclosing
12289 -- generic, there is no generic body available, and none
12290 -- needed. A more precise test should be used ???
12291
12292 if No (Inst_Node) then
12293 return;
12294 end if;
12295
12296 exit;
12297
12298 else
12299 True_Parent := Parent (True_Parent);
12300 end if;
12301 end loop;
12302
12303 -- Case where we are currently instantiating a nested generic
12304
12305 if Present (Inst_Node) then
12306 if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
12307
12308 -- Instantiation node and declaration of instantiated package
12309 -- were exchanged when only the declaration was needed.
12310 -- Restore instantiation node before proceeding with body.
12311
12312 Set_Unit (Parent (True_Parent), Inst_Node);
12313 end if;
12314
12315 -- Now complete instantiation of enclosing body, if it appears in
12316 -- some other unit. If it appears in the current unit, the body
12317 -- will have been instantiated already.
12318
12319 if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
12320
12321 -- We need to determine the expander mode to instantiate the
12322 -- enclosing body. Because the generic body we need may use
12323 -- global entities declared in the enclosing package (including
12324 -- aggregates) it is in general necessary to compile this body
12325 -- with expansion enabled, except if we are within a generic
12326 -- package, in which case the usual generic rule applies.
12327
12328 declare
12329 Exp_Status : Boolean := True;
12330 Scop : Entity_Id;
12331
12332 begin
12333 -- Loop through scopes looking for generic package
12334
12335 Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
12336 while Present (Scop)
12337 and then Scop /= Standard_Standard
12338 loop
12339 if Ekind (Scop) = E_Generic_Package then
12340 Exp_Status := False;
12341 exit;
12342 end if;
12343
12344 Scop := Scope (Scop);
12345 end loop;
12346
12347 -- Collect previous instantiations in the unit that contains
12348 -- the desired generic.
12349
12350 if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12351 and then not Body_Optional
12352 then
12353 declare
12354 Decl : Elmt_Id;
12355 Info : Pending_Body_Info;
12356 Par : Node_Id;
12357
12358 begin
12359 Par := Parent (Inst_Node);
12360 while Present (Par) loop
12361 exit when Nkind (Parent (Par)) = N_Compilation_Unit;
12362 Par := Parent (Par);
12363 end loop;
12364
12365 pragma Assert (Present (Par));
12366
12367 if Nkind (Par) = N_Package_Body then
12368 Collect_Previous_Instances (Declarations (Par));
12369
12370 elsif Nkind (Par) = N_Package_Declaration then
12371 Collect_Previous_Instances
12372 (Visible_Declarations (Specification (Par)));
12373 Collect_Previous_Instances
12374 (Private_Declarations (Specification (Par)));
12375
12376 else
12377 -- Enclosing unit is a subprogram body. In this
12378 -- case all instance bodies are processed in order
12379 -- and there is no need to collect them separately.
12380
12381 null;
12382 end if;
12383
12384 Decl := First_Elmt (Previous_Instances);
12385 while Present (Decl) loop
12386 Info :=
12387 (Inst_Node => Node (Decl),
12388 Act_Decl =>
12389 Instance_Spec (Node (Decl)),
12390 Expander_Status => Exp_Status,
12391 Current_Sem_Unit =>
12392 Get_Code_Unit (Sloc (Node (Decl))),
12393 Scope_Suppress => Scope_Suppress,
12394 Local_Suppress_Stack_Top =>
12395 Local_Suppress_Stack_Top,
12396 Version => Ada_Version,
12397 Version_Pragma => Ada_Version_Pragma,
12398 Warnings => Save_Warnings,
12399 SPARK_Mode => SPARK_Mode,
12400 SPARK_Mode_Pragma => SPARK_Mode_Pragma);
12401
12402 -- Package instance
12403
12404 if
12405 Nkind (Node (Decl)) = N_Package_Instantiation
12406 then
12407 Instantiate_Package_Body
12408 (Info, Body_Optional => True);
12409
12410 -- Subprogram instance
12411
12412 else
12413 -- The instance_spec is the wrapper package,
12414 -- and the subprogram declaration is the last
12415 -- declaration in the wrapper.
12416
12417 Info.Act_Decl :=
12418 Last
12419 (Visible_Declarations
12420 (Specification (Info.Act_Decl)));
12421
12422 Instantiate_Subprogram_Body
12423 (Info, Body_Optional => True);
12424 end if;
12425
12426 Next_Elmt (Decl);
12427 end loop;
12428 end;
12429 end if;
12430
12431 Instantiate_Package_Body
12432 (Body_Info =>
12433 ((Inst_Node => Inst_Node,
12434 Act_Decl => True_Parent,
12435 Expander_Status => Exp_Status,
12436 Current_Sem_Unit => Get_Code_Unit
12437 (Sloc (Inst_Node)),
12438 Scope_Suppress => Scope_Suppress,
12439 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
12440 Version => Ada_Version,
12441 Version_Pragma => Ada_Version_Pragma,
12442 Warnings => Save_Warnings,
12443 SPARK_Mode => SPARK_Mode,
12444 SPARK_Mode_Pragma => SPARK_Mode_Pragma)),
12445 Body_Optional => Body_Optional);
12446 end;
12447 end if;
12448
12449 -- Case where we are not instantiating a nested generic
12450
12451 else
12452 Opt.Style_Check := False;
12453 Expander_Mode_Save_And_Set (True);
12454 Load_Needed_Body (Comp_Unit, OK);
12455 Opt.Style_Check := Saved_Style_Check;
12456 Restore_Warnings (Saved_Warnings);
12457 Expander_Mode_Restore;
12458
12459 if not OK
12460 and then Unit_Requires_Body (Defining_Entity (Spec))
12461 and then not Body_Optional
12462 then
12463 declare
12464 Bname : constant Unit_Name_Type :=
12465 Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
12466
12467 begin
12468 -- In CodePeer mode, the missing body may make the analysis
12469 -- incomplete, but we do not treat it as fatal.
12470
12471 if CodePeer_Mode then
12472 return;
12473
12474 else
12475 Error_Msg_Unit_1 := Bname;
12476 Error_Msg_N ("this instantiation requires$!", N);
12477 Error_Msg_File_1 :=
12478 Get_File_Name (Bname, Subunit => False);
12479 Error_Msg_N ("\but file{ was not found!", N);
12480 raise Unrecoverable_Error;
12481 end if;
12482 end;
12483 end if;
12484 end if;
12485 end if;
12486
12487 -- If loading parent of the generic caused an instantiation circularity,
12488 -- we abandon compilation at this point, because otherwise in some cases
12489 -- we get into trouble with infinite recursions after this point.
12490
12491 if Circularity_Detected then
12492 raise Unrecoverable_Error;
12493 end if;
12494 end Load_Parent_Of_Generic;
12495
12496 ---------------------------------
12497 -- Map_Formal_Package_Entities --
12498 ---------------------------------
12499
12500 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
12501 E1 : Entity_Id;
12502 E2 : Entity_Id;
12503
12504 begin
12505 Set_Instance_Of (Form, Act);
12506
12507 -- Traverse formal and actual package to map the corresponding entities.
12508 -- We skip over internal entities that may be generated during semantic
12509 -- analysis, and find the matching entities by name, given that they
12510 -- must appear in the same order.
12511
12512 E1 := First_Entity (Form);
12513 E2 := First_Entity (Act);
12514 while Present (E1) and then E1 /= First_Private_Entity (Form) loop
12515 -- Could this test be a single condition??? Seems like it could, and
12516 -- isn't FPE (Form) a constant anyway???
12517
12518 if not Is_Internal (E1)
12519 and then Present (Parent (E1))
12520 and then not Is_Class_Wide_Type (E1)
12521 and then not Is_Internal_Name (Chars (E1))
12522 then
12523 while Present (E2) and then Chars (E2) /= Chars (E1) loop
12524 Next_Entity (E2);
12525 end loop;
12526
12527 if No (E2) then
12528 exit;
12529 else
12530 Set_Instance_Of (E1, E2);
12531
12532 if Is_Type (E1) and then Is_Tagged_Type (E2) then
12533 Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
12534 end if;
12535
12536 if Is_Constrained (E1) then
12537 Set_Instance_Of (Base_Type (E1), Base_Type (E2));
12538 end if;
12539
12540 if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
12541 Map_Formal_Package_Entities (E1, E2);
12542 end if;
12543 end if;
12544 end if;
12545
12546 Next_Entity (E1);
12547 end loop;
12548 end Map_Formal_Package_Entities;
12549
12550 -----------------------
12551 -- Move_Freeze_Nodes --
12552 -----------------------
12553
12554 procedure Move_Freeze_Nodes
12555 (Out_Of : Entity_Id;
12556 After : Node_Id;
12557 L : List_Id)
12558 is
12559 Decl : Node_Id;
12560 Next_Decl : Node_Id;
12561 Next_Node : Node_Id := After;
12562 Spec : Node_Id;
12563
12564 function Is_Outer_Type (T : Entity_Id) return Boolean;
12565 -- Check whether entity is declared in a scope external to that of the
12566 -- generic unit.
12567
12568 -------------------
12569 -- Is_Outer_Type --
12570 -------------------
12571
12572 function Is_Outer_Type (T : Entity_Id) return Boolean is
12573 Scop : Entity_Id := Scope (T);
12574
12575 begin
12576 if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12577 return True;
12578
12579 else
12580 while Scop /= Standard_Standard loop
12581 if Scop = Out_Of then
12582 return False;
12583 else
12584 Scop := Scope (Scop);
12585 end if;
12586 end loop;
12587
12588 return True;
12589 end if;
12590 end Is_Outer_Type;
12591
12592 -- Start of processing for Move_Freeze_Nodes
12593
12594 begin
12595 if No (L) then
12596 return;
12597 end if;
12598
12599 -- First remove the freeze nodes that may appear before all other
12600 -- declarations.
12601
12602 Decl := First (L);
12603 while Present (Decl)
12604 and then Nkind (Decl) = N_Freeze_Entity
12605 and then Is_Outer_Type (Entity (Decl))
12606 loop
12607 Decl := Remove_Head (L);
12608 Insert_After (Next_Node, Decl);
12609 Set_Analyzed (Decl, False);
12610 Next_Node := Decl;
12611 Decl := First (L);
12612 end loop;
12613
12614 -- Next scan the list of declarations and remove each freeze node that
12615 -- appears ahead of the current node.
12616
12617 while Present (Decl) loop
12618 while Present (Next (Decl))
12619 and then Nkind (Next (Decl)) = N_Freeze_Entity
12620 and then Is_Outer_Type (Entity (Next (Decl)))
12621 loop
12622 Next_Decl := Remove_Next (Decl);
12623 Insert_After (Next_Node, Next_Decl);
12624 Set_Analyzed (Next_Decl, False);
12625 Next_Node := Next_Decl;
12626 end loop;
12627
12628 -- If the declaration is a nested package or concurrent type, then
12629 -- recurse. Nested generic packages will have been processed from the
12630 -- inside out.
12631
12632 case Nkind (Decl) is
12633 when N_Package_Declaration =>
12634 Spec := Specification (Decl);
12635
12636 when N_Task_Type_Declaration =>
12637 Spec := Task_Definition (Decl);
12638
12639 when N_Protected_Type_Declaration =>
12640 Spec := Protected_Definition (Decl);
12641
12642 when others =>
12643 Spec := Empty;
12644 end case;
12645
12646 if Present (Spec) then
12647 Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
12648 Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
12649 end if;
12650
12651 Next (Decl);
12652 end loop;
12653 end Move_Freeze_Nodes;
12654
12655 ----------------
12656 -- Next_Assoc --
12657 ----------------
12658
12659 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
12660 begin
12661 return Generic_Renamings.Table (E).Next_In_HTable;
12662 end Next_Assoc;
12663
12664 ------------------------
12665 -- Preanalyze_Actuals --
12666 ------------------------
12667
12668 procedure Preanalyze_Actuals (N : Node_Id) is
12669 Assoc : Node_Id;
12670 Act : Node_Id;
12671 Errs : constant Int := Serious_Errors_Detected;
12672
12673 Cur : Entity_Id := Empty;
12674 -- Current homograph of the instance name
12675
12676 Vis : Boolean;
12677 -- Saved visibility status of the current homograph
12678
12679 begin
12680 Assoc := First (Generic_Associations (N));
12681
12682 -- If the instance is a child unit, its name may hide an outer homonym,
12683 -- so make it invisible to perform name resolution on the actuals.
12684
12685 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
12686 and then Present
12687 (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
12688 then
12689 Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
12690
12691 if Is_Compilation_Unit (Cur) then
12692 Vis := Is_Immediately_Visible (Cur);
12693 Set_Is_Immediately_Visible (Cur, False);
12694 else
12695 Cur := Empty;
12696 end if;
12697 end if;
12698
12699 while Present (Assoc) loop
12700 if Nkind (Assoc) /= N_Others_Choice then
12701 Act := Explicit_Generic_Actual_Parameter (Assoc);
12702
12703 -- Within a nested instantiation, a defaulted actual is an empty
12704 -- association, so nothing to analyze. If the subprogram actual
12705 -- is an attribute, analyze prefix only, because actual is not a
12706 -- complete attribute reference.
12707
12708 -- If actual is an allocator, analyze expression only. The full
12709 -- analysis can generate code, and if instance is a compilation
12710 -- unit we have to wait until the package instance is installed
12711 -- to have a proper place to insert this code.
12712
12713 -- String literals may be operators, but at this point we do not
12714 -- know whether the actual is a formal subprogram or a string.
12715
12716 if No (Act) then
12717 null;
12718
12719 elsif Nkind (Act) = N_Attribute_Reference then
12720 Analyze (Prefix (Act));
12721
12722 elsif Nkind (Act) = N_Explicit_Dereference then
12723 Analyze (Prefix (Act));
12724
12725 elsif Nkind (Act) = N_Allocator then
12726 declare
12727 Expr : constant Node_Id := Expression (Act);
12728
12729 begin
12730 if Nkind (Expr) = N_Subtype_Indication then
12731 Analyze (Subtype_Mark (Expr));
12732
12733 -- Analyze separately each discriminant constraint, when
12734 -- given with a named association.
12735
12736 declare
12737 Constr : Node_Id;
12738
12739 begin
12740 Constr := First (Constraints (Constraint (Expr)));
12741 while Present (Constr) loop
12742 if Nkind (Constr) = N_Discriminant_Association then
12743 Analyze (Expression (Constr));
12744 else
12745 Analyze (Constr);
12746 end if;
12747
12748 Next (Constr);
12749 end loop;
12750 end;
12751
12752 else
12753 Analyze (Expr);
12754 end if;
12755 end;
12756
12757 elsif Nkind (Act) /= N_Operator_Symbol then
12758 Analyze (Act);
12759 end if;
12760
12761 -- Ensure that a ghost subprogram does not act as generic actual
12762
12763 if Is_Entity_Name (Act)
12764 and then Is_Ghost_Subprogram (Entity (Act))
12765 then
12766 Error_Msg_N
12767 ("ghost subprogram & cannot act as generic actual", Act);
12768 Abandon_Instantiation (Act);
12769
12770 elsif Errs /= Serious_Errors_Detected then
12771
12772 -- Do a minimal analysis of the generic, to prevent spurious
12773 -- warnings complaining about the generic being unreferenced,
12774 -- before abandoning the instantiation.
12775
12776 Analyze (Name (N));
12777
12778 if Is_Entity_Name (Name (N))
12779 and then Etype (Name (N)) /= Any_Type
12780 then
12781 Generate_Reference (Entity (Name (N)), Name (N));
12782 Set_Is_Instantiated (Entity (Name (N)));
12783 end if;
12784
12785 if Present (Cur) then
12786
12787 -- For the case of a child instance hiding an outer homonym,
12788 -- provide additional warning which might explain the error.
12789
12790 Set_Is_Immediately_Visible (Cur, Vis);
12791 Error_Msg_NE ("& hides outer unit with the same name??",
12792 N, Defining_Unit_Name (N));
12793 end if;
12794
12795 Abandon_Instantiation (Act);
12796 end if;
12797 end if;
12798
12799 Next (Assoc);
12800 end loop;
12801
12802 if Present (Cur) then
12803 Set_Is_Immediately_Visible (Cur, Vis);
12804 end if;
12805 end Preanalyze_Actuals;
12806
12807 -------------------
12808 -- Remove_Parent --
12809 -------------------
12810
12811 procedure Remove_Parent (In_Body : Boolean := False) is
12812 S : Entity_Id := Current_Scope;
12813 -- S is the scope containing the instantiation just completed. The scope
12814 -- stack contains the parent instances of the instantiation, followed by
12815 -- the original S.
12816
12817 Cur_P : Entity_Id;
12818 E : Entity_Id;
12819 P : Entity_Id;
12820 Hidden : Elmt_Id;
12821
12822 begin
12823 -- After child instantiation is complete, remove from scope stack the
12824 -- extra copy of the current scope, and then remove parent instances.
12825
12826 if not In_Body then
12827 Pop_Scope;
12828
12829 while Current_Scope /= S loop
12830 P := Current_Scope;
12831 End_Package_Scope (Current_Scope);
12832
12833 if In_Open_Scopes (P) then
12834 E := First_Entity (P);
12835 while Present (E) loop
12836 Set_Is_Immediately_Visible (E, True);
12837 Next_Entity (E);
12838 end loop;
12839
12840 -- If instantiation is declared in a block, it is the enclosing
12841 -- scope that might be a parent instance. Note that only one
12842 -- block can be involved, because the parent instances have
12843 -- been installed within it.
12844
12845 if Ekind (P) = E_Block then
12846 Cur_P := Scope (P);
12847 else
12848 Cur_P := P;
12849 end if;
12850
12851 if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
12852 -- We are within an instance of some sibling. Retain
12853 -- visibility of parent, for proper subsequent cleanup, and
12854 -- reinstall private declarations as well.
12855
12856 Set_In_Private_Part (P);
12857 Install_Private_Declarations (P);
12858 end if;
12859
12860 -- If the ultimate parent is a top-level unit recorded in
12861 -- Instance_Parent_Unit, then reset its visibility to what it was
12862 -- before instantiation. (It's not clear what the purpose is of
12863 -- testing whether Scope (P) is In_Open_Scopes, but that test was
12864 -- present before the ultimate parent test was added.???)
12865
12866 elsif not In_Open_Scopes (Scope (P))
12867 or else (P = Instance_Parent_Unit
12868 and then not Parent_Unit_Visible)
12869 then
12870 Set_Is_Immediately_Visible (P, False);
12871
12872 -- If the current scope is itself an instantiation of a generic
12873 -- nested within P, and we are in the private part of body of this
12874 -- instantiation, restore the full views of P, that were removed
12875 -- in End_Package_Scope above. This obscure case can occur when a
12876 -- subunit of a generic contains an instance of a child unit of
12877 -- its generic parent unit.
12878
12879 elsif S = Current_Scope and then Is_Generic_Instance (S) then
12880 declare
12881 Par : constant Entity_Id :=
12882 Generic_Parent (Package_Specification (S));
12883 begin
12884 if Present (Par)
12885 and then P = Scope (Par)
12886 and then (In_Package_Body (S) or else In_Private_Part (S))
12887 then
12888 Set_In_Private_Part (P);
12889 Install_Private_Declarations (P);
12890 end if;
12891 end;
12892 end if;
12893 end loop;
12894
12895 -- Reset visibility of entities in the enclosing scope
12896
12897 Set_Is_Hidden_Open_Scope (Current_Scope, False);
12898
12899 Hidden := First_Elmt (Hidden_Entities);
12900 while Present (Hidden) loop
12901 Set_Is_Immediately_Visible (Node (Hidden), True);
12902 Next_Elmt (Hidden);
12903 end loop;
12904
12905 else
12906 -- Each body is analyzed separately, and there is no context that
12907 -- needs preserving from one body instance to the next, so remove all
12908 -- parent scopes that have been installed.
12909
12910 while Present (S) loop
12911 End_Package_Scope (S);
12912 Set_Is_Immediately_Visible (S, False);
12913 S := Current_Scope;
12914 exit when S = Standard_Standard;
12915 end loop;
12916 end if;
12917 end Remove_Parent;
12918
12919 -----------------
12920 -- Restore_Env --
12921 -----------------
12922
12923 procedure Restore_Env is
12924 Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
12925
12926 begin
12927 if No (Current_Instantiated_Parent.Act_Id) then
12928 -- Restore environment after subprogram inlining
12929
12930 Restore_Private_Views (Empty);
12931 end if;
12932
12933 Current_Instantiated_Parent := Saved.Instantiated_Parent;
12934 Exchanged_Views := Saved.Exchanged_Views;
12935 Hidden_Entities := Saved.Hidden_Entities;
12936 Current_Sem_Unit := Saved.Current_Sem_Unit;
12937 Parent_Unit_Visible := Saved.Parent_Unit_Visible;
12938 Instance_Parent_Unit := Saved.Instance_Parent_Unit;
12939
12940 Restore_Opt_Config_Switches (Saved.Switches);
12941
12942 Instance_Envs.Decrement_Last;
12943 end Restore_Env;
12944
12945 ---------------------------
12946 -- Restore_Private_Views --
12947 ---------------------------
12948
12949 procedure Restore_Private_Views
12950 (Pack_Id : Entity_Id;
12951 Is_Package : Boolean := True)
12952 is
12953 M : Elmt_Id;
12954 E : Entity_Id;
12955 Typ : Entity_Id;
12956 Dep_Elmt : Elmt_Id;
12957 Dep_Typ : Node_Id;
12958
12959 procedure Restore_Nested_Formal (Formal : Entity_Id);
12960 -- Hide the generic formals of formal packages declared with box which
12961 -- were reachable in the current instantiation.
12962
12963 ---------------------------
12964 -- Restore_Nested_Formal --
12965 ---------------------------
12966
12967 procedure Restore_Nested_Formal (Formal : Entity_Id) is
12968 Ent : Entity_Id;
12969
12970 begin
12971 if Present (Renamed_Object (Formal))
12972 and then Denotes_Formal_Package (Renamed_Object (Formal), True)
12973 then
12974 return;
12975
12976 elsif Present (Associated_Formal_Package (Formal)) then
12977 Ent := First_Entity (Formal);
12978 while Present (Ent) loop
12979 exit when Ekind (Ent) = E_Package
12980 and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
12981
12982 Set_Is_Hidden (Ent);
12983 Set_Is_Potentially_Use_Visible (Ent, False);
12984
12985 -- If package, then recurse
12986
12987 if Ekind (Ent) = E_Package then
12988 Restore_Nested_Formal (Ent);
12989 end if;
12990
12991 Next_Entity (Ent);
12992 end loop;
12993 end if;
12994 end Restore_Nested_Formal;
12995
12996 -- Start of processing for Restore_Private_Views
12997
12998 begin
12999 M := First_Elmt (Exchanged_Views);
13000 while Present (M) loop
13001 Typ := Node (M);
13002
13003 -- Subtypes of types whose views have been exchanged, and that are
13004 -- defined within the instance, were not on the Private_Dependents
13005 -- list on entry to the instance, so they have to be exchanged
13006 -- explicitly now, in order to remain consistent with the view of the
13007 -- parent type.
13008
13009 if Ekind_In (Typ, E_Private_Type,
13010 E_Limited_Private_Type,
13011 E_Record_Type_With_Private)
13012 then
13013 Dep_Elmt := First_Elmt (Private_Dependents (Typ));
13014 while Present (Dep_Elmt) loop
13015 Dep_Typ := Node (Dep_Elmt);
13016
13017 if Scope (Dep_Typ) = Pack_Id
13018 and then Present (Full_View (Dep_Typ))
13019 then
13020 Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
13021 Exchange_Declarations (Dep_Typ);
13022 end if;
13023
13024 Next_Elmt (Dep_Elmt);
13025 end loop;
13026 end if;
13027
13028 Exchange_Declarations (Node (M));
13029 Next_Elmt (M);
13030 end loop;
13031
13032 if No (Pack_Id) then
13033 return;
13034 end if;
13035
13036 -- Make the generic formal parameters private, and make the formal types
13037 -- into subtypes of the actuals again.
13038
13039 E := First_Entity (Pack_Id);
13040 while Present (E) loop
13041 Set_Is_Hidden (E, True);
13042
13043 if Is_Type (E)
13044 and then Nkind (Parent (E)) = N_Subtype_Declaration
13045 then
13046 -- If the actual for E is itself a generic actual type from
13047 -- an enclosing instance, E is still a generic actual type
13048 -- outside of the current instance. This matter when resolving
13049 -- an overloaded call that may be ambiguous in the enclosing
13050 -- instance, when two of its actuals coincide.
13051
13052 if Is_Entity_Name (Subtype_Indication (Parent (E)))
13053 and then Is_Generic_Actual_Type
13054 (Entity (Subtype_Indication (Parent (E))))
13055 then
13056 null;
13057 else
13058 Set_Is_Generic_Actual_Type (E, False);
13059 end if;
13060
13061 -- An unusual case of aliasing: the actual may also be directly
13062 -- visible in the generic, and be private there, while it is fully
13063 -- visible in the context of the instance. The internal subtype
13064 -- is private in the instance but has full visibility like its
13065 -- parent in the enclosing scope. This enforces the invariant that
13066 -- the privacy status of all private dependents of a type coincide
13067 -- with that of the parent type. This can only happen when a
13068 -- generic child unit is instantiated within a sibling.
13069
13070 if Is_Private_Type (E)
13071 and then not Is_Private_Type (Etype (E))
13072 then
13073 Exchange_Declarations (E);
13074 end if;
13075
13076 elsif Ekind (E) = E_Package then
13077
13078 -- The end of the renaming list is the renaming of the generic
13079 -- package itself. If the instance is a subprogram, all entities
13080 -- in the corresponding package are renamings. If this entity is
13081 -- a formal package, make its own formals private as well. The
13082 -- actual in this case is itself the renaming of an instantiation.
13083 -- If the entity is not a package renaming, it is the entity
13084 -- created to validate formal package actuals: ignore it.
13085
13086 -- If the actual is itself a formal package for the enclosing
13087 -- generic, or the actual for such a formal package, it remains
13088 -- visible on exit from the instance, and therefore nothing needs
13089 -- to be done either, except to keep it accessible.
13090
13091 if Is_Package and then Renamed_Object (E) = Pack_Id then
13092 exit;
13093
13094 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
13095 null;
13096
13097 elsif
13098 Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
13099 then
13100 Set_Is_Hidden (E, False);
13101
13102 else
13103 declare
13104 Act_P : constant Entity_Id := Renamed_Object (E);
13105 Id : Entity_Id;
13106
13107 begin
13108 Id := First_Entity (Act_P);
13109 while Present (Id)
13110 and then Id /= First_Private_Entity (Act_P)
13111 loop
13112 exit when Ekind (Id) = E_Package
13113 and then Renamed_Object (Id) = Act_P;
13114
13115 Set_Is_Hidden (Id, True);
13116 Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
13117
13118 if Ekind (Id) = E_Package then
13119 Restore_Nested_Formal (Id);
13120 end if;
13121
13122 Next_Entity (Id);
13123 end loop;
13124 end;
13125 end if;
13126 end if;
13127
13128 Next_Entity (E);
13129 end loop;
13130 end Restore_Private_Views;
13131
13132 --------------
13133 -- Save_Env --
13134 --------------
13135
13136 procedure Save_Env
13137 (Gen_Unit : Entity_Id;
13138 Act_Unit : Entity_Id)
13139 is
13140 begin
13141 Init_Env;
13142 Set_Instance_Env (Gen_Unit, Act_Unit);
13143 end Save_Env;
13144
13145 ----------------------------
13146 -- Save_Global_References --
13147 ----------------------------
13148
13149 procedure Save_Global_References (N : Node_Id) is
13150 Gen_Scope : Entity_Id;
13151 E : Entity_Id;
13152 N2 : Node_Id;
13153
13154 function Is_Global (E : Entity_Id) return Boolean;
13155 -- Check whether entity is defined outside of generic unit. Examine the
13156 -- scope of an entity, and the scope of the scope, etc, until we find
13157 -- either Standard, in which case the entity is global, or the generic
13158 -- unit itself, which indicates that the entity is local. If the entity
13159 -- is the generic unit itself, as in the case of a recursive call, or
13160 -- the enclosing generic unit, if different from the current scope, then
13161 -- it is local as well, because it will be replaced at the point of
13162 -- instantiation. On the other hand, if it is a reference to a child
13163 -- unit of a common ancestor, which appears in an instantiation, it is
13164 -- global because it is used to denote a specific compilation unit at
13165 -- the time the instantiations will be analyzed.
13166
13167 procedure Reset_Entity (N : Node_Id);
13168 -- Save semantic information on global entity so that it is not resolved
13169 -- again at instantiation time.
13170
13171 procedure Save_Entity_Descendants (N : Node_Id);
13172 -- Apply Save_Global_References to the two syntactic descendants of
13173 -- non-terminal nodes that carry an Associated_Node and are processed
13174 -- through Reset_Entity. Once the global entity (if any) has been
13175 -- captured together with its type, only two syntactic descendants need
13176 -- to be traversed to complete the processing of the tree rooted at N.
13177 -- This applies to Selected_Components, Expanded_Names, and to Operator
13178 -- nodes. N can also be a character literal, identifier, or operator
13179 -- symbol node, but the call has no effect in these cases.
13180
13181 procedure Save_Global_Defaults (N1, N2 : Node_Id);
13182 -- Default actuals in nested instances must be handled specially
13183 -- because there is no link to them from the original tree. When an
13184 -- actual subprogram is given by a default, we add an explicit generic
13185 -- association for it in the instantiation node. When we save the
13186 -- global references on the name of the instance, we recover the list
13187 -- of generic associations, and add an explicit one to the original
13188 -- generic tree, through which a global actual can be preserved.
13189 -- Similarly, if a child unit is instantiated within a sibling, in the
13190 -- context of the parent, we must preserve the identifier of the parent
13191 -- so that it can be properly resolved in a subsequent instantiation.
13192
13193 procedure Save_Global_Descendant (D : Union_Id);
13194 -- Apply Save_Global_References recursively to the descendents of the
13195 -- current node.
13196
13197 procedure Save_References (N : Node_Id);
13198 -- This is the recursive procedure that does the work, once the
13199 -- enclosing generic scope has been established.
13200
13201 ---------------
13202 -- Is_Global --
13203 ---------------
13204
13205 function Is_Global (E : Entity_Id) return Boolean is
13206 Se : Entity_Id;
13207
13208 function Is_Instance_Node (Decl : Node_Id) return Boolean;
13209 -- Determine whether the parent node of a reference to a child unit
13210 -- denotes an instantiation or a formal package, in which case the
13211 -- reference to the child unit is global, even if it appears within
13212 -- the current scope (e.g. when the instance appears within the body
13213 -- of an ancestor).
13214
13215 ----------------------
13216 -- Is_Instance_Node --
13217 ----------------------
13218
13219 function Is_Instance_Node (Decl : Node_Id) return Boolean is
13220 begin
13221 return Nkind (Decl) in N_Generic_Instantiation
13222 or else
13223 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
13224 end Is_Instance_Node;
13225
13226 -- Start of processing for Is_Global
13227
13228 begin
13229 if E = Gen_Scope then
13230 return False;
13231
13232 elsif E = Standard_Standard then
13233 return True;
13234
13235 elsif Is_Child_Unit (E)
13236 and then (Is_Instance_Node (Parent (N2))
13237 or else (Nkind (Parent (N2)) = N_Expanded_Name
13238 and then N2 = Selector_Name (Parent (N2))
13239 and then
13240 Is_Instance_Node (Parent (Parent (N2)))))
13241 then
13242 return True;
13243
13244 else
13245 Se := Scope (E);
13246 while Se /= Gen_Scope loop
13247 if Se = Standard_Standard then
13248 return True;
13249 else
13250 Se := Scope (Se);
13251 end if;
13252 end loop;
13253
13254 return False;
13255 end if;
13256 end Is_Global;
13257
13258 ------------------
13259 -- Reset_Entity --
13260 ------------------
13261
13262 procedure Reset_Entity (N : Node_Id) is
13263
13264 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
13265 -- If the type of N2 is global to the generic unit, save the type in
13266 -- the generic node. Just as we perform name capture for explicit
13267 -- references within the generic, we must capture the global types
13268 -- of local entities because they may participate in resolution in
13269 -- the instance.
13270
13271 function Top_Ancestor (E : Entity_Id) return Entity_Id;
13272 -- Find the ultimate ancestor of the current unit. If it is not a
13273 -- generic unit, then the name of the current unit in the prefix of
13274 -- an expanded name must be replaced with its generic homonym to
13275 -- ensure that it will be properly resolved in an instance.
13276
13277 ---------------------
13278 -- Set_Global_Type --
13279 ---------------------
13280
13281 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
13282 Typ : constant Entity_Id := Etype (N2);
13283
13284 begin
13285 Set_Etype (N, Typ);
13286
13287 if Entity (N) /= N2
13288 and then Has_Private_View (Entity (N))
13289 then
13290 -- If the entity of N is not the associated node, this is a
13291 -- nested generic and it has an associated node as well, whose
13292 -- type is already the full view (see below). Indicate that the
13293 -- original node has a private view.
13294
13295 Set_Has_Private_View (N);
13296 end if;
13297
13298 -- If not a private type, nothing else to do
13299
13300 if not Is_Private_Type (Typ) then
13301 if Is_Array_Type (Typ)
13302 and then Is_Private_Type (Component_Type (Typ))
13303 then
13304 Set_Has_Private_View (N);
13305 end if;
13306
13307 -- If it is a derivation of a private type in a context where no
13308 -- full view is needed, nothing to do either.
13309
13310 elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
13311 null;
13312
13313 -- Otherwise mark the type for flipping and use the full view when
13314 -- available.
13315
13316 else
13317 Set_Has_Private_View (N);
13318
13319 if Present (Full_View (Typ)) then
13320 Set_Etype (N2, Full_View (Typ));
13321 end if;
13322 end if;
13323 end Set_Global_Type;
13324
13325 ------------------
13326 -- Top_Ancestor --
13327 ------------------
13328
13329 function Top_Ancestor (E : Entity_Id) return Entity_Id is
13330 Par : Entity_Id;
13331
13332 begin
13333 Par := E;
13334 while Is_Child_Unit (Par) loop
13335 Par := Scope (Par);
13336 end loop;
13337
13338 return Par;
13339 end Top_Ancestor;
13340
13341 -- Start of processing for Reset_Entity
13342
13343 begin
13344 N2 := Get_Associated_Node (N);
13345 E := Entity (N2);
13346
13347 if Present (E) then
13348
13349 -- If the node is an entry call to an entry in an enclosing task,
13350 -- it is rewritten as a selected component. No global entity to
13351 -- preserve in this case, since the expansion will be redone in
13352 -- the instance.
13353
13354 if not Nkind_In (E, N_Defining_Identifier,
13355 N_Defining_Character_Literal,
13356 N_Defining_Operator_Symbol)
13357 then
13358 Set_Associated_Node (N, Empty);
13359 Set_Etype (N, Empty);
13360 return;
13361 end if;
13362
13363 -- If the entity is an itype created as a subtype of an access
13364 -- type with a null exclusion restore source entity for proper
13365 -- visibility. The itype will be created anew in the instance.
13366
13367 if Is_Itype (E)
13368 and then Ekind (E) = E_Access_Subtype
13369 and then Is_Entity_Name (N)
13370 and then Chars (Etype (E)) = Chars (N)
13371 then
13372 E := Etype (E);
13373 Set_Entity (N2, E);
13374 Set_Etype (N2, E);
13375 end if;
13376
13377 if Is_Global (E) then
13378
13379 -- If the entity is a package renaming that is the prefix of
13380 -- an expanded name, it has been rewritten as the renamed
13381 -- package, which is necessary semantically but complicates
13382 -- ASIS tree traversal, so we recover the original entity to
13383 -- expose the renaming. Take into account that the context may
13384 -- be a nested generic, that the original node may itself have
13385 -- an associated node that had better be an entity, and that
13386 -- the current node is still a selected component.
13387
13388 if Ekind (E) = E_Package
13389 and then Nkind (N) = N_Selected_Component
13390 and then Nkind (Parent (N)) = N_Expanded_Name
13391 and then Present (Original_Node (N2))
13392 and then Is_Entity_Name (Original_Node (N2))
13393 and then Present (Entity (Original_Node (N2)))
13394 then
13395 if Is_Global (Entity (Original_Node (N2))) then
13396 N2 := Original_Node (N2);
13397 Set_Associated_Node (N, N2);
13398 Set_Global_Type (N, N2);
13399
13400 else
13401 -- Renaming is local, and will be resolved in instance
13402
13403 Set_Associated_Node (N, Empty);
13404 Set_Etype (N, Empty);
13405 end if;
13406
13407 else
13408 Set_Global_Type (N, N2);
13409 end if;
13410
13411 elsif Nkind (N) = N_Op_Concat
13412 and then Is_Generic_Type (Etype (N2))
13413 and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
13414 or else
13415 Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
13416 and then Is_Intrinsic_Subprogram (E)
13417 then
13418 null;
13419
13420 else
13421 -- Entity is local. Mark generic node as unresolved.
13422 -- Note that now it does not have an entity.
13423
13424 Set_Associated_Node (N, Empty);
13425 Set_Etype (N, Empty);
13426 end if;
13427
13428 if Nkind (Parent (N)) in N_Generic_Instantiation
13429 and then N = Name (Parent (N))
13430 then
13431 Save_Global_Defaults (Parent (N), Parent (N2));
13432 end if;
13433
13434 elsif Nkind (Parent (N)) = N_Selected_Component
13435 and then Nkind (Parent (N2)) = N_Expanded_Name
13436 then
13437 if Is_Global (Entity (Parent (N2))) then
13438 Change_Selected_Component_To_Expanded_Name (Parent (N));
13439 Set_Associated_Node (Parent (N), Parent (N2));
13440 Set_Global_Type (Parent (N), Parent (N2));
13441 Save_Entity_Descendants (N);
13442
13443 -- If this is a reference to the current generic entity, replace
13444 -- by the name of the generic homonym of the current package. This
13445 -- is because in an instantiation Par.P.Q will not resolve to the
13446 -- name of the instance, whose enclosing scope is not necessarily
13447 -- Par. We use the generic homonym rather that the name of the
13448 -- generic itself because it may be hidden by a local declaration.
13449
13450 elsif In_Open_Scopes (Entity (Parent (N2)))
13451 and then not
13452 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
13453 then
13454 if Ekind (Entity (Parent (N2))) = E_Generic_Package then
13455 Rewrite (Parent (N),
13456 Make_Identifier (Sloc (N),
13457 Chars =>
13458 Chars (Generic_Homonym (Entity (Parent (N2))))));
13459 else
13460 Rewrite (Parent (N),
13461 Make_Identifier (Sloc (N),
13462 Chars => Chars (Selector_Name (Parent (N2)))));
13463 end if;
13464 end if;
13465
13466 if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
13467 and then Parent (N) = Name (Parent (Parent (N)))
13468 then
13469 Save_Global_Defaults
13470 (Parent (Parent (N)), Parent (Parent ((N2))));
13471 end if;
13472
13473 -- A selected component may denote a static constant that has been
13474 -- folded. If the static constant is global to the generic, capture
13475 -- its value. Otherwise the folding will happen in any instantiation.
13476
13477 elsif Nkind (Parent (N)) = N_Selected_Component
13478 and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
13479 then
13480 if Present (Entity (Original_Node (Parent (N2))))
13481 and then Is_Global (Entity (Original_Node (Parent (N2))))
13482 then
13483 Rewrite (Parent (N), New_Copy (Parent (N2)));
13484 Set_Analyzed (Parent (N), False);
13485
13486 else
13487 null;
13488 end if;
13489
13490 -- A selected component may be transformed into a parameterless
13491 -- function call. If the called entity is global, rewrite the node
13492 -- appropriately, i.e. as an extended name for the global entity.
13493
13494 elsif Nkind (Parent (N)) = N_Selected_Component
13495 and then Nkind (Parent (N2)) = N_Function_Call
13496 and then N = Selector_Name (Parent (N))
13497 then
13498 if No (Parameter_Associations (Parent (N2))) then
13499 if Is_Global (Entity (Name (Parent (N2)))) then
13500 Change_Selected_Component_To_Expanded_Name (Parent (N));
13501 Set_Associated_Node (Parent (N), Name (Parent (N2)));
13502 Set_Global_Type (Parent (N), Name (Parent (N2)));
13503 Save_Entity_Descendants (N);
13504
13505 else
13506 Set_Is_Prefixed_Call (Parent (N));
13507 Set_Associated_Node (N, Empty);
13508 Set_Etype (N, Empty);
13509 end if;
13510
13511 -- In Ada 2005, X.F may be a call to a primitive operation,
13512 -- rewritten as F (X). This rewriting will be done again in an
13513 -- instance, so keep the original node. Global entities will be
13514 -- captured as for other constructs. Indicate that this must
13515 -- resolve as a call, to prevent accidental overloading in the
13516 -- instance, if both a component and a primitive operation appear
13517 -- as candidates.
13518
13519 else
13520 Set_Is_Prefixed_Call (Parent (N));
13521 end if;
13522
13523 -- Entity is local. Reset in generic unit, so that node is resolved
13524 -- anew at the point of instantiation.
13525
13526 else
13527 Set_Associated_Node (N, Empty);
13528 Set_Etype (N, Empty);
13529 end if;
13530 end Reset_Entity;
13531
13532 -----------------------------
13533 -- Save_Entity_Descendants --
13534 -----------------------------
13535
13536 procedure Save_Entity_Descendants (N : Node_Id) is
13537 begin
13538 case Nkind (N) is
13539 when N_Binary_Op =>
13540 Save_Global_Descendant (Union_Id (Left_Opnd (N)));
13541 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13542
13543 when N_Unary_Op =>
13544 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13545
13546 when N_Expanded_Name | N_Selected_Component =>
13547 Save_Global_Descendant (Union_Id (Prefix (N)));
13548 Save_Global_Descendant (Union_Id (Selector_Name (N)));
13549
13550 when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
13551 null;
13552
13553 when others =>
13554 raise Program_Error;
13555 end case;
13556 end Save_Entity_Descendants;
13557
13558 --------------------------
13559 -- Save_Global_Defaults --
13560 --------------------------
13561
13562 procedure Save_Global_Defaults (N1, N2 : Node_Id) is
13563 Loc : constant Source_Ptr := Sloc (N1);
13564 Assoc2 : constant List_Id := Generic_Associations (N2);
13565 Gen_Id : constant Entity_Id := Get_Generic_Entity (N2);
13566 Assoc1 : List_Id;
13567 Act1 : Node_Id;
13568 Act2 : Node_Id;
13569 Def : Node_Id;
13570 Ndec : Node_Id;
13571 Subp : Entity_Id;
13572 Actual : Entity_Id;
13573
13574 begin
13575 Assoc1 := Generic_Associations (N1);
13576
13577 if Present (Assoc1) then
13578 Act1 := First (Assoc1);
13579 else
13580 Act1 := Empty;
13581 Set_Generic_Associations (N1, New_List);
13582 Assoc1 := Generic_Associations (N1);
13583 end if;
13584
13585 if Present (Assoc2) then
13586 Act2 := First (Assoc2);
13587 else
13588 return;
13589 end if;
13590
13591 while Present (Act1) and then Present (Act2) loop
13592 Next (Act1);
13593 Next (Act2);
13594 end loop;
13595
13596 -- Find the associations added for default subprograms
13597
13598 if Present (Act2) then
13599 while Nkind (Act2) /= N_Generic_Association
13600 or else No (Entity (Selector_Name (Act2)))
13601 or else not Is_Overloadable (Entity (Selector_Name (Act2)))
13602 loop
13603 Next (Act2);
13604 end loop;
13605
13606 -- Add a similar association if the default is global. The
13607 -- renaming declaration for the actual has been analyzed, and
13608 -- its alias is the program it renames. Link the actual in the
13609 -- original generic tree with the node in the analyzed tree.
13610
13611 while Present (Act2) loop
13612 Subp := Entity (Selector_Name (Act2));
13613 Def := Explicit_Generic_Actual_Parameter (Act2);
13614
13615 -- Following test is defence against rubbish errors
13616
13617 if No (Alias (Subp)) then
13618 return;
13619 end if;
13620
13621 -- Retrieve the resolved actual from the renaming declaration
13622 -- created for the instantiated formal.
13623
13624 Actual := Entity (Name (Parent (Parent (Subp))));
13625 Set_Entity (Def, Actual);
13626 Set_Etype (Def, Etype (Actual));
13627
13628 if Is_Global (Actual) then
13629 Ndec :=
13630 Make_Generic_Association (Loc,
13631 Selector_Name => New_Occurrence_Of (Subp, Loc),
13632 Explicit_Generic_Actual_Parameter =>
13633 New_Occurrence_Of (Actual, Loc));
13634
13635 Set_Associated_Node
13636 (Explicit_Generic_Actual_Parameter (Ndec), Def);
13637
13638 Append (Ndec, Assoc1);
13639
13640 -- If there are other defaults, add a dummy association in case
13641 -- there are other defaulted formals with the same name.
13642
13643 elsif Present (Next (Act2)) then
13644 Ndec :=
13645 Make_Generic_Association (Loc,
13646 Selector_Name => New_Occurrence_Of (Subp, Loc),
13647 Explicit_Generic_Actual_Parameter => Empty);
13648
13649 Append (Ndec, Assoc1);
13650 end if;
13651
13652 Next (Act2);
13653 end loop;
13654 end if;
13655
13656 if Nkind (Name (N1)) = N_Identifier
13657 and then Is_Child_Unit (Gen_Id)
13658 and then Is_Global (Gen_Id)
13659 and then Is_Generic_Unit (Scope (Gen_Id))
13660 and then In_Open_Scopes (Scope (Gen_Id))
13661 then
13662 -- This is an instantiation of a child unit within a sibling, so
13663 -- that the generic parent is in scope. An eventual instance must
13664 -- occur within the scope of an instance of the parent. Make name
13665 -- in instance into an expanded name, to preserve the identifier
13666 -- of the parent, so it can be resolved subsequently.
13667
13668 Rewrite (Name (N2),
13669 Make_Expanded_Name (Loc,
13670 Chars => Chars (Gen_Id),
13671 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13672 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13673 Set_Entity (Name (N2), Gen_Id);
13674
13675 Rewrite (Name (N1),
13676 Make_Expanded_Name (Loc,
13677 Chars => Chars (Gen_Id),
13678 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13679 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13680
13681 Set_Associated_Node (Name (N1), Name (N2));
13682 Set_Associated_Node (Prefix (Name (N1)), Empty);
13683 Set_Associated_Node
13684 (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
13685 Set_Etype (Name (N1), Etype (Gen_Id));
13686 end if;
13687
13688 end Save_Global_Defaults;
13689
13690 ----------------------------
13691 -- Save_Global_Descendant --
13692 ----------------------------
13693
13694 procedure Save_Global_Descendant (D : Union_Id) is
13695 N1 : Node_Id;
13696
13697 begin
13698 if D in Node_Range then
13699 if D = Union_Id (Empty) then
13700 null;
13701
13702 elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
13703 Save_References (Node_Id (D));
13704 end if;
13705
13706 elsif D in List_Range then
13707 if D = Union_Id (No_List)
13708 or else Is_Empty_List (List_Id (D))
13709 then
13710 null;
13711
13712 else
13713 N1 := First (List_Id (D));
13714 while Present (N1) loop
13715 Save_References (N1);
13716 Next (N1);
13717 end loop;
13718 end if;
13719
13720 -- Element list or other non-node field, nothing to do
13721
13722 else
13723 null;
13724 end if;
13725 end Save_Global_Descendant;
13726
13727 ---------------------
13728 -- Save_References --
13729 ---------------------
13730
13731 -- This is the recursive procedure that does the work once the enclosing
13732 -- generic scope has been established. We have to treat specially a
13733 -- number of node rewritings that are required by semantic processing
13734 -- and which change the kind of nodes in the generic copy: typically
13735 -- constant-folding, replacing an operator node by a string literal, or
13736 -- a selected component by an expanded name. In each of those cases, the
13737 -- transformation is propagated to the generic unit.
13738
13739 procedure Save_References (N : Node_Id) is
13740 Loc : constant Source_Ptr := Sloc (N);
13741
13742 begin
13743 if N = Empty then
13744 null;
13745
13746 elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
13747 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13748 Reset_Entity (N);
13749
13750 elsif Nkind (N) = N_Operator_Symbol
13751 and then Nkind (Get_Associated_Node (N)) = N_String_Literal
13752 then
13753 Change_Operator_Symbol_To_String_Literal (N);
13754 end if;
13755
13756 elsif Nkind (N) in N_Op then
13757 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13758 if Nkind (N) = N_Op_Concat then
13759 Set_Is_Component_Left_Opnd (N,
13760 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13761
13762 Set_Is_Component_Right_Opnd (N,
13763 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13764 end if;
13765
13766 Reset_Entity (N);
13767
13768 else
13769 -- Node may be transformed into call to a user-defined operator
13770
13771 N2 := Get_Associated_Node (N);
13772
13773 if Nkind (N2) = N_Function_Call then
13774 E := Entity (Name (N2));
13775
13776 if Present (E)
13777 and then Is_Global (E)
13778 then
13779 Set_Etype (N, Etype (N2));
13780 else
13781 Set_Associated_Node (N, Empty);
13782 Set_Etype (N, Empty);
13783 end if;
13784
13785 elsif Nkind_In (N2, N_Integer_Literal,
13786 N_Real_Literal,
13787 N_String_Literal)
13788 then
13789 if Present (Original_Node (N2))
13790 and then Nkind (Original_Node (N2)) = Nkind (N)
13791 then
13792
13793 -- Operation was constant-folded. Whenever possible,
13794 -- recover semantic information from unfolded node,
13795 -- for ASIS use.
13796
13797 Set_Associated_Node (N, Original_Node (N2));
13798
13799 if Nkind (N) = N_Op_Concat then
13800 Set_Is_Component_Left_Opnd (N,
13801 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13802 Set_Is_Component_Right_Opnd (N,
13803 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13804 end if;
13805
13806 Reset_Entity (N);
13807
13808 else
13809 -- If original node is already modified, propagate
13810 -- constant-folding to template.
13811
13812 Rewrite (N, New_Copy (N2));
13813 Set_Analyzed (N, False);
13814 end if;
13815
13816 elsif Nkind (N2) = N_Identifier
13817 and then Ekind (Entity (N2)) = E_Enumeration_Literal
13818 then
13819 -- Same if call was folded into a literal, but in this case
13820 -- retain the entity to avoid spurious ambiguities if it is
13821 -- overloaded at the point of instantiation or inlining.
13822
13823 Rewrite (N, New_Copy (N2));
13824 Set_Analyzed (N, False);
13825 end if;
13826 end if;
13827
13828 -- Complete operands check if node has not been constant-folded
13829
13830 if Nkind (N) in N_Op then
13831 Save_Entity_Descendants (N);
13832 end if;
13833
13834 elsif Nkind (N) = N_Identifier then
13835 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13836
13837 -- If this is a discriminant reference, always save it. It is
13838 -- used in the instance to find the corresponding discriminant
13839 -- positionally rather than by name.
13840
13841 Set_Original_Discriminant
13842 (N, Original_Discriminant (Get_Associated_Node (N)));
13843 Reset_Entity (N);
13844
13845 else
13846 N2 := Get_Associated_Node (N);
13847
13848 if Nkind (N2) = N_Function_Call then
13849 E := Entity (Name (N2));
13850
13851 -- Name resolves to a call to parameterless function. If
13852 -- original entity is global, mark node as resolved.
13853
13854 if Present (E)
13855 and then Is_Global (E)
13856 then
13857 Set_Etype (N, Etype (N2));
13858 else
13859 Set_Associated_Node (N, Empty);
13860 Set_Etype (N, Empty);
13861 end if;
13862
13863 elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
13864 and then Is_Entity_Name (Original_Node (N2))
13865 then
13866 -- Name resolves to named number that is constant-folded,
13867 -- We must preserve the original name for ASIS use, and
13868 -- undo the constant-folding, which will be repeated in
13869 -- each instance.
13870
13871 Set_Associated_Node (N, Original_Node (N2));
13872 Reset_Entity (N);
13873
13874 elsif Nkind (N2) = N_String_Literal then
13875
13876 -- Name resolves to string literal. Perform the same
13877 -- replacement in generic.
13878
13879 Rewrite (N, New_Copy (N2));
13880
13881 elsif Nkind (N2) = N_Explicit_Dereference then
13882
13883 -- An identifier is rewritten as a dereference if it is the
13884 -- prefix in an implicit dereference (call or attribute).
13885 -- The analysis of an instantiation will expand the node
13886 -- again, so we preserve the original tree but link it to
13887 -- the resolved entity in case it is global.
13888
13889 if Is_Entity_Name (Prefix (N2))
13890 and then Present (Entity (Prefix (N2)))
13891 and then Is_Global (Entity (Prefix (N2)))
13892 then
13893 Set_Associated_Node (N, Prefix (N2));
13894
13895 elsif Nkind (Prefix (N2)) = N_Function_Call
13896 and then Is_Global (Entity (Name (Prefix (N2))))
13897 then
13898 Rewrite (N,
13899 Make_Explicit_Dereference (Loc,
13900 Prefix => Make_Function_Call (Loc,
13901 Name =>
13902 New_Occurrence_Of (Entity (Name (Prefix (N2))),
13903 Loc))));
13904
13905 else
13906 Set_Associated_Node (N, Empty);
13907 Set_Etype (N, Empty);
13908 end if;
13909
13910 -- The subtype mark of a nominally unconstrained object is
13911 -- rewritten as a subtype indication using the bounds of the
13912 -- expression. Recover the original subtype mark.
13913
13914 elsif Nkind (N2) = N_Subtype_Indication
13915 and then Is_Entity_Name (Original_Node (N2))
13916 then
13917 Set_Associated_Node (N, Original_Node (N2));
13918 Reset_Entity (N);
13919
13920 else
13921 null;
13922 end if;
13923 end if;
13924
13925 elsif Nkind (N) in N_Entity then
13926 null;
13927
13928 else
13929 declare
13930 Qual : Node_Id := Empty;
13931 Typ : Entity_Id := Empty;
13932 Nam : Node_Id;
13933
13934 use Atree.Unchecked_Access;
13935 -- This code section is part of implementing an untyped tree
13936 -- traversal, so it needs direct access to node fields.
13937
13938 begin
13939 if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
13940 N2 := Get_Associated_Node (N);
13941
13942 if No (N2) then
13943 Typ := Empty;
13944 else
13945 Typ := Etype (N2);
13946
13947 -- In an instance within a generic, use the name of the
13948 -- actual and not the original generic parameter. If the
13949 -- actual is global in the current generic it must be
13950 -- preserved for its instantiation.
13951
13952 if Nkind (Parent (Typ)) = N_Subtype_Declaration
13953 and then
13954 Present (Generic_Parent_Type (Parent (Typ)))
13955 then
13956 Typ := Base_Type (Typ);
13957 Set_Etype (N2, Typ);
13958 end if;
13959 end if;
13960
13961 if No (N2)
13962 or else No (Typ)
13963 or else not Is_Global (Typ)
13964 then
13965 Set_Associated_Node (N, Empty);
13966
13967 -- If the aggregate is an actual in a call, it has been
13968 -- resolved in the current context, to some local type.
13969 -- The enclosing call may have been disambiguated by the
13970 -- aggregate, and this disambiguation might fail at
13971 -- instantiation time because the type to which the
13972 -- aggregate did resolve is not preserved. In order to
13973 -- preserve some of this information, we wrap the
13974 -- aggregate in a qualified expression, using the id of
13975 -- its type. For further disambiguation we qualify the
13976 -- type name with its scope (if visible) because both
13977 -- id's will have corresponding entities in an instance.
13978 -- This resolves most of the problems with missing type
13979 -- information on aggregates in instances.
13980
13981 if Nkind (N2) = Nkind (N)
13982 and then Nkind (Parent (N2)) in N_Subprogram_Call
13983 and then Comes_From_Source (Typ)
13984 then
13985 if Is_Immediately_Visible (Scope (Typ)) then
13986 Nam := Make_Selected_Component (Loc,
13987 Prefix =>
13988 Make_Identifier (Loc, Chars (Scope (Typ))),
13989 Selector_Name =>
13990 Make_Identifier (Loc, Chars (Typ)));
13991 else
13992 Nam := Make_Identifier (Loc, Chars (Typ));
13993 end if;
13994
13995 Qual :=
13996 Make_Qualified_Expression (Loc,
13997 Subtype_Mark => Nam,
13998 Expression => Relocate_Node (N));
13999 end if;
14000 end if;
14001
14002 Save_Global_Descendant (Field1 (N));
14003 Save_Global_Descendant (Field2 (N));
14004 Save_Global_Descendant (Field3 (N));
14005 Save_Global_Descendant (Field5 (N));
14006
14007 if Present (Qual) then
14008 Rewrite (N, Qual);
14009 end if;
14010
14011 -- All other cases than aggregates
14012
14013 else
14014 Save_Global_Descendant (Field1 (N));
14015 Save_Global_Descendant (Field2 (N));
14016 Save_Global_Descendant (Field3 (N));
14017 Save_Global_Descendant (Field4 (N));
14018 Save_Global_Descendant (Field5 (N));
14019 end if;
14020 end;
14021 end if;
14022
14023 -- If a node has aspects, references within their expressions must
14024 -- be saved separately, given they are not directly in the tree.
14025
14026 if Has_Aspects (N) then
14027 declare
14028 Aspect : Node_Id;
14029
14030 begin
14031 Aspect := First (Aspect_Specifications (N));
14032 while Present (Aspect) loop
14033 if Present (Expression (Aspect)) then
14034 Save_Global_References (Expression (Aspect));
14035 end if;
14036
14037 Next (Aspect);
14038 end loop;
14039 end;
14040 end if;
14041 end Save_References;
14042
14043 -- Start of processing for Save_Global_References
14044
14045 begin
14046 Gen_Scope := Current_Scope;
14047
14048 -- If the generic unit is a child unit, references to entities in the
14049 -- parent are treated as local, because they will be resolved anew in
14050 -- the context of the instance of the parent.
14051
14052 while Is_Child_Unit (Gen_Scope)
14053 and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
14054 loop
14055 Gen_Scope := Scope (Gen_Scope);
14056 end loop;
14057
14058 Save_References (N);
14059 end Save_Global_References;
14060
14061 --------------------------------------
14062 -- Set_Copied_Sloc_For_Inlined_Body --
14063 --------------------------------------
14064
14065 procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
14066 begin
14067 Create_Instantiation_Source (N, E, True, S_Adjustment);
14068 end Set_Copied_Sloc_For_Inlined_Body;
14069
14070 ---------------------
14071 -- Set_Instance_Of --
14072 ---------------------
14073
14074 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
14075 begin
14076 Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
14077 Generic_Renamings_HTable.Set (Generic_Renamings.Last);
14078 Generic_Renamings.Increment_Last;
14079 end Set_Instance_Of;
14080
14081 --------------------
14082 -- Set_Next_Assoc --
14083 --------------------
14084
14085 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
14086 begin
14087 Generic_Renamings.Table (E).Next_In_HTable := Next;
14088 end Set_Next_Assoc;
14089
14090 -------------------
14091 -- Start_Generic --
14092 -------------------
14093
14094 procedure Start_Generic is
14095 begin
14096 -- ??? More things could be factored out in this routine.
14097 -- Should probably be done at a later stage.
14098
14099 Generic_Flags.Append (Inside_A_Generic);
14100 Inside_A_Generic := True;
14101
14102 Expander_Mode_Save_And_Set (False);
14103 end Start_Generic;
14104
14105 ----------------------
14106 -- Set_Instance_Env --
14107 ----------------------
14108
14109 procedure Set_Instance_Env
14110 (Gen_Unit : Entity_Id;
14111 Act_Unit : Entity_Id)
14112 is
14113 Assertion_Status : constant Boolean := Assertions_Enabled;
14114 Save_SPARK_Mode : constant SPARK_Mode_Type := SPARK_Mode;
14115 Save_SPARK_Mode_Pragma : constant Node_Id := SPARK_Mode_Pragma;
14116
14117 begin
14118 -- Regardless of the current mode, predefined units are analyzed in the
14119 -- most current Ada mode, and earlier version Ada checks do not apply
14120 -- to predefined units. Nothing needs to be done for non-internal units.
14121 -- These are always analyzed in the current mode.
14122
14123 if Is_Internal_File_Name
14124 (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
14125 Renamings_Included => True)
14126 then
14127 Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
14128
14129 -- In Ada2012 we may want to enable assertions in an instance of a
14130 -- predefined unit, in which case we need to preserve the current
14131 -- setting for the Assertions_Enabled flag. This will become more
14132 -- critical when pre/postconditions are added to predefined units,
14133 -- as is already the case for some numeric libraries.
14134
14135 if Ada_Version >= Ada_2012 then
14136 Assertions_Enabled := Assertion_Status;
14137 end if;
14138
14139 -- SPARK_Mode for an instance is the one applicable at the point of
14140 -- instantiation.
14141
14142 SPARK_Mode := Save_SPARK_Mode;
14143 SPARK_Mode_Pragma := Save_SPARK_Mode_Pragma;
14144 end if;
14145
14146 Current_Instantiated_Parent :=
14147 (Gen_Id => Gen_Unit,
14148 Act_Id => Act_Unit,
14149 Next_In_HTable => Assoc_Null);
14150 end Set_Instance_Env;
14151
14152 -----------------
14153 -- Switch_View --
14154 -----------------
14155
14156 procedure Switch_View (T : Entity_Id) is
14157 BT : constant Entity_Id := Base_Type (T);
14158 Priv_Elmt : Elmt_Id := No_Elmt;
14159 Priv_Sub : Entity_Id;
14160
14161 begin
14162 -- T may be private but its base type may have been exchanged through
14163 -- some other occurrence, in which case there is nothing to switch
14164 -- besides T itself. Note that a private dependent subtype of a private
14165 -- type might not have been switched even if the base type has been,
14166 -- because of the last branch of Check_Private_View (see comment there).
14167
14168 if not Is_Private_Type (BT) then
14169 Prepend_Elmt (Full_View (T), Exchanged_Views);
14170 Exchange_Declarations (T);
14171 return;
14172 end if;
14173
14174 Priv_Elmt := First_Elmt (Private_Dependents (BT));
14175
14176 if Present (Full_View (BT)) then
14177 Prepend_Elmt (Full_View (BT), Exchanged_Views);
14178 Exchange_Declarations (BT);
14179 end if;
14180
14181 while Present (Priv_Elmt) loop
14182 Priv_Sub := (Node (Priv_Elmt));
14183
14184 -- We avoid flipping the subtype if the Etype of its full view is
14185 -- private because this would result in a malformed subtype. This
14186 -- occurs when the Etype of the subtype full view is the full view of
14187 -- the base type (and since the base types were just switched, the
14188 -- subtype is pointing to the wrong view). This is currently the case
14189 -- for tagged record types, access types (maybe more?) and needs to
14190 -- be resolved. ???
14191
14192 if Present (Full_View (Priv_Sub))
14193 and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
14194 then
14195 Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
14196 Exchange_Declarations (Priv_Sub);
14197 end if;
14198
14199 Next_Elmt (Priv_Elmt);
14200 end loop;
14201 end Switch_View;
14202
14203 -----------------
14204 -- True_Parent --
14205 -----------------
14206
14207 function True_Parent (N : Node_Id) return Node_Id is
14208 begin
14209 if Nkind (Parent (N)) = N_Subunit then
14210 return Parent (Corresponding_Stub (Parent (N)));
14211 else
14212 return Parent (N);
14213 end if;
14214 end True_Parent;
14215
14216 -----------------------------
14217 -- Valid_Default_Attribute --
14218 -----------------------------
14219
14220 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
14221 Attr_Id : constant Attribute_Id :=
14222 Get_Attribute_Id (Attribute_Name (Def));
14223 T : constant Entity_Id := Entity (Prefix (Def));
14224 Is_Fun : constant Boolean := (Ekind (Nam) = E_Function);
14225 F : Entity_Id;
14226 Num_F : Int;
14227 OK : Boolean;
14228
14229 begin
14230 if No (T)
14231 or else T = Any_Id
14232 then
14233 return;
14234 end if;
14235
14236 Num_F := 0;
14237 F := First_Formal (Nam);
14238 while Present (F) loop
14239 Num_F := Num_F + 1;
14240 Next_Formal (F);
14241 end loop;
14242
14243 case Attr_Id is
14244 when Attribute_Adjacent | Attribute_Ceiling | Attribute_Copy_Sign |
14245 Attribute_Floor | Attribute_Fraction | Attribute_Machine |
14246 Attribute_Model | Attribute_Remainder | Attribute_Rounding |
14247 Attribute_Unbiased_Rounding =>
14248 OK := Is_Fun
14249 and then Num_F = 1
14250 and then Is_Floating_Point_Type (T);
14251
14252 when Attribute_Image | Attribute_Pred | Attribute_Succ |
14253 Attribute_Value | Attribute_Wide_Image |
14254 Attribute_Wide_Value =>
14255 OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
14256
14257 when Attribute_Max | Attribute_Min =>
14258 OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
14259
14260 when Attribute_Input =>
14261 OK := (Is_Fun and then Num_F = 1);
14262
14263 when Attribute_Output | Attribute_Read | Attribute_Write =>
14264 OK := (not Is_Fun and then Num_F = 2);
14265
14266 when others =>
14267 OK := False;
14268 end case;
14269
14270 if not OK then
14271 Error_Msg_N ("attribute reference has wrong profile for subprogram",
14272 Def);
14273 end if;
14274 end Valid_Default_Attribute;
14275
14276 end Sem_Ch12;