sem_ch12.adb, [...]: Minor reformatting.
[gcc.git] / gcc / ada / sem_ch12.adb
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- S E M _ C H 1 2 --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1992-2013, Free Software Foundation, Inc. --
10 -- --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
24 ------------------------------------------------------------------------------
25
26 with Aspects; use Aspects;
27 with Atree; use Atree;
28 with Debug; use Debug;
29 with Einfo; use Einfo;
30 with Elists; use Elists;
31 with Errout; use Errout;
32 with Expander; use Expander;
33 with Exp_Disp; use Exp_Disp;
34 with Fname; use Fname;
35 with Fname.UF; use Fname.UF;
36 with Freeze; use Freeze;
37 with Itypes; use Itypes;
38 with Lib; use Lib;
39 with Lib.Load; use Lib.Load;
40 with Lib.Xref; use Lib.Xref;
41 with Nlists; use Nlists;
42 with Namet; use Namet;
43 with Nmake; use Nmake;
44 with Opt; use Opt;
45 with Rident; use Rident;
46 with Restrict; use Restrict;
47 with Rtsfind; use Rtsfind;
48 with Sem; use Sem;
49 with Sem_Aux; use Sem_Aux;
50 with Sem_Cat; use Sem_Cat;
51 with Sem_Ch3; use Sem_Ch3;
52 with Sem_Ch6; use Sem_Ch6;
53 with Sem_Ch7; use Sem_Ch7;
54 with Sem_Ch8; use Sem_Ch8;
55 with Sem_Ch10; use Sem_Ch10;
56 with Sem_Ch13; use Sem_Ch13;
57 with Sem_Dim; use Sem_Dim;
58 with Sem_Disp; use Sem_Disp;
59 with Sem_Elab; use Sem_Elab;
60 with Sem_Elim; use Sem_Elim;
61 with Sem_Eval; use Sem_Eval;
62 with Sem_Prag; use Sem_Prag;
63 with Sem_Res; use Sem_Res;
64 with Sem_Type; use Sem_Type;
65 with Sem_Util; use Sem_Util;
66 with Sem_Warn; use Sem_Warn;
67 with Stand; use Stand;
68 with Sinfo; use Sinfo;
69 with Sinfo.CN; use Sinfo.CN;
70 with Sinput; use Sinput;
71 with Sinput.L; use Sinput.L;
72 with Snames; use Snames;
73 with Stringt; use Stringt;
74 with Uname; use Uname;
75 with Table;
76 with Tbuild; use Tbuild;
77 with Uintp; use Uintp;
78 with Urealp; use Urealp;
79
80 with GNAT.HTable;
81
82 package body Sem_Ch12 is
83
84 ----------------------------------------------------------
85 -- Implementation of Generic Analysis and Instantiation --
86 ----------------------------------------------------------
87
88 -- GNAT implements generics by macro expansion. No attempt is made to share
89 -- generic instantiations (for now). Analysis of a generic definition does
90 -- not perform any expansion action, but the expander must be called on the
91 -- tree for each instantiation, because the expansion may of course depend
92 -- on the generic actuals. All of this is best achieved as follows:
93 --
94 -- a) Semantic analysis of a generic unit is performed on a copy of the
95 -- tree for the generic unit. All tree modifications that follow analysis
96 -- do not affect the original tree. Links are kept between the original
97 -- tree and the copy, in order to recognize non-local references within
98 -- the generic, and propagate them to each instance (recall that name
99 -- resolution is done on the generic declaration: generics are not really
100 -- macros!). This is summarized in the following diagram:
101
102 -- .-----------. .----------.
103 -- | semantic |<--------------| generic |
104 -- | copy | | unit |
105 -- | |==============>| |
106 -- |___________| global |__________|
107 -- references | | |
108 -- | | |
109 -- .-----|--|.
110 -- | .-----|---.
111 -- | | .----------.
112 -- | | | generic |
113 -- |__| | |
114 -- |__| instance |
115 -- |__________|
116
117 -- b) Each instantiation copies the original tree, and inserts into it a
118 -- series of declarations that describe the mapping between generic formals
119 -- and actuals. For example, a generic In OUT parameter is an object
120 -- renaming of the corresponding actual, etc. Generic IN parameters are
121 -- constant declarations.
122
123 -- c) In order to give the right visibility for these renamings, we use
124 -- a different scheme for package and subprogram instantiations. For
125 -- packages, the list of renamings is inserted into the package
126 -- specification, before the visible declarations of the package. The
127 -- renamings are analyzed before any of the text of the instance, and are
128 -- thus visible at the right place. Furthermore, outside of the instance,
129 -- the generic parameters are visible and denote their corresponding
130 -- actuals.
131
132 -- For subprograms, we create a container package to hold the renamings
133 -- and the subprogram instance itself. Analysis of the package makes the
134 -- renaming declarations visible to the subprogram. After analyzing the
135 -- package, the defining entity for the subprogram is touched-up so that
136 -- it appears declared in the current scope, and not inside the container
137 -- package.
138
139 -- If the instantiation is a compilation unit, the container package is
140 -- given the same name as the subprogram instance. This ensures that
141 -- the elaboration procedure called by the binder, using the compilation
142 -- unit name, calls in fact the elaboration procedure for the package.
143
144 -- Not surprisingly, private types complicate this approach. By saving in
145 -- the original generic object the non-local references, we guarantee that
146 -- the proper entities are referenced at the point of instantiation.
147 -- However, for private types, this by itself does not insure that the
148 -- proper VIEW of the entity is used (the full type may be visible at the
149 -- point of generic definition, but not at instantiation, or vice-versa).
150 -- In order to reference the proper view, we special-case any reference
151 -- to private types in the generic object, by saving both views, one in
152 -- the generic and one in the semantic copy. At time of instantiation, we
153 -- check whether the two views are consistent, and exchange declarations if
154 -- necessary, in order to restore the correct visibility. Similarly, if
155 -- the instance view is private when the generic view was not, we perform
156 -- the exchange. After completing the instantiation, we restore the
157 -- current visibility. The flag Has_Private_View marks identifiers in the
158 -- the generic unit that require checking.
159
160 -- Visibility within nested generic units requires special handling.
161 -- Consider the following scheme:
162
163 -- type Global is ... -- outside of generic unit.
164 -- generic ...
165 -- package Outer is
166 -- ...
167 -- type Semi_Global is ... -- global to inner.
168
169 -- generic ... -- 1
170 -- procedure inner (X1 : Global; X2 : Semi_Global);
171
172 -- procedure in2 is new inner (...); -- 4
173 -- end Outer;
174
175 -- package New_Outer is new Outer (...); -- 2
176 -- procedure New_Inner is new New_Outer.Inner (...); -- 3
177
178 -- The semantic analysis of Outer captures all occurrences of Global.
179 -- The semantic analysis of Inner (at 1) captures both occurrences of
180 -- Global and Semi_Global.
181
182 -- At point 2 (instantiation of Outer), we also produce a generic copy
183 -- of Inner, even though Inner is, at that point, not being instantiated.
184 -- (This is just part of the semantic analysis of New_Outer).
185
186 -- Critically, references to Global within Inner must be preserved, while
187 -- references to Semi_Global should not preserved, because they must now
188 -- resolve to an entity within New_Outer. To distinguish between these, we
189 -- use a global variable, Current_Instantiated_Parent, which is set when
190 -- performing a generic copy during instantiation (at 2). This variable is
191 -- used when performing a generic copy that is not an instantiation, but
192 -- that is nested within one, as the occurrence of 1 within 2. The analysis
193 -- of a nested generic only preserves references that are global to the
194 -- enclosing Current_Instantiated_Parent. We use the Scope_Depth value to
195 -- determine whether a reference is external to the given parent.
196
197 -- The instantiation at point 3 requires no special treatment. The method
198 -- works as well for further nestings of generic units, but of course the
199 -- variable Current_Instantiated_Parent must be stacked because nested
200 -- instantiations can occur, e.g. the occurrence of 4 within 2.
201
202 -- The instantiation of package and subprogram bodies is handled in a
203 -- similar manner, except that it is delayed until after semantic
204 -- analysis is complete. In this fashion complex cross-dependencies
205 -- between several package declarations and bodies containing generics
206 -- can be compiled which otherwise would diagnose spurious circularities.
207
208 -- For example, it is possible to compile two packages A and B that
209 -- have the following structure:
210
211 -- package A is package B is
212 -- generic ... generic ...
213 -- package G_A is package G_B is
214
215 -- with B; with A;
216 -- package body A is package body B is
217 -- package N_B is new G_B (..) package N_A is new G_A (..)
218
219 -- The table Pending_Instantiations in package Inline is used to keep
220 -- track of body instantiations that are delayed in this manner. Inline
221 -- handles the actual calls to do the body instantiations. This activity
222 -- is part of Inline, since the processing occurs at the same point, and
223 -- for essentially the same reason, as the handling of inlined routines.
224
225 ----------------------------------------------
226 -- Detection of Instantiation Circularities --
227 ----------------------------------------------
228
229 -- If we have a chain of instantiations that is circular, this is static
230 -- error which must be detected at compile time. The detection of these
231 -- circularities is carried out at the point that we insert a generic
232 -- instance spec or body. If there is a circularity, then the analysis of
233 -- the offending spec or body will eventually result in trying to load the
234 -- same unit again, and we detect this problem as we analyze the package
235 -- instantiation for the second time.
236
237 -- At least in some cases after we have detected the circularity, we get
238 -- into trouble if we try to keep going. The following flag is set if a
239 -- circularity is detected, and used to abandon compilation after the
240 -- messages have been posted.
241
242 Circularity_Detected : Boolean := False;
243 -- This should really be reset on encountering a new main unit, but in
244 -- practice we are not using multiple main units so it is not critical.
245
246 -------------------------------------------------
247 -- Formal packages and partial parametrization --
248 -------------------------------------------------
249
250 -- When compiling a generic, a formal package is a local instantiation. If
251 -- declared with a box, its generic formals are visible in the enclosing
252 -- generic. If declared with a partial list of actuals, those actuals that
253 -- are defaulted (covered by an Others clause, or given an explicit box
254 -- initialization) are also visible in the enclosing generic, while those
255 -- that have a corresponding actual are not.
256
257 -- In our source model of instantiation, the same visibility must be
258 -- present in the spec and body of an instance: the names of the formals
259 -- that are defaulted must be made visible within the instance, and made
260 -- invisible (hidden) after the instantiation is complete, so that they
261 -- are not accessible outside of the instance.
262
263 -- In a generic, a formal package is treated like a special instantiation.
264 -- Our Ada 95 compiler handled formals with and without box in different
265 -- ways. With partial parametrization, we use a single model for both.
266 -- We create a package declaration that consists of the specification of
267 -- the generic package, and a set of declarations that map the actuals
268 -- into local renamings, just as we do for bona fide instantiations. For
269 -- defaulted parameters and formals with a box, we copy directly the
270 -- declarations of the formal into this local package. The result is a
271 -- a package whose visible declarations may include generic formals. This
272 -- package is only used for type checking and visibility analysis, and
273 -- never reaches the back-end, so it can freely violate the placement
274 -- rules for generic formal declarations.
275
276 -- The list of declarations (renamings and copies of formals) is built
277 -- by Analyze_Associations, just as for regular instantiations.
278
279 -- At the point of instantiation, conformance checking must be applied only
280 -- to those parameters that were specified in the formal. We perform this
281 -- checking by creating another internal instantiation, this one including
282 -- only the renamings and the formals (the rest of the package spec is not
283 -- relevant to conformance checking). We can then traverse two lists: the
284 -- list of actuals in the instance that corresponds to the formal package,
285 -- and the list of actuals produced for this bogus instantiation. We apply
286 -- the conformance rules to those actuals that are not defaulted (i.e.
287 -- which still appear as generic formals.
288
289 -- When we compile an instance body we must make the right parameters
290 -- visible again. The predicate Is_Generic_Formal indicates which of the
291 -- formals should have its Is_Hidden flag reset.
292
293 -----------------------
294 -- Local subprograms --
295 -----------------------
296
297 procedure Abandon_Instantiation (N : Node_Id);
298 pragma No_Return (Abandon_Instantiation);
299 -- Posts an error message "instantiation abandoned" at the indicated node
300 -- and then raises the exception Instantiation_Error to do it.
301
302 procedure Analyze_Formal_Array_Type
303 (T : in out Entity_Id;
304 Def : Node_Id);
305 -- A formal array type is treated like an array type declaration, and
306 -- invokes Array_Type_Declaration (sem_ch3) whose first parameter is
307 -- in-out, because in the case of an anonymous type the entity is
308 -- actually created in the procedure.
309
310 -- The following procedures treat other kinds of formal parameters
311
312 procedure Analyze_Formal_Derived_Interface_Type
313 (N : Node_Id;
314 T : Entity_Id;
315 Def : Node_Id);
316
317 procedure Analyze_Formal_Derived_Type
318 (N : Node_Id;
319 T : Entity_Id;
320 Def : Node_Id);
321
322 procedure Analyze_Formal_Interface_Type
323 (N : Node_Id;
324 T : Entity_Id;
325 Def : Node_Id);
326
327 -- The following subprograms create abbreviated declarations for formal
328 -- scalar types. We introduce an anonymous base of the proper class for
329 -- each of them, and define the formals as constrained first subtypes of
330 -- their bases. The bounds are expressions that are non-static in the
331 -- generic.
332
333 procedure Analyze_Formal_Decimal_Fixed_Point_Type
334 (T : Entity_Id; Def : Node_Id);
335 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id);
336 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id);
337 procedure Analyze_Formal_Signed_Integer_Type (T : Entity_Id; Def : Node_Id);
338 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id);
339 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
340 (T : Entity_Id; Def : Node_Id);
341
342 procedure Analyze_Formal_Private_Type
343 (N : Node_Id;
344 T : Entity_Id;
345 Def : Node_Id);
346 -- Creates a new private type, which does not require completion
347
348 procedure Analyze_Formal_Incomplete_Type (T : Entity_Id; Def : Node_Id);
349 -- Ada 2012: Creates a new incomplete type whose actual does not freeze
350
351 procedure Analyze_Generic_Formal_Part (N : Node_Id);
352 -- Analyze generic formal part
353
354 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
355 -- Create a new access type with the given designated type
356
357 function Analyze_Associations
358 (I_Node : Node_Id;
359 Formals : List_Id;
360 F_Copy : List_Id) return List_Id;
361 -- At instantiation time, build the list of associations between formals
362 -- and actuals. Each association becomes a renaming declaration for the
363 -- formal entity. F_Copy is the analyzed list of formals in the generic
364 -- copy. It is used to apply legality checks to the actuals. I_Node is the
365 -- instantiation node itself.
366
367 procedure Analyze_Subprogram_Instantiation
368 (N : Node_Id;
369 K : Entity_Kind);
370
371 procedure Build_Instance_Compilation_Unit_Nodes
372 (N : Node_Id;
373 Act_Body : Node_Id;
374 Act_Decl : Node_Id);
375 -- This procedure is used in the case where the generic instance of a
376 -- subprogram body or package body is a library unit. In this case, the
377 -- original library unit node for the generic instantiation must be
378 -- replaced by the resulting generic body, and a link made to a new
379 -- compilation unit node for the generic declaration. The argument N is
380 -- the original generic instantiation. Act_Body and Act_Decl are the body
381 -- and declaration of the instance (either package body and declaration
382 -- nodes or subprogram body and declaration nodes depending on the case).
383 -- On return, the node N has been rewritten with the actual body.
384
385 procedure Check_Access_Definition (N : Node_Id);
386 -- Subsidiary routine to null exclusion processing. Perform an assertion
387 -- check on Ada version and the presence of an access definition in N.
388
389 procedure Check_Formal_Packages (P_Id : Entity_Id);
390 -- Apply the following to all formal packages in generic associations
391
392 procedure Check_Formal_Package_Instance
393 (Formal_Pack : Entity_Id;
394 Actual_Pack : Entity_Id);
395 -- Verify that the actuals of the actual instance match the actuals of
396 -- the template for a formal package that is not declared with a box.
397
398 procedure Check_Forward_Instantiation (Decl : Node_Id);
399 -- If the generic is a local entity and the corresponding body has not
400 -- been seen yet, flag enclosing packages to indicate that it will be
401 -- elaborated after the generic body. Subprograms declared in the same
402 -- package cannot be inlined by the front-end because front-end inlining
403 -- requires a strict linear order of elaboration.
404
405 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id;
406 -- Check if some association between formals and actuals requires to make
407 -- visible primitives of a tagged type, and make those primitives visible.
408 -- Return the list of primitives whose visibility is modified (to restore
409 -- their visibility later through Restore_Hidden_Primitives). If no
410 -- candidate is found then return No_Elist.
411
412 procedure Check_Hidden_Child_Unit
413 (N : Node_Id;
414 Gen_Unit : Entity_Id;
415 Act_Decl_Id : Entity_Id);
416 -- If the generic unit is an implicit child instance within a parent
417 -- instance, we need to make an explicit test that it is not hidden by
418 -- a child instance of the same name and parent.
419
420 procedure Check_Generic_Actuals
421 (Instance : Entity_Id;
422 Is_Formal_Box : Boolean);
423 -- Similar to previous one. Check the actuals in the instantiation,
424 -- whose views can change between the point of instantiation and the point
425 -- of instantiation of the body. In addition, mark the generic renamings
426 -- as generic actuals, so that they are not compatible with other actuals.
427 -- Recurse on an actual that is a formal package whose declaration has
428 -- a box.
429
430 function Contains_Instance_Of
431 (Inner : Entity_Id;
432 Outer : Entity_Id;
433 N : Node_Id) return Boolean;
434 -- Inner is instantiated within the generic Outer. Check whether Inner
435 -- directly or indirectly contains an instance of Outer or of one of its
436 -- parents, in the case of a subunit. Each generic unit holds a list of
437 -- the entities instantiated within (at any depth). This procedure
438 -- determines whether the set of such lists contains a cycle, i.e. an
439 -- illegal circular instantiation.
440
441 function Denotes_Formal_Package
442 (Pack : Entity_Id;
443 On_Exit : Boolean := False;
444 Instance : Entity_Id := Empty) return Boolean;
445 -- Returns True if E is a formal package of an enclosing generic, or
446 -- the actual for such a formal in an enclosing instantiation. If such
447 -- a package is used as a formal in an nested generic, or as an actual
448 -- in a nested instantiation, the visibility of ITS formals should not
449 -- be modified. When called from within Restore_Private_Views, the flag
450 -- On_Exit is true, to indicate that the search for a possible enclosing
451 -- instance should ignore the current one. In that case Instance denotes
452 -- the declaration for which this is an actual. This declaration may be
453 -- an instantiation in the source, or the internal instantiation that
454 -- corresponds to the actual for a formal package.
455
456 function Earlier (N1, N2 : Node_Id) return Boolean;
457 -- Yields True if N1 and N2 appear in the same compilation unit,
458 -- ignoring subunits, and if N1 is to the left of N2 in a left-to-right
459 -- traversal of the tree for the unit. Used to determine the placement
460 -- of freeze nodes for instance bodies that may depend on other instances.
461
462 function Find_Actual_Type
463 (Typ : Entity_Id;
464 Gen_Type : Entity_Id) return Entity_Id;
465 -- When validating the actual types of a child instance, check whether
466 -- the formal is a formal type of the parent unit, and retrieve the current
467 -- actual for it. Typ is the entity in the analyzed formal type declaration
468 -- (component or index type of an array type, or designated type of an
469 -- access formal) and Gen_Type is the enclosing analyzed formal array
470 -- or access type. The desired actual may be a formal of a parent, or may
471 -- be declared in a formal package of a parent. In both cases it is a
472 -- generic actual type because it appears within a visible instance.
473 -- Finally, it may be declared in a parent unit without being a formal
474 -- of that unit, in which case it must be retrieved by visibility.
475 -- Ambiguities may still arise if two homonyms are declared in two formal
476 -- packages, and the prefix of the formal type may be needed to resolve
477 -- the ambiguity in the instance ???
478
479 function In_Same_Declarative_Part
480 (F_Node : Node_Id;
481 Inst : Node_Id) return Boolean;
482 -- True if the instantiation Inst and the given freeze_node F_Node appear
483 -- within the same declarative part, ignoring subunits, but with no inter-
484 -- vening subprograms or concurrent units. Used to find the proper plave
485 -- for the freeze node of an instance, when the generic is declared in a
486 -- previous instance. If predicate is true, the freeze node of the instance
487 -- can be placed after the freeze node of the previous instance, Otherwise
488 -- it has to be placed at the end of the current declarative part.
489
490 function In_Main_Context (E : Entity_Id) return Boolean;
491 -- Check whether an instantiation is in the context of the main unit.
492 -- Used to determine whether its body should be elaborated to allow
493 -- front-end inlining.
494
495 procedure Set_Instance_Env
496 (Gen_Unit : Entity_Id;
497 Act_Unit : Entity_Id);
498 -- Save current instance on saved environment, to be used to determine
499 -- the global status of entities in nested instances. Part of Save_Env.
500 -- called after verifying that the generic unit is legal for the instance,
501 -- The procedure also examines whether the generic unit is a predefined
502 -- unit, in order to set configuration switches accordingly. As a result
503 -- the procedure must be called after analyzing and freezing the actuals.
504
505 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id);
506 -- Associate analyzed generic parameter with corresponding
507 -- instance. Used for semantic checks at instantiation time.
508
509 function Has_Been_Exchanged (E : Entity_Id) return Boolean;
510 -- Traverse the Exchanged_Views list to see if a type was private
511 -- and has already been flipped during this phase of instantiation.
512
513 procedure Hide_Current_Scope;
514 -- When instantiating a generic child unit, the parent context must be
515 -- present, but the instance and all entities that may be generated
516 -- must be inserted in the current scope. We leave the current scope
517 -- on the stack, but make its entities invisible to avoid visibility
518 -- problems. This is reversed at the end of the instantiation. This is
519 -- not done for the instantiation of the bodies, which only require the
520 -- instances of the generic parents to be in scope.
521
522 procedure Install_Body
523 (Act_Body : Node_Id;
524 N : Node_Id;
525 Gen_Body : Node_Id;
526 Gen_Decl : Node_Id);
527 -- If the instantiation happens textually before the body of the generic,
528 -- the instantiation of the body must be analyzed after the generic body,
529 -- and not at the point of instantiation. Such early instantiations can
530 -- happen if the generic and the instance appear in a package declaration
531 -- because the generic body can only appear in the corresponding package
532 -- body. Early instantiations can also appear if generic, instance and
533 -- body are all in the declarative part of a subprogram or entry. Entities
534 -- of packages that are early instantiations are delayed, and their freeze
535 -- node appears after the generic body.
536
537 procedure Insert_Freeze_Node_For_Instance
538 (N : Node_Id;
539 F_Node : Node_Id);
540 -- N denotes a package or a subprogram instantiation and F_Node is the
541 -- associated freeze node. Insert the freeze node before the first source
542 -- body which follows immediately after N. If no such body is found, the
543 -- freeze node is inserted at the end of the declarative region which
544 -- contains N.
545
546 procedure Freeze_Subprogram_Body
547 (Inst_Node : Node_Id;
548 Gen_Body : Node_Id;
549 Pack_Id : Entity_Id);
550 -- The generic body may appear textually after the instance, including
551 -- in the proper body of a stub, or within a different package instance.
552 -- Given that the instance can only be elaborated after the generic, we
553 -- place freeze_nodes for the instance and/or for packages that may enclose
554 -- the instance and the generic, so that the back-end can establish the
555 -- proper order of elaboration.
556
557 procedure Init_Env;
558 -- Establish environment for subsequent instantiation. Separated from
559 -- Save_Env because data-structures for visibility handling must be
560 -- initialized before call to Check_Generic_Child_Unit.
561
562 procedure Install_Formal_Packages (Par : Entity_Id);
563 -- Install the visible part of any formal of the parent that is a formal
564 -- package. Note that for the case of a formal package with a box, this
565 -- includes the formal part of the formal package (12.7(10/2)).
566
567 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False);
568 -- When compiling an instance of a child unit the parent (which is
569 -- itself an instance) is an enclosing scope that must be made
570 -- immediately visible. This procedure is also used to install the non-
571 -- generic parent of a generic child unit when compiling its body, so
572 -- that full views of types in the parent are made visible.
573
574 procedure Remove_Parent (In_Body : Boolean := False);
575 -- Reverse effect after instantiation of child is complete
576
577 procedure Install_Hidden_Primitives
578 (Prims_List : in out Elist_Id;
579 Gen_T : Entity_Id;
580 Act_T : Entity_Id);
581 -- Remove suffix 'P' from hidden primitives of Act_T to match the
582 -- visibility of primitives of Gen_T. The list of primitives to which
583 -- the suffix is removed is added to Prims_List to restore them later.
584
585 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id);
586 -- Restore suffix 'P' to primitives of Prims_List and leave Prims_List
587 -- set to No_Elist.
588
589 procedure Inline_Instance_Body
590 (N : Node_Id;
591 Gen_Unit : Entity_Id;
592 Act_Decl : Node_Id);
593 -- If front-end inlining is requested, instantiate the package body,
594 -- and preserve the visibility of its compilation unit, to insure
595 -- that successive instantiations succeed.
596
597 -- The functions Instantiate_XXX perform various legality checks and build
598 -- the declarations for instantiated generic parameters. In all of these
599 -- Formal is the entity in the generic unit, Actual is the entity of
600 -- expression in the generic associations, and Analyzed_Formal is the
601 -- formal in the generic copy, which contains the semantic information to
602 -- be used to validate the actual.
603
604 function Instantiate_Object
605 (Formal : Node_Id;
606 Actual : Node_Id;
607 Analyzed_Formal : Node_Id) return List_Id;
608
609 function Instantiate_Type
610 (Formal : Node_Id;
611 Actual : Node_Id;
612 Analyzed_Formal : Node_Id;
613 Actual_Decls : List_Id) return List_Id;
614
615 function Instantiate_Formal_Subprogram
616 (Formal : Node_Id;
617 Actual : Node_Id;
618 Analyzed_Formal : Node_Id) return Node_Id;
619
620 function Instantiate_Formal_Package
621 (Formal : Node_Id;
622 Actual : Node_Id;
623 Analyzed_Formal : Node_Id) return List_Id;
624 -- If the formal package is declared with a box, special visibility rules
625 -- apply to its formals: they are in the visible part of the package. This
626 -- is true in the declarative region of the formal package, that is to say
627 -- in the enclosing generic or instantiation. For an instantiation, the
628 -- parameters of the formal package are made visible in an explicit step.
629 -- Furthermore, if the actual has a visible USE clause, these formals must
630 -- be made potentially use-visible as well. On exit from the enclosing
631 -- instantiation, the reverse must be done.
632
633 -- For a formal package declared without a box, there are conformance rules
634 -- that apply to the actuals in the generic declaration and the actuals of
635 -- the actual package in the enclosing instantiation. The simplest way to
636 -- apply these rules is to repeat the instantiation of the formal package
637 -- in the context of the enclosing instance, and compare the generic
638 -- associations of this instantiation with those of the actual package.
639 -- This internal instantiation only needs to contain the renamings of the
640 -- formals: the visible and private declarations themselves need not be
641 -- created.
642
643 -- In Ada 2005, the formal package may be only partially parameterized.
644 -- In that case the visibility step must make visible those actuals whose
645 -- corresponding formals were given with a box. A final complication
646 -- involves inherited operations from formal derived types, which must
647 -- be visible if the type is.
648
649 function Is_In_Main_Unit (N : Node_Id) return Boolean;
650 -- Test if given node is in the main unit
651
652 procedure Load_Parent_Of_Generic
653 (N : Node_Id;
654 Spec : Node_Id;
655 Body_Optional : Boolean := False);
656 -- If the generic appears in a separate non-generic library unit, load the
657 -- corresponding body to retrieve the body of the generic. N is the node
658 -- for the generic instantiation, Spec is the generic package declaration.
659 --
660 -- Body_Optional is a flag that indicates that the body is being loaded to
661 -- ensure that temporaries are generated consistently when there are other
662 -- instances in the current declarative part that precede the one being
663 -- loaded. In that case a missing body is acceptable.
664
665 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id);
666 -- Add the context clause of the unit containing a generic unit to a
667 -- compilation unit that is, or contains, an instantiation.
668
669 function Get_Associated_Node (N : Node_Id) return Node_Id;
670 -- In order to propagate semantic information back from the analyzed copy
671 -- to the original generic, we maintain links between selected nodes in the
672 -- generic and their corresponding copies. At the end of generic analysis,
673 -- the routine Save_Global_References traverses the generic tree, examines
674 -- the semantic information, and preserves the links to those nodes that
675 -- contain global information. At instantiation, the information from the
676 -- associated node is placed on the new copy, so that name resolution is
677 -- not repeated.
678 --
679 -- Three kinds of source nodes have associated nodes:
680 --
681 -- a) those that can reference (denote) entities, that is identifiers,
682 -- character literals, expanded_names, operator symbols, operators,
683 -- and attribute reference nodes. These nodes have an Entity field
684 -- and are the set of nodes that are in N_Has_Entity.
685 --
686 -- b) aggregates (N_Aggregate and N_Extension_Aggregate)
687 --
688 -- c) selected components (N_Selected_Component)
689 --
690 -- For the first class, the associated node preserves the entity if it is
691 -- global. If the generic contains nested instantiations, the associated
692 -- node itself has been recopied, and a chain of them must be followed.
693 --
694 -- For aggregates, the associated node allows retrieval of the type, which
695 -- may otherwise not appear in the generic. The view of this type may be
696 -- different between generic and instantiation, and the full view can be
697 -- installed before the instantiation is analyzed. For aggregates of type
698 -- extensions, the same view exchange may have to be performed for some of
699 -- the ancestor types, if their view is private at the point of
700 -- instantiation.
701 --
702 -- Nodes that are selected components in the parse tree may be rewritten
703 -- as expanded names after resolution, and must be treated as potential
704 -- entity holders, which is why they also have an Associated_Node.
705 --
706 -- Nodes that do not come from source, such as freeze nodes, do not appear
707 -- in the generic tree, and need not have an associated node.
708 --
709 -- The associated node is stored in the Associated_Node field. Note that
710 -- this field overlaps Entity, which is fine, because the whole point is
711 -- that we don't need or want the normal Entity field in this situation.
712
713 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id);
714 -- Within the generic part, entities in the formal package are
715 -- visible. To validate subsequent type declarations, indicate
716 -- the correspondence between the entities in the analyzed formal,
717 -- and the entities in the actual package. There are three packages
718 -- involved in the instantiation of a formal package: the parent
719 -- generic P1 which appears in the generic declaration, the fake
720 -- instantiation P2 which appears in the analyzed generic, and whose
721 -- visible entities may be used in subsequent formals, and the actual
722 -- P3 in the instance. To validate subsequent formals, me indicate
723 -- that the entities in P2 are mapped into those of P3. The mapping of
724 -- entities has to be done recursively for nested packages.
725
726 procedure Move_Freeze_Nodes
727 (Out_Of : Entity_Id;
728 After : Node_Id;
729 L : List_Id);
730 -- Freeze nodes can be generated in the analysis of a generic unit, but
731 -- will not be seen by the back-end. It is necessary to move those nodes
732 -- to the enclosing scope if they freeze an outer entity. We place them
733 -- at the end of the enclosing generic package, which is semantically
734 -- neutral.
735
736 procedure Preanalyze_Actuals (N : Node_Id);
737 -- Analyze actuals to perform name resolution. Full resolution is done
738 -- later, when the expected types are known, but names have to be captured
739 -- before installing parents of generics, that are not visible for the
740 -- actuals themselves.
741
742 function True_Parent (N : Node_Id) return Node_Id;
743 -- For a subunit, return parent of corresponding stub, else return
744 -- parent of node.
745
746 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id);
747 -- Verify that an attribute that appears as the default for a formal
748 -- subprogram is a function or procedure with the correct profile.
749
750 -------------------------------------------
751 -- Data Structures for Generic Renamings --
752 -------------------------------------------
753
754 -- The map Generic_Renamings associates generic entities with their
755 -- corresponding actuals. Currently used to validate type instances. It
756 -- will eventually be used for all generic parameters to eliminate the
757 -- need for overload resolution in the instance.
758
759 type Assoc_Ptr is new Int;
760
761 Assoc_Null : constant Assoc_Ptr := -1;
762
763 type Assoc is record
764 Gen_Id : Entity_Id;
765 Act_Id : Entity_Id;
766 Next_In_HTable : Assoc_Ptr;
767 end record;
768
769 package Generic_Renamings is new Table.Table
770 (Table_Component_Type => Assoc,
771 Table_Index_Type => Assoc_Ptr,
772 Table_Low_Bound => 0,
773 Table_Initial => 10,
774 Table_Increment => 100,
775 Table_Name => "Generic_Renamings");
776
777 -- Variable to hold enclosing instantiation. When the environment is
778 -- saved for a subprogram inlining, the corresponding Act_Id is empty.
779
780 Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
781
782 -- Hash table for associations
783
784 HTable_Size : constant := 37;
785 type HTable_Range is range 0 .. HTable_Size - 1;
786
787 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr);
788 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr;
789 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id;
790 function Hash (F : Entity_Id) return HTable_Range;
791
792 package Generic_Renamings_HTable is new GNAT.HTable.Static_HTable (
793 Header_Num => HTable_Range,
794 Element => Assoc,
795 Elmt_Ptr => Assoc_Ptr,
796 Null_Ptr => Assoc_Null,
797 Set_Next => Set_Next_Assoc,
798 Next => Next_Assoc,
799 Key => Entity_Id,
800 Get_Key => Get_Gen_Id,
801 Hash => Hash,
802 Equal => "=");
803
804 Exchanged_Views : Elist_Id;
805 -- This list holds the private views that have been exchanged during
806 -- instantiation to restore the visibility of the generic declaration.
807 -- (see comments above). After instantiation, the current visibility is
808 -- reestablished by means of a traversal of this list.
809
810 Hidden_Entities : Elist_Id;
811 -- This list holds the entities of the current scope that are removed
812 -- from immediate visibility when instantiating a child unit. Their
813 -- visibility is restored in Remove_Parent.
814
815 -- Because instantiations can be recursive, the following must be saved
816 -- on entry and restored on exit from an instantiation (spec or body).
817 -- This is done by the two procedures Save_Env and Restore_Env. For
818 -- package and subprogram instantiations (but not for the body instances)
819 -- the action of Save_Env is done in two steps: Init_Env is called before
820 -- Check_Generic_Child_Unit, because setting the parent instances requires
821 -- that the visibility data structures be properly initialized. Once the
822 -- generic is unit is validated, Set_Instance_Env completes Save_Env.
823
824 Parent_Unit_Visible : Boolean := False;
825 -- Parent_Unit_Visible is used when the generic is a child unit, and
826 -- indicates whether the ultimate parent of the generic is visible in the
827 -- instantiation environment. It is used to reset the visibility of the
828 -- parent at the end of the instantiation (see Remove_Parent).
829
830 Instance_Parent_Unit : Entity_Id := Empty;
831 -- This records the ultimate parent unit of an instance of a generic
832 -- child unit and is used in conjunction with Parent_Unit_Visible to
833 -- indicate the unit to which the Parent_Unit_Visible flag corresponds.
834
835 type Instance_Env is record
836 Instantiated_Parent : Assoc;
837 Exchanged_Views : Elist_Id;
838 Hidden_Entities : Elist_Id;
839 Current_Sem_Unit : Unit_Number_Type;
840 Parent_Unit_Visible : Boolean := False;
841 Instance_Parent_Unit : Entity_Id := Empty;
842 Switches : Config_Switches_Type;
843 end record;
844
845 package Instance_Envs is new Table.Table (
846 Table_Component_Type => Instance_Env,
847 Table_Index_Type => Int,
848 Table_Low_Bound => 0,
849 Table_Initial => 32,
850 Table_Increment => 100,
851 Table_Name => "Instance_Envs");
852
853 procedure Restore_Private_Views
854 (Pack_Id : Entity_Id;
855 Is_Package : Boolean := True);
856 -- Restore the private views of external types, and unmark the generic
857 -- renamings of actuals, so that they become compatible subtypes again.
858 -- For subprograms, Pack_Id is the package constructed to hold the
859 -- renamings.
860
861 procedure Switch_View (T : Entity_Id);
862 -- Switch the partial and full views of a type and its private
863 -- dependents (i.e. its subtypes and derived types).
864
865 ------------------------------------
866 -- Structures for Error Reporting --
867 ------------------------------------
868
869 Instantiation_Node : Node_Id;
870 -- Used by subprograms that validate instantiation of formal parameters
871 -- where there might be no actual on which to place the error message.
872 -- Also used to locate the instantiation node for generic subunits.
873
874 Instantiation_Error : exception;
875 -- When there is a semantic error in the generic parameter matching,
876 -- there is no point in continuing the instantiation, because the
877 -- number of cascaded errors is unpredictable. This exception aborts
878 -- the instantiation process altogether.
879
880 S_Adjustment : Sloc_Adjustment;
881 -- Offset created for each node in an instantiation, in order to keep
882 -- track of the source position of the instantiation in each of its nodes.
883 -- A subsequent semantic error or warning on a construct of the instance
884 -- points to both places: the original generic node, and the point of
885 -- instantiation. See Sinput and Sinput.L for additional details.
886
887 ------------------------------------------------------------
888 -- Data structure for keeping track when inside a Generic --
889 ------------------------------------------------------------
890
891 -- The following table is used to save values of the Inside_A_Generic
892 -- flag (see spec of Sem) when they are saved by Start_Generic.
893
894 package Generic_Flags is new Table.Table (
895 Table_Component_Type => Boolean,
896 Table_Index_Type => Int,
897 Table_Low_Bound => 0,
898 Table_Initial => 32,
899 Table_Increment => 200,
900 Table_Name => "Generic_Flags");
901
902 ---------------------------
903 -- Abandon_Instantiation --
904 ---------------------------
905
906 procedure Abandon_Instantiation (N : Node_Id) is
907 begin
908 Error_Msg_N ("\instantiation abandoned!", N);
909 raise Instantiation_Error;
910 end Abandon_Instantiation;
911
912 --------------------------
913 -- Analyze_Associations --
914 --------------------------
915
916 function Analyze_Associations
917 (I_Node : Node_Id;
918 Formals : List_Id;
919 F_Copy : List_Id) return List_Id
920 is
921 Actuals_To_Freeze : constant Elist_Id := New_Elmt_List;
922 Assoc : constant List_Id := New_List;
923 Default_Actuals : constant Elist_Id := New_Elmt_List;
924 Gen_Unit : constant Entity_Id :=
925 Defining_Entity (Parent (F_Copy));
926
927 Actuals : List_Id;
928 Actual : Node_Id;
929 Analyzed_Formal : Node_Id;
930 First_Named : Node_Id := Empty;
931 Formal : Node_Id;
932 Match : Node_Id;
933 Named : Node_Id;
934 Saved_Formal : Node_Id;
935
936 Default_Formals : constant List_Id := New_List;
937 -- If an Others_Choice is present, some of the formals may be defaulted.
938 -- To simplify the treatment of visibility in an instance, we introduce
939 -- individual defaults for each such formal. These defaults are
940 -- appended to the list of associations and replace the Others_Choice.
941
942 Found_Assoc : Node_Id;
943 -- Association for the current formal being match. Empty if there are
944 -- no remaining actuals, or if there is no named association with the
945 -- name of the formal.
946
947 Is_Named_Assoc : Boolean;
948 Num_Matched : Int := 0;
949 Num_Actuals : Int := 0;
950
951 Others_Present : Boolean := False;
952 Others_Choice : Node_Id := Empty;
953 -- In Ada 2005, indicates partial parametrization of a formal
954 -- package. As usual an other association must be last in the list.
955
956 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id);
957 -- Apply RM 12.3 (9): if a formal subprogram is overloaded, the instance
958 -- cannot have a named association for it. AI05-0025 extends this rule
959 -- to formals of formal packages by AI05-0025, and it also applies to
960 -- box-initialized formals.
961
962 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean;
963 -- Determine whether the parameter types and the return type of Subp
964 -- are fully defined at the point of instantiation.
965
966 function Matching_Actual
967 (F : Entity_Id;
968 A_F : Entity_Id) return Node_Id;
969 -- Find actual that corresponds to a given a formal parameter. If the
970 -- actuals are positional, return the next one, if any. If the actuals
971 -- are named, scan the parameter associations to find the right one.
972 -- A_F is the corresponding entity in the analyzed generic,which is
973 -- placed on the selector name for ASIS use.
974 --
975 -- In Ada 2005, a named association may be given with a box, in which
976 -- case Matching_Actual sets Found_Assoc to the generic association,
977 -- but return Empty for the actual itself. In this case the code below
978 -- creates a corresponding declaration for the formal.
979
980 function Partial_Parametrization return Boolean;
981 -- Ada 2005: if no match is found for a given formal, check if the
982 -- association for it includes a box, or whether the associations
983 -- include an Others clause.
984
985 procedure Process_Default (F : Entity_Id);
986 -- Add a copy of the declaration of generic formal F to the list of
987 -- associations, and add an explicit box association for F if there
988 -- is none yet, and the default comes from an Others_Choice.
989
990 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean;
991 -- Determine whether Subp renames one of the subprograms defined in the
992 -- generated package Standard.
993
994 procedure Set_Analyzed_Formal;
995 -- Find the node in the generic copy that corresponds to a given formal.
996 -- The semantic information on this node is used to perform legality
997 -- checks on the actuals. Because semantic analysis can introduce some
998 -- anonymous entities or modify the declaration node itself, the
999 -- correspondence between the two lists is not one-one. In addition to
1000 -- anonymous types, the presence a formal equality will introduce an
1001 -- implicit declaration for the corresponding inequality.
1002
1003 ----------------------------------------
1004 -- Check_Overloaded_Formal_Subprogram --
1005 ----------------------------------------
1006
1007 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id) is
1008 Temp_Formal : Entity_Id;
1009
1010 begin
1011 Temp_Formal := First (Formals);
1012 while Present (Temp_Formal) loop
1013 if Nkind (Temp_Formal) in N_Formal_Subprogram_Declaration
1014 and then Temp_Formal /= Formal
1015 and then
1016 Chars (Defining_Unit_Name (Specification (Formal))) =
1017 Chars (Defining_Unit_Name (Specification (Temp_Formal)))
1018 then
1019 if Present (Found_Assoc) then
1020 Error_Msg_N
1021 ("named association not allowed for overloaded formal",
1022 Found_Assoc);
1023
1024 else
1025 Error_Msg_N
1026 ("named association not allowed for overloaded formal",
1027 Others_Choice);
1028 end if;
1029
1030 Abandon_Instantiation (Instantiation_Node);
1031 end if;
1032
1033 Next (Temp_Formal);
1034 end loop;
1035 end Check_Overloaded_Formal_Subprogram;
1036
1037 -------------------------------
1038 -- Has_Fully_Defined_Profile --
1039 -------------------------------
1040
1041 function Has_Fully_Defined_Profile (Subp : Entity_Id) return Boolean is
1042 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean;
1043 -- Determine whethet type Typ is fully defined
1044
1045 ---------------------------
1046 -- Is_Fully_Defined_Type --
1047 ---------------------------
1048
1049 function Is_Fully_Defined_Type (Typ : Entity_Id) return Boolean is
1050 begin
1051 -- A private type without a full view is not fully defined
1052
1053 if Is_Private_Type (Typ)
1054 and then No (Full_View (Typ))
1055 then
1056 return False;
1057
1058 -- An incomplete type is never fully defined
1059
1060 elsif Is_Incomplete_Type (Typ) then
1061 return False;
1062
1063 -- All other types are fully defined
1064
1065 else
1066 return True;
1067 end if;
1068 end Is_Fully_Defined_Type;
1069
1070 -- Local declarations
1071
1072 Param : Entity_Id;
1073
1074 -- Start of processing for Has_Fully_Defined_Profile
1075
1076 begin
1077 -- Check the parameters
1078
1079 Param := First_Formal (Subp);
1080 while Present (Param) loop
1081 if not Is_Fully_Defined_Type (Etype (Param)) then
1082 return False;
1083 end if;
1084
1085 Next_Formal (Param);
1086 end loop;
1087
1088 -- Check the return type
1089
1090 return Is_Fully_Defined_Type (Etype (Subp));
1091 end Has_Fully_Defined_Profile;
1092
1093 ---------------------
1094 -- Matching_Actual --
1095 ---------------------
1096
1097 function Matching_Actual
1098 (F : Entity_Id;
1099 A_F : Entity_Id) return Node_Id
1100 is
1101 Prev : Node_Id;
1102 Act : Node_Id;
1103
1104 begin
1105 Is_Named_Assoc := False;
1106
1107 -- End of list of purely positional parameters
1108
1109 if No (Actual) or else Nkind (Actual) = N_Others_Choice then
1110 Found_Assoc := Empty;
1111 Act := Empty;
1112
1113 -- Case of positional parameter corresponding to current formal
1114
1115 elsif No (Selector_Name (Actual)) then
1116 Found_Assoc := Actual;
1117 Act := Explicit_Generic_Actual_Parameter (Actual);
1118 Num_Matched := Num_Matched + 1;
1119 Next (Actual);
1120
1121 -- Otherwise scan list of named actuals to find the one with the
1122 -- desired name. All remaining actuals have explicit names.
1123
1124 else
1125 Is_Named_Assoc := True;
1126 Found_Assoc := Empty;
1127 Act := Empty;
1128 Prev := Empty;
1129
1130 while Present (Actual) loop
1131 if Chars (Selector_Name (Actual)) = Chars (F) then
1132 Set_Entity (Selector_Name (Actual), A_F);
1133 Set_Etype (Selector_Name (Actual), Etype (A_F));
1134 Generate_Reference (A_F, Selector_Name (Actual));
1135 Found_Assoc := Actual;
1136 Act := Explicit_Generic_Actual_Parameter (Actual);
1137 Num_Matched := Num_Matched + 1;
1138 exit;
1139 end if;
1140
1141 Prev := Actual;
1142 Next (Actual);
1143 end loop;
1144
1145 -- Reset for subsequent searches. In most cases the named
1146 -- associations are in order. If they are not, we reorder them
1147 -- to avoid scanning twice the same actual. This is not just a
1148 -- question of efficiency: there may be multiple defaults with
1149 -- boxes that have the same name. In a nested instantiation we
1150 -- insert actuals for those defaults, and cannot rely on their
1151 -- names to disambiguate them.
1152
1153 if Actual = First_Named then
1154 Next (First_Named);
1155
1156 elsif Present (Actual) then
1157 Insert_Before (First_Named, Remove_Next (Prev));
1158 end if;
1159
1160 Actual := First_Named;
1161 end if;
1162
1163 if Is_Entity_Name (Act) and then Present (Entity (Act)) then
1164 Set_Used_As_Generic_Actual (Entity (Act));
1165 end if;
1166
1167 return Act;
1168 end Matching_Actual;
1169
1170 -----------------------------
1171 -- Partial_Parametrization --
1172 -----------------------------
1173
1174 function Partial_Parametrization return Boolean is
1175 begin
1176 return Others_Present
1177 or else (Present (Found_Assoc) and then Box_Present (Found_Assoc));
1178 end Partial_Parametrization;
1179
1180 ---------------------
1181 -- Process_Default --
1182 ---------------------
1183
1184 procedure Process_Default (F : Entity_Id) is
1185 Loc : constant Source_Ptr := Sloc (I_Node);
1186 F_Id : constant Entity_Id := Defining_Entity (F);
1187 Decl : Node_Id;
1188 Default : Node_Id;
1189 Id : Entity_Id;
1190
1191 begin
1192 -- Append copy of formal declaration to associations, and create new
1193 -- defining identifier for it.
1194
1195 Decl := New_Copy_Tree (F);
1196 Id := Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id));
1197
1198 if Nkind (F) in N_Formal_Subprogram_Declaration then
1199 Set_Defining_Unit_Name (Specification (Decl), Id);
1200
1201 else
1202 Set_Defining_Identifier (Decl, Id);
1203 end if;
1204
1205 Append (Decl, Assoc);
1206
1207 if No (Found_Assoc) then
1208 Default :=
1209 Make_Generic_Association (Loc,
1210 Selector_Name => New_Occurrence_Of (Id, Loc),
1211 Explicit_Generic_Actual_Parameter => Empty);
1212 Set_Box_Present (Default);
1213 Append (Default, Default_Formals);
1214 end if;
1215 end Process_Default;
1216
1217 ---------------------------------
1218 -- Renames_Standard_Subprogram --
1219 ---------------------------------
1220
1221 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean is
1222 Id : Entity_Id;
1223
1224 begin
1225 Id := Alias (Subp);
1226 while Present (Id) loop
1227 if Scope (Id) = Standard_Standard then
1228 return True;
1229 end if;
1230
1231 Id := Alias (Id);
1232 end loop;
1233
1234 return False;
1235 end Renames_Standard_Subprogram;
1236
1237 -------------------------
1238 -- Set_Analyzed_Formal --
1239 -------------------------
1240
1241 procedure Set_Analyzed_Formal is
1242 Kind : Node_Kind;
1243
1244 begin
1245 while Present (Analyzed_Formal) loop
1246 Kind := Nkind (Analyzed_Formal);
1247
1248 case Nkind (Formal) is
1249
1250 when N_Formal_Subprogram_Declaration =>
1251 exit when Kind in N_Formal_Subprogram_Declaration
1252 and then
1253 Chars
1254 (Defining_Unit_Name (Specification (Formal))) =
1255 Chars
1256 (Defining_Unit_Name (Specification (Analyzed_Formal)));
1257
1258 when N_Formal_Package_Declaration =>
1259 exit when Nkind_In (Kind, N_Formal_Package_Declaration,
1260 N_Generic_Package_Declaration,
1261 N_Package_Declaration);
1262
1263 when N_Use_Package_Clause | N_Use_Type_Clause => exit;
1264
1265 when others =>
1266
1267 -- Skip freeze nodes, and nodes inserted to replace
1268 -- unrecognized pragmas.
1269
1270 exit when
1271 Kind not in N_Formal_Subprogram_Declaration
1272 and then not Nkind_In (Kind, N_Subprogram_Declaration,
1273 N_Freeze_Entity,
1274 N_Null_Statement,
1275 N_Itype_Reference)
1276 and then Chars (Defining_Identifier (Formal)) =
1277 Chars (Defining_Identifier (Analyzed_Formal));
1278 end case;
1279
1280 Next (Analyzed_Formal);
1281 end loop;
1282 end Set_Analyzed_Formal;
1283
1284 -- Start of processing for Analyze_Associations
1285
1286 begin
1287 Actuals := Generic_Associations (I_Node);
1288
1289 if Present (Actuals) then
1290
1291 -- Check for an Others choice, indicating a partial parametrization
1292 -- for a formal package.
1293
1294 Actual := First (Actuals);
1295 while Present (Actual) loop
1296 if Nkind (Actual) = N_Others_Choice then
1297 Others_Present := True;
1298 Others_Choice := Actual;
1299
1300 if Present (Next (Actual)) then
1301 Error_Msg_N ("others must be last association", Actual);
1302 end if;
1303
1304 -- This subprogram is used both for formal packages and for
1305 -- instantiations. For the latter, associations must all be
1306 -- explicit.
1307
1308 if Nkind (I_Node) /= N_Formal_Package_Declaration
1309 and then Comes_From_Source (I_Node)
1310 then
1311 Error_Msg_N
1312 ("others association not allowed in an instance",
1313 Actual);
1314 end if;
1315
1316 -- In any case, nothing to do after the others association
1317
1318 exit;
1319
1320 elsif Box_Present (Actual)
1321 and then Comes_From_Source (I_Node)
1322 and then Nkind (I_Node) /= N_Formal_Package_Declaration
1323 then
1324 Error_Msg_N
1325 ("box association not allowed in an instance", Actual);
1326 end if;
1327
1328 Next (Actual);
1329 end loop;
1330
1331 -- If named associations are present, save first named association
1332 -- (it may of course be Empty) to facilitate subsequent name search.
1333
1334 First_Named := First (Actuals);
1335 while Present (First_Named)
1336 and then Nkind (First_Named) /= N_Others_Choice
1337 and then No (Selector_Name (First_Named))
1338 loop
1339 Num_Actuals := Num_Actuals + 1;
1340 Next (First_Named);
1341 end loop;
1342 end if;
1343
1344 Named := First_Named;
1345 while Present (Named) loop
1346 if Nkind (Named) /= N_Others_Choice
1347 and then No (Selector_Name (Named))
1348 then
1349 Error_Msg_N ("invalid positional actual after named one", Named);
1350 Abandon_Instantiation (Named);
1351 end if;
1352
1353 -- A named association may lack an actual parameter, if it was
1354 -- introduced for a default subprogram that turns out to be local
1355 -- to the outer instantiation.
1356
1357 if Nkind (Named) /= N_Others_Choice
1358 and then Present (Explicit_Generic_Actual_Parameter (Named))
1359 then
1360 Num_Actuals := Num_Actuals + 1;
1361 end if;
1362
1363 Next (Named);
1364 end loop;
1365
1366 if Present (Formals) then
1367 Formal := First_Non_Pragma (Formals);
1368 Analyzed_Formal := First_Non_Pragma (F_Copy);
1369
1370 if Present (Actuals) then
1371 Actual := First (Actuals);
1372
1373 -- All formals should have default values
1374
1375 else
1376 Actual := Empty;
1377 end if;
1378
1379 while Present (Formal) loop
1380 Set_Analyzed_Formal;
1381 Saved_Formal := Next_Non_Pragma (Formal);
1382
1383 case Nkind (Formal) is
1384 when N_Formal_Object_Declaration =>
1385 Match :=
1386 Matching_Actual (
1387 Defining_Identifier (Formal),
1388 Defining_Identifier (Analyzed_Formal));
1389
1390 if No (Match) and then Partial_Parametrization then
1391 Process_Default (Formal);
1392 else
1393 Append_List
1394 (Instantiate_Object (Formal, Match, Analyzed_Formal),
1395 Assoc);
1396 end if;
1397
1398 when N_Formal_Type_Declaration =>
1399 Match :=
1400 Matching_Actual (
1401 Defining_Identifier (Formal),
1402 Defining_Identifier (Analyzed_Formal));
1403
1404 if No (Match) then
1405 if Partial_Parametrization then
1406 Process_Default (Formal);
1407
1408 else
1409 Error_Msg_Sloc := Sloc (Gen_Unit);
1410 Error_Msg_NE
1411 ("missing actual&",
1412 Instantiation_Node,
1413 Defining_Identifier (Formal));
1414 Error_Msg_NE ("\in instantiation of & declared#",
1415 Instantiation_Node, Gen_Unit);
1416 Abandon_Instantiation (Instantiation_Node);
1417 end if;
1418
1419 else
1420 Analyze (Match);
1421 Append_List
1422 (Instantiate_Type
1423 (Formal, Match, Analyzed_Formal, Assoc),
1424 Assoc);
1425
1426 -- An instantiation is a freeze point for the actuals,
1427 -- unless this is a rewritten formal package, or the
1428 -- formal is an Ada 2012 formal incomplete type.
1429
1430 if Nkind (I_Node) = N_Formal_Package_Declaration
1431 or else
1432 (Ada_Version >= Ada_2012
1433 and then
1434 Ekind (Defining_Identifier (Analyzed_Formal)) =
1435 E_Incomplete_Type)
1436 then
1437 null;
1438
1439 else
1440 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1441 end if;
1442 end if;
1443
1444 -- A remote access-to-class-wide type is not a legal actual
1445 -- for a generic formal of an access type (E.2.2(17/2)).
1446 -- In GNAT an exception to this rule is introduced when
1447 -- the formal is marked as remote using implementation
1448 -- defined aspect/pragma Remote_Access_Type. In that case
1449 -- the actual must be remote as well.
1450
1451 -- If the current instantiation is the construction of a
1452 -- local copy for a formal package the actuals may be
1453 -- defaulted, and there is no matching actual to check.
1454
1455 if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1456 and then
1457 Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1458 N_Access_To_Object_Definition
1459 and then Present (Match)
1460 then
1461 declare
1462 Formal_Ent : constant Entity_Id :=
1463 Defining_Identifier (Analyzed_Formal);
1464 begin
1465 if Is_Remote_Access_To_Class_Wide_Type (Entity (Match))
1466 = Is_Remote_Types (Formal_Ent)
1467 then
1468 -- Remoteness of formal and actual match
1469
1470 null;
1471
1472 elsif Is_Remote_Types (Formal_Ent) then
1473
1474 -- Remote formal, non-remote actual
1475
1476 Error_Msg_NE
1477 ("actual for& must be remote", Match, Formal_Ent);
1478
1479 else
1480 -- Non-remote formal, remote actual
1481
1482 Error_Msg_NE
1483 ("actual for& may not be remote",
1484 Match, Formal_Ent);
1485 end if;
1486 end;
1487 end if;
1488
1489 when N_Formal_Subprogram_Declaration =>
1490 Match :=
1491 Matching_Actual
1492 (Defining_Unit_Name (Specification (Formal)),
1493 Defining_Unit_Name (Specification (Analyzed_Formal)));
1494
1495 -- If the formal subprogram has the same name as another
1496 -- formal subprogram of the generic, then a named
1497 -- association is illegal (12.3(9)). Exclude named
1498 -- associations that are generated for a nested instance.
1499
1500 if Present (Match)
1501 and then Is_Named_Assoc
1502 and then Comes_From_Source (Found_Assoc)
1503 then
1504 Check_Overloaded_Formal_Subprogram (Formal);
1505 end if;
1506
1507 -- If there is no corresponding actual, this may be case of
1508 -- partial parametrization, or else the formal has a default
1509 -- or a box.
1510
1511 if No (Match) and then Partial_Parametrization then
1512 Process_Default (Formal);
1513
1514 if Nkind (I_Node) = N_Formal_Package_Declaration then
1515 Check_Overloaded_Formal_Subprogram (Formal);
1516 end if;
1517
1518 else
1519 Append_To (Assoc,
1520 Instantiate_Formal_Subprogram
1521 (Formal, Match, Analyzed_Formal));
1522
1523 -- An instantiation is a freeze point for the actuals,
1524 -- unless this is a rewritten formal package.
1525
1526 if Nkind (I_Node) /= N_Formal_Package_Declaration
1527 and then Nkind (Match) = N_Identifier
1528 and then Is_Subprogram (Entity (Match))
1529
1530 -- The actual subprogram may rename a routine defined
1531 -- in Standard. Avoid freezing such renamings because
1532 -- subprograms coming from Standard cannot be frozen.
1533
1534 and then
1535 not Renames_Standard_Subprogram (Entity (Match))
1536
1537 -- If the actual subprogram comes from a different
1538 -- unit, it is already frozen, either by a body in
1539 -- that unit or by the end of the declarative part
1540 -- of the unit. This check avoids the freezing of
1541 -- subprograms defined in Standard which are used
1542 -- as generic actuals.
1543
1544 and then In_Same_Code_Unit (Entity (Match), I_Node)
1545 and then Has_Fully_Defined_Profile (Entity (Match))
1546 then
1547 -- Mark the subprogram as having a delayed freeze
1548 -- since this may be an out-of-order action.
1549
1550 Set_Has_Delayed_Freeze (Entity (Match));
1551 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1552 end if;
1553 end if;
1554
1555 -- If this is a nested generic, preserve default for later
1556 -- instantiations.
1557
1558 if No (Match)
1559 and then Box_Present (Formal)
1560 then
1561 Append_Elmt
1562 (Defining_Unit_Name (Specification (Last (Assoc))),
1563 Default_Actuals);
1564 end if;
1565
1566 when N_Formal_Package_Declaration =>
1567 Match :=
1568 Matching_Actual (
1569 Defining_Identifier (Formal),
1570 Defining_Identifier (Original_Node (Analyzed_Formal)));
1571
1572 if No (Match) then
1573 if Partial_Parametrization then
1574 Process_Default (Formal);
1575
1576 else
1577 Error_Msg_Sloc := Sloc (Gen_Unit);
1578 Error_Msg_NE
1579 ("missing actual&",
1580 Instantiation_Node, Defining_Identifier (Formal));
1581 Error_Msg_NE ("\in instantiation of & declared#",
1582 Instantiation_Node, Gen_Unit);
1583
1584 Abandon_Instantiation (Instantiation_Node);
1585 end if;
1586
1587 else
1588 Analyze (Match);
1589 Append_List
1590 (Instantiate_Formal_Package
1591 (Formal, Match, Analyzed_Formal),
1592 Assoc);
1593 end if;
1594
1595 -- For use type and use package appearing in the generic part,
1596 -- we have already copied them, so we can just move them where
1597 -- they belong (we mustn't recopy them since this would mess up
1598 -- the Sloc values).
1599
1600 when N_Use_Package_Clause |
1601 N_Use_Type_Clause =>
1602 if Nkind (Original_Node (I_Node)) =
1603 N_Formal_Package_Declaration
1604 then
1605 Append (New_Copy_Tree (Formal), Assoc);
1606 else
1607 Remove (Formal);
1608 Append (Formal, Assoc);
1609 end if;
1610
1611 when others =>
1612 raise Program_Error;
1613
1614 end case;
1615
1616 Formal := Saved_Formal;
1617 Next_Non_Pragma (Analyzed_Formal);
1618 end loop;
1619
1620 if Num_Actuals > Num_Matched then
1621 Error_Msg_Sloc := Sloc (Gen_Unit);
1622
1623 if Present (Selector_Name (Actual)) then
1624 Error_Msg_NE
1625 ("unmatched actual&",
1626 Actual, Selector_Name (Actual));
1627 Error_Msg_NE ("\in instantiation of& declared#",
1628 Actual, Gen_Unit);
1629 else
1630 Error_Msg_NE
1631 ("unmatched actual in instantiation of& declared#",
1632 Actual, Gen_Unit);
1633 end if;
1634 end if;
1635
1636 elsif Present (Actuals) then
1637 Error_Msg_N
1638 ("too many actuals in generic instantiation", Instantiation_Node);
1639 end if;
1640
1641 -- An instantiation freezes all generic actuals. The only exceptions
1642 -- to this are incomplete types and subprograms which are not fully
1643 -- defined at the point of instantiation.
1644
1645 declare
1646 Elmt : Elmt_Id := First_Elmt (Actuals_To_Freeze);
1647 begin
1648 while Present (Elmt) loop
1649 Freeze_Before (I_Node, Node (Elmt));
1650 Next_Elmt (Elmt);
1651 end loop;
1652 end;
1653
1654 -- If there are default subprograms, normalize the tree by adding
1655 -- explicit associations for them. This is required if the instance
1656 -- appears within a generic.
1657
1658 declare
1659 Elmt : Elmt_Id;
1660 Subp : Entity_Id;
1661 New_D : Node_Id;
1662
1663 begin
1664 Elmt := First_Elmt (Default_Actuals);
1665 while Present (Elmt) loop
1666 if No (Actuals) then
1667 Actuals := New_List;
1668 Set_Generic_Associations (I_Node, Actuals);
1669 end if;
1670
1671 Subp := Node (Elmt);
1672 New_D :=
1673 Make_Generic_Association (Sloc (Subp),
1674 Selector_Name => New_Occurrence_Of (Subp, Sloc (Subp)),
1675 Explicit_Generic_Actual_Parameter =>
1676 New_Occurrence_Of (Subp, Sloc (Subp)));
1677 Mark_Rewrite_Insertion (New_D);
1678 Append_To (Actuals, New_D);
1679 Next_Elmt (Elmt);
1680 end loop;
1681 end;
1682
1683 -- If this is a formal package, normalize the parameter list by adding
1684 -- explicit box associations for the formals that are covered by an
1685 -- Others_Choice.
1686
1687 if not Is_Empty_List (Default_Formals) then
1688 Append_List (Default_Formals, Formals);
1689 end if;
1690
1691 return Assoc;
1692 end Analyze_Associations;
1693
1694 -------------------------------
1695 -- Analyze_Formal_Array_Type --
1696 -------------------------------
1697
1698 procedure Analyze_Formal_Array_Type
1699 (T : in out Entity_Id;
1700 Def : Node_Id)
1701 is
1702 DSS : Node_Id;
1703
1704 begin
1705 -- Treated like a non-generic array declaration, with additional
1706 -- semantic checks.
1707
1708 Enter_Name (T);
1709
1710 if Nkind (Def) = N_Constrained_Array_Definition then
1711 DSS := First (Discrete_Subtype_Definitions (Def));
1712 while Present (DSS) loop
1713 if Nkind_In (DSS, N_Subtype_Indication,
1714 N_Range,
1715 N_Attribute_Reference)
1716 then
1717 Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
1718 end if;
1719
1720 Next (DSS);
1721 end loop;
1722 end if;
1723
1724 Array_Type_Declaration (T, Def);
1725 Set_Is_Generic_Type (Base_Type (T));
1726
1727 if Ekind (Component_Type (T)) = E_Incomplete_Type
1728 and then No (Full_View (Component_Type (T)))
1729 then
1730 Error_Msg_N ("premature usage of incomplete type", Def);
1731
1732 -- Check that range constraint is not allowed on the component type
1733 -- of a generic formal array type (AARM 12.5.3(3))
1734
1735 elsif Is_Internal (Component_Type (T))
1736 and then Present (Subtype_Indication (Component_Definition (Def)))
1737 and then Nkind (Original_Node
1738 (Subtype_Indication (Component_Definition (Def)))) =
1739 N_Subtype_Indication
1740 then
1741 Error_Msg_N
1742 ("in a formal, a subtype indication can only be "
1743 & "a subtype mark (RM 12.5.3(3))",
1744 Subtype_Indication (Component_Definition (Def)));
1745 end if;
1746
1747 end Analyze_Formal_Array_Type;
1748
1749 ---------------------------------------------
1750 -- Analyze_Formal_Decimal_Fixed_Point_Type --
1751 ---------------------------------------------
1752
1753 -- As for other generic types, we create a valid type representation with
1754 -- legal but arbitrary attributes, whose values are never considered
1755 -- static. For all scalar types we introduce an anonymous base type, with
1756 -- the same attributes. We choose the corresponding integer type to be
1757 -- Standard_Integer.
1758 -- Here and in other similar routines, the Sloc of the generated internal
1759 -- type must be the same as the sloc of the defining identifier of the
1760 -- formal type declaration, to provide proper source navigation.
1761
1762 procedure Analyze_Formal_Decimal_Fixed_Point_Type
1763 (T : Entity_Id;
1764 Def : Node_Id)
1765 is
1766 Loc : constant Source_Ptr := Sloc (Def);
1767
1768 Base : constant Entity_Id :=
1769 New_Internal_Entity
1770 (E_Decimal_Fixed_Point_Type,
1771 Current_Scope,
1772 Sloc (Defining_Identifier (Parent (Def))), 'G');
1773
1774 Int_Base : constant Entity_Id := Standard_Integer;
1775 Delta_Val : constant Ureal := Ureal_1;
1776 Digs_Val : constant Uint := Uint_6;
1777
1778 begin
1779 Enter_Name (T);
1780
1781 Set_Etype (Base, Base);
1782 Set_Size_Info (Base, Int_Base);
1783 Set_RM_Size (Base, RM_Size (Int_Base));
1784 Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
1785 Set_Digits_Value (Base, Digs_Val);
1786 Set_Delta_Value (Base, Delta_Val);
1787 Set_Small_Value (Base, Delta_Val);
1788 Set_Scalar_Range (Base,
1789 Make_Range (Loc,
1790 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
1791 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
1792
1793 Set_Is_Generic_Type (Base);
1794 Set_Parent (Base, Parent (Def));
1795
1796 Set_Ekind (T, E_Decimal_Fixed_Point_Subtype);
1797 Set_Etype (T, Base);
1798 Set_Size_Info (T, Int_Base);
1799 Set_RM_Size (T, RM_Size (Int_Base));
1800 Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
1801 Set_Digits_Value (T, Digs_Val);
1802 Set_Delta_Value (T, Delta_Val);
1803 Set_Small_Value (T, Delta_Val);
1804 Set_Scalar_Range (T, Scalar_Range (Base));
1805 Set_Is_Constrained (T);
1806
1807 Check_Restriction (No_Fixed_Point, Def);
1808 end Analyze_Formal_Decimal_Fixed_Point_Type;
1809
1810 -------------------------------------------
1811 -- Analyze_Formal_Derived_Interface_Type --
1812 -------------------------------------------
1813
1814 procedure Analyze_Formal_Derived_Interface_Type
1815 (N : Node_Id;
1816 T : Entity_Id;
1817 Def : Node_Id)
1818 is
1819 Loc : constant Source_Ptr := Sloc (Def);
1820
1821 begin
1822 -- Rewrite as a type declaration of a derived type. This ensures that
1823 -- the interface list and primitive operations are properly captured.
1824
1825 Rewrite (N,
1826 Make_Full_Type_Declaration (Loc,
1827 Defining_Identifier => T,
1828 Type_Definition => Def));
1829 Analyze (N);
1830 Set_Is_Generic_Type (T);
1831 end Analyze_Formal_Derived_Interface_Type;
1832
1833 ---------------------------------
1834 -- Analyze_Formal_Derived_Type --
1835 ---------------------------------
1836
1837 procedure Analyze_Formal_Derived_Type
1838 (N : Node_Id;
1839 T : Entity_Id;
1840 Def : Node_Id)
1841 is
1842 Loc : constant Source_Ptr := Sloc (Def);
1843 Unk_Disc : constant Boolean := Unknown_Discriminants_Present (N);
1844 New_N : Node_Id;
1845
1846 begin
1847 Set_Is_Generic_Type (T);
1848
1849 if Private_Present (Def) then
1850 New_N :=
1851 Make_Private_Extension_Declaration (Loc,
1852 Defining_Identifier => T,
1853 Discriminant_Specifications => Discriminant_Specifications (N),
1854 Unknown_Discriminants_Present => Unk_Disc,
1855 Subtype_Indication => Subtype_Mark (Def),
1856 Interface_List => Interface_List (Def));
1857
1858 Set_Abstract_Present (New_N, Abstract_Present (Def));
1859 Set_Limited_Present (New_N, Limited_Present (Def));
1860 Set_Synchronized_Present (New_N, Synchronized_Present (Def));
1861
1862 else
1863 New_N :=
1864 Make_Full_Type_Declaration (Loc,
1865 Defining_Identifier => T,
1866 Discriminant_Specifications =>
1867 Discriminant_Specifications (Parent (T)),
1868 Type_Definition =>
1869 Make_Derived_Type_Definition (Loc,
1870 Subtype_Indication => Subtype_Mark (Def)));
1871
1872 Set_Abstract_Present
1873 (Type_Definition (New_N), Abstract_Present (Def));
1874 Set_Limited_Present
1875 (Type_Definition (New_N), Limited_Present (Def));
1876 end if;
1877
1878 Rewrite (N, New_N);
1879 Analyze (N);
1880
1881 if Unk_Disc then
1882 if not Is_Composite_Type (T) then
1883 Error_Msg_N
1884 ("unknown discriminants not allowed for elementary types", N);
1885 else
1886 Set_Has_Unknown_Discriminants (T);
1887 Set_Is_Constrained (T, False);
1888 end if;
1889 end if;
1890
1891 -- If the parent type has a known size, so does the formal, which makes
1892 -- legal representation clauses that involve the formal.
1893
1894 Set_Size_Known_At_Compile_Time
1895 (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
1896 end Analyze_Formal_Derived_Type;
1897
1898 ----------------------------------
1899 -- Analyze_Formal_Discrete_Type --
1900 ----------------------------------
1901
1902 -- The operations defined for a discrete types are those of an enumeration
1903 -- type. The size is set to an arbitrary value, for use in analyzing the
1904 -- generic unit.
1905
1906 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
1907 Loc : constant Source_Ptr := Sloc (Def);
1908 Lo : Node_Id;
1909 Hi : Node_Id;
1910
1911 Base : constant Entity_Id :=
1912 New_Internal_Entity
1913 (E_Floating_Point_Type, Current_Scope,
1914 Sloc (Defining_Identifier (Parent (Def))), 'G');
1915
1916 begin
1917 Enter_Name (T);
1918 Set_Ekind (T, E_Enumeration_Subtype);
1919 Set_Etype (T, Base);
1920 Init_Size (T, 8);
1921 Init_Alignment (T);
1922 Set_Is_Generic_Type (T);
1923 Set_Is_Constrained (T);
1924
1925 -- For semantic analysis, the bounds of the type must be set to some
1926 -- non-static value. The simplest is to create attribute nodes for those
1927 -- bounds, that refer to the type itself. These bounds are never
1928 -- analyzed but serve as place-holders.
1929
1930 Lo :=
1931 Make_Attribute_Reference (Loc,
1932 Attribute_Name => Name_First,
1933 Prefix => New_Reference_To (T, Loc));
1934 Set_Etype (Lo, T);
1935
1936 Hi :=
1937 Make_Attribute_Reference (Loc,
1938 Attribute_Name => Name_Last,
1939 Prefix => New_Reference_To (T, Loc));
1940 Set_Etype (Hi, T);
1941
1942 Set_Scalar_Range (T,
1943 Make_Range (Loc,
1944 Low_Bound => Lo,
1945 High_Bound => Hi));
1946
1947 Set_Ekind (Base, E_Enumeration_Type);
1948 Set_Etype (Base, Base);
1949 Init_Size (Base, 8);
1950 Init_Alignment (Base);
1951 Set_Is_Generic_Type (Base);
1952 Set_Scalar_Range (Base, Scalar_Range (T));
1953 Set_Parent (Base, Parent (Def));
1954 end Analyze_Formal_Discrete_Type;
1955
1956 ----------------------------------
1957 -- Analyze_Formal_Floating_Type --
1958 ---------------------------------
1959
1960 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
1961 Base : constant Entity_Id :=
1962 New_Internal_Entity
1963 (E_Floating_Point_Type, Current_Scope,
1964 Sloc (Defining_Identifier (Parent (Def))), 'G');
1965
1966 begin
1967 -- The various semantic attributes are taken from the predefined type
1968 -- Float, just so that all of them are initialized. Their values are
1969 -- never used because no constant folding or expansion takes place in
1970 -- the generic itself.
1971
1972 Enter_Name (T);
1973 Set_Ekind (T, E_Floating_Point_Subtype);
1974 Set_Etype (T, Base);
1975 Set_Size_Info (T, (Standard_Float));
1976 Set_RM_Size (T, RM_Size (Standard_Float));
1977 Set_Digits_Value (T, Digits_Value (Standard_Float));
1978 Set_Scalar_Range (T, Scalar_Range (Standard_Float));
1979 Set_Is_Constrained (T);
1980
1981 Set_Is_Generic_Type (Base);
1982 Set_Etype (Base, Base);
1983 Set_Size_Info (Base, (Standard_Float));
1984 Set_RM_Size (Base, RM_Size (Standard_Float));
1985 Set_Digits_Value (Base, Digits_Value (Standard_Float));
1986 Set_Scalar_Range (Base, Scalar_Range (Standard_Float));
1987 Set_Parent (Base, Parent (Def));
1988
1989 Check_Restriction (No_Floating_Point, Def);
1990 end Analyze_Formal_Floating_Type;
1991
1992 -----------------------------------
1993 -- Analyze_Formal_Interface_Type;--
1994 -----------------------------------
1995
1996 procedure Analyze_Formal_Interface_Type
1997 (N : Node_Id;
1998 T : Entity_Id;
1999 Def : Node_Id)
2000 is
2001 Loc : constant Source_Ptr := Sloc (N);
2002 New_N : Node_Id;
2003
2004 begin
2005 New_N :=
2006 Make_Full_Type_Declaration (Loc,
2007 Defining_Identifier => T,
2008 Type_Definition => Def);
2009
2010 Rewrite (N, New_N);
2011 Analyze (N);
2012 Set_Is_Generic_Type (T);
2013 end Analyze_Formal_Interface_Type;
2014
2015 ---------------------------------
2016 -- Analyze_Formal_Modular_Type --
2017 ---------------------------------
2018
2019 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
2020 begin
2021 -- Apart from their entity kind, generic modular types are treated like
2022 -- signed integer types, and have the same attributes.
2023
2024 Analyze_Formal_Signed_Integer_Type (T, Def);
2025 Set_Ekind (T, E_Modular_Integer_Subtype);
2026 Set_Ekind (Etype (T), E_Modular_Integer_Type);
2027
2028 end Analyze_Formal_Modular_Type;
2029
2030 ---------------------------------------
2031 -- Analyze_Formal_Object_Declaration --
2032 ---------------------------------------
2033
2034 procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
2035 E : constant Node_Id := Default_Expression (N);
2036 Id : constant Node_Id := Defining_Identifier (N);
2037 K : Entity_Kind;
2038 T : Node_Id;
2039
2040 begin
2041 Enter_Name (Id);
2042
2043 -- Determine the mode of the formal object
2044
2045 if Out_Present (N) then
2046 K := E_Generic_In_Out_Parameter;
2047
2048 if not In_Present (N) then
2049 Error_Msg_N ("formal generic objects cannot have mode OUT", N);
2050 end if;
2051
2052 else
2053 K := E_Generic_In_Parameter;
2054 end if;
2055
2056 if Present (Subtype_Mark (N)) then
2057 Find_Type (Subtype_Mark (N));
2058 T := Entity (Subtype_Mark (N));
2059
2060 -- Verify that there is no redundant null exclusion
2061
2062 if Null_Exclusion_Present (N) then
2063 if not Is_Access_Type (T) then
2064 Error_Msg_N
2065 ("null exclusion can only apply to an access type", N);
2066
2067 elsif Can_Never_Be_Null (T) then
2068 Error_Msg_NE
2069 ("`NOT NULL` not allowed (& already excludes null)",
2070 N, T);
2071 end if;
2072 end if;
2073
2074 -- Ada 2005 (AI-423): Formal object with an access definition
2075
2076 else
2077 Check_Access_Definition (N);
2078 T := Access_Definition
2079 (Related_Nod => N,
2080 N => Access_Definition (N));
2081 end if;
2082
2083 if Ekind (T) = E_Incomplete_Type then
2084 declare
2085 Error_Node : Node_Id;
2086
2087 begin
2088 if Present (Subtype_Mark (N)) then
2089 Error_Node := Subtype_Mark (N);
2090 else
2091 Check_Access_Definition (N);
2092 Error_Node := Access_Definition (N);
2093 end if;
2094
2095 Error_Msg_N ("premature usage of incomplete type", Error_Node);
2096 end;
2097 end if;
2098
2099 if K = E_Generic_In_Parameter then
2100
2101 -- Ada 2005 (AI-287): Limited aggregates allowed in generic formals
2102
2103 if Ada_Version < Ada_2005 and then Is_Limited_Type (T) then
2104 Error_Msg_N
2105 ("generic formal of mode IN must not be of limited type", N);
2106 Explain_Limited_Type (T, N);
2107 end if;
2108
2109 if Is_Abstract_Type (T) then
2110 Error_Msg_N
2111 ("generic formal of mode IN must not be of abstract type", N);
2112 end if;
2113
2114 if Present (E) then
2115 Preanalyze_Spec_Expression (E, T);
2116
2117 if Is_Limited_Type (T) and then not OK_For_Limited_Init (T, E) then
2118 Error_Msg_N
2119 ("initialization not allowed for limited types", E);
2120 Explain_Limited_Type (T, E);
2121 end if;
2122 end if;
2123
2124 Set_Ekind (Id, K);
2125 Set_Etype (Id, T);
2126
2127 -- Case of generic IN OUT parameter
2128
2129 else
2130 -- If the formal has an unconstrained type, construct its actual
2131 -- subtype, as is done for subprogram formals. In this fashion, all
2132 -- its uses can refer to specific bounds.
2133
2134 Set_Ekind (Id, K);
2135 Set_Etype (Id, T);
2136
2137 if (Is_Array_Type (T)
2138 and then not Is_Constrained (T))
2139 or else
2140 (Ekind (T) = E_Record_Type
2141 and then Has_Discriminants (T))
2142 then
2143 declare
2144 Non_Freezing_Ref : constant Node_Id :=
2145 New_Reference_To (Id, Sloc (Id));
2146 Decl : Node_Id;
2147
2148 begin
2149 -- Make sure the actual subtype doesn't generate bogus freezing
2150
2151 Set_Must_Not_Freeze (Non_Freezing_Ref);
2152 Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
2153 Insert_Before_And_Analyze (N, Decl);
2154 Set_Actual_Subtype (Id, Defining_Identifier (Decl));
2155 end;
2156 else
2157 Set_Actual_Subtype (Id, T);
2158 end if;
2159
2160 if Present (E) then
2161 Error_Msg_N
2162 ("initialization not allowed for `IN OUT` formals", N);
2163 end if;
2164 end if;
2165
2166 if Has_Aspects (N) then
2167 Analyze_Aspect_Specifications (N, Id);
2168 end if;
2169 end Analyze_Formal_Object_Declaration;
2170
2171 ----------------------------------------------
2172 -- Analyze_Formal_Ordinary_Fixed_Point_Type --
2173 ----------------------------------------------
2174
2175 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
2176 (T : Entity_Id;
2177 Def : Node_Id)
2178 is
2179 Loc : constant Source_Ptr := Sloc (Def);
2180 Base : constant Entity_Id :=
2181 New_Internal_Entity
2182 (E_Ordinary_Fixed_Point_Type, Current_Scope,
2183 Sloc (Defining_Identifier (Parent (Def))), 'G');
2184
2185 begin
2186 -- The semantic attributes are set for completeness only, their values
2187 -- will never be used, since all properties of the type are non-static.
2188
2189 Enter_Name (T);
2190 Set_Ekind (T, E_Ordinary_Fixed_Point_Subtype);
2191 Set_Etype (T, Base);
2192 Set_Size_Info (T, Standard_Integer);
2193 Set_RM_Size (T, RM_Size (Standard_Integer));
2194 Set_Small_Value (T, Ureal_1);
2195 Set_Delta_Value (T, Ureal_1);
2196 Set_Scalar_Range (T,
2197 Make_Range (Loc,
2198 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
2199 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
2200 Set_Is_Constrained (T);
2201
2202 Set_Is_Generic_Type (Base);
2203 Set_Etype (Base, Base);
2204 Set_Size_Info (Base, Standard_Integer);
2205 Set_RM_Size (Base, RM_Size (Standard_Integer));
2206 Set_Small_Value (Base, Ureal_1);
2207 Set_Delta_Value (Base, Ureal_1);
2208 Set_Scalar_Range (Base, Scalar_Range (T));
2209 Set_Parent (Base, Parent (Def));
2210
2211 Check_Restriction (No_Fixed_Point, Def);
2212 end Analyze_Formal_Ordinary_Fixed_Point_Type;
2213
2214 ----------------------------------------
2215 -- Analyze_Formal_Package_Declaration --
2216 ----------------------------------------
2217
2218 procedure Analyze_Formal_Package_Declaration (N : Node_Id) is
2219 Loc : constant Source_Ptr := Sloc (N);
2220 Pack_Id : constant Entity_Id := Defining_Identifier (N);
2221 Formal : Entity_Id;
2222 Gen_Id : constant Node_Id := Name (N);
2223 Gen_Decl : Node_Id;
2224 Gen_Unit : Entity_Id;
2225 New_N : Node_Id;
2226 Parent_Installed : Boolean := False;
2227 Renaming : Node_Id;
2228 Parent_Instance : Entity_Id;
2229 Renaming_In_Par : Entity_Id;
2230 Associations : Boolean := True;
2231
2232 Vis_Prims_List : Elist_Id := No_Elist;
2233 -- List of primitives made temporarily visible in the instantiation
2234 -- to match the visibility of the formal type
2235
2236 function Build_Local_Package return Node_Id;
2237 -- The formal package is rewritten so that its parameters are replaced
2238 -- with corresponding declarations. For parameters with bona fide
2239 -- associations these declarations are created by Analyze_Associations
2240 -- as for a regular instantiation. For boxed parameters, we preserve
2241 -- the formal declarations and analyze them, in order to introduce
2242 -- entities of the right kind in the environment of the formal.
2243
2244 -------------------------
2245 -- Build_Local_Package --
2246 -------------------------
2247
2248 function Build_Local_Package return Node_Id is
2249 Decls : List_Id;
2250 Pack_Decl : Node_Id;
2251
2252 begin
2253 -- Within the formal, the name of the generic package is a renaming
2254 -- of the formal (as for a regular instantiation).
2255
2256 Pack_Decl :=
2257 Make_Package_Declaration (Loc,
2258 Specification =>
2259 Copy_Generic_Node
2260 (Specification (Original_Node (Gen_Decl)),
2261 Empty, Instantiating => True));
2262
2263 Renaming := Make_Package_Renaming_Declaration (Loc,
2264 Defining_Unit_Name =>
2265 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2266 Name => New_Occurrence_Of (Formal, Loc));
2267
2268 if Nkind (Gen_Id) = N_Identifier
2269 and then Chars (Gen_Id) = Chars (Pack_Id)
2270 then
2271 Error_Msg_NE
2272 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2273 end if;
2274
2275 -- If the formal is declared with a box, or with an others choice,
2276 -- create corresponding declarations for all entities in the formal
2277 -- part, so that names with the proper types are available in the
2278 -- specification of the formal package.
2279
2280 -- On the other hand, if there are no associations, then all the
2281 -- formals must have defaults, and this will be checked by the
2282 -- call to Analyze_Associations.
2283
2284 if Box_Present (N)
2285 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2286 then
2287 declare
2288 Formal_Decl : Node_Id;
2289
2290 begin
2291 -- TBA : for a formal package, need to recurse ???
2292
2293 Decls := New_List;
2294 Formal_Decl :=
2295 First
2296 (Generic_Formal_Declarations (Original_Node (Gen_Decl)));
2297 while Present (Formal_Decl) loop
2298 Append_To
2299 (Decls, Copy_Generic_Node (Formal_Decl, Empty, True));
2300 Next (Formal_Decl);
2301 end loop;
2302 end;
2303
2304 -- If generic associations are present, use Analyze_Associations to
2305 -- create the proper renaming declarations.
2306
2307 else
2308 declare
2309 Act_Tree : constant Node_Id :=
2310 Copy_Generic_Node
2311 (Original_Node (Gen_Decl), Empty,
2312 Instantiating => True);
2313
2314 begin
2315 Generic_Renamings.Set_Last (0);
2316 Generic_Renamings_HTable.Reset;
2317 Instantiation_Node := N;
2318
2319 Decls :=
2320 Analyze_Associations
2321 (I_Node => Original_Node (N),
2322 Formals => Generic_Formal_Declarations (Act_Tree),
2323 F_Copy => Generic_Formal_Declarations (Gen_Decl));
2324
2325 Vis_Prims_List := Check_Hidden_Primitives (Decls);
2326 end;
2327 end if;
2328
2329 Append (Renaming, To => Decls);
2330
2331 -- Add generated declarations ahead of local declarations in
2332 -- the package.
2333
2334 if No (Visible_Declarations (Specification (Pack_Decl))) then
2335 Set_Visible_Declarations (Specification (Pack_Decl), Decls);
2336 else
2337 Insert_List_Before
2338 (First (Visible_Declarations (Specification (Pack_Decl))),
2339 Decls);
2340 end if;
2341
2342 return Pack_Decl;
2343 end Build_Local_Package;
2344
2345 -- Start of processing for Analyze_Formal_Package_Declaration
2346
2347 begin
2348 Text_IO_Kludge (Gen_Id);
2349
2350 Init_Env;
2351 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2352 Gen_Unit := Entity (Gen_Id);
2353
2354 -- Check for a formal package that is a package renaming
2355
2356 if Present (Renamed_Object (Gen_Unit)) then
2357
2358 -- Indicate that unit is used, before replacing it with renamed
2359 -- entity for use below.
2360
2361 if In_Extended_Main_Source_Unit (N) then
2362 Set_Is_Instantiated (Gen_Unit);
2363 Generate_Reference (Gen_Unit, N);
2364 end if;
2365
2366 Gen_Unit := Renamed_Object (Gen_Unit);
2367 end if;
2368
2369 if Ekind (Gen_Unit) /= E_Generic_Package then
2370 Error_Msg_N ("expect generic package name", Gen_Id);
2371 Restore_Env;
2372 goto Leave;
2373
2374 elsif Gen_Unit = Current_Scope then
2375 Error_Msg_N
2376 ("generic package cannot be used as a formal package of itself",
2377 Gen_Id);
2378 Restore_Env;
2379 goto Leave;
2380
2381 elsif In_Open_Scopes (Gen_Unit) then
2382 if Is_Compilation_Unit (Gen_Unit)
2383 and then Is_Child_Unit (Current_Scope)
2384 then
2385 -- Special-case the error when the formal is a parent, and
2386 -- continue analysis to minimize cascaded errors.
2387
2388 Error_Msg_N
2389 ("generic parent cannot be used as formal package "
2390 & "of a child unit",
2391 Gen_Id);
2392
2393 else
2394 Error_Msg_N
2395 ("generic package cannot be used as a formal package "
2396 & "within itself",
2397 Gen_Id);
2398 Restore_Env;
2399 goto Leave;
2400 end if;
2401 end if;
2402
2403 -- Check that name of formal package does not hide name of generic,
2404 -- or its leading prefix. This check must be done separately because
2405 -- the name of the generic has already been analyzed.
2406
2407 declare
2408 Gen_Name : Entity_Id;
2409
2410 begin
2411 Gen_Name := Gen_Id;
2412 while Nkind (Gen_Name) = N_Expanded_Name loop
2413 Gen_Name := Prefix (Gen_Name);
2414 end loop;
2415
2416 if Chars (Gen_Name) = Chars (Pack_Id) then
2417 Error_Msg_NE
2418 ("& is hidden within declaration of formal package",
2419 Gen_Id, Gen_Name);
2420 end if;
2421 end;
2422
2423 if Box_Present (N)
2424 or else No (Generic_Associations (N))
2425 or else Nkind (First (Generic_Associations (N))) = N_Others_Choice
2426 then
2427 Associations := False;
2428 end if;
2429
2430 -- If there are no generic associations, the generic parameters appear
2431 -- as local entities and are instantiated like them. We copy the generic
2432 -- package declaration as if it were an instantiation, and analyze it
2433 -- like a regular package, except that we treat the formals as
2434 -- additional visible components.
2435
2436 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2437
2438 if In_Extended_Main_Source_Unit (N) then
2439 Set_Is_Instantiated (Gen_Unit);
2440 Generate_Reference (Gen_Unit, N);
2441 end if;
2442
2443 Formal := New_Copy (Pack_Id);
2444 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2445
2446 begin
2447 -- Make local generic without formals. The formals will be replaced
2448 -- with internal declarations.
2449
2450 New_N := Build_Local_Package;
2451
2452 -- If there are errors in the parameter list, Analyze_Associations
2453 -- raises Instantiation_Error. Patch the declaration to prevent
2454 -- further exception propagation.
2455
2456 exception
2457 when Instantiation_Error =>
2458
2459 Enter_Name (Formal);
2460 Set_Ekind (Formal, E_Variable);
2461 Set_Etype (Formal, Any_Type);
2462 Restore_Hidden_Primitives (Vis_Prims_List);
2463
2464 if Parent_Installed then
2465 Remove_Parent;
2466 end if;
2467
2468 goto Leave;
2469 end;
2470
2471 Rewrite (N, New_N);
2472 Set_Defining_Unit_Name (Specification (New_N), Formal);
2473 Set_Generic_Parent (Specification (N), Gen_Unit);
2474 Set_Instance_Env (Gen_Unit, Formal);
2475 Set_Is_Generic_Instance (Formal);
2476
2477 Enter_Name (Formal);
2478 Set_Ekind (Formal, E_Package);
2479 Set_Etype (Formal, Standard_Void_Type);
2480 Set_Inner_Instances (Formal, New_Elmt_List);
2481 Push_Scope (Formal);
2482
2483 if Is_Child_Unit (Gen_Unit)
2484 and then Parent_Installed
2485 then
2486 -- Similarly, we have to make the name of the formal visible in the
2487 -- parent instance, to resolve properly fully qualified names that
2488 -- may appear in the generic unit. The parent instance has been
2489 -- placed on the scope stack ahead of the current scope.
2490
2491 Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
2492
2493 Renaming_In_Par :=
2494 Make_Defining_Identifier (Loc, Chars (Gen_Unit));
2495 Set_Ekind (Renaming_In_Par, E_Package);
2496 Set_Etype (Renaming_In_Par, Standard_Void_Type);
2497 Set_Scope (Renaming_In_Par, Parent_Instance);
2498 Set_Parent (Renaming_In_Par, Parent (Formal));
2499 Set_Renamed_Object (Renaming_In_Par, Formal);
2500 Append_Entity (Renaming_In_Par, Parent_Instance);
2501 end if;
2502
2503 Analyze (Specification (N));
2504
2505 -- The formals for which associations are provided are not visible
2506 -- outside of the formal package. The others are still declared by a
2507 -- formal parameter declaration.
2508
2509 -- If there are no associations, the only local entity to hide is the
2510 -- generated package renaming itself.
2511
2512 declare
2513 E : Entity_Id;
2514
2515 begin
2516 E := First_Entity (Formal);
2517 while Present (E) loop
2518 if Associations
2519 and then not Is_Generic_Formal (E)
2520 then
2521 Set_Is_Hidden (E);
2522 end if;
2523
2524 if Ekind (E) = E_Package
2525 and then Renamed_Entity (E) = Formal
2526 then
2527 Set_Is_Hidden (E);
2528 exit;
2529 end if;
2530
2531 Next_Entity (E);
2532 end loop;
2533 end;
2534
2535 End_Package_Scope (Formal);
2536 Restore_Hidden_Primitives (Vis_Prims_List);
2537
2538 if Parent_Installed then
2539 Remove_Parent;
2540 end if;
2541
2542 Restore_Env;
2543
2544 -- Inside the generic unit, the formal package is a regular package, but
2545 -- no body is needed for it. Note that after instantiation, the defining
2546 -- unit name we need is in the new tree and not in the original (see
2547 -- Package_Instantiation). A generic formal package is an instance, and
2548 -- can be used as an actual for an inner instance.
2549
2550 Set_Has_Completion (Formal, True);
2551
2552 -- Add semantic information to the original defining identifier.
2553 -- for ASIS use.
2554
2555 Set_Ekind (Pack_Id, E_Package);
2556 Set_Etype (Pack_Id, Standard_Void_Type);
2557 Set_Scope (Pack_Id, Scope (Formal));
2558 Set_Has_Completion (Pack_Id, True);
2559
2560 <<Leave>>
2561 if Has_Aspects (N) then
2562 Analyze_Aspect_Specifications (N, Pack_Id);
2563 end if;
2564 end Analyze_Formal_Package_Declaration;
2565
2566 ---------------------------------
2567 -- Analyze_Formal_Private_Type --
2568 ---------------------------------
2569
2570 procedure Analyze_Formal_Private_Type
2571 (N : Node_Id;
2572 T : Entity_Id;
2573 Def : Node_Id)
2574 is
2575 begin
2576 New_Private_Type (N, T, Def);
2577
2578 -- Set the size to an arbitrary but legal value
2579
2580 Set_Size_Info (T, Standard_Integer);
2581 Set_RM_Size (T, RM_Size (Standard_Integer));
2582 end Analyze_Formal_Private_Type;
2583
2584 ------------------------------------
2585 -- Analyze_Formal_Incomplete_Type --
2586 ------------------------------------
2587
2588 procedure Analyze_Formal_Incomplete_Type
2589 (T : Entity_Id;
2590 Def : Node_Id)
2591 is
2592 begin
2593 Enter_Name (T);
2594 Set_Ekind (T, E_Incomplete_Type);
2595 Set_Etype (T, T);
2596 Set_Private_Dependents (T, New_Elmt_List);
2597
2598 if Tagged_Present (Def) then
2599 Set_Is_Tagged_Type (T);
2600 Make_Class_Wide_Type (T);
2601 Set_Direct_Primitive_Operations (T, New_Elmt_List);
2602 end if;
2603 end Analyze_Formal_Incomplete_Type;
2604
2605 ----------------------------------------
2606 -- Analyze_Formal_Signed_Integer_Type --
2607 ----------------------------------------
2608
2609 procedure Analyze_Formal_Signed_Integer_Type
2610 (T : Entity_Id;
2611 Def : Node_Id)
2612 is
2613 Base : constant Entity_Id :=
2614 New_Internal_Entity
2615 (E_Signed_Integer_Type,
2616 Current_Scope,
2617 Sloc (Defining_Identifier (Parent (Def))), 'G');
2618
2619 begin
2620 Enter_Name (T);
2621
2622 Set_Ekind (T, E_Signed_Integer_Subtype);
2623 Set_Etype (T, Base);
2624 Set_Size_Info (T, Standard_Integer);
2625 Set_RM_Size (T, RM_Size (Standard_Integer));
2626 Set_Scalar_Range (T, Scalar_Range (Standard_Integer));
2627 Set_Is_Constrained (T);
2628
2629 Set_Is_Generic_Type (Base);
2630 Set_Size_Info (Base, Standard_Integer);
2631 Set_RM_Size (Base, RM_Size (Standard_Integer));
2632 Set_Etype (Base, Base);
2633 Set_Scalar_Range (Base, Scalar_Range (Standard_Integer));
2634 Set_Parent (Base, Parent (Def));
2635 end Analyze_Formal_Signed_Integer_Type;
2636
2637 -------------------------------------------
2638 -- Analyze_Formal_Subprogram_Declaration --
2639 -------------------------------------------
2640
2641 procedure Analyze_Formal_Subprogram_Declaration (N : Node_Id) is
2642 Spec : constant Node_Id := Specification (N);
2643 Def : constant Node_Id := Default_Name (N);
2644 Nam : constant Entity_Id := Defining_Unit_Name (Spec);
2645 Subp : Entity_Id;
2646
2647 begin
2648 if Nam = Error then
2649 return;
2650 end if;
2651
2652 if Nkind (Nam) = N_Defining_Program_Unit_Name then
2653 Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
2654 goto Leave;
2655 end if;
2656
2657 Analyze_Subprogram_Declaration (N);
2658 Set_Is_Formal_Subprogram (Nam);
2659 Set_Has_Completion (Nam);
2660
2661 if Nkind (N) = N_Formal_Abstract_Subprogram_Declaration then
2662 Set_Is_Abstract_Subprogram (Nam);
2663 Set_Is_Dispatching_Operation (Nam);
2664
2665 declare
2666 Ctrl_Type : constant Entity_Id := Find_Dispatching_Type (Nam);
2667 begin
2668 if No (Ctrl_Type) then
2669 Error_Msg_N
2670 ("abstract formal subprogram must have a controlling type",
2671 N);
2672
2673 elsif Ada_Version >= Ada_2012
2674 and then Is_Incomplete_Type (Ctrl_Type)
2675 then
2676 Error_Msg_NE
2677 ("controlling type of abstract formal subprogram cannot " &
2678 "be incomplete type", N, Ctrl_Type);
2679
2680 else
2681 Check_Controlling_Formals (Ctrl_Type, Nam);
2682 end if;
2683 end;
2684 end if;
2685
2686 -- Default name is resolved at the point of instantiation
2687
2688 if Box_Present (N) then
2689 null;
2690
2691 -- Else default is bound at the point of generic declaration
2692
2693 elsif Present (Def) then
2694 if Nkind (Def) = N_Operator_Symbol then
2695 Find_Direct_Name (Def);
2696
2697 elsif Nkind (Def) /= N_Attribute_Reference then
2698 Analyze (Def);
2699
2700 else
2701 -- For an attribute reference, analyze the prefix and verify
2702 -- that it has the proper profile for the subprogram.
2703
2704 Analyze (Prefix (Def));
2705 Valid_Default_Attribute (Nam, Def);
2706 goto Leave;
2707 end if;
2708
2709 -- Default name may be overloaded, in which case the interpretation
2710 -- with the correct profile must be selected, as for a renaming.
2711 -- If the definition is an indexed component, it must denote a
2712 -- member of an entry family. If it is a selected component, it
2713 -- can be a protected operation.
2714
2715 if Etype (Def) = Any_Type then
2716 goto Leave;
2717
2718 elsif Nkind (Def) = N_Selected_Component then
2719 if not Is_Overloadable (Entity (Selector_Name (Def))) then
2720 Error_Msg_N ("expect valid subprogram name as default", Def);
2721 end if;
2722
2723 elsif Nkind (Def) = N_Indexed_Component then
2724 if Is_Entity_Name (Prefix (Def)) then
2725 if Ekind (Entity (Prefix (Def))) /= E_Entry_Family then
2726 Error_Msg_N ("expect valid subprogram name as default", Def);
2727 end if;
2728
2729 elsif Nkind (Prefix (Def)) = N_Selected_Component then
2730 if Ekind (Entity (Selector_Name (Prefix (Def)))) /=
2731 E_Entry_Family
2732 then
2733 Error_Msg_N ("expect valid subprogram name as default", Def);
2734 end if;
2735
2736 else
2737 Error_Msg_N ("expect valid subprogram name as default", Def);
2738 goto Leave;
2739 end if;
2740
2741 elsif Nkind (Def) = N_Character_Literal then
2742
2743 -- Needs some type checks: subprogram should be parameterless???
2744
2745 Resolve (Def, (Etype (Nam)));
2746
2747 elsif not Is_Entity_Name (Def)
2748 or else not Is_Overloadable (Entity (Def))
2749 then
2750 Error_Msg_N ("expect valid subprogram name as default", Def);
2751 goto Leave;
2752
2753 elsif not Is_Overloaded (Def) then
2754 Subp := Entity (Def);
2755
2756 if Subp = Nam then
2757 Error_Msg_N ("premature usage of formal subprogram", Def);
2758
2759 elsif not Entity_Matches_Spec (Subp, Nam) then
2760 Error_Msg_N ("no visible entity matches specification", Def);
2761 end if;
2762
2763 -- More than one interpretation, so disambiguate as for a renaming
2764
2765 else
2766 declare
2767 I : Interp_Index;
2768 I1 : Interp_Index := 0;
2769 It : Interp;
2770 It1 : Interp;
2771
2772 begin
2773 Subp := Any_Id;
2774 Get_First_Interp (Def, I, It);
2775 while Present (It.Nam) loop
2776 if Entity_Matches_Spec (It.Nam, Nam) then
2777 if Subp /= Any_Id then
2778 It1 := Disambiguate (Def, I1, I, Etype (Subp));
2779
2780 if It1 = No_Interp then
2781 Error_Msg_N ("ambiguous default subprogram", Def);
2782 else
2783 Subp := It1.Nam;
2784 end if;
2785
2786 exit;
2787
2788 else
2789 I1 := I;
2790 Subp := It.Nam;
2791 end if;
2792 end if;
2793
2794 Get_Next_Interp (I, It);
2795 end loop;
2796 end;
2797
2798 if Subp /= Any_Id then
2799
2800 -- Subprogram found, generate reference to it
2801
2802 Set_Entity (Def, Subp);
2803 Generate_Reference (Subp, Def);
2804
2805 if Subp = Nam then
2806 Error_Msg_N ("premature usage of formal subprogram", Def);
2807
2808 elsif Ekind (Subp) /= E_Operator then
2809 Check_Mode_Conformant (Subp, Nam);
2810 end if;
2811
2812 else
2813 Error_Msg_N ("no visible subprogram matches specification", N);
2814 end if;
2815 end if;
2816 end if;
2817
2818 <<Leave>>
2819 if Has_Aspects (N) then
2820 Analyze_Aspect_Specifications (N, Nam);
2821 end if;
2822
2823 end Analyze_Formal_Subprogram_Declaration;
2824
2825 -------------------------------------
2826 -- Analyze_Formal_Type_Declaration --
2827 -------------------------------------
2828
2829 procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
2830 Def : constant Node_Id := Formal_Type_Definition (N);
2831 T : Entity_Id;
2832
2833 begin
2834 T := Defining_Identifier (N);
2835
2836 if Present (Discriminant_Specifications (N))
2837 and then Nkind (Def) /= N_Formal_Private_Type_Definition
2838 then
2839 Error_Msg_N
2840 ("discriminants not allowed for this formal type", T);
2841 end if;
2842
2843 -- Enter the new name, and branch to specific routine
2844
2845 case Nkind (Def) is
2846 when N_Formal_Private_Type_Definition =>
2847 Analyze_Formal_Private_Type (N, T, Def);
2848
2849 when N_Formal_Derived_Type_Definition =>
2850 Analyze_Formal_Derived_Type (N, T, Def);
2851
2852 when N_Formal_Incomplete_Type_Definition =>
2853 Analyze_Formal_Incomplete_Type (T, Def);
2854
2855 when N_Formal_Discrete_Type_Definition =>
2856 Analyze_Formal_Discrete_Type (T, Def);
2857
2858 when N_Formal_Signed_Integer_Type_Definition =>
2859 Analyze_Formal_Signed_Integer_Type (T, Def);
2860
2861 when N_Formal_Modular_Type_Definition =>
2862 Analyze_Formal_Modular_Type (T, Def);
2863
2864 when N_Formal_Floating_Point_Definition =>
2865 Analyze_Formal_Floating_Type (T, Def);
2866
2867 when N_Formal_Ordinary_Fixed_Point_Definition =>
2868 Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
2869
2870 when N_Formal_Decimal_Fixed_Point_Definition =>
2871 Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
2872
2873 when N_Array_Type_Definition =>
2874 Analyze_Formal_Array_Type (T, Def);
2875
2876 when N_Access_To_Object_Definition |
2877 N_Access_Function_Definition |
2878 N_Access_Procedure_Definition =>
2879 Analyze_Generic_Access_Type (T, Def);
2880
2881 -- Ada 2005: a interface declaration is encoded as an abstract
2882 -- record declaration or a abstract type derivation.
2883
2884 when N_Record_Definition =>
2885 Analyze_Formal_Interface_Type (N, T, Def);
2886
2887 when N_Derived_Type_Definition =>
2888 Analyze_Formal_Derived_Interface_Type (N, T, Def);
2889
2890 when N_Error =>
2891 null;
2892
2893 when others =>
2894 raise Program_Error;
2895
2896 end case;
2897
2898 Set_Is_Generic_Type (T);
2899
2900 if Has_Aspects (N) then
2901 Analyze_Aspect_Specifications (N, T);
2902 end if;
2903 end Analyze_Formal_Type_Declaration;
2904
2905 ------------------------------------
2906 -- Analyze_Function_Instantiation --
2907 ------------------------------------
2908
2909 procedure Analyze_Function_Instantiation (N : Node_Id) is
2910 begin
2911 Analyze_Subprogram_Instantiation (N, E_Function);
2912 end Analyze_Function_Instantiation;
2913
2914 ---------------------------------
2915 -- Analyze_Generic_Access_Type --
2916 ---------------------------------
2917
2918 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
2919 begin
2920 Enter_Name (T);
2921
2922 if Nkind (Def) = N_Access_To_Object_Definition then
2923 Access_Type_Declaration (T, Def);
2924
2925 if Is_Incomplete_Or_Private_Type (Designated_Type (T))
2926 and then No (Full_View (Designated_Type (T)))
2927 and then not Is_Generic_Type (Designated_Type (T))
2928 then
2929 Error_Msg_N ("premature usage of incomplete type", Def);
2930
2931 elsif not Is_Entity_Name (Subtype_Indication (Def)) then
2932 Error_Msg_N
2933 ("only a subtype mark is allowed in a formal", Def);
2934 end if;
2935
2936 else
2937 Access_Subprogram_Declaration (T, Def);
2938 end if;
2939 end Analyze_Generic_Access_Type;
2940
2941 ---------------------------------
2942 -- Analyze_Generic_Formal_Part --
2943 ---------------------------------
2944
2945 procedure Analyze_Generic_Formal_Part (N : Node_Id) is
2946 Gen_Parm_Decl : Node_Id;
2947
2948 begin
2949 -- The generic formals are processed in the scope of the generic unit,
2950 -- where they are immediately visible. The scope is installed by the
2951 -- caller.
2952
2953 Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
2954
2955 while Present (Gen_Parm_Decl) loop
2956 Analyze (Gen_Parm_Decl);
2957 Next (Gen_Parm_Decl);
2958 end loop;
2959
2960 Generate_Reference_To_Generic_Formals (Current_Scope);
2961 end Analyze_Generic_Formal_Part;
2962
2963 ------------------------------------------
2964 -- Analyze_Generic_Package_Declaration --
2965 ------------------------------------------
2966
2967 procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
2968 Loc : constant Source_Ptr := Sloc (N);
2969 Id : Entity_Id;
2970 New_N : Node_Id;
2971 Save_Parent : Node_Id;
2972 Renaming : Node_Id;
2973 Decls : constant List_Id :=
2974 Visible_Declarations (Specification (N));
2975 Decl : Node_Id;
2976
2977 begin
2978 Check_SPARK_Restriction ("generic is not allowed", N);
2979
2980 -- We introduce a renaming of the enclosing package, to have a usable
2981 -- entity as the prefix of an expanded name for a local entity of the
2982 -- form Par.P.Q, where P is the generic package. This is because a local
2983 -- entity named P may hide it, so that the usual visibility rules in
2984 -- the instance will not resolve properly.
2985
2986 Renaming :=
2987 Make_Package_Renaming_Declaration (Loc,
2988 Defining_Unit_Name =>
2989 Make_Defining_Identifier (Loc,
2990 Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
2991 Name => Make_Identifier (Loc, Chars (Defining_Entity (N))));
2992
2993 if Present (Decls) then
2994 Decl := First (Decls);
2995 while Present (Decl)
2996 and then Nkind (Decl) = N_Pragma
2997 loop
2998 Next (Decl);
2999 end loop;
3000
3001 if Present (Decl) then
3002 Insert_Before (Decl, Renaming);
3003 else
3004 Append (Renaming, Visible_Declarations (Specification (N)));
3005 end if;
3006
3007 else
3008 Set_Visible_Declarations (Specification (N), New_List (Renaming));
3009 end if;
3010
3011 -- Create copy of generic unit, and save for instantiation. If the unit
3012 -- is a child unit, do not copy the specifications for the parent, which
3013 -- are not part of the generic tree.
3014
3015 Save_Parent := Parent_Spec (N);
3016 Set_Parent_Spec (N, Empty);
3017
3018 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3019 Set_Parent_Spec (New_N, Save_Parent);
3020 Rewrite (N, New_N);
3021 Id := Defining_Entity (N);
3022 Generate_Definition (Id);
3023
3024 -- Analyze aspects now, so that generated pragmas appear in the
3025 -- declarations before building and analyzing the generic copy.
3026
3027 if Has_Aspects (N) then
3028 Analyze_Aspect_Specifications (N, Id);
3029 end if;
3030
3031 -- Expansion is not applied to generic units
3032
3033 Start_Generic;
3034
3035 Enter_Name (Id);
3036 Set_Ekind (Id, E_Generic_Package);
3037 Set_Etype (Id, Standard_Void_Type);
3038 Push_Scope (Id);
3039 Enter_Generic_Scope (Id);
3040 Set_Inner_Instances (Id, New_Elmt_List);
3041
3042 Set_Categorization_From_Pragmas (N);
3043 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3044
3045 -- Link the declaration of the generic homonym in the generic copy to
3046 -- the package it renames, so that it is always resolved properly.
3047
3048 Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
3049 Set_Entity (Associated_Node (Name (Renaming)), Id);
3050
3051 -- For a library unit, we have reconstructed the entity for the unit,
3052 -- and must reset it in the library tables.
3053
3054 if Nkind (Parent (N)) = N_Compilation_Unit then
3055 Set_Cunit_Entity (Current_Sem_Unit, Id);
3056 end if;
3057
3058 Analyze_Generic_Formal_Part (N);
3059
3060 -- After processing the generic formals, analysis proceeds as for a
3061 -- non-generic package.
3062
3063 Analyze (Specification (N));
3064
3065 Validate_Categorization_Dependency (N, Id);
3066
3067 End_Generic;
3068
3069 End_Package_Scope (Id);
3070 Exit_Generic_Scope (Id);
3071
3072 if Nkind (Parent (N)) /= N_Compilation_Unit then
3073 Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
3074 Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
3075 Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
3076
3077 else
3078 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3079 Validate_RT_RAT_Component (N);
3080
3081 -- If this is a spec without a body, check that generic parameters
3082 -- are referenced.
3083
3084 if not Body_Required (Parent (N)) then
3085 Check_References (Id);
3086 end if;
3087 end if;
3088
3089 end Analyze_Generic_Package_Declaration;
3090
3091 --------------------------------------------
3092 -- Analyze_Generic_Subprogram_Declaration --
3093 --------------------------------------------
3094
3095 procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
3096 Spec : Node_Id;
3097 Id : Entity_Id;
3098 Formals : List_Id;
3099 New_N : Node_Id;
3100 Result_Type : Entity_Id;
3101 Save_Parent : Node_Id;
3102 Typ : Entity_Id;
3103
3104 begin
3105 Check_SPARK_Restriction ("generic is not allowed", N);
3106
3107 -- Create copy of generic unit, and save for instantiation. If the unit
3108 -- is a child unit, do not copy the specifications for the parent, which
3109 -- are not part of the generic tree.
3110
3111 Save_Parent := Parent_Spec (N);
3112 Set_Parent_Spec (N, Empty);
3113
3114 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3115 Set_Parent_Spec (New_N, Save_Parent);
3116 Rewrite (N, New_N);
3117
3118 -- The aspect specifications are not attached to the tree, and must
3119 -- be copied and attached to the generic copy explicitly.
3120
3121 if Present (Aspect_Specifications (New_N)) then
3122 declare
3123 Aspects : constant List_Id := Aspect_Specifications (N);
3124 begin
3125 Set_Has_Aspects (N, False);
3126 Move_Aspects (New_N, N);
3127 Set_Has_Aspects (Original_Node (N), False);
3128 Set_Aspect_Specifications (Original_Node (N), Aspects);
3129 end;
3130 end if;
3131
3132 Spec := Specification (N);
3133 Id := Defining_Entity (Spec);
3134 Generate_Definition (Id);
3135 Set_Contract (Id, Make_Contract (Sloc (Id)));
3136
3137 if Nkind (Id) = N_Defining_Operator_Symbol then
3138 Error_Msg_N
3139 ("operator symbol not allowed for generic subprogram", Id);
3140 end if;
3141
3142 Start_Generic;
3143
3144 Enter_Name (Id);
3145
3146 Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
3147 Push_Scope (Id);
3148 Enter_Generic_Scope (Id);
3149 Set_Inner_Instances (Id, New_Elmt_List);
3150 Set_Is_Pure (Id, Is_Pure (Current_Scope));
3151
3152 Analyze_Generic_Formal_Part (N);
3153
3154 Formals := Parameter_Specifications (Spec);
3155
3156 if Present (Formals) then
3157 Process_Formals (Formals, Spec);
3158 end if;
3159
3160 if Nkind (Spec) = N_Function_Specification then
3161 Set_Ekind (Id, E_Generic_Function);
3162
3163 if Nkind (Result_Definition (Spec)) = N_Access_Definition then
3164 Result_Type := Access_Definition (Spec, Result_Definition (Spec));
3165 Set_Etype (Id, Result_Type);
3166
3167 -- Check restriction imposed by AI05-073: a generic function
3168 -- cannot return an abstract type or an access to such.
3169
3170 -- This is a binding interpretation should it apply to earlier
3171 -- versions of Ada as well as Ada 2012???
3172
3173 if Is_Abstract_Type (Designated_Type (Result_Type))
3174 and then Ada_Version >= Ada_2012
3175 then
3176 Error_Msg_N ("generic function cannot have an access result"
3177 & " that designates an abstract type", Spec);
3178 end if;
3179
3180 else
3181 Find_Type (Result_Definition (Spec));
3182 Typ := Entity (Result_Definition (Spec));
3183
3184 if Is_Abstract_Type (Typ)
3185 and then Ada_Version >= Ada_2012
3186 then
3187 Error_Msg_N
3188 ("generic function cannot have abstract result type", Spec);
3189 end if;
3190
3191 -- If a null exclusion is imposed on the result type, then create
3192 -- a null-excluding itype (an access subtype) and use it as the
3193 -- function's Etype.
3194
3195 if Is_Access_Type (Typ)
3196 and then Null_Exclusion_Present (Spec)
3197 then
3198 Set_Etype (Id,
3199 Create_Null_Excluding_Itype
3200 (T => Typ,
3201 Related_Nod => Spec,
3202 Scope_Id => Defining_Unit_Name (Spec)));
3203 else
3204 Set_Etype (Id, Typ);
3205 end if;
3206 end if;
3207
3208 else
3209 Set_Ekind (Id, E_Generic_Procedure);
3210 Set_Etype (Id, Standard_Void_Type);
3211 end if;
3212
3213 -- For a library unit, we have reconstructed the entity for the unit,
3214 -- and must reset it in the library tables. We also make sure that
3215 -- Body_Required is set properly in the original compilation unit node.
3216
3217 if Nkind (Parent (N)) = N_Compilation_Unit then
3218 Set_Cunit_Entity (Current_Sem_Unit, Id);
3219 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3220 end if;
3221
3222 Set_Categorization_From_Pragmas (N);
3223 Validate_Categorization_Dependency (N, Id);
3224
3225 Save_Global_References (Original_Node (N));
3226
3227 -- For ASIS purposes, convert any postcondition, precondition pragmas
3228 -- into aspects, if N is not a compilation unit by itself, in order to
3229 -- enable the analysis of expressions inside the corresponding PPC
3230 -- pragmas.
3231
3232 if ASIS_Mode and then Is_List_Member (N) then
3233 Make_Aspect_For_PPC_In_Gen_Sub_Decl (N);
3234 end if;
3235
3236 -- To capture global references, analyze the expressions of aspects,
3237 -- and propagate information to original tree. Note that in this case
3238 -- analysis of attributes is not delayed until the freeze point.
3239
3240 -- It seems very hard to recreate the proper visibility of the generic
3241 -- subprogram at a later point because the analysis of an aspect may
3242 -- create pragmas after the generic copies have been made ???
3243
3244 if Has_Aspects (N) then
3245 declare
3246 Aspect : Node_Id;
3247
3248 begin
3249 Aspect := First (Aspect_Specifications (N));
3250 while Present (Aspect) loop
3251 if Get_Aspect_Id (Aspect) /= Aspect_Warnings then
3252 Analyze (Expression (Aspect));
3253 end if;
3254
3255 Next (Aspect);
3256 end loop;
3257
3258 Aspect := First (Aspect_Specifications (Original_Node (N)));
3259 while Present (Aspect) loop
3260 Save_Global_References (Expression (Aspect));
3261 Next (Aspect);
3262 end loop;
3263 end;
3264 end if;
3265
3266 End_Generic;
3267 End_Scope;
3268 Exit_Generic_Scope (Id);
3269 Generate_Reference_To_Formals (Id);
3270
3271 List_Inherited_Pre_Post_Aspects (Id);
3272 end Analyze_Generic_Subprogram_Declaration;
3273
3274 -----------------------------------
3275 -- Analyze_Package_Instantiation --
3276 -----------------------------------
3277
3278 procedure Analyze_Package_Instantiation (N : Node_Id) is
3279 Loc : constant Source_Ptr := Sloc (N);
3280 Gen_Id : constant Node_Id := Name (N);
3281
3282 Act_Decl : Node_Id;
3283 Act_Decl_Name : Node_Id;
3284 Act_Decl_Id : Entity_Id;
3285 Act_Spec : Node_Id;
3286 Act_Tree : Node_Id;
3287
3288 Gen_Decl : Node_Id;
3289 Gen_Unit : Entity_Id;
3290
3291 Is_Actual_Pack : constant Boolean :=
3292 Is_Internal (Defining_Entity (N));
3293
3294 Env_Installed : Boolean := False;
3295 Parent_Installed : Boolean := False;
3296 Renaming_List : List_Id;
3297 Unit_Renaming : Node_Id;
3298 Needs_Body : Boolean;
3299 Inline_Now : Boolean := False;
3300
3301 Save_Style_Check : constant Boolean := Style_Check;
3302 -- Save style check mode for restore on exit
3303
3304 procedure Delay_Descriptors (E : Entity_Id);
3305 -- Delay generation of subprogram descriptors for given entity
3306
3307 function Might_Inline_Subp return Boolean;
3308 -- If inlining is active and the generic contains inlined subprograms,
3309 -- we instantiate the body. This may cause superfluous instantiations,
3310 -- but it is simpler than detecting the need for the body at the point
3311 -- of inlining, when the context of the instance is not available.
3312
3313 function Must_Inline_Subp return Boolean;
3314 -- If inlining is active and the generic contains inlined subprograms,
3315 -- return True if some of the inlined subprograms must be inlined by
3316 -- the frontend.
3317
3318 -----------------------
3319 -- Delay_Descriptors --
3320 -----------------------
3321
3322 procedure Delay_Descriptors (E : Entity_Id) is
3323 begin
3324 if not Delay_Subprogram_Descriptors (E) then
3325 Set_Delay_Subprogram_Descriptors (E);
3326 Pending_Descriptor.Append (E);
3327 end if;
3328 end Delay_Descriptors;
3329
3330 -----------------------
3331 -- Might_Inline_Subp --
3332 -----------------------
3333
3334 function Might_Inline_Subp return Boolean is
3335 E : Entity_Id;
3336
3337 begin
3338 if not Inline_Processing_Required then
3339 return False;
3340
3341 else
3342 E := First_Entity (Gen_Unit);
3343 while Present (E) loop
3344 if Is_Subprogram (E)
3345 and then Is_Inlined (E)
3346 then
3347 return True;
3348 end if;
3349
3350 Next_Entity (E);
3351 end loop;
3352 end if;
3353
3354 return False;
3355 end Might_Inline_Subp;
3356
3357 ----------------------
3358 -- Must_Inline_Subp --
3359 ----------------------
3360
3361 function Must_Inline_Subp return Boolean is
3362 E : Entity_Id;
3363
3364 begin
3365 if not Inline_Processing_Required then
3366 return False;
3367
3368 else
3369 E := First_Entity (Gen_Unit);
3370 while Present (E) loop
3371 if Is_Subprogram (E)
3372 and then Is_Inlined (E)
3373 and then Must_Inline (E)
3374 then
3375 return True;
3376 end if;
3377
3378 Next_Entity (E);
3379 end loop;
3380 end if;
3381
3382 return False;
3383 end Must_Inline_Subp;
3384
3385 -- Local declarations
3386
3387 Vis_Prims_List : Elist_Id := No_Elist;
3388 -- List of primitives made temporarily visible in the instantiation
3389 -- to match the visibility of the formal type
3390
3391 -- Start of processing for Analyze_Package_Instantiation
3392
3393 begin
3394 Check_SPARK_Restriction ("generic is not allowed", N);
3395
3396 -- Very first thing: apply the special kludge for Text_IO processing
3397 -- in case we are instantiating one of the children of [Wide_]Text_IO.
3398
3399 Text_IO_Kludge (Name (N));
3400
3401 -- Make node global for error reporting
3402
3403 Instantiation_Node := N;
3404
3405 -- Turn off style checking in instances. If the check is enabled on the
3406 -- generic unit, a warning in an instance would just be noise. If not
3407 -- enabled on the generic, then a warning in an instance is just wrong.
3408
3409 Style_Check := False;
3410
3411 -- Case of instantiation of a generic package
3412
3413 if Nkind (N) = N_Package_Instantiation then
3414 Act_Decl_Id := New_Copy (Defining_Entity (N));
3415 Set_Comes_From_Source (Act_Decl_Id, True);
3416
3417 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
3418 Act_Decl_Name :=
3419 Make_Defining_Program_Unit_Name (Loc,
3420 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
3421 Defining_Identifier => Act_Decl_Id);
3422 else
3423 Act_Decl_Name := Act_Decl_Id;
3424 end if;
3425
3426 -- Case of instantiation of a formal package
3427
3428 else
3429 Act_Decl_Id := Defining_Identifier (N);
3430 Act_Decl_Name := Act_Decl_Id;
3431 end if;
3432
3433 Generate_Definition (Act_Decl_Id);
3434 Preanalyze_Actuals (N);
3435
3436 Init_Env;
3437 Env_Installed := True;
3438
3439 -- Reset renaming map for formal types. The mapping is established
3440 -- when analyzing the generic associations, but some mappings are
3441 -- inherited from formal packages of parent units, and these are
3442 -- constructed when the parents are installed.
3443
3444 Generic_Renamings.Set_Last (0);
3445 Generic_Renamings_HTable.Reset;
3446
3447 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3448 Gen_Unit := Entity (Gen_Id);
3449
3450 -- Verify that it is the name of a generic package
3451
3452 -- A visibility glitch: if the instance is a child unit and the generic
3453 -- is the generic unit of a parent instance (i.e. both the parent and
3454 -- the child units are instances of the same package) the name now
3455 -- denotes the renaming within the parent, not the intended generic
3456 -- unit. See if there is a homonym that is the desired generic. The
3457 -- renaming declaration must be visible inside the instance of the
3458 -- child, but not when analyzing the name in the instantiation itself.
3459
3460 if Ekind (Gen_Unit) = E_Package
3461 and then Present (Renamed_Entity (Gen_Unit))
3462 and then In_Open_Scopes (Renamed_Entity (Gen_Unit))
3463 and then Is_Generic_Instance (Renamed_Entity (Gen_Unit))
3464 and then Present (Homonym (Gen_Unit))
3465 then
3466 Gen_Unit := Homonym (Gen_Unit);
3467 end if;
3468
3469 if Etype (Gen_Unit) = Any_Type then
3470 Restore_Env;
3471 goto Leave;
3472
3473 elsif Ekind (Gen_Unit) /= E_Generic_Package then
3474
3475 -- Ada 2005 (AI-50217): Cannot use instance in limited with_clause
3476
3477 if From_With_Type (Gen_Unit) then
3478 Error_Msg_N
3479 ("cannot instantiate a limited withed package", Gen_Id);
3480 else
3481 Error_Msg_N
3482 ("expect name of generic package in instantiation", Gen_Id);
3483 end if;
3484
3485 Restore_Env;
3486 goto Leave;
3487 end if;
3488
3489 if In_Extended_Main_Source_Unit (N) then
3490 Set_Is_Instantiated (Gen_Unit);
3491 Generate_Reference (Gen_Unit, N);
3492
3493 if Present (Renamed_Object (Gen_Unit)) then
3494 Set_Is_Instantiated (Renamed_Object (Gen_Unit));
3495 Generate_Reference (Renamed_Object (Gen_Unit), N);
3496 end if;
3497 end if;
3498
3499 if Nkind (Gen_Id) = N_Identifier
3500 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3501 then
3502 Error_Msg_NE
3503 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3504
3505 elsif Nkind (Gen_Id) = N_Expanded_Name
3506 and then Is_Child_Unit (Gen_Unit)
3507 and then Nkind (Prefix (Gen_Id)) = N_Identifier
3508 and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
3509 then
3510 Error_Msg_N
3511 ("& is hidden within declaration of instance ", Prefix (Gen_Id));
3512 end if;
3513
3514 Set_Entity (Gen_Id, Gen_Unit);
3515
3516 -- If generic is a renaming, get original generic unit
3517
3518 if Present (Renamed_Object (Gen_Unit))
3519 and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
3520 then
3521 Gen_Unit := Renamed_Object (Gen_Unit);
3522 end if;
3523
3524 -- Verify that there are no circular instantiations
3525
3526 if In_Open_Scopes (Gen_Unit) then
3527 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3528 Restore_Env;
3529 goto Leave;
3530
3531 elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3532 Error_Msg_Node_2 := Current_Scope;
3533 Error_Msg_NE
3534 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3535 Circularity_Detected := True;
3536 Restore_Env;
3537 goto Leave;
3538
3539 else
3540 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3541
3542 -- Initialize renamings map, for error checking, and the list that
3543 -- holds private entities whose views have changed between generic
3544 -- definition and instantiation. If this is the instance created to
3545 -- validate an actual package, the instantiation environment is that
3546 -- of the enclosing instance.
3547
3548 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3549
3550 -- Copy original generic tree, to produce text for instantiation
3551
3552 Act_Tree :=
3553 Copy_Generic_Node
3554 (Original_Node (Gen_Decl), Empty, Instantiating => True);
3555
3556 Act_Spec := Specification (Act_Tree);
3557
3558 -- If this is the instance created to validate an actual package,
3559 -- only the formals matter, do not examine the package spec itself.
3560
3561 if Is_Actual_Pack then
3562 Set_Visible_Declarations (Act_Spec, New_List);
3563 Set_Private_Declarations (Act_Spec, New_List);
3564 end if;
3565
3566 Renaming_List :=
3567 Analyze_Associations
3568 (I_Node => N,
3569 Formals => Generic_Formal_Declarations (Act_Tree),
3570 F_Copy => Generic_Formal_Declarations (Gen_Decl));
3571
3572 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
3573
3574 Set_Instance_Env (Gen_Unit, Act_Decl_Id);
3575 Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
3576 Set_Is_Generic_Instance (Act_Decl_Id);
3577
3578 Set_Generic_Parent (Act_Spec, Gen_Unit);
3579
3580 -- References to the generic in its own declaration or its body are
3581 -- references to the instance. Add a renaming declaration for the
3582 -- generic unit itself. This declaration, as well as the renaming
3583 -- declarations for the generic formals, must remain private to the
3584 -- unit: the formals, because this is the language semantics, and
3585 -- the unit because its use is an artifact of the implementation.
3586
3587 Unit_Renaming :=
3588 Make_Package_Renaming_Declaration (Loc,
3589 Defining_Unit_Name =>
3590 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
3591 Name => New_Reference_To (Act_Decl_Id, Loc));
3592
3593 Append (Unit_Renaming, Renaming_List);
3594
3595 -- The renaming declarations are the first local declarations of
3596 -- the new unit.
3597
3598 if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
3599 Insert_List_Before
3600 (First (Visible_Declarations (Act_Spec)), Renaming_List);
3601 else
3602 Set_Visible_Declarations (Act_Spec, Renaming_List);
3603 end if;
3604
3605 Act_Decl :=
3606 Make_Package_Declaration (Loc,
3607 Specification => Act_Spec);
3608
3609 -- Save the instantiation node, for subsequent instantiation of the
3610 -- body, if there is one and we are generating code for the current
3611 -- unit. Mark the unit as having a body, to avoid a premature error
3612 -- message.
3613
3614 -- We instantiate the body if we are generating code, if we are
3615 -- generating cross-reference information, or if we are building
3616 -- trees for ASIS use.
3617
3618 declare
3619 Enclosing_Body_Present : Boolean := False;
3620 -- If the generic unit is not a compilation unit, then a body may
3621 -- be present in its parent even if none is required. We create a
3622 -- tentative pending instantiation for the body, which will be
3623 -- discarded if none is actually present.
3624
3625 Scop : Entity_Id;
3626
3627 begin
3628 if Scope (Gen_Unit) /= Standard_Standard
3629 and then not Is_Child_Unit (Gen_Unit)
3630 then
3631 Scop := Scope (Gen_Unit);
3632
3633 while Present (Scop)
3634 and then Scop /= Standard_Standard
3635 loop
3636 if Unit_Requires_Body (Scop) then
3637 Enclosing_Body_Present := True;
3638 exit;
3639
3640 elsif In_Open_Scopes (Scop)
3641 and then In_Package_Body (Scop)
3642 then
3643 Enclosing_Body_Present := True;
3644 exit;
3645 end if;
3646
3647 exit when Is_Compilation_Unit (Scop);
3648 Scop := Scope (Scop);
3649 end loop;
3650 end if;
3651
3652 -- If front-end inlining is enabled, and this is a unit for which
3653 -- code will be generated, we instantiate the body at once.
3654
3655 -- This is done if the instance is not the main unit, and if the
3656 -- generic is not a child unit of another generic, to avoid scope
3657 -- problems and the reinstallation of parent instances.
3658
3659 if Expander_Active
3660 and then (not Is_Child_Unit (Gen_Unit)
3661 or else not Is_Generic_Unit (Scope (Gen_Unit)))
3662 and then Might_Inline_Subp
3663 and then not Is_Actual_Pack
3664 then
3665 if not Debug_Flag_Dot_K
3666 and then Front_End_Inlining
3667 and then (Is_In_Main_Unit (N)
3668 or else In_Main_Context (Current_Scope))
3669 and then Nkind (Parent (N)) /= N_Compilation_Unit
3670 then
3671 Inline_Now := True;
3672
3673 elsif Debug_Flag_Dot_K
3674 and then Must_Inline_Subp
3675 and then (Is_In_Main_Unit (N)
3676 or else In_Main_Context (Current_Scope))
3677 and then Nkind (Parent (N)) /= N_Compilation_Unit
3678 then
3679 Inline_Now := True;
3680
3681 -- In configurable_run_time mode we force the inlining of
3682 -- predefined subprograms marked Inline_Always, to minimize
3683 -- the use of the run-time library.
3684
3685 elsif Is_Predefined_File_Name
3686 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
3687 and then Configurable_Run_Time_Mode
3688 and then Nkind (Parent (N)) /= N_Compilation_Unit
3689 then
3690 Inline_Now := True;
3691 end if;
3692
3693 -- If the current scope is itself an instance within a child
3694 -- unit, there will be duplications in the scope stack, and the
3695 -- unstacking mechanism in Inline_Instance_Body will fail.
3696 -- This loses some rare cases of optimization, and might be
3697 -- improved some day, if we can find a proper abstraction for
3698 -- "the complete compilation context" that can be saved and
3699 -- restored. ???
3700
3701 if Is_Generic_Instance (Current_Scope) then
3702 declare
3703 Curr_Unit : constant Entity_Id :=
3704 Cunit_Entity (Current_Sem_Unit);
3705 begin
3706 if Curr_Unit /= Current_Scope
3707 and then Is_Child_Unit (Curr_Unit)
3708 then
3709 Inline_Now := False;
3710 end if;
3711 end;
3712 end if;
3713 end if;
3714
3715 Needs_Body :=
3716 (Unit_Requires_Body (Gen_Unit)
3717 or else Enclosing_Body_Present
3718 or else Present (Corresponding_Body (Gen_Decl)))
3719 and then (Is_In_Main_Unit (N)
3720 or else Might_Inline_Subp)
3721 and then not Is_Actual_Pack
3722 and then not Inline_Now
3723 and then (Operating_Mode = Generate_Code
3724 or else (Operating_Mode = Check_Semantics
3725 and then ASIS_Mode));
3726
3727 -- If front_end_inlining is enabled, do not instantiate body if
3728 -- within a generic context.
3729
3730 if (Front_End_Inlining
3731 and then not Expander_Active)
3732 or else Is_Generic_Unit (Cunit_Entity (Main_Unit))
3733 then
3734 Needs_Body := False;
3735 end if;
3736
3737 -- If the current context is generic, and the package being
3738 -- instantiated is declared within a formal package, there is no
3739 -- body to instantiate until the enclosing generic is instantiated
3740 -- and there is an actual for the formal package. If the formal
3741 -- package has parameters, we build a regular package instance for
3742 -- it, that precedes the original formal package declaration.
3743
3744 if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
3745 declare
3746 Decl : constant Node_Id :=
3747 Original_Node
3748 (Unit_Declaration_Node (Scope (Gen_Unit)));
3749 begin
3750 if Nkind (Decl) = N_Formal_Package_Declaration
3751 or else (Nkind (Decl) = N_Package_Declaration
3752 and then Is_List_Member (Decl)
3753 and then Present (Next (Decl))
3754 and then
3755 Nkind (Next (Decl)) =
3756 N_Formal_Package_Declaration)
3757 then
3758 Needs_Body := False;
3759 end if;
3760 end;
3761 end if;
3762 end;
3763
3764 -- For RCI unit calling stubs, we omit the instance body if the
3765 -- instance is the RCI library unit itself.
3766
3767 -- However there is a special case for nested instances: in this case
3768 -- we do generate the instance body, as it might be required, e.g.
3769 -- because it provides stream attributes for some type used in the
3770 -- profile of a remote subprogram. This is consistent with 12.3(12),
3771 -- which indicates that the instance body occurs at the place of the
3772 -- instantiation, and thus is part of the RCI declaration, which is
3773 -- present on all client partitions (this is E.2.3(18)).
3774
3775 -- Note that AI12-0002 may make it illegal at some point to have
3776 -- stream attributes defined in an RCI unit, in which case this
3777 -- special case will become unnecessary. In the meantime, there
3778 -- is known application code in production that depends on this
3779 -- being possible, so we definitely cannot eliminate the body in
3780 -- the case of nested instances for the time being.
3781
3782 -- When we generate a nested instance body, calling stubs for any
3783 -- relevant subprogram will be be inserted immediately after the
3784 -- subprogram declarations, and will take precedence over the
3785 -- subsequent (original) body. (The stub and original body will be
3786 -- complete homographs, but this is permitted in an instance).
3787 -- (Could we do better and remove the original body???)
3788
3789 if Distribution_Stub_Mode = Generate_Caller_Stub_Body
3790 and then Comes_From_Source (N)
3791 and then Nkind (Parent (N)) = N_Compilation_Unit
3792 then
3793 Needs_Body := False;
3794 end if;
3795
3796 if Needs_Body then
3797
3798 -- Here is a defence against a ludicrous number of instantiations
3799 -- caused by a circular set of instantiation attempts.
3800
3801 if Pending_Instantiations.Last > Maximum_Instantiations then
3802 Error_Msg_Uint_1 := UI_From_Int (Maximum_Instantiations);
3803 Error_Msg_N ("too many instantiations, exceeds max of^", N);
3804 Error_Msg_N ("\limit can be changed using -gnateinn switch", N);
3805 raise Unrecoverable_Error;
3806 end if;
3807
3808 -- Indicate that the enclosing scopes contain an instantiation,
3809 -- and that cleanup actions should be delayed until after the
3810 -- instance body is expanded.
3811
3812 Check_Forward_Instantiation (Gen_Decl);
3813 if Nkind (N) = N_Package_Instantiation then
3814 declare
3815 Enclosing_Master : Entity_Id;
3816
3817 begin
3818 -- Loop to search enclosing masters
3819
3820 Enclosing_Master := Current_Scope;
3821 Scope_Loop : while Enclosing_Master /= Standard_Standard loop
3822 if Ekind (Enclosing_Master) = E_Package then
3823 if Is_Compilation_Unit (Enclosing_Master) then
3824 if In_Package_Body (Enclosing_Master) then
3825 Delay_Descriptors
3826 (Body_Entity (Enclosing_Master));
3827 else
3828 Delay_Descriptors
3829 (Enclosing_Master);
3830 end if;
3831
3832 exit Scope_Loop;
3833
3834 else
3835 Enclosing_Master := Scope (Enclosing_Master);
3836 end if;
3837
3838 elsif Is_Generic_Unit (Enclosing_Master)
3839 or else Ekind (Enclosing_Master) = E_Void
3840 then
3841 -- Cleanup actions will eventually be performed on the
3842 -- enclosing subprogram or package instance, if any.
3843 -- Enclosing scope is void in the formal part of a
3844 -- generic subprogram.
3845
3846 exit Scope_Loop;
3847
3848 else
3849 if Ekind (Enclosing_Master) = E_Entry
3850 and then
3851 Ekind (Scope (Enclosing_Master)) = E_Protected_Type
3852 then
3853 if not Expander_Active then
3854 exit Scope_Loop;
3855 else
3856 Enclosing_Master :=
3857 Protected_Body_Subprogram (Enclosing_Master);
3858 end if;
3859 end if;
3860
3861 Set_Delay_Cleanups (Enclosing_Master);
3862
3863 while Ekind (Enclosing_Master) = E_Block loop
3864 Enclosing_Master := Scope (Enclosing_Master);
3865 end loop;
3866
3867 if Is_Subprogram (Enclosing_Master) then
3868 Delay_Descriptors (Enclosing_Master);
3869
3870 elsif Is_Task_Type (Enclosing_Master) then
3871 declare
3872 TBP : constant Node_Id :=
3873 Get_Task_Body_Procedure
3874 (Enclosing_Master);
3875 begin
3876 if Present (TBP) then
3877 Delay_Descriptors (TBP);
3878 Set_Delay_Cleanups (TBP);
3879 end if;
3880 end;
3881 end if;
3882
3883 exit Scope_Loop;
3884 end if;
3885 end loop Scope_Loop;
3886 end;
3887
3888 -- Make entry in table
3889
3890 Pending_Instantiations.Append
3891 ((Inst_Node => N,
3892 Act_Decl => Act_Decl,
3893 Expander_Status => Expander_Active,
3894 Current_Sem_Unit => Current_Sem_Unit,
3895 Scope_Suppress => Scope_Suppress,
3896 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
3897 Version => Ada_Version));
3898 end if;
3899 end if;
3900
3901 Set_Categorization_From_Pragmas (Act_Decl);
3902
3903 if Parent_Installed then
3904 Hide_Current_Scope;
3905 end if;
3906
3907 Set_Instance_Spec (N, Act_Decl);
3908
3909 -- If not a compilation unit, insert the package declaration before
3910 -- the original instantiation node.
3911
3912 if Nkind (Parent (N)) /= N_Compilation_Unit then
3913 Mark_Rewrite_Insertion (Act_Decl);
3914 Insert_Before (N, Act_Decl);
3915 Analyze (Act_Decl);
3916
3917 -- For an instantiation that is a compilation unit, place
3918 -- declaration on current node so context is complete for analysis
3919 -- (including nested instantiations). If this is the main unit,
3920 -- the declaration eventually replaces the instantiation node.
3921 -- If the instance body is created later, it replaces the
3922 -- instance node, and the declaration is attached to it
3923 -- (see Build_Instance_Compilation_Unit_Nodes).
3924
3925 else
3926 if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
3927
3928 -- The entity for the current unit is the newly created one,
3929 -- and all semantic information is attached to it.
3930
3931 Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
3932
3933 -- If this is the main unit, replace the main entity as well
3934
3935 if Current_Sem_Unit = Main_Unit then
3936 Main_Unit_Entity := Act_Decl_Id;
3937 end if;
3938 end if;
3939
3940 Set_Unit (Parent (N), Act_Decl);
3941 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
3942 Set_Package_Instantiation (Act_Decl_Id, N);
3943 Analyze (Act_Decl);
3944 Set_Unit (Parent (N), N);
3945 Set_Body_Required (Parent (N), False);
3946
3947 -- We never need elaboration checks on instantiations, since by
3948 -- definition, the body instantiation is elaborated at the same
3949 -- time as the spec instantiation.
3950
3951 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
3952 Set_Kill_Elaboration_Checks (Act_Decl_Id);
3953 end if;
3954
3955 Check_Elab_Instantiation (N);
3956
3957 if ABE_Is_Certain (N) and then Needs_Body then
3958 Pending_Instantiations.Decrement_Last;
3959 end if;
3960
3961 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
3962
3963 Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
3964 First_Private_Entity (Act_Decl_Id));
3965
3966 -- If the instantiation will receive a body, the unit will be
3967 -- transformed into a package body, and receive its own elaboration
3968 -- entity. Otherwise, the nature of the unit is now a package
3969 -- declaration.
3970
3971 if Nkind (Parent (N)) = N_Compilation_Unit
3972 and then not Needs_Body
3973 then
3974 Rewrite (N, Act_Decl);
3975 end if;
3976
3977 if Present (Corresponding_Body (Gen_Decl))
3978 or else Unit_Requires_Body (Gen_Unit)
3979 then
3980 Set_Has_Completion (Act_Decl_Id);
3981 end if;
3982
3983 Check_Formal_Packages (Act_Decl_Id);
3984
3985 Restore_Hidden_Primitives (Vis_Prims_List);
3986 Restore_Private_Views (Act_Decl_Id);
3987
3988 Inherit_Context (Gen_Decl, N);
3989
3990 if Parent_Installed then
3991 Remove_Parent;
3992 end if;
3993
3994 Restore_Env;
3995 Env_Installed := False;
3996 end if;
3997
3998 Validate_Categorization_Dependency (N, Act_Decl_Id);
3999
4000 -- There used to be a check here to prevent instantiations in local
4001 -- contexts if the No_Local_Allocators restriction was active. This
4002 -- check was removed by a binding interpretation in AI-95-00130/07,
4003 -- but we retain the code for documentation purposes.
4004
4005 -- if Ekind (Act_Decl_Id) /= E_Void
4006 -- and then not Is_Library_Level_Entity (Act_Decl_Id)
4007 -- then
4008 -- Check_Restriction (No_Local_Allocators, N);
4009 -- end if;
4010
4011 if Inline_Now then
4012 Inline_Instance_Body (N, Gen_Unit, Act_Decl);
4013 end if;
4014
4015 -- The following is a tree patch for ASIS: ASIS needs separate nodes to
4016 -- be used as defining identifiers for a formal package and for the
4017 -- corresponding expanded package.
4018
4019 if Nkind (N) = N_Formal_Package_Declaration then
4020 Act_Decl_Id := New_Copy (Defining_Entity (N));
4021 Set_Comes_From_Source (Act_Decl_Id, True);
4022 Set_Is_Generic_Instance (Act_Decl_Id, False);
4023 Set_Defining_Identifier (N, Act_Decl_Id);
4024 end if;
4025
4026 Style_Check := Save_Style_Check;
4027
4028 -- Check that if N is an instantiation of System.Dim_Float_IO or
4029 -- System.Dim_Integer_IO, the formal type has a dimension system.
4030
4031 if Nkind (N) = N_Package_Instantiation
4032 and then Is_Dim_IO_Package_Instantiation (N)
4033 then
4034 declare
4035 Assoc : constant Node_Id := First (Generic_Associations (N));
4036 begin
4037 if not Has_Dimension_System
4038 (Etype (Explicit_Generic_Actual_Parameter (Assoc)))
4039 then
4040 Error_Msg_N ("type with a dimension system expected", Assoc);
4041 end if;
4042 end;
4043 end if;
4044
4045 <<Leave>>
4046 if Has_Aspects (N) then
4047 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4048 end if;
4049
4050 exception
4051 when Instantiation_Error =>
4052 if Parent_Installed then
4053 Remove_Parent;
4054 end if;
4055
4056 if Env_Installed then
4057 Restore_Env;
4058 end if;
4059
4060 Style_Check := Save_Style_Check;
4061 end Analyze_Package_Instantiation;
4062
4063 --------------------------
4064 -- Inline_Instance_Body --
4065 --------------------------
4066
4067 procedure Inline_Instance_Body
4068 (N : Node_Id;
4069 Gen_Unit : Entity_Id;
4070 Act_Decl : Node_Id)
4071 is
4072 Vis : Boolean;
4073 Gen_Comp : constant Entity_Id :=
4074 Cunit_Entity (Get_Source_Unit (Gen_Unit));
4075 Curr_Comp : constant Node_Id := Cunit (Current_Sem_Unit);
4076 Curr_Scope : Entity_Id := Empty;
4077 Curr_Unit : constant Entity_Id := Cunit_Entity (Current_Sem_Unit);
4078 Removed : Boolean := False;
4079 Num_Scopes : Int := 0;
4080
4081 Scope_Stack_Depth : constant Int :=
4082 Scope_Stack.Last - Scope_Stack.First + 1;
4083
4084 Use_Clauses : array (1 .. Scope_Stack_Depth) of Node_Id;
4085 Instances : array (1 .. Scope_Stack_Depth) of Entity_Id;
4086 Inner_Scopes : array (1 .. Scope_Stack_Depth) of Entity_Id;
4087 Num_Inner : Int := 0;
4088 N_Instances : Int := 0;
4089 S : Entity_Id;
4090
4091 begin
4092 -- Case of generic unit defined in another unit. We must remove the
4093 -- complete context of the current unit to install that of the generic.
4094
4095 if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
4096
4097 -- Add some comments for the following two loops ???
4098
4099 S := Current_Scope;
4100 while Present (S) and then S /= Standard_Standard loop
4101 loop
4102 Num_Scopes := Num_Scopes + 1;
4103
4104 Use_Clauses (Num_Scopes) :=
4105 (Scope_Stack.Table
4106 (Scope_Stack.Last - Num_Scopes + 1).
4107 First_Use_Clause);
4108 End_Use_Clauses (Use_Clauses (Num_Scopes));
4109
4110 exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
4111 or else Scope_Stack.Table
4112 (Scope_Stack.Last - Num_Scopes).Entity
4113 = Scope (S);
4114 end loop;
4115
4116 exit when Is_Generic_Instance (S)
4117 and then (In_Package_Body (S)
4118 or else Ekind (S) = E_Procedure
4119 or else Ekind (S) = E_Function);
4120 S := Scope (S);
4121 end loop;
4122
4123 Vis := Is_Immediately_Visible (Gen_Comp);
4124
4125 -- Find and save all enclosing instances
4126
4127 S := Current_Scope;
4128
4129 while Present (S)
4130 and then S /= Standard_Standard
4131 loop
4132 if Is_Generic_Instance (S) then
4133 N_Instances := N_Instances + 1;
4134 Instances (N_Instances) := S;
4135
4136 exit when In_Package_Body (S);
4137 end if;
4138
4139 S := Scope (S);
4140 end loop;
4141
4142 -- Remove context of current compilation unit, unless we are within a
4143 -- nested package instantiation, in which case the context has been
4144 -- removed previously.
4145
4146 -- If current scope is the body of a child unit, remove context of
4147 -- spec as well. If an enclosing scope is an instance body, the
4148 -- context has already been removed, but the entities in the body
4149 -- must be made invisible as well.
4150
4151 S := Current_Scope;
4152
4153 while Present (S)
4154 and then S /= Standard_Standard
4155 loop
4156 if Is_Generic_Instance (S)
4157 and then (In_Package_Body (S)
4158 or else Ekind (S) = E_Procedure
4159 or else Ekind (S) = E_Function)
4160 then
4161 -- We still have to remove the entities of the enclosing
4162 -- instance from direct visibility.
4163
4164 declare
4165 E : Entity_Id;
4166 begin
4167 E := First_Entity (S);
4168 while Present (E) loop
4169 Set_Is_Immediately_Visible (E, False);
4170 Next_Entity (E);
4171 end loop;
4172 end;
4173
4174 exit;
4175 end if;
4176
4177 if S = Curr_Unit
4178 or else (Ekind (Curr_Unit) = E_Package_Body
4179 and then S = Spec_Entity (Curr_Unit))
4180 or else (Ekind (Curr_Unit) = E_Subprogram_Body
4181 and then S =
4182 Corresponding_Spec
4183 (Unit_Declaration_Node (Curr_Unit)))
4184 then
4185 Removed := True;
4186
4187 -- Remove entities in current scopes from visibility, so that
4188 -- instance body is compiled in a clean environment.
4189
4190 Save_Scope_Stack (Handle_Use => False);
4191
4192 if Is_Child_Unit (S) then
4193
4194 -- Remove child unit from stack, as well as inner scopes.
4195 -- Removing the context of a child unit removes parent units
4196 -- as well.
4197
4198 while Current_Scope /= S loop
4199 Num_Inner := Num_Inner + 1;
4200 Inner_Scopes (Num_Inner) := Current_Scope;
4201 Pop_Scope;
4202 end loop;
4203
4204 Pop_Scope;
4205 Remove_Context (Curr_Comp);
4206 Curr_Scope := S;
4207
4208 else
4209 Remove_Context (Curr_Comp);
4210 end if;
4211
4212 if Ekind (Curr_Unit) = E_Package_Body then
4213 Remove_Context (Library_Unit (Curr_Comp));
4214 end if;
4215 end if;
4216
4217 S := Scope (S);
4218 end loop;
4219 pragma Assert (Num_Inner < Num_Scopes);
4220
4221 Push_Scope (Standard_Standard);
4222 Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4223 Instantiate_Package_Body
4224 (Body_Info =>
4225 ((Inst_Node => N,
4226 Act_Decl => Act_Decl,
4227 Expander_Status => Expander_Active,
4228 Current_Sem_Unit => Current_Sem_Unit,
4229 Scope_Suppress => Scope_Suppress,
4230 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4231 Version => Ada_Version)),
4232 Inlined_Body => True);
4233
4234 Pop_Scope;
4235
4236 -- Restore context
4237
4238 Set_Is_Immediately_Visible (Gen_Comp, Vis);
4239
4240 -- Reset Generic_Instance flag so that use clauses can be installed
4241 -- in the proper order. (See Use_One_Package for effect of enclosing
4242 -- instances on processing of use clauses).
4243
4244 for J in 1 .. N_Instances loop
4245 Set_Is_Generic_Instance (Instances (J), False);
4246 end loop;
4247
4248 if Removed then
4249 Install_Context (Curr_Comp);
4250
4251 if Present (Curr_Scope)
4252 and then Is_Child_Unit (Curr_Scope)
4253 then
4254 Push_Scope (Curr_Scope);
4255 Set_Is_Immediately_Visible (Curr_Scope);
4256
4257 -- Finally, restore inner scopes as well
4258
4259 for J in reverse 1 .. Num_Inner loop
4260 Push_Scope (Inner_Scopes (J));
4261 end loop;
4262 end if;
4263
4264 Restore_Scope_Stack (Handle_Use => False);
4265
4266 if Present (Curr_Scope)
4267 and then
4268 (In_Private_Part (Curr_Scope)
4269 or else In_Package_Body (Curr_Scope))
4270 then
4271 -- Install private declaration of ancestor units, which are
4272 -- currently available. Restore_Scope_Stack and Install_Context
4273 -- only install the visible part of parents.
4274
4275 declare
4276 Par : Entity_Id;
4277 begin
4278 Par := Scope (Curr_Scope);
4279 while (Present (Par))
4280 and then Par /= Standard_Standard
4281 loop
4282 Install_Private_Declarations (Par);
4283 Par := Scope (Par);
4284 end loop;
4285 end;
4286 end if;
4287 end if;
4288
4289 -- Restore use clauses. For a child unit, use clauses in the parents
4290 -- are restored when installing the context, so only those in inner
4291 -- scopes (and those local to the child unit itself) need to be
4292 -- installed explicitly.
4293
4294 if Is_Child_Unit (Curr_Unit)
4295 and then Removed
4296 then
4297 for J in reverse 1 .. Num_Inner + 1 loop
4298 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4299 Use_Clauses (J);
4300 Install_Use_Clauses (Use_Clauses (J));
4301 end loop;
4302
4303 else
4304 for J in reverse 1 .. Num_Scopes loop
4305 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4306 Use_Clauses (J);
4307 Install_Use_Clauses (Use_Clauses (J));
4308 end loop;
4309 end if;
4310
4311 -- Restore status of instances. If one of them is a body, make
4312 -- its local entities visible again.
4313
4314 declare
4315 E : Entity_Id;
4316 Inst : Entity_Id;
4317
4318 begin
4319 for J in 1 .. N_Instances loop
4320 Inst := Instances (J);
4321 Set_Is_Generic_Instance (Inst, True);
4322
4323 if In_Package_Body (Inst)
4324 or else Ekind (S) = E_Procedure
4325 or else Ekind (S) = E_Function
4326 then
4327 E := First_Entity (Instances (J));
4328 while Present (E) loop
4329 Set_Is_Immediately_Visible (E);
4330 Next_Entity (E);
4331 end loop;
4332 end if;
4333 end loop;
4334 end;
4335
4336 -- If generic unit is in current unit, current context is correct
4337
4338 else
4339 Instantiate_Package_Body
4340 (Body_Info =>
4341 ((Inst_Node => N,
4342 Act_Decl => Act_Decl,
4343 Expander_Status => Expander_Active,
4344 Current_Sem_Unit => Current_Sem_Unit,
4345 Scope_Suppress => Scope_Suppress,
4346 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4347 Version => Ada_Version)),
4348 Inlined_Body => True);
4349 end if;
4350 end Inline_Instance_Body;
4351
4352 -------------------------------------
4353 -- Analyze_Procedure_Instantiation --
4354 -------------------------------------
4355
4356 procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4357 begin
4358 Analyze_Subprogram_Instantiation (N, E_Procedure);
4359 end Analyze_Procedure_Instantiation;
4360
4361 -----------------------------------
4362 -- Need_Subprogram_Instance_Body --
4363 -----------------------------------
4364
4365 function Need_Subprogram_Instance_Body
4366 (N : Node_Id;
4367 Subp : Entity_Id) return Boolean
4368 is
4369 begin
4370 if (Is_In_Main_Unit (N)
4371 or else Is_Inlined (Subp)
4372 or else Is_Inlined (Alias (Subp)))
4373 and then (Operating_Mode = Generate_Code
4374 or else (Operating_Mode = Check_Semantics
4375 and then ASIS_Mode))
4376 and then (Full_Expander_Active or else ASIS_Mode)
4377 and then not ABE_Is_Certain (N)
4378 and then not Is_Eliminated (Subp)
4379 then
4380 Pending_Instantiations.Append
4381 ((Inst_Node => N,
4382 Act_Decl => Unit_Declaration_Node (Subp),
4383 Expander_Status => Expander_Active,
4384 Current_Sem_Unit => Current_Sem_Unit,
4385 Scope_Suppress => Scope_Suppress,
4386 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4387 Version => Ada_Version));
4388 return True;
4389
4390 else
4391 return False;
4392 end if;
4393 end Need_Subprogram_Instance_Body;
4394
4395 --------------------------------------
4396 -- Analyze_Subprogram_Instantiation --
4397 --------------------------------------
4398
4399 procedure Analyze_Subprogram_Instantiation
4400 (N : Node_Id;
4401 K : Entity_Kind)
4402 is
4403 Loc : constant Source_Ptr := Sloc (N);
4404 Gen_Id : constant Node_Id := Name (N);
4405
4406 Anon_Id : constant Entity_Id :=
4407 Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4408 Chars => New_External_Name
4409 (Chars (Defining_Entity (N)), 'R'));
4410
4411 Act_Decl_Id : Entity_Id;
4412 Act_Decl : Node_Id;
4413 Act_Spec : Node_Id;
4414 Act_Tree : Node_Id;
4415
4416 Env_Installed : Boolean := False;
4417 Gen_Unit : Entity_Id;
4418 Gen_Decl : Node_Id;
4419 Pack_Id : Entity_Id;
4420 Parent_Installed : Boolean := False;
4421 Renaming_List : List_Id;
4422
4423 procedure Analyze_Instance_And_Renamings;
4424 -- The instance must be analyzed in a context that includes the mappings
4425 -- of generic parameters into actuals. We create a package declaration
4426 -- for this purpose, and a subprogram with an internal name within the
4427 -- package. The subprogram instance is simply an alias for the internal
4428 -- subprogram, declared in the current scope.
4429
4430 ------------------------------------
4431 -- Analyze_Instance_And_Renamings --
4432 ------------------------------------
4433
4434 procedure Analyze_Instance_And_Renamings is
4435 Def_Ent : constant Entity_Id := Defining_Entity (N);
4436 Pack_Decl : Node_Id;
4437
4438 begin
4439 if Nkind (Parent (N)) = N_Compilation_Unit then
4440
4441 -- For the case of a compilation unit, the container package has
4442 -- the same name as the instantiation, to insure that the binder
4443 -- calls the elaboration procedure with the right name. Copy the
4444 -- entity of the instance, which may have compilation level flags
4445 -- (e.g. Is_Child_Unit) set.
4446
4447 Pack_Id := New_Copy (Def_Ent);
4448
4449 else
4450 -- Otherwise we use the name of the instantiation concatenated
4451 -- with its source position to ensure uniqueness if there are
4452 -- several instantiations with the same name.
4453
4454 Pack_Id :=
4455 Make_Defining_Identifier (Loc,
4456 Chars => New_External_Name
4457 (Related_Id => Chars (Def_Ent),
4458 Suffix => "GP",
4459 Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4460 end if;
4461
4462 Pack_Decl := Make_Package_Declaration (Loc,
4463 Specification => Make_Package_Specification (Loc,
4464 Defining_Unit_Name => Pack_Id,
4465 Visible_Declarations => Renaming_List,
4466 End_Label => Empty));
4467
4468 Set_Instance_Spec (N, Pack_Decl);
4469 Set_Is_Generic_Instance (Pack_Id);
4470 Set_Debug_Info_Needed (Pack_Id);
4471
4472 -- Case of not a compilation unit
4473
4474 if Nkind (Parent (N)) /= N_Compilation_Unit then
4475 Mark_Rewrite_Insertion (Pack_Decl);
4476 Insert_Before (N, Pack_Decl);
4477 Set_Has_Completion (Pack_Id);
4478
4479 -- Case of an instantiation that is a compilation unit
4480
4481 -- Place declaration on current node so context is complete for
4482 -- analysis (including nested instantiations), and for use in a
4483 -- context_clause (see Analyze_With_Clause).
4484
4485 else
4486 Set_Unit (Parent (N), Pack_Decl);
4487 Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4488 end if;
4489
4490 Analyze (Pack_Decl);
4491 Check_Formal_Packages (Pack_Id);
4492 Set_Is_Generic_Instance (Pack_Id, False);
4493
4494 -- Why do we clear Is_Generic_Instance??? We set it 20 lines
4495 -- above???
4496
4497 -- Body of the enclosing package is supplied when instantiating the
4498 -- subprogram body, after semantic analysis is completed.
4499
4500 if Nkind (Parent (N)) = N_Compilation_Unit then
4501
4502 -- Remove package itself from visibility, so it does not
4503 -- conflict with subprogram.
4504
4505 Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4506
4507 -- Set name and scope of internal subprogram so that the proper
4508 -- external name will be generated. The proper scope is the scope
4509 -- of the wrapper package. We need to generate debugging info for
4510 -- the internal subprogram, so set flag accordingly.
4511
4512 Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4513 Set_Scope (Anon_Id, Scope (Pack_Id));
4514
4515 -- Mark wrapper package as referenced, to avoid spurious warnings
4516 -- if the instantiation appears in various with_ clauses of
4517 -- subunits of the main unit.
4518
4519 Set_Referenced (Pack_Id);
4520 end if;
4521
4522 Set_Is_Generic_Instance (Anon_Id);
4523 Set_Debug_Info_Needed (Anon_Id);
4524 Act_Decl_Id := New_Copy (Anon_Id);
4525
4526 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4527 Set_Chars (Act_Decl_Id, Chars (Defining_Entity (N)));
4528 Set_Sloc (Act_Decl_Id, Sloc (Defining_Entity (N)));
4529 Set_Comes_From_Source (Act_Decl_Id, True);
4530
4531 -- The signature may involve types that are not frozen yet, but the
4532 -- subprogram will be frozen at the point the wrapper package is
4533 -- frozen, so it does not need its own freeze node. In fact, if one
4534 -- is created, it might conflict with the freezing actions from the
4535 -- wrapper package.
4536
4537 Set_Has_Delayed_Freeze (Anon_Id, False);
4538
4539 -- If the instance is a child unit, mark the Id accordingly. Mark
4540 -- the anonymous entity as well, which is the real subprogram and
4541 -- which is used when the instance appears in a context clause.
4542 -- Similarly, propagate the Is_Eliminated flag to handle properly
4543 -- nested eliminated subprograms.
4544
4545 Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
4546 Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
4547 New_Overloaded_Entity (Act_Decl_Id);
4548 Check_Eliminated (Act_Decl_Id);
4549 Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
4550
4551 -- In compilation unit case, kill elaboration checks on the
4552 -- instantiation, since they are never needed -- the body is
4553 -- instantiated at the same point as the spec.
4554
4555 if Nkind (Parent (N)) = N_Compilation_Unit then
4556 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4557 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4558 Set_Is_Compilation_Unit (Anon_Id);
4559
4560 Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
4561 end if;
4562
4563 -- The instance is not a freezing point for the new subprogram
4564
4565 Set_Is_Frozen (Act_Decl_Id, False);
4566
4567 if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
4568 Valid_Operator_Definition (Act_Decl_Id);
4569 end if;
4570
4571 Set_Alias (Act_Decl_Id, Anon_Id);
4572 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4573 Set_Has_Completion (Act_Decl_Id);
4574 Set_Related_Instance (Pack_Id, Act_Decl_Id);
4575
4576 if Nkind (Parent (N)) = N_Compilation_Unit then
4577 Set_Body_Required (Parent (N), False);
4578 end if;
4579 end Analyze_Instance_And_Renamings;
4580
4581 -- Local variables
4582
4583 Vis_Prims_List : Elist_Id := No_Elist;
4584 -- List of primitives made temporarily visible in the instantiation
4585 -- to match the visibility of the formal type
4586
4587 -- Start of processing for Analyze_Subprogram_Instantiation
4588
4589 begin
4590 Check_SPARK_Restriction ("generic is not allowed", N);
4591
4592 -- Very first thing: apply the special kludge for Text_IO processing
4593 -- in case we are instantiating one of the children of [Wide_]Text_IO.
4594 -- Of course such an instantiation is bogus (these are packages, not
4595 -- subprograms), but we get a better error message if we do this.
4596
4597 Text_IO_Kludge (Gen_Id);
4598
4599 -- Make node global for error reporting
4600
4601 Instantiation_Node := N;
4602
4603 -- For package instantiations we turn off style checks, because they
4604 -- will have been emitted in the generic. For subprogram instantiations
4605 -- we want to apply at least the check on overriding indicators so we
4606 -- do not modify the style check status.
4607
4608 -- The renaming declarations for the actuals do not come from source and
4609 -- will not generate spurious warnings.
4610
4611 Preanalyze_Actuals (N);
4612
4613 Init_Env;
4614 Env_Installed := True;
4615 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
4616 Gen_Unit := Entity (Gen_Id);
4617
4618 Generate_Reference (Gen_Unit, Gen_Id);
4619
4620 if Nkind (Gen_Id) = N_Identifier
4621 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
4622 then
4623 Error_Msg_NE
4624 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
4625 end if;
4626
4627 if Etype (Gen_Unit) = Any_Type then
4628 Restore_Env;
4629 return;
4630 end if;
4631
4632 -- Verify that it is a generic subprogram of the right kind, and that
4633 -- it does not lead to a circular instantiation.
4634
4635 if not Ekind_In (Gen_Unit, E_Generic_Procedure, E_Generic_Function) then
4636 Error_Msg_N ("expect generic subprogram in instantiation", Gen_Id);
4637
4638 elsif In_Open_Scopes (Gen_Unit) then
4639 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
4640
4641 elsif K = E_Procedure
4642 and then Ekind (Gen_Unit) /= E_Generic_Procedure
4643 then
4644 if Ekind (Gen_Unit) = E_Generic_Function then
4645 Error_Msg_N
4646 ("cannot instantiate generic function as procedure", Gen_Id);
4647 else
4648 Error_Msg_N
4649 ("expect name of generic procedure in instantiation", Gen_Id);
4650 end if;
4651
4652 elsif K = E_Function
4653 and then Ekind (Gen_Unit) /= E_Generic_Function
4654 then
4655 if Ekind (Gen_Unit) = E_Generic_Procedure then
4656 Error_Msg_N
4657 ("cannot instantiate generic procedure as function", Gen_Id);
4658 else
4659 Error_Msg_N
4660 ("expect name of generic function in instantiation", Gen_Id);
4661 end if;
4662
4663 else
4664 Set_Entity (Gen_Id, Gen_Unit);
4665 Set_Is_Instantiated (Gen_Unit);
4666
4667 if In_Extended_Main_Source_Unit (N) then
4668 Generate_Reference (Gen_Unit, N);
4669 end if;
4670
4671 -- If renaming, get original unit
4672
4673 if Present (Renamed_Object (Gen_Unit))
4674 and then (Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Procedure
4675 or else
4676 Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Function)
4677 then
4678 Gen_Unit := Renamed_Object (Gen_Unit);
4679 Set_Is_Instantiated (Gen_Unit);
4680 Generate_Reference (Gen_Unit, N);
4681 end if;
4682
4683 if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
4684 Error_Msg_Node_2 := Current_Scope;
4685 Error_Msg_NE
4686 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
4687 Circularity_Detected := True;
4688 Restore_Hidden_Primitives (Vis_Prims_List);
4689 goto Leave;
4690 end if;
4691
4692 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
4693
4694 -- Initialize renamings map, for error checking
4695
4696 Generic_Renamings.Set_Last (0);
4697 Generic_Renamings_HTable.Reset;
4698
4699 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
4700
4701 -- Copy original generic tree, to produce text for instantiation
4702
4703 Act_Tree :=
4704 Copy_Generic_Node
4705 (Original_Node (Gen_Decl), Empty, Instantiating => True);
4706
4707 -- Inherit overriding indicator from instance node
4708
4709 Act_Spec := Specification (Act_Tree);
4710 Set_Must_Override (Act_Spec, Must_Override (N));
4711 Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
4712
4713 Renaming_List :=
4714 Analyze_Associations
4715 (I_Node => N,
4716 Formals => Generic_Formal_Declarations (Act_Tree),
4717 F_Copy => Generic_Formal_Declarations (Gen_Decl));
4718
4719 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
4720
4721 -- The subprogram itself cannot contain a nested instance, so the
4722 -- current parent is left empty.
4723
4724 Set_Instance_Env (Gen_Unit, Empty);
4725
4726 -- Build the subprogram declaration, which does not appear in the
4727 -- generic template, and give it a sloc consistent with that of the
4728 -- template.
4729
4730 Set_Defining_Unit_Name (Act_Spec, Anon_Id);
4731 Set_Generic_Parent (Act_Spec, Gen_Unit);
4732 Act_Decl :=
4733 Make_Subprogram_Declaration (Sloc (Act_Spec),
4734 Specification => Act_Spec);
4735
4736 -- The aspects have been copied previously, but they have to be
4737 -- linked explicitly to the new subprogram declaration. Explicit
4738 -- pre/postconditions on the instance are analyzed below, in a
4739 -- separate step.
4740
4741 Move_Aspects (Act_Tree, Act_Decl);
4742 Set_Categorization_From_Pragmas (Act_Decl);
4743
4744 if Parent_Installed then
4745 Hide_Current_Scope;
4746 end if;
4747
4748 Append (Act_Decl, Renaming_List);
4749 Analyze_Instance_And_Renamings;
4750
4751 -- If the generic is marked Import (Intrinsic), then so is the
4752 -- instance. This indicates that there is no body to instantiate. If
4753 -- generic is marked inline, so it the instance, and the anonymous
4754 -- subprogram it renames. If inlined, or else if inlining is enabled
4755 -- for the compilation, we generate the instance body even if it is
4756 -- not within the main unit.
4757
4758 if Is_Intrinsic_Subprogram (Gen_Unit) then
4759 Set_Is_Intrinsic_Subprogram (Anon_Id);
4760 Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
4761
4762 if Chars (Gen_Unit) = Name_Unchecked_Conversion then
4763 Validate_Unchecked_Conversion (N, Act_Decl_Id);
4764 end if;
4765 end if;
4766
4767 -- Inherit convention from generic unit. Intrinsic convention, as for
4768 -- an instance of unchecked conversion, is not inherited because an
4769 -- explicit Ada instance has been created.
4770
4771 if Has_Convention_Pragma (Gen_Unit)
4772 and then Convention (Gen_Unit) /= Convention_Intrinsic
4773 then
4774 Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
4775 Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
4776 end if;
4777
4778 Generate_Definition (Act_Decl_Id);
4779 -- Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id)));
4780 -- ??? needed?
4781 Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
4782
4783 -- Inherit all inlining-related flags which apply to the generic in
4784 -- the subprogram and its declaration.
4785
4786 Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
4787 Set_Is_Inlined (Anon_Id, Is_Inlined (Gen_Unit));
4788
4789 Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
4790 Set_Has_Pragma_Inline (Anon_Id, Has_Pragma_Inline (Gen_Unit));
4791
4792 Set_Has_Pragma_Inline_Always
4793 (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
4794 Set_Has_Pragma_Inline_Always
4795 (Anon_Id, Has_Pragma_Inline_Always (Gen_Unit));
4796
4797 if not Is_Intrinsic_Subprogram (Gen_Unit) then
4798 Check_Elab_Instantiation (N);
4799 end if;
4800
4801 if Is_Dispatching_Operation (Act_Decl_Id)
4802 and then Ada_Version >= Ada_2005
4803 then
4804 declare
4805 Formal : Entity_Id;
4806
4807 begin
4808 Formal := First_Formal (Act_Decl_Id);
4809 while Present (Formal) loop
4810 if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
4811 and then Is_Controlling_Formal (Formal)
4812 and then not Can_Never_Be_Null (Formal)
4813 then
4814 Error_Msg_NE ("access parameter& is controlling,",
4815 N, Formal);
4816 Error_Msg_NE
4817 ("\corresponding parameter of & must be"
4818 & " explicitly null-excluding", N, Gen_Id);
4819 end if;
4820
4821 Next_Formal (Formal);
4822 end loop;
4823 end;
4824 end if;
4825
4826 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4827
4828 Validate_Categorization_Dependency (N, Act_Decl_Id);
4829
4830 if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
4831 Inherit_Context (Gen_Decl, N);
4832
4833 Restore_Private_Views (Pack_Id, False);
4834
4835 -- If the context requires a full instantiation, mark node for
4836 -- subsequent construction of the body.
4837
4838 if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
4839
4840 Check_Forward_Instantiation (Gen_Decl);
4841
4842 -- The wrapper package is always delayed, because it does not
4843 -- constitute a freeze point, but to insure that the freeze
4844 -- node is placed properly, it is created directly when
4845 -- instantiating the body (otherwise the freeze node might
4846 -- appear to early for nested instantiations).
4847
4848 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4849
4850 -- For ASIS purposes, indicate that the wrapper package has
4851 -- replaced the instantiation node.
4852
4853 Rewrite (N, Unit (Parent (N)));
4854 Set_Unit (Parent (N), N);
4855 end if;
4856
4857 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4858
4859 -- Replace instance node for library-level instantiations of
4860 -- intrinsic subprograms, for ASIS use.
4861
4862 Rewrite (N, Unit (Parent (N)));
4863 Set_Unit (Parent (N), N);
4864 end if;
4865
4866 if Parent_Installed then
4867 Remove_Parent;
4868 end if;
4869
4870 Restore_Hidden_Primitives (Vis_Prims_List);
4871 Restore_Env;
4872 Env_Installed := False;
4873 Generic_Renamings.Set_Last (0);
4874 Generic_Renamings_HTable.Reset;
4875 end if;
4876
4877 <<Leave>>
4878 if Has_Aspects (N) then
4879 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4880 end if;
4881
4882 exception
4883 when Instantiation_Error =>
4884 if Parent_Installed then
4885 Remove_Parent;
4886 end if;
4887
4888 if Env_Installed then
4889 Restore_Env;
4890 end if;
4891 end Analyze_Subprogram_Instantiation;
4892
4893 -------------------------
4894 -- Get_Associated_Node --
4895 -------------------------
4896
4897 function Get_Associated_Node (N : Node_Id) return Node_Id is
4898 Assoc : Node_Id;
4899
4900 begin
4901 Assoc := Associated_Node (N);
4902
4903 if Nkind (Assoc) /= Nkind (N) then
4904 return Assoc;
4905
4906 elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
4907 return Assoc;
4908
4909 else
4910 -- If the node is part of an inner generic, it may itself have been
4911 -- remapped into a further generic copy. Associated_Node is otherwise
4912 -- used for the entity of the node, and will be of a different node
4913 -- kind, or else N has been rewritten as a literal or function call.
4914
4915 while Present (Associated_Node (Assoc))
4916 and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
4917 loop
4918 Assoc := Associated_Node (Assoc);
4919 end loop;
4920
4921 -- Follow and additional link in case the final node was rewritten.
4922 -- This can only happen with nested generic units.
4923
4924 if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
4925 and then Present (Associated_Node (Assoc))
4926 and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
4927 N_Explicit_Dereference,
4928 N_Integer_Literal,
4929 N_Real_Literal,
4930 N_String_Literal))
4931 then
4932 Assoc := Associated_Node (Assoc);
4933 end if;
4934
4935 -- An additional special case: an unconstrained type in an object
4936 -- declaration may have been rewritten as a local subtype constrained
4937 -- by the expression in the declaration. We need to recover the
4938 -- original entity which may be global.
4939
4940 if Present (Original_Node (Assoc))
4941 and then Nkind (Parent (N)) = N_Object_Declaration
4942 then
4943 Assoc := Original_Node (Assoc);
4944 end if;
4945
4946 return Assoc;
4947 end if;
4948 end Get_Associated_Node;
4949
4950 -------------------------------------------
4951 -- Build_Instance_Compilation_Unit_Nodes --
4952 -------------------------------------------
4953
4954 procedure Build_Instance_Compilation_Unit_Nodes
4955 (N : Node_Id;
4956 Act_Body : Node_Id;
4957 Act_Decl : Node_Id)
4958 is
4959 Decl_Cunit : Node_Id;
4960 Body_Cunit : Node_Id;
4961 Citem : Node_Id;
4962 New_Main : constant Entity_Id := Defining_Entity (Act_Decl);
4963 Old_Main : constant Entity_Id := Cunit_Entity (Main_Unit);
4964
4965 begin
4966 -- A new compilation unit node is built for the instance declaration
4967
4968 Decl_Cunit :=
4969 Make_Compilation_Unit (Sloc (N),
4970 Context_Items => Empty_List,
4971 Unit => Act_Decl,
4972 Aux_Decls_Node => Make_Compilation_Unit_Aux (Sloc (N)));
4973
4974 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
4975
4976 -- The new compilation unit is linked to its body, but both share the
4977 -- same file, so we do not set Body_Required on the new unit so as not
4978 -- to create a spurious dependency on a non-existent body in the ali.
4979 -- This simplifies CodePeer unit traversal.
4980
4981 -- We use the original instantiation compilation unit as the resulting
4982 -- compilation unit of the instance, since this is the main unit.
4983
4984 Rewrite (N, Act_Body);
4985 Body_Cunit := Parent (N);
4986
4987 -- The two compilation unit nodes are linked by the Library_Unit field
4988
4989 Set_Library_Unit (Decl_Cunit, Body_Cunit);
4990 Set_Library_Unit (Body_Cunit, Decl_Cunit);
4991
4992 -- Preserve the private nature of the package if needed
4993
4994 Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
4995
4996 -- If the instance is not the main unit, its context, categorization
4997 -- and elaboration entity are not relevant to the compilation.
4998
4999 if Body_Cunit /= Cunit (Main_Unit) then
5000 Make_Instance_Unit (Body_Cunit, In_Main => False);
5001 return;
5002 end if;
5003
5004 -- The context clause items on the instantiation, which are now attached
5005 -- to the body compilation unit (since the body overwrote the original
5006 -- instantiation node), semantically belong on the spec, so copy them
5007 -- there. It's harmless to leave them on the body as well. In fact one
5008 -- could argue that they belong in both places.
5009
5010 Citem := First (Context_Items (Body_Cunit));
5011 while Present (Citem) loop
5012 Append (New_Copy (Citem), Context_Items (Decl_Cunit));
5013 Next (Citem);
5014 end loop;
5015
5016 -- Propagate categorization flags on packages, so that they appear in
5017 -- the ali file for the spec of the unit.
5018
5019 if Ekind (New_Main) = E_Package then
5020 Set_Is_Pure (Old_Main, Is_Pure (New_Main));
5021 Set_Is_Preelaborated (Old_Main, Is_Preelaborated (New_Main));
5022 Set_Is_Remote_Types (Old_Main, Is_Remote_Types (New_Main));
5023 Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
5024 Set_Is_Remote_Call_Interface
5025 (Old_Main, Is_Remote_Call_Interface (New_Main));
5026 end if;
5027
5028 -- Make entry in Units table, so that binder can generate call to
5029 -- elaboration procedure for body, if any.
5030
5031 Make_Instance_Unit (Body_Cunit, In_Main => True);
5032 Main_Unit_Entity := New_Main;
5033 Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
5034
5035 -- Build elaboration entity, since the instance may certainly generate
5036 -- elaboration code requiring a flag for protection.
5037
5038 Build_Elaboration_Entity (Decl_Cunit, New_Main);
5039 end Build_Instance_Compilation_Unit_Nodes;
5040
5041 -----------------------------
5042 -- Check_Access_Definition --
5043 -----------------------------
5044
5045 procedure Check_Access_Definition (N : Node_Id) is
5046 begin
5047 pragma Assert
5048 (Ada_Version >= Ada_2005 and then Present (Access_Definition (N)));
5049 null;
5050 end Check_Access_Definition;
5051
5052 -----------------------------------
5053 -- Check_Formal_Package_Instance --
5054 -----------------------------------
5055
5056 -- If the formal has specific parameters, they must match those of the
5057 -- actual. Both of them are instances, and the renaming declarations for
5058 -- their formal parameters appear in the same order in both. The analyzed
5059 -- formal has been analyzed in the context of the current instance.
5060
5061 procedure Check_Formal_Package_Instance
5062 (Formal_Pack : Entity_Id;
5063 Actual_Pack : Entity_Id)
5064 is
5065 E1 : Entity_Id := First_Entity (Actual_Pack);
5066 E2 : Entity_Id := First_Entity (Formal_Pack);
5067
5068 Expr1 : Node_Id;
5069 Expr2 : Node_Id;
5070
5071 procedure Check_Mismatch (B : Boolean);
5072 -- Common error routine for mismatch between the parameters of the
5073 -- actual instance and those of the formal package.
5074
5075 function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
5076 -- The formal may come from a nested formal package, and the actual may
5077 -- have been constant-folded. To determine whether the two denote the
5078 -- same entity we may have to traverse several definitions to recover
5079 -- the ultimate entity that they refer to.
5080
5081 function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
5082 -- Similarly, if the formal comes from a nested formal package, the
5083 -- actual may designate the formal through multiple renamings, which
5084 -- have to be followed to determine the original variable in question.
5085
5086 --------------------
5087 -- Check_Mismatch --
5088 --------------------
5089
5090 procedure Check_Mismatch (B : Boolean) is
5091 Kind : constant Node_Kind := Nkind (Parent (E2));
5092
5093 begin
5094 if Kind = N_Formal_Type_Declaration then
5095 return;
5096
5097 elsif Nkind_In (Kind, N_Formal_Object_Declaration,
5098 N_Formal_Package_Declaration)
5099 or else Kind in N_Formal_Subprogram_Declaration
5100 then
5101 null;
5102
5103 elsif B then
5104 Error_Msg_NE
5105 ("actual for & in actual instance does not match formal",
5106 Parent (Actual_Pack), E1);
5107 end if;
5108 end Check_Mismatch;
5109
5110 --------------------------------
5111 -- Same_Instantiated_Constant --
5112 --------------------------------
5113
5114 function Same_Instantiated_Constant
5115 (E1, E2 : Entity_Id) return Boolean
5116 is
5117 Ent : Entity_Id;
5118
5119 begin
5120 Ent := E2;
5121 while Present (Ent) loop
5122 if E1 = Ent then
5123 return True;
5124
5125 elsif Ekind (Ent) /= E_Constant then
5126 return False;
5127
5128 elsif Is_Entity_Name (Constant_Value (Ent)) then
5129 if Entity (Constant_Value (Ent)) = E1 then
5130 return True;
5131 else
5132 Ent := Entity (Constant_Value (Ent));
5133 end if;
5134
5135 -- The actual may be a constant that has been folded. Recover
5136 -- original name.
5137
5138 elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5139 Ent := Entity (Original_Node (Constant_Value (Ent)));
5140 else
5141 return False;
5142 end if;
5143 end loop;
5144
5145 return False;
5146 end Same_Instantiated_Constant;
5147
5148 --------------------------------
5149 -- Same_Instantiated_Variable --
5150 --------------------------------
5151
5152 function Same_Instantiated_Variable
5153 (E1, E2 : Entity_Id) return Boolean
5154 is
5155 function Original_Entity (E : Entity_Id) return Entity_Id;
5156 -- Follow chain of renamings to the ultimate ancestor
5157
5158 ---------------------
5159 -- Original_Entity --
5160 ---------------------
5161
5162 function Original_Entity (E : Entity_Id) return Entity_Id is
5163 Orig : Entity_Id;
5164
5165 begin
5166 Orig := E;
5167 while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5168 and then Present (Renamed_Object (Orig))
5169 and then Is_Entity_Name (Renamed_Object (Orig))
5170 loop
5171 Orig := Entity (Renamed_Object (Orig));
5172 end loop;
5173
5174 return Orig;
5175 end Original_Entity;
5176
5177 -- Start of processing for Same_Instantiated_Variable
5178
5179 begin
5180 return Ekind (E1) = Ekind (E2)
5181 and then Original_Entity (E1) = Original_Entity (E2);
5182 end Same_Instantiated_Variable;
5183
5184 -- Start of processing for Check_Formal_Package_Instance
5185
5186 begin
5187 while Present (E1)
5188 and then Present (E2)
5189 loop
5190 exit when Ekind (E1) = E_Package
5191 and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5192
5193 -- If the formal is the renaming of the formal package, this
5194 -- is the end of its formal part, which may occur before the
5195 -- end of the formal part in the actual in the presence of
5196 -- defaulted parameters in the formal package.
5197
5198 exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5199 and then Renamed_Entity (E2) = Scope (E2);
5200
5201 -- The analysis of the actual may generate additional internal
5202 -- entities. If the formal is defaulted, there is no corresponding
5203 -- analysis and the internal entities must be skipped, until we
5204 -- find corresponding entities again.
5205
5206 if Comes_From_Source (E2)
5207 and then not Comes_From_Source (E1)
5208 and then Chars (E1) /= Chars (E2)
5209 then
5210 while Present (E1)
5211 and then Chars (E1) /= Chars (E2)
5212 loop
5213 Next_Entity (E1);
5214 end loop;
5215 end if;
5216
5217 if No (E1) then
5218 return;
5219
5220 -- If the formal entity comes from a formal declaration, it was
5221 -- defaulted in the formal package, and no check is needed on it.
5222
5223 elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
5224 goto Next_E;
5225
5226 elsif Is_Type (E1) then
5227
5228 -- Subtypes must statically match. E1, E2 are the local entities
5229 -- that are subtypes of the actuals. Itypes generated for other
5230 -- parameters need not be checked, the check will be performed
5231 -- on the parameters themselves.
5232
5233 -- If E2 is a formal type declaration, it is a defaulted parameter
5234 -- and needs no checking.
5235
5236 if not Is_Itype (E1)
5237 and then not Is_Itype (E2)
5238 then
5239 Check_Mismatch
5240 (not Is_Type (E2)
5241 or else Etype (E1) /= Etype (E2)
5242 or else not Subtypes_Statically_Match (E1, E2));
5243 end if;
5244
5245 elsif Ekind (E1) = E_Constant then
5246
5247 -- IN parameters must denote the same static value, or the same
5248 -- constant, or the literal null.
5249
5250 Expr1 := Expression (Parent (E1));
5251
5252 if Ekind (E2) /= E_Constant then
5253 Check_Mismatch (True);
5254 goto Next_E;
5255 else
5256 Expr2 := Expression (Parent (E2));
5257 end if;
5258
5259 if Is_Static_Expression (Expr1) then
5260
5261 if not Is_Static_Expression (Expr2) then
5262 Check_Mismatch (True);
5263
5264 elsif Is_Discrete_Type (Etype (E1)) then
5265 declare
5266 V1 : constant Uint := Expr_Value (Expr1);
5267 V2 : constant Uint := Expr_Value (Expr2);
5268 begin
5269 Check_Mismatch (V1 /= V2);
5270 end;
5271
5272 elsif Is_Real_Type (Etype (E1)) then
5273 declare
5274 V1 : constant Ureal := Expr_Value_R (Expr1);
5275 V2 : constant Ureal := Expr_Value_R (Expr2);
5276 begin
5277 Check_Mismatch (V1 /= V2);
5278 end;
5279
5280 elsif Is_String_Type (Etype (E1))
5281 and then Nkind (Expr1) = N_String_Literal
5282 then
5283 if Nkind (Expr2) /= N_String_Literal then
5284 Check_Mismatch (True);
5285 else
5286 Check_Mismatch
5287 (not String_Equal (Strval (Expr1), Strval (Expr2)));
5288 end if;
5289 end if;
5290
5291 elsif Is_Entity_Name (Expr1) then
5292 if Is_Entity_Name (Expr2) then
5293 if Entity (Expr1) = Entity (Expr2) then
5294 null;
5295 else
5296 Check_Mismatch
5297 (not Same_Instantiated_Constant
5298 (Entity (Expr1), Entity (Expr2)));
5299 end if;
5300 else
5301 Check_Mismatch (True);
5302 end if;
5303
5304 elsif Is_Entity_Name (Original_Node (Expr1))
5305 and then Is_Entity_Name (Expr2)
5306 and then
5307 Same_Instantiated_Constant
5308 (Entity (Original_Node (Expr1)), Entity (Expr2))
5309 then
5310 null;
5311
5312 elsif Nkind (Expr1) = N_Null then
5313 Check_Mismatch (Nkind (Expr1) /= N_Null);
5314
5315 else
5316 Check_Mismatch (True);
5317 end if;
5318
5319 elsif Ekind (E1) = E_Variable then
5320 Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5321
5322 elsif Ekind (E1) = E_Package then
5323 Check_Mismatch
5324 (Ekind (E1) /= Ekind (E2)
5325 or else Renamed_Object (E1) /= Renamed_Object (E2));
5326
5327 elsif Is_Overloadable (E1) then
5328
5329 -- Verify that the actual subprograms match. Note that actuals
5330 -- that are attributes are rewritten as subprograms. If the
5331 -- subprogram in the formal package is defaulted, no check is
5332 -- needed. Note that this can only happen in Ada 2005 when the
5333 -- formal package can be partially parameterized.
5334
5335 if Nkind (Unit_Declaration_Node (E1)) =
5336 N_Subprogram_Renaming_Declaration
5337 and then From_Default (Unit_Declaration_Node (E1))
5338 then
5339 null;
5340
5341 -- If the formal package has an "others" box association that
5342 -- covers this formal, there is no need for a check either.
5343
5344 elsif Nkind (Unit_Declaration_Node (E2)) in
5345 N_Formal_Subprogram_Declaration
5346 and then Box_Present (Unit_Declaration_Node (E2))
5347 then
5348 null;
5349
5350 -- No check needed if subprogram is a defaulted null procedure
5351
5352 elsif No (Alias (E2))
5353 and then Ekind (E2) = E_Procedure
5354 and then
5355 Null_Present (Specification (Unit_Declaration_Node (E2)))
5356 then
5357 null;
5358
5359 -- Otherwise the actual in the formal and the actual in the
5360 -- instantiation of the formal must match, up to renamings.
5361
5362 else
5363 Check_Mismatch
5364 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5365 end if;
5366
5367 else
5368 raise Program_Error;
5369 end if;
5370
5371 <<Next_E>>
5372 Next_Entity (E1);
5373 Next_Entity (E2);
5374 end loop;
5375 end Check_Formal_Package_Instance;
5376
5377 ---------------------------
5378 -- Check_Formal_Packages --
5379 ---------------------------
5380
5381 procedure Check_Formal_Packages (P_Id : Entity_Id) is
5382 E : Entity_Id;
5383 Formal_P : Entity_Id;
5384
5385 begin
5386 -- Iterate through the declarations in the instance, looking for package
5387 -- renaming declarations that denote instances of formal packages. Stop
5388 -- when we find the renaming of the current package itself. The
5389 -- declaration for a formal package without a box is followed by an
5390 -- internal entity that repeats the instantiation.
5391
5392 E := First_Entity (P_Id);
5393 while Present (E) loop
5394 if Ekind (E) = E_Package then
5395 if Renamed_Object (E) = P_Id then
5396 exit;
5397
5398 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5399 null;
5400
5401 elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5402 Formal_P := Next_Entity (E);
5403 Check_Formal_Package_Instance (Formal_P, E);
5404
5405 -- After checking, remove the internal validating package. It
5406 -- is only needed for semantic checks, and as it may contain
5407 -- generic formal declarations it should not reach gigi.
5408
5409 Remove (Unit_Declaration_Node (Formal_P));
5410 end if;
5411 end if;
5412
5413 Next_Entity (E);
5414 end loop;
5415 end Check_Formal_Packages;
5416
5417 ---------------------------------
5418 -- Check_Forward_Instantiation --
5419 ---------------------------------
5420
5421 procedure Check_Forward_Instantiation (Decl : Node_Id) is
5422 S : Entity_Id;
5423 Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5424
5425 begin
5426 -- The instantiation appears before the generic body if we are in the
5427 -- scope of the unit containing the generic, either in its spec or in
5428 -- the package body, and before the generic body.
5429
5430 if Ekind (Gen_Comp) = E_Package_Body then
5431 Gen_Comp := Spec_Entity (Gen_Comp);
5432 end if;
5433
5434 if In_Open_Scopes (Gen_Comp)
5435 and then No (Corresponding_Body (Decl))
5436 then
5437 S := Current_Scope;
5438
5439 while Present (S)
5440 and then not Is_Compilation_Unit (S)
5441 and then not Is_Child_Unit (S)
5442 loop
5443 if Ekind (S) = E_Package then
5444 Set_Has_Forward_Instantiation (S);
5445 end if;
5446
5447 S := Scope (S);
5448 end loop;
5449 end if;
5450 end Check_Forward_Instantiation;
5451
5452 ---------------------------
5453 -- Check_Generic_Actuals --
5454 ---------------------------
5455
5456 -- The visibility of the actuals may be different between the point of
5457 -- generic instantiation and the instantiation of the body.
5458
5459 procedure Check_Generic_Actuals
5460 (Instance : Entity_Id;
5461 Is_Formal_Box : Boolean)
5462 is
5463 E : Entity_Id;
5464 Astype : Entity_Id;
5465
5466 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5467 -- For a formal that is an array type, the component type is often a
5468 -- previous formal in the same unit. The privacy status of the component
5469 -- type will have been examined earlier in the traversal of the
5470 -- corresponding actuals, and this status should not be modified for
5471 -- the array (sub)type itself. However, if the base type of the array
5472 -- (sub)type is private, its full view must be restored in the body to
5473 -- be consistent with subsequent index subtypes, etc.
5474 --
5475 -- To detect this case we have to rescan the list of formals, which is
5476 -- usually short enough to ignore the resulting inefficiency.
5477
5478 -----------------------------
5479 -- Denotes_Previous_Actual --
5480 -----------------------------
5481
5482 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5483 Prev : Entity_Id;
5484
5485 begin
5486 Prev := First_Entity (Instance);
5487 while Present (Prev) loop
5488 if Is_Type (Prev)
5489 and then Nkind (Parent (Prev)) = N_Subtype_Declaration
5490 and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
5491 and then Entity (Subtype_Indication (Parent (Prev))) = Typ
5492 then
5493 return True;
5494
5495 elsif Prev = E then
5496 return False;
5497
5498 else
5499 Next_Entity (Prev);
5500 end if;
5501 end loop;
5502
5503 return False;
5504 end Denotes_Previous_Actual;
5505
5506 -- Start of processing for Check_Generic_Actuals
5507
5508 begin
5509 E := First_Entity (Instance);
5510 while Present (E) loop
5511 if Is_Type (E)
5512 and then Nkind (Parent (E)) = N_Subtype_Declaration
5513 and then Scope (Etype (E)) /= Instance
5514 and then Is_Entity_Name (Subtype_Indication (Parent (E)))
5515 then
5516 if Is_Array_Type (E)
5517 and then not Is_Private_Type (Etype (E))
5518 and then Denotes_Previous_Actual (Component_Type (E))
5519 then
5520 null;
5521 else
5522 Check_Private_View (Subtype_Indication (Parent (E)));
5523 end if;
5524
5525 Set_Is_Generic_Actual_Type (E, True);
5526 Set_Is_Hidden (E, False);
5527 Set_Is_Potentially_Use_Visible (E,
5528 In_Use (Instance));
5529
5530 -- We constructed the generic actual type as a subtype of the
5531 -- supplied type. This means that it normally would not inherit
5532 -- subtype specific attributes of the actual, which is wrong for
5533 -- the generic case.
5534
5535 Astype := Ancestor_Subtype (E);
5536
5537 if No (Astype) then
5538
5539 -- This can happen when E is an itype that is the full view of
5540 -- a private type completed, e.g. with a constrained array. In
5541 -- that case, use the first subtype, which will carry size
5542 -- information. The base type itself is unconstrained and will
5543 -- not carry it.
5544
5545 Astype := First_Subtype (E);
5546 end if;
5547
5548 Set_Size_Info (E, (Astype));
5549 Set_RM_Size (E, RM_Size (Astype));
5550 Set_First_Rep_Item (E, First_Rep_Item (Astype));
5551
5552 if Is_Discrete_Or_Fixed_Point_Type (E) then
5553 Set_RM_Size (E, RM_Size (Astype));
5554
5555 -- In nested instances, the base type of an access actual may
5556 -- itself be private, and need to be exchanged.
5557
5558 elsif Is_Access_Type (E)
5559 and then Is_Private_Type (Etype (E))
5560 then
5561 Check_Private_View
5562 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
5563 end if;
5564
5565 elsif Ekind (E) = E_Package then
5566
5567 -- If this is the renaming for the current instance, we're done.
5568 -- Otherwise it is a formal package. If the corresponding formal
5569 -- was declared with a box, the (instantiations of the) generic
5570 -- formal part are also visible. Otherwise, ignore the entity
5571 -- created to validate the actuals.
5572
5573 if Renamed_Object (E) = Instance then
5574 exit;
5575
5576 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5577 null;
5578
5579 -- The visibility of a formal of an enclosing generic is already
5580 -- correct.
5581
5582 elsif Denotes_Formal_Package (E) then
5583 null;
5584
5585 elsif Present (Associated_Formal_Package (E))
5586 and then not Is_Generic_Formal (E)
5587 then
5588 if Box_Present (Parent (Associated_Formal_Package (E))) then
5589 Check_Generic_Actuals (Renamed_Object (E), True);
5590
5591 else
5592 Check_Generic_Actuals (Renamed_Object (E), False);
5593 end if;
5594
5595 Set_Is_Hidden (E, False);
5596 end if;
5597
5598 -- If this is a subprogram instance (in a wrapper package) the
5599 -- actual is fully visible.
5600
5601 elsif Is_Wrapper_Package (Instance) then
5602 Set_Is_Hidden (E, False);
5603
5604 -- If the formal package is declared with a box, or if the formal
5605 -- parameter is defaulted, it is visible in the body.
5606
5607 elsif Is_Formal_Box
5608 or else Is_Visible_Formal (E)
5609 then
5610 Set_Is_Hidden (E, False);
5611 end if;
5612
5613 if Ekind (E) = E_Constant then
5614
5615 -- If the type of the actual is a private type declared in the
5616 -- enclosing scope of the generic unit, the body of the generic
5617 -- sees the full view of the type (because it has to appear in
5618 -- the corresponding package body). If the type is private now,
5619 -- exchange views to restore the proper visiblity in the instance.
5620
5621 declare
5622 Typ : constant Entity_Id := Base_Type (Etype (E));
5623 -- The type of the actual
5624
5625 Gen_Id : Entity_Id;
5626 -- The generic unit
5627
5628 Parent_Scope : Entity_Id;
5629 -- The enclosing scope of the generic unit
5630
5631 begin
5632 if Is_Wrapper_Package (Instance) then
5633 Gen_Id :=
5634 Generic_Parent
5635 (Specification
5636 (Unit_Declaration_Node
5637 (Related_Instance (Instance))));
5638 else
5639 Gen_Id :=
5640 Generic_Parent
5641 (Specification (Unit_Declaration_Node (Instance)));
5642 end if;
5643
5644 Parent_Scope := Scope (Gen_Id);
5645
5646 -- The exchange is only needed if the generic is defined
5647 -- within a package which is not a common ancestor of the
5648 -- scope of the instance, and is not already in scope.
5649
5650 if Is_Private_Type (Typ)
5651 and then Scope (Typ) = Parent_Scope
5652 and then Scope (Instance) /= Parent_Scope
5653 and then Ekind (Parent_Scope) = E_Package
5654 and then not Is_Child_Unit (Gen_Id)
5655 then
5656 Switch_View (Typ);
5657
5658 -- If the type of the entity is a subtype, it may also have
5659 -- to be made visible, together with the base type of its
5660 -- full view, after exchange.
5661
5662 if Is_Private_Type (Etype (E)) then
5663 Switch_View (Etype (E));
5664 Switch_View (Base_Type (Etype (E)));
5665 end if;
5666 end if;
5667 end;
5668 end if;
5669
5670 Next_Entity (E);
5671 end loop;
5672 end Check_Generic_Actuals;
5673
5674 ------------------------------
5675 -- Check_Generic_Child_Unit --
5676 ------------------------------
5677
5678 procedure Check_Generic_Child_Unit
5679 (Gen_Id : Node_Id;
5680 Parent_Installed : in out Boolean)
5681 is
5682 Loc : constant Source_Ptr := Sloc (Gen_Id);
5683 Gen_Par : Entity_Id := Empty;
5684 E : Entity_Id;
5685 Inst_Par : Entity_Id;
5686 S : Node_Id;
5687
5688 function Find_Generic_Child
5689 (Scop : Entity_Id;
5690 Id : Node_Id) return Entity_Id;
5691 -- Search generic parent for possible child unit with the given name
5692
5693 function In_Enclosing_Instance return Boolean;
5694 -- Within an instance of the parent, the child unit may be denoted by
5695 -- a simple name, or an abbreviated expanded name. Examine enclosing
5696 -- scopes to locate a possible parent instantiation.
5697
5698 ------------------------
5699 -- Find_Generic_Child --
5700 ------------------------
5701
5702 function Find_Generic_Child
5703 (Scop : Entity_Id;
5704 Id : Node_Id) return Entity_Id
5705 is
5706 E : Entity_Id;
5707
5708 begin
5709 -- If entity of name is already set, instance has already been
5710 -- resolved, e.g. in an enclosing instantiation.
5711
5712 if Present (Entity (Id)) then
5713 if Scope (Entity (Id)) = Scop then
5714 return Entity (Id);
5715 else
5716 return Empty;
5717 end if;
5718
5719 else
5720 E := First_Entity (Scop);
5721 while Present (E) loop
5722 if Chars (E) = Chars (Id)
5723 and then Is_Child_Unit (E)
5724 then
5725 if Is_Child_Unit (E)
5726 and then not Is_Visible_Lib_Unit (E)
5727 then
5728 Error_Msg_NE
5729 ("generic child unit& is not visible", Gen_Id, E);
5730 end if;
5731
5732 Set_Entity (Id, E);
5733 return E;
5734 end if;
5735
5736 Next_Entity (E);
5737 end loop;
5738
5739 return Empty;
5740 end if;
5741 end Find_Generic_Child;
5742
5743 ---------------------------
5744 -- In_Enclosing_Instance --
5745 ---------------------------
5746
5747 function In_Enclosing_Instance return Boolean is
5748 Enclosing_Instance : Node_Id;
5749 Instance_Decl : Node_Id;
5750
5751 begin
5752 -- We do not inline any call that contains instantiations, except
5753 -- for instantiations of Unchecked_Conversion, so if we are within
5754 -- an inlined body the current instance does not require parents.
5755
5756 if In_Inlined_Body then
5757 pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
5758 return False;
5759 end if;
5760
5761 -- Loop to check enclosing scopes
5762
5763 Enclosing_Instance := Current_Scope;
5764 while Present (Enclosing_Instance) loop
5765 Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
5766
5767 if Ekind (Enclosing_Instance) = E_Package
5768 and then Is_Generic_Instance (Enclosing_Instance)
5769 and then Present
5770 (Generic_Parent (Specification (Instance_Decl)))
5771 then
5772 -- Check whether the generic we are looking for is a child of
5773 -- this instance.
5774
5775 E := Find_Generic_Child
5776 (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
5777 exit when Present (E);
5778
5779 else
5780 E := Empty;
5781 end if;
5782
5783 Enclosing_Instance := Scope (Enclosing_Instance);
5784 end loop;
5785
5786 if No (E) then
5787
5788 -- Not a child unit
5789
5790 Analyze (Gen_Id);
5791 return False;
5792
5793 else
5794 Rewrite (Gen_Id,
5795 Make_Expanded_Name (Loc,
5796 Chars => Chars (E),
5797 Prefix => New_Occurrence_Of (Enclosing_Instance, Loc),
5798 Selector_Name => New_Occurrence_Of (E, Loc)));
5799
5800 Set_Entity (Gen_Id, E);
5801 Set_Etype (Gen_Id, Etype (E));
5802 Parent_Installed := False; -- Already in scope.
5803 return True;
5804 end if;
5805 end In_Enclosing_Instance;
5806
5807 -- Start of processing for Check_Generic_Child_Unit
5808
5809 begin
5810 -- If the name of the generic is given by a selected component, it may
5811 -- be the name of a generic child unit, and the prefix is the name of an
5812 -- instance of the parent, in which case the child unit must be visible.
5813 -- If this instance is not in scope, it must be placed there and removed
5814 -- after instantiation, because what is being instantiated is not the
5815 -- original child, but the corresponding child present in the instance
5816 -- of the parent.
5817
5818 -- If the child is instantiated within the parent, it can be given by
5819 -- a simple name. In this case the instance is already in scope, but
5820 -- the child generic must be recovered from the generic parent as well.
5821
5822 if Nkind (Gen_Id) = N_Selected_Component then
5823 S := Selector_Name (Gen_Id);
5824 Analyze (Prefix (Gen_Id));
5825 Inst_Par := Entity (Prefix (Gen_Id));
5826
5827 if Ekind (Inst_Par) = E_Package
5828 and then Present (Renamed_Object (Inst_Par))
5829 then
5830 Inst_Par := Renamed_Object (Inst_Par);
5831 end if;
5832
5833 if Ekind (Inst_Par) = E_Package then
5834 if Nkind (Parent (Inst_Par)) = N_Package_Specification then
5835 Gen_Par := Generic_Parent (Parent (Inst_Par));
5836
5837 elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
5838 and then
5839 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
5840 then
5841 Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
5842 end if;
5843
5844 elsif Ekind (Inst_Par) = E_Generic_Package
5845 and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
5846 then
5847 -- A formal package may be a real child package, and not the
5848 -- implicit instance within a parent. In this case the child is
5849 -- not visible and has to be retrieved explicitly as well.
5850
5851 Gen_Par := Inst_Par;
5852 end if;
5853
5854 if Present (Gen_Par) then
5855
5856 -- The prefix denotes an instantiation. The entity itself may be a
5857 -- nested generic, or a child unit.
5858
5859 E := Find_Generic_Child (Gen_Par, S);
5860
5861 if Present (E) then
5862 Change_Selected_Component_To_Expanded_Name (Gen_Id);
5863 Set_Entity (Gen_Id, E);
5864 Set_Etype (Gen_Id, Etype (E));
5865 Set_Entity (S, E);
5866 Set_Etype (S, Etype (E));
5867
5868 -- Indicate that this is a reference to the parent
5869
5870 if In_Extended_Main_Source_Unit (Gen_Id) then
5871 Set_Is_Instantiated (Inst_Par);
5872 end if;
5873
5874 -- A common mistake is to replicate the naming scheme of a
5875 -- hierarchy by instantiating a generic child directly, rather
5876 -- than the implicit child in a parent instance:
5877
5878 -- generic .. package Gpar is ..
5879 -- generic .. package Gpar.Child is ..
5880 -- package Par is new Gpar ();
5881
5882 -- with Gpar.Child;
5883 -- package Par.Child is new Gpar.Child ();
5884 -- rather than Par.Child
5885
5886 -- In this case the instantiation is within Par, which is an
5887 -- instance, but Gpar does not denote Par because we are not IN
5888 -- the instance of Gpar, so this is illegal. The test below
5889 -- recognizes this particular case.
5890
5891 if Is_Child_Unit (E)
5892 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
5893 and then (not In_Instance
5894 or else Nkind (Parent (Parent (Gen_Id))) =
5895 N_Compilation_Unit)
5896 then
5897 Error_Msg_N
5898 ("prefix of generic child unit must be instance of parent",
5899 Gen_Id);
5900 end if;
5901
5902 if not In_Open_Scopes (Inst_Par)
5903 and then Nkind (Parent (Gen_Id)) not in
5904 N_Generic_Renaming_Declaration
5905 then
5906 Install_Parent (Inst_Par);
5907 Parent_Installed := True;
5908
5909 elsif In_Open_Scopes (Inst_Par) then
5910
5911 -- If the parent is already installed, install the actuals
5912 -- for its formal packages. This is necessary when the child
5913 -- instance is a child of the parent instance: in this case,
5914 -- the parent is placed on the scope stack but the formal
5915 -- packages are not made visible.
5916
5917 Install_Formal_Packages (Inst_Par);
5918 end if;
5919
5920 else
5921 -- If the generic parent does not contain an entity that
5922 -- corresponds to the selector, the instance doesn't either.
5923 -- Analyzing the node will yield the appropriate error message.
5924 -- If the entity is not a child unit, then it is an inner
5925 -- generic in the parent.
5926
5927 Analyze (Gen_Id);
5928 end if;
5929
5930 else
5931 Analyze (Gen_Id);
5932
5933 if Is_Child_Unit (Entity (Gen_Id))
5934 and then
5935 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
5936 and then not In_Open_Scopes (Inst_Par)
5937 then
5938 Install_Parent (Inst_Par);
5939 Parent_Installed := True;
5940
5941 -- The generic unit may be the renaming of the implicit child
5942 -- present in an instance. In that case the parent instance is
5943 -- obtained from the name of the renamed entity.
5944
5945 elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
5946 and then Present (Renamed_Entity (Entity (Gen_Id)))
5947 and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
5948 then
5949 declare
5950 Renamed_Package : constant Node_Id :=
5951 Name (Parent (Entity (Gen_Id)));
5952 begin
5953 if Nkind (Renamed_Package) = N_Expanded_Name then
5954 Inst_Par := Entity (Prefix (Renamed_Package));
5955 Install_Parent (Inst_Par);
5956 Parent_Installed := True;
5957 end if;
5958 end;
5959 end if;
5960 end if;
5961
5962 elsif Nkind (Gen_Id) = N_Expanded_Name then
5963
5964 -- Entity already present, analyze prefix, whose meaning may be
5965 -- an instance in the current context. If it is an instance of
5966 -- a relative within another, the proper parent may still have
5967 -- to be installed, if they are not of the same generation.
5968
5969 Analyze (Prefix (Gen_Id));
5970
5971 -- In the unlikely case that a local declaration hides the name
5972 -- of the parent package, locate it on the homonym chain. If the
5973 -- context is an instance of the parent, the renaming entity is
5974 -- flagged as such.
5975
5976 Inst_Par := Entity (Prefix (Gen_Id));
5977 while Present (Inst_Par)
5978 and then not Is_Package_Or_Generic_Package (Inst_Par)
5979 loop
5980 Inst_Par := Homonym (Inst_Par);
5981 end loop;
5982
5983 pragma Assert (Present (Inst_Par));
5984 Set_Entity (Prefix (Gen_Id), Inst_Par);
5985
5986 if In_Enclosing_Instance then
5987 null;
5988
5989 elsif Present (Entity (Gen_Id))
5990 and then Is_Child_Unit (Entity (Gen_Id))
5991 and then not In_Open_Scopes (Inst_Par)
5992 then
5993 Install_Parent (Inst_Par);
5994 Parent_Installed := True;
5995 end if;
5996
5997 elsif In_Enclosing_Instance then
5998
5999 -- The child unit is found in some enclosing scope
6000
6001 null;
6002
6003 else
6004 Analyze (Gen_Id);
6005
6006 -- If this is the renaming of the implicit child in a parent
6007 -- instance, recover the parent name and install it.
6008
6009 if Is_Entity_Name (Gen_Id) then
6010 E := Entity (Gen_Id);
6011
6012 if Is_Generic_Unit (E)
6013 and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
6014 and then Is_Child_Unit (Renamed_Object (E))
6015 and then Is_Generic_Unit (Scope (Renamed_Object (E)))
6016 and then Nkind (Name (Parent (E))) = N_Expanded_Name
6017 then
6018 Rewrite (Gen_Id,
6019 New_Copy_Tree (Name (Parent (E))));
6020 Inst_Par := Entity (Prefix (Gen_Id));
6021
6022 if not In_Open_Scopes (Inst_Par) then
6023 Install_Parent (Inst_Par);
6024 Parent_Installed := True;
6025 end if;
6026
6027 -- If it is a child unit of a non-generic parent, it may be
6028 -- use-visible and given by a direct name. Install parent as
6029 -- for other cases.
6030
6031 elsif Is_Generic_Unit (E)
6032 and then Is_Child_Unit (E)
6033 and then
6034 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6035 and then not Is_Generic_Unit (Scope (E))
6036 then
6037 if not In_Open_Scopes (Scope (E)) then
6038 Install_Parent (Scope (E));
6039 Parent_Installed := True;
6040 end if;
6041 end if;
6042 end if;
6043 end if;
6044 end Check_Generic_Child_Unit;
6045
6046 -----------------------------
6047 -- Check_Hidden_Child_Unit --
6048 -----------------------------
6049
6050 procedure Check_Hidden_Child_Unit
6051 (N : Node_Id;
6052 Gen_Unit : Entity_Id;
6053 Act_Decl_Id : Entity_Id)
6054 is
6055 Gen_Id : constant Node_Id := Name (N);
6056
6057 begin
6058 if Is_Child_Unit (Gen_Unit)
6059 and then Is_Child_Unit (Act_Decl_Id)
6060 and then Nkind (Gen_Id) = N_Expanded_Name
6061 and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
6062 and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
6063 then
6064 Error_Msg_Node_2 := Scope (Act_Decl_Id);
6065 Error_Msg_NE
6066 ("generic unit & is implicitly declared in &",
6067 Defining_Unit_Name (N), Gen_Unit);
6068 Error_Msg_N ("\instance must have different name",
6069 Defining_Unit_Name (N));
6070 end if;
6071 end Check_Hidden_Child_Unit;
6072
6073 ------------------------
6074 -- Check_Private_View --
6075 ------------------------
6076
6077 procedure Check_Private_View (N : Node_Id) is
6078 T : constant Entity_Id := Etype (N);
6079 BT : Entity_Id;
6080
6081 begin
6082 -- Exchange views if the type was not private in the generic but is
6083 -- private at the point of instantiation. Do not exchange views if
6084 -- the scope of the type is in scope. This can happen if both generic
6085 -- and instance are sibling units, or if type is defined in a parent.
6086 -- In this case the visibility of the type will be correct for all
6087 -- semantic checks.
6088
6089 if Present (T) then
6090 BT := Base_Type (T);
6091
6092 if Is_Private_Type (T)
6093 and then not Has_Private_View (N)
6094 and then Present (Full_View (T))
6095 and then not In_Open_Scopes (Scope (T))
6096 then
6097 -- In the generic, the full type was visible. Save the private
6098 -- entity, for subsequent exchange.
6099
6100 Switch_View (T);
6101
6102 elsif Has_Private_View (N)
6103 and then not Is_Private_Type (T)
6104 and then not Has_Been_Exchanged (T)
6105 and then Etype (Get_Associated_Node (N)) /= T
6106 then
6107 -- Only the private declaration was visible in the generic. If
6108 -- the type appears in a subtype declaration, the subtype in the
6109 -- instance must have a view compatible with that of its parent,
6110 -- which must be exchanged (see corresponding code in Restore_
6111 -- Private_Views). Otherwise, if the type is defined in a parent
6112 -- unit, leave full visibility within instance, which is safe.
6113
6114 if In_Open_Scopes (Scope (Base_Type (T)))
6115 and then not Is_Private_Type (Base_Type (T))
6116 and then Comes_From_Source (Base_Type (T))
6117 then
6118 null;
6119
6120 elsif Nkind (Parent (N)) = N_Subtype_Declaration
6121 or else not In_Private_Part (Scope (Base_Type (T)))
6122 then
6123 Prepend_Elmt (T, Exchanged_Views);
6124 Exchange_Declarations (Etype (Get_Associated_Node (N)));
6125 end if;
6126
6127 -- For composite types with inconsistent representation exchange
6128 -- component types accordingly.
6129
6130 elsif Is_Access_Type (T)
6131 and then Is_Private_Type (Designated_Type (T))
6132 and then not Has_Private_View (N)
6133 and then Present (Full_View (Designated_Type (T)))
6134 then
6135 Switch_View (Designated_Type (T));
6136
6137 elsif Is_Array_Type (T) then
6138 if Is_Private_Type (Component_Type (T))
6139 and then not Has_Private_View (N)
6140 and then Present (Full_View (Component_Type (T)))
6141 then
6142 Switch_View (Component_Type (T));
6143 end if;
6144
6145 -- The normal exchange mechanism relies on the setting of a
6146 -- flag on the reference in the generic. However, an additional
6147 -- mechanism is needed for types that are not explicitly
6148 -- mentioned in the generic, but may be needed in expanded code
6149 -- in the instance. This includes component types of arrays and
6150 -- designated types of access types. This processing must also
6151 -- include the index types of arrays which we take care of here.
6152
6153 declare
6154 Indx : Node_Id;
6155 Typ : Entity_Id;
6156
6157 begin
6158 Indx := First_Index (T);
6159 while Present (Indx) loop
6160 Typ := Base_Type (Etype (Indx));
6161
6162 if Is_Private_Type (Typ)
6163 and then Present (Full_View (Typ))
6164 then
6165 Switch_View (Typ);
6166 end if;
6167
6168 Next_Index (Indx);
6169 end loop;
6170 end;
6171
6172 elsif Is_Private_Type (T)
6173 and then Present (Full_View (T))
6174 and then Is_Array_Type (Full_View (T))
6175 and then Is_Private_Type (Component_Type (Full_View (T)))
6176 then
6177 Switch_View (T);
6178
6179 -- Finally, a non-private subtype may have a private base type, which
6180 -- must be exchanged for consistency. This can happen when a package
6181 -- body is instantiated, when the scope stack is empty but in fact
6182 -- the subtype and the base type are declared in an enclosing scope.
6183
6184 -- Note that in this case we introduce an inconsistency in the view
6185 -- set, because we switch the base type BT, but there could be some
6186 -- private dependent subtypes of BT which remain unswitched. Such
6187 -- subtypes might need to be switched at a later point (see specific
6188 -- provision for that case in Switch_View).
6189
6190 elsif not Is_Private_Type (T)
6191 and then not Has_Private_View (N)
6192 and then Is_Private_Type (BT)
6193 and then Present (Full_View (BT))
6194 and then not Is_Generic_Type (BT)
6195 and then not In_Open_Scopes (BT)
6196 then
6197 Prepend_Elmt (Full_View (BT), Exchanged_Views);
6198 Exchange_Declarations (BT);
6199 end if;
6200 end if;
6201 end Check_Private_View;
6202
6203 -----------------------------
6204 -- Check_Hidden_Primitives --
6205 -----------------------------
6206
6207 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6208 Actual : Node_Id;
6209 Gen_T : Entity_Id;
6210 Result : Elist_Id := No_Elist;
6211
6212 begin
6213 if No (Assoc_List) then
6214 return No_Elist;
6215 end if;
6216
6217 -- Traverse the list of associations between formals and actuals
6218 -- searching for renamings of tagged types
6219
6220 Actual := First (Assoc_List);
6221 while Present (Actual) loop
6222 if Nkind (Actual) = N_Subtype_Declaration then
6223 Gen_T := Generic_Parent_Type (Actual);
6224
6225 if Present (Gen_T)
6226 and then Is_Tagged_Type (Gen_T)
6227 then
6228 -- Traverse the list of primitives of the actual types
6229 -- searching for hidden primitives that are visible in the
6230 -- corresponding generic formal; leave them visible and
6231 -- append them to Result to restore their decoration later.
6232
6233 Install_Hidden_Primitives
6234 (Prims_List => Result,
6235 Gen_T => Gen_T,
6236 Act_T => Entity (Subtype_Indication (Actual)));
6237 end if;
6238 end if;
6239
6240 Next (Actual);
6241 end loop;
6242
6243 return Result;
6244 end Check_Hidden_Primitives;
6245
6246 --------------------------
6247 -- Contains_Instance_Of --
6248 --------------------------
6249
6250 function Contains_Instance_Of
6251 (Inner : Entity_Id;
6252 Outer : Entity_Id;
6253 N : Node_Id) return Boolean
6254 is
6255 Elmt : Elmt_Id;
6256 Scop : Entity_Id;
6257
6258 begin
6259 Scop := Outer;
6260
6261 -- Verify that there are no circular instantiations. We check whether
6262 -- the unit contains an instance of the current scope or some enclosing
6263 -- scope (in case one of the instances appears in a subunit). Longer
6264 -- circularities involving subunits might seem too pathological to
6265 -- consider, but they were not too pathological for the authors of
6266 -- DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6267 -- enclosing generic scopes as containing an instance.
6268
6269 loop
6270 -- Within a generic subprogram body, the scope is not generic, to
6271 -- allow for recursive subprograms. Use the declaration to determine
6272 -- whether this is a generic unit.
6273
6274 if Ekind (Scop) = E_Generic_Package
6275 or else (Is_Subprogram (Scop)
6276 and then Nkind (Unit_Declaration_Node (Scop)) =
6277 N_Generic_Subprogram_Declaration)
6278 then
6279 Elmt := First_Elmt (Inner_Instances (Inner));
6280
6281 while Present (Elmt) loop
6282 if Node (Elmt) = Scop then
6283 Error_Msg_Node_2 := Inner;
6284 Error_Msg_NE
6285 ("circular Instantiation: & instantiated within &!",
6286 N, Scop);
6287 return True;
6288
6289 elsif Node (Elmt) = Inner then
6290 return True;
6291
6292 elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6293 Error_Msg_Node_2 := Inner;
6294 Error_Msg_NE
6295 ("circular Instantiation: & instantiated within &!",
6296 N, Node (Elmt));
6297 return True;
6298 end if;
6299
6300 Next_Elmt (Elmt);
6301 end loop;
6302
6303 -- Indicate that Inner is being instantiated within Scop
6304
6305 Append_Elmt (Inner, Inner_Instances (Scop));
6306 end if;
6307
6308 if Scop = Standard_Standard then
6309 exit;
6310 else
6311 Scop := Scope (Scop);
6312 end if;
6313 end loop;
6314
6315 return False;
6316 end Contains_Instance_Of;
6317
6318 -----------------------
6319 -- Copy_Generic_Node --
6320 -----------------------
6321
6322 function Copy_Generic_Node
6323 (N : Node_Id;
6324 Parent_Id : Node_Id;
6325 Instantiating : Boolean) return Node_Id
6326 is
6327 Ent : Entity_Id;
6328 New_N : Node_Id;
6329
6330 function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6331 -- Check the given value of one of the Fields referenced by the current
6332 -- node to determine whether to copy it recursively. The field may hold
6333 -- a Node_Id, a List_Id, or an Elist_Id, or a plain value (Sloc, Uint,
6334 -- Char) in which case it need not be copied.
6335
6336 procedure Copy_Descendants;
6337 -- Common utility for various nodes
6338
6339 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6340 -- Make copy of element list
6341
6342 function Copy_Generic_List
6343 (L : List_Id;
6344 Parent_Id : Node_Id) return List_Id;
6345 -- Apply Copy_Node recursively to the members of a node list
6346
6347 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6348 -- True if an identifier is part of the defining program unit name of
6349 -- a child unit. The entity of such an identifier must be kept (for
6350 -- ASIS use) even though as the name of an enclosing generic it would
6351 -- otherwise not be preserved in the generic tree.
6352
6353 ----------------------
6354 -- Copy_Descendants --
6355 ----------------------
6356
6357 procedure Copy_Descendants is
6358
6359 use Atree.Unchecked_Access;
6360 -- This code section is part of the implementation of an untyped
6361 -- tree traversal, so it needs direct access to node fields.
6362
6363 begin
6364 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6365 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6366 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6367 Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6368 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6369 end Copy_Descendants;
6370
6371 -----------------------------
6372 -- Copy_Generic_Descendant --
6373 -----------------------------
6374
6375 function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6376 begin
6377 if D = Union_Id (Empty) then
6378 return D;
6379
6380 elsif D in Node_Range then
6381 return Union_Id
6382 (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6383
6384 elsif D in List_Range then
6385 return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6386
6387 elsif D in Elist_Range then
6388 return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6389
6390 -- Nothing else is copyable (e.g. Uint values), return as is
6391
6392 else
6393 return D;
6394 end if;
6395 end Copy_Generic_Descendant;
6396
6397 ------------------------
6398 -- Copy_Generic_Elist --
6399 ------------------------
6400
6401 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6402 M : Elmt_Id;
6403 L : Elist_Id;
6404
6405 begin
6406 if Present (E) then
6407 L := New_Elmt_List;
6408 M := First_Elmt (E);
6409 while Present (M) loop
6410 Append_Elmt
6411 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6412 Next_Elmt (M);
6413 end loop;
6414
6415 return L;
6416
6417 else
6418 return No_Elist;
6419 end if;
6420 end Copy_Generic_Elist;
6421
6422 -----------------------
6423 -- Copy_Generic_List --
6424 -----------------------
6425
6426 function Copy_Generic_List
6427 (L : List_Id;
6428 Parent_Id : Node_Id) return List_Id
6429 is
6430 N : Node_Id;
6431 New_L : List_Id;
6432
6433 begin
6434 if Present (L) then
6435 New_L := New_List;
6436 Set_Parent (New_L, Parent_Id);
6437
6438 N := First (L);
6439 while Present (N) loop
6440 Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6441 Next (N);
6442 end loop;
6443
6444 return New_L;
6445
6446 else
6447 return No_List;
6448 end if;
6449 end Copy_Generic_List;
6450
6451 ---------------------------
6452 -- In_Defining_Unit_Name --
6453 ---------------------------
6454
6455 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6456 begin
6457 return Present (Parent (Nam))
6458 and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6459 or else
6460 (Nkind (Parent (Nam)) = N_Expanded_Name
6461 and then In_Defining_Unit_Name (Parent (Nam))));
6462 end In_Defining_Unit_Name;
6463
6464 -- Start of processing for Copy_Generic_Node
6465
6466 begin
6467 if N = Empty then
6468 return N;
6469 end if;
6470
6471 New_N := New_Copy (N);
6472
6473 -- Copy aspects if present
6474
6475 if Has_Aspects (N) then
6476 Set_Has_Aspects (New_N, False);
6477 Set_Aspect_Specifications
6478 (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6479 end if;
6480
6481 if Instantiating then
6482 Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6483 end if;
6484
6485 if not Is_List_Member (N) then
6486 Set_Parent (New_N, Parent_Id);
6487 end if;
6488
6489 -- If defining identifier, then all fields have been copied already
6490
6491 if Nkind (New_N) in N_Entity then
6492 null;
6493
6494 -- Special casing for identifiers and other entity names and operators
6495
6496 elsif Nkind_In (New_N, N_Identifier,
6497 N_Character_Literal,
6498 N_Expanded_Name,
6499 N_Operator_Symbol)
6500 or else Nkind (New_N) in N_Op
6501 then
6502 if not Instantiating then
6503
6504 -- Link both nodes in order to assign subsequently the entity of
6505 -- the copy to the original node, in case this is a global
6506 -- reference.
6507
6508 Set_Associated_Node (N, New_N);
6509
6510 -- If we are within an instantiation, this is a nested generic
6511 -- that has already been analyzed at the point of definition.
6512 -- We must preserve references that were global to the enclosing
6513 -- parent at that point. Other occurrences, whether global or
6514 -- local to the current generic, must be resolved anew, so we
6515 -- reset the entity in the generic copy. A global reference has a
6516 -- smaller depth than the parent, or else the same depth in case
6517 -- both are distinct compilation units.
6518
6519 -- A child unit is implicitly declared within the enclosing parent
6520 -- but is in fact global to it, and must be preserved.
6521
6522 -- It is also possible for Current_Instantiated_Parent to be
6523 -- defined, and for this not to be a nested generic, namely if
6524 -- the unit is loaded through Rtsfind. In that case, the entity of
6525 -- New_N is only a link to the associated node, and not a defining
6526 -- occurrence.
6527
6528 -- The entities for parent units in the defining_program_unit of a
6529 -- generic child unit are established when the context of the unit
6530 -- is first analyzed, before the generic copy is made. They are
6531 -- preserved in the copy for use in ASIS queries.
6532
6533 Ent := Entity (New_N);
6534
6535 if No (Current_Instantiated_Parent.Gen_Id) then
6536 if No (Ent)
6537 or else Nkind (Ent) /= N_Defining_Identifier
6538 or else not In_Defining_Unit_Name (N)
6539 then
6540 Set_Associated_Node (New_N, Empty);
6541 end if;
6542
6543 elsif No (Ent)
6544 or else
6545 not Nkind_In (Ent, N_Defining_Identifier,
6546 N_Defining_Character_Literal,
6547 N_Defining_Operator_Symbol)
6548 or else No (Scope (Ent))
6549 or else
6550 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
6551 and then not Is_Child_Unit (Ent))
6552 or else
6553 (Scope_Depth (Scope (Ent)) >
6554 Scope_Depth (Current_Instantiated_Parent.Gen_Id)
6555 and then
6556 Get_Source_Unit (Ent) =
6557 Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
6558 then
6559 Set_Associated_Node (New_N, Empty);
6560 end if;
6561
6562 -- Case of instantiating identifier or some other name or operator
6563
6564 else
6565 -- If the associated node is still defined, the entity in it
6566 -- is global, and must be copied to the instance. If this copy
6567 -- is being made for a body to inline, it is applied to an
6568 -- instantiated tree, and the entity is already present and
6569 -- must be also preserved.
6570
6571 declare
6572 Assoc : constant Node_Id := Get_Associated_Node (N);
6573
6574 begin
6575 if Present (Assoc) then
6576 if Nkind (Assoc) = Nkind (N) then
6577 Set_Entity (New_N, Entity (Assoc));
6578 Check_Private_View (N);
6579
6580 elsif Nkind (Assoc) = N_Function_Call then
6581 Set_Entity (New_N, Entity (Name (Assoc)));
6582
6583 elsif Nkind_In (Assoc, N_Defining_Identifier,
6584 N_Defining_Character_Literal,
6585 N_Defining_Operator_Symbol)
6586 and then Expander_Active
6587 then
6588 -- Inlining case: we are copying a tree that contains
6589 -- global entities, which are preserved in the copy to be
6590 -- used for subsequent inlining.
6591
6592 null;
6593
6594 else
6595 Set_Entity (New_N, Empty);
6596 end if;
6597 end if;
6598 end;
6599 end if;
6600
6601 -- For expanded name, we must copy the Prefix and Selector_Name
6602
6603 if Nkind (N) = N_Expanded_Name then
6604 Set_Prefix
6605 (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
6606
6607 Set_Selector_Name (New_N,
6608 Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
6609
6610 -- For operators, we must copy the right operand
6611
6612 elsif Nkind (N) in N_Op then
6613 Set_Right_Opnd (New_N,
6614 Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
6615
6616 -- And for binary operators, the left operand as well
6617
6618 if Nkind (N) in N_Binary_Op then
6619 Set_Left_Opnd (New_N,
6620 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
6621 end if;
6622 end if;
6623
6624 -- Special casing for stubs
6625
6626 elsif Nkind (N) in N_Body_Stub then
6627
6628 -- In any case, we must copy the specification or defining
6629 -- identifier as appropriate.
6630
6631 if Nkind (N) = N_Subprogram_Body_Stub then
6632 Set_Specification (New_N,
6633 Copy_Generic_Node (Specification (N), New_N, Instantiating));
6634
6635 else
6636 Set_Defining_Identifier (New_N,
6637 Copy_Generic_Node
6638 (Defining_Identifier (N), New_N, Instantiating));
6639 end if;
6640
6641 -- If we are not instantiating, then this is where we load and
6642 -- analyze subunits, i.e. at the point where the stub occurs. A
6643 -- more permissive system might defer this analysis to the point
6644 -- of instantiation, but this seems too complicated for now.
6645
6646 if not Instantiating then
6647 declare
6648 Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
6649 Subunit : Node_Id;
6650 Unum : Unit_Number_Type;
6651 New_Body : Node_Id;
6652
6653 begin
6654 -- Make sure that, if it is a subunit of the main unit that is
6655 -- preprocessed and if -gnateG is specified, the preprocessed
6656 -- file will be written.
6657
6658 Lib.Analysing_Subunit_Of_Main :=
6659 Lib.In_Extended_Main_Source_Unit (N);
6660 Unum :=
6661 Load_Unit
6662 (Load_Name => Subunit_Name,
6663 Required => False,
6664 Subunit => True,
6665 Error_Node => N);
6666 Lib.Analysing_Subunit_Of_Main := False;
6667
6668 -- If the proper body is not found, a warning message will be
6669 -- emitted when analyzing the stub, or later at the point of
6670 -- instantiation. Here we just leave the stub as is.
6671
6672 if Unum = No_Unit then
6673 Subunits_Missing := True;
6674 goto Subunit_Not_Found;
6675 end if;
6676
6677 Subunit := Cunit (Unum);
6678
6679 if Nkind (Unit (Subunit)) /= N_Subunit then
6680 Error_Msg_N
6681 ("found child unit instead of expected SEPARATE subunit",
6682 Subunit);
6683 Error_Msg_Sloc := Sloc (N);
6684 Error_Msg_N ("\to complete stub #", Subunit);
6685 goto Subunit_Not_Found;
6686 end if;
6687
6688 -- We must create a generic copy of the subunit, in order to
6689 -- perform semantic analysis on it, and we must replace the
6690 -- stub in the original generic unit with the subunit, in order
6691 -- to preserve non-local references within.
6692
6693 -- Only the proper body needs to be copied. Library_Unit and
6694 -- context clause are simply inherited by the generic copy.
6695 -- Note that the copy (which may be recursive if there are
6696 -- nested subunits) must be done first, before attaching it to
6697 -- the enclosing generic.
6698
6699 New_Body :=
6700 Copy_Generic_Node
6701 (Proper_Body (Unit (Subunit)),
6702 Empty, Instantiating => False);
6703
6704 -- Now place the original proper body in the original generic
6705 -- unit. This is a body, not a compilation unit.
6706
6707 Rewrite (N, Proper_Body (Unit (Subunit)));
6708 Set_Is_Compilation_Unit (Defining_Entity (N), False);
6709 Set_Was_Originally_Stub (N);
6710
6711 -- Finally replace the body of the subunit with its copy, and
6712 -- make this new subunit into the library unit of the generic
6713 -- copy, which does not have stubs any longer.
6714
6715 Set_Proper_Body (Unit (Subunit), New_Body);
6716 Set_Library_Unit (New_N, Subunit);
6717 Inherit_Context (Unit (Subunit), N);
6718 end;
6719
6720 -- If we are instantiating, this must be an error case, since
6721 -- otherwise we would have replaced the stub node by the proper body
6722 -- that corresponds. So just ignore it in the copy (i.e. we have
6723 -- copied it, and that is good enough).
6724
6725 else
6726 null;
6727 end if;
6728
6729 <<Subunit_Not_Found>> null;
6730
6731 -- If the node is a compilation unit, it is the subunit of a stub, which
6732 -- has been loaded already (see code below). In this case, the library
6733 -- unit field of N points to the parent unit (which is a compilation
6734 -- unit) and need not (and cannot!) be copied.
6735
6736 -- When the proper body of the stub is analyzed, the library_unit link
6737 -- is used to establish the proper context (see sem_ch10).
6738
6739 -- The other fields of a compilation unit are copied as usual
6740
6741 elsif Nkind (N) = N_Compilation_Unit then
6742
6743 -- This code can only be executed when not instantiating, because in
6744 -- the copy made for an instantiation, the compilation unit node has
6745 -- disappeared at the point that a stub is replaced by its proper
6746 -- body.
6747
6748 pragma Assert (not Instantiating);
6749
6750 Set_Context_Items (New_N,
6751 Copy_Generic_List (Context_Items (N), New_N));
6752
6753 Set_Unit (New_N,
6754 Copy_Generic_Node (Unit (N), New_N, False));
6755
6756 Set_First_Inlined_Subprogram (New_N,
6757 Copy_Generic_Node
6758 (First_Inlined_Subprogram (N), New_N, False));
6759
6760 Set_Aux_Decls_Node (New_N,
6761 Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
6762
6763 -- For an assignment node, the assignment is known to be semantically
6764 -- legal if we are instantiating the template. This avoids incorrect
6765 -- diagnostics in generated code.
6766
6767 elsif Nkind (N) = N_Assignment_Statement then
6768
6769 -- Copy name and expression fields in usual manner
6770
6771 Set_Name (New_N,
6772 Copy_Generic_Node (Name (N), New_N, Instantiating));
6773
6774 Set_Expression (New_N,
6775 Copy_Generic_Node (Expression (N), New_N, Instantiating));
6776
6777 if Instantiating then
6778 Set_Assignment_OK (Name (New_N), True);
6779 end if;
6780
6781 elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
6782 if not Instantiating then
6783 Set_Associated_Node (N, New_N);
6784
6785 else
6786 if Present (Get_Associated_Node (N))
6787 and then Nkind (Get_Associated_Node (N)) = Nkind (N)
6788 then
6789 -- In the generic the aggregate has some composite type. If at
6790 -- the point of instantiation the type has a private view,
6791 -- install the full view (and that of its ancestors, if any).
6792
6793 declare
6794 T : Entity_Id := (Etype (Get_Associated_Node (New_N)));
6795 Rt : Entity_Id;
6796
6797 begin
6798 if Present (T)
6799 and then Is_Private_Type (T)
6800 then
6801 Switch_View (T);
6802 end if;
6803
6804 if Present (T)
6805 and then Is_Tagged_Type (T)
6806 and then Is_Derived_Type (T)
6807 then
6808 Rt := Root_Type (T);
6809
6810 loop
6811 T := Etype (T);
6812
6813 if Is_Private_Type (T) then
6814 Switch_View (T);
6815 end if;
6816
6817 exit when T = Rt;
6818 end loop;
6819 end if;
6820 end;
6821 end if;
6822 end if;
6823
6824 -- Do not copy the associated node, which points to the generic copy
6825 -- of the aggregate.
6826
6827 declare
6828 use Atree.Unchecked_Access;
6829 -- This code section is part of the implementation of an untyped
6830 -- tree traversal, so it needs direct access to node fields.
6831
6832 begin
6833 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6834 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6835 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6836 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6837 end;
6838
6839 -- Allocators do not have an identifier denoting the access type, so we
6840 -- must locate it through the expression to check whether the views are
6841 -- consistent.
6842
6843 elsif Nkind (N) = N_Allocator
6844 and then Nkind (Expression (N)) = N_Qualified_Expression
6845 and then Is_Entity_Name (Subtype_Mark (Expression (N)))
6846 and then Instantiating
6847 then
6848 declare
6849 T : constant Node_Id :=
6850 Get_Associated_Node (Subtype_Mark (Expression (N)));
6851 Acc_T : Entity_Id;
6852
6853 begin
6854 if Present (T) then
6855
6856 -- Retrieve the allocator node in the generic copy
6857
6858 Acc_T := Etype (Parent (Parent (T)));
6859 if Present (Acc_T)
6860 and then Is_Private_Type (Acc_T)
6861 then
6862 Switch_View (Acc_T);
6863 end if;
6864 end if;
6865
6866 Copy_Descendants;
6867 end;
6868
6869 -- For a proper body, we must catch the case of a proper body that
6870 -- replaces a stub. This represents the point at which a separate
6871 -- compilation unit, and hence template file, may be referenced, so we
6872 -- must make a new source instantiation entry for the template of the
6873 -- subunit, and ensure that all nodes in the subunit are adjusted using
6874 -- this new source instantiation entry.
6875
6876 elsif Nkind (N) in N_Proper_Body then
6877 declare
6878 Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
6879
6880 begin
6881 if Instantiating and then Was_Originally_Stub (N) then
6882 Create_Instantiation_Source
6883 (Instantiation_Node,
6884 Defining_Entity (N),
6885 False,
6886 S_Adjustment);
6887 end if;
6888
6889 -- Now copy the fields of the proper body, using the new
6890 -- adjustment factor if one was needed as per test above.
6891
6892 Copy_Descendants;
6893
6894 -- Restore the original adjustment factor in case changed
6895
6896 S_Adjustment := Save_Adjustment;
6897 end;
6898
6899 -- Don't copy Ident or Comment pragmas, since the comment belongs to the
6900 -- generic unit, not to the instantiating unit.
6901
6902 elsif Nkind (N) = N_Pragma and then Instantiating then
6903 declare
6904 Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
6905 begin
6906 if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
6907 New_N := Make_Null_Statement (Sloc (N));
6908 else
6909 Copy_Descendants;
6910 end if;
6911 end;
6912
6913 elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
6914
6915 -- No descendant fields need traversing
6916
6917 null;
6918
6919 elsif Nkind (N) = N_String_Literal
6920 and then Present (Etype (N))
6921 and then Instantiating
6922 then
6923 -- If the string is declared in an outer scope, the string_literal
6924 -- subtype created for it may have the wrong scope. We force the
6925 -- reanalysis of the constant to generate a new itype in the proper
6926 -- context.
6927
6928 Set_Etype (New_N, Empty);
6929 Set_Analyzed (New_N, False);
6930
6931 -- For the remaining nodes, copy their descendants recursively
6932
6933 else
6934 Copy_Descendants;
6935
6936 if Instantiating and then Nkind (N) = N_Subprogram_Body then
6937 Set_Generic_Parent (Specification (New_N), N);
6938
6939 -- Should preserve Corresponding_Spec??? (12.3(14))
6940 end if;
6941 end if;
6942
6943 return New_N;
6944 end Copy_Generic_Node;
6945
6946 ----------------------------
6947 -- Denotes_Formal_Package --
6948 ----------------------------
6949
6950 function Denotes_Formal_Package
6951 (Pack : Entity_Id;
6952 On_Exit : Boolean := False;
6953 Instance : Entity_Id := Empty) return Boolean
6954 is
6955 Par : Entity_Id;
6956 Scop : constant Entity_Id := Scope (Pack);
6957 E : Entity_Id;
6958
6959 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
6960 -- The package in question may be an actual for a previous formal
6961 -- package P of the current instance, so examine its actuals as well.
6962 -- This must be recursive over other formal packages.
6963
6964 ----------------------------------
6965 -- Is_Actual_Of_Previous_Formal --
6966 ----------------------------------
6967
6968 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
6969 E1 : Entity_Id;
6970
6971 begin
6972 E1 := First_Entity (P);
6973 while Present (E1) and then E1 /= Instance loop
6974 if Ekind (E1) = E_Package
6975 and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
6976 then
6977 if Renamed_Object (E1) = Pack then
6978 return True;
6979
6980 elsif E1 = P or else Renamed_Object (E1) = P then
6981 return False;
6982
6983 elsif Is_Actual_Of_Previous_Formal (E1) then
6984 return True;
6985 end if;
6986 end if;
6987
6988 Next_Entity (E1);
6989 end loop;
6990
6991 return False;
6992 end Is_Actual_Of_Previous_Formal;
6993
6994 -- Start of processing for Denotes_Formal_Package
6995
6996 begin
6997 if On_Exit then
6998 Par :=
6999 Instance_Envs.Table
7000 (Instance_Envs.Last).Instantiated_Parent.Act_Id;
7001 else
7002 Par := Current_Instantiated_Parent.Act_Id;
7003 end if;
7004
7005 if Ekind (Scop) = E_Generic_Package
7006 or else Nkind (Unit_Declaration_Node (Scop)) =
7007 N_Generic_Subprogram_Declaration
7008 then
7009 return True;
7010
7011 elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
7012 N_Formal_Package_Declaration
7013 then
7014 return True;
7015
7016 elsif No (Par) then
7017 return False;
7018
7019 else
7020 -- Check whether this package is associated with a formal package of
7021 -- the enclosing instantiation. Iterate over the list of renamings.
7022
7023 E := First_Entity (Par);
7024 while Present (E) loop
7025 if Ekind (E) /= E_Package
7026 or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
7027 then
7028 null;
7029
7030 elsif Renamed_Object (E) = Par then
7031 return False;
7032
7033 elsif Renamed_Object (E) = Pack then
7034 return True;
7035
7036 elsif Is_Actual_Of_Previous_Formal (E) then
7037 return True;
7038
7039 end if;
7040
7041 Next_Entity (E);
7042 end loop;
7043
7044 return False;
7045 end if;
7046 end Denotes_Formal_Package;
7047
7048 -----------------
7049 -- End_Generic --
7050 -----------------
7051
7052 procedure End_Generic is
7053 begin
7054 -- ??? More things could be factored out in this routine. Should
7055 -- probably be done at a later stage.
7056
7057 Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
7058 Generic_Flags.Decrement_Last;
7059
7060 Expander_Mode_Restore;
7061 end End_Generic;
7062
7063 -------------
7064 -- Earlier --
7065 -------------
7066
7067 function Earlier (N1, N2 : Node_Id) return Boolean is
7068 procedure Find_Depth (P : in out Node_Id; D : in out Integer);
7069 -- Find distance from given node to enclosing compilation unit
7070
7071 ----------------
7072 -- Find_Depth --
7073 ----------------
7074
7075 procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
7076 begin
7077 while Present (P)
7078 and then Nkind (P) /= N_Compilation_Unit
7079 loop
7080 P := True_Parent (P);
7081 D := D + 1;
7082 end loop;
7083 end Find_Depth;
7084
7085 -- Local declarations
7086
7087 D1 : Integer := 0;
7088 D2 : Integer := 0;
7089 P1 : Node_Id := N1;
7090 P2 : Node_Id := N2;
7091 T1 : Source_Ptr;
7092 T2 : Source_Ptr;
7093
7094 -- Start of processing for Earlier
7095
7096 begin
7097 Find_Depth (P1, D1);
7098 Find_Depth (P2, D2);
7099
7100 if P1 /= P2 then
7101 return False;
7102 else
7103 P1 := N1;
7104 P2 := N2;
7105 end if;
7106
7107 while D1 > D2 loop
7108 P1 := True_Parent (P1);
7109 D1 := D1 - 1;
7110 end loop;
7111
7112 while D2 > D1 loop
7113 P2 := True_Parent (P2);
7114 D2 := D2 - 1;
7115 end loop;
7116
7117 -- At this point P1 and P2 are at the same distance from the root.
7118 -- We examine their parents until we find a common declarative list.
7119 -- If we reach the root, N1 and N2 do not descend from the same
7120 -- declarative list (e.g. one is nested in the declarative part and
7121 -- the other is in a block in the statement part) and the earlier
7122 -- one is already frozen.
7123
7124 while not Is_List_Member (P1)
7125 or else not Is_List_Member (P2)
7126 or else List_Containing (P1) /= List_Containing (P2)
7127 loop
7128 P1 := True_Parent (P1);
7129 P2 := True_Parent (P2);
7130
7131 if Nkind (Parent (P1)) = N_Subunit then
7132 P1 := Corresponding_Stub (Parent (P1));
7133 end if;
7134
7135 if Nkind (Parent (P2)) = N_Subunit then
7136 P2 := Corresponding_Stub (Parent (P2));
7137 end if;
7138
7139 if P1 = P2 then
7140 return False;
7141 end if;
7142 end loop;
7143
7144 -- Expanded code usually shares the source location of the original
7145 -- construct it was generated for. This however may not necessarely
7146 -- reflect the true location of the code within the tree.
7147
7148 -- Before comparing the slocs of the two nodes, make sure that we are
7149 -- working with correct source locations. Assume that P1 is to the left
7150 -- of P2. If either one does not come from source, traverse the common
7151 -- list heading towards the other node and locate the first source
7152 -- statement.
7153
7154 -- P1 P2
7155 -- ----+===+===+--------------+===+===+----
7156 -- expanded code expanded code
7157
7158 if not Comes_From_Source (P1) then
7159 while Present (P1) loop
7160
7161 -- Neither P2 nor a source statement were located during the
7162 -- search. If we reach the end of the list, then P1 does not
7163 -- occur earlier than P2.
7164
7165 -- ---->
7166 -- start --- P2 ----- P1 --- end
7167
7168 if No (Next (P1)) then
7169 return False;
7170
7171 -- We encounter P2 while going to the right of the list. This
7172 -- means that P1 does indeed appear earlier.
7173
7174 -- ---->
7175 -- start --- P1 ===== P2 --- end
7176 -- expanded code in between
7177
7178 elsif P1 = P2 then
7179 return True;
7180
7181 -- No need to look any further since we have located a source
7182 -- statement.
7183
7184 elsif Comes_From_Source (P1) then
7185 exit;
7186 end if;
7187
7188 -- Keep going right
7189
7190 Next (P1);
7191 end loop;
7192 end if;
7193
7194 if not Comes_From_Source (P2) then
7195 while Present (P2) loop
7196
7197 -- Neither P1 nor a source statement were located during the
7198 -- search. If we reach the start of the list, then P1 does not
7199 -- occur earlier than P2.
7200
7201 -- <----
7202 -- start --- P2 --- P1 --- end
7203
7204 if No (Prev (P2)) then
7205 return False;
7206
7207 -- We encounter P1 while going to the left of the list. This
7208 -- means that P1 does indeed appear earlier.
7209
7210 -- <----
7211 -- start --- P1 ===== P2 --- end
7212 -- expanded code in between
7213
7214 elsif P2 = P1 then
7215 return True;
7216
7217 -- No need to look any further since we have located a source
7218 -- statement.
7219
7220 elsif Comes_From_Source (P2) then
7221 exit;
7222 end if;
7223
7224 -- Keep going left
7225
7226 Prev (P2);
7227 end loop;
7228 end if;
7229
7230 -- At this point either both nodes came from source or we approximated
7231 -- their source locations through neighbouring source statements.
7232
7233 T1 := Top_Level_Location (Sloc (P1));
7234 T2 := Top_Level_Location (Sloc (P2));
7235
7236 -- When two nodes come from the same instance, they have identical top
7237 -- level locations. To determine proper relation within the tree, check
7238 -- their locations within the template.
7239
7240 if T1 = T2 then
7241 return Sloc (P1) < Sloc (P2);
7242
7243 -- The two nodes either come from unrelated instances or do not come
7244 -- from instantiated code at all.
7245
7246 else
7247 return T1 < T2;
7248 end if;
7249 end Earlier;
7250
7251 ----------------------
7252 -- Find_Actual_Type --
7253 ----------------------
7254
7255 function Find_Actual_Type
7256 (Typ : Entity_Id;
7257 Gen_Type : Entity_Id) return Entity_Id
7258 is
7259 Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7260 T : Entity_Id;
7261
7262 begin
7263 -- Special processing only applies to child units
7264
7265 if not Is_Child_Unit (Gen_Scope) then
7266 return Get_Instance_Of (Typ);
7267
7268 -- If designated or component type is itself a formal of the child unit,
7269 -- its instance is available.
7270
7271 elsif Scope (Typ) = Gen_Scope then
7272 return Get_Instance_Of (Typ);
7273
7274 -- If the array or access type is not declared in the parent unit,
7275 -- no special processing needed.
7276
7277 elsif not Is_Generic_Type (Typ)
7278 and then Scope (Gen_Scope) /= Scope (Typ)
7279 then
7280 return Get_Instance_Of (Typ);
7281
7282 -- Otherwise, retrieve designated or component type by visibility
7283
7284 else
7285 T := Current_Entity (Typ);
7286 while Present (T) loop
7287 if In_Open_Scopes (Scope (T)) then
7288 return T;
7289
7290 elsif Is_Generic_Actual_Type (T) then
7291 return T;
7292 end if;
7293
7294 T := Homonym (T);
7295 end loop;
7296
7297 return Typ;
7298 end if;
7299 end Find_Actual_Type;
7300
7301 ----------------------------
7302 -- Freeze_Subprogram_Body --
7303 ----------------------------
7304
7305 procedure Freeze_Subprogram_Body
7306 (Inst_Node : Node_Id;
7307 Gen_Body : Node_Id;
7308 Pack_Id : Entity_Id)
7309 is
7310 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7311 Par : constant Entity_Id := Scope (Gen_Unit);
7312 E_G_Id : Entity_Id;
7313 Enc_G : Entity_Id;
7314 Enc_I : Node_Id;
7315 F_Node : Node_Id;
7316
7317 function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7318 -- Find innermost package body that encloses the given node, and which
7319 -- is not a compilation unit. Freeze nodes for the instance, or for its
7320 -- enclosing body, may be inserted after the enclosing_body of the
7321 -- generic unit. Used to determine proper placement of freeze node for
7322 -- both package and subprogram instances.
7323
7324 function Package_Freeze_Node (B : Node_Id) return Node_Id;
7325 -- Find entity for given package body, and locate or create a freeze
7326 -- node for it.
7327
7328 ----------------------------
7329 -- Enclosing_Package_Body --
7330 ----------------------------
7331
7332 function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7333 P : Node_Id;
7334
7335 begin
7336 P := Parent (N);
7337 while Present (P)
7338 and then Nkind (Parent (P)) /= N_Compilation_Unit
7339 loop
7340 if Nkind (P) = N_Package_Body then
7341 if Nkind (Parent (P)) = N_Subunit then
7342 return Corresponding_Stub (Parent (P));
7343 else
7344 return P;
7345 end if;
7346 end if;
7347
7348 P := True_Parent (P);
7349 end loop;
7350
7351 return Empty;
7352 end Enclosing_Package_Body;
7353
7354 -------------------------
7355 -- Package_Freeze_Node --
7356 -------------------------
7357
7358 function Package_Freeze_Node (B : Node_Id) return Node_Id is
7359 Id : Entity_Id;
7360
7361 begin
7362 if Nkind (B) = N_Package_Body then
7363 Id := Corresponding_Spec (B);
7364 else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7365 Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7366 end if;
7367
7368 Ensure_Freeze_Node (Id);
7369 return Freeze_Node (Id);
7370 end Package_Freeze_Node;
7371
7372 -- Start of processing of Freeze_Subprogram_Body
7373
7374 begin
7375 -- If the instance and the generic body appear within the same unit, and
7376 -- the instance precedes the generic, the freeze node for the instance
7377 -- must appear after that of the generic. If the generic is nested
7378 -- within another instance I2, then current instance must be frozen
7379 -- after I2. In both cases, the freeze nodes are those of enclosing
7380 -- packages. Otherwise, the freeze node is placed at the end of the
7381 -- current declarative part.
7382
7383 Enc_G := Enclosing_Package_Body (Gen_Body);
7384 Enc_I := Enclosing_Package_Body (Inst_Node);
7385 Ensure_Freeze_Node (Pack_Id);
7386 F_Node := Freeze_Node (Pack_Id);
7387
7388 if Is_Generic_Instance (Par)
7389 and then Present (Freeze_Node (Par))
7390 and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7391 then
7392 -- The parent was a premature instantiation. Insert freeze node at
7393 -- the end the current declarative part.
7394
7395 if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7396 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7397
7398 -- Handle the following case:
7399 --
7400 -- package Parent_Inst is new ...
7401 -- Parent_Inst []
7402 --
7403 -- procedure P ... -- this body freezes Parent_Inst
7404 --
7405 -- package Inst is new ...
7406 --
7407 -- In this particular scenario, the freeze node for Inst must be
7408 -- inserted in the same manner as that of Parent_Inst - before the
7409 -- next source body or at the end of the declarative list (body not
7410 -- available). If body P did not exist and Parent_Inst was frozen
7411 -- after Inst, either by a body following Inst or at the end of the
7412 -- declarative region, the freeze node for Inst must be inserted
7413 -- after that of Parent_Inst. This relation is established by
7414 -- comparing the Slocs of Parent_Inst freeze node and Inst.
7415
7416 elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7417 List_Containing (Inst_Node)
7418 and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7419 then
7420 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7421
7422 else
7423 Insert_After (Freeze_Node (Par), F_Node);
7424 end if;
7425
7426 -- The body enclosing the instance should be frozen after the body that
7427 -- includes the generic, because the body of the instance may make
7428 -- references to entities therein. If the two are not in the same
7429 -- declarative part, or if the one enclosing the instance is frozen
7430 -- already, freeze the instance at the end of the current declarative
7431 -- part.
7432
7433 elsif Is_Generic_Instance (Par)
7434 and then Present (Freeze_Node (Par))
7435 and then Present (Enc_I)
7436 then
7437 if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7438 or else
7439 (Nkind (Enc_I) = N_Package_Body
7440 and then
7441 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7442 then
7443 -- The enclosing package may contain several instances. Rather
7444 -- than computing the earliest point at which to insert its freeze
7445 -- node, we place it at the end of the declarative part of the
7446 -- parent of the generic.
7447
7448 Insert_Freeze_Node_For_Instance
7449 (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7450 end if;
7451
7452 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7453
7454 elsif Present (Enc_G)
7455 and then Present (Enc_I)
7456 and then Enc_G /= Enc_I
7457 and then Earlier (Inst_Node, Gen_Body)
7458 then
7459 if Nkind (Enc_G) = N_Package_Body then
7460 E_G_Id := Corresponding_Spec (Enc_G);
7461 else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7462 E_G_Id :=
7463 Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7464 end if;
7465
7466 -- Freeze package that encloses instance, and place node after the
7467 -- package that encloses generic. If enclosing package is already
7468 -- frozen we have to assume it is at the proper place. This may be a
7469 -- potential ABE that requires dynamic checking. Do not add a freeze
7470 -- node if the package that encloses the generic is inside the body
7471 -- that encloses the instance, because the freeze node would be in
7472 -- the wrong scope. Additional contortions needed if the bodies are
7473 -- within a subunit.
7474
7475 declare
7476 Enclosing_Body : Node_Id;
7477
7478 begin
7479 if Nkind (Enc_I) = N_Package_Body_Stub then
7480 Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7481 else
7482 Enclosing_Body := Enc_I;
7483 end if;
7484
7485 if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
7486 Insert_Freeze_Node_For_Instance
7487 (Enc_G, Package_Freeze_Node (Enc_I));
7488 end if;
7489 end;
7490
7491 -- Freeze enclosing subunit before instance
7492
7493 Ensure_Freeze_Node (E_G_Id);
7494
7495 if not Is_List_Member (Freeze_Node (E_G_Id)) then
7496 Insert_After (Enc_G, Freeze_Node (E_G_Id));
7497 end if;
7498
7499 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7500
7501 else
7502 -- If none of the above, insert freeze node at the end of the current
7503 -- declarative part.
7504
7505 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7506 end if;
7507 end Freeze_Subprogram_Body;
7508
7509 ----------------
7510 -- Get_Gen_Id --
7511 ----------------
7512
7513 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
7514 begin
7515 return Generic_Renamings.Table (E).Gen_Id;
7516 end Get_Gen_Id;
7517
7518 ---------------------
7519 -- Get_Instance_Of --
7520 ---------------------
7521
7522 function Get_Instance_Of (A : Entity_Id) return Entity_Id is
7523 Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
7524
7525 begin
7526 if Res /= Assoc_Null then
7527 return Generic_Renamings.Table (Res).Act_Id;
7528 else
7529 -- On exit, entity is not instantiated: not a generic parameter, or
7530 -- else parameter of an inner generic unit.
7531
7532 return A;
7533 end if;
7534 end Get_Instance_Of;
7535
7536 ------------------------------------
7537 -- Get_Package_Instantiation_Node --
7538 ------------------------------------
7539
7540 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
7541 Decl : Node_Id := Unit_Declaration_Node (A);
7542 Inst : Node_Id;
7543
7544 begin
7545 -- If the Package_Instantiation attribute has been set on the package
7546 -- entity, then use it directly when it (or its Original_Node) refers
7547 -- to an N_Package_Instantiation node. In principle it should be
7548 -- possible to have this field set in all cases, which should be
7549 -- investigated, and would allow this function to be significantly
7550 -- simplified. ???
7551
7552 Inst := Package_Instantiation (A);
7553
7554 if Present (Inst) then
7555 if Nkind (Inst) = N_Package_Instantiation then
7556 return Inst;
7557
7558 elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
7559 return Original_Node (Inst);
7560 end if;
7561 end if;
7562
7563 -- If the instantiation is a compilation unit that does not need body
7564 -- then the instantiation node has been rewritten as a package
7565 -- declaration for the instance, and we return the original node.
7566
7567 -- If it is a compilation unit and the instance node has not been
7568 -- rewritten, then it is still the unit of the compilation. Finally, if
7569 -- a body is present, this is a parent of the main unit whose body has
7570 -- been compiled for inlining purposes, and the instantiation node has
7571 -- been rewritten with the instance body.
7572
7573 -- Otherwise the instantiation node appears after the declaration. If
7574 -- the entity is a formal package, the declaration may have been
7575 -- rewritten as a generic declaration (in the case of a formal with box)
7576 -- or left as a formal package declaration if it has actuals, and is
7577 -- found with a forward search.
7578
7579 if Nkind (Parent (Decl)) = N_Compilation_Unit then
7580 if Nkind (Decl) = N_Package_Declaration
7581 and then Present (Corresponding_Body (Decl))
7582 then
7583 Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
7584 end if;
7585
7586 if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
7587 return Original_Node (Decl);
7588 else
7589 return Unit (Parent (Decl));
7590 end if;
7591
7592 elsif Nkind (Decl) = N_Package_Declaration
7593 and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
7594 then
7595 return Original_Node (Decl);
7596
7597 else
7598 Inst := Next (Decl);
7599 while not Nkind_In (Inst, N_Package_Instantiation,
7600 N_Formal_Package_Declaration)
7601 loop
7602 Next (Inst);
7603 end loop;
7604
7605 return Inst;
7606 end if;
7607 end Get_Package_Instantiation_Node;
7608
7609 ------------------------
7610 -- Has_Been_Exchanged --
7611 ------------------------
7612
7613 function Has_Been_Exchanged (E : Entity_Id) return Boolean is
7614 Next : Elmt_Id;
7615
7616 begin
7617 Next := First_Elmt (Exchanged_Views);
7618 while Present (Next) loop
7619 if Full_View (Node (Next)) = E then
7620 return True;
7621 end if;
7622
7623 Next_Elmt (Next);
7624 end loop;
7625
7626 return False;
7627 end Has_Been_Exchanged;
7628
7629 ----------
7630 -- Hash --
7631 ----------
7632
7633 function Hash (F : Entity_Id) return HTable_Range is
7634 begin
7635 return HTable_Range (F mod HTable_Size);
7636 end Hash;
7637
7638 ------------------------
7639 -- Hide_Current_Scope --
7640 ------------------------
7641
7642 procedure Hide_Current_Scope is
7643 C : constant Entity_Id := Current_Scope;
7644 E : Entity_Id;
7645
7646 begin
7647 Set_Is_Hidden_Open_Scope (C);
7648
7649 E := First_Entity (C);
7650 while Present (E) loop
7651 if Is_Immediately_Visible (E) then
7652 Set_Is_Immediately_Visible (E, False);
7653 Append_Elmt (E, Hidden_Entities);
7654 end if;
7655
7656 Next_Entity (E);
7657 end loop;
7658
7659 -- Make the scope name invisible as well. This is necessary, but might
7660 -- conflict with calls to Rtsfind later on, in case the scope is a
7661 -- predefined one. There is no clean solution to this problem, so for
7662 -- now we depend on the user not redefining Standard itself in one of
7663 -- the parent units.
7664
7665 if Is_Immediately_Visible (C) and then C /= Standard_Standard then
7666 Set_Is_Immediately_Visible (C, False);
7667 Append_Elmt (C, Hidden_Entities);
7668 end if;
7669
7670 end Hide_Current_Scope;
7671
7672 --------------
7673 -- Init_Env --
7674 --------------
7675
7676 procedure Init_Env is
7677 Saved : Instance_Env;
7678
7679 begin
7680 Saved.Instantiated_Parent := Current_Instantiated_Parent;
7681 Saved.Exchanged_Views := Exchanged_Views;
7682 Saved.Hidden_Entities := Hidden_Entities;
7683 Saved.Current_Sem_Unit := Current_Sem_Unit;
7684 Saved.Parent_Unit_Visible := Parent_Unit_Visible;
7685 Saved.Instance_Parent_Unit := Instance_Parent_Unit;
7686
7687 -- Save configuration switches. These may be reset if the unit is a
7688 -- predefined unit, and the current mode is not Ada 2005.
7689
7690 Save_Opt_Config_Switches (Saved.Switches);
7691
7692 Instance_Envs.Append (Saved);
7693
7694 Exchanged_Views := New_Elmt_List;
7695 Hidden_Entities := New_Elmt_List;
7696
7697 -- Make dummy entry for Instantiated parent. If generic unit is legal,
7698 -- this is set properly in Set_Instance_Env.
7699
7700 Current_Instantiated_Parent :=
7701 (Current_Scope, Current_Scope, Assoc_Null);
7702 end Init_Env;
7703
7704 ------------------------------
7705 -- In_Same_Declarative_Part --
7706 ------------------------------
7707
7708 function In_Same_Declarative_Part
7709 (F_Node : Node_Id;
7710 Inst : Node_Id) return Boolean
7711 is
7712 Decls : constant Node_Id := Parent (F_Node);
7713 Nod : Node_Id := Parent (Inst);
7714
7715 begin
7716 while Present (Nod) loop
7717 if Nod = Decls then
7718 return True;
7719
7720 elsif Nkind_In (Nod, N_Subprogram_Body,
7721 N_Package_Body,
7722 N_Package_Declaration,
7723 N_Task_Body,
7724 N_Protected_Body,
7725 N_Block_Statement)
7726 then
7727 return False;
7728
7729 elsif Nkind (Nod) = N_Subunit then
7730 Nod := Corresponding_Stub (Nod);
7731
7732 elsif Nkind (Nod) = N_Compilation_Unit then
7733 return False;
7734
7735 else
7736 Nod := Parent (Nod);
7737 end if;
7738 end loop;
7739
7740 return False;
7741 end In_Same_Declarative_Part;
7742
7743 ---------------------
7744 -- In_Main_Context --
7745 ---------------------
7746
7747 function In_Main_Context (E : Entity_Id) return Boolean is
7748 Context : List_Id;
7749 Clause : Node_Id;
7750 Nam : Node_Id;
7751
7752 begin
7753 if not Is_Compilation_Unit (E)
7754 or else Ekind (E) /= E_Package
7755 or else In_Private_Part (E)
7756 then
7757 return False;
7758 end if;
7759
7760 Context := Context_Items (Cunit (Main_Unit));
7761
7762 Clause := First (Context);
7763 while Present (Clause) loop
7764 if Nkind (Clause) = N_With_Clause then
7765 Nam := Name (Clause);
7766
7767 -- If the current scope is part of the context of the main unit,
7768 -- analysis of the corresponding with_clause is not complete, and
7769 -- the entity is not set. We use the Chars field directly, which
7770 -- might produce false positives in rare cases, but guarantees
7771 -- that we produce all the instance bodies we will need.
7772
7773 if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
7774 or else (Nkind (Nam) = N_Selected_Component
7775 and then Chars (Selector_Name (Nam)) = Chars (E))
7776 then
7777 return True;
7778 end if;
7779 end if;
7780
7781 Next (Clause);
7782 end loop;
7783
7784 return False;
7785 end In_Main_Context;
7786
7787 ---------------------
7788 -- Inherit_Context --
7789 ---------------------
7790
7791 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
7792 Current_Context : List_Id;
7793 Current_Unit : Node_Id;
7794 Item : Node_Id;
7795 New_I : Node_Id;
7796
7797 Clause : Node_Id;
7798 OK : Boolean;
7799 Lib_Unit : Node_Id;
7800
7801 begin
7802 if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
7803
7804 -- The inherited context is attached to the enclosing compilation
7805 -- unit. This is either the main unit, or the declaration for the
7806 -- main unit (in case the instantiation appears within the package
7807 -- declaration and the main unit is its body).
7808
7809 Current_Unit := Parent (Inst);
7810 while Present (Current_Unit)
7811 and then Nkind (Current_Unit) /= N_Compilation_Unit
7812 loop
7813 Current_Unit := Parent (Current_Unit);
7814 end loop;
7815
7816 Current_Context := Context_Items (Current_Unit);
7817
7818 Item := First (Context_Items (Parent (Gen_Decl)));
7819 while Present (Item) loop
7820 if Nkind (Item) = N_With_Clause then
7821 Lib_Unit := Library_Unit (Item);
7822
7823 -- Take care to prevent direct cyclic with's
7824
7825 if Lib_Unit /= Current_Unit then
7826
7827 -- Do not add a unit if it is already in the context
7828
7829 Clause := First (Current_Context);
7830 OK := True;
7831 while Present (Clause) loop
7832 if Nkind (Clause) = N_With_Clause and then
7833 Library_Unit (Clause) = Lib_Unit
7834 then
7835 OK := False;
7836 exit;
7837 end if;
7838
7839 Next (Clause);
7840 end loop;
7841
7842 if OK then
7843 New_I := New_Copy (Item);
7844 Set_Implicit_With (New_I, True);
7845 Set_Implicit_With_From_Instantiation (New_I, True);
7846 Append (New_I, Current_Context);
7847 end if;
7848 end if;
7849 end if;
7850
7851 Next (Item);
7852 end loop;
7853 end if;
7854 end Inherit_Context;
7855
7856 ----------------
7857 -- Initialize --
7858 ----------------
7859
7860 procedure Initialize is
7861 begin
7862 Generic_Renamings.Init;
7863 Instance_Envs.Init;
7864 Generic_Flags.Init;
7865 Generic_Renamings_HTable.Reset;
7866 Circularity_Detected := False;
7867 Exchanged_Views := No_Elist;
7868 Hidden_Entities := No_Elist;
7869 end Initialize;
7870
7871 -------------------------------------
7872 -- Insert_Freeze_Node_For_Instance --
7873 -------------------------------------
7874
7875 procedure Insert_Freeze_Node_For_Instance
7876 (N : Node_Id;
7877 F_Node : Node_Id)
7878 is
7879 Decl : Node_Id;
7880 Decls : List_Id;
7881 Inst : Entity_Id;
7882 Par_N : Node_Id;
7883
7884 function Enclosing_Body (N : Node_Id) return Node_Id;
7885 -- Find enclosing package or subprogram body, if any. Freeze node may
7886 -- be placed at end of current declarative list if previous instance
7887 -- and current one have different enclosing bodies.
7888
7889 function Previous_Instance (Gen : Entity_Id) return Entity_Id;
7890 -- Find the local instance, if any, that declares the generic that is
7891 -- being instantiated. If present, the freeze node for this instance
7892 -- must follow the freeze node for the previous instance.
7893
7894 --------------------
7895 -- Enclosing_Body --
7896 --------------------
7897
7898 function Enclosing_Body (N : Node_Id) return Node_Id is
7899 P : Node_Id;
7900
7901 begin
7902 P := Parent (N);
7903 while Present (P)
7904 and then Nkind (Parent (P)) /= N_Compilation_Unit
7905 loop
7906 if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
7907 if Nkind (Parent (P)) = N_Subunit then
7908 return Corresponding_Stub (Parent (P));
7909 else
7910 return P;
7911 end if;
7912 end if;
7913
7914 P := True_Parent (P);
7915 end loop;
7916
7917 return Empty;
7918 end Enclosing_Body;
7919
7920 -----------------------
7921 -- Previous_Instance --
7922 -----------------------
7923
7924 function Previous_Instance (Gen : Entity_Id) return Entity_Id is
7925 S : Entity_Id;
7926
7927 begin
7928 S := Scope (Gen);
7929 while Present (S)
7930 and then S /= Standard_Standard
7931 loop
7932 if Is_Generic_Instance (S)
7933 and then In_Same_Source_Unit (S, N)
7934 then
7935 return S;
7936 end if;
7937
7938 S := Scope (S);
7939 end loop;
7940
7941 return Empty;
7942 end Previous_Instance;
7943
7944 -- Start of processing for Insert_Freeze_Node_For_Instance
7945
7946 begin
7947 if not Is_List_Member (F_Node) then
7948 Decl := N;
7949 Decls := List_Containing (N);
7950 Inst := Entity (F_Node);
7951 Par_N := Parent (Decls);
7952
7953 -- When processing a subprogram instantiation, utilize the actual
7954 -- subprogram instantiation rather than its package wrapper as it
7955 -- carries all the context information.
7956
7957 if Is_Wrapper_Package (Inst) then
7958 Inst := Related_Instance (Inst);
7959 end if;
7960
7961 -- If this is a package instance, check whether the generic is
7962 -- declared in a previous instance and the current instance is
7963 -- not within the previous one.
7964
7965 if Present (Generic_Parent (Parent (Inst)))
7966 and then Is_In_Main_Unit (N)
7967 then
7968 declare
7969 Enclosing_N : constant Node_Id := Enclosing_Body (N);
7970 Par_I : constant Entity_Id :=
7971 Previous_Instance
7972 (Generic_Parent (Parent (Inst)));
7973 Scop : Entity_Id;
7974
7975 begin
7976 if Present (Par_I)
7977 and then Earlier (N, Freeze_Node (Par_I))
7978 then
7979 Scop := Scope (Inst);
7980
7981 -- If the current instance is within the one that contains
7982 -- the generic, the freeze node for the current one must
7983 -- appear in the current declarative part. Ditto, if the
7984 -- current instance is within another package instance or
7985 -- within a body that does not enclose the current instance.
7986 -- In these three cases the freeze node of the previous
7987 -- instance is not relevant.
7988
7989 while Present (Scop)
7990 and then Scop /= Standard_Standard
7991 loop
7992 exit when Scop = Par_I
7993 or else
7994 (Is_Generic_Instance (Scop)
7995 and then Scope_Depth (Scop) > Scope_Depth (Par_I));
7996 Scop := Scope (Scop);
7997 end loop;
7998
7999 -- Previous instance encloses current instance
8000
8001 if Scop = Par_I then
8002 null;
8003
8004 -- If the next node is a source body we must freeze in
8005 -- the current scope as well.
8006
8007 elsif Present (Next (N))
8008 and then Nkind_In (Next (N),
8009 N_Subprogram_Body, N_Package_Body)
8010 and then Comes_From_Source (Next (N))
8011 then
8012 null;
8013
8014 -- Current instance is within an unrelated instance
8015
8016 elsif Is_Generic_Instance (Scop) then
8017 null;
8018
8019 -- Current instance is within an unrelated body
8020
8021 elsif Present (Enclosing_N)
8022 and then Enclosing_N /= Enclosing_Body (Par_I)
8023 then
8024 null;
8025
8026 else
8027 Insert_After (Freeze_Node (Par_I), F_Node);
8028 return;
8029 end if;
8030 end if;
8031 end;
8032 end if;
8033
8034 -- When the instantiation occurs in a package declaration, append the
8035 -- freeze node to the private declarations (if any).
8036
8037 if Nkind (Par_N) = N_Package_Specification
8038 and then Decls = Visible_Declarations (Par_N)
8039 and then Present (Private_Declarations (Par_N))
8040 and then not Is_Empty_List (Private_Declarations (Par_N))
8041 then
8042 Decls := Private_Declarations (Par_N);
8043 Decl := First (Decls);
8044 end if;
8045
8046 -- Determine the proper freeze point of a package instantiation. We
8047 -- adhere to the general rule of a package or subprogram body causing
8048 -- freezing of anything before it in the same declarative region. In
8049 -- this case, the proper freeze point of a package instantiation is
8050 -- before the first source body which follows, or before a stub. This
8051 -- ensures that entities coming from the instance are already frozen
8052 -- and usable in source bodies.
8053
8054 if Nkind (Par_N) /= N_Package_Declaration
8055 and then Ekind (Inst) = E_Package
8056 and then Is_Generic_Instance (Inst)
8057 and then
8058 not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
8059 then
8060 while Present (Decl) loop
8061 if (Nkind (Decl) in N_Unit_Body
8062 or else
8063 Nkind (Decl) in N_Body_Stub)
8064 and then Comes_From_Source (Decl)
8065 then
8066 Insert_Before (Decl, F_Node);
8067 return;
8068 end if;
8069
8070 Next (Decl);
8071 end loop;
8072 end if;
8073
8074 -- In a package declaration, or if no previous body, insert at end
8075 -- of list.
8076
8077 Set_Sloc (F_Node, Sloc (Last (Decls)));
8078 Insert_After (Last (Decls), F_Node);
8079 end if;
8080 end Insert_Freeze_Node_For_Instance;
8081
8082 ------------------
8083 -- Install_Body --
8084 ------------------
8085
8086 procedure Install_Body
8087 (Act_Body : Node_Id;
8088 N : Node_Id;
8089 Gen_Body : Node_Id;
8090 Gen_Decl : Node_Id)
8091 is
8092 Act_Id : constant Entity_Id := Corresponding_Spec (Act_Body);
8093 Act_Unit : constant Node_Id := Unit (Cunit (Get_Source_Unit (N)));
8094 Gen_Id : constant Entity_Id := Corresponding_Spec (Gen_Body);
8095 Par : constant Entity_Id := Scope (Gen_Id);
8096 Gen_Unit : constant Node_Id :=
8097 Unit (Cunit (Get_Source_Unit (Gen_Decl)));
8098 Orig_Body : Node_Id := Gen_Body;
8099 F_Node : Node_Id;
8100 Body_Unit : Node_Id;
8101
8102 Must_Delay : Boolean;
8103
8104 function Enclosing_Subp (Id : Entity_Id) return Entity_Id;
8105 -- Find subprogram (if any) that encloses instance and/or generic body
8106
8107 function True_Sloc (N : Node_Id) return Source_Ptr;
8108 -- If the instance is nested inside a generic unit, the Sloc of the
8109 -- instance indicates the place of the original definition, not the
8110 -- point of the current enclosing instance. Pending a better usage of
8111 -- Slocs to indicate instantiation places, we determine the place of
8112 -- origin of a node by finding the maximum sloc of any ancestor node.
8113 -- Why is this not equivalent to Top_Level_Location ???
8114
8115 --------------------
8116 -- Enclosing_Subp --
8117 --------------------
8118
8119 function Enclosing_Subp (Id : Entity_Id) return Entity_Id is
8120 Scop : Entity_Id;
8121
8122 begin
8123 Scop := Scope (Id);
8124 while Scop /= Standard_Standard
8125 and then not Is_Overloadable (Scop)
8126 loop
8127 Scop := Scope (Scop);
8128 end loop;
8129
8130 return Scop;
8131 end Enclosing_Subp;
8132
8133 ---------------
8134 -- True_Sloc --
8135 ---------------
8136
8137 function True_Sloc (N : Node_Id) return Source_Ptr is
8138 Res : Source_Ptr;
8139 N1 : Node_Id;
8140
8141 begin
8142 Res := Sloc (N);
8143 N1 := N;
8144 while Present (N1) and then N1 /= Act_Unit loop
8145 if Sloc (N1) > Res then
8146 Res := Sloc (N1);
8147 end if;
8148
8149 N1 := Parent (N1);
8150 end loop;
8151
8152 return Res;
8153 end True_Sloc;
8154
8155 -- Start of processing for Install_Body
8156
8157 begin
8158 -- If the body is a subunit, the freeze point is the corresponding stub
8159 -- in the current compilation, not the subunit itself.
8160
8161 if Nkind (Parent (Gen_Body)) = N_Subunit then
8162 Orig_Body := Corresponding_Stub (Parent (Gen_Body));
8163 else
8164 Orig_Body := Gen_Body;
8165 end if;
8166
8167 Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8168
8169 -- If the instantiation and the generic definition appear in the same
8170 -- package declaration, this is an early instantiation. If they appear
8171 -- in the same declarative part, it is an early instantiation only if
8172 -- the generic body appears textually later, and the generic body is
8173 -- also in the main unit.
8174
8175 -- If instance is nested within a subprogram, and the generic body is
8176 -- not, the instance is delayed because the enclosing body is. If
8177 -- instance and body are within the same scope, or the same sub-
8178 -- program body, indicate explicitly that the instance is delayed.
8179
8180 Must_Delay :=
8181 (Gen_Unit = Act_Unit
8182 and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8183 N_Generic_Package_Declaration)
8184 or else (Gen_Unit = Body_Unit
8185 and then True_Sloc (N) < Sloc (Orig_Body)))
8186 and then Is_In_Main_Unit (Gen_Unit)
8187 and then (Scope (Act_Id) = Scope (Gen_Id)
8188 or else
8189 Enclosing_Subp (Act_Id) = Enclosing_Subp (Gen_Id)));
8190
8191 -- If this is an early instantiation, the freeze node is placed after
8192 -- the generic body. Otherwise, if the generic appears in an instance,
8193 -- we cannot freeze the current instance until the outer one is frozen.
8194 -- This is only relevant if the current instance is nested within some
8195 -- inner scope not itself within the outer instance. If this scope is
8196 -- a package body in the same declarative part as the outer instance,
8197 -- then that body needs to be frozen after the outer instance. Finally,
8198 -- if no delay is needed, we place the freeze node at the end of the
8199 -- current declarative part.
8200
8201 if Expander_Active then
8202 Ensure_Freeze_Node (Act_Id);
8203 F_Node := Freeze_Node (Act_Id);
8204
8205 if Must_Delay then
8206 Insert_After (Orig_Body, F_Node);
8207
8208 elsif Is_Generic_Instance (Par)
8209 and then Present (Freeze_Node (Par))
8210 and then Scope (Act_Id) /= Par
8211 then
8212 -- Freeze instance of inner generic after instance of enclosing
8213 -- generic.
8214
8215 if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8216
8217 -- Handle the following case:
8218
8219 -- package Parent_Inst is new ...
8220 -- Parent_Inst []
8221
8222 -- procedure P ... -- this body freezes Parent_Inst
8223
8224 -- package Inst is new ...
8225
8226 -- In this particular scenario, the freeze node for Inst must
8227 -- be inserted in the same manner as that of Parent_Inst -
8228 -- before the next source body or at the end of the declarative
8229 -- list (body not available). If body P did not exist and
8230 -- Parent_Inst was frozen after Inst, either by a body
8231 -- following Inst or at the end of the declarative region, the
8232 -- freeze node for Inst must be inserted after that of
8233 -- Parent_Inst. This relation is established by comparing the
8234 -- Slocs of Parent_Inst freeze node and Inst.
8235
8236 if List_Containing (Get_Package_Instantiation_Node (Par)) =
8237 List_Containing (N)
8238 and then Sloc (Freeze_Node (Par)) < Sloc (N)
8239 then
8240 Insert_Freeze_Node_For_Instance (N, F_Node);
8241 else
8242 Insert_After (Freeze_Node (Par), F_Node);
8243 end if;
8244
8245 -- Freeze package enclosing instance of inner generic after
8246 -- instance of enclosing generic.
8247
8248 elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8249 and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8250 then
8251 declare
8252 Enclosing : Entity_Id;
8253
8254 begin
8255 Enclosing := Corresponding_Spec (Parent (N));
8256
8257 if No (Enclosing) then
8258 Enclosing := Defining_Entity (Parent (N));
8259 end if;
8260
8261 Insert_Freeze_Node_For_Instance (N, F_Node);
8262 Ensure_Freeze_Node (Enclosing);
8263
8264 if not Is_List_Member (Freeze_Node (Enclosing)) then
8265
8266 -- The enclosing context is a subunit, insert the freeze
8267 -- node after the stub.
8268
8269 if Nkind (Parent (Parent (N))) = N_Subunit then
8270 Insert_Freeze_Node_For_Instance
8271 (Corresponding_Stub (Parent (Parent (N))),
8272 Freeze_Node (Enclosing));
8273
8274 -- The enclosing context is a package with a stub body
8275 -- which has already been replaced by the real body.
8276 -- Insert the freeze node after the actual body.
8277
8278 elsif Ekind (Enclosing) = E_Package
8279 and then Present (Body_Entity (Enclosing))
8280 and then Was_Originally_Stub
8281 (Parent (Body_Entity (Enclosing)))
8282 then
8283 Insert_Freeze_Node_For_Instance
8284 (Parent (Body_Entity (Enclosing)),
8285 Freeze_Node (Enclosing));
8286
8287 -- The parent instance has been frozen before the body of
8288 -- the enclosing package, insert the freeze node after
8289 -- the body.
8290
8291 elsif List_Containing (Freeze_Node (Par)) =
8292 List_Containing (Parent (N))
8293 and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8294 then
8295 Insert_Freeze_Node_For_Instance
8296 (Parent (N), Freeze_Node (Enclosing));
8297
8298 else
8299 Insert_After
8300 (Freeze_Node (Par), Freeze_Node (Enclosing));
8301 end if;
8302 end if;
8303 end;
8304
8305 else
8306 Insert_Freeze_Node_For_Instance (N, F_Node);
8307 end if;
8308
8309 else
8310 Insert_Freeze_Node_For_Instance (N, F_Node);
8311 end if;
8312 end if;
8313
8314 Set_Is_Frozen (Act_Id);
8315 Insert_Before (N, Act_Body);
8316 Mark_Rewrite_Insertion (Act_Body);
8317 end Install_Body;
8318
8319 -----------------------------
8320 -- Install_Formal_Packages --
8321 -----------------------------
8322
8323 procedure Install_Formal_Packages (Par : Entity_Id) is
8324 E : Entity_Id;
8325 Gen : Entity_Id;
8326 Gen_E : Entity_Id := Empty;
8327
8328 begin
8329 E := First_Entity (Par);
8330
8331 -- If we are installing an instance parent, locate the formal packages
8332 -- of its generic parent.
8333
8334 if Is_Generic_Instance (Par) then
8335 Gen := Generic_Parent (Specification (Unit_Declaration_Node (Par)));
8336 Gen_E := First_Entity (Gen);
8337 end if;
8338
8339 while Present (E) loop
8340 if Ekind (E) = E_Package
8341 and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8342 then
8343 -- If this is the renaming for the parent instance, done
8344
8345 if Renamed_Object (E) = Par then
8346 exit;
8347
8348 -- The visibility of a formal of an enclosing generic is already
8349 -- correct.
8350
8351 elsif Denotes_Formal_Package (E) then
8352 null;
8353
8354 elsif Present (Associated_Formal_Package (E)) then
8355 Check_Generic_Actuals (Renamed_Object (E), True);
8356 Set_Is_Hidden (E, False);
8357
8358 -- Find formal package in generic unit that corresponds to
8359 -- (instance of) formal package in instance.
8360
8361 while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8362 Next_Entity (Gen_E);
8363 end loop;
8364
8365 if Present (Gen_E) then
8366 Map_Formal_Package_Entities (Gen_E, E);
8367 end if;
8368 end if;
8369 end if;
8370
8371 Next_Entity (E);
8372 if Present (Gen_E) then
8373 Next_Entity (Gen_E);
8374 end if;
8375 end loop;
8376 end Install_Formal_Packages;
8377
8378 --------------------
8379 -- Install_Parent --
8380 --------------------
8381
8382 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8383 Ancestors : constant Elist_Id := New_Elmt_List;
8384 S : constant Entity_Id := Current_Scope;
8385 Inst_Par : Entity_Id;
8386 First_Par : Entity_Id;
8387 Inst_Node : Node_Id;
8388 Gen_Par : Entity_Id;
8389 First_Gen : Entity_Id;
8390 Elmt : Elmt_Id;
8391
8392 procedure Install_Noninstance_Specs (Par : Entity_Id);
8393 -- Install the scopes of noninstance parent units ending with Par
8394
8395 procedure Install_Spec (Par : Entity_Id);
8396 -- The child unit is within the declarative part of the parent, so the
8397 -- declarations within the parent are immediately visible.
8398
8399 -------------------------------
8400 -- Install_Noninstance_Specs --
8401 -------------------------------
8402
8403 procedure Install_Noninstance_Specs (Par : Entity_Id) is
8404 begin
8405 if Present (Par)
8406 and then Par /= Standard_Standard
8407 and then not In_Open_Scopes (Par)
8408 then
8409 Install_Noninstance_Specs (Scope (Par));
8410 Install_Spec (Par);
8411 end if;
8412 end Install_Noninstance_Specs;
8413
8414 ------------------
8415 -- Install_Spec --
8416 ------------------
8417
8418 procedure Install_Spec (Par : Entity_Id) is
8419 Spec : constant Node_Id :=
8420 Specification (Unit_Declaration_Node (Par));
8421
8422 begin
8423 -- If this parent of the child instance is a top-level unit,
8424 -- then record the unit and its visibility for later resetting in
8425 -- Remove_Parent. We exclude units that are generic instances, as we
8426 -- only want to record this information for the ultimate top-level
8427 -- noninstance parent (is that always correct???).
8428
8429 if Scope (Par) = Standard_Standard
8430 and then not Is_Generic_Instance (Par)
8431 then
8432 Parent_Unit_Visible := Is_Immediately_Visible (Par);
8433 Instance_Parent_Unit := Par;
8434 end if;
8435
8436 -- Open the parent scope and make it and its declarations visible.
8437 -- If this point is not within a body, then only the visible
8438 -- declarations should be made visible, and installation of the
8439 -- private declarations is deferred until the appropriate point
8440 -- within analysis of the spec being instantiated (see the handling
8441 -- of parent visibility in Analyze_Package_Specification). This is
8442 -- relaxed in the case where the parent unit is Ada.Tags, to avoid
8443 -- private view problems that occur when compiling instantiations of
8444 -- a generic child of that package (Generic_Dispatching_Constructor).
8445 -- If the instance freezes a tagged type, inlinings of operations
8446 -- from Ada.Tags may need the full view of type Tag. If inlining took
8447 -- proper account of establishing visibility of inlined subprograms'
8448 -- parents then it should be possible to remove this
8449 -- special check. ???
8450
8451 Push_Scope (Par);
8452 Set_Is_Immediately_Visible (Par);
8453 Install_Visible_Declarations (Par);
8454 Set_Use (Visible_Declarations (Spec));
8455
8456 if In_Body or else Is_RTU (Par, Ada_Tags) then
8457 Install_Private_Declarations (Par);
8458 Set_Use (Private_Declarations (Spec));
8459 end if;
8460 end Install_Spec;
8461
8462 -- Start of processing for Install_Parent
8463
8464 begin
8465 -- We need to install the parent instance to compile the instantiation
8466 -- of the child, but the child instance must appear in the current
8467 -- scope. Given that we cannot place the parent above the current scope
8468 -- in the scope stack, we duplicate the current scope and unstack both
8469 -- after the instantiation is complete.
8470
8471 -- If the parent is itself the instantiation of a child unit, we must
8472 -- also stack the instantiation of its parent, and so on. Each such
8473 -- ancestor is the prefix of the name in a prior instantiation.
8474
8475 -- If this is a nested instance, the parent unit itself resolves to
8476 -- a renaming of the parent instance, whose declaration we need.
8477
8478 -- Finally, the parent may be a generic (not an instance) when the
8479 -- child unit appears as a formal package.
8480
8481 Inst_Par := P;
8482
8483 if Present (Renamed_Entity (Inst_Par)) then
8484 Inst_Par := Renamed_Entity (Inst_Par);
8485 end if;
8486
8487 First_Par := Inst_Par;
8488
8489 Gen_Par :=
8490 Generic_Parent (Specification (Unit_Declaration_Node (Inst_Par)));
8491
8492 First_Gen := Gen_Par;
8493
8494 while Present (Gen_Par)
8495 and then Is_Child_Unit (Gen_Par)
8496 loop
8497 -- Load grandparent instance as well
8498
8499 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
8500
8501 if Nkind (Name (Inst_Node)) = N_Expanded_Name then
8502 Inst_Par := Entity (Prefix (Name (Inst_Node)));
8503
8504 if Present (Renamed_Entity (Inst_Par)) then
8505 Inst_Par := Renamed_Entity (Inst_Par);
8506 end if;
8507
8508 Gen_Par :=
8509 Generic_Parent
8510 (Specification (Unit_Declaration_Node (Inst_Par)));
8511
8512 if Present (Gen_Par) then
8513 Prepend_Elmt (Inst_Par, Ancestors);
8514
8515 else
8516 -- Parent is not the name of an instantiation
8517
8518 Install_Noninstance_Specs (Inst_Par);
8519 exit;
8520 end if;
8521
8522 else
8523 -- Previous error
8524
8525 exit;
8526 end if;
8527 end loop;
8528
8529 if Present (First_Gen) then
8530 Append_Elmt (First_Par, Ancestors);
8531 else
8532 Install_Noninstance_Specs (First_Par);
8533 end if;
8534
8535 if not Is_Empty_Elmt_List (Ancestors) then
8536 Elmt := First_Elmt (Ancestors);
8537 while Present (Elmt) loop
8538 Install_Spec (Node (Elmt));
8539 Install_Formal_Packages (Node (Elmt));
8540 Next_Elmt (Elmt);
8541 end loop;
8542 end if;
8543
8544 if not In_Body then
8545 Push_Scope (S);
8546 end if;
8547 end Install_Parent;
8548
8549 -------------------------------
8550 -- Install_Hidden_Primitives --
8551 -------------------------------
8552
8553 procedure Install_Hidden_Primitives
8554 (Prims_List : in out Elist_Id;
8555 Gen_T : Entity_Id;
8556 Act_T : Entity_Id)
8557 is
8558 Elmt : Elmt_Id;
8559 List : Elist_Id := No_Elist;
8560 Prim_G_Elmt : Elmt_Id;
8561 Prim_A_Elmt : Elmt_Id;
8562 Prim_G : Node_Id;
8563 Prim_A : Node_Id;
8564
8565 begin
8566 -- No action needed in case of serious errors because we cannot trust
8567 -- in the order of primitives
8568
8569 if Serious_Errors_Detected > 0 then
8570 return;
8571
8572 -- No action possible if we don't have available the list of primitive
8573 -- operations
8574
8575 elsif No (Gen_T)
8576 or else not Is_Record_Type (Gen_T)
8577 or else not Is_Tagged_Type (Gen_T)
8578 or else not Is_Record_Type (Act_T)
8579 or else not Is_Tagged_Type (Act_T)
8580 then
8581 return;
8582
8583 -- There is no need to handle interface types since their primitives
8584 -- cannot be hidden
8585
8586 elsif Is_Interface (Gen_T) then
8587 return;
8588 end if;
8589
8590 Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
8591
8592 if not Is_Class_Wide_Type (Act_T) then
8593 Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
8594 else
8595 Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
8596 end if;
8597
8598 loop
8599 -- Skip predefined primitives in the generic formal
8600
8601 while Present (Prim_G_Elmt)
8602 and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
8603 loop
8604 Next_Elmt (Prim_G_Elmt);
8605 end loop;
8606
8607 -- Skip predefined primitives in the generic actual
8608
8609 while Present (Prim_A_Elmt)
8610 and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
8611 loop
8612 Next_Elmt (Prim_A_Elmt);
8613 end loop;
8614
8615 exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
8616
8617 Prim_G := Node (Prim_G_Elmt);
8618 Prim_A := Node (Prim_A_Elmt);
8619
8620 -- There is no need to handle interface primitives because their
8621 -- primitives are not hidden
8622
8623 exit when Present (Interface_Alias (Prim_G));
8624
8625 -- Here we install one hidden primitive
8626
8627 if Chars (Prim_G) /= Chars (Prim_A)
8628 and then Has_Suffix (Prim_A, 'P')
8629 and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
8630 then
8631 Set_Chars (Prim_A, Chars (Prim_G));
8632
8633 if List = No_Elist then
8634 List := New_Elmt_List;
8635 end if;
8636
8637 Append_Elmt (Prim_A, List);
8638 end if;
8639
8640 Next_Elmt (Prim_A_Elmt);
8641 Next_Elmt (Prim_G_Elmt);
8642 end loop;
8643
8644 -- Append the elements to the list of temporarily visible primitives
8645 -- avoiding duplicates.
8646
8647 if Present (List) then
8648 if No (Prims_List) then
8649 Prims_List := New_Elmt_List;
8650 end if;
8651
8652 Elmt := First_Elmt (List);
8653 while Present (Elmt) loop
8654 Append_Unique_Elmt (Node (Elmt), Prims_List);
8655 Next_Elmt (Elmt);
8656 end loop;
8657 end if;
8658 end Install_Hidden_Primitives;
8659
8660 -------------------------------
8661 -- Restore_Hidden_Primitives --
8662 -------------------------------
8663
8664 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
8665 Prim_Elmt : Elmt_Id;
8666 Prim : Node_Id;
8667
8668 begin
8669 if Prims_List /= No_Elist then
8670 Prim_Elmt := First_Elmt (Prims_List);
8671 while Present (Prim_Elmt) loop
8672 Prim := Node (Prim_Elmt);
8673 Set_Chars (Prim, Add_Suffix (Prim, 'P'));
8674 Next_Elmt (Prim_Elmt);
8675 end loop;
8676
8677 Prims_List := No_Elist;
8678 end if;
8679 end Restore_Hidden_Primitives;
8680
8681 --------------------------------
8682 -- Instantiate_Formal_Package --
8683 --------------------------------
8684
8685 function Instantiate_Formal_Package
8686 (Formal : Node_Id;
8687 Actual : Node_Id;
8688 Analyzed_Formal : Node_Id) return List_Id
8689 is
8690 Loc : constant Source_Ptr := Sloc (Actual);
8691 Actual_Pack : Entity_Id;
8692 Formal_Pack : Entity_Id;
8693 Gen_Parent : Entity_Id;
8694 Decls : List_Id;
8695 Nod : Node_Id;
8696 Parent_Spec : Node_Id;
8697
8698 procedure Find_Matching_Actual
8699 (F : Node_Id;
8700 Act : in out Entity_Id);
8701 -- We need to associate each formal entity in the formal package with
8702 -- the corresponding entity in the actual package. The actual package
8703 -- has been analyzed and possibly expanded, and as a result there is
8704 -- no one-to-one correspondence between the two lists (for example,
8705 -- the actual may include subtypes, itypes, and inherited primitive
8706 -- operations, interspersed among the renaming declarations for the
8707 -- actuals) . We retrieve the corresponding actual by name because each
8708 -- actual has the same name as the formal, and they do appear in the
8709 -- same order.
8710
8711 function Get_Formal_Entity (N : Node_Id) return Entity_Id;
8712 -- Retrieve entity of defining entity of generic formal parameter.
8713 -- Only the declarations of formals need to be considered when
8714 -- linking them to actuals, but the declarative list may include
8715 -- internal entities generated during analysis, and those are ignored.
8716
8717 procedure Match_Formal_Entity
8718 (Formal_Node : Node_Id;
8719 Formal_Ent : Entity_Id;
8720 Actual_Ent : Entity_Id);
8721 -- Associates the formal entity with the actual. In the case where
8722 -- Formal_Ent is a formal package, this procedure iterates through all
8723 -- of its formals and enters associations between the actuals occurring
8724 -- in the formal package's corresponding actual package (given by
8725 -- Actual_Ent) and the formal package's formal parameters. This
8726 -- procedure recurses if any of the parameters is itself a package.
8727
8728 function Is_Instance_Of
8729 (Act_Spec : Entity_Id;
8730 Gen_Anc : Entity_Id) return Boolean;
8731 -- The actual can be an instantiation of a generic within another
8732 -- instance, in which case there is no direct link from it to the
8733 -- original generic ancestor. In that case, we recognize that the
8734 -- ultimate ancestor is the same by examining names and scopes.
8735
8736 procedure Process_Nested_Formal (Formal : Entity_Id);
8737 -- If the current formal is declared with a box, its own formals are
8738 -- visible in the instance, as they were in the generic, and their
8739 -- Hidden flag must be reset. If some of these formals are themselves
8740 -- packages declared with a box, the processing must be recursive.
8741
8742 --------------------------
8743 -- Find_Matching_Actual --
8744 --------------------------
8745
8746 procedure Find_Matching_Actual
8747 (F : Node_Id;
8748 Act : in out Entity_Id)
8749 is
8750 Formal_Ent : Entity_Id;
8751
8752 begin
8753 case Nkind (Original_Node (F)) is
8754 when N_Formal_Object_Declaration |
8755 N_Formal_Type_Declaration =>
8756 Formal_Ent := Defining_Identifier (F);
8757
8758 while Chars (Act) /= Chars (Formal_Ent) loop
8759 Next_Entity (Act);
8760 end loop;
8761
8762 when N_Formal_Subprogram_Declaration |
8763 N_Formal_Package_Declaration |
8764 N_Package_Declaration |
8765 N_Generic_Package_Declaration =>
8766 Formal_Ent := Defining_Entity (F);
8767
8768 while Chars (Act) /= Chars (Formal_Ent) loop
8769 Next_Entity (Act);
8770 end loop;
8771
8772 when others =>
8773 raise Program_Error;
8774 end case;
8775 end Find_Matching_Actual;
8776
8777 -------------------------
8778 -- Match_Formal_Entity --
8779 -------------------------
8780
8781 procedure Match_Formal_Entity
8782 (Formal_Node : Node_Id;
8783 Formal_Ent : Entity_Id;
8784 Actual_Ent : Entity_Id)
8785 is
8786 Act_Pkg : Entity_Id;
8787
8788 begin
8789 Set_Instance_Of (Formal_Ent, Actual_Ent);
8790
8791 if Ekind (Actual_Ent) = E_Package then
8792
8793 -- Record associations for each parameter
8794
8795 Act_Pkg := Actual_Ent;
8796
8797 declare
8798 A_Ent : Entity_Id := First_Entity (Act_Pkg);
8799 F_Ent : Entity_Id;
8800 F_Node : Node_Id;
8801
8802 Gen_Decl : Node_Id;
8803 Formals : List_Id;
8804 Actual : Entity_Id;
8805
8806 begin
8807 -- Retrieve the actual given in the formal package declaration
8808
8809 Actual := Entity (Name (Original_Node (Formal_Node)));
8810
8811 -- The actual in the formal package declaration may be a
8812 -- renamed generic package, in which case we want to retrieve
8813 -- the original generic in order to traverse its formal part.
8814
8815 if Present (Renamed_Entity (Actual)) then
8816 Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
8817 else
8818 Gen_Decl := Unit_Declaration_Node (Actual);
8819 end if;
8820
8821 Formals := Generic_Formal_Declarations (Gen_Decl);
8822
8823 if Present (Formals) then
8824 F_Node := First_Non_Pragma (Formals);
8825 else
8826 F_Node := Empty;
8827 end if;
8828
8829 while Present (A_Ent)
8830 and then Present (F_Node)
8831 and then A_Ent /= First_Private_Entity (Act_Pkg)
8832 loop
8833 F_Ent := Get_Formal_Entity (F_Node);
8834
8835 if Present (F_Ent) then
8836
8837 -- This is a formal of the original package. Record
8838 -- association and recurse.
8839
8840 Find_Matching_Actual (F_Node, A_Ent);
8841 Match_Formal_Entity (F_Node, F_Ent, A_Ent);
8842 Next_Entity (A_Ent);
8843 end if;
8844
8845 Next_Non_Pragma (F_Node);
8846 end loop;
8847 end;
8848 end if;
8849 end Match_Formal_Entity;
8850
8851 -----------------------
8852 -- Get_Formal_Entity --
8853 -----------------------
8854
8855 function Get_Formal_Entity (N : Node_Id) return Entity_Id is
8856 Kind : constant Node_Kind := Nkind (Original_Node (N));
8857 begin
8858 case Kind is
8859 when N_Formal_Object_Declaration =>
8860 return Defining_Identifier (N);
8861
8862 when N_Formal_Type_Declaration =>
8863 return Defining_Identifier (N);
8864
8865 when N_Formal_Subprogram_Declaration =>
8866 return Defining_Unit_Name (Specification (N));
8867
8868 when N_Formal_Package_Declaration =>
8869 return Defining_Identifier (Original_Node (N));
8870
8871 when N_Generic_Package_Declaration =>
8872 return Defining_Identifier (Original_Node (N));
8873
8874 -- All other declarations are introduced by semantic analysis and
8875 -- have no match in the actual.
8876
8877 when others =>
8878 return Empty;
8879 end case;
8880 end Get_Formal_Entity;
8881
8882 --------------------
8883 -- Is_Instance_Of --
8884 --------------------
8885
8886 function Is_Instance_Of
8887 (Act_Spec : Entity_Id;
8888 Gen_Anc : Entity_Id) return Boolean
8889 is
8890 Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
8891
8892 begin
8893 if No (Gen_Par) then
8894 return False;
8895
8896 -- Simplest case: the generic parent of the actual is the formal
8897
8898 elsif Gen_Par = Gen_Anc then
8899 return True;
8900
8901 elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
8902 return False;
8903
8904 -- The actual may be obtained through several instantiations. Its
8905 -- scope must itself be an instance of a generic declared in the
8906 -- same scope as the formal. Any other case is detected above.
8907
8908 elsif not Is_Generic_Instance (Scope (Gen_Par)) then
8909 return False;
8910
8911 else
8912 return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
8913 end if;
8914 end Is_Instance_Of;
8915
8916 ---------------------------
8917 -- Process_Nested_Formal --
8918 ---------------------------
8919
8920 procedure Process_Nested_Formal (Formal : Entity_Id) is
8921 Ent : Entity_Id;
8922
8923 begin
8924 if Present (Associated_Formal_Package (Formal))
8925 and then Box_Present (Parent (Associated_Formal_Package (Formal)))
8926 then
8927 Ent := First_Entity (Formal);
8928 while Present (Ent) loop
8929 Set_Is_Hidden (Ent, False);
8930 Set_Is_Visible_Formal (Ent);
8931 Set_Is_Potentially_Use_Visible
8932 (Ent, Is_Potentially_Use_Visible (Formal));
8933
8934 if Ekind (Ent) = E_Package then
8935 exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
8936 Process_Nested_Formal (Ent);
8937 end if;
8938
8939 Next_Entity (Ent);
8940 end loop;
8941 end if;
8942 end Process_Nested_Formal;
8943
8944 -- Start of processing for Instantiate_Formal_Package
8945
8946 begin
8947 Analyze (Actual);
8948
8949 if not Is_Entity_Name (Actual)
8950 or else Ekind (Entity (Actual)) /= E_Package
8951 then
8952 Error_Msg_N
8953 ("expect package instance to instantiate formal", Actual);
8954 Abandon_Instantiation (Actual);
8955 raise Program_Error;
8956
8957 else
8958 Actual_Pack := Entity (Actual);
8959 Set_Is_Instantiated (Actual_Pack);
8960
8961 -- The actual may be a renamed package, or an outer generic formal
8962 -- package whose instantiation is converted into a renaming.
8963
8964 if Present (Renamed_Object (Actual_Pack)) then
8965 Actual_Pack := Renamed_Object (Actual_Pack);
8966 end if;
8967
8968 if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
8969 Gen_Parent := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
8970 Formal_Pack := Defining_Identifier (Analyzed_Formal);
8971 else
8972 Gen_Parent :=
8973 Generic_Parent (Specification (Analyzed_Formal));
8974 Formal_Pack :=
8975 Defining_Unit_Name (Specification (Analyzed_Formal));
8976 end if;
8977
8978 if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
8979 Parent_Spec := Specification (Unit_Declaration_Node (Actual_Pack));
8980 else
8981 Parent_Spec := Parent (Actual_Pack);
8982 end if;
8983
8984 if Gen_Parent = Any_Id then
8985 Error_Msg_N
8986 ("previous error in declaration of formal package", Actual);
8987 Abandon_Instantiation (Actual);
8988
8989 elsif
8990 Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
8991 then
8992 null;
8993
8994 else
8995 Error_Msg_NE
8996 ("actual parameter must be instance of&", Actual, Gen_Parent);
8997 Abandon_Instantiation (Actual);
8998 end if;
8999
9000 Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
9001 Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
9002
9003 Nod :=
9004 Make_Package_Renaming_Declaration (Loc,
9005 Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
9006 Name => New_Reference_To (Actual_Pack, Loc));
9007
9008 Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
9009 Defining_Identifier (Formal));
9010 Decls := New_List (Nod);
9011
9012 -- If the formal F has a box, then the generic declarations are
9013 -- visible in the generic G. In an instance of G, the corresponding
9014 -- entities in the actual for F (which are the actuals for the
9015 -- instantiation of the generic that F denotes) must also be made
9016 -- visible for analysis of the current instance. On exit from the
9017 -- current instance, those entities are made private again. If the
9018 -- actual is currently in use, these entities are also use-visible.
9019
9020 -- The loop through the actual entities also steps through the formal
9021 -- entities and enters associations from formals to actuals into the
9022 -- renaming map. This is necessary to properly handle checking of
9023 -- actual parameter associations for later formals that depend on
9024 -- actuals declared in the formal package.
9025
9026 -- In Ada 2005, partial parametrization requires that we make visible
9027 -- the actuals corresponding to formals that were defaulted in the
9028 -- formal package. There formals are identified because they remain
9029 -- formal generics within the formal package, rather than being
9030 -- renamings of the actuals supplied.
9031
9032 declare
9033 Gen_Decl : constant Node_Id :=
9034 Unit_Declaration_Node (Gen_Parent);
9035 Formals : constant List_Id :=
9036 Generic_Formal_Declarations (Gen_Decl);
9037
9038 Actual_Ent : Entity_Id;
9039 Actual_Of_Formal : Node_Id;
9040 Formal_Node : Node_Id;
9041 Formal_Ent : Entity_Id;
9042
9043 begin
9044 if Present (Formals) then
9045 Formal_Node := First_Non_Pragma (Formals);
9046 else
9047 Formal_Node := Empty;
9048 end if;
9049
9050 Actual_Ent := First_Entity (Actual_Pack);
9051 Actual_Of_Formal :=
9052 First (Visible_Declarations (Specification (Analyzed_Formal)));
9053 while Present (Actual_Ent)
9054 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9055 loop
9056 if Present (Formal_Node) then
9057 Formal_Ent := Get_Formal_Entity (Formal_Node);
9058
9059 if Present (Formal_Ent) then
9060 Find_Matching_Actual (Formal_Node, Actual_Ent);
9061 Match_Formal_Entity
9062 (Formal_Node, Formal_Ent, Actual_Ent);
9063
9064 -- We iterate at the same time over the actuals of the
9065 -- local package created for the formal, to determine
9066 -- which one of the formals of the original generic were
9067 -- defaulted in the formal. The corresponding actual
9068 -- entities are visible in the enclosing instance.
9069
9070 if Box_Present (Formal)
9071 or else
9072 (Present (Actual_Of_Formal)
9073 and then
9074 Is_Generic_Formal
9075 (Get_Formal_Entity (Actual_Of_Formal)))
9076 then
9077 Set_Is_Hidden (Actual_Ent, False);
9078 Set_Is_Visible_Formal (Actual_Ent);
9079 Set_Is_Potentially_Use_Visible
9080 (Actual_Ent, In_Use (Actual_Pack));
9081
9082 if Ekind (Actual_Ent) = E_Package then
9083 Process_Nested_Formal (Actual_Ent);
9084 end if;
9085
9086 else
9087 Set_Is_Hidden (Actual_Ent);
9088 Set_Is_Potentially_Use_Visible (Actual_Ent, False);
9089 end if;
9090 end if;
9091
9092 Next_Non_Pragma (Formal_Node);
9093 Next (Actual_Of_Formal);
9094
9095 else
9096 -- No further formals to match, but the generic part may
9097 -- contain inherited operation that are not hidden in the
9098 -- enclosing instance.
9099
9100 Next_Entity (Actual_Ent);
9101 end if;
9102 end loop;
9103
9104 -- Inherited subprograms generated by formal derived types are
9105 -- also visible if the types are.
9106
9107 Actual_Ent := First_Entity (Actual_Pack);
9108 while Present (Actual_Ent)
9109 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9110 loop
9111 if Is_Overloadable (Actual_Ent)
9112 and then
9113 Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
9114 and then
9115 not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
9116 then
9117 Set_Is_Hidden (Actual_Ent, False);
9118 Set_Is_Potentially_Use_Visible
9119 (Actual_Ent, In_Use (Actual_Pack));
9120 end if;
9121
9122 Next_Entity (Actual_Ent);
9123 end loop;
9124 end;
9125
9126 -- If the formal is not declared with a box, reanalyze it as an
9127 -- abbreviated instantiation, to verify the matching rules of 12.7.
9128 -- The actual checks are performed after the generic associations
9129 -- have been analyzed, to guarantee the same visibility for this
9130 -- instantiation and for the actuals.
9131
9132 -- In Ada 2005, the generic associations for the formal can include
9133 -- defaulted parameters. These are ignored during check. This
9134 -- internal instantiation is removed from the tree after conformance
9135 -- checking, because it contains formal declarations for those
9136 -- defaulted parameters, and those should not reach the back-end.
9137
9138 if not Box_Present (Formal) then
9139 declare
9140 I_Pack : constant Entity_Id :=
9141 Make_Temporary (Sloc (Actual), 'P');
9142
9143 begin
9144 Set_Is_Internal (I_Pack);
9145
9146 Append_To (Decls,
9147 Make_Package_Instantiation (Sloc (Actual),
9148 Defining_Unit_Name => I_Pack,
9149 Name =>
9150 New_Occurrence_Of
9151 (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
9152 Generic_Associations =>
9153 Generic_Associations (Formal)));
9154 end;
9155 end if;
9156
9157 return Decls;
9158 end if;
9159 end Instantiate_Formal_Package;
9160
9161 -----------------------------------
9162 -- Instantiate_Formal_Subprogram --
9163 -----------------------------------
9164
9165 function Instantiate_Formal_Subprogram
9166 (Formal : Node_Id;
9167 Actual : Node_Id;
9168 Analyzed_Formal : Node_Id) return Node_Id
9169 is
9170 Loc : Source_Ptr;
9171 Formal_Sub : constant Entity_Id :=
9172 Defining_Unit_Name (Specification (Formal));
9173 Analyzed_S : constant Entity_Id :=
9174 Defining_Unit_Name (Specification (Analyzed_Formal));
9175 Decl_Node : Node_Id;
9176 Nam : Node_Id;
9177 New_Spec : Node_Id;
9178
9179 function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9180 -- If the generic is a child unit, the parent has been installed on the
9181 -- scope stack, but a default subprogram cannot resolve to something
9182 -- on the parent because that parent is not really part of the visible
9183 -- context (it is there to resolve explicit local entities). If the
9184 -- default has resolved in this way, we remove the entity from immediate
9185 -- visibility and analyze the node again to emit an error message or
9186 -- find another visible candidate.
9187
9188 procedure Valid_Actual_Subprogram (Act : Node_Id);
9189 -- Perform legality check and raise exception on failure
9190
9191 -----------------------
9192 -- From_Parent_Scope --
9193 -----------------------
9194
9195 function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9196 Gen_Scope : Node_Id;
9197
9198 begin
9199 Gen_Scope := Scope (Analyzed_S);
9200 while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9201 if Scope (Subp) = Scope (Gen_Scope) then
9202 return True;
9203 end if;
9204
9205 Gen_Scope := Scope (Gen_Scope);
9206 end loop;
9207
9208 return False;
9209 end From_Parent_Scope;
9210
9211 -----------------------------
9212 -- Valid_Actual_Subprogram --
9213 -----------------------------
9214
9215 procedure Valid_Actual_Subprogram (Act : Node_Id) is
9216 Act_E : Entity_Id;
9217
9218 begin
9219 if Is_Entity_Name (Act) then
9220 Act_E := Entity (Act);
9221
9222 elsif Nkind (Act) = N_Selected_Component
9223 and then Is_Entity_Name (Selector_Name (Act))
9224 then
9225 Act_E := Entity (Selector_Name (Act));
9226
9227 else
9228 Act_E := Empty;
9229 end if;
9230
9231 if (Present (Act_E) and then Is_Overloadable (Act_E))
9232 or else Nkind_In (Act, N_Attribute_Reference,
9233 N_Indexed_Component,
9234 N_Character_Literal,
9235 N_Explicit_Dereference)
9236 then
9237 return;
9238 end if;
9239
9240 Error_Msg_NE
9241 ("expect subprogram or entry name in instantiation of&",
9242 Instantiation_Node, Formal_Sub);
9243 Abandon_Instantiation (Instantiation_Node);
9244
9245 end Valid_Actual_Subprogram;
9246
9247 -- Start of processing for Instantiate_Formal_Subprogram
9248
9249 begin
9250 New_Spec := New_Copy_Tree (Specification (Formal));
9251
9252 -- The tree copy has created the proper instantiation sloc for the
9253 -- new specification. Use this location for all other constructed
9254 -- declarations.
9255
9256 Loc := Sloc (Defining_Unit_Name (New_Spec));
9257
9258 -- Create new entity for the actual (New_Copy_Tree does not)
9259
9260 Set_Defining_Unit_Name
9261 (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9262
9263 -- Create new entities for the each of the formals in the
9264 -- specification of the renaming declaration built for the actual.
9265
9266 if Present (Parameter_Specifications (New_Spec)) then
9267 declare
9268 F : Node_Id;
9269 begin
9270 F := First (Parameter_Specifications (New_Spec));
9271 while Present (F) loop
9272 Set_Defining_Identifier (F,
9273 Make_Defining_Identifier (Sloc (F),
9274 Chars => Chars (Defining_Identifier (F))));
9275 Next (F);
9276 end loop;
9277 end;
9278 end if;
9279
9280 -- Find entity of actual. If the actual is an attribute reference, it
9281 -- cannot be resolved here (its formal is missing) but is handled
9282 -- instead in Attribute_Renaming. If the actual is overloaded, it is
9283 -- fully resolved subsequently, when the renaming declaration for the
9284 -- formal is analyzed. If it is an explicit dereference, resolve the
9285 -- prefix but not the actual itself, to prevent interpretation as call.
9286
9287 if Present (Actual) then
9288 Loc := Sloc (Actual);
9289 Set_Sloc (New_Spec, Loc);
9290
9291 if Nkind (Actual) = N_Operator_Symbol then
9292 Find_Direct_Name (Actual);
9293
9294 elsif Nkind (Actual) = N_Explicit_Dereference then
9295 Analyze (Prefix (Actual));
9296
9297 elsif Nkind (Actual) /= N_Attribute_Reference then
9298 Analyze (Actual);
9299 end if;
9300
9301 Valid_Actual_Subprogram (Actual);
9302 Nam := Actual;
9303
9304 elsif Present (Default_Name (Formal)) then
9305 if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9306 N_Selected_Component,
9307 N_Indexed_Component,
9308 N_Character_Literal)
9309 and then Present (Entity (Default_Name (Formal)))
9310 then
9311 Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9312 else
9313 Nam := New_Copy (Default_Name (Formal));
9314 Set_Sloc (Nam, Loc);
9315 end if;
9316
9317 elsif Box_Present (Formal) then
9318
9319 -- Actual is resolved at the point of instantiation. Create an
9320 -- identifier or operator with the same name as the formal.
9321
9322 if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9323 Nam := Make_Operator_Symbol (Loc,
9324 Chars => Chars (Formal_Sub),
9325 Strval => No_String);
9326 else
9327 Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9328 end if;
9329
9330 elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9331 and then Null_Present (Specification (Formal))
9332 then
9333 -- Generate null body for procedure, for use in the instance
9334
9335 Decl_Node :=
9336 Make_Subprogram_Body (Loc,
9337 Specification => New_Spec,
9338 Declarations => New_List,
9339 Handled_Statement_Sequence =>
9340 Make_Handled_Sequence_Of_Statements (Loc,
9341 Statements => New_List (Make_Null_Statement (Loc))));
9342
9343 Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9344 return Decl_Node;
9345
9346 else
9347 Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9348 Error_Msg_NE
9349 ("missing actual&", Instantiation_Node, Formal_Sub);
9350 Error_Msg_NE
9351 ("\in instantiation of & declared#",
9352 Instantiation_Node, Scope (Analyzed_S));
9353 Abandon_Instantiation (Instantiation_Node);
9354 end if;
9355
9356 Decl_Node :=
9357 Make_Subprogram_Renaming_Declaration (Loc,
9358 Specification => New_Spec,
9359 Name => Nam);
9360
9361 -- If we do not have an actual and the formal specified <> then set to
9362 -- get proper default.
9363
9364 if No (Actual) and then Box_Present (Formal) then
9365 Set_From_Default (Decl_Node);
9366 end if;
9367
9368 -- Gather possible interpretations for the actual before analyzing the
9369 -- instance. If overloaded, it will be resolved when analyzing the
9370 -- renaming declaration.
9371
9372 if Box_Present (Formal)
9373 and then No (Actual)
9374 then
9375 Analyze (Nam);
9376
9377 if Is_Child_Unit (Scope (Analyzed_S))
9378 and then Present (Entity (Nam))
9379 then
9380 if not Is_Overloaded (Nam) then
9381 if From_Parent_Scope (Entity (Nam)) then
9382 Set_Is_Immediately_Visible (Entity (Nam), False);
9383 Set_Entity (Nam, Empty);
9384 Set_Etype (Nam, Empty);
9385
9386 Analyze (Nam);
9387 Set_Is_Immediately_Visible (Entity (Nam));
9388 end if;
9389
9390 else
9391 declare
9392 I : Interp_Index;
9393 It : Interp;
9394
9395 begin
9396 Get_First_Interp (Nam, I, It);
9397 while Present (It.Nam) loop
9398 if From_Parent_Scope (It.Nam) then
9399 Remove_Interp (I);
9400 end if;
9401
9402 Get_Next_Interp (I, It);
9403 end loop;
9404 end;
9405 end if;
9406 end if;
9407 end if;
9408
9409 -- The generic instantiation freezes the actual. This can only be done
9410 -- once the actual is resolved, in the analysis of the renaming
9411 -- declaration. To make the formal subprogram entity available, we set
9412 -- Corresponding_Formal_Spec to point to the formal subprogram entity.
9413 -- This is also needed in Analyze_Subprogram_Renaming for the processing
9414 -- of formal abstract subprograms.
9415
9416 Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9417
9418 -- We cannot analyze the renaming declaration, and thus find the actual,
9419 -- until all the actuals are assembled in the instance. For subsequent
9420 -- checks of other actuals, indicate the node that will hold the
9421 -- instance of this formal.
9422
9423 Set_Instance_Of (Analyzed_S, Nam);
9424
9425 if Nkind (Actual) = N_Selected_Component
9426 and then Is_Task_Type (Etype (Prefix (Actual)))
9427 and then not Is_Frozen (Etype (Prefix (Actual)))
9428 then
9429 -- The renaming declaration will create a body, which must appear
9430 -- outside of the instantiation, We move the renaming declaration
9431 -- out of the instance, and create an additional renaming inside,
9432 -- to prevent freezing anomalies.
9433
9434 declare
9435 Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9436
9437 begin
9438 Set_Defining_Unit_Name (New_Spec, Anon_Id);
9439 Insert_Before (Instantiation_Node, Decl_Node);
9440 Analyze (Decl_Node);
9441
9442 -- Now create renaming within the instance
9443
9444 Decl_Node :=
9445 Make_Subprogram_Renaming_Declaration (Loc,
9446 Specification => New_Copy_Tree (New_Spec),
9447 Name => New_Occurrence_Of (Anon_Id, Loc));
9448
9449 Set_Defining_Unit_Name (Specification (Decl_Node),
9450 Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9451 end;
9452 end if;
9453
9454 return Decl_Node;
9455 end Instantiate_Formal_Subprogram;
9456
9457 ------------------------
9458 -- Instantiate_Object --
9459 ------------------------
9460
9461 function Instantiate_Object
9462 (Formal : Node_Id;
9463 Actual : Node_Id;
9464 Analyzed_Formal : Node_Id) return List_Id
9465 is
9466 Gen_Obj : constant Entity_Id := Defining_Identifier (Formal);
9467 A_Gen_Obj : constant Entity_Id :=
9468 Defining_Identifier (Analyzed_Formal);
9469 Acc_Def : Node_Id := Empty;
9470 Act_Assoc : constant Node_Id := Parent (Actual);
9471 Actual_Decl : Node_Id := Empty;
9472 Decl_Node : Node_Id;
9473 Def : Node_Id;
9474 Ftyp : Entity_Id;
9475 List : constant List_Id := New_List;
9476 Loc : constant Source_Ptr := Sloc (Actual);
9477 Orig_Ftyp : constant Entity_Id := Etype (A_Gen_Obj);
9478 Subt_Decl : Node_Id := Empty;
9479 Subt_Mark : Node_Id := Empty;
9480
9481 begin
9482 if Present (Subtype_Mark (Formal)) then
9483 Subt_Mark := Subtype_Mark (Formal);
9484 else
9485 Check_Access_Definition (Formal);
9486 Acc_Def := Access_Definition (Formal);
9487 end if;
9488
9489 -- Sloc for error message on missing actual
9490
9491 Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
9492
9493 if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
9494 Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
9495 end if;
9496
9497 Set_Parent (List, Parent (Actual));
9498
9499 -- OUT present
9500
9501 if Out_Present (Formal) then
9502
9503 -- An IN OUT generic actual must be a name. The instantiation is a
9504 -- renaming declaration. The actual is the name being renamed. We
9505 -- use the actual directly, rather than a copy, because it is not
9506 -- used further in the list of actuals, and because a copy or a use
9507 -- of relocate_node is incorrect if the instance is nested within a
9508 -- generic. In order to simplify ASIS searches, the Generic_Parent
9509 -- field links the declaration to the generic association.
9510
9511 if No (Actual) then
9512 Error_Msg_NE
9513 ("missing actual&",
9514 Instantiation_Node, Gen_Obj);
9515 Error_Msg_NE
9516 ("\in instantiation of & declared#",
9517 Instantiation_Node, Scope (A_Gen_Obj));
9518 Abandon_Instantiation (Instantiation_Node);
9519 end if;
9520
9521 if Present (Subt_Mark) then
9522 Decl_Node :=
9523 Make_Object_Renaming_Declaration (Loc,
9524 Defining_Identifier => New_Copy (Gen_Obj),
9525 Subtype_Mark => New_Copy_Tree (Subt_Mark),
9526 Name => Actual);
9527
9528 else pragma Assert (Present (Acc_Def));
9529 Decl_Node :=
9530 Make_Object_Renaming_Declaration (Loc,
9531 Defining_Identifier => New_Copy (Gen_Obj),
9532 Access_Definition => New_Copy_Tree (Acc_Def),
9533 Name => Actual);
9534 end if;
9535
9536 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9537
9538 -- The analysis of the actual may produce Insert_Action nodes, so
9539 -- the declaration must have a context in which to attach them.
9540
9541 Append (Decl_Node, List);
9542 Analyze (Actual);
9543
9544 -- Return if the analysis of the actual reported some error
9545
9546 if Etype (Actual) = Any_Type then
9547 return List;
9548 end if;
9549
9550 -- This check is performed here because Analyze_Object_Renaming will
9551 -- not check it when Comes_From_Source is False. Note though that the
9552 -- check for the actual being the name of an object will be performed
9553 -- in Analyze_Object_Renaming.
9554
9555 if Is_Object_Reference (Actual)
9556 and then Is_Dependent_Component_Of_Mutable_Object (Actual)
9557 then
9558 Error_Msg_N
9559 ("illegal discriminant-dependent component for in out parameter",
9560 Actual);
9561 end if;
9562
9563 -- The actual has to be resolved in order to check that it is a
9564 -- variable (due to cases such as F (1), where F returns access to
9565 -- an array, and for overloaded prefixes).
9566
9567 Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
9568
9569 -- If the type of the formal is not itself a formal, and the current
9570 -- unit is a child unit, the formal type must be declared in a
9571 -- parent, and must be retrieved by visibility.
9572
9573 if Ftyp = Orig_Ftyp
9574 and then Is_Generic_Unit (Scope (Ftyp))
9575 and then Is_Child_Unit (Scope (A_Gen_Obj))
9576 then
9577 declare
9578 Temp : constant Node_Id :=
9579 New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
9580 begin
9581 Set_Entity (Temp, Empty);
9582 Find_Type (Temp);
9583 Ftyp := Entity (Temp);
9584 end;
9585 end if;
9586
9587 if Is_Private_Type (Ftyp)
9588 and then not Is_Private_Type (Etype (Actual))
9589 and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
9590 or else Base_Type (Etype (Actual)) = Ftyp)
9591 then
9592 -- If the actual has the type of the full view of the formal, or
9593 -- else a non-private subtype of the formal, then the visibility
9594 -- of the formal type has changed. Add to the actuals a subtype
9595 -- declaration that will force the exchange of views in the body
9596 -- of the instance as well.
9597
9598 Subt_Decl :=
9599 Make_Subtype_Declaration (Loc,
9600 Defining_Identifier => Make_Temporary (Loc, 'P'),
9601 Subtype_Indication => New_Occurrence_Of (Ftyp, Loc));
9602
9603 Prepend (Subt_Decl, List);
9604
9605 Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
9606 Exchange_Declarations (Ftyp);
9607 end if;
9608
9609 Resolve (Actual, Ftyp);
9610
9611 if not Denotes_Variable (Actual) then
9612 Error_Msg_NE
9613 ("actual for& must be a variable", Actual, Gen_Obj);
9614
9615 elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
9616
9617 -- Ada 2005 (AI-423): For a generic formal object of mode in out,
9618 -- the type of the actual shall resolve to a specific anonymous
9619 -- access type.
9620
9621 if Ada_Version < Ada_2005
9622 or else
9623 Ekind (Base_Type (Ftyp)) /=
9624 E_Anonymous_Access_Type
9625 or else
9626 Ekind (Base_Type (Etype (Actual))) /=
9627 E_Anonymous_Access_Type
9628 then
9629 Error_Msg_NE ("type of actual does not match type of&",
9630 Actual, Gen_Obj);
9631 end if;
9632 end if;
9633
9634 Note_Possible_Modification (Actual, Sure => True);
9635
9636 -- Check for instantiation of atomic/volatile actual for
9637 -- non-atomic/volatile formal (RM C.6 (12)).
9638
9639 if Is_Atomic_Object (Actual)
9640 and then not Is_Atomic (Orig_Ftyp)
9641 then
9642 Error_Msg_N
9643 ("cannot instantiate non-atomic formal object " &
9644 "with atomic actual", Actual);
9645
9646 elsif Is_Volatile_Object (Actual)
9647 and then not Is_Volatile (Orig_Ftyp)
9648 then
9649 Error_Msg_N
9650 ("cannot instantiate non-volatile formal object " &
9651 "with volatile actual", Actual);
9652 end if;
9653
9654 -- Formal in-parameter
9655
9656 else
9657 -- The instantiation of a generic formal in-parameter is constant
9658 -- declaration. The actual is the expression for that declaration.
9659
9660 if Present (Actual) then
9661 if Present (Subt_Mark) then
9662 Def := Subt_Mark;
9663 else pragma Assert (Present (Acc_Def));
9664 Def := Acc_Def;
9665 end if;
9666
9667 Decl_Node :=
9668 Make_Object_Declaration (Loc,
9669 Defining_Identifier => New_Copy (Gen_Obj),
9670 Constant_Present => True,
9671 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9672 Object_Definition => New_Copy_Tree (Def),
9673 Expression => Actual);
9674
9675 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9676
9677 -- A generic formal object of a tagged type is defined to be
9678 -- aliased so the new constant must also be treated as aliased.
9679
9680 if Is_Tagged_Type (Etype (A_Gen_Obj)) then
9681 Set_Aliased_Present (Decl_Node);
9682 end if;
9683
9684 Append (Decl_Node, List);
9685
9686 -- No need to repeat (pre-)analysis of some expression nodes
9687 -- already handled in Preanalyze_Actuals.
9688
9689 if Nkind (Actual) /= N_Allocator then
9690 Analyze (Actual);
9691
9692 -- Return if the analysis of the actual reported some error
9693
9694 if Etype (Actual) = Any_Type then
9695 return List;
9696 end if;
9697 end if;
9698
9699 declare
9700 Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
9701 Typ : Entity_Id;
9702
9703 begin
9704 Typ := Get_Instance_Of (Formal_Type);
9705
9706 Freeze_Before (Instantiation_Node, Typ);
9707
9708 -- If the actual is an aggregate, perform name resolution on
9709 -- its components (the analysis of an aggregate does not do it)
9710 -- to capture local names that may be hidden if the generic is
9711 -- a child unit.
9712
9713 if Nkind (Actual) = N_Aggregate then
9714 Preanalyze_And_Resolve (Actual, Typ);
9715 end if;
9716
9717 if Is_Limited_Type (Typ)
9718 and then not OK_For_Limited_Init (Typ, Actual)
9719 then
9720 Error_Msg_N
9721 ("initialization not allowed for limited types", Actual);
9722 Explain_Limited_Type (Typ, Actual);
9723 end if;
9724 end;
9725
9726 elsif Present (Default_Expression (Formal)) then
9727
9728 -- Use default to construct declaration
9729
9730 if Present (Subt_Mark) then
9731 Def := Subt_Mark;
9732 else pragma Assert (Present (Acc_Def));
9733 Def := Acc_Def;
9734 end if;
9735
9736 Decl_Node :=
9737 Make_Object_Declaration (Sloc (Formal),
9738 Defining_Identifier => New_Copy (Gen_Obj),
9739 Constant_Present => True,
9740 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9741 Object_Definition => New_Copy (Def),
9742 Expression => New_Copy_Tree
9743 (Default_Expression (Formal)));
9744
9745 Append (Decl_Node, List);
9746 Set_Analyzed (Expression (Decl_Node), False);
9747
9748 else
9749 Error_Msg_NE
9750 ("missing actual&",
9751 Instantiation_Node, Gen_Obj);
9752 Error_Msg_NE ("\in instantiation of & declared#",
9753 Instantiation_Node, Scope (A_Gen_Obj));
9754
9755 if Is_Scalar_Type (Etype (A_Gen_Obj)) then
9756
9757 -- Create dummy constant declaration so that instance can be
9758 -- analyzed, to minimize cascaded visibility errors.
9759
9760 if Present (Subt_Mark) then
9761 Def := Subt_Mark;
9762 else pragma Assert (Present (Acc_Def));
9763 Def := Acc_Def;
9764 end if;
9765
9766 Decl_Node :=
9767 Make_Object_Declaration (Loc,
9768 Defining_Identifier => New_Copy (Gen_Obj),
9769 Constant_Present => True,
9770 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9771 Object_Definition => New_Copy (Def),
9772 Expression =>
9773 Make_Attribute_Reference (Sloc (Gen_Obj),
9774 Attribute_Name => Name_First,
9775 Prefix => New_Copy (Def)));
9776
9777 Append (Decl_Node, List);
9778
9779 else
9780 Abandon_Instantiation (Instantiation_Node);
9781 end if;
9782 end if;
9783 end if;
9784
9785 if Nkind (Actual) in N_Has_Entity then
9786 Actual_Decl := Parent (Entity (Actual));
9787 end if;
9788
9789 -- Ada 2005 (AI-423): For a formal object declaration with a null
9790 -- exclusion or an access definition that has a null exclusion: If the
9791 -- actual matching the formal object declaration denotes a generic
9792 -- formal object of another generic unit G, and the instantiation
9793 -- containing the actual occurs within the body of G or within the body
9794 -- of a generic unit declared within the declarative region of G, then
9795 -- the declaration of the formal object of G must have a null exclusion.
9796 -- Otherwise, the subtype of the actual matching the formal object
9797 -- declaration shall exclude null.
9798
9799 if Ada_Version >= Ada_2005
9800 and then Present (Actual_Decl)
9801 and then
9802 Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
9803 N_Object_Declaration)
9804 and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
9805 and then not Has_Null_Exclusion (Actual_Decl)
9806 and then Has_Null_Exclusion (Analyzed_Formal)
9807 then
9808 Error_Msg_Sloc := Sloc (Analyzed_Formal);
9809 Error_Msg_N
9810 ("actual must exclude null to match generic formal#", Actual);
9811 end if;
9812
9813 return List;
9814 end Instantiate_Object;
9815
9816 ------------------------------
9817 -- Instantiate_Package_Body --
9818 ------------------------------
9819
9820 procedure Instantiate_Package_Body
9821 (Body_Info : Pending_Body_Info;
9822 Inlined_Body : Boolean := False;
9823 Body_Optional : Boolean := False)
9824 is
9825 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
9826 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
9827 Loc : constant Source_Ptr := Sloc (Inst_Node);
9828
9829 Gen_Id : constant Node_Id := Name (Inst_Node);
9830 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
9831 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
9832 Act_Spec : constant Node_Id := Specification (Act_Decl);
9833 Act_Decl_Id : constant Entity_Id := Defining_Entity (Act_Spec);
9834
9835 Act_Body_Name : Node_Id;
9836 Gen_Body : Node_Id;
9837 Gen_Body_Id : Node_Id;
9838 Act_Body : Node_Id;
9839 Act_Body_Id : Entity_Id;
9840
9841 Parent_Installed : Boolean := False;
9842 Save_Style_Check : constant Boolean := Style_Check;
9843
9844 Par_Ent : Entity_Id := Empty;
9845 Par_Vis : Boolean := False;
9846
9847 Vis_Prims_List : Elist_Id := No_Elist;
9848 -- List of primitives made temporarily visible in the instantiation
9849 -- to match the visibility of the formal type
9850
9851 begin
9852 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9853
9854 -- The instance body may already have been processed, as the parent of
9855 -- another instance that is inlined (Load_Parent_Of_Generic).
9856
9857 if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
9858 return;
9859 end if;
9860
9861 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
9862
9863 -- Re-establish the state of information on which checks are suppressed.
9864 -- This information was set in Body_Info at the point of instantiation,
9865 -- and now we restore it so that the instance is compiled using the
9866 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
9867
9868 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
9869 Scope_Suppress := Body_Info.Scope_Suppress;
9870 Opt.Ada_Version := Body_Info.Version;
9871
9872 if No (Gen_Body_Id) then
9873 Load_Parent_Of_Generic
9874 (Inst_Node, Specification (Gen_Decl), Body_Optional);
9875 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9876 end if;
9877
9878 -- Establish global variable for sloc adjustment and for error recovery
9879
9880 Instantiation_Node := Inst_Node;
9881
9882 if Present (Gen_Body_Id) then
9883 Save_Env (Gen_Unit, Act_Decl_Id);
9884 Style_Check := False;
9885 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
9886
9887 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
9888
9889 Create_Instantiation_Source
9890 (Inst_Node, Gen_Body_Id, False, S_Adjustment);
9891
9892 Act_Body :=
9893 Copy_Generic_Node
9894 (Original_Node (Gen_Body), Empty, Instantiating => True);
9895
9896 -- Build new name (possibly qualified) for body declaration
9897
9898 Act_Body_Id := New_Copy (Act_Decl_Id);
9899
9900 -- Some attributes of spec entity are not inherited by body entity
9901
9902 Set_Handler_Records (Act_Body_Id, No_List);
9903
9904 if Nkind (Defining_Unit_Name (Act_Spec)) =
9905 N_Defining_Program_Unit_Name
9906 then
9907 Act_Body_Name :=
9908 Make_Defining_Program_Unit_Name (Loc,
9909 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
9910 Defining_Identifier => Act_Body_Id);
9911 else
9912 Act_Body_Name := Act_Body_Id;
9913 end if;
9914
9915 Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
9916
9917 Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
9918 Check_Generic_Actuals (Act_Decl_Id, False);
9919
9920 -- Install primitives hidden at the point of the instantiation but
9921 -- visible when processing the generic formals
9922
9923 declare
9924 E : Entity_Id;
9925
9926 begin
9927 E := First_Entity (Act_Decl_Id);
9928 while Present (E) loop
9929 if Is_Type (E)
9930 and then Is_Generic_Actual_Type (E)
9931 and then Is_Tagged_Type (E)
9932 then
9933 Install_Hidden_Primitives
9934 (Prims_List => Vis_Prims_List,
9935 Gen_T => Generic_Parent_Type (Parent (E)),
9936 Act_T => E);
9937 end if;
9938
9939 Next_Entity (E);
9940 end loop;
9941 end;
9942
9943 -- If it is a child unit, make the parent instance (which is an
9944 -- instance of the parent of the generic) visible. The parent
9945 -- instance is the prefix of the name of the generic unit.
9946
9947 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
9948 and then Nkind (Gen_Id) = N_Expanded_Name
9949 then
9950 Par_Ent := Entity (Prefix (Gen_Id));
9951 Par_Vis := Is_Immediately_Visible (Par_Ent);
9952 Install_Parent (Par_Ent, In_Body => True);
9953 Parent_Installed := True;
9954
9955 elsif Is_Child_Unit (Gen_Unit) then
9956 Par_Ent := Scope (Gen_Unit);
9957 Par_Vis := Is_Immediately_Visible (Par_Ent);
9958 Install_Parent (Par_Ent, In_Body => True);
9959 Parent_Installed := True;
9960 end if;
9961
9962 -- If the instantiation is a library unit, and this is the main unit,
9963 -- then build the resulting compilation unit nodes for the instance.
9964 -- If this is a compilation unit but it is not the main unit, then it
9965 -- is the body of a unit in the context, that is being compiled
9966 -- because it is encloses some inlined unit or another generic unit
9967 -- being instantiated. In that case, this body is not part of the
9968 -- current compilation, and is not attached to the tree, but its
9969 -- parent must be set for analysis.
9970
9971 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
9972
9973 -- Replace instance node with body of instance, and create new
9974 -- node for corresponding instance declaration.
9975
9976 Build_Instance_Compilation_Unit_Nodes
9977 (Inst_Node, Act_Body, Act_Decl);
9978 Analyze (Inst_Node);
9979
9980 if Parent (Inst_Node) = Cunit (Main_Unit) then
9981
9982 -- If the instance is a child unit itself, then set the scope
9983 -- of the expanded body to be the parent of the instantiation
9984 -- (ensuring that the fully qualified name will be generated
9985 -- for the elaboration subprogram).
9986
9987 if Nkind (Defining_Unit_Name (Act_Spec)) =
9988 N_Defining_Program_Unit_Name
9989 then
9990 Set_Scope
9991 (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
9992 end if;
9993 end if;
9994
9995 -- Case where instantiation is not a library unit
9996
9997 else
9998 -- If this is an early instantiation, i.e. appears textually
9999 -- before the corresponding body and must be elaborated first,
10000 -- indicate that the body instance is to be delayed.
10001
10002 Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
10003
10004 -- Now analyze the body. We turn off all checks if this is an
10005 -- internal unit, since there is no reason to have checks on for
10006 -- any predefined run-time library code. All such code is designed
10007 -- to be compiled with checks off.
10008
10009 -- Note that we do NOT apply this criterion to children of GNAT
10010 -- (or on VMS, children of DEC). The latter units must suppress
10011 -- checks explicitly if this is needed.
10012
10013 if Is_Predefined_File_Name
10014 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
10015 then
10016 Analyze (Act_Body, Suppress => All_Checks);
10017 else
10018 Analyze (Act_Body);
10019 end if;
10020 end if;
10021
10022 Inherit_Context (Gen_Body, Inst_Node);
10023
10024 -- Remove the parent instances if they have been placed on the scope
10025 -- stack to compile the body.
10026
10027 if Parent_Installed then
10028 Remove_Parent (In_Body => True);
10029
10030 -- Restore the previous visibility of the parent
10031
10032 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10033 end if;
10034
10035 Restore_Hidden_Primitives (Vis_Prims_List);
10036 Restore_Private_Views (Act_Decl_Id);
10037
10038 -- Remove the current unit from visibility if this is an instance
10039 -- that is not elaborated on the fly for inlining purposes.
10040
10041 if not Inlined_Body then
10042 Set_Is_Immediately_Visible (Act_Decl_Id, False);
10043 end if;
10044
10045 Restore_Env;
10046 Style_Check := Save_Style_Check;
10047
10048 -- If we have no body, and the unit requires a body, then complain. This
10049 -- complaint is suppressed if we have detected other errors (since a
10050 -- common reason for missing the body is that it had errors).
10051 -- In CodePeer mode, a warning has been emitted already, no need for
10052 -- further messages.
10053
10054 elsif Unit_Requires_Body (Gen_Unit)
10055 and then not Body_Optional
10056 then
10057 if CodePeer_Mode then
10058 null;
10059
10060 elsif Serious_Errors_Detected = 0 then
10061 Error_Msg_NE
10062 ("cannot find body of generic package &", Inst_Node, Gen_Unit);
10063
10064 -- Don't attempt to perform any cleanup actions if some other error
10065 -- was already detected, since this can cause blowups.
10066
10067 else
10068 return;
10069 end if;
10070
10071 -- Case of package that does not need a body
10072
10073 else
10074 -- If the instantiation of the declaration is a library unit, rewrite
10075 -- the original package instantiation as a package declaration in the
10076 -- compilation unit node.
10077
10078 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10079 Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
10080 Rewrite (Inst_Node, Act_Decl);
10081
10082 -- Generate elaboration entity, in case spec has elaboration code.
10083 -- This cannot be done when the instance is analyzed, because it
10084 -- is not known yet whether the body exists.
10085
10086 Set_Elaboration_Entity_Required (Act_Decl_Id, False);
10087 Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
10088
10089 -- If the instantiation is not a library unit, then append the
10090 -- declaration to the list of implicitly generated entities, unless
10091 -- it is already a list member which means that it was already
10092 -- processed
10093
10094 elsif not Is_List_Member (Act_Decl) then
10095 Mark_Rewrite_Insertion (Act_Decl);
10096 Insert_Before (Inst_Node, Act_Decl);
10097 end if;
10098 end if;
10099
10100 Expander_Mode_Restore;
10101 end Instantiate_Package_Body;
10102
10103 ---------------------------------
10104 -- Instantiate_Subprogram_Body --
10105 ---------------------------------
10106
10107 procedure Instantiate_Subprogram_Body
10108 (Body_Info : Pending_Body_Info;
10109 Body_Optional : Boolean := False)
10110 is
10111 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10112 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10113 Loc : constant Source_Ptr := Sloc (Inst_Node);
10114 Gen_Id : constant Node_Id := Name (Inst_Node);
10115 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10116 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10117 Anon_Id : constant Entity_Id :=
10118 Defining_Unit_Name (Specification (Act_Decl));
10119 Pack_Id : constant Entity_Id :=
10120 Defining_Unit_Name (Parent (Act_Decl));
10121 Decls : List_Id;
10122 Gen_Body : Node_Id;
10123 Gen_Body_Id : Node_Id;
10124 Act_Body : Node_Id;
10125 Pack_Body : Node_Id;
10126 Prev_Formal : Entity_Id;
10127 Ret_Expr : Node_Id;
10128 Unit_Renaming : Node_Id;
10129
10130 Parent_Installed : Boolean := False;
10131 Save_Style_Check : constant Boolean := Style_Check;
10132
10133 Par_Ent : Entity_Id := Empty;
10134 Par_Vis : Boolean := False;
10135
10136 begin
10137 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10138
10139 -- Subprogram body may have been created already because of an inline
10140 -- pragma, or because of multiple elaborations of the enclosing package
10141 -- when several instances of the subprogram appear in the main unit.
10142
10143 if Present (Corresponding_Body (Act_Decl)) then
10144 return;
10145 end if;
10146
10147 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10148
10149 -- Re-establish the state of information on which checks are suppressed.
10150 -- This information was set in Body_Info at the point of instantiation,
10151 -- and now we restore it so that the instance is compiled using the
10152 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10153
10154 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10155 Scope_Suppress := Body_Info.Scope_Suppress;
10156 Opt.Ada_Version := Body_Info.Version;
10157
10158 if No (Gen_Body_Id) then
10159
10160 -- For imported generic subprogram, no body to compile, complete
10161 -- the spec entity appropriately.
10162
10163 if Is_Imported (Gen_Unit) then
10164 Set_Is_Imported (Anon_Id);
10165 Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10166 Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10167 Set_Convention (Anon_Id, Convention (Gen_Unit));
10168 Set_Has_Completion (Anon_Id);
10169 return;
10170
10171 -- For other cases, compile the body
10172
10173 else
10174 Load_Parent_Of_Generic
10175 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10176 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10177 end if;
10178 end if;
10179
10180 Instantiation_Node := Inst_Node;
10181
10182 if Present (Gen_Body_Id) then
10183 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10184
10185 if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10186
10187 -- Either body is not present, or context is non-expanding, as
10188 -- when compiling a subunit. Mark the instance as completed, and
10189 -- diagnose a missing body when needed.
10190
10191 if Expander_Active
10192 and then Operating_Mode = Generate_Code
10193 then
10194 Error_Msg_N
10195 ("missing proper body for instantiation", Gen_Body);
10196 end if;
10197
10198 Set_Has_Completion (Anon_Id);
10199 return;
10200 end if;
10201
10202 Save_Env (Gen_Unit, Anon_Id);
10203 Style_Check := False;
10204 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10205 Create_Instantiation_Source
10206 (Inst_Node,
10207 Gen_Body_Id,
10208 False,
10209 S_Adjustment);
10210
10211 Act_Body :=
10212 Copy_Generic_Node
10213 (Original_Node (Gen_Body), Empty, Instantiating => True);
10214
10215 -- Create proper defining name for the body, to correspond to
10216 -- the one in the spec.
10217
10218 Set_Defining_Unit_Name (Specification (Act_Body),
10219 Make_Defining_Identifier
10220 (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10221 Set_Corresponding_Spec (Act_Body, Anon_Id);
10222 Set_Has_Completion (Anon_Id);
10223 Check_Generic_Actuals (Pack_Id, False);
10224
10225 -- Generate a reference to link the visible subprogram instance to
10226 -- the generic body, which for navigation purposes is the only
10227 -- available source for the instance.
10228
10229 Generate_Reference
10230 (Related_Instance (Pack_Id),
10231 Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10232
10233 -- If it is a child unit, make the parent instance (which is an
10234 -- instance of the parent of the generic) visible. The parent
10235 -- instance is the prefix of the name of the generic unit.
10236
10237 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10238 and then Nkind (Gen_Id) = N_Expanded_Name
10239 then
10240 Par_Ent := Entity (Prefix (Gen_Id));
10241 Par_Vis := Is_Immediately_Visible (Par_Ent);
10242 Install_Parent (Par_Ent, In_Body => True);
10243 Parent_Installed := True;
10244
10245 elsif Is_Child_Unit (Gen_Unit) then
10246 Par_Ent := Scope (Gen_Unit);
10247 Par_Vis := Is_Immediately_Visible (Par_Ent);
10248 Install_Parent (Par_Ent, In_Body => True);
10249 Parent_Installed := True;
10250 end if;
10251
10252 -- Inside its body, a reference to the generic unit is a reference
10253 -- to the instance. The corresponding renaming is the first
10254 -- declaration in the body.
10255
10256 Unit_Renaming :=
10257 Make_Subprogram_Renaming_Declaration (Loc,
10258 Specification =>
10259 Copy_Generic_Node (
10260 Specification (Original_Node (Gen_Body)),
10261 Empty,
10262 Instantiating => True),
10263 Name => New_Occurrence_Of (Anon_Id, Loc));
10264
10265 -- If there is a formal subprogram with the same name as the unit
10266 -- itself, do not add this renaming declaration. This is a temporary
10267 -- fix for one ACVC test. ???
10268
10269 Prev_Formal := First_Entity (Pack_Id);
10270 while Present (Prev_Formal) loop
10271 if Chars (Prev_Formal) = Chars (Gen_Unit)
10272 and then Is_Overloadable (Prev_Formal)
10273 then
10274 exit;
10275 end if;
10276
10277 Next_Entity (Prev_Formal);
10278 end loop;
10279
10280 if Present (Prev_Formal) then
10281 Decls := New_List (Act_Body);
10282 else
10283 Decls := New_List (Unit_Renaming, Act_Body);
10284 end if;
10285
10286 -- The subprogram body is placed in the body of a dummy package body,
10287 -- whose spec contains the subprogram declaration as well as the
10288 -- renaming declarations for the generic parameters.
10289
10290 Pack_Body := Make_Package_Body (Loc,
10291 Defining_Unit_Name => New_Copy (Pack_Id),
10292 Declarations => Decls);
10293
10294 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10295
10296 -- If the instantiation is a library unit, then build resulting
10297 -- compilation unit nodes for the instance. The declaration of
10298 -- the enclosing package is the grandparent of the subprogram
10299 -- declaration. First replace the instantiation node as the unit
10300 -- of the corresponding compilation.
10301
10302 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10303 if Parent (Inst_Node) = Cunit (Main_Unit) then
10304 Set_Unit (Parent (Inst_Node), Inst_Node);
10305 Build_Instance_Compilation_Unit_Nodes
10306 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10307 Analyze (Inst_Node);
10308 else
10309 Set_Parent (Pack_Body, Parent (Inst_Node));
10310 Analyze (Pack_Body);
10311 end if;
10312
10313 else
10314 Insert_Before (Inst_Node, Pack_Body);
10315 Mark_Rewrite_Insertion (Pack_Body);
10316 Analyze (Pack_Body);
10317
10318 if Expander_Active then
10319 Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10320 end if;
10321 end if;
10322
10323 Inherit_Context (Gen_Body, Inst_Node);
10324
10325 Restore_Private_Views (Pack_Id, False);
10326
10327 if Parent_Installed then
10328 Remove_Parent (In_Body => True);
10329
10330 -- Restore the previous visibility of the parent
10331
10332 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10333 end if;
10334
10335 Restore_Env;
10336 Style_Check := Save_Style_Check;
10337
10338 -- Body not found. Error was emitted already. If there were no previous
10339 -- errors, this may be an instance whose scope is a premature instance.
10340 -- In that case we must insure that the (legal) program does raise
10341 -- program error if executed. We generate a subprogram body for this
10342 -- purpose. See DEC ac30vso.
10343
10344 -- Should not reference proprietary DEC tests in comments ???
10345
10346 elsif Serious_Errors_Detected = 0
10347 and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
10348 then
10349 if Body_Optional then
10350 return;
10351
10352 elsif Ekind (Anon_Id) = E_Procedure then
10353 Act_Body :=
10354 Make_Subprogram_Body (Loc,
10355 Specification =>
10356 Make_Procedure_Specification (Loc,
10357 Defining_Unit_Name =>
10358 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10359 Parameter_Specifications =>
10360 New_Copy_List
10361 (Parameter_Specifications (Parent (Anon_Id)))),
10362
10363 Declarations => Empty_List,
10364 Handled_Statement_Sequence =>
10365 Make_Handled_Sequence_Of_Statements (Loc,
10366 Statements =>
10367 New_List (
10368 Make_Raise_Program_Error (Loc,
10369 Reason =>
10370 PE_Access_Before_Elaboration))));
10371
10372 else
10373 Ret_Expr :=
10374 Make_Raise_Program_Error (Loc,
10375 Reason => PE_Access_Before_Elaboration);
10376
10377 Set_Etype (Ret_Expr, (Etype (Anon_Id)));
10378 Set_Analyzed (Ret_Expr);
10379
10380 Act_Body :=
10381 Make_Subprogram_Body (Loc,
10382 Specification =>
10383 Make_Function_Specification (Loc,
10384 Defining_Unit_Name =>
10385 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10386 Parameter_Specifications =>
10387 New_Copy_List
10388 (Parameter_Specifications (Parent (Anon_Id))),
10389 Result_Definition =>
10390 New_Occurrence_Of (Etype (Anon_Id), Loc)),
10391
10392 Declarations => Empty_List,
10393 Handled_Statement_Sequence =>
10394 Make_Handled_Sequence_Of_Statements (Loc,
10395 Statements =>
10396 New_List
10397 (Make_Simple_Return_Statement (Loc, Ret_Expr))));
10398 end if;
10399
10400 Pack_Body := Make_Package_Body (Loc,
10401 Defining_Unit_Name => New_Copy (Pack_Id),
10402 Declarations => New_List (Act_Body));
10403
10404 Insert_After (Inst_Node, Pack_Body);
10405 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10406 Analyze (Pack_Body);
10407 end if;
10408
10409 Expander_Mode_Restore;
10410 end Instantiate_Subprogram_Body;
10411
10412 ----------------------
10413 -- Instantiate_Type --
10414 ----------------------
10415
10416 function Instantiate_Type
10417 (Formal : Node_Id;
10418 Actual : Node_Id;
10419 Analyzed_Formal : Node_Id;
10420 Actual_Decls : List_Id) return List_Id
10421 is
10422 Gen_T : constant Entity_Id := Defining_Identifier (Formal);
10423 A_Gen_T : constant Entity_Id :=
10424 Defining_Identifier (Analyzed_Formal);
10425 Ancestor : Entity_Id := Empty;
10426 Def : constant Node_Id := Formal_Type_Definition (Formal);
10427 Act_T : Entity_Id;
10428 Decl_Node : Node_Id;
10429 Decl_Nodes : List_Id;
10430 Loc : Source_Ptr;
10431 Subt : Entity_Id;
10432
10433 procedure Validate_Array_Type_Instance;
10434 procedure Validate_Access_Subprogram_Instance;
10435 procedure Validate_Access_Type_Instance;
10436 procedure Validate_Derived_Type_Instance;
10437 procedure Validate_Derived_Interface_Type_Instance;
10438 procedure Validate_Discriminated_Formal_Type;
10439 procedure Validate_Interface_Type_Instance;
10440 procedure Validate_Private_Type_Instance;
10441 procedure Validate_Incomplete_Type_Instance;
10442 -- These procedures perform validation tests for the named case.
10443 -- Validate_Discriminated_Formal_Type is shared by formal private
10444 -- types and Ada 2012 formal incomplete types.
10445
10446 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
10447 -- Check that base types are the same and that the subtypes match
10448 -- statically. Used in several of the above.
10449
10450 --------------------
10451 -- Subtypes_Match --
10452 --------------------
10453
10454 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
10455 T : constant Entity_Id := Get_Instance_Of (Gen_T);
10456
10457 begin
10458 -- Some detailed comments would be useful here ???
10459
10460 return ((Base_Type (T) = Act_T
10461 or else Base_Type (T) = Base_Type (Act_T))
10462 and then Subtypes_Statically_Match (T, Act_T))
10463
10464 or else (Is_Class_Wide_Type (Gen_T)
10465 and then Is_Class_Wide_Type (Act_T)
10466 and then Subtypes_Match
10467 (Get_Instance_Of (Root_Type (Gen_T)),
10468 Root_Type (Act_T)))
10469
10470 or else
10471 (Ekind_In (Gen_T, E_Anonymous_Access_Subprogram_Type,
10472 E_Anonymous_Access_Type)
10473 and then Ekind (Act_T) = Ekind (Gen_T)
10474 and then Subtypes_Statically_Match
10475 (Designated_Type (Gen_T), Designated_Type (Act_T)));
10476 end Subtypes_Match;
10477
10478 -----------------------------------------
10479 -- Validate_Access_Subprogram_Instance --
10480 -----------------------------------------
10481
10482 procedure Validate_Access_Subprogram_Instance is
10483 begin
10484 if not Is_Access_Type (Act_T)
10485 or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
10486 then
10487 Error_Msg_NE
10488 ("expect access type in instantiation of &", Actual, Gen_T);
10489 Abandon_Instantiation (Actual);
10490 end if;
10491
10492 -- According to AI05-288, actuals for access_to_subprograms must be
10493 -- subtype conformant with the generic formal. Previous to AI05-288
10494 -- only mode conformance was required.
10495
10496 -- This is a binding interpretation that applies to previous versions
10497 -- of the language, but for now we retain the milder check in order
10498 -- to preserve ACATS tests. These will be protested eventually ???
10499
10500 if Ada_Version < Ada_2012 then
10501 Check_Mode_Conformant
10502 (Designated_Type (Act_T),
10503 Designated_Type (A_Gen_T),
10504 Actual,
10505 Get_Inst => True);
10506
10507 else
10508 Check_Subtype_Conformant
10509 (Designated_Type (Act_T),
10510 Designated_Type (A_Gen_T),
10511 Actual,
10512 Get_Inst => True);
10513 end if;
10514
10515 if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
10516 if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
10517 Error_Msg_NE
10518 ("protected access type not allowed for formal &",
10519 Actual, Gen_T);
10520 end if;
10521
10522 elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
10523 Error_Msg_NE
10524 ("expect protected access type for formal &",
10525 Actual, Gen_T);
10526 end if;
10527 end Validate_Access_Subprogram_Instance;
10528
10529 -----------------------------------
10530 -- Validate_Access_Type_Instance --
10531 -----------------------------------
10532
10533 procedure Validate_Access_Type_Instance is
10534 Desig_Type : constant Entity_Id :=
10535 Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
10536 Desig_Act : Entity_Id;
10537
10538 begin
10539 if not Is_Access_Type (Act_T) then
10540 Error_Msg_NE
10541 ("expect access type in instantiation of &", Actual, Gen_T);
10542 Abandon_Instantiation (Actual);
10543 end if;
10544
10545 if Is_Access_Constant (A_Gen_T) then
10546 if not Is_Access_Constant (Act_T) then
10547 Error_Msg_N
10548 ("actual type must be access-to-constant type", Actual);
10549 Abandon_Instantiation (Actual);
10550 end if;
10551 else
10552 if Is_Access_Constant (Act_T) then
10553 Error_Msg_N
10554 ("actual type must be access-to-variable type", Actual);
10555 Abandon_Instantiation (Actual);
10556
10557 elsif Ekind (A_Gen_T) = E_General_Access_Type
10558 and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
10559 then
10560 Error_Msg_N -- CODEFIX
10561 ("actual must be general access type!", Actual);
10562 Error_Msg_NE -- CODEFIX
10563 ("add ALL to }!", Actual, Act_T);
10564 Abandon_Instantiation (Actual);
10565 end if;
10566 end if;
10567
10568 -- The designated subtypes, that is to say the subtypes introduced
10569 -- by an access type declaration (and not by a subtype declaration)
10570 -- must match.
10571
10572 Desig_Act := Designated_Type (Base_Type (Act_T));
10573
10574 -- The designated type may have been introduced through a limited_
10575 -- with clause, in which case retrieve the non-limited view. This
10576 -- applies to incomplete types as well as to class-wide types.
10577
10578 if From_With_Type (Desig_Act) then
10579 Desig_Act := Available_View (Desig_Act);
10580 end if;
10581
10582 if not Subtypes_Match
10583 (Desig_Type, Desig_Act) then
10584 Error_Msg_NE
10585 ("designated type of actual does not match that of formal &",
10586 Actual, Gen_T);
10587 Abandon_Instantiation (Actual);
10588
10589 elsif Is_Access_Type (Designated_Type (Act_T))
10590 and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
10591 /=
10592 Is_Constrained (Designated_Type (Desig_Type))
10593 then
10594 Error_Msg_NE
10595 ("designated type of actual does not match that of formal &",
10596 Actual, Gen_T);
10597 Abandon_Instantiation (Actual);
10598 end if;
10599
10600 -- Ada 2005: null-exclusion indicators of the two types must agree
10601
10602 if Can_Never_Be_Null (A_Gen_T) /= Can_Never_Be_Null (Act_T) then
10603 Error_Msg_NE
10604 ("non null exclusion of actual and formal & do not match",
10605 Actual, Gen_T);
10606 end if;
10607 end Validate_Access_Type_Instance;
10608
10609 ----------------------------------
10610 -- Validate_Array_Type_Instance --
10611 ----------------------------------
10612
10613 procedure Validate_Array_Type_Instance is
10614 I1 : Node_Id;
10615 I2 : Node_Id;
10616 T2 : Entity_Id;
10617
10618 function Formal_Dimensions return Int;
10619 -- Count number of dimensions in array type formal
10620
10621 -----------------------
10622 -- Formal_Dimensions --
10623 -----------------------
10624
10625 function Formal_Dimensions return Int is
10626 Num : Int := 0;
10627 Index : Node_Id;
10628
10629 begin
10630 if Nkind (Def) = N_Constrained_Array_Definition then
10631 Index := First (Discrete_Subtype_Definitions (Def));
10632 else
10633 Index := First (Subtype_Marks (Def));
10634 end if;
10635
10636 while Present (Index) loop
10637 Num := Num + 1;
10638 Next_Index (Index);
10639 end loop;
10640
10641 return Num;
10642 end Formal_Dimensions;
10643
10644 -- Start of processing for Validate_Array_Type_Instance
10645
10646 begin
10647 if not Is_Array_Type (Act_T) then
10648 Error_Msg_NE
10649 ("expect array type in instantiation of &", Actual, Gen_T);
10650 Abandon_Instantiation (Actual);
10651
10652 elsif Nkind (Def) = N_Constrained_Array_Definition then
10653 if not (Is_Constrained (Act_T)) then
10654 Error_Msg_NE
10655 ("expect constrained array in instantiation of &",
10656 Actual, Gen_T);
10657 Abandon_Instantiation (Actual);
10658 end if;
10659
10660 else
10661 if Is_Constrained (Act_T) then
10662 Error_Msg_NE
10663 ("expect unconstrained array in instantiation of &",
10664 Actual, Gen_T);
10665 Abandon_Instantiation (Actual);
10666 end if;
10667 end if;
10668
10669 if Formal_Dimensions /= Number_Dimensions (Act_T) then
10670 Error_Msg_NE
10671 ("dimensions of actual do not match formal &", Actual, Gen_T);
10672 Abandon_Instantiation (Actual);
10673 end if;
10674
10675 I1 := First_Index (A_Gen_T);
10676 I2 := First_Index (Act_T);
10677 for J in 1 .. Formal_Dimensions loop
10678
10679 -- If the indexes of the actual were given by a subtype_mark,
10680 -- the index was transformed into a range attribute. Retrieve
10681 -- the original type mark for checking.
10682
10683 if Is_Entity_Name (Original_Node (I2)) then
10684 T2 := Entity (Original_Node (I2));
10685 else
10686 T2 := Etype (I2);
10687 end if;
10688
10689 if not Subtypes_Match
10690 (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
10691 then
10692 Error_Msg_NE
10693 ("index types of actual do not match those of formal &",
10694 Actual, Gen_T);
10695 Abandon_Instantiation (Actual);
10696 end if;
10697
10698 Next_Index (I1);
10699 Next_Index (I2);
10700 end loop;
10701
10702 -- Check matching subtypes. Note that there are complex visibility
10703 -- issues when the generic is a child unit and some aspect of the
10704 -- generic type is declared in a parent unit of the generic. We do
10705 -- the test to handle this special case only after a direct check
10706 -- for static matching has failed. The case where both the component
10707 -- type and the array type are separate formals, and the component
10708 -- type is a private view may also require special checking in
10709 -- Subtypes_Match.
10710
10711 if Subtypes_Match
10712 (Component_Type (A_Gen_T), Component_Type (Act_T))
10713 or else Subtypes_Match
10714 (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
10715 Component_Type (Act_T))
10716 then
10717 null;
10718 else
10719 Error_Msg_NE
10720 ("component subtype of actual does not match that of formal &",
10721 Actual, Gen_T);
10722 Abandon_Instantiation (Actual);
10723 end if;
10724
10725 if Has_Aliased_Components (A_Gen_T)
10726 and then not Has_Aliased_Components (Act_T)
10727 then
10728 Error_Msg_NE
10729 ("actual must have aliased components to match formal type &",
10730 Actual, Gen_T);
10731 end if;
10732 end Validate_Array_Type_Instance;
10733
10734 -----------------------------------------------
10735 -- Validate_Derived_Interface_Type_Instance --
10736 -----------------------------------------------
10737
10738 procedure Validate_Derived_Interface_Type_Instance is
10739 Par : constant Entity_Id := Entity (Subtype_Indication (Def));
10740 Elmt : Elmt_Id;
10741
10742 begin
10743 -- First apply interface instance checks
10744
10745 Validate_Interface_Type_Instance;
10746
10747 -- Verify that immediate parent interface is an ancestor of
10748 -- the actual.
10749
10750 if Present (Par)
10751 and then not Interface_Present_In_Ancestor (Act_T, Par)
10752 then
10753 Error_Msg_NE
10754 ("interface actual must include progenitor&", Actual, Par);
10755 end if;
10756
10757 -- Now verify that the actual includes all other ancestors of
10758 -- the formal.
10759
10760 Elmt := First_Elmt (Interfaces (A_Gen_T));
10761 while Present (Elmt) loop
10762 if not Interface_Present_In_Ancestor
10763 (Act_T, Get_Instance_Of (Node (Elmt)))
10764 then
10765 Error_Msg_NE
10766 ("interface actual must include progenitor&",
10767 Actual, Node (Elmt));
10768 end if;
10769
10770 Next_Elmt (Elmt);
10771 end loop;
10772 end Validate_Derived_Interface_Type_Instance;
10773
10774 ------------------------------------
10775 -- Validate_Derived_Type_Instance --
10776 ------------------------------------
10777
10778 procedure Validate_Derived_Type_Instance is
10779 Actual_Discr : Entity_Id;
10780 Ancestor_Discr : Entity_Id;
10781
10782 begin
10783 -- If the parent type in the generic declaration is itself a previous
10784 -- formal type, then it is local to the generic and absent from the
10785 -- analyzed generic definition. In that case the ancestor is the
10786 -- instance of the formal (which must have been instantiated
10787 -- previously), unless the ancestor is itself a formal derived type.
10788 -- In this latter case (which is the subject of Corrigendum 8652/0038
10789 -- (AI-202) the ancestor of the formals is the ancestor of its
10790 -- parent. Otherwise, the analyzed generic carries the parent type.
10791 -- If the parent type is defined in a previous formal package, then
10792 -- the scope of that formal package is that of the generic type
10793 -- itself, and it has already been mapped into the corresponding type
10794 -- in the actual package.
10795
10796 -- Common case: parent type defined outside of the generic
10797
10798 if Is_Entity_Name (Subtype_Mark (Def))
10799 and then Present (Entity (Subtype_Mark (Def)))
10800 then
10801 Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
10802
10803 -- Check whether parent is defined in a previous formal package
10804
10805 elsif
10806 Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
10807 then
10808 Ancestor :=
10809 Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
10810
10811 -- The type may be a local derivation, or a type extension of a
10812 -- previous formal, or of a formal of a parent package.
10813
10814 elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
10815 or else
10816 Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
10817 then
10818 -- Check whether the parent is another derived formal type in the
10819 -- same generic unit.
10820
10821 if Etype (A_Gen_T) /= A_Gen_T
10822 and then Is_Generic_Type (Etype (A_Gen_T))
10823 and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
10824 and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
10825 then
10826 -- Locate ancestor of parent from the subtype declaration
10827 -- created for the actual.
10828
10829 declare
10830 Decl : Node_Id;
10831
10832 begin
10833 Decl := First (Actual_Decls);
10834 while Present (Decl) loop
10835 if Nkind (Decl) = N_Subtype_Declaration
10836 and then Chars (Defining_Identifier (Decl)) =
10837 Chars (Etype (A_Gen_T))
10838 then
10839 Ancestor := Generic_Parent_Type (Decl);
10840 exit;
10841 else
10842 Next (Decl);
10843 end if;
10844 end loop;
10845 end;
10846
10847 pragma Assert (Present (Ancestor));
10848
10849 -- The ancestor itself may be a previous formal that has been
10850 -- instantiated.
10851
10852 Ancestor := Get_Instance_Of (Ancestor);
10853
10854 else
10855 Ancestor :=
10856 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
10857 end if;
10858
10859 -- An unusual case: the actual is a type declared in a parent unit,
10860 -- but is not a formal type so there is no instance_of for it.
10861 -- Retrieve it by analyzing the record extension.
10862
10863 elsif Is_Child_Unit (Scope (A_Gen_T))
10864 and then In_Open_Scopes (Scope (Act_T))
10865 and then Is_Generic_Instance (Scope (Act_T))
10866 then
10867 Analyze (Subtype_Mark (Def));
10868 Ancestor := Entity (Subtype_Mark (Def));
10869
10870 else
10871 Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
10872 end if;
10873
10874 -- If the formal derived type has pragma Preelaborable_Initialization
10875 -- then the actual type must have preelaborable initialization.
10876
10877 if Known_To_Have_Preelab_Init (A_Gen_T)
10878 and then not Has_Preelaborable_Initialization (Act_T)
10879 then
10880 Error_Msg_NE
10881 ("actual for & must have preelaborable initialization",
10882 Actual, Gen_T);
10883 end if;
10884
10885 -- Ada 2005 (AI-251)
10886
10887 if Ada_Version >= Ada_2005
10888 and then Is_Interface (Ancestor)
10889 then
10890 if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
10891 Error_Msg_NE
10892 ("(Ada 2005) expected type implementing & in instantiation",
10893 Actual, Ancestor);
10894 end if;
10895
10896 elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
10897 Error_Msg_NE
10898 ("expect type derived from & in instantiation",
10899 Actual, First_Subtype (Ancestor));
10900 Abandon_Instantiation (Actual);
10901 end if;
10902
10903 -- Ada 2005 (AI-443): Synchronized formal derived type checks. Note
10904 -- that the formal type declaration has been rewritten as a private
10905 -- extension.
10906
10907 if Ada_Version >= Ada_2005
10908 and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
10909 and then Synchronized_Present (Parent (A_Gen_T))
10910 then
10911 -- The actual must be a synchronized tagged type
10912
10913 if not Is_Tagged_Type (Act_T) then
10914 Error_Msg_N
10915 ("actual of synchronized type must be tagged", Actual);
10916 Abandon_Instantiation (Actual);
10917
10918 elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
10919 and then Nkind (Type_Definition (Parent (Act_T))) =
10920 N_Derived_Type_Definition
10921 and then not Synchronized_Present (Type_Definition
10922 (Parent (Act_T)))
10923 then
10924 Error_Msg_N
10925 ("actual of synchronized type must be synchronized", Actual);
10926 Abandon_Instantiation (Actual);
10927 end if;
10928 end if;
10929
10930 -- Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
10931 -- removes the second instance of the phrase "or allow pass by copy".
10932
10933 if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
10934 Error_Msg_N
10935 ("cannot have atomic actual type for non-atomic formal type",
10936 Actual);
10937
10938 elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
10939 Error_Msg_N
10940 ("cannot have volatile actual type for non-volatile formal type",
10941 Actual);
10942 end if;
10943
10944 -- It should not be necessary to check for unknown discriminants on
10945 -- Formal, but for some reason Has_Unknown_Discriminants is false for
10946 -- A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
10947 -- needs fixing. ???
10948
10949 if not Is_Indefinite_Subtype (A_Gen_T)
10950 and then not Unknown_Discriminants_Present (Formal)
10951 and then Is_Indefinite_Subtype (Act_T)
10952 then
10953 Error_Msg_N
10954 ("actual subtype must be constrained", Actual);
10955 Abandon_Instantiation (Actual);
10956 end if;
10957
10958 if not Unknown_Discriminants_Present (Formal) then
10959 if Is_Constrained (Ancestor) then
10960 if not Is_Constrained (Act_T) then
10961 Error_Msg_N
10962 ("actual subtype must be constrained", Actual);
10963 Abandon_Instantiation (Actual);
10964 end if;
10965
10966 -- Ancestor is unconstrained, Check if generic formal and actual
10967 -- agree on constrainedness. The check only applies to array types
10968 -- and discriminated types.
10969
10970 elsif Is_Constrained (Act_T) then
10971 if Ekind (Ancestor) = E_Access_Type
10972 or else
10973 (not Is_Constrained (A_Gen_T)
10974 and then Is_Composite_Type (A_Gen_T))
10975 then
10976 Error_Msg_N
10977 ("actual subtype must be unconstrained", Actual);
10978 Abandon_Instantiation (Actual);
10979 end if;
10980
10981 -- A class-wide type is only allowed if the formal has unknown
10982 -- discriminants.
10983
10984 elsif Is_Class_Wide_Type (Act_T)
10985 and then not Has_Unknown_Discriminants (Ancestor)
10986 then
10987 Error_Msg_NE
10988 ("actual for & cannot be a class-wide type", Actual, Gen_T);
10989 Abandon_Instantiation (Actual);
10990
10991 -- Otherwise, the formal and actual shall have the same number
10992 -- of discriminants and each discriminant of the actual must
10993 -- correspond to a discriminant of the formal.
10994
10995 elsif Has_Discriminants (Act_T)
10996 and then not Has_Unknown_Discriminants (Act_T)
10997 and then Has_Discriminants (Ancestor)
10998 then
10999 Actual_Discr := First_Discriminant (Act_T);
11000 Ancestor_Discr := First_Discriminant (Ancestor);
11001 while Present (Actual_Discr)
11002 and then Present (Ancestor_Discr)
11003 loop
11004 if Base_Type (Act_T) /= Base_Type (Ancestor) and then
11005 No (Corresponding_Discriminant (Actual_Discr))
11006 then
11007 Error_Msg_NE
11008 ("discriminant & does not correspond " &
11009 "to ancestor discriminant", Actual, Actual_Discr);
11010 Abandon_Instantiation (Actual);
11011 end if;
11012
11013 Next_Discriminant (Actual_Discr);
11014 Next_Discriminant (Ancestor_Discr);
11015 end loop;
11016
11017 if Present (Actual_Discr) or else Present (Ancestor_Discr) then
11018 Error_Msg_NE
11019 ("actual for & must have same number of discriminants",
11020 Actual, Gen_T);
11021 Abandon_Instantiation (Actual);
11022 end if;
11023
11024 -- This case should be caught by the earlier check for
11025 -- constrainedness, but the check here is added for completeness.
11026
11027 elsif Has_Discriminants (Act_T)
11028 and then not Has_Unknown_Discriminants (Act_T)
11029 then
11030 Error_Msg_NE
11031 ("actual for & must not have discriminants", Actual, Gen_T);
11032 Abandon_Instantiation (Actual);
11033
11034 elsif Has_Discriminants (Ancestor) then
11035 Error_Msg_NE
11036 ("actual for & must have known discriminants", Actual, Gen_T);
11037 Abandon_Instantiation (Actual);
11038 end if;
11039
11040 if not Subtypes_Statically_Compatible (Act_T, Ancestor) then
11041 Error_Msg_N
11042 ("constraint on actual is incompatible with formal", Actual);
11043 Abandon_Instantiation (Actual);
11044 end if;
11045 end if;
11046
11047 -- If the formal and actual types are abstract, check that there
11048 -- are no abstract primitives of the actual type that correspond to
11049 -- nonabstract primitives of the formal type (second sentence of
11050 -- RM95-3.9.3(9)).
11051
11052 if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
11053 Check_Abstract_Primitives : declare
11054 Gen_Prims : constant Elist_Id :=
11055 Primitive_Operations (A_Gen_T);
11056 Gen_Elmt : Elmt_Id;
11057 Gen_Subp : Entity_Id;
11058 Anc_Subp : Entity_Id;
11059 Anc_Formal : Entity_Id;
11060 Anc_F_Type : Entity_Id;
11061
11062 Act_Prims : constant Elist_Id := Primitive_Operations (Act_T);
11063 Act_Elmt : Elmt_Id;
11064 Act_Subp : Entity_Id;
11065 Act_Formal : Entity_Id;
11066 Act_F_Type : Entity_Id;
11067
11068 Subprograms_Correspond : Boolean;
11069
11070 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
11071 -- Returns true if T2 is derived directly or indirectly from
11072 -- T1, including derivations from interfaces. T1 and T2 are
11073 -- required to be specific tagged base types.
11074
11075 ------------------------
11076 -- Is_Tagged_Ancestor --
11077 ------------------------
11078
11079 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
11080 is
11081 Intfc_Elmt : Elmt_Id;
11082
11083 begin
11084 -- The predicate is satisfied if the types are the same
11085
11086 if T1 = T2 then
11087 return True;
11088
11089 -- If we've reached the top of the derivation chain then
11090 -- we know that T1 is not an ancestor of T2.
11091
11092 elsif Etype (T2) = T2 then
11093 return False;
11094
11095 -- Proceed to check T2's immediate parent
11096
11097 elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
11098 return True;
11099
11100 -- Finally, check to see if T1 is an ancestor of any of T2's
11101 -- progenitors.
11102
11103 else
11104 Intfc_Elmt := First_Elmt (Interfaces (T2));
11105 while Present (Intfc_Elmt) loop
11106 if Is_Ancestor (T1, Node (Intfc_Elmt)) then
11107 return True;
11108 end if;
11109
11110 Next_Elmt (Intfc_Elmt);
11111 end loop;
11112 end if;
11113
11114 return False;
11115 end Is_Tagged_Ancestor;
11116
11117 -- Start of processing for Check_Abstract_Primitives
11118
11119 begin
11120 -- Loop over all of the formal derived type's primitives
11121
11122 Gen_Elmt := First_Elmt (Gen_Prims);
11123 while Present (Gen_Elmt) loop
11124 Gen_Subp := Node (Gen_Elmt);
11125
11126 -- If the primitive of the formal is not abstract, then
11127 -- determine whether there is a corresponding primitive of
11128 -- the actual type that's abstract.
11129
11130 if not Is_Abstract_Subprogram (Gen_Subp) then
11131 Act_Elmt := First_Elmt (Act_Prims);
11132 while Present (Act_Elmt) loop
11133 Act_Subp := Node (Act_Elmt);
11134
11135 -- If we find an abstract primitive of the actual,
11136 -- then we need to test whether it corresponds to the
11137 -- subprogram from which the generic formal primitive
11138 -- is inherited.
11139
11140 if Is_Abstract_Subprogram (Act_Subp) then
11141 Anc_Subp := Alias (Gen_Subp);
11142
11143 -- Test whether we have a corresponding primitive
11144 -- by comparing names, kinds, formal types, and
11145 -- result types.
11146
11147 if Chars (Anc_Subp) = Chars (Act_Subp)
11148 and then Ekind (Anc_Subp) = Ekind (Act_Subp)
11149 then
11150 Anc_Formal := First_Formal (Anc_Subp);
11151 Act_Formal := First_Formal (Act_Subp);
11152 while Present (Anc_Formal)
11153 and then Present (Act_Formal)
11154 loop
11155 Anc_F_Type := Etype (Anc_Formal);
11156 Act_F_Type := Etype (Act_Formal);
11157
11158 if Ekind (Anc_F_Type)
11159 = E_Anonymous_Access_Type
11160 then
11161 Anc_F_Type := Designated_Type (Anc_F_Type);
11162
11163 if Ekind (Act_F_Type)
11164 = E_Anonymous_Access_Type
11165 then
11166 Act_F_Type :=
11167 Designated_Type (Act_F_Type);
11168 else
11169 exit;
11170 end if;
11171
11172 elsif
11173 Ekind (Act_F_Type) = E_Anonymous_Access_Type
11174 then
11175 exit;
11176 end if;
11177
11178 Anc_F_Type := Base_Type (Anc_F_Type);
11179 Act_F_Type := Base_Type (Act_F_Type);
11180
11181 -- If the formal is controlling, then the
11182 -- the type of the actual primitive's formal
11183 -- must be derived directly or indirectly
11184 -- from the type of the ancestor primitive's
11185 -- formal.
11186
11187 if Is_Controlling_Formal (Anc_Formal) then
11188 if not Is_Tagged_Ancestor
11189 (Anc_F_Type, Act_F_Type)
11190 then
11191 exit;
11192 end if;
11193
11194 -- Otherwise the types of the formals must
11195 -- be the same.
11196
11197 elsif Anc_F_Type /= Act_F_Type then
11198 exit;
11199 end if;
11200
11201 Next_Entity (Anc_Formal);
11202 Next_Entity (Act_Formal);
11203 end loop;
11204
11205 -- If we traversed through all of the formals
11206 -- then so far the subprograms correspond, so
11207 -- now check that any result types correspond.
11208
11209 if No (Anc_Formal) and then No (Act_Formal) then
11210 Subprograms_Correspond := True;
11211
11212 if Ekind (Act_Subp) = E_Function then
11213 Anc_F_Type := Etype (Anc_Subp);
11214 Act_F_Type := Etype (Act_Subp);
11215
11216 if Ekind (Anc_F_Type)
11217 = E_Anonymous_Access_Type
11218 then
11219 Anc_F_Type :=
11220 Designated_Type (Anc_F_Type);
11221
11222 if Ekind (Act_F_Type)
11223 = E_Anonymous_Access_Type
11224 then
11225 Act_F_Type :=
11226 Designated_Type (Act_F_Type);
11227 else
11228 Subprograms_Correspond := False;
11229 end if;
11230
11231 elsif
11232 Ekind (Act_F_Type)
11233 = E_Anonymous_Access_Type
11234 then
11235 Subprograms_Correspond := False;
11236 end if;
11237
11238 Anc_F_Type := Base_Type (Anc_F_Type);
11239 Act_F_Type := Base_Type (Act_F_Type);
11240
11241 -- Now either the result types must be
11242 -- the same or, if the result type is
11243 -- controlling, the result type of the
11244 -- actual primitive must descend from the
11245 -- result type of the ancestor primitive.
11246
11247 if Subprograms_Correspond
11248 and then Anc_F_Type /= Act_F_Type
11249 and then
11250 Has_Controlling_Result (Anc_Subp)
11251 and then
11252 not Is_Tagged_Ancestor
11253 (Anc_F_Type, Act_F_Type)
11254 then
11255 Subprograms_Correspond := False;
11256 end if;
11257 end if;
11258
11259 -- Found a matching subprogram belonging to
11260 -- formal ancestor type, so actual subprogram
11261 -- corresponds and this violates 3.9.3(9).
11262
11263 if Subprograms_Correspond then
11264 Error_Msg_NE
11265 ("abstract subprogram & overrides " &
11266 "nonabstract subprogram of ancestor",
11267 Actual,
11268 Act_Subp);
11269 end if;
11270 end if;
11271 end if;
11272 end if;
11273
11274 Next_Elmt (Act_Elmt);
11275 end loop;
11276 end if;
11277
11278 Next_Elmt (Gen_Elmt);
11279 end loop;
11280 end Check_Abstract_Primitives;
11281 end if;
11282
11283 -- Verify that limitedness matches. If parent is a limited
11284 -- interface then the generic formal is not unless declared
11285 -- explicitly so. If not declared limited, the actual cannot be
11286 -- limited (see AI05-0087).
11287
11288 -- Even though this AI is a binding interpretation, we enable the
11289 -- check only in Ada 2012 mode, because this improper construct
11290 -- shows up in user code and in existing B-tests.
11291
11292 if Is_Limited_Type (Act_T)
11293 and then not Is_Limited_Type (A_Gen_T)
11294 and then Ada_Version >= Ada_2012
11295 then
11296 if In_Instance then
11297 null;
11298 else
11299 Error_Msg_NE
11300 ("actual for non-limited & cannot be a limited type", Actual,
11301 Gen_T);
11302 Explain_Limited_Type (Act_T, Actual);
11303 Abandon_Instantiation (Actual);
11304 end if;
11305 end if;
11306 end Validate_Derived_Type_Instance;
11307
11308 ----------------------------------------
11309 -- Validate_Discriminated_Formal_Type --
11310 ----------------------------------------
11311
11312 procedure Validate_Discriminated_Formal_Type is
11313 Formal_Discr : Entity_Id;
11314 Actual_Discr : Entity_Id;
11315 Formal_Subt : Entity_Id;
11316
11317 begin
11318 if Has_Discriminants (A_Gen_T) then
11319 if not Has_Discriminants (Act_T) then
11320 Error_Msg_NE
11321 ("actual for & must have discriminants", Actual, Gen_T);
11322 Abandon_Instantiation (Actual);
11323
11324 elsif Is_Constrained (Act_T) then
11325 Error_Msg_NE
11326 ("actual for & must be unconstrained", Actual, Gen_T);
11327 Abandon_Instantiation (Actual);
11328
11329 else
11330 Formal_Discr := First_Discriminant (A_Gen_T);
11331 Actual_Discr := First_Discriminant (Act_T);
11332 while Formal_Discr /= Empty loop
11333 if Actual_Discr = Empty then
11334 Error_Msg_NE
11335 ("discriminants on actual do not match formal",
11336 Actual, Gen_T);
11337 Abandon_Instantiation (Actual);
11338 end if;
11339
11340 Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
11341
11342 -- Access discriminants match if designated types do
11343
11344 if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
11345 and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
11346 E_Anonymous_Access_Type
11347 and then
11348 Get_Instance_Of
11349 (Designated_Type (Base_Type (Formal_Subt))) =
11350 Designated_Type (Base_Type (Etype (Actual_Discr)))
11351 then
11352 null;
11353
11354 elsif Base_Type (Formal_Subt) /=
11355 Base_Type (Etype (Actual_Discr))
11356 then
11357 Error_Msg_NE
11358 ("types of actual discriminants must match formal",
11359 Actual, Gen_T);
11360 Abandon_Instantiation (Actual);
11361
11362 elsif not Subtypes_Statically_Match
11363 (Formal_Subt, Etype (Actual_Discr))
11364 and then Ada_Version >= Ada_95
11365 then
11366 Error_Msg_NE
11367 ("subtypes of actual discriminants must match formal",
11368 Actual, Gen_T);
11369 Abandon_Instantiation (Actual);
11370 end if;
11371
11372 Next_Discriminant (Formal_Discr);
11373 Next_Discriminant (Actual_Discr);
11374 end loop;
11375
11376 if Actual_Discr /= Empty then
11377 Error_Msg_NE
11378 ("discriminants on actual do not match formal",
11379 Actual, Gen_T);
11380 Abandon_Instantiation (Actual);
11381 end if;
11382 end if;
11383 end if;
11384 end Validate_Discriminated_Formal_Type;
11385
11386 ---------------------------------------
11387 -- Validate_Incomplete_Type_Instance --
11388 ---------------------------------------
11389
11390 procedure Validate_Incomplete_Type_Instance is
11391 begin
11392 if not Is_Tagged_Type (Act_T)
11393 and then Is_Tagged_Type (A_Gen_T)
11394 then
11395 Error_Msg_NE
11396 ("actual for & must be a tagged type", Actual, Gen_T);
11397 end if;
11398
11399 Validate_Discriminated_Formal_Type;
11400 end Validate_Incomplete_Type_Instance;
11401
11402 --------------------------------------
11403 -- Validate_Interface_Type_Instance --
11404 --------------------------------------
11405
11406 procedure Validate_Interface_Type_Instance is
11407 begin
11408 if not Is_Interface (Act_T) then
11409 Error_Msg_NE
11410 ("actual for formal interface type must be an interface",
11411 Actual, Gen_T);
11412
11413 elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
11414 or else
11415 Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
11416 or else
11417 Is_Protected_Interface (A_Gen_T) /=
11418 Is_Protected_Interface (Act_T)
11419 or else
11420 Is_Synchronized_Interface (A_Gen_T) /=
11421 Is_Synchronized_Interface (Act_T)
11422 then
11423 Error_Msg_NE
11424 ("actual for interface& does not match (RM 12.5.5(4))",
11425 Actual, Gen_T);
11426 end if;
11427 end Validate_Interface_Type_Instance;
11428
11429 ------------------------------------
11430 -- Validate_Private_Type_Instance --
11431 ------------------------------------
11432
11433 procedure Validate_Private_Type_Instance is
11434 begin
11435 if Is_Limited_Type (Act_T)
11436 and then not Is_Limited_Type (A_Gen_T)
11437 then
11438 if In_Instance then
11439 null;
11440 else
11441 Error_Msg_NE
11442 ("actual for non-limited & cannot be a limited type", Actual,
11443 Gen_T);
11444 Explain_Limited_Type (Act_T, Actual);
11445 Abandon_Instantiation (Actual);
11446 end if;
11447
11448 elsif Known_To_Have_Preelab_Init (A_Gen_T)
11449 and then not Has_Preelaborable_Initialization (Act_T)
11450 then
11451 Error_Msg_NE
11452 ("actual for & must have preelaborable initialization", Actual,
11453 Gen_T);
11454
11455 elsif Is_Indefinite_Subtype (Act_T)
11456 and then not Is_Indefinite_Subtype (A_Gen_T)
11457 and then Ada_Version >= Ada_95
11458 then
11459 Error_Msg_NE
11460 ("actual for & must be a definite subtype", Actual, Gen_T);
11461
11462 elsif not Is_Tagged_Type (Act_T)
11463 and then Is_Tagged_Type (A_Gen_T)
11464 then
11465 Error_Msg_NE
11466 ("actual for & must be a tagged type", Actual, Gen_T);
11467 end if;
11468
11469 Validate_Discriminated_Formal_Type;
11470 Ancestor := Gen_T;
11471 end Validate_Private_Type_Instance;
11472
11473 -- Start of processing for Instantiate_Type
11474
11475 begin
11476 if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
11477 Error_Msg_N ("duplicate instantiation of generic type", Actual);
11478 return New_List (Error);
11479
11480 elsif not Is_Entity_Name (Actual)
11481 or else not Is_Type (Entity (Actual))
11482 then
11483 Error_Msg_NE
11484 ("expect valid subtype mark to instantiate &", Actual, Gen_T);
11485 Abandon_Instantiation (Actual);
11486
11487 else
11488 Act_T := Entity (Actual);
11489
11490 -- Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
11491 -- as a generic actual parameter if the corresponding formal type
11492 -- does not have a known_discriminant_part, or is a formal derived
11493 -- type that is an Unchecked_Union type.
11494
11495 if Is_Unchecked_Union (Base_Type (Act_T)) then
11496 if not Has_Discriminants (A_Gen_T)
11497 or else
11498 (Is_Derived_Type (A_Gen_T)
11499 and then
11500 Is_Unchecked_Union (A_Gen_T))
11501 then
11502 null;
11503 else
11504 Error_Msg_N ("unchecked union cannot be the actual for a" &
11505 " discriminated formal type", Act_T);
11506
11507 end if;
11508 end if;
11509
11510 -- Deal with fixed/floating restrictions
11511
11512 if Is_Floating_Point_Type (Act_T) then
11513 Check_Restriction (No_Floating_Point, Actual);
11514 elsif Is_Fixed_Point_Type (Act_T) then
11515 Check_Restriction (No_Fixed_Point, Actual);
11516 end if;
11517
11518 -- Deal with error of using incomplete type as generic actual.
11519 -- This includes limited views of a type, even if the non-limited
11520 -- view may be available.
11521
11522 if Ekind (Act_T) = E_Incomplete_Type
11523 or else (Is_Class_Wide_Type (Act_T)
11524 and then
11525 Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
11526 then
11527 -- If the formal is an incomplete type, the actual can be
11528 -- incomplete as well.
11529
11530 if Ekind (A_Gen_T) = E_Incomplete_Type then
11531 null;
11532
11533 elsif Is_Class_Wide_Type (Act_T)
11534 or else No (Full_View (Act_T))
11535 then
11536 Error_Msg_N ("premature use of incomplete type", Actual);
11537 Abandon_Instantiation (Actual);
11538 else
11539 Act_T := Full_View (Act_T);
11540 Set_Entity (Actual, Act_T);
11541
11542 if Has_Private_Component (Act_T) then
11543 Error_Msg_N
11544 ("premature use of type with private component", Actual);
11545 end if;
11546 end if;
11547
11548 -- Deal with error of premature use of private type as generic actual
11549
11550 elsif Is_Private_Type (Act_T)
11551 and then Is_Private_Type (Base_Type (Act_T))
11552 and then not Is_Generic_Type (Act_T)
11553 and then not Is_Derived_Type (Act_T)
11554 and then No (Full_View (Root_Type (Act_T)))
11555 then
11556 -- If the formal is an incomplete type, the actual can be
11557 -- private or incomplete as well.
11558
11559 if Ekind (A_Gen_T) = E_Incomplete_Type then
11560 null;
11561 else
11562 Error_Msg_N ("premature use of private type", Actual);
11563 end if;
11564
11565 elsif Has_Private_Component (Act_T) then
11566 Error_Msg_N
11567 ("premature use of type with private component", Actual);
11568 end if;
11569
11570 Set_Instance_Of (A_Gen_T, Act_T);
11571
11572 -- If the type is generic, the class-wide type may also be used
11573
11574 if Is_Tagged_Type (A_Gen_T)
11575 and then Is_Tagged_Type (Act_T)
11576 and then not Is_Class_Wide_Type (A_Gen_T)
11577 then
11578 Set_Instance_Of (Class_Wide_Type (A_Gen_T),
11579 Class_Wide_Type (Act_T));
11580 end if;
11581
11582 if not Is_Abstract_Type (A_Gen_T)
11583 and then Is_Abstract_Type (Act_T)
11584 then
11585 Error_Msg_N
11586 ("actual of non-abstract formal cannot be abstract", Actual);
11587 end if;
11588
11589 -- A generic scalar type is a first subtype for which we generate
11590 -- an anonymous base type. Indicate that the instance of this base
11591 -- is the base type of the actual.
11592
11593 if Is_Scalar_Type (A_Gen_T) then
11594 Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
11595 end if;
11596 end if;
11597
11598 if Error_Posted (Act_T) then
11599 null;
11600 else
11601 case Nkind (Def) is
11602 when N_Formal_Private_Type_Definition =>
11603 Validate_Private_Type_Instance;
11604
11605 when N_Formal_Incomplete_Type_Definition =>
11606 Validate_Incomplete_Type_Instance;
11607
11608 when N_Formal_Derived_Type_Definition =>
11609 Validate_Derived_Type_Instance;
11610
11611 when N_Formal_Discrete_Type_Definition =>
11612 if not Is_Discrete_Type (Act_T) then
11613 Error_Msg_NE
11614 ("expect discrete type in instantiation of&",
11615 Actual, Gen_T);
11616 Abandon_Instantiation (Actual);
11617 end if;
11618
11619 when N_Formal_Signed_Integer_Type_Definition =>
11620 if not Is_Signed_Integer_Type (Act_T) then
11621 Error_Msg_NE
11622 ("expect signed integer type in instantiation of&",
11623 Actual, Gen_T);
11624 Abandon_Instantiation (Actual);
11625 end if;
11626
11627 when N_Formal_Modular_Type_Definition =>
11628 if not Is_Modular_Integer_Type (Act_T) then
11629 Error_Msg_NE
11630 ("expect modular type in instantiation of &",
11631 Actual, Gen_T);
11632 Abandon_Instantiation (Actual);
11633 end if;
11634
11635 when N_Formal_Floating_Point_Definition =>
11636 if not Is_Floating_Point_Type (Act_T) then
11637 Error_Msg_NE
11638 ("expect float type in instantiation of &", Actual, Gen_T);
11639 Abandon_Instantiation (Actual);
11640 end if;
11641
11642 when N_Formal_Ordinary_Fixed_Point_Definition =>
11643 if not Is_Ordinary_Fixed_Point_Type (Act_T) then
11644 Error_Msg_NE
11645 ("expect ordinary fixed point type in instantiation of &",
11646 Actual, Gen_T);
11647 Abandon_Instantiation (Actual);
11648 end if;
11649
11650 when N_Formal_Decimal_Fixed_Point_Definition =>
11651 if not Is_Decimal_Fixed_Point_Type (Act_T) then
11652 Error_Msg_NE
11653 ("expect decimal type in instantiation of &",
11654 Actual, Gen_T);
11655 Abandon_Instantiation (Actual);
11656 end if;
11657
11658 when N_Array_Type_Definition =>
11659 Validate_Array_Type_Instance;
11660
11661 when N_Access_To_Object_Definition =>
11662 Validate_Access_Type_Instance;
11663
11664 when N_Access_Function_Definition |
11665 N_Access_Procedure_Definition =>
11666 Validate_Access_Subprogram_Instance;
11667
11668 when N_Record_Definition =>
11669 Validate_Interface_Type_Instance;
11670
11671 when N_Derived_Type_Definition =>
11672 Validate_Derived_Interface_Type_Instance;
11673
11674 when others =>
11675 raise Program_Error;
11676
11677 end case;
11678 end if;
11679
11680 Subt := New_Copy (Gen_T);
11681
11682 -- Use adjusted sloc of subtype name as the location for other nodes in
11683 -- the subtype declaration.
11684
11685 Loc := Sloc (Subt);
11686
11687 Decl_Node :=
11688 Make_Subtype_Declaration (Loc,
11689 Defining_Identifier => Subt,
11690 Subtype_Indication => New_Reference_To (Act_T, Loc));
11691
11692 if Is_Private_Type (Act_T) then
11693 Set_Has_Private_View (Subtype_Indication (Decl_Node));
11694
11695 elsif Is_Access_Type (Act_T)
11696 and then Is_Private_Type (Designated_Type (Act_T))
11697 then
11698 Set_Has_Private_View (Subtype_Indication (Decl_Node));
11699 end if;
11700
11701 Decl_Nodes := New_List (Decl_Node);
11702
11703 -- Flag actual derived types so their elaboration produces the
11704 -- appropriate renamings for the primitive operations of the ancestor.
11705 -- Flag actual for formal private types as well, to determine whether
11706 -- operations in the private part may override inherited operations.
11707 -- If the formal has an interface list, the ancestor is not the
11708 -- parent, but the analyzed formal that includes the interface
11709 -- operations of all its progenitors.
11710
11711 -- Same treatment for formal private types, so we can check whether the
11712 -- type is tagged limited when validating derivations in the private
11713 -- part. (See AI05-096).
11714
11715 if Nkind (Def) = N_Formal_Derived_Type_Definition then
11716 if Present (Interface_List (Def)) then
11717 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11718 else
11719 Set_Generic_Parent_Type (Decl_Node, Ancestor);
11720 end if;
11721
11722 elsif Nkind_In (Def,
11723 N_Formal_Private_Type_Definition,
11724 N_Formal_Incomplete_Type_Definition)
11725 then
11726 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11727 end if;
11728
11729 -- If the actual is a synchronized type that implements an interface,
11730 -- the primitive operations are attached to the corresponding record,
11731 -- and we have to treat it as an additional generic actual, so that its
11732 -- primitive operations become visible in the instance. The task or
11733 -- protected type itself does not carry primitive operations.
11734
11735 if Is_Concurrent_Type (Act_T)
11736 and then Is_Tagged_Type (Act_T)
11737 and then Present (Corresponding_Record_Type (Act_T))
11738 and then Present (Ancestor)
11739 and then Is_Interface (Ancestor)
11740 then
11741 declare
11742 Corr_Rec : constant Entity_Id :=
11743 Corresponding_Record_Type (Act_T);
11744 New_Corr : Entity_Id;
11745 Corr_Decl : Node_Id;
11746
11747 begin
11748 New_Corr := Make_Temporary (Loc, 'S');
11749 Corr_Decl :=
11750 Make_Subtype_Declaration (Loc,
11751 Defining_Identifier => New_Corr,
11752 Subtype_Indication =>
11753 New_Reference_To (Corr_Rec, Loc));
11754 Append_To (Decl_Nodes, Corr_Decl);
11755
11756 if Ekind (Act_T) = E_Task_Type then
11757 Set_Ekind (Subt, E_Task_Subtype);
11758 else
11759 Set_Ekind (Subt, E_Protected_Subtype);
11760 end if;
11761
11762 Set_Corresponding_Record_Type (Subt, Corr_Rec);
11763 Set_Generic_Parent_Type (Corr_Decl, Ancestor);
11764 Set_Generic_Parent_Type (Decl_Node, Empty);
11765 end;
11766 end if;
11767
11768 return Decl_Nodes;
11769 end Instantiate_Type;
11770
11771 ---------------------
11772 -- Is_In_Main_Unit --
11773 ---------------------
11774
11775 function Is_In_Main_Unit (N : Node_Id) return Boolean is
11776 Unum : constant Unit_Number_Type := Get_Source_Unit (N);
11777 Current_Unit : Node_Id;
11778
11779 begin
11780 if Unum = Main_Unit then
11781 return True;
11782
11783 -- If the current unit is a subunit then it is either the main unit or
11784 -- is being compiled as part of the main unit.
11785
11786 elsif Nkind (N) = N_Compilation_Unit then
11787 return Nkind (Unit (N)) = N_Subunit;
11788 end if;
11789
11790 Current_Unit := Parent (N);
11791 while Present (Current_Unit)
11792 and then Nkind (Current_Unit) /= N_Compilation_Unit
11793 loop
11794 Current_Unit := Parent (Current_Unit);
11795 end loop;
11796
11797 -- The instantiation node is in the main unit, or else the current node
11798 -- (perhaps as the result of nested instantiations) is in the main unit,
11799 -- or in the declaration of the main unit, which in this last case must
11800 -- be a body.
11801
11802 return Unum = Main_Unit
11803 or else Current_Unit = Cunit (Main_Unit)
11804 or else Current_Unit = Library_Unit (Cunit (Main_Unit))
11805 or else (Present (Library_Unit (Current_Unit))
11806 and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
11807 end Is_In_Main_Unit;
11808
11809 ----------------------------
11810 -- Load_Parent_Of_Generic --
11811 ----------------------------
11812
11813 procedure Load_Parent_Of_Generic
11814 (N : Node_Id;
11815 Spec : Node_Id;
11816 Body_Optional : Boolean := False)
11817 is
11818 Comp_Unit : constant Node_Id := Cunit (Get_Source_Unit (Spec));
11819 Save_Style_Check : constant Boolean := Style_Check;
11820 True_Parent : Node_Id;
11821 Inst_Node : Node_Id;
11822 OK : Boolean;
11823 Previous_Instances : constant Elist_Id := New_Elmt_List;
11824
11825 procedure Collect_Previous_Instances (Decls : List_Id);
11826 -- Collect all instantiations in the given list of declarations, that
11827 -- precede the generic that we need to load. If the bodies of these
11828 -- instantiations are available, we must analyze them, to ensure that
11829 -- the public symbols generated are the same when the unit is compiled
11830 -- to generate code, and when it is compiled in the context of a unit
11831 -- that needs a particular nested instance. This process is applied to
11832 -- both package and subprogram instances.
11833
11834 --------------------------------
11835 -- Collect_Previous_Instances --
11836 --------------------------------
11837
11838 procedure Collect_Previous_Instances (Decls : List_Id) is
11839 Decl : Node_Id;
11840
11841 begin
11842 Decl := First (Decls);
11843 while Present (Decl) loop
11844 if Sloc (Decl) >= Sloc (Inst_Node) then
11845 return;
11846
11847 -- If Decl is an instantiation, then record it as requiring
11848 -- instantiation of the corresponding body, except if it is an
11849 -- abbreviated instantiation generated internally for conformance
11850 -- checking purposes only for the case of a formal package
11851 -- declared without a box (see Instantiate_Formal_Package). Such
11852 -- an instantiation does not generate any code (the actual code
11853 -- comes from actual) and thus does not need to be analyzed here.
11854 -- If the instantiation appears with a generic package body it is
11855 -- not analyzed here either.
11856
11857 elsif Nkind (Decl) = N_Package_Instantiation
11858 and then not Is_Internal (Defining_Entity (Decl))
11859 then
11860 Append_Elmt (Decl, Previous_Instances);
11861
11862 -- For a subprogram instantiation, omit instantiations intrinsic
11863 -- operations (Unchecked_Conversions, etc.) that have no bodies.
11864
11865 elsif Nkind_In (Decl, N_Function_Instantiation,
11866 N_Procedure_Instantiation)
11867 and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
11868 then
11869 Append_Elmt (Decl, Previous_Instances);
11870
11871 elsif Nkind (Decl) = N_Package_Declaration then
11872 Collect_Previous_Instances
11873 (Visible_Declarations (Specification (Decl)));
11874 Collect_Previous_Instances
11875 (Private_Declarations (Specification (Decl)));
11876
11877 -- Previous non-generic bodies may contain instances as well
11878
11879 elsif Nkind (Decl) = N_Package_Body
11880 and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
11881 then
11882 Collect_Previous_Instances (Declarations (Decl));
11883
11884 elsif Nkind (Decl) = N_Subprogram_Body
11885 and then not Acts_As_Spec (Decl)
11886 and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
11887 then
11888 Collect_Previous_Instances (Declarations (Decl));
11889 end if;
11890
11891 Next (Decl);
11892 end loop;
11893 end Collect_Previous_Instances;
11894
11895 -- Start of processing for Load_Parent_Of_Generic
11896
11897 begin
11898 if not In_Same_Source_Unit (N, Spec)
11899 or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
11900 or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
11901 and then not Is_In_Main_Unit (Spec))
11902 then
11903 -- Find body of parent of spec, and analyze it. A special case arises
11904 -- when the parent is an instantiation, that is to say when we are
11905 -- currently instantiating a nested generic. In that case, there is
11906 -- no separate file for the body of the enclosing instance. Instead,
11907 -- the enclosing body must be instantiated as if it were a pending
11908 -- instantiation, in order to produce the body for the nested generic
11909 -- we require now. Note that in that case the generic may be defined
11910 -- in a package body, the instance defined in the same package body,
11911 -- and the original enclosing body may not be in the main unit.
11912
11913 Inst_Node := Empty;
11914
11915 True_Parent := Parent (Spec);
11916 while Present (True_Parent)
11917 and then Nkind (True_Parent) /= N_Compilation_Unit
11918 loop
11919 if Nkind (True_Parent) = N_Package_Declaration
11920 and then
11921 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
11922 then
11923 -- Parent is a compilation unit that is an instantiation.
11924 -- Instantiation node has been replaced with package decl.
11925
11926 Inst_Node := Original_Node (True_Parent);
11927 exit;
11928
11929 elsif Nkind (True_Parent) = N_Package_Declaration
11930 and then Present (Generic_Parent (Specification (True_Parent)))
11931 and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
11932 then
11933 -- Parent is an instantiation within another specification.
11934 -- Declaration for instance has been inserted before original
11935 -- instantiation node. A direct link would be preferable?
11936
11937 Inst_Node := Next (True_Parent);
11938 while Present (Inst_Node)
11939 and then Nkind (Inst_Node) /= N_Package_Instantiation
11940 loop
11941 Next (Inst_Node);
11942 end loop;
11943
11944 -- If the instance appears within a generic, and the generic
11945 -- unit is defined within a formal package of the enclosing
11946 -- generic, there is no generic body available, and none
11947 -- needed. A more precise test should be used ???
11948
11949 if No (Inst_Node) then
11950 return;
11951 end if;
11952
11953 exit;
11954
11955 else
11956 True_Parent := Parent (True_Parent);
11957 end if;
11958 end loop;
11959
11960 -- Case where we are currently instantiating a nested generic
11961
11962 if Present (Inst_Node) then
11963 if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
11964
11965 -- Instantiation node and declaration of instantiated package
11966 -- were exchanged when only the declaration was needed.
11967 -- Restore instantiation node before proceeding with body.
11968
11969 Set_Unit (Parent (True_Parent), Inst_Node);
11970 end if;
11971
11972 -- Now complete instantiation of enclosing body, if it appears in
11973 -- some other unit. If it appears in the current unit, the body
11974 -- will have been instantiated already.
11975
11976 if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
11977
11978 -- We need to determine the expander mode to instantiate the
11979 -- enclosing body. Because the generic body we need may use
11980 -- global entities declared in the enclosing package (including
11981 -- aggregates) it is in general necessary to compile this body
11982 -- with expansion enabled, except if we are within a generic
11983 -- package, in which case the usual generic rule applies.
11984
11985 declare
11986 Exp_Status : Boolean := True;
11987 Scop : Entity_Id;
11988
11989 begin
11990 -- Loop through scopes looking for generic package
11991
11992 Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
11993 while Present (Scop)
11994 and then Scop /= Standard_Standard
11995 loop
11996 if Ekind (Scop) = E_Generic_Package then
11997 Exp_Status := False;
11998 exit;
11999 end if;
12000
12001 Scop := Scope (Scop);
12002 end loop;
12003
12004 -- Collect previous instantiations in the unit that contains
12005 -- the desired generic.
12006
12007 if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12008 and then not Body_Optional
12009 then
12010 declare
12011 Decl : Elmt_Id;
12012 Info : Pending_Body_Info;
12013 Par : Node_Id;
12014
12015 begin
12016 Par := Parent (Inst_Node);
12017 while Present (Par) loop
12018 exit when Nkind (Parent (Par)) = N_Compilation_Unit;
12019 Par := Parent (Par);
12020 end loop;
12021
12022 pragma Assert (Present (Par));
12023
12024 if Nkind (Par) = N_Package_Body then
12025 Collect_Previous_Instances (Declarations (Par));
12026
12027 elsif Nkind (Par) = N_Package_Declaration then
12028 Collect_Previous_Instances
12029 (Visible_Declarations (Specification (Par)));
12030 Collect_Previous_Instances
12031 (Private_Declarations (Specification (Par)));
12032
12033 else
12034 -- Enclosing unit is a subprogram body. In this
12035 -- case all instance bodies are processed in order
12036 -- and there is no need to collect them separately.
12037
12038 null;
12039 end if;
12040
12041 Decl := First_Elmt (Previous_Instances);
12042 while Present (Decl) loop
12043 Info :=
12044 (Inst_Node => Node (Decl),
12045 Act_Decl =>
12046 Instance_Spec (Node (Decl)),
12047 Expander_Status => Exp_Status,
12048 Current_Sem_Unit =>
12049 Get_Code_Unit (Sloc (Node (Decl))),
12050 Scope_Suppress => Scope_Suppress,
12051 Local_Suppress_Stack_Top =>
12052 Local_Suppress_Stack_Top,
12053 Version => Ada_Version);
12054
12055 -- Package instance
12056
12057 if
12058 Nkind (Node (Decl)) = N_Package_Instantiation
12059 then
12060 Instantiate_Package_Body
12061 (Info, Body_Optional => True);
12062
12063 -- Subprogram instance
12064
12065 else
12066 -- The instance_spec is the wrapper package,
12067 -- and the subprogram declaration is the last
12068 -- declaration in the wrapper.
12069
12070 Info.Act_Decl :=
12071 Last
12072 (Visible_Declarations
12073 (Specification (Info.Act_Decl)));
12074
12075 Instantiate_Subprogram_Body
12076 (Info, Body_Optional => True);
12077 end if;
12078
12079 Next_Elmt (Decl);
12080 end loop;
12081 end;
12082 end if;
12083
12084 Instantiate_Package_Body
12085 (Body_Info =>
12086 ((Inst_Node => Inst_Node,
12087 Act_Decl => True_Parent,
12088 Expander_Status => Exp_Status,
12089 Current_Sem_Unit =>
12090 Get_Code_Unit (Sloc (Inst_Node)),
12091 Scope_Suppress => Scope_Suppress,
12092 Local_Suppress_Stack_Top =>
12093 Local_Suppress_Stack_Top,
12094 Version => Ada_Version)),
12095 Body_Optional => Body_Optional);
12096 end;
12097 end if;
12098
12099 -- Case where we are not instantiating a nested generic
12100
12101 else
12102 Opt.Style_Check := False;
12103 Expander_Mode_Save_And_Set (True);
12104 Load_Needed_Body (Comp_Unit, OK);
12105 Opt.Style_Check := Save_Style_Check;
12106 Expander_Mode_Restore;
12107
12108 if not OK
12109 and then Unit_Requires_Body (Defining_Entity (Spec))
12110 and then not Body_Optional
12111 then
12112 declare
12113 Bname : constant Unit_Name_Type :=
12114 Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
12115
12116 begin
12117 -- In CodePeer mode, the missing body may make the analysis
12118 -- incomplete, but we do not treat it as fatal.
12119
12120 if CodePeer_Mode then
12121 return;
12122
12123 else
12124 Error_Msg_Unit_1 := Bname;
12125 Error_Msg_N ("this instantiation requires$!", N);
12126 Error_Msg_File_1 :=
12127 Get_File_Name (Bname, Subunit => False);
12128 Error_Msg_N ("\but file{ was not found!", N);
12129 raise Unrecoverable_Error;
12130 end if;
12131 end;
12132 end if;
12133 end if;
12134 end if;
12135
12136 -- If loading parent of the generic caused an instantiation circularity,
12137 -- we abandon compilation at this point, because otherwise in some cases
12138 -- we get into trouble with infinite recursions after this point.
12139
12140 if Circularity_Detected then
12141 raise Unrecoverable_Error;
12142 end if;
12143 end Load_Parent_Of_Generic;
12144
12145 ---------------------------------
12146 -- Map_Formal_Package_Entities --
12147 ---------------------------------
12148
12149 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
12150 E1 : Entity_Id;
12151 E2 : Entity_Id;
12152
12153 begin
12154 Set_Instance_Of (Form, Act);
12155
12156 -- Traverse formal and actual package to map the corresponding entities.
12157 -- We skip over internal entities that may be generated during semantic
12158 -- analysis, and find the matching entities by name, given that they
12159 -- must appear in the same order.
12160
12161 E1 := First_Entity (Form);
12162 E2 := First_Entity (Act);
12163 while Present (E1) and then E1 /= First_Private_Entity (Form) loop
12164 -- Could this test be a single condition??? Seems like it could, and
12165 -- isn't FPE (Form) a constant anyway???
12166
12167 if not Is_Internal (E1)
12168 and then Present (Parent (E1))
12169 and then not Is_Class_Wide_Type (E1)
12170 and then not Is_Internal_Name (Chars (E1))
12171 then
12172 while Present (E2) and then Chars (E2) /= Chars (E1) loop
12173 Next_Entity (E2);
12174 end loop;
12175
12176 if No (E2) then
12177 exit;
12178 else
12179 Set_Instance_Of (E1, E2);
12180
12181 if Is_Type (E1) and then Is_Tagged_Type (E2) then
12182 Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
12183 end if;
12184
12185 if Is_Constrained (E1) then
12186 Set_Instance_Of (Base_Type (E1), Base_Type (E2));
12187 end if;
12188
12189 if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
12190 Map_Formal_Package_Entities (E1, E2);
12191 end if;
12192 end if;
12193 end if;
12194
12195 Next_Entity (E1);
12196 end loop;
12197 end Map_Formal_Package_Entities;
12198
12199 -----------------------
12200 -- Move_Freeze_Nodes --
12201 -----------------------
12202
12203 procedure Move_Freeze_Nodes
12204 (Out_Of : Entity_Id;
12205 After : Node_Id;
12206 L : List_Id)
12207 is
12208 Decl : Node_Id;
12209 Next_Decl : Node_Id;
12210 Next_Node : Node_Id := After;
12211 Spec : Node_Id;
12212
12213 function Is_Outer_Type (T : Entity_Id) return Boolean;
12214 -- Check whether entity is declared in a scope external to that of the
12215 -- generic unit.
12216
12217 -------------------
12218 -- Is_Outer_Type --
12219 -------------------
12220
12221 function Is_Outer_Type (T : Entity_Id) return Boolean is
12222 Scop : Entity_Id := Scope (T);
12223
12224 begin
12225 if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12226 return True;
12227
12228 else
12229 while Scop /= Standard_Standard loop
12230 if Scop = Out_Of then
12231 return False;
12232 else
12233 Scop := Scope (Scop);
12234 end if;
12235 end loop;
12236
12237 return True;
12238 end if;
12239 end Is_Outer_Type;
12240
12241 -- Start of processing for Move_Freeze_Nodes
12242
12243 begin
12244 if No (L) then
12245 return;
12246 end if;
12247
12248 -- First remove the freeze nodes that may appear before all other
12249 -- declarations.
12250
12251 Decl := First (L);
12252 while Present (Decl)
12253 and then Nkind (Decl) = N_Freeze_Entity
12254 and then Is_Outer_Type (Entity (Decl))
12255 loop
12256 Decl := Remove_Head (L);
12257 Insert_After (Next_Node, Decl);
12258 Set_Analyzed (Decl, False);
12259 Next_Node := Decl;
12260 Decl := First (L);
12261 end loop;
12262
12263 -- Next scan the list of declarations and remove each freeze node that
12264 -- appears ahead of the current node.
12265
12266 while Present (Decl) loop
12267 while Present (Next (Decl))
12268 and then Nkind (Next (Decl)) = N_Freeze_Entity
12269 and then Is_Outer_Type (Entity (Next (Decl)))
12270 loop
12271 Next_Decl := Remove_Next (Decl);
12272 Insert_After (Next_Node, Next_Decl);
12273 Set_Analyzed (Next_Decl, False);
12274 Next_Node := Next_Decl;
12275 end loop;
12276
12277 -- If the declaration is a nested package or concurrent type, then
12278 -- recurse. Nested generic packages will have been processed from the
12279 -- inside out.
12280
12281 case Nkind (Decl) is
12282 when N_Package_Declaration =>
12283 Spec := Specification (Decl);
12284
12285 when N_Task_Type_Declaration =>
12286 Spec := Task_Definition (Decl);
12287
12288 when N_Protected_Type_Declaration =>
12289 Spec := Protected_Definition (Decl);
12290
12291 when others =>
12292 Spec := Empty;
12293 end case;
12294
12295 if Present (Spec) then
12296 Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
12297 Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
12298 end if;
12299
12300 Next (Decl);
12301 end loop;
12302 end Move_Freeze_Nodes;
12303
12304 ----------------
12305 -- Next_Assoc --
12306 ----------------
12307
12308 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
12309 begin
12310 return Generic_Renamings.Table (E).Next_In_HTable;
12311 end Next_Assoc;
12312
12313 ------------------------
12314 -- Preanalyze_Actuals --
12315 ------------------------
12316
12317 procedure Preanalyze_Actuals (N : Node_Id) is
12318 Assoc : Node_Id;
12319 Act : Node_Id;
12320 Errs : constant Int := Serious_Errors_Detected;
12321
12322 Cur : Entity_Id := Empty;
12323 -- Current homograph of the instance name
12324
12325 Vis : Boolean;
12326 -- Saved visibility status of the current homograph
12327
12328 begin
12329 Assoc := First (Generic_Associations (N));
12330
12331 -- If the instance is a child unit, its name may hide an outer homonym,
12332 -- so make it invisible to perform name resolution on the actuals.
12333
12334 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
12335 and then Present
12336 (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
12337 then
12338 Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
12339
12340 if Is_Compilation_Unit (Cur) then
12341 Vis := Is_Immediately_Visible (Cur);
12342 Set_Is_Immediately_Visible (Cur, False);
12343 else
12344 Cur := Empty;
12345 end if;
12346 end if;
12347
12348 while Present (Assoc) loop
12349 if Nkind (Assoc) /= N_Others_Choice then
12350 Act := Explicit_Generic_Actual_Parameter (Assoc);
12351
12352 -- Within a nested instantiation, a defaulted actual is an empty
12353 -- association, so nothing to analyze. If the subprogram actual
12354 -- is an attribute, analyze prefix only, because actual is not a
12355 -- complete attribute reference.
12356
12357 -- If actual is an allocator, analyze expression only. The full
12358 -- analysis can generate code, and if instance is a compilation
12359 -- unit we have to wait until the package instance is installed
12360 -- to have a proper place to insert this code.
12361
12362 -- String literals may be operators, but at this point we do not
12363 -- know whether the actual is a formal subprogram or a string.
12364
12365 if No (Act) then
12366 null;
12367
12368 elsif Nkind (Act) = N_Attribute_Reference then
12369 Analyze (Prefix (Act));
12370
12371 elsif Nkind (Act) = N_Explicit_Dereference then
12372 Analyze (Prefix (Act));
12373
12374 elsif Nkind (Act) = N_Allocator then
12375 declare
12376 Expr : constant Node_Id := Expression (Act);
12377
12378 begin
12379 if Nkind (Expr) = N_Subtype_Indication then
12380 Analyze (Subtype_Mark (Expr));
12381
12382 -- Analyze separately each discriminant constraint, when
12383 -- given with a named association.
12384
12385 declare
12386 Constr : Node_Id;
12387
12388 begin
12389 Constr := First (Constraints (Constraint (Expr)));
12390 while Present (Constr) loop
12391 if Nkind (Constr) = N_Discriminant_Association then
12392 Analyze (Expression (Constr));
12393 else
12394 Analyze (Constr);
12395 end if;
12396
12397 Next (Constr);
12398 end loop;
12399 end;
12400
12401 else
12402 Analyze (Expr);
12403 end if;
12404 end;
12405
12406 elsif Nkind (Act) /= N_Operator_Symbol then
12407 Analyze (Act);
12408 end if;
12409
12410 -- Ensure that a ghost subprogram does not act as generic actual
12411
12412 if Is_Entity_Name (Act)
12413 and then Is_Ghost_Subprogram (Entity (Act))
12414 then
12415 Error_Msg_N
12416 ("ghost subprogram & cannot act as generic actual", Act);
12417 Abandon_Instantiation (Act);
12418
12419 elsif Errs /= Serious_Errors_Detected then
12420
12421 -- Do a minimal analysis of the generic, to prevent spurious
12422 -- warnings complaining about the generic being unreferenced,
12423 -- before abandoning the instantiation.
12424
12425 Analyze (Name (N));
12426
12427 if Is_Entity_Name (Name (N))
12428 and then Etype (Name (N)) /= Any_Type
12429 then
12430 Generate_Reference (Entity (Name (N)), Name (N));
12431 Set_Is_Instantiated (Entity (Name (N)));
12432 end if;
12433
12434 if Present (Cur) then
12435
12436 -- For the case of a child instance hiding an outer homonym,
12437 -- provide additional warning which might explain the error.
12438
12439 Set_Is_Immediately_Visible (Cur, Vis);
12440 Error_Msg_NE ("& hides outer unit with the same name??",
12441 N, Defining_Unit_Name (N));
12442 end if;
12443
12444 Abandon_Instantiation (Act);
12445 end if;
12446 end if;
12447
12448 Next (Assoc);
12449 end loop;
12450
12451 if Present (Cur) then
12452 Set_Is_Immediately_Visible (Cur, Vis);
12453 end if;
12454 end Preanalyze_Actuals;
12455
12456 -------------------
12457 -- Remove_Parent --
12458 -------------------
12459
12460 procedure Remove_Parent (In_Body : Boolean := False) is
12461 S : Entity_Id := Current_Scope;
12462 -- S is the scope containing the instantiation just completed. The scope
12463 -- stack contains the parent instances of the instantiation, followed by
12464 -- the original S.
12465
12466 Cur_P : Entity_Id;
12467 E : Entity_Id;
12468 P : Entity_Id;
12469 Hidden : Elmt_Id;
12470
12471 begin
12472 -- After child instantiation is complete, remove from scope stack the
12473 -- extra copy of the current scope, and then remove parent instances.
12474
12475 if not In_Body then
12476 Pop_Scope;
12477
12478 while Current_Scope /= S loop
12479 P := Current_Scope;
12480 End_Package_Scope (Current_Scope);
12481
12482 if In_Open_Scopes (P) then
12483 E := First_Entity (P);
12484 while Present (E) loop
12485 Set_Is_Immediately_Visible (E, True);
12486 Next_Entity (E);
12487 end loop;
12488
12489 -- If instantiation is declared in a block, it is the enclosing
12490 -- scope that might be a parent instance. Note that only one
12491 -- block can be involved, because the parent instances have
12492 -- been installed within it.
12493
12494 if Ekind (P) = E_Block then
12495 Cur_P := Scope (P);
12496 else
12497 Cur_P := P;
12498 end if;
12499
12500 if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
12501 -- We are within an instance of some sibling. Retain
12502 -- visibility of parent, for proper subsequent cleanup, and
12503 -- reinstall private declarations as well.
12504
12505 Set_In_Private_Part (P);
12506 Install_Private_Declarations (P);
12507 end if;
12508
12509 -- If the ultimate parent is a top-level unit recorded in
12510 -- Instance_Parent_Unit, then reset its visibility to what it was
12511 -- before instantiation. (It's not clear what the purpose is of
12512 -- testing whether Scope (P) is In_Open_Scopes, but that test was
12513 -- present before the ultimate parent test was added.???)
12514
12515 elsif not In_Open_Scopes (Scope (P))
12516 or else (P = Instance_Parent_Unit
12517 and then not Parent_Unit_Visible)
12518 then
12519 Set_Is_Immediately_Visible (P, False);
12520
12521 -- If the current scope is itself an instantiation of a generic
12522 -- nested within P, and we are in the private part of body of this
12523 -- instantiation, restore the full views of P, that were removed
12524 -- in End_Package_Scope above. This obscure case can occur when a
12525 -- subunit of a generic contains an instance of a child unit of
12526 -- its generic parent unit.
12527
12528 elsif S = Current_Scope and then Is_Generic_Instance (S) then
12529 declare
12530 Par : constant Entity_Id :=
12531 Generic_Parent
12532 (Specification (Unit_Declaration_Node (S)));
12533 begin
12534 if Present (Par)
12535 and then P = Scope (Par)
12536 and then (In_Package_Body (S) or else In_Private_Part (S))
12537 then
12538 Set_In_Private_Part (P);
12539 Install_Private_Declarations (P);
12540 end if;
12541 end;
12542 end if;
12543 end loop;
12544
12545 -- Reset visibility of entities in the enclosing scope
12546
12547 Set_Is_Hidden_Open_Scope (Current_Scope, False);
12548
12549 Hidden := First_Elmt (Hidden_Entities);
12550 while Present (Hidden) loop
12551 Set_Is_Immediately_Visible (Node (Hidden), True);
12552 Next_Elmt (Hidden);
12553 end loop;
12554
12555 else
12556 -- Each body is analyzed separately, and there is no context that
12557 -- needs preserving from one body instance to the next, so remove all
12558 -- parent scopes that have been installed.
12559
12560 while Present (S) loop
12561 End_Package_Scope (S);
12562 Set_Is_Immediately_Visible (S, False);
12563 S := Current_Scope;
12564 exit when S = Standard_Standard;
12565 end loop;
12566 end if;
12567 end Remove_Parent;
12568
12569 -----------------
12570 -- Restore_Env --
12571 -----------------
12572
12573 procedure Restore_Env is
12574 Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
12575
12576 begin
12577 if No (Current_Instantiated_Parent.Act_Id) then
12578 -- Restore environment after subprogram inlining
12579
12580 Restore_Private_Views (Empty);
12581 end if;
12582
12583 Current_Instantiated_Parent := Saved.Instantiated_Parent;
12584 Exchanged_Views := Saved.Exchanged_Views;
12585 Hidden_Entities := Saved.Hidden_Entities;
12586 Current_Sem_Unit := Saved.Current_Sem_Unit;
12587 Parent_Unit_Visible := Saved.Parent_Unit_Visible;
12588 Instance_Parent_Unit := Saved.Instance_Parent_Unit;
12589
12590 Restore_Opt_Config_Switches (Saved.Switches);
12591
12592 Instance_Envs.Decrement_Last;
12593 end Restore_Env;
12594
12595 ---------------------------
12596 -- Restore_Private_Views --
12597 ---------------------------
12598
12599 procedure Restore_Private_Views
12600 (Pack_Id : Entity_Id;
12601 Is_Package : Boolean := True)
12602 is
12603 M : Elmt_Id;
12604 E : Entity_Id;
12605 Typ : Entity_Id;
12606 Dep_Elmt : Elmt_Id;
12607 Dep_Typ : Node_Id;
12608
12609 procedure Restore_Nested_Formal (Formal : Entity_Id);
12610 -- Hide the generic formals of formal packages declared with box which
12611 -- were reachable in the current instantiation.
12612
12613 ---------------------------
12614 -- Restore_Nested_Formal --
12615 ---------------------------
12616
12617 procedure Restore_Nested_Formal (Formal : Entity_Id) is
12618 Ent : Entity_Id;
12619
12620 begin
12621 if Present (Renamed_Object (Formal))
12622 and then Denotes_Formal_Package (Renamed_Object (Formal), True)
12623 then
12624 return;
12625
12626 elsif Present (Associated_Formal_Package (Formal)) then
12627 Ent := First_Entity (Formal);
12628 while Present (Ent) loop
12629 exit when Ekind (Ent) = E_Package
12630 and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
12631
12632 Set_Is_Hidden (Ent);
12633 Set_Is_Potentially_Use_Visible (Ent, False);
12634
12635 -- If package, then recurse
12636
12637 if Ekind (Ent) = E_Package then
12638 Restore_Nested_Formal (Ent);
12639 end if;
12640
12641 Next_Entity (Ent);
12642 end loop;
12643 end if;
12644 end Restore_Nested_Formal;
12645
12646 -- Start of processing for Restore_Private_Views
12647
12648 begin
12649 M := First_Elmt (Exchanged_Views);
12650 while Present (M) loop
12651 Typ := Node (M);
12652
12653 -- Subtypes of types whose views have been exchanged, and that are
12654 -- defined within the instance, were not on the Private_Dependents
12655 -- list on entry to the instance, so they have to be exchanged
12656 -- explicitly now, in order to remain consistent with the view of the
12657 -- parent type.
12658
12659 if Ekind_In (Typ, E_Private_Type,
12660 E_Limited_Private_Type,
12661 E_Record_Type_With_Private)
12662 then
12663 Dep_Elmt := First_Elmt (Private_Dependents (Typ));
12664 while Present (Dep_Elmt) loop
12665 Dep_Typ := Node (Dep_Elmt);
12666
12667 if Scope (Dep_Typ) = Pack_Id
12668 and then Present (Full_View (Dep_Typ))
12669 then
12670 Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
12671 Exchange_Declarations (Dep_Typ);
12672 end if;
12673
12674 Next_Elmt (Dep_Elmt);
12675 end loop;
12676 end if;
12677
12678 Exchange_Declarations (Node (M));
12679 Next_Elmt (M);
12680 end loop;
12681
12682 if No (Pack_Id) then
12683 return;
12684 end if;
12685
12686 -- Make the generic formal parameters private, and make the formal types
12687 -- into subtypes of the actuals again.
12688
12689 E := First_Entity (Pack_Id);
12690 while Present (E) loop
12691 Set_Is_Hidden (E, True);
12692
12693 if Is_Type (E)
12694 and then Nkind (Parent (E)) = N_Subtype_Declaration
12695 then
12696 -- If the actual for E is itself a generic actual type from
12697 -- an enclosing instance, E is still a generic actual type
12698 -- outside of the current instance. This matter when resolving
12699 -- an overloaded call that may be ambiguous in the enclosing
12700 -- instance, when two of its actuals coincide.
12701
12702 if Is_Entity_Name (Subtype_Indication (Parent (E)))
12703 and then Is_Generic_Actual_Type
12704 (Entity (Subtype_Indication (Parent (E))))
12705 then
12706 null;
12707 else
12708 Set_Is_Generic_Actual_Type (E, False);
12709 end if;
12710
12711 -- An unusual case of aliasing: the actual may also be directly
12712 -- visible in the generic, and be private there, while it is fully
12713 -- visible in the context of the instance. The internal subtype
12714 -- is private in the instance but has full visibility like its
12715 -- parent in the enclosing scope. This enforces the invariant that
12716 -- the privacy status of all private dependents of a type coincide
12717 -- with that of the parent type. This can only happen when a
12718 -- generic child unit is instantiated within a sibling.
12719
12720 if Is_Private_Type (E)
12721 and then not Is_Private_Type (Etype (E))
12722 then
12723 Exchange_Declarations (E);
12724 end if;
12725
12726 elsif Ekind (E) = E_Package then
12727
12728 -- The end of the renaming list is the renaming of the generic
12729 -- package itself. If the instance is a subprogram, all entities
12730 -- in the corresponding package are renamings. If this entity is
12731 -- a formal package, make its own formals private as well. The
12732 -- actual in this case is itself the renaming of an instantiation.
12733 -- If the entity is not a package renaming, it is the entity
12734 -- created to validate formal package actuals: ignore it.
12735
12736 -- If the actual is itself a formal package for the enclosing
12737 -- generic, or the actual for such a formal package, it remains
12738 -- visible on exit from the instance, and therefore nothing needs
12739 -- to be done either, except to keep it accessible.
12740
12741 if Is_Package and then Renamed_Object (E) = Pack_Id then
12742 exit;
12743
12744 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
12745 null;
12746
12747 elsif
12748 Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
12749 then
12750 Set_Is_Hidden (E, False);
12751
12752 else
12753 declare
12754 Act_P : constant Entity_Id := Renamed_Object (E);
12755 Id : Entity_Id;
12756
12757 begin
12758 Id := First_Entity (Act_P);
12759 while Present (Id)
12760 and then Id /= First_Private_Entity (Act_P)
12761 loop
12762 exit when Ekind (Id) = E_Package
12763 and then Renamed_Object (Id) = Act_P;
12764
12765 Set_Is_Hidden (Id, True);
12766 Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
12767
12768 if Ekind (Id) = E_Package then
12769 Restore_Nested_Formal (Id);
12770 end if;
12771
12772 Next_Entity (Id);
12773 end loop;
12774 end;
12775 end if;
12776 end if;
12777
12778 Next_Entity (E);
12779 end loop;
12780 end Restore_Private_Views;
12781
12782 --------------
12783 -- Save_Env --
12784 --------------
12785
12786 procedure Save_Env
12787 (Gen_Unit : Entity_Id;
12788 Act_Unit : Entity_Id)
12789 is
12790 begin
12791 Init_Env;
12792 Set_Instance_Env (Gen_Unit, Act_Unit);
12793 end Save_Env;
12794
12795 ----------------------------
12796 -- Save_Global_References --
12797 ----------------------------
12798
12799 procedure Save_Global_References (N : Node_Id) is
12800 Gen_Scope : Entity_Id;
12801 E : Entity_Id;
12802 N2 : Node_Id;
12803
12804 function Is_Global (E : Entity_Id) return Boolean;
12805 -- Check whether entity is defined outside of generic unit. Examine the
12806 -- scope of an entity, and the scope of the scope, etc, until we find
12807 -- either Standard, in which case the entity is global, or the generic
12808 -- unit itself, which indicates that the entity is local. If the entity
12809 -- is the generic unit itself, as in the case of a recursive call, or
12810 -- the enclosing generic unit, if different from the current scope, then
12811 -- it is local as well, because it will be replaced at the point of
12812 -- instantiation. On the other hand, if it is a reference to a child
12813 -- unit of a common ancestor, which appears in an instantiation, it is
12814 -- global because it is used to denote a specific compilation unit at
12815 -- the time the instantiations will be analyzed.
12816
12817 procedure Reset_Entity (N : Node_Id);
12818 -- Save semantic information on global entity so that it is not resolved
12819 -- again at instantiation time.
12820
12821 procedure Save_Entity_Descendants (N : Node_Id);
12822 -- Apply Save_Global_References to the two syntactic descendants of
12823 -- non-terminal nodes that carry an Associated_Node and are processed
12824 -- through Reset_Entity. Once the global entity (if any) has been
12825 -- captured together with its type, only two syntactic descendants need
12826 -- to be traversed to complete the processing of the tree rooted at N.
12827 -- This applies to Selected_Components, Expanded_Names, and to Operator
12828 -- nodes. N can also be a character literal, identifier, or operator
12829 -- symbol node, but the call has no effect in these cases.
12830
12831 procedure Save_Global_Defaults (N1, N2 : Node_Id);
12832 -- Default actuals in nested instances must be handled specially
12833 -- because there is no link to them from the original tree. When an
12834 -- actual subprogram is given by a default, we add an explicit generic
12835 -- association for it in the instantiation node. When we save the
12836 -- global references on the name of the instance, we recover the list
12837 -- of generic associations, and add an explicit one to the original
12838 -- generic tree, through which a global actual can be preserved.
12839 -- Similarly, if a child unit is instantiated within a sibling, in the
12840 -- context of the parent, we must preserve the identifier of the parent
12841 -- so that it can be properly resolved in a subsequent instantiation.
12842
12843 procedure Save_Global_Descendant (D : Union_Id);
12844 -- Apply Save_Global_References recursively to the descendents of the
12845 -- current node.
12846
12847 procedure Save_References (N : Node_Id);
12848 -- This is the recursive procedure that does the work, once the
12849 -- enclosing generic scope has been established.
12850
12851 ---------------
12852 -- Is_Global --
12853 ---------------
12854
12855 function Is_Global (E : Entity_Id) return Boolean is
12856 Se : Entity_Id;
12857
12858 function Is_Instance_Node (Decl : Node_Id) return Boolean;
12859 -- Determine whether the parent node of a reference to a child unit
12860 -- denotes an instantiation or a formal package, in which case the
12861 -- reference to the child unit is global, even if it appears within
12862 -- the current scope (e.g. when the instance appears within the body
12863 -- of an ancestor).
12864
12865 ----------------------
12866 -- Is_Instance_Node --
12867 ----------------------
12868
12869 function Is_Instance_Node (Decl : Node_Id) return Boolean is
12870 begin
12871 return Nkind (Decl) in N_Generic_Instantiation
12872 or else
12873 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
12874 end Is_Instance_Node;
12875
12876 -- Start of processing for Is_Global
12877
12878 begin
12879 if E = Gen_Scope then
12880 return False;
12881
12882 elsif E = Standard_Standard then
12883 return True;
12884
12885 elsif Is_Child_Unit (E)
12886 and then (Is_Instance_Node (Parent (N2))
12887 or else (Nkind (Parent (N2)) = N_Expanded_Name
12888 and then N2 = Selector_Name (Parent (N2))
12889 and then
12890 Is_Instance_Node (Parent (Parent (N2)))))
12891 then
12892 return True;
12893
12894 else
12895 Se := Scope (E);
12896 while Se /= Gen_Scope loop
12897 if Se = Standard_Standard then
12898 return True;
12899 else
12900 Se := Scope (Se);
12901 end if;
12902 end loop;
12903
12904 return False;
12905 end if;
12906 end Is_Global;
12907
12908 ------------------
12909 -- Reset_Entity --
12910 ------------------
12911
12912 procedure Reset_Entity (N : Node_Id) is
12913
12914 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
12915 -- If the type of N2 is global to the generic unit, save the type in
12916 -- the generic node. Just as we perform name capture for explicit
12917 -- references within the generic, we must capture the global types
12918 -- of local entities because they may participate in resolution in
12919 -- the instance.
12920
12921 function Top_Ancestor (E : Entity_Id) return Entity_Id;
12922 -- Find the ultimate ancestor of the current unit. If it is not a
12923 -- generic unit, then the name of the current unit in the prefix of
12924 -- an expanded name must be replaced with its generic homonym to
12925 -- ensure that it will be properly resolved in an instance.
12926
12927 ---------------------
12928 -- Set_Global_Type --
12929 ---------------------
12930
12931 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
12932 Typ : constant Entity_Id := Etype (N2);
12933
12934 begin
12935 Set_Etype (N, Typ);
12936
12937 if Entity (N) /= N2
12938 and then Has_Private_View (Entity (N))
12939 then
12940 -- If the entity of N is not the associated node, this is a
12941 -- nested generic and it has an associated node as well, whose
12942 -- type is already the full view (see below). Indicate that the
12943 -- original node has a private view.
12944
12945 Set_Has_Private_View (N);
12946 end if;
12947
12948 -- If not a private type, nothing else to do
12949
12950 if not Is_Private_Type (Typ) then
12951 if Is_Array_Type (Typ)
12952 and then Is_Private_Type (Component_Type (Typ))
12953 then
12954 Set_Has_Private_View (N);
12955 end if;
12956
12957 -- If it is a derivation of a private type in a context where no
12958 -- full view is needed, nothing to do either.
12959
12960 elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
12961 null;
12962
12963 -- Otherwise mark the type for flipping and use the full view when
12964 -- available.
12965
12966 else
12967 Set_Has_Private_View (N);
12968
12969 if Present (Full_View (Typ)) then
12970 Set_Etype (N2, Full_View (Typ));
12971 end if;
12972 end if;
12973 end Set_Global_Type;
12974
12975 ------------------
12976 -- Top_Ancestor --
12977 ------------------
12978
12979 function Top_Ancestor (E : Entity_Id) return Entity_Id is
12980 Par : Entity_Id;
12981
12982 begin
12983 Par := E;
12984 while Is_Child_Unit (Par) loop
12985 Par := Scope (Par);
12986 end loop;
12987
12988 return Par;
12989 end Top_Ancestor;
12990
12991 -- Start of processing for Reset_Entity
12992
12993 begin
12994 N2 := Get_Associated_Node (N);
12995 E := Entity (N2);
12996
12997 if Present (E) then
12998
12999 -- If the node is an entry call to an entry in an enclosing task,
13000 -- it is rewritten as a selected component. No global entity to
13001 -- preserve in this case, since the expansion will be redone in
13002 -- the instance.
13003
13004 if not Nkind_In (E, N_Defining_Identifier,
13005 N_Defining_Character_Literal,
13006 N_Defining_Operator_Symbol)
13007 then
13008 Set_Associated_Node (N, Empty);
13009 Set_Etype (N, Empty);
13010 return;
13011 end if;
13012
13013 -- If the entity is an itype created as a subtype of an access
13014 -- type with a null exclusion restore source entity for proper
13015 -- visibility. The itype will be created anew in the instance.
13016
13017 if Is_Itype (E)
13018 and then Ekind (E) = E_Access_Subtype
13019 and then Is_Entity_Name (N)
13020 and then Chars (Etype (E)) = Chars (N)
13021 then
13022 E := Etype (E);
13023 Set_Entity (N2, E);
13024 Set_Etype (N2, E);
13025 end if;
13026
13027 if Is_Global (E) then
13028
13029 -- If the entity is a package renaming that is the prefix of
13030 -- an expanded name, it has been rewritten as the renamed
13031 -- package, which is necessary semantically but complicates
13032 -- ASIS tree traversal, so we recover the original entity to
13033 -- expose the renaming. Take into account that the context may
13034 -- be a nested generic and that the original node may itself
13035 -- have an associated node.
13036
13037 if Ekind (E) = E_Package
13038 and then Nkind (Parent (N)) = N_Expanded_Name
13039 and then Present (Original_Node (N2))
13040 and then Present (Entity (Original_Node (N2)))
13041 and then Is_Entity_Name (Entity (Original_Node (N2)))
13042 then
13043 if Is_Global (Entity (Original_Node (N2))) then
13044 N2 := Original_Node (N2);
13045 Set_Associated_Node (N, N2);
13046 Set_Global_Type (N, N2);
13047
13048 else
13049 -- Renaming is local, and will be resolved in instance
13050
13051 Set_Associated_Node (N, Empty);
13052 Set_Etype (N, Empty);
13053 end if;
13054
13055 else
13056 Set_Global_Type (N, N2);
13057 end if;
13058
13059 elsif Nkind (N) = N_Op_Concat
13060 and then Is_Generic_Type (Etype (N2))
13061 and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
13062 or else
13063 Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
13064 and then Is_Intrinsic_Subprogram (E)
13065 then
13066 null;
13067
13068 else
13069 -- Entity is local. Mark generic node as unresolved.
13070 -- Note that now it does not have an entity.
13071
13072 Set_Associated_Node (N, Empty);
13073 Set_Etype (N, Empty);
13074 end if;
13075
13076 if Nkind (Parent (N)) in N_Generic_Instantiation
13077 and then N = Name (Parent (N))
13078 then
13079 Save_Global_Defaults (Parent (N), Parent (N2));
13080 end if;
13081
13082 elsif Nkind (Parent (N)) = N_Selected_Component
13083 and then Nkind (Parent (N2)) = N_Expanded_Name
13084 then
13085 if Is_Global (Entity (Parent (N2))) then
13086 Change_Selected_Component_To_Expanded_Name (Parent (N));
13087 Set_Associated_Node (Parent (N), Parent (N2));
13088 Set_Global_Type (Parent (N), Parent (N2));
13089 Save_Entity_Descendants (N);
13090
13091 -- If this is a reference to the current generic entity, replace
13092 -- by the name of the generic homonym of the current package. This
13093 -- is because in an instantiation Par.P.Q will not resolve to the
13094 -- name of the instance, whose enclosing scope is not necessarily
13095 -- Par. We use the generic homonym rather that the name of the
13096 -- generic itself because it may be hidden by a local declaration.
13097
13098 elsif In_Open_Scopes (Entity (Parent (N2)))
13099 and then not
13100 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
13101 then
13102 if Ekind (Entity (Parent (N2))) = E_Generic_Package then
13103 Rewrite (Parent (N),
13104 Make_Identifier (Sloc (N),
13105 Chars =>
13106 Chars (Generic_Homonym (Entity (Parent (N2))))));
13107 else
13108 Rewrite (Parent (N),
13109 Make_Identifier (Sloc (N),
13110 Chars => Chars (Selector_Name (Parent (N2)))));
13111 end if;
13112 end if;
13113
13114 if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
13115 and then Parent (N) = Name (Parent (Parent (N)))
13116 then
13117 Save_Global_Defaults
13118 (Parent (Parent (N)), Parent (Parent ((N2))));
13119 end if;
13120
13121 -- A selected component may denote a static constant that has been
13122 -- folded. If the static constant is global to the generic, capture
13123 -- its value. Otherwise the folding will happen in any instantiation.
13124
13125 elsif Nkind (Parent (N)) = N_Selected_Component
13126 and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
13127 then
13128 if Present (Entity (Original_Node (Parent (N2))))
13129 and then Is_Global (Entity (Original_Node (Parent (N2))))
13130 then
13131 Rewrite (Parent (N), New_Copy (Parent (N2)));
13132 Set_Analyzed (Parent (N), False);
13133
13134 else
13135 null;
13136 end if;
13137
13138 -- A selected component may be transformed into a parameterless
13139 -- function call. If the called entity is global, rewrite the node
13140 -- appropriately, i.e. as an extended name for the global entity.
13141
13142 elsif Nkind (Parent (N)) = N_Selected_Component
13143 and then Nkind (Parent (N2)) = N_Function_Call
13144 and then N = Selector_Name (Parent (N))
13145 then
13146 if No (Parameter_Associations (Parent (N2))) then
13147 if Is_Global (Entity (Name (Parent (N2)))) then
13148 Change_Selected_Component_To_Expanded_Name (Parent (N));
13149 Set_Associated_Node (Parent (N), Name (Parent (N2)));
13150 Set_Global_Type (Parent (N), Name (Parent (N2)));
13151 Save_Entity_Descendants (N);
13152
13153 else
13154 Set_Is_Prefixed_Call (Parent (N));
13155 Set_Associated_Node (N, Empty);
13156 Set_Etype (N, Empty);
13157 end if;
13158
13159 -- In Ada 2005, X.F may be a call to a primitive operation,
13160 -- rewritten as F (X). This rewriting will be done again in an
13161 -- instance, so keep the original node. Global entities will be
13162 -- captured as for other constructs. Indicate that this must
13163 -- resolve as a call, to prevent accidental overloading in the
13164 -- instance, if both a component and a primitive operation appear
13165 -- as candidates.
13166
13167 else
13168 Set_Is_Prefixed_Call (Parent (N));
13169 end if;
13170
13171 -- Entity is local. Reset in generic unit, so that node is resolved
13172 -- anew at the point of instantiation.
13173
13174 else
13175 Set_Associated_Node (N, Empty);
13176 Set_Etype (N, Empty);
13177 end if;
13178 end Reset_Entity;
13179
13180 -----------------------------
13181 -- Save_Entity_Descendants --
13182 -----------------------------
13183
13184 procedure Save_Entity_Descendants (N : Node_Id) is
13185 begin
13186 case Nkind (N) is
13187 when N_Binary_Op =>
13188 Save_Global_Descendant (Union_Id (Left_Opnd (N)));
13189 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13190
13191 when N_Unary_Op =>
13192 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13193
13194 when N_Expanded_Name | N_Selected_Component =>
13195 Save_Global_Descendant (Union_Id (Prefix (N)));
13196 Save_Global_Descendant (Union_Id (Selector_Name (N)));
13197
13198 when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
13199 null;
13200
13201 when others =>
13202 raise Program_Error;
13203 end case;
13204 end Save_Entity_Descendants;
13205
13206 --------------------------
13207 -- Save_Global_Defaults --
13208 --------------------------
13209
13210 procedure Save_Global_Defaults (N1, N2 : Node_Id) is
13211 Loc : constant Source_Ptr := Sloc (N1);
13212 Assoc2 : constant List_Id := Generic_Associations (N2);
13213 Gen_Id : constant Entity_Id := Get_Generic_Entity (N2);
13214 Assoc1 : List_Id;
13215 Act1 : Node_Id;
13216 Act2 : Node_Id;
13217 Def : Node_Id;
13218 Ndec : Node_Id;
13219 Subp : Entity_Id;
13220 Actual : Entity_Id;
13221
13222 begin
13223 Assoc1 := Generic_Associations (N1);
13224
13225 if Present (Assoc1) then
13226 Act1 := First (Assoc1);
13227 else
13228 Act1 := Empty;
13229 Set_Generic_Associations (N1, New_List);
13230 Assoc1 := Generic_Associations (N1);
13231 end if;
13232
13233 if Present (Assoc2) then
13234 Act2 := First (Assoc2);
13235 else
13236 return;
13237 end if;
13238
13239 while Present (Act1) and then Present (Act2) loop
13240 Next (Act1);
13241 Next (Act2);
13242 end loop;
13243
13244 -- Find the associations added for default subprograms
13245
13246 if Present (Act2) then
13247 while Nkind (Act2) /= N_Generic_Association
13248 or else No (Entity (Selector_Name (Act2)))
13249 or else not Is_Overloadable (Entity (Selector_Name (Act2)))
13250 loop
13251 Next (Act2);
13252 end loop;
13253
13254 -- Add a similar association if the default is global. The
13255 -- renaming declaration for the actual has been analyzed, and
13256 -- its alias is the program it renames. Link the actual in the
13257 -- original generic tree with the node in the analyzed tree.
13258
13259 while Present (Act2) loop
13260 Subp := Entity (Selector_Name (Act2));
13261 Def := Explicit_Generic_Actual_Parameter (Act2);
13262
13263 -- Following test is defence against rubbish errors
13264
13265 if No (Alias (Subp)) then
13266 return;
13267 end if;
13268
13269 -- Retrieve the resolved actual from the renaming declaration
13270 -- created for the instantiated formal.
13271
13272 Actual := Entity (Name (Parent (Parent (Subp))));
13273 Set_Entity (Def, Actual);
13274 Set_Etype (Def, Etype (Actual));
13275
13276 if Is_Global (Actual) then
13277 Ndec :=
13278 Make_Generic_Association (Loc,
13279 Selector_Name => New_Occurrence_Of (Subp, Loc),
13280 Explicit_Generic_Actual_Parameter =>
13281 New_Occurrence_Of (Actual, Loc));
13282
13283 Set_Associated_Node
13284 (Explicit_Generic_Actual_Parameter (Ndec), Def);
13285
13286 Append (Ndec, Assoc1);
13287
13288 -- If there are other defaults, add a dummy association in case
13289 -- there are other defaulted formals with the same name.
13290
13291 elsif Present (Next (Act2)) then
13292 Ndec :=
13293 Make_Generic_Association (Loc,
13294 Selector_Name => New_Occurrence_Of (Subp, Loc),
13295 Explicit_Generic_Actual_Parameter => Empty);
13296
13297 Append (Ndec, Assoc1);
13298 end if;
13299
13300 Next (Act2);
13301 end loop;
13302 end if;
13303
13304 if Nkind (Name (N1)) = N_Identifier
13305 and then Is_Child_Unit (Gen_Id)
13306 and then Is_Global (Gen_Id)
13307 and then Is_Generic_Unit (Scope (Gen_Id))
13308 and then In_Open_Scopes (Scope (Gen_Id))
13309 then
13310 -- This is an instantiation of a child unit within a sibling, so
13311 -- that the generic parent is in scope. An eventual instance must
13312 -- occur within the scope of an instance of the parent. Make name
13313 -- in instance into an expanded name, to preserve the identifier
13314 -- of the parent, so it can be resolved subsequently.
13315
13316 Rewrite (Name (N2),
13317 Make_Expanded_Name (Loc,
13318 Chars => Chars (Gen_Id),
13319 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13320 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13321 Set_Entity (Name (N2), Gen_Id);
13322
13323 Rewrite (Name (N1),
13324 Make_Expanded_Name (Loc,
13325 Chars => Chars (Gen_Id),
13326 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13327 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13328
13329 Set_Associated_Node (Name (N1), Name (N2));
13330 Set_Associated_Node (Prefix (Name (N1)), Empty);
13331 Set_Associated_Node
13332 (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
13333 Set_Etype (Name (N1), Etype (Gen_Id));
13334 end if;
13335
13336 end Save_Global_Defaults;
13337
13338 ----------------------------
13339 -- Save_Global_Descendant --
13340 ----------------------------
13341
13342 procedure Save_Global_Descendant (D : Union_Id) is
13343 N1 : Node_Id;
13344
13345 begin
13346 if D in Node_Range then
13347 if D = Union_Id (Empty) then
13348 null;
13349
13350 elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
13351 Save_References (Node_Id (D));
13352 end if;
13353
13354 elsif D in List_Range then
13355 if D = Union_Id (No_List)
13356 or else Is_Empty_List (List_Id (D))
13357 then
13358 null;
13359
13360 else
13361 N1 := First (List_Id (D));
13362 while Present (N1) loop
13363 Save_References (N1);
13364 Next (N1);
13365 end loop;
13366 end if;
13367
13368 -- Element list or other non-node field, nothing to do
13369
13370 else
13371 null;
13372 end if;
13373 end Save_Global_Descendant;
13374
13375 ---------------------
13376 -- Save_References --
13377 ---------------------
13378
13379 -- This is the recursive procedure that does the work once the enclosing
13380 -- generic scope has been established. We have to treat specially a
13381 -- number of node rewritings that are required by semantic processing
13382 -- and which change the kind of nodes in the generic copy: typically
13383 -- constant-folding, replacing an operator node by a string literal, or
13384 -- a selected component by an expanded name. In each of those cases, the
13385 -- transformation is propagated to the generic unit.
13386
13387 procedure Save_References (N : Node_Id) is
13388 Loc : constant Source_Ptr := Sloc (N);
13389
13390 begin
13391 if N = Empty then
13392 null;
13393
13394 elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
13395 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13396 Reset_Entity (N);
13397
13398 elsif Nkind (N) = N_Operator_Symbol
13399 and then Nkind (Get_Associated_Node (N)) = N_String_Literal
13400 then
13401 Change_Operator_Symbol_To_String_Literal (N);
13402 end if;
13403
13404 elsif Nkind (N) in N_Op then
13405 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13406 if Nkind (N) = N_Op_Concat then
13407 Set_Is_Component_Left_Opnd (N,
13408 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13409
13410 Set_Is_Component_Right_Opnd (N,
13411 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13412 end if;
13413
13414 Reset_Entity (N);
13415
13416 else
13417 -- Node may be transformed into call to a user-defined operator
13418
13419 N2 := Get_Associated_Node (N);
13420
13421 if Nkind (N2) = N_Function_Call then
13422 E := Entity (Name (N2));
13423
13424 if Present (E)
13425 and then Is_Global (E)
13426 then
13427 Set_Etype (N, Etype (N2));
13428 else
13429 Set_Associated_Node (N, Empty);
13430 Set_Etype (N, Empty);
13431 end if;
13432
13433 elsif Nkind_In (N2, N_Integer_Literal,
13434 N_Real_Literal,
13435 N_String_Literal)
13436 then
13437 if Present (Original_Node (N2))
13438 and then Nkind (Original_Node (N2)) = Nkind (N)
13439 then
13440
13441 -- Operation was constant-folded. Whenever possible,
13442 -- recover semantic information from unfolded node,
13443 -- for ASIS use.
13444
13445 Set_Associated_Node (N, Original_Node (N2));
13446
13447 if Nkind (N) = N_Op_Concat then
13448 Set_Is_Component_Left_Opnd (N,
13449 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13450 Set_Is_Component_Right_Opnd (N,
13451 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13452 end if;
13453
13454 Reset_Entity (N);
13455
13456 else
13457 -- If original node is already modified, propagate
13458 -- constant-folding to template.
13459
13460 Rewrite (N, New_Copy (N2));
13461 Set_Analyzed (N, False);
13462 end if;
13463
13464 elsif Nkind (N2) = N_Identifier
13465 and then Ekind (Entity (N2)) = E_Enumeration_Literal
13466 then
13467 -- Same if call was folded into a literal, but in this case
13468 -- retain the entity to avoid spurious ambiguities if it is
13469 -- overloaded at the point of instantiation or inlining.
13470
13471 Rewrite (N, New_Copy (N2));
13472 Set_Analyzed (N, False);
13473 end if;
13474 end if;
13475
13476 -- Complete operands check if node has not been constant-folded
13477
13478 if Nkind (N) in N_Op then
13479 Save_Entity_Descendants (N);
13480 end if;
13481
13482 elsif Nkind (N) = N_Identifier then
13483 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13484
13485 -- If this is a discriminant reference, always save it. It is
13486 -- used in the instance to find the corresponding discriminant
13487 -- positionally rather than by name.
13488
13489 Set_Original_Discriminant
13490 (N, Original_Discriminant (Get_Associated_Node (N)));
13491 Reset_Entity (N);
13492
13493 else
13494 N2 := Get_Associated_Node (N);
13495
13496 if Nkind (N2) = N_Function_Call then
13497 E := Entity (Name (N2));
13498
13499 -- Name resolves to a call to parameterless function. If
13500 -- original entity is global, mark node as resolved.
13501
13502 if Present (E)
13503 and then Is_Global (E)
13504 then
13505 Set_Etype (N, Etype (N2));
13506 else
13507 Set_Associated_Node (N, Empty);
13508 Set_Etype (N, Empty);
13509 end if;
13510
13511 elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
13512 and then Is_Entity_Name (Original_Node (N2))
13513 then
13514 -- Name resolves to named number that is constant-folded,
13515 -- We must preserve the original name for ASIS use, and
13516 -- undo the constant-folding, which will be repeated in
13517 -- each instance.
13518
13519 Set_Associated_Node (N, Original_Node (N2));
13520 Reset_Entity (N);
13521
13522 elsif Nkind (N2) = N_String_Literal then
13523
13524 -- Name resolves to string literal. Perform the same
13525 -- replacement in generic.
13526
13527 Rewrite (N, New_Copy (N2));
13528
13529 elsif Nkind (N2) = N_Explicit_Dereference then
13530
13531 -- An identifier is rewritten as a dereference if it is the
13532 -- prefix in an implicit dereference (call or attribute).
13533 -- The analysis of an instantiation will expand the node
13534 -- again, so we preserve the original tree but link it to
13535 -- the resolved entity in case it is global.
13536
13537 if Is_Entity_Name (Prefix (N2))
13538 and then Present (Entity (Prefix (N2)))
13539 and then Is_Global (Entity (Prefix (N2)))
13540 then
13541 Set_Associated_Node (N, Prefix (N2));
13542
13543 elsif Nkind (Prefix (N2)) = N_Function_Call
13544 and then Is_Global (Entity (Name (Prefix (N2))))
13545 then
13546 Rewrite (N,
13547 Make_Explicit_Dereference (Loc,
13548 Prefix => Make_Function_Call (Loc,
13549 Name =>
13550 New_Occurrence_Of (Entity (Name (Prefix (N2))),
13551 Loc))));
13552
13553 else
13554 Set_Associated_Node (N, Empty);
13555 Set_Etype (N, Empty);
13556 end if;
13557
13558 -- The subtype mark of a nominally unconstrained object is
13559 -- rewritten as a subtype indication using the bounds of the
13560 -- expression. Recover the original subtype mark.
13561
13562 elsif Nkind (N2) = N_Subtype_Indication
13563 and then Is_Entity_Name (Original_Node (N2))
13564 then
13565 Set_Associated_Node (N, Original_Node (N2));
13566 Reset_Entity (N);
13567
13568 else
13569 null;
13570 end if;
13571 end if;
13572
13573 elsif Nkind (N) in N_Entity then
13574 null;
13575
13576 else
13577 declare
13578 Qual : Node_Id := Empty;
13579 Typ : Entity_Id := Empty;
13580 Nam : Node_Id;
13581
13582 use Atree.Unchecked_Access;
13583 -- This code section is part of implementing an untyped tree
13584 -- traversal, so it needs direct access to node fields.
13585
13586 begin
13587 if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
13588 N2 := Get_Associated_Node (N);
13589
13590 if No (N2) then
13591 Typ := Empty;
13592 else
13593 Typ := Etype (N2);
13594
13595 -- In an instance within a generic, use the name of the
13596 -- actual and not the original generic parameter. If the
13597 -- actual is global in the current generic it must be
13598 -- preserved for its instantiation.
13599
13600 if Nkind (Parent (Typ)) = N_Subtype_Declaration
13601 and then
13602 Present (Generic_Parent_Type (Parent (Typ)))
13603 then
13604 Typ := Base_Type (Typ);
13605 Set_Etype (N2, Typ);
13606 end if;
13607 end if;
13608
13609 if No (N2)
13610 or else No (Typ)
13611 or else not Is_Global (Typ)
13612 then
13613 Set_Associated_Node (N, Empty);
13614
13615 -- If the aggregate is an actual in a call, it has been
13616 -- resolved in the current context, to some local type.
13617 -- The enclosing call may have been disambiguated by the
13618 -- aggregate, and this disambiguation might fail at
13619 -- instantiation time because the type to which the
13620 -- aggregate did resolve is not preserved. In order to
13621 -- preserve some of this information, we wrap the
13622 -- aggregate in a qualified expression, using the id of
13623 -- its type. For further disambiguation we qualify the
13624 -- type name with its scope (if visible) because both
13625 -- id's will have corresponding entities in an instance.
13626 -- This resolves most of the problems with missing type
13627 -- information on aggregates in instances.
13628
13629 if Nkind (N2) = Nkind (N)
13630 and then Nkind (Parent (N2)) in N_Subprogram_Call
13631 and then Comes_From_Source (Typ)
13632 then
13633 if Is_Immediately_Visible (Scope (Typ)) then
13634 Nam := Make_Selected_Component (Loc,
13635 Prefix =>
13636 Make_Identifier (Loc, Chars (Scope (Typ))),
13637 Selector_Name =>
13638 Make_Identifier (Loc, Chars (Typ)));
13639 else
13640 Nam := Make_Identifier (Loc, Chars (Typ));
13641 end if;
13642
13643 Qual :=
13644 Make_Qualified_Expression (Loc,
13645 Subtype_Mark => Nam,
13646 Expression => Relocate_Node (N));
13647 end if;
13648 end if;
13649
13650 Save_Global_Descendant (Field1 (N));
13651 Save_Global_Descendant (Field2 (N));
13652 Save_Global_Descendant (Field3 (N));
13653 Save_Global_Descendant (Field5 (N));
13654
13655 if Present (Qual) then
13656 Rewrite (N, Qual);
13657 end if;
13658
13659 -- All other cases than aggregates
13660
13661 else
13662 Save_Global_Descendant (Field1 (N));
13663 Save_Global_Descendant (Field2 (N));
13664 Save_Global_Descendant (Field3 (N));
13665 Save_Global_Descendant (Field4 (N));
13666 Save_Global_Descendant (Field5 (N));
13667 end if;
13668 end;
13669 end if;
13670
13671 -- If a node has aspects, references within their expressions must
13672 -- be saved separately, given that they are not directly in the
13673 -- tree.
13674
13675 if Has_Aspects (N) then
13676 declare
13677 Aspect : Node_Id;
13678 begin
13679 Aspect := First (Aspect_Specifications (N));
13680 while Present (Aspect) loop
13681 Save_Global_References (Expression (Aspect));
13682 Next (Aspect);
13683 end loop;
13684 end;
13685 end if;
13686 end Save_References;
13687
13688 -- Start of processing for Save_Global_References
13689
13690 begin
13691 Gen_Scope := Current_Scope;
13692
13693 -- If the generic unit is a child unit, references to entities in the
13694 -- parent are treated as local, because they will be resolved anew in
13695 -- the context of the instance of the parent.
13696
13697 while Is_Child_Unit (Gen_Scope)
13698 and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
13699 loop
13700 Gen_Scope := Scope (Gen_Scope);
13701 end loop;
13702
13703 Save_References (N);
13704 end Save_Global_References;
13705
13706 --------------------------------------
13707 -- Set_Copied_Sloc_For_Inlined_Body --
13708 --------------------------------------
13709
13710 procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
13711 begin
13712 Create_Instantiation_Source (N, E, True, S_Adjustment);
13713 end Set_Copied_Sloc_For_Inlined_Body;
13714
13715 ---------------------
13716 -- Set_Instance_Of --
13717 ---------------------
13718
13719 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
13720 begin
13721 Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
13722 Generic_Renamings_HTable.Set (Generic_Renamings.Last);
13723 Generic_Renamings.Increment_Last;
13724 end Set_Instance_Of;
13725
13726 --------------------
13727 -- Set_Next_Assoc --
13728 --------------------
13729
13730 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
13731 begin
13732 Generic_Renamings.Table (E).Next_In_HTable := Next;
13733 end Set_Next_Assoc;
13734
13735 -------------------
13736 -- Start_Generic --
13737 -------------------
13738
13739 procedure Start_Generic is
13740 begin
13741 -- ??? More things could be factored out in this routine.
13742 -- Should probably be done at a later stage.
13743
13744 Generic_Flags.Append (Inside_A_Generic);
13745 Inside_A_Generic := True;
13746
13747 Expander_Mode_Save_And_Set (False);
13748 end Start_Generic;
13749
13750 ----------------------
13751 -- Set_Instance_Env --
13752 ----------------------
13753
13754 procedure Set_Instance_Env
13755 (Gen_Unit : Entity_Id;
13756 Act_Unit : Entity_Id)
13757 is
13758 begin
13759 -- Regardless of the current mode, predefined units are analyzed in the
13760 -- most current Ada mode, and earlier version Ada checks do not apply
13761 -- to predefined units. Nothing needs to be done for non-internal units.
13762 -- These are always analyzed in the current mode.
13763
13764 if Is_Internal_File_Name
13765 (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
13766 Renamings_Included => True)
13767 then
13768 Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
13769 end if;
13770
13771 Current_Instantiated_Parent :=
13772 (Gen_Id => Gen_Unit,
13773 Act_Id => Act_Unit,
13774 Next_In_HTable => Assoc_Null);
13775 end Set_Instance_Env;
13776
13777 -----------------
13778 -- Switch_View --
13779 -----------------
13780
13781 procedure Switch_View (T : Entity_Id) is
13782 BT : constant Entity_Id := Base_Type (T);
13783 Priv_Elmt : Elmt_Id := No_Elmt;
13784 Priv_Sub : Entity_Id;
13785
13786 begin
13787 -- T may be private but its base type may have been exchanged through
13788 -- some other occurrence, in which case there is nothing to switch
13789 -- besides T itself. Note that a private dependent subtype of a private
13790 -- type might not have been switched even if the base type has been,
13791 -- because of the last branch of Check_Private_View (see comment there).
13792
13793 if not Is_Private_Type (BT) then
13794 Prepend_Elmt (Full_View (T), Exchanged_Views);
13795 Exchange_Declarations (T);
13796 return;
13797 end if;
13798
13799 Priv_Elmt := First_Elmt (Private_Dependents (BT));
13800
13801 if Present (Full_View (BT)) then
13802 Prepend_Elmt (Full_View (BT), Exchanged_Views);
13803 Exchange_Declarations (BT);
13804 end if;
13805
13806 while Present (Priv_Elmt) loop
13807 Priv_Sub := (Node (Priv_Elmt));
13808
13809 -- We avoid flipping the subtype if the Etype of its full view is
13810 -- private because this would result in a malformed subtype. This
13811 -- occurs when the Etype of the subtype full view is the full view of
13812 -- the base type (and since the base types were just switched, the
13813 -- subtype is pointing to the wrong view). This is currently the case
13814 -- for tagged record types, access types (maybe more?) and needs to
13815 -- be resolved. ???
13816
13817 if Present (Full_View (Priv_Sub))
13818 and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
13819 then
13820 Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
13821 Exchange_Declarations (Priv_Sub);
13822 end if;
13823
13824 Next_Elmt (Priv_Elmt);
13825 end loop;
13826 end Switch_View;
13827
13828 -----------------
13829 -- True_Parent --
13830 -----------------
13831
13832 function True_Parent (N : Node_Id) return Node_Id is
13833 begin
13834 if Nkind (Parent (N)) = N_Subunit then
13835 return Parent (Corresponding_Stub (Parent (N)));
13836 else
13837 return Parent (N);
13838 end if;
13839 end True_Parent;
13840
13841 -----------------------------
13842 -- Valid_Default_Attribute --
13843 -----------------------------
13844
13845 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
13846 Attr_Id : constant Attribute_Id :=
13847 Get_Attribute_Id (Attribute_Name (Def));
13848 T : constant Entity_Id := Entity (Prefix (Def));
13849 Is_Fun : constant Boolean := (Ekind (Nam) = E_Function);
13850 F : Entity_Id;
13851 Num_F : Int;
13852 OK : Boolean;
13853
13854 begin
13855 if No (T)
13856 or else T = Any_Id
13857 then
13858 return;
13859 end if;
13860
13861 Num_F := 0;
13862 F := First_Formal (Nam);
13863 while Present (F) loop
13864 Num_F := Num_F + 1;
13865 Next_Formal (F);
13866 end loop;
13867
13868 case Attr_Id is
13869 when Attribute_Adjacent | Attribute_Ceiling | Attribute_Copy_Sign |
13870 Attribute_Floor | Attribute_Fraction | Attribute_Machine |
13871 Attribute_Model | Attribute_Remainder | Attribute_Rounding |
13872 Attribute_Unbiased_Rounding =>
13873 OK := Is_Fun
13874 and then Num_F = 1
13875 and then Is_Floating_Point_Type (T);
13876
13877 when Attribute_Image | Attribute_Pred | Attribute_Succ |
13878 Attribute_Value | Attribute_Wide_Image |
13879 Attribute_Wide_Value =>
13880 OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
13881
13882 when Attribute_Max | Attribute_Min =>
13883 OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
13884
13885 when Attribute_Input =>
13886 OK := (Is_Fun and then Num_F = 1);
13887
13888 when Attribute_Output | Attribute_Read | Attribute_Write =>
13889 OK := (not Is_Fun and then Num_F = 2);
13890
13891 when others =>
13892 OK := False;
13893 end case;
13894
13895 if not OK then
13896 Error_Msg_N ("attribute reference has wrong profile for subprogram",
13897 Def);
13898 end if;
13899 end Valid_Default_Attribute;
13900
13901 end Sem_Ch12;