Implement -mmemcpy-strategy= and -mmemset-strategy= options
[official-gcc.git] / gcc / ada / sem_ch12.adb
blobb93d3858335483e6c1d486a594a7315378822a28
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 ------------------------------------------------------------------------------
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;
80 with GNAT.HTable;
82 package body Sem_Ch12 is
84 ----------------------------------------------------------
85 -- Implementation of Generic Analysis and Instantiation --
86 ----------------------------------------------------------
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:
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:
102 -- .-----------. .----------.
103 -- | semantic |<--------------| generic |
104 -- | copy | | unit |
105 -- | |==============>| |
106 -- |___________| global |__________|
107 -- references | | |
108 -- | | |
109 -- .-----|--|.
110 -- | .-----|---.
111 -- | | .----------.
112 -- | | | generic |
113 -- |__| | |
114 -- |__| instance |
115 -- |__________|
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.
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.
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.
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.
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.
160 -- Visibility within nested generic units requires special handling.
161 -- Consider the following scheme:
163 -- type Global is ... -- outside of generic unit.
164 -- generic ...
165 -- package Outer is
166 -- ...
167 -- type Semi_Global is ... -- global to inner.
169 -- generic ... -- 1
170 -- procedure inner (X1 : Global; X2 : Semi_Global);
172 -- procedure in2 is new inner (...); -- 4
173 -- end Outer;
175 -- package New_Outer is new Outer (...); -- 2
176 -- procedure New_Inner is new New_Outer.Inner (...); -- 3
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.
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).
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.
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.
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.
208 -- For example, it is possible to compile two packages A and B that
209 -- have the following structure:
211 -- package A is package B is
212 -- generic ... generic ...
213 -- package G_A is package G_B is
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 (..)
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.
225 ----------------------------------------------
226 -- Detection of Instantiation Circularities --
227 ----------------------------------------------
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.
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.
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.
246 -------------------------------------------------
247 -- Formal packages and partial parametrization --
248 -------------------------------------------------
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.
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.
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.
276 -- The list of declarations (renamings and copies of formals) is built
277 -- by Analyze_Associations, just as for regular instantiations.
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.
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.
293 -----------------------
294 -- Local subprograms --
295 -----------------------
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.
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.
310 -- The following procedures treat other kinds of formal parameters
312 procedure Analyze_Formal_Derived_Interface_Type
313 (N : Node_Id;
314 T : Entity_Id;
315 Def : Node_Id);
317 procedure Analyze_Formal_Derived_Type
318 (N : Node_Id;
319 T : Entity_Id;
320 Def : Node_Id);
322 procedure Analyze_Formal_Interface_Type
323 (N : Node_Id;
324 T : Entity_Id;
325 Def : Node_Id);
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.
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);
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
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
351 procedure Analyze_Generic_Formal_Part (N : Node_Id);
352 -- Analyze generic formal part
354 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
355 -- Create a new access type with the given designated type
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.
367 procedure Analyze_Subprogram_Instantiation
368 (N : Node_Id;
369 K : Entity_Kind);
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.
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.
389 procedure Check_Formal_Packages (P_Id : Entity_Id);
390 -- Apply the following to all formal packages in generic associations
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.
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.
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.
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.
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.
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.
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.
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.
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 ???
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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)).
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.
574 procedure Remove_Parent (In_Body : Boolean := False);
575 -- Reverse effect after instantiation of child is complete
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.
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.
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.
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.
604 function Instantiate_Object
605 (Formal : Node_Id;
606 Actual : Node_Id;
607 Analyzed_Formal : Node_Id) return List_Id;
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;
615 function Instantiate_Formal_Subprogram
616 (Formal : Node_Id;
617 Actual : Node_Id;
618 Analyzed_Formal : Node_Id) return Node_Id;
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.
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.
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.
649 function Is_In_Main_Unit (N : Node_Id) return Boolean;
650 -- Test if given node is in the main unit
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.
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.
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.
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.
679 -- Three kinds of source nodes have associated nodes:
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.
686 -- b) aggregates (N_Aggregate and N_Extension_Aggregate)
688 -- c) selected components (N_Selected_Component)
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
750 -------------------------------------------
751 -- Data Structures for Generic Renamings --
752 -------------------------------------------
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.
759 type Assoc_Ptr is new Int;
761 Assoc_Null : constant Assoc_Ptr := -1;
763 type Assoc is record
764 Gen_Id : Entity_Id;
765 Act_Id : Entity_Id;
766 Next_In_HTable : Assoc_Ptr;
767 end record;
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");
777 -- Variable to hold enclosing instantiation. When the environment is
778 -- saved for a subprogram inlining, the corresponding Act_Id is empty.
780 Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
782 -- Hash table for associations
784 HTable_Size : constant := 37;
785 type HTable_Range is range 0 .. HTable_Size - 1;
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;
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 => "=");
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.
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.
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.
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).
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.
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;
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");
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.
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).
865 ------------------------------------
866 -- Structures for Error Reporting --
867 ------------------------------------
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.
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.
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.
887 ------------------------------------------------------------
888 -- Data structure for keeping track when inside a Generic --
889 ------------------------------------------------------------
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.
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");
902 ---------------------------
903 -- Abandon_Instantiation --
904 ---------------------------
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;
912 --------------------------
913 -- Analyze_Associations --
914 --------------------------
916 function Analyze_Associations
917 (I_Node : Node_Id;
918 Formals : List_Id;
919 F_Copy : List_Id) return List_Id
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));
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;
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.
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.
947 Is_Named_Assoc : Boolean;
948 Num_Matched : Int := 0;
949 Num_Actuals : Int := 0;
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.
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.
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.
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.
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.
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.
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.
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.
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.
1003 ----------------------------------------
1004 -- Check_Overloaded_Formal_Subprogram --
1005 ----------------------------------------
1007 procedure Check_Overloaded_Formal_Subprogram (Formal : Entity_Id) is
1008 Temp_Formal : Entity_Id;
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);
1024 else
1025 Error_Msg_N
1026 ("named association not allowed for overloaded formal",
1027 Others_Choice);
1028 end if;
1030 Abandon_Instantiation (Instantiation_Node);
1031 end if;
1033 Next (Temp_Formal);
1034 end loop;
1035 end Check_Overloaded_Formal_Subprogram;
1037 -------------------------------
1038 -- Has_Fully_Defined_Profile --
1039 -------------------------------
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
1045 ---------------------------
1046 -- Is_Fully_Defined_Type --
1047 ---------------------------
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
1053 if Is_Private_Type (Typ)
1054 and then No (Full_View (Typ))
1055 then
1056 return False;
1058 -- An incomplete type is never fully defined
1060 elsif Is_Incomplete_Type (Typ) then
1061 return False;
1063 -- All other types are fully defined
1065 else
1066 return True;
1067 end if;
1068 end Is_Fully_Defined_Type;
1070 -- Local declarations
1072 Param : Entity_Id;
1074 -- Start of processing for Has_Fully_Defined_Profile
1076 begin
1077 -- Check the parameters
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;
1085 Next_Formal (Param);
1086 end loop;
1088 -- Check the return type
1090 return Is_Fully_Defined_Type (Etype (Subp));
1091 end Has_Fully_Defined_Profile;
1093 ---------------------
1094 -- Matching_Actual --
1095 ---------------------
1097 function Matching_Actual
1098 (F : Entity_Id;
1099 A_F : Entity_Id) return Node_Id
1101 Prev : Node_Id;
1102 Act : Node_Id;
1104 begin
1105 Is_Named_Assoc := False;
1107 -- End of list of purely positional parameters
1109 if No (Actual) or else Nkind (Actual) = N_Others_Choice then
1110 Found_Assoc := Empty;
1111 Act := Empty;
1113 -- Case of positional parameter corresponding to current formal
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);
1121 -- Otherwise scan list of named actuals to find the one with the
1122 -- desired name. All remaining actuals have explicit names.
1124 else
1125 Is_Named_Assoc := True;
1126 Found_Assoc := Empty;
1127 Act := Empty;
1128 Prev := Empty;
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;
1141 Prev := Actual;
1142 Next (Actual);
1143 end loop;
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.
1153 if Actual = First_Named then
1154 Next (First_Named);
1156 elsif Present (Actual) then
1157 Insert_Before (First_Named, Remove_Next (Prev));
1158 end if;
1160 Actual := First_Named;
1161 end if;
1163 if Is_Entity_Name (Act) and then Present (Entity (Act)) then
1164 Set_Used_As_Generic_Actual (Entity (Act));
1165 end if;
1167 return Act;
1168 end Matching_Actual;
1170 -----------------------------
1171 -- Partial_Parametrization --
1172 -----------------------------
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;
1180 ---------------------
1181 -- Process_Default --
1182 ---------------------
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;
1191 begin
1192 -- Append copy of formal declaration to associations, and create new
1193 -- defining identifier for it.
1195 Decl := New_Copy_Tree (F);
1196 Id := Make_Defining_Identifier (Sloc (F_Id), Chars (F_Id));
1198 if Nkind (F) in N_Formal_Subprogram_Declaration then
1199 Set_Defining_Unit_Name (Specification (Decl), Id);
1201 else
1202 Set_Defining_Identifier (Decl, Id);
1203 end if;
1205 Append (Decl, Assoc);
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;
1217 ---------------------------------
1218 -- Renames_Standard_Subprogram --
1219 ---------------------------------
1221 function Renames_Standard_Subprogram (Subp : Entity_Id) return Boolean is
1222 Id : Entity_Id;
1224 begin
1225 Id := Alias (Subp);
1226 while Present (Id) loop
1227 if Scope (Id) = Standard_Standard then
1228 return True;
1229 end if;
1231 Id := Alias (Id);
1232 end loop;
1234 return False;
1235 end Renames_Standard_Subprogram;
1237 -------------------------
1238 -- Set_Analyzed_Formal --
1239 -------------------------
1241 procedure Set_Analyzed_Formal is
1242 Kind : Node_Kind;
1244 begin
1245 while Present (Analyzed_Formal) loop
1246 Kind := Nkind (Analyzed_Formal);
1248 case Nkind (Formal) is
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)));
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);
1263 when N_Use_Package_Clause | N_Use_Type_Clause => exit;
1265 when others =>
1267 -- Skip freeze nodes, and nodes inserted to replace
1268 -- unrecognized pragmas.
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;
1280 Next (Analyzed_Formal);
1281 end loop;
1282 end Set_Analyzed_Formal;
1284 -- Start of processing for Analyze_Associations
1286 begin
1287 Actuals := Generic_Associations (I_Node);
1289 if Present (Actuals) then
1291 -- Check for an Others choice, indicating a partial parametrization
1292 -- for a formal package.
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;
1300 if Present (Next (Actual)) then
1301 Error_Msg_N ("others must be last association", Actual);
1302 end if;
1304 -- This subprogram is used both for formal packages and for
1305 -- instantiations. For the latter, associations must all be
1306 -- explicit.
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;
1316 -- In any case, nothing to do after the others association
1318 exit;
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;
1328 Next (Actual);
1329 end loop;
1331 -- If named associations are present, save first named association
1332 -- (it may of course be Empty) to facilitate subsequent name search.
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;
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;
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.
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;
1363 Next (Named);
1364 end loop;
1366 if Present (Formals) then
1367 Formal := First_Non_Pragma (Formals);
1368 Analyzed_Formal := First_Non_Pragma (F_Copy);
1370 if Present (Actuals) then
1371 Actual := First (Actuals);
1373 -- All formals should have default values
1375 else
1376 Actual := Empty;
1377 end if;
1379 while Present (Formal) loop
1380 Set_Analyzed_Formal;
1381 Saved_Formal := Next_Non_Pragma (Formal);
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));
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;
1398 when N_Formal_Type_Declaration =>
1399 Match :=
1400 Matching_Actual (
1401 Defining_Identifier (Formal),
1402 Defining_Identifier (Analyzed_Formal));
1404 if No (Match) then
1405 if Partial_Parametrization then
1406 Process_Default (Formal);
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;
1419 else
1420 Analyze (Match);
1421 Append_List
1422 (Instantiate_Type
1423 (Formal, Match, Analyzed_Formal, Assoc),
1424 Assoc);
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.
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;
1439 else
1440 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1441 end if;
1442 end if;
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.
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.
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
1470 null;
1472 elsif Is_Remote_Types (Formal_Ent) then
1474 -- Remote formal, non-remote actual
1476 Error_Msg_NE
1477 ("actual for& must be remote", Match, Formal_Ent);
1479 else
1480 -- Non-remote formal, remote actual
1482 Error_Msg_NE
1483 ("actual for& may not be remote",
1484 Match, Formal_Ent);
1485 end if;
1486 end;
1487 end if;
1489 when N_Formal_Subprogram_Declaration =>
1490 Match :=
1491 Matching_Actual
1492 (Defining_Unit_Name (Specification (Formal)),
1493 Defining_Unit_Name (Specification (Analyzed_Formal)));
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.
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;
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.
1511 if No (Match) and then Partial_Parametrization then
1512 Process_Default (Formal);
1514 if Nkind (I_Node) = N_Formal_Package_Declaration then
1515 Check_Overloaded_Formal_Subprogram (Formal);
1516 end if;
1518 else
1519 Append_To (Assoc,
1520 Instantiate_Formal_Subprogram
1521 (Formal, Match, Analyzed_Formal));
1523 -- An instantiation is a freeze point for the actuals,
1524 -- unless this is a rewritten formal package.
1526 if Nkind (I_Node) /= N_Formal_Package_Declaration
1527 and then Nkind (Match) = N_Identifier
1528 and then Is_Subprogram (Entity (Match))
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.
1534 and then
1535 not Renames_Standard_Subprogram (Entity (Match))
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.
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.
1550 Set_Has_Delayed_Freeze (Entity (Match));
1551 Append_Elmt (Entity (Match), Actuals_To_Freeze);
1552 end if;
1553 end if;
1555 -- If this is a nested generic, preserve default for later
1556 -- instantiations.
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;
1566 when N_Formal_Package_Declaration =>
1567 Match :=
1568 Matching_Actual (
1569 Defining_Identifier (Formal),
1570 Defining_Identifier (Original_Node (Analyzed_Formal)));
1572 if No (Match) then
1573 if Partial_Parametrization then
1574 Process_Default (Formal);
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);
1584 Abandon_Instantiation (Instantiation_Node);
1585 end if;
1587 else
1588 Analyze (Match);
1589 Append_List
1590 (Instantiate_Formal_Package
1591 (Formal, Match, Analyzed_Formal),
1592 Assoc);
1593 end if;
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).
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;
1611 when others =>
1612 raise Program_Error;
1614 end case;
1616 Formal := Saved_Formal;
1617 Next_Non_Pragma (Analyzed_Formal);
1618 end loop;
1620 if Num_Actuals > Num_Matched then
1621 Error_Msg_Sloc := Sloc (Gen_Unit);
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;
1636 elsif Present (Actuals) then
1637 Error_Msg_N
1638 ("too many actuals in generic instantiation", Instantiation_Node);
1639 end if;
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.
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;
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.
1658 declare
1659 Elmt : Elmt_Id;
1660 Subp : Entity_Id;
1661 New_D : Node_Id;
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;
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;
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.
1687 if not Is_Empty_List (Default_Formals) then
1688 Append_List (Default_Formals, Formals);
1689 end if;
1691 return Assoc;
1692 end Analyze_Associations;
1694 -------------------------------
1695 -- Analyze_Formal_Array_Type --
1696 -------------------------------
1698 procedure Analyze_Formal_Array_Type
1699 (T : in out Entity_Id;
1700 Def : Node_Id)
1702 DSS : Node_Id;
1704 begin
1705 -- Treated like a non-generic array declaration, with additional
1706 -- semantic checks.
1708 Enter_Name (T);
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;
1720 Next (DSS);
1721 end loop;
1722 end if;
1724 Array_Type_Declaration (T, Def);
1725 Set_Is_Generic_Type (Base_Type (T));
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);
1732 -- Check that range constraint is not allowed on the component type
1733 -- of a generic formal array type (AARM 12.5.3(3))
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;
1747 end Analyze_Formal_Array_Type;
1749 ---------------------------------------------
1750 -- Analyze_Formal_Decimal_Fixed_Point_Type --
1751 ---------------------------------------------
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.
1762 procedure Analyze_Formal_Decimal_Fixed_Point_Type
1763 (T : Entity_Id;
1764 Def : Node_Id)
1766 Loc : constant Source_Ptr := Sloc (Def);
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');
1774 Int_Base : constant Entity_Id := Standard_Integer;
1775 Delta_Val : constant Ureal := Ureal_1;
1776 Digs_Val : constant Uint := Uint_6;
1778 begin
1779 Enter_Name (T);
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)));
1793 Set_Is_Generic_Type (Base);
1794 Set_Parent (Base, Parent (Def));
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);
1807 Check_Restriction (No_Fixed_Point, Def);
1808 end Analyze_Formal_Decimal_Fixed_Point_Type;
1810 -------------------------------------------
1811 -- Analyze_Formal_Derived_Interface_Type --
1812 -------------------------------------------
1814 procedure Analyze_Formal_Derived_Interface_Type
1815 (N : Node_Id;
1816 T : Entity_Id;
1817 Def : Node_Id)
1819 Loc : constant Source_Ptr := Sloc (Def);
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.
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;
1833 ---------------------------------
1834 -- Analyze_Formal_Derived_Type --
1835 ---------------------------------
1837 procedure Analyze_Formal_Derived_Type
1838 (N : Node_Id;
1839 T : Entity_Id;
1840 Def : Node_Id)
1842 Loc : constant Source_Ptr := Sloc (Def);
1843 Unk_Disc : constant Boolean := Unknown_Discriminants_Present (N);
1844 New_N : Node_Id;
1846 begin
1847 Set_Is_Generic_Type (T);
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));
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));
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)));
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;
1878 Rewrite (N, New_N);
1879 Analyze (N);
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;
1891 -- If the parent type has a known size, so does the formal, which makes
1892 -- legal representation clauses that involve the formal.
1894 Set_Size_Known_At_Compile_Time
1895 (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
1896 end Analyze_Formal_Derived_Type;
1898 ----------------------------------
1899 -- Analyze_Formal_Discrete_Type --
1900 ----------------------------------
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.
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;
1911 Base : constant Entity_Id :=
1912 New_Internal_Entity
1913 (E_Floating_Point_Type, Current_Scope,
1914 Sloc (Defining_Identifier (Parent (Def))), 'G');
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);
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.
1930 Lo :=
1931 Make_Attribute_Reference (Loc,
1932 Attribute_Name => Name_First,
1933 Prefix => New_Reference_To (T, Loc));
1934 Set_Etype (Lo, T);
1936 Hi :=
1937 Make_Attribute_Reference (Loc,
1938 Attribute_Name => Name_Last,
1939 Prefix => New_Reference_To (T, Loc));
1940 Set_Etype (Hi, T);
1942 Set_Scalar_Range (T,
1943 Make_Range (Loc,
1944 Low_Bound => Lo,
1945 High_Bound => Hi));
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;
1956 ----------------------------------
1957 -- Analyze_Formal_Floating_Type --
1958 ---------------------------------
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');
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.
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);
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));
1989 Check_Restriction (No_Floating_Point, Def);
1990 end Analyze_Formal_Floating_Type;
1992 -----------------------------------
1993 -- Analyze_Formal_Interface_Type;--
1994 -----------------------------------
1996 procedure Analyze_Formal_Interface_Type
1997 (N : Node_Id;
1998 T : Entity_Id;
1999 Def : Node_Id)
2001 Loc : constant Source_Ptr := Sloc (N);
2002 New_N : Node_Id;
2004 begin
2005 New_N :=
2006 Make_Full_Type_Declaration (Loc,
2007 Defining_Identifier => T,
2008 Type_Definition => Def);
2010 Rewrite (N, New_N);
2011 Analyze (N);
2012 Set_Is_Generic_Type (T);
2013 end Analyze_Formal_Interface_Type;
2015 ---------------------------------
2016 -- Analyze_Formal_Modular_Type --
2017 ---------------------------------
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.
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);
2028 end Analyze_Formal_Modular_Type;
2030 ---------------------------------------
2031 -- Analyze_Formal_Object_Declaration --
2032 ---------------------------------------
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;
2040 begin
2041 Enter_Name (Id);
2043 -- Determine the mode of the formal object
2045 if Out_Present (N) then
2046 K := E_Generic_In_Out_Parameter;
2048 if not In_Present (N) then
2049 Error_Msg_N ("formal generic objects cannot have mode OUT", N);
2050 end if;
2052 else
2053 K := E_Generic_In_Parameter;
2054 end if;
2056 if Present (Subtype_Mark (N)) then
2057 Find_Type (Subtype_Mark (N));
2058 T := Entity (Subtype_Mark (N));
2060 -- Verify that there is no redundant null exclusion
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);
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;
2074 -- Ada 2005 (AI-423): Formal object with an access definition
2076 else
2077 Check_Access_Definition (N);
2078 T := Access_Definition
2079 (Related_Nod => N,
2080 N => Access_Definition (N));
2081 end if;
2083 if Ekind (T) = E_Incomplete_Type then
2084 declare
2085 Error_Node : Node_Id;
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;
2095 Error_Msg_N ("premature usage of incomplete type", Error_Node);
2096 end;
2097 end if;
2099 if K = E_Generic_In_Parameter then
2101 -- Ada 2005 (AI-287): Limited aggregates allowed in generic formals
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;
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;
2114 if Present (E) then
2115 Preanalyze_Spec_Expression (E, T);
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;
2124 Set_Ekind (Id, K);
2125 Set_Etype (Id, T);
2127 -- Case of generic IN OUT parameter
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.
2134 Set_Ekind (Id, K);
2135 Set_Etype (Id, T);
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;
2148 begin
2149 -- Make sure the actual subtype doesn't generate bogus freezing
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;
2160 if Present (E) then
2161 Error_Msg_N
2162 ("initialization not allowed for `IN OUT` formals", N);
2163 end if;
2164 end if;
2166 if Has_Aspects (N) then
2167 Analyze_Aspect_Specifications (N, Id);
2168 end if;
2169 end Analyze_Formal_Object_Declaration;
2171 ----------------------------------------------
2172 -- Analyze_Formal_Ordinary_Fixed_Point_Type --
2173 ----------------------------------------------
2175 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
2176 (T : Entity_Id;
2177 Def : Node_Id)
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');
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.
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);
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));
2211 Check_Restriction (No_Fixed_Point, Def);
2212 end Analyze_Formal_Ordinary_Fixed_Point_Type;
2214 ----------------------------------------
2215 -- Analyze_Formal_Package_Declaration --
2216 ----------------------------------------
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;
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
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.
2244 -------------------------
2245 -- Build_Local_Package --
2246 -------------------------
2248 function Build_Local_Package return Node_Id is
2249 Decls : List_Id;
2250 Pack_Decl : Node_Id;
2252 begin
2253 -- Within the formal, the name of the generic package is a renaming
2254 -- of the formal (as for a regular instantiation).
2256 Pack_Decl :=
2257 Make_Package_Declaration (Loc,
2258 Specification =>
2259 Copy_Generic_Node
2260 (Specification (Original_Node (Gen_Decl)),
2261 Empty, Instantiating => True));
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));
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;
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.
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.
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;
2290 begin
2291 -- TBA : for a formal package, need to recurse ???
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;
2304 -- If generic associations are present, use Analyze_Associations to
2305 -- create the proper renaming declarations.
2307 else
2308 declare
2309 Act_Tree : constant Node_Id :=
2310 Copy_Generic_Node
2311 (Original_Node (Gen_Decl), Empty,
2312 Instantiating => True);
2314 begin
2315 Generic_Renamings.Set_Last (0);
2316 Generic_Renamings_HTable.Reset;
2317 Instantiation_Node := N;
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));
2325 Vis_Prims_List := Check_Hidden_Primitives (Decls);
2326 end;
2327 end if;
2329 Append (Renaming, To => Decls);
2331 -- Add generated declarations ahead of local declarations in
2332 -- the package.
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;
2342 return Pack_Decl;
2343 end Build_Local_Package;
2345 -- Start of processing for Analyze_Formal_Package_Declaration
2347 begin
2348 Text_IO_Kludge (Gen_Id);
2350 Init_Env;
2351 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2352 Gen_Unit := Entity (Gen_Id);
2354 -- Check for a formal package that is a package renaming
2356 if Present (Renamed_Object (Gen_Unit)) then
2358 -- Indicate that unit is used, before replacing it with renamed
2359 -- entity for use below.
2361 if In_Extended_Main_Source_Unit (N) then
2362 Set_Is_Instantiated (Gen_Unit);
2363 Generate_Reference (Gen_Unit, N);
2364 end if;
2366 Gen_Unit := Renamed_Object (Gen_Unit);
2367 end if;
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;
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;
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.
2388 Error_Msg_N
2389 ("generic parent cannot be used as formal package "
2390 & "of a child unit",
2391 Gen_Id);
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;
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.
2407 declare
2408 Gen_Name : Entity_Id;
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;
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;
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;
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.
2436 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2438 if In_Extended_Main_Source_Unit (N) then
2439 Set_Is_Instantiated (Gen_Unit);
2440 Generate_Reference (Gen_Unit, N);
2441 end if;
2443 Formal := New_Copy (Pack_Id);
2444 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2446 begin
2447 -- Make local generic without formals. The formals will be replaced
2448 -- with internal declarations.
2450 New_N := Build_Local_Package;
2452 -- If there are errors in the parameter list, Analyze_Associations
2453 -- raises Instantiation_Error. Patch the declaration to prevent
2454 -- further exception propagation.
2456 exception
2457 when Instantiation_Error =>
2459 Enter_Name (Formal);
2460 Set_Ekind (Formal, E_Variable);
2461 Set_Etype (Formal, Any_Type);
2462 Restore_Hidden_Primitives (Vis_Prims_List);
2464 if Parent_Installed then
2465 Remove_Parent;
2466 end if;
2468 goto Leave;
2469 end;
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);
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);
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.
2491 Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
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;
2503 Analyze (Specification (N));
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.
2509 -- If there are no associations, the only local entity to hide is the
2510 -- generated package renaming itself.
2512 declare
2513 E : Entity_Id;
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;
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;
2531 Next_Entity (E);
2532 end loop;
2533 end;
2535 End_Package_Scope (Formal);
2536 Restore_Hidden_Primitives (Vis_Prims_List);
2538 if Parent_Installed then
2539 Remove_Parent;
2540 end if;
2542 Restore_Env;
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.
2550 Set_Has_Completion (Formal, True);
2552 -- Add semantic information to the original defining identifier.
2553 -- for ASIS use.
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);
2560 <<Leave>>
2561 if Has_Aspects (N) then
2562 Analyze_Aspect_Specifications (N, Pack_Id);
2563 end if;
2564 end Analyze_Formal_Package_Declaration;
2566 ---------------------------------
2567 -- Analyze_Formal_Private_Type --
2568 ---------------------------------
2570 procedure Analyze_Formal_Private_Type
2571 (N : Node_Id;
2572 T : Entity_Id;
2573 Def : Node_Id)
2575 begin
2576 New_Private_Type (N, T, Def);
2578 -- Set the size to an arbitrary but legal value
2580 Set_Size_Info (T, Standard_Integer);
2581 Set_RM_Size (T, RM_Size (Standard_Integer));
2582 end Analyze_Formal_Private_Type;
2584 ------------------------------------
2585 -- Analyze_Formal_Incomplete_Type --
2586 ------------------------------------
2588 procedure Analyze_Formal_Incomplete_Type
2589 (T : Entity_Id;
2590 Def : Node_Id)
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);
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;
2605 ----------------------------------------
2606 -- Analyze_Formal_Signed_Integer_Type --
2607 ----------------------------------------
2609 procedure Analyze_Formal_Signed_Integer_Type
2610 (T : Entity_Id;
2611 Def : Node_Id)
2613 Base : constant Entity_Id :=
2614 New_Internal_Entity
2615 (E_Signed_Integer_Type,
2616 Current_Scope,
2617 Sloc (Defining_Identifier (Parent (Def))), 'G');
2619 begin
2620 Enter_Name (T);
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);
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;
2637 -------------------------------------------
2638 -- Analyze_Formal_Subprogram_Declaration --
2639 -------------------------------------------
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;
2647 begin
2648 if Nam = Error then
2649 return;
2650 end if;
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;
2657 Analyze_Subprogram_Declaration (N);
2658 Set_Is_Formal_Subprogram (Nam);
2659 Set_Has_Completion (Nam);
2661 if Nkind (N) = N_Formal_Abstract_Subprogram_Declaration then
2662 Set_Is_Abstract_Subprogram (Nam);
2663 Set_Is_Dispatching_Operation (Nam);
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",
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);
2680 else
2681 Check_Controlling_Formals (Ctrl_Type, Nam);
2682 end if;
2683 end;
2684 end if;
2686 -- Default name is resolved at the point of instantiation
2688 if Box_Present (N) then
2689 null;
2691 -- Else default is bound at the point of generic declaration
2693 elsif Present (Def) then
2694 if Nkind (Def) = N_Operator_Symbol then
2695 Find_Direct_Name (Def);
2697 elsif Nkind (Def) /= N_Attribute_Reference then
2698 Analyze (Def);
2700 else
2701 -- For an attribute reference, analyze the prefix and verify
2702 -- that it has the proper profile for the subprogram.
2704 Analyze (Prefix (Def));
2705 Valid_Default_Attribute (Nam, Def);
2706 goto Leave;
2707 end if;
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.
2715 if Etype (Def) = Any_Type then
2716 goto Leave;
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;
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;
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;
2736 else
2737 Error_Msg_N ("expect valid subprogram name as default", Def);
2738 goto Leave;
2739 end if;
2741 elsif Nkind (Def) = N_Character_Literal then
2743 -- Needs some type checks: subprogram should be parameterless???
2745 Resolve (Def, (Etype (Nam)));
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;
2753 elsif not Is_Overloaded (Def) then
2754 Subp := Entity (Def);
2756 if Subp = Nam then
2757 Error_Msg_N ("premature usage of formal subprogram", Def);
2759 elsif not Entity_Matches_Spec (Subp, Nam) then
2760 Error_Msg_N ("no visible entity matches specification", Def);
2761 end if;
2763 -- More than one interpretation, so disambiguate as for a renaming
2765 else
2766 declare
2767 I : Interp_Index;
2768 I1 : Interp_Index := 0;
2769 It : Interp;
2770 It1 : Interp;
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));
2780 if It1 = No_Interp then
2781 Error_Msg_N ("ambiguous default subprogram", Def);
2782 else
2783 Subp := It1.Nam;
2784 end if;
2786 exit;
2788 else
2789 I1 := I;
2790 Subp := It.Nam;
2791 end if;
2792 end if;
2794 Get_Next_Interp (I, It);
2795 end loop;
2796 end;
2798 if Subp /= Any_Id then
2800 -- Subprogram found, generate reference to it
2802 Set_Entity (Def, Subp);
2803 Generate_Reference (Subp, Def);
2805 if Subp = Nam then
2806 Error_Msg_N ("premature usage of formal subprogram", Def);
2808 elsif Ekind (Subp) /= E_Operator then
2809 Check_Mode_Conformant (Subp, Nam);
2810 end if;
2812 else
2813 Error_Msg_N ("no visible subprogram matches specification", N);
2814 end if;
2815 end if;
2816 end if;
2818 <<Leave>>
2819 if Has_Aspects (N) then
2820 Analyze_Aspect_Specifications (N, Nam);
2821 end if;
2823 end Analyze_Formal_Subprogram_Declaration;
2825 -------------------------------------
2826 -- Analyze_Formal_Type_Declaration --
2827 -------------------------------------
2829 procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
2830 Def : constant Node_Id := Formal_Type_Definition (N);
2831 T : Entity_Id;
2833 begin
2834 T := Defining_Identifier (N);
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;
2843 -- Enter the new name, and branch to specific routine
2845 case Nkind (Def) is
2846 when N_Formal_Private_Type_Definition =>
2847 Analyze_Formal_Private_Type (N, T, Def);
2849 when N_Formal_Derived_Type_Definition =>
2850 Analyze_Formal_Derived_Type (N, T, Def);
2852 when N_Formal_Incomplete_Type_Definition =>
2853 Analyze_Formal_Incomplete_Type (T, Def);
2855 when N_Formal_Discrete_Type_Definition =>
2856 Analyze_Formal_Discrete_Type (T, Def);
2858 when N_Formal_Signed_Integer_Type_Definition =>
2859 Analyze_Formal_Signed_Integer_Type (T, Def);
2861 when N_Formal_Modular_Type_Definition =>
2862 Analyze_Formal_Modular_Type (T, Def);
2864 when N_Formal_Floating_Point_Definition =>
2865 Analyze_Formal_Floating_Type (T, Def);
2867 when N_Formal_Ordinary_Fixed_Point_Definition =>
2868 Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
2870 when N_Formal_Decimal_Fixed_Point_Definition =>
2871 Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
2873 when N_Array_Type_Definition =>
2874 Analyze_Formal_Array_Type (T, Def);
2876 when N_Access_To_Object_Definition |
2877 N_Access_Function_Definition |
2878 N_Access_Procedure_Definition =>
2879 Analyze_Generic_Access_Type (T, Def);
2881 -- Ada 2005: a interface declaration is encoded as an abstract
2882 -- record declaration or a abstract type derivation.
2884 when N_Record_Definition =>
2885 Analyze_Formal_Interface_Type (N, T, Def);
2887 when N_Derived_Type_Definition =>
2888 Analyze_Formal_Derived_Interface_Type (N, T, Def);
2890 when N_Error =>
2891 null;
2893 when others =>
2894 raise Program_Error;
2896 end case;
2898 Set_Is_Generic_Type (T);
2900 if Has_Aspects (N) then
2901 Analyze_Aspect_Specifications (N, T);
2902 end if;
2903 end Analyze_Formal_Type_Declaration;
2905 ------------------------------------
2906 -- Analyze_Function_Instantiation --
2907 ------------------------------------
2909 procedure Analyze_Function_Instantiation (N : Node_Id) is
2910 begin
2911 Analyze_Subprogram_Instantiation (N, E_Function);
2912 end Analyze_Function_Instantiation;
2914 ---------------------------------
2915 -- Analyze_Generic_Access_Type --
2916 ---------------------------------
2918 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
2919 begin
2920 Enter_Name (T);
2922 if Nkind (Def) = N_Access_To_Object_Definition then
2923 Access_Type_Declaration (T, Def);
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);
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;
2936 else
2937 Access_Subprogram_Declaration (T, Def);
2938 end if;
2939 end Analyze_Generic_Access_Type;
2941 ---------------------------------
2942 -- Analyze_Generic_Formal_Part --
2943 ---------------------------------
2945 procedure Analyze_Generic_Formal_Part (N : Node_Id) is
2946 Gen_Parm_Decl : Node_Id;
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.
2953 Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
2955 while Present (Gen_Parm_Decl) loop
2956 Analyze (Gen_Parm_Decl);
2957 Next (Gen_Parm_Decl);
2958 end loop;
2960 Generate_Reference_To_Generic_Formals (Current_Scope);
2961 end Analyze_Generic_Formal_Part;
2963 ------------------------------------------
2964 -- Analyze_Generic_Package_Declaration --
2965 ------------------------------------------
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;
2977 begin
2978 Check_SPARK_Restriction ("generic is not allowed", N);
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.
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))));
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;
3001 if Present (Decl) then
3002 Insert_Before (Decl, Renaming);
3003 else
3004 Append (Renaming, Visible_Declarations (Specification (N)));
3005 end if;
3007 else
3008 Set_Visible_Declarations (Specification (N), New_List (Renaming));
3009 end if;
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.
3015 Save_Parent := Parent_Spec (N);
3016 Set_Parent_Spec (N, Empty);
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);
3024 -- Analyze aspects now, so that generated pragmas appear in the
3025 -- declarations before building and analyzing the generic copy.
3027 if Has_Aspects (N) then
3028 Analyze_Aspect_Specifications (N, Id);
3029 end if;
3031 -- Expansion is not applied to generic units
3033 Start_Generic;
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);
3042 Set_Categorization_From_Pragmas (N);
3043 Set_Is_Pure (Id, Is_Pure (Current_Scope));
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.
3048 Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
3049 Set_Entity (Associated_Node (Name (Renaming)), Id);
3051 -- For a library unit, we have reconstructed the entity for the unit,
3052 -- and must reset it in the library tables.
3054 if Nkind (Parent (N)) = N_Compilation_Unit then
3055 Set_Cunit_Entity (Current_Sem_Unit, Id);
3056 end if;
3058 Analyze_Generic_Formal_Part (N);
3060 -- After processing the generic formals, analysis proceeds as for a
3061 -- non-generic package.
3063 Analyze (Specification (N));
3065 Validate_Categorization_Dependency (N, Id);
3067 End_Generic;
3069 End_Package_Scope (Id);
3070 Exit_Generic_Scope (Id);
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));
3077 else
3078 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
3079 Validate_RT_RAT_Component (N);
3081 -- If this is a spec without a body, check that generic parameters
3082 -- are referenced.
3084 if not Body_Required (Parent (N)) then
3085 Check_References (Id);
3086 end if;
3087 end if;
3089 end Analyze_Generic_Package_Declaration;
3091 --------------------------------------------
3092 -- Analyze_Generic_Subprogram_Declaration --
3093 --------------------------------------------
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;
3104 begin
3105 Check_SPARK_Restriction ("generic is not allowed", N);
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.
3111 Save_Parent := Parent_Spec (N);
3112 Set_Parent_Spec (N, Empty);
3114 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
3115 Set_Parent_Spec (New_N, Save_Parent);
3116 Rewrite (N, New_N);
3118 -- The aspect specifications are not attached to the tree, and must
3119 -- be copied and attached to the generic copy explicitly.
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;
3132 Spec := Specification (N);
3133 Id := Defining_Entity (Spec);
3134 Generate_Definition (Id);
3135 Set_Contract (Id, Make_Contract (Sloc (Id)));
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;
3142 Start_Generic;
3144 Enter_Name (Id);
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));
3152 Analyze_Generic_Formal_Part (N);
3154 Formals := Parameter_Specifications (Spec);
3156 if Present (Formals) then
3157 Process_Formals (Formals, Spec);
3158 end if;
3160 if Nkind (Spec) = N_Function_Specification then
3161 Set_Ekind (Id, E_Generic_Function);
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);
3167 -- Check restriction imposed by AI05-073: a generic function
3168 -- cannot return an abstract type or an access to such.
3170 -- This is a binding interpretation should it apply to earlier
3171 -- versions of Ada as well as Ada 2012???
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;
3180 else
3181 Find_Type (Result_Definition (Spec));
3182 Typ := Entity (Result_Definition (Spec));
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;
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.
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;
3208 else
3209 Set_Ekind (Id, E_Generic_Procedure);
3210 Set_Etype (Id, Standard_Void_Type);
3211 end if;
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.
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;
3222 Set_Categorization_From_Pragmas (N);
3223 Validate_Categorization_Dependency (N, Id);
3225 Save_Global_References (Original_Node (N));
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.
3232 if ASIS_Mode and then Is_List_Member (N) then
3233 Make_Aspect_For_PPC_In_Gen_Sub_Decl (N);
3234 end if;
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.
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 ???
3244 if Has_Aspects (N) then
3245 declare
3246 Aspect : Node_Id;
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;
3255 Next (Aspect);
3256 end loop;
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;
3266 End_Generic;
3267 End_Scope;
3268 Exit_Generic_Scope (Id);
3269 Generate_Reference_To_Formals (Id);
3271 List_Inherited_Pre_Post_Aspects (Id);
3272 end Analyze_Generic_Subprogram_Declaration;
3274 -----------------------------------
3275 -- Analyze_Package_Instantiation --
3276 -----------------------------------
3278 procedure Analyze_Package_Instantiation (N : Node_Id) is
3279 Loc : constant Source_Ptr := Sloc (N);
3280 Gen_Id : constant Node_Id := Name (N);
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;
3288 Gen_Decl : Node_Id;
3289 Gen_Unit : Entity_Id;
3291 Is_Actual_Pack : constant Boolean :=
3292 Is_Internal (Defining_Entity (N));
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;
3301 Save_Style_Check : constant Boolean := Style_Check;
3302 -- Save style check mode for restore on exit
3304 procedure Delay_Descriptors (E : Entity_Id);
3305 -- Delay generation of subprogram descriptors for given entity
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.
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.
3318 -----------------------
3319 -- Delay_Descriptors --
3320 -----------------------
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;
3330 -----------------------
3331 -- Might_Inline_Subp --
3332 -----------------------
3334 function Might_Inline_Subp return Boolean is
3335 E : Entity_Id;
3337 begin
3338 if not Inline_Processing_Required then
3339 return False;
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;
3350 Next_Entity (E);
3351 end loop;
3352 end if;
3354 return False;
3355 end Might_Inline_Subp;
3357 ----------------------
3358 -- Must_Inline_Subp --
3359 ----------------------
3361 function Must_Inline_Subp return Boolean is
3362 E : Entity_Id;
3364 begin
3365 if not Inline_Processing_Required then
3366 return False;
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;
3378 Next_Entity (E);
3379 end loop;
3380 end if;
3382 return False;
3383 end Must_Inline_Subp;
3385 -- Local declarations
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
3391 -- Start of processing for Analyze_Package_Instantiation
3393 begin
3394 Check_SPARK_Restriction ("generic is not allowed", N);
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.
3399 Text_IO_Kludge (Name (N));
3401 -- Make node global for error reporting
3403 Instantiation_Node := N;
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.
3409 Style_Check := False;
3411 -- Case of instantiation of a generic package
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);
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;
3426 -- Case of instantiation of a formal package
3428 else
3429 Act_Decl_Id := Defining_Identifier (N);
3430 Act_Decl_Name := Act_Decl_Id;
3431 end if;
3433 Generate_Definition (Act_Decl_Id);
3434 Preanalyze_Actuals (N);
3436 Init_Env;
3437 Env_Installed := True;
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.
3444 Generic_Renamings.Set_Last (0);
3445 Generic_Renamings_HTable.Reset;
3447 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3448 Gen_Unit := Entity (Gen_Id);
3450 -- Verify that it is the name of a generic package
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.
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;
3469 if Etype (Gen_Unit) = Any_Type then
3470 Restore_Env;
3471 goto Leave;
3473 elsif Ekind (Gen_Unit) /= E_Generic_Package then
3475 -- Ada 2005 (AI-50217): Cannot use instance in limited with_clause
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;
3485 Restore_Env;
3486 goto Leave;
3487 end if;
3489 if In_Extended_Main_Source_Unit (N) then
3490 Set_Is_Instantiated (Gen_Unit);
3491 Generate_Reference (Gen_Unit, N);
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;
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);
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;
3514 Set_Entity (Gen_Id, Gen_Unit);
3516 -- If generic is a renaming, get original generic unit
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;
3524 -- Verify that there are no circular instantiations
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;
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;
3539 else
3540 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
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.
3548 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3550 -- Copy original generic tree, to produce text for instantiation
3552 Act_Tree :=
3553 Copy_Generic_Node
3554 (Original_Node (Gen_Decl), Empty, Instantiating => True);
3556 Act_Spec := Specification (Act_Tree);
3558 -- If this is the instance created to validate an actual package,
3559 -- only the formals matter, do not examine the package spec itself.
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;
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));
3572 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
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);
3578 Set_Generic_Parent (Act_Spec, Gen_Unit);
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.
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));
3593 Append (Unit_Renaming, Renaming_List);
3595 -- The renaming declarations are the first local declarations of
3596 -- the new unit.
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;
3605 Act_Decl :=
3606 Make_Package_Declaration (Loc,
3607 Specification => Act_Spec);
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.
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.
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.
3625 Scop : Entity_Id;
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);
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;
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;
3647 exit when Is_Compilation_Unit (Scop);
3648 Scop := Scope (Scop);
3649 end loop;
3650 end if;
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.
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.
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;
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;
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.
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;
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. ???
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;
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));
3727 -- If front_end_inlining is enabled, do not instantiate body if
3728 -- within a generic context.
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;
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.
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;
3764 -- For RCI unit calling stubs, we omit the instance body if the
3765 -- instance is the RCI library unit itself.
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)).
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.
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???)
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;
3796 if Needs_Body then
3798 -- Here is a defence against a ludicrous number of instantiations
3799 -- caused by a circular set of instantiation attempts.
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;
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.
3812 Check_Forward_Instantiation (Gen_Decl);
3813 if Nkind (N) = N_Package_Instantiation then
3814 declare
3815 Enclosing_Master : Entity_Id;
3817 begin
3818 -- Loop to search enclosing masters
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;
3832 exit Scope_Loop;
3834 else
3835 Enclosing_Master := Scope (Enclosing_Master);
3836 end if;
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.
3846 exit Scope_Loop;
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;
3861 Set_Delay_Cleanups (Enclosing_Master);
3863 while Ekind (Enclosing_Master) = E_Block loop
3864 Enclosing_Master := Scope (Enclosing_Master);
3865 end loop;
3867 if Is_Subprogram (Enclosing_Master) then
3868 Delay_Descriptors (Enclosing_Master);
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;
3883 exit Scope_Loop;
3884 end if;
3885 end loop Scope_Loop;
3886 end;
3888 -- Make entry in table
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;
3901 Set_Categorization_From_Pragmas (Act_Decl);
3903 if Parent_Installed then
3904 Hide_Current_Scope;
3905 end if;
3907 Set_Instance_Spec (N, Act_Decl);
3909 -- If not a compilation unit, insert the package declaration before
3910 -- the original instantiation node.
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);
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).
3925 else
3926 if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
3928 -- The entity for the current unit is the newly created one,
3929 -- and all semantic information is attached to it.
3931 Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
3933 -- If this is the main unit, replace the main entity as well
3935 if Current_Sem_Unit = Main_Unit then
3936 Main_Unit_Entity := Act_Decl_Id;
3937 end if;
3938 end if;
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);
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.
3951 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
3952 Set_Kill_Elaboration_Checks (Act_Decl_Id);
3953 end if;
3955 Check_Elab_Instantiation (N);
3957 if ABE_Is_Certain (N) and then Needs_Body then
3958 Pending_Instantiations.Decrement_Last;
3959 end if;
3961 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
3963 Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
3964 First_Private_Entity (Act_Decl_Id));
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.
3971 if Nkind (Parent (N)) = N_Compilation_Unit
3972 and then not Needs_Body
3973 then
3974 Rewrite (N, Act_Decl);
3975 end if;
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;
3983 Check_Formal_Packages (Act_Decl_Id);
3985 Restore_Hidden_Primitives (Vis_Prims_List);
3986 Restore_Private_Views (Act_Decl_Id);
3988 Inherit_Context (Gen_Decl, N);
3990 if Parent_Installed then
3991 Remove_Parent;
3992 end if;
3994 Restore_Env;
3995 Env_Installed := False;
3996 end if;
3998 Validate_Categorization_Dependency (N, Act_Decl_Id);
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.
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;
4011 if Inline_Now then
4012 Inline_Instance_Body (N, Gen_Unit, Act_Decl);
4013 end if;
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.
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;
4026 Style_Check := Save_Style_Check;
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.
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;
4045 <<Leave>>
4046 if Has_Aspects (N) then
4047 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4048 end if;
4050 exception
4051 when Instantiation_Error =>
4052 if Parent_Installed then
4053 Remove_Parent;
4054 end if;
4056 if Env_Installed then
4057 Restore_Env;
4058 end if;
4060 Style_Check := Save_Style_Check;
4061 end Analyze_Package_Instantiation;
4063 --------------------------
4064 -- Inline_Instance_Body --
4065 --------------------------
4067 procedure Inline_Instance_Body
4068 (N : Node_Id;
4069 Gen_Unit : Entity_Id;
4070 Act_Decl : Node_Id)
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;
4081 Scope_Stack_Depth : constant Int :=
4082 Scope_Stack.Last - Scope_Stack.First + 1;
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 List : Elist_Id;
4088 Num_Inner : Int := 0;
4089 N_Instances : Int := 0;
4090 S : Entity_Id;
4092 begin
4093 -- Case of generic unit defined in another unit. We must remove the
4094 -- complete context of the current unit to install that of the generic.
4096 if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
4098 -- Add some comments for the following two loops ???
4100 S := Current_Scope;
4101 while Present (S) and then S /= Standard_Standard loop
4102 loop
4103 Num_Scopes := Num_Scopes + 1;
4105 Use_Clauses (Num_Scopes) :=
4106 (Scope_Stack.Table
4107 (Scope_Stack.Last - Num_Scopes + 1).
4108 First_Use_Clause);
4109 End_Use_Clauses (Use_Clauses (Num_Scopes));
4111 exit when Scope_Stack.Last - Num_Scopes + 1 = Scope_Stack.First
4112 or else Scope_Stack.Table
4113 (Scope_Stack.Last - Num_Scopes).Entity
4114 = Scope (S);
4115 end loop;
4117 exit when Is_Generic_Instance (S)
4118 and then (In_Package_Body (S)
4119 or else Ekind (S) = E_Procedure
4120 or else Ekind (S) = E_Function);
4121 S := Scope (S);
4122 end loop;
4124 Vis := Is_Immediately_Visible (Gen_Comp);
4126 -- Find and save all enclosing instances
4128 S := Current_Scope;
4130 while Present (S)
4131 and then S /= Standard_Standard
4132 loop
4133 if Is_Generic_Instance (S) then
4134 N_Instances := N_Instances + 1;
4135 Instances (N_Instances) := S;
4137 exit when In_Package_Body (S);
4138 end if;
4140 S := Scope (S);
4141 end loop;
4143 -- Remove context of current compilation unit, unless we are within a
4144 -- nested package instantiation, in which case the context has been
4145 -- removed previously.
4147 -- If current scope is the body of a child unit, remove context of
4148 -- spec as well. If an enclosing scope is an instance body, the
4149 -- context has already been removed, but the entities in the body
4150 -- must be made invisible as well.
4152 S := Current_Scope;
4154 while Present (S)
4155 and then S /= Standard_Standard
4156 loop
4157 if Is_Generic_Instance (S)
4158 and then (In_Package_Body (S)
4159 or else Ekind (S) = E_Procedure
4160 or else Ekind (S) = E_Function)
4161 then
4162 -- We still have to remove the entities of the enclosing
4163 -- instance from direct visibility.
4165 declare
4166 E : Entity_Id;
4167 begin
4168 E := First_Entity (S);
4169 while Present (E) loop
4170 Set_Is_Immediately_Visible (E, False);
4171 Next_Entity (E);
4172 end loop;
4173 end;
4175 exit;
4176 end if;
4178 if S = Curr_Unit
4179 or else (Ekind (Curr_Unit) = E_Package_Body
4180 and then S = Spec_Entity (Curr_Unit))
4181 or else (Ekind (Curr_Unit) = E_Subprogram_Body
4182 and then S =
4183 Corresponding_Spec
4184 (Unit_Declaration_Node (Curr_Unit)))
4185 then
4186 Removed := True;
4188 -- Remove entities in current scopes from visibility, so that
4189 -- instance body is compiled in a clean environment.
4191 List := Save_Scope_Stack (Handle_Use => False);
4193 if Is_Child_Unit (S) then
4195 -- Remove child unit from stack, as well as inner scopes.
4196 -- Removing the context of a child unit removes parent units
4197 -- as well.
4199 while Current_Scope /= S loop
4200 Num_Inner := Num_Inner + 1;
4201 Inner_Scopes (Num_Inner) := Current_Scope;
4202 Pop_Scope;
4203 end loop;
4205 Pop_Scope;
4206 Remove_Context (Curr_Comp);
4207 Curr_Scope := S;
4209 else
4210 Remove_Context (Curr_Comp);
4211 end if;
4213 if Ekind (Curr_Unit) = E_Package_Body then
4214 Remove_Context (Library_Unit (Curr_Comp));
4215 end if;
4216 end if;
4218 S := Scope (S);
4219 end loop;
4220 pragma Assert (Num_Inner < Num_Scopes);
4222 Push_Scope (Standard_Standard);
4223 Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
4224 Instantiate_Package_Body
4225 (Body_Info =>
4226 ((Inst_Node => N,
4227 Act_Decl => Act_Decl,
4228 Expander_Status => Expander_Active,
4229 Current_Sem_Unit => Current_Sem_Unit,
4230 Scope_Suppress => Scope_Suppress,
4231 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4232 Version => Ada_Version)),
4233 Inlined_Body => True);
4235 Pop_Scope;
4237 -- Restore context
4239 Set_Is_Immediately_Visible (Gen_Comp, Vis);
4241 -- Reset Generic_Instance flag so that use clauses can be installed
4242 -- in the proper order. (See Use_One_Package for effect of enclosing
4243 -- instances on processing of use clauses).
4245 for J in 1 .. N_Instances loop
4246 Set_Is_Generic_Instance (Instances (J), False);
4247 end loop;
4249 if Removed then
4250 Install_Context (Curr_Comp);
4252 if Present (Curr_Scope)
4253 and then Is_Child_Unit (Curr_Scope)
4254 then
4255 Push_Scope (Curr_Scope);
4256 Set_Is_Immediately_Visible (Curr_Scope);
4258 -- Finally, restore inner scopes as well
4260 for J in reverse 1 .. Num_Inner loop
4261 Push_Scope (Inner_Scopes (J));
4262 end loop;
4263 end if;
4265 Restore_Scope_Stack (List, Handle_Use => False);
4267 if Present (Curr_Scope)
4268 and then
4269 (In_Private_Part (Curr_Scope)
4270 or else In_Package_Body (Curr_Scope))
4271 then
4272 -- Install private declaration of ancestor units, which are
4273 -- currently available. Restore_Scope_Stack and Install_Context
4274 -- only install the visible part of parents.
4276 declare
4277 Par : Entity_Id;
4278 begin
4279 Par := Scope (Curr_Scope);
4280 while (Present (Par))
4281 and then Par /= Standard_Standard
4282 loop
4283 Install_Private_Declarations (Par);
4284 Par := Scope (Par);
4285 end loop;
4286 end;
4287 end if;
4288 end if;
4290 -- Restore use clauses. For a child unit, use clauses in the parents
4291 -- are restored when installing the context, so only those in inner
4292 -- scopes (and those local to the child unit itself) need to be
4293 -- installed explicitly.
4295 if Is_Child_Unit (Curr_Unit)
4296 and then Removed
4297 then
4298 for J in reverse 1 .. Num_Inner + 1 loop
4299 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4300 Use_Clauses (J);
4301 Install_Use_Clauses (Use_Clauses (J));
4302 end loop;
4304 else
4305 for J in reverse 1 .. Num_Scopes loop
4306 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
4307 Use_Clauses (J);
4308 Install_Use_Clauses (Use_Clauses (J));
4309 end loop;
4310 end if;
4312 -- Restore status of instances. If one of them is a body, make
4313 -- its local entities visible again.
4315 declare
4316 E : Entity_Id;
4317 Inst : Entity_Id;
4319 begin
4320 for J in 1 .. N_Instances loop
4321 Inst := Instances (J);
4322 Set_Is_Generic_Instance (Inst, True);
4324 if In_Package_Body (Inst)
4325 or else Ekind (S) = E_Procedure
4326 or else Ekind (S) = E_Function
4327 then
4328 E := First_Entity (Instances (J));
4329 while Present (E) loop
4330 Set_Is_Immediately_Visible (E);
4331 Next_Entity (E);
4332 end loop;
4333 end if;
4334 end loop;
4335 end;
4337 -- If generic unit is in current unit, current context is correct
4339 else
4340 Instantiate_Package_Body
4341 (Body_Info =>
4342 ((Inst_Node => N,
4343 Act_Decl => Act_Decl,
4344 Expander_Status => Expander_Active,
4345 Current_Sem_Unit => Current_Sem_Unit,
4346 Scope_Suppress => Scope_Suppress,
4347 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4348 Version => Ada_Version)),
4349 Inlined_Body => True);
4350 end if;
4351 end Inline_Instance_Body;
4353 -------------------------------------
4354 -- Analyze_Procedure_Instantiation --
4355 -------------------------------------
4357 procedure Analyze_Procedure_Instantiation (N : Node_Id) is
4358 begin
4359 Analyze_Subprogram_Instantiation (N, E_Procedure);
4360 end Analyze_Procedure_Instantiation;
4362 -----------------------------------
4363 -- Need_Subprogram_Instance_Body --
4364 -----------------------------------
4366 function Need_Subprogram_Instance_Body
4367 (N : Node_Id;
4368 Subp : Entity_Id) return Boolean
4370 begin
4371 -- Must be inlined (or inlined renaming)
4373 if (Is_In_Main_Unit (N)
4374 or else Is_Inlined (Subp)
4375 or else Is_Inlined (Alias (Subp)))
4377 -- Must be generating code or analyzing code in ASIS mode
4379 and then (Operating_Mode = Generate_Code
4380 or else (Operating_Mode = Check_Semantics
4381 and then ASIS_Mode))
4383 -- The body is needed when generating code (full expansion), in ASIS
4384 -- mode for other tools, and in SPARK mode (special expansion) for
4385 -- formal verification of the body itself.
4387 and then (Expander_Active or ASIS_Mode)
4389 -- No point in inlining if ABE is inevitable
4391 and then not ABE_Is_Certain (N)
4393 -- Or if subprogram is eliminated
4395 and then not Is_Eliminated (Subp)
4396 then
4397 Pending_Instantiations.Append
4398 ((Inst_Node => N,
4399 Act_Decl => Unit_Declaration_Node (Subp),
4400 Expander_Status => Expander_Active,
4401 Current_Sem_Unit => Current_Sem_Unit,
4402 Scope_Suppress => Scope_Suppress,
4403 Local_Suppress_Stack_Top => Local_Suppress_Stack_Top,
4404 Version => Ada_Version));
4405 return True;
4407 -- Here if not inlined, or we ignore the inlining
4409 else
4410 return False;
4411 end if;
4412 end Need_Subprogram_Instance_Body;
4414 --------------------------------------
4415 -- Analyze_Subprogram_Instantiation --
4416 --------------------------------------
4418 procedure Analyze_Subprogram_Instantiation
4419 (N : Node_Id;
4420 K : Entity_Kind)
4422 Loc : constant Source_Ptr := Sloc (N);
4423 Gen_Id : constant Node_Id := Name (N);
4425 Anon_Id : constant Entity_Id :=
4426 Make_Defining_Identifier (Sloc (Defining_Entity (N)),
4427 Chars => New_External_Name
4428 (Chars (Defining_Entity (N)), 'R'));
4430 Act_Decl_Id : Entity_Id;
4431 Act_Decl : Node_Id;
4432 Act_Spec : Node_Id;
4433 Act_Tree : Node_Id;
4435 Env_Installed : Boolean := False;
4436 Gen_Unit : Entity_Id;
4437 Gen_Decl : Node_Id;
4438 Pack_Id : Entity_Id;
4439 Parent_Installed : Boolean := False;
4440 Renaming_List : List_Id;
4442 procedure Analyze_Instance_And_Renamings;
4443 -- The instance must be analyzed in a context that includes the mappings
4444 -- of generic parameters into actuals. We create a package declaration
4445 -- for this purpose, and a subprogram with an internal name within the
4446 -- package. The subprogram instance is simply an alias for the internal
4447 -- subprogram, declared in the current scope.
4449 ------------------------------------
4450 -- Analyze_Instance_And_Renamings --
4451 ------------------------------------
4453 procedure Analyze_Instance_And_Renamings is
4454 Def_Ent : constant Entity_Id := Defining_Entity (N);
4455 Pack_Decl : Node_Id;
4457 begin
4458 if Nkind (Parent (N)) = N_Compilation_Unit then
4460 -- For the case of a compilation unit, the container package has
4461 -- the same name as the instantiation, to insure that the binder
4462 -- calls the elaboration procedure with the right name. Copy the
4463 -- entity of the instance, which may have compilation level flags
4464 -- (e.g. Is_Child_Unit) set.
4466 Pack_Id := New_Copy (Def_Ent);
4468 else
4469 -- Otherwise we use the name of the instantiation concatenated
4470 -- with its source position to ensure uniqueness if there are
4471 -- several instantiations with the same name.
4473 Pack_Id :=
4474 Make_Defining_Identifier (Loc,
4475 Chars => New_External_Name
4476 (Related_Id => Chars (Def_Ent),
4477 Suffix => "GP",
4478 Suffix_Index => Source_Offset (Sloc (Def_Ent))));
4479 end if;
4481 Pack_Decl := Make_Package_Declaration (Loc,
4482 Specification => Make_Package_Specification (Loc,
4483 Defining_Unit_Name => Pack_Id,
4484 Visible_Declarations => Renaming_List,
4485 End_Label => Empty));
4487 Set_Instance_Spec (N, Pack_Decl);
4488 Set_Is_Generic_Instance (Pack_Id);
4489 Set_Debug_Info_Needed (Pack_Id);
4491 -- Case of not a compilation unit
4493 if Nkind (Parent (N)) /= N_Compilation_Unit then
4494 Mark_Rewrite_Insertion (Pack_Decl);
4495 Insert_Before (N, Pack_Decl);
4496 Set_Has_Completion (Pack_Id);
4498 -- Case of an instantiation that is a compilation unit
4500 -- Place declaration on current node so context is complete for
4501 -- analysis (including nested instantiations), and for use in a
4502 -- context_clause (see Analyze_With_Clause).
4504 else
4505 Set_Unit (Parent (N), Pack_Decl);
4506 Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
4507 end if;
4509 Analyze (Pack_Decl);
4510 Check_Formal_Packages (Pack_Id);
4511 Set_Is_Generic_Instance (Pack_Id, False);
4513 -- Why do we clear Is_Generic_Instance??? We set it 20 lines
4514 -- above???
4516 -- Body of the enclosing package is supplied when instantiating the
4517 -- subprogram body, after semantic analysis is completed.
4519 if Nkind (Parent (N)) = N_Compilation_Unit then
4521 -- Remove package itself from visibility, so it does not
4522 -- conflict with subprogram.
4524 Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
4526 -- Set name and scope of internal subprogram so that the proper
4527 -- external name will be generated. The proper scope is the scope
4528 -- of the wrapper package. We need to generate debugging info for
4529 -- the internal subprogram, so set flag accordingly.
4531 Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
4532 Set_Scope (Anon_Id, Scope (Pack_Id));
4534 -- Mark wrapper package as referenced, to avoid spurious warnings
4535 -- if the instantiation appears in various with_ clauses of
4536 -- subunits of the main unit.
4538 Set_Referenced (Pack_Id);
4539 end if;
4541 Set_Is_Generic_Instance (Anon_Id);
4542 Set_Debug_Info_Needed (Anon_Id);
4543 Act_Decl_Id := New_Copy (Anon_Id);
4545 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4546 Set_Chars (Act_Decl_Id, Chars (Defining_Entity (N)));
4547 Set_Sloc (Act_Decl_Id, Sloc (Defining_Entity (N)));
4548 Set_Comes_From_Source (Act_Decl_Id, True);
4550 -- The signature may involve types that are not frozen yet, but the
4551 -- subprogram will be frozen at the point the wrapper package is
4552 -- frozen, so it does not need its own freeze node. In fact, if one
4553 -- is created, it might conflict with the freezing actions from the
4554 -- wrapper package.
4556 Set_Has_Delayed_Freeze (Anon_Id, False);
4558 -- If the instance is a child unit, mark the Id accordingly. Mark
4559 -- the anonymous entity as well, which is the real subprogram and
4560 -- which is used when the instance appears in a context clause.
4561 -- Similarly, propagate the Is_Eliminated flag to handle properly
4562 -- nested eliminated subprograms.
4564 Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
4565 Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
4566 New_Overloaded_Entity (Act_Decl_Id);
4567 Check_Eliminated (Act_Decl_Id);
4568 Set_Is_Eliminated (Anon_Id, Is_Eliminated (Act_Decl_Id));
4570 -- In compilation unit case, kill elaboration checks on the
4571 -- instantiation, since they are never needed -- the body is
4572 -- instantiated at the same point as the spec.
4574 if Nkind (Parent (N)) = N_Compilation_Unit then
4575 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
4576 Set_Kill_Elaboration_Checks (Act_Decl_Id);
4577 Set_Is_Compilation_Unit (Anon_Id);
4579 Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
4580 end if;
4582 -- The instance is not a freezing point for the new subprogram
4584 Set_Is_Frozen (Act_Decl_Id, False);
4586 if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
4587 Valid_Operator_Definition (Act_Decl_Id);
4588 end if;
4590 Set_Alias (Act_Decl_Id, Anon_Id);
4591 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
4592 Set_Has_Completion (Act_Decl_Id);
4593 Set_Related_Instance (Pack_Id, Act_Decl_Id);
4595 if Nkind (Parent (N)) = N_Compilation_Unit then
4596 Set_Body_Required (Parent (N), False);
4597 end if;
4598 end Analyze_Instance_And_Renamings;
4600 -- Local variables
4602 Vis_Prims_List : Elist_Id := No_Elist;
4603 -- List of primitives made temporarily visible in the instantiation
4604 -- to match the visibility of the formal type
4606 -- Start of processing for Analyze_Subprogram_Instantiation
4608 begin
4609 Check_SPARK_Restriction ("generic is not allowed", N);
4611 -- Very first thing: apply the special kludge for Text_IO processing
4612 -- in case we are instantiating one of the children of [Wide_]Text_IO.
4613 -- Of course such an instantiation is bogus (these are packages, not
4614 -- subprograms), but we get a better error message if we do this.
4616 Text_IO_Kludge (Gen_Id);
4618 -- Make node global for error reporting
4620 Instantiation_Node := N;
4622 -- For package instantiations we turn off style checks, because they
4623 -- will have been emitted in the generic. For subprogram instantiations
4624 -- we want to apply at least the check on overriding indicators so we
4625 -- do not modify the style check status.
4627 -- The renaming declarations for the actuals do not come from source and
4628 -- will not generate spurious warnings.
4630 Preanalyze_Actuals (N);
4632 Init_Env;
4633 Env_Installed := True;
4634 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
4635 Gen_Unit := Entity (Gen_Id);
4637 Generate_Reference (Gen_Unit, Gen_Id);
4639 if Nkind (Gen_Id) = N_Identifier
4640 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
4641 then
4642 Error_Msg_NE
4643 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
4644 end if;
4646 if Etype (Gen_Unit) = Any_Type then
4647 Restore_Env;
4648 return;
4649 end if;
4651 -- Verify that it is a generic subprogram of the right kind, and that
4652 -- it does not lead to a circular instantiation.
4654 if not Ekind_In (Gen_Unit, E_Generic_Procedure, E_Generic_Function) then
4655 Error_Msg_N ("expect generic subprogram in instantiation", Gen_Id);
4657 elsif In_Open_Scopes (Gen_Unit) then
4658 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
4660 elsif K = E_Procedure
4661 and then Ekind (Gen_Unit) /= E_Generic_Procedure
4662 then
4663 if Ekind (Gen_Unit) = E_Generic_Function then
4664 Error_Msg_N
4665 ("cannot instantiate generic function as procedure", Gen_Id);
4666 else
4667 Error_Msg_N
4668 ("expect name of generic procedure in instantiation", Gen_Id);
4669 end if;
4671 elsif K = E_Function
4672 and then Ekind (Gen_Unit) /= E_Generic_Function
4673 then
4674 if Ekind (Gen_Unit) = E_Generic_Procedure then
4675 Error_Msg_N
4676 ("cannot instantiate generic procedure as function", Gen_Id);
4677 else
4678 Error_Msg_N
4679 ("expect name of generic function in instantiation", Gen_Id);
4680 end if;
4682 else
4683 Set_Entity (Gen_Id, Gen_Unit);
4684 Set_Is_Instantiated (Gen_Unit);
4686 if In_Extended_Main_Source_Unit (N) then
4687 Generate_Reference (Gen_Unit, N);
4688 end if;
4690 -- If renaming, get original unit
4692 if Present (Renamed_Object (Gen_Unit))
4693 and then (Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Procedure
4694 or else
4695 Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Function)
4696 then
4697 Gen_Unit := Renamed_Object (Gen_Unit);
4698 Set_Is_Instantiated (Gen_Unit);
4699 Generate_Reference (Gen_Unit, N);
4700 end if;
4702 if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
4703 Error_Msg_Node_2 := Current_Scope;
4704 Error_Msg_NE
4705 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
4706 Circularity_Detected := True;
4707 Restore_Hidden_Primitives (Vis_Prims_List);
4708 goto Leave;
4709 end if;
4711 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
4713 -- Initialize renamings map, for error checking
4715 Generic_Renamings.Set_Last (0);
4716 Generic_Renamings_HTable.Reset;
4718 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
4720 -- Copy original generic tree, to produce text for instantiation
4722 Act_Tree :=
4723 Copy_Generic_Node
4724 (Original_Node (Gen_Decl), Empty, Instantiating => True);
4726 -- Inherit overriding indicator from instance node
4728 Act_Spec := Specification (Act_Tree);
4729 Set_Must_Override (Act_Spec, Must_Override (N));
4730 Set_Must_Not_Override (Act_Spec, Must_Not_Override (N));
4732 Renaming_List :=
4733 Analyze_Associations
4734 (I_Node => N,
4735 Formals => Generic_Formal_Declarations (Act_Tree),
4736 F_Copy => Generic_Formal_Declarations (Gen_Decl));
4738 Vis_Prims_List := Check_Hidden_Primitives (Renaming_List);
4740 -- The subprogram itself cannot contain a nested instance, so the
4741 -- current parent is left empty.
4743 Set_Instance_Env (Gen_Unit, Empty);
4745 -- Build the subprogram declaration, which does not appear in the
4746 -- generic template, and give it a sloc consistent with that of the
4747 -- template.
4749 Set_Defining_Unit_Name (Act_Spec, Anon_Id);
4750 Set_Generic_Parent (Act_Spec, Gen_Unit);
4751 Act_Decl :=
4752 Make_Subprogram_Declaration (Sloc (Act_Spec),
4753 Specification => Act_Spec);
4755 -- The aspects have been copied previously, but they have to be
4756 -- linked explicitly to the new subprogram declaration. Explicit
4757 -- pre/postconditions on the instance are analyzed below, in a
4758 -- separate step.
4760 Move_Aspects (Act_Tree, Act_Decl);
4761 Set_Categorization_From_Pragmas (Act_Decl);
4763 if Parent_Installed then
4764 Hide_Current_Scope;
4765 end if;
4767 Append (Act_Decl, Renaming_List);
4768 Analyze_Instance_And_Renamings;
4770 -- If the generic is marked Import (Intrinsic), then so is the
4771 -- instance. This indicates that there is no body to instantiate. If
4772 -- generic is marked inline, so it the instance, and the anonymous
4773 -- subprogram it renames. If inlined, or else if inlining is enabled
4774 -- for the compilation, we generate the instance body even if it is
4775 -- not within the main unit.
4777 if Is_Intrinsic_Subprogram (Gen_Unit) then
4778 Set_Is_Intrinsic_Subprogram (Anon_Id);
4779 Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
4781 if Chars (Gen_Unit) = Name_Unchecked_Conversion then
4782 Validate_Unchecked_Conversion (N, Act_Decl_Id);
4783 end if;
4784 end if;
4786 -- Inherit convention from generic unit. Intrinsic convention, as for
4787 -- an instance of unchecked conversion, is not inherited because an
4788 -- explicit Ada instance has been created.
4790 if Has_Convention_Pragma (Gen_Unit)
4791 and then Convention (Gen_Unit) /= Convention_Intrinsic
4792 then
4793 Set_Convention (Act_Decl_Id, Convention (Gen_Unit));
4794 Set_Is_Exported (Act_Decl_Id, Is_Exported (Gen_Unit));
4795 end if;
4797 Generate_Definition (Act_Decl_Id);
4798 -- Set_Contract (Anon_Id, Make_Contract (Sloc (Anon_Id)));
4799 -- ??? needed?
4800 Set_Contract (Act_Decl_Id, Make_Contract (Sloc (Act_Decl_Id)));
4802 -- Inherit all inlining-related flags which apply to the generic in
4803 -- the subprogram and its declaration.
4805 Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
4806 Set_Is_Inlined (Anon_Id, Is_Inlined (Gen_Unit));
4808 Set_Has_Pragma_Inline (Act_Decl_Id, Has_Pragma_Inline (Gen_Unit));
4809 Set_Has_Pragma_Inline (Anon_Id, Has_Pragma_Inline (Gen_Unit));
4811 Set_Has_Pragma_Inline_Always
4812 (Act_Decl_Id, Has_Pragma_Inline_Always (Gen_Unit));
4813 Set_Has_Pragma_Inline_Always
4814 (Anon_Id, Has_Pragma_Inline_Always (Gen_Unit));
4816 if not Is_Intrinsic_Subprogram (Gen_Unit) then
4817 Check_Elab_Instantiation (N);
4818 end if;
4820 if Is_Dispatching_Operation (Act_Decl_Id)
4821 and then Ada_Version >= Ada_2005
4822 then
4823 declare
4824 Formal : Entity_Id;
4826 begin
4827 Formal := First_Formal (Act_Decl_Id);
4828 while Present (Formal) loop
4829 if Ekind (Etype (Formal)) = E_Anonymous_Access_Type
4830 and then Is_Controlling_Formal (Formal)
4831 and then not Can_Never_Be_Null (Formal)
4832 then
4833 Error_Msg_NE ("access parameter& is controlling,",
4834 N, Formal);
4835 Error_Msg_NE
4836 ("\corresponding parameter of & must be"
4837 & " explicitly null-excluding", N, Gen_Id);
4838 end if;
4840 Next_Formal (Formal);
4841 end loop;
4842 end;
4843 end if;
4845 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
4847 Validate_Categorization_Dependency (N, Act_Decl_Id);
4849 if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
4850 Inherit_Context (Gen_Decl, N);
4852 Restore_Private_Views (Pack_Id, False);
4854 -- If the context requires a full instantiation, mark node for
4855 -- subsequent construction of the body.
4857 if Need_Subprogram_Instance_Body (N, Act_Decl_Id) then
4859 Check_Forward_Instantiation (Gen_Decl);
4861 -- The wrapper package is always delayed, because it does not
4862 -- constitute a freeze point, but to insure that the freeze
4863 -- node is placed properly, it is created directly when
4864 -- instantiating the body (otherwise the freeze node might
4865 -- appear to early for nested instantiations).
4867 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4869 -- For ASIS purposes, indicate that the wrapper package has
4870 -- replaced the instantiation node.
4872 Rewrite (N, Unit (Parent (N)));
4873 Set_Unit (Parent (N), N);
4874 end if;
4876 elsif Nkind (Parent (N)) = N_Compilation_Unit then
4878 -- Replace instance node for library-level instantiations of
4879 -- intrinsic subprograms, for ASIS use.
4881 Rewrite (N, Unit (Parent (N)));
4882 Set_Unit (Parent (N), N);
4883 end if;
4885 if Parent_Installed then
4886 Remove_Parent;
4887 end if;
4889 Restore_Hidden_Primitives (Vis_Prims_List);
4890 Restore_Env;
4891 Env_Installed := False;
4892 Generic_Renamings.Set_Last (0);
4893 Generic_Renamings_HTable.Reset;
4894 end if;
4896 <<Leave>>
4897 if Has_Aspects (N) then
4898 Analyze_Aspect_Specifications (N, Act_Decl_Id);
4899 end if;
4901 exception
4902 when Instantiation_Error =>
4903 if Parent_Installed then
4904 Remove_Parent;
4905 end if;
4907 if Env_Installed then
4908 Restore_Env;
4909 end if;
4910 end Analyze_Subprogram_Instantiation;
4912 -------------------------
4913 -- Get_Associated_Node --
4914 -------------------------
4916 function Get_Associated_Node (N : Node_Id) return Node_Id is
4917 Assoc : Node_Id;
4919 begin
4920 Assoc := Associated_Node (N);
4922 if Nkind (Assoc) /= Nkind (N) then
4923 return Assoc;
4925 elsif Nkind_In (Assoc, N_Aggregate, N_Extension_Aggregate) then
4926 return Assoc;
4928 else
4929 -- If the node is part of an inner generic, it may itself have been
4930 -- remapped into a further generic copy. Associated_Node is otherwise
4931 -- used for the entity of the node, and will be of a different node
4932 -- kind, or else N has been rewritten as a literal or function call.
4934 while Present (Associated_Node (Assoc))
4935 and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
4936 loop
4937 Assoc := Associated_Node (Assoc);
4938 end loop;
4940 -- Follow and additional link in case the final node was rewritten.
4941 -- This can only happen with nested generic units.
4943 if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
4944 and then Present (Associated_Node (Assoc))
4945 and then (Nkind_In (Associated_Node (Assoc), N_Function_Call,
4946 N_Explicit_Dereference,
4947 N_Integer_Literal,
4948 N_Real_Literal,
4949 N_String_Literal))
4950 then
4951 Assoc := Associated_Node (Assoc);
4952 end if;
4954 -- An additional special case: an unconstrained type in an object
4955 -- declaration may have been rewritten as a local subtype constrained
4956 -- by the expression in the declaration. We need to recover the
4957 -- original entity which may be global.
4959 if Present (Original_Node (Assoc))
4960 and then Nkind (Parent (N)) = N_Object_Declaration
4961 then
4962 Assoc := Original_Node (Assoc);
4963 end if;
4965 return Assoc;
4966 end if;
4967 end Get_Associated_Node;
4969 -------------------------------------------
4970 -- Build_Instance_Compilation_Unit_Nodes --
4971 -------------------------------------------
4973 procedure Build_Instance_Compilation_Unit_Nodes
4974 (N : Node_Id;
4975 Act_Body : Node_Id;
4976 Act_Decl : Node_Id)
4978 Decl_Cunit : Node_Id;
4979 Body_Cunit : Node_Id;
4980 Citem : Node_Id;
4981 New_Main : constant Entity_Id := Defining_Entity (Act_Decl);
4982 Old_Main : constant Entity_Id := Cunit_Entity (Main_Unit);
4984 begin
4985 -- A new compilation unit node is built for the instance declaration
4987 Decl_Cunit :=
4988 Make_Compilation_Unit (Sloc (N),
4989 Context_Items => Empty_List,
4990 Unit => Act_Decl,
4991 Aux_Decls_Node => Make_Compilation_Unit_Aux (Sloc (N)));
4993 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
4995 -- The new compilation unit is linked to its body, but both share the
4996 -- same file, so we do not set Body_Required on the new unit so as not
4997 -- to create a spurious dependency on a non-existent body in the ali.
4998 -- This simplifies CodePeer unit traversal.
5000 -- We use the original instantiation compilation unit as the resulting
5001 -- compilation unit of the instance, since this is the main unit.
5003 Rewrite (N, Act_Body);
5004 Body_Cunit := Parent (N);
5006 -- The two compilation unit nodes are linked by the Library_Unit field
5008 Set_Library_Unit (Decl_Cunit, Body_Cunit);
5009 Set_Library_Unit (Body_Cunit, Decl_Cunit);
5011 -- Preserve the private nature of the package if needed
5013 Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
5015 -- If the instance is not the main unit, its context, categorization
5016 -- and elaboration entity are not relevant to the compilation.
5018 if Body_Cunit /= Cunit (Main_Unit) then
5019 Make_Instance_Unit (Body_Cunit, In_Main => False);
5020 return;
5021 end if;
5023 -- The context clause items on the instantiation, which are now attached
5024 -- to the body compilation unit (since the body overwrote the original
5025 -- instantiation node), semantically belong on the spec, so copy them
5026 -- there. It's harmless to leave them on the body as well. In fact one
5027 -- could argue that they belong in both places.
5029 Citem := First (Context_Items (Body_Cunit));
5030 while Present (Citem) loop
5031 Append (New_Copy (Citem), Context_Items (Decl_Cunit));
5032 Next (Citem);
5033 end loop;
5035 -- Propagate categorization flags on packages, so that they appear in
5036 -- the ali file for the spec of the unit.
5038 if Ekind (New_Main) = E_Package then
5039 Set_Is_Pure (Old_Main, Is_Pure (New_Main));
5040 Set_Is_Preelaborated (Old_Main, Is_Preelaborated (New_Main));
5041 Set_Is_Remote_Types (Old_Main, Is_Remote_Types (New_Main));
5042 Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
5043 Set_Is_Remote_Call_Interface
5044 (Old_Main, Is_Remote_Call_Interface (New_Main));
5045 end if;
5047 -- Make entry in Units table, so that binder can generate call to
5048 -- elaboration procedure for body, if any.
5050 Make_Instance_Unit (Body_Cunit, In_Main => True);
5051 Main_Unit_Entity := New_Main;
5052 Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
5054 -- Build elaboration entity, since the instance may certainly generate
5055 -- elaboration code requiring a flag for protection.
5057 Build_Elaboration_Entity (Decl_Cunit, New_Main);
5058 end Build_Instance_Compilation_Unit_Nodes;
5060 -----------------------------
5061 -- Check_Access_Definition --
5062 -----------------------------
5064 procedure Check_Access_Definition (N : Node_Id) is
5065 begin
5066 pragma Assert
5067 (Ada_Version >= Ada_2005 and then Present (Access_Definition (N)));
5068 null;
5069 end Check_Access_Definition;
5071 -----------------------------------
5072 -- Check_Formal_Package_Instance --
5073 -----------------------------------
5075 -- If the formal has specific parameters, they must match those of the
5076 -- actual. Both of them are instances, and the renaming declarations for
5077 -- their formal parameters appear in the same order in both. The analyzed
5078 -- formal has been analyzed in the context of the current instance.
5080 procedure Check_Formal_Package_Instance
5081 (Formal_Pack : Entity_Id;
5082 Actual_Pack : Entity_Id)
5084 E1 : Entity_Id := First_Entity (Actual_Pack);
5085 E2 : Entity_Id := First_Entity (Formal_Pack);
5087 Expr1 : Node_Id;
5088 Expr2 : Node_Id;
5090 procedure Check_Mismatch (B : Boolean);
5091 -- Common error routine for mismatch between the parameters of the
5092 -- actual instance and those of the formal package.
5094 function Same_Instantiated_Constant (E1, E2 : Entity_Id) return Boolean;
5095 -- The formal may come from a nested formal package, and the actual may
5096 -- have been constant-folded. To determine whether the two denote the
5097 -- same entity we may have to traverse several definitions to recover
5098 -- the ultimate entity that they refer to.
5100 function Same_Instantiated_Variable (E1, E2 : Entity_Id) return Boolean;
5101 -- Similarly, if the formal comes from a nested formal package, the
5102 -- actual may designate the formal through multiple renamings, which
5103 -- have to be followed to determine the original variable in question.
5105 --------------------
5106 -- Check_Mismatch --
5107 --------------------
5109 procedure Check_Mismatch (B : Boolean) is
5110 Kind : constant Node_Kind := Nkind (Parent (E2));
5112 begin
5113 if Kind = N_Formal_Type_Declaration then
5114 return;
5116 elsif Nkind_In (Kind, N_Formal_Object_Declaration,
5117 N_Formal_Package_Declaration)
5118 or else Kind in N_Formal_Subprogram_Declaration
5119 then
5120 null;
5122 elsif B then
5123 Error_Msg_NE
5124 ("actual for & in actual instance does not match formal",
5125 Parent (Actual_Pack), E1);
5126 end if;
5127 end Check_Mismatch;
5129 --------------------------------
5130 -- Same_Instantiated_Constant --
5131 --------------------------------
5133 function Same_Instantiated_Constant
5134 (E1, E2 : Entity_Id) return Boolean
5136 Ent : Entity_Id;
5138 begin
5139 Ent := E2;
5140 while Present (Ent) loop
5141 if E1 = Ent then
5142 return True;
5144 elsif Ekind (Ent) /= E_Constant then
5145 return False;
5147 elsif Is_Entity_Name (Constant_Value (Ent)) then
5148 if Entity (Constant_Value (Ent)) = E1 then
5149 return True;
5150 else
5151 Ent := Entity (Constant_Value (Ent));
5152 end if;
5154 -- The actual may be a constant that has been folded. Recover
5155 -- original name.
5157 elsif Is_Entity_Name (Original_Node (Constant_Value (Ent))) then
5158 Ent := Entity (Original_Node (Constant_Value (Ent)));
5159 else
5160 return False;
5161 end if;
5162 end loop;
5164 return False;
5165 end Same_Instantiated_Constant;
5167 --------------------------------
5168 -- Same_Instantiated_Variable --
5169 --------------------------------
5171 function Same_Instantiated_Variable
5172 (E1, E2 : Entity_Id) return Boolean
5174 function Original_Entity (E : Entity_Id) return Entity_Id;
5175 -- Follow chain of renamings to the ultimate ancestor
5177 ---------------------
5178 -- Original_Entity --
5179 ---------------------
5181 function Original_Entity (E : Entity_Id) return Entity_Id is
5182 Orig : Entity_Id;
5184 begin
5185 Orig := E;
5186 while Nkind (Parent (Orig)) = N_Object_Renaming_Declaration
5187 and then Present (Renamed_Object (Orig))
5188 and then Is_Entity_Name (Renamed_Object (Orig))
5189 loop
5190 Orig := Entity (Renamed_Object (Orig));
5191 end loop;
5193 return Orig;
5194 end Original_Entity;
5196 -- Start of processing for Same_Instantiated_Variable
5198 begin
5199 return Ekind (E1) = Ekind (E2)
5200 and then Original_Entity (E1) = Original_Entity (E2);
5201 end Same_Instantiated_Variable;
5203 -- Start of processing for Check_Formal_Package_Instance
5205 begin
5206 while Present (E1)
5207 and then Present (E2)
5208 loop
5209 exit when Ekind (E1) = E_Package
5210 and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
5212 -- If the formal is the renaming of the formal package, this
5213 -- is the end of its formal part, which may occur before the
5214 -- end of the formal part in the actual in the presence of
5215 -- defaulted parameters in the formal package.
5217 exit when Nkind (Parent (E2)) = N_Package_Renaming_Declaration
5218 and then Renamed_Entity (E2) = Scope (E2);
5220 -- The analysis of the actual may generate additional internal
5221 -- entities. If the formal is defaulted, there is no corresponding
5222 -- analysis and the internal entities must be skipped, until we
5223 -- find corresponding entities again.
5225 if Comes_From_Source (E2)
5226 and then not Comes_From_Source (E1)
5227 and then Chars (E1) /= Chars (E2)
5228 then
5229 while Present (E1)
5230 and then Chars (E1) /= Chars (E2)
5231 loop
5232 Next_Entity (E1);
5233 end loop;
5234 end if;
5236 if No (E1) then
5237 return;
5239 -- If the formal entity comes from a formal declaration, it was
5240 -- defaulted in the formal package, and no check is needed on it.
5242 elsif Nkind (Parent (E2)) = N_Formal_Object_Declaration then
5243 goto Next_E;
5245 -- Ditto for defaulted formal subprograms.
5247 elsif Is_Overloadable (E1)
5248 and then Nkind (Unit_Declaration_Node (E2)) in
5249 N_Formal_Subprogram_Declaration
5250 then
5251 goto Next_E;
5253 elsif Is_Type (E1) then
5255 -- Subtypes must statically match. E1, E2 are the local entities
5256 -- that are subtypes of the actuals. Itypes generated for other
5257 -- parameters need not be checked, the check will be performed
5258 -- on the parameters themselves.
5260 -- If E2 is a formal type declaration, it is a defaulted parameter
5261 -- and needs no checking.
5263 if not Is_Itype (E1)
5264 and then not Is_Itype (E2)
5265 then
5266 Check_Mismatch
5267 (not Is_Type (E2)
5268 or else Etype (E1) /= Etype (E2)
5269 or else not Subtypes_Statically_Match (E1, E2));
5270 end if;
5272 elsif Ekind (E1) = E_Constant then
5274 -- IN parameters must denote the same static value, or the same
5275 -- constant, or the literal null.
5277 Expr1 := Expression (Parent (E1));
5279 if Ekind (E2) /= E_Constant then
5280 Check_Mismatch (True);
5281 goto Next_E;
5282 else
5283 Expr2 := Expression (Parent (E2));
5284 end if;
5286 if Is_Static_Expression (Expr1) then
5288 if not Is_Static_Expression (Expr2) then
5289 Check_Mismatch (True);
5291 elsif Is_Discrete_Type (Etype (E1)) then
5292 declare
5293 V1 : constant Uint := Expr_Value (Expr1);
5294 V2 : constant Uint := Expr_Value (Expr2);
5295 begin
5296 Check_Mismatch (V1 /= V2);
5297 end;
5299 elsif Is_Real_Type (Etype (E1)) then
5300 declare
5301 V1 : constant Ureal := Expr_Value_R (Expr1);
5302 V2 : constant Ureal := Expr_Value_R (Expr2);
5303 begin
5304 Check_Mismatch (V1 /= V2);
5305 end;
5307 elsif Is_String_Type (Etype (E1))
5308 and then Nkind (Expr1) = N_String_Literal
5309 then
5310 if Nkind (Expr2) /= N_String_Literal then
5311 Check_Mismatch (True);
5312 else
5313 Check_Mismatch
5314 (not String_Equal (Strval (Expr1), Strval (Expr2)));
5315 end if;
5316 end if;
5318 elsif Is_Entity_Name (Expr1) then
5319 if Is_Entity_Name (Expr2) then
5320 if Entity (Expr1) = Entity (Expr2) then
5321 null;
5322 else
5323 Check_Mismatch
5324 (not Same_Instantiated_Constant
5325 (Entity (Expr1), Entity (Expr2)));
5326 end if;
5327 else
5328 Check_Mismatch (True);
5329 end if;
5331 elsif Is_Entity_Name (Original_Node (Expr1))
5332 and then Is_Entity_Name (Expr2)
5333 and then
5334 Same_Instantiated_Constant
5335 (Entity (Original_Node (Expr1)), Entity (Expr2))
5336 then
5337 null;
5339 elsif Nkind (Expr1) = N_Null then
5340 Check_Mismatch (Nkind (Expr1) /= N_Null);
5342 else
5343 Check_Mismatch (True);
5344 end if;
5346 elsif Ekind (E1) = E_Variable then
5347 Check_Mismatch (not Same_Instantiated_Variable (E1, E2));
5349 elsif Ekind (E1) = E_Package then
5350 Check_Mismatch
5351 (Ekind (E1) /= Ekind (E2)
5352 or else Renamed_Object (E1) /= Renamed_Object (E2));
5354 elsif Is_Overloadable (E1) then
5356 -- Verify that the actual subprograms match. Note that actuals
5357 -- that are attributes are rewritten as subprograms. If the
5358 -- subprogram in the formal package is defaulted, no check is
5359 -- needed. Note that this can only happen in Ada 2005 when the
5360 -- formal package can be partially parameterized.
5362 if Nkind (Unit_Declaration_Node (E1)) =
5363 N_Subprogram_Renaming_Declaration
5364 and then From_Default (Unit_Declaration_Node (E1))
5365 then
5366 null;
5368 -- If the formal package has an "others" box association that
5369 -- covers this formal, there is no need for a check either.
5371 elsif Nkind (Unit_Declaration_Node (E2)) in
5372 N_Formal_Subprogram_Declaration
5373 and then Box_Present (Unit_Declaration_Node (E2))
5374 then
5375 null;
5377 -- No check needed if subprogram is a defaulted null procedure
5379 elsif No (Alias (E2))
5380 and then Ekind (E2) = E_Procedure
5381 and then
5382 Null_Present (Specification (Unit_Declaration_Node (E2)))
5383 then
5384 null;
5386 -- Otherwise the actual in the formal and the actual in the
5387 -- instantiation of the formal must match, up to renamings.
5389 else
5390 Check_Mismatch
5391 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
5392 end if;
5394 else
5395 raise Program_Error;
5396 end if;
5398 <<Next_E>>
5399 Next_Entity (E1);
5400 Next_Entity (E2);
5401 end loop;
5402 end Check_Formal_Package_Instance;
5404 ---------------------------
5405 -- Check_Formal_Packages --
5406 ---------------------------
5408 procedure Check_Formal_Packages (P_Id : Entity_Id) is
5409 E : Entity_Id;
5410 Formal_P : Entity_Id;
5412 begin
5413 -- Iterate through the declarations in the instance, looking for package
5414 -- renaming declarations that denote instances of formal packages. Stop
5415 -- when we find the renaming of the current package itself. The
5416 -- declaration for a formal package without a box is followed by an
5417 -- internal entity that repeats the instantiation.
5419 E := First_Entity (P_Id);
5420 while Present (E) loop
5421 if Ekind (E) = E_Package then
5422 if Renamed_Object (E) = P_Id then
5423 exit;
5425 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5426 null;
5428 elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
5429 Formal_P := Next_Entity (E);
5430 Check_Formal_Package_Instance (Formal_P, E);
5432 -- After checking, remove the internal validating package. It
5433 -- is only needed for semantic checks, and as it may contain
5434 -- generic formal declarations it should not reach gigi.
5436 Remove (Unit_Declaration_Node (Formal_P));
5437 end if;
5438 end if;
5440 Next_Entity (E);
5441 end loop;
5442 end Check_Formal_Packages;
5444 ---------------------------------
5445 -- Check_Forward_Instantiation --
5446 ---------------------------------
5448 procedure Check_Forward_Instantiation (Decl : Node_Id) is
5449 S : Entity_Id;
5450 Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
5452 begin
5453 -- The instantiation appears before the generic body if we are in the
5454 -- scope of the unit containing the generic, either in its spec or in
5455 -- the package body, and before the generic body.
5457 if Ekind (Gen_Comp) = E_Package_Body then
5458 Gen_Comp := Spec_Entity (Gen_Comp);
5459 end if;
5461 if In_Open_Scopes (Gen_Comp)
5462 and then No (Corresponding_Body (Decl))
5463 then
5464 S := Current_Scope;
5466 while Present (S)
5467 and then not Is_Compilation_Unit (S)
5468 and then not Is_Child_Unit (S)
5469 loop
5470 if Ekind (S) = E_Package then
5471 Set_Has_Forward_Instantiation (S);
5472 end if;
5474 S := Scope (S);
5475 end loop;
5476 end if;
5477 end Check_Forward_Instantiation;
5479 ---------------------------
5480 -- Check_Generic_Actuals --
5481 ---------------------------
5483 -- The visibility of the actuals may be different between the point of
5484 -- generic instantiation and the instantiation of the body.
5486 procedure Check_Generic_Actuals
5487 (Instance : Entity_Id;
5488 Is_Formal_Box : Boolean)
5490 E : Entity_Id;
5491 Astype : Entity_Id;
5493 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean;
5494 -- For a formal that is an array type, the component type is often a
5495 -- previous formal in the same unit. The privacy status of the component
5496 -- type will have been examined earlier in the traversal of the
5497 -- corresponding actuals, and this status should not be modified for
5498 -- the array (sub)type itself. However, if the base type of the array
5499 -- (sub)type is private, its full view must be restored in the body to
5500 -- be consistent with subsequent index subtypes, etc.
5502 -- To detect this case we have to rescan the list of formals, which is
5503 -- usually short enough to ignore the resulting inefficiency.
5505 -----------------------------
5506 -- Denotes_Previous_Actual --
5507 -----------------------------
5509 function Denotes_Previous_Actual (Typ : Entity_Id) return Boolean is
5510 Prev : Entity_Id;
5512 begin
5513 Prev := First_Entity (Instance);
5514 while Present (Prev) loop
5515 if Is_Type (Prev)
5516 and then Nkind (Parent (Prev)) = N_Subtype_Declaration
5517 and then Is_Entity_Name (Subtype_Indication (Parent (Prev)))
5518 and then Entity (Subtype_Indication (Parent (Prev))) = Typ
5519 then
5520 return True;
5522 elsif Prev = E then
5523 return False;
5525 else
5526 Next_Entity (Prev);
5527 end if;
5528 end loop;
5530 return False;
5531 end Denotes_Previous_Actual;
5533 -- Start of processing for Check_Generic_Actuals
5535 begin
5536 E := First_Entity (Instance);
5537 while Present (E) loop
5538 if Is_Type (E)
5539 and then Nkind (Parent (E)) = N_Subtype_Declaration
5540 and then Scope (Etype (E)) /= Instance
5541 and then Is_Entity_Name (Subtype_Indication (Parent (E)))
5542 then
5543 if Is_Array_Type (E)
5544 and then not Is_Private_Type (Etype (E))
5545 and then Denotes_Previous_Actual (Component_Type (E))
5546 then
5547 null;
5548 else
5549 Check_Private_View (Subtype_Indication (Parent (E)));
5550 end if;
5552 Set_Is_Generic_Actual_Type (E, True);
5553 Set_Is_Hidden (E, False);
5554 Set_Is_Potentially_Use_Visible (E,
5555 In_Use (Instance));
5557 -- We constructed the generic actual type as a subtype of the
5558 -- supplied type. This means that it normally would not inherit
5559 -- subtype specific attributes of the actual, which is wrong for
5560 -- the generic case.
5562 Astype := Ancestor_Subtype (E);
5564 if No (Astype) then
5566 -- This can happen when E is an itype that is the full view of
5567 -- a private type completed, e.g. with a constrained array. In
5568 -- that case, use the first subtype, which will carry size
5569 -- information. The base type itself is unconstrained and will
5570 -- not carry it.
5572 Astype := First_Subtype (E);
5573 end if;
5575 Set_Size_Info (E, (Astype));
5576 Set_RM_Size (E, RM_Size (Astype));
5577 Set_First_Rep_Item (E, First_Rep_Item (Astype));
5579 if Is_Discrete_Or_Fixed_Point_Type (E) then
5580 Set_RM_Size (E, RM_Size (Astype));
5582 -- In nested instances, the base type of an access actual may
5583 -- itself be private, and need to be exchanged.
5585 elsif Is_Access_Type (E)
5586 and then Is_Private_Type (Etype (E))
5587 then
5588 Check_Private_View
5589 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
5590 end if;
5592 elsif Ekind (E) = E_Package then
5594 -- If this is the renaming for the current instance, we're done.
5595 -- Otherwise it is a formal package. If the corresponding formal
5596 -- was declared with a box, the (instantiations of the) generic
5597 -- formal part are also visible. Otherwise, ignore the entity
5598 -- created to validate the actuals.
5600 if Renamed_Object (E) = Instance then
5601 exit;
5603 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
5604 null;
5606 -- The visibility of a formal of an enclosing generic is already
5607 -- correct.
5609 elsif Denotes_Formal_Package (E) then
5610 null;
5612 elsif Present (Associated_Formal_Package (E))
5613 and then not Is_Generic_Formal (E)
5614 then
5615 if Box_Present (Parent (Associated_Formal_Package (E))) then
5616 Check_Generic_Actuals (Renamed_Object (E), True);
5618 else
5619 Check_Generic_Actuals (Renamed_Object (E), False);
5620 end if;
5622 Set_Is_Hidden (E, False);
5623 end if;
5625 -- If this is a subprogram instance (in a wrapper package) the
5626 -- actual is fully visible.
5628 elsif Is_Wrapper_Package (Instance) then
5629 Set_Is_Hidden (E, False);
5631 -- If the formal package is declared with a box, or if the formal
5632 -- parameter is defaulted, it is visible in the body.
5634 elsif Is_Formal_Box
5635 or else Is_Visible_Formal (E)
5636 then
5637 Set_Is_Hidden (E, False);
5638 end if;
5640 if Ekind (E) = E_Constant then
5642 -- If the type of the actual is a private type declared in the
5643 -- enclosing scope of the generic unit, the body of the generic
5644 -- sees the full view of the type (because it has to appear in
5645 -- the corresponding package body). If the type is private now,
5646 -- exchange views to restore the proper visiblity in the instance.
5648 declare
5649 Typ : constant Entity_Id := Base_Type (Etype (E));
5650 -- The type of the actual
5652 Gen_Id : Entity_Id;
5653 -- The generic unit
5655 Parent_Scope : Entity_Id;
5656 -- The enclosing scope of the generic unit
5658 begin
5659 if Is_Wrapper_Package (Instance) then
5660 Gen_Id :=
5661 Generic_Parent
5662 (Specification
5663 (Unit_Declaration_Node
5664 (Related_Instance (Instance))));
5665 else
5666 Gen_Id :=
5667 Generic_Parent
5668 (Specification (Unit_Declaration_Node (Instance)));
5669 end if;
5671 Parent_Scope := Scope (Gen_Id);
5673 -- The exchange is only needed if the generic is defined
5674 -- within a package which is not a common ancestor of the
5675 -- scope of the instance, and is not already in scope.
5677 if Is_Private_Type (Typ)
5678 and then Scope (Typ) = Parent_Scope
5679 and then Scope (Instance) /= Parent_Scope
5680 and then Ekind (Parent_Scope) = E_Package
5681 and then not Is_Child_Unit (Gen_Id)
5682 then
5683 Switch_View (Typ);
5685 -- If the type of the entity is a subtype, it may also have
5686 -- to be made visible, together with the base type of its
5687 -- full view, after exchange.
5689 if Is_Private_Type (Etype (E)) then
5690 Switch_View (Etype (E));
5691 Switch_View (Base_Type (Etype (E)));
5692 end if;
5693 end if;
5694 end;
5695 end if;
5697 Next_Entity (E);
5698 end loop;
5699 end Check_Generic_Actuals;
5701 ------------------------------
5702 -- Check_Generic_Child_Unit --
5703 ------------------------------
5705 procedure Check_Generic_Child_Unit
5706 (Gen_Id : Node_Id;
5707 Parent_Installed : in out Boolean)
5709 Loc : constant Source_Ptr := Sloc (Gen_Id);
5710 Gen_Par : Entity_Id := Empty;
5711 E : Entity_Id;
5712 Inst_Par : Entity_Id;
5713 S : Node_Id;
5715 function Find_Generic_Child
5716 (Scop : Entity_Id;
5717 Id : Node_Id) return Entity_Id;
5718 -- Search generic parent for possible child unit with the given name
5720 function In_Enclosing_Instance return Boolean;
5721 -- Within an instance of the parent, the child unit may be denoted by
5722 -- a simple name, or an abbreviated expanded name. Examine enclosing
5723 -- scopes to locate a possible parent instantiation.
5725 ------------------------
5726 -- Find_Generic_Child --
5727 ------------------------
5729 function Find_Generic_Child
5730 (Scop : Entity_Id;
5731 Id : Node_Id) return Entity_Id
5733 E : Entity_Id;
5735 begin
5736 -- If entity of name is already set, instance has already been
5737 -- resolved, e.g. in an enclosing instantiation.
5739 if Present (Entity (Id)) then
5740 if Scope (Entity (Id)) = Scop then
5741 return Entity (Id);
5742 else
5743 return Empty;
5744 end if;
5746 else
5747 E := First_Entity (Scop);
5748 while Present (E) loop
5749 if Chars (E) = Chars (Id)
5750 and then Is_Child_Unit (E)
5751 then
5752 if Is_Child_Unit (E)
5753 and then not Is_Visible_Lib_Unit (E)
5754 then
5755 Error_Msg_NE
5756 ("generic child unit& is not visible", Gen_Id, E);
5757 end if;
5759 Set_Entity (Id, E);
5760 return E;
5761 end if;
5763 Next_Entity (E);
5764 end loop;
5766 return Empty;
5767 end if;
5768 end Find_Generic_Child;
5770 ---------------------------
5771 -- In_Enclosing_Instance --
5772 ---------------------------
5774 function In_Enclosing_Instance return Boolean is
5775 Enclosing_Instance : Node_Id;
5776 Instance_Decl : Node_Id;
5778 begin
5779 -- We do not inline any call that contains instantiations, except
5780 -- for instantiations of Unchecked_Conversion, so if we are within
5781 -- an inlined body the current instance does not require parents.
5783 if In_Inlined_Body then
5784 pragma Assert (Chars (Gen_Id) = Name_Unchecked_Conversion);
5785 return False;
5786 end if;
5788 -- Loop to check enclosing scopes
5790 Enclosing_Instance := Current_Scope;
5791 while Present (Enclosing_Instance) loop
5792 Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
5794 if Ekind (Enclosing_Instance) = E_Package
5795 and then Is_Generic_Instance (Enclosing_Instance)
5796 and then Present
5797 (Generic_Parent (Specification (Instance_Decl)))
5798 then
5799 -- Check whether the generic we are looking for is a child of
5800 -- this instance.
5802 E := Find_Generic_Child
5803 (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
5804 exit when Present (E);
5806 else
5807 E := Empty;
5808 end if;
5810 Enclosing_Instance := Scope (Enclosing_Instance);
5811 end loop;
5813 if No (E) then
5815 -- Not a child unit
5817 Analyze (Gen_Id);
5818 return False;
5820 else
5821 Rewrite (Gen_Id,
5822 Make_Expanded_Name (Loc,
5823 Chars => Chars (E),
5824 Prefix => New_Occurrence_Of (Enclosing_Instance, Loc),
5825 Selector_Name => New_Occurrence_Of (E, Loc)));
5827 Set_Entity (Gen_Id, E);
5828 Set_Etype (Gen_Id, Etype (E));
5829 Parent_Installed := False; -- Already in scope.
5830 return True;
5831 end if;
5832 end In_Enclosing_Instance;
5834 -- Start of processing for Check_Generic_Child_Unit
5836 begin
5837 -- If the name of the generic is given by a selected component, it may
5838 -- be the name of a generic child unit, and the prefix is the name of an
5839 -- instance of the parent, in which case the child unit must be visible.
5840 -- If this instance is not in scope, it must be placed there and removed
5841 -- after instantiation, because what is being instantiated is not the
5842 -- original child, but the corresponding child present in the instance
5843 -- of the parent.
5845 -- If the child is instantiated within the parent, it can be given by
5846 -- a simple name. In this case the instance is already in scope, but
5847 -- the child generic must be recovered from the generic parent as well.
5849 if Nkind (Gen_Id) = N_Selected_Component then
5850 S := Selector_Name (Gen_Id);
5851 Analyze (Prefix (Gen_Id));
5852 Inst_Par := Entity (Prefix (Gen_Id));
5854 if Ekind (Inst_Par) = E_Package
5855 and then Present (Renamed_Object (Inst_Par))
5856 then
5857 Inst_Par := Renamed_Object (Inst_Par);
5858 end if;
5860 if Ekind (Inst_Par) = E_Package then
5861 if Nkind (Parent (Inst_Par)) = N_Package_Specification then
5862 Gen_Par := Generic_Parent (Parent (Inst_Par));
5864 elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
5865 and then
5866 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
5867 then
5868 Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
5869 end if;
5871 elsif Ekind (Inst_Par) = E_Generic_Package
5872 and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
5873 then
5874 -- A formal package may be a real child package, and not the
5875 -- implicit instance within a parent. In this case the child is
5876 -- not visible and has to be retrieved explicitly as well.
5878 Gen_Par := Inst_Par;
5879 end if;
5881 if Present (Gen_Par) then
5883 -- The prefix denotes an instantiation. The entity itself may be a
5884 -- nested generic, or a child unit.
5886 E := Find_Generic_Child (Gen_Par, S);
5888 if Present (E) then
5889 Change_Selected_Component_To_Expanded_Name (Gen_Id);
5890 Set_Entity (Gen_Id, E);
5891 Set_Etype (Gen_Id, Etype (E));
5892 Set_Entity (S, E);
5893 Set_Etype (S, Etype (E));
5895 -- Indicate that this is a reference to the parent
5897 if In_Extended_Main_Source_Unit (Gen_Id) then
5898 Set_Is_Instantiated (Inst_Par);
5899 end if;
5901 -- A common mistake is to replicate the naming scheme of a
5902 -- hierarchy by instantiating a generic child directly, rather
5903 -- than the implicit child in a parent instance:
5905 -- generic .. package Gpar is ..
5906 -- generic .. package Gpar.Child is ..
5907 -- package Par is new Gpar ();
5909 -- with Gpar.Child;
5910 -- package Par.Child is new Gpar.Child ();
5911 -- rather than Par.Child
5913 -- In this case the instantiation is within Par, which is an
5914 -- instance, but Gpar does not denote Par because we are not IN
5915 -- the instance of Gpar, so this is illegal. The test below
5916 -- recognizes this particular case.
5918 if Is_Child_Unit (E)
5919 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
5920 and then (not In_Instance
5921 or else Nkind (Parent (Parent (Gen_Id))) =
5922 N_Compilation_Unit)
5923 then
5924 Error_Msg_N
5925 ("prefix of generic child unit must be instance of parent",
5926 Gen_Id);
5927 end if;
5929 if not In_Open_Scopes (Inst_Par)
5930 and then Nkind (Parent (Gen_Id)) not in
5931 N_Generic_Renaming_Declaration
5932 then
5933 Install_Parent (Inst_Par);
5934 Parent_Installed := True;
5936 elsif In_Open_Scopes (Inst_Par) then
5938 -- If the parent is already installed, install the actuals
5939 -- for its formal packages. This is necessary when the child
5940 -- instance is a child of the parent instance: in this case,
5941 -- the parent is placed on the scope stack but the formal
5942 -- packages are not made visible.
5944 Install_Formal_Packages (Inst_Par);
5945 end if;
5947 else
5948 -- If the generic parent does not contain an entity that
5949 -- corresponds to the selector, the instance doesn't either.
5950 -- Analyzing the node will yield the appropriate error message.
5951 -- If the entity is not a child unit, then it is an inner
5952 -- generic in the parent.
5954 Analyze (Gen_Id);
5955 end if;
5957 else
5958 Analyze (Gen_Id);
5960 if Is_Child_Unit (Entity (Gen_Id))
5961 and then
5962 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
5963 and then not In_Open_Scopes (Inst_Par)
5964 then
5965 Install_Parent (Inst_Par);
5966 Parent_Installed := True;
5968 -- The generic unit may be the renaming of the implicit child
5969 -- present in an instance. In that case the parent instance is
5970 -- obtained from the name of the renamed entity.
5972 elsif Ekind (Entity (Gen_Id)) = E_Generic_Package
5973 and then Present (Renamed_Entity (Entity (Gen_Id)))
5974 and then Is_Child_Unit (Renamed_Entity (Entity (Gen_Id)))
5975 then
5976 declare
5977 Renamed_Package : constant Node_Id :=
5978 Name (Parent (Entity (Gen_Id)));
5979 begin
5980 if Nkind (Renamed_Package) = N_Expanded_Name then
5981 Inst_Par := Entity (Prefix (Renamed_Package));
5982 Install_Parent (Inst_Par);
5983 Parent_Installed := True;
5984 end if;
5985 end;
5986 end if;
5987 end if;
5989 elsif Nkind (Gen_Id) = N_Expanded_Name then
5991 -- Entity already present, analyze prefix, whose meaning may be
5992 -- an instance in the current context. If it is an instance of
5993 -- a relative within another, the proper parent may still have
5994 -- to be installed, if they are not of the same generation.
5996 Analyze (Prefix (Gen_Id));
5998 -- In the unlikely case that a local declaration hides the name
5999 -- of the parent package, locate it on the homonym chain. If the
6000 -- context is an instance of the parent, the renaming entity is
6001 -- flagged as such.
6003 Inst_Par := Entity (Prefix (Gen_Id));
6004 while Present (Inst_Par)
6005 and then not Is_Package_Or_Generic_Package (Inst_Par)
6006 loop
6007 Inst_Par := Homonym (Inst_Par);
6008 end loop;
6010 pragma Assert (Present (Inst_Par));
6011 Set_Entity (Prefix (Gen_Id), Inst_Par);
6013 if In_Enclosing_Instance then
6014 null;
6016 elsif Present (Entity (Gen_Id))
6017 and then Is_Child_Unit (Entity (Gen_Id))
6018 and then not In_Open_Scopes (Inst_Par)
6019 then
6020 Install_Parent (Inst_Par);
6021 Parent_Installed := True;
6022 end if;
6024 elsif In_Enclosing_Instance then
6026 -- The child unit is found in some enclosing scope
6028 null;
6030 else
6031 Analyze (Gen_Id);
6033 -- If this is the renaming of the implicit child in a parent
6034 -- instance, recover the parent name and install it.
6036 if Is_Entity_Name (Gen_Id) then
6037 E := Entity (Gen_Id);
6039 if Is_Generic_Unit (E)
6040 and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
6041 and then Is_Child_Unit (Renamed_Object (E))
6042 and then Is_Generic_Unit (Scope (Renamed_Object (E)))
6043 and then Nkind (Name (Parent (E))) = N_Expanded_Name
6044 then
6045 Rewrite (Gen_Id,
6046 New_Copy_Tree (Name (Parent (E))));
6047 Inst_Par := Entity (Prefix (Gen_Id));
6049 if not In_Open_Scopes (Inst_Par) then
6050 Install_Parent (Inst_Par);
6051 Parent_Installed := True;
6052 end if;
6054 -- If it is a child unit of a non-generic parent, it may be
6055 -- use-visible and given by a direct name. Install parent as
6056 -- for other cases.
6058 elsif Is_Generic_Unit (E)
6059 and then Is_Child_Unit (E)
6060 and then
6061 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
6062 and then not Is_Generic_Unit (Scope (E))
6063 then
6064 if not In_Open_Scopes (Scope (E)) then
6065 Install_Parent (Scope (E));
6066 Parent_Installed := True;
6067 end if;
6068 end if;
6069 end if;
6070 end if;
6071 end Check_Generic_Child_Unit;
6073 -----------------------------
6074 -- Check_Hidden_Child_Unit --
6075 -----------------------------
6077 procedure Check_Hidden_Child_Unit
6078 (N : Node_Id;
6079 Gen_Unit : Entity_Id;
6080 Act_Decl_Id : Entity_Id)
6082 Gen_Id : constant Node_Id := Name (N);
6084 begin
6085 if Is_Child_Unit (Gen_Unit)
6086 and then Is_Child_Unit (Act_Decl_Id)
6087 and then Nkind (Gen_Id) = N_Expanded_Name
6088 and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
6089 and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
6090 then
6091 Error_Msg_Node_2 := Scope (Act_Decl_Id);
6092 Error_Msg_NE
6093 ("generic unit & is implicitly declared in &",
6094 Defining_Unit_Name (N), Gen_Unit);
6095 Error_Msg_N ("\instance must have different name",
6096 Defining_Unit_Name (N));
6097 end if;
6098 end Check_Hidden_Child_Unit;
6100 ------------------------
6101 -- Check_Private_View --
6102 ------------------------
6104 procedure Check_Private_View (N : Node_Id) is
6105 T : constant Entity_Id := Etype (N);
6106 BT : Entity_Id;
6108 begin
6109 -- Exchange views if the type was not private in the generic but is
6110 -- private at the point of instantiation. Do not exchange views if
6111 -- the scope of the type is in scope. This can happen if both generic
6112 -- and instance are sibling units, or if type is defined in a parent.
6113 -- In this case the visibility of the type will be correct for all
6114 -- semantic checks.
6116 if Present (T) then
6117 BT := Base_Type (T);
6119 if Is_Private_Type (T)
6120 and then not Has_Private_View (N)
6121 and then Present (Full_View (T))
6122 and then not In_Open_Scopes (Scope (T))
6123 then
6124 -- In the generic, the full type was visible. Save the private
6125 -- entity, for subsequent exchange.
6127 Switch_View (T);
6129 elsif Has_Private_View (N)
6130 and then not Is_Private_Type (T)
6131 and then not Has_Been_Exchanged (T)
6132 and then Etype (Get_Associated_Node (N)) /= T
6133 then
6134 -- Only the private declaration was visible in the generic. If
6135 -- the type appears in a subtype declaration, the subtype in the
6136 -- instance must have a view compatible with that of its parent,
6137 -- which must be exchanged (see corresponding code in Restore_
6138 -- Private_Views). Otherwise, if the type is defined in a parent
6139 -- unit, leave full visibility within instance, which is safe.
6141 if In_Open_Scopes (Scope (Base_Type (T)))
6142 and then not Is_Private_Type (Base_Type (T))
6143 and then Comes_From_Source (Base_Type (T))
6144 then
6145 null;
6147 elsif Nkind (Parent (N)) = N_Subtype_Declaration
6148 or else not In_Private_Part (Scope (Base_Type (T)))
6149 then
6150 Prepend_Elmt (T, Exchanged_Views);
6151 Exchange_Declarations (Etype (Get_Associated_Node (N)));
6152 end if;
6154 -- For composite types with inconsistent representation exchange
6155 -- component types accordingly.
6157 elsif Is_Access_Type (T)
6158 and then Is_Private_Type (Designated_Type (T))
6159 and then not Has_Private_View (N)
6160 and then Present (Full_View (Designated_Type (T)))
6161 then
6162 Switch_View (Designated_Type (T));
6164 elsif Is_Array_Type (T) then
6165 if Is_Private_Type (Component_Type (T))
6166 and then not Has_Private_View (N)
6167 and then Present (Full_View (Component_Type (T)))
6168 then
6169 Switch_View (Component_Type (T));
6170 end if;
6172 -- The normal exchange mechanism relies on the setting of a
6173 -- flag on the reference in the generic. However, an additional
6174 -- mechanism is needed for types that are not explicitly
6175 -- mentioned in the generic, but may be needed in expanded code
6176 -- in the instance. This includes component types of arrays and
6177 -- designated types of access types. This processing must also
6178 -- include the index types of arrays which we take care of here.
6180 declare
6181 Indx : Node_Id;
6182 Typ : Entity_Id;
6184 begin
6185 Indx := First_Index (T);
6186 while Present (Indx) loop
6187 Typ := Base_Type (Etype (Indx));
6189 if Is_Private_Type (Typ)
6190 and then Present (Full_View (Typ))
6191 then
6192 Switch_View (Typ);
6193 end if;
6195 Next_Index (Indx);
6196 end loop;
6197 end;
6199 elsif Is_Private_Type (T)
6200 and then Present (Full_View (T))
6201 and then Is_Array_Type (Full_View (T))
6202 and then Is_Private_Type (Component_Type (Full_View (T)))
6203 then
6204 Switch_View (T);
6206 -- Finally, a non-private subtype may have a private base type, which
6207 -- must be exchanged for consistency. This can happen when a package
6208 -- body is instantiated, when the scope stack is empty but in fact
6209 -- the subtype and the base type are declared in an enclosing scope.
6211 -- Note that in this case we introduce an inconsistency in the view
6212 -- set, because we switch the base type BT, but there could be some
6213 -- private dependent subtypes of BT which remain unswitched. Such
6214 -- subtypes might need to be switched at a later point (see specific
6215 -- provision for that case in Switch_View).
6217 elsif not Is_Private_Type (T)
6218 and then not Has_Private_View (N)
6219 and then Is_Private_Type (BT)
6220 and then Present (Full_View (BT))
6221 and then not Is_Generic_Type (BT)
6222 and then not In_Open_Scopes (BT)
6223 then
6224 Prepend_Elmt (Full_View (BT), Exchanged_Views);
6225 Exchange_Declarations (BT);
6226 end if;
6227 end if;
6228 end Check_Private_View;
6230 -----------------------------
6231 -- Check_Hidden_Primitives --
6232 -----------------------------
6234 function Check_Hidden_Primitives (Assoc_List : List_Id) return Elist_Id is
6235 Actual : Node_Id;
6236 Gen_T : Entity_Id;
6237 Result : Elist_Id := No_Elist;
6239 begin
6240 if No (Assoc_List) then
6241 return No_Elist;
6242 end if;
6244 -- Traverse the list of associations between formals and actuals
6245 -- searching for renamings of tagged types
6247 Actual := First (Assoc_List);
6248 while Present (Actual) loop
6249 if Nkind (Actual) = N_Subtype_Declaration then
6250 Gen_T := Generic_Parent_Type (Actual);
6252 if Present (Gen_T)
6253 and then Is_Tagged_Type (Gen_T)
6254 then
6255 -- Traverse the list of primitives of the actual types
6256 -- searching for hidden primitives that are visible in the
6257 -- corresponding generic formal; leave them visible and
6258 -- append them to Result to restore their decoration later.
6260 Install_Hidden_Primitives
6261 (Prims_List => Result,
6262 Gen_T => Gen_T,
6263 Act_T => Entity (Subtype_Indication (Actual)));
6264 end if;
6265 end if;
6267 Next (Actual);
6268 end loop;
6270 return Result;
6271 end Check_Hidden_Primitives;
6273 --------------------------
6274 -- Contains_Instance_Of --
6275 --------------------------
6277 function Contains_Instance_Of
6278 (Inner : Entity_Id;
6279 Outer : Entity_Id;
6280 N : Node_Id) return Boolean
6282 Elmt : Elmt_Id;
6283 Scop : Entity_Id;
6285 begin
6286 Scop := Outer;
6288 -- Verify that there are no circular instantiations. We check whether
6289 -- the unit contains an instance of the current scope or some enclosing
6290 -- scope (in case one of the instances appears in a subunit). Longer
6291 -- circularities involving subunits might seem too pathological to
6292 -- consider, but they were not too pathological for the authors of
6293 -- DEC bc30vsq, so we loop over all enclosing scopes, and mark all
6294 -- enclosing generic scopes as containing an instance.
6296 loop
6297 -- Within a generic subprogram body, the scope is not generic, to
6298 -- allow for recursive subprograms. Use the declaration to determine
6299 -- whether this is a generic unit.
6301 if Ekind (Scop) = E_Generic_Package
6302 or else (Is_Subprogram (Scop)
6303 and then Nkind (Unit_Declaration_Node (Scop)) =
6304 N_Generic_Subprogram_Declaration)
6305 then
6306 Elmt := First_Elmt (Inner_Instances (Inner));
6308 while Present (Elmt) loop
6309 if Node (Elmt) = Scop then
6310 Error_Msg_Node_2 := Inner;
6311 Error_Msg_NE
6312 ("circular Instantiation: & instantiated within &!",
6313 N, Scop);
6314 return True;
6316 elsif Node (Elmt) = Inner then
6317 return True;
6319 elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
6320 Error_Msg_Node_2 := Inner;
6321 Error_Msg_NE
6322 ("circular Instantiation: & instantiated within &!",
6323 N, Node (Elmt));
6324 return True;
6325 end if;
6327 Next_Elmt (Elmt);
6328 end loop;
6330 -- Indicate that Inner is being instantiated within Scop
6332 Append_Elmt (Inner, Inner_Instances (Scop));
6333 end if;
6335 if Scop = Standard_Standard then
6336 exit;
6337 else
6338 Scop := Scope (Scop);
6339 end if;
6340 end loop;
6342 return False;
6343 end Contains_Instance_Of;
6345 -----------------------
6346 -- Copy_Generic_Node --
6347 -----------------------
6349 function Copy_Generic_Node
6350 (N : Node_Id;
6351 Parent_Id : Node_Id;
6352 Instantiating : Boolean) return Node_Id
6354 Ent : Entity_Id;
6355 New_N : Node_Id;
6357 function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
6358 -- Check the given value of one of the Fields referenced by the current
6359 -- node to determine whether to copy it recursively. The field may hold
6360 -- a Node_Id, a List_Id, or an Elist_Id, or a plain value (Sloc, Uint,
6361 -- Char) in which case it need not be copied.
6363 procedure Copy_Descendants;
6364 -- Common utility for various nodes
6366 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
6367 -- Make copy of element list
6369 function Copy_Generic_List
6370 (L : List_Id;
6371 Parent_Id : Node_Id) return List_Id;
6372 -- Apply Copy_Node recursively to the members of a node list
6374 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
6375 -- True if an identifier is part of the defining program unit name of
6376 -- a child unit. The entity of such an identifier must be kept (for
6377 -- ASIS use) even though as the name of an enclosing generic it would
6378 -- otherwise not be preserved in the generic tree.
6380 ----------------------
6381 -- Copy_Descendants --
6382 ----------------------
6384 procedure Copy_Descendants is
6386 use Atree.Unchecked_Access;
6387 -- This code section is part of the implementation of an untyped
6388 -- tree traversal, so it needs direct access to node fields.
6390 begin
6391 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6392 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6393 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6394 Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
6395 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6396 end Copy_Descendants;
6398 -----------------------------
6399 -- Copy_Generic_Descendant --
6400 -----------------------------
6402 function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
6403 begin
6404 if D = Union_Id (Empty) then
6405 return D;
6407 elsif D in Node_Range then
6408 return Union_Id
6409 (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
6411 elsif D in List_Range then
6412 return Union_Id (Copy_Generic_List (List_Id (D), New_N));
6414 elsif D in Elist_Range then
6415 return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
6417 -- Nothing else is copyable (e.g. Uint values), return as is
6419 else
6420 return D;
6421 end if;
6422 end Copy_Generic_Descendant;
6424 ------------------------
6425 -- Copy_Generic_Elist --
6426 ------------------------
6428 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
6429 M : Elmt_Id;
6430 L : Elist_Id;
6432 begin
6433 if Present (E) then
6434 L := New_Elmt_List;
6435 M := First_Elmt (E);
6436 while Present (M) loop
6437 Append_Elmt
6438 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
6439 Next_Elmt (M);
6440 end loop;
6442 return L;
6444 else
6445 return No_Elist;
6446 end if;
6447 end Copy_Generic_Elist;
6449 -----------------------
6450 -- Copy_Generic_List --
6451 -----------------------
6453 function Copy_Generic_List
6454 (L : List_Id;
6455 Parent_Id : Node_Id) return List_Id
6457 N : Node_Id;
6458 New_L : List_Id;
6460 begin
6461 if Present (L) then
6462 New_L := New_List;
6463 Set_Parent (New_L, Parent_Id);
6465 N := First (L);
6466 while Present (N) loop
6467 Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
6468 Next (N);
6469 end loop;
6471 return New_L;
6473 else
6474 return No_List;
6475 end if;
6476 end Copy_Generic_List;
6478 ---------------------------
6479 -- In_Defining_Unit_Name --
6480 ---------------------------
6482 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
6483 begin
6484 return Present (Parent (Nam))
6485 and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
6486 or else
6487 (Nkind (Parent (Nam)) = N_Expanded_Name
6488 and then In_Defining_Unit_Name (Parent (Nam))));
6489 end In_Defining_Unit_Name;
6491 -- Start of processing for Copy_Generic_Node
6493 begin
6494 if N = Empty then
6495 return N;
6496 end if;
6498 New_N := New_Copy (N);
6500 -- Copy aspects if present
6502 if Has_Aspects (N) then
6503 Set_Has_Aspects (New_N, False);
6504 Set_Aspect_Specifications
6505 (New_N, Copy_Generic_List (Aspect_Specifications (N), Parent_Id));
6506 end if;
6508 if Instantiating then
6509 Adjust_Instantiation_Sloc (New_N, S_Adjustment);
6510 end if;
6512 if not Is_List_Member (N) then
6513 Set_Parent (New_N, Parent_Id);
6514 end if;
6516 -- If defining identifier, then all fields have been copied already
6518 if Nkind (New_N) in N_Entity then
6519 null;
6521 -- Special casing for identifiers and other entity names and operators
6523 elsif Nkind_In (New_N, N_Identifier,
6524 N_Character_Literal,
6525 N_Expanded_Name,
6526 N_Operator_Symbol)
6527 or else Nkind (New_N) in N_Op
6528 then
6529 if not Instantiating then
6531 -- Link both nodes in order to assign subsequently the entity of
6532 -- the copy to the original node, in case this is a global
6533 -- reference.
6535 Set_Associated_Node (N, New_N);
6537 -- If we are within an instantiation, this is a nested generic
6538 -- that has already been analyzed at the point of definition.
6539 -- We must preserve references that were global to the enclosing
6540 -- parent at that point. Other occurrences, whether global or
6541 -- local to the current generic, must be resolved anew, so we
6542 -- reset the entity in the generic copy. A global reference has a
6543 -- smaller depth than the parent, or else the same depth in case
6544 -- both are distinct compilation units.
6546 -- A child unit is implicitly declared within the enclosing parent
6547 -- but is in fact global to it, and must be preserved.
6549 -- It is also possible for Current_Instantiated_Parent to be
6550 -- defined, and for this not to be a nested generic, namely if
6551 -- the unit is loaded through Rtsfind. In that case, the entity of
6552 -- New_N is only a link to the associated node, and not a defining
6553 -- occurrence.
6555 -- The entities for parent units in the defining_program_unit of a
6556 -- generic child unit are established when the context of the unit
6557 -- is first analyzed, before the generic copy is made. They are
6558 -- preserved in the copy for use in ASIS queries.
6560 Ent := Entity (New_N);
6562 if No (Current_Instantiated_Parent.Gen_Id) then
6563 if No (Ent)
6564 or else Nkind (Ent) /= N_Defining_Identifier
6565 or else not In_Defining_Unit_Name (N)
6566 then
6567 Set_Associated_Node (New_N, Empty);
6568 end if;
6570 elsif No (Ent)
6571 or else
6572 not Nkind_In (Ent, N_Defining_Identifier,
6573 N_Defining_Character_Literal,
6574 N_Defining_Operator_Symbol)
6575 or else No (Scope (Ent))
6576 or else
6577 (Scope (Ent) = Current_Instantiated_Parent.Gen_Id
6578 and then not Is_Child_Unit (Ent))
6579 or else
6580 (Scope_Depth (Scope (Ent)) >
6581 Scope_Depth (Current_Instantiated_Parent.Gen_Id)
6582 and then
6583 Get_Source_Unit (Ent) =
6584 Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
6585 then
6586 Set_Associated_Node (New_N, Empty);
6587 end if;
6589 -- Case of instantiating identifier or some other name or operator
6591 else
6592 -- If the associated node is still defined, the entity in it
6593 -- is global, and must be copied to the instance. If this copy
6594 -- is being made for a body to inline, it is applied to an
6595 -- instantiated tree, and the entity is already present and
6596 -- must be also preserved.
6598 declare
6599 Assoc : constant Node_Id := Get_Associated_Node (N);
6601 begin
6602 if Present (Assoc) then
6603 if Nkind (Assoc) = Nkind (N) then
6604 Set_Entity (New_N, Entity (Assoc));
6605 Check_Private_View (N);
6607 -- The name in the call may be a selected component if the
6608 -- call has not been analyzed yet, as may be the case for
6609 -- pre/post conditions in a generic unit.
6611 elsif Nkind (Assoc) = N_Function_Call
6612 and then Is_Entity_Name (Name (Assoc))
6613 then
6614 Set_Entity (New_N, Entity (Name (Assoc)));
6616 elsif Nkind_In (Assoc, N_Defining_Identifier,
6617 N_Defining_Character_Literal,
6618 N_Defining_Operator_Symbol)
6619 and then Expander_Active
6620 then
6621 -- Inlining case: we are copying a tree that contains
6622 -- global entities, which are preserved in the copy to be
6623 -- used for subsequent inlining.
6625 null;
6627 else
6628 Set_Entity (New_N, Empty);
6629 end if;
6630 end if;
6631 end;
6632 end if;
6634 -- For expanded name, we must copy the Prefix and Selector_Name
6636 if Nkind (N) = N_Expanded_Name then
6637 Set_Prefix
6638 (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
6640 Set_Selector_Name (New_N,
6641 Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
6643 -- For operators, we must copy the right operand
6645 elsif Nkind (N) in N_Op then
6646 Set_Right_Opnd (New_N,
6647 Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
6649 -- And for binary operators, the left operand as well
6651 if Nkind (N) in N_Binary_Op then
6652 Set_Left_Opnd (New_N,
6653 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
6654 end if;
6655 end if;
6657 -- Special casing for stubs
6659 elsif Nkind (N) in N_Body_Stub then
6661 -- In any case, we must copy the specification or defining
6662 -- identifier as appropriate.
6664 if Nkind (N) = N_Subprogram_Body_Stub then
6665 Set_Specification (New_N,
6666 Copy_Generic_Node (Specification (N), New_N, Instantiating));
6668 else
6669 Set_Defining_Identifier (New_N,
6670 Copy_Generic_Node
6671 (Defining_Identifier (N), New_N, Instantiating));
6672 end if;
6674 -- If we are not instantiating, then this is where we load and
6675 -- analyze subunits, i.e. at the point where the stub occurs. A
6676 -- more permissive system might defer this analysis to the point
6677 -- of instantiation, but this seems too complicated for now.
6679 if not Instantiating then
6680 declare
6681 Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
6682 Subunit : Node_Id;
6683 Unum : Unit_Number_Type;
6684 New_Body : Node_Id;
6686 begin
6687 -- Make sure that, if it is a subunit of the main unit that is
6688 -- preprocessed and if -gnateG is specified, the preprocessed
6689 -- file will be written.
6691 Lib.Analysing_Subunit_Of_Main :=
6692 Lib.In_Extended_Main_Source_Unit (N);
6693 Unum :=
6694 Load_Unit
6695 (Load_Name => Subunit_Name,
6696 Required => False,
6697 Subunit => True,
6698 Error_Node => N);
6699 Lib.Analysing_Subunit_Of_Main := False;
6701 -- If the proper body is not found, a warning message will be
6702 -- emitted when analyzing the stub, or later at the point of
6703 -- instantiation. Here we just leave the stub as is.
6705 if Unum = No_Unit then
6706 Subunits_Missing := True;
6707 goto Subunit_Not_Found;
6708 end if;
6710 Subunit := Cunit (Unum);
6712 if Nkind (Unit (Subunit)) /= N_Subunit then
6713 Error_Msg_N
6714 ("found child unit instead of expected SEPARATE subunit",
6715 Subunit);
6716 Error_Msg_Sloc := Sloc (N);
6717 Error_Msg_N ("\to complete stub #", Subunit);
6718 goto Subunit_Not_Found;
6719 end if;
6721 -- We must create a generic copy of the subunit, in order to
6722 -- perform semantic analysis on it, and we must replace the
6723 -- stub in the original generic unit with the subunit, in order
6724 -- to preserve non-local references within.
6726 -- Only the proper body needs to be copied. Library_Unit and
6727 -- context clause are simply inherited by the generic copy.
6728 -- Note that the copy (which may be recursive if there are
6729 -- nested subunits) must be done first, before attaching it to
6730 -- the enclosing generic.
6732 New_Body :=
6733 Copy_Generic_Node
6734 (Proper_Body (Unit (Subunit)),
6735 Empty, Instantiating => False);
6737 -- Now place the original proper body in the original generic
6738 -- unit. This is a body, not a compilation unit.
6740 Rewrite (N, Proper_Body (Unit (Subunit)));
6741 Set_Is_Compilation_Unit (Defining_Entity (N), False);
6742 Set_Was_Originally_Stub (N);
6744 -- Finally replace the body of the subunit with its copy, and
6745 -- make this new subunit into the library unit of the generic
6746 -- copy, which does not have stubs any longer.
6748 Set_Proper_Body (Unit (Subunit), New_Body);
6749 Set_Library_Unit (New_N, Subunit);
6750 Inherit_Context (Unit (Subunit), N);
6751 end;
6753 -- If we are instantiating, this must be an error case, since
6754 -- otherwise we would have replaced the stub node by the proper body
6755 -- that corresponds. So just ignore it in the copy (i.e. we have
6756 -- copied it, and that is good enough).
6758 else
6759 null;
6760 end if;
6762 <<Subunit_Not_Found>> null;
6764 -- If the node is a compilation unit, it is the subunit of a stub, which
6765 -- has been loaded already (see code below). In this case, the library
6766 -- unit field of N points to the parent unit (which is a compilation
6767 -- unit) and need not (and cannot!) be copied.
6769 -- When the proper body of the stub is analyzed, the library_unit link
6770 -- is used to establish the proper context (see sem_ch10).
6772 -- The other fields of a compilation unit are copied as usual
6774 elsif Nkind (N) = N_Compilation_Unit then
6776 -- This code can only be executed when not instantiating, because in
6777 -- the copy made for an instantiation, the compilation unit node has
6778 -- disappeared at the point that a stub is replaced by its proper
6779 -- body.
6781 pragma Assert (not Instantiating);
6783 Set_Context_Items (New_N,
6784 Copy_Generic_List (Context_Items (N), New_N));
6786 Set_Unit (New_N,
6787 Copy_Generic_Node (Unit (N), New_N, False));
6789 Set_First_Inlined_Subprogram (New_N,
6790 Copy_Generic_Node
6791 (First_Inlined_Subprogram (N), New_N, False));
6793 Set_Aux_Decls_Node (New_N,
6794 Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
6796 -- For an assignment node, the assignment is known to be semantically
6797 -- legal if we are instantiating the template. This avoids incorrect
6798 -- diagnostics in generated code.
6800 elsif Nkind (N) = N_Assignment_Statement then
6802 -- Copy name and expression fields in usual manner
6804 Set_Name (New_N,
6805 Copy_Generic_Node (Name (N), New_N, Instantiating));
6807 Set_Expression (New_N,
6808 Copy_Generic_Node (Expression (N), New_N, Instantiating));
6810 if Instantiating then
6811 Set_Assignment_OK (Name (New_N), True);
6812 end if;
6814 elsif Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
6815 if not Instantiating then
6816 Set_Associated_Node (N, New_N);
6818 else
6819 if Present (Get_Associated_Node (N))
6820 and then Nkind (Get_Associated_Node (N)) = Nkind (N)
6821 then
6822 -- In the generic the aggregate has some composite type. If at
6823 -- the point of instantiation the type has a private view,
6824 -- install the full view (and that of its ancestors, if any).
6826 declare
6827 T : Entity_Id := (Etype (Get_Associated_Node (New_N)));
6828 Rt : Entity_Id;
6830 begin
6831 if Present (T)
6832 and then Is_Private_Type (T)
6833 then
6834 Switch_View (T);
6835 end if;
6837 if Present (T)
6838 and then Is_Tagged_Type (T)
6839 and then Is_Derived_Type (T)
6840 then
6841 Rt := Root_Type (T);
6843 loop
6844 T := Etype (T);
6846 if Is_Private_Type (T) then
6847 Switch_View (T);
6848 end if;
6850 exit when T = Rt;
6851 end loop;
6852 end if;
6853 end;
6854 end if;
6855 end if;
6857 -- Do not copy the associated node, which points to the generic copy
6858 -- of the aggregate.
6860 declare
6861 use Atree.Unchecked_Access;
6862 -- This code section is part of the implementation of an untyped
6863 -- tree traversal, so it needs direct access to node fields.
6865 begin
6866 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
6867 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
6868 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
6869 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
6870 end;
6872 -- Allocators do not have an identifier denoting the access type, so we
6873 -- must locate it through the expression to check whether the views are
6874 -- consistent.
6876 elsif Nkind (N) = N_Allocator
6877 and then Nkind (Expression (N)) = N_Qualified_Expression
6878 and then Is_Entity_Name (Subtype_Mark (Expression (N)))
6879 and then Instantiating
6880 then
6881 declare
6882 T : constant Node_Id :=
6883 Get_Associated_Node (Subtype_Mark (Expression (N)));
6884 Acc_T : Entity_Id;
6886 begin
6887 if Present (T) then
6889 -- Retrieve the allocator node in the generic copy
6891 Acc_T := Etype (Parent (Parent (T)));
6892 if Present (Acc_T)
6893 and then Is_Private_Type (Acc_T)
6894 then
6895 Switch_View (Acc_T);
6896 end if;
6897 end if;
6899 Copy_Descendants;
6900 end;
6902 -- For a proper body, we must catch the case of a proper body that
6903 -- replaces a stub. This represents the point at which a separate
6904 -- compilation unit, and hence template file, may be referenced, so we
6905 -- must make a new source instantiation entry for the template of the
6906 -- subunit, and ensure that all nodes in the subunit are adjusted using
6907 -- this new source instantiation entry.
6909 elsif Nkind (N) in N_Proper_Body then
6910 declare
6911 Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
6913 begin
6914 if Instantiating and then Was_Originally_Stub (N) then
6915 Create_Instantiation_Source
6916 (Instantiation_Node,
6917 Defining_Entity (N),
6918 False,
6919 S_Adjustment);
6920 end if;
6922 -- Now copy the fields of the proper body, using the new
6923 -- adjustment factor if one was needed as per test above.
6925 Copy_Descendants;
6927 -- Restore the original adjustment factor in case changed
6929 S_Adjustment := Save_Adjustment;
6930 end;
6932 -- Don't copy Ident or Comment pragmas, since the comment belongs to the
6933 -- generic unit, not to the instantiating unit.
6935 elsif Nkind (N) = N_Pragma and then Instantiating then
6936 declare
6937 Prag_Id : constant Pragma_Id := Get_Pragma_Id (N);
6938 begin
6939 if Prag_Id = Pragma_Ident or else Prag_Id = Pragma_Comment then
6940 New_N := Make_Null_Statement (Sloc (N));
6941 else
6942 Copy_Descendants;
6943 end if;
6944 end;
6946 elsif Nkind_In (N, N_Integer_Literal, N_Real_Literal) then
6948 -- No descendant fields need traversing
6950 null;
6952 elsif Nkind (N) = N_String_Literal
6953 and then Present (Etype (N))
6954 and then Instantiating
6955 then
6956 -- If the string is declared in an outer scope, the string_literal
6957 -- subtype created for it may have the wrong scope. We force the
6958 -- reanalysis of the constant to generate a new itype in the proper
6959 -- context.
6961 Set_Etype (New_N, Empty);
6962 Set_Analyzed (New_N, False);
6964 -- For the remaining nodes, copy their descendants recursively
6966 else
6967 Copy_Descendants;
6969 if Instantiating and then Nkind (N) = N_Subprogram_Body then
6970 Set_Generic_Parent (Specification (New_N), N);
6972 -- Should preserve Corresponding_Spec??? (12.3(14))
6973 end if;
6974 end if;
6976 return New_N;
6977 end Copy_Generic_Node;
6979 ----------------------------
6980 -- Denotes_Formal_Package --
6981 ----------------------------
6983 function Denotes_Formal_Package
6984 (Pack : Entity_Id;
6985 On_Exit : Boolean := False;
6986 Instance : Entity_Id := Empty) return Boolean
6988 Par : Entity_Id;
6989 Scop : constant Entity_Id := Scope (Pack);
6990 E : Entity_Id;
6992 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean;
6993 -- The package in question may be an actual for a previous formal
6994 -- package P of the current instance, so examine its actuals as well.
6995 -- This must be recursive over other formal packages.
6997 ----------------------------------
6998 -- Is_Actual_Of_Previous_Formal --
6999 ----------------------------------
7001 function Is_Actual_Of_Previous_Formal (P : Entity_Id) return Boolean is
7002 E1 : Entity_Id;
7004 begin
7005 E1 := First_Entity (P);
7006 while Present (E1) and then E1 /= Instance loop
7007 if Ekind (E1) = E_Package
7008 and then Nkind (Parent (E1)) = N_Package_Renaming_Declaration
7009 then
7010 if Renamed_Object (E1) = Pack then
7011 return True;
7013 elsif E1 = P or else Renamed_Object (E1) = P then
7014 return False;
7016 elsif Is_Actual_Of_Previous_Formal (E1) then
7017 return True;
7018 end if;
7019 end if;
7021 Next_Entity (E1);
7022 end loop;
7024 return False;
7025 end Is_Actual_Of_Previous_Formal;
7027 -- Start of processing for Denotes_Formal_Package
7029 begin
7030 if On_Exit then
7031 Par :=
7032 Instance_Envs.Table
7033 (Instance_Envs.Last).Instantiated_Parent.Act_Id;
7034 else
7035 Par := Current_Instantiated_Parent.Act_Id;
7036 end if;
7038 if Ekind (Scop) = E_Generic_Package
7039 or else Nkind (Unit_Declaration_Node (Scop)) =
7040 N_Generic_Subprogram_Declaration
7041 then
7042 return True;
7044 elsif Nkind (Original_Node (Unit_Declaration_Node (Pack))) =
7045 N_Formal_Package_Declaration
7046 then
7047 return True;
7049 elsif No (Par) then
7050 return False;
7052 else
7053 -- Check whether this package is associated with a formal package of
7054 -- the enclosing instantiation. Iterate over the list of renamings.
7056 E := First_Entity (Par);
7057 while Present (E) loop
7058 if Ekind (E) /= E_Package
7059 or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
7060 then
7061 null;
7063 elsif Renamed_Object (E) = Par then
7064 return False;
7066 elsif Renamed_Object (E) = Pack then
7067 return True;
7069 elsif Is_Actual_Of_Previous_Formal (E) then
7070 return True;
7072 end if;
7074 Next_Entity (E);
7075 end loop;
7077 return False;
7078 end if;
7079 end Denotes_Formal_Package;
7081 -----------------
7082 -- End_Generic --
7083 -----------------
7085 procedure End_Generic is
7086 begin
7087 -- ??? More things could be factored out in this routine. Should
7088 -- probably be done at a later stage.
7090 Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
7091 Generic_Flags.Decrement_Last;
7093 Expander_Mode_Restore;
7094 end End_Generic;
7096 -------------
7097 -- Earlier --
7098 -------------
7100 function Earlier (N1, N2 : Node_Id) return Boolean is
7101 procedure Find_Depth (P : in out Node_Id; D : in out Integer);
7102 -- Find distance from given node to enclosing compilation unit
7104 ----------------
7105 -- Find_Depth --
7106 ----------------
7108 procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
7109 begin
7110 while Present (P)
7111 and then Nkind (P) /= N_Compilation_Unit
7112 loop
7113 P := True_Parent (P);
7114 D := D + 1;
7115 end loop;
7116 end Find_Depth;
7118 -- Local declarations
7120 D1 : Integer := 0;
7121 D2 : Integer := 0;
7122 P1 : Node_Id := N1;
7123 P2 : Node_Id := N2;
7124 T1 : Source_Ptr;
7125 T2 : Source_Ptr;
7127 -- Start of processing for Earlier
7129 begin
7130 Find_Depth (P1, D1);
7131 Find_Depth (P2, D2);
7133 if P1 /= P2 then
7134 return False;
7135 else
7136 P1 := N1;
7137 P2 := N2;
7138 end if;
7140 while D1 > D2 loop
7141 P1 := True_Parent (P1);
7142 D1 := D1 - 1;
7143 end loop;
7145 while D2 > D1 loop
7146 P2 := True_Parent (P2);
7147 D2 := D2 - 1;
7148 end loop;
7150 -- At this point P1 and P2 are at the same distance from the root.
7151 -- We examine their parents until we find a common declarative list.
7152 -- If we reach the root, N1 and N2 do not descend from the same
7153 -- declarative list (e.g. one is nested in the declarative part and
7154 -- the other is in a block in the statement part) and the earlier
7155 -- one is already frozen.
7157 while not Is_List_Member (P1)
7158 or else not Is_List_Member (P2)
7159 or else List_Containing (P1) /= List_Containing (P2)
7160 loop
7161 P1 := True_Parent (P1);
7162 P2 := True_Parent (P2);
7164 if Nkind (Parent (P1)) = N_Subunit then
7165 P1 := Corresponding_Stub (Parent (P1));
7166 end if;
7168 if Nkind (Parent (P2)) = N_Subunit then
7169 P2 := Corresponding_Stub (Parent (P2));
7170 end if;
7172 if P1 = P2 then
7173 return False;
7174 end if;
7175 end loop;
7177 -- Expanded code usually shares the source location of the original
7178 -- construct it was generated for. This however may not necessarely
7179 -- reflect the true location of the code within the tree.
7181 -- Before comparing the slocs of the two nodes, make sure that we are
7182 -- working with correct source locations. Assume that P1 is to the left
7183 -- of P2. If either one does not come from source, traverse the common
7184 -- list heading towards the other node and locate the first source
7185 -- statement.
7187 -- P1 P2
7188 -- ----+===+===+--------------+===+===+----
7189 -- expanded code expanded code
7191 if not Comes_From_Source (P1) then
7192 while Present (P1) loop
7194 -- Neither P2 nor a source statement were located during the
7195 -- search. If we reach the end of the list, then P1 does not
7196 -- occur earlier than P2.
7198 -- ---->
7199 -- start --- P2 ----- P1 --- end
7201 if No (Next (P1)) then
7202 return False;
7204 -- We encounter P2 while going to the right of the list. This
7205 -- means that P1 does indeed appear earlier.
7207 -- ---->
7208 -- start --- P1 ===== P2 --- end
7209 -- expanded code in between
7211 elsif P1 = P2 then
7212 return True;
7214 -- No need to look any further since we have located a source
7215 -- statement.
7217 elsif Comes_From_Source (P1) then
7218 exit;
7219 end if;
7221 -- Keep going right
7223 Next (P1);
7224 end loop;
7225 end if;
7227 if not Comes_From_Source (P2) then
7228 while Present (P2) loop
7230 -- Neither P1 nor a source statement were located during the
7231 -- search. If we reach the start of the list, then P1 does not
7232 -- occur earlier than P2.
7234 -- <----
7235 -- start --- P2 --- P1 --- end
7237 if No (Prev (P2)) then
7238 return False;
7240 -- We encounter P1 while going to the left of the list. This
7241 -- means that P1 does indeed appear earlier.
7243 -- <----
7244 -- start --- P1 ===== P2 --- end
7245 -- expanded code in between
7247 elsif P2 = P1 then
7248 return True;
7250 -- No need to look any further since we have located a source
7251 -- statement.
7253 elsif Comes_From_Source (P2) then
7254 exit;
7255 end if;
7257 -- Keep going left
7259 Prev (P2);
7260 end loop;
7261 end if;
7263 -- At this point either both nodes came from source or we approximated
7264 -- their source locations through neighbouring source statements.
7266 T1 := Top_Level_Location (Sloc (P1));
7267 T2 := Top_Level_Location (Sloc (P2));
7269 -- When two nodes come from the same instance, they have identical top
7270 -- level locations. To determine proper relation within the tree, check
7271 -- their locations within the template.
7273 if T1 = T2 then
7274 return Sloc (P1) < Sloc (P2);
7276 -- The two nodes either come from unrelated instances or do not come
7277 -- from instantiated code at all.
7279 else
7280 return T1 < T2;
7281 end if;
7282 end Earlier;
7284 ----------------------
7285 -- Find_Actual_Type --
7286 ----------------------
7288 function Find_Actual_Type
7289 (Typ : Entity_Id;
7290 Gen_Type : Entity_Id) return Entity_Id
7292 Gen_Scope : constant Entity_Id := Scope (Gen_Type);
7293 T : Entity_Id;
7295 begin
7296 -- Special processing only applies to child units
7298 if not Is_Child_Unit (Gen_Scope) then
7299 return Get_Instance_Of (Typ);
7301 -- If designated or component type is itself a formal of the child unit,
7302 -- its instance is available.
7304 elsif Scope (Typ) = Gen_Scope then
7305 return Get_Instance_Of (Typ);
7307 -- If the array or access type is not declared in the parent unit,
7308 -- no special processing needed.
7310 elsif not Is_Generic_Type (Typ)
7311 and then Scope (Gen_Scope) /= Scope (Typ)
7312 then
7313 return Get_Instance_Of (Typ);
7315 -- Otherwise, retrieve designated or component type by visibility
7317 else
7318 T := Current_Entity (Typ);
7319 while Present (T) loop
7320 if In_Open_Scopes (Scope (T)) then
7321 return T;
7323 elsif Is_Generic_Actual_Type (T) then
7324 return T;
7325 end if;
7327 T := Homonym (T);
7328 end loop;
7330 return Typ;
7331 end if;
7332 end Find_Actual_Type;
7334 ----------------------------
7335 -- Freeze_Subprogram_Body --
7336 ----------------------------
7338 procedure Freeze_Subprogram_Body
7339 (Inst_Node : Node_Id;
7340 Gen_Body : Node_Id;
7341 Pack_Id : Entity_Id)
7343 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7344 Par : constant Entity_Id := Scope (Gen_Unit);
7345 E_G_Id : Entity_Id;
7346 Enc_G : Entity_Id;
7347 Enc_I : Node_Id;
7348 F_Node : Node_Id;
7350 function Enclosing_Package_Body (N : Node_Id) return Node_Id;
7351 -- Find innermost package body that encloses the given node, and which
7352 -- is not a compilation unit. Freeze nodes for the instance, or for its
7353 -- enclosing body, may be inserted after the enclosing_body of the
7354 -- generic unit. Used to determine proper placement of freeze node for
7355 -- both package and subprogram instances.
7357 function Package_Freeze_Node (B : Node_Id) return Node_Id;
7358 -- Find entity for given package body, and locate or create a freeze
7359 -- node for it.
7361 ----------------------------
7362 -- Enclosing_Package_Body --
7363 ----------------------------
7365 function Enclosing_Package_Body (N : Node_Id) return Node_Id is
7366 P : Node_Id;
7368 begin
7369 P := Parent (N);
7370 while Present (P)
7371 and then Nkind (Parent (P)) /= N_Compilation_Unit
7372 loop
7373 if Nkind (P) = N_Package_Body then
7374 if Nkind (Parent (P)) = N_Subunit then
7375 return Corresponding_Stub (Parent (P));
7376 else
7377 return P;
7378 end if;
7379 end if;
7381 P := True_Parent (P);
7382 end loop;
7384 return Empty;
7385 end Enclosing_Package_Body;
7387 -------------------------
7388 -- Package_Freeze_Node --
7389 -------------------------
7391 function Package_Freeze_Node (B : Node_Id) return Node_Id is
7392 Id : Entity_Id;
7394 begin
7395 if Nkind (B) = N_Package_Body then
7396 Id := Corresponding_Spec (B);
7397 else pragma Assert (Nkind (B) = N_Package_Body_Stub);
7398 Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
7399 end if;
7401 Ensure_Freeze_Node (Id);
7402 return Freeze_Node (Id);
7403 end Package_Freeze_Node;
7405 -- Start of processing of Freeze_Subprogram_Body
7407 begin
7408 -- If the instance and the generic body appear within the same unit, and
7409 -- the instance precedes the generic, the freeze node for the instance
7410 -- must appear after that of the generic. If the generic is nested
7411 -- within another instance I2, then current instance must be frozen
7412 -- after I2. In both cases, the freeze nodes are those of enclosing
7413 -- packages. Otherwise, the freeze node is placed at the end of the
7414 -- current declarative part.
7416 Enc_G := Enclosing_Package_Body (Gen_Body);
7417 Enc_I := Enclosing_Package_Body (Inst_Node);
7418 Ensure_Freeze_Node (Pack_Id);
7419 F_Node := Freeze_Node (Pack_Id);
7421 if Is_Generic_Instance (Par)
7422 and then Present (Freeze_Node (Par))
7423 and then In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
7424 then
7425 -- The parent was a premature instantiation. Insert freeze node at
7426 -- the end the current declarative part.
7428 if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
7429 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7431 -- Handle the following case:
7433 -- package Parent_Inst is new ...
7434 -- Parent_Inst []
7436 -- procedure P ... -- this body freezes Parent_Inst
7438 -- package Inst is new ...
7440 -- In this particular scenario, the freeze node for Inst must be
7441 -- inserted in the same manner as that of Parent_Inst - before the
7442 -- next source body or at the end of the declarative list (body not
7443 -- available). If body P did not exist and Parent_Inst was frozen
7444 -- after Inst, either by a body following Inst or at the end of the
7445 -- declarative region, the freeze node for Inst must be inserted
7446 -- after that of Parent_Inst. This relation is established by
7447 -- comparing the Slocs of Parent_Inst freeze node and Inst.
7449 elsif List_Containing (Get_Package_Instantiation_Node (Par)) =
7450 List_Containing (Inst_Node)
7451 and then Sloc (Freeze_Node (Par)) < Sloc (Inst_Node)
7452 then
7453 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7455 else
7456 Insert_After (Freeze_Node (Par), F_Node);
7457 end if;
7459 -- The body enclosing the instance should be frozen after the body that
7460 -- includes the generic, because the body of the instance may make
7461 -- references to entities therein. If the two are not in the same
7462 -- declarative part, or if the one enclosing the instance is frozen
7463 -- already, freeze the instance at the end of the current declarative
7464 -- part.
7466 elsif Is_Generic_Instance (Par)
7467 and then Present (Freeze_Node (Par))
7468 and then Present (Enc_I)
7469 then
7470 if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
7471 or else
7472 (Nkind (Enc_I) = N_Package_Body
7473 and then
7474 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
7475 then
7476 -- The enclosing package may contain several instances. Rather
7477 -- than computing the earliest point at which to insert its freeze
7478 -- node, we place it at the end of the declarative part of the
7479 -- parent of the generic.
7481 Insert_Freeze_Node_For_Instance
7482 (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
7483 end if;
7485 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7487 elsif Present (Enc_G)
7488 and then Present (Enc_I)
7489 and then Enc_G /= Enc_I
7490 and then Earlier (Inst_Node, Gen_Body)
7491 then
7492 if Nkind (Enc_G) = N_Package_Body then
7493 E_G_Id := Corresponding_Spec (Enc_G);
7494 else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
7495 E_G_Id :=
7496 Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
7497 end if;
7499 -- Freeze package that encloses instance, and place node after the
7500 -- package that encloses generic. If enclosing package is already
7501 -- frozen we have to assume it is at the proper place. This may be a
7502 -- potential ABE that requires dynamic checking. Do not add a freeze
7503 -- node if the package that encloses the generic is inside the body
7504 -- that encloses the instance, because the freeze node would be in
7505 -- the wrong scope. Additional contortions needed if the bodies are
7506 -- within a subunit.
7508 declare
7509 Enclosing_Body : Node_Id;
7511 begin
7512 if Nkind (Enc_I) = N_Package_Body_Stub then
7513 Enclosing_Body := Proper_Body (Unit (Library_Unit (Enc_I)));
7514 else
7515 Enclosing_Body := Enc_I;
7516 end if;
7518 if Parent (List_Containing (Enc_G)) /= Enclosing_Body then
7519 Insert_Freeze_Node_For_Instance
7520 (Enc_G, Package_Freeze_Node (Enc_I));
7521 end if;
7522 end;
7524 -- Freeze enclosing subunit before instance
7526 Ensure_Freeze_Node (E_G_Id);
7528 if not Is_List_Member (Freeze_Node (E_G_Id)) then
7529 Insert_After (Enc_G, Freeze_Node (E_G_Id));
7530 end if;
7532 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7534 else
7535 -- If none of the above, insert freeze node at the end of the current
7536 -- declarative part.
7538 Insert_Freeze_Node_For_Instance (Inst_Node, F_Node);
7539 end if;
7540 end Freeze_Subprogram_Body;
7542 ----------------
7543 -- Get_Gen_Id --
7544 ----------------
7546 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
7547 begin
7548 return Generic_Renamings.Table (E).Gen_Id;
7549 end Get_Gen_Id;
7551 ---------------------
7552 -- Get_Instance_Of --
7553 ---------------------
7555 function Get_Instance_Of (A : Entity_Id) return Entity_Id is
7556 Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
7558 begin
7559 if Res /= Assoc_Null then
7560 return Generic_Renamings.Table (Res).Act_Id;
7561 else
7562 -- On exit, entity is not instantiated: not a generic parameter, or
7563 -- else parameter of an inner generic unit.
7565 return A;
7566 end if;
7567 end Get_Instance_Of;
7569 ------------------------------------
7570 -- Get_Package_Instantiation_Node --
7571 ------------------------------------
7573 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
7574 Decl : Node_Id := Unit_Declaration_Node (A);
7575 Inst : Node_Id;
7577 begin
7578 -- If the Package_Instantiation attribute has been set on the package
7579 -- entity, then use it directly when it (or its Original_Node) refers
7580 -- to an N_Package_Instantiation node. In principle it should be
7581 -- possible to have this field set in all cases, which should be
7582 -- investigated, and would allow this function to be significantly
7583 -- simplified. ???
7585 Inst := Package_Instantiation (A);
7587 if Present (Inst) then
7588 if Nkind (Inst) = N_Package_Instantiation then
7589 return Inst;
7591 elsif Nkind (Original_Node (Inst)) = N_Package_Instantiation then
7592 return Original_Node (Inst);
7593 end if;
7594 end if;
7596 -- If the instantiation is a compilation unit that does not need body
7597 -- then the instantiation node has been rewritten as a package
7598 -- declaration for the instance, and we return the original node.
7600 -- If it is a compilation unit and the instance node has not been
7601 -- rewritten, then it is still the unit of the compilation. Finally, if
7602 -- a body is present, this is a parent of the main unit whose body has
7603 -- been compiled for inlining purposes, and the instantiation node has
7604 -- been rewritten with the instance body.
7606 -- Otherwise the instantiation node appears after the declaration. If
7607 -- the entity is a formal package, the declaration may have been
7608 -- rewritten as a generic declaration (in the case of a formal with box)
7609 -- or left as a formal package declaration if it has actuals, and is
7610 -- found with a forward search.
7612 if Nkind (Parent (Decl)) = N_Compilation_Unit then
7613 if Nkind (Decl) = N_Package_Declaration
7614 and then Present (Corresponding_Body (Decl))
7615 then
7616 Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
7617 end if;
7619 if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
7620 return Original_Node (Decl);
7621 else
7622 return Unit (Parent (Decl));
7623 end if;
7625 elsif Nkind (Decl) = N_Package_Declaration
7626 and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
7627 then
7628 return Original_Node (Decl);
7630 else
7631 Inst := Next (Decl);
7632 while not Nkind_In (Inst, N_Package_Instantiation,
7633 N_Formal_Package_Declaration)
7634 loop
7635 Next (Inst);
7636 end loop;
7638 return Inst;
7639 end if;
7640 end Get_Package_Instantiation_Node;
7642 ------------------------
7643 -- Has_Been_Exchanged --
7644 ------------------------
7646 function Has_Been_Exchanged (E : Entity_Id) return Boolean is
7647 Next : Elmt_Id;
7649 begin
7650 Next := First_Elmt (Exchanged_Views);
7651 while Present (Next) loop
7652 if Full_View (Node (Next)) = E then
7653 return True;
7654 end if;
7656 Next_Elmt (Next);
7657 end loop;
7659 return False;
7660 end Has_Been_Exchanged;
7662 ----------
7663 -- Hash --
7664 ----------
7666 function Hash (F : Entity_Id) return HTable_Range is
7667 begin
7668 return HTable_Range (F mod HTable_Size);
7669 end Hash;
7671 ------------------------
7672 -- Hide_Current_Scope --
7673 ------------------------
7675 procedure Hide_Current_Scope is
7676 C : constant Entity_Id := Current_Scope;
7677 E : Entity_Id;
7679 begin
7680 Set_Is_Hidden_Open_Scope (C);
7682 E := First_Entity (C);
7683 while Present (E) loop
7684 if Is_Immediately_Visible (E) then
7685 Set_Is_Immediately_Visible (E, False);
7686 Append_Elmt (E, Hidden_Entities);
7687 end if;
7689 Next_Entity (E);
7690 end loop;
7692 -- Make the scope name invisible as well. This is necessary, but might
7693 -- conflict with calls to Rtsfind later on, in case the scope is a
7694 -- predefined one. There is no clean solution to this problem, so for
7695 -- now we depend on the user not redefining Standard itself in one of
7696 -- the parent units.
7698 if Is_Immediately_Visible (C) and then C /= Standard_Standard then
7699 Set_Is_Immediately_Visible (C, False);
7700 Append_Elmt (C, Hidden_Entities);
7701 end if;
7703 end Hide_Current_Scope;
7705 --------------
7706 -- Init_Env --
7707 --------------
7709 procedure Init_Env is
7710 Saved : Instance_Env;
7712 begin
7713 Saved.Instantiated_Parent := Current_Instantiated_Parent;
7714 Saved.Exchanged_Views := Exchanged_Views;
7715 Saved.Hidden_Entities := Hidden_Entities;
7716 Saved.Current_Sem_Unit := Current_Sem_Unit;
7717 Saved.Parent_Unit_Visible := Parent_Unit_Visible;
7718 Saved.Instance_Parent_Unit := Instance_Parent_Unit;
7720 -- Save configuration switches. These may be reset if the unit is a
7721 -- predefined unit, and the current mode is not Ada 2005.
7723 Save_Opt_Config_Switches (Saved.Switches);
7725 Instance_Envs.Append (Saved);
7727 Exchanged_Views := New_Elmt_List;
7728 Hidden_Entities := New_Elmt_List;
7730 -- Make dummy entry for Instantiated parent. If generic unit is legal,
7731 -- this is set properly in Set_Instance_Env.
7733 Current_Instantiated_Parent :=
7734 (Current_Scope, Current_Scope, Assoc_Null);
7735 end Init_Env;
7737 ------------------------------
7738 -- In_Same_Declarative_Part --
7739 ------------------------------
7741 function In_Same_Declarative_Part
7742 (F_Node : Node_Id;
7743 Inst : Node_Id) return Boolean
7745 Decls : constant Node_Id := Parent (F_Node);
7746 Nod : Node_Id := Parent (Inst);
7748 begin
7749 while Present (Nod) loop
7750 if Nod = Decls then
7751 return True;
7753 elsif Nkind_In (Nod, N_Subprogram_Body,
7754 N_Package_Body,
7755 N_Package_Declaration,
7756 N_Task_Body,
7757 N_Protected_Body,
7758 N_Block_Statement)
7759 then
7760 return False;
7762 elsif Nkind (Nod) = N_Subunit then
7763 Nod := Corresponding_Stub (Nod);
7765 elsif Nkind (Nod) = N_Compilation_Unit then
7766 return False;
7768 else
7769 Nod := Parent (Nod);
7770 end if;
7771 end loop;
7773 return False;
7774 end In_Same_Declarative_Part;
7776 ---------------------
7777 -- In_Main_Context --
7778 ---------------------
7780 function In_Main_Context (E : Entity_Id) return Boolean is
7781 Context : List_Id;
7782 Clause : Node_Id;
7783 Nam : Node_Id;
7785 begin
7786 if not Is_Compilation_Unit (E)
7787 or else Ekind (E) /= E_Package
7788 or else In_Private_Part (E)
7789 then
7790 return False;
7791 end if;
7793 Context := Context_Items (Cunit (Main_Unit));
7795 Clause := First (Context);
7796 while Present (Clause) loop
7797 if Nkind (Clause) = N_With_Clause then
7798 Nam := Name (Clause);
7800 -- If the current scope is part of the context of the main unit,
7801 -- analysis of the corresponding with_clause is not complete, and
7802 -- the entity is not set. We use the Chars field directly, which
7803 -- might produce false positives in rare cases, but guarantees
7804 -- that we produce all the instance bodies we will need.
7806 if (Is_Entity_Name (Nam) and then Chars (Nam) = Chars (E))
7807 or else (Nkind (Nam) = N_Selected_Component
7808 and then Chars (Selector_Name (Nam)) = Chars (E))
7809 then
7810 return True;
7811 end if;
7812 end if;
7814 Next (Clause);
7815 end loop;
7817 return False;
7818 end In_Main_Context;
7820 ---------------------
7821 -- Inherit_Context --
7822 ---------------------
7824 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
7825 Current_Context : List_Id;
7826 Current_Unit : Node_Id;
7827 Item : Node_Id;
7828 New_I : Node_Id;
7830 Clause : Node_Id;
7831 OK : Boolean;
7832 Lib_Unit : Node_Id;
7834 begin
7835 if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
7837 -- The inherited context is attached to the enclosing compilation
7838 -- unit. This is either the main unit, or the declaration for the
7839 -- main unit (in case the instantiation appears within the package
7840 -- declaration and the main unit is its body).
7842 Current_Unit := Parent (Inst);
7843 while Present (Current_Unit)
7844 and then Nkind (Current_Unit) /= N_Compilation_Unit
7845 loop
7846 Current_Unit := Parent (Current_Unit);
7847 end loop;
7849 Current_Context := Context_Items (Current_Unit);
7851 Item := First (Context_Items (Parent (Gen_Decl)));
7852 while Present (Item) loop
7853 if Nkind (Item) = N_With_Clause then
7854 Lib_Unit := Library_Unit (Item);
7856 -- Take care to prevent direct cyclic with's
7858 if Lib_Unit /= Current_Unit then
7860 -- Do not add a unit if it is already in the context
7862 Clause := First (Current_Context);
7863 OK := True;
7864 while Present (Clause) loop
7865 if Nkind (Clause) = N_With_Clause and then
7866 Library_Unit (Clause) = Lib_Unit
7867 then
7868 OK := False;
7869 exit;
7870 end if;
7872 Next (Clause);
7873 end loop;
7875 if OK then
7876 New_I := New_Copy (Item);
7877 Set_Implicit_With (New_I, True);
7878 Set_Implicit_With_From_Instantiation (New_I, True);
7879 Append (New_I, Current_Context);
7880 end if;
7881 end if;
7882 end if;
7884 Next (Item);
7885 end loop;
7886 end if;
7887 end Inherit_Context;
7889 ----------------
7890 -- Initialize --
7891 ----------------
7893 procedure Initialize is
7894 begin
7895 Generic_Renamings.Init;
7896 Instance_Envs.Init;
7897 Generic_Flags.Init;
7898 Generic_Renamings_HTable.Reset;
7899 Circularity_Detected := False;
7900 Exchanged_Views := No_Elist;
7901 Hidden_Entities := No_Elist;
7902 end Initialize;
7904 -------------------------------------
7905 -- Insert_Freeze_Node_For_Instance --
7906 -------------------------------------
7908 procedure Insert_Freeze_Node_For_Instance
7909 (N : Node_Id;
7910 F_Node : Node_Id)
7912 Decl : Node_Id;
7913 Decls : List_Id;
7914 Inst : Entity_Id;
7915 Par_N : Node_Id;
7917 function Enclosing_Body (N : Node_Id) return Node_Id;
7918 -- Find enclosing package or subprogram body, if any. Freeze node may
7919 -- be placed at end of current declarative list if previous instance
7920 -- and current one have different enclosing bodies.
7922 function Previous_Instance (Gen : Entity_Id) return Entity_Id;
7923 -- Find the local instance, if any, that declares the generic that is
7924 -- being instantiated. If present, the freeze node for this instance
7925 -- must follow the freeze node for the previous instance.
7927 --------------------
7928 -- Enclosing_Body --
7929 --------------------
7931 function Enclosing_Body (N : Node_Id) return Node_Id is
7932 P : Node_Id;
7934 begin
7935 P := Parent (N);
7936 while Present (P)
7937 and then Nkind (Parent (P)) /= N_Compilation_Unit
7938 loop
7939 if Nkind_In (P, N_Package_Body, N_Subprogram_Body) then
7940 if Nkind (Parent (P)) = N_Subunit then
7941 return Corresponding_Stub (Parent (P));
7942 else
7943 return P;
7944 end if;
7945 end if;
7947 P := True_Parent (P);
7948 end loop;
7950 return Empty;
7951 end Enclosing_Body;
7953 -----------------------
7954 -- Previous_Instance --
7955 -----------------------
7957 function Previous_Instance (Gen : Entity_Id) return Entity_Id is
7958 S : Entity_Id;
7960 begin
7961 S := Scope (Gen);
7962 while Present (S)
7963 and then S /= Standard_Standard
7964 loop
7965 if Is_Generic_Instance (S)
7966 and then In_Same_Source_Unit (S, N)
7967 then
7968 return S;
7969 end if;
7971 S := Scope (S);
7972 end loop;
7974 return Empty;
7975 end Previous_Instance;
7977 -- Start of processing for Insert_Freeze_Node_For_Instance
7979 begin
7980 if not Is_List_Member (F_Node) then
7981 Decl := N;
7982 Decls := List_Containing (N);
7983 Inst := Entity (F_Node);
7984 Par_N := Parent (Decls);
7986 -- When processing a subprogram instantiation, utilize the actual
7987 -- subprogram instantiation rather than its package wrapper as it
7988 -- carries all the context information.
7990 if Is_Wrapper_Package (Inst) then
7991 Inst := Related_Instance (Inst);
7992 end if;
7994 -- If this is a package instance, check whether the generic is
7995 -- declared in a previous instance and the current instance is
7996 -- not within the previous one.
7998 if Present (Generic_Parent (Parent (Inst)))
7999 and then Is_In_Main_Unit (N)
8000 then
8001 declare
8002 Enclosing_N : constant Node_Id := Enclosing_Body (N);
8003 Par_I : constant Entity_Id :=
8004 Previous_Instance
8005 (Generic_Parent (Parent (Inst)));
8006 Scop : Entity_Id;
8008 begin
8009 if Present (Par_I)
8010 and then Earlier (N, Freeze_Node (Par_I))
8011 then
8012 Scop := Scope (Inst);
8014 -- If the current instance is within the one that contains
8015 -- the generic, the freeze node for the current one must
8016 -- appear in the current declarative part. Ditto, if the
8017 -- current instance is within another package instance or
8018 -- within a body that does not enclose the current instance.
8019 -- In these three cases the freeze node of the previous
8020 -- instance is not relevant.
8022 while Present (Scop)
8023 and then Scop /= Standard_Standard
8024 loop
8025 exit when Scop = Par_I
8026 or else
8027 (Is_Generic_Instance (Scop)
8028 and then Scope_Depth (Scop) > Scope_Depth (Par_I));
8029 Scop := Scope (Scop);
8030 end loop;
8032 -- Previous instance encloses current instance
8034 if Scop = Par_I then
8035 null;
8037 -- If the next node is a source body we must freeze in
8038 -- the current scope as well.
8040 elsif Present (Next (N))
8041 and then Nkind_In (Next (N),
8042 N_Subprogram_Body, N_Package_Body)
8043 and then Comes_From_Source (Next (N))
8044 then
8045 null;
8047 -- Current instance is within an unrelated instance
8049 elsif Is_Generic_Instance (Scop) then
8050 null;
8052 -- Current instance is within an unrelated body
8054 elsif Present (Enclosing_N)
8055 and then Enclosing_N /= Enclosing_Body (Par_I)
8056 then
8057 null;
8059 else
8060 Insert_After (Freeze_Node (Par_I), F_Node);
8061 return;
8062 end if;
8063 end if;
8064 end;
8065 end if;
8067 -- When the instantiation occurs in a package declaration, append the
8068 -- freeze node to the private declarations (if any).
8070 if Nkind (Par_N) = N_Package_Specification
8071 and then Decls = Visible_Declarations (Par_N)
8072 and then Present (Private_Declarations (Par_N))
8073 and then not Is_Empty_List (Private_Declarations (Par_N))
8074 then
8075 Decls := Private_Declarations (Par_N);
8076 Decl := First (Decls);
8077 end if;
8079 -- Determine the proper freeze point of a package instantiation. We
8080 -- adhere to the general rule of a package or subprogram body causing
8081 -- freezing of anything before it in the same declarative region. In
8082 -- this case, the proper freeze point of a package instantiation is
8083 -- before the first source body which follows, or before a stub. This
8084 -- ensures that entities coming from the instance are already frozen
8085 -- and usable in source bodies.
8087 if Nkind (Par_N) /= N_Package_Declaration
8088 and then Ekind (Inst) = E_Package
8089 and then Is_Generic_Instance (Inst)
8090 and then
8091 not In_Same_Source_Unit (Generic_Parent (Parent (Inst)), Inst)
8092 then
8093 while Present (Decl) loop
8094 if (Nkind (Decl) in N_Unit_Body
8095 or else
8096 Nkind (Decl) in N_Body_Stub)
8097 and then Comes_From_Source (Decl)
8098 then
8099 Insert_Before (Decl, F_Node);
8100 return;
8101 end if;
8103 Next (Decl);
8104 end loop;
8105 end if;
8107 -- In a package declaration, or if no previous body, insert at end
8108 -- of list.
8110 Set_Sloc (F_Node, Sloc (Last (Decls)));
8111 Insert_After (Last (Decls), F_Node);
8112 end if;
8113 end Insert_Freeze_Node_For_Instance;
8115 ------------------
8116 -- Install_Body --
8117 ------------------
8119 procedure Install_Body
8120 (Act_Body : Node_Id;
8121 N : Node_Id;
8122 Gen_Body : Node_Id;
8123 Gen_Decl : Node_Id)
8125 Act_Id : constant Entity_Id := Corresponding_Spec (Act_Body);
8126 Act_Unit : constant Node_Id := Unit (Cunit (Get_Source_Unit (N)));
8127 Gen_Id : constant Entity_Id := Corresponding_Spec (Gen_Body);
8128 Par : constant Entity_Id := Scope (Gen_Id);
8129 Gen_Unit : constant Node_Id :=
8130 Unit (Cunit (Get_Source_Unit (Gen_Decl)));
8131 Orig_Body : Node_Id := Gen_Body;
8132 F_Node : Node_Id;
8133 Body_Unit : Node_Id;
8135 Must_Delay : Boolean;
8137 function Enclosing_Subp (Id : Entity_Id) return Entity_Id;
8138 -- Find subprogram (if any) that encloses instance and/or generic body
8140 function True_Sloc (N : Node_Id) return Source_Ptr;
8141 -- If the instance is nested inside a generic unit, the Sloc of the
8142 -- instance indicates the place of the original definition, not the
8143 -- point of the current enclosing instance. Pending a better usage of
8144 -- Slocs to indicate instantiation places, we determine the place of
8145 -- origin of a node by finding the maximum sloc of any ancestor node.
8146 -- Why is this not equivalent to Top_Level_Location ???
8148 --------------------
8149 -- Enclosing_Subp --
8150 --------------------
8152 function Enclosing_Subp (Id : Entity_Id) return Entity_Id is
8153 Scop : Entity_Id;
8155 begin
8156 Scop := Scope (Id);
8157 while Scop /= Standard_Standard
8158 and then not Is_Overloadable (Scop)
8159 loop
8160 Scop := Scope (Scop);
8161 end loop;
8163 return Scop;
8164 end Enclosing_Subp;
8166 ---------------
8167 -- True_Sloc --
8168 ---------------
8170 function True_Sloc (N : Node_Id) return Source_Ptr is
8171 Res : Source_Ptr;
8172 N1 : Node_Id;
8174 begin
8175 Res := Sloc (N);
8176 N1 := N;
8177 while Present (N1) and then N1 /= Act_Unit loop
8178 if Sloc (N1) > Res then
8179 Res := Sloc (N1);
8180 end if;
8182 N1 := Parent (N1);
8183 end loop;
8185 return Res;
8186 end True_Sloc;
8188 -- Start of processing for Install_Body
8190 begin
8191 -- If the body is a subunit, the freeze point is the corresponding stub
8192 -- in the current compilation, not the subunit itself.
8194 if Nkind (Parent (Gen_Body)) = N_Subunit then
8195 Orig_Body := Corresponding_Stub (Parent (Gen_Body));
8196 else
8197 Orig_Body := Gen_Body;
8198 end if;
8200 Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
8202 -- If the instantiation and the generic definition appear in the same
8203 -- package declaration, this is an early instantiation. If they appear
8204 -- in the same declarative part, it is an early instantiation only if
8205 -- the generic body appears textually later, and the generic body is
8206 -- also in the main unit.
8208 -- If instance is nested within a subprogram, and the generic body is
8209 -- not, the instance is delayed because the enclosing body is. If
8210 -- instance and body are within the same scope, or the same sub-
8211 -- program body, indicate explicitly that the instance is delayed.
8213 Must_Delay :=
8214 (Gen_Unit = Act_Unit
8215 and then (Nkind_In (Gen_Unit, N_Package_Declaration,
8216 N_Generic_Package_Declaration)
8217 or else (Gen_Unit = Body_Unit
8218 and then True_Sloc (N) < Sloc (Orig_Body)))
8219 and then Is_In_Main_Unit (Gen_Unit)
8220 and then (Scope (Act_Id) = Scope (Gen_Id)
8221 or else
8222 Enclosing_Subp (Act_Id) = Enclosing_Subp (Gen_Id)));
8224 -- If this is an early instantiation, the freeze node is placed after
8225 -- the generic body. Otherwise, if the generic appears in an instance,
8226 -- we cannot freeze the current instance until the outer one is frozen.
8227 -- This is only relevant if the current instance is nested within some
8228 -- inner scope not itself within the outer instance. If this scope is
8229 -- a package body in the same declarative part as the outer instance,
8230 -- then that body needs to be frozen after the outer instance. Finally,
8231 -- if no delay is needed, we place the freeze node at the end of the
8232 -- current declarative part.
8234 if Expander_Active then
8235 Ensure_Freeze_Node (Act_Id);
8236 F_Node := Freeze_Node (Act_Id);
8238 if Must_Delay then
8239 Insert_After (Orig_Body, F_Node);
8241 elsif Is_Generic_Instance (Par)
8242 and then Present (Freeze_Node (Par))
8243 and then Scope (Act_Id) /= Par
8244 then
8245 -- Freeze instance of inner generic after instance of enclosing
8246 -- generic.
8248 if In_Same_Declarative_Part (Freeze_Node (Par), N) then
8250 -- Handle the following case:
8252 -- package Parent_Inst is new ...
8253 -- Parent_Inst []
8255 -- procedure P ... -- this body freezes Parent_Inst
8257 -- package Inst is new ...
8259 -- In this particular scenario, the freeze node for Inst must
8260 -- be inserted in the same manner as that of Parent_Inst -
8261 -- before the next source body or at the end of the declarative
8262 -- list (body not available). If body P did not exist and
8263 -- Parent_Inst was frozen after Inst, either by a body
8264 -- following Inst or at the end of the declarative region, the
8265 -- freeze node for Inst must be inserted after that of
8266 -- Parent_Inst. This relation is established by comparing the
8267 -- Slocs of Parent_Inst freeze node and Inst.
8269 if List_Containing (Get_Package_Instantiation_Node (Par)) =
8270 List_Containing (N)
8271 and then Sloc (Freeze_Node (Par)) < Sloc (N)
8272 then
8273 Insert_Freeze_Node_For_Instance (N, F_Node);
8274 else
8275 Insert_After (Freeze_Node (Par), F_Node);
8276 end if;
8278 -- Freeze package enclosing instance of inner generic after
8279 -- instance of enclosing generic.
8281 elsif Nkind_In (Parent (N), N_Package_Body, N_Subprogram_Body)
8282 and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
8283 then
8284 declare
8285 Enclosing : Entity_Id;
8287 begin
8288 Enclosing := Corresponding_Spec (Parent (N));
8290 if No (Enclosing) then
8291 Enclosing := Defining_Entity (Parent (N));
8292 end if;
8294 Insert_Freeze_Node_For_Instance (N, F_Node);
8295 Ensure_Freeze_Node (Enclosing);
8297 if not Is_List_Member (Freeze_Node (Enclosing)) then
8299 -- The enclosing context is a subunit, insert the freeze
8300 -- node after the stub.
8302 if Nkind (Parent (Parent (N))) = N_Subunit then
8303 Insert_Freeze_Node_For_Instance
8304 (Corresponding_Stub (Parent (Parent (N))),
8305 Freeze_Node (Enclosing));
8307 -- The enclosing context is a package with a stub body
8308 -- which has already been replaced by the real body.
8309 -- Insert the freeze node after the actual body.
8311 elsif Ekind (Enclosing) = E_Package
8312 and then Present (Body_Entity (Enclosing))
8313 and then Was_Originally_Stub
8314 (Parent (Body_Entity (Enclosing)))
8315 then
8316 Insert_Freeze_Node_For_Instance
8317 (Parent (Body_Entity (Enclosing)),
8318 Freeze_Node (Enclosing));
8320 -- The parent instance has been frozen before the body of
8321 -- the enclosing package, insert the freeze node after
8322 -- the body.
8324 elsif List_Containing (Freeze_Node (Par)) =
8325 List_Containing (Parent (N))
8326 and then Sloc (Freeze_Node (Par)) < Sloc (Parent (N))
8327 then
8328 Insert_Freeze_Node_For_Instance
8329 (Parent (N), Freeze_Node (Enclosing));
8331 else
8332 Insert_After
8333 (Freeze_Node (Par), Freeze_Node (Enclosing));
8334 end if;
8335 end if;
8336 end;
8338 else
8339 Insert_Freeze_Node_For_Instance (N, F_Node);
8340 end if;
8342 else
8343 Insert_Freeze_Node_For_Instance (N, F_Node);
8344 end if;
8345 end if;
8347 Set_Is_Frozen (Act_Id);
8348 Insert_Before (N, Act_Body);
8349 Mark_Rewrite_Insertion (Act_Body);
8350 end Install_Body;
8352 -----------------------------
8353 -- Install_Formal_Packages --
8354 -----------------------------
8356 procedure Install_Formal_Packages (Par : Entity_Id) is
8357 E : Entity_Id;
8358 Gen : Entity_Id;
8359 Gen_E : Entity_Id := Empty;
8361 begin
8362 E := First_Entity (Par);
8364 -- If we are installing an instance parent, locate the formal packages
8365 -- of its generic parent.
8367 if Is_Generic_Instance (Par) then
8368 Gen := Generic_Parent (Specification (Unit_Declaration_Node (Par)));
8369 Gen_E := First_Entity (Gen);
8370 end if;
8372 while Present (E) loop
8373 if Ekind (E) = E_Package
8374 and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
8375 then
8376 -- If this is the renaming for the parent instance, done
8378 if Renamed_Object (E) = Par then
8379 exit;
8381 -- The visibility of a formal of an enclosing generic is already
8382 -- correct.
8384 elsif Denotes_Formal_Package (E) then
8385 null;
8387 elsif Present (Associated_Formal_Package (E)) then
8388 Check_Generic_Actuals (Renamed_Object (E), True);
8389 Set_Is_Hidden (E, False);
8391 -- Find formal package in generic unit that corresponds to
8392 -- (instance of) formal package in instance.
8394 while Present (Gen_E) and then Chars (Gen_E) /= Chars (E) loop
8395 Next_Entity (Gen_E);
8396 end loop;
8398 if Present (Gen_E) then
8399 Map_Formal_Package_Entities (Gen_E, E);
8400 end if;
8401 end if;
8402 end if;
8404 Next_Entity (E);
8405 if Present (Gen_E) then
8406 Next_Entity (Gen_E);
8407 end if;
8408 end loop;
8409 end Install_Formal_Packages;
8411 --------------------
8412 -- Install_Parent --
8413 --------------------
8415 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
8416 Ancestors : constant Elist_Id := New_Elmt_List;
8417 S : constant Entity_Id := Current_Scope;
8418 Inst_Par : Entity_Id;
8419 First_Par : Entity_Id;
8420 Inst_Node : Node_Id;
8421 Gen_Par : Entity_Id;
8422 First_Gen : Entity_Id;
8423 Elmt : Elmt_Id;
8425 procedure Install_Noninstance_Specs (Par : Entity_Id);
8426 -- Install the scopes of noninstance parent units ending with Par
8428 procedure Install_Spec (Par : Entity_Id);
8429 -- The child unit is within the declarative part of the parent, so the
8430 -- declarations within the parent are immediately visible.
8432 -------------------------------
8433 -- Install_Noninstance_Specs --
8434 -------------------------------
8436 procedure Install_Noninstance_Specs (Par : Entity_Id) is
8437 begin
8438 if Present (Par)
8439 and then Par /= Standard_Standard
8440 and then not In_Open_Scopes (Par)
8441 then
8442 Install_Noninstance_Specs (Scope (Par));
8443 Install_Spec (Par);
8444 end if;
8445 end Install_Noninstance_Specs;
8447 ------------------
8448 -- Install_Spec --
8449 ------------------
8451 procedure Install_Spec (Par : Entity_Id) is
8452 Spec : constant Node_Id :=
8453 Specification (Unit_Declaration_Node (Par));
8455 begin
8456 -- If this parent of the child instance is a top-level unit,
8457 -- then record the unit and its visibility for later resetting in
8458 -- Remove_Parent. We exclude units that are generic instances, as we
8459 -- only want to record this information for the ultimate top-level
8460 -- noninstance parent (is that always correct???).
8462 if Scope (Par) = Standard_Standard
8463 and then not Is_Generic_Instance (Par)
8464 then
8465 Parent_Unit_Visible := Is_Immediately_Visible (Par);
8466 Instance_Parent_Unit := Par;
8467 end if;
8469 -- Open the parent scope and make it and its declarations visible.
8470 -- If this point is not within a body, then only the visible
8471 -- declarations should be made visible, and installation of the
8472 -- private declarations is deferred until the appropriate point
8473 -- within analysis of the spec being instantiated (see the handling
8474 -- of parent visibility in Analyze_Package_Specification). This is
8475 -- relaxed in the case where the parent unit is Ada.Tags, to avoid
8476 -- private view problems that occur when compiling instantiations of
8477 -- a generic child of that package (Generic_Dispatching_Constructor).
8478 -- If the instance freezes a tagged type, inlinings of operations
8479 -- from Ada.Tags may need the full view of type Tag. If inlining took
8480 -- proper account of establishing visibility of inlined subprograms'
8481 -- parents then it should be possible to remove this
8482 -- special check. ???
8484 Push_Scope (Par);
8485 Set_Is_Immediately_Visible (Par);
8486 Install_Visible_Declarations (Par);
8487 Set_Use (Visible_Declarations (Spec));
8489 if In_Body or else Is_RTU (Par, Ada_Tags) then
8490 Install_Private_Declarations (Par);
8491 Set_Use (Private_Declarations (Spec));
8492 end if;
8493 end Install_Spec;
8495 -- Start of processing for Install_Parent
8497 begin
8498 -- We need to install the parent instance to compile the instantiation
8499 -- of the child, but the child instance must appear in the current
8500 -- scope. Given that we cannot place the parent above the current scope
8501 -- in the scope stack, we duplicate the current scope and unstack both
8502 -- after the instantiation is complete.
8504 -- If the parent is itself the instantiation of a child unit, we must
8505 -- also stack the instantiation of its parent, and so on. Each such
8506 -- ancestor is the prefix of the name in a prior instantiation.
8508 -- If this is a nested instance, the parent unit itself resolves to
8509 -- a renaming of the parent instance, whose declaration we need.
8511 -- Finally, the parent may be a generic (not an instance) when the
8512 -- child unit appears as a formal package.
8514 Inst_Par := P;
8516 if Present (Renamed_Entity (Inst_Par)) then
8517 Inst_Par := Renamed_Entity (Inst_Par);
8518 end if;
8520 First_Par := Inst_Par;
8522 Gen_Par :=
8523 Generic_Parent (Specification (Unit_Declaration_Node (Inst_Par)));
8525 First_Gen := Gen_Par;
8527 while Present (Gen_Par)
8528 and then Is_Child_Unit (Gen_Par)
8529 loop
8530 -- Load grandparent instance as well
8532 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
8534 if Nkind (Name (Inst_Node)) = N_Expanded_Name then
8535 Inst_Par := Entity (Prefix (Name (Inst_Node)));
8537 if Present (Renamed_Entity (Inst_Par)) then
8538 Inst_Par := Renamed_Entity (Inst_Par);
8539 end if;
8541 Gen_Par :=
8542 Generic_Parent
8543 (Specification (Unit_Declaration_Node (Inst_Par)));
8545 if Present (Gen_Par) then
8546 Prepend_Elmt (Inst_Par, Ancestors);
8548 else
8549 -- Parent is not the name of an instantiation
8551 Install_Noninstance_Specs (Inst_Par);
8552 exit;
8553 end if;
8555 else
8556 -- Previous error
8558 exit;
8559 end if;
8560 end loop;
8562 if Present (First_Gen) then
8563 Append_Elmt (First_Par, Ancestors);
8564 else
8565 Install_Noninstance_Specs (First_Par);
8566 end if;
8568 if not Is_Empty_Elmt_List (Ancestors) then
8569 Elmt := First_Elmt (Ancestors);
8570 while Present (Elmt) loop
8571 Install_Spec (Node (Elmt));
8572 Install_Formal_Packages (Node (Elmt));
8573 Next_Elmt (Elmt);
8574 end loop;
8575 end if;
8577 if not In_Body then
8578 Push_Scope (S);
8579 end if;
8580 end Install_Parent;
8582 -------------------------------
8583 -- Install_Hidden_Primitives --
8584 -------------------------------
8586 procedure Install_Hidden_Primitives
8587 (Prims_List : in out Elist_Id;
8588 Gen_T : Entity_Id;
8589 Act_T : Entity_Id)
8591 Elmt : Elmt_Id;
8592 List : Elist_Id := No_Elist;
8593 Prim_G_Elmt : Elmt_Id;
8594 Prim_A_Elmt : Elmt_Id;
8595 Prim_G : Node_Id;
8596 Prim_A : Node_Id;
8598 begin
8599 -- No action needed in case of serious errors because we cannot trust
8600 -- in the order of primitives
8602 if Serious_Errors_Detected > 0 then
8603 return;
8605 -- No action possible if we don't have available the list of primitive
8606 -- operations
8608 elsif No (Gen_T)
8609 or else not Is_Record_Type (Gen_T)
8610 or else not Is_Tagged_Type (Gen_T)
8611 or else not Is_Record_Type (Act_T)
8612 or else not Is_Tagged_Type (Act_T)
8613 then
8614 return;
8616 -- There is no need to handle interface types since their primitives
8617 -- cannot be hidden
8619 elsif Is_Interface (Gen_T) then
8620 return;
8621 end if;
8623 Prim_G_Elmt := First_Elmt (Primitive_Operations (Gen_T));
8625 if not Is_Class_Wide_Type (Act_T) then
8626 Prim_A_Elmt := First_Elmt (Primitive_Operations (Act_T));
8627 else
8628 Prim_A_Elmt := First_Elmt (Primitive_Operations (Root_Type (Act_T)));
8629 end if;
8631 loop
8632 -- Skip predefined primitives in the generic formal
8634 while Present (Prim_G_Elmt)
8635 and then Is_Predefined_Dispatching_Operation (Node (Prim_G_Elmt))
8636 loop
8637 Next_Elmt (Prim_G_Elmt);
8638 end loop;
8640 -- Skip predefined primitives in the generic actual
8642 while Present (Prim_A_Elmt)
8643 and then Is_Predefined_Dispatching_Operation (Node (Prim_A_Elmt))
8644 loop
8645 Next_Elmt (Prim_A_Elmt);
8646 end loop;
8648 exit when No (Prim_G_Elmt) or else No (Prim_A_Elmt);
8650 Prim_G := Node (Prim_G_Elmt);
8651 Prim_A := Node (Prim_A_Elmt);
8653 -- There is no need to handle interface primitives because their
8654 -- primitives are not hidden
8656 exit when Present (Interface_Alias (Prim_G));
8658 -- Here we install one hidden primitive
8660 if Chars (Prim_G) /= Chars (Prim_A)
8661 and then Has_Suffix (Prim_A, 'P')
8662 and then Remove_Suffix (Prim_A, 'P') = Chars (Prim_G)
8663 then
8664 Set_Chars (Prim_A, Chars (Prim_G));
8666 if List = No_Elist then
8667 List := New_Elmt_List;
8668 end if;
8670 Append_Elmt (Prim_A, List);
8671 end if;
8673 Next_Elmt (Prim_A_Elmt);
8674 Next_Elmt (Prim_G_Elmt);
8675 end loop;
8677 -- Append the elements to the list of temporarily visible primitives
8678 -- avoiding duplicates.
8680 if Present (List) then
8681 if No (Prims_List) then
8682 Prims_List := New_Elmt_List;
8683 end if;
8685 Elmt := First_Elmt (List);
8686 while Present (Elmt) loop
8687 Append_Unique_Elmt (Node (Elmt), Prims_List);
8688 Next_Elmt (Elmt);
8689 end loop;
8690 end if;
8691 end Install_Hidden_Primitives;
8693 -------------------------------
8694 -- Restore_Hidden_Primitives --
8695 -------------------------------
8697 procedure Restore_Hidden_Primitives (Prims_List : in out Elist_Id) is
8698 Prim_Elmt : Elmt_Id;
8699 Prim : Node_Id;
8701 begin
8702 if Prims_List /= No_Elist then
8703 Prim_Elmt := First_Elmt (Prims_List);
8704 while Present (Prim_Elmt) loop
8705 Prim := Node (Prim_Elmt);
8706 Set_Chars (Prim, Add_Suffix (Prim, 'P'));
8707 Next_Elmt (Prim_Elmt);
8708 end loop;
8710 Prims_List := No_Elist;
8711 end if;
8712 end Restore_Hidden_Primitives;
8714 --------------------------------
8715 -- Instantiate_Formal_Package --
8716 --------------------------------
8718 function Instantiate_Formal_Package
8719 (Formal : Node_Id;
8720 Actual : Node_Id;
8721 Analyzed_Formal : Node_Id) return List_Id
8723 Loc : constant Source_Ptr := Sloc (Actual);
8724 Actual_Pack : Entity_Id;
8725 Formal_Pack : Entity_Id;
8726 Gen_Parent : Entity_Id;
8727 Decls : List_Id;
8728 Nod : Node_Id;
8729 Parent_Spec : Node_Id;
8731 procedure Find_Matching_Actual
8732 (F : Node_Id;
8733 Act : in out Entity_Id);
8734 -- We need to associate each formal entity in the formal package with
8735 -- the corresponding entity in the actual package. The actual package
8736 -- has been analyzed and possibly expanded, and as a result there is
8737 -- no one-to-one correspondence between the two lists (for example,
8738 -- the actual may include subtypes, itypes, and inherited primitive
8739 -- operations, interspersed among the renaming declarations for the
8740 -- actuals) . We retrieve the corresponding actual by name because each
8741 -- actual has the same name as the formal, and they do appear in the
8742 -- same order.
8744 function Get_Formal_Entity (N : Node_Id) return Entity_Id;
8745 -- Retrieve entity of defining entity of generic formal parameter.
8746 -- Only the declarations of formals need to be considered when
8747 -- linking them to actuals, but the declarative list may include
8748 -- internal entities generated during analysis, and those are ignored.
8750 procedure Match_Formal_Entity
8751 (Formal_Node : Node_Id;
8752 Formal_Ent : Entity_Id;
8753 Actual_Ent : Entity_Id);
8754 -- Associates the formal entity with the actual. In the case where
8755 -- Formal_Ent is a formal package, this procedure iterates through all
8756 -- of its formals and enters associations between the actuals occurring
8757 -- in the formal package's corresponding actual package (given by
8758 -- Actual_Ent) and the formal package's formal parameters. This
8759 -- procedure recurses if any of the parameters is itself a package.
8761 function Is_Instance_Of
8762 (Act_Spec : Entity_Id;
8763 Gen_Anc : Entity_Id) return Boolean;
8764 -- The actual can be an instantiation of a generic within another
8765 -- instance, in which case there is no direct link from it to the
8766 -- original generic ancestor. In that case, we recognize that the
8767 -- ultimate ancestor is the same by examining names and scopes.
8769 procedure Process_Nested_Formal (Formal : Entity_Id);
8770 -- If the current formal is declared with a box, its own formals are
8771 -- visible in the instance, as they were in the generic, and their
8772 -- Hidden flag must be reset. If some of these formals are themselves
8773 -- packages declared with a box, the processing must be recursive.
8775 --------------------------
8776 -- Find_Matching_Actual --
8777 --------------------------
8779 procedure Find_Matching_Actual
8780 (F : Node_Id;
8781 Act : in out Entity_Id)
8783 Formal_Ent : Entity_Id;
8785 begin
8786 case Nkind (Original_Node (F)) is
8787 when N_Formal_Object_Declaration |
8788 N_Formal_Type_Declaration =>
8789 Formal_Ent := Defining_Identifier (F);
8791 while Chars (Act) /= Chars (Formal_Ent) loop
8792 Next_Entity (Act);
8793 end loop;
8795 when N_Formal_Subprogram_Declaration |
8796 N_Formal_Package_Declaration |
8797 N_Package_Declaration |
8798 N_Generic_Package_Declaration =>
8799 Formal_Ent := Defining_Entity (F);
8801 while Chars (Act) /= Chars (Formal_Ent) loop
8802 Next_Entity (Act);
8803 end loop;
8805 when others =>
8806 raise Program_Error;
8807 end case;
8808 end Find_Matching_Actual;
8810 -------------------------
8811 -- Match_Formal_Entity --
8812 -------------------------
8814 procedure Match_Formal_Entity
8815 (Formal_Node : Node_Id;
8816 Formal_Ent : Entity_Id;
8817 Actual_Ent : Entity_Id)
8819 Act_Pkg : Entity_Id;
8821 begin
8822 Set_Instance_Of (Formal_Ent, Actual_Ent);
8824 if Ekind (Actual_Ent) = E_Package then
8826 -- Record associations for each parameter
8828 Act_Pkg := Actual_Ent;
8830 declare
8831 A_Ent : Entity_Id := First_Entity (Act_Pkg);
8832 F_Ent : Entity_Id;
8833 F_Node : Node_Id;
8835 Gen_Decl : Node_Id;
8836 Formals : List_Id;
8837 Actual : Entity_Id;
8839 begin
8840 -- Retrieve the actual given in the formal package declaration
8842 Actual := Entity (Name (Original_Node (Formal_Node)));
8844 -- The actual in the formal package declaration may be a
8845 -- renamed generic package, in which case we want to retrieve
8846 -- the original generic in order to traverse its formal part.
8848 if Present (Renamed_Entity (Actual)) then
8849 Gen_Decl := Unit_Declaration_Node (Renamed_Entity (Actual));
8850 else
8851 Gen_Decl := Unit_Declaration_Node (Actual);
8852 end if;
8854 Formals := Generic_Formal_Declarations (Gen_Decl);
8856 if Present (Formals) then
8857 F_Node := First_Non_Pragma (Formals);
8858 else
8859 F_Node := Empty;
8860 end if;
8862 while Present (A_Ent)
8863 and then Present (F_Node)
8864 and then A_Ent /= First_Private_Entity (Act_Pkg)
8865 loop
8866 F_Ent := Get_Formal_Entity (F_Node);
8868 if Present (F_Ent) then
8870 -- This is a formal of the original package. Record
8871 -- association and recurse.
8873 Find_Matching_Actual (F_Node, A_Ent);
8874 Match_Formal_Entity (F_Node, F_Ent, A_Ent);
8875 Next_Entity (A_Ent);
8876 end if;
8878 Next_Non_Pragma (F_Node);
8879 end loop;
8880 end;
8881 end if;
8882 end Match_Formal_Entity;
8884 -----------------------
8885 -- Get_Formal_Entity --
8886 -----------------------
8888 function Get_Formal_Entity (N : Node_Id) return Entity_Id is
8889 Kind : constant Node_Kind := Nkind (Original_Node (N));
8890 begin
8891 case Kind is
8892 when N_Formal_Object_Declaration =>
8893 return Defining_Identifier (N);
8895 when N_Formal_Type_Declaration =>
8896 return Defining_Identifier (N);
8898 when N_Formal_Subprogram_Declaration =>
8899 return Defining_Unit_Name (Specification (N));
8901 when N_Formal_Package_Declaration =>
8902 return Defining_Identifier (Original_Node (N));
8904 when N_Generic_Package_Declaration =>
8905 return Defining_Identifier (Original_Node (N));
8907 -- All other declarations are introduced by semantic analysis and
8908 -- have no match in the actual.
8910 when others =>
8911 return Empty;
8912 end case;
8913 end Get_Formal_Entity;
8915 --------------------
8916 -- Is_Instance_Of --
8917 --------------------
8919 function Is_Instance_Of
8920 (Act_Spec : Entity_Id;
8921 Gen_Anc : Entity_Id) return Boolean
8923 Gen_Par : constant Entity_Id := Generic_Parent (Act_Spec);
8925 begin
8926 if No (Gen_Par) then
8927 return False;
8929 -- Simplest case: the generic parent of the actual is the formal
8931 elsif Gen_Par = Gen_Anc then
8932 return True;
8934 elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
8935 return False;
8937 -- The actual may be obtained through several instantiations. Its
8938 -- scope must itself be an instance of a generic declared in the
8939 -- same scope as the formal. Any other case is detected above.
8941 elsif not Is_Generic_Instance (Scope (Gen_Par)) then
8942 return False;
8944 else
8945 return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
8946 end if;
8947 end Is_Instance_Of;
8949 ---------------------------
8950 -- Process_Nested_Formal --
8951 ---------------------------
8953 procedure Process_Nested_Formal (Formal : Entity_Id) is
8954 Ent : Entity_Id;
8956 begin
8957 if Present (Associated_Formal_Package (Formal))
8958 and then Box_Present (Parent (Associated_Formal_Package (Formal)))
8959 then
8960 Ent := First_Entity (Formal);
8961 while Present (Ent) loop
8962 Set_Is_Hidden (Ent, False);
8963 Set_Is_Visible_Formal (Ent);
8964 Set_Is_Potentially_Use_Visible
8965 (Ent, Is_Potentially_Use_Visible (Formal));
8967 if Ekind (Ent) = E_Package then
8968 exit when Renamed_Entity (Ent) = Renamed_Entity (Formal);
8969 Process_Nested_Formal (Ent);
8970 end if;
8972 Next_Entity (Ent);
8973 end loop;
8974 end if;
8975 end Process_Nested_Formal;
8977 -- Start of processing for Instantiate_Formal_Package
8979 begin
8980 Analyze (Actual);
8982 if not Is_Entity_Name (Actual)
8983 or else Ekind (Entity (Actual)) /= E_Package
8984 then
8985 Error_Msg_N
8986 ("expect package instance to instantiate formal", Actual);
8987 Abandon_Instantiation (Actual);
8988 raise Program_Error;
8990 else
8991 Actual_Pack := Entity (Actual);
8992 Set_Is_Instantiated (Actual_Pack);
8994 -- The actual may be a renamed package, or an outer generic formal
8995 -- package whose instantiation is converted into a renaming.
8997 if Present (Renamed_Object (Actual_Pack)) then
8998 Actual_Pack := Renamed_Object (Actual_Pack);
8999 end if;
9001 if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
9002 Gen_Parent := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
9003 Formal_Pack := Defining_Identifier (Analyzed_Formal);
9004 else
9005 Gen_Parent :=
9006 Generic_Parent (Specification (Analyzed_Formal));
9007 Formal_Pack :=
9008 Defining_Unit_Name (Specification (Analyzed_Formal));
9009 end if;
9011 if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
9012 Parent_Spec := Specification (Unit_Declaration_Node (Actual_Pack));
9013 else
9014 Parent_Spec := Parent (Actual_Pack);
9015 end if;
9017 if Gen_Parent = Any_Id then
9018 Error_Msg_N
9019 ("previous error in declaration of formal package", Actual);
9020 Abandon_Instantiation (Actual);
9022 elsif
9023 Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
9024 then
9025 null;
9027 else
9028 Error_Msg_NE
9029 ("actual parameter must be instance of&", Actual, Gen_Parent);
9030 Abandon_Instantiation (Actual);
9031 end if;
9033 Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
9034 Map_Formal_Package_Entities (Formal_Pack, Actual_Pack);
9036 Nod :=
9037 Make_Package_Renaming_Declaration (Loc,
9038 Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
9039 Name => New_Reference_To (Actual_Pack, Loc));
9041 Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
9042 Defining_Identifier (Formal));
9043 Decls := New_List (Nod);
9045 -- If the formal F has a box, then the generic declarations are
9046 -- visible in the generic G. In an instance of G, the corresponding
9047 -- entities in the actual for F (which are the actuals for the
9048 -- instantiation of the generic that F denotes) must also be made
9049 -- visible for analysis of the current instance. On exit from the
9050 -- current instance, those entities are made private again. If the
9051 -- actual is currently in use, these entities are also use-visible.
9053 -- The loop through the actual entities also steps through the formal
9054 -- entities and enters associations from formals to actuals into the
9055 -- renaming map. This is necessary to properly handle checking of
9056 -- actual parameter associations for later formals that depend on
9057 -- actuals declared in the formal package.
9059 -- In Ada 2005, partial parametrization requires that we make visible
9060 -- the actuals corresponding to formals that were defaulted in the
9061 -- formal package. There formals are identified because they remain
9062 -- formal generics within the formal package, rather than being
9063 -- renamings of the actuals supplied.
9065 declare
9066 Gen_Decl : constant Node_Id :=
9067 Unit_Declaration_Node (Gen_Parent);
9068 Formals : constant List_Id :=
9069 Generic_Formal_Declarations (Gen_Decl);
9071 Actual_Ent : Entity_Id;
9072 Actual_Of_Formal : Node_Id;
9073 Formal_Node : Node_Id;
9074 Formal_Ent : Entity_Id;
9076 begin
9077 if Present (Formals) then
9078 Formal_Node := First_Non_Pragma (Formals);
9079 else
9080 Formal_Node := Empty;
9081 end if;
9083 Actual_Ent := First_Entity (Actual_Pack);
9084 Actual_Of_Formal :=
9085 First (Visible_Declarations (Specification (Analyzed_Formal)));
9086 while Present (Actual_Ent)
9087 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9088 loop
9089 if Present (Formal_Node) then
9090 Formal_Ent := Get_Formal_Entity (Formal_Node);
9092 if Present (Formal_Ent) then
9093 Find_Matching_Actual (Formal_Node, Actual_Ent);
9094 Match_Formal_Entity
9095 (Formal_Node, Formal_Ent, Actual_Ent);
9097 -- We iterate at the same time over the actuals of the
9098 -- local package created for the formal, to determine
9099 -- which one of the formals of the original generic were
9100 -- defaulted in the formal. The corresponding actual
9101 -- entities are visible in the enclosing instance.
9103 if Box_Present (Formal)
9104 or else
9105 (Present (Actual_Of_Formal)
9106 and then
9107 Is_Generic_Formal
9108 (Get_Formal_Entity (Actual_Of_Formal)))
9109 then
9110 Set_Is_Hidden (Actual_Ent, False);
9111 Set_Is_Visible_Formal (Actual_Ent);
9112 Set_Is_Potentially_Use_Visible
9113 (Actual_Ent, In_Use (Actual_Pack));
9115 if Ekind (Actual_Ent) = E_Package then
9116 Process_Nested_Formal (Actual_Ent);
9117 end if;
9119 else
9120 Set_Is_Hidden (Actual_Ent);
9121 Set_Is_Potentially_Use_Visible (Actual_Ent, False);
9122 end if;
9123 end if;
9125 Next_Non_Pragma (Formal_Node);
9126 Next (Actual_Of_Formal);
9128 else
9129 -- No further formals to match, but the generic part may
9130 -- contain inherited operation that are not hidden in the
9131 -- enclosing instance.
9133 Next_Entity (Actual_Ent);
9134 end if;
9135 end loop;
9137 -- Inherited subprograms generated by formal derived types are
9138 -- also visible if the types are.
9140 Actual_Ent := First_Entity (Actual_Pack);
9141 while Present (Actual_Ent)
9142 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
9143 loop
9144 if Is_Overloadable (Actual_Ent)
9145 and then
9146 Nkind (Parent (Actual_Ent)) = N_Subtype_Declaration
9147 and then
9148 not Is_Hidden (Defining_Identifier (Parent (Actual_Ent)))
9149 then
9150 Set_Is_Hidden (Actual_Ent, False);
9151 Set_Is_Potentially_Use_Visible
9152 (Actual_Ent, In_Use (Actual_Pack));
9153 end if;
9155 Next_Entity (Actual_Ent);
9156 end loop;
9157 end;
9159 -- If the formal is not declared with a box, reanalyze it as an
9160 -- abbreviated instantiation, to verify the matching rules of 12.7.
9161 -- The actual checks are performed after the generic associations
9162 -- have been analyzed, to guarantee the same visibility for this
9163 -- instantiation and for the actuals.
9165 -- In Ada 2005, the generic associations for the formal can include
9166 -- defaulted parameters. These are ignored during check. This
9167 -- internal instantiation is removed from the tree after conformance
9168 -- checking, because it contains formal declarations for those
9169 -- defaulted parameters, and those should not reach the back-end.
9171 if not Box_Present (Formal) then
9172 declare
9173 I_Pack : constant Entity_Id :=
9174 Make_Temporary (Sloc (Actual), 'P');
9176 begin
9177 Set_Is_Internal (I_Pack);
9179 Append_To (Decls,
9180 Make_Package_Instantiation (Sloc (Actual),
9181 Defining_Unit_Name => I_Pack,
9182 Name =>
9183 New_Occurrence_Of
9184 (Get_Instance_Of (Gen_Parent), Sloc (Actual)),
9185 Generic_Associations =>
9186 Generic_Associations (Formal)));
9187 end;
9188 end if;
9190 return Decls;
9191 end if;
9192 end Instantiate_Formal_Package;
9194 -----------------------------------
9195 -- Instantiate_Formal_Subprogram --
9196 -----------------------------------
9198 function Instantiate_Formal_Subprogram
9199 (Formal : Node_Id;
9200 Actual : Node_Id;
9201 Analyzed_Formal : Node_Id) return Node_Id
9203 Loc : Source_Ptr;
9204 Formal_Sub : constant Entity_Id :=
9205 Defining_Unit_Name (Specification (Formal));
9206 Analyzed_S : constant Entity_Id :=
9207 Defining_Unit_Name (Specification (Analyzed_Formal));
9208 Decl_Node : Node_Id;
9209 Nam : Node_Id;
9210 New_Spec : Node_Id;
9212 function From_Parent_Scope (Subp : Entity_Id) return Boolean;
9213 -- If the generic is a child unit, the parent has been installed on the
9214 -- scope stack, but a default subprogram cannot resolve to something
9215 -- on the parent because that parent is not really part of the visible
9216 -- context (it is there to resolve explicit local entities). If the
9217 -- default has resolved in this way, we remove the entity from immediate
9218 -- visibility and analyze the node again to emit an error message or
9219 -- find another visible candidate.
9221 procedure Valid_Actual_Subprogram (Act : Node_Id);
9222 -- Perform legality check and raise exception on failure
9224 -----------------------
9225 -- From_Parent_Scope --
9226 -----------------------
9228 function From_Parent_Scope (Subp : Entity_Id) return Boolean is
9229 Gen_Scope : Node_Id;
9231 begin
9232 Gen_Scope := Scope (Analyzed_S);
9233 while Present (Gen_Scope) and then Is_Child_Unit (Gen_Scope) loop
9234 if Scope (Subp) = Scope (Gen_Scope) then
9235 return True;
9236 end if;
9238 Gen_Scope := Scope (Gen_Scope);
9239 end loop;
9241 return False;
9242 end From_Parent_Scope;
9244 -----------------------------
9245 -- Valid_Actual_Subprogram --
9246 -----------------------------
9248 procedure Valid_Actual_Subprogram (Act : Node_Id) is
9249 Act_E : Entity_Id;
9251 begin
9252 if Is_Entity_Name (Act) then
9253 Act_E := Entity (Act);
9255 elsif Nkind (Act) = N_Selected_Component
9256 and then Is_Entity_Name (Selector_Name (Act))
9257 then
9258 Act_E := Entity (Selector_Name (Act));
9260 else
9261 Act_E := Empty;
9262 end if;
9264 if (Present (Act_E) and then Is_Overloadable (Act_E))
9265 or else Nkind_In (Act, N_Attribute_Reference,
9266 N_Indexed_Component,
9267 N_Character_Literal,
9268 N_Explicit_Dereference)
9269 then
9270 return;
9271 end if;
9273 Error_Msg_NE
9274 ("expect subprogram or entry name in instantiation of&",
9275 Instantiation_Node, Formal_Sub);
9276 Abandon_Instantiation (Instantiation_Node);
9278 end Valid_Actual_Subprogram;
9280 -- Start of processing for Instantiate_Formal_Subprogram
9282 begin
9283 New_Spec := New_Copy_Tree (Specification (Formal));
9285 -- The tree copy has created the proper instantiation sloc for the
9286 -- new specification. Use this location for all other constructed
9287 -- declarations.
9289 Loc := Sloc (Defining_Unit_Name (New_Spec));
9291 -- Create new entity for the actual (New_Copy_Tree does not)
9293 Set_Defining_Unit_Name
9294 (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9296 -- Create new entities for the each of the formals in the
9297 -- specification of the renaming declaration built for the actual.
9299 if Present (Parameter_Specifications (New_Spec)) then
9300 declare
9301 F : Node_Id;
9302 begin
9303 F := First (Parameter_Specifications (New_Spec));
9304 while Present (F) loop
9305 Set_Defining_Identifier (F,
9306 Make_Defining_Identifier (Sloc (F),
9307 Chars => Chars (Defining_Identifier (F))));
9308 Next (F);
9309 end loop;
9310 end;
9311 end if;
9313 -- Find entity of actual. If the actual is an attribute reference, it
9314 -- cannot be resolved here (its formal is missing) but is handled
9315 -- instead in Attribute_Renaming. If the actual is overloaded, it is
9316 -- fully resolved subsequently, when the renaming declaration for the
9317 -- formal is analyzed. If it is an explicit dereference, resolve the
9318 -- prefix but not the actual itself, to prevent interpretation as call.
9320 if Present (Actual) then
9321 Loc := Sloc (Actual);
9322 Set_Sloc (New_Spec, Loc);
9324 if Nkind (Actual) = N_Operator_Symbol then
9325 Find_Direct_Name (Actual);
9327 elsif Nkind (Actual) = N_Explicit_Dereference then
9328 Analyze (Prefix (Actual));
9330 elsif Nkind (Actual) /= N_Attribute_Reference then
9331 Analyze (Actual);
9332 end if;
9334 Valid_Actual_Subprogram (Actual);
9335 Nam := Actual;
9337 elsif Present (Default_Name (Formal)) then
9338 if not Nkind_In (Default_Name (Formal), N_Attribute_Reference,
9339 N_Selected_Component,
9340 N_Indexed_Component,
9341 N_Character_Literal)
9342 and then Present (Entity (Default_Name (Formal)))
9343 then
9344 Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
9345 else
9346 Nam := New_Copy (Default_Name (Formal));
9347 Set_Sloc (Nam, Loc);
9348 end if;
9350 elsif Box_Present (Formal) then
9352 -- Actual is resolved at the point of instantiation. Create an
9353 -- identifier or operator with the same name as the formal.
9355 if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
9356 Nam := Make_Operator_Symbol (Loc,
9357 Chars => Chars (Formal_Sub),
9358 Strval => No_String);
9359 else
9360 Nam := Make_Identifier (Loc, Chars (Formal_Sub));
9361 end if;
9363 elsif Nkind (Specification (Formal)) = N_Procedure_Specification
9364 and then Null_Present (Specification (Formal))
9365 then
9366 -- Generate null body for procedure, for use in the instance
9368 Decl_Node :=
9369 Make_Subprogram_Body (Loc,
9370 Specification => New_Spec,
9371 Declarations => New_List,
9372 Handled_Statement_Sequence =>
9373 Make_Handled_Sequence_Of_Statements (Loc,
9374 Statements => New_List (Make_Null_Statement (Loc))));
9376 Set_Is_Intrinsic_Subprogram (Defining_Unit_Name (New_Spec));
9377 return Decl_Node;
9379 else
9380 Error_Msg_Sloc := Sloc (Scope (Analyzed_S));
9381 Error_Msg_NE
9382 ("missing actual&", Instantiation_Node, Formal_Sub);
9383 Error_Msg_NE
9384 ("\in instantiation of & declared#",
9385 Instantiation_Node, Scope (Analyzed_S));
9386 Abandon_Instantiation (Instantiation_Node);
9387 end if;
9389 Decl_Node :=
9390 Make_Subprogram_Renaming_Declaration (Loc,
9391 Specification => New_Spec,
9392 Name => Nam);
9394 -- If we do not have an actual and the formal specified <> then set to
9395 -- get proper default.
9397 if No (Actual) and then Box_Present (Formal) then
9398 Set_From_Default (Decl_Node);
9399 end if;
9401 -- Gather possible interpretations for the actual before analyzing the
9402 -- instance. If overloaded, it will be resolved when analyzing the
9403 -- renaming declaration.
9405 if Box_Present (Formal)
9406 and then No (Actual)
9407 then
9408 Analyze (Nam);
9410 if Is_Child_Unit (Scope (Analyzed_S))
9411 and then Present (Entity (Nam))
9412 then
9413 if not Is_Overloaded (Nam) then
9414 if From_Parent_Scope (Entity (Nam)) then
9415 Set_Is_Immediately_Visible (Entity (Nam), False);
9416 Set_Entity (Nam, Empty);
9417 Set_Etype (Nam, Empty);
9419 Analyze (Nam);
9420 Set_Is_Immediately_Visible (Entity (Nam));
9421 end if;
9423 else
9424 declare
9425 I : Interp_Index;
9426 It : Interp;
9428 begin
9429 Get_First_Interp (Nam, I, It);
9430 while Present (It.Nam) loop
9431 if From_Parent_Scope (It.Nam) then
9432 Remove_Interp (I);
9433 end if;
9435 Get_Next_Interp (I, It);
9436 end loop;
9437 end;
9438 end if;
9439 end if;
9440 end if;
9442 -- The generic instantiation freezes the actual. This can only be done
9443 -- once the actual is resolved, in the analysis of the renaming
9444 -- declaration. To make the formal subprogram entity available, we set
9445 -- Corresponding_Formal_Spec to point to the formal subprogram entity.
9446 -- This is also needed in Analyze_Subprogram_Renaming for the processing
9447 -- of formal abstract subprograms.
9449 Set_Corresponding_Formal_Spec (Decl_Node, Analyzed_S);
9451 -- We cannot analyze the renaming declaration, and thus find the actual,
9452 -- until all the actuals are assembled in the instance. For subsequent
9453 -- checks of other actuals, indicate the node that will hold the
9454 -- instance of this formal.
9456 Set_Instance_Of (Analyzed_S, Nam);
9458 if Nkind (Actual) = N_Selected_Component
9459 and then Is_Task_Type (Etype (Prefix (Actual)))
9460 and then not Is_Frozen (Etype (Prefix (Actual)))
9461 then
9462 -- The renaming declaration will create a body, which must appear
9463 -- outside of the instantiation, We move the renaming declaration
9464 -- out of the instance, and create an additional renaming inside,
9465 -- to prevent freezing anomalies.
9467 declare
9468 Anon_Id : constant Entity_Id := Make_Temporary (Loc, 'E');
9470 begin
9471 Set_Defining_Unit_Name (New_Spec, Anon_Id);
9472 Insert_Before (Instantiation_Node, Decl_Node);
9473 Analyze (Decl_Node);
9475 -- Now create renaming within the instance
9477 Decl_Node :=
9478 Make_Subprogram_Renaming_Declaration (Loc,
9479 Specification => New_Copy_Tree (New_Spec),
9480 Name => New_Occurrence_Of (Anon_Id, Loc));
9482 Set_Defining_Unit_Name (Specification (Decl_Node),
9483 Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
9484 end;
9485 end if;
9487 return Decl_Node;
9488 end Instantiate_Formal_Subprogram;
9490 ------------------------
9491 -- Instantiate_Object --
9492 ------------------------
9494 function Instantiate_Object
9495 (Formal : Node_Id;
9496 Actual : Node_Id;
9497 Analyzed_Formal : Node_Id) return List_Id
9499 Gen_Obj : constant Entity_Id := Defining_Identifier (Formal);
9500 A_Gen_Obj : constant Entity_Id :=
9501 Defining_Identifier (Analyzed_Formal);
9502 Acc_Def : Node_Id := Empty;
9503 Act_Assoc : constant Node_Id := Parent (Actual);
9504 Actual_Decl : Node_Id := Empty;
9505 Decl_Node : Node_Id;
9506 Def : Node_Id;
9507 Ftyp : Entity_Id;
9508 List : constant List_Id := New_List;
9509 Loc : constant Source_Ptr := Sloc (Actual);
9510 Orig_Ftyp : constant Entity_Id := Etype (A_Gen_Obj);
9511 Subt_Decl : Node_Id := Empty;
9512 Subt_Mark : Node_Id := Empty;
9514 begin
9515 if Present (Subtype_Mark (Formal)) then
9516 Subt_Mark := Subtype_Mark (Formal);
9517 else
9518 Check_Access_Definition (Formal);
9519 Acc_Def := Access_Definition (Formal);
9520 end if;
9522 -- Sloc for error message on missing actual
9524 Error_Msg_Sloc := Sloc (Scope (A_Gen_Obj));
9526 if Get_Instance_Of (Gen_Obj) /= Gen_Obj then
9527 Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
9528 end if;
9530 Set_Parent (List, Parent (Actual));
9532 -- OUT present
9534 if Out_Present (Formal) then
9536 -- An IN OUT generic actual must be a name. The instantiation is a
9537 -- renaming declaration. The actual is the name being renamed. We
9538 -- use the actual directly, rather than a copy, because it is not
9539 -- used further in the list of actuals, and because a copy or a use
9540 -- of relocate_node is incorrect if the instance is nested within a
9541 -- generic. In order to simplify ASIS searches, the Generic_Parent
9542 -- field links the declaration to the generic association.
9544 if No (Actual) then
9545 Error_Msg_NE
9546 ("missing actual&",
9547 Instantiation_Node, Gen_Obj);
9548 Error_Msg_NE
9549 ("\in instantiation of & declared#",
9550 Instantiation_Node, Scope (A_Gen_Obj));
9551 Abandon_Instantiation (Instantiation_Node);
9552 end if;
9554 if Present (Subt_Mark) then
9555 Decl_Node :=
9556 Make_Object_Renaming_Declaration (Loc,
9557 Defining_Identifier => New_Copy (Gen_Obj),
9558 Subtype_Mark => New_Copy_Tree (Subt_Mark),
9559 Name => Actual);
9561 else pragma Assert (Present (Acc_Def));
9562 Decl_Node :=
9563 Make_Object_Renaming_Declaration (Loc,
9564 Defining_Identifier => New_Copy (Gen_Obj),
9565 Access_Definition => New_Copy_Tree (Acc_Def),
9566 Name => Actual);
9567 end if;
9569 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9571 -- The analysis of the actual may produce Insert_Action nodes, so
9572 -- the declaration must have a context in which to attach them.
9574 Append (Decl_Node, List);
9575 Analyze (Actual);
9577 -- Return if the analysis of the actual reported some error
9579 if Etype (Actual) = Any_Type then
9580 return List;
9581 end if;
9583 -- This check is performed here because Analyze_Object_Renaming will
9584 -- not check it when Comes_From_Source is False. Note though that the
9585 -- check for the actual being the name of an object will be performed
9586 -- in Analyze_Object_Renaming.
9588 if Is_Object_Reference (Actual)
9589 and then Is_Dependent_Component_Of_Mutable_Object (Actual)
9590 then
9591 Error_Msg_N
9592 ("illegal discriminant-dependent component for in out parameter",
9593 Actual);
9594 end if;
9596 -- The actual has to be resolved in order to check that it is a
9597 -- variable (due to cases such as F (1), where F returns access to
9598 -- an array, and for overloaded prefixes).
9600 Ftyp := Get_Instance_Of (Etype (A_Gen_Obj));
9602 -- If the type of the formal is not itself a formal, and the current
9603 -- unit is a child unit, the formal type must be declared in a
9604 -- parent, and must be retrieved by visibility.
9606 if Ftyp = Orig_Ftyp
9607 and then Is_Generic_Unit (Scope (Ftyp))
9608 and then Is_Child_Unit (Scope (A_Gen_Obj))
9609 then
9610 declare
9611 Temp : constant Node_Id :=
9612 New_Copy_Tree (Subtype_Mark (Analyzed_Formal));
9613 begin
9614 Set_Entity (Temp, Empty);
9615 Find_Type (Temp);
9616 Ftyp := Entity (Temp);
9617 end;
9618 end if;
9620 if Is_Private_Type (Ftyp)
9621 and then not Is_Private_Type (Etype (Actual))
9622 and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
9623 or else Base_Type (Etype (Actual)) = Ftyp)
9624 then
9625 -- If the actual has the type of the full view of the formal, or
9626 -- else a non-private subtype of the formal, then the visibility
9627 -- of the formal type has changed. Add to the actuals a subtype
9628 -- declaration that will force the exchange of views in the body
9629 -- of the instance as well.
9631 Subt_Decl :=
9632 Make_Subtype_Declaration (Loc,
9633 Defining_Identifier => Make_Temporary (Loc, 'P'),
9634 Subtype_Indication => New_Occurrence_Of (Ftyp, Loc));
9636 Prepend (Subt_Decl, List);
9638 Prepend_Elmt (Full_View (Ftyp), Exchanged_Views);
9639 Exchange_Declarations (Ftyp);
9640 end if;
9642 Resolve (Actual, Ftyp);
9644 if not Denotes_Variable (Actual) then
9645 Error_Msg_NE
9646 ("actual for& must be a variable", Actual, Gen_Obj);
9648 elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
9650 -- Ada 2005 (AI-423): For a generic formal object of mode in out,
9651 -- the type of the actual shall resolve to a specific anonymous
9652 -- access type.
9654 if Ada_Version < Ada_2005
9655 or else
9656 Ekind (Base_Type (Ftyp)) /=
9657 E_Anonymous_Access_Type
9658 or else
9659 Ekind (Base_Type (Etype (Actual))) /=
9660 E_Anonymous_Access_Type
9661 then
9662 Error_Msg_NE ("type of actual does not match type of&",
9663 Actual, Gen_Obj);
9664 end if;
9665 end if;
9667 Note_Possible_Modification (Actual, Sure => True);
9669 -- Check for instantiation of atomic/volatile actual for
9670 -- non-atomic/volatile formal (RM C.6 (12)).
9672 if Is_Atomic_Object (Actual)
9673 and then not Is_Atomic (Orig_Ftyp)
9674 then
9675 Error_Msg_N
9676 ("cannot instantiate non-atomic formal object " &
9677 "with atomic actual", Actual);
9679 elsif Is_Volatile_Object (Actual)
9680 and then not Is_Volatile (Orig_Ftyp)
9681 then
9682 Error_Msg_N
9683 ("cannot instantiate non-volatile formal object " &
9684 "with volatile actual", Actual);
9685 end if;
9687 -- Formal in-parameter
9689 else
9690 -- The instantiation of a generic formal in-parameter is constant
9691 -- declaration. The actual is the expression for that declaration.
9693 if Present (Actual) then
9694 if Present (Subt_Mark) then
9695 Def := Subt_Mark;
9696 else pragma Assert (Present (Acc_Def));
9697 Def := Acc_Def;
9698 end if;
9700 Decl_Node :=
9701 Make_Object_Declaration (Loc,
9702 Defining_Identifier => New_Copy (Gen_Obj),
9703 Constant_Present => True,
9704 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9705 Object_Definition => New_Copy_Tree (Def),
9706 Expression => Actual);
9708 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
9710 -- A generic formal object of a tagged type is defined to be
9711 -- aliased so the new constant must also be treated as aliased.
9713 if Is_Tagged_Type (Etype (A_Gen_Obj)) then
9714 Set_Aliased_Present (Decl_Node);
9715 end if;
9717 Append (Decl_Node, List);
9719 -- No need to repeat (pre-)analysis of some expression nodes
9720 -- already handled in Preanalyze_Actuals.
9722 if Nkind (Actual) /= N_Allocator then
9723 Analyze (Actual);
9725 -- Return if the analysis of the actual reported some error
9727 if Etype (Actual) = Any_Type then
9728 return List;
9729 end if;
9730 end if;
9732 declare
9733 Formal_Type : constant Entity_Id := Etype (A_Gen_Obj);
9734 Typ : Entity_Id;
9736 begin
9737 Typ := Get_Instance_Of (Formal_Type);
9739 Freeze_Before (Instantiation_Node, Typ);
9741 -- If the actual is an aggregate, perform name resolution on
9742 -- its components (the analysis of an aggregate does not do it)
9743 -- to capture local names that may be hidden if the generic is
9744 -- a child unit.
9746 if Nkind (Actual) = N_Aggregate then
9747 Preanalyze_And_Resolve (Actual, Typ);
9748 end if;
9750 if Is_Limited_Type (Typ)
9751 and then not OK_For_Limited_Init (Typ, Actual)
9752 then
9753 Error_Msg_N
9754 ("initialization not allowed for limited types", Actual);
9755 Explain_Limited_Type (Typ, Actual);
9756 end if;
9757 end;
9759 elsif Present (Default_Expression (Formal)) then
9761 -- Use default to construct declaration
9763 if Present (Subt_Mark) then
9764 Def := Subt_Mark;
9765 else pragma Assert (Present (Acc_Def));
9766 Def := Acc_Def;
9767 end if;
9769 Decl_Node :=
9770 Make_Object_Declaration (Sloc (Formal),
9771 Defining_Identifier => New_Copy (Gen_Obj),
9772 Constant_Present => True,
9773 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9774 Object_Definition => New_Copy (Def),
9775 Expression => New_Copy_Tree
9776 (Default_Expression (Formal)));
9778 Append (Decl_Node, List);
9779 Set_Analyzed (Expression (Decl_Node), False);
9781 else
9782 Error_Msg_NE
9783 ("missing actual&",
9784 Instantiation_Node, Gen_Obj);
9785 Error_Msg_NE ("\in instantiation of & declared#",
9786 Instantiation_Node, Scope (A_Gen_Obj));
9788 if Is_Scalar_Type (Etype (A_Gen_Obj)) then
9790 -- Create dummy constant declaration so that instance can be
9791 -- analyzed, to minimize cascaded visibility errors.
9793 if Present (Subt_Mark) then
9794 Def := Subt_Mark;
9795 else pragma Assert (Present (Acc_Def));
9796 Def := Acc_Def;
9797 end if;
9799 Decl_Node :=
9800 Make_Object_Declaration (Loc,
9801 Defining_Identifier => New_Copy (Gen_Obj),
9802 Constant_Present => True,
9803 Null_Exclusion_Present => Null_Exclusion_Present (Formal),
9804 Object_Definition => New_Copy (Def),
9805 Expression =>
9806 Make_Attribute_Reference (Sloc (Gen_Obj),
9807 Attribute_Name => Name_First,
9808 Prefix => New_Copy (Def)));
9810 Append (Decl_Node, List);
9812 else
9813 Abandon_Instantiation (Instantiation_Node);
9814 end if;
9815 end if;
9816 end if;
9818 if Nkind (Actual) in N_Has_Entity then
9819 Actual_Decl := Parent (Entity (Actual));
9820 end if;
9822 -- Ada 2005 (AI-423): For a formal object declaration with a null
9823 -- exclusion or an access definition that has a null exclusion: If the
9824 -- actual matching the formal object declaration denotes a generic
9825 -- formal object of another generic unit G, and the instantiation
9826 -- containing the actual occurs within the body of G or within the body
9827 -- of a generic unit declared within the declarative region of G, then
9828 -- the declaration of the formal object of G must have a null exclusion.
9829 -- Otherwise, the subtype of the actual matching the formal object
9830 -- declaration shall exclude null.
9832 if Ada_Version >= Ada_2005
9833 and then Present (Actual_Decl)
9834 and then
9835 Nkind_In (Actual_Decl, N_Formal_Object_Declaration,
9836 N_Object_Declaration)
9837 and then Nkind (Analyzed_Formal) = N_Formal_Object_Declaration
9838 and then not Has_Null_Exclusion (Actual_Decl)
9839 and then Has_Null_Exclusion (Analyzed_Formal)
9840 then
9841 Error_Msg_Sloc := Sloc (Analyzed_Formal);
9842 Error_Msg_N
9843 ("actual must exclude null to match generic formal#", Actual);
9844 end if;
9846 return List;
9847 end Instantiate_Object;
9849 ------------------------------
9850 -- Instantiate_Package_Body --
9851 ------------------------------
9853 procedure Instantiate_Package_Body
9854 (Body_Info : Pending_Body_Info;
9855 Inlined_Body : Boolean := False;
9856 Body_Optional : Boolean := False)
9858 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
9859 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
9860 Loc : constant Source_Ptr := Sloc (Inst_Node);
9862 Gen_Id : constant Node_Id := Name (Inst_Node);
9863 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
9864 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
9865 Act_Spec : constant Node_Id := Specification (Act_Decl);
9866 Act_Decl_Id : constant Entity_Id := Defining_Entity (Act_Spec);
9868 Act_Body_Name : Node_Id;
9869 Gen_Body : Node_Id;
9870 Gen_Body_Id : Node_Id;
9871 Act_Body : Node_Id;
9872 Act_Body_Id : Entity_Id;
9874 Parent_Installed : Boolean := False;
9875 Save_Style_Check : constant Boolean := Style_Check;
9877 Par_Ent : Entity_Id := Empty;
9878 Par_Vis : Boolean := False;
9880 Vis_Prims_List : Elist_Id := No_Elist;
9881 -- List of primitives made temporarily visible in the instantiation
9882 -- to match the visibility of the formal type
9884 begin
9885 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9887 -- The instance body may already have been processed, as the parent of
9888 -- another instance that is inlined (Load_Parent_Of_Generic).
9890 if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
9891 return;
9892 end if;
9894 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
9896 -- Re-establish the state of information on which checks are suppressed.
9897 -- This information was set in Body_Info at the point of instantiation,
9898 -- and now we restore it so that the instance is compiled using the
9899 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
9901 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
9902 Scope_Suppress := Body_Info.Scope_Suppress;
9903 Opt.Ada_Version := Body_Info.Version;
9905 if No (Gen_Body_Id) then
9906 Load_Parent_Of_Generic
9907 (Inst_Node, Specification (Gen_Decl), Body_Optional);
9908 Gen_Body_Id := Corresponding_Body (Gen_Decl);
9909 end if;
9911 -- Establish global variable for sloc adjustment and for error recovery
9913 Instantiation_Node := Inst_Node;
9915 if Present (Gen_Body_Id) then
9916 Save_Env (Gen_Unit, Act_Decl_Id);
9917 Style_Check := False;
9918 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
9920 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
9922 Create_Instantiation_Source
9923 (Inst_Node, Gen_Body_Id, False, S_Adjustment);
9925 Act_Body :=
9926 Copy_Generic_Node
9927 (Original_Node (Gen_Body), Empty, Instantiating => True);
9929 -- Build new name (possibly qualified) for body declaration
9931 Act_Body_Id := New_Copy (Act_Decl_Id);
9933 -- Some attributes of spec entity are not inherited by body entity
9935 Set_Handler_Records (Act_Body_Id, No_List);
9937 if Nkind (Defining_Unit_Name (Act_Spec)) =
9938 N_Defining_Program_Unit_Name
9939 then
9940 Act_Body_Name :=
9941 Make_Defining_Program_Unit_Name (Loc,
9942 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
9943 Defining_Identifier => Act_Body_Id);
9944 else
9945 Act_Body_Name := Act_Body_Id;
9946 end if;
9948 Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
9950 Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
9951 Check_Generic_Actuals (Act_Decl_Id, False);
9953 -- Install primitives hidden at the point of the instantiation but
9954 -- visible when processing the generic formals
9956 declare
9957 E : Entity_Id;
9959 begin
9960 E := First_Entity (Act_Decl_Id);
9961 while Present (E) loop
9962 if Is_Type (E)
9963 and then Is_Generic_Actual_Type (E)
9964 and then Is_Tagged_Type (E)
9965 then
9966 Install_Hidden_Primitives
9967 (Prims_List => Vis_Prims_List,
9968 Gen_T => Generic_Parent_Type (Parent (E)),
9969 Act_T => E);
9970 end if;
9972 Next_Entity (E);
9973 end loop;
9974 end;
9976 -- If it is a child unit, make the parent instance (which is an
9977 -- instance of the parent of the generic) visible. The parent
9978 -- instance is the prefix of the name of the generic unit.
9980 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
9981 and then Nkind (Gen_Id) = N_Expanded_Name
9982 then
9983 Par_Ent := Entity (Prefix (Gen_Id));
9984 Par_Vis := Is_Immediately_Visible (Par_Ent);
9985 Install_Parent (Par_Ent, In_Body => True);
9986 Parent_Installed := True;
9988 elsif Is_Child_Unit (Gen_Unit) then
9989 Par_Ent := Scope (Gen_Unit);
9990 Par_Vis := Is_Immediately_Visible (Par_Ent);
9991 Install_Parent (Par_Ent, In_Body => True);
9992 Parent_Installed := True;
9993 end if;
9995 -- If the instantiation is a library unit, and this is the main unit,
9996 -- then build the resulting compilation unit nodes for the instance.
9997 -- If this is a compilation unit but it is not the main unit, then it
9998 -- is the body of a unit in the context, that is being compiled
9999 -- because it is encloses some inlined unit or another generic unit
10000 -- being instantiated. In that case, this body is not part of the
10001 -- current compilation, and is not attached to the tree, but its
10002 -- parent must be set for analysis.
10004 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10006 -- Replace instance node with body of instance, and create new
10007 -- node for corresponding instance declaration.
10009 Build_Instance_Compilation_Unit_Nodes
10010 (Inst_Node, Act_Body, Act_Decl);
10011 Analyze (Inst_Node);
10013 if Parent (Inst_Node) = Cunit (Main_Unit) then
10015 -- If the instance is a child unit itself, then set the scope
10016 -- of the expanded body to be the parent of the instantiation
10017 -- (ensuring that the fully qualified name will be generated
10018 -- for the elaboration subprogram).
10020 if Nkind (Defining_Unit_Name (Act_Spec)) =
10021 N_Defining_Program_Unit_Name
10022 then
10023 Set_Scope
10024 (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
10025 end if;
10026 end if;
10028 -- Case where instantiation is not a library unit
10030 else
10031 -- If this is an early instantiation, i.e. appears textually
10032 -- before the corresponding body and must be elaborated first,
10033 -- indicate that the body instance is to be delayed.
10035 Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
10037 -- Now analyze the body. We turn off all checks if this is an
10038 -- internal unit, since there is no reason to have checks on for
10039 -- any predefined run-time library code. All such code is designed
10040 -- to be compiled with checks off.
10042 -- Note that we do NOT apply this criterion to children of GNAT
10043 -- (or on VMS, children of DEC). The latter units must suppress
10044 -- checks explicitly if this is needed.
10046 if Is_Predefined_File_Name
10047 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
10048 then
10049 Analyze (Act_Body, Suppress => All_Checks);
10050 else
10051 Analyze (Act_Body);
10052 end if;
10053 end if;
10055 Inherit_Context (Gen_Body, Inst_Node);
10057 -- Remove the parent instances if they have been placed on the scope
10058 -- stack to compile the body.
10060 if Parent_Installed then
10061 Remove_Parent (In_Body => True);
10063 -- Restore the previous visibility of the parent
10065 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10066 end if;
10068 Restore_Hidden_Primitives (Vis_Prims_List);
10069 Restore_Private_Views (Act_Decl_Id);
10071 -- Remove the current unit from visibility if this is an instance
10072 -- that is not elaborated on the fly for inlining purposes.
10074 if not Inlined_Body then
10075 Set_Is_Immediately_Visible (Act_Decl_Id, False);
10076 end if;
10078 Restore_Env;
10079 Style_Check := Save_Style_Check;
10081 -- If we have no body, and the unit requires a body, then complain. This
10082 -- complaint is suppressed if we have detected other errors (since a
10083 -- common reason for missing the body is that it had errors).
10084 -- In CodePeer mode, a warning has been emitted already, no need for
10085 -- further messages.
10087 elsif Unit_Requires_Body (Gen_Unit)
10088 and then not Body_Optional
10089 then
10090 if CodePeer_Mode then
10091 null;
10093 elsif Serious_Errors_Detected = 0 then
10094 Error_Msg_NE
10095 ("cannot find body of generic package &", Inst_Node, Gen_Unit);
10097 -- Don't attempt to perform any cleanup actions if some other error
10098 -- was already detected, since this can cause blowups.
10100 else
10101 return;
10102 end if;
10104 -- Case of package that does not need a body
10106 else
10107 -- If the instantiation of the declaration is a library unit, rewrite
10108 -- the original package instantiation as a package declaration in the
10109 -- compilation unit node.
10111 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10112 Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
10113 Rewrite (Inst_Node, Act_Decl);
10115 -- Generate elaboration entity, in case spec has elaboration code.
10116 -- This cannot be done when the instance is analyzed, because it
10117 -- is not known yet whether the body exists.
10119 Set_Elaboration_Entity_Required (Act_Decl_Id, False);
10120 Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
10122 -- If the instantiation is not a library unit, then append the
10123 -- declaration to the list of implicitly generated entities, unless
10124 -- it is already a list member which means that it was already
10125 -- processed
10127 elsif not Is_List_Member (Act_Decl) then
10128 Mark_Rewrite_Insertion (Act_Decl);
10129 Insert_Before (Inst_Node, Act_Decl);
10130 end if;
10131 end if;
10133 Expander_Mode_Restore;
10134 end Instantiate_Package_Body;
10136 ---------------------------------
10137 -- Instantiate_Subprogram_Body --
10138 ---------------------------------
10140 procedure Instantiate_Subprogram_Body
10141 (Body_Info : Pending_Body_Info;
10142 Body_Optional : Boolean := False)
10144 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
10145 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
10146 Loc : constant Source_Ptr := Sloc (Inst_Node);
10147 Gen_Id : constant Node_Id := Name (Inst_Node);
10148 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
10149 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
10150 Anon_Id : constant Entity_Id :=
10151 Defining_Unit_Name (Specification (Act_Decl));
10152 Pack_Id : constant Entity_Id :=
10153 Defining_Unit_Name (Parent (Act_Decl));
10154 Decls : List_Id;
10155 Gen_Body : Node_Id;
10156 Gen_Body_Id : Node_Id;
10157 Act_Body : Node_Id;
10158 Pack_Body : Node_Id;
10159 Prev_Formal : Entity_Id;
10160 Ret_Expr : Node_Id;
10161 Unit_Renaming : Node_Id;
10163 Parent_Installed : Boolean := False;
10164 Save_Style_Check : constant Boolean := Style_Check;
10166 Par_Ent : Entity_Id := Empty;
10167 Par_Vis : Boolean := False;
10169 begin
10170 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10172 -- Subprogram body may have been created already because of an inline
10173 -- pragma, or because of multiple elaborations of the enclosing package
10174 -- when several instances of the subprogram appear in the main unit.
10176 if Present (Corresponding_Body (Act_Decl)) then
10177 return;
10178 end if;
10180 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
10182 -- Re-establish the state of information on which checks are suppressed.
10183 -- This information was set in Body_Info at the point of instantiation,
10184 -- and now we restore it so that the instance is compiled using the
10185 -- check status at the instantiation (RM 11.5 (7.2/2), AI95-00224-01).
10187 Local_Suppress_Stack_Top := Body_Info.Local_Suppress_Stack_Top;
10188 Scope_Suppress := Body_Info.Scope_Suppress;
10189 Opt.Ada_Version := Body_Info.Version;
10191 if No (Gen_Body_Id) then
10193 -- For imported generic subprogram, no body to compile, complete
10194 -- the spec entity appropriately.
10196 if Is_Imported (Gen_Unit) then
10197 Set_Is_Imported (Anon_Id);
10198 Set_First_Rep_Item (Anon_Id, First_Rep_Item (Gen_Unit));
10199 Set_Interface_Name (Anon_Id, Interface_Name (Gen_Unit));
10200 Set_Convention (Anon_Id, Convention (Gen_Unit));
10201 Set_Has_Completion (Anon_Id);
10202 return;
10204 -- For other cases, compile the body
10206 else
10207 Load_Parent_Of_Generic
10208 (Inst_Node, Specification (Gen_Decl), Body_Optional);
10209 Gen_Body_Id := Corresponding_Body (Gen_Decl);
10210 end if;
10211 end if;
10213 Instantiation_Node := Inst_Node;
10215 if Present (Gen_Body_Id) then
10216 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
10218 if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
10220 -- Either body is not present, or context is non-expanding, as
10221 -- when compiling a subunit. Mark the instance as completed, and
10222 -- diagnose a missing body when needed.
10224 if Expander_Active
10225 and then Operating_Mode = Generate_Code
10226 then
10227 Error_Msg_N
10228 ("missing proper body for instantiation", Gen_Body);
10229 end if;
10231 Set_Has_Completion (Anon_Id);
10232 return;
10233 end if;
10235 Save_Env (Gen_Unit, Anon_Id);
10236 Style_Check := False;
10237 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
10238 Create_Instantiation_Source
10239 (Inst_Node,
10240 Gen_Body_Id,
10241 False,
10242 S_Adjustment);
10244 Act_Body :=
10245 Copy_Generic_Node
10246 (Original_Node (Gen_Body), Empty, Instantiating => True);
10248 -- Create proper defining name for the body, to correspond to
10249 -- the one in the spec.
10251 Set_Defining_Unit_Name (Specification (Act_Body),
10252 Make_Defining_Identifier
10253 (Sloc (Defining_Entity (Inst_Node)), Chars (Anon_Id)));
10254 Set_Corresponding_Spec (Act_Body, Anon_Id);
10255 Set_Has_Completion (Anon_Id);
10256 Check_Generic_Actuals (Pack_Id, False);
10258 -- Generate a reference to link the visible subprogram instance to
10259 -- the generic body, which for navigation purposes is the only
10260 -- available source for the instance.
10262 Generate_Reference
10263 (Related_Instance (Pack_Id),
10264 Gen_Body_Id, 'b', Set_Ref => False, Force => True);
10266 -- If it is a child unit, make the parent instance (which is an
10267 -- instance of the parent of the generic) visible. The parent
10268 -- instance is the prefix of the name of the generic unit.
10270 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
10271 and then Nkind (Gen_Id) = N_Expanded_Name
10272 then
10273 Par_Ent := Entity (Prefix (Gen_Id));
10274 Par_Vis := Is_Immediately_Visible (Par_Ent);
10275 Install_Parent (Par_Ent, In_Body => True);
10276 Parent_Installed := True;
10278 elsif Is_Child_Unit (Gen_Unit) then
10279 Par_Ent := Scope (Gen_Unit);
10280 Par_Vis := Is_Immediately_Visible (Par_Ent);
10281 Install_Parent (Par_Ent, In_Body => True);
10282 Parent_Installed := True;
10283 end if;
10285 -- Inside its body, a reference to the generic unit is a reference
10286 -- to the instance. The corresponding renaming is the first
10287 -- declaration in the body.
10289 Unit_Renaming :=
10290 Make_Subprogram_Renaming_Declaration (Loc,
10291 Specification =>
10292 Copy_Generic_Node (
10293 Specification (Original_Node (Gen_Body)),
10294 Empty,
10295 Instantiating => True),
10296 Name => New_Occurrence_Of (Anon_Id, Loc));
10298 -- If there is a formal subprogram with the same name as the unit
10299 -- itself, do not add this renaming declaration. This is a temporary
10300 -- fix for one ACVC test. ???
10302 Prev_Formal := First_Entity (Pack_Id);
10303 while Present (Prev_Formal) loop
10304 if Chars (Prev_Formal) = Chars (Gen_Unit)
10305 and then Is_Overloadable (Prev_Formal)
10306 then
10307 exit;
10308 end if;
10310 Next_Entity (Prev_Formal);
10311 end loop;
10313 if Present (Prev_Formal) then
10314 Decls := New_List (Act_Body);
10315 else
10316 Decls := New_List (Unit_Renaming, Act_Body);
10317 end if;
10319 -- The subprogram body is placed in the body of a dummy package body,
10320 -- whose spec contains the subprogram declaration as well as the
10321 -- renaming declarations for the generic parameters.
10323 Pack_Body := Make_Package_Body (Loc,
10324 Defining_Unit_Name => New_Copy (Pack_Id),
10325 Declarations => Decls);
10327 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10329 -- If the instantiation is a library unit, then build resulting
10330 -- compilation unit nodes for the instance. The declaration of
10331 -- the enclosing package is the grandparent of the subprogram
10332 -- declaration. First replace the instantiation node as the unit
10333 -- of the corresponding compilation.
10335 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
10336 if Parent (Inst_Node) = Cunit (Main_Unit) then
10337 Set_Unit (Parent (Inst_Node), Inst_Node);
10338 Build_Instance_Compilation_Unit_Nodes
10339 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
10340 Analyze (Inst_Node);
10341 else
10342 Set_Parent (Pack_Body, Parent (Inst_Node));
10343 Analyze (Pack_Body);
10344 end if;
10346 else
10347 Insert_Before (Inst_Node, Pack_Body);
10348 Mark_Rewrite_Insertion (Pack_Body);
10349 Analyze (Pack_Body);
10351 if Expander_Active then
10352 Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
10353 end if;
10354 end if;
10356 Inherit_Context (Gen_Body, Inst_Node);
10358 Restore_Private_Views (Pack_Id, False);
10360 if Parent_Installed then
10361 Remove_Parent (In_Body => True);
10363 -- Restore the previous visibility of the parent
10365 Set_Is_Immediately_Visible (Par_Ent, Par_Vis);
10366 end if;
10368 Restore_Env;
10369 Style_Check := Save_Style_Check;
10371 -- Body not found. Error was emitted already. If there were no previous
10372 -- errors, this may be an instance whose scope is a premature instance.
10373 -- In that case we must insure that the (legal) program does raise
10374 -- program error if executed. We generate a subprogram body for this
10375 -- purpose. See DEC ac30vso.
10377 -- Should not reference proprietary DEC tests in comments ???
10379 elsif Serious_Errors_Detected = 0
10380 and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
10381 then
10382 if Body_Optional then
10383 return;
10385 elsif Ekind (Anon_Id) = E_Procedure then
10386 Act_Body :=
10387 Make_Subprogram_Body (Loc,
10388 Specification =>
10389 Make_Procedure_Specification (Loc,
10390 Defining_Unit_Name =>
10391 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10392 Parameter_Specifications =>
10393 New_Copy_List
10394 (Parameter_Specifications (Parent (Anon_Id)))),
10396 Declarations => Empty_List,
10397 Handled_Statement_Sequence =>
10398 Make_Handled_Sequence_Of_Statements (Loc,
10399 Statements =>
10400 New_List (
10401 Make_Raise_Program_Error (Loc,
10402 Reason =>
10403 PE_Access_Before_Elaboration))));
10405 else
10406 Ret_Expr :=
10407 Make_Raise_Program_Error (Loc,
10408 Reason => PE_Access_Before_Elaboration);
10410 Set_Etype (Ret_Expr, (Etype (Anon_Id)));
10411 Set_Analyzed (Ret_Expr);
10413 Act_Body :=
10414 Make_Subprogram_Body (Loc,
10415 Specification =>
10416 Make_Function_Specification (Loc,
10417 Defining_Unit_Name =>
10418 Make_Defining_Identifier (Loc, Chars (Anon_Id)),
10419 Parameter_Specifications =>
10420 New_Copy_List
10421 (Parameter_Specifications (Parent (Anon_Id))),
10422 Result_Definition =>
10423 New_Occurrence_Of (Etype (Anon_Id), Loc)),
10425 Declarations => Empty_List,
10426 Handled_Statement_Sequence =>
10427 Make_Handled_Sequence_Of_Statements (Loc,
10428 Statements =>
10429 New_List
10430 (Make_Simple_Return_Statement (Loc, Ret_Expr))));
10431 end if;
10433 Pack_Body := Make_Package_Body (Loc,
10434 Defining_Unit_Name => New_Copy (Pack_Id),
10435 Declarations => New_List (Act_Body));
10437 Insert_After (Inst_Node, Pack_Body);
10438 Set_Corresponding_Spec (Pack_Body, Pack_Id);
10439 Analyze (Pack_Body);
10440 end if;
10442 Expander_Mode_Restore;
10443 end Instantiate_Subprogram_Body;
10445 ----------------------
10446 -- Instantiate_Type --
10447 ----------------------
10449 function Instantiate_Type
10450 (Formal : Node_Id;
10451 Actual : Node_Id;
10452 Analyzed_Formal : Node_Id;
10453 Actual_Decls : List_Id) return List_Id
10455 Gen_T : constant Entity_Id := Defining_Identifier (Formal);
10456 A_Gen_T : constant Entity_Id :=
10457 Defining_Identifier (Analyzed_Formal);
10458 Ancestor : Entity_Id := Empty;
10459 Def : constant Node_Id := Formal_Type_Definition (Formal);
10460 Act_T : Entity_Id;
10461 Decl_Node : Node_Id;
10462 Decl_Nodes : List_Id;
10463 Loc : Source_Ptr;
10464 Subt : Entity_Id;
10466 procedure Validate_Array_Type_Instance;
10467 procedure Validate_Access_Subprogram_Instance;
10468 procedure Validate_Access_Type_Instance;
10469 procedure Validate_Derived_Type_Instance;
10470 procedure Validate_Derived_Interface_Type_Instance;
10471 procedure Validate_Discriminated_Formal_Type;
10472 procedure Validate_Interface_Type_Instance;
10473 procedure Validate_Private_Type_Instance;
10474 procedure Validate_Incomplete_Type_Instance;
10475 -- These procedures perform validation tests for the named case.
10476 -- Validate_Discriminated_Formal_Type is shared by formal private
10477 -- types and Ada 2012 formal incomplete types.
10479 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
10480 -- Check that base types are the same and that the subtypes match
10481 -- statically. Used in several of the above.
10483 --------------------
10484 -- Subtypes_Match --
10485 --------------------
10487 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
10488 T : constant Entity_Id := Get_Instance_Of (Gen_T);
10490 begin
10491 -- Some detailed comments would be useful here ???
10493 return ((Base_Type (T) = Act_T
10494 or else Base_Type (T) = Base_Type (Act_T))
10495 and then Subtypes_Statically_Match (T, Act_T))
10497 or else (Is_Class_Wide_Type (Gen_T)
10498 and then Is_Class_Wide_Type (Act_T)
10499 and then Subtypes_Match
10500 (Get_Instance_Of (Root_Type (Gen_T)),
10501 Root_Type (Act_T)))
10503 or else
10504 (Ekind_In (Gen_T, E_Anonymous_Access_Subprogram_Type,
10505 E_Anonymous_Access_Type)
10506 and then Ekind (Act_T) = Ekind (Gen_T)
10507 and then Subtypes_Statically_Match
10508 (Designated_Type (Gen_T), Designated_Type (Act_T)));
10509 end Subtypes_Match;
10511 -----------------------------------------
10512 -- Validate_Access_Subprogram_Instance --
10513 -----------------------------------------
10515 procedure Validate_Access_Subprogram_Instance is
10516 begin
10517 if not Is_Access_Type (Act_T)
10518 or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
10519 then
10520 Error_Msg_NE
10521 ("expect access type in instantiation of &", Actual, Gen_T);
10522 Abandon_Instantiation (Actual);
10523 end if;
10525 -- According to AI05-288, actuals for access_to_subprograms must be
10526 -- subtype conformant with the generic formal. Previous to AI05-288
10527 -- only mode conformance was required.
10529 -- This is a binding interpretation that applies to previous versions
10530 -- of the language, but for now we retain the milder check in order
10531 -- to preserve ACATS tests. These will be protested eventually ???
10533 if Ada_Version < Ada_2012 then
10534 Check_Mode_Conformant
10535 (Designated_Type (Act_T),
10536 Designated_Type (A_Gen_T),
10537 Actual,
10538 Get_Inst => True);
10540 else
10541 Check_Subtype_Conformant
10542 (Designated_Type (Act_T),
10543 Designated_Type (A_Gen_T),
10544 Actual,
10545 Get_Inst => True);
10546 end if;
10548 if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
10549 if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
10550 Error_Msg_NE
10551 ("protected access type not allowed for formal &",
10552 Actual, Gen_T);
10553 end if;
10555 elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
10556 Error_Msg_NE
10557 ("expect protected access type for formal &",
10558 Actual, Gen_T);
10559 end if;
10560 end Validate_Access_Subprogram_Instance;
10562 -----------------------------------
10563 -- Validate_Access_Type_Instance --
10564 -----------------------------------
10566 procedure Validate_Access_Type_Instance is
10567 Desig_Type : constant Entity_Id :=
10568 Find_Actual_Type (Designated_Type (A_Gen_T), A_Gen_T);
10569 Desig_Act : Entity_Id;
10571 begin
10572 if not Is_Access_Type (Act_T) then
10573 Error_Msg_NE
10574 ("expect access type in instantiation of &", Actual, Gen_T);
10575 Abandon_Instantiation (Actual);
10576 end if;
10578 if Is_Access_Constant (A_Gen_T) then
10579 if not Is_Access_Constant (Act_T) then
10580 Error_Msg_N
10581 ("actual type must be access-to-constant type", Actual);
10582 Abandon_Instantiation (Actual);
10583 end if;
10584 else
10585 if Is_Access_Constant (Act_T) then
10586 Error_Msg_N
10587 ("actual type must be access-to-variable type", Actual);
10588 Abandon_Instantiation (Actual);
10590 elsif Ekind (A_Gen_T) = E_General_Access_Type
10591 and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
10592 then
10593 Error_Msg_N -- CODEFIX
10594 ("actual must be general access type!", Actual);
10595 Error_Msg_NE -- CODEFIX
10596 ("add ALL to }!", Actual, Act_T);
10597 Abandon_Instantiation (Actual);
10598 end if;
10599 end if;
10601 -- The designated subtypes, that is to say the subtypes introduced
10602 -- by an access type declaration (and not by a subtype declaration)
10603 -- must match.
10605 Desig_Act := Designated_Type (Base_Type (Act_T));
10607 -- The designated type may have been introduced through a limited_
10608 -- with clause, in which case retrieve the non-limited view. This
10609 -- applies to incomplete types as well as to class-wide types.
10611 if From_With_Type (Desig_Act) then
10612 Desig_Act := Available_View (Desig_Act);
10613 end if;
10615 if not Subtypes_Match
10616 (Desig_Type, Desig_Act) then
10617 Error_Msg_NE
10618 ("designated type of actual does not match that of formal &",
10619 Actual, Gen_T);
10620 Abandon_Instantiation (Actual);
10622 elsif Is_Access_Type (Designated_Type (Act_T))
10623 and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
10625 Is_Constrained (Designated_Type (Desig_Type))
10626 then
10627 Error_Msg_NE
10628 ("designated type of actual does not match that of formal &",
10629 Actual, Gen_T);
10630 Abandon_Instantiation (Actual);
10631 end if;
10633 -- Ada 2005: null-exclusion indicators of the two types must agree
10635 if Can_Never_Be_Null (A_Gen_T) /= Can_Never_Be_Null (Act_T) then
10636 Error_Msg_NE
10637 ("non null exclusion of actual and formal & do not match",
10638 Actual, Gen_T);
10639 end if;
10640 end Validate_Access_Type_Instance;
10642 ----------------------------------
10643 -- Validate_Array_Type_Instance --
10644 ----------------------------------
10646 procedure Validate_Array_Type_Instance is
10647 I1 : Node_Id;
10648 I2 : Node_Id;
10649 T2 : Entity_Id;
10651 function Formal_Dimensions return Int;
10652 -- Count number of dimensions in array type formal
10654 -----------------------
10655 -- Formal_Dimensions --
10656 -----------------------
10658 function Formal_Dimensions return Int is
10659 Num : Int := 0;
10660 Index : Node_Id;
10662 begin
10663 if Nkind (Def) = N_Constrained_Array_Definition then
10664 Index := First (Discrete_Subtype_Definitions (Def));
10665 else
10666 Index := First (Subtype_Marks (Def));
10667 end if;
10669 while Present (Index) loop
10670 Num := Num + 1;
10671 Next_Index (Index);
10672 end loop;
10674 return Num;
10675 end Formal_Dimensions;
10677 -- Start of processing for Validate_Array_Type_Instance
10679 begin
10680 if not Is_Array_Type (Act_T) then
10681 Error_Msg_NE
10682 ("expect array type in instantiation of &", Actual, Gen_T);
10683 Abandon_Instantiation (Actual);
10685 elsif Nkind (Def) = N_Constrained_Array_Definition then
10686 if not (Is_Constrained (Act_T)) then
10687 Error_Msg_NE
10688 ("expect constrained array in instantiation of &",
10689 Actual, Gen_T);
10690 Abandon_Instantiation (Actual);
10691 end if;
10693 else
10694 if Is_Constrained (Act_T) then
10695 Error_Msg_NE
10696 ("expect unconstrained array in instantiation of &",
10697 Actual, Gen_T);
10698 Abandon_Instantiation (Actual);
10699 end if;
10700 end if;
10702 if Formal_Dimensions /= Number_Dimensions (Act_T) then
10703 Error_Msg_NE
10704 ("dimensions of actual do not match formal &", Actual, Gen_T);
10705 Abandon_Instantiation (Actual);
10706 end if;
10708 I1 := First_Index (A_Gen_T);
10709 I2 := First_Index (Act_T);
10710 for J in 1 .. Formal_Dimensions loop
10712 -- If the indexes of the actual were given by a subtype_mark,
10713 -- the index was transformed into a range attribute. Retrieve
10714 -- the original type mark for checking.
10716 if Is_Entity_Name (Original_Node (I2)) then
10717 T2 := Entity (Original_Node (I2));
10718 else
10719 T2 := Etype (I2);
10720 end if;
10722 if not Subtypes_Match
10723 (Find_Actual_Type (Etype (I1), A_Gen_T), T2)
10724 then
10725 Error_Msg_NE
10726 ("index types of actual do not match those of formal &",
10727 Actual, Gen_T);
10728 Abandon_Instantiation (Actual);
10729 end if;
10731 Next_Index (I1);
10732 Next_Index (I2);
10733 end loop;
10735 -- Check matching subtypes. Note that there are complex visibility
10736 -- issues when the generic is a child unit and some aspect of the
10737 -- generic type is declared in a parent unit of the generic. We do
10738 -- the test to handle this special case only after a direct check
10739 -- for static matching has failed. The case where both the component
10740 -- type and the array type are separate formals, and the component
10741 -- type is a private view may also require special checking in
10742 -- Subtypes_Match.
10744 if Subtypes_Match
10745 (Component_Type (A_Gen_T), Component_Type (Act_T))
10746 or else Subtypes_Match
10747 (Find_Actual_Type (Component_Type (A_Gen_T), A_Gen_T),
10748 Component_Type (Act_T))
10749 then
10750 null;
10751 else
10752 Error_Msg_NE
10753 ("component subtype of actual does not match that of formal &",
10754 Actual, Gen_T);
10755 Abandon_Instantiation (Actual);
10756 end if;
10758 if Has_Aliased_Components (A_Gen_T)
10759 and then not Has_Aliased_Components (Act_T)
10760 then
10761 Error_Msg_NE
10762 ("actual must have aliased components to match formal type &",
10763 Actual, Gen_T);
10764 end if;
10765 end Validate_Array_Type_Instance;
10767 -----------------------------------------------
10768 -- Validate_Derived_Interface_Type_Instance --
10769 -----------------------------------------------
10771 procedure Validate_Derived_Interface_Type_Instance is
10772 Par : constant Entity_Id := Entity (Subtype_Indication (Def));
10773 Elmt : Elmt_Id;
10775 begin
10776 -- First apply interface instance checks
10778 Validate_Interface_Type_Instance;
10780 -- Verify that immediate parent interface is an ancestor of
10781 -- the actual.
10783 if Present (Par)
10784 and then not Interface_Present_In_Ancestor (Act_T, Par)
10785 then
10786 Error_Msg_NE
10787 ("interface actual must include progenitor&", Actual, Par);
10788 end if;
10790 -- Now verify that the actual includes all other ancestors of
10791 -- the formal.
10793 Elmt := First_Elmt (Interfaces (A_Gen_T));
10794 while Present (Elmt) loop
10795 if not Interface_Present_In_Ancestor
10796 (Act_T, Get_Instance_Of (Node (Elmt)))
10797 then
10798 Error_Msg_NE
10799 ("interface actual must include progenitor&",
10800 Actual, Node (Elmt));
10801 end if;
10803 Next_Elmt (Elmt);
10804 end loop;
10805 end Validate_Derived_Interface_Type_Instance;
10807 ------------------------------------
10808 -- Validate_Derived_Type_Instance --
10809 ------------------------------------
10811 procedure Validate_Derived_Type_Instance is
10812 Actual_Discr : Entity_Id;
10813 Ancestor_Discr : Entity_Id;
10815 begin
10816 -- If the parent type in the generic declaration is itself a previous
10817 -- formal type, then it is local to the generic and absent from the
10818 -- analyzed generic definition. In that case the ancestor is the
10819 -- instance of the formal (which must have been instantiated
10820 -- previously), unless the ancestor is itself a formal derived type.
10821 -- In this latter case (which is the subject of Corrigendum 8652/0038
10822 -- (AI-202) the ancestor of the formals is the ancestor of its
10823 -- parent. Otherwise, the analyzed generic carries the parent type.
10824 -- If the parent type is defined in a previous formal package, then
10825 -- the scope of that formal package is that of the generic type
10826 -- itself, and it has already been mapped into the corresponding type
10827 -- in the actual package.
10829 -- Common case: parent type defined outside of the generic
10831 if Is_Entity_Name (Subtype_Mark (Def))
10832 and then Present (Entity (Subtype_Mark (Def)))
10833 then
10834 Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
10836 -- Check whether parent is defined in a previous formal package
10838 elsif
10839 Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
10840 then
10841 Ancestor :=
10842 Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
10844 -- The type may be a local derivation, or a type extension of a
10845 -- previous formal, or of a formal of a parent package.
10847 elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
10848 or else
10849 Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
10850 then
10851 -- Check whether the parent is another derived formal type in the
10852 -- same generic unit.
10854 if Etype (A_Gen_T) /= A_Gen_T
10855 and then Is_Generic_Type (Etype (A_Gen_T))
10856 and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
10857 and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
10858 then
10859 -- Locate ancestor of parent from the subtype declaration
10860 -- created for the actual.
10862 declare
10863 Decl : Node_Id;
10865 begin
10866 Decl := First (Actual_Decls);
10867 while Present (Decl) loop
10868 if Nkind (Decl) = N_Subtype_Declaration
10869 and then Chars (Defining_Identifier (Decl)) =
10870 Chars (Etype (A_Gen_T))
10871 then
10872 Ancestor := Generic_Parent_Type (Decl);
10873 exit;
10874 else
10875 Next (Decl);
10876 end if;
10877 end loop;
10878 end;
10880 pragma Assert (Present (Ancestor));
10882 -- The ancestor itself may be a previous formal that has been
10883 -- instantiated.
10885 Ancestor := Get_Instance_Of (Ancestor);
10887 else
10888 Ancestor :=
10889 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
10890 end if;
10892 -- An unusual case: the actual is a type declared in a parent unit,
10893 -- but is not a formal type so there is no instance_of for it.
10894 -- Retrieve it by analyzing the record extension.
10896 elsif Is_Child_Unit (Scope (A_Gen_T))
10897 and then In_Open_Scopes (Scope (Act_T))
10898 and then Is_Generic_Instance (Scope (Act_T))
10899 then
10900 Analyze (Subtype_Mark (Def));
10901 Ancestor := Entity (Subtype_Mark (Def));
10903 else
10904 Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
10905 end if;
10907 -- If the formal derived type has pragma Preelaborable_Initialization
10908 -- then the actual type must have preelaborable initialization.
10910 if Known_To_Have_Preelab_Init (A_Gen_T)
10911 and then not Has_Preelaborable_Initialization (Act_T)
10912 then
10913 Error_Msg_NE
10914 ("actual for & must have preelaborable initialization",
10915 Actual, Gen_T);
10916 end if;
10918 -- Ada 2005 (AI-251)
10920 if Ada_Version >= Ada_2005
10921 and then Is_Interface (Ancestor)
10922 then
10923 if not Interface_Present_In_Ancestor (Act_T, Ancestor) then
10924 Error_Msg_NE
10925 ("(Ada 2005) expected type implementing & in instantiation",
10926 Actual, Ancestor);
10927 end if;
10929 elsif not Is_Ancestor (Base_Type (Ancestor), Act_T) then
10930 Error_Msg_NE
10931 ("expect type derived from & in instantiation",
10932 Actual, First_Subtype (Ancestor));
10933 Abandon_Instantiation (Actual);
10934 end if;
10936 -- Ada 2005 (AI-443): Synchronized formal derived type checks. Note
10937 -- that the formal type declaration has been rewritten as a private
10938 -- extension.
10940 if Ada_Version >= Ada_2005
10941 and then Nkind (Parent (A_Gen_T)) = N_Private_Extension_Declaration
10942 and then Synchronized_Present (Parent (A_Gen_T))
10943 then
10944 -- The actual must be a synchronized tagged type
10946 if not Is_Tagged_Type (Act_T) then
10947 Error_Msg_N
10948 ("actual of synchronized type must be tagged", Actual);
10949 Abandon_Instantiation (Actual);
10951 elsif Nkind (Parent (Act_T)) = N_Full_Type_Declaration
10952 and then Nkind (Type_Definition (Parent (Act_T))) =
10953 N_Derived_Type_Definition
10954 and then not Synchronized_Present (Type_Definition
10955 (Parent (Act_T)))
10956 then
10957 Error_Msg_N
10958 ("actual of synchronized type must be synchronized", Actual);
10959 Abandon_Instantiation (Actual);
10960 end if;
10961 end if;
10963 -- Perform atomic/volatile checks (RM C.6(12)). Note that AI05-0218-1
10964 -- removes the second instance of the phrase "or allow pass by copy".
10966 if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
10967 Error_Msg_N
10968 ("cannot have atomic actual type for non-atomic formal type",
10969 Actual);
10971 elsif Is_Volatile (Act_T) and then not Is_Volatile (Ancestor) then
10972 Error_Msg_N
10973 ("cannot have volatile actual type for non-volatile formal type",
10974 Actual);
10975 end if;
10977 -- It should not be necessary to check for unknown discriminants on
10978 -- Formal, but for some reason Has_Unknown_Discriminants is false for
10979 -- A_Gen_T, so Is_Indefinite_Subtype incorrectly returns False. This
10980 -- needs fixing. ???
10982 if not Is_Indefinite_Subtype (A_Gen_T)
10983 and then not Unknown_Discriminants_Present (Formal)
10984 and then Is_Indefinite_Subtype (Act_T)
10985 then
10986 Error_Msg_N
10987 ("actual subtype must be constrained", Actual);
10988 Abandon_Instantiation (Actual);
10989 end if;
10991 if not Unknown_Discriminants_Present (Formal) then
10992 if Is_Constrained (Ancestor) then
10993 if not Is_Constrained (Act_T) then
10994 Error_Msg_N
10995 ("actual subtype must be constrained", Actual);
10996 Abandon_Instantiation (Actual);
10997 end if;
10999 -- Ancestor is unconstrained, Check if generic formal and actual
11000 -- agree on constrainedness. The check only applies to array types
11001 -- and discriminated types.
11003 elsif Is_Constrained (Act_T) then
11004 if Ekind (Ancestor) = E_Access_Type
11005 or else
11006 (not Is_Constrained (A_Gen_T)
11007 and then Is_Composite_Type (A_Gen_T))
11008 then
11009 Error_Msg_N
11010 ("actual subtype must be unconstrained", Actual);
11011 Abandon_Instantiation (Actual);
11012 end if;
11014 -- A class-wide type is only allowed if the formal has unknown
11015 -- discriminants.
11017 elsif Is_Class_Wide_Type (Act_T)
11018 and then not Has_Unknown_Discriminants (Ancestor)
11019 then
11020 Error_Msg_NE
11021 ("actual for & cannot be a class-wide type", Actual, Gen_T);
11022 Abandon_Instantiation (Actual);
11024 -- Otherwise, the formal and actual shall have the same number
11025 -- of discriminants and each discriminant of the actual must
11026 -- correspond to a discriminant of the formal.
11028 elsif Has_Discriminants (Act_T)
11029 and then not Has_Unknown_Discriminants (Act_T)
11030 and then Has_Discriminants (Ancestor)
11031 then
11032 Actual_Discr := First_Discriminant (Act_T);
11033 Ancestor_Discr := First_Discriminant (Ancestor);
11034 while Present (Actual_Discr)
11035 and then Present (Ancestor_Discr)
11036 loop
11037 if Base_Type (Act_T) /= Base_Type (Ancestor) and then
11038 No (Corresponding_Discriminant (Actual_Discr))
11039 then
11040 Error_Msg_NE
11041 ("discriminant & does not correspond " &
11042 "to ancestor discriminant", Actual, Actual_Discr);
11043 Abandon_Instantiation (Actual);
11044 end if;
11046 Next_Discriminant (Actual_Discr);
11047 Next_Discriminant (Ancestor_Discr);
11048 end loop;
11050 if Present (Actual_Discr) or else Present (Ancestor_Discr) then
11051 Error_Msg_NE
11052 ("actual for & must have same number of discriminants",
11053 Actual, Gen_T);
11054 Abandon_Instantiation (Actual);
11055 end if;
11057 -- This case should be caught by the earlier check for
11058 -- constrainedness, but the check here is added for completeness.
11060 elsif Has_Discriminants (Act_T)
11061 and then not Has_Unknown_Discriminants (Act_T)
11062 then
11063 Error_Msg_NE
11064 ("actual for & must not have discriminants", Actual, Gen_T);
11065 Abandon_Instantiation (Actual);
11067 elsif Has_Discriminants (Ancestor) then
11068 Error_Msg_NE
11069 ("actual for & must have known discriminants", Actual, Gen_T);
11070 Abandon_Instantiation (Actual);
11071 end if;
11073 if not Subtypes_Statically_Compatible (Act_T, Ancestor) then
11074 Error_Msg_N
11075 ("constraint on actual is incompatible with formal", Actual);
11076 Abandon_Instantiation (Actual);
11077 end if;
11078 end if;
11080 -- If the formal and actual types are abstract, check that there
11081 -- are no abstract primitives of the actual type that correspond to
11082 -- nonabstract primitives of the formal type (second sentence of
11083 -- RM95-3.9.3(9)).
11085 if Is_Abstract_Type (A_Gen_T) and then Is_Abstract_Type (Act_T) then
11086 Check_Abstract_Primitives : declare
11087 Gen_Prims : constant Elist_Id :=
11088 Primitive_Operations (A_Gen_T);
11089 Gen_Elmt : Elmt_Id;
11090 Gen_Subp : Entity_Id;
11091 Anc_Subp : Entity_Id;
11092 Anc_Formal : Entity_Id;
11093 Anc_F_Type : Entity_Id;
11095 Act_Prims : constant Elist_Id := Primitive_Operations (Act_T);
11096 Act_Elmt : Elmt_Id;
11097 Act_Subp : Entity_Id;
11098 Act_Formal : Entity_Id;
11099 Act_F_Type : Entity_Id;
11101 Subprograms_Correspond : Boolean;
11103 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean;
11104 -- Returns true if T2 is derived directly or indirectly from
11105 -- T1, including derivations from interfaces. T1 and T2 are
11106 -- required to be specific tagged base types.
11108 ------------------------
11109 -- Is_Tagged_Ancestor --
11110 ------------------------
11112 function Is_Tagged_Ancestor (T1, T2 : Entity_Id) return Boolean
11114 Intfc_Elmt : Elmt_Id;
11116 begin
11117 -- The predicate is satisfied if the types are the same
11119 if T1 = T2 then
11120 return True;
11122 -- If we've reached the top of the derivation chain then
11123 -- we know that T1 is not an ancestor of T2.
11125 elsif Etype (T2) = T2 then
11126 return False;
11128 -- Proceed to check T2's immediate parent
11130 elsif Is_Ancestor (T1, Base_Type (Etype (T2))) then
11131 return True;
11133 -- Finally, check to see if T1 is an ancestor of any of T2's
11134 -- progenitors.
11136 else
11137 Intfc_Elmt := First_Elmt (Interfaces (T2));
11138 while Present (Intfc_Elmt) loop
11139 if Is_Ancestor (T1, Node (Intfc_Elmt)) then
11140 return True;
11141 end if;
11143 Next_Elmt (Intfc_Elmt);
11144 end loop;
11145 end if;
11147 return False;
11148 end Is_Tagged_Ancestor;
11150 -- Start of processing for Check_Abstract_Primitives
11152 begin
11153 -- Loop over all of the formal derived type's primitives
11155 Gen_Elmt := First_Elmt (Gen_Prims);
11156 while Present (Gen_Elmt) loop
11157 Gen_Subp := Node (Gen_Elmt);
11159 -- If the primitive of the formal is not abstract, then
11160 -- determine whether there is a corresponding primitive of
11161 -- the actual type that's abstract.
11163 if not Is_Abstract_Subprogram (Gen_Subp) then
11164 Act_Elmt := First_Elmt (Act_Prims);
11165 while Present (Act_Elmt) loop
11166 Act_Subp := Node (Act_Elmt);
11168 -- If we find an abstract primitive of the actual,
11169 -- then we need to test whether it corresponds to the
11170 -- subprogram from which the generic formal primitive
11171 -- is inherited.
11173 if Is_Abstract_Subprogram (Act_Subp) then
11174 Anc_Subp := Alias (Gen_Subp);
11176 -- Test whether we have a corresponding primitive
11177 -- by comparing names, kinds, formal types, and
11178 -- result types.
11180 if Chars (Anc_Subp) = Chars (Act_Subp)
11181 and then Ekind (Anc_Subp) = Ekind (Act_Subp)
11182 then
11183 Anc_Formal := First_Formal (Anc_Subp);
11184 Act_Formal := First_Formal (Act_Subp);
11185 while Present (Anc_Formal)
11186 and then Present (Act_Formal)
11187 loop
11188 Anc_F_Type := Etype (Anc_Formal);
11189 Act_F_Type := Etype (Act_Formal);
11191 if Ekind (Anc_F_Type)
11192 = E_Anonymous_Access_Type
11193 then
11194 Anc_F_Type := Designated_Type (Anc_F_Type);
11196 if Ekind (Act_F_Type)
11197 = E_Anonymous_Access_Type
11198 then
11199 Act_F_Type :=
11200 Designated_Type (Act_F_Type);
11201 else
11202 exit;
11203 end if;
11205 elsif
11206 Ekind (Act_F_Type) = E_Anonymous_Access_Type
11207 then
11208 exit;
11209 end if;
11211 Anc_F_Type := Base_Type (Anc_F_Type);
11212 Act_F_Type := Base_Type (Act_F_Type);
11214 -- If the formal is controlling, then the
11215 -- the type of the actual primitive's formal
11216 -- must be derived directly or indirectly
11217 -- from the type of the ancestor primitive's
11218 -- formal.
11220 if Is_Controlling_Formal (Anc_Formal) then
11221 if not Is_Tagged_Ancestor
11222 (Anc_F_Type, Act_F_Type)
11223 then
11224 exit;
11225 end if;
11227 -- Otherwise the types of the formals must
11228 -- be the same.
11230 elsif Anc_F_Type /= Act_F_Type then
11231 exit;
11232 end if;
11234 Next_Entity (Anc_Formal);
11235 Next_Entity (Act_Formal);
11236 end loop;
11238 -- If we traversed through all of the formals
11239 -- then so far the subprograms correspond, so
11240 -- now check that any result types correspond.
11242 if No (Anc_Formal) and then No (Act_Formal) then
11243 Subprograms_Correspond := True;
11245 if Ekind (Act_Subp) = E_Function then
11246 Anc_F_Type := Etype (Anc_Subp);
11247 Act_F_Type := Etype (Act_Subp);
11249 if Ekind (Anc_F_Type)
11250 = E_Anonymous_Access_Type
11251 then
11252 Anc_F_Type :=
11253 Designated_Type (Anc_F_Type);
11255 if Ekind (Act_F_Type)
11256 = E_Anonymous_Access_Type
11257 then
11258 Act_F_Type :=
11259 Designated_Type (Act_F_Type);
11260 else
11261 Subprograms_Correspond := False;
11262 end if;
11264 elsif
11265 Ekind (Act_F_Type)
11266 = E_Anonymous_Access_Type
11267 then
11268 Subprograms_Correspond := False;
11269 end if;
11271 Anc_F_Type := Base_Type (Anc_F_Type);
11272 Act_F_Type := Base_Type (Act_F_Type);
11274 -- Now either the result types must be
11275 -- the same or, if the result type is
11276 -- controlling, the result type of the
11277 -- actual primitive must descend from the
11278 -- result type of the ancestor primitive.
11280 if Subprograms_Correspond
11281 and then Anc_F_Type /= Act_F_Type
11282 and then
11283 Has_Controlling_Result (Anc_Subp)
11284 and then
11285 not Is_Tagged_Ancestor
11286 (Anc_F_Type, Act_F_Type)
11287 then
11288 Subprograms_Correspond := False;
11289 end if;
11290 end if;
11292 -- Found a matching subprogram belonging to
11293 -- formal ancestor type, so actual subprogram
11294 -- corresponds and this violates 3.9.3(9).
11296 if Subprograms_Correspond then
11297 Error_Msg_NE
11298 ("abstract subprogram & overrides " &
11299 "nonabstract subprogram of ancestor",
11300 Actual,
11301 Act_Subp);
11302 end if;
11303 end if;
11304 end if;
11305 end if;
11307 Next_Elmt (Act_Elmt);
11308 end loop;
11309 end if;
11311 Next_Elmt (Gen_Elmt);
11312 end loop;
11313 end Check_Abstract_Primitives;
11314 end if;
11316 -- Verify that limitedness matches. If parent is a limited
11317 -- interface then the generic formal is not unless declared
11318 -- explicitly so. If not declared limited, the actual cannot be
11319 -- limited (see AI05-0087).
11321 -- Even though this AI is a binding interpretation, we enable the
11322 -- check only in Ada 2012 mode, because this improper construct
11323 -- shows up in user code and in existing B-tests.
11325 if Is_Limited_Type (Act_T)
11326 and then not Is_Limited_Type (A_Gen_T)
11327 and then Ada_Version >= Ada_2012
11328 then
11329 if In_Instance then
11330 null;
11331 else
11332 Error_Msg_NE
11333 ("actual for non-limited & cannot be a limited type", Actual,
11334 Gen_T);
11335 Explain_Limited_Type (Act_T, Actual);
11336 Abandon_Instantiation (Actual);
11337 end if;
11338 end if;
11339 end Validate_Derived_Type_Instance;
11341 ----------------------------------------
11342 -- Validate_Discriminated_Formal_Type --
11343 ----------------------------------------
11345 procedure Validate_Discriminated_Formal_Type is
11346 Formal_Discr : Entity_Id;
11347 Actual_Discr : Entity_Id;
11348 Formal_Subt : Entity_Id;
11350 begin
11351 if Has_Discriminants (A_Gen_T) then
11352 if not Has_Discriminants (Act_T) then
11353 Error_Msg_NE
11354 ("actual for & must have discriminants", Actual, Gen_T);
11355 Abandon_Instantiation (Actual);
11357 elsif Is_Constrained (Act_T) then
11358 Error_Msg_NE
11359 ("actual for & must be unconstrained", Actual, Gen_T);
11360 Abandon_Instantiation (Actual);
11362 else
11363 Formal_Discr := First_Discriminant (A_Gen_T);
11364 Actual_Discr := First_Discriminant (Act_T);
11365 while Formal_Discr /= Empty loop
11366 if Actual_Discr = Empty then
11367 Error_Msg_NE
11368 ("discriminants on actual do not match formal",
11369 Actual, Gen_T);
11370 Abandon_Instantiation (Actual);
11371 end if;
11373 Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
11375 -- Access discriminants match if designated types do
11377 if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
11378 and then (Ekind (Base_Type (Etype (Actual_Discr)))) =
11379 E_Anonymous_Access_Type
11380 and then
11381 Get_Instance_Of
11382 (Designated_Type (Base_Type (Formal_Subt))) =
11383 Designated_Type (Base_Type (Etype (Actual_Discr)))
11384 then
11385 null;
11387 elsif Base_Type (Formal_Subt) /=
11388 Base_Type (Etype (Actual_Discr))
11389 then
11390 Error_Msg_NE
11391 ("types of actual discriminants must match formal",
11392 Actual, Gen_T);
11393 Abandon_Instantiation (Actual);
11395 elsif not Subtypes_Statically_Match
11396 (Formal_Subt, Etype (Actual_Discr))
11397 and then Ada_Version >= Ada_95
11398 then
11399 Error_Msg_NE
11400 ("subtypes of actual discriminants must match formal",
11401 Actual, Gen_T);
11402 Abandon_Instantiation (Actual);
11403 end if;
11405 Next_Discriminant (Formal_Discr);
11406 Next_Discriminant (Actual_Discr);
11407 end loop;
11409 if Actual_Discr /= Empty then
11410 Error_Msg_NE
11411 ("discriminants on actual do not match formal",
11412 Actual, Gen_T);
11413 Abandon_Instantiation (Actual);
11414 end if;
11415 end if;
11416 end if;
11417 end Validate_Discriminated_Formal_Type;
11419 ---------------------------------------
11420 -- Validate_Incomplete_Type_Instance --
11421 ---------------------------------------
11423 procedure Validate_Incomplete_Type_Instance is
11424 begin
11425 if not Is_Tagged_Type (Act_T)
11426 and then Is_Tagged_Type (A_Gen_T)
11427 then
11428 Error_Msg_NE
11429 ("actual for & must be a tagged type", Actual, Gen_T);
11430 end if;
11432 Validate_Discriminated_Formal_Type;
11433 end Validate_Incomplete_Type_Instance;
11435 --------------------------------------
11436 -- Validate_Interface_Type_Instance --
11437 --------------------------------------
11439 procedure Validate_Interface_Type_Instance is
11440 begin
11441 if not Is_Interface (Act_T) then
11442 Error_Msg_NE
11443 ("actual for formal interface type must be an interface",
11444 Actual, Gen_T);
11446 elsif Is_Limited_Type (Act_T) /= Is_Limited_Type (A_Gen_T)
11447 or else
11448 Is_Task_Interface (A_Gen_T) /= Is_Task_Interface (Act_T)
11449 or else
11450 Is_Protected_Interface (A_Gen_T) /=
11451 Is_Protected_Interface (Act_T)
11452 or else
11453 Is_Synchronized_Interface (A_Gen_T) /=
11454 Is_Synchronized_Interface (Act_T)
11455 then
11456 Error_Msg_NE
11457 ("actual for interface& does not match (RM 12.5.5(4))",
11458 Actual, Gen_T);
11459 end if;
11460 end Validate_Interface_Type_Instance;
11462 ------------------------------------
11463 -- Validate_Private_Type_Instance --
11464 ------------------------------------
11466 procedure Validate_Private_Type_Instance is
11467 begin
11468 if Is_Limited_Type (Act_T)
11469 and then not Is_Limited_Type (A_Gen_T)
11470 then
11471 if In_Instance then
11472 null;
11473 else
11474 Error_Msg_NE
11475 ("actual for non-limited & cannot be a limited type", Actual,
11476 Gen_T);
11477 Explain_Limited_Type (Act_T, Actual);
11478 Abandon_Instantiation (Actual);
11479 end if;
11481 elsif Known_To_Have_Preelab_Init (A_Gen_T)
11482 and then not Has_Preelaborable_Initialization (Act_T)
11483 then
11484 Error_Msg_NE
11485 ("actual for & must have preelaborable initialization", Actual,
11486 Gen_T);
11488 elsif Is_Indefinite_Subtype (Act_T)
11489 and then not Is_Indefinite_Subtype (A_Gen_T)
11490 and then Ada_Version >= Ada_95
11491 then
11492 Error_Msg_NE
11493 ("actual for & must be a definite subtype", Actual, Gen_T);
11495 elsif not Is_Tagged_Type (Act_T)
11496 and then Is_Tagged_Type (A_Gen_T)
11497 then
11498 Error_Msg_NE
11499 ("actual for & must be a tagged type", Actual, Gen_T);
11500 end if;
11502 Validate_Discriminated_Formal_Type;
11503 Ancestor := Gen_T;
11504 end Validate_Private_Type_Instance;
11506 -- Start of processing for Instantiate_Type
11508 begin
11509 if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
11510 Error_Msg_N ("duplicate instantiation of generic type", Actual);
11511 return New_List (Error);
11513 elsif not Is_Entity_Name (Actual)
11514 or else not Is_Type (Entity (Actual))
11515 then
11516 Error_Msg_NE
11517 ("expect valid subtype mark to instantiate &", Actual, Gen_T);
11518 Abandon_Instantiation (Actual);
11520 else
11521 Act_T := Entity (Actual);
11523 -- Ada 2005 (AI-216): An Unchecked_Union subtype shall only be passed
11524 -- as a generic actual parameter if the corresponding formal type
11525 -- does not have a known_discriminant_part, or is a formal derived
11526 -- type that is an Unchecked_Union type.
11528 if Is_Unchecked_Union (Base_Type (Act_T)) then
11529 if not Has_Discriminants (A_Gen_T)
11530 or else
11531 (Is_Derived_Type (A_Gen_T)
11532 and then
11533 Is_Unchecked_Union (A_Gen_T))
11534 then
11535 null;
11536 else
11537 Error_Msg_N ("unchecked union cannot be the actual for a" &
11538 " discriminated formal type", Act_T);
11540 end if;
11541 end if;
11543 -- Deal with fixed/floating restrictions
11545 if Is_Floating_Point_Type (Act_T) then
11546 Check_Restriction (No_Floating_Point, Actual);
11547 elsif Is_Fixed_Point_Type (Act_T) then
11548 Check_Restriction (No_Fixed_Point, Actual);
11549 end if;
11551 -- Deal with error of using incomplete type as generic actual.
11552 -- This includes limited views of a type, even if the non-limited
11553 -- view may be available.
11555 if Ekind (Act_T) = E_Incomplete_Type
11556 or else (Is_Class_Wide_Type (Act_T)
11557 and then
11558 Ekind (Root_Type (Act_T)) = E_Incomplete_Type)
11559 then
11560 -- If the formal is an incomplete type, the actual can be
11561 -- incomplete as well.
11563 if Ekind (A_Gen_T) = E_Incomplete_Type then
11564 null;
11566 elsif Is_Class_Wide_Type (Act_T)
11567 or else No (Full_View (Act_T))
11568 then
11569 Error_Msg_N ("premature use of incomplete type", Actual);
11570 Abandon_Instantiation (Actual);
11571 else
11572 Act_T := Full_View (Act_T);
11573 Set_Entity (Actual, Act_T);
11575 if Has_Private_Component (Act_T) then
11576 Error_Msg_N
11577 ("premature use of type with private component", Actual);
11578 end if;
11579 end if;
11581 -- Deal with error of premature use of private type as generic actual
11583 elsif Is_Private_Type (Act_T)
11584 and then Is_Private_Type (Base_Type (Act_T))
11585 and then not Is_Generic_Type (Act_T)
11586 and then not Is_Derived_Type (Act_T)
11587 and then No (Full_View (Root_Type (Act_T)))
11588 then
11589 -- If the formal is an incomplete type, the actual can be
11590 -- private or incomplete as well.
11592 if Ekind (A_Gen_T) = E_Incomplete_Type then
11593 null;
11594 else
11595 Error_Msg_N ("premature use of private type", Actual);
11596 end if;
11598 elsif Has_Private_Component (Act_T) then
11599 Error_Msg_N
11600 ("premature use of type with private component", Actual);
11601 end if;
11603 Set_Instance_Of (A_Gen_T, Act_T);
11605 -- If the type is generic, the class-wide type may also be used
11607 if Is_Tagged_Type (A_Gen_T)
11608 and then Is_Tagged_Type (Act_T)
11609 and then not Is_Class_Wide_Type (A_Gen_T)
11610 then
11611 Set_Instance_Of (Class_Wide_Type (A_Gen_T),
11612 Class_Wide_Type (Act_T));
11613 end if;
11615 if not Is_Abstract_Type (A_Gen_T)
11616 and then Is_Abstract_Type (Act_T)
11617 then
11618 Error_Msg_N
11619 ("actual of non-abstract formal cannot be abstract", Actual);
11620 end if;
11622 -- A generic scalar type is a first subtype for which we generate
11623 -- an anonymous base type. Indicate that the instance of this base
11624 -- is the base type of the actual.
11626 if Is_Scalar_Type (A_Gen_T) then
11627 Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
11628 end if;
11629 end if;
11631 if Error_Posted (Act_T) then
11632 null;
11633 else
11634 case Nkind (Def) is
11635 when N_Formal_Private_Type_Definition =>
11636 Validate_Private_Type_Instance;
11638 when N_Formal_Incomplete_Type_Definition =>
11639 Validate_Incomplete_Type_Instance;
11641 when N_Formal_Derived_Type_Definition =>
11642 Validate_Derived_Type_Instance;
11644 when N_Formal_Discrete_Type_Definition =>
11645 if not Is_Discrete_Type (Act_T) then
11646 Error_Msg_NE
11647 ("expect discrete type in instantiation of&",
11648 Actual, Gen_T);
11649 Abandon_Instantiation (Actual);
11650 end if;
11652 when N_Formal_Signed_Integer_Type_Definition =>
11653 if not Is_Signed_Integer_Type (Act_T) then
11654 Error_Msg_NE
11655 ("expect signed integer type in instantiation of&",
11656 Actual, Gen_T);
11657 Abandon_Instantiation (Actual);
11658 end if;
11660 when N_Formal_Modular_Type_Definition =>
11661 if not Is_Modular_Integer_Type (Act_T) then
11662 Error_Msg_NE
11663 ("expect modular type in instantiation of &",
11664 Actual, Gen_T);
11665 Abandon_Instantiation (Actual);
11666 end if;
11668 when N_Formal_Floating_Point_Definition =>
11669 if not Is_Floating_Point_Type (Act_T) then
11670 Error_Msg_NE
11671 ("expect float type in instantiation of &", Actual, Gen_T);
11672 Abandon_Instantiation (Actual);
11673 end if;
11675 when N_Formal_Ordinary_Fixed_Point_Definition =>
11676 if not Is_Ordinary_Fixed_Point_Type (Act_T) then
11677 Error_Msg_NE
11678 ("expect ordinary fixed point type in instantiation of &",
11679 Actual, Gen_T);
11680 Abandon_Instantiation (Actual);
11681 end if;
11683 when N_Formal_Decimal_Fixed_Point_Definition =>
11684 if not Is_Decimal_Fixed_Point_Type (Act_T) then
11685 Error_Msg_NE
11686 ("expect decimal type in instantiation of &",
11687 Actual, Gen_T);
11688 Abandon_Instantiation (Actual);
11689 end if;
11691 when N_Array_Type_Definition =>
11692 Validate_Array_Type_Instance;
11694 when N_Access_To_Object_Definition =>
11695 Validate_Access_Type_Instance;
11697 when N_Access_Function_Definition |
11698 N_Access_Procedure_Definition =>
11699 Validate_Access_Subprogram_Instance;
11701 when N_Record_Definition =>
11702 Validate_Interface_Type_Instance;
11704 when N_Derived_Type_Definition =>
11705 Validate_Derived_Interface_Type_Instance;
11707 when others =>
11708 raise Program_Error;
11710 end case;
11711 end if;
11713 Subt := New_Copy (Gen_T);
11715 -- Use adjusted sloc of subtype name as the location for other nodes in
11716 -- the subtype declaration.
11718 Loc := Sloc (Subt);
11720 Decl_Node :=
11721 Make_Subtype_Declaration (Loc,
11722 Defining_Identifier => Subt,
11723 Subtype_Indication => New_Reference_To (Act_T, Loc));
11725 if Is_Private_Type (Act_T) then
11726 Set_Has_Private_View (Subtype_Indication (Decl_Node));
11728 elsif Is_Access_Type (Act_T)
11729 and then Is_Private_Type (Designated_Type (Act_T))
11730 then
11731 Set_Has_Private_View (Subtype_Indication (Decl_Node));
11732 end if;
11734 Decl_Nodes := New_List (Decl_Node);
11736 -- Flag actual derived types so their elaboration produces the
11737 -- appropriate renamings for the primitive operations of the ancestor.
11738 -- Flag actual for formal private types as well, to determine whether
11739 -- operations in the private part may override inherited operations.
11740 -- If the formal has an interface list, the ancestor is not the
11741 -- parent, but the analyzed formal that includes the interface
11742 -- operations of all its progenitors.
11744 -- Same treatment for formal private types, so we can check whether the
11745 -- type is tagged limited when validating derivations in the private
11746 -- part. (See AI05-096).
11748 if Nkind (Def) = N_Formal_Derived_Type_Definition then
11749 if Present (Interface_List (Def)) then
11750 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11751 else
11752 Set_Generic_Parent_Type (Decl_Node, Ancestor);
11753 end if;
11755 elsif Nkind_In (Def,
11756 N_Formal_Private_Type_Definition,
11757 N_Formal_Incomplete_Type_Definition)
11758 then
11759 Set_Generic_Parent_Type (Decl_Node, A_Gen_T);
11760 end if;
11762 -- If the actual is a synchronized type that implements an interface,
11763 -- the primitive operations are attached to the corresponding record,
11764 -- and we have to treat it as an additional generic actual, so that its
11765 -- primitive operations become visible in the instance. The task or
11766 -- protected type itself does not carry primitive operations.
11768 if Is_Concurrent_Type (Act_T)
11769 and then Is_Tagged_Type (Act_T)
11770 and then Present (Corresponding_Record_Type (Act_T))
11771 and then Present (Ancestor)
11772 and then Is_Interface (Ancestor)
11773 then
11774 declare
11775 Corr_Rec : constant Entity_Id :=
11776 Corresponding_Record_Type (Act_T);
11777 New_Corr : Entity_Id;
11778 Corr_Decl : Node_Id;
11780 begin
11781 New_Corr := Make_Temporary (Loc, 'S');
11782 Corr_Decl :=
11783 Make_Subtype_Declaration (Loc,
11784 Defining_Identifier => New_Corr,
11785 Subtype_Indication =>
11786 New_Reference_To (Corr_Rec, Loc));
11787 Append_To (Decl_Nodes, Corr_Decl);
11789 if Ekind (Act_T) = E_Task_Type then
11790 Set_Ekind (Subt, E_Task_Subtype);
11791 else
11792 Set_Ekind (Subt, E_Protected_Subtype);
11793 end if;
11795 Set_Corresponding_Record_Type (Subt, Corr_Rec);
11796 Set_Generic_Parent_Type (Corr_Decl, Ancestor);
11797 Set_Generic_Parent_Type (Decl_Node, Empty);
11798 end;
11799 end if;
11801 return Decl_Nodes;
11802 end Instantiate_Type;
11804 ---------------------
11805 -- Is_In_Main_Unit --
11806 ---------------------
11808 function Is_In_Main_Unit (N : Node_Id) return Boolean is
11809 Unum : constant Unit_Number_Type := Get_Source_Unit (N);
11810 Current_Unit : Node_Id;
11812 begin
11813 if Unum = Main_Unit then
11814 return True;
11816 -- If the current unit is a subunit then it is either the main unit or
11817 -- is being compiled as part of the main unit.
11819 elsif Nkind (N) = N_Compilation_Unit then
11820 return Nkind (Unit (N)) = N_Subunit;
11821 end if;
11823 Current_Unit := Parent (N);
11824 while Present (Current_Unit)
11825 and then Nkind (Current_Unit) /= N_Compilation_Unit
11826 loop
11827 Current_Unit := Parent (Current_Unit);
11828 end loop;
11830 -- The instantiation node is in the main unit, or else the current node
11831 -- (perhaps as the result of nested instantiations) is in the main unit,
11832 -- or in the declaration of the main unit, which in this last case must
11833 -- be a body.
11835 return Unum = Main_Unit
11836 or else Current_Unit = Cunit (Main_Unit)
11837 or else Current_Unit = Library_Unit (Cunit (Main_Unit))
11838 or else (Present (Library_Unit (Current_Unit))
11839 and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
11840 end Is_In_Main_Unit;
11842 ----------------------------
11843 -- Load_Parent_Of_Generic --
11844 ----------------------------
11846 procedure Load_Parent_Of_Generic
11847 (N : Node_Id;
11848 Spec : Node_Id;
11849 Body_Optional : Boolean := False)
11851 Comp_Unit : constant Node_Id := Cunit (Get_Source_Unit (Spec));
11852 Save_Style_Check : constant Boolean := Style_Check;
11853 True_Parent : Node_Id;
11854 Inst_Node : Node_Id;
11855 OK : Boolean;
11856 Previous_Instances : constant Elist_Id := New_Elmt_List;
11858 procedure Collect_Previous_Instances (Decls : List_Id);
11859 -- Collect all instantiations in the given list of declarations, that
11860 -- precede the generic that we need to load. If the bodies of these
11861 -- instantiations are available, we must analyze them, to ensure that
11862 -- the public symbols generated are the same when the unit is compiled
11863 -- to generate code, and when it is compiled in the context of a unit
11864 -- that needs a particular nested instance. This process is applied to
11865 -- both package and subprogram instances.
11867 --------------------------------
11868 -- Collect_Previous_Instances --
11869 --------------------------------
11871 procedure Collect_Previous_Instances (Decls : List_Id) is
11872 Decl : Node_Id;
11874 begin
11875 Decl := First (Decls);
11876 while Present (Decl) loop
11877 if Sloc (Decl) >= Sloc (Inst_Node) then
11878 return;
11880 -- If Decl is an instantiation, then record it as requiring
11881 -- instantiation of the corresponding body, except if it is an
11882 -- abbreviated instantiation generated internally for conformance
11883 -- checking purposes only for the case of a formal package
11884 -- declared without a box (see Instantiate_Formal_Package). Such
11885 -- an instantiation does not generate any code (the actual code
11886 -- comes from actual) and thus does not need to be analyzed here.
11887 -- If the instantiation appears with a generic package body it is
11888 -- not analyzed here either.
11890 elsif Nkind (Decl) = N_Package_Instantiation
11891 and then not Is_Internal (Defining_Entity (Decl))
11892 then
11893 Append_Elmt (Decl, Previous_Instances);
11895 -- For a subprogram instantiation, omit instantiations intrinsic
11896 -- operations (Unchecked_Conversions, etc.) that have no bodies.
11898 elsif Nkind_In (Decl, N_Function_Instantiation,
11899 N_Procedure_Instantiation)
11900 and then not Is_Intrinsic_Subprogram (Entity (Name (Decl)))
11901 then
11902 Append_Elmt (Decl, Previous_Instances);
11904 elsif Nkind (Decl) = N_Package_Declaration then
11905 Collect_Previous_Instances
11906 (Visible_Declarations (Specification (Decl)));
11907 Collect_Previous_Instances
11908 (Private_Declarations (Specification (Decl)));
11910 -- Previous non-generic bodies may contain instances as well
11912 elsif Nkind (Decl) = N_Package_Body
11913 and then Ekind (Corresponding_Spec (Decl)) /= E_Generic_Package
11914 then
11915 Collect_Previous_Instances (Declarations (Decl));
11917 elsif Nkind (Decl) = N_Subprogram_Body
11918 and then not Acts_As_Spec (Decl)
11919 and then not Is_Generic_Subprogram (Corresponding_Spec (Decl))
11920 then
11921 Collect_Previous_Instances (Declarations (Decl));
11922 end if;
11924 Next (Decl);
11925 end loop;
11926 end Collect_Previous_Instances;
11928 -- Start of processing for Load_Parent_Of_Generic
11930 begin
11931 if not In_Same_Source_Unit (N, Spec)
11932 or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
11933 or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
11934 and then not Is_In_Main_Unit (Spec))
11935 then
11936 -- Find body of parent of spec, and analyze it. A special case arises
11937 -- when the parent is an instantiation, that is to say when we are
11938 -- currently instantiating a nested generic. In that case, there is
11939 -- no separate file for the body of the enclosing instance. Instead,
11940 -- the enclosing body must be instantiated as if it were a pending
11941 -- instantiation, in order to produce the body for the nested generic
11942 -- we require now. Note that in that case the generic may be defined
11943 -- in a package body, the instance defined in the same package body,
11944 -- and the original enclosing body may not be in the main unit.
11946 Inst_Node := Empty;
11948 True_Parent := Parent (Spec);
11949 while Present (True_Parent)
11950 and then Nkind (True_Parent) /= N_Compilation_Unit
11951 loop
11952 if Nkind (True_Parent) = N_Package_Declaration
11953 and then
11954 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
11955 then
11956 -- Parent is a compilation unit that is an instantiation.
11957 -- Instantiation node has been replaced with package decl.
11959 Inst_Node := Original_Node (True_Parent);
11960 exit;
11962 elsif Nkind (True_Parent) = N_Package_Declaration
11963 and then Present (Generic_Parent (Specification (True_Parent)))
11964 and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
11965 then
11966 -- Parent is an instantiation within another specification.
11967 -- Declaration for instance has been inserted before original
11968 -- instantiation node. A direct link would be preferable?
11970 Inst_Node := Next (True_Parent);
11971 while Present (Inst_Node)
11972 and then Nkind (Inst_Node) /= N_Package_Instantiation
11973 loop
11974 Next (Inst_Node);
11975 end loop;
11977 -- If the instance appears within a generic, and the generic
11978 -- unit is defined within a formal package of the enclosing
11979 -- generic, there is no generic body available, and none
11980 -- needed. A more precise test should be used ???
11982 if No (Inst_Node) then
11983 return;
11984 end if;
11986 exit;
11988 else
11989 True_Parent := Parent (True_Parent);
11990 end if;
11991 end loop;
11993 -- Case where we are currently instantiating a nested generic
11995 if Present (Inst_Node) then
11996 if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
11998 -- Instantiation node and declaration of instantiated package
11999 -- were exchanged when only the declaration was needed.
12000 -- Restore instantiation node before proceeding with body.
12002 Set_Unit (Parent (True_Parent), Inst_Node);
12003 end if;
12005 -- Now complete instantiation of enclosing body, if it appears in
12006 -- some other unit. If it appears in the current unit, the body
12007 -- will have been instantiated already.
12009 if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
12011 -- We need to determine the expander mode to instantiate the
12012 -- enclosing body. Because the generic body we need may use
12013 -- global entities declared in the enclosing package (including
12014 -- aggregates) it is in general necessary to compile this body
12015 -- with expansion enabled, except if we are within a generic
12016 -- package, in which case the usual generic rule applies.
12018 declare
12019 Exp_Status : Boolean := True;
12020 Scop : Entity_Id;
12022 begin
12023 -- Loop through scopes looking for generic package
12025 Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
12026 while Present (Scop)
12027 and then Scop /= Standard_Standard
12028 loop
12029 if Ekind (Scop) = E_Generic_Package then
12030 Exp_Status := False;
12031 exit;
12032 end if;
12034 Scop := Scope (Scop);
12035 end loop;
12037 -- Collect previous instantiations in the unit that contains
12038 -- the desired generic.
12040 if Nkind (Parent (True_Parent)) /= N_Compilation_Unit
12041 and then not Body_Optional
12042 then
12043 declare
12044 Decl : Elmt_Id;
12045 Info : Pending_Body_Info;
12046 Par : Node_Id;
12048 begin
12049 Par := Parent (Inst_Node);
12050 while Present (Par) loop
12051 exit when Nkind (Parent (Par)) = N_Compilation_Unit;
12052 Par := Parent (Par);
12053 end loop;
12055 pragma Assert (Present (Par));
12057 if Nkind (Par) = N_Package_Body then
12058 Collect_Previous_Instances (Declarations (Par));
12060 elsif Nkind (Par) = N_Package_Declaration then
12061 Collect_Previous_Instances
12062 (Visible_Declarations (Specification (Par)));
12063 Collect_Previous_Instances
12064 (Private_Declarations (Specification (Par)));
12066 else
12067 -- Enclosing unit is a subprogram body. In this
12068 -- case all instance bodies are processed in order
12069 -- and there is no need to collect them separately.
12071 null;
12072 end if;
12074 Decl := First_Elmt (Previous_Instances);
12075 while Present (Decl) loop
12076 Info :=
12077 (Inst_Node => Node (Decl),
12078 Act_Decl =>
12079 Instance_Spec (Node (Decl)),
12080 Expander_Status => Exp_Status,
12081 Current_Sem_Unit =>
12082 Get_Code_Unit (Sloc (Node (Decl))),
12083 Scope_Suppress => Scope_Suppress,
12084 Local_Suppress_Stack_Top =>
12085 Local_Suppress_Stack_Top,
12086 Version => Ada_Version);
12088 -- Package instance
12091 Nkind (Node (Decl)) = N_Package_Instantiation
12092 then
12093 Instantiate_Package_Body
12094 (Info, Body_Optional => True);
12096 -- Subprogram instance
12098 else
12099 -- The instance_spec is the wrapper package,
12100 -- and the subprogram declaration is the last
12101 -- declaration in the wrapper.
12103 Info.Act_Decl :=
12104 Last
12105 (Visible_Declarations
12106 (Specification (Info.Act_Decl)));
12108 Instantiate_Subprogram_Body
12109 (Info, Body_Optional => True);
12110 end if;
12112 Next_Elmt (Decl);
12113 end loop;
12114 end;
12115 end if;
12117 Instantiate_Package_Body
12118 (Body_Info =>
12119 ((Inst_Node => Inst_Node,
12120 Act_Decl => True_Parent,
12121 Expander_Status => Exp_Status,
12122 Current_Sem_Unit =>
12123 Get_Code_Unit (Sloc (Inst_Node)),
12124 Scope_Suppress => Scope_Suppress,
12125 Local_Suppress_Stack_Top =>
12126 Local_Suppress_Stack_Top,
12127 Version => Ada_Version)),
12128 Body_Optional => Body_Optional);
12129 end;
12130 end if;
12132 -- Case where we are not instantiating a nested generic
12134 else
12135 Opt.Style_Check := False;
12136 Expander_Mode_Save_And_Set (True);
12137 Load_Needed_Body (Comp_Unit, OK);
12138 Opt.Style_Check := Save_Style_Check;
12139 Expander_Mode_Restore;
12141 if not OK
12142 and then Unit_Requires_Body (Defining_Entity (Spec))
12143 and then not Body_Optional
12144 then
12145 declare
12146 Bname : constant Unit_Name_Type :=
12147 Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
12149 begin
12150 -- In CodePeer mode, the missing body may make the analysis
12151 -- incomplete, but we do not treat it as fatal.
12153 if CodePeer_Mode then
12154 return;
12156 else
12157 Error_Msg_Unit_1 := Bname;
12158 Error_Msg_N ("this instantiation requires$!", N);
12159 Error_Msg_File_1 :=
12160 Get_File_Name (Bname, Subunit => False);
12161 Error_Msg_N ("\but file{ was not found!", N);
12162 raise Unrecoverable_Error;
12163 end if;
12164 end;
12165 end if;
12166 end if;
12167 end if;
12169 -- If loading parent of the generic caused an instantiation circularity,
12170 -- we abandon compilation at this point, because otherwise in some cases
12171 -- we get into trouble with infinite recursions after this point.
12173 if Circularity_Detected then
12174 raise Unrecoverable_Error;
12175 end if;
12176 end Load_Parent_Of_Generic;
12178 ---------------------------------
12179 -- Map_Formal_Package_Entities --
12180 ---------------------------------
12182 procedure Map_Formal_Package_Entities (Form : Entity_Id; Act : Entity_Id) is
12183 E1 : Entity_Id;
12184 E2 : Entity_Id;
12186 begin
12187 Set_Instance_Of (Form, Act);
12189 -- Traverse formal and actual package to map the corresponding entities.
12190 -- We skip over internal entities that may be generated during semantic
12191 -- analysis, and find the matching entities by name, given that they
12192 -- must appear in the same order.
12194 E1 := First_Entity (Form);
12195 E2 := First_Entity (Act);
12196 while Present (E1) and then E1 /= First_Private_Entity (Form) loop
12197 -- Could this test be a single condition??? Seems like it could, and
12198 -- isn't FPE (Form) a constant anyway???
12200 if not Is_Internal (E1)
12201 and then Present (Parent (E1))
12202 and then not Is_Class_Wide_Type (E1)
12203 and then not Is_Internal_Name (Chars (E1))
12204 then
12205 while Present (E2) and then Chars (E2) /= Chars (E1) loop
12206 Next_Entity (E2);
12207 end loop;
12209 if No (E2) then
12210 exit;
12211 else
12212 Set_Instance_Of (E1, E2);
12214 if Is_Type (E1) and then Is_Tagged_Type (E2) then
12215 Set_Instance_Of (Class_Wide_Type (E1), Class_Wide_Type (E2));
12216 end if;
12218 if Is_Constrained (E1) then
12219 Set_Instance_Of (Base_Type (E1), Base_Type (E2));
12220 end if;
12222 if Ekind (E1) = E_Package and then No (Renamed_Object (E1)) then
12223 Map_Formal_Package_Entities (E1, E2);
12224 end if;
12225 end if;
12226 end if;
12228 Next_Entity (E1);
12229 end loop;
12230 end Map_Formal_Package_Entities;
12232 -----------------------
12233 -- Move_Freeze_Nodes --
12234 -----------------------
12236 procedure Move_Freeze_Nodes
12237 (Out_Of : Entity_Id;
12238 After : Node_Id;
12239 L : List_Id)
12241 Decl : Node_Id;
12242 Next_Decl : Node_Id;
12243 Next_Node : Node_Id := After;
12244 Spec : Node_Id;
12246 function Is_Outer_Type (T : Entity_Id) return Boolean;
12247 -- Check whether entity is declared in a scope external to that of the
12248 -- generic unit.
12250 -------------------
12251 -- Is_Outer_Type --
12252 -------------------
12254 function Is_Outer_Type (T : Entity_Id) return Boolean is
12255 Scop : Entity_Id := Scope (T);
12257 begin
12258 if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
12259 return True;
12261 else
12262 while Scop /= Standard_Standard loop
12263 if Scop = Out_Of then
12264 return False;
12265 else
12266 Scop := Scope (Scop);
12267 end if;
12268 end loop;
12270 return True;
12271 end if;
12272 end Is_Outer_Type;
12274 -- Start of processing for Move_Freeze_Nodes
12276 begin
12277 if No (L) then
12278 return;
12279 end if;
12281 -- First remove the freeze nodes that may appear before all other
12282 -- declarations.
12284 Decl := First (L);
12285 while Present (Decl)
12286 and then Nkind (Decl) = N_Freeze_Entity
12287 and then Is_Outer_Type (Entity (Decl))
12288 loop
12289 Decl := Remove_Head (L);
12290 Insert_After (Next_Node, Decl);
12291 Set_Analyzed (Decl, False);
12292 Next_Node := Decl;
12293 Decl := First (L);
12294 end loop;
12296 -- Next scan the list of declarations and remove each freeze node that
12297 -- appears ahead of the current node.
12299 while Present (Decl) loop
12300 while Present (Next (Decl))
12301 and then Nkind (Next (Decl)) = N_Freeze_Entity
12302 and then Is_Outer_Type (Entity (Next (Decl)))
12303 loop
12304 Next_Decl := Remove_Next (Decl);
12305 Insert_After (Next_Node, Next_Decl);
12306 Set_Analyzed (Next_Decl, False);
12307 Next_Node := Next_Decl;
12308 end loop;
12310 -- If the declaration is a nested package or concurrent type, then
12311 -- recurse. Nested generic packages will have been processed from the
12312 -- inside out.
12314 case Nkind (Decl) is
12315 when N_Package_Declaration =>
12316 Spec := Specification (Decl);
12318 when N_Task_Type_Declaration =>
12319 Spec := Task_Definition (Decl);
12321 when N_Protected_Type_Declaration =>
12322 Spec := Protected_Definition (Decl);
12324 when others =>
12325 Spec := Empty;
12326 end case;
12328 if Present (Spec) then
12329 Move_Freeze_Nodes (Out_Of, Next_Node, Visible_Declarations (Spec));
12330 Move_Freeze_Nodes (Out_Of, Next_Node, Private_Declarations (Spec));
12331 end if;
12333 Next (Decl);
12334 end loop;
12335 end Move_Freeze_Nodes;
12337 ----------------
12338 -- Next_Assoc --
12339 ----------------
12341 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
12342 begin
12343 return Generic_Renamings.Table (E).Next_In_HTable;
12344 end Next_Assoc;
12346 ------------------------
12347 -- Preanalyze_Actuals --
12348 ------------------------
12350 procedure Preanalyze_Actuals (N : Node_Id) is
12351 Assoc : Node_Id;
12352 Act : Node_Id;
12353 Errs : constant Int := Serious_Errors_Detected;
12355 Cur : Entity_Id := Empty;
12356 -- Current homograph of the instance name
12358 Vis : Boolean;
12359 -- Saved visibility status of the current homograph
12361 begin
12362 Assoc := First (Generic_Associations (N));
12364 -- If the instance is a child unit, its name may hide an outer homonym,
12365 -- so make it invisible to perform name resolution on the actuals.
12367 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name
12368 and then Present
12369 (Current_Entity (Defining_Identifier (Defining_Unit_Name (N))))
12370 then
12371 Cur := Current_Entity (Defining_Identifier (Defining_Unit_Name (N)));
12373 if Is_Compilation_Unit (Cur) then
12374 Vis := Is_Immediately_Visible (Cur);
12375 Set_Is_Immediately_Visible (Cur, False);
12376 else
12377 Cur := Empty;
12378 end if;
12379 end if;
12381 while Present (Assoc) loop
12382 if Nkind (Assoc) /= N_Others_Choice then
12383 Act := Explicit_Generic_Actual_Parameter (Assoc);
12385 -- Within a nested instantiation, a defaulted actual is an empty
12386 -- association, so nothing to analyze. If the subprogram actual
12387 -- is an attribute, analyze prefix only, because actual is not a
12388 -- complete attribute reference.
12390 -- If actual is an allocator, analyze expression only. The full
12391 -- analysis can generate code, and if instance is a compilation
12392 -- unit we have to wait until the package instance is installed
12393 -- to have a proper place to insert this code.
12395 -- String literals may be operators, but at this point we do not
12396 -- know whether the actual is a formal subprogram or a string.
12398 if No (Act) then
12399 null;
12401 elsif Nkind (Act) = N_Attribute_Reference then
12402 Analyze (Prefix (Act));
12404 elsif Nkind (Act) = N_Explicit_Dereference then
12405 Analyze (Prefix (Act));
12407 elsif Nkind (Act) = N_Allocator then
12408 declare
12409 Expr : constant Node_Id := Expression (Act);
12411 begin
12412 if Nkind (Expr) = N_Subtype_Indication then
12413 Analyze (Subtype_Mark (Expr));
12415 -- Analyze separately each discriminant constraint, when
12416 -- given with a named association.
12418 declare
12419 Constr : Node_Id;
12421 begin
12422 Constr := First (Constraints (Constraint (Expr)));
12423 while Present (Constr) loop
12424 if Nkind (Constr) = N_Discriminant_Association then
12425 Analyze (Expression (Constr));
12426 else
12427 Analyze (Constr);
12428 end if;
12430 Next (Constr);
12431 end loop;
12432 end;
12434 else
12435 Analyze (Expr);
12436 end if;
12437 end;
12439 elsif Nkind (Act) /= N_Operator_Symbol then
12440 Analyze (Act);
12441 end if;
12443 -- Ensure that a ghost subprogram does not act as generic actual
12445 if Is_Entity_Name (Act)
12446 and then Is_Ghost_Subprogram (Entity (Act))
12447 then
12448 Error_Msg_N
12449 ("ghost subprogram & cannot act as generic actual", Act);
12450 Abandon_Instantiation (Act);
12452 elsif Errs /= Serious_Errors_Detected then
12454 -- Do a minimal analysis of the generic, to prevent spurious
12455 -- warnings complaining about the generic being unreferenced,
12456 -- before abandoning the instantiation.
12458 Analyze (Name (N));
12460 if Is_Entity_Name (Name (N))
12461 and then Etype (Name (N)) /= Any_Type
12462 then
12463 Generate_Reference (Entity (Name (N)), Name (N));
12464 Set_Is_Instantiated (Entity (Name (N)));
12465 end if;
12467 if Present (Cur) then
12469 -- For the case of a child instance hiding an outer homonym,
12470 -- provide additional warning which might explain the error.
12472 Set_Is_Immediately_Visible (Cur, Vis);
12473 Error_Msg_NE ("& hides outer unit with the same name??",
12474 N, Defining_Unit_Name (N));
12475 end if;
12477 Abandon_Instantiation (Act);
12478 end if;
12479 end if;
12481 Next (Assoc);
12482 end loop;
12484 if Present (Cur) then
12485 Set_Is_Immediately_Visible (Cur, Vis);
12486 end if;
12487 end Preanalyze_Actuals;
12489 -------------------
12490 -- Remove_Parent --
12491 -------------------
12493 procedure Remove_Parent (In_Body : Boolean := False) is
12494 S : Entity_Id := Current_Scope;
12495 -- S is the scope containing the instantiation just completed. The scope
12496 -- stack contains the parent instances of the instantiation, followed by
12497 -- the original S.
12499 Cur_P : Entity_Id;
12500 E : Entity_Id;
12501 P : Entity_Id;
12502 Hidden : Elmt_Id;
12504 begin
12505 -- After child instantiation is complete, remove from scope stack the
12506 -- extra copy of the current scope, and then remove parent instances.
12508 if not In_Body then
12509 Pop_Scope;
12511 while Current_Scope /= S loop
12512 P := Current_Scope;
12513 End_Package_Scope (Current_Scope);
12515 if In_Open_Scopes (P) then
12516 E := First_Entity (P);
12517 while Present (E) loop
12518 Set_Is_Immediately_Visible (E, True);
12519 Next_Entity (E);
12520 end loop;
12522 -- If instantiation is declared in a block, it is the enclosing
12523 -- scope that might be a parent instance. Note that only one
12524 -- block can be involved, because the parent instances have
12525 -- been installed within it.
12527 if Ekind (P) = E_Block then
12528 Cur_P := Scope (P);
12529 else
12530 Cur_P := P;
12531 end if;
12533 if Is_Generic_Instance (Cur_P) and then P /= Current_Scope then
12534 -- We are within an instance of some sibling. Retain
12535 -- visibility of parent, for proper subsequent cleanup, and
12536 -- reinstall private declarations as well.
12538 Set_In_Private_Part (P);
12539 Install_Private_Declarations (P);
12540 end if;
12542 -- If the ultimate parent is a top-level unit recorded in
12543 -- Instance_Parent_Unit, then reset its visibility to what it was
12544 -- before instantiation. (It's not clear what the purpose is of
12545 -- testing whether Scope (P) is In_Open_Scopes, but that test was
12546 -- present before the ultimate parent test was added.???)
12548 elsif not In_Open_Scopes (Scope (P))
12549 or else (P = Instance_Parent_Unit
12550 and then not Parent_Unit_Visible)
12551 then
12552 Set_Is_Immediately_Visible (P, False);
12554 -- If the current scope is itself an instantiation of a generic
12555 -- nested within P, and we are in the private part of body of this
12556 -- instantiation, restore the full views of P, that were removed
12557 -- in End_Package_Scope above. This obscure case can occur when a
12558 -- subunit of a generic contains an instance of a child unit of
12559 -- its generic parent unit.
12561 elsif S = Current_Scope and then Is_Generic_Instance (S) then
12562 declare
12563 Par : constant Entity_Id :=
12564 Generic_Parent
12565 (Specification (Unit_Declaration_Node (S)));
12566 begin
12567 if Present (Par)
12568 and then P = Scope (Par)
12569 and then (In_Package_Body (S) or else In_Private_Part (S))
12570 then
12571 Set_In_Private_Part (P);
12572 Install_Private_Declarations (P);
12573 end if;
12574 end;
12575 end if;
12576 end loop;
12578 -- Reset visibility of entities in the enclosing scope
12580 Set_Is_Hidden_Open_Scope (Current_Scope, False);
12582 Hidden := First_Elmt (Hidden_Entities);
12583 while Present (Hidden) loop
12584 Set_Is_Immediately_Visible (Node (Hidden), True);
12585 Next_Elmt (Hidden);
12586 end loop;
12588 else
12589 -- Each body is analyzed separately, and there is no context that
12590 -- needs preserving from one body instance to the next, so remove all
12591 -- parent scopes that have been installed.
12593 while Present (S) loop
12594 End_Package_Scope (S);
12595 Set_Is_Immediately_Visible (S, False);
12596 S := Current_Scope;
12597 exit when S = Standard_Standard;
12598 end loop;
12599 end if;
12600 end Remove_Parent;
12602 -----------------
12603 -- Restore_Env --
12604 -----------------
12606 procedure Restore_Env is
12607 Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
12609 begin
12610 if No (Current_Instantiated_Parent.Act_Id) then
12611 -- Restore environment after subprogram inlining
12613 Restore_Private_Views (Empty);
12614 end if;
12616 Current_Instantiated_Parent := Saved.Instantiated_Parent;
12617 Exchanged_Views := Saved.Exchanged_Views;
12618 Hidden_Entities := Saved.Hidden_Entities;
12619 Current_Sem_Unit := Saved.Current_Sem_Unit;
12620 Parent_Unit_Visible := Saved.Parent_Unit_Visible;
12621 Instance_Parent_Unit := Saved.Instance_Parent_Unit;
12623 Restore_Opt_Config_Switches (Saved.Switches);
12625 Instance_Envs.Decrement_Last;
12626 end Restore_Env;
12628 ---------------------------
12629 -- Restore_Private_Views --
12630 ---------------------------
12632 procedure Restore_Private_Views
12633 (Pack_Id : Entity_Id;
12634 Is_Package : Boolean := True)
12636 M : Elmt_Id;
12637 E : Entity_Id;
12638 Typ : Entity_Id;
12639 Dep_Elmt : Elmt_Id;
12640 Dep_Typ : Node_Id;
12642 procedure Restore_Nested_Formal (Formal : Entity_Id);
12643 -- Hide the generic formals of formal packages declared with box which
12644 -- were reachable in the current instantiation.
12646 ---------------------------
12647 -- Restore_Nested_Formal --
12648 ---------------------------
12650 procedure Restore_Nested_Formal (Formal : Entity_Id) is
12651 Ent : Entity_Id;
12653 begin
12654 if Present (Renamed_Object (Formal))
12655 and then Denotes_Formal_Package (Renamed_Object (Formal), True)
12656 then
12657 return;
12659 elsif Present (Associated_Formal_Package (Formal)) then
12660 Ent := First_Entity (Formal);
12661 while Present (Ent) loop
12662 exit when Ekind (Ent) = E_Package
12663 and then Renamed_Entity (Ent) = Renamed_Entity (Formal);
12665 Set_Is_Hidden (Ent);
12666 Set_Is_Potentially_Use_Visible (Ent, False);
12668 -- If package, then recurse
12670 if Ekind (Ent) = E_Package then
12671 Restore_Nested_Formal (Ent);
12672 end if;
12674 Next_Entity (Ent);
12675 end loop;
12676 end if;
12677 end Restore_Nested_Formal;
12679 -- Start of processing for Restore_Private_Views
12681 begin
12682 M := First_Elmt (Exchanged_Views);
12683 while Present (M) loop
12684 Typ := Node (M);
12686 -- Subtypes of types whose views have been exchanged, and that are
12687 -- defined within the instance, were not on the Private_Dependents
12688 -- list on entry to the instance, so they have to be exchanged
12689 -- explicitly now, in order to remain consistent with the view of the
12690 -- parent type.
12692 if Ekind_In (Typ, E_Private_Type,
12693 E_Limited_Private_Type,
12694 E_Record_Type_With_Private)
12695 then
12696 Dep_Elmt := First_Elmt (Private_Dependents (Typ));
12697 while Present (Dep_Elmt) loop
12698 Dep_Typ := Node (Dep_Elmt);
12700 if Scope (Dep_Typ) = Pack_Id
12701 and then Present (Full_View (Dep_Typ))
12702 then
12703 Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
12704 Exchange_Declarations (Dep_Typ);
12705 end if;
12707 Next_Elmt (Dep_Elmt);
12708 end loop;
12709 end if;
12711 Exchange_Declarations (Node (M));
12712 Next_Elmt (M);
12713 end loop;
12715 if No (Pack_Id) then
12716 return;
12717 end if;
12719 -- Make the generic formal parameters private, and make the formal types
12720 -- into subtypes of the actuals again.
12722 E := First_Entity (Pack_Id);
12723 while Present (E) loop
12724 Set_Is_Hidden (E, True);
12726 if Is_Type (E)
12727 and then Nkind (Parent (E)) = N_Subtype_Declaration
12728 then
12729 -- If the actual for E is itself a generic actual type from
12730 -- an enclosing instance, E is still a generic actual type
12731 -- outside of the current instance. This matter when resolving
12732 -- an overloaded call that may be ambiguous in the enclosing
12733 -- instance, when two of its actuals coincide.
12735 if Is_Entity_Name (Subtype_Indication (Parent (E)))
12736 and then Is_Generic_Actual_Type
12737 (Entity (Subtype_Indication (Parent (E))))
12738 then
12739 null;
12740 else
12741 Set_Is_Generic_Actual_Type (E, False);
12742 end if;
12744 -- An unusual case of aliasing: the actual may also be directly
12745 -- visible in the generic, and be private there, while it is fully
12746 -- visible in the context of the instance. The internal subtype
12747 -- is private in the instance but has full visibility like its
12748 -- parent in the enclosing scope. This enforces the invariant that
12749 -- the privacy status of all private dependents of a type coincide
12750 -- with that of the parent type. This can only happen when a
12751 -- generic child unit is instantiated within a sibling.
12753 if Is_Private_Type (E)
12754 and then not Is_Private_Type (Etype (E))
12755 then
12756 Exchange_Declarations (E);
12757 end if;
12759 elsif Ekind (E) = E_Package then
12761 -- The end of the renaming list is the renaming of the generic
12762 -- package itself. If the instance is a subprogram, all entities
12763 -- in the corresponding package are renamings. If this entity is
12764 -- a formal package, make its own formals private as well. The
12765 -- actual in this case is itself the renaming of an instantiation.
12766 -- If the entity is not a package renaming, it is the entity
12767 -- created to validate formal package actuals: ignore it.
12769 -- If the actual is itself a formal package for the enclosing
12770 -- generic, or the actual for such a formal package, it remains
12771 -- visible on exit from the instance, and therefore nothing needs
12772 -- to be done either, except to keep it accessible.
12774 if Is_Package and then Renamed_Object (E) = Pack_Id then
12775 exit;
12777 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
12778 null;
12780 elsif
12781 Denotes_Formal_Package (Renamed_Object (E), True, Pack_Id)
12782 then
12783 Set_Is_Hidden (E, False);
12785 else
12786 declare
12787 Act_P : constant Entity_Id := Renamed_Object (E);
12788 Id : Entity_Id;
12790 begin
12791 Id := First_Entity (Act_P);
12792 while Present (Id)
12793 and then Id /= First_Private_Entity (Act_P)
12794 loop
12795 exit when Ekind (Id) = E_Package
12796 and then Renamed_Object (Id) = Act_P;
12798 Set_Is_Hidden (Id, True);
12799 Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
12801 if Ekind (Id) = E_Package then
12802 Restore_Nested_Formal (Id);
12803 end if;
12805 Next_Entity (Id);
12806 end loop;
12807 end;
12808 end if;
12809 end if;
12811 Next_Entity (E);
12812 end loop;
12813 end Restore_Private_Views;
12815 --------------
12816 -- Save_Env --
12817 --------------
12819 procedure Save_Env
12820 (Gen_Unit : Entity_Id;
12821 Act_Unit : Entity_Id)
12823 begin
12824 Init_Env;
12825 Set_Instance_Env (Gen_Unit, Act_Unit);
12826 end Save_Env;
12828 ----------------------------
12829 -- Save_Global_References --
12830 ----------------------------
12832 procedure Save_Global_References (N : Node_Id) is
12833 Gen_Scope : Entity_Id;
12834 E : Entity_Id;
12835 N2 : Node_Id;
12837 function Is_Global (E : Entity_Id) return Boolean;
12838 -- Check whether entity is defined outside of generic unit. Examine the
12839 -- scope of an entity, and the scope of the scope, etc, until we find
12840 -- either Standard, in which case the entity is global, or the generic
12841 -- unit itself, which indicates that the entity is local. If the entity
12842 -- is the generic unit itself, as in the case of a recursive call, or
12843 -- the enclosing generic unit, if different from the current scope, then
12844 -- it is local as well, because it will be replaced at the point of
12845 -- instantiation. On the other hand, if it is a reference to a child
12846 -- unit of a common ancestor, which appears in an instantiation, it is
12847 -- global because it is used to denote a specific compilation unit at
12848 -- the time the instantiations will be analyzed.
12850 procedure Reset_Entity (N : Node_Id);
12851 -- Save semantic information on global entity so that it is not resolved
12852 -- again at instantiation time.
12854 procedure Save_Entity_Descendants (N : Node_Id);
12855 -- Apply Save_Global_References to the two syntactic descendants of
12856 -- non-terminal nodes that carry an Associated_Node and are processed
12857 -- through Reset_Entity. Once the global entity (if any) has been
12858 -- captured together with its type, only two syntactic descendants need
12859 -- to be traversed to complete the processing of the tree rooted at N.
12860 -- This applies to Selected_Components, Expanded_Names, and to Operator
12861 -- nodes. N can also be a character literal, identifier, or operator
12862 -- symbol node, but the call has no effect in these cases.
12864 procedure Save_Global_Defaults (N1, N2 : Node_Id);
12865 -- Default actuals in nested instances must be handled specially
12866 -- because there is no link to them from the original tree. When an
12867 -- actual subprogram is given by a default, we add an explicit generic
12868 -- association for it in the instantiation node. When we save the
12869 -- global references on the name of the instance, we recover the list
12870 -- of generic associations, and add an explicit one to the original
12871 -- generic tree, through which a global actual can be preserved.
12872 -- Similarly, if a child unit is instantiated within a sibling, in the
12873 -- context of the parent, we must preserve the identifier of the parent
12874 -- so that it can be properly resolved in a subsequent instantiation.
12876 procedure Save_Global_Descendant (D : Union_Id);
12877 -- Apply Save_Global_References recursively to the descendents of the
12878 -- current node.
12880 procedure Save_References (N : Node_Id);
12881 -- This is the recursive procedure that does the work, once the
12882 -- enclosing generic scope has been established.
12884 ---------------
12885 -- Is_Global --
12886 ---------------
12888 function Is_Global (E : Entity_Id) return Boolean is
12889 Se : Entity_Id;
12891 function Is_Instance_Node (Decl : Node_Id) return Boolean;
12892 -- Determine whether the parent node of a reference to a child unit
12893 -- denotes an instantiation or a formal package, in which case the
12894 -- reference to the child unit is global, even if it appears within
12895 -- the current scope (e.g. when the instance appears within the body
12896 -- of an ancestor).
12898 ----------------------
12899 -- Is_Instance_Node --
12900 ----------------------
12902 function Is_Instance_Node (Decl : Node_Id) return Boolean is
12903 begin
12904 return Nkind (Decl) in N_Generic_Instantiation
12905 or else
12906 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration;
12907 end Is_Instance_Node;
12909 -- Start of processing for Is_Global
12911 begin
12912 if E = Gen_Scope then
12913 return False;
12915 elsif E = Standard_Standard then
12916 return True;
12918 elsif Is_Child_Unit (E)
12919 and then (Is_Instance_Node (Parent (N2))
12920 or else (Nkind (Parent (N2)) = N_Expanded_Name
12921 and then N2 = Selector_Name (Parent (N2))
12922 and then
12923 Is_Instance_Node (Parent (Parent (N2)))))
12924 then
12925 return True;
12927 else
12928 Se := Scope (E);
12929 while Se /= Gen_Scope loop
12930 if Se = Standard_Standard then
12931 return True;
12932 else
12933 Se := Scope (Se);
12934 end if;
12935 end loop;
12937 return False;
12938 end if;
12939 end Is_Global;
12941 ------------------
12942 -- Reset_Entity --
12943 ------------------
12945 procedure Reset_Entity (N : Node_Id) is
12947 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
12948 -- If the type of N2 is global to the generic unit, save the type in
12949 -- the generic node. Just as we perform name capture for explicit
12950 -- references within the generic, we must capture the global types
12951 -- of local entities because they may participate in resolution in
12952 -- the instance.
12954 function Top_Ancestor (E : Entity_Id) return Entity_Id;
12955 -- Find the ultimate ancestor of the current unit. If it is not a
12956 -- generic unit, then the name of the current unit in the prefix of
12957 -- an expanded name must be replaced with its generic homonym to
12958 -- ensure that it will be properly resolved in an instance.
12960 ---------------------
12961 -- Set_Global_Type --
12962 ---------------------
12964 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
12965 Typ : constant Entity_Id := Etype (N2);
12967 begin
12968 Set_Etype (N, Typ);
12970 if Entity (N) /= N2
12971 and then Has_Private_View (Entity (N))
12972 then
12973 -- If the entity of N is not the associated node, this is a
12974 -- nested generic and it has an associated node as well, whose
12975 -- type is already the full view (see below). Indicate that the
12976 -- original node has a private view.
12978 Set_Has_Private_View (N);
12979 end if;
12981 -- If not a private type, nothing else to do
12983 if not Is_Private_Type (Typ) then
12984 if Is_Array_Type (Typ)
12985 and then Is_Private_Type (Component_Type (Typ))
12986 then
12987 Set_Has_Private_View (N);
12988 end if;
12990 -- If it is a derivation of a private type in a context where no
12991 -- full view is needed, nothing to do either.
12993 elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
12994 null;
12996 -- Otherwise mark the type for flipping and use the full view when
12997 -- available.
12999 else
13000 Set_Has_Private_View (N);
13002 if Present (Full_View (Typ)) then
13003 Set_Etype (N2, Full_View (Typ));
13004 end if;
13005 end if;
13006 end Set_Global_Type;
13008 ------------------
13009 -- Top_Ancestor --
13010 ------------------
13012 function Top_Ancestor (E : Entity_Id) return Entity_Id is
13013 Par : Entity_Id;
13015 begin
13016 Par := E;
13017 while Is_Child_Unit (Par) loop
13018 Par := Scope (Par);
13019 end loop;
13021 return Par;
13022 end Top_Ancestor;
13024 -- Start of processing for Reset_Entity
13026 begin
13027 N2 := Get_Associated_Node (N);
13028 E := Entity (N2);
13030 if Present (E) then
13032 -- If the node is an entry call to an entry in an enclosing task,
13033 -- it is rewritten as a selected component. No global entity to
13034 -- preserve in this case, since the expansion will be redone in
13035 -- the instance.
13037 if not Nkind_In (E, N_Defining_Identifier,
13038 N_Defining_Character_Literal,
13039 N_Defining_Operator_Symbol)
13040 then
13041 Set_Associated_Node (N, Empty);
13042 Set_Etype (N, Empty);
13043 return;
13044 end if;
13046 -- If the entity is an itype created as a subtype of an access
13047 -- type with a null exclusion restore source entity for proper
13048 -- visibility. The itype will be created anew in the instance.
13050 if Is_Itype (E)
13051 and then Ekind (E) = E_Access_Subtype
13052 and then Is_Entity_Name (N)
13053 and then Chars (Etype (E)) = Chars (N)
13054 then
13055 E := Etype (E);
13056 Set_Entity (N2, E);
13057 Set_Etype (N2, E);
13058 end if;
13060 if Is_Global (E) then
13062 -- If the entity is a package renaming that is the prefix of
13063 -- an expanded name, it has been rewritten as the renamed
13064 -- package, which is necessary semantically but complicates
13065 -- ASIS tree traversal, so we recover the original entity to
13066 -- expose the renaming. Take into account that the context may
13067 -- be a nested generic and that the original node may itself
13068 -- have an associated node.
13070 if Ekind (E) = E_Package
13071 and then Nkind (Parent (N)) = N_Expanded_Name
13072 and then Present (Original_Node (N2))
13073 and then Present (Entity (Original_Node (N2)))
13074 and then Is_Entity_Name (Entity (Original_Node (N2)))
13075 then
13076 if Is_Global (Entity (Original_Node (N2))) then
13077 N2 := Original_Node (N2);
13078 Set_Associated_Node (N, N2);
13079 Set_Global_Type (N, N2);
13081 else
13082 -- Renaming is local, and will be resolved in instance
13084 Set_Associated_Node (N, Empty);
13085 Set_Etype (N, Empty);
13086 end if;
13088 else
13089 Set_Global_Type (N, N2);
13090 end if;
13092 elsif Nkind (N) = N_Op_Concat
13093 and then Is_Generic_Type (Etype (N2))
13094 and then (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
13095 or else
13096 Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
13097 and then Is_Intrinsic_Subprogram (E)
13098 then
13099 null;
13101 else
13102 -- Entity is local. Mark generic node as unresolved.
13103 -- Note that now it does not have an entity.
13105 Set_Associated_Node (N, Empty);
13106 Set_Etype (N, Empty);
13107 end if;
13109 if Nkind (Parent (N)) in N_Generic_Instantiation
13110 and then N = Name (Parent (N))
13111 then
13112 Save_Global_Defaults (Parent (N), Parent (N2));
13113 end if;
13115 elsif Nkind (Parent (N)) = N_Selected_Component
13116 and then Nkind (Parent (N2)) = N_Expanded_Name
13117 then
13118 if Is_Global (Entity (Parent (N2))) then
13119 Change_Selected_Component_To_Expanded_Name (Parent (N));
13120 Set_Associated_Node (Parent (N), Parent (N2));
13121 Set_Global_Type (Parent (N), Parent (N2));
13122 Save_Entity_Descendants (N);
13124 -- If this is a reference to the current generic entity, replace
13125 -- by the name of the generic homonym of the current package. This
13126 -- is because in an instantiation Par.P.Q will not resolve to the
13127 -- name of the instance, whose enclosing scope is not necessarily
13128 -- Par. We use the generic homonym rather that the name of the
13129 -- generic itself because it may be hidden by a local declaration.
13131 elsif In_Open_Scopes (Entity (Parent (N2)))
13132 and then not
13133 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
13134 then
13135 if Ekind (Entity (Parent (N2))) = E_Generic_Package then
13136 Rewrite (Parent (N),
13137 Make_Identifier (Sloc (N),
13138 Chars =>
13139 Chars (Generic_Homonym (Entity (Parent (N2))))));
13140 else
13141 Rewrite (Parent (N),
13142 Make_Identifier (Sloc (N),
13143 Chars => Chars (Selector_Name (Parent (N2)))));
13144 end if;
13145 end if;
13147 if Nkind (Parent (Parent (N))) in N_Generic_Instantiation
13148 and then Parent (N) = Name (Parent (Parent (N)))
13149 then
13150 Save_Global_Defaults
13151 (Parent (Parent (N)), Parent (Parent ((N2))));
13152 end if;
13154 -- A selected component may denote a static constant that has been
13155 -- folded. If the static constant is global to the generic, capture
13156 -- its value. Otherwise the folding will happen in any instantiation.
13158 elsif Nkind (Parent (N)) = N_Selected_Component
13159 and then Nkind_In (Parent (N2), N_Integer_Literal, N_Real_Literal)
13160 then
13161 if Present (Entity (Original_Node (Parent (N2))))
13162 and then Is_Global (Entity (Original_Node (Parent (N2))))
13163 then
13164 Rewrite (Parent (N), New_Copy (Parent (N2)));
13165 Set_Analyzed (Parent (N), False);
13167 else
13168 null;
13169 end if;
13171 -- A selected component may be transformed into a parameterless
13172 -- function call. If the called entity is global, rewrite the node
13173 -- appropriately, i.e. as an extended name for the global entity.
13175 elsif Nkind (Parent (N)) = N_Selected_Component
13176 and then Nkind (Parent (N2)) = N_Function_Call
13177 and then N = Selector_Name (Parent (N))
13178 then
13179 if No (Parameter_Associations (Parent (N2))) then
13180 if Is_Global (Entity (Name (Parent (N2)))) then
13181 Change_Selected_Component_To_Expanded_Name (Parent (N));
13182 Set_Associated_Node (Parent (N), Name (Parent (N2)));
13183 Set_Global_Type (Parent (N), Name (Parent (N2)));
13184 Save_Entity_Descendants (N);
13186 else
13187 Set_Is_Prefixed_Call (Parent (N));
13188 Set_Associated_Node (N, Empty);
13189 Set_Etype (N, Empty);
13190 end if;
13192 -- In Ada 2005, X.F may be a call to a primitive operation,
13193 -- rewritten as F (X). This rewriting will be done again in an
13194 -- instance, so keep the original node. Global entities will be
13195 -- captured as for other constructs. Indicate that this must
13196 -- resolve as a call, to prevent accidental overloading in the
13197 -- instance, if both a component and a primitive operation appear
13198 -- as candidates.
13200 else
13201 Set_Is_Prefixed_Call (Parent (N));
13202 end if;
13204 -- Entity is local. Reset in generic unit, so that node is resolved
13205 -- anew at the point of instantiation.
13207 else
13208 Set_Associated_Node (N, Empty);
13209 Set_Etype (N, Empty);
13210 end if;
13211 end Reset_Entity;
13213 -----------------------------
13214 -- Save_Entity_Descendants --
13215 -----------------------------
13217 procedure Save_Entity_Descendants (N : Node_Id) is
13218 begin
13219 case Nkind (N) is
13220 when N_Binary_Op =>
13221 Save_Global_Descendant (Union_Id (Left_Opnd (N)));
13222 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13224 when N_Unary_Op =>
13225 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
13227 when N_Expanded_Name | N_Selected_Component =>
13228 Save_Global_Descendant (Union_Id (Prefix (N)));
13229 Save_Global_Descendant (Union_Id (Selector_Name (N)));
13231 when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
13232 null;
13234 when others =>
13235 raise Program_Error;
13236 end case;
13237 end Save_Entity_Descendants;
13239 --------------------------
13240 -- Save_Global_Defaults --
13241 --------------------------
13243 procedure Save_Global_Defaults (N1, N2 : Node_Id) is
13244 Loc : constant Source_Ptr := Sloc (N1);
13245 Assoc2 : constant List_Id := Generic_Associations (N2);
13246 Gen_Id : constant Entity_Id := Get_Generic_Entity (N2);
13247 Assoc1 : List_Id;
13248 Act1 : Node_Id;
13249 Act2 : Node_Id;
13250 Def : Node_Id;
13251 Ndec : Node_Id;
13252 Subp : Entity_Id;
13253 Actual : Entity_Id;
13255 begin
13256 Assoc1 := Generic_Associations (N1);
13258 if Present (Assoc1) then
13259 Act1 := First (Assoc1);
13260 else
13261 Act1 := Empty;
13262 Set_Generic_Associations (N1, New_List);
13263 Assoc1 := Generic_Associations (N1);
13264 end if;
13266 if Present (Assoc2) then
13267 Act2 := First (Assoc2);
13268 else
13269 return;
13270 end if;
13272 while Present (Act1) and then Present (Act2) loop
13273 Next (Act1);
13274 Next (Act2);
13275 end loop;
13277 -- Find the associations added for default subprograms
13279 if Present (Act2) then
13280 while Nkind (Act2) /= N_Generic_Association
13281 or else No (Entity (Selector_Name (Act2)))
13282 or else not Is_Overloadable (Entity (Selector_Name (Act2)))
13283 loop
13284 Next (Act2);
13285 end loop;
13287 -- Add a similar association if the default is global. The
13288 -- renaming declaration for the actual has been analyzed, and
13289 -- its alias is the program it renames. Link the actual in the
13290 -- original generic tree with the node in the analyzed tree.
13292 while Present (Act2) loop
13293 Subp := Entity (Selector_Name (Act2));
13294 Def := Explicit_Generic_Actual_Parameter (Act2);
13296 -- Following test is defence against rubbish errors
13298 if No (Alias (Subp)) then
13299 return;
13300 end if;
13302 -- Retrieve the resolved actual from the renaming declaration
13303 -- created for the instantiated formal.
13305 Actual := Entity (Name (Parent (Parent (Subp))));
13306 Set_Entity (Def, Actual);
13307 Set_Etype (Def, Etype (Actual));
13309 if Is_Global (Actual) then
13310 Ndec :=
13311 Make_Generic_Association (Loc,
13312 Selector_Name => New_Occurrence_Of (Subp, Loc),
13313 Explicit_Generic_Actual_Parameter =>
13314 New_Occurrence_Of (Actual, Loc));
13316 Set_Associated_Node
13317 (Explicit_Generic_Actual_Parameter (Ndec), Def);
13319 Append (Ndec, Assoc1);
13321 -- If there are other defaults, add a dummy association in case
13322 -- there are other defaulted formals with the same name.
13324 elsif Present (Next (Act2)) then
13325 Ndec :=
13326 Make_Generic_Association (Loc,
13327 Selector_Name => New_Occurrence_Of (Subp, Loc),
13328 Explicit_Generic_Actual_Parameter => Empty);
13330 Append (Ndec, Assoc1);
13331 end if;
13333 Next (Act2);
13334 end loop;
13335 end if;
13337 if Nkind (Name (N1)) = N_Identifier
13338 and then Is_Child_Unit (Gen_Id)
13339 and then Is_Global (Gen_Id)
13340 and then Is_Generic_Unit (Scope (Gen_Id))
13341 and then In_Open_Scopes (Scope (Gen_Id))
13342 then
13343 -- This is an instantiation of a child unit within a sibling, so
13344 -- that the generic parent is in scope. An eventual instance must
13345 -- occur within the scope of an instance of the parent. Make name
13346 -- in instance into an expanded name, to preserve the identifier
13347 -- of the parent, so it can be resolved subsequently.
13349 Rewrite (Name (N2),
13350 Make_Expanded_Name (Loc,
13351 Chars => Chars (Gen_Id),
13352 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13353 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13354 Set_Entity (Name (N2), Gen_Id);
13356 Rewrite (Name (N1),
13357 Make_Expanded_Name (Loc,
13358 Chars => Chars (Gen_Id),
13359 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
13360 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
13362 Set_Associated_Node (Name (N1), Name (N2));
13363 Set_Associated_Node (Prefix (Name (N1)), Empty);
13364 Set_Associated_Node
13365 (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
13366 Set_Etype (Name (N1), Etype (Gen_Id));
13367 end if;
13369 end Save_Global_Defaults;
13371 ----------------------------
13372 -- Save_Global_Descendant --
13373 ----------------------------
13375 procedure Save_Global_Descendant (D : Union_Id) is
13376 N1 : Node_Id;
13378 begin
13379 if D in Node_Range then
13380 if D = Union_Id (Empty) then
13381 null;
13383 elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
13384 Save_References (Node_Id (D));
13385 end if;
13387 elsif D in List_Range then
13388 if D = Union_Id (No_List)
13389 or else Is_Empty_List (List_Id (D))
13390 then
13391 null;
13393 else
13394 N1 := First (List_Id (D));
13395 while Present (N1) loop
13396 Save_References (N1);
13397 Next (N1);
13398 end loop;
13399 end if;
13401 -- Element list or other non-node field, nothing to do
13403 else
13404 null;
13405 end if;
13406 end Save_Global_Descendant;
13408 ---------------------
13409 -- Save_References --
13410 ---------------------
13412 -- This is the recursive procedure that does the work once the enclosing
13413 -- generic scope has been established. We have to treat specially a
13414 -- number of node rewritings that are required by semantic processing
13415 -- and which change the kind of nodes in the generic copy: typically
13416 -- constant-folding, replacing an operator node by a string literal, or
13417 -- a selected component by an expanded name. In each of those cases, the
13418 -- transformation is propagated to the generic unit.
13420 procedure Save_References (N : Node_Id) is
13421 Loc : constant Source_Ptr := Sloc (N);
13423 begin
13424 if N = Empty then
13425 null;
13427 elsif Nkind_In (N, N_Character_Literal, N_Operator_Symbol) then
13428 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13429 Reset_Entity (N);
13431 elsif Nkind (N) = N_Operator_Symbol
13432 and then Nkind (Get_Associated_Node (N)) = N_String_Literal
13433 then
13434 Change_Operator_Symbol_To_String_Literal (N);
13435 end if;
13437 elsif Nkind (N) in N_Op then
13438 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13439 if Nkind (N) = N_Op_Concat then
13440 Set_Is_Component_Left_Opnd (N,
13441 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13443 Set_Is_Component_Right_Opnd (N,
13444 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13445 end if;
13447 Reset_Entity (N);
13449 else
13450 -- Node may be transformed into call to a user-defined operator
13452 N2 := Get_Associated_Node (N);
13454 if Nkind (N2) = N_Function_Call then
13455 E := Entity (Name (N2));
13457 if Present (E)
13458 and then Is_Global (E)
13459 then
13460 Set_Etype (N, Etype (N2));
13461 else
13462 Set_Associated_Node (N, Empty);
13463 Set_Etype (N, Empty);
13464 end if;
13466 elsif Nkind_In (N2, N_Integer_Literal,
13467 N_Real_Literal,
13468 N_String_Literal)
13469 then
13470 if Present (Original_Node (N2))
13471 and then Nkind (Original_Node (N2)) = Nkind (N)
13472 then
13474 -- Operation was constant-folded. Whenever possible,
13475 -- recover semantic information from unfolded node,
13476 -- for ASIS use.
13478 Set_Associated_Node (N, Original_Node (N2));
13480 if Nkind (N) = N_Op_Concat then
13481 Set_Is_Component_Left_Opnd (N,
13482 Is_Component_Left_Opnd (Get_Associated_Node (N)));
13483 Set_Is_Component_Right_Opnd (N,
13484 Is_Component_Right_Opnd (Get_Associated_Node (N)));
13485 end if;
13487 Reset_Entity (N);
13489 else
13490 -- If original node is already modified, propagate
13491 -- constant-folding to template.
13493 Rewrite (N, New_Copy (N2));
13494 Set_Analyzed (N, False);
13495 end if;
13497 elsif Nkind (N2) = N_Identifier
13498 and then Ekind (Entity (N2)) = E_Enumeration_Literal
13499 then
13500 -- Same if call was folded into a literal, but in this case
13501 -- retain the entity to avoid spurious ambiguities if it is
13502 -- overloaded at the point of instantiation or inlining.
13504 Rewrite (N, New_Copy (N2));
13505 Set_Analyzed (N, False);
13506 end if;
13507 end if;
13509 -- Complete operands check if node has not been constant-folded
13511 if Nkind (N) in N_Op then
13512 Save_Entity_Descendants (N);
13513 end if;
13515 elsif Nkind (N) = N_Identifier then
13516 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
13518 -- If this is a discriminant reference, always save it. It is
13519 -- used in the instance to find the corresponding discriminant
13520 -- positionally rather than by name.
13522 Set_Original_Discriminant
13523 (N, Original_Discriminant (Get_Associated_Node (N)));
13524 Reset_Entity (N);
13526 else
13527 N2 := Get_Associated_Node (N);
13529 if Nkind (N2) = N_Function_Call then
13530 E := Entity (Name (N2));
13532 -- Name resolves to a call to parameterless function. If
13533 -- original entity is global, mark node as resolved.
13535 if Present (E)
13536 and then Is_Global (E)
13537 then
13538 Set_Etype (N, Etype (N2));
13539 else
13540 Set_Associated_Node (N, Empty);
13541 Set_Etype (N, Empty);
13542 end if;
13544 elsif Nkind_In (N2, N_Integer_Literal, N_Real_Literal)
13545 and then Is_Entity_Name (Original_Node (N2))
13546 then
13547 -- Name resolves to named number that is constant-folded,
13548 -- We must preserve the original name for ASIS use, and
13549 -- undo the constant-folding, which will be repeated in
13550 -- each instance.
13552 Set_Associated_Node (N, Original_Node (N2));
13553 Reset_Entity (N);
13555 elsif Nkind (N2) = N_String_Literal then
13557 -- Name resolves to string literal. Perform the same
13558 -- replacement in generic.
13560 Rewrite (N, New_Copy (N2));
13562 elsif Nkind (N2) = N_Explicit_Dereference then
13564 -- An identifier is rewritten as a dereference if it is the
13565 -- prefix in an implicit dereference (call or attribute).
13566 -- The analysis of an instantiation will expand the node
13567 -- again, so we preserve the original tree but link it to
13568 -- the resolved entity in case it is global.
13570 if Is_Entity_Name (Prefix (N2))
13571 and then Present (Entity (Prefix (N2)))
13572 and then Is_Global (Entity (Prefix (N2)))
13573 then
13574 Set_Associated_Node (N, Prefix (N2));
13576 elsif Nkind (Prefix (N2)) = N_Function_Call
13577 and then Is_Global (Entity (Name (Prefix (N2))))
13578 then
13579 Rewrite (N,
13580 Make_Explicit_Dereference (Loc,
13581 Prefix => Make_Function_Call (Loc,
13582 Name =>
13583 New_Occurrence_Of (Entity (Name (Prefix (N2))),
13584 Loc))));
13586 else
13587 Set_Associated_Node (N, Empty);
13588 Set_Etype (N, Empty);
13589 end if;
13591 -- The subtype mark of a nominally unconstrained object is
13592 -- rewritten as a subtype indication using the bounds of the
13593 -- expression. Recover the original subtype mark.
13595 elsif Nkind (N2) = N_Subtype_Indication
13596 and then Is_Entity_Name (Original_Node (N2))
13597 then
13598 Set_Associated_Node (N, Original_Node (N2));
13599 Reset_Entity (N);
13601 else
13602 null;
13603 end if;
13604 end if;
13606 elsif Nkind (N) in N_Entity then
13607 null;
13609 else
13610 declare
13611 Qual : Node_Id := Empty;
13612 Typ : Entity_Id := Empty;
13613 Nam : Node_Id;
13615 use Atree.Unchecked_Access;
13616 -- This code section is part of implementing an untyped tree
13617 -- traversal, so it needs direct access to node fields.
13619 begin
13620 if Nkind_In (N, N_Aggregate, N_Extension_Aggregate) then
13621 N2 := Get_Associated_Node (N);
13623 if No (N2) then
13624 Typ := Empty;
13625 else
13626 Typ := Etype (N2);
13628 -- In an instance within a generic, use the name of the
13629 -- actual and not the original generic parameter. If the
13630 -- actual is global in the current generic it must be
13631 -- preserved for its instantiation.
13633 if Nkind (Parent (Typ)) = N_Subtype_Declaration
13634 and then
13635 Present (Generic_Parent_Type (Parent (Typ)))
13636 then
13637 Typ := Base_Type (Typ);
13638 Set_Etype (N2, Typ);
13639 end if;
13640 end if;
13642 if No (N2)
13643 or else No (Typ)
13644 or else not Is_Global (Typ)
13645 then
13646 Set_Associated_Node (N, Empty);
13648 -- If the aggregate is an actual in a call, it has been
13649 -- resolved in the current context, to some local type.
13650 -- The enclosing call may have been disambiguated by the
13651 -- aggregate, and this disambiguation might fail at
13652 -- instantiation time because the type to which the
13653 -- aggregate did resolve is not preserved. In order to
13654 -- preserve some of this information, we wrap the
13655 -- aggregate in a qualified expression, using the id of
13656 -- its type. For further disambiguation we qualify the
13657 -- type name with its scope (if visible) because both
13658 -- id's will have corresponding entities in an instance.
13659 -- This resolves most of the problems with missing type
13660 -- information on aggregates in instances.
13662 if Nkind (N2) = Nkind (N)
13663 and then Nkind (Parent (N2)) in N_Subprogram_Call
13664 and then Comes_From_Source (Typ)
13665 then
13666 if Is_Immediately_Visible (Scope (Typ)) then
13667 Nam := Make_Selected_Component (Loc,
13668 Prefix =>
13669 Make_Identifier (Loc, Chars (Scope (Typ))),
13670 Selector_Name =>
13671 Make_Identifier (Loc, Chars (Typ)));
13672 else
13673 Nam := Make_Identifier (Loc, Chars (Typ));
13674 end if;
13676 Qual :=
13677 Make_Qualified_Expression (Loc,
13678 Subtype_Mark => Nam,
13679 Expression => Relocate_Node (N));
13680 end if;
13681 end if;
13683 Save_Global_Descendant (Field1 (N));
13684 Save_Global_Descendant (Field2 (N));
13685 Save_Global_Descendant (Field3 (N));
13686 Save_Global_Descendant (Field5 (N));
13688 if Present (Qual) then
13689 Rewrite (N, Qual);
13690 end if;
13692 -- All other cases than aggregates
13694 else
13695 Save_Global_Descendant (Field1 (N));
13696 Save_Global_Descendant (Field2 (N));
13697 Save_Global_Descendant (Field3 (N));
13698 Save_Global_Descendant (Field4 (N));
13699 Save_Global_Descendant (Field5 (N));
13700 end if;
13701 end;
13702 end if;
13704 -- If a node has aspects, references within their expressions must
13705 -- be saved separately, given that they are not directly in the
13706 -- tree.
13708 if Has_Aspects (N) then
13709 declare
13710 Aspect : Node_Id;
13711 begin
13712 Aspect := First (Aspect_Specifications (N));
13713 while Present (Aspect) loop
13714 Save_Global_References (Expression (Aspect));
13715 Next (Aspect);
13716 end loop;
13717 end;
13718 end if;
13719 end Save_References;
13721 -- Start of processing for Save_Global_References
13723 begin
13724 Gen_Scope := Current_Scope;
13726 -- If the generic unit is a child unit, references to entities in the
13727 -- parent are treated as local, because they will be resolved anew in
13728 -- the context of the instance of the parent.
13730 while Is_Child_Unit (Gen_Scope)
13731 and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
13732 loop
13733 Gen_Scope := Scope (Gen_Scope);
13734 end loop;
13736 Save_References (N);
13737 end Save_Global_References;
13739 --------------------------------------
13740 -- Set_Copied_Sloc_For_Inlined_Body --
13741 --------------------------------------
13743 procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
13744 begin
13745 Create_Instantiation_Source (N, E, True, S_Adjustment);
13746 end Set_Copied_Sloc_For_Inlined_Body;
13748 ---------------------
13749 -- Set_Instance_Of --
13750 ---------------------
13752 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
13753 begin
13754 Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
13755 Generic_Renamings_HTable.Set (Generic_Renamings.Last);
13756 Generic_Renamings.Increment_Last;
13757 end Set_Instance_Of;
13759 --------------------
13760 -- Set_Next_Assoc --
13761 --------------------
13763 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
13764 begin
13765 Generic_Renamings.Table (E).Next_In_HTable := Next;
13766 end Set_Next_Assoc;
13768 -------------------
13769 -- Start_Generic --
13770 -------------------
13772 procedure Start_Generic is
13773 begin
13774 -- ??? More things could be factored out in this routine.
13775 -- Should probably be done at a later stage.
13777 Generic_Flags.Append (Inside_A_Generic);
13778 Inside_A_Generic := True;
13780 Expander_Mode_Save_And_Set (False);
13781 end Start_Generic;
13783 ----------------------
13784 -- Set_Instance_Env --
13785 ----------------------
13787 procedure Set_Instance_Env
13788 (Gen_Unit : Entity_Id;
13789 Act_Unit : Entity_Id)
13791 begin
13792 -- Regardless of the current mode, predefined units are analyzed in the
13793 -- most current Ada mode, and earlier version Ada checks do not apply
13794 -- to predefined units. Nothing needs to be done for non-internal units.
13795 -- These are always analyzed in the current mode.
13797 if Is_Internal_File_Name
13798 (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
13799 Renamings_Included => True)
13800 then
13801 Set_Opt_Config_Switches (True, Current_Sem_Unit = Main_Unit);
13802 end if;
13804 Current_Instantiated_Parent :=
13805 (Gen_Id => Gen_Unit,
13806 Act_Id => Act_Unit,
13807 Next_In_HTable => Assoc_Null);
13808 end Set_Instance_Env;
13810 -----------------
13811 -- Switch_View --
13812 -----------------
13814 procedure Switch_View (T : Entity_Id) is
13815 BT : constant Entity_Id := Base_Type (T);
13816 Priv_Elmt : Elmt_Id := No_Elmt;
13817 Priv_Sub : Entity_Id;
13819 begin
13820 -- T may be private but its base type may have been exchanged through
13821 -- some other occurrence, in which case there is nothing to switch
13822 -- besides T itself. Note that a private dependent subtype of a private
13823 -- type might not have been switched even if the base type has been,
13824 -- because of the last branch of Check_Private_View (see comment there).
13826 if not Is_Private_Type (BT) then
13827 Prepend_Elmt (Full_View (T), Exchanged_Views);
13828 Exchange_Declarations (T);
13829 return;
13830 end if;
13832 Priv_Elmt := First_Elmt (Private_Dependents (BT));
13834 if Present (Full_View (BT)) then
13835 Prepend_Elmt (Full_View (BT), Exchanged_Views);
13836 Exchange_Declarations (BT);
13837 end if;
13839 while Present (Priv_Elmt) loop
13840 Priv_Sub := (Node (Priv_Elmt));
13842 -- We avoid flipping the subtype if the Etype of its full view is
13843 -- private because this would result in a malformed subtype. This
13844 -- occurs when the Etype of the subtype full view is the full view of
13845 -- the base type (and since the base types were just switched, the
13846 -- subtype is pointing to the wrong view). This is currently the case
13847 -- for tagged record types, access types (maybe more?) and needs to
13848 -- be resolved. ???
13850 if Present (Full_View (Priv_Sub))
13851 and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
13852 then
13853 Prepend_Elmt (Full_View (Priv_Sub), Exchanged_Views);
13854 Exchange_Declarations (Priv_Sub);
13855 end if;
13857 Next_Elmt (Priv_Elmt);
13858 end loop;
13859 end Switch_View;
13861 -----------------
13862 -- True_Parent --
13863 -----------------
13865 function True_Parent (N : Node_Id) return Node_Id is
13866 begin
13867 if Nkind (Parent (N)) = N_Subunit then
13868 return Parent (Corresponding_Stub (Parent (N)));
13869 else
13870 return Parent (N);
13871 end if;
13872 end True_Parent;
13874 -----------------------------
13875 -- Valid_Default_Attribute --
13876 -----------------------------
13878 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
13879 Attr_Id : constant Attribute_Id :=
13880 Get_Attribute_Id (Attribute_Name (Def));
13881 T : constant Entity_Id := Entity (Prefix (Def));
13882 Is_Fun : constant Boolean := (Ekind (Nam) = E_Function);
13883 F : Entity_Id;
13884 Num_F : Int;
13885 OK : Boolean;
13887 begin
13888 if No (T)
13889 or else T = Any_Id
13890 then
13891 return;
13892 end if;
13894 Num_F := 0;
13895 F := First_Formal (Nam);
13896 while Present (F) loop
13897 Num_F := Num_F + 1;
13898 Next_Formal (F);
13899 end loop;
13901 case Attr_Id is
13902 when Attribute_Adjacent | Attribute_Ceiling | Attribute_Copy_Sign |
13903 Attribute_Floor | Attribute_Fraction | Attribute_Machine |
13904 Attribute_Model | Attribute_Remainder | Attribute_Rounding |
13905 Attribute_Unbiased_Rounding =>
13906 OK := Is_Fun
13907 and then Num_F = 1
13908 and then Is_Floating_Point_Type (T);
13910 when Attribute_Image | Attribute_Pred | Attribute_Succ |
13911 Attribute_Value | Attribute_Wide_Image |
13912 Attribute_Wide_Value =>
13913 OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
13915 when Attribute_Max | Attribute_Min =>
13916 OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
13918 when Attribute_Input =>
13919 OK := (Is_Fun and then Num_F = 1);
13921 when Attribute_Output | Attribute_Read | Attribute_Write =>
13922 OK := (not Is_Fun and then Num_F = 2);
13924 when others =>
13925 OK := False;
13926 end case;
13928 if not OK then
13929 Error_Msg_N ("attribute reference has wrong profile for subprogram",
13930 Def);
13931 end if;
13932 end Valid_Default_Attribute;
13934 end Sem_Ch12;