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