1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1998-2013, 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 3, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Atree
; use Atree
;
27 with Csets
; use Csets
;
28 with Elists
; use Elists
;
29 with Errout
; use Errout
;
30 with Nlists
; use Nlists
;
32 with Restrict
; use Restrict
;
33 with Rident
; use Rident
;
35 with Sem_Aux
; use Sem_Aux
;
36 with Sem_Prag
; use Sem_Prag
;
37 with Sem_Util
; use Sem_Util
;
38 with Sem_Warn
; use Sem_Warn
;
39 with Sinfo
; use Sinfo
;
40 with Sinput
; use Sinput
;
41 with Snames
; use Snames
;
42 with Stringt
; use Stringt
;
43 with Stand
; use Stand
;
44 with Table
; use Table
;
46 with GNAT
.Heap_Sort_G
;
49 package body Lib
.Xref
is
55 -- The Xref table is used to record references. The Loc field is set
56 -- to No_Location for a definition entry.
58 subtype Xref_Entry_Number
is Int
;
60 type Xref_Key
is record
61 -- These are the components of Xref_Entry that participate in hash
65 -- Entity referenced (E parameter to Generate_Reference)
68 -- Location of reference (Original_Location (Sloc field of N parameter
69 -- to Generate_Reference). Set to No_Location for the case of a
70 -- defining occurrence.
73 -- Reference type (Typ param to Generate_Reference)
75 Eun
: Unit_Number_Type
;
76 -- Unit number corresponding to Ent
78 Lun
: Unit_Number_Type
;
79 -- Unit number corresponding to Loc. Value is undefined and not
80 -- referenced if Loc is set to No_Location.
82 -- The following components are only used for SPARK cross-references
84 Ref_Scope
: Entity_Id
;
85 -- Entity of the closest subprogram or package enclosing the reference
87 Ent_Scope
: Entity_Id
;
88 -- Entity of the closest subprogram or package enclosing the definition,
89 -- which should be located in the same file as the definition itself.
92 type Xref_Entry
is record
95 Ent_Scope_File
: Unit_Number_Type
;
96 -- File for entity Ent_Scope
99 -- Original source location for entity being referenced. Note that these
100 -- values are used only during the output process, they are not set when
101 -- the entries are originally built. This is because private entities
102 -- can be swapped when the initial call is made.
104 HTable_Next
: Xref_Entry_Number
;
105 -- For use only by Static_HTable
108 package Xrefs
is new Table
.Table
(
109 Table_Component_Type
=> Xref_Entry
,
110 Table_Index_Type
=> Xref_Entry_Number
,
111 Table_Low_Bound
=> 1,
112 Table_Initial
=> Alloc
.Xrefs_Initial
,
113 Table_Increment
=> Alloc
.Xrefs_Increment
,
114 Table_Name
=> "Xrefs");
120 -- We keep a set of xref entries, in order to avoid inserting duplicate
121 -- entries into the above Xrefs table. An entry is in Xref_Set if and only
122 -- if it is in Xrefs.
124 Num_Buckets
: constant := 2**16;
126 subtype Header_Num
is Integer range 0 .. Num_Buckets
- 1;
127 type Null_Type
is null record;
128 pragma Unreferenced
(Null_Type
);
130 function Hash
(F
: Xref_Entry_Number
) return Header_Num
;
132 function Equal
(F1
, F2
: Xref_Entry_Number
) return Boolean;
134 procedure HT_Set_Next
(E
: Xref_Entry_Number
; Next
: Xref_Entry_Number
);
136 function HT_Next
(E
: Xref_Entry_Number
) return Xref_Entry_Number
;
138 function Get_Key
(E
: Xref_Entry_Number
) return Xref_Entry_Number
;
140 pragma Inline
(Hash
, Equal
, HT_Set_Next
, HT_Next
, Get_Key
);
142 package Xref_Set
is new GNAT
.HTable
.Static_HTable
(
144 Element
=> Xref_Entry
,
145 Elmt_Ptr
=> Xref_Entry_Number
,
147 Set_Next
=> HT_Set_Next
,
149 Key
=> Xref_Entry_Number
,
154 -----------------------------
155 -- SPARK Xrefs Information --
156 -----------------------------
158 package body SPARK_Specific
is separate;
160 ------------------------
161 -- Local Subprograms --
162 ------------------------
164 procedure Add_Entry
(Key
: Xref_Key
; Ent_Scope_File
: Unit_Number_Type
);
165 -- Add an entry to the tables of Xref_Entries, avoiding duplicates
167 procedure Generate_Prim_Op_References
(Typ
: Entity_Id
);
168 -- For a tagged type, generate implicit references to its primitive
169 -- operations, for source navigation. This is done right before emitting
170 -- cross-reference information rather than at the freeze point of the type
171 -- in order to handle late bodies that are primitive operations.
173 function Lt
(T1
, T2
: Xref_Entry
) return Boolean;
174 -- Order cross-references
180 procedure Add_Entry
(Key
: Xref_Key
; Ent_Scope_File
: Unit_Number_Type
) is
182 Xrefs
.Increment_Last
; -- tentative
183 Xrefs
.Table
(Xrefs
.Last
).Key
:= Key
;
185 -- Set the entry in Xref_Set, and if newly set, keep the above
186 -- tentative increment.
188 if Xref_Set
.Set_If_Not_Present
(Xrefs
.Last
) then
189 Xrefs
.Table
(Xrefs
.Last
).Ent_Scope_File
:= Ent_Scope_File
;
190 -- Leave Def and HTable_Next uninitialized
192 Set_Has_Xref_Entry
(Key
.Ent
);
194 -- It was already in Xref_Set, so throw away the tentatively-added
198 Xrefs
.Decrement_Last
;
206 function Equal
(F1
, F2
: Xref_Entry_Number
) return Boolean is
207 Result
: constant Boolean :=
208 Xrefs
.Table
(F1
).Key
= Xrefs
.Table
(F2
).Key
;
213 -------------------------
214 -- Generate_Definition --
215 -------------------------
217 procedure Generate_Definition
(E
: Entity_Id
) is
219 pragma Assert
(Nkind
(E
) in N_Entity
);
221 -- Note that we do not test Xref_Entity_Letters here. It is too early
222 -- to do so, since we are often called before the entity is fully
223 -- constructed, so that the Ekind is still E_Void.
227 -- Definition must come from source
229 -- We make an exception for subprogram child units that have no spec.
230 -- For these we generate a subprogram declaration for library use,
231 -- and the corresponding entity does not come from source.
232 -- Nevertheless, all references will be attached to it and we have
233 -- to treat is as coming from user code.
235 and then (Comes_From_Source
(E
) or else Is_Child_Unit
(E
))
237 -- And must have a reasonable source location that is not
238 -- within an instance (all entities in instances are ignored)
240 and then Sloc
(E
) > No_Location
241 and then Instantiation_Location
(Sloc
(E
)) = No_Location
243 -- And must be a non-internal name from the main source unit
245 and then In_Extended_Main_Source_Unit
(E
)
246 and then not Is_Internal_Name
(Chars
(E
))
252 Eun
=> Get_Source_Unit
(Original_Location
(Sloc
(E
))),
256 Ent_Scope_File
=> No_Unit
);
258 if In_Inlined_Body
then
262 end Generate_Definition
;
264 ---------------------------------
265 -- Generate_Operator_Reference --
266 ---------------------------------
268 procedure Generate_Operator_Reference
273 if not In_Extended_Main_Source_Unit
(N
) then
277 -- If the operator is not a Standard operator, then we generate a real
278 -- reference to the user defined operator.
280 if Sloc
(Entity
(N
)) /= Standard_Location
then
281 Generate_Reference
(Entity
(N
), N
);
283 -- A reference to an implicit inequality operator is also a reference
284 -- to the user-defined equality.
286 if Nkind
(N
) = N_Op_Ne
287 and then not Comes_From_Source
(Entity
(N
))
288 and then Present
(Corresponding_Equality
(Entity
(N
)))
290 Generate_Reference
(Corresponding_Equality
(Entity
(N
)), N
);
293 -- For the case of Standard operators, we mark the result type as
294 -- referenced. This ensures that in the case where we are using a
295 -- derived operator, we mark an entity of the unit that implicitly
296 -- defines this operator as used. Otherwise we may think that no entity
297 -- of the unit is used. The actual entity marked as referenced is the
298 -- first subtype, which is the relevant user defined entity.
300 -- Note: we only do this for operators that come from source. The
301 -- generated code sometimes reaches for entities that do not need to be
302 -- explicitly visible (for example, when we expand the code for
303 -- comparing two record objects, the fields of the record may not be
306 elsif Comes_From_Source
(N
) then
307 Set_Referenced
(First_Subtype
(T
));
309 end Generate_Operator_Reference
;
311 ---------------------------------
312 -- Generate_Prim_Op_References --
313 ---------------------------------
315 procedure Generate_Prim_Op_References
(Typ
: Entity_Id
) is
318 Prim_List
: Elist_Id
;
321 -- Handle subtypes of synchronized types
323 if Ekind
(Typ
) = E_Protected_Subtype
324 or else Ekind
(Typ
) = E_Task_Subtype
326 Base_T
:= Etype
(Typ
);
331 -- References to primitive operations are only relevant for tagged types
333 if not Is_Tagged_Type
(Base_T
)
334 or else Is_Class_Wide_Type
(Base_T
)
339 -- Ada 2005 (AI-345): For synchronized types generate reference to the
340 -- wrapper that allow us to dispatch calls through their implemented
341 -- abstract interface types.
343 -- The check for Present here is to protect against previously reported
346 Prim_List
:= Primitive_Operations
(Base_T
);
348 if No
(Prim_List
) then
352 Prim
:= First_Elmt
(Prim_List
);
353 while Present
(Prim
) loop
355 -- If the operation is derived, get the original for cross-reference
356 -- reference purposes (it is the original for which we want the xref
357 -- and for which the comes_from_source test must be performed).
360 (Typ
, Ultimate_Alias
(Node
(Prim
)), 'p', Set_Ref
=> False);
363 end Generate_Prim_Op_References
;
365 ------------------------
366 -- Generate_Reference --
367 ------------------------
369 procedure Generate_Reference
372 Typ
: Character := 'r';
373 Set_Ref
: Boolean := True;
374 Force
: Boolean := False)
376 Actual_Typ
: Character := Typ
;
380 Ent_Scope
: Entity_Id
;
385 Ref_Scope
: Entity_Id
;
387 function Get_Through_Renamings
(E
: Entity_Id
) return Entity_Id
;
388 -- Get the enclosing entity through renamings, which may come from
389 -- source or from the translation of generic instantiations.
391 function Is_On_LHS
(Node
: Node_Id
) return Boolean;
392 -- Used to check if a node is on the left hand side of an assignment.
393 -- The following cases are handled:
395 -- Variable Node is a direct descendant of left hand side of an
396 -- assignment statement.
398 -- Prefix Of an indexed or selected component that is present in
399 -- a subtree rooted by an assignment statement. There is
400 -- no restriction of nesting of components, thus cases
401 -- such as A.B (C).D are handled properly. However a prefix
402 -- of a dereference (either implicit or explicit) is never
403 -- considered as on a LHS.
405 -- Out param Same as above cases, but OUT parameter
407 function OK_To_Set_Referenced
return Boolean;
408 -- Returns True if the Referenced flag can be set. There are a few
409 -- exceptions where we do not want to set this flag, see body for
410 -- details of these exceptional cases.
412 ---------------------------
413 -- Get_Through_Renamings --
414 ---------------------------
416 function Get_Through_Renamings
(E
: Entity_Id
) return Entity_Id
is
417 Result
: Entity_Id
:= E
;
419 while Present
(Result
)
420 and then Is_Object
(Result
)
421 and then Present
(Renamed_Object
(Result
))
423 Result
:= Get_Enclosing_Object
(Renamed_Object
(Result
));
426 end Get_Through_Renamings
;
432 -- ??? There are several routines here and there that perform a similar
433 -- (but subtly different) computation, which should be factored:
436 -- Sem_Util.May_Be_Lvalue
437 -- Sem_Util.Known_To_Be_Assigned
438 -- Exp_Ch2.Expand_Entry_Parameter.In_Assignment_Context
439 -- Exp_Smem.Is_Out_Actual
441 function Is_On_LHS
(Node
: Node_Id
) return Boolean is
447 -- Only identifiers are considered, is this necessary???
449 if Nkind
(Node
) /= N_Identifier
then
453 -- Immediate return if appeared as OUT parameter
455 if Kind
= E_Out_Parameter
then
459 -- Search for assignment statement subtree root
466 if K
= N_Assignment_Statement
then
469 -- Check whether the parent is a component and the current node is
470 -- its prefix, but return False if the current node has an access
471 -- type, as in that case the selected or indexed component is an
472 -- implicit dereference, and the LHS is the designated object, not
473 -- the access object.
475 -- ??? case of a slice assignment?
477 elsif (K
= N_Selected_Component
or else K
= N_Indexed_Component
)
478 and then Prefix
(P
) = N
480 -- Check for access type. First a kludge, In some cases this is
481 -- called too early (see comments in Sem_Ch8.Find_Direct_Name),
482 -- at a point where the tree is not fully typed yet. In that
483 -- case we may lack an Etype for N, and we can't check the
484 -- Etype. For now, we always return False in such a case,
485 -- but this is clearly not right in all cases ???
487 if No
(Etype
(N
)) then
490 elsif Is_Access_Type
(Etype
(N
)) then
493 -- Access type case dealt with, keep going
499 -- All other cases, definitely not on left side
507 ---------------------------
508 -- OK_To_Set_Referenced --
509 ---------------------------
511 function OK_To_Set_Referenced
return Boolean is
515 -- A reference from a pragma Unreferenced or pragma Unmodified or
516 -- pragma Warnings does not cause the Referenced flag to be set.
517 -- This avoids silly warnings about things being referenced and
518 -- not assigned when the only reference is from the pragma.
520 if Nkind
(N
) = N_Identifier
then
523 if Nkind
(P
) = N_Pragma_Argument_Association
then
526 if Nkind
(P
) = N_Pragma
then
527 if Nam_In
(Pragma_Name
(P
), Name_Warnings
,
535 -- A reference to a formal in a named parameter association does
536 -- not make the formal referenced. Formals that are unused in the
537 -- subprogram body are properly flagged as such, even if calls
538 -- elsewhere use named notation.
540 elsif Nkind
(P
) = N_Parameter_Association
541 and then N
= Selector_Name
(P
)
548 end OK_To_Set_Referenced
;
550 -- Start of processing for Generate_Reference
553 pragma Assert
(Nkind
(E
) in N_Entity
);
554 Find_Actual
(N
, Formal
, Call
);
556 if Present
(Formal
) then
557 Kind
:= Ekind
(Formal
);
562 -- Check for obsolescent reference to package ASCII. GNAT treats this
563 -- element of annex J specially since in practice, programs make a lot
564 -- of use of this feature, so we don't include it in the set of features
565 -- diagnosed when Warn_On_Obsolescent_Features mode is set. However we
566 -- are required to note it as a violation of the RM defined restriction.
568 if E
= Standard_ASCII
then
569 Check_Restriction
(No_Obsolescent_Features
, N
);
572 -- Check for reference to entity marked with Is_Obsolescent
574 -- Note that we always allow obsolescent references in the compiler
575 -- itself and the run time, since we assume that we know what we are
576 -- doing in such cases. For example the calls in Ada.Characters.Handling
577 -- to its own obsolescent subprograms are just fine.
579 -- In any case we only generate warnings if we are in the extended main
580 -- source unit, and the entity itself is not in the extended main source
581 -- unit, since we assume the source unit itself knows what is going on
582 -- (and for sure we do not want silly warnings, e.g. on the end line of
583 -- an obsolescent procedure body).
585 if Is_Obsolescent
(E
)
586 and then not GNAT_Mode
587 and then not In_Extended_Main_Source_Unit
(E
)
588 and then In_Extended_Main_Source_Unit
(N
)
590 Check_Restriction
(No_Obsolescent_Features
, N
);
592 if Warn_On_Obsolescent_Feature
then
593 Output_Obsolescent_Entity_Warnings
(N
, E
);
597 -- Warn if reference to Ada 2005 entity not in Ada 2005 mode. We only
598 -- detect real explicit references (modifications and references).
600 if Comes_From_Source
(N
)
601 and then Is_Ada_2005_Only
(E
)
602 and then Ada_Version
< Ada_2005
603 and then Warn_On_Ada_2005_Compatibility
604 and then (Typ
= 'm' or else Typ
= 'r' or else Typ
= 's')
606 Error_Msg_NE
("& is only defined in Ada 2005?y?", N
, E
);
609 -- Warn if reference to Ada 2012 entity not in Ada 2012 mode. We only
610 -- detect real explicit references (modifications and references).
612 if Comes_From_Source
(N
)
613 and then Is_Ada_2012_Only
(E
)
614 and then Ada_Version
< Ada_2012
615 and then Warn_On_Ada_2012_Compatibility
616 and then (Typ
= 'm' or else Typ
= 'r')
618 Error_Msg_NE
("& is only defined in Ada 2012?y?", N
, E
);
621 -- Do not generate references if we are within a postcondition sub-
622 -- program, because the reference does not comes from source, and the
623 -- pre-analysis of the aspect has already created an entry for the ali
624 -- file at the proper source location.
626 if Chars
(Current_Scope
) = Name_uPostconditions
then
630 -- Never collect references if not in main source unit. However, we omit
631 -- this test if Typ is 'e' or 'k', since these entries are structural,
632 -- and it is useful to have them in units that reference packages as
633 -- well as units that define packages. We also omit the test for the
634 -- case of 'p' since we want to include inherited primitive operations
635 -- from other packages.
637 -- We also omit this test is this is a body reference for a subprogram
638 -- instantiation. In this case the reference is to the generic body,
639 -- which clearly need not be in the main unit containing the instance.
640 -- For the same reason we accept an implicit reference generated for
641 -- a default in an instance.
643 if not In_Extended_Main_Source_Unit
(N
) then
649 or else (Typ
= 'b' and then Is_Generic_Instance
(E
))
651 -- Allow the generation of references to reads, writes and calls
652 -- in SPARK mode when the related context comes from an instance.
656 and then In_Extended_Main_Code_Unit
(N
)
657 and then (Typ
= 'm' or else Typ
= 'r' or else Typ
= 's'))
665 -- For reference type p, the entity must be in main source unit
667 if Typ
= 'p' and then not In_Extended_Main_Source_Unit
(E
) then
671 -- Unless the reference is forced, we ignore references where the
672 -- reference itself does not come from source.
674 if not Force
and then not Comes_From_Source
(N
) then
678 -- Deal with setting entity as referenced, unless suppressed. Note that
679 -- we still do Set_Referenced on entities that do not come from source.
680 -- This situation arises when we have a source reference to a derived
681 -- operation, where the derived operation itself does not come from
682 -- source, but we still want to mark it as referenced, since we really
683 -- are referencing an entity in the corresponding package (this avoids
684 -- wrong complaints that the package contains no referenced entities).
688 -- Assignable object appearing on left side of assignment or as
692 and then Is_On_LHS
(N
)
693 and then Ekind
(E
) /= E_In_Out_Parameter
695 -- For objects that are renamings, just set as simply referenced
696 -- we do not try to do assignment type tracking in this case.
698 if Present
(Renamed_Object
(E
)) then
701 -- Out parameter case
703 elsif Kind
= E_Out_Parameter
then
705 -- If warning mode for all out parameters is set, or this is
706 -- the only warning parameter, then we want to mark this for
707 -- later warning logic by setting Referenced_As_Out_Parameter
709 if Warn_On_Modified_As_Out_Parameter
(Formal
) then
710 Set_Referenced_As_Out_Parameter
(E
, True);
711 Set_Referenced_As_LHS
(E
, False);
713 -- For OUT parameter not covered by the above cases, we simply
714 -- regard it as a normal reference (in this case we do not
715 -- want any of the warning machinery for out parameters).
721 -- For the left hand of an assignment case, we do nothing here.
722 -- The processing for Analyze_Assignment_Statement will set the
723 -- Referenced_As_LHS flag.
729 -- Check for a reference in a pragma that should not count as a
730 -- making the variable referenced for warning purposes.
732 elsif Is_Non_Significant_Pragma_Reference
(N
) then
735 -- A reference in an attribute definition clause does not count as a
736 -- reference except for the case of Address. The reason that 'Address
737 -- is an exception is that it creates an alias through which the
738 -- variable may be referenced.
740 elsif Nkind
(Parent
(N
)) = N_Attribute_Definition_Clause
741 and then Chars
(Parent
(N
)) /= Name_Address
742 and then N
= Name
(Parent
(N
))
746 -- Constant completion does not count as a reference
749 and then Ekind
(E
) = E_Constant
753 -- Record representation clause does not count as a reference
755 elsif Nkind
(N
) = N_Identifier
756 and then Nkind
(Parent
(N
)) = N_Record_Representation_Clause
760 -- Discriminants do not need to produce a reference to record type
763 and then Nkind
(Parent
(N
)) = N_Discriminant_Specification
770 -- Special processing for IN OUT parameters, where we have an
771 -- implicit assignment to a simple variable.
773 if Kind
= E_In_Out_Parameter
774 and then Is_Assignable
(E
)
776 -- For sure this counts as a normal read reference
779 Set_Last_Assignment
(E
, Empty
);
781 -- We count it as being referenced as an out parameter if the
782 -- option is set to warn on all out parameters, except that we
783 -- have a special exclusion for an intrinsic subprogram, which
784 -- is most likely an instantiation of Unchecked_Deallocation
785 -- which we do not want to consider as an assignment since it
786 -- generates false positives. We also exclude the case of an
787 -- IN OUT parameter if the name of the procedure is Free,
788 -- since we suspect similar semantics.
790 if Warn_On_All_Unread_Out_Parameters
791 and then Is_Entity_Name
(Name
(Call
))
792 and then not Is_Intrinsic_Subprogram
(Entity
(Name
(Call
)))
793 and then Chars
(Name
(Call
)) /= Name_Free
795 Set_Referenced_As_Out_Parameter
(E
, True);
796 Set_Referenced_As_LHS
(E
, False);
799 -- Don't count a recursive reference within a subprogram as a
800 -- reference (that allows detection of a recursive subprogram
801 -- whose only references are recursive calls as unreferenced).
803 elsif Is_Subprogram
(E
)
804 and then E
= Nearest_Dynamic_Scope
(Current_Scope
)
808 -- Any other occurrence counts as referencing the entity
810 elsif OK_To_Set_Referenced
then
813 -- If variable, this is an OK reference after an assignment
814 -- so we can clear the Last_Assignment indication.
816 if Is_Assignable
(E
) then
817 Set_Last_Assignment
(E
, Empty
);
822 -- Check for pragma Unreferenced given and reference is within
823 -- this source unit (occasion for possible warning to be issued).
825 if Has_Unreferenced
(E
)
826 and then In_Same_Extended_Unit
(E
, N
)
828 -- A reference as a named parameter in a call does not count
829 -- as a violation of pragma Unreferenced for this purpose...
831 if Nkind
(N
) = N_Identifier
832 and then Nkind
(Parent
(N
)) = N_Parameter_Association
833 and then Selector_Name
(Parent
(N
)) = N
837 -- ... Neither does a reference to a variable on the left side
840 elsif Is_On_LHS
(N
) then
843 -- For entry formals, we want to place the warning message on the
844 -- corresponding entity in the accept statement. The current scope
845 -- is the body of the accept, so we find the formal whose name
846 -- matches that of the entry formal (there is no link between the
847 -- two entities, and the one in the accept statement is only used
848 -- for conformance checking).
850 elsif Ekind
(Scope
(E
)) = E_Entry
then
855 BE
:= First_Entity
(Current_Scope
);
856 while Present
(BE
) loop
857 if Chars
(BE
) = Chars
(E
) then
858 Error_Msg_NE
-- CODEFIX
859 ("??pragma Unreferenced given for&!", N
, BE
);
867 -- Here we issue the warning, since this is a real reference
870 Error_Msg_NE
-- CODEFIX
871 ("?pragma Unreferenced given for&!", N
, E
);
875 -- If this is a subprogram instance, mark as well the internal
876 -- subprogram in the wrapper package, which may be a visible
879 if Is_Overloadable
(E
)
880 and then Is_Generic_Instance
(E
)
881 and then Present
(Alias
(E
))
883 Set_Referenced
(Alias
(E
));
887 -- Generate reference if all conditions are met:
890 -- Cross referencing must be active
894 -- The entity must be one for which we collect references
896 and then Xref_Entity_Letters
(Ekind
(E
)) /= ' '
898 -- Both Sloc values must be set to something sensible
900 and then Sloc
(E
) > No_Location
901 and then Sloc
(N
) > No_Location
903 -- Ignore references from within an instance. The only exceptions to
904 -- this are default subprograms, for which we generate an implicit
905 -- reference and compilations in SPARK mode.
908 (Instantiation_Location
(Sloc
(N
)) = No_Location
910 or else GNATprove_Mode
)
912 -- Ignore dummy references
916 if Nkind_In
(N
, N_Identifier
,
917 N_Defining_Identifier
,
918 N_Defining_Operator_Symbol
,
920 N_Defining_Character_Literal
)
921 or else Nkind
(N
) in N_Op
922 or else (Nkind
(N
) = N_Character_Literal
923 and then Sloc
(Entity
(N
)) /= Standard_Location
)
927 elsif Nkind_In
(N
, N_Expanded_Name
, N_Selected_Component
) then
928 Nod
:= Selector_Name
(N
);
934 -- Normal case of source entity comes from source
936 if Comes_From_Source
(E
) then
939 -- Entity does not come from source, but is a derived subprogram and
940 -- the derived subprogram comes from source (after one or more
941 -- derivations) in which case the reference is to parent subprogram.
943 elsif Is_Overloadable
(E
)
944 and then Present
(Alias
(E
))
947 while not Comes_From_Source
(Ent
) loop
948 if No
(Alias
(Ent
)) then
955 -- The internally created defining entity for a child subprogram
956 -- that has no previous spec has valid references.
958 elsif Is_Overloadable
(E
)
959 and then Is_Child_Unit
(E
)
963 -- Ditto for the formals of such a subprogram
965 elsif Is_Overloadable
(Scope
(E
))
966 and then Is_Child_Unit
(Scope
(E
))
970 -- Record components of discriminated subtypes or derived types must
971 -- be treated as references to the original component.
973 elsif Ekind
(E
) = E_Component
974 and then Comes_From_Source
(Original_Record_Component
(E
))
976 Ent
:= Original_Record_Component
(E
);
978 -- If this is an expanded reference to a discriminant, recover the
979 -- original discriminant, which gets the reference.
981 elsif Ekind
(E
) = E_In_Parameter
982 and then Present
(Discriminal_Link
(E
))
984 Ent
:= Discriminal_Link
(E
);
985 Set_Referenced
(Ent
);
987 -- Ignore reference to any other entity that is not from source
993 -- In SPARK mode, consider the underlying entity renamed instead of
994 -- the renaming, which is needed to compute a valid set of effects
995 -- (reads, writes) for the enclosing subprogram.
997 if GNATprove_Mode
then
998 Ent
:= Get_Through_Renamings
(Ent
);
1000 -- If no enclosing object, then it could be a reference to any
1001 -- location not tracked individually, like heap-allocated data.
1002 -- Conservatively approximate this possibility by generating a
1003 -- dereference, and return.
1006 if Actual_Typ
= 'w' then
1007 SPARK_Specific
.Generate_Dereference
(Nod
, 'r');
1008 SPARK_Specific
.Generate_Dereference
(Nod
, 'w');
1010 SPARK_Specific
.Generate_Dereference
(Nod
, 'r');
1017 -- Record reference to entity
1020 and then Is_Subprogram
(Nod
)
1021 and then Present
(Overridden_Operation
(Nod
))
1026 -- Comment needed here for special SPARK code ???
1028 if GNATprove_Mode
then
1032 Ref_Scope
:= SPARK_Specific
.Enclosing_Subprogram_Or_Package
(Nod
);
1033 Ent_Scope
:= SPARK_Specific
.Enclosing_Subprogram_Or_Package
(Ent
);
1035 -- Since we are reaching through renamings in SPARK mode, we may
1036 -- end up with standard constants. Ignore those.
1038 if Sloc
(Ent_Scope
) <= Standard_Location
1039 or else Def
<= Standard_Location
1048 Eun
=> Get_Code_Unit
(Def
),
1049 Lun
=> Get_Code_Unit
(Ref
),
1050 Ref_Scope
=> Ref_Scope
,
1051 Ent_Scope
=> Ent_Scope
),
1052 Ent_Scope_File
=> Get_Code_Unit
(Ent
));
1055 Ref
:= Original_Location
(Sloc
(Nod
));
1056 Def
:= Original_Location
(Sloc
(Ent
));
1058 -- If this is an operator symbol, skip the initial quote for
1059 -- navigation purposes. This is not done for the end label,
1060 -- where we want the actual position after the closing quote.
1065 elsif Nkind
(N
) = N_Defining_Operator_Symbol
1066 or else Nkind
(Nod
) = N_Operator_Symbol
1075 Eun
=> Get_Source_Unit
(Def
),
1076 Lun
=> Get_Source_Unit
(Ref
),
1078 Ent_Scope
=> Empty
),
1079 Ent_Scope_File
=> No_Unit
);
1081 -- Generate reference to the first private entity
1084 and then Comes_From_Source
(E
)
1085 and then Nkind
(Ent
) = N_Defining_Identifier
1086 and then (Is_Package_Or_Generic_Package
(Ent
)
1087 or else Is_Concurrent_Type
(Ent
))
1088 and then Present
(First_Private_Entity
(E
))
1089 and then In_Extended_Main_Source_Unit
(N
)
1091 -- Handle case in which the full-view and partial-view of the
1092 -- first private entity are swapped
1095 First_Private
: Entity_Id
:= First_Private_Entity
(E
);
1098 if Is_Private_Type
(First_Private
)
1099 and then Present
(Full_View
(First_Private
))
1101 First_Private
:= Full_View
(First_Private
);
1106 Loc
=> Sloc
(First_Private
),
1108 Eun
=> Get_Source_Unit
(Def
),
1109 Lun
=> Get_Source_Unit
(Ref
),
1111 Ent_Scope
=> Empty
),
1112 Ent_Scope_File
=> No_Unit
);
1117 end Generate_Reference
;
1119 -----------------------------------
1120 -- Generate_Reference_To_Formals --
1121 -----------------------------------
1123 procedure Generate_Reference_To_Formals
(E
: Entity_Id
) is
1127 if Is_Generic_Subprogram
(E
) then
1128 Formal
:= First_Entity
(E
);
1130 while Present
(Formal
)
1131 and then not Is_Formal
(Formal
)
1133 Next_Entity
(Formal
);
1136 elsif Ekind
(E
) in Access_Subprogram_Kind
then
1137 Formal
:= First_Formal
(Designated_Type
(E
));
1140 Formal
:= First_Formal
(E
);
1143 while Present
(Formal
) loop
1144 if Ekind
(Formal
) = E_In_Parameter
then
1146 if Nkind
(Parameter_Type
(Parent
(Formal
)))
1147 = N_Access_Definition
1149 Generate_Reference
(E
, Formal
, '^', False);
1151 Generate_Reference
(E
, Formal
, '>', False);
1154 elsif Ekind
(Formal
) = E_In_Out_Parameter
then
1155 Generate_Reference
(E
, Formal
, '=', False);
1158 Generate_Reference
(E
, Formal
, '<', False);
1161 Next_Formal
(Formal
);
1163 end Generate_Reference_To_Formals
;
1165 -------------------------------------------
1166 -- Generate_Reference_To_Generic_Formals --
1167 -------------------------------------------
1169 procedure Generate_Reference_To_Generic_Formals
(E
: Entity_Id
) is
1173 Formal
:= First_Entity
(E
);
1174 while Present
(Formal
) loop
1175 if Comes_From_Source
(Formal
) then
1176 Generate_Reference
(E
, Formal
, 'z', False);
1179 Next_Entity
(Formal
);
1181 end Generate_Reference_To_Generic_Formals
;
1187 function Get_Key
(E
: Xref_Entry_Number
) return Xref_Entry_Number
is
1196 function Hash
(F
: Xref_Entry_Number
) return Header_Num
is
1197 -- It is unlikely to have two references to the same entity at the same
1198 -- source location, so the hash function depends only on the Ent and Loc
1201 XE
: Xref_Entry
renames Xrefs
.Table
(F
);
1202 type M
is mod 2**32;
1204 H
: constant M
:= M
(XE
.Key
.Ent
) + 2 ** 7 * M
(abs XE
.Key
.Loc
);
1205 -- It would be more natural to write:
1207 -- H : constant M := M'Mod (XE.Key.Ent) + 2**7 * M'Mod (XE.Key.Loc);
1209 -- But we can't use M'Mod, because it prevents bootstrapping with older
1210 -- compilers. Loc can be negative, so we do "abs" before converting.
1211 -- One day this can be cleaned up ???
1214 return Header_Num
(H
mod Num_Buckets
);
1221 procedure HT_Set_Next
(E
: Xref_Entry_Number
; Next
: Xref_Entry_Number
) is
1223 Xrefs
.Table
(E
).HTable_Next
:= Next
;
1230 function HT_Next
(E
: Xref_Entry_Number
) return Xref_Entry_Number
is
1232 return Xrefs
.Table
(E
).HTable_Next
;
1239 procedure Initialize
is
1248 function Lt
(T1
, T2
: Xref_Entry
) return Boolean is
1250 -- First test: if entity is in different unit, sort by unit
1252 if T1
.Key
.Eun
/= T2
.Key
.Eun
then
1253 return Dependency_Num
(T1
.Key
.Eun
) < Dependency_Num
(T2
.Key
.Eun
);
1255 -- Second test: within same unit, sort by entity Sloc
1257 elsif T1
.Def
/= T2
.Def
then
1258 return T1
.Def
< T2
.Def
;
1260 -- Third test: sort definitions ahead of references
1262 elsif T1
.Key
.Loc
= No_Location
then
1265 elsif T2
.Key
.Loc
= No_Location
then
1268 -- Fourth test: for same entity, sort by reference location unit
1270 elsif T1
.Key
.Lun
/= T2
.Key
.Lun
then
1271 return Dependency_Num
(T1
.Key
.Lun
) < Dependency_Num
(T2
.Key
.Lun
);
1273 -- Fifth test: order of location within referencing unit
1275 elsif T1
.Key
.Loc
/= T2
.Key
.Loc
then
1276 return T1
.Key
.Loc
< T2
.Key
.Loc
;
1278 -- Finally, for two locations at the same address, we prefer
1279 -- the one that does NOT have the type 'r' so that a modification
1280 -- or extension takes preference, when there are more than one
1281 -- reference at the same location. As a result, in the case of
1282 -- entities that are in-out actuals, the read reference follows
1283 -- the modify reference.
1286 return T2
.Key
.Typ
= 'r';
1290 -----------------------
1291 -- Output_References --
1292 -----------------------
1294 procedure Output_References
is
1296 procedure Get_Type_Reference
1298 Tref
: out Entity_Id
;
1299 Left
: out Character;
1300 Right
: out Character);
1301 -- Given an Entity_Id Ent, determines whether a type reference is
1302 -- required. If so, Tref is set to the entity for the type reference
1303 -- and Left and Right are set to the left/right brackets to be output
1304 -- for the reference. If no type reference is required, then Tref is
1305 -- set to Empty, and Left/Right are set to space.
1307 procedure Output_Import_Export_Info
(Ent
: Entity_Id
);
1308 -- Output language and external name information for an interfaced
1309 -- entity, using the format <language, external_name>.
1311 ------------------------
1312 -- Get_Type_Reference --
1313 ------------------------
1315 procedure Get_Type_Reference
1317 Tref
: out Entity_Id
;
1318 Left
: out Character;
1319 Right
: out Character)
1324 -- See if we have a type reference
1333 -- Processing for types
1335 if Is_Type
(Tref
) then
1337 -- Case of base type
1339 if Base_Type
(Tref
) = Tref
then
1341 -- If derived, then get first subtype
1343 if Tref
/= Etype
(Tref
) then
1344 Tref
:= First_Subtype
(Etype
(Tref
));
1346 -- Set brackets for derived type, but don't override
1347 -- pointer case since the fact that something is a
1348 -- pointer is more important.
1355 -- If the completion of a private type is itself a derived
1356 -- type, we need the parent of the full view.
1358 elsif Is_Private_Type
(Tref
)
1359 and then Present
(Full_View
(Tref
))
1360 and then Etype
(Full_View
(Tref
)) /= Full_View
(Tref
)
1362 Tref
:= Etype
(Full_View
(Tref
));
1369 -- If non-derived pointer, get directly designated type.
1370 -- If the type has a full view, all references are on the
1371 -- partial view that is seen first.
1373 elsif Is_Access_Type
(Tref
) then
1374 Tref
:= Directly_Designated_Type
(Tref
);
1378 elsif Is_Private_Type
(Tref
)
1379 and then Present
(Full_View
(Tref
))
1381 if Is_Access_Type
(Full_View
(Tref
)) then
1382 Tref
:= Directly_Designated_Type
(Full_View
(Tref
));
1386 -- If the full view is an array type, we also retrieve
1387 -- the corresponding component type, because the ali
1388 -- entry already indicates that this is an array.
1390 elsif Is_Array_Type
(Full_View
(Tref
)) then
1391 Tref
:= Component_Type
(Full_View
(Tref
));
1396 -- If non-derived array, get component type. Skip component
1397 -- type for case of String or Wide_String, saves worthwhile
1400 elsif Is_Array_Type
(Tref
)
1401 and then Tref
/= Standard_String
1402 and then Tref
/= Standard_Wide_String
1404 Tref
:= Component_Type
(Tref
);
1408 -- For other non-derived base types, nothing
1414 -- For a subtype, go to ancestor subtype
1417 Tref
:= Ancestor_Subtype
(Tref
);
1419 -- If no ancestor subtype, go to base type
1422 Tref
:= Base_Type
(Sav
);
1426 -- For objects, functions, enum literals, just get type from
1429 elsif Is_Object
(Tref
)
1430 or else Ekind
(Tref
) = E_Enumeration_Literal
1431 or else Ekind
(Tref
) = E_Function
1432 or else Ekind
(Tref
) = E_Operator
1434 Tref
:= Etype
(Tref
);
1436 -- Another special case: an object of a classwide type
1437 -- initialized with a tag-indeterminate call gets a subtype
1438 -- of the classwide type during expansion. See if the original
1439 -- type in the declaration is named, and return it instead
1440 -- of going to the root type.
1442 if Ekind
(Tref
) = E_Class_Wide_Subtype
1443 and then Nkind
(Parent
(Ent
)) = N_Object_Declaration
1445 Nkind
(Original_Node
(Object_Definition
(Parent
(Ent
))))
1450 (Original_Node
((Object_Definition
(Parent
(Ent
)))));
1453 -- For anything else, exit
1459 -- Exit if no type reference, or we are stuck in some loop trying
1460 -- to find the type reference, or if the type is standard void
1461 -- type (the latter is an implementation artifact that should not
1462 -- show up in the generated cross-references).
1466 or else Tref
= Standard_Void_Type
;
1468 -- If we have a usable type reference, return, otherwise keep
1469 -- looking for something useful (we are looking for something
1470 -- that either comes from source or standard)
1472 if Sloc
(Tref
) = Standard_Location
1473 or else Comes_From_Source
(Tref
)
1475 -- If the reference is a subtype created for a generic actual,
1476 -- go actual directly, the inner subtype is not user visible.
1478 if Nkind
(Parent
(Tref
)) = N_Subtype_Declaration
1479 and then not Comes_From_Source
(Parent
(Tref
))
1481 (Is_Wrapper_Package
(Scope
(Tref
))
1482 or else Is_Generic_Instance
(Scope
(Tref
)))
1484 Tref
:= First_Subtype
(Base_Type
(Tref
));
1491 -- If we fall through the loop, no type reference
1496 end Get_Type_Reference
;
1498 -------------------------------
1499 -- Output_Import_Export_Info --
1500 -------------------------------
1502 procedure Output_Import_Export_Info
(Ent
: Entity_Id
) is
1503 Language_Name
: Name_Id
;
1504 Conv
: constant Convention_Id
:= Convention
(Ent
);
1507 -- Generate language name from convention
1509 if Conv
= Convention_C
then
1510 Language_Name
:= Name_C
;
1512 elsif Conv
= Convention_CPP
then
1513 Language_Name
:= Name_CPP
;
1515 elsif Conv
= Convention_Ada
then
1516 Language_Name
:= Name_Ada
;
1519 -- For the moment we ignore all other cases ???
1524 Write_Info_Char
('<');
1525 Get_Unqualified_Name_String
(Language_Name
);
1527 for J
in 1 .. Name_Len
loop
1528 Write_Info_Char
(Name_Buffer
(J
));
1531 if Present
(Interface_Name
(Ent
)) then
1532 Write_Info_Char
(',');
1533 String_To_Name_Buffer
(Strval
(Interface_Name
(Ent
)));
1535 for J
in 1 .. Name_Len
loop
1536 Write_Info_Char
(Name_Buffer
(J
));
1540 Write_Info_Char
('>');
1541 end Output_Import_Export_Info
;
1543 -- Start of processing for Output_References
1546 -- First we add references to the primitive operations of tagged types
1547 -- declared in the main unit.
1549 Handle_Prim_Ops
: declare
1553 for J
in 1 .. Xrefs
.Last
loop
1554 Ent
:= Xrefs
.Table
(J
).Key
.Ent
;
1557 and then Is_Tagged_Type
(Ent
)
1558 and then Is_Base_Type
(Ent
)
1559 and then In_Extended_Main_Source_Unit
(Ent
)
1561 Generate_Prim_Op_References
(Ent
);
1564 end Handle_Prim_Ops
;
1566 -- Before we go ahead and output the references we have a problem
1567 -- that needs dealing with. So far we have captured things that are
1568 -- definitely referenced by the main unit, or defined in the main
1569 -- unit. That's because we don't want to clutter up the ali file
1570 -- for this unit with definition lines for entities in other units
1571 -- that are not referenced.
1573 -- But there is a glitch. We may reference an entity in another unit,
1574 -- and it may have a type reference to an entity that is not directly
1575 -- referenced in the main unit, which may mean that there is no xref
1576 -- entry for this entity yet in the list of references.
1578 -- If we don't do something about this, we will end with an orphan type
1579 -- reference, i.e. it will point to an entity that does not appear
1580 -- within the generated references in the ali file. That is not good for
1581 -- tools using the xref information.
1583 -- To fix this, we go through the references adding definition entries
1584 -- for any unreferenced entities that can be referenced in a type
1585 -- reference. There is a recursion problem here, and that is dealt with
1586 -- by making sure that this traversal also traverses any entries that
1587 -- get added by the traversal.
1589 Handle_Orphan_Type_References
: declare
1595 pragma Warnings
(Off
, L
);
1596 pragma Warnings
(Off
, R
);
1598 procedure New_Entry
(E
: Entity_Id
);
1599 -- Make an additional entry into the Xref table for a type entity
1600 -- that is related to the current entity (parent, type ancestor,
1601 -- progenitor, etc.).
1607 procedure New_Entry
(E
: Entity_Id
) is
1609 pragma Assert
(Present
(E
));
1611 if not Has_Xref_Entry
(Implementation_Base_Type
(E
))
1612 and then Sloc
(E
) > No_Location
1617 Typ
=> Character'First,
1618 Eun
=> Get_Source_Unit
(Original_Location
(Sloc
(E
))),
1621 Ent_Scope
=> Empty
),
1622 Ent_Scope_File
=> No_Unit
);
1626 -- Start of processing for Handle_Orphan_Type_References
1629 -- Note that this is not a for loop for a very good reason. The
1630 -- processing of items in the table can add new items to the table,
1631 -- and they must be processed as well.
1634 while J
<= Xrefs
.Last
loop
1635 Ent
:= Xrefs
.Table
(J
).Key
.Ent
;
1636 Get_Type_Reference
(Ent
, Tref
, L
, R
);
1639 and then not Has_Xref_Entry
(Tref
)
1640 and then Sloc
(Tref
) > No_Location
1644 if Is_Record_Type
(Ent
)
1645 and then Present
(Interfaces
(Ent
))
1647 -- Add an entry for each one of the given interfaces
1648 -- implemented by type Ent.
1651 Elmt
: Elmt_Id
:= First_Elmt
(Interfaces
(Ent
));
1653 while Present
(Elmt
) loop
1654 New_Entry
(Node
(Elmt
));
1661 -- Collect inherited primitive operations that may be declared in
1662 -- another unit and have no visible reference in the current one.
1665 and then Is_Tagged_Type
(Ent
)
1666 and then Is_Derived_Type
(Ent
)
1667 and then Is_Base_Type
(Ent
)
1668 and then In_Extended_Main_Source_Unit
(Ent
)
1671 Op_List
: constant Elist_Id
:= Primitive_Operations
(Ent
);
1675 function Parent_Op
(E
: Entity_Id
) return Entity_Id
;
1676 -- Find original operation, which may be inherited through
1677 -- several derivations.
1679 function Parent_Op
(E
: Entity_Id
) return Entity_Id
is
1680 Orig_Op
: constant Entity_Id
:= Alias
(E
);
1683 if No
(Orig_Op
) then
1686 elsif not Comes_From_Source
(E
)
1687 and then not Has_Xref_Entry
(Orig_Op
)
1688 and then Comes_From_Source
(Orig_Op
)
1692 return Parent_Op
(Orig_Op
);
1697 Op
:= First_Elmt
(Op_List
);
1698 while Present
(Op
) loop
1699 Prim
:= Parent_Op
(Node
(Op
));
1701 if Present
(Prim
) then
1705 Typ
=> Character'First,
1706 Eun
=> Get_Source_Unit
(Sloc
(Prim
)),
1709 Ent_Scope
=> Empty
),
1710 Ent_Scope_File
=> No_Unit
);
1720 end Handle_Orphan_Type_References
;
1722 -- Now we have all the references, including those for any embedded type
1723 -- references, so we can sort them, and output them.
1725 Output_Refs
: declare
1727 Nrefs
: constant Nat
:= Xrefs
.Last
;
1728 -- Number of references in table
1730 Rnums
: array (0 .. Nrefs
) of Nat
;
1731 -- This array contains numbers of references in the Xrefs table.
1732 -- This list is sorted in output order. The extra 0'th entry is
1733 -- convenient for the call to sort. When we sort the table, we
1734 -- move the entries in Rnums around, but we do not move the
1735 -- original table entries.
1737 Curxu
: Unit_Number_Type
;
1738 -- Current xref unit
1740 Curru
: Unit_Number_Type
;
1741 -- Current reference unit for one entity
1746 Curnam
: String (1 .. Name_Buffer
'Length);
1748 -- Simple name and length of current entity
1750 Curdef
: Source_Ptr
;
1751 -- Original source location for current entity
1754 -- Current reference location
1757 -- Entity type character
1760 -- reference kind of previous reference
1766 -- Renaming reference
1768 Trunit
: Unit_Number_Type
;
1769 -- Unit number for type reference
1771 function Lt
(Op1
, Op2
: Natural) return Boolean;
1772 -- Comparison function for Sort call
1774 function Name_Change
(X
: Entity_Id
) return Boolean;
1775 -- Determines if entity X has a different simple name from Curent
1777 procedure Move
(From
: Natural; To
: Natural);
1778 -- Move procedure for Sort call
1780 package Sorting
is new GNAT
.Heap_Sort_G
(Move
, Lt
);
1786 function Lt
(Op1
, Op2
: Natural) return Boolean is
1787 T1
: Xref_Entry
renames Xrefs
.Table
(Rnums
(Nat
(Op1
)));
1788 T2
: Xref_Entry
renames Xrefs
.Table
(Rnums
(Nat
(Op2
)));
1798 procedure Move
(From
: Natural; To
: Natural) is
1800 Rnums
(Nat
(To
)) := Rnums
(Nat
(From
));
1807 -- Why a string comparison here??? Why not compare Name_Id values???
1809 function Name_Change
(X
: Entity_Id
) return Boolean is
1811 Get_Unqualified_Name_String
(Chars
(X
));
1813 if Name_Len
/= Curlen
then
1816 return Name_Buffer
(1 .. Curlen
) /= Curnam
(1 .. Curlen
);
1820 -- Start of processing for Output_Refs
1823 -- Capture the definition Sloc values. We delay doing this till now,
1824 -- since at the time the reference or definition is made, private
1825 -- types may be swapped, and the Sloc value may be incorrect. We
1826 -- also set up the pointer vector for the sort.
1828 -- For user-defined operators we need to skip the initial quote and
1829 -- point to the first character of the name, for navigation purposes.
1831 for J
in 1 .. Nrefs
loop
1833 E
: constant Entity_Id
:= Xrefs
.Table
(J
).Key
.Ent
;
1834 Loc
: constant Source_Ptr
:= Original_Location
(Sloc
(E
));
1839 if Nkind
(E
) = N_Defining_Operator_Symbol
then
1840 Xrefs
.Table
(J
).Def
:= Loc
+ 1;
1842 Xrefs
.Table
(J
).Def
:= Loc
;
1847 -- Sort the references
1849 Sorting
.Sort
(Integer (Nrefs
));
1851 -- Initialize loop through references
1855 Curdef
:= No_Location
;
1857 Crloc
:= No_Location
;
1860 -- Loop to output references
1862 for Refno
in 1 .. Nrefs
loop
1863 Output_One_Ref
: declare
1866 XE
: Xref_Entry
renames Xrefs
.Table
(Rnums
(Refno
));
1867 -- The current entry to be accessed
1871 -- Used for {} or <> or () for type reference
1873 procedure Check_Type_Reference
1875 List_Interface
: Boolean);
1876 -- Find whether there is a meaningful type reference for
1877 -- Ent, and display it accordingly. If List_Interface is
1878 -- true, then Ent is a progenitor interface of the current
1879 -- type entity being listed. In that case list it as is,
1880 -- without looking for a type reference for it.
1882 procedure Output_Instantiation_Refs
(Loc
: Source_Ptr
);
1883 -- Recursive procedure to output instantiation references for
1884 -- the given source ptr in [file|line[...]] form. No output
1885 -- if the given location is not a generic template reference.
1887 procedure Output_Overridden_Op
(Old_E
: Entity_Id
);
1888 -- For a subprogram that is overriding, display information
1889 -- about the inherited operation that it overrides.
1891 --------------------------
1892 -- Check_Type_Reference --
1893 --------------------------
1895 procedure Check_Type_Reference
1897 List_Interface
: Boolean)
1900 if List_Interface
then
1902 -- This is a progenitor interface of the type for which
1903 -- xref information is being generated.
1910 Get_Type_Reference
(Ent
, Tref
, Left
, Right
);
1913 if Present
(Tref
) then
1915 -- Case of standard entity, output name
1917 if Sloc
(Tref
) = Standard_Location
then
1918 Write_Info_Char
(Left
);
1919 Write_Info_Name
(Chars
(Tref
));
1920 Write_Info_Char
(Right
);
1922 -- Case of source entity, output location
1925 Write_Info_Char
(Left
);
1926 Trunit
:= Get_Source_Unit
(Sloc
(Tref
));
1928 if Trunit
/= Curxu
then
1929 Write_Info_Nat
(Dependency_Num
(Trunit
));
1930 Write_Info_Char
('|');
1934 (Int
(Get_Logical_Line_Number
(Sloc
(Tref
))));
1942 Ctyp
:= Xref_Entity_Letters
(Ekind
(Ent
));
1945 and then Present
(Full_View
(Ent
))
1947 Ent
:= Underlying_Type
(Ent
);
1949 if Present
(Ent
) then
1950 Ctyp
:= Xref_Entity_Letters
(Ekind
(Ent
));
1954 Write_Info_Char
(Ctyp
);
1958 (Int
(Get_Column_Number
(Sloc
(Tref
))));
1960 -- If the type comes from an instantiation, add the
1961 -- corresponding info.
1963 Output_Instantiation_Refs
(Sloc
(Tref
));
1964 Write_Info_Char
(Right
);
1967 end Check_Type_Reference
;
1969 -------------------------------
1970 -- Output_Instantiation_Refs --
1971 -------------------------------
1973 procedure Output_Instantiation_Refs
(Loc
: Source_Ptr
) is
1974 Iloc
: constant Source_Ptr
:= Instantiation_Location
(Loc
);
1975 Lun
: Unit_Number_Type
;
1976 Cu
: constant Unit_Number_Type
:= Curru
;
1979 -- Nothing to do if this is not an instantiation
1981 if Iloc
= No_Location
then
1985 -- Output instantiation reference
1987 Write_Info_Char
('[');
1988 Lun
:= Get_Source_Unit
(Iloc
);
1990 if Lun
/= Curru
then
1992 Write_Info_Nat
(Dependency_Num
(Curru
));
1993 Write_Info_Char
('|');
1996 Write_Info_Nat
(Int
(Get_Logical_Line_Number
(Iloc
)));
1998 -- Recursive call to get nested instantiations
2000 Output_Instantiation_Refs
(Iloc
);
2002 -- Output final ] after call to get proper nesting
2004 Write_Info_Char
(']');
2007 end Output_Instantiation_Refs
;
2009 --------------------------
2010 -- Output_Overridden_Op --
2011 --------------------------
2013 procedure Output_Overridden_Op
(Old_E
: Entity_Id
) is
2017 -- The overridden operation has an implicit declaration
2018 -- at the point of derivation. What we want to display
2019 -- is the original operation, which has the actual body
2020 -- (or abstract declaration) that is being overridden.
2021 -- The overridden operation is not always set, e.g. when
2022 -- it is a predefined operator.
2027 -- Follow alias chain if one is present
2029 elsif Present
(Alias
(Old_E
)) then
2031 -- The subprogram may have been implicitly inherited
2032 -- through several levels of derivation, so find the
2033 -- ultimate (source) ancestor.
2035 Op
:= Ultimate_Alias
(Old_E
);
2037 -- Normal case of no alias present. We omit generated
2038 -- primitives like tagged equality, that have no source
2046 and then Sloc
(Op
) /= Standard_Location
2047 and then Comes_From_Source
(Op
)
2050 Loc
: constant Source_Ptr
:= Sloc
(Op
);
2051 Par_Unit
: constant Unit_Number_Type
:=
2052 Get_Source_Unit
(Loc
);
2055 Write_Info_Char
('<');
2057 if Par_Unit
/= Curxu
then
2058 Write_Info_Nat
(Dependency_Num
(Par_Unit
));
2059 Write_Info_Char
('|');
2062 Write_Info_Nat
(Int
(Get_Logical_Line_Number
(Loc
)));
2063 Write_Info_Char
('p');
2064 Write_Info_Nat
(Int
(Get_Column_Number
(Loc
)));
2065 Write_Info_Char
('>');
2068 end Output_Overridden_Op
;
2070 -- Start of processing for Output_One_Ref
2074 Ctyp
:= Xref_Entity_Letters
(Ekind
(Ent
));
2076 -- Skip reference if it is the only reference to an entity,
2077 -- and it is an END line reference, and the entity is not in
2078 -- the current extended source. This prevents junk entries
2079 -- consisting only of packages with END lines, where no
2080 -- entity from the package is actually referenced.
2083 and then Ent
/= Curent
2084 and then (Refno
= Nrefs
2086 Ent
/= Xrefs
.Table
(Rnums
(Refno
+ 1)).Key
.Ent
)
2087 and then not In_Extended_Main_Source_Unit
(Ent
)
2092 -- For private type, get full view type
2095 and then Present
(Full_View
(XE
.Key
.Ent
))
2097 Ent
:= Underlying_Type
(Ent
);
2099 if Present
(Ent
) then
2100 Ctyp
:= Xref_Entity_Letters
(Ekind
(Ent
));
2104 -- Special exception for Boolean
2106 if Ctyp
= 'E' and then Is_Boolean_Type
(Ent
) then
2110 -- For variable reference, get corresponding type
2113 Ent
:= Etype
(XE
.Key
.Ent
);
2114 Ctyp
:= Fold_Lower
(Xref_Entity_Letters
(Ekind
(Ent
)));
2116 -- If variable is private type, get full view type
2119 and then Present
(Full_View
(Etype
(XE
.Key
.Ent
)))
2121 Ent
:= Underlying_Type
(Etype
(XE
.Key
.Ent
));
2123 if Present
(Ent
) then
2124 Ctyp
:= Fold_Lower
(Xref_Entity_Letters
(Ekind
(Ent
)));
2127 elsif Is_Generic_Type
(Ent
) then
2129 -- If the type of the entity is a generic private type,
2130 -- there is no usable full view, so retain the indication
2131 -- that this is an object.
2136 -- Special handling for access parameters and objects and
2137 -- components of an anonymous access type.
2139 if Ekind_In
(Etype
(XE
.Key
.Ent
),
2140 E_Anonymous_Access_Type
,
2141 E_Anonymous_Access_Subprogram_Type
,
2142 E_Anonymous_Access_Protected_Subprogram_Type
)
2144 if Is_Formal
(XE
.Key
.Ent
)
2147 (XE
.Key
.Ent
, E_Variable
, E_Constant
, E_Component
)
2152 -- Special handling for Boolean
2154 elsif Ctyp
= 'e' and then Is_Boolean_Type
(Ent
) then
2159 -- Special handling for abstract types and operations
2161 if Is_Overloadable
(XE
.Key
.Ent
)
2162 and then Is_Abstract_Subprogram
(XE
.Key
.Ent
)
2165 Ctyp
:= 'x'; -- Abstract procedure
2167 elsif Ctyp
= 'V' then
2168 Ctyp
:= 'y'; -- Abstract function
2171 elsif Is_Type
(XE
.Key
.Ent
)
2172 and then Is_Abstract_Type
(XE
.Key
.Ent
)
2174 if Is_Interface
(XE
.Key
.Ent
) then
2177 elsif Ctyp
= 'R' then
2178 Ctyp
:= 'H'; -- Abstract type
2182 -- Only output reference if interesting type of entity
2186 -- Suppress references to object definitions, used for local
2189 or else XE
.Key
.Typ
= 'D'
2190 or else XE
.Key
.Typ
= 'I'
2192 -- Suppress self references, except for bodies that act as
2195 or else (XE
.Key
.Loc
= XE
.Def
2198 or else not Is_Subprogram
(XE
.Key
.Ent
)))
2200 -- Also suppress definitions of body formals (we only
2201 -- treat these as references, and the references were
2202 -- separately recorded).
2204 or else (Is_Formal
(XE
.Key
.Ent
)
2205 and then Present
(Spec_Entity
(XE
.Key
.Ent
)))
2210 -- Start new Xref section if new xref unit
2212 if XE
.Key
.Eun
/= Curxu
then
2213 if Write_Info_Col
> 1 then
2217 Curxu
:= XE
.Key
.Eun
;
2219 Write_Info_Initiate
('X');
2220 Write_Info_Char
(' ');
2221 Write_Info_Nat
(Dependency_Num
(XE
.Key
.Eun
));
2222 Write_Info_Char
(' ');
2224 (Reference_Name
(Source_Index
(XE
.Key
.Eun
)));
2227 -- Start new Entity line if new entity. Note that we
2228 -- consider two entities the same if they have the same
2229 -- name and source location. This causes entities in
2230 -- instantiations to be treated as though they referred
2235 (XE
.Key
.Ent
/= Curent
2237 (Name_Change
(XE
.Key
.Ent
) or else XE
.Def
/= Curdef
))
2239 Curent
:= XE
.Key
.Ent
;
2242 Get_Unqualified_Name_String
(Chars
(XE
.Key
.Ent
));
2244 Curnam
(1 .. Curlen
) := Name_Buffer
(1 .. Curlen
);
2246 if Write_Info_Col
> 1 then
2250 -- Write column number information
2252 Write_Info_Nat
(Int
(Get_Logical_Line_Number
(XE
.Def
)));
2253 Write_Info_Char
(Ctyp
);
2254 Write_Info_Nat
(Int
(Get_Column_Number
(XE
.Def
)));
2256 -- Write level information
2258 Write_Level_Info
: declare
2259 function Is_Visible_Generic_Entity
2260 (E
: Entity_Id
) return Boolean;
2261 -- Check whether E is declared in the visible part
2262 -- of a generic package. For source navigation
2263 -- purposes, treat this as a visible entity.
2265 function Is_Private_Record_Component
2266 (E
: Entity_Id
) return Boolean;
2267 -- Check whether E is a non-inherited component of a
2268 -- private extension. Even if the enclosing record is
2269 -- public, we want to treat the component as private
2270 -- for navigation purposes.
2272 ---------------------------------
2273 -- Is_Private_Record_Component --
2274 ---------------------------------
2276 function Is_Private_Record_Component
2277 (E
: Entity_Id
) return Boolean
2279 S
: constant Entity_Id
:= Scope
(E
);
2282 Ekind
(E
) = E_Component
2283 and then Nkind
(Declaration_Node
(S
)) =
2284 N_Private_Extension_Declaration
2285 and then Original_Record_Component
(E
) = E
;
2286 end Is_Private_Record_Component
;
2288 -------------------------------
2289 -- Is_Visible_Generic_Entity --
2290 -------------------------------
2292 function Is_Visible_Generic_Entity
2293 (E
: Entity_Id
) return Boolean
2298 -- The Present check here is an error defense
2300 if Present
(Scope
(E
))
2301 and then Ekind
(Scope
(E
)) /= E_Generic_Package
2307 while Present
(Par
) loop
2309 Nkind
(Par
) = N_Generic_Package_Declaration
2311 -- Entity is a generic formal
2316 Nkind
(Parent
(Par
)) = N_Package_Specification
2319 Is_List_Member
(Par
)
2320 and then List_Containing
(Par
) =
2321 Visible_Declarations
(Parent
(Par
));
2323 Par
:= Parent
(Par
);
2328 end Is_Visible_Generic_Entity
;
2330 -- Start of processing for Write_Level_Info
2333 if Is_Hidden
(Curent
)
2334 or else Is_Private_Record_Component
(Curent
)
2336 Write_Info_Char
(' ');
2340 or else Is_Visible_Generic_Entity
(Curent
)
2342 Write_Info_Char
('*');
2345 Write_Info_Char
(' ');
2347 end Write_Level_Info
;
2349 -- Output entity name. We use the occurrence from the
2350 -- actual source program at the definition point.
2353 Ent_Name
: constant String :=
2354 Exact_Source_Name
(Sloc
(XE
.Key
.Ent
));
2356 for C
in Ent_Name
'Range loop
2357 Write_Info_Char
(Ent_Name
(C
));
2361 -- See if we have a renaming reference
2363 if Is_Object
(XE
.Key
.Ent
)
2364 and then Present
(Renamed_Object
(XE
.Key
.Ent
))
2366 Rref
:= Renamed_Object
(XE
.Key
.Ent
);
2368 elsif Is_Overloadable
(XE
.Key
.Ent
)
2369 and then Nkind
(Parent
(Declaration_Node
(XE
.Key
.Ent
)))
2370 = N_Subprogram_Renaming_Declaration
2372 Rref
:= Name
(Parent
(Declaration_Node
(XE
.Key
.Ent
)));
2374 elsif Ekind
(XE
.Key
.Ent
) = E_Package
2375 and then Nkind
(Declaration_Node
(XE
.Key
.Ent
)) =
2376 N_Package_Renaming_Declaration
2378 Rref
:= Name
(Declaration_Node
(XE
.Key
.Ent
));
2384 if Present
(Rref
) then
2385 if Nkind
(Rref
) = N_Expanded_Name
then
2386 Rref
:= Selector_Name
(Rref
);
2389 if Nkind
(Rref
) = N_Identifier
2390 or else Nkind
(Rref
) = N_Operator_Symbol
2394 -- For renamed array components, use the array name
2395 -- for the renamed entity, which reflect the fact that
2396 -- in general the whole array is aliased.
2398 elsif Nkind
(Rref
) = N_Indexed_Component
then
2399 if Nkind
(Prefix
(Rref
)) = N_Identifier
then
2400 Rref
:= Prefix
(Rref
);
2401 elsif Nkind
(Prefix
(Rref
)) = N_Expanded_Name
then
2402 Rref
:= Selector_Name
(Prefix
(Rref
));
2412 -- Write out renaming reference if we have one
2414 if Present
(Rref
) then
2415 Write_Info_Char
('=');
2417 (Int
(Get_Logical_Line_Number
(Sloc
(Rref
))));
2418 Write_Info_Char
(':');
2420 (Int
(Get_Column_Number
(Sloc
(Rref
))));
2423 -- Indicate that the entity is in the unit of the current
2428 -- Write out information about generic parent, if entity
2431 if Is_Generic_Instance
(XE
.Key
.Ent
) then
2433 Gen_Par
: constant Entity_Id
:=
2436 (Unit_Declaration_Node
2438 Loc
: constant Source_Ptr
:= Sloc
(Gen_Par
);
2439 Gen_U
: constant Unit_Number_Type
:=
2440 Get_Source_Unit
(Loc
);
2443 Write_Info_Char
('[');
2445 if Curru
/= Gen_U
then
2446 Write_Info_Nat
(Dependency_Num
(Gen_U
));
2447 Write_Info_Char
('|');
2451 (Int
(Get_Logical_Line_Number
(Loc
)));
2452 Write_Info_Char
(']');
2456 -- See if we have a type reference and if so output
2458 Check_Type_Reference
(XE
.Key
.Ent
, False);
2460 -- Additional information for types with progenitors,
2461 -- including synchronized tagged types.
2464 Typ
: constant Entity_Id
:= XE
.Key
.Ent
;
2468 if Is_Record_Type
(Typ
)
2469 and then Present
(Interfaces
(Typ
))
2471 Elmt
:= First_Elmt
(Interfaces
(Typ
));
2473 elsif Is_Concurrent_Type
(Typ
)
2474 and then Present
(Corresponding_Record_Type
(Typ
))
2476 Interfaces
(Corresponding_Record_Type
(Typ
)))
2480 Interfaces
(Corresponding_Record_Type
(Typ
)));
2486 while Present
(Elmt
) loop
2487 Check_Type_Reference
(Node
(Elmt
), True);
2492 -- For array types, list index types as well. (This is
2493 -- not C, indexes have distinct types).
2495 if Is_Array_Type
(XE
.Key
.Ent
) then
2499 Indx
:= First_Index
(XE
.Key
.Ent
);
2500 while Present
(Indx
) loop
2501 Check_Type_Reference
2502 (First_Subtype
(Etype
(Indx
)), True);
2508 -- If the entity is an overriding operation, write info
2509 -- on operation that was overridden.
2511 if Is_Subprogram
(XE
.Key
.Ent
)
2512 and then Present
(Overridden_Operation
(XE
.Key
.Ent
))
2514 Output_Overridden_Op
2515 (Overridden_Operation
(XE
.Key
.Ent
));
2518 -- End of processing for entity output
2520 Crloc
:= No_Location
;
2523 -- Output the reference if it is not as the same location
2524 -- as the previous one, or it is a read-reference that
2525 -- indicates that the entity is an in-out actual in a call.
2527 if XE
.Key
.Loc
/= No_Location
2529 (XE
.Key
.Loc
/= Crloc
2530 or else (Prevt
= 'm' and then XE
.Key
.Typ
= 'r'))
2532 Crloc
:= XE
.Key
.Loc
;
2533 Prevt
:= XE
.Key
.Typ
;
2535 -- Start continuation if line full, else blank
2537 if Write_Info_Col
> 72 then
2539 Write_Info_Initiate
('.');
2542 Write_Info_Char
(' ');
2544 -- Output file number if changed
2546 if XE
.Key
.Lun
/= Curru
then
2547 Curru
:= XE
.Key
.Lun
;
2548 Write_Info_Nat
(Dependency_Num
(Curru
));
2549 Write_Info_Char
('|');
2553 (Int
(Get_Logical_Line_Number
(XE
.Key
.Loc
)));
2554 Write_Info_Char
(XE
.Key
.Typ
);
2556 if Is_Overloadable
(XE
.Key
.Ent
) then
2557 if (Is_Imported
(XE
.Key
.Ent
) and then XE
.Key
.Typ
= 'b')
2559 (Is_Exported
(XE
.Key
.Ent
) and then XE
.Key
.Typ
= 'i')
2561 Output_Import_Export_Info
(XE
.Key
.Ent
);
2565 Write_Info_Nat
(Int
(Get_Column_Number
(XE
.Key
.Loc
)));
2567 Output_Instantiation_Refs
(Sloc
(XE
.Key
.Ent
));
2578 end Output_References
;
2580 ---------------------------------
2581 -- Process_Deferred_References --
2582 ---------------------------------
2584 procedure Process_Deferred_References
is
2586 for J
in Deferred_References
.First
.. Deferred_References
.Last
loop
2588 D
: Deferred_Reference_Entry
renames Deferred_References
.Table
(J
);
2591 case Is_LHS
(D
.N
) is
2593 Generate_Reference
(D
.E
, D
.N
, 'm');
2596 Generate_Reference
(D
.E
, D
.N
, 'r');
2598 -- Not clear if Unknown can occur at this stage, but if it
2599 -- does we will treat it as a normal reference.
2602 Generate_Reference
(D
.E
, D
.N
, 'r');
2607 -- Clear processed entries from table
2609 Deferred_References
.Init
;
2610 end Process_Deferred_References
;
2612 -- Start of elaboration for Lib.Xref
2615 -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
2616 -- because it's not an access type.