1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1992-2003, Free Software Foundation, Inc. --
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 2, 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 COPYING. If not, write --
19 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, USA. --
22 -- GNAT was originally developed by the GNAT team at New York University. --
23 -- Extensive contributions were provided by Ada Core Technologies Inc. --
25 ------------------------------------------------------------------------------
27 with Atree; use Atree;
28 with Einfo; use Einfo;
29 with Elists; use Elists;
30 with Errout; use Errout;
31 with Expander; use Expander;
32 with Fname; use Fname;
33 with Fname.UF; use Fname.UF;
34 with Freeze; use Freeze;
36 with Inline; use Inline;
38 with Lib.Load; use Lib.Load;
39 with Lib.Xref; use Lib.Xref;
40 with Nlists; use Nlists;
41 with Nmake; use Nmake;
43 with Restrict; use Restrict;
44 with Rtsfind; use Rtsfind;
46 with Sem_Cat; use Sem_Cat;
47 with Sem_Ch3; use Sem_Ch3;
48 with Sem_Ch6; use Sem_Ch6;
49 with Sem_Ch7; use Sem_Ch7;
50 with Sem_Ch8; use Sem_Ch8;
51 with Sem_Ch10; use Sem_Ch10;
52 with Sem_Ch13; use Sem_Ch13;
53 with Sem_Elab; use Sem_Elab;
54 with Sem_Elim; use Sem_Elim;
55 with Sem_Eval; use Sem_Eval;
56 with Sem_Res; use Sem_Res;
57 with Sem_Type; use Sem_Type;
58 with Sem_Util; use Sem_Util;
59 with Sem_Warn; use Sem_Warn;
60 with Stand; use Stand;
61 with Sinfo; use Sinfo;
62 with Sinfo.CN; use Sinfo.CN;
63 with Sinput; use Sinput;
64 with Sinput.L; use Sinput.L;
65 with Snames; use Snames;
66 with Stringt; use Stringt;
67 with Uname; use Uname;
69 with Tbuild; use Tbuild;
70 with Uintp; use Uintp;
71 with Urealp; use Urealp;
75 package body Sem_Ch12 is
77 ----------------------------------------------------------
78 -- Implementation of Generic Analysis and Instantiation --
79 -----------------------------------------------------------
81 -- GNAT implements generics by macro expansion. No attempt is made to
82 -- share generic instantiations (for now). Analysis of a generic definition
83 -- does not perform any expansion action, but the expander must be called
84 -- on the tree for each instantiation, because the expansion may of course
85 -- depend on the generic actuals. All of this is best achieved as follows:
87 -- a) Semantic analysis of a generic unit is performed on a copy of the
88 -- tree for the generic unit. All tree modifications that follow analysis
89 -- do not affect the original tree. Links are kept between the original
90 -- tree and the copy, in order to recognize non-local references within
91 -- the generic, and propagate them to each instance (recall that name
92 -- resolution is done on the generic declaration: generics are not really
93 -- macros!). This is summarized in the following diagram:
95 -- .-----------. .----------.
96 -- | semantic |<--------------| generic |
98 -- | |==============>| |
99 -- |___________| global |__________|
110 -- b) Each instantiation copies the original tree, and inserts into it a
111 -- series of declarations that describe the mapping between generic formals
112 -- and actuals. For example, a generic In OUT parameter is an object
113 -- renaming of the corresponing actual, etc. Generic IN parameters are
114 -- constant declarations.
116 -- c) In order to give the right visibility for these renamings, we use
117 -- a different scheme for package and subprogram instantiations. For
118 -- packages, the list of renamings is inserted into the package
119 -- specification, before the visible declarations of the package. The
120 -- renamings are analyzed before any of the text of the instance, and are
121 -- thus visible at the right place. Furthermore, outside of the instance,
122 -- the generic parameters are visible and denote their corresponding
125 -- For subprograms, we create a container package to hold the renamings
126 -- and the subprogram instance itself. Analysis of the package makes the
127 -- renaming declarations visible to the subprogram. After analyzing the
128 -- package, the defining entity for the subprogram is touched-up so that
129 -- it appears declared in the current scope, and not inside the container
132 -- If the instantiation is a compilation unit, the container package is
133 -- given the same name as the subprogram instance. This ensures that
134 -- the elaboration procedure called by the binder, using the compilation
135 -- unit name, calls in fact the elaboration procedure for the package.
137 -- Not surprisingly, private types complicate this approach. By saving in
138 -- the original generic object the non-local references, we guarantee that
139 -- the proper entities are referenced at the point of instantiation.
140 -- However, for private types, this by itself does not insure that the
141 -- proper VIEW of the entity is used (the full type may be visible at the
142 -- point of generic definition, but not at instantiation, or vice-versa).
143 -- In order to reference the proper view, we special-case any reference
144 -- to private types in the generic object, by saving both views, one in
145 -- the generic and one in the semantic copy. At time of instantiation, we
146 -- check whether the two views are consistent, and exchange declarations if
147 -- necessary, in order to restore the correct visibility. Similarly, if
148 -- the instance view is private when the generic view was not, we perform
149 -- the exchange. After completing the instantiation, we restore the
150 -- current visibility. The flag Has_Private_View marks identifiers in the
151 -- the generic unit that require checking.
153 -- Visibility within nested generic units requires special handling.
154 -- Consider the following scheme:
156 -- type Global is ... -- outside of generic unit.
160 -- type Semi_Global is ... -- global to inner.
163 -- procedure inner (X1 : Global; X2 : Semi_Global);
165 -- procedure in2 is new inner (...); -- 4
168 -- package New_Outer is new Outer (...); -- 2
169 -- procedure New_Inner is new New_Outer.Inner (...); -- 3
171 -- The semantic analysis of Outer captures all occurrences of Global.
172 -- The semantic analysis of Inner (at 1) captures both occurrences of
173 -- Global and Semi_Global.
175 -- At point 2 (instantiation of Outer), we also produce a generic copy
176 -- of Inner, even though Inner is, at that point, not being instantiated.
177 -- (This is just part of the semantic analysis of New_Outer).
179 -- Critically, references to Global within Inner must be preserved, while
180 -- references to Semi_Global should not preserved, because they must now
181 -- resolve to an entity within New_Outer. To distinguish between these, we
182 -- use a global variable, Current_Instantiated_Parent, which is set when
183 -- performing a generic copy during instantiation (at 2). This variable is
184 -- used when performing a generic copy that is not an instantiation, but
185 -- that is nested within one, as the occurrence of 1 within 2. The analysis
186 -- of a nested generic only preserves references that are global to the
187 -- enclosing Current_Instantiated_Parent. We use the Scope_Depth value to
188 -- determine whether a reference is external to the given parent.
190 -- The instantiation at point 3 requires no special treatment. The method
191 -- works as well for further nestings of generic units, but of course the
192 -- variable Current_Instantiated_Parent must be stacked because nested
193 -- instantiations can occur, e.g. the occurrence of 4 within 2.
195 -- The instantiation of package and subprogram bodies is handled in a
196 -- similar manner, except that it is delayed until after semantic
197 -- analysis is complete. In this fashion complex cross-dependencies
198 -- between several package declarations and bodies containing generics
199 -- can be compiled which otherwise would diagnose spurious circularities.
201 -- For example, it is possible to compile two packages A and B that
202 -- have the following structure:
204 -- package A is package B is
205 -- generic ... generic ...
206 -- package G_A is package G_B is
209 -- package body A is package body B is
210 -- package N_B is new G_B (..) package N_A is new G_A (..)
212 -- The table Pending_Instantiations in package Inline is used to keep
213 -- track of body instantiations that are delayed in this manner. Inline
214 -- handles the actual calls to do the body instantiations. This activity
215 -- is part of Inline, since the processing occurs at the same point, and
216 -- for essentially the same reason, as the handling of inlined routines.
218 ----------------------------------------------
219 -- Detection of Instantiation Circularities --
220 ----------------------------------------------
222 -- If we have a chain of instantiations that is circular, this is a
223 -- static error which must be detected at compile time. The detection
224 -- of these circularities is carried out at the point that we insert
225 -- a generic instance spec or body. If there is a circularity, then
226 -- the analysis of the offending spec or body will eventually result
227 -- in trying to load the same unit again, and we detect this problem
228 -- as we analyze the package instantiation for the second time.
230 -- At least in some cases after we have detected the circularity, we
231 -- get into trouble if we try to keep going. The following flag is
232 -- set if a circularity is detected, and used to abandon compilation
233 -- after the messages have been posted.
235 Circularity_Detected : Boolean := False;
236 -- This should really be reset on encountering a new main unit, but in
237 -- practice we are not using multiple main units so it is not critical.
239 -----------------------
240 -- Local subprograms --
241 -----------------------
243 procedure Abandon_Instantiation (N : Node_Id);
244 pragma No_Return (Abandon_Instantiation);
245 -- Posts an error message "instantiation abandoned" at the indicated
246 -- node and then raises the exception Instantiation_Error to do it.
248 procedure Analyze_Formal_Array_Type
249 (T : in out Entity_Id;
251 -- A formal array type is treated like an array type declaration, and
252 -- invokes Array_Type_Declaration (sem_ch3) whose first parameter is
253 -- in-out, because in the case of an anonymous type the entity is
254 -- actually created in the procedure.
256 -- The following procedures treat other kinds of formal parameters.
258 procedure Analyze_Formal_Derived_Type
263 -- All the following need comments???
265 procedure Analyze_Formal_Decimal_Fixed_Point_Type
266 (T : Entity_Id; Def : Node_Id);
267 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id);
268 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id);
269 procedure Analyze_Formal_Signed_Integer_Type (T : Entity_Id; Def : Node_Id);
270 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id);
271 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
272 (T : Entity_Id; Def : Node_Id);
274 procedure Analyze_Formal_Private_Type
278 -- This needs comments???
280 procedure Analyze_Generic_Formal_Part (N : Node_Id);
282 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id);
283 -- This needs comments ???
285 function Analyze_Associations
290 -- At instantiation time, build the list of associations between formals
291 -- and actuals. Each association becomes a renaming declaration for the
292 -- formal entity. F_Copy is the analyzed list of formals in the generic
293 -- copy. It is used to apply legality checks to the actuals. I_Node is the
294 -- instantiation node itself.
296 procedure Analyze_Subprogram_Instantiation
300 procedure Build_Instance_Compilation_Unit_Nodes
304 -- This procedure is used in the case where the generic instance of a
305 -- subprogram body or package body is a library unit. In this case, the
306 -- original library unit node for the generic instantiation must be
307 -- replaced by the resulting generic body, and a link made to a new
308 -- compilation unit node for the generic declaration. The argument N is
309 -- the original generic instantiation. Act_Body and Act_Decl are the body
310 -- and declaration of the instance (either package body and declaration
311 -- nodes or subprogram body and declaration nodes depending on the case).
312 -- On return, the node N has been rewritten with the actual body.
314 procedure Check_Formal_Packages (P_Id : Entity_Id);
315 -- Apply the following to all formal packages in generic associations.
317 procedure Check_Formal_Package_Instance
318 (Formal_Pack : Entity_Id;
319 Actual_Pack : Entity_Id);
320 -- Verify that the actuals of the actual instance match the actuals of
321 -- the template for a formal package that is not declared with a box.
323 procedure Check_Forward_Instantiation (Decl : Node_Id);
324 -- If the generic is a local entity and the corresponding body has not
325 -- been seen yet, flag enclosing packages to indicate that it will be
326 -- elaborated after the generic body. Subprograms declared in the same
327 -- package cannot be inlined by the front-end because front-end inlining
328 -- requires a strict linear order of elaboration.
330 procedure Check_Hidden_Child_Unit
332 Gen_Unit : Entity_Id;
333 Act_Decl_Id : Entity_Id);
334 -- If the generic unit is an implicit child instance within a parent
335 -- instance, we need to make an explicit test that it is not hidden by
336 -- a child instance of the same name and parent.
338 procedure Check_Private_View (N : Node_Id);
339 -- Check whether the type of a generic entity has a different view between
340 -- the point of generic analysis and the point of instantiation. If the
341 -- view has changed, then at the point of instantiation we restore the
342 -- correct view to perform semantic analysis of the instance, and reset
343 -- the current view after instantiation. The processing is driven by the
344 -- current private status of the type of the node, and Has_Private_View,
345 -- a flag that is set at the point of generic compilation. If view and
346 -- flag are inconsistent then the type is updated appropriately.
348 procedure Check_Generic_Actuals
349 (Instance : Entity_Id;
350 Is_Formal_Box : Boolean);
351 -- Similar to previous one. Check the actuals in the instantiation,
352 -- whose views can change between the point of instantiation and the point
353 -- of instantiation of the body. In addition, mark the generic renamings
354 -- as generic actuals, so that they are not compatible with other actuals.
355 -- Recurse on an actual that is a formal package whose declaration has
358 function Contains_Instance_Of
363 -- Inner is instantiated within the generic Outer. Check whether Inner
364 -- directly or indirectly contains an instance of Outer or of one of its
365 -- parents, in the case of a subunit. Each generic unit holds a list of
366 -- the entities instantiated within (at any depth). This procedure
367 -- determines whether the set of such lists contains a cycle, i.e. an
368 -- illegal circular instantiation.
370 function Denotes_Formal_Package (Pack : Entity_Id) return Boolean;
371 -- Returns True if E is a formal package of an enclosing generic, or
372 -- the actual for such a formal in an enclosing instantiation. Used in
373 -- Restore_Private_Views, to keep the formals of such a package visible
374 -- on exit from an inner instantiation.
376 function Find_Actual_Type
378 Gen_Scope : Entity_Id)
380 -- When validating the actual types of a child instance, check whether
381 -- the formal is a formal type of the parent unit, and retrieve the current
382 -- actual for it. Typ is the entity in the analyzed formal type declaration
383 -- (component or index type of an array type) and Gen_Scope is the scope of
384 -- the analyzed formal array type.
386 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id;
387 -- Given the entity of a unit that is an instantiation, retrieve the
388 -- original instance node. This is used when loading the instantiations
389 -- of the ancestors of a child generic that is being instantiated.
391 function In_Same_Declarative_Part
395 -- True if the instantiation Inst and the given freeze_node F_Node appear
396 -- within the same declarative part, ignoring subunits, but with no inter-
397 -- vening suprograms or concurrent units. If true, the freeze node
398 -- of the instance can be placed after the freeze node of the parent,
399 -- which it itself an instance.
401 procedure Set_Instance_Env
402 (Gen_Unit : Entity_Id;
403 Act_Unit : Entity_Id);
404 -- Save current instance on saved environment, to be used to determine
405 -- the global status of entities in nested instances. Part of Save_Env.
406 -- called after verifying that the generic unit is legal for the instance.
408 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id);
409 -- Associate analyzed generic parameter with corresponding
410 -- instance. Used for semantic checks at instantiation time.
412 function Has_Been_Exchanged (E : Entity_Id) return Boolean;
413 -- Traverse the Exchanged_Views list to see if a type was private
414 -- and has already been flipped during this phase of instantiation.
416 procedure Hide_Current_Scope;
417 -- When compiling a generic child unit, the parent context must be
418 -- present, but the instance and all entities that may be generated
419 -- must be inserted in the current scope. We leave the current scope
420 -- on the stack, but make its entities invisible to avoid visibility
421 -- problems. This is reversed at the end of instantiations. This is
422 -- not done for the instantiation of the bodies, which only require the
423 -- instances of the generic parents to be in scope.
425 procedure Install_Body
430 -- If the instantiation happens textually before the body of the generic,
431 -- the instantiation of the body must be analyzed after the generic body,
432 -- and not at the point of instantiation. Such early instantiations can
433 -- happen if the generic and the instance appear in a package declaration
434 -- because the generic body can only appear in the corresponding package
435 -- body. Early instantiations can also appear if generic, instance and
436 -- body are all in the declarative part of a subprogram or entry. Entities
437 -- of packages that are early instantiations are delayed, and their freeze
438 -- node appears after the generic body.
440 procedure Insert_After_Last_Decl (N : Node_Id; F_Node : Node_Id);
441 -- Insert freeze node at the end of the declarative part that includes the
442 -- instance node N. If N is in the visible part of an enclosing package
443 -- declaration, the freeze node has to be inserted at the end of the
444 -- private declarations, if any.
446 procedure Freeze_Subprogram_Body
447 (Inst_Node : Node_Id;
449 Pack_Id : Entity_Id);
450 -- The generic body may appear textually after the instance, including
451 -- in the proper body of a stub, or within a different package instance.
452 -- Given that the instance can only be elaborated after the generic, we
453 -- place freeze_nodes for the instance and/or for packages that may enclose
454 -- the instance and the generic, so that the back-end can establish the
455 -- proper order of elaboration.
458 -- Establish environment for subsequent instantiation. Separated from
459 -- Save_Env because data-structures for visibility handling must be
460 -- initialized before call to Check_Generic_Child_Unit.
462 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False);
463 -- When compiling an instance of a child unit the parent (which is
464 -- itself an instance) is an enclosing scope that must be made
465 -- immediately visible. This procedure is also used to install the non-
466 -- generic parent of a generic child unit when compiling its body, so that
467 -- full views of types in the parent are made visible.
469 procedure Remove_Parent (In_Body : Boolean := False);
470 -- Reverse effect after instantiation of child is complete.
472 procedure Inline_Instance_Body
474 Gen_Unit : Entity_Id;
476 -- If front-end inlining is requested, instantiate the package body,
477 -- and preserve the visibility of its compilation unit, to insure
478 -- that successive instantiations succeed.
480 -- The functions Instantiate_XXX perform various legality checks and build
481 -- the declarations for instantiated generic parameters.
482 -- Need to describe what the parameters are ???
484 function Instantiate_Object
487 Analyzed_Formal : Node_Id)
490 function Instantiate_Type
493 Analyzed_Formal : Node_Id;
494 Actual_Decls : List_Id)
497 function Instantiate_Formal_Subprogram
500 Analyzed_Formal : Node_Id)
503 function Instantiate_Formal_Package
506 Analyzed_Formal : Node_Id)
508 -- If the formal package is declared with a box, special visibility rules
509 -- apply to its formals: they are in the visible part of the package. This
510 -- is true in the declarative region of the formal package, that is to say
511 -- in the enclosing generic or instantiation. For an instantiation, the
512 -- parameters of the formal package are made visible in an explicit step.
513 -- Furthermore, if the actual is a visible use_clause, these formals must
514 -- be made potentially use_visible as well. On exit from the enclosing
515 -- instantiation, the reverse must be done.
517 -- For a formal package declared without a box, there are conformance rules
518 -- that apply to the actuals in the generic declaration and the actuals of
519 -- the actual package in the enclosing instantiation. The simplest way to
520 -- apply these rules is to repeat the instantiation of the formal package
521 -- in the context of the enclosing instance, and compare the generic
522 -- associations of this instantiation with those of the actual package.
524 function Is_In_Main_Unit (N : Node_Id) return Boolean;
525 -- Test if given node is in the main unit
527 procedure Load_Parent_Of_Generic (N : Node_Id; Spec : Node_Id);
528 -- If the generic appears in a separate non-generic library unit,
529 -- load the corresponding body to retrieve the body of the generic.
530 -- N is the node for the generic instantiation, Spec is the generic
531 -- package declaration.
533 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id);
534 -- Add the context clause of the unit containing a generic unit to
535 -- an instantiation that is a compilation unit.
537 function Get_Associated_Node (N : Node_Id) return Node_Id;
538 -- In order to propagate semantic information back from the analyzed
539 -- copy to the original generic, we maintain links between selected nodes
540 -- in the generic and their corresponding copies. At the end of generic
541 -- analysis, the routine Save_Global_References traverses the generic
542 -- tree, examines the semantic information, and preserves the links to
543 -- those nodes that contain global information. At instantiation, the
544 -- information from the associated node is placed on the new copy, so
545 -- that name resolution is not repeated.
547 -- Three kinds of source nodes have associated nodes:
549 -- a) those that can reference (denote) entities, that is identifiers,
550 -- character literals, expanded_names, operator symbols, operators,
551 -- and attribute reference nodes. These nodes have an Entity field
552 -- and are the set of nodes that are in N_Has_Entity.
554 -- b) aggregates (N_Aggregate and N_Extension_Aggregate)
556 -- c) selected components (N_Selected_Component)
558 -- For the first class, the associated node preserves the entity if it is
559 -- global. If the generic contains nested instantiations, the associated
560 -- node itself has been recopied, and a chain of them must be followed.
562 -- For aggregates, the associated node allows retrieval of the type, which
563 -- may otherwise not appear in the generic. The view of this type may be
564 -- different between generic and instantiation, and the full view can be
565 -- installed before the instantiation is analyzed. For aggregates of
566 -- type extensions, the same view exchange may have to be performed for
567 -- some of the ancestor types, if their view is private at the point of
570 -- Nodes that are selected components in the parse tree may be rewritten
571 -- as expanded names after resolution, and must be treated as potential
572 -- entity holders. which is why they also have an Associated_Node.
574 -- Nodes that do not come from source, such as freeze nodes, do not appear
575 -- in the generic tree, and need not have an associated node.
577 -- The associated node is stored in the Associated_Node field. Note that
578 -- this field overlaps Entity, which is fine, because the whole point is
579 -- that we don't need or want the normal Entity field in this situation.
581 procedure Move_Freeze_Nodes
585 -- Freeze nodes can be generated in the analysis of a generic unit, but
586 -- will not be seen by the back-end. It is necessary to move those nodes
587 -- to the enclosing scope if they freeze an outer entity. We place them
588 -- at the end of the enclosing generic package, which is semantically
591 procedure Pre_Analyze_Actuals (N : Node_Id);
592 -- Analyze actuals to perform name resolution. Full resolution is done
593 -- later, when the expected types are known, but names have to be captured
594 -- before installing parents of generics, that are not visible for the
595 -- actuals themselves.
597 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id);
598 -- Verify that an attribute that appears as the default for a formal
599 -- subprogram is a function or procedure with the correct profile.
601 -------------------------------------------
602 -- Data Structures for Generic Renamings --
603 -------------------------------------------
605 -- The map Generic_Renamings associates generic entities with their
606 -- corresponding actuals. Currently used to validate type instances.
607 -- It will eventually be used for all generic parameters to eliminate
608 -- the need for overload resolution in the instance.
610 type Assoc_Ptr is new Int;
612 Assoc_Null : constant Assoc_Ptr := -1;
617 Next_In_HTable : Assoc_Ptr;
620 package Generic_Renamings is new Table.Table
621 (Table_Component_Type => Assoc,
622 Table_Index_Type => Assoc_Ptr,
623 Table_Low_Bound => 0,
625 Table_Increment => 100,
626 Table_Name => "Generic_Renamings");
628 -- Variable to hold enclosing instantiation. When the environment is
629 -- saved for a subprogram inlining, the corresponding Act_Id is empty.
631 Current_Instantiated_Parent : Assoc := (Empty, Empty, Assoc_Null);
633 -- Hash table for associations
635 HTable_Size : constant := 37;
636 type HTable_Range is range 0 .. HTable_Size - 1;
638 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr);
639 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr;
640 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id;
641 function Hash (F : Entity_Id) return HTable_Range;
643 package Generic_Renamings_HTable is new GNAT.HTable.Static_HTable (
644 Header_Num => HTable_Range,
646 Elmt_Ptr => Assoc_Ptr,
647 Null_Ptr => Assoc_Null,
648 Set_Next => Set_Next_Assoc,
651 Get_Key => Get_Gen_Id,
655 Exchanged_Views : Elist_Id;
656 -- This list holds the private views that have been exchanged during
657 -- instantiation to restore the visibility of the generic declaration.
658 -- (see comments above). After instantiation, the current visibility is
659 -- reestablished by means of a traversal of this list.
661 Hidden_Entities : Elist_Id;
662 -- This list holds the entities of the current scope that are removed
663 -- from immediate visibility when instantiating a child unit. Their
664 -- visibility is restored in Remove_Parent.
666 -- Because instantiations can be recursive, the following must be saved
667 -- on entry and restored on exit from an instantiation (spec or body).
668 -- This is done by the two procedures Save_Env and Restore_Env. For
669 -- package and subprogram instantiations (but not for the body instances)
670 -- the action of Save_Env is done in two steps: Init_Env is called before
671 -- Check_Generic_Child_Unit, because setting the parent instances requires
672 -- that the visibility data structures be properly initialized. Once the
673 -- generic is unit is validated, Set_Instance_Env completes Save_Env.
675 type Instance_Env is record
677 Instantiated_Parent : Assoc;
678 Exchanged_Views : Elist_Id;
679 Hidden_Entities : Elist_Id;
680 Current_Sem_Unit : Unit_Number_Type;
683 package Instance_Envs is new Table.Table (
684 Table_Component_Type => Instance_Env,
685 Table_Index_Type => Int,
686 Table_Low_Bound => 0,
688 Table_Increment => 100,
689 Table_Name => "Instance_Envs");
691 procedure Restore_Private_Views
692 (Pack_Id : Entity_Id;
693 Is_Package : Boolean := True);
694 -- Restore the private views of external types, and unmark the generic
695 -- renamings of actuals, so that they become comptible subtypes again.
696 -- For subprograms, Pack_Id is the package constructed to hold the
699 procedure Switch_View (T : Entity_Id);
700 -- Switch the partial and full views of a type and its private
701 -- dependents (i.e. its subtypes and derived types).
703 ------------------------------------
704 -- Structures for Error Reporting --
705 ------------------------------------
707 Instantiation_Node : Node_Id;
708 -- Used by subprograms that validate instantiation of formal parameters
709 -- where there might be no actual on which to place the error message.
710 -- Also used to locate the instantiation node for generic subunits.
712 Instantiation_Error : exception;
713 -- When there is a semantic error in the generic parameter matching,
714 -- there is no point in continuing the instantiation, because the
715 -- number of cascaded errors is unpredictable. This exception aborts
716 -- the instantiation process altogether.
718 S_Adjustment : Sloc_Adjustment;
719 -- Offset created for each node in an instantiation, in order to keep
720 -- track of the source position of the instantiation in each of its nodes.
721 -- A subsequent semantic error or warning on a construct of the instance
722 -- points to both places: the original generic node, and the point of
723 -- instantiation. See Sinput and Sinput.L for additional details.
725 ------------------------------------------------------------
726 -- Data structure for keeping track when inside a Generic --
727 ------------------------------------------------------------
729 -- The following table is used to save values of the Inside_A_Generic
730 -- flag (see spec of Sem) when they are saved by Start_Generic.
732 package Generic_Flags is new Table.Table (
733 Table_Component_Type => Boolean,
734 Table_Index_Type => Int,
735 Table_Low_Bound => 0,
737 Table_Increment => 200,
738 Table_Name => "Generic_Flags");
740 ---------------------------
741 -- Abandon_Instantiation --
742 ---------------------------
744 procedure Abandon_Instantiation (N : Node_Id) is
746 Error_Msg_N ("instantiation abandoned!", N);
747 raise Instantiation_Error;
748 end Abandon_Instantiation;
750 --------------------------
751 -- Analyze_Associations --
752 --------------------------
754 function Analyze_Associations
760 Actual_Types : constant Elist_Id := New_Elmt_List;
761 Assoc : constant List_Id := New_List;
762 Defaults : constant Elist_Id := New_Elmt_List;
763 Gen_Unit : constant Entity_Id := Defining_Entity
768 Next_Formal : Node_Id;
769 Temp_Formal : Node_Id;
770 Analyzed_Formal : Node_Id;
773 First_Named : Node_Id := Empty;
774 Found_Assoc : Node_Id;
775 Is_Named_Assoc : Boolean;
776 Num_Matched : Int := 0;
777 Num_Actuals : Int := 0;
779 function Matching_Actual
783 -- Find actual that corresponds to a given a formal parameter. If the
784 -- actuals are positional, return the next one, if any. If the actuals
785 -- are named, scan the parameter associations to find the right one.
786 -- A_F is the corresponding entity in the analyzed generic,which is
787 -- placed on the selector name for ASIS use.
789 procedure Set_Analyzed_Formal;
790 -- Find the node in the generic copy that corresponds to a given formal.
791 -- The semantic information on this node is used to perform legality
792 -- checks on the actuals. Because semantic analysis can introduce some
793 -- anonymous entities or modify the declaration node itself, the
794 -- correspondence between the two lists is not one-one. In addition to
795 -- anonymous types, the presence a formal equality will introduce an
796 -- implicit declaration for the corresponding inequality.
798 ---------------------
799 -- Matching_Actual --
800 ---------------------
802 function Matching_Actual
811 Is_Named_Assoc := False;
813 -- End of list of purely positional parameters
818 -- Case of positional parameter corresponding to current formal
820 elsif No (Selector_Name (Actual)) then
821 Found := Explicit_Generic_Actual_Parameter (Actual);
822 Found_Assoc := Actual;
823 Num_Matched := Num_Matched + 1;
826 -- Otherwise scan list of named actuals to find the one with the
827 -- desired name. All remaining actuals have explicit names.
830 Is_Named_Assoc := True;
834 while Present (Actual) loop
835 if Chars (Selector_Name (Actual)) = Chars (F) then
836 Found := Explicit_Generic_Actual_Parameter (Actual);
837 Set_Entity (Selector_Name (Actual), A_F);
838 Set_Etype (Selector_Name (Actual), Etype (A_F));
839 Generate_Reference (A_F, Selector_Name (Actual));
840 Found_Assoc := Actual;
841 Num_Matched := Num_Matched + 1;
849 -- Reset for subsequent searches. In most cases the named
850 -- associations are in order. If they are not, we reorder them
851 -- to avoid scanning twice the same actual. This is not just a
852 -- question of efficiency: there may be multiple defaults with
853 -- boxes that have the same name. In a nested instantiation we
854 -- insert actuals for those defaults, and cannot rely on their
855 -- names to disambiguate them.
857 if Actual = First_Named then
860 elsif Present (Actual) then
861 Insert_Before (First_Named, Remove_Next (Prev));
864 Actual := First_Named;
870 -------------------------
871 -- Set_Analyzed_Formal --
872 -------------------------
874 procedure Set_Analyzed_Formal is
877 while Present (Analyzed_Formal) loop
878 Kind := Nkind (Analyzed_Formal);
880 case Nkind (Formal) is
882 when N_Formal_Subprogram_Declaration =>
883 exit when Kind = N_Formal_Subprogram_Declaration
886 (Defining_Unit_Name (Specification (Formal))) =
888 (Defining_Unit_Name (Specification (Analyzed_Formal)));
890 when N_Formal_Package_Declaration =>
892 Kind = N_Formal_Package_Declaration
894 Kind = N_Generic_Package_Declaration;
896 when N_Use_Package_Clause | N_Use_Type_Clause => exit;
900 -- Skip freeze nodes, and nodes inserted to replace
901 -- unrecognized pragmas.
904 Kind /= N_Formal_Subprogram_Declaration
905 and then Kind /= N_Subprogram_Declaration
906 and then Kind /= N_Freeze_Entity
907 and then Kind /= N_Null_Statement
908 and then Kind /= N_Itype_Reference
909 and then Chars (Defining_Identifier (Formal)) =
910 Chars (Defining_Identifier (Analyzed_Formal));
913 Next (Analyzed_Formal);
916 end Set_Analyzed_Formal;
918 -- Start of processing for Analyze_Associations
921 -- If named associations are present, save the first named association
922 -- (it may of course be Empty) to facilitate subsequent name search.
924 Actuals := Generic_Associations (I_Node);
926 if Present (Actuals) then
927 First_Named := First (Actuals);
929 while Present (First_Named)
930 and then No (Selector_Name (First_Named))
932 Num_Actuals := Num_Actuals + 1;
937 Named := First_Named;
938 while Present (Named) loop
939 if No (Selector_Name (Named)) then
940 Error_Msg_N ("invalid positional actual after named one", Named);
941 Abandon_Instantiation (Named);
944 -- A named association may lack an actual parameter, if it was
945 -- introduced for a default subprogram that turns out to be local
946 -- to the outer instantiation.
948 if Present (Explicit_Generic_Actual_Parameter (Named)) then
949 Num_Actuals := Num_Actuals + 1;
955 if Present (Formals) then
956 Formal := First_Non_Pragma (Formals);
957 Analyzed_Formal := First_Non_Pragma (F_Copy);
959 if Present (Actuals) then
960 Actual := First (Actuals);
962 -- All formals should have default values
968 while Present (Formal) loop
970 Next_Formal := Next_Non_Pragma (Formal);
972 case Nkind (Formal) is
973 when N_Formal_Object_Declaration =>
976 Defining_Identifier (Formal),
977 Defining_Identifier (Analyzed_Formal));
980 (Instantiate_Object (Formal, Match, Analyzed_Formal),
983 when N_Formal_Type_Declaration =>
986 Defining_Identifier (Formal),
987 Defining_Identifier (Analyzed_Formal));
992 Instantiation_Node, Defining_Identifier (Formal));
993 Error_Msg_NE ("\in instantiation of & declared#",
994 Instantiation_Node, Gen_Unit);
995 Abandon_Instantiation (Instantiation_Node);
1001 (Formal, Match, Analyzed_Formal, Assoc));
1003 -- an instantiation is a freeze point for the actuals,
1004 -- unless this is a rewritten formal package.
1006 if Nkind (I_Node) /= N_Formal_Package_Declaration then
1007 Append_Elmt (Entity (Match), Actual_Types);
1011 -- A remote access-to-class-wide type must not be an
1012 -- actual parameter for a generic formal of an access
1013 -- type (E.2.2 (17)).
1015 if Nkind (Analyzed_Formal) = N_Formal_Type_Declaration
1017 Nkind (Formal_Type_Definition (Analyzed_Formal)) =
1018 N_Access_To_Object_Definition
1020 Validate_Remote_Access_To_Class_Wide_Type (Match);
1023 when N_Formal_Subprogram_Declaration =>
1026 Defining_Unit_Name (Specification (Formal)),
1027 Defining_Unit_Name (Specification (Analyzed_Formal)));
1029 -- If the formal subprogram has the same name as
1030 -- another formal subprogram of the generic, then
1031 -- a named association is illegal (12.3(9)). Exclude
1032 -- named associations that are generated for a nested
1036 and then Is_Named_Assoc
1037 and then Comes_From_Source (Found_Assoc)
1039 Temp_Formal := First (Formals);
1040 while Present (Temp_Formal) loop
1041 if Nkind (Temp_Formal) =
1042 N_Formal_Subprogram_Declaration
1043 and then Temp_Formal /= Formal
1045 Chars (Selector_Name (Found_Assoc)) =
1046 Chars (Defining_Unit_Name
1047 (Specification (Temp_Formal)))
1050 ("name not allowed for overloaded formal",
1052 Abandon_Instantiation (Instantiation_Node);
1060 Instantiate_Formal_Subprogram
1061 (Formal, Match, Analyzed_Formal));
1064 and then Box_Present (Formal)
1067 (Defining_Unit_Name (Specification (Last (Assoc))),
1071 when N_Formal_Package_Declaration =>
1074 Defining_Identifier (Formal),
1075 Defining_Identifier (Original_Node (Analyzed_Formal)));
1080 Instantiation_Node, Defining_Identifier (Formal));
1081 Error_Msg_NE ("\in instantiation of & declared#",
1082 Instantiation_Node, Gen_Unit);
1084 Abandon_Instantiation (Instantiation_Node);
1089 (Instantiate_Formal_Package
1090 (Formal, Match, Analyzed_Formal),
1094 -- For use type and use package appearing in the context
1095 -- clause, we have already copied them, so we can just
1096 -- move them where they belong (we mustn't recopy them
1097 -- since this would mess up the Sloc values).
1099 when N_Use_Package_Clause |
1100 N_Use_Type_Clause =>
1102 Append (Formal, Assoc);
1105 raise Program_Error;
1109 Formal := Next_Formal;
1110 Next_Non_Pragma (Analyzed_Formal);
1113 if Num_Actuals > Num_Matched then
1114 if Present (Selector_Name (Actual)) then
1116 ("unmatched actual&",
1117 Actual, Selector_Name (Actual));
1118 Error_Msg_NE ("\in instantiation of& declared#",
1122 ("unmatched actual in instantiation of& declared#",
1127 elsif Present (Actuals) then
1129 ("too many actuals in generic instantiation", Instantiation_Node);
1133 Elmt : Elmt_Id := First_Elmt (Actual_Types);
1136 while Present (Elmt) loop
1137 Freeze_Before (I_Node, Node (Elmt));
1142 -- If there are default subprograms, normalize the tree by adding
1143 -- explicit associations for them. This is required if the instance
1144 -- appears within a generic.
1152 Elmt := First_Elmt (Defaults);
1153 while Present (Elmt) loop
1154 if No (Actuals) then
1155 Actuals := New_List;
1156 Set_Generic_Associations (I_Node, Actuals);
1159 Subp := Node (Elmt);
1161 Make_Generic_Association (Sloc (Subp),
1162 Selector_Name => New_Occurrence_Of (Subp, Sloc (Subp)),
1163 Explicit_Generic_Actual_Parameter =>
1164 New_Occurrence_Of (Subp, Sloc (Subp)));
1165 Mark_Rewrite_Insertion (New_D);
1166 Append_To (Actuals, New_D);
1172 end Analyze_Associations;
1174 -------------------------------
1175 -- Analyze_Formal_Array_Type --
1176 -------------------------------
1178 procedure Analyze_Formal_Array_Type
1179 (T : in out Entity_Id;
1185 -- Treated like a non-generic array declaration, with
1186 -- additional semantic checks.
1190 if Nkind (Def) = N_Constrained_Array_Definition then
1191 DSS := First (Discrete_Subtype_Definitions (Def));
1192 while Present (DSS) loop
1193 if Nkind (DSS) = N_Subtype_Indication
1194 or else Nkind (DSS) = N_Range
1195 or else Nkind (DSS) = N_Attribute_Reference
1197 Error_Msg_N ("only a subtype mark is allowed in a formal", DSS);
1204 Array_Type_Declaration (T, Def);
1205 Set_Is_Generic_Type (Base_Type (T));
1207 if Ekind (Component_Type (T)) = E_Incomplete_Type
1208 and then No (Full_View (Component_Type (T)))
1210 Error_Msg_N ("premature usage of incomplete type", Def);
1212 elsif Is_Internal (Component_Type (T))
1213 and then Nkind (Original_Node (Subtype_Indication (Def)))
1214 /= N_Attribute_Reference
1217 ("only a subtype mark is allowed in a formal",
1218 Subtype_Indication (Def));
1221 end Analyze_Formal_Array_Type;
1223 ---------------------------------------------
1224 -- Analyze_Formal_Decimal_Fixed_Point_Type --
1225 ---------------------------------------------
1227 -- As for other generic types, we create a valid type representation
1228 -- with legal but arbitrary attributes, whose values are never considered
1229 -- static. For all scalar types we introduce an anonymous base type, with
1230 -- the same attributes. We choose the corresponding integer type to be
1231 -- Standard_Integer.
1233 procedure Analyze_Formal_Decimal_Fixed_Point_Type
1237 Loc : constant Source_Ptr := Sloc (Def);
1238 Base : constant Entity_Id :=
1240 (E_Decimal_Fixed_Point_Type,
1241 Current_Scope, Sloc (Def), 'G');
1242 Int_Base : constant Entity_Id := Standard_Integer;
1243 Delta_Val : constant Ureal := Ureal_1;
1244 Digs_Val : constant Uint := Uint_6;
1249 Set_Etype (Base, Base);
1250 Set_Size_Info (Base, Int_Base);
1251 Set_RM_Size (Base, RM_Size (Int_Base));
1252 Set_First_Rep_Item (Base, First_Rep_Item (Int_Base));
1253 Set_Digits_Value (Base, Digs_Val);
1254 Set_Delta_Value (Base, Delta_Val);
1255 Set_Small_Value (Base, Delta_Val);
1256 Set_Scalar_Range (Base,
1258 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
1259 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
1261 Set_Is_Generic_Type (Base);
1262 Set_Parent (Base, Parent (Def));
1264 Set_Ekind (T, E_Decimal_Fixed_Point_Subtype);
1265 Set_Etype (T, Base);
1266 Set_Size_Info (T, Int_Base);
1267 Set_RM_Size (T, RM_Size (Int_Base));
1268 Set_First_Rep_Item (T, First_Rep_Item (Int_Base));
1269 Set_Digits_Value (T, Digs_Val);
1270 Set_Delta_Value (T, Delta_Val);
1271 Set_Small_Value (T, Delta_Val);
1272 Set_Scalar_Range (T, Scalar_Range (Base));
1274 Check_Restriction (No_Fixed_Point, Def);
1275 end Analyze_Formal_Decimal_Fixed_Point_Type;
1277 ---------------------------------
1278 -- Analyze_Formal_Derived_Type --
1279 ---------------------------------
1281 procedure Analyze_Formal_Derived_Type
1286 Loc : constant Source_Ptr := Sloc (Def);
1287 Unk_Disc : constant Boolean := Unknown_Discriminants_Present (N);
1291 Set_Is_Generic_Type (T);
1293 if Private_Present (Def) then
1295 Make_Private_Extension_Declaration (Loc,
1296 Defining_Identifier => T,
1297 Discriminant_Specifications => Discriminant_Specifications (N),
1298 Unknown_Discriminants_Present => Unk_Disc,
1299 Subtype_Indication => Subtype_Mark (Def));
1301 Set_Abstract_Present (New_N, Abstract_Present (Def));
1305 Make_Full_Type_Declaration (Loc,
1306 Defining_Identifier => T,
1307 Discriminant_Specifications =>
1308 Discriminant_Specifications (Parent (T)),
1310 Make_Derived_Type_Definition (Loc,
1311 Subtype_Indication => Subtype_Mark (Def)));
1313 Set_Abstract_Present
1314 (Type_Definition (New_N), Abstract_Present (Def));
1321 if not Is_Composite_Type (T) then
1323 ("unknown discriminants not allowed for elementary types", N);
1325 Set_Has_Unknown_Discriminants (T);
1326 Set_Is_Constrained (T, False);
1330 -- If the parent type has a known size, so does the formal, which
1331 -- makes legal representation clauses that involve the formal.
1333 Set_Size_Known_At_Compile_Time
1334 (T, Size_Known_At_Compile_Time (Entity (Subtype_Mark (Def))));
1336 end Analyze_Formal_Derived_Type;
1338 ----------------------------------
1339 -- Analyze_Formal_Discrete_Type --
1340 ----------------------------------
1342 -- The operations defined for a discrete types are those of an
1343 -- enumeration type. The size is set to an arbitrary value, for use
1344 -- in analyzing the generic unit.
1346 procedure Analyze_Formal_Discrete_Type (T : Entity_Id; Def : Node_Id) is
1347 Loc : constant Source_Ptr := Sloc (Def);
1353 Set_Ekind (T, E_Enumeration_Type);
1358 -- For semantic analysis, the bounds of the type must be set to some
1359 -- non-static value. The simplest is to create attribute nodes for
1360 -- those bounds, that refer to the type itself. These bounds are never
1361 -- analyzed but serve as place-holders.
1364 Make_Attribute_Reference (Loc,
1365 Attribute_Name => Name_First,
1366 Prefix => New_Reference_To (T, Loc));
1370 Make_Attribute_Reference (Loc,
1371 Attribute_Name => Name_Last,
1372 Prefix => New_Reference_To (T, Loc));
1375 Set_Scalar_Range (T,
1380 end Analyze_Formal_Discrete_Type;
1382 ----------------------------------
1383 -- Analyze_Formal_Floating_Type --
1384 ---------------------------------
1386 procedure Analyze_Formal_Floating_Type (T : Entity_Id; Def : Node_Id) is
1387 Base : constant Entity_Id :=
1389 (E_Floating_Point_Type, Current_Scope, Sloc (Def), 'G');
1392 -- The various semantic attributes are taken from the predefined type
1393 -- Float, just so that all of them are initialized. Their values are
1394 -- never used because no constant folding or expansion takes place in
1395 -- the generic itself.
1398 Set_Ekind (T, E_Floating_Point_Subtype);
1399 Set_Etype (T, Base);
1400 Set_Size_Info (T, (Standard_Float));
1401 Set_RM_Size (T, RM_Size (Standard_Float));
1402 Set_Digits_Value (T, Digits_Value (Standard_Float));
1403 Set_Scalar_Range (T, Scalar_Range (Standard_Float));
1405 Set_Is_Generic_Type (Base);
1406 Set_Etype (Base, Base);
1407 Set_Size_Info (Base, (Standard_Float));
1408 Set_RM_Size (Base, RM_Size (Standard_Float));
1409 Set_Digits_Value (Base, Digits_Value (Standard_Float));
1410 Set_Scalar_Range (Base, Scalar_Range (Standard_Float));
1411 Set_Parent (Base, Parent (Def));
1413 Check_Restriction (No_Floating_Point, Def);
1414 end Analyze_Formal_Floating_Type;
1416 ---------------------------------
1417 -- Analyze_Formal_Modular_Type --
1418 ---------------------------------
1420 procedure Analyze_Formal_Modular_Type (T : Entity_Id; Def : Node_Id) is
1422 -- Apart from their entity kind, generic modular types are treated
1423 -- like signed integer types, and have the same attributes.
1425 Analyze_Formal_Signed_Integer_Type (T, Def);
1426 Set_Ekind (T, E_Modular_Integer_Subtype);
1427 Set_Ekind (Etype (T), E_Modular_Integer_Type);
1429 end Analyze_Formal_Modular_Type;
1431 ---------------------------------------
1432 -- Analyze_Formal_Object_Declaration --
1433 ---------------------------------------
1435 procedure Analyze_Formal_Object_Declaration (N : Node_Id) is
1436 E : constant Node_Id := Expression (N);
1437 Id : constant Node_Id := Defining_Identifier (N);
1444 -- Determine the mode of the formal object
1446 if Out_Present (N) then
1447 K := E_Generic_In_Out_Parameter;
1449 if not In_Present (N) then
1450 Error_Msg_N ("formal generic objects cannot have mode OUT", N);
1454 K := E_Generic_In_Parameter;
1457 Find_Type (Subtype_Mark (N));
1458 T := Entity (Subtype_Mark (N));
1460 if Ekind (T) = E_Incomplete_Type then
1461 Error_Msg_N ("premature usage of incomplete type", Subtype_Mark (N));
1464 if K = E_Generic_In_Parameter then
1465 if Is_Limited_Type (T) then
1467 ("generic formal of mode IN must not be of limited type", N);
1468 Explain_Limited_Type (T, N);
1471 if Is_Abstract (T) then
1473 ("generic formal of mode IN must not be of abstract type", N);
1477 Analyze_Per_Use_Expression (E, T);
1483 -- Case of generic IN OUT parameter.
1486 -- If the formal has an unconstrained type, construct its
1487 -- actual subtype, as is done for subprogram formals. In this
1488 -- fashion, all its uses can refer to specific bounds.
1493 if (Is_Array_Type (T)
1494 and then not Is_Constrained (T))
1496 (Ekind (T) = E_Record_Type
1497 and then Has_Discriminants (T))
1500 Non_Freezing_Ref : constant Node_Id :=
1501 New_Reference_To (Id, Sloc (Id));
1505 -- Make sure that the actual subtype doesn't generate
1508 Set_Must_Not_Freeze (Non_Freezing_Ref);
1509 Decl := Build_Actual_Subtype (T, Non_Freezing_Ref);
1510 Insert_Before_And_Analyze (N, Decl);
1511 Set_Actual_Subtype (Id, Defining_Identifier (Decl));
1514 Set_Actual_Subtype (Id, T);
1519 ("initialization not allowed for `IN OUT` formals", N);
1523 end Analyze_Formal_Object_Declaration;
1525 ----------------------------------------------
1526 -- Analyze_Formal_Ordinary_Fixed_Point_Type --
1527 ----------------------------------------------
1529 procedure Analyze_Formal_Ordinary_Fixed_Point_Type
1533 Loc : constant Source_Ptr := Sloc (Def);
1534 Base : constant Entity_Id :=
1536 (E_Ordinary_Fixed_Point_Type, Current_Scope, Sloc (Def), 'G');
1538 -- The semantic attributes are set for completeness only, their
1539 -- values will never be used, because all properties of the type
1543 Set_Ekind (T, E_Ordinary_Fixed_Point_Subtype);
1544 Set_Etype (T, Base);
1545 Set_Size_Info (T, Standard_Integer);
1546 Set_RM_Size (T, RM_Size (Standard_Integer));
1547 Set_Small_Value (T, Ureal_1);
1548 Set_Delta_Value (T, Ureal_1);
1549 Set_Scalar_Range (T,
1551 Low_Bound => Make_Real_Literal (Loc, Ureal_1),
1552 High_Bound => Make_Real_Literal (Loc, Ureal_1)));
1554 Set_Is_Generic_Type (Base);
1555 Set_Etype (Base, Base);
1556 Set_Size_Info (Base, Standard_Integer);
1557 Set_RM_Size (Base, RM_Size (Standard_Integer));
1558 Set_Small_Value (Base, Ureal_1);
1559 Set_Delta_Value (Base, Ureal_1);
1560 Set_Scalar_Range (Base, Scalar_Range (T));
1561 Set_Parent (Base, Parent (Def));
1563 Check_Restriction (No_Fixed_Point, Def);
1564 end Analyze_Formal_Ordinary_Fixed_Point_Type;
1566 ----------------------------
1567 -- Analyze_Formal_Package --
1568 ----------------------------
1570 procedure Analyze_Formal_Package (N : Node_Id) is
1571 Loc : constant Source_Ptr := Sloc (N);
1572 Formal : constant Entity_Id := Defining_Identifier (N);
1573 Gen_Id : constant Node_Id := Name (N);
1575 Gen_Unit : Entity_Id;
1577 Parent_Installed : Boolean := False;
1579 Parent_Instance : Entity_Id;
1580 Renaming_In_Par : Entity_Id;
1583 Text_IO_Kludge (Gen_Id);
1586 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
1587 Gen_Unit := Entity (Gen_Id);
1589 if Ekind (Gen_Unit) /= E_Generic_Package then
1590 Error_Msg_N ("expect generic package name", Gen_Id);
1594 elsif Gen_Unit = Current_Scope then
1596 ("generic package cannot be used as a formal package of itself",
1602 -- Check for a formal package that is a package renaming.
1604 if Present (Renamed_Object (Gen_Unit)) then
1605 Gen_Unit := Renamed_Object (Gen_Unit);
1608 -- The formal package is treated like a regular instance, but only
1609 -- the specification needs to be instantiated, to make entities visible.
1611 if not Box_Present (N) then
1612 Hidden_Entities := New_Elmt_List;
1613 Analyze_Package_Instantiation (N);
1615 if Parent_Installed then
1620 -- If there are no generic associations, the generic parameters
1621 -- appear as local entities and are instantiated like them. We copy
1622 -- the generic package declaration as if it were an instantiation,
1623 -- and analyze it like a regular package, except that we treat the
1624 -- formals as additional visible components.
1626 Set_Instance_Env (Gen_Unit, Formal);
1628 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
1630 if In_Extended_Main_Source_Unit (N) then
1631 Set_Is_Instantiated (Gen_Unit);
1632 Generate_Reference (Gen_Unit, N);
1637 (Original_Node (Gen_Decl), Empty, Instantiating => True);
1638 Set_Defining_Unit_Name (Specification (New_N), Formal);
1641 Enter_Name (Formal);
1642 Set_Ekind (Formal, E_Generic_Package);
1643 Set_Etype (Formal, Standard_Void_Type);
1644 Set_Inner_Instances (Formal, New_Elmt_List);
1647 -- Within the formal, the name of the generic package is a renaming
1648 -- of the formal (as for a regular instantiation).
1650 Renaming := Make_Package_Renaming_Declaration (Loc,
1651 Defining_Unit_Name =>
1652 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
1653 Name => New_Reference_To (Formal, Loc));
1655 if Present (Visible_Declarations (Specification (N))) then
1656 Prepend (Renaming, To => Visible_Declarations (Specification (N)));
1657 elsif Present (Private_Declarations (Specification (N))) then
1658 Prepend (Renaming, To => Private_Declarations (Specification (N)));
1661 if Is_Child_Unit (Gen_Unit)
1662 and then Parent_Installed
1664 -- Similarly, we have to make the name of the formal visible in
1665 -- the parent instance, to resolve properly fully qualified names
1666 -- that may appear in the generic unit. The parent instance has
1667 -- been placed on the scope stack ahead of the current scope.
1669 Parent_Instance := Scope_Stack.Table (Scope_Stack.Last - 1).Entity;
1672 Make_Defining_Identifier (Loc, Chars (Gen_Unit));
1673 Set_Ekind (Renaming_In_Par, E_Package);
1674 Set_Etype (Renaming_In_Par, Standard_Void_Type);
1675 Set_Scope (Renaming_In_Par, Parent_Instance);
1676 Set_Parent (Renaming_In_Par, Parent (Formal));
1677 Set_Renamed_Object (Renaming_In_Par, Formal);
1678 Append_Entity (Renaming_In_Par, Parent_Instance);
1681 Analyze_Generic_Formal_Part (N);
1682 Analyze (Specification (N));
1683 End_Package_Scope (Formal);
1685 if Parent_Installed then
1691 -- Inside the generic unit, the formal package is a regular
1692 -- package, but no body is needed for it. Note that after
1693 -- instantiation, the defining_unit_name we need is in the
1694 -- new tree and not in the original. (see Package_Instantiation).
1695 -- A generic formal package is an instance, and can be used as
1696 -- an actual for an inner instance. Mark its generic parent.
1698 Set_Ekind (Formal, E_Package);
1699 Set_Generic_Parent (Specification (N), Gen_Unit);
1700 Set_Has_Completion (Formal, True);
1702 end Analyze_Formal_Package;
1704 ---------------------------------
1705 -- Analyze_Formal_Private_Type --
1706 ---------------------------------
1708 procedure Analyze_Formal_Private_Type
1714 New_Private_Type (N, T, Def);
1716 -- Set the size to an arbitrary but legal value.
1718 Set_Size_Info (T, Standard_Integer);
1719 Set_RM_Size (T, RM_Size (Standard_Integer));
1720 end Analyze_Formal_Private_Type;
1722 ----------------------------------------
1723 -- Analyze_Formal_Signed_Integer_Type --
1724 ----------------------------------------
1726 procedure Analyze_Formal_Signed_Integer_Type
1730 Base : constant Entity_Id :=
1732 (E_Signed_Integer_Type, Current_Scope, Sloc (Def), 'G');
1737 Set_Ekind (T, E_Signed_Integer_Subtype);
1738 Set_Etype (T, Base);
1739 Set_Size_Info (T, Standard_Integer);
1740 Set_RM_Size (T, RM_Size (Standard_Integer));
1741 Set_Scalar_Range (T, Scalar_Range (Standard_Integer));
1743 Set_Is_Generic_Type (Base);
1744 Set_Size_Info (Base, Standard_Integer);
1745 Set_RM_Size (Base, RM_Size (Standard_Integer));
1746 Set_Etype (Base, Base);
1747 Set_Scalar_Range (Base, Scalar_Range (Standard_Integer));
1748 Set_Parent (Base, Parent (Def));
1749 end Analyze_Formal_Signed_Integer_Type;
1751 -------------------------------
1752 -- Analyze_Formal_Subprogram --
1753 -------------------------------
1755 procedure Analyze_Formal_Subprogram (N : Node_Id) is
1756 Spec : constant Node_Id := Specification (N);
1757 Def : constant Node_Id := Default_Name (N);
1758 Nam : constant Entity_Id := Defining_Unit_Name (Spec);
1766 if Nkind (Nam) = N_Defining_Program_Unit_Name then
1767 Error_Msg_N ("name of formal subprogram must be a direct name", Nam);
1771 Analyze_Subprogram_Declaration (N);
1772 Set_Is_Formal_Subprogram (Nam);
1773 Set_Has_Completion (Nam);
1775 -- Default name is resolved at the point of instantiation
1777 if Box_Present (N) then
1780 -- Else default is bound at the point of generic declaration
1782 elsif Present (Def) then
1783 if Nkind (Def) = N_Operator_Symbol then
1784 Find_Direct_Name (Def);
1786 elsif Nkind (Def) /= N_Attribute_Reference then
1790 -- For an attribute reference, analyze the prefix and verify
1791 -- that it has the proper profile for the subprogram.
1793 Analyze (Prefix (Def));
1794 Valid_Default_Attribute (Nam, Def);
1798 -- Default name may be overloaded, in which case the interpretation
1799 -- with the correct profile must be selected, as for a renaming.
1801 if Etype (Def) = Any_Type then
1804 elsif Nkind (Def) = N_Selected_Component then
1805 Subp := Entity (Selector_Name (Def));
1807 if Ekind (Subp) /= E_Entry then
1808 Error_Msg_N ("expect valid subprogram name as default", Def);
1812 elsif Nkind (Def) = N_Indexed_Component then
1814 if Nkind (Prefix (Def)) /= N_Selected_Component then
1815 Error_Msg_N ("expect valid subprogram name as default", Def);
1819 Subp := Entity (Selector_Name (Prefix (Def)));
1821 if Ekind (Subp) /= E_Entry_Family then
1822 Error_Msg_N ("expect valid subprogram name as default", Def);
1827 elsif Nkind (Def) = N_Character_Literal then
1829 -- Needs some type checks: subprogram should be parameterless???
1831 Resolve (Def, (Etype (Nam)));
1833 elsif not Is_Entity_Name (Def)
1834 or else not Is_Overloadable (Entity (Def))
1836 Error_Msg_N ("expect valid subprogram name as default", Def);
1839 elsif not Is_Overloaded (Def) then
1840 Subp := Entity (Def);
1843 Error_Msg_N ("premature usage of formal subprogram", Def);
1845 elsif not Entity_Matches_Spec (Subp, Nam) then
1846 Error_Msg_N ("no visible entity matches specification", Def);
1852 I1 : Interp_Index := 0;
1858 Get_First_Interp (Def, I, It);
1859 while Present (It.Nam) loop
1861 if Entity_Matches_Spec (It.Nam, Nam) then
1862 if Subp /= Any_Id then
1863 It1 := Disambiguate (Def, I1, I, Etype (Subp));
1865 if It1 = No_Interp then
1866 Error_Msg_N ("ambiguous default subprogram", Def);
1879 Get_Next_Interp (I, It);
1883 if Subp /= Any_Id then
1884 Set_Entity (Def, Subp);
1887 Error_Msg_N ("premature usage of formal subprogram", Def);
1889 elsif Ekind (Subp) /= E_Operator then
1890 Check_Mode_Conformant (Subp, Nam);
1894 Error_Msg_N ("no visible subprogram matches specification", N);
1898 end Analyze_Formal_Subprogram;
1900 -------------------------------------
1901 -- Analyze_Formal_Type_Declaration --
1902 -------------------------------------
1904 procedure Analyze_Formal_Type_Declaration (N : Node_Id) is
1905 Def : constant Node_Id := Formal_Type_Definition (N);
1909 T := Defining_Identifier (N);
1911 if Present (Discriminant_Specifications (N))
1912 and then Nkind (Def) /= N_Formal_Private_Type_Definition
1915 ("discriminants not allowed for this formal type",
1916 Defining_Identifier (First (Discriminant_Specifications (N))));
1919 -- Enter the new name, and branch to specific routine.
1922 when N_Formal_Private_Type_Definition =>
1923 Analyze_Formal_Private_Type (N, T, Def);
1925 when N_Formal_Derived_Type_Definition =>
1926 Analyze_Formal_Derived_Type (N, T, Def);
1928 when N_Formal_Discrete_Type_Definition =>
1929 Analyze_Formal_Discrete_Type (T, Def);
1931 when N_Formal_Signed_Integer_Type_Definition =>
1932 Analyze_Formal_Signed_Integer_Type (T, Def);
1934 when N_Formal_Modular_Type_Definition =>
1935 Analyze_Formal_Modular_Type (T, Def);
1937 when N_Formal_Floating_Point_Definition =>
1938 Analyze_Formal_Floating_Type (T, Def);
1940 when N_Formal_Ordinary_Fixed_Point_Definition =>
1941 Analyze_Formal_Ordinary_Fixed_Point_Type (T, Def);
1943 when N_Formal_Decimal_Fixed_Point_Definition =>
1944 Analyze_Formal_Decimal_Fixed_Point_Type (T, Def);
1946 when N_Array_Type_Definition =>
1947 Analyze_Formal_Array_Type (T, Def);
1949 when N_Access_To_Object_Definition |
1950 N_Access_Function_Definition |
1951 N_Access_Procedure_Definition =>
1952 Analyze_Generic_Access_Type (T, Def);
1958 raise Program_Error;
1962 Set_Is_Generic_Type (T);
1963 end Analyze_Formal_Type_Declaration;
1965 ------------------------------------
1966 -- Analyze_Function_Instantiation --
1967 ------------------------------------
1969 procedure Analyze_Function_Instantiation (N : Node_Id) is
1971 Analyze_Subprogram_Instantiation (N, E_Function);
1972 end Analyze_Function_Instantiation;
1974 ---------------------------------
1975 -- Analyze_Generic_Access_Type --
1976 ---------------------------------
1978 procedure Analyze_Generic_Access_Type (T : Entity_Id; Def : Node_Id) is
1982 if Nkind (Def) = N_Access_To_Object_Definition then
1983 Access_Type_Declaration (T, Def);
1985 if Is_Incomplete_Or_Private_Type (Designated_Type (T))
1986 and then No (Full_View (Designated_Type (T)))
1987 and then not Is_Generic_Type (Designated_Type (T))
1989 Error_Msg_N ("premature usage of incomplete type", Def);
1991 elsif Is_Internal (Designated_Type (T)) then
1993 ("only a subtype mark is allowed in a formal", Def);
1997 Access_Subprogram_Declaration (T, Def);
1999 end Analyze_Generic_Access_Type;
2001 ---------------------------------
2002 -- Analyze_Generic_Formal_Part --
2003 ---------------------------------
2005 procedure Analyze_Generic_Formal_Part (N : Node_Id) is
2006 Gen_Parm_Decl : Node_Id;
2009 -- The generic formals are processed in the scope of the generic
2010 -- unit, where they are immediately visible. The scope is installed
2013 Gen_Parm_Decl := First (Generic_Formal_Declarations (N));
2015 while Present (Gen_Parm_Decl) loop
2016 Analyze (Gen_Parm_Decl);
2017 Next (Gen_Parm_Decl);
2020 Generate_Reference_To_Generic_Formals (Current_Scope);
2021 end Analyze_Generic_Formal_Part;
2023 ------------------------------------------
2024 -- Analyze_Generic_Package_Declaration --
2025 ------------------------------------------
2027 procedure Analyze_Generic_Package_Declaration (N : Node_Id) is
2028 Loc : constant Source_Ptr := Sloc (N);
2031 Save_Parent : Node_Id;
2033 Decls : constant List_Id :=
2034 Visible_Declarations (Specification (N));
2038 -- We introduce a renaming of the enclosing package, to have a usable
2039 -- entity as the prefix of an expanded name for a local entity of the
2040 -- form Par.P.Q, where P is the generic package. This is because a local
2041 -- entity named P may hide it, so that the usual visibility rules in
2042 -- the instance will not resolve properly.
2045 Make_Package_Renaming_Declaration (Loc,
2046 Defining_Unit_Name =>
2047 Make_Defining_Identifier (Loc,
2048 Chars => New_External_Name (Chars (Defining_Entity (N)), "GH")),
2049 Name => Make_Identifier (Loc, Chars (Defining_Entity (N))));
2051 if Present (Decls) then
2052 Decl := First (Decls);
2053 while Present (Decl)
2054 and then Nkind (Decl) = N_Pragma
2059 if Present (Decl) then
2060 Insert_Before (Decl, Renaming);
2062 Append (Renaming, Visible_Declarations (Specification (N)));
2066 Set_Visible_Declarations (Specification (N), New_List (Renaming));
2069 -- Create copy of generic unit, and save for instantiation.
2070 -- If the unit is a child unit, do not copy the specifications
2071 -- for the parent, which are not part of the generic tree.
2073 Save_Parent := Parent_Spec (N);
2074 Set_Parent_Spec (N, Empty);
2076 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
2077 Set_Parent_Spec (New_N, Save_Parent);
2079 Id := Defining_Entity (N);
2080 Generate_Definition (Id);
2082 -- Expansion is not applied to generic units.
2087 Set_Ekind (Id, E_Generic_Package);
2088 Set_Etype (Id, Standard_Void_Type);
2090 Enter_Generic_Scope (Id);
2091 Set_Inner_Instances (Id, New_Elmt_List);
2093 Set_Categorization_From_Pragmas (N);
2094 Set_Is_Pure (Id, Is_Pure (Current_Scope));
2096 -- Link the declaration of the generic homonym in the generic copy
2097 -- to the package it renames, so that it is always resolved properly.
2099 Set_Generic_Homonym (Id, Defining_Unit_Name (Renaming));
2100 Set_Entity (Associated_Node (Name (Renaming)), Id);
2102 -- For a library unit, we have reconstructed the entity for the
2103 -- unit, and must reset it in the library tables.
2105 if Nkind (Parent (N)) = N_Compilation_Unit then
2106 Set_Cunit_Entity (Current_Sem_Unit, Id);
2109 Analyze_Generic_Formal_Part (N);
2111 -- After processing the generic formals, analysis proceeds
2112 -- as for a non-generic package.
2114 Analyze (Specification (N));
2116 Validate_Categorization_Dependency (N, Id);
2120 End_Package_Scope (Id);
2121 Exit_Generic_Scope (Id);
2123 if Nkind (Parent (N)) /= N_Compilation_Unit then
2124 Move_Freeze_Nodes (Id, N, Visible_Declarations (Specification (N)));
2125 Move_Freeze_Nodes (Id, N, Private_Declarations (Specification (N)));
2126 Move_Freeze_Nodes (Id, N, Generic_Formal_Declarations (N));
2129 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
2130 Validate_RT_RAT_Component (N);
2132 -- If this is a spec without a body, check that generic parameters
2135 if not Body_Required (Parent (N)) then
2136 Check_References (Id);
2139 end Analyze_Generic_Package_Declaration;
2141 --------------------------------------------
2142 -- Analyze_Generic_Subprogram_Declaration --
2143 --------------------------------------------
2145 procedure Analyze_Generic_Subprogram_Declaration (N : Node_Id) is
2150 Save_Parent : Node_Id;
2153 -- Create copy of generic unit,and save for instantiation.
2154 -- If the unit is a child unit, do not copy the specifications
2155 -- for the parent, which are not part of the generic tree.
2157 Save_Parent := Parent_Spec (N);
2158 Set_Parent_Spec (N, Empty);
2160 New_N := Copy_Generic_Node (N, Empty, Instantiating => False);
2161 Set_Parent_Spec (New_N, Save_Parent);
2164 Spec := Specification (N);
2165 Id := Defining_Entity (Spec);
2166 Generate_Definition (Id);
2168 if Nkind (Id) = N_Defining_Operator_Symbol then
2170 ("operator symbol not allowed for generic subprogram", Id);
2177 Set_Scope_Depth_Value (Id, Scope_Depth (Current_Scope) + 1);
2179 Enter_Generic_Scope (Id);
2180 Set_Inner_Instances (Id, New_Elmt_List);
2181 Set_Is_Pure (Id, Is_Pure (Current_Scope));
2183 Analyze_Generic_Formal_Part (N);
2185 Formals := Parameter_Specifications (Spec);
2187 if Present (Formals) then
2188 Process_Formals (Formals, Spec);
2191 if Nkind (Spec) = N_Function_Specification then
2192 Set_Ekind (Id, E_Generic_Function);
2193 Find_Type (Subtype_Mark (Spec));
2194 Set_Etype (Id, Entity (Subtype_Mark (Spec)));
2196 Set_Ekind (Id, E_Generic_Procedure);
2197 Set_Etype (Id, Standard_Void_Type);
2200 -- For a library unit, we have reconstructed the entity for the
2201 -- unit, and must reset it in the library tables. We also need
2202 -- to make sure that Body_Required is set properly in the original
2203 -- compilation unit node.
2205 if Nkind (Parent (N)) = N_Compilation_Unit then
2206 Set_Cunit_Entity (Current_Sem_Unit, Id);
2207 Set_Body_Required (Parent (N), Unit_Requires_Body (Id));
2210 Set_Categorization_From_Pragmas (N);
2211 Validate_Categorization_Dependency (N, Id);
2213 Save_Global_References (Original_Node (N));
2217 Exit_Generic_Scope (Id);
2218 Generate_Reference_To_Formals (Id);
2219 end Analyze_Generic_Subprogram_Declaration;
2221 -----------------------------------
2222 -- Analyze_Package_Instantiation --
2223 -----------------------------------
2225 -- Note: this procedure is also used for formal package declarations,
2226 -- in which case the argument N is an N_Formal_Package_Declaration
2227 -- node. This should really be noted in the spec! ???
2229 procedure Analyze_Package_Instantiation (N : Node_Id) is
2230 Loc : constant Source_Ptr := Sloc (N);
2231 Gen_Id : constant Node_Id := Name (N);
2234 Act_Decl_Name : Node_Id;
2235 Act_Decl_Id : Entity_Id;
2240 Gen_Unit : Entity_Id;
2242 Is_Actual_Pack : constant Boolean :=
2243 Is_Internal (Defining_Entity (N));
2245 Parent_Installed : Boolean := False;
2246 Renaming_List : List_Id;
2247 Unit_Renaming : Node_Id;
2248 Needs_Body : Boolean;
2249 Inline_Now : Boolean := False;
2251 procedure Delay_Descriptors (E : Entity_Id);
2252 -- Delay generation of subprogram descriptors for given entity
2254 function Might_Inline_Subp return Boolean;
2255 -- If inlining is active and the generic contains inlined subprograms,
2256 -- we instantiate the body. This may cause superfluous instantiations,
2257 -- but it is simpler than detecting the need for the body at the point
2258 -- of inlining, when the context of the instance is not available.
2260 -----------------------
2261 -- Delay_Descriptors --
2262 -----------------------
2264 procedure Delay_Descriptors (E : Entity_Id) is
2266 if not Delay_Subprogram_Descriptors (E) then
2267 Set_Delay_Subprogram_Descriptors (E);
2268 Pending_Descriptor.Increment_Last;
2269 Pending_Descriptor.Table (Pending_Descriptor.Last) := E;
2271 end Delay_Descriptors;
2273 -----------------------
2274 -- Might_Inline_Subp --
2275 -----------------------
2277 function Might_Inline_Subp return Boolean is
2281 if not Inline_Processing_Required then
2285 E := First_Entity (Gen_Unit);
2287 while Present (E) loop
2289 if Is_Subprogram (E)
2290 and then Is_Inlined (E)
2300 end Might_Inline_Subp;
2302 -- Start of processing for Analyze_Package_Instantiation
2305 -- Very first thing: apply the special kludge for Text_IO processing
2306 -- in case we are instantiating one of the children of [Wide_]Text_IO.
2308 Text_IO_Kludge (Name (N));
2310 -- Make node global for error reporting.
2312 Instantiation_Node := N;
2314 -- Case of instantiation of a generic package
2316 if Nkind (N) = N_Package_Instantiation then
2317 Act_Decl_Id := New_Copy (Defining_Entity (N));
2318 Set_Comes_From_Source (Act_Decl_Id, True);
2320 if Nkind (Defining_Unit_Name (N)) = N_Defining_Program_Unit_Name then
2322 Make_Defining_Program_Unit_Name (Loc,
2323 Name => New_Copy_Tree (Name (Defining_Unit_Name (N))),
2324 Defining_Identifier => Act_Decl_Id);
2326 Act_Decl_Name := Act_Decl_Id;
2329 -- Case of instantiation of a formal package
2332 Act_Decl_Id := Defining_Identifier (N);
2333 Act_Decl_Name := Act_Decl_Id;
2336 Generate_Definition (Act_Decl_Id);
2337 Pre_Analyze_Actuals (N);
2340 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
2341 Gen_Unit := Entity (Gen_Id);
2343 -- Verify that it is the name of a generic package
2345 if Etype (Gen_Unit) = Any_Type then
2349 elsif Ekind (Gen_Unit) /= E_Generic_Package then
2351 if From_With_Type (Gen_Unit) then
2353 ("cannot instantiate a limited withed package", Gen_Id);
2356 ("expect name of generic package in instantiation", Gen_Id);
2363 if In_Extended_Main_Source_Unit (N) then
2364 Set_Is_Instantiated (Gen_Unit);
2365 Generate_Reference (Gen_Unit, N);
2367 if Present (Renamed_Object (Gen_Unit)) then
2368 Set_Is_Instantiated (Renamed_Object (Gen_Unit));
2369 Generate_Reference (Renamed_Object (Gen_Unit), N);
2373 if Nkind (Gen_Id) = N_Identifier
2374 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
2377 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
2379 elsif Nkind (Gen_Id) = N_Expanded_Name
2380 and then Is_Child_Unit (Gen_Unit)
2381 and then Nkind (Prefix (Gen_Id)) = N_Identifier
2382 and then Chars (Act_Decl_Id) = Chars (Prefix (Gen_Id))
2385 ("& is hidden within declaration of instance ", Prefix (Gen_Id));
2388 Set_Entity (Gen_Id, Gen_Unit);
2390 -- If generic is a renaming, get original generic unit.
2392 if Present (Renamed_Object (Gen_Unit))
2393 and then Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Package
2395 Gen_Unit := Renamed_Object (Gen_Unit);
2398 -- Verify that there are no circular instantiations.
2400 if In_Open_Scopes (Gen_Unit) then
2401 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
2405 elsif Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
2406 Error_Msg_Node_2 := Current_Scope;
2408 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
2409 Circularity_Detected := True;
2414 Set_Instance_Env (Gen_Unit, Act_Decl_Id);
2415 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
2417 -- Initialize renamings map, for error checking, and the list
2418 -- that holds private entities whose views have changed between
2419 -- generic definition and instantiation. If this is the instance
2420 -- created to validate an actual package, the instantiation
2421 -- environment is that of the enclosing instance.
2423 Generic_Renamings.Set_Last (0);
2424 Generic_Renamings_HTable.Reset;
2426 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
2428 -- Copy original generic tree, to produce text for instantiation.
2432 (Original_Node (Gen_Decl), Empty, Instantiating => True);
2434 Act_Spec := Specification (Act_Tree);
2436 -- If this is the instance created to validate an actual package,
2437 -- only the formals matter, do not examine the package spec itself.
2439 if Is_Actual_Pack then
2440 Set_Visible_Declarations (Act_Spec, New_List);
2441 Set_Private_Declarations (Act_Spec, New_List);
2445 Analyze_Associations
2447 Generic_Formal_Declarations (Act_Tree),
2448 Generic_Formal_Declarations (Gen_Decl));
2450 Set_Defining_Unit_Name (Act_Spec, Act_Decl_Name);
2451 Set_Is_Generic_Instance (Act_Decl_Id);
2453 Set_Generic_Parent (Act_Spec, Gen_Unit);
2455 -- References to the generic in its own declaration or its body
2456 -- are references to the instance. Add a renaming declaration for
2457 -- the generic unit itself. This declaration, as well as the renaming
2458 -- declarations for the generic formals, must remain private to the
2459 -- unit: the formals, because this is the language semantics, and
2460 -- the unit because its use is an artifact of the implementation.
2463 Make_Package_Renaming_Declaration (Loc,
2464 Defining_Unit_Name =>
2465 Make_Defining_Identifier (Loc, Chars (Gen_Unit)),
2466 Name => New_Reference_To (Act_Decl_Id, Loc));
2468 Append (Unit_Renaming, Renaming_List);
2470 -- The renaming declarations are the first local declarations of
2473 if Is_Non_Empty_List (Visible_Declarations (Act_Spec)) then
2475 (First (Visible_Declarations (Act_Spec)), Renaming_List);
2477 Set_Visible_Declarations (Act_Spec, Renaming_List);
2481 Make_Package_Declaration (Loc,
2482 Specification => Act_Spec);
2484 -- Save the instantiation node, for subsequent instantiation
2485 -- of the body, if there is one and we are generating code for
2486 -- the current unit. Mark the unit as having a body, to avoid
2487 -- a premature error message.
2489 -- We instantiate the body if we are generating code, if we are
2490 -- generating cross-reference information, or if we are building
2491 -- trees for ASIS use.
2494 Enclosing_Body_Present : Boolean := False;
2495 -- If the generic unit is not a compilation unit, then a body
2496 -- may be present in its parent even if none is required. We
2497 -- create a tentative pending instantiation for the body, which
2498 -- will be discarded if none is actually present.
2503 if Scope (Gen_Unit) /= Standard_Standard
2504 and then not Is_Child_Unit (Gen_Unit)
2506 Scop := Scope (Gen_Unit);
2508 while Present (Scop)
2509 and then Scop /= Standard_Standard
2511 if Unit_Requires_Body (Scop) then
2512 Enclosing_Body_Present := True;
2516 exit when Is_Compilation_Unit (Scop);
2517 Scop := Scope (Scop);
2521 -- If front-end inlining is enabled, and this is a unit for which
2522 -- code will be generated, we instantiate the body at once.
2523 -- This is done if the instance is not the main unit, and if the
2524 -- generic is not a child unit of another generic, to avoid scope
2525 -- problems and the reinstallation of parent instances.
2527 if Front_End_Inlining
2528 and then Expander_Active
2529 and then (not Is_Child_Unit (Gen_Unit)
2530 or else not Is_Generic_Unit (Scope (Gen_Unit)))
2531 and then Is_In_Main_Unit (N)
2532 and then Nkind (Parent (N)) /= N_Compilation_Unit
2533 and then Might_Inline_Subp
2534 and then not Is_Actual_Pack
2540 (Unit_Requires_Body (Gen_Unit)
2541 or else Enclosing_Body_Present
2542 or else Present (Corresponding_Body (Gen_Decl)))
2543 and then (Is_In_Main_Unit (N)
2544 or else Might_Inline_Subp)
2545 and then not Is_Actual_Pack
2546 and then not Inline_Now
2548 and then (Operating_Mode = Generate_Code
2549 or else (Operating_Mode = Check_Semantics
2550 and then ASIS_Mode));
2552 -- If front_end_inlining is enabled, do not instantiate a
2553 -- body if within a generic context.
2555 if Front_End_Inlining
2556 and then not Expander_Active
2558 Needs_Body := False;
2561 -- If the current context is generic, and the package being
2562 -- instantiated is declared within a formal package, there
2563 -- is no body to instantiate until the enclosing generic is
2564 -- instantiated, and there is an actual for the formal
2565 -- package. If the formal package has parameters, we build a
2566 -- regular package instance for it, that preceeds the original
2567 -- formal package declaration.
2569 if In_Open_Scopes (Scope (Scope (Gen_Unit))) then
2573 (Unit_Declaration_Node (Scope (Gen_Unit)));
2575 if Nkind (Decl) = N_Formal_Package_Declaration
2576 or else (Nkind (Decl) = N_Package_Declaration
2577 and then Is_List_Member (Decl)
2578 and then Present (Next (Decl))
2580 Nkind (Next (Decl)) = N_Formal_Package_Declaration)
2582 Needs_Body := False;
2588 -- If we are generating the calling stubs from the instantiation
2589 -- of a generic RCI package, we will not use the body of the
2592 if Distribution_Stub_Mode = Generate_Caller_Stub_Body
2593 and then Is_Compilation_Unit (Defining_Entity (N))
2595 Needs_Body := False;
2600 -- Here is a defence against a ludicrous number of instantiations
2601 -- caused by a circular set of instantiation attempts.
2603 if Pending_Instantiations.Last >
2604 Hostparm.Max_Instantiations
2606 Error_Msg_N ("too many instantiations", N);
2607 raise Unrecoverable_Error;
2610 -- Indicate that the enclosing scopes contain an instantiation,
2611 -- and that cleanup actions should be delayed until after the
2612 -- instance body is expanded.
2614 Check_Forward_Instantiation (Gen_Decl);
2615 if Nkind (N) = N_Package_Instantiation then
2617 Enclosing_Master : Entity_Id := Current_Scope;
2620 while Enclosing_Master /= Standard_Standard loop
2622 if Ekind (Enclosing_Master) = E_Package then
2623 if Is_Compilation_Unit (Enclosing_Master) then
2624 if In_Package_Body (Enclosing_Master) then
2626 (Body_Entity (Enclosing_Master));
2635 Enclosing_Master := Scope (Enclosing_Master);
2638 elsif Ekind (Enclosing_Master) = E_Generic_Package then
2639 Enclosing_Master := Scope (Enclosing_Master);
2641 elsif Is_Generic_Subprogram (Enclosing_Master)
2642 or else Ekind (Enclosing_Master) = E_Void
2644 -- Cleanup actions will eventually be performed on
2645 -- the enclosing instance, if any. enclosing scope
2646 -- is void in the formal part of a generic subp.
2651 if Ekind (Enclosing_Master) = E_Entry
2653 Ekind (Scope (Enclosing_Master)) = E_Protected_Type
2656 Protected_Body_Subprogram (Enclosing_Master);
2659 Set_Delay_Cleanups (Enclosing_Master);
2661 while Ekind (Enclosing_Master) = E_Block loop
2662 Enclosing_Master := Scope (Enclosing_Master);
2665 if Is_Subprogram (Enclosing_Master) then
2666 Delay_Descriptors (Enclosing_Master);
2668 elsif Is_Task_Type (Enclosing_Master) then
2670 TBP : constant Node_Id :=
2671 Get_Task_Body_Procedure
2675 if Present (TBP) then
2676 Delay_Descriptors (TBP);
2677 Set_Delay_Cleanups (TBP);
2687 -- Make entry in table
2689 Pending_Instantiations.Increment_Last;
2690 Pending_Instantiations.Table (Pending_Instantiations.Last) :=
2691 (N, Act_Decl, Expander_Active, Current_Sem_Unit);
2695 Set_Categorization_From_Pragmas (Act_Decl);
2697 if Parent_Installed then
2701 Set_Instance_Spec (N, Act_Decl);
2703 -- If not a compilation unit, insert the package declaration
2704 -- before the original instantiation node.
2706 if Nkind (Parent (N)) /= N_Compilation_Unit then
2707 Mark_Rewrite_Insertion (Act_Decl);
2708 Insert_Before (N, Act_Decl);
2711 -- For an instantiation that is a compilation unit, place
2712 -- declaration on current node so context is complete
2713 -- for analysis (including nested instantiations). It this
2714 -- is the main unit, the declaration eventually replaces the
2715 -- instantiation node. If the instance body is later created, it
2716 -- replaces the instance node, and the declation is attached to
2717 -- it (see Build_Instance_Compilation_Unit_Nodes).
2720 if Cunit_Entity (Current_Sem_Unit) = Defining_Entity (N) then
2722 -- The entity for the current unit is the newly created one,
2723 -- and all semantic information is attached to it.
2725 Set_Cunit_Entity (Current_Sem_Unit, Act_Decl_Id);
2727 -- If this is the main unit, replace the main entity as well.
2729 if Current_Sem_Unit = Main_Unit then
2730 Main_Unit_Entity := Act_Decl_Id;
2734 Set_Unit (Parent (N), Act_Decl);
2735 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
2737 Set_Unit (Parent (N), N);
2738 Set_Body_Required (Parent (N), False);
2740 -- We never need elaboration checks on instantiations, since
2741 -- by definition, the body instantiation is elaborated at the
2742 -- same time as the spec instantiation.
2744 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
2745 Set_Kill_Elaboration_Checks (Act_Decl_Id);
2748 Check_Elab_Instantiation (N);
2750 if ABE_Is_Certain (N) and then Needs_Body then
2751 Pending_Instantiations.Decrement_Last;
2753 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
2755 Set_First_Private_Entity (Defining_Unit_Name (Unit_Renaming),
2756 First_Private_Entity (Act_Decl_Id));
2758 -- If the instantiation will receive a body, the unit will
2759 -- be transformed into a package body, and receive its own
2760 -- elaboration entity. Otherwise, the nature of the unit is
2761 -- now a package declaration.
2763 if Nkind (Parent (N)) = N_Compilation_Unit
2764 and then not Needs_Body
2766 Rewrite (N, Act_Decl);
2769 if Present (Corresponding_Body (Gen_Decl))
2770 or else Unit_Requires_Body (Gen_Unit)
2772 Set_Has_Completion (Act_Decl_Id);
2775 Check_Formal_Packages (Act_Decl_Id);
2777 Restore_Private_Views (Act_Decl_Id);
2779 if not Generic_Separately_Compiled (Gen_Unit) then
2780 Inherit_Context (Gen_Decl, N);
2783 if Parent_Installed then
2790 Validate_Categorization_Dependency (N, Act_Decl_Id);
2792 -- Check restriction, but skip this if something went wrong in
2793 -- the above analysis, indicated by Act_Decl_Id being void.
2795 if Ekind (Act_Decl_Id) /= E_Void
2796 and then not Is_Library_Level_Entity (Act_Decl_Id)
2798 Check_Restriction (No_Local_Allocators, N);
2802 Inline_Instance_Body (N, Gen_Unit, Act_Decl);
2806 when Instantiation_Error =>
2807 if Parent_Installed then
2810 end Analyze_Package_Instantiation;
2812 ---------------------------
2813 -- Inline_Instance_Body --
2814 ---------------------------
2816 procedure Inline_Instance_Body
2818 Gen_Unit : Entity_Id;
2822 Gen_Comp : constant Entity_Id :=
2823 Cunit_Entity (Get_Source_Unit (Gen_Unit));
2824 Curr_Comp : constant Node_Id := Cunit (Current_Sem_Unit);
2825 Curr_Scope : Entity_Id := Empty;
2826 Curr_Unit : constant Entity_Id :=
2827 Cunit_Entity (Current_Sem_Unit);
2828 Removed : Boolean := False;
2829 Num_Scopes : Int := 0;
2830 Use_Clauses : array (1 .. Scope_Stack.Last) of Node_Id;
2831 Instances : array (1 .. Scope_Stack.Last) of Entity_Id;
2832 Inner_Scopes : array (1 .. Scope_Stack.Last) of Entity_Id;
2833 Num_Inner : Int := 0;
2834 N_Instances : Int := 0;
2838 -- Case of generic unit defined in another unit. We must remove
2839 -- the complete context of the current unit to install that of
2842 if Gen_Comp /= Cunit_Entity (Current_Sem_Unit) then
2846 and then S /= Standard_Standard
2848 Num_Scopes := Num_Scopes + 1;
2850 Use_Clauses (Num_Scopes) :=
2852 (Scope_Stack.Last - Num_Scopes + 1).
2854 End_Use_Clauses (Use_Clauses (Num_Scopes));
2856 exit when Is_Generic_Instance (S)
2857 and then (In_Package_Body (S)
2858 or else Ekind (S) = E_Procedure
2859 or else Ekind (S) = E_Function);
2863 Vis := Is_Immediately_Visible (Gen_Comp);
2865 -- Find and save all enclosing instances
2870 and then S /= Standard_Standard
2872 if Is_Generic_Instance (S) then
2873 N_Instances := N_Instances + 1;
2874 Instances (N_Instances) := S;
2876 exit when In_Package_Body (S);
2882 -- Remove context of current compilation unit, unless we
2883 -- are within a nested package instantiation, in which case
2884 -- the context has been removed previously.
2886 -- If current scope is the body of a child unit, remove context
2892 and then S /= Standard_Standard
2894 exit when Is_Generic_Instance (S)
2895 and then (In_Package_Body (S)
2896 or else Ekind (S) = E_Procedure
2897 or else Ekind (S) = E_Function);
2900 or else (Ekind (Curr_Unit) = E_Package_Body
2901 and then S = Spec_Entity (Curr_Unit))
2902 or else (Ekind (Curr_Unit) = E_Subprogram_Body
2905 (Unit_Declaration_Node (Curr_Unit)))
2909 -- Remove entities in current scopes from visibility, so
2910 -- than instance body is compiled in a clean environment.
2912 Save_Scope_Stack (Handle_Use => False);
2914 if Is_Child_Unit (S) then
2916 -- Remove child unit from stack, as well as inner scopes.
2917 -- Removing the context of a child unit removes parent
2920 while Current_Scope /= S loop
2921 Num_Inner := Num_Inner + 1;
2922 Inner_Scopes (Num_Inner) := Current_Scope;
2927 Remove_Context (Curr_Comp);
2931 Remove_Context (Curr_Comp);
2934 if Ekind (Curr_Unit) = E_Package_Body then
2935 Remove_Context (Library_Unit (Curr_Comp));
2942 New_Scope (Standard_Standard);
2943 Scope_Stack.Table (Scope_Stack.Last).Is_Active_Stack_Base := True;
2944 Instantiate_Package_Body
2945 ((N, Act_Decl, Expander_Active, Current_Sem_Unit), True);
2950 Set_Is_Immediately_Visible (Gen_Comp, Vis);
2952 -- Reset Generic_Instance flag so that use clauses can be installed
2953 -- in the proper order. (See Use_One_Package for effect of enclosing
2954 -- instances on processing of use clauses).
2956 for J in 1 .. N_Instances loop
2957 Set_Is_Generic_Instance (Instances (J), False);
2961 Install_Context (Curr_Comp);
2963 if Present (Curr_Scope)
2964 and then Is_Child_Unit (Curr_Scope)
2966 New_Scope (Curr_Scope);
2967 Set_Is_Immediately_Visible (Curr_Scope);
2969 -- Finally, restore inner scopes as well.
2971 for J in reverse 1 .. Num_Inner loop
2972 New_Scope (Inner_Scopes (J));
2976 Restore_Scope_Stack (Handle_Use => False);
2979 -- Restore use clauses. For a child unit, use clauses in the
2980 -- parents are restored when installing the context, so only
2981 -- those in inner scopes (and those local to the child unit itself)
2982 -- need to be installed explicitly.
2984 if Is_Child_Unit (Curr_Unit)
2987 for J in reverse 1 .. Num_Inner + 1 loop
2988 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
2990 Install_Use_Clauses (Use_Clauses (J));
2994 for J in reverse 1 .. Num_Scopes loop
2995 Scope_Stack.Table (Scope_Stack.Last - J + 1).First_Use_Clause :=
2997 Install_Use_Clauses (Use_Clauses (J));
3001 for J in 1 .. N_Instances loop
3002 Set_Is_Generic_Instance (Instances (J), True);
3005 -- If generic unit is in current unit, current context is correct.
3008 Instantiate_Package_Body
3009 ((N, Act_Decl, Expander_Active, Current_Sem_Unit), True);
3011 end Inline_Instance_Body;
3013 -------------------------------------
3014 -- Analyze_Procedure_Instantiation --
3015 -------------------------------------
3017 procedure Analyze_Procedure_Instantiation (N : Node_Id) is
3019 Analyze_Subprogram_Instantiation (N, E_Procedure);
3020 end Analyze_Procedure_Instantiation;
3022 --------------------------------------
3023 -- Analyze_Subprogram_Instantiation --
3024 --------------------------------------
3026 procedure Analyze_Subprogram_Instantiation
3030 Loc : constant Source_Ptr := Sloc (N);
3031 Gen_Id : constant Node_Id := Name (N);
3033 Anon_Id : constant Entity_Id :=
3034 Make_Defining_Identifier (Sloc (Defining_Entity (N)),
3035 Chars => New_External_Name
3036 (Chars (Defining_Entity (N)), 'R'));
3038 Act_Decl_Id : Entity_Id;
3043 Gen_Unit : Entity_Id;
3045 Pack_Id : Entity_Id;
3046 Parent_Installed : Boolean := False;
3047 Renaming_List : List_Id;
3049 procedure Analyze_Instance_And_Renamings;
3050 -- The instance must be analyzed in a context that includes the
3051 -- mappings of generic parameters into actuals. We create a package
3052 -- declaration for this purpose, and a subprogram with an internal
3053 -- name within the package. The subprogram instance is simply an
3054 -- alias for the internal subprogram, declared in the current scope.
3056 ------------------------------------
3057 -- Analyze_Instance_And_Renamings --
3058 ------------------------------------
3060 procedure Analyze_Instance_And_Renamings is
3061 Def_Ent : constant Entity_Id := Defining_Entity (N);
3062 Pack_Decl : Node_Id;
3065 if Nkind (Parent (N)) = N_Compilation_Unit then
3067 -- For the case of a compilation unit, the container package
3068 -- has the same name as the instantiation, to insure that the
3069 -- binder calls the elaboration procedure with the right name.
3070 -- Copy the entity of the instance, which may have compilation
3071 -- level flags (e.g. Is_Child_Unit) set.
3073 Pack_Id := New_Copy (Def_Ent);
3076 -- Otherwise we use the name of the instantiation concatenated
3077 -- with its source position to ensure uniqueness if there are
3078 -- several instantiations with the same name.
3081 Make_Defining_Identifier (Loc,
3082 Chars => New_External_Name
3083 (Related_Id => Chars (Def_Ent),
3085 Suffix_Index => Source_Offset (Sloc (Def_Ent))));
3088 Pack_Decl := Make_Package_Declaration (Loc,
3089 Specification => Make_Package_Specification (Loc,
3090 Defining_Unit_Name => Pack_Id,
3091 Visible_Declarations => Renaming_List,
3092 End_Label => Empty));
3094 Set_Instance_Spec (N, Pack_Decl);
3095 Set_Is_Generic_Instance (Pack_Id);
3096 Set_Needs_Debug_Info (Pack_Id);
3098 -- Case of not a compilation unit
3100 if Nkind (Parent (N)) /= N_Compilation_Unit then
3101 Mark_Rewrite_Insertion (Pack_Decl);
3102 Insert_Before (N, Pack_Decl);
3103 Set_Has_Completion (Pack_Id);
3105 -- Case of an instantiation that is a compilation unit
3107 -- Place declaration on current node so context is complete
3108 -- for analysis (including nested instantiations), and for
3109 -- use in a context_clause (see Analyze_With_Clause).
3112 Set_Unit (Parent (N), Pack_Decl);
3113 Set_Parent_Spec (Pack_Decl, Parent_Spec (N));
3116 Analyze (Pack_Decl);
3117 Check_Formal_Packages (Pack_Id);
3118 Set_Is_Generic_Instance (Pack_Id, False);
3120 -- Body of the enclosing package is supplied when instantiating
3121 -- the subprogram body, after semantic analysis is completed.
3123 if Nkind (Parent (N)) = N_Compilation_Unit then
3125 -- Remove package itself from visibility, so it does not
3126 -- conflict with subprogram.
3128 Set_Name_Entity_Id (Chars (Pack_Id), Homonym (Pack_Id));
3130 -- Set name and scope of internal subprogram so that the
3131 -- proper external name will be generated. The proper scope
3132 -- is the scope of the wrapper package. We need to generate
3133 -- debugging information for the internal subprogram, so set
3134 -- flag accordingly.
3136 Set_Chars (Anon_Id, Chars (Defining_Entity (N)));
3137 Set_Scope (Anon_Id, Scope (Pack_Id));
3139 -- Mark wrapper package as referenced, to avoid spurious
3140 -- warnings if the instantiation appears in various with_
3141 -- clauses of subunits of the main unit.
3143 Set_Referenced (Pack_Id);
3146 Set_Is_Generic_Instance (Anon_Id);
3147 Set_Needs_Debug_Info (Anon_Id);
3148 Act_Decl_Id := New_Copy (Anon_Id);
3150 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
3151 Set_Chars (Act_Decl_Id, Chars (Defining_Entity (N)));
3152 Set_Sloc (Act_Decl_Id, Sloc (Defining_Entity (N)));
3153 Set_Comes_From_Source (Act_Decl_Id, True);
3155 -- The signature may involve types that are not frozen yet, but
3156 -- the subprogram will be frozen at the point the wrapper package
3157 -- is frozen, so it does not need its own freeze node. In fact, if
3158 -- one is created, it might conflict with the freezing actions from
3159 -- the wrapper package (see 7206-013).
3161 Set_Has_Delayed_Freeze (Anon_Id, False);
3163 -- If the instance is a child unit, mark the Id accordingly. Mark
3164 -- the anonymous entity as well, which is the real subprogram and
3165 -- which is used when the instance appears in a context clause.
3167 Set_Is_Child_Unit (Act_Decl_Id, Is_Child_Unit (Defining_Entity (N)));
3168 Set_Is_Child_Unit (Anon_Id, Is_Child_Unit (Defining_Entity (N)));
3169 New_Overloaded_Entity (Act_Decl_Id);
3170 Check_Eliminated (Act_Decl_Id);
3172 -- In compilation unit case, kill elaboration checks on the
3173 -- instantiation, since they are never needed -- the body is
3174 -- instantiated at the same point as the spec.
3176 if Nkind (Parent (N)) = N_Compilation_Unit then
3177 Set_Suppress_Elaboration_Warnings (Act_Decl_Id);
3178 Set_Kill_Elaboration_Checks (Act_Decl_Id);
3179 Set_Is_Compilation_Unit (Anon_Id);
3181 Set_Cunit_Entity (Current_Sem_Unit, Pack_Id);
3184 -- The instance is not a freezing point for the new subprogram.
3186 Set_Is_Frozen (Act_Decl_Id, False);
3188 if Nkind (Defining_Entity (N)) = N_Defining_Operator_Symbol then
3189 Valid_Operator_Definition (Act_Decl_Id);
3192 Set_Alias (Act_Decl_Id, Anon_Id);
3193 Set_Parent (Act_Decl_Id, Parent (Anon_Id));
3194 Set_Has_Completion (Act_Decl_Id);
3195 Set_Related_Instance (Pack_Id, Act_Decl_Id);
3197 if Nkind (Parent (N)) = N_Compilation_Unit then
3198 Set_Body_Required (Parent (N), False);
3201 end Analyze_Instance_And_Renamings;
3203 -- Start of processing for Analyze_Subprogram_Instantiation
3206 -- Very first thing: apply the special kludge for Text_IO processing
3207 -- in case we are instantiating one of the children of [Wide_]Text_IO.
3208 -- Of course such an instantiation is bogus (these are packages, not
3209 -- subprograms), but we get a better error message if we do this.
3211 Text_IO_Kludge (Gen_Id);
3213 -- Make node global for error reporting.
3215 Instantiation_Node := N;
3216 Pre_Analyze_Actuals (N);
3219 Check_Generic_Child_Unit (Gen_Id, Parent_Installed);
3220 Gen_Unit := Entity (Gen_Id);
3222 Generate_Reference (Gen_Unit, Gen_Id);
3224 if Nkind (Gen_Id) = N_Identifier
3225 and then Chars (Gen_Unit) = Chars (Defining_Entity (N))
3228 ("& is hidden within declaration of instance", Gen_Id, Gen_Unit);
3231 if Etype (Gen_Unit) = Any_Type then
3236 -- Verify that it is a generic subprogram of the right kind, and that
3237 -- it does not lead to a circular instantiation.
3239 if Ekind (Gen_Unit) /= E_Generic_Procedure
3240 and then Ekind (Gen_Unit) /= E_Generic_Function
3242 Error_Msg_N ("expect generic subprogram in instantiation", Gen_Id);
3244 elsif In_Open_Scopes (Gen_Unit) then
3245 Error_Msg_NE ("instantiation of & within itself", N, Gen_Unit);
3247 elsif K = E_Procedure
3248 and then Ekind (Gen_Unit) /= E_Generic_Procedure
3250 if Ekind (Gen_Unit) = E_Generic_Function then
3252 ("cannot instantiate generic function as procedure", Gen_Id);
3255 ("expect name of generic procedure in instantiation", Gen_Id);
3258 elsif K = E_Function
3259 and then Ekind (Gen_Unit) /= E_Generic_Function
3261 if Ekind (Gen_Unit) = E_Generic_Procedure then
3263 ("cannot instantiate generic procedure as function", Gen_Id);
3266 ("expect name of generic function in instantiation", Gen_Id);
3270 Set_Entity (Gen_Id, Gen_Unit);
3271 Set_Is_Instantiated (Gen_Unit);
3273 if In_Extended_Main_Source_Unit (N) then
3274 Generate_Reference (Gen_Unit, N);
3277 -- If renaming, get original unit
3279 if Present (Renamed_Object (Gen_Unit))
3280 and then (Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Procedure
3282 Ekind (Renamed_Object (Gen_Unit)) = E_Generic_Function)
3284 Gen_Unit := Renamed_Object (Gen_Unit);
3285 Set_Is_Instantiated (Gen_Unit);
3286 Generate_Reference (Gen_Unit, N);
3289 if Contains_Instance_Of (Gen_Unit, Current_Scope, Gen_Id) then
3290 Error_Msg_Node_2 := Current_Scope;
3292 ("circular Instantiation: & instantiated in &!", N, Gen_Unit);
3293 Circularity_Detected := True;
3297 Gen_Decl := Unit_Declaration_Node (Gen_Unit);
3299 -- The subprogram itself cannot contain a nested instance, so
3300 -- the current parent is left empty.
3302 Set_Instance_Env (Gen_Unit, Empty);
3304 -- Initialize renamings map, for error checking.
3306 Generic_Renamings.Set_Last (0);
3307 Generic_Renamings_HTable.Reset;
3309 Create_Instantiation_Source (N, Gen_Unit, False, S_Adjustment);
3311 -- Copy original generic tree, to produce text for instantiation.
3315 (Original_Node (Gen_Decl), Empty, Instantiating => True);
3317 Act_Spec := Specification (Act_Tree);
3319 Analyze_Associations
3321 Generic_Formal_Declarations (Act_Tree),
3322 Generic_Formal_Declarations (Gen_Decl));
3324 -- Build the subprogram declaration, which does not appear
3325 -- in the generic template, and give it a sloc consistent
3326 -- with that of the template.
3328 Set_Defining_Unit_Name (Act_Spec, Anon_Id);
3329 Set_Generic_Parent (Act_Spec, Gen_Unit);
3331 Make_Subprogram_Declaration (Sloc (Act_Spec),
3332 Specification => Act_Spec);
3334 Set_Categorization_From_Pragmas (Act_Decl);
3336 if Parent_Installed then
3340 Append (Act_Decl, Renaming_List);
3341 Analyze_Instance_And_Renamings;
3343 -- If the generic is marked Import (Intrinsic), then so is the
3344 -- instance. This indicates that there is no body to instantiate.
3345 -- If generic is marked inline, so it the instance, and the
3346 -- anonymous subprogram it renames. If inlined, or else if inlining
3347 -- is enabled for the compilation, we generate the instance body
3348 -- even if it is not within the main unit.
3350 -- Any other pragmas might also be inherited ???
3352 if Is_Intrinsic_Subprogram (Gen_Unit) then
3353 Set_Is_Intrinsic_Subprogram (Anon_Id);
3354 Set_Is_Intrinsic_Subprogram (Act_Decl_Id);
3356 if Chars (Gen_Unit) = Name_Unchecked_Conversion then
3357 Validate_Unchecked_Conversion (N, Act_Decl_Id);
3361 Generate_Definition (Act_Decl_Id);
3363 Set_Is_Inlined (Act_Decl_Id, Is_Inlined (Gen_Unit));
3364 Set_Is_Inlined (Anon_Id, Is_Inlined (Gen_Unit));
3366 if not Is_Intrinsic_Subprogram (Gen_Unit) then
3367 Check_Elab_Instantiation (N);
3370 Check_Hidden_Child_Unit (N, Gen_Unit, Act_Decl_Id);
3372 -- Subject to change, pending on if other pragmas are inherited ???
3374 Validate_Categorization_Dependency (N, Act_Decl_Id);
3376 if not Is_Intrinsic_Subprogram (Act_Decl_Id) then
3378 if not Generic_Separately_Compiled (Gen_Unit) then
3379 Inherit_Context (Gen_Decl, N);
3382 Restore_Private_Views (Pack_Id, False);
3384 -- If the context requires a full instantiation, mark node for
3385 -- subsequent construction of the body.
3387 if (Is_In_Main_Unit (N)
3388 or else Is_Inlined (Act_Decl_Id))
3389 and then (Operating_Mode = Generate_Code
3390 or else (Operating_Mode = Check_Semantics
3391 and then ASIS_Mode))
3392 and then (Expander_Active or else ASIS_Mode)
3393 and then not ABE_Is_Certain (N)
3394 and then not Is_Eliminated (Act_Decl_Id)
3396 Pending_Instantiations.Increment_Last;
3397 Pending_Instantiations.Table (Pending_Instantiations.Last) :=
3398 (N, Act_Decl, Expander_Active, Current_Sem_Unit);
3399 Check_Forward_Instantiation (Gen_Decl);
3401 -- The wrapper package is always delayed, because it does
3402 -- not constitute a freeze point, but to insure that the
3403 -- freeze node is placed properly, it is created directly
3404 -- when instantiating the body (otherwise the freeze node
3405 -- might appear to early for nested instantiations).
3407 elsif Nkind (Parent (N)) = N_Compilation_Unit then
3409 -- For ASIS purposes, indicate that the wrapper package has
3410 -- replaced the instantiation node.
3412 Rewrite (N, Unit (Parent (N)));
3413 Set_Unit (Parent (N), N);
3416 elsif Nkind (Parent (N)) = N_Compilation_Unit then
3418 -- Replace instance node for library-level instantiations
3419 -- of intrinsic subprograms, for ASIS use.
3421 Rewrite (N, Unit (Parent (N)));
3422 Set_Unit (Parent (N), N);
3425 if Parent_Installed then
3430 Generic_Renamings.Set_Last (0);
3431 Generic_Renamings_HTable.Reset;
3435 when Instantiation_Error =>
3436 if Parent_Installed then
3439 end Analyze_Subprogram_Instantiation;
3441 -------------------------
3442 -- Get_Associated_Node --
3443 -------------------------
3445 function Get_Associated_Node (N : Node_Id) return Node_Id is
3446 Assoc : Node_Id := Associated_Node (N);
3449 if Nkind (Assoc) /= Nkind (N) then
3452 elsif Nkind (Assoc) = N_Aggregate
3453 or else Nkind (Assoc) = N_Extension_Aggregate
3457 -- If the node is part of an inner generic, it may itself have been
3458 -- remapped into a further generic copy. Associated_Node is otherwise
3459 -- used for the entity of the node, and will be of a different node
3460 -- kind, or else N has been rewritten as a literal or function call.
3462 while Present (Associated_Node (Assoc))
3463 and then Nkind (Associated_Node (Assoc)) = Nkind (Assoc)
3465 Assoc := Associated_Node (Assoc);
3468 -- Follow and additional link in case the final node was rewritten.
3469 -- This can only happen with nested generic units.
3471 if (Nkind (Assoc) = N_Identifier or else Nkind (Assoc) in N_Op)
3472 and then Present (Associated_Node (Assoc))
3473 and then (Nkind (Associated_Node (Assoc)) = N_Function_Call
3475 Nkind (Associated_Node (Assoc)) = N_Explicit_Dereference
3477 Nkind (Associated_Node (Assoc)) = N_Integer_Literal
3479 Nkind (Associated_Node (Assoc)) = N_Real_Literal
3481 Nkind (Associated_Node (Assoc)) = N_String_Literal)
3483 Assoc := Associated_Node (Assoc);
3488 end Get_Associated_Node;
3490 -------------------------------------------
3491 -- Build_Instance_Compilation_Unit_Nodes --
3492 -------------------------------------------
3494 procedure Build_Instance_Compilation_Unit_Nodes
3499 Decl_Cunit : Node_Id;
3500 Body_Cunit : Node_Id;
3502 New_Main : constant Entity_Id := Defining_Entity (Act_Decl);
3503 Old_Main : constant Entity_Id := Cunit_Entity (Main_Unit);
3506 -- A new compilation unit node is built for the instance declaration
3509 Make_Compilation_Unit (Sloc (N),
3510 Context_Items => Empty_List,
3513 Make_Compilation_Unit_Aux (Sloc (N)));
3515 Set_Parent_Spec (Act_Decl, Parent_Spec (N));
3516 Set_Body_Required (Decl_Cunit, True);
3518 -- We use the original instantiation compilation unit as the resulting
3519 -- compilation unit of the instance, since this is the main unit.
3521 Rewrite (N, Act_Body);
3522 Body_Cunit := Parent (N);
3524 -- The two compilation unit nodes are linked by the Library_Unit field
3526 Set_Library_Unit (Decl_Cunit, Body_Cunit);
3527 Set_Library_Unit (Body_Cunit, Decl_Cunit);
3529 -- Preserve the private nature of the package if needed.
3531 Set_Private_Present (Decl_Cunit, Private_Present (Body_Cunit));
3533 -- If the instance is not the main unit, its context, categorization,
3534 -- and elaboration entity are not relevant to the compilation.
3536 if Parent (N) /= Cunit (Main_Unit) then
3540 -- The context clause items on the instantiation, which are now
3541 -- attached to the body compilation unit (since the body overwrote
3542 -- the original instantiation node), semantically belong on the spec,
3543 -- so copy them there. It's harmless to leave them on the body as well.
3544 -- In fact one could argue that they belong in both places.
3546 Citem := First (Context_Items (Body_Cunit));
3547 while Present (Citem) loop
3548 Append (New_Copy (Citem), Context_Items (Decl_Cunit));
3552 -- Propagate categorization flags on packages, so that they appear
3553 -- in ali file for the spec of the unit.
3555 if Ekind (New_Main) = E_Package then
3556 Set_Is_Pure (Old_Main, Is_Pure (New_Main));
3557 Set_Is_Preelaborated (Old_Main, Is_Preelaborated (New_Main));
3558 Set_Is_Remote_Types (Old_Main, Is_Remote_Types (New_Main));
3559 Set_Is_Shared_Passive (Old_Main, Is_Shared_Passive (New_Main));
3560 Set_Is_Remote_Call_Interface
3561 (Old_Main, Is_Remote_Call_Interface (New_Main));
3564 -- Make entry in Units table, so that binder can generate call to
3565 -- elaboration procedure for body, if any.
3567 Make_Instance_Unit (Body_Cunit);
3568 Main_Unit_Entity := New_Main;
3569 Set_Cunit_Entity (Main_Unit, Main_Unit_Entity);
3571 -- Build elaboration entity, since the instance may certainly
3572 -- generate elaboration code requiring a flag for protection.
3574 Build_Elaboration_Entity (Decl_Cunit, New_Main);
3575 end Build_Instance_Compilation_Unit_Nodes;
3577 -----------------------------------
3578 -- Check_Formal_Package_Instance --
3579 -----------------------------------
3581 -- If the formal has specific parameters, they must match those of the
3582 -- actual. Both of them are instances, and the renaming declarations
3583 -- for their formal parameters appear in the same order in both. The
3584 -- analyzed formal has been analyzed in the context of the current
3587 procedure Check_Formal_Package_Instance
3588 (Formal_Pack : Entity_Id;
3589 Actual_Pack : Entity_Id)
3591 E1 : Entity_Id := First_Entity (Actual_Pack);
3592 E2 : Entity_Id := First_Entity (Formal_Pack);
3597 procedure Check_Mismatch (B : Boolean);
3598 -- Common error routine for mismatch between the parameters of
3599 -- the actual instance and those of the formal package.
3601 procedure Check_Mismatch (B : Boolean) is
3605 ("actual for & in actual instance does not match formal",
3606 Parent (Actual_Pack), E1);
3610 -- Start of processing for Check_Formal_Package_Instance
3614 and then Present (E2)
3616 exit when Ekind (E1) = E_Package
3617 and then Renamed_Entity (E1) = Renamed_Entity (Actual_Pack);
3619 if Is_Type (E1) then
3621 -- Subtypes must statically match. E1 and E2 are the
3622 -- local entities that are subtypes of the actuals.
3623 -- Itypes generated for other parameters need not be checked,
3624 -- the check will be performed on the parameters themselves.
3626 if not Is_Itype (E1)
3627 and then not Is_Itype (E2)
3631 or else Etype (E1) /= Etype (E2)
3632 or else not Subtypes_Statically_Match (E1, E2));
3635 elsif Ekind (E1) = E_Constant then
3637 -- IN parameters must denote the same static value, or
3638 -- the same constant, or the literal null.
3640 Expr1 := Expression (Parent (E1));
3642 if Ekind (E2) /= E_Constant then
3643 Check_Mismatch (True);
3646 Expr2 := Expression (Parent (E2));
3649 if Is_Static_Expression (Expr1) then
3651 if not Is_Static_Expression (Expr2) then
3652 Check_Mismatch (True);
3654 elsif Is_Integer_Type (Etype (E1)) then
3657 V1 : constant Uint := Expr_Value (Expr1);
3658 V2 : constant Uint := Expr_Value (Expr2);
3660 Check_Mismatch (V1 /= V2);
3663 elsif Is_Real_Type (Etype (E1)) then
3665 V1 : constant Ureal := Expr_Value_R (Expr1);
3666 V2 : constant Ureal := Expr_Value_R (Expr2);
3668 Check_Mismatch (V1 /= V2);
3671 elsif Is_String_Type (Etype (E1))
3672 and then Nkind (Expr1) = N_String_Literal
3675 if Nkind (Expr2) /= N_String_Literal then
3676 Check_Mismatch (True);
3679 (not String_Equal (Strval (Expr1), Strval (Expr2)));
3683 elsif Is_Entity_Name (Expr1) then
3684 if Is_Entity_Name (Expr2) then
3685 if Entity (Expr1) = Entity (Expr2) then
3688 elsif Ekind (Entity (Expr2)) = E_Constant
3689 and then Is_Entity_Name (Constant_Value (Entity (Expr2)))
3691 Entity (Constant_Value (Entity (Expr2))) = Entity (Expr1)
3695 Check_Mismatch (True);
3698 Check_Mismatch (True);
3701 elsif Nkind (Expr1) = N_Null then
3702 Check_Mismatch (Nkind (Expr1) /= N_Null);
3705 Check_Mismatch (True);
3708 elsif Ekind (E1) = E_Variable
3709 or else Ekind (E1) = E_Package
3712 (Ekind (E1) /= Ekind (E2)
3713 or else Renamed_Object (E1) /= Renamed_Object (E2));
3715 elsif Is_Overloadable (E1) then
3717 -- Verify that the names of the entities match.
3718 -- What if actual is an attribute ???
3721 (Ekind (E2) /= Ekind (E1) or else (Alias (E1)) /= Alias (E2));
3724 raise Program_Error;
3731 end Check_Formal_Package_Instance;
3733 ---------------------------
3734 -- Check_Formal_Packages --
3735 ---------------------------
3737 procedure Check_Formal_Packages (P_Id : Entity_Id) is
3739 Formal_P : Entity_Id;
3742 -- Iterate through the declarations in the instance, looking for
3743 -- package renaming declarations that denote instances of formal
3744 -- packages. Stop when we find the renaming of the current package
3745 -- itself. The declaration for a formal package without a box is
3746 -- followed by an internal entity that repeats the instantiation.
3748 E := First_Entity (P_Id);
3749 while Present (E) loop
3750 if Ekind (E) = E_Package then
3751 if Renamed_Object (E) = P_Id then
3754 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
3757 elsif not Box_Present (Parent (Associated_Formal_Package (E))) then
3758 Formal_P := Next_Entity (E);
3759 Check_Formal_Package_Instance (Formal_P, E);
3765 end Check_Formal_Packages;
3767 ---------------------------------
3768 -- Check_Forward_Instantiation --
3769 ---------------------------------
3771 procedure Check_Forward_Instantiation (Decl : Node_Id) is
3773 Gen_Comp : Entity_Id := Cunit_Entity (Get_Source_Unit (Decl));
3776 -- The instantiation appears before the generic body if we are in the
3777 -- scope of the unit containing the generic, either in its spec or in
3778 -- the package body. and before the generic body.
3780 if Ekind (Gen_Comp) = E_Package_Body then
3781 Gen_Comp := Spec_Entity (Gen_Comp);
3784 if In_Open_Scopes (Gen_Comp)
3785 and then No (Corresponding_Body (Decl))
3790 and then not Is_Compilation_Unit (S)
3791 and then not Is_Child_Unit (S)
3793 if Ekind (S) = E_Package then
3794 Set_Has_Forward_Instantiation (S);
3800 end Check_Forward_Instantiation;
3802 ---------------------------
3803 -- Check_Generic_Actuals --
3804 ---------------------------
3806 -- The visibility of the actuals may be different between the
3807 -- point of generic instantiation and the instantiation of the body.
3809 procedure Check_Generic_Actuals
3810 (Instance : Entity_Id;
3811 Is_Formal_Box : Boolean)
3817 E := First_Entity (Instance);
3818 while Present (E) loop
3820 and then Nkind (Parent (E)) = N_Subtype_Declaration
3821 and then Scope (Etype (E)) /= Instance
3822 and then Is_Entity_Name (Subtype_Indication (Parent (E)))
3824 Check_Private_View (Subtype_Indication (Parent (E)));
3825 Set_Is_Generic_Actual_Type (E, True);
3826 Set_Is_Hidden (E, False);
3828 -- We constructed the generic actual type as a subtype of
3829 -- the supplied type. This means that it normally would not
3830 -- inherit subtype specific attributes of the actual, which
3831 -- is wrong for the generic case.
3833 Astype := Ancestor_Subtype (E);
3837 -- can happen when E is an itype that is the full view of
3838 -- a private type completed, e.g. with a constrained array.
3840 Astype := Base_Type (E);
3843 Set_Size_Info (E, (Astype));
3844 Set_RM_Size (E, RM_Size (Astype));
3845 Set_First_Rep_Item (E, First_Rep_Item (Astype));
3847 if Is_Discrete_Or_Fixed_Point_Type (E) then
3848 Set_RM_Size (E, RM_Size (Astype));
3850 -- In nested instances, the base type of an access actual
3851 -- may itself be private, and need to be exchanged.
3853 elsif Is_Access_Type (E)
3854 and then Is_Private_Type (Etype (E))
3857 (New_Occurrence_Of (Etype (E), Sloc (Instance)));
3860 elsif Ekind (E) = E_Package then
3862 -- If this is the renaming for the current instance, we're done.
3863 -- Otherwise it is a formal package. If the corresponding formal
3864 -- was declared with a box, the (instantiations of the) generic
3865 -- formal part are also visible. Otherwise, ignore the entity
3866 -- created to validate the actuals.
3868 if Renamed_Object (E) = Instance then
3871 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
3874 -- The visibility of a formal of an enclosing generic is already
3877 elsif Denotes_Formal_Package (E) then
3880 elsif Present (Associated_Formal_Package (E))
3881 and then Box_Present (Parent (Associated_Formal_Package (E)))
3883 Check_Generic_Actuals (Renamed_Object (E), True);
3884 Set_Is_Hidden (E, False);
3887 -- If this is a subprogram instance (in a wrapper package) the
3888 -- actual is fully visible.
3890 elsif Is_Wrapper_Package (Instance) then
3891 Set_Is_Hidden (E, False);
3894 Set_Is_Hidden (E, not Is_Formal_Box);
3899 end Check_Generic_Actuals;
3901 ------------------------------
3902 -- Check_Generic_Child_Unit --
3903 ------------------------------
3905 procedure Check_Generic_Child_Unit
3907 Parent_Installed : in out Boolean)
3909 Loc : constant Source_Ptr := Sloc (Gen_Id);
3910 Gen_Par : Entity_Id := Empty;
3911 Inst_Par : Entity_Id;
3915 function Find_Generic_Child
3919 -- Search generic parent for possible child unit with the given name.
3921 function In_Enclosing_Instance return Boolean;
3922 -- Within an instance of the parent, the child unit may be denoted
3923 -- by a simple name, or an abbreviated expanded name. Examine enclosing
3924 -- scopes to locate a possible parent instantiation.
3926 ------------------------
3927 -- Find_Generic_Child --
3928 ------------------------
3930 function Find_Generic_Child
3938 -- If entity of name is already set, instance has already been
3939 -- resolved, e.g. in an enclosing instantiation.
3941 if Present (Entity (Id)) then
3942 if Scope (Entity (Id)) = Scop then
3949 E := First_Entity (Scop);
3950 while Present (E) loop
3951 if Chars (E) = Chars (Id)
3952 and then Is_Child_Unit (E)
3954 if Is_Child_Unit (E)
3955 and then not Is_Visible_Child_Unit (E)
3958 ("generic child unit& is not visible", Gen_Id, E);
3970 end Find_Generic_Child;
3972 ---------------------------
3973 -- In_Enclosing_Instance --
3974 ---------------------------
3976 function In_Enclosing_Instance return Boolean is
3977 Enclosing_Instance : Node_Id;
3978 Instance_Decl : Node_Id;
3981 Enclosing_Instance := Current_Scope;
3983 while Present (Enclosing_Instance) loop
3984 Instance_Decl := Unit_Declaration_Node (Enclosing_Instance);
3986 if Ekind (Enclosing_Instance) = E_Package
3987 and then Is_Generic_Instance (Enclosing_Instance)
3989 (Generic_Parent (Specification (Instance_Decl)))
3991 -- Check whether the generic we are looking for is a child
3992 -- of this instance.
3994 E := Find_Generic_Child
3995 (Generic_Parent (Specification (Instance_Decl)), Gen_Id);
3996 exit when Present (E);
4002 Enclosing_Instance := Scope (Enclosing_Instance);
4014 Make_Expanded_Name (Loc,
4016 Prefix => New_Occurrence_Of (Enclosing_Instance, Loc),
4017 Selector_Name => New_Occurrence_Of (E, Loc)));
4019 Set_Entity (Gen_Id, E);
4020 Set_Etype (Gen_Id, Etype (E));
4021 Parent_Installed := False; -- Already in scope.
4024 end In_Enclosing_Instance;
4026 -- Start of processing for Check_Generic_Child_Unit
4029 -- If the name of the generic is given by a selected component, it
4030 -- may be the name of a generic child unit, and the prefix is the name
4031 -- of an instance of the parent, in which case the child unit must be
4032 -- visible. If this instance is not in scope, it must be placed there
4033 -- and removed after instantiation, because what is being instantiated
4034 -- is not the original child, but the corresponding child present in
4035 -- the instance of the parent.
4037 -- If the child is instantiated within the parent, it can be given by
4038 -- a simple name. In this case the instance is already in scope, but
4039 -- the child generic must be recovered from the generic parent as well.
4041 if Nkind (Gen_Id) = N_Selected_Component then
4042 S := Selector_Name (Gen_Id);
4043 Analyze (Prefix (Gen_Id));
4044 Inst_Par := Entity (Prefix (Gen_Id));
4046 if Ekind (Inst_Par) = E_Package
4047 and then Present (Renamed_Object (Inst_Par))
4049 Inst_Par := Renamed_Object (Inst_Par);
4052 if Ekind (Inst_Par) = E_Package then
4053 if Nkind (Parent (Inst_Par)) = N_Package_Specification then
4054 Gen_Par := Generic_Parent (Parent (Inst_Par));
4056 elsif Nkind (Parent (Inst_Par)) = N_Defining_Program_Unit_Name
4058 Nkind (Parent (Parent (Inst_Par))) = N_Package_Specification
4060 Gen_Par := Generic_Parent (Parent (Parent (Inst_Par)));
4063 elsif Ekind (Inst_Par) = E_Generic_Package
4064 and then Nkind (Parent (Gen_Id)) = N_Formal_Package_Declaration
4066 -- A formal package may be a real child package, and not the
4067 -- implicit instance within a parent. In this case the child is
4068 -- not visible and has to be retrieved explicitly as well.
4070 Gen_Par := Inst_Par;
4073 if Present (Gen_Par) then
4075 -- The prefix denotes an instantiation. The entity itself
4076 -- may be a nested generic, or a child unit.
4078 E := Find_Generic_Child (Gen_Par, S);
4081 Change_Selected_Component_To_Expanded_Name (Gen_Id);
4082 Set_Entity (Gen_Id, E);
4083 Set_Etype (Gen_Id, Etype (E));
4085 Set_Etype (S, Etype (E));
4087 -- Indicate that this is a reference to the parent.
4089 if In_Extended_Main_Source_Unit (Gen_Id) then
4090 Set_Is_Instantiated (Inst_Par);
4093 -- A common mistake is to replicate the naming scheme of
4094 -- a hierarchy by instantiating a generic child directly,
4095 -- rather than the implicit child in a parent instance:
4097 -- generic .. package Gpar is ..
4098 -- generic .. package Gpar.Child is ..
4099 -- package Par is new Gpar ();
4102 -- package Par.Child is new Gpar.Child ();
4103 -- rather than Par.Child
4105 -- In this case the instantiation is within Par, which is
4106 -- an instance, but Gpar does not denote Par because we are
4107 -- not IN the instance of Gpar, so this is illegal. The test
4108 -- below recognizes this particular case.
4110 if Is_Child_Unit (E)
4111 and then not Comes_From_Source (Entity (Prefix (Gen_Id)))
4112 and then (not In_Instance
4113 or else Nkind (Parent (Parent (Gen_Id))) =
4117 ("prefix of generic child unit must be instance of parent",
4121 if not In_Open_Scopes (Inst_Par)
4122 and then Nkind (Parent (Gen_Id)) not in
4123 N_Generic_Renaming_Declaration
4125 Install_Parent (Inst_Par);
4126 Parent_Installed := True;
4130 -- If the generic parent does not contain an entity that
4131 -- corresponds to the selector, the instance doesn't either.
4132 -- Analyzing the node will yield the appropriate error message.
4133 -- If the entity is not a child unit, then it is an inner
4134 -- generic in the parent.
4142 if Is_Child_Unit (Entity (Gen_Id))
4144 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
4145 and then not In_Open_Scopes (Inst_Par)
4147 Install_Parent (Inst_Par);
4148 Parent_Installed := True;
4152 elsif Nkind (Gen_Id) = N_Expanded_Name then
4154 -- Entity already present, analyze prefix, whose meaning may be
4155 -- an instance in the current context. If it is an instance of
4156 -- a relative within another, the proper parent may still have
4157 -- to be installed, if they are not of the same generation.
4159 Analyze (Prefix (Gen_Id));
4160 Inst_Par := Entity (Prefix (Gen_Id));
4162 if In_Enclosing_Instance then
4165 elsif Present (Entity (Gen_Id))
4166 and then Is_Child_Unit (Entity (Gen_Id))
4167 and then not In_Open_Scopes (Inst_Par)
4169 Install_Parent (Inst_Par);
4170 Parent_Installed := True;
4173 elsif In_Enclosing_Instance then
4175 -- The child unit is found in some enclosing scope
4182 -- If this is the renaming of the implicit child in a parent
4183 -- instance, recover the parent name and install it.
4185 if Is_Entity_Name (Gen_Id) then
4186 E := Entity (Gen_Id);
4188 if Is_Generic_Unit (E)
4189 and then Nkind (Parent (E)) in N_Generic_Renaming_Declaration
4190 and then Is_Child_Unit (Renamed_Object (E))
4191 and then Is_Generic_Unit (Scope (Renamed_Object (E)))
4192 and then Nkind (Name (Parent (E))) = N_Expanded_Name
4195 New_Copy_Tree (Name (Parent (E))));
4196 Inst_Par := Entity (Prefix (Gen_Id));
4198 if not In_Open_Scopes (Inst_Par) then
4199 Install_Parent (Inst_Par);
4200 Parent_Installed := True;
4203 -- If it is a child unit of a non-generic parent, it may be
4204 -- use-visible and given by a direct name. Install parent as
4207 elsif Is_Generic_Unit (E)
4208 and then Is_Child_Unit (E)
4210 Nkind (Parent (Gen_Id)) not in N_Generic_Renaming_Declaration
4211 and then not Is_Generic_Unit (Scope (E))
4213 if not In_Open_Scopes (Scope (E)) then
4214 Install_Parent (Scope (E));
4215 Parent_Installed := True;
4220 end Check_Generic_Child_Unit;
4222 -----------------------------
4223 -- Check_Hidden_Child_Unit --
4224 -----------------------------
4226 procedure Check_Hidden_Child_Unit
4228 Gen_Unit : Entity_Id;
4229 Act_Decl_Id : Entity_Id)
4231 Gen_Id : constant Node_Id := Name (N);
4234 if Is_Child_Unit (Gen_Unit)
4235 and then Is_Child_Unit (Act_Decl_Id)
4236 and then Nkind (Gen_Id) = N_Expanded_Name
4237 and then Entity (Prefix (Gen_Id)) = Scope (Act_Decl_Id)
4238 and then Chars (Gen_Unit) = Chars (Act_Decl_Id)
4240 Error_Msg_Node_2 := Scope (Act_Decl_Id);
4242 ("generic unit & is implicitly declared in &",
4243 Defining_Unit_Name (N), Gen_Unit);
4244 Error_Msg_N ("\instance must have different name",
4245 Defining_Unit_Name (N));
4247 end Check_Hidden_Child_Unit;
4249 ------------------------
4250 -- Check_Private_View --
4251 ------------------------
4253 procedure Check_Private_View (N : Node_Id) is
4254 T : constant Entity_Id := Etype (N);
4258 -- Exchange views if the type was not private in the generic but is
4259 -- private at the point of instantiation. Do not exchange views if
4260 -- the scope of the type is in scope. This can happen if both generic
4261 -- and instance are sibling units, or if type is defined in a parent.
4262 -- In this case the visibility of the type will be correct for all
4266 BT := Base_Type (T);
4268 if Is_Private_Type (T)
4269 and then not Has_Private_View (N)
4270 and then Present (Full_View (T))
4271 and then not In_Open_Scopes (Scope (T))
4273 -- In the generic, the full type was visible. Save the
4274 -- private entity, for subsequent exchange.
4278 elsif Has_Private_View (N)
4279 and then not Is_Private_Type (T)
4280 and then not Has_Been_Exchanged (T)
4281 and then Etype (Get_Associated_Node (N)) /= T
4283 -- Only the private declaration was visible in the generic. If
4284 -- the type appears in a subtype declaration, the subtype in the
4285 -- instance must have a view compatible with that of its parent,
4286 -- which must be exchanged (see corresponding code in Restore_
4287 -- Private_Views). Otherwise, if the type is defined in a parent
4288 -- unit, leave full visibility within instance, which is safe.
4290 if In_Open_Scopes (Scope (Base_Type (T)))
4291 and then not Is_Private_Type (Base_Type (T))
4292 and then Comes_From_Source (Base_Type (T))
4296 elsif Nkind (Parent (N)) = N_Subtype_Declaration
4297 or else not In_Private_Part (Scope (Base_Type (T)))
4299 Append_Elmt (T, Exchanged_Views);
4300 Exchange_Declarations (Etype (Get_Associated_Node (N)));
4303 -- For composite types with inconsistent representation
4304 -- exchange component types accordingly.
4306 elsif Is_Access_Type (T)
4307 and then Is_Private_Type (Designated_Type (T))
4308 and then not Has_Private_View (N)
4309 and then Present (Full_View (Designated_Type (T)))
4311 Switch_View (Designated_Type (T));
4313 elsif Is_Array_Type (T)
4314 and then Is_Private_Type (Component_Type (T))
4315 and then not Has_Private_View (N)
4316 and then Present (Full_View (Component_Type (T)))
4318 Switch_View (Component_Type (T));
4320 elsif Is_Private_Type (T)
4321 and then Present (Full_View (T))
4322 and then Is_Array_Type (Full_View (T))
4323 and then Is_Private_Type (Component_Type (Full_View (T)))
4327 -- Finally, a non-private subtype may have a private base type,
4328 -- which must be exchanged for consistency. This can happen when
4329 -- instantiating a package body, when the scope stack is empty
4330 -- but in fact the subtype and the base type are declared in an
4333 elsif not Is_Private_Type (T)
4334 and then not Has_Private_View (N)
4335 and then Is_Private_Type (Base_Type (T))
4336 and then Present (Full_View (BT))
4337 and then not Is_Generic_Type (BT)
4338 and then not In_Open_Scopes (BT)
4340 Append_Elmt (Full_View (BT), Exchanged_Views);
4341 Exchange_Declarations (BT);
4344 end Check_Private_View;
4346 --------------------------
4347 -- Contains_Instance_Of --
4348 --------------------------
4350 function Contains_Instance_Of
4362 -- Verify that there are no circular instantiations. We check whether
4363 -- the unit contains an instance of the current scope or some enclosing
4364 -- scope (in case one of the instances appears in a subunit). Longer
4365 -- circularities involving subunits might seem too pathological to
4366 -- consider, but they were not too pathological for the authors of
4367 -- DEC bc30vsq, so we loop over all enclosing scopes, and mark all
4368 -- enclosing generic scopes as containing an instance.
4371 -- Within a generic subprogram body, the scope is not generic, to
4372 -- allow for recursive subprograms. Use the declaration to determine
4373 -- whether this is a generic unit.
4375 if Ekind (Scop) = E_Generic_Package
4376 or else (Is_Subprogram (Scop)
4377 and then Nkind (Unit_Declaration_Node (Scop)) =
4378 N_Generic_Subprogram_Declaration)
4380 Elmt := First_Elmt (Inner_Instances (Inner));
4382 while Present (Elmt) loop
4383 if Node (Elmt) = Scop then
4384 Error_Msg_Node_2 := Inner;
4386 ("circular Instantiation: & instantiated within &!",
4390 elsif Node (Elmt) = Inner then
4393 elsif Contains_Instance_Of (Node (Elmt), Scop, N) then
4394 Error_Msg_Node_2 := Inner;
4396 ("circular Instantiation: & instantiated within &!",
4404 -- Indicate that Inner is being instantiated within Scop.
4406 Append_Elmt (Inner, Inner_Instances (Scop));
4409 if Scop = Standard_Standard then
4412 Scop := Scope (Scop);
4417 end Contains_Instance_Of;
4419 -----------------------
4420 -- Copy_Generic_Node --
4421 -----------------------
4423 function Copy_Generic_Node
4425 Parent_Id : Node_Id;
4426 Instantiating : Boolean)
4432 function Copy_Generic_Descendant (D : Union_Id) return Union_Id;
4433 -- Check the given value of one of the Fields referenced by the
4434 -- current node to determine whether to copy it recursively. The
4435 -- field may hold a Node_Id, a List_Id, or an Elist_Id, or a plain
4436 -- value (Sloc, Uint, Char) in which case it need not be copied.
4438 procedure Copy_Descendants;
4439 -- Common utility for various nodes.
4441 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id;
4442 -- Make copy of element list.
4444 function Copy_Generic_List
4446 Parent_Id : Node_Id)
4448 -- Apply Copy_Node recursively to the members of a node list.
4450 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean;
4451 -- True if an identifier is part of the defining program unit name
4452 -- of a child unit. The entity of such an identifier must be kept
4453 -- (for ASIS use) even though as the name of an enclosing generic
4454 -- it would otherwise not be preserved in the generic tree.
4456 -----------------------
4457 -- Copy_Descendants --
4458 -----------------------
4460 procedure Copy_Descendants is
4462 use Atree.Unchecked_Access;
4463 -- This code section is part of the implementation of an untyped
4464 -- tree traversal, so it needs direct access to node fields.
4467 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
4468 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
4469 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
4470 Set_Field4 (New_N, Copy_Generic_Descendant (Field4 (N)));
4471 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
4472 end Copy_Descendants;
4474 -----------------------------
4475 -- Copy_Generic_Descendant --
4476 -----------------------------
4478 function Copy_Generic_Descendant (D : Union_Id) return Union_Id is
4480 if D = Union_Id (Empty) then
4483 elsif D in Node_Range then
4485 (Copy_Generic_Node (Node_Id (D), New_N, Instantiating));
4487 elsif D in List_Range then
4488 return Union_Id (Copy_Generic_List (List_Id (D), New_N));
4490 elsif D in Elist_Range then
4491 return Union_Id (Copy_Generic_Elist (Elist_Id (D)));
4493 -- Nothing else is copyable (e.g. Uint values), return as is
4498 end Copy_Generic_Descendant;
4500 ------------------------
4501 -- Copy_Generic_Elist --
4502 ------------------------
4504 function Copy_Generic_Elist (E : Elist_Id) return Elist_Id is
4511 M := First_Elmt (E);
4512 while Present (M) loop
4514 (Copy_Generic_Node (Node (M), Empty, Instantiating), L);
4523 end Copy_Generic_Elist;
4525 -----------------------
4526 -- Copy_Generic_List --
4527 -----------------------
4529 function Copy_Generic_List
4531 Parent_Id : Node_Id)
4540 Set_Parent (New_L, Parent_Id);
4543 while Present (N) loop
4544 Append (Copy_Generic_Node (N, Empty, Instantiating), New_L);
4553 end Copy_Generic_List;
4555 ---------------------------
4556 -- In_Defining_Unit_Name --
4557 ---------------------------
4559 function In_Defining_Unit_Name (Nam : Node_Id) return Boolean is
4561 return Present (Parent (Nam))
4562 and then (Nkind (Parent (Nam)) = N_Defining_Program_Unit_Name
4564 (Nkind (Parent (Nam)) = N_Expanded_Name
4565 and then In_Defining_Unit_Name (Parent (Nam))));
4566 end In_Defining_Unit_Name;
4568 -- Start of processing for Copy_Generic_Node
4575 New_N := New_Copy (N);
4577 if Instantiating then
4578 Adjust_Instantiation_Sloc (New_N, S_Adjustment);
4581 if not Is_List_Member (N) then
4582 Set_Parent (New_N, Parent_Id);
4585 -- If defining identifier, then all fields have been copied already
4587 if Nkind (New_N) in N_Entity then
4590 -- Special casing for identifiers and other entity names and operators
4592 elsif Nkind (New_N) = N_Identifier
4593 or else Nkind (New_N) = N_Character_Literal
4594 or else Nkind (New_N) = N_Expanded_Name
4595 or else Nkind (New_N) = N_Operator_Symbol
4596 or else Nkind (New_N) in N_Op
4598 if not Instantiating then
4600 -- Link both nodes in order to assign subsequently the
4601 -- entity of the copy to the original node, in case this
4602 -- is a global reference.
4604 Set_Associated_Node (N, New_N);
4606 -- If we are within an instantiation, this is a nested generic
4607 -- that has already been analyzed at the point of definition. We
4608 -- must preserve references that were global to the enclosing
4609 -- parent at that point. Other occurrences, whether global or
4610 -- local to the current generic, must be resolved anew, so we
4611 -- reset the entity in the generic copy. A global reference has
4612 -- a smaller depth than the parent, or else the same depth in
4613 -- case both are distinct compilation units.
4615 -- It is also possible for Current_Instantiated_Parent to be
4616 -- defined, and for this not to be a nested generic, namely
4617 -- if the unit is loaded through Rtsfind. In that case, the
4618 -- entity of New_N is only a link to the associated node, and
4619 -- not a defining occurrence.
4621 -- The entities for parent units in the defining_program_unit
4622 -- of a generic child unit are established when the context of
4623 -- the unit is first analyzed, before the generic copy is made.
4624 -- They are preserved in the copy for use in ASIS queries.
4626 Ent := Entity (New_N);
4628 if No (Current_Instantiated_Parent.Gen_Id) then
4630 or else Nkind (Ent) /= N_Defining_Identifier
4631 or else not In_Defining_Unit_Name (N)
4633 Set_Associated_Node (New_N, Empty);
4638 not (Nkind (Ent) = N_Defining_Identifier
4640 Nkind (Ent) = N_Defining_Character_Literal
4642 Nkind (Ent) = N_Defining_Operator_Symbol)
4643 or else No (Scope (Ent))
4644 or else Scope (Ent) = Current_Instantiated_Parent.Gen_Id
4645 or else (Scope_Depth (Scope (Ent)) >
4646 Scope_Depth (Current_Instantiated_Parent.Gen_Id)
4648 Get_Source_Unit (Ent) =
4649 Get_Source_Unit (Current_Instantiated_Parent.Gen_Id))
4651 Set_Associated_Node (New_N, Empty);
4654 -- Case of instantiating identifier or some other name or operator
4657 -- If the associated node is still defined, the entity in
4658 -- it is global, and must be copied to the instance.
4659 -- If this copy is being made for a body to inline, it is
4660 -- applied to an instantiated tree, and the entity is already
4661 -- present and must be also preserved.
4664 Assoc : constant Node_Id := Get_Associated_Node (N);
4666 if Present (Assoc) then
4667 if Nkind (Assoc) = Nkind (N) then
4668 Set_Entity (New_N, Entity (Assoc));
4669 Check_Private_View (N);
4671 elsif Nkind (Assoc) = N_Function_Call then
4672 Set_Entity (New_N, Entity (Name (Assoc)));
4674 elsif (Nkind (Assoc) = N_Defining_Identifier
4675 or else Nkind (Assoc) = N_Defining_Character_Literal
4676 or else Nkind (Assoc) = N_Defining_Operator_Symbol)
4677 and then Expander_Active
4679 -- Inlining case: we are copying a tree that contains
4680 -- global entities, which are preserved in the copy
4681 -- to be used for subsequent inlining.
4686 Set_Entity (New_N, Empty);
4692 -- For expanded name, we must copy the Prefix and Selector_Name
4694 if Nkind (N) = N_Expanded_Name then
4696 (New_N, Copy_Generic_Node (Prefix (N), New_N, Instantiating));
4698 Set_Selector_Name (New_N,
4699 Copy_Generic_Node (Selector_Name (N), New_N, Instantiating));
4701 -- For operators, we must copy the right operand
4703 elsif Nkind (N) in N_Op then
4704 Set_Right_Opnd (New_N,
4705 Copy_Generic_Node (Right_Opnd (N), New_N, Instantiating));
4707 -- And for binary operators, the left operand as well
4709 if Nkind (N) in N_Binary_Op then
4710 Set_Left_Opnd (New_N,
4711 Copy_Generic_Node (Left_Opnd (N), New_N, Instantiating));
4715 -- Special casing for stubs
4717 elsif Nkind (N) in N_Body_Stub then
4719 -- In any case, we must copy the specification or defining
4720 -- identifier as appropriate.
4722 if Nkind (N) = N_Subprogram_Body_Stub then
4723 Set_Specification (New_N,
4724 Copy_Generic_Node (Specification (N), New_N, Instantiating));
4727 Set_Defining_Identifier (New_N,
4729 (Defining_Identifier (N), New_N, Instantiating));
4732 -- If we are not instantiating, then this is where we load and
4733 -- analyze subunits, i.e. at the point where the stub occurs. A
4734 -- more permissivle system might defer this analysis to the point
4735 -- of instantiation, but this seems to complicated for now.
4737 if not Instantiating then
4739 Subunit_Name : constant Unit_Name_Type := Get_Unit_Name (N);
4741 Unum : Unit_Number_Type;
4747 (Load_Name => Subunit_Name,
4752 -- If the proper body is not found, a warning message will
4753 -- be emitted when analyzing the stub, or later at the the
4754 -- point of instantiation. Here we just leave the stub as is.
4756 if Unum = No_Unit then
4757 Subunits_Missing := True;
4758 goto Subunit_Not_Found;
4761 Subunit := Cunit (Unum);
4763 if Nkind (Unit (Subunit)) /= N_Subunit then
4764 Error_Msg_Sloc := Sloc (N);
4766 ("expected SEPARATE subunit to complete stub at#,"
4767 & " found child unit", Subunit);
4768 goto Subunit_Not_Found;
4771 -- We must create a generic copy of the subunit, in order
4772 -- to perform semantic analysis on it, and we must replace
4773 -- the stub in the original generic unit with the subunit,
4774 -- in order to preserve non-local references within.
4776 -- Only the proper body needs to be copied. Library_Unit and
4777 -- context clause are simply inherited by the generic copy.
4778 -- Note that the copy (which may be recursive if there are
4779 -- nested subunits) must be done first, before attaching it
4780 -- to the enclosing generic.
4784 (Proper_Body (Unit (Subunit)),
4785 Empty, Instantiating => False);
4787 -- Now place the original proper body in the original
4788 -- generic unit. This is a body, not a compilation unit.
4790 Rewrite (N, Proper_Body (Unit (Subunit)));
4791 Set_Is_Compilation_Unit (Defining_Entity (N), False);
4792 Set_Was_Originally_Stub (N);
4794 -- Finally replace the body of the subunit with its copy,
4795 -- and make this new subunit into the library unit of the
4796 -- generic copy, which does not have stubs any longer.
4798 Set_Proper_Body (Unit (Subunit), New_Body);
4799 Set_Library_Unit (New_N, Subunit);
4800 Inherit_Context (Unit (Subunit), N);
4803 -- If we are instantiating, this must be an error case, since
4804 -- otherwise we would have replaced the stub node by the proper
4805 -- body that corresponds. So just ignore it in the copy (i.e.
4806 -- we have copied it, and that is good enough).
4812 <<Subunit_Not_Found>> null;
4814 -- If the node is a compilation unit, it is the subunit of a stub,
4815 -- which has been loaded already (see code below). In this case,
4816 -- the library unit field of N points to the parent unit (which
4817 -- is a compilation unit) and need not (and cannot!) be copied.
4819 -- When the proper body of the stub is analyzed, thie library_unit
4820 -- link is used to establish the proper context (see sem_ch10).
4822 -- The other fields of a compilation unit are copied as usual
4824 elsif Nkind (N) = N_Compilation_Unit then
4826 -- This code can only be executed when not instantiating, because
4827 -- in the copy made for an instantiation, the compilation unit
4828 -- node has disappeared at the point that a stub is replaced by
4831 pragma Assert (not Instantiating);
4833 Set_Context_Items (New_N,
4834 Copy_Generic_List (Context_Items (N), New_N));
4837 Copy_Generic_Node (Unit (N), New_N, False));
4839 Set_First_Inlined_Subprogram (New_N,
4841 (First_Inlined_Subprogram (N), New_N, False));
4843 Set_Aux_Decls_Node (New_N,
4844 Copy_Generic_Node (Aux_Decls_Node (N), New_N, False));
4846 -- For an assignment node, the assignment is known to be semantically
4847 -- legal if we are instantiating the template. This avoids incorrect
4848 -- diagnostics in generated code.
4850 elsif Nkind (N) = N_Assignment_Statement then
4852 -- Copy name and expression fields in usual manner
4855 Copy_Generic_Node (Name (N), New_N, Instantiating));
4857 Set_Expression (New_N,
4858 Copy_Generic_Node (Expression (N), New_N, Instantiating));
4860 if Instantiating then
4861 Set_Assignment_OK (Name (New_N), True);
4864 elsif Nkind (N) = N_Aggregate
4865 or else Nkind (N) = N_Extension_Aggregate
4868 if not Instantiating then
4869 Set_Associated_Node (N, New_N);
4872 if Present (Get_Associated_Node (N))
4873 and then Nkind (Get_Associated_Node (N)) = Nkind (N)
4875 -- In the generic the aggregate has some composite type. If at
4876 -- the point of instantiation the type has a private view,
4877 -- install the full view (and that of its ancestors, if any).
4880 T : Entity_Id := (Etype (Get_Associated_Node (New_N)));
4885 and then Is_Private_Type (T)
4891 and then Is_Tagged_Type (T)
4892 and then Is_Derived_Type (T)
4894 Rt := Root_Type (T);
4899 if Is_Private_Type (T) then
4910 -- Do not copy the associated node, which points to
4911 -- the generic copy of the aggregate.
4914 use Atree.Unchecked_Access;
4915 -- This code section is part of the implementation of an untyped
4916 -- tree traversal, so it needs direct access to node fields.
4919 Set_Field1 (New_N, Copy_Generic_Descendant (Field1 (N)));
4920 Set_Field2 (New_N, Copy_Generic_Descendant (Field2 (N)));
4921 Set_Field3 (New_N, Copy_Generic_Descendant (Field3 (N)));
4922 Set_Field5 (New_N, Copy_Generic_Descendant (Field5 (N)));
4925 -- Allocators do not have an identifier denoting the access type,
4926 -- so we must locate it through the expression to check whether
4927 -- the views are consistent.
4929 elsif Nkind (N) = N_Allocator
4930 and then Nkind (Expression (N)) = N_Qualified_Expression
4931 and then Is_Entity_Name (Subtype_Mark (Expression (N)))
4932 and then Instantiating
4935 T : constant Node_Id :=
4936 Get_Associated_Node (Subtype_Mark (Expression (N)));
4941 -- Retrieve the allocator node in the generic copy.
4943 Acc_T := Etype (Parent (Parent (T)));
4945 and then Is_Private_Type (Acc_T)
4947 Switch_View (Acc_T);
4954 -- For a proper body, we must catch the case of a proper body that
4955 -- replaces a stub. This represents the point at which a separate
4956 -- compilation unit, and hence template file, may be referenced, so
4957 -- we must make a new source instantiation entry for the template
4958 -- of the subunit, and ensure that all nodes in the subunit are
4959 -- adjusted using this new source instantiation entry.
4961 elsif Nkind (N) in N_Proper_Body then
4963 Save_Adjustment : constant Sloc_Adjustment := S_Adjustment;
4966 if Instantiating and then Was_Originally_Stub (N) then
4967 Create_Instantiation_Source
4968 (Instantiation_Node,
4969 Defining_Entity (N),
4974 -- Now copy the fields of the proper body, using the new
4975 -- adjustment factor if one was needed as per test above.
4979 -- Restore the original adjustment factor in case changed
4981 S_Adjustment := Save_Adjustment;
4984 -- Don't copy Ident or Comment pragmas, since the comment belongs
4985 -- to the generic unit, not to the instantiating unit.
4987 elsif Nkind (N) = N_Pragma
4988 and then Instantiating
4991 Prag_Id : constant Pragma_Id := Get_Pragma_Id (Chars (N));
4994 if Prag_Id = Pragma_Ident
4995 or else Prag_Id = Pragma_Comment
4997 New_N := Make_Null_Statement (Sloc (N));
5004 elsif Nkind (N) = N_Integer_Literal
5005 or else Nkind (N) = N_Real_Literal
5007 -- No descendant fields need traversing
5011 -- For the remaining nodes, copy recursively their descendants
5017 and then Nkind (N) = N_Subprogram_Body
5019 Set_Generic_Parent (Specification (New_N), N);
5024 end Copy_Generic_Node;
5026 ----------------------------
5027 -- Denotes_Formal_Package --
5028 ----------------------------
5030 function Denotes_Formal_Package (Pack : Entity_Id) return Boolean is
5031 Par : constant Entity_Id := Current_Instantiated_Parent.Act_Id;
5032 Scop : constant Entity_Id := Scope (Pack);
5036 if Ekind (Scop) = E_Generic_Package
5037 or else Nkind (Unit_Declaration_Node (Scop)) =
5038 N_Generic_Subprogram_Declaration
5042 elsif Nkind (Parent (Pack)) = N_Formal_Package_Declaration then
5049 -- Check whether this package is associated with a formal
5050 -- package of the enclosing instantiation. Iterate over the
5051 -- list of renamings.
5053 E := First_Entity (Par);
5054 while Present (E) loop
5055 if Ekind (E) /= E_Package
5056 or else Nkind (Parent (E)) /= N_Package_Renaming_Declaration
5059 elsif Renamed_Object (E) = Par then
5062 elsif Renamed_Object (E) = Pack then
5071 end Denotes_Formal_Package;
5077 procedure End_Generic is
5079 -- ??? More things could be factored out in this
5080 -- routine. Should probably be done at a later stage.
5082 Inside_A_Generic := Generic_Flags.Table (Generic_Flags.Last);
5083 Generic_Flags.Decrement_Last;
5085 Expander_Mode_Restore;
5088 ----------------------
5089 -- Find_Actual_Type --
5090 ----------------------
5092 function Find_Actual_Type
5094 Gen_Scope : Entity_Id)
5100 if not Is_Child_Unit (Gen_Scope) then
5101 return Get_Instance_Of (Typ);
5103 elsif not Is_Generic_Type (Typ)
5104 or else Scope (Typ) = Gen_Scope
5106 return Get_Instance_Of (Typ);
5109 T := Current_Entity (Typ);
5110 while Present (T) loop
5111 if In_Open_Scopes (Scope (T)) then
5120 end Find_Actual_Type;
5122 ----------------------------
5123 -- Freeze_Subprogram_Body --
5124 ----------------------------
5126 procedure Freeze_Subprogram_Body
5127 (Inst_Node : Node_Id;
5129 Pack_Id : Entity_Id)
5132 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
5133 Par : constant Entity_Id := Scope (Gen_Unit);
5138 function Earlier (N1, N2 : Node_Id) return Boolean;
5139 -- Yields True if N1 and N2 appear in the same compilation unit,
5140 -- ignoring subunits, and if N1 is to the left of N2 in a left-to-right
5141 -- traversal of the tree for the unit.
5143 function Enclosing_Body (N : Node_Id) return Node_Id;
5144 -- Find innermost package body that encloses the given node, and which
5145 -- is not a compilation unit. Freeze nodes for the instance, or for its
5146 -- enclosing body, may be inserted after the enclosing_body of the
5149 function Package_Freeze_Node (B : Node_Id) return Node_Id;
5150 -- Find entity for given package body, and locate or create a freeze
5153 function True_Parent (N : Node_Id) return Node_Id;
5154 -- For a subunit, return parent of corresponding stub.
5160 function Earlier (N1, N2 : Node_Id) return Boolean is
5166 procedure Find_Depth (P : in out Node_Id; D : in out Integer);
5167 -- Find distance from given node to enclosing compilation unit.
5173 procedure Find_Depth (P : in out Node_Id; D : in out Integer) is
5176 and then Nkind (P) /= N_Compilation_Unit
5178 P := True_Parent (P);
5183 -- Start of procesing for Earlier
5186 Find_Depth (P1, D1);
5187 Find_Depth (P2, D2);
5197 P1 := True_Parent (P1);
5202 P2 := True_Parent (P2);
5206 -- At this point P1 and P2 are at the same distance from the root.
5207 -- We examine their parents until we find a common declarative
5208 -- list, at which point we can establish their relative placement
5209 -- by comparing their ultimate slocs. If we reach the root,
5210 -- N1 and N2 do not descend from the same declarative list (e.g.
5211 -- one is nested in the declarative part and the other is in a block
5212 -- in the statement part) and the earlier one is already frozen.
5214 while not Is_List_Member (P1)
5215 or else not Is_List_Member (P2)
5216 or else List_Containing (P1) /= List_Containing (P2)
5218 P1 := True_Parent (P1);
5219 P2 := True_Parent (P2);
5221 if Nkind (Parent (P1)) = N_Subunit then
5222 P1 := Corresponding_Stub (Parent (P1));
5225 if Nkind (Parent (P2)) = N_Subunit then
5226 P2 := Corresponding_Stub (Parent (P2));
5235 Top_Level_Location (Sloc (P1)) < Top_Level_Location (Sloc (P2));
5238 --------------------
5239 -- Enclosing_Body --
5240 --------------------
5242 function Enclosing_Body (N : Node_Id) return Node_Id is
5243 P : Node_Id := Parent (N);
5247 and then Nkind (Parent (P)) /= N_Compilation_Unit
5249 if Nkind (P) = N_Package_Body then
5251 if Nkind (Parent (P)) = N_Subunit then
5252 return Corresponding_Stub (Parent (P));
5258 P := True_Parent (P);
5264 -------------------------
5265 -- Package_Freeze_Node --
5266 -------------------------
5268 function Package_Freeze_Node (B : Node_Id) return Node_Id is
5272 if Nkind (B) = N_Package_Body then
5273 Id := Corresponding_Spec (B);
5275 else pragma Assert (Nkind (B) = N_Package_Body_Stub);
5276 Id := Corresponding_Spec (Proper_Body (Unit (Library_Unit (B))));
5279 Ensure_Freeze_Node (Id);
5280 return Freeze_Node (Id);
5281 end Package_Freeze_Node;
5287 function True_Parent (N : Node_Id) return Node_Id is
5289 if Nkind (Parent (N)) = N_Subunit then
5290 return Parent (Corresponding_Stub (Parent (N)));
5296 -- Start of processing of Freeze_Subprogram_Body
5299 -- If the instance and the generic body appear within the same
5300 -- unit, and the instance preceeds the generic, the freeze node for
5301 -- the instance must appear after that of the generic. If the generic
5302 -- is nested within another instance I2, then current instance must
5303 -- be frozen after I2. In both cases, the freeze nodes are those of
5304 -- enclosing packages. Otherwise, the freeze node is placed at the end
5305 -- of the current declarative part.
5307 Enc_G := Enclosing_Body (Gen_Body);
5308 Enc_I := Enclosing_Body (Inst_Node);
5309 Ensure_Freeze_Node (Pack_Id);
5310 F_Node := Freeze_Node (Pack_Id);
5312 if Is_Generic_Instance (Par)
5313 and then Present (Freeze_Node (Par))
5315 In_Same_Declarative_Part (Freeze_Node (Par), Inst_Node)
5317 if ABE_Is_Certain (Get_Package_Instantiation_Node (Par)) then
5319 -- The parent was a premature instantiation. Insert freeze
5320 -- node at the end the current declarative part.
5322 Insert_After_Last_Decl (Inst_Node, F_Node);
5325 Insert_After (Freeze_Node (Par), F_Node);
5328 -- The body enclosing the instance should be frozen after the body
5329 -- that includes the generic, because the body of the instance may
5330 -- make references to entities therein. If the two are not in the
5331 -- same declarative part, or if the one enclosing the instance is
5332 -- frozen already, freeze the instance at the end of the current
5333 -- declarative part.
5335 elsif Is_Generic_Instance (Par)
5336 and then Present (Freeze_Node (Par))
5337 and then Present (Enc_I)
5339 if In_Same_Declarative_Part (Freeze_Node (Par), Enc_I)
5341 (Nkind (Enc_I) = N_Package_Body
5343 In_Same_Declarative_Part (Freeze_Node (Par), Parent (Enc_I)))
5345 -- The enclosing package may contain several instances. Rather
5346 -- than computing the earliest point at which to insert its
5347 -- freeze node, we place it at the end of the declarative part
5348 -- of the parent of the generic.
5350 Insert_After_Last_Decl
5351 (Freeze_Node (Par), Package_Freeze_Node (Enc_I));
5354 Insert_After_Last_Decl (Inst_Node, F_Node);
5356 elsif Present (Enc_G)
5357 and then Present (Enc_I)
5358 and then Enc_G /= Enc_I
5359 and then Earlier (Inst_Node, Gen_Body)
5361 if Nkind (Enc_G) = N_Package_Body then
5362 E_G_Id := Corresponding_Spec (Enc_G);
5363 else pragma Assert (Nkind (Enc_G) = N_Package_Body_Stub);
5365 Corresponding_Spec (Proper_Body (Unit (Library_Unit (Enc_G))));
5368 -- Freeze package that encloses instance, and place node after
5369 -- package that encloses generic. If enclosing package is already
5370 -- frozen we have to assume it is at the proper place. This may
5371 -- be a potential ABE that requires dynamic checking.
5373 Insert_After_Last_Decl (Enc_G, Package_Freeze_Node (Enc_I));
5375 -- Freeze enclosing subunit before instance
5377 Ensure_Freeze_Node (E_G_Id);
5379 if not Is_List_Member (Freeze_Node (E_G_Id)) then
5380 Insert_After (Enc_G, Freeze_Node (E_G_Id));
5383 Insert_After_Last_Decl (Inst_Node, F_Node);
5386 -- If none of the above, insert freeze node at the end of the
5387 -- current declarative part.
5389 Insert_After_Last_Decl (Inst_Node, F_Node);
5391 end Freeze_Subprogram_Body;
5397 function Get_Gen_Id (E : Assoc_Ptr) return Entity_Id is
5399 return Generic_Renamings.Table (E).Gen_Id;
5402 ---------------------
5403 -- Get_Instance_Of --
5404 ---------------------
5406 function Get_Instance_Of (A : Entity_Id) return Entity_Id is
5407 Res : constant Assoc_Ptr := Generic_Renamings_HTable.Get (A);
5410 if Res /= Assoc_Null then
5411 return Generic_Renamings.Table (Res).Act_Id;
5413 -- On exit, entity is not instantiated: not a generic parameter,
5414 -- or else parameter of an inner generic unit.
5418 end Get_Instance_Of;
5420 ------------------------------------
5421 -- Get_Package_Instantiation_Node --
5422 ------------------------------------
5424 function Get_Package_Instantiation_Node (A : Entity_Id) return Node_Id is
5425 Decl : Node_Id := Unit_Declaration_Node (A);
5429 -- If the instantiation is a compilation unit that does not need a
5430 -- body then the instantiation node has been rewritten as a package
5431 -- declaration for the instance, and we return the original node.
5433 -- If it is a compilation unit and the instance node has not been
5434 -- rewritten, then it is still the unit of the compilation. Finally,
5435 -- if a body is present, this is a parent of the main unit whose body
5436 -- has been compiled for inlining purposes, and the instantiation node
5437 -- has been rewritten with the instance body.
5439 -- Otherwise the instantiation node appears after the declaration.
5440 -- If the entity is a formal package, the declaration may have been
5441 -- rewritten as a generic declaration (in the case of a formal with a
5442 -- box) or left as a formal package declaration if it has actuals, and
5443 -- is found with a forward search.
5445 if Nkind (Parent (Decl)) = N_Compilation_Unit then
5446 if Nkind (Decl) = N_Package_Declaration
5447 and then Present (Corresponding_Body (Decl))
5449 Decl := Unit_Declaration_Node (Corresponding_Body (Decl));
5452 if Nkind (Original_Node (Decl)) = N_Package_Instantiation then
5453 return Original_Node (Decl);
5455 return Unit (Parent (Decl));
5458 elsif Nkind (Decl) = N_Generic_Package_Declaration
5459 and then Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration
5461 return Original_Node (Decl);
5464 Inst := Next (Decl);
5465 while Nkind (Inst) /= N_Package_Instantiation
5466 and then Nkind (Inst) /= N_Formal_Package_Declaration
5473 end Get_Package_Instantiation_Node;
5475 ------------------------
5476 -- Has_Been_Exchanged --
5477 ------------------------
5479 function Has_Been_Exchanged (E : Entity_Id) return Boolean is
5480 Next : Elmt_Id := First_Elmt (Exchanged_Views);
5483 while Present (Next) loop
5484 if Full_View (Node (Next)) = E then
5492 end Has_Been_Exchanged;
5498 function Hash (F : Entity_Id) return HTable_Range is
5500 return HTable_Range (F mod HTable_Size);
5503 ------------------------
5504 -- Hide_Current_Scope --
5505 ------------------------
5507 procedure Hide_Current_Scope is
5508 C : constant Entity_Id := Current_Scope;
5512 Set_Is_Hidden_Open_Scope (C);
5513 E := First_Entity (C);
5515 while Present (E) loop
5516 if Is_Immediately_Visible (E) then
5517 Set_Is_Immediately_Visible (E, False);
5518 Append_Elmt (E, Hidden_Entities);
5524 -- Make the scope name invisible as well. This is necessary, but
5525 -- might conflict with calls to Rtsfind later on, in case the scope
5526 -- is a predefined one. There is no clean solution to this problem, so
5527 -- for now we depend on the user not redefining Standard itself in one
5528 -- of the parent units.
5530 if Is_Immediately_Visible (C)
5531 and then C /= Standard_Standard
5533 Set_Is_Immediately_Visible (C, False);
5534 Append_Elmt (C, Hidden_Entities);
5537 end Hide_Current_Scope;
5543 procedure Init_Env is
5544 Saved : Instance_Env;
5547 Saved.Ada_83 := Ada_83;
5548 Saved.Instantiated_Parent := Current_Instantiated_Parent;
5549 Saved.Exchanged_Views := Exchanged_Views;
5550 Saved.Hidden_Entities := Hidden_Entities;
5551 Saved.Current_Sem_Unit := Current_Sem_Unit;
5552 Instance_Envs.Increment_Last;
5553 Instance_Envs.Table (Instance_Envs.Last) := Saved;
5555 Exchanged_Views := New_Elmt_List;
5556 Hidden_Entities := New_Elmt_List;
5558 -- Make dummy entry for Instantiated parent. If generic unit is
5559 -- legal, this is set properly in Set_Instance_Env.
5561 Current_Instantiated_Parent :=
5562 (Current_Scope, Current_Scope, Assoc_Null);
5565 ------------------------------
5566 -- In_Same_Declarative_Part --
5567 ------------------------------
5569 function In_Same_Declarative_Part
5574 Decls : constant Node_Id := Parent (F_Node);
5575 Nod : Node_Id := Parent (Inst);
5578 while Present (Nod) loop
5582 elsif Nkind (Nod) = N_Subprogram_Body
5583 or else Nkind (Nod) = N_Package_Body
5584 or else Nkind (Nod) = N_Task_Body
5585 or else Nkind (Nod) = N_Protected_Body
5586 or else Nkind (Nod) = N_Block_Statement
5590 elsif Nkind (Nod) = N_Subunit then
5591 Nod := Corresponding_Stub (Nod);
5593 elsif Nkind (Nod) = N_Compilation_Unit then
5596 Nod := Parent (Nod);
5601 end In_Same_Declarative_Part;
5603 ---------------------
5604 -- Inherit_Context --
5605 ---------------------
5607 procedure Inherit_Context (Gen_Decl : Node_Id; Inst : Node_Id) is
5608 Current_Context : List_Id;
5609 Current_Unit : Node_Id;
5614 if Nkind (Parent (Gen_Decl)) = N_Compilation_Unit then
5616 -- The inherited context is attached to the enclosing compilation
5617 -- unit. This is either the main unit, or the declaration for the
5618 -- main unit (in case the instantation appears within the package
5619 -- declaration and the main unit is its body).
5621 Current_Unit := Parent (Inst);
5622 while Present (Current_Unit)
5623 and then Nkind (Current_Unit) /= N_Compilation_Unit
5625 Current_Unit := Parent (Current_Unit);
5628 Current_Context := Context_Items (Current_Unit);
5630 Item := First (Context_Items (Parent (Gen_Decl)));
5631 while Present (Item) loop
5632 if Nkind (Item) = N_With_Clause then
5633 New_I := New_Copy (Item);
5634 Set_Implicit_With (New_I, True);
5635 Append (New_I, Current_Context);
5641 end Inherit_Context;
5647 procedure Initialize is
5649 Generic_Renamings.Init;
5652 Generic_Renamings_HTable.Reset;
5653 Circularity_Detected := False;
5654 Exchanged_Views := No_Elist;
5655 Hidden_Entities := No_Elist;
5658 ----------------------------
5659 -- Insert_After_Last_Decl --
5660 ----------------------------
5662 procedure Insert_After_Last_Decl (N : Node_Id; F_Node : Node_Id) is
5663 L : List_Id := List_Containing (N);
5664 P : constant Node_Id := Parent (L);
5667 if not Is_List_Member (F_Node) then
5668 if Nkind (P) = N_Package_Specification
5669 and then L = Visible_Declarations (P)
5670 and then Present (Private_Declarations (P))
5671 and then not Is_Empty_List (Private_Declarations (P))
5673 L := Private_Declarations (P);
5676 Insert_After (Last (L), F_Node);
5678 end Insert_After_Last_Decl;
5684 procedure Install_Body
5685 (Act_Body : Node_Id;
5690 Act_Id : constant Entity_Id := Corresponding_Spec (Act_Body);
5691 Act_Unit : constant Node_Id := Unit (Cunit (Get_Source_Unit (N)));
5692 Gen_Id : constant Entity_Id := Corresponding_Spec (Gen_Body);
5693 Par : constant Entity_Id := Scope (Gen_Id);
5694 Gen_Unit : constant Node_Id :=
5695 Unit (Cunit (Get_Source_Unit (Gen_Decl)));
5696 Orig_Body : Node_Id := Gen_Body;
5698 Body_Unit : Node_Id;
5700 Must_Delay : Boolean;
5702 function Enclosing_Subp (Id : Entity_Id) return Entity_Id;
5703 -- Find subprogram (if any) that encloses instance and/or generic body.
5705 function True_Sloc (N : Node_Id) return Source_Ptr;
5706 -- If the instance is nested inside a generic unit, the Sloc of the
5707 -- instance indicates the place of the original definition, not the
5708 -- point of the current enclosing instance. Pending a better usage of
5709 -- Slocs to indicate instantiation places, we determine the place of
5710 -- origin of a node by finding the maximum sloc of any ancestor node.
5711 -- Why is this not equivalent fo Top_Level_Location ???
5713 function Enclosing_Subp (Id : Entity_Id) return Entity_Id is
5714 Scop : Entity_Id := Scope (Id);
5717 while Scop /= Standard_Standard
5718 and then not Is_Overloadable (Scop)
5720 Scop := Scope (Scop);
5726 function True_Sloc (N : Node_Id) return Source_Ptr is
5733 while Present (N1) and then N1 /= Act_Unit loop
5734 if Sloc (N1) > Res then
5744 -- Start of processing for Install_Body
5747 -- If the body is a subunit, the freeze point is the corresponding
5748 -- stub in the current compilation, not the subunit itself.
5750 if Nkind (Parent (Gen_Body)) = N_Subunit then
5751 Orig_Body := Corresponding_Stub (Parent (Gen_Body));
5753 Orig_Body := Gen_Body;
5756 Body_Unit := Unit (Cunit (Get_Source_Unit (Orig_Body)));
5758 -- If the instantiation and the generic definition appear in the
5759 -- same package declaration, this is an early instantiation.
5760 -- If they appear in the same declarative part, it is an early
5761 -- instantiation only if the generic body appears textually later,
5762 -- and the generic body is also in the main unit.
5764 -- If instance is nested within a subprogram, and the generic body is
5765 -- not, the instance is delayed because the enclosing body is. If
5766 -- instance and body are within the same scope, or the same sub-
5767 -- program body, indicate explicitly that the instance is delayed.
5770 (Gen_Unit = Act_Unit
5771 and then ((Nkind (Gen_Unit) = N_Package_Declaration)
5772 or else Nkind (Gen_Unit) = N_Generic_Package_Declaration
5773 or else (Gen_Unit = Body_Unit
5774 and then True_Sloc (N) < Sloc (Orig_Body)))
5775 and then Is_In_Main_Unit (Gen_Unit)
5776 and then (Scope (Act_Id) = Scope (Gen_Id)
5778 Enclosing_Subp (Act_Id) = Enclosing_Subp (Gen_Id)));
5780 -- If this is an early instantiation, the freeze node is placed after
5781 -- the generic body. Otherwise, if the generic appears in an instance,
5782 -- we cannot freeze the current instance until the outer one is frozen.
5783 -- This is only relevant if the current instance is nested within some
5784 -- inner scope not itself within the outer instance. If this scope is
5785 -- a package body in the same declarative part as the outer instance,
5786 -- then that body needs to be frozen after the outer instance. Finally,
5787 -- if no delay is needed, we place the freeze node at the end of the
5788 -- current declarative part.
5790 if Expander_Active then
5791 Ensure_Freeze_Node (Act_Id);
5792 F_Node := Freeze_Node (Act_Id);
5795 Insert_After (Orig_Body, F_Node);
5797 elsif Is_Generic_Instance (Par)
5798 and then Present (Freeze_Node (Par))
5799 and then Scope (Act_Id) /= Par
5801 -- Freeze instance of inner generic after instance of enclosing
5804 if In_Same_Declarative_Part (Freeze_Node (Par), N) then
5805 Insert_After (Freeze_Node (Par), F_Node);
5807 -- Freeze package enclosing instance of inner generic after
5808 -- instance of enclosing generic.
5810 elsif Nkind (Parent (N)) = N_Package_Body
5811 and then In_Same_Declarative_Part (Freeze_Node (Par), Parent (N))
5815 Enclosing : constant Entity_Id :=
5816 Corresponding_Spec (Parent (N));
5819 Insert_After_Last_Decl (N, F_Node);
5820 Ensure_Freeze_Node (Enclosing);
5822 if not Is_List_Member (Freeze_Node (Enclosing)) then
5823 Insert_After (Freeze_Node (Par), Freeze_Node (Enclosing));
5828 Insert_After_Last_Decl (N, F_Node);
5832 Insert_After_Last_Decl (N, F_Node);
5836 Set_Is_Frozen (Act_Id);
5837 Insert_Before (N, Act_Body);
5838 Mark_Rewrite_Insertion (Act_Body);
5841 --------------------
5842 -- Install_Parent --
5843 --------------------
5845 procedure Install_Parent (P : Entity_Id; In_Body : Boolean := False) is
5846 Ancestors : constant Elist_Id := New_Elmt_List;
5847 S : constant Entity_Id := Current_Scope;
5848 Inst_Par : Entity_Id;
5849 First_Par : Entity_Id;
5850 Inst_Node : Node_Id;
5851 Gen_Par : Entity_Id;
5852 First_Gen : Entity_Id;
5855 procedure Install_Formal_Packages (Par : Entity_Id);
5856 -- If any of the formals of the parent are formal packages with box,
5857 -- their formal parts are visible in the parent and thus in the child
5858 -- unit as well. Analogous to what is done in Check_Generic_Actuals
5859 -- for the unit itself.
5861 procedure Install_Noninstance_Specs (Par : Entity_Id);
5862 -- Install the scopes of noninstance parent units ending with Par.
5864 procedure Install_Spec (Par : Entity_Id);
5865 -- The child unit is within the declarative part of the parent, so
5866 -- the declarations within the parent are immediately visible.
5868 -----------------------------
5869 -- Install_Formal_Packages --
5870 -----------------------------
5872 procedure Install_Formal_Packages (Par : Entity_Id) is
5876 E := First_Entity (Par);
5878 while Present (E) loop
5880 if Ekind (E) = E_Package
5881 and then Nkind (Parent (E)) = N_Package_Renaming_Declaration
5883 -- If this is the renaming for the parent instance, done.
5885 if Renamed_Object (E) = Par then
5888 -- The visibility of a formal of an enclosing generic is
5891 elsif Denotes_Formal_Package (E) then
5894 elsif Present (Associated_Formal_Package (E))
5895 and then Box_Present (Parent (Associated_Formal_Package (E)))
5897 Check_Generic_Actuals (Renamed_Object (E), True);
5898 Set_Is_Hidden (E, False);
5904 end Install_Formal_Packages;
5906 -------------------------------
5907 -- Install_Noninstance_Specs --
5908 -------------------------------
5910 procedure Install_Noninstance_Specs (Par : Entity_Id) is
5913 and then Par /= Standard_Standard
5914 and then not In_Open_Scopes (Par)
5916 Install_Noninstance_Specs (Scope (Par));
5919 end Install_Noninstance_Specs;
5925 procedure Install_Spec (Par : Entity_Id) is
5926 Spec : constant Node_Id :=
5927 Specification (Unit_Declaration_Node (Par));
5931 Set_Is_Immediately_Visible (Par);
5932 Install_Visible_Declarations (Par);
5933 Install_Private_Declarations (Par);
5934 Set_Use (Visible_Declarations (Spec));
5935 Set_Use (Private_Declarations (Spec));
5938 -- Start of processing for Install_Parent
5941 -- We need to install the parent instance to compile the instantiation
5942 -- of the child, but the child instance must appear in the current
5943 -- scope. Given that we cannot place the parent above the current
5944 -- scope in the scope stack, we duplicate the current scope and unstack
5945 -- both after the instantiation is complete.
5947 -- If the parent is itself the instantiation of a child unit, we must
5948 -- also stack the instantiation of its parent, and so on. Each such
5949 -- ancestor is the prefix of the name in a prior instantiation.
5951 -- If this is a nested instance, the parent unit itself resolves to
5952 -- a renaming of the parent instance, whose declaration we need.
5954 -- Finally, the parent may be a generic (not an instance) when the
5955 -- child unit appears as a formal package.
5959 if Present (Renamed_Entity (Inst_Par)) then
5960 Inst_Par := Renamed_Entity (Inst_Par);
5963 First_Par := Inst_Par;
5966 Generic_Parent (Specification (Unit_Declaration_Node (Inst_Par)));
5968 First_Gen := Gen_Par;
5970 while Present (Gen_Par)
5971 and then Is_Child_Unit (Gen_Par)
5973 -- Load grandparent instance as well
5975 Inst_Node := Get_Package_Instantiation_Node (Inst_Par);
5977 if Nkind (Name (Inst_Node)) = N_Expanded_Name then
5978 Inst_Par := Entity (Prefix (Name (Inst_Node)));
5980 if Present (Renamed_Entity (Inst_Par)) then
5981 Inst_Par := Renamed_Entity (Inst_Par);
5986 (Specification (Unit_Declaration_Node (Inst_Par)));
5988 if Present (Gen_Par) then
5989 Prepend_Elmt (Inst_Par, Ancestors);
5992 -- Parent is not the name of an instantiation
5994 Install_Noninstance_Specs (Inst_Par);
6006 if Present (First_Gen) then
6007 Append_Elmt (First_Par, Ancestors);
6010 Install_Noninstance_Specs (First_Par);
6013 if not Is_Empty_Elmt_List (Ancestors) then
6014 Elmt := First_Elmt (Ancestors);
6016 while Present (Elmt) loop
6017 Install_Spec (Node (Elmt));
6018 Install_Formal_Packages (Node (Elmt));
6029 --------------------------------
6030 -- Instantiate_Formal_Package --
6031 --------------------------------
6033 function Instantiate_Formal_Package
6036 Analyzed_Formal : Node_Id)
6039 Loc : constant Source_Ptr := Sloc (Actual);
6040 Actual_Pack : Entity_Id;
6041 Formal_Pack : Entity_Id;
6042 Gen_Parent : Entity_Id;
6045 Parent_Spec : Node_Id;
6047 procedure Find_Matching_Actual
6049 Act : in out Entity_Id);
6050 -- We need to associate each formal entity in the formal package
6051 -- with the corresponding entity in the actual package. The actual
6052 -- package has been analyzed and possibly expanded, and as a result
6053 -- there is no one-to-one correspondence between the two lists (for
6054 -- example, the actual may include subtypes, itypes, and inherited
6055 -- primitive operations, interspersed among the renaming declarations
6056 -- for the actuals) . We retrieve the corresponding actual by name
6057 -- because each actual has the same name as the formal, and they do
6058 -- appear in the same order.
6060 function Formal_Entity
6062 Act_Ent : Entity_Id)
6064 -- Returns the entity associated with the given formal F. In the
6065 -- case where F is a formal package, this function will iterate
6066 -- through all of F's formals and enter map associations from the
6067 -- actuals occurring in the formal package's corresponding actual
6068 -- package (obtained via Act_Ent) to the formal package's formal
6069 -- parameters. This function is called recursively for arbitrary
6070 -- levels of formal packages.
6072 function Is_Instance_Of
6073 (Act_Spec : Entity_Id;
6074 Gen_Anc : Entity_Id)
6076 -- The actual can be an instantiation of a generic within another
6077 -- instance, in which case there is no direct link from it to the
6078 -- original generic ancestor. In that case, we recognize that the
6079 -- ultimate ancestor is the same by examining names and scopes.
6081 procedure Map_Entities (Form : Entity_Id; Act : Entity_Id);
6082 -- Within the generic part, entities in the formal package are
6083 -- visible. To validate subsequent type declarations, indicate
6084 -- the correspondence betwen the entities in the analyzed formal,
6085 -- and the entities in the actual package. There are three packages
6086 -- involved in the instantiation of a formal package: the parent
6087 -- generic P1 which appears in the generic declaration, the fake
6088 -- instantiation P2 which appears in the analyzed generic, and whose
6089 -- visible entities may be used in subsequent formals, and the actual
6090 -- P3 in the instance. To validate subsequent formals, me indicate
6091 -- that the entities in P2 are mapped into those of P3. The mapping of
6092 -- entities has to be done recursively for nested packages.
6094 --------------------------
6095 -- Find_Matching_Actual --
6096 --------------------------
6098 procedure Find_Matching_Actual
6100 Act : in out Entity_Id)
6102 Formal_Ent : Entity_Id;
6105 case Nkind (Original_Node (F)) is
6106 when N_Formal_Object_Declaration |
6107 N_Formal_Type_Declaration =>
6108 Formal_Ent := Defining_Identifier (F);
6110 while Chars (Act) /= Chars (Formal_Ent) loop
6114 when N_Formal_Subprogram_Declaration |
6115 N_Formal_Package_Declaration |
6116 N_Package_Declaration |
6117 N_Generic_Package_Declaration =>
6118 Formal_Ent := Defining_Entity (F);
6120 while Chars (Act) /= Chars (Formal_Ent) loop
6126 pragma Assert (False);
6128 end Find_Matching_Actual;
6134 function Formal_Entity
6136 Act_Ent : Entity_Id)
6139 Orig_Node : Node_Id := F;
6140 Act_Pkg : Entity_Id;
6143 case Nkind (Original_Node (F)) is
6144 when N_Formal_Object_Declaration =>
6145 return Defining_Identifier (F);
6147 when N_Formal_Type_Declaration =>
6148 return Defining_Identifier (F);
6150 when N_Formal_Subprogram_Declaration =>
6151 return Defining_Unit_Name (Specification (F));
6153 when N_Package_Declaration =>
6154 return Defining_Unit_Name (Specification (F));
6156 when N_Formal_Package_Declaration |
6157 N_Generic_Package_Declaration =>
6159 if Nkind (F) = N_Generic_Package_Declaration then
6160 Orig_Node := Original_Node (F);
6165 -- Find matching actual package, skipping over itypes and
6166 -- other entities generated when analyzing the formal. We
6167 -- know that if the instantiation is legal then there is
6168 -- a matching package for the formal.
6170 while Ekind (Act_Pkg) /= E_Package loop
6171 Act_Pkg := Next_Entity (Act_Pkg);
6175 Actual_Ent : Entity_Id := First_Entity (Act_Pkg);
6176 Formal_Node : Node_Id;
6177 Formal_Ent : Entity_Id;
6179 Gen_Decl : constant Node_Id :=
6180 Unit_Declaration_Node
6181 (Entity (Name (Orig_Node)));
6183 Formals : constant List_Id :=
6184 Generic_Formal_Declarations (Gen_Decl);
6187 if Present (Formals) then
6188 Formal_Node := First_Non_Pragma (Formals);
6190 Formal_Node := Empty;
6193 while Present (Actual_Ent)
6194 and then Present (Formal_Node)
6195 and then Actual_Ent /= First_Private_Entity (Act_Ent)
6197 -- ??? Are the following calls also needed here:
6199 -- Set_Is_Hidden (Actual_Ent, False);
6200 -- Set_Is_Potentially_Use_Visible
6201 -- (Actual_Ent, In_Use (Act_Ent));
6203 Formal_Ent := Formal_Entity (Formal_Node, Actual_Ent);
6204 if Present (Formal_Ent) then
6205 Set_Instance_Of (Formal_Ent, Actual_Ent);
6207 Next_Non_Pragma (Formal_Node);
6209 Next_Entity (Actual_Ent);
6213 return Defining_Identifier (Orig_Node);
6215 when N_Use_Package_Clause =>
6218 when N_Use_Type_Clause =>
6221 -- We return Empty for all other encountered forms of
6222 -- declarations because there are some cases of nonformal
6223 -- sorts of declaration that can show up (e.g., when array
6224 -- formals are present). Since it's not clear what kinds
6225 -- can appear among the formals, we won't raise failure here.
6233 --------------------
6234 -- Is_Instance_Of --
6235 --------------------
6237 function Is_Instance_Of
6238 (Act_Spec : Entity_Id;
6239 Gen_Anc : Entity_Id)
6242 Gen_Par : Entity_Id := Generic_Parent (Act_Spec);
6245 if No (Gen_Par) then
6248 -- Simplest case: the generic parent of the actual is the formal.
6250 elsif Gen_Par = Gen_Anc then
6253 elsif Chars (Gen_Par) /= Chars (Gen_Anc) then
6256 -- The actual may be obtained through several instantiations. Its
6257 -- scope must itself be an instance of a generic declared in the
6258 -- same scope as the formal. Any other case is detected above.
6260 elsif not Is_Generic_Instance (Scope (Gen_Par)) then
6264 return Generic_Parent (Parent (Scope (Gen_Par))) = Scope (Gen_Anc);
6272 procedure Map_Entities (Form : Entity_Id; Act : Entity_Id) is
6277 Set_Instance_Of (Form, Act);
6279 -- Traverse formal and actual package to map the corresponding
6280 -- entities. We skip over internal entities that may be generated
6281 -- during semantic analysis, and find the matching entities by
6282 -- name, given that they must appear in the same order.
6284 E1 := First_Entity (Form);
6285 E2 := First_Entity (Act);
6287 and then E1 /= First_Private_Entity (Form)
6289 if not Is_Internal (E1)
6290 and then not Is_Class_Wide_Type (E1)
6291 and then Present (Parent (E1))
6294 and then Chars (E2) /= Chars (E1)
6302 Set_Instance_Of (E1, E2);
6305 and then Is_Tagged_Type (E2)
6308 (Class_Wide_Type (E1), Class_Wide_Type (E2));
6311 if Ekind (E1) = E_Package
6312 and then No (Renamed_Object (E1))
6314 Map_Entities (E1, E2);
6323 -- Start of processing for Instantiate_Formal_Package
6328 if not Is_Entity_Name (Actual)
6329 or else Ekind (Entity (Actual)) /= E_Package
6332 ("expect package instance to instantiate formal", Actual);
6333 Abandon_Instantiation (Actual);
6334 raise Program_Error;
6337 Actual_Pack := Entity (Actual);
6338 Set_Is_Instantiated (Actual_Pack);
6340 -- The actual may be a renamed package, or an outer generic
6341 -- formal package whose instantiation is converted into a renaming.
6343 if Present (Renamed_Object (Actual_Pack)) then
6344 Actual_Pack := Renamed_Object (Actual_Pack);
6347 if Nkind (Analyzed_Formal) = N_Formal_Package_Declaration then
6348 Gen_Parent := Get_Instance_Of (Entity (Name (Analyzed_Formal)));
6349 Formal_Pack := Defining_Identifier (Analyzed_Formal);
6352 Generic_Parent (Specification (Analyzed_Formal));
6354 Defining_Unit_Name (Specification (Analyzed_Formal));
6357 if Nkind (Parent (Actual_Pack)) = N_Defining_Program_Unit_Name then
6358 Parent_Spec := Specification (Unit_Declaration_Node (Actual_Pack));
6360 Parent_Spec := Parent (Actual_Pack);
6363 if Gen_Parent = Any_Id then
6365 ("previous error in declaration of formal package", Actual);
6366 Abandon_Instantiation (Actual);
6369 Is_Instance_Of (Parent_Spec, Get_Instance_Of (Gen_Parent))
6375 ("actual parameter must be instance of&", Actual, Gen_Parent);
6376 Abandon_Instantiation (Actual);
6379 Set_Instance_Of (Defining_Identifier (Formal), Actual_Pack);
6380 Map_Entities (Formal_Pack, Actual_Pack);
6383 Make_Package_Renaming_Declaration (Loc,
6384 Defining_Unit_Name => New_Copy (Defining_Identifier (Formal)),
6385 Name => New_Reference_To (Actual_Pack, Loc));
6387 Set_Associated_Formal_Package (Defining_Unit_Name (Nod),
6388 Defining_Identifier (Formal));
6389 Decls := New_List (Nod);
6391 -- If the formal F has a box, then the generic declarations are
6392 -- visible in the generic G. In an instance of G, the corresponding
6393 -- entities in the actual for F (which are the actuals for the
6394 -- instantiation of the generic that F denotes) must also be made
6395 -- visible for analysis of the current instance. On exit from the
6396 -- current instance, those entities are made private again. If the
6397 -- actual is currently in use, these entities are also use-visible.
6399 -- The loop through the actual entities also steps through the
6400 -- formal entities and enters associations from formals to
6401 -- actuals into the renaming map. This is necessary to properly
6402 -- handle checking of actual parameter associations for later
6403 -- formals that depend on actuals declared in the formal package.
6405 if Box_Present (Formal) then
6407 Gen_Decl : constant Node_Id :=
6408 Unit_Declaration_Node (Gen_Parent);
6409 Formals : constant List_Id :=
6410 Generic_Formal_Declarations (Gen_Decl);
6411 Actual_Ent : Entity_Id;
6412 Formal_Node : Node_Id;
6413 Formal_Ent : Entity_Id;
6416 if Present (Formals) then
6417 Formal_Node := First_Non_Pragma (Formals);
6419 Formal_Node := Empty;
6422 Actual_Ent := First_Entity (Actual_Pack);
6424 while Present (Actual_Ent)
6425 and then Actual_Ent /= First_Private_Entity (Actual_Pack)
6427 Set_Is_Hidden (Actual_Ent, False);
6428 Set_Is_Potentially_Use_Visible
6429 (Actual_Ent, In_Use (Actual_Pack));
6431 if Present (Formal_Node) then
6432 Formal_Ent := Formal_Entity (Formal_Node, Actual_Ent);
6434 if Present (Formal_Ent) then
6435 Find_Matching_Actual (Formal_Node, Actual_Ent);
6436 Set_Instance_Of (Formal_Ent, Actual_Ent);
6439 Next_Non_Pragma (Formal_Node);
6442 -- No further formals to match.
6450 -- If the formal is not declared with a box, reanalyze it as
6451 -- an instantiation, to verify the matching rules of 12.7. The
6452 -- actual checks are performed after the generic associations
6457 I_Pack : constant Entity_Id :=
6458 Make_Defining_Identifier (Sloc (Actual),
6459 Chars => New_Internal_Name ('P'));
6462 Set_Is_Internal (I_Pack);
6465 Make_Package_Instantiation (Sloc (Actual),
6466 Defining_Unit_Name => I_Pack,
6467 Name => New_Occurrence_Of (Gen_Parent, Sloc (Actual)),
6468 Generic_Associations =>
6469 Generic_Associations (Formal)));
6475 end Instantiate_Formal_Package;
6477 -----------------------------------
6478 -- Instantiate_Formal_Subprogram --
6479 -----------------------------------
6481 function Instantiate_Formal_Subprogram
6484 Analyzed_Formal : Node_Id)
6487 Loc : Source_Ptr := Sloc (Instantiation_Node);
6488 Formal_Sub : constant Entity_Id :=
6489 Defining_Unit_Name (Specification (Formal));
6490 Analyzed_S : constant Entity_Id :=
6491 Defining_Unit_Name (Specification (Analyzed_Formal));
6492 Decl_Node : Node_Id;
6496 function From_Parent_Scope (Subp : Entity_Id) return Boolean;
6497 -- If the generic is a child unit, the parent has been installed
6498 -- on the scope stack, but a default subprogram cannot resolve to
6499 -- something on the parent because that parent is not really part
6500 -- of the visible context (it is there to resolve explicit local
6501 -- entities). If the default has resolved in this way, we remove
6502 -- the entity from immediate visibility and analyze the node again
6503 -- to emit an error message or find another visible candidate.
6505 procedure Valid_Actual_Subprogram (Act : Node_Id);
6506 -- Perform legality check and raise exception on failure.
6508 -----------------------
6509 -- From_Parent_Scope --
6510 -----------------------
6512 function From_Parent_Scope (Subp : Entity_Id) return Boolean is
6513 Gen_Scope : Node_Id := Scope (Analyzed_S);
6516 while Present (Gen_Scope)
6517 and then Is_Child_Unit (Gen_Scope)
6519 if Scope (Subp) = Scope (Gen_Scope) then
6523 Gen_Scope := Scope (Gen_Scope);
6527 end From_Parent_Scope;
6529 -----------------------------
6530 -- Valid_Actual_Subprogram --
6531 -----------------------------
6533 procedure Valid_Actual_Subprogram (Act : Node_Id) is
6534 Act_E : Entity_Id := Empty;
6537 if Is_Entity_Name (Act) then
6538 Act_E := Entity (Act);
6539 elsif Nkind (Act) = N_Selected_Component
6540 and then Is_Entity_Name (Selector_Name (Act))
6542 Act_E := Entity (Selector_Name (Act));
6545 if (Present (Act_E) and then Is_Overloadable (Act_E))
6546 or else Nkind (Act) = N_Attribute_Reference
6547 or else Nkind (Act) = N_Indexed_Component
6548 or else Nkind (Act) = N_Character_Literal
6549 or else Nkind (Act) = N_Explicit_Dereference
6555 ("expect subprogram or entry name in instantiation of&",
6556 Instantiation_Node, Formal_Sub);
6557 Abandon_Instantiation (Instantiation_Node);
6559 end Valid_Actual_Subprogram;
6561 -- Start of processing for Instantiate_Formal_Subprogram
6564 New_Spec := New_Copy_Tree (Specification (Formal));
6566 -- Create new entity for the actual (New_Copy_Tree does not).
6568 Set_Defining_Unit_Name
6569 (New_Spec, Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
6571 -- Find entity of actual. If the actual is an attribute reference, it
6572 -- cannot be resolved here (its formal is missing) but is handled
6573 -- instead in Attribute_Renaming. If the actual is overloaded, it is
6574 -- fully resolved subsequently, when the renaming declaration for the
6575 -- formal is analyzed. If it is an explicit dereference, resolve the
6576 -- prefix but not the actual itself, to prevent interpretation as a
6579 if Present (Actual) then
6580 Loc := Sloc (Actual);
6581 Set_Sloc (New_Spec, Loc);
6583 if Nkind (Actual) = N_Operator_Symbol then
6584 Find_Direct_Name (Actual);
6586 elsif Nkind (Actual) = N_Explicit_Dereference then
6587 Analyze (Prefix (Actual));
6589 elsif Nkind (Actual) /= N_Attribute_Reference then
6593 Valid_Actual_Subprogram (Actual);
6596 elsif Present (Default_Name (Formal)) then
6597 if Nkind (Default_Name (Formal)) /= N_Attribute_Reference
6598 and then Nkind (Default_Name (Formal)) /= N_Selected_Component
6599 and then Nkind (Default_Name (Formal)) /= N_Indexed_Component
6600 and then Nkind (Default_Name (Formal)) /= N_Character_Literal
6601 and then Present (Entity (Default_Name (Formal)))
6603 Nam := New_Occurrence_Of (Entity (Default_Name (Formal)), Loc);
6605 Nam := New_Copy (Default_Name (Formal));
6606 Set_Sloc (Nam, Loc);
6609 elsif Box_Present (Formal) then
6611 -- Actual is resolved at the point of instantiation. Create
6612 -- an identifier or operator with the same name as the formal.
6614 if Nkind (Formal_Sub) = N_Defining_Operator_Symbol then
6615 Nam := Make_Operator_Symbol (Loc,
6616 Chars => Chars (Formal_Sub),
6617 Strval => No_String);
6619 Nam := Make_Identifier (Loc, Chars (Formal_Sub));
6624 ("missing actual&", Instantiation_Node, Formal_Sub);
6626 ("\in instantiation of & declared#",
6627 Instantiation_Node, Scope (Analyzed_S));
6628 Abandon_Instantiation (Instantiation_Node);
6632 Make_Subprogram_Renaming_Declaration (Loc,
6633 Specification => New_Spec,
6636 -- Gather possible interpretations for the actual before analyzing the
6637 -- instance. If overloaded, it will be resolved when analyzing the
6638 -- renaming declaration.
6640 if Box_Present (Formal)
6641 and then No (Actual)
6645 if Is_Child_Unit (Scope (Analyzed_S))
6646 and then Present (Entity (Nam))
6648 if not Is_Overloaded (Nam) then
6650 if From_Parent_Scope (Entity (Nam)) then
6651 Set_Is_Immediately_Visible (Entity (Nam), False);
6652 Set_Entity (Nam, Empty);
6653 Set_Etype (Nam, Empty);
6657 Set_Is_Immediately_Visible (Entity (Nam));
6666 Get_First_Interp (Nam, I, It);
6668 while Present (It.Nam) loop
6669 if From_Parent_Scope (It.Nam) then
6673 Get_Next_Interp (I, It);
6680 -- The generic instantiation freezes the actual. This can only be
6681 -- done once the actual is resolved, in the analysis of the renaming
6682 -- declaration. To indicate that must be done, we set the corresponding
6683 -- spec of the node to point to the formal subprogram entity.
6685 Set_Corresponding_Spec (Decl_Node, Analyzed_S);
6687 -- We cannot analyze the renaming declaration, and thus find the
6688 -- actual, until the all the actuals are assembled in the instance.
6689 -- For subsequent checks of other actuals, indicate the node that
6690 -- will hold the instance of this formal.
6692 Set_Instance_Of (Analyzed_S, Nam);
6694 if Nkind (Actual) = N_Selected_Component
6695 and then Is_Task_Type (Etype (Prefix (Actual)))
6696 and then not Is_Frozen (Etype (Prefix (Actual)))
6698 -- The renaming declaration will create a body, which must appear
6699 -- outside of the instantiation, We move the renaming declaration
6700 -- out of the instance, and create an additional renaming inside,
6701 -- to prevent freezing anomalies.
6704 Anon_Id : constant Entity_Id :=
6705 Make_Defining_Identifier
6706 (Loc, New_Internal_Name ('E'));
6708 Set_Defining_Unit_Name (New_Spec, Anon_Id);
6709 Insert_Before (Instantiation_Node, Decl_Node);
6710 Analyze (Decl_Node);
6712 -- Now create renaming within the instance
6715 Make_Subprogram_Renaming_Declaration (Loc,
6716 Specification => New_Copy_Tree (New_Spec),
6717 Name => New_Occurrence_Of (Anon_Id, Loc));
6719 Set_Defining_Unit_Name (Specification (Decl_Node),
6720 Make_Defining_Identifier (Loc, Chars (Formal_Sub)));
6725 end Instantiate_Formal_Subprogram;
6727 ------------------------
6728 -- Instantiate_Object --
6729 ------------------------
6731 function Instantiate_Object
6734 Analyzed_Formal : Node_Id)
6737 Formal_Id : constant Entity_Id := Defining_Identifier (Formal);
6738 Type_Id : constant Node_Id := Subtype_Mark (Formal);
6739 Loc : constant Source_Ptr := Sloc (Actual);
6740 Act_Assoc : constant Node_Id := Parent (Actual);
6741 Orig_Ftyp : constant Entity_Id :=
6742 Etype (Defining_Identifier (Analyzed_Formal));
6743 List : constant List_Id := New_List;
6745 Decl_Node : Node_Id;
6746 Subt_Decl : Node_Id := Empty;
6749 if Get_Instance_Of (Formal_Id) /= Formal_Id then
6750 Error_Msg_N ("duplicate instantiation of generic parameter", Actual);
6753 Set_Parent (List, Parent (Actual));
6757 if Out_Present (Formal) then
6759 -- An IN OUT generic actual must be a name. The instantiation is
6760 -- a renaming declaration. The actual is the name being renamed.
6761 -- We use the actual directly, rather than a copy, because it is not
6762 -- used further in the list of actuals, and because a copy or a use
6763 -- of relocate_node is incorrect if the instance is nested within
6764 -- a generic. In order to simplify ASIS searches, the Generic_Parent
6765 -- field links the declaration to the generic association.
6770 Instantiation_Node, Formal_Id);
6772 ("\in instantiation of & declared#",
6774 Scope (Defining_Identifier (Analyzed_Formal)));
6775 Abandon_Instantiation (Instantiation_Node);
6779 Make_Object_Renaming_Declaration (Loc,
6780 Defining_Identifier => New_Copy (Formal_Id),
6781 Subtype_Mark => New_Copy_Tree (Type_Id),
6784 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
6786 -- The analysis of the actual may produce insert_action nodes, so
6787 -- the declaration must have a context in which to attach them.
6789 Append (Decl_Node, List);
6792 -- This check is performed here because Analyze_Object_Renaming
6793 -- will not check it when Comes_From_Source is False. Note
6794 -- though that the check for the actual being the name of an
6795 -- object will be performed in Analyze_Object_Renaming.
6797 if Is_Object_Reference (Actual)
6798 and then Is_Dependent_Component_Of_Mutable_Object (Actual)
6801 ("illegal discriminant-dependent component for in out parameter",
6805 -- The actual has to be resolved in order to check that it is
6806 -- a variable (due to cases such as F(1), where F returns
6807 -- access to an array, and for overloaded prefixes).
6810 Get_Instance_Of (Etype (Defining_Identifier (Analyzed_Formal)));
6812 if Is_Private_Type (Ftyp)
6813 and then not Is_Private_Type (Etype (Actual))
6814 and then (Base_Type (Full_View (Ftyp)) = Base_Type (Etype (Actual))
6815 or else Base_Type (Etype (Actual)) = Ftyp)
6817 -- If the actual has the type of the full view of the formal,
6818 -- or else a non-private subtype of the formal, then
6819 -- the visibility of the formal type has changed. Add to the
6820 -- actuals a subtype declaration that will force the exchange
6821 -- of views in the body of the instance as well.
6824 Make_Subtype_Declaration (Loc,
6825 Defining_Identifier =>
6826 Make_Defining_Identifier (Loc, New_Internal_Name ('P')),
6827 Subtype_Indication => New_Occurrence_Of (Ftyp, Loc));
6829 Prepend (Subt_Decl, List);
6831 Append_Elmt (Full_View (Ftyp), Exchanged_Views);
6832 Exchange_Declarations (Ftyp);
6835 Resolve (Actual, Ftyp);
6837 if not Is_Variable (Actual) or else Paren_Count (Actual) > 0 then
6839 ("actual for& must be a variable", Actual, Formal_Id);
6841 elsif Base_Type (Ftyp) /= Base_Type (Etype (Actual)) then
6843 "type of actual does not match type of&", Actual, Formal_Id);
6847 Note_Possible_Modification (Actual);
6849 -- Check for instantiation of atomic/volatile actual for
6850 -- non-atomic/volatile formal (RM C.6 (12)).
6852 if Is_Atomic_Object (Actual)
6853 and then not Is_Atomic (Orig_Ftyp)
6856 ("cannot instantiate non-atomic formal object " &
6857 "with atomic actual", Actual);
6859 elsif Is_Volatile_Object (Actual)
6860 and then not Is_Volatile (Orig_Ftyp)
6863 ("cannot instantiate non-volatile formal object " &
6864 "with volatile actual", Actual);
6870 -- The instantiation of a generic formal in-parameter
6871 -- is a constant declaration. The actual is the expression for
6872 -- that declaration.
6874 if Present (Actual) then
6876 Decl_Node := Make_Object_Declaration (Loc,
6877 Defining_Identifier => New_Copy (Formal_Id),
6878 Constant_Present => True,
6879 Object_Definition => New_Copy_Tree (Type_Id),
6880 Expression => Actual);
6882 Set_Corresponding_Generic_Association (Decl_Node, Act_Assoc);
6884 -- A generic formal object of a tagged type is defined
6885 -- to be aliased so the new constant must also be treated
6889 (Etype (Defining_Identifier (Analyzed_Formal)))
6891 Set_Aliased_Present (Decl_Node);
6894 Append (Decl_Node, List);
6896 -- No need to repeat (pre-)analysis of some expression nodes
6897 -- already handled in Pre_Analyze_Actuals.
6899 if Nkind (Actual) /= N_Allocator then
6904 Typ : constant Entity_Id :=
6906 (Etype (Defining_Identifier (Analyzed_Formal)));
6909 Freeze_Before (Instantiation_Node, Typ);
6911 -- If the actual is an aggregate, perform name resolution
6912 -- on its components (the analysis of an aggregate does not
6913 -- do it) to capture local names that may be hidden if the
6914 -- generic is a child unit.
6916 if Nkind (Actual) = N_Aggregate then
6917 Pre_Analyze_And_Resolve (Actual, Typ);
6921 elsif Present (Expression (Formal)) then
6923 -- Use default to construct declaration.
6926 Make_Object_Declaration (Sloc (Formal),
6927 Defining_Identifier => New_Copy (Formal_Id),
6928 Constant_Present => True,
6929 Object_Definition => New_Copy (Type_Id),
6930 Expression => New_Copy_Tree (Expression (Formal)));
6932 Append (Decl_Node, List);
6933 Set_Analyzed (Expression (Decl_Node), False);
6938 Instantiation_Node, Formal_Id);
6939 Error_Msg_NE ("\in instantiation of & declared#",
6941 Scope (Defining_Identifier (Analyzed_Formal)));
6944 (Etype (Defining_Identifier (Analyzed_Formal)))
6946 -- Create dummy constant declaration so that instance can
6947 -- be analyzed, to minimize cascaded visibility errors.
6950 Make_Object_Declaration (Loc,
6951 Defining_Identifier => New_Copy (Formal_Id),
6952 Constant_Present => True,
6953 Object_Definition => New_Copy (Type_Id),
6955 Make_Attribute_Reference (Sloc (Formal_Id),
6956 Attribute_Name => Name_First,
6957 Prefix => New_Copy (Type_Id)));
6959 Append (Decl_Node, List);
6962 Abandon_Instantiation (Instantiation_Node);
6969 end Instantiate_Object;
6971 ------------------------------
6972 -- Instantiate_Package_Body --
6973 ------------------------------
6975 procedure Instantiate_Package_Body
6976 (Body_Info : Pending_Body_Info;
6977 Inlined_Body : Boolean := False)
6979 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
6980 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
6981 Loc : constant Source_Ptr := Sloc (Inst_Node);
6983 Gen_Id : constant Node_Id := Name (Inst_Node);
6984 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
6985 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
6986 Act_Spec : constant Node_Id := Specification (Act_Decl);
6987 Act_Decl_Id : constant Entity_Id := Defining_Entity (Act_Spec);
6989 Act_Body_Name : Node_Id;
6991 Gen_Body_Id : Node_Id;
6993 Act_Body_Id : Entity_Id;
6995 Parent_Installed : Boolean := False;
6996 Save_Style_Check : constant Boolean := Style_Check;
6999 Gen_Body_Id := Corresponding_Body (Gen_Decl);
7001 -- The instance body may already have been processed, as the parent
7002 -- of another instance that is inlined. (Load_Parent_Of_Generic).
7004 if Present (Corresponding_Body (Instance_Spec (Inst_Node))) then
7008 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
7010 if No (Gen_Body_Id) then
7011 Load_Parent_Of_Generic (Inst_Node, Specification (Gen_Decl));
7012 Gen_Body_Id := Corresponding_Body (Gen_Decl);
7015 -- Establish global variable for sloc adjustment and for error
7018 Instantiation_Node := Inst_Node;
7020 if Present (Gen_Body_Id) then
7021 Save_Env (Gen_Unit, Act_Decl_Id);
7022 Style_Check := False;
7023 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
7025 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
7027 Create_Instantiation_Source
7028 (Inst_Node, Gen_Body_Id, False, S_Adjustment);
7032 (Original_Node (Gen_Body), Empty, Instantiating => True);
7034 -- Build new name (possibly qualified) for body declaration
7036 Act_Body_Id := New_Copy (Act_Decl_Id);
7038 -- Some attributes of the spec entity are not inherited by the
7041 Set_Handler_Records (Act_Body_Id, No_List);
7043 if Nkind (Defining_Unit_Name (Act_Spec)) =
7044 N_Defining_Program_Unit_Name
7047 Make_Defining_Program_Unit_Name (Loc,
7048 Name => New_Copy_Tree (Name (Defining_Unit_Name (Act_Spec))),
7049 Defining_Identifier => Act_Body_Id);
7051 Act_Body_Name := Act_Body_Id;
7054 Set_Defining_Unit_Name (Act_Body, Act_Body_Name);
7056 Set_Corresponding_Spec (Act_Body, Act_Decl_Id);
7057 Check_Generic_Actuals (Act_Decl_Id, False);
7059 -- If it is a child unit, make the parent instance (which is an
7060 -- instance of the parent of the generic) visible. The parent
7061 -- instance is the prefix of the name of the generic unit.
7063 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
7064 and then Nkind (Gen_Id) = N_Expanded_Name
7066 Install_Parent (Entity (Prefix (Gen_Id)), In_Body => True);
7067 Parent_Installed := True;
7069 elsif Is_Child_Unit (Gen_Unit) then
7070 Install_Parent (Scope (Gen_Unit), In_Body => True);
7071 Parent_Installed := True;
7074 -- If the instantiation is a library unit, and this is the main
7075 -- unit, then build the resulting compilation unit nodes for the
7076 -- instance. If this is a compilation unit but it is not the main
7077 -- unit, then it is the body of a unit in the context, that is being
7078 -- compiled because it is encloses some inlined unit or another
7079 -- generic unit being instantiated. In that case, this body is not
7080 -- part of the current compilation, and is not attached to the tree,
7081 -- but its parent must be set for analysis.
7083 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
7085 -- Replace instance node with body of instance, and create
7086 -- new node for corresponding instance declaration.
7088 Build_Instance_Compilation_Unit_Nodes
7089 (Inst_Node, Act_Body, Act_Decl);
7090 Analyze (Inst_Node);
7092 if Parent (Inst_Node) = Cunit (Main_Unit) then
7094 -- If the instance is a child unit itself, then set the
7095 -- scope of the expanded body to be the parent of the
7096 -- instantiation (ensuring that the fully qualified name
7097 -- will be generated for the elaboration subprogram).
7099 if Nkind (Defining_Unit_Name (Act_Spec)) =
7100 N_Defining_Program_Unit_Name
7103 (Defining_Entity (Inst_Node), Scope (Act_Decl_Id));
7107 -- Case where instantiation is not a library unit
7110 -- If this is an early instantiation, i.e. appears textually
7111 -- before the corresponding body and must be elaborated first,
7112 -- indicate that the body instance is to be delayed.
7114 Install_Body (Act_Body, Inst_Node, Gen_Body, Gen_Decl);
7116 -- Now analyze the body. We turn off all checks if this is
7117 -- an internal unit, since there is no reason to have checks
7118 -- on for any predefined run-time library code. All such
7119 -- code is designed to be compiled with checks off.
7121 -- Note that we do NOT apply this criterion to children of
7122 -- GNAT (or on VMS, children of DEC). The latter units must
7123 -- suppress checks explicitly if this is needed.
7125 if Is_Predefined_File_Name
7126 (Unit_File_Name (Get_Source_Unit (Gen_Decl)))
7128 Analyze (Act_Body, Suppress => All_Checks);
7134 if not Generic_Separately_Compiled (Gen_Unit) then
7135 Inherit_Context (Gen_Body, Inst_Node);
7138 -- Remove the parent instances if they have been placed on the
7139 -- scope stack to compile the body.
7141 if Parent_Installed then
7142 Remove_Parent (In_Body => True);
7145 Restore_Private_Views (Act_Decl_Id);
7147 -- Remove the current unit from visibility if this is an instance
7148 -- that is not elaborated on the fly for inlining purposes.
7150 if not Inlined_Body then
7151 Set_Is_Immediately_Visible (Act_Decl_Id, False);
7155 Style_Check := Save_Style_Check;
7157 -- If we have no body, and the unit requires a body, then complain.
7158 -- This complaint is suppressed if we have detected other errors
7159 -- (since a common reason for missing the body is that it had errors).
7161 elsif Unit_Requires_Body (Gen_Unit) then
7162 if Serious_Errors_Detected = 0 then
7164 ("cannot find body of generic package &", Inst_Node, Gen_Unit);
7166 -- Don't attempt to perform any cleanup actions if some other
7167 -- error was aready detected, since this can cause blowups.
7173 -- Case of package that does not need a body
7176 -- If the instantiation of the declaration is a library unit,
7177 -- rewrite the original package instantiation as a package
7178 -- declaration in the compilation unit node.
7180 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
7181 Set_Parent_Spec (Act_Decl, Parent_Spec (Inst_Node));
7182 Rewrite (Inst_Node, Act_Decl);
7184 -- Generate elaboration entity, in case spec has elaboration
7185 -- code. This cannot be done when the instance is analyzed,
7186 -- because it is not known yet whether the body exists.
7188 Set_Elaboration_Entity_Required (Act_Decl_Id, False);
7189 Build_Elaboration_Entity (Parent (Inst_Node), Act_Decl_Id);
7191 -- If the instantiation is not a library unit, then append the
7192 -- declaration to the list of implicitly generated entities.
7193 -- unless it is already a list member which means that it was
7194 -- already processed
7196 elsif not Is_List_Member (Act_Decl) then
7197 Mark_Rewrite_Insertion (Act_Decl);
7198 Insert_Before (Inst_Node, Act_Decl);
7202 Expander_Mode_Restore;
7203 end Instantiate_Package_Body;
7205 ---------------------------------
7206 -- Instantiate_Subprogram_Body --
7207 ---------------------------------
7209 procedure Instantiate_Subprogram_Body
7210 (Body_Info : Pending_Body_Info)
7212 Act_Decl : constant Node_Id := Body_Info.Act_Decl;
7213 Inst_Node : constant Node_Id := Body_Info.Inst_Node;
7214 Loc : constant Source_Ptr := Sloc (Inst_Node);
7215 Gen_Id : constant Node_Id := Name (Inst_Node);
7216 Gen_Unit : constant Entity_Id := Get_Generic_Entity (Inst_Node);
7217 Gen_Decl : constant Node_Id := Unit_Declaration_Node (Gen_Unit);
7218 Anon_Id : constant Entity_Id :=
7219 Defining_Unit_Name (Specification (Act_Decl));
7220 Pack_Id : constant Entity_Id :=
7221 Defining_Unit_Name (Parent (Act_Decl));
7224 Gen_Body_Id : Node_Id;
7226 Act_Body_Id : Entity_Id;
7227 Pack_Body : Node_Id;
7228 Prev_Formal : Entity_Id;
7230 Unit_Renaming : Node_Id;
7232 Parent_Installed : Boolean := False;
7233 Save_Style_Check : constant Boolean := Style_Check;
7236 Gen_Body_Id := Corresponding_Body (Gen_Decl);
7238 Expander_Mode_Save_And_Set (Body_Info.Expander_Status);
7240 if No (Gen_Body_Id) then
7241 Load_Parent_Of_Generic (Inst_Node, Specification (Gen_Decl));
7242 Gen_Body_Id := Corresponding_Body (Gen_Decl);
7245 Instantiation_Node := Inst_Node;
7247 if Present (Gen_Body_Id) then
7248 Gen_Body := Unit_Declaration_Node (Gen_Body_Id);
7250 if Nkind (Gen_Body) = N_Subprogram_Body_Stub then
7252 -- Either body is not present, or context is non-expanding, as
7253 -- when compiling a subunit. Mark the instance as completed.
7255 Set_Has_Completion (Anon_Id);
7259 Save_Env (Gen_Unit, Anon_Id);
7260 Style_Check := False;
7261 Current_Sem_Unit := Body_Info.Current_Sem_Unit;
7262 Create_Instantiation_Source
7270 (Original_Node (Gen_Body), Empty, Instantiating => True);
7271 Act_Body_Id := Defining_Entity (Act_Body);
7272 Set_Chars (Act_Body_Id, Chars (Anon_Id));
7273 Set_Sloc (Act_Body_Id, Sloc (Defining_Entity (Inst_Node)));
7274 Set_Corresponding_Spec (Act_Body, Anon_Id);
7275 Set_Has_Completion (Anon_Id);
7276 Check_Generic_Actuals (Pack_Id, False);
7278 -- If it is a child unit, make the parent instance (which is an
7279 -- instance of the parent of the generic) visible. The parent
7280 -- instance is the prefix of the name of the generic unit.
7282 if Ekind (Scope (Gen_Unit)) = E_Generic_Package
7283 and then Nkind (Gen_Id) = N_Expanded_Name
7285 Install_Parent (Entity (Prefix (Gen_Id)), In_Body => True);
7286 Parent_Installed := True;
7288 elsif Is_Child_Unit (Gen_Unit) then
7289 Install_Parent (Scope (Gen_Unit), In_Body => True);
7290 Parent_Installed := True;
7293 -- Inside its body, a reference to the generic unit is a reference
7294 -- to the instance. The corresponding renaming is the first
7295 -- declaration in the body.
7298 Make_Subprogram_Renaming_Declaration (Loc,
7301 Specification (Original_Node (Gen_Body)),
7303 Instantiating => True),
7304 Name => New_Occurrence_Of (Anon_Id, Loc));
7306 -- If there is a formal subprogram with the same name as the
7307 -- unit itself, do not add this renaming declaration. This is
7308 -- a temporary fix for one ACVC test. ???
7310 Prev_Formal := First_Entity (Pack_Id);
7311 while Present (Prev_Formal) loop
7312 if Chars (Prev_Formal) = Chars (Gen_Unit)
7313 and then Is_Overloadable (Prev_Formal)
7318 Next_Entity (Prev_Formal);
7321 if Present (Prev_Formal) then
7322 Decls := New_List (Act_Body);
7324 Decls := New_List (Unit_Renaming, Act_Body);
7327 -- The subprogram body is placed in the body of a dummy package
7328 -- body, whose spec contains the subprogram declaration as well
7329 -- as the renaming declarations for the generic parameters.
7331 Pack_Body := Make_Package_Body (Loc,
7332 Defining_Unit_Name => New_Copy (Pack_Id),
7333 Declarations => Decls);
7335 Set_Corresponding_Spec (Pack_Body, Pack_Id);
7337 -- If the instantiation is a library unit, then build resulting
7338 -- compilation unit nodes for the instance. The declaration of
7339 -- the enclosing package is the grandparent of the subprogram
7340 -- declaration. First replace the instantiation node as the unit
7341 -- of the corresponding compilation.
7343 if Nkind (Parent (Inst_Node)) = N_Compilation_Unit then
7344 if Parent (Inst_Node) = Cunit (Main_Unit) then
7345 Set_Unit (Parent (Inst_Node), Inst_Node);
7346 Build_Instance_Compilation_Unit_Nodes
7347 (Inst_Node, Pack_Body, Parent (Parent (Act_Decl)));
7348 Analyze (Inst_Node);
7350 Set_Parent (Pack_Body, Parent (Inst_Node));
7351 Analyze (Pack_Body);
7355 Insert_Before (Inst_Node, Pack_Body);
7356 Mark_Rewrite_Insertion (Pack_Body);
7357 Analyze (Pack_Body);
7359 if Expander_Active then
7360 Freeze_Subprogram_Body (Inst_Node, Gen_Body, Pack_Id);
7364 if not Generic_Separately_Compiled (Gen_Unit) then
7365 Inherit_Context (Gen_Body, Inst_Node);
7368 Restore_Private_Views (Pack_Id, False);
7370 if Parent_Installed then
7371 Remove_Parent (In_Body => True);
7375 Style_Check := Save_Style_Check;
7377 -- Body not found. Error was emitted already. If there were no
7378 -- previous errors, this may be an instance whose scope is a premature
7379 -- instance. In that case we must insure that the (legal) program does
7380 -- raise program error if executed. We generate a subprogram body for
7381 -- this purpose. See DEC ac30vso.
7383 elsif Serious_Errors_Detected = 0
7384 and then Nkind (Parent (Inst_Node)) /= N_Compilation_Unit
7386 if Ekind (Anon_Id) = E_Procedure then
7388 Make_Subprogram_Body (Loc,
7390 Make_Procedure_Specification (Loc,
7391 Defining_Unit_Name => New_Copy (Anon_Id),
7392 Parameter_Specifications =>
7394 (Parameter_Specifications (Parent (Anon_Id)))),
7396 Declarations => Empty_List,
7397 Handled_Statement_Sequence =>
7398 Make_Handled_Sequence_Of_Statements (Loc,
7401 Make_Raise_Program_Error (Loc,
7403 PE_Access_Before_Elaboration))));
7407 Make_Raise_Program_Error (Loc,
7408 Reason => PE_Access_Before_Elaboration);
7410 Set_Etype (Ret_Expr, (Etype (Anon_Id)));
7411 Set_Analyzed (Ret_Expr);
7414 Make_Subprogram_Body (Loc,
7416 Make_Function_Specification (Loc,
7417 Defining_Unit_Name => New_Copy (Anon_Id),
7418 Parameter_Specifications =>
7420 (Parameter_Specifications (Parent (Anon_Id))),
7422 New_Occurrence_Of (Etype (Anon_Id), Loc)),
7424 Declarations => Empty_List,
7425 Handled_Statement_Sequence =>
7426 Make_Handled_Sequence_Of_Statements (Loc,
7428 New_List (Make_Return_Statement (Loc, Ret_Expr))));
7431 Pack_Body := Make_Package_Body (Loc,
7432 Defining_Unit_Name => New_Copy (Pack_Id),
7433 Declarations => New_List (Act_Body));
7435 Insert_After (Inst_Node, Pack_Body);
7436 Set_Corresponding_Spec (Pack_Body, Pack_Id);
7437 Analyze (Pack_Body);
7440 Expander_Mode_Restore;
7441 end Instantiate_Subprogram_Body;
7443 ----------------------
7444 -- Instantiate_Type --
7445 ----------------------
7447 function Instantiate_Type
7450 Analyzed_Formal : Node_Id;
7451 Actual_Decls : List_Id)
7454 Loc : constant Source_Ptr := Sloc (Actual);
7455 Gen_T : constant Entity_Id := Defining_Identifier (Formal);
7456 A_Gen_T : constant Entity_Id := Defining_Identifier (Analyzed_Formal);
7457 Ancestor : Entity_Id := Empty;
7458 Def : constant Node_Id := Formal_Type_Definition (Formal);
7460 Decl_Node : Node_Id;
7462 procedure Validate_Array_Type_Instance;
7463 procedure Validate_Access_Subprogram_Instance;
7464 procedure Validate_Access_Type_Instance;
7465 procedure Validate_Derived_Type_Instance;
7466 procedure Validate_Private_Type_Instance;
7467 -- These procedures perform validation tests for the named case
7469 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean;
7470 -- Check that base types are the same and that the subtypes match
7471 -- statically. Used in several of the above.
7473 --------------------
7474 -- Subtypes_Match --
7475 --------------------
7477 function Subtypes_Match (Gen_T, Act_T : Entity_Id) return Boolean is
7478 T : constant Entity_Id := Get_Instance_Of (Gen_T);
7481 return (Base_Type (T) = Base_Type (Act_T)
7482 -- why is the and then commented out here???
7483 -- and then Is_Constrained (T) = Is_Constrained (Act_T)
7484 and then Subtypes_Statically_Match (T, Act_T))
7486 or else (Is_Class_Wide_Type (Gen_T)
7487 and then Is_Class_Wide_Type (Act_T)
7490 Get_Instance_Of (Root_Type (Gen_T)),
7491 Root_Type (Act_T)));
7494 -----------------------------------------
7495 -- Validate_Access_Subprogram_Instance --
7496 -----------------------------------------
7498 procedure Validate_Access_Subprogram_Instance is
7500 if not Is_Access_Type (Act_T)
7501 or else Ekind (Designated_Type (Act_T)) /= E_Subprogram_Type
7504 ("expect access type in instantiation of &", Actual, Gen_T);
7505 Abandon_Instantiation (Actual);
7508 Check_Mode_Conformant
7509 (Designated_Type (Act_T),
7510 Designated_Type (A_Gen_T),
7514 if Ekind (Base_Type (Act_T)) = E_Access_Protected_Subprogram_Type then
7515 if Ekind (A_Gen_T) = E_Access_Subprogram_Type then
7517 ("protected access type not allowed for formal &",
7521 elsif Ekind (A_Gen_T) = E_Access_Protected_Subprogram_Type then
7523 ("expect protected access type for formal &",
7526 end Validate_Access_Subprogram_Instance;
7528 -----------------------------------
7529 -- Validate_Access_Type_Instance --
7530 -----------------------------------
7532 procedure Validate_Access_Type_Instance is
7533 Desig_Type : constant Entity_Id :=
7535 (Designated_Type (A_Gen_T), Scope (A_Gen_T));
7538 if not Is_Access_Type (Act_T) then
7540 ("expect access type in instantiation of &", Actual, Gen_T);
7541 Abandon_Instantiation (Actual);
7544 if Is_Access_Constant (A_Gen_T) then
7545 if not Is_Access_Constant (Act_T) then
7547 ("actual type must be access-to-constant type", Actual);
7548 Abandon_Instantiation (Actual);
7551 if Is_Access_Constant (Act_T) then
7553 ("actual type must be access-to-variable type", Actual);
7554 Abandon_Instantiation (Actual);
7556 elsif Ekind (A_Gen_T) = E_General_Access_Type
7557 and then Ekind (Base_Type (Act_T)) /= E_General_Access_Type
7559 Error_Msg_N ("actual must be general access type!", Actual);
7560 Error_Msg_NE ("add ALL to }!", Actual, Act_T);
7561 Abandon_Instantiation (Actual);
7565 -- The designated subtypes, that is to say the subtypes introduced
7566 -- by an access type declaration (and not by a subtype declaration)
7569 if not Subtypes_Match
7570 (Desig_Type, Designated_Type (Base_Type (Act_T)))
7573 ("designated type of actual does not match that of formal &",
7575 Abandon_Instantiation (Actual);
7577 elsif Is_Access_Type (Designated_Type (Act_T))
7578 and then Is_Constrained (Designated_Type (Designated_Type (Act_T)))
7580 Is_Constrained (Designated_Type (Desig_Type))
7583 ("designated type of actual does not match that of formal &",
7585 Abandon_Instantiation (Actual);
7587 end Validate_Access_Type_Instance;
7589 ----------------------------------
7590 -- Validate_Array_Type_Instance --
7591 ----------------------------------
7593 procedure Validate_Array_Type_Instance is
7598 function Formal_Dimensions return Int;
7599 -- Count number of dimensions in array type formal
7601 function Formal_Dimensions return Int is
7606 if Nkind (Def) = N_Constrained_Array_Definition then
7607 Index := First (Discrete_Subtype_Definitions (Def));
7609 Index := First (Subtype_Marks (Def));
7612 while Present (Index) loop
7618 end Formal_Dimensions;
7620 -- Start of processing for Validate_Array_Type_Instance
7623 if not Is_Array_Type (Act_T) then
7625 ("expect array type in instantiation of &", Actual, Gen_T);
7626 Abandon_Instantiation (Actual);
7628 elsif Nkind (Def) = N_Constrained_Array_Definition then
7629 if not (Is_Constrained (Act_T)) then
7631 ("expect constrained array in instantiation of &",
7633 Abandon_Instantiation (Actual);
7637 if Is_Constrained (Act_T) then
7639 ("expect unconstrained array in instantiation of &",
7641 Abandon_Instantiation (Actual);
7645 if Formal_Dimensions /= Number_Dimensions (Act_T) then
7647 ("dimensions of actual do not match formal &", Actual, Gen_T);
7648 Abandon_Instantiation (Actual);
7651 I1 := First_Index (A_Gen_T);
7652 I2 := First_Index (Act_T);
7653 for J in 1 .. Formal_Dimensions loop
7655 -- If the indices of the actual were given by a subtype_mark,
7656 -- the index was transformed into a range attribute. Retrieve
7657 -- the original type mark for checking.
7659 if Is_Entity_Name (Original_Node (I2)) then
7660 T2 := Entity (Original_Node (I2));
7665 if not Subtypes_Match
7666 (Find_Actual_Type (Etype (I1), Scope (A_Gen_T)), T2)
7669 ("index types of actual do not match those of formal &",
7671 Abandon_Instantiation (Actual);
7678 if not Subtypes_Match (
7679 Find_Actual_Type (Component_Type (A_Gen_T), Scope (A_Gen_T)),
7680 Component_Type (Act_T))
7683 ("component subtype of actual does not match that of formal &",
7685 Abandon_Instantiation (Actual);
7688 if Has_Aliased_Components (A_Gen_T)
7689 and then not Has_Aliased_Components (Act_T)
7692 ("actual must have aliased components to match formal type &",
7696 end Validate_Array_Type_Instance;
7698 ------------------------------------
7699 -- Validate_Derived_Type_Instance --
7700 ------------------------------------
7702 procedure Validate_Derived_Type_Instance is
7703 Actual_Discr : Entity_Id;
7704 Ancestor_Discr : Entity_Id;
7707 -- If the parent type in the generic declaration is itself
7708 -- a previous formal type, then it is local to the generic
7709 -- and absent from the analyzed generic definition. In that
7710 -- case the ancestor is the instance of the formal (which must
7711 -- have been instantiated previously), unless the ancestor is
7712 -- itself a formal derived type. In this latter case (which is the
7713 -- subject of Corrigendum 8652/0038 (AI-202) the ancestor of the
7714 -- formals is the ancestor of its parent. Otherwise, the analyzed
7715 -- generic carries the parent type. If the parent type is defined
7716 -- in a previous formal package, then the scope of that formal
7717 -- package is that of the generic type itself, and it has already
7718 -- been mapped into the corresponding type in the actual package.
7720 -- Common case: parent type defined outside of the generic
7722 if Is_Entity_Name (Subtype_Mark (Def))
7723 and then Present (Entity (Subtype_Mark (Def)))
7725 Ancestor := Get_Instance_Of (Entity (Subtype_Mark (Def)));
7727 -- Check whether parent is defined in a previous formal package
7730 Scope (Scope (Base_Type (Etype (A_Gen_T)))) = Scope (A_Gen_T)
7733 Get_Instance_Of (Base_Type (Etype (A_Gen_T)));
7735 -- The type may be a local derivation, or a type extension of
7736 -- a previous formal, or of a formal of a parent package.
7738 elsif Is_Derived_Type (Get_Instance_Of (A_Gen_T))
7740 Ekind (Get_Instance_Of (A_Gen_T)) = E_Record_Type_With_Private
7742 -- Check whether the parent is another derived formal type
7743 -- in the same generic unit.
7745 if Etype (A_Gen_T) /= A_Gen_T
7746 and then Is_Generic_Type (Etype (A_Gen_T))
7747 and then Scope (Etype (A_Gen_T)) = Scope (A_Gen_T)
7748 and then Etype (Etype (A_Gen_T)) /= Etype (A_Gen_T)
7750 -- Locate ancestor of parent from the subtype declaration
7751 -- created for the actual.
7757 Decl := First (Actual_Decls);
7759 while (Present (Decl)) loop
7760 if Nkind (Decl) = N_Subtype_Declaration
7761 and then Chars (Defining_Identifier (Decl)) =
7762 Chars (Etype (A_Gen_T))
7764 Ancestor := Generic_Parent_Type (Decl);
7772 pragma Assert (Present (Ancestor));
7776 Get_Instance_Of (Base_Type (Get_Instance_Of (A_Gen_T)));
7780 Ancestor := Get_Instance_Of (Etype (Base_Type (A_Gen_T)));
7783 if not Is_Ancestor (Base_Type (Ancestor), Act_T) then
7785 ("expect type derived from & in instantiation",
7786 Actual, First_Subtype (Ancestor));
7787 Abandon_Instantiation (Actual);
7790 -- Perform atomic/volatile checks (RM C.6(12))
7792 if Is_Atomic (Act_T) and then not Is_Atomic (Ancestor) then
7794 ("cannot have atomic actual type for non-atomic formal type",
7797 elsif Is_Volatile (Act_T)
7798 and then not Is_Volatile (Ancestor)
7799 and then Is_By_Reference_Type (Ancestor)
7802 ("cannot have volatile actual type for non-volatile formal type",
7806 -- It should not be necessary to check for unknown discriminants
7807 -- on Formal, but for some reason Has_Unknown_Discriminants is
7808 -- false for A_Gen_T, so Is_Indefinite_Subtype incorrectly
7809 -- returns False. This needs fixing. ???
7811 if not Is_Indefinite_Subtype (A_Gen_T)
7812 and then not Unknown_Discriminants_Present (Formal)
7813 and then Is_Indefinite_Subtype (Act_T)
7816 ("actual subtype must be constrained", Actual);
7817 Abandon_Instantiation (Actual);
7820 if not Unknown_Discriminants_Present (Formal) then
7821 if Is_Constrained (Ancestor) then
7822 if not Is_Constrained (Act_T) then
7824 ("actual subtype must be constrained", Actual);
7825 Abandon_Instantiation (Actual);
7828 -- Ancestor is unconstrained
7830 elsif Is_Constrained (Act_T) then
7831 if Ekind (Ancestor) = E_Access_Type
7832 or else Is_Composite_Type (Ancestor)
7835 ("actual subtype must be unconstrained", Actual);
7836 Abandon_Instantiation (Actual);
7839 -- A class-wide type is only allowed if the formal has
7840 -- unknown discriminants.
7842 elsif Is_Class_Wide_Type (Act_T)
7843 and then not Has_Unknown_Discriminants (Ancestor)
7846 ("actual for & cannot be a class-wide type", Actual, Gen_T);
7847 Abandon_Instantiation (Actual);
7849 -- Otherwise, the formal and actual shall have the same
7850 -- number of discriminants and each discriminant of the
7851 -- actual must correspond to a discriminant of the formal.
7853 elsif Has_Discriminants (Act_T)
7854 and then Has_Discriminants (Ancestor)
7856 Actual_Discr := First_Discriminant (Act_T);
7857 Ancestor_Discr := First_Discriminant (Ancestor);
7858 while Present (Actual_Discr)
7859 and then Present (Ancestor_Discr)
7861 if Base_Type (Act_T) /= Base_Type (Ancestor) and then
7862 not Present (Corresponding_Discriminant (Actual_Discr))
7865 ("discriminant & does not correspond " &
7866 "to ancestor discriminant", Actual, Actual_Discr);
7867 Abandon_Instantiation (Actual);
7870 Next_Discriminant (Actual_Discr);
7871 Next_Discriminant (Ancestor_Discr);
7874 if Present (Actual_Discr) or else Present (Ancestor_Discr) then
7876 ("actual for & must have same number of discriminants",
7878 Abandon_Instantiation (Actual);
7881 -- This case should be caught by the earlier check for
7882 -- for constrainedness, but the check here is added for
7885 elsif Has_Discriminants (Act_T) then
7887 ("actual for & must not have discriminants", Actual, Gen_T);
7888 Abandon_Instantiation (Actual);
7890 elsif Has_Discriminants (Ancestor) then
7892 ("actual for & must have known discriminants", Actual, Gen_T);
7893 Abandon_Instantiation (Actual);
7896 if not Subtypes_Statically_Compatible (Act_T, Ancestor) then
7898 ("constraint on actual is incompatible with formal", Actual);
7899 Abandon_Instantiation (Actual);
7902 end Validate_Derived_Type_Instance;
7904 ------------------------------------
7905 -- Validate_Private_Type_Instance --
7906 ------------------------------------
7908 procedure Validate_Private_Type_Instance is
7909 Formal_Discr : Entity_Id;
7910 Actual_Discr : Entity_Id;
7911 Formal_Subt : Entity_Id;
7914 if Is_Limited_Type (Act_T)
7915 and then not Is_Limited_Type (A_Gen_T)
7918 ("actual for non-limited & cannot be a limited type", Actual,
7920 Explain_Limited_Type (Act_T, Actual);
7921 Abandon_Instantiation (Actual);
7923 elsif Is_Indefinite_Subtype (Act_T)
7924 and then not Is_Indefinite_Subtype (A_Gen_T)
7928 ("actual for & must be a definite subtype", Actual, Gen_T);
7930 elsif not Is_Tagged_Type (Act_T)
7931 and then Is_Tagged_Type (A_Gen_T)
7934 ("actual for & must be a tagged type", Actual, Gen_T);
7936 elsif Has_Discriminants (A_Gen_T) then
7937 if not Has_Discriminants (Act_T) then
7939 ("actual for & must have discriminants", Actual, Gen_T);
7940 Abandon_Instantiation (Actual);
7942 elsif Is_Constrained (Act_T) then
7944 ("actual for & must be unconstrained", Actual, Gen_T);
7945 Abandon_Instantiation (Actual);
7948 Formal_Discr := First_Discriminant (A_Gen_T);
7949 Actual_Discr := First_Discriminant (Act_T);
7950 while Formal_Discr /= Empty loop
7951 if Actual_Discr = Empty then
7953 ("discriminants on actual do not match formal",
7955 Abandon_Instantiation (Actual);
7958 Formal_Subt := Get_Instance_Of (Etype (Formal_Discr));
7960 -- access discriminants match if designated types do.
7962 if Ekind (Base_Type (Formal_Subt)) = E_Anonymous_Access_Type
7963 and then (Ekind (Base_Type (Etype (Actual_Discr))))
7964 = E_Anonymous_Access_Type
7965 and then Get_Instance_Of (
7966 Designated_Type (Base_Type (Formal_Subt)))
7967 = Designated_Type (Base_Type (Etype (Actual_Discr)))
7971 elsif Base_Type (Formal_Subt) /=
7972 Base_Type (Etype (Actual_Discr))
7975 ("types of actual discriminants must match formal",
7977 Abandon_Instantiation (Actual);
7979 elsif not Subtypes_Statically_Match
7980 (Formal_Subt, Etype (Actual_Discr))
7984 ("subtypes of actual discriminants must match formal",
7986 Abandon_Instantiation (Actual);
7989 Next_Discriminant (Formal_Discr);
7990 Next_Discriminant (Actual_Discr);
7993 if Actual_Discr /= Empty then
7995 ("discriminants on actual do not match formal",
7997 Abandon_Instantiation (Actual);
8004 end Validate_Private_Type_Instance;
8006 -- Start of processing for Instantiate_Type
8009 if Get_Instance_Of (A_Gen_T) /= A_Gen_T then
8010 Error_Msg_N ("duplicate instantiation of generic type", Actual);
8013 elsif not Is_Entity_Name (Actual)
8014 or else not Is_Type (Entity (Actual))
8017 ("expect valid subtype mark to instantiate &", Actual, Gen_T);
8018 Abandon_Instantiation (Actual);
8021 Act_T := Entity (Actual);
8023 -- Deal with fixed/floating restrictions
8025 if Is_Floating_Point_Type (Act_T) then
8026 Check_Restriction (No_Floating_Point, Actual);
8027 elsif Is_Fixed_Point_Type (Act_T) then
8028 Check_Restriction (No_Fixed_Point, Actual);
8031 -- Deal with error of using incomplete type as generic actual
8033 if Ekind (Act_T) = E_Incomplete_Type then
8034 if No (Underlying_Type (Act_T)) then
8035 Error_Msg_N ("premature use of incomplete type", Actual);
8036 Abandon_Instantiation (Actual);
8038 Act_T := Full_View (Act_T);
8039 Set_Entity (Actual, Act_T);
8041 if Has_Private_Component (Act_T) then
8043 ("premature use of type with private component", Actual);
8047 -- Deal with error of premature use of private type as generic actual
8049 elsif Is_Private_Type (Act_T)
8050 and then Is_Private_Type (Base_Type (Act_T))
8051 and then not Is_Generic_Type (Act_T)
8052 and then not Is_Derived_Type (Act_T)
8053 and then No (Full_View (Root_Type (Act_T)))
8055 Error_Msg_N ("premature use of private type", Actual);
8057 elsif Has_Private_Component (Act_T) then
8059 ("premature use of type with private component", Actual);
8062 Set_Instance_Of (A_Gen_T, Act_T);
8064 -- If the type is generic, the class-wide type may also be used
8066 if Is_Tagged_Type (A_Gen_T)
8067 and then Is_Tagged_Type (Act_T)
8068 and then not Is_Class_Wide_Type (A_Gen_T)
8070 Set_Instance_Of (Class_Wide_Type (A_Gen_T),
8071 Class_Wide_Type (Act_T));
8074 if not Is_Abstract (A_Gen_T)
8075 and then Is_Abstract (Act_T)
8078 ("actual of non-abstract formal cannot be abstract", Actual);
8081 if Is_Scalar_Type (Gen_T) then
8082 Set_Instance_Of (Etype (A_Gen_T), Etype (Act_T));
8087 when N_Formal_Private_Type_Definition =>
8088 Validate_Private_Type_Instance;
8090 when N_Formal_Derived_Type_Definition =>
8091 Validate_Derived_Type_Instance;
8093 when N_Formal_Discrete_Type_Definition =>
8094 if not Is_Discrete_Type (Act_T) then
8096 ("expect discrete type in instantiation of&", Actual, Gen_T);
8097 Abandon_Instantiation (Actual);
8100 when N_Formal_Signed_Integer_Type_Definition =>
8101 if not Is_Signed_Integer_Type (Act_T) then
8103 ("expect signed integer type in instantiation of&",
8105 Abandon_Instantiation (Actual);
8108 when N_Formal_Modular_Type_Definition =>
8109 if not Is_Modular_Integer_Type (Act_T) then
8111 ("expect modular type in instantiation of &", Actual, Gen_T);
8112 Abandon_Instantiation (Actual);
8115 when N_Formal_Floating_Point_Definition =>
8116 if not Is_Floating_Point_Type (Act_T) then
8118 ("expect float type in instantiation of &", Actual, Gen_T);
8119 Abandon_Instantiation (Actual);
8122 when N_Formal_Ordinary_Fixed_Point_Definition =>
8123 if not Is_Ordinary_Fixed_Point_Type (Act_T) then
8125 ("expect ordinary fixed point type in instantiation of &",
8127 Abandon_Instantiation (Actual);
8130 when N_Formal_Decimal_Fixed_Point_Definition =>
8131 if not Is_Decimal_Fixed_Point_Type (Act_T) then
8133 ("expect decimal type in instantiation of &",
8135 Abandon_Instantiation (Actual);
8138 when N_Array_Type_Definition =>
8139 Validate_Array_Type_Instance;
8141 when N_Access_To_Object_Definition =>
8142 Validate_Access_Type_Instance;
8144 when N_Access_Function_Definition |
8145 N_Access_Procedure_Definition =>
8146 Validate_Access_Subprogram_Instance;
8149 raise Program_Error;
8154 Make_Subtype_Declaration (Loc,
8155 Defining_Identifier => New_Copy (Gen_T),
8156 Subtype_Indication => New_Reference_To (Act_T, Loc));
8158 if Is_Private_Type (Act_T) then
8159 Set_Has_Private_View (Subtype_Indication (Decl_Node));
8161 elsif Is_Access_Type (Act_T)
8162 and then Is_Private_Type (Designated_Type (Act_T))
8164 Set_Has_Private_View (Subtype_Indication (Decl_Node));
8167 -- Flag actual derived types so their elaboration produces the
8168 -- appropriate renamings for the primitive operations of the ancestor.
8169 -- Flag actual for formal private types as well, to determine whether
8170 -- operations in the private part may override inherited operations.
8172 if Nkind (Def) = N_Formal_Derived_Type_Definition
8173 or else Nkind (Def) = N_Formal_Private_Type_Definition
8175 Set_Generic_Parent_Type (Decl_Node, Ancestor);
8179 end Instantiate_Type;
8181 ---------------------
8182 -- Is_In_Main_Unit --
8183 ---------------------
8185 function Is_In_Main_Unit (N : Node_Id) return Boolean is
8186 Unum : constant Unit_Number_Type := Get_Source_Unit (N);
8188 Current_Unit : Node_Id;
8191 if Unum = Main_Unit then
8194 -- If the current unit is a subunit then it is either the main unit
8195 -- or is being compiled as part of the main unit.
8197 elsif Nkind (N) = N_Compilation_Unit then
8198 return Nkind (Unit (N)) = N_Subunit;
8201 Current_Unit := Parent (N);
8202 while Present (Current_Unit)
8203 and then Nkind (Current_Unit) /= N_Compilation_Unit
8205 Current_Unit := Parent (Current_Unit);
8208 -- The instantiation node is in the main unit, or else the current
8209 -- node (perhaps as the result of nested instantiations) is in the
8210 -- main unit, or in the declaration of the main unit, which in this
8211 -- last case must be a body.
8213 return Unum = Main_Unit
8214 or else Current_Unit = Cunit (Main_Unit)
8215 or else Current_Unit = Library_Unit (Cunit (Main_Unit))
8216 or else (Present (Library_Unit (Current_Unit))
8217 and then Is_In_Main_Unit (Library_Unit (Current_Unit)));
8218 end Is_In_Main_Unit;
8220 ----------------------------
8221 -- Load_Parent_Of_Generic --
8222 ----------------------------
8224 procedure Load_Parent_Of_Generic (N : Node_Id; Spec : Node_Id) is
8225 Comp_Unit : constant Node_Id := Cunit (Get_Source_Unit (Spec));
8226 Save_Style_Check : constant Boolean := Style_Check;
8227 True_Parent : Node_Id;
8228 Inst_Node : Node_Id;
8232 if not In_Same_Source_Unit (N, Spec)
8233 or else Nkind (Unit (Comp_Unit)) = N_Package_Declaration
8234 or else (Nkind (Unit (Comp_Unit)) = N_Package_Body
8235 and then not Is_In_Main_Unit (Spec))
8237 -- Find body of parent of spec, and analyze it. A special case
8238 -- arises when the parent is an instantiation, that is to say when
8239 -- we are currently instantiating a nested generic. In that case,
8240 -- there is no separate file for the body of the enclosing instance.
8241 -- Instead, the enclosing body must be instantiated as if it were
8242 -- a pending instantiation, in order to produce the body for the
8243 -- nested generic we require now. Note that in that case the
8244 -- generic may be defined in a package body, the instance defined
8245 -- in the same package body, and the original enclosing body may not
8246 -- be in the main unit.
8248 True_Parent := Parent (Spec);
8251 while Present (True_Parent)
8252 and then Nkind (True_Parent) /= N_Compilation_Unit
8254 if Nkind (True_Parent) = N_Package_Declaration
8256 Nkind (Original_Node (True_Parent)) = N_Package_Instantiation
8258 -- Parent is a compilation unit that is an instantiation.
8259 -- Instantiation node has been replaced with package decl.
8261 Inst_Node := Original_Node (True_Parent);
8264 elsif Nkind (True_Parent) = N_Package_Declaration
8265 and then Present (Generic_Parent (Specification (True_Parent)))
8266 and then Nkind (Parent (True_Parent)) /= N_Compilation_Unit
8268 -- Parent is an instantiation within another specification.
8269 -- Declaration for instance has been inserted before original
8270 -- instantiation node. A direct link would be preferable?
8272 Inst_Node := Next (True_Parent);
8274 while Present (Inst_Node)
8275 and then Nkind (Inst_Node) /= N_Package_Instantiation
8280 -- If the instance appears within a generic, and the generic
8281 -- unit is defined within a formal package of the enclosing
8282 -- generic, there is no generic body available, and none
8283 -- needed. A more precise test should be used ???
8285 if No (Inst_Node) then
8291 True_Parent := Parent (True_Parent);
8295 -- Case where we are currently instantiating a nested generic
8297 if Present (Inst_Node) then
8298 if Nkind (Parent (True_Parent)) = N_Compilation_Unit then
8300 -- Instantiation node and declaration of instantiated package
8301 -- were exchanged when only the declaration was needed.
8302 -- Restore instantiation node before proceeding with body.
8304 Set_Unit (Parent (True_Parent), Inst_Node);
8307 -- Now complete instantiation of enclosing body, if it appears
8308 -- in some other unit. If it appears in the current unit, the
8309 -- body will have been instantiated already.
8311 if No (Corresponding_Body (Instance_Spec (Inst_Node))) then
8313 -- We need to determine the expander mode to instantiate
8314 -- the enclosing body. Because the generic body we need
8315 -- may use global entities declared in the enclosing package
8316 -- (including aggregates) it is in general necessary to
8317 -- compile this body with expansion enabled. The exception
8318 -- is if we are within a generic package, in which case
8319 -- the usual generic rule applies.
8322 Exp_Status : Boolean := True;
8326 -- Loop through scopes looking for generic package
8328 Scop := Scope (Defining_Entity (Instance_Spec (Inst_Node)));
8329 while Present (Scop)
8330 and then Scop /= Standard_Standard
8332 if Ekind (Scop) = E_Generic_Package then
8333 Exp_Status := False;
8337 Scop := Scope (Scop);
8340 Instantiate_Package_Body
8341 (Pending_Body_Info'(
8342 Inst_Node, True_Parent, Exp_Status,
8343 Get_Code_Unit (Sloc (Inst_Node))));
8347 -- Case where we are not instantiating a nested generic
8350 Opt.Style_Check := False;
8351 Expander_Mode_Save_And_Set (True);
8352 Load_Needed_Body (Comp_Unit, OK);
8353 Opt.Style_Check := Save_Style_Check;
8354 Expander_Mode_Restore;
8357 and then Unit_Requires_Body (Defining_Entity (Spec))
8360 Bname : constant Unit_Name_Type :=
8361 Get_Body_Name (Get_Unit_Name (Unit (Comp_Unit)));
8364 Error_Msg_Unit_1 := Bname;
8365 Error_Msg_N ("this instantiation requires$!", N);
8367 Get_File_Name (Bname, Subunit => False);
8368 Error_Msg_N ("\but file{ was not found!", N);
8369 raise Unrecoverable_Error;
8375 -- If loading the parent of the generic caused an instantiation
8376 -- circularity, we abandon compilation at this point, because
8377 -- otherwise in some cases we get into trouble with infinite
8378 -- recursions after this point.
8380 if Circularity_Detected then
8381 raise Unrecoverable_Error;
8383 end Load_Parent_Of_Generic;
8385 -----------------------
8386 -- Move_Freeze_Nodes --
8387 -----------------------
8389 procedure Move_Freeze_Nodes
8390 (Out_Of : Entity_Id;
8395 Next_Decl : Node_Id;
8396 Next_Node : Node_Id := After;
8399 function Is_Outer_Type (T : Entity_Id) return Boolean;
8400 -- Check whether entity is declared in a scope external to that
8401 -- of the generic unit.
8407 function Is_Outer_Type (T : Entity_Id) return Boolean is
8408 Scop : Entity_Id := Scope (T);
8411 if Scope_Depth (Scop) < Scope_Depth (Out_Of) then
8415 while Scop /= Standard_Standard loop
8417 if Scop = Out_Of then
8420 Scop := Scope (Scop);
8428 -- Start of processing for Move_Freeze_Nodes
8435 -- First remove the freeze nodes that may appear before all other
8439 while Present (Decl)
8440 and then Nkind (Decl) = N_Freeze_Entity
8441 and then Is_Outer_Type (Entity (Decl))
8443 Decl := Remove_Head (L);
8444 Insert_After (Next_Node, Decl);
8445 Set_Analyzed (Decl, False);
8450 -- Next scan the list of declarations and remove each freeze node that
8451 -- appears ahead of the current node.
8453 while Present (Decl) loop
8454 while Present (Next (Decl))
8455 and then Nkind (Next (Decl)) = N_Freeze_Entity
8456 and then Is_Outer_Type (Entity (Next (Decl)))
8458 Next_Decl := Remove_Next (Decl);
8459 Insert_After (Next_Node, Next_Decl);
8460 Set_Analyzed (Next_Decl, False);
8461 Next_Node := Next_Decl;
8464 -- If the declaration is a nested package or concurrent type, then
8465 -- recurse. Nested generic packages will have been processed from the
8468 if Nkind (Decl) = N_Package_Declaration then
8469 Spec := Specification (Decl);
8471 elsif Nkind (Decl) = N_Task_Type_Declaration then
8472 Spec := Task_Definition (Decl);
8474 elsif Nkind (Decl) = N_Protected_Type_Declaration then
8475 Spec := Protected_Definition (Decl);
8481 if Present (Spec) then
8482 Move_Freeze_Nodes (Out_Of, Next_Node,
8483 Visible_Declarations (Spec));
8484 Move_Freeze_Nodes (Out_Of, Next_Node,
8485 Private_Declarations (Spec));
8490 end Move_Freeze_Nodes;
8496 function Next_Assoc (E : Assoc_Ptr) return Assoc_Ptr is
8498 return Generic_Renamings.Table (E).Next_In_HTable;
8501 ------------------------
8502 -- Preanalyze_Actuals --
8503 ------------------------
8505 procedure Pre_Analyze_Actuals (N : Node_Id) is
8508 Errs : constant Int := Serious_Errors_Detected;
8511 Assoc := First (Generic_Associations (N));
8513 while Present (Assoc) loop
8514 Act := Explicit_Generic_Actual_Parameter (Assoc);
8516 -- Within a nested instantiation, a defaulted actual is an
8517 -- empty association, so nothing to analyze. If the actual for
8518 -- a subprogram is an attribute, analyze prefix only, because
8519 -- actual is not a complete attribute reference.
8521 -- If actual is an allocator, analyze expression only. The full
8522 -- analysis can generate code, and if the instance is a compilation
8523 -- unit we have to wait until the package instance is installed to
8524 -- have a proper place to insert this code.
8526 -- String literals may be operators, but at this point we do not
8527 -- know whether the actual is a formal subprogram or a string.
8532 elsif Nkind (Act) = N_Attribute_Reference then
8533 Analyze (Prefix (Act));
8535 elsif Nkind (Act) = N_Explicit_Dereference then
8536 Analyze (Prefix (Act));
8538 elsif Nkind (Act) = N_Allocator then
8540 Expr : constant Node_Id := Expression (Act);
8543 if Nkind (Expr) = N_Subtype_Indication then
8544 Analyze (Subtype_Mark (Expr));
8545 Analyze_List (Constraints (Constraint (Expr)));
8551 elsif Nkind (Act) /= N_Operator_Symbol then
8555 if Errs /= Serious_Errors_Detected then
8556 Abandon_Instantiation (Act);
8561 end Pre_Analyze_Actuals;
8567 procedure Remove_Parent (In_Body : Boolean := False) is
8568 S : Entity_Id := Current_Scope;
8574 -- After child instantiation is complete, remove from scope stack
8575 -- the extra copy of the current scope, and then remove parent
8581 while Current_Scope /= S loop
8583 End_Package_Scope (Current_Scope);
8585 if In_Open_Scopes (P) then
8586 E := First_Entity (P);
8588 while Present (E) loop
8589 Set_Is_Immediately_Visible (E, True);
8593 if Is_Generic_Instance (Current_Scope)
8594 and then P /= Current_Scope
8596 -- We are within an instance of some sibling. Retain
8597 -- visibility of parent, for proper subsequent cleanup.
8599 Set_In_Private_Part (P);
8602 elsif not In_Open_Scopes (Scope (P)) then
8603 Set_Is_Immediately_Visible (P, False);
8607 -- Reset visibility of entities in the enclosing scope.
8609 Set_Is_Hidden_Open_Scope (Current_Scope, False);
8610 Hidden := First_Elmt (Hidden_Entities);
8612 while Present (Hidden) loop
8613 Set_Is_Immediately_Visible (Node (Hidden), True);
8618 -- Each body is analyzed separately, and there is no context
8619 -- that needs preserving from one body instance to the next,
8620 -- so remove all parent scopes that have been installed.
8622 while Present (S) loop
8623 End_Package_Scope (S);
8624 Set_Is_Immediately_Visible (S, False);
8626 exit when S = Standard_Standard;
8636 procedure Restore_Env is
8637 Saved : Instance_Env renames Instance_Envs.Table (Instance_Envs.Last);
8640 Ada_83 := Saved.Ada_83;
8642 if No (Current_Instantiated_Parent.Act_Id) then
8644 -- Restore environment after subprogram inlining
8646 Restore_Private_Views (Empty);
8649 Current_Instantiated_Parent := Saved.Instantiated_Parent;
8650 Exchanged_Views := Saved.Exchanged_Views;
8651 Hidden_Entities := Saved.Hidden_Entities;
8652 Current_Sem_Unit := Saved.Current_Sem_Unit;
8654 Instance_Envs.Decrement_Last;
8657 ---------------------------
8658 -- Restore_Private_Views --
8659 ---------------------------
8661 procedure Restore_Private_Views
8662 (Pack_Id : Entity_Id;
8663 Is_Package : Boolean := True)
8672 M := First_Elmt (Exchanged_Views);
8673 while Present (M) loop
8676 -- Subtypes of types whose views have been exchanged, and that
8677 -- are defined within the instance, were not on the list of
8678 -- Private_Dependents on entry to the instance, so they have to
8679 -- be exchanged explicitly now, in order to remain consistent with
8680 -- the view of the parent type.
8682 if Ekind (Typ) = E_Private_Type
8683 or else Ekind (Typ) = E_Limited_Private_Type
8684 or else Ekind (Typ) = E_Record_Type_With_Private
8686 Dep_Elmt := First_Elmt (Private_Dependents (Typ));
8688 while Present (Dep_Elmt) loop
8689 Dep_Typ := Node (Dep_Elmt);
8691 if Scope (Dep_Typ) = Pack_Id
8692 and then Present (Full_View (Dep_Typ))
8694 Replace_Elmt (Dep_Elmt, Full_View (Dep_Typ));
8695 Exchange_Declarations (Dep_Typ);
8698 Next_Elmt (Dep_Elmt);
8702 Exchange_Declarations (Node (M));
8706 if No (Pack_Id) then
8710 -- Make the generic formal parameters private, and make the formal
8711 -- types into subtypes of the actuals again.
8713 E := First_Entity (Pack_Id);
8715 while Present (E) loop
8716 Set_Is_Hidden (E, True);
8719 and then Nkind (Parent (E)) = N_Subtype_Declaration
8721 Set_Is_Generic_Actual_Type (E, False);
8723 -- An unusual case of aliasing: the actual may also be directly
8724 -- visible in the generic, and be private there, while it is
8725 -- fully visible in the context of the instance. The internal
8726 -- subtype is private in the instance, but has full visibility
8727 -- like its parent in the enclosing scope. This enforces the
8728 -- invariant that the privacy status of all private dependents of
8729 -- a type coincide with that of the parent type. This can only
8730 -- happen when a generic child unit is instantiated within a
8733 if Is_Private_Type (E)
8734 and then not Is_Private_Type (Etype (E))
8736 Exchange_Declarations (E);
8739 elsif Ekind (E) = E_Package then
8741 -- The end of the renaming list is the renaming of the generic
8742 -- package itself. If the instance is a subprogram, all entities
8743 -- in the corresponding package are renamings. If this entity is
8744 -- a formal package, make its own formals private as well. The
8745 -- actual in this case is itself the renaming of an instantation.
8746 -- If the entity is not a package renaming, it is the entity
8747 -- created to validate formal package actuals: ignore.
8749 -- If the actual is itself a formal package for the enclosing
8750 -- generic, or the actual for such a formal package, it remains
8751 -- visible after the current instance, and therefore nothing
8752 -- needs to be done either, except to keep it accessible.
8755 and then Renamed_Object (E) = Pack_Id
8759 elsif Nkind (Parent (E)) /= N_Package_Renaming_Declaration then
8762 elsif Denotes_Formal_Package (Renamed_Object (E)) then
8763 Set_Is_Hidden (E, False);
8767 Act_P : constant Entity_Id := Renamed_Object (E);
8771 Id := First_Entity (Act_P);
8773 and then Id /= First_Private_Entity (Act_P)
8775 Set_Is_Hidden (Id, True);
8776 Set_Is_Potentially_Use_Visible (Id, In_Use (Act_P));
8777 exit when Ekind (Id) = E_Package
8778 and then Renamed_Object (Id) = Act_P;
8789 end Restore_Private_Views;
8796 (Gen_Unit : Entity_Id;
8797 Act_Unit : Entity_Id)
8801 Set_Instance_Env (Gen_Unit, Act_Unit);
8804 ----------------------------
8805 -- Save_Global_References --
8806 ----------------------------
8808 procedure Save_Global_References (N : Node_Id) is
8809 Gen_Scope : Entity_Id;
8813 function Is_Global (E : Entity_Id) return Boolean;
8814 -- Check whether entity is defined outside of generic unit.
8815 -- Examine the scope of an entity, and the scope of the scope,
8816 -- etc, until we find either Standard, in which case the entity
8817 -- is global, or the generic unit itself, which indicates that
8818 -- the entity is local. If the entity is the generic unit itself,
8819 -- as in the case of a recursive call, or the enclosing generic unit,
8820 -- if different from the current scope, then it is local as well,
8821 -- because it will be replaced at the point of instantiation. On
8822 -- the other hand, if it is a reference to a child unit of a common
8823 -- ancestor, which appears in an instantiation, it is global because
8824 -- it is used to denote a specific compilation unit at the time the
8825 -- instantiations will be analyzed.
8827 procedure Reset_Entity (N : Node_Id);
8828 -- Save semantic information on global entity, so that it is not
8829 -- resolved again at instantiation time.
8831 procedure Save_Entity_Descendants (N : Node_Id);
8832 -- Apply Save_Global_References to the two syntactic descendants of
8833 -- non-terminal nodes that carry an Associated_Node and are processed
8834 -- through Reset_Entity. Once the global entity (if any) has been
8835 -- captured together with its type, only two syntactic descendants
8836 -- need to be traversed to complete the processing of the tree rooted
8837 -- at N. This applies to Selected_Components, Expanded_Names, and to
8838 -- Operator nodes. N can also be a character literal, identifier, or
8839 -- operator symbol node, but the call has no effect in these cases.
8841 procedure Save_Global_Defaults (N1, N2 : Node_Id);
8842 -- Default actuals in nested instances must be handled specially
8843 -- because there is no link to them from the original tree. When an
8844 -- actual subprogram is given by a default, we add an explicit generic
8845 -- association for it in the instantiation node. When we save the
8846 -- global references on the name of the instance, we recover the list
8847 -- of generic associations, and add an explicit one to the original
8848 -- generic tree, through which a global actual can be preserved.
8849 -- Similarly, if a child unit is instantiated within a sibling, in the
8850 -- context of the parent, we must preserve the identifier of the parent
8851 -- so that it can be properly resolved in a subsequent instantiation.
8853 procedure Save_Global_Descendant (D : Union_Id);
8854 -- Apply Save_Global_References recursively to the descendents of
8857 procedure Save_References (N : Node_Id);
8858 -- This is the recursive procedure that does the work, once the
8859 -- enclosing generic scope has been established.
8865 function Is_Global (E : Entity_Id) return Boolean is
8866 Se : Entity_Id := Scope (E);
8868 function Is_Instance_Node (Decl : Node_Id) return Boolean;
8869 -- Determine whether the parent node of a reference to a child unit
8870 -- denotes an instantiation or a formal package, in which case the
8871 -- reference to the child unit is global, even if it appears within
8872 -- the current scope (e.g. when the instance appears within the body
8875 function Is_Instance_Node (Decl : Node_Id) return Boolean is
8877 return (Nkind (Decl) in N_Generic_Instantiation
8879 Nkind (Original_Node (Decl)) = N_Formal_Package_Declaration);
8880 end Is_Instance_Node;
8882 -- Start of processing for Is_Global
8885 if E = Gen_Scope then
8888 elsif E = Standard_Standard then
8891 elsif Is_Child_Unit (E)
8892 and then (Is_Instance_Node (Parent (N2))
8893 or else (Nkind (Parent (N2)) = N_Expanded_Name
8894 and then N2 = Selector_Name (Parent (N2))
8895 and then Is_Instance_Node (Parent (Parent (N2)))))
8900 while Se /= Gen_Scope loop
8901 if Se = Standard_Standard then
8916 procedure Reset_Entity (N : Node_Id) is
8918 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id);
8919 -- The type of N2 is global to the generic unit. Save the
8920 -- type in the generic node.
8922 function Top_Ancestor (E : Entity_Id) return Entity_Id;
8923 -- Find the ultimate ancestor of the current unit. If it is
8924 -- not a generic unit, then the name of the current unit
8925 -- in the prefix of an expanded name must be replaced with
8926 -- its generic homonym to ensure that it will be properly
8927 -- resolved in an instance.
8929 ---------------------
8930 -- Set_Global_Type --
8931 ---------------------
8933 procedure Set_Global_Type (N : Node_Id; N2 : Node_Id) is
8934 Typ : constant Entity_Id := Etype (N2);
8940 and then Has_Private_View (Entity (N))
8942 -- If the entity of N is not the associated node, this is
8943 -- a nested generic and it has an associated node as well,
8944 -- whose type is already the full view (see below). Indicate
8945 -- that the original node has a private view.
8947 Set_Has_Private_View (N);
8950 -- If not a private type, nothing else to do
8952 if not Is_Private_Type (Typ) then
8953 if Is_Array_Type (Typ)
8954 and then Is_Private_Type (Component_Type (Typ))
8956 Set_Has_Private_View (N);
8959 -- If it is a derivation of a private type in a context where
8960 -- no full view is needed, nothing to do either.
8962 elsif No (Full_View (Typ)) and then Typ /= Etype (Typ) then
8965 -- Otherwise mark the type for flipping and use the full_view
8969 Set_Has_Private_View (N);
8971 if Present (Full_View (Typ)) then
8972 Set_Etype (N2, Full_View (Typ));
8975 end Set_Global_Type;
8981 function Top_Ancestor (E : Entity_Id) return Entity_Id is
8982 Par : Entity_Id := E;
8985 while Is_Child_Unit (Par) loop
8992 -- Start of processing for Reset_Entity
8995 N2 := Get_Associated_Node (N);
8999 if Is_Global (E) then
9000 Set_Global_Type (N, N2);
9002 elsif Nkind (N) = N_Op_Concat
9003 and then Is_Generic_Type (Etype (N2))
9005 (Base_Type (Etype (Right_Opnd (N2))) = Etype (N2)
9006 or else Base_Type (Etype (Left_Opnd (N2))) = Etype (N2))
9007 and then Is_Intrinsic_Subprogram (E)
9012 -- Entity is local. Mark generic node as unresolved.
9013 -- Note that now it does not have an entity.
9015 Set_Associated_Node (N, Empty);
9016 Set_Etype (N, Empty);
9019 if (Nkind (Parent (N)) = N_Package_Instantiation
9020 or else Nkind (Parent (N)) = N_Function_Instantiation
9021 or else Nkind (Parent (N)) = N_Procedure_Instantiation)
9022 and then N = Name (Parent (N))
9024 Save_Global_Defaults (Parent (N), Parent (N2));
9027 elsif Nkind (Parent (N)) = N_Selected_Component
9028 and then Nkind (Parent (N2)) = N_Expanded_Name
9031 if Is_Global (Entity (Parent (N2))) then
9032 Change_Selected_Component_To_Expanded_Name (Parent (N));
9033 Set_Associated_Node (Parent (N), Parent (N2));
9034 Set_Global_Type (Parent (N), Parent (N2));
9035 Save_Entity_Descendants (N);
9037 -- If this is a reference to the current generic entity,
9038 -- replace by the name of the generic homonym of the current
9039 -- package. This is because in an instantiation Par.P.Q will
9040 -- not resolve to the name of the instance, whose enclosing
9041 -- scope is not necessarily Par. We use the generic homonym
9042 -- rather that the name of the generic itself, because it may
9043 -- be hidden by a local declaration.
9045 elsif In_Open_Scopes (Entity (Parent (N2)))
9047 Is_Generic_Unit (Top_Ancestor (Entity (Prefix (Parent (N2)))))
9049 if Ekind (Entity (Parent (N2))) = E_Generic_Package then
9050 Rewrite (Parent (N),
9051 Make_Identifier (Sloc (N),
9053 Chars (Generic_Homonym (Entity (Parent (N2))))));
9055 Rewrite (Parent (N),
9056 Make_Identifier (Sloc (N),
9057 Chars => Chars (Selector_Name (Parent (N2)))));
9061 if (Nkind (Parent (Parent (N))) = N_Package_Instantiation
9062 or else Nkind (Parent (Parent (N)))
9063 = N_Function_Instantiation
9064 or else Nkind (Parent (Parent (N)))
9065 = N_Procedure_Instantiation)
9066 and then Parent (N) = Name (Parent (Parent (N)))
9068 Save_Global_Defaults
9069 (Parent (Parent (N)), Parent (Parent ((N2))));
9072 -- A selected component may denote a static constant that has
9073 -- been folded. Make the same replacement in original tree.
9075 elsif Nkind (Parent (N)) = N_Selected_Component
9076 and then (Nkind (Parent (N2)) = N_Integer_Literal
9077 or else Nkind (Parent (N2)) = N_Real_Literal)
9079 Rewrite (Parent (N),
9080 New_Copy (Parent (N2)));
9081 Set_Analyzed (Parent (N), False);
9083 -- A selected component may be transformed into a parameterless
9084 -- function call. If the called entity is global, rewrite the
9085 -- node appropriately, i.e. as an extended name for the global
9088 elsif Nkind (Parent (N)) = N_Selected_Component
9089 and then Nkind (Parent (N2)) = N_Function_Call
9090 and then Is_Global (Entity (Name (Parent (N2))))
9092 Change_Selected_Component_To_Expanded_Name (Parent (N));
9093 Set_Associated_Node (Parent (N), Name (Parent (N2)));
9094 Set_Global_Type (Parent (N), Name (Parent (N2)));
9095 Save_Entity_Descendants (N);
9098 -- Entity is local. Reset in generic unit, so that node
9099 -- is resolved anew at the point of instantiation.
9101 Set_Associated_Node (N, Empty);
9102 Set_Etype (N, Empty);
9106 -----------------------------
9107 -- Save_Entity_Descendants --
9108 -----------------------------
9110 procedure Save_Entity_Descendants (N : Node_Id) is
9114 Save_Global_Descendant (Union_Id (Left_Opnd (N)));
9115 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
9118 Save_Global_Descendant (Union_Id (Right_Opnd (N)));
9120 when N_Expanded_Name | N_Selected_Component =>
9121 Save_Global_Descendant (Union_Id (Prefix (N)));
9122 Save_Global_Descendant (Union_Id (Selector_Name (N)));
9124 when N_Identifier | N_Character_Literal | N_Operator_Symbol =>
9128 raise Program_Error;
9130 end Save_Entity_Descendants;
9132 --------------------------
9133 -- Save_Global_Defaults --
9134 --------------------------
9136 procedure Save_Global_Defaults (N1, N2 : Node_Id) is
9137 Loc : constant Source_Ptr := Sloc (N1);
9138 Assoc2 : constant List_Id := Generic_Associations (N2);
9139 Gen_Id : constant Entity_Id := Get_Generic_Entity (N2);
9149 Assoc1 := Generic_Associations (N1);
9151 if Present (Assoc1) then
9152 Act1 := First (Assoc1);
9155 Set_Generic_Associations (N1, New_List);
9156 Assoc1 := Generic_Associations (N1);
9159 if Present (Assoc2) then
9160 Act2 := First (Assoc2);
9165 while Present (Act1) and then Present (Act2) loop
9170 -- Find the associations added for default suprograms.
9172 if Present (Act2) then
9173 while Nkind (Act2) /= N_Generic_Association
9174 or else No (Entity (Selector_Name (Act2)))
9175 or else not Is_Overloadable (Entity (Selector_Name (Act2)))
9180 -- Add a similar association if the default is global. The
9181 -- renaming declaration for the actual has been analyzed, and
9182 -- its alias is the program it renames. Link the actual in the
9183 -- original generic tree with the node in the analyzed tree.
9185 while Present (Act2) loop
9186 Subp := Entity (Selector_Name (Act2));
9187 Def := Explicit_Generic_Actual_Parameter (Act2);
9189 -- Following test is defence against rubbish errors
9191 if No (Alias (Subp)) then
9195 -- Retrieve the resolved actual from the renaming declaration
9196 -- created for the instantiated formal.
9198 Actual := Entity (Name (Parent (Parent (Subp))));
9199 Set_Entity (Def, Actual);
9200 Set_Etype (Def, Etype (Actual));
9202 if Is_Global (Actual) then
9204 Make_Generic_Association (Loc,
9205 Selector_Name => New_Occurrence_Of (Subp, Loc),
9206 Explicit_Generic_Actual_Parameter =>
9207 New_Occurrence_Of (Actual, Loc));
9210 (Explicit_Generic_Actual_Parameter (Ndec), Def);
9212 Append (Ndec, Assoc1);
9214 -- If there are other defaults, add a dummy association
9215 -- in case there are other defaulted formals with the same
9218 elsif Present (Next (Act2)) then
9220 Make_Generic_Association (Loc,
9221 Selector_Name => New_Occurrence_Of (Subp, Loc),
9222 Explicit_Generic_Actual_Parameter => Empty);
9224 Append (Ndec, Assoc1);
9231 if Nkind (Name (N1)) = N_Identifier
9232 and then Is_Child_Unit (Gen_Id)
9233 and then Is_Global (Gen_Id)
9234 and then Is_Generic_Unit (Scope (Gen_Id))
9235 and then In_Open_Scopes (Scope (Gen_Id))
9237 -- This is an instantiation of a child unit within a sibling,
9238 -- so that the generic parent is in scope. An eventual instance
9239 -- must occur within the scope of an instance of the parent.
9240 -- Make name in instance into an expanded name, to preserve the
9241 -- identifier of the parent, so it can be resolved subsequently.
9244 Make_Expanded_Name (Loc,
9245 Chars => Chars (Gen_Id),
9246 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
9247 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
9248 Set_Entity (Name (N2), Gen_Id);
9251 Make_Expanded_Name (Loc,
9252 Chars => Chars (Gen_Id),
9253 Prefix => New_Occurrence_Of (Scope (Gen_Id), Loc),
9254 Selector_Name => New_Occurrence_Of (Gen_Id, Loc)));
9256 Set_Associated_Node (Name (N1), Name (N2));
9257 Set_Associated_Node (Prefix (Name (N1)), Empty);
9259 (Selector_Name (Name (N1)), Selector_Name (Name (N2)));
9260 Set_Etype (Name (N1), Etype (Gen_Id));
9263 end Save_Global_Defaults;
9265 ----------------------------
9266 -- Save_Global_Descendant --
9267 ----------------------------
9269 procedure Save_Global_Descendant (D : Union_Id) is
9273 if D in Node_Range then
9274 if D = Union_Id (Empty) then
9277 elsif Nkind (Node_Id (D)) /= N_Compilation_Unit then
9278 Save_References (Node_Id (D));
9281 elsif D in List_Range then
9282 if D = Union_Id (No_List)
9283 or else Is_Empty_List (List_Id (D))
9288 N1 := First (List_Id (D));
9289 while Present (N1) loop
9290 Save_References (N1);
9295 -- Element list or other non-node field, nothing to do
9300 end Save_Global_Descendant;
9302 ---------------------
9303 -- Save_References --
9304 ---------------------
9306 -- This is the recursive procedure that does the work, once the
9307 -- enclosing generic scope has been established. We have to treat
9308 -- specially a number of node rewritings that are required by semantic
9309 -- processing and which change the kind of nodes in the generic copy:
9310 -- typically constant-folding, replacing an operator node by a string
9311 -- literal, or a selected component by an expanded name. In each of
9312 -- those cases, the transformation is propagated to the generic unit.
9314 procedure Save_References (N : Node_Id) is
9319 elsif Nkind (N) = N_Character_Literal
9320 or else Nkind (N) = N_Operator_Symbol
9322 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
9325 elsif Nkind (N) = N_Operator_Symbol
9326 and then Nkind (Get_Associated_Node (N)) = N_String_Literal
9328 Change_Operator_Symbol_To_String_Literal (N);
9331 elsif Nkind (N) in N_Op then
9333 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
9335 if Nkind (N) = N_Op_Concat then
9336 Set_Is_Component_Left_Opnd (N,
9337 Is_Component_Left_Opnd (Get_Associated_Node (N)));
9339 Set_Is_Component_Right_Opnd (N,
9340 Is_Component_Right_Opnd (Get_Associated_Node (N)));
9345 -- Node may be transformed into call to a user-defined operator
9347 N2 := Get_Associated_Node (N);
9349 if Nkind (N2) = N_Function_Call then
9350 E := Entity (Name (N2));
9353 and then Is_Global (E)
9355 Set_Etype (N, Etype (N2));
9357 Set_Associated_Node (N, Empty);
9358 Set_Etype (N, Empty);
9361 elsif Nkind (N2) = N_Integer_Literal
9362 or else Nkind (N2) = N_Real_Literal
9363 or else Nkind (N2) = N_String_Literal
9365 -- Operation was constant-folded, perform the same
9366 -- replacement in generic.
9368 Rewrite (N, New_Copy (N2));
9369 Set_Analyzed (N, False);
9371 elsif Nkind (N2) = N_Identifier
9372 and then Ekind (Entity (N2)) = E_Enumeration_Literal
9374 -- Same if call was folded into a literal, but in this
9375 -- case retain the entity to avoid spurious ambiguities
9376 -- if id is overloaded at the point of instantiation or
9379 Rewrite (N, New_Copy (N2));
9380 Set_Associated_Node (N, N2);
9381 Set_Analyzed (N, False);
9385 -- Complete the check on operands, if node has not been
9388 if Nkind (N) in N_Op then
9389 Save_Entity_Descendants (N);
9392 elsif Nkind (N) = N_Identifier then
9393 if Nkind (N) = Nkind (Get_Associated_Node (N)) then
9395 -- If this is a discriminant reference, always save it.
9396 -- It is used in the instance to find the corresponding
9397 -- discriminant positionally rather than by name.
9399 Set_Original_Discriminant
9400 (N, Original_Discriminant (Get_Associated_Node (N)));
9404 N2 := Get_Associated_Node (N);
9406 if Nkind (N2) = N_Function_Call then
9407 E := Entity (Name (N2));
9409 -- Name resolves to a call to parameterless function.
9410 -- If original entity is global, mark node as resolved.
9413 and then Is_Global (E)
9415 Set_Etype (N, Etype (N2));
9417 Set_Associated_Node (N, Empty);
9418 Set_Etype (N, Empty);
9422 Nkind (N2) = N_Integer_Literal or else
9423 Nkind (N2) = N_Real_Literal or else
9424 Nkind (N2) = N_String_Literal
9426 -- Name resolves to named number that is constant-folded,
9427 -- or to string literal from concatenation.
9428 -- Perform the same replacement in generic.
9430 Rewrite (N, New_Copy (N2));
9431 Set_Analyzed (N, False);
9433 elsif Nkind (N2) = N_Explicit_Dereference then
9435 -- An identifier is rewritten as a dereference if it is
9436 -- the prefix in a selected component, and it denotes an
9437 -- access to a composite type, or a parameterless function
9438 -- call that returns an access type.
9440 -- Check whether corresponding entity in prefix is global.
9442 if Is_Entity_Name (Prefix (N2))
9443 and then Present (Entity (Prefix (N2)))
9444 and then Is_Global (Entity (Prefix (N2)))
9447 Make_Explicit_Dereference (Sloc (N),
9448 Prefix => Make_Identifier (Sloc (N),
9449 Chars => Chars (N))));
9450 Set_Associated_Node (Prefix (N), Prefix (N2));
9452 elsif Nkind (Prefix (N2)) = N_Function_Call
9453 and then Is_Global (Entity (Name (Prefix (N2))))
9456 Make_Explicit_Dereference (Sloc (N),
9457 Prefix => Make_Function_Call (Sloc (N),
9459 Make_Identifier (Sloc (N),
9460 Chars => Chars (N)))));
9463 (Name (Prefix (N)), Name (Prefix (N2)));
9466 Set_Associated_Node (N, Empty);
9467 Set_Etype (N, Empty);
9470 -- The subtype mark of a nominally unconstrained object
9471 -- is rewritten as a subtype indication using the bounds
9472 -- of the expression. Recover the original subtype mark.
9474 elsif Nkind (N2) = N_Subtype_Indication
9475 and then Is_Entity_Name (Original_Node (N2))
9477 Set_Associated_Node (N, Original_Node (N2));
9485 elsif Nkind (N) in N_Entity then
9490 use Atree.Unchecked_Access;
9491 -- This code section is part of implementing an untyped tree
9492 -- traversal, so it needs direct access to node fields.
9495 if Nkind (N) = N_Aggregate
9497 Nkind (N) = N_Extension_Aggregate
9499 N2 := Get_Associated_Node (N);
9502 or else No (Etype (N2))
9503 or else not Is_Global (Etype (N2))
9505 Set_Associated_Node (N, Empty);
9508 Save_Global_Descendant (Field1 (N));
9509 Save_Global_Descendant (Field2 (N));
9510 Save_Global_Descendant (Field3 (N));
9511 Save_Global_Descendant (Field5 (N));
9513 -- All other cases than aggregates
9516 Save_Global_Descendant (Field1 (N));
9517 Save_Global_Descendant (Field2 (N));
9518 Save_Global_Descendant (Field3 (N));
9519 Save_Global_Descendant (Field4 (N));
9520 Save_Global_Descendant (Field5 (N));
9524 end Save_References;
9526 -- Start of processing for Save_Global_References
9529 Gen_Scope := Current_Scope;
9531 -- If the generic unit is a child unit, references to entities in
9532 -- the parent are treated as local, because they will be resolved
9533 -- anew in the context of the instance of the parent.
9535 while Is_Child_Unit (Gen_Scope)
9536 and then Ekind (Scope (Gen_Scope)) = E_Generic_Package
9538 Gen_Scope := Scope (Gen_Scope);
9541 Save_References (N);
9542 end Save_Global_References;
9544 --------------------------------------
9545 -- Set_Copied_Sloc_For_Inlined_Body --
9546 --------------------------------------
9548 procedure Set_Copied_Sloc_For_Inlined_Body (N : Node_Id; E : Entity_Id) is
9550 Create_Instantiation_Source (N, E, True, S_Adjustment);
9551 end Set_Copied_Sloc_For_Inlined_Body;
9553 ---------------------
9554 -- Set_Instance_Of --
9555 ---------------------
9557 procedure Set_Instance_Of (A : Entity_Id; B : Entity_Id) is
9559 Generic_Renamings.Table (Generic_Renamings.Last) := (A, B, Assoc_Null);
9560 Generic_Renamings_HTable.Set (Generic_Renamings.Last);
9561 Generic_Renamings.Increment_Last;
9562 end Set_Instance_Of;
9564 --------------------
9565 -- Set_Next_Assoc --
9566 --------------------
9568 procedure Set_Next_Assoc (E : Assoc_Ptr; Next : Assoc_Ptr) is
9570 Generic_Renamings.Table (E).Next_In_HTable := Next;
9577 procedure Start_Generic is
9579 -- ??? I am sure more things could be factored out in this
9580 -- routine. Should probably be done at a later stage.
9582 Generic_Flags.Increment_Last;
9583 Generic_Flags.Table (Generic_Flags.Last) := Inside_A_Generic;
9584 Inside_A_Generic := True;
9586 Expander_Mode_Save_And_Set (False);
9589 ----------------------
9590 -- Set_Instance_Env --
9591 ----------------------
9593 procedure Set_Instance_Env
9594 (Gen_Unit : Entity_Id;
9595 Act_Unit : Entity_Id)
9599 -- Regardless of the current mode, predefined units are analyzed in
9600 -- Ada95 mode, and Ada83 checks don't apply.
9602 if Is_Internal_File_Name
9603 (Fname => Unit_File_Name (Get_Source_Unit (Gen_Unit)),
9604 Renamings_Included => True) then
9608 Current_Instantiated_Parent := (Gen_Unit, Act_Unit, Assoc_Null);
9609 end Set_Instance_Env;
9615 procedure Switch_View (T : Entity_Id) is
9616 BT : constant Entity_Id := Base_Type (T);
9617 Priv_Elmt : Elmt_Id := No_Elmt;
9618 Priv_Sub : Entity_Id;
9621 -- T may be private but its base type may have been exchanged through
9622 -- some other occurrence, in which case there is nothing to switch.
9624 if not Is_Private_Type (BT) then
9628 Priv_Elmt := First_Elmt (Private_Dependents (BT));
9630 if Present (Full_View (BT)) then
9631 Append_Elmt (Full_View (BT), Exchanged_Views);
9632 Exchange_Declarations (BT);
9635 while Present (Priv_Elmt) loop
9636 Priv_Sub := (Node (Priv_Elmt));
9638 -- We avoid flipping the subtype if the Etype of its full
9639 -- view is private because this would result in a malformed
9640 -- subtype. This occurs when the Etype of the subtype full
9641 -- view is the full view of the base type (and since the
9642 -- base types were just switched, the subtype is pointing
9643 -- to the wrong view). This is currently the case for
9644 -- tagged record types, access types (maybe more?) and
9645 -- needs to be resolved. ???
9647 if Present (Full_View (Priv_Sub))
9648 and then not Is_Private_Type (Etype (Full_View (Priv_Sub)))
9650 Append_Elmt (Full_View (Priv_Sub), Exchanged_Views);
9651 Exchange_Declarations (Priv_Sub);
9654 Next_Elmt (Priv_Elmt);
9658 -----------------------------
9659 -- Valid_Default_Attribute --
9660 -----------------------------
9662 procedure Valid_Default_Attribute (Nam : Entity_Id; Def : Node_Id) is
9663 Attr_Id : constant Attribute_Id :=
9664 Get_Attribute_Id (Attribute_Name (Def));
9665 T : constant Entity_Id := Entity (Prefix (Def));
9666 Is_Fun : constant Boolean := (Ekind (Nam) = E_Function);
9679 F := First_Formal (Nam);
9680 while Present (F) loop
9686 when Attribute_Adjacent | Attribute_Ceiling | Attribute_Copy_Sign |
9687 Attribute_Floor | Attribute_Fraction | Attribute_Machine |
9688 Attribute_Model | Attribute_Remainder | Attribute_Rounding |
9689 Attribute_Unbiased_Rounding =>
9692 and then Is_Floating_Point_Type (T);
9694 when Attribute_Image | Attribute_Pred | Attribute_Succ |
9695 Attribute_Value | Attribute_Wide_Image |
9696 Attribute_Wide_Value =>
9697 OK := (Is_Fun and then Num_F = 1 and then Is_Scalar_Type (T));
9699 when Attribute_Max | Attribute_Min =>
9700 OK := (Is_Fun and then Num_F = 2 and then Is_Scalar_Type (T));
9702 when Attribute_Input =>
9703 OK := (Is_Fun and then Num_F = 1);
9705 when Attribute_Output | Attribute_Read | Attribute_Write =>
9706 OK := (not Is_Fun and then Num_F = 2);
9713 Error_Msg_N ("attribute reference has wrong profile for subprogram",
9716 end Valid_Default_Attribute;