1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1998-2017, 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 entry
197 Xrefs.Decrement_Last;
205 function Equal (F1, F2 : Xref_Entry_Number) return Boolean is
206 Result : constant Boolean :=
207 Xrefs.Table (F1).Key = Xrefs.Table (F2).Key;
212 -------------------------
213 -- Generate_Definition --
214 -------------------------
216 procedure Generate_Definition (E : Entity_Id) is
218 pragma Assert (Nkind (E) in N_Entity);
220 -- Note that we do not test Xref_Entity_Letters here. It is too early
221 -- to do so, since we are often called before the entity is fully
222 -- constructed, so that the Ekind is still E_Void.
226 -- Definition must come from source
228 -- We make an exception for subprogram child units that have no spec.
229 -- For these we generate a subprogram declaration for library use,
230 -- and the corresponding entity does not come from source.
231 -- Nevertheless, all references will be attached to it and we have
232 -- to treat is as coming from user code.
234 and then (Comes_From_Source (E) or else Is_Child_Unit (E))
236 -- And must have a reasonable source location that is not
237 -- within an instance (all entities in instances are ignored)
239 and then Sloc (E) > No_Location
240 and then Instantiation_Location (Sloc (E)) = No_Location
242 -- And must be a non-internal name from the main source unit
244 and then In_Extended_Main_Source_Unit (E)
245 and then not Is_Internal_Name (Chars (E))
251 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
255 Ent_Scope_File => No_Unit);
257 if In_Inlined_Body then
261 end Generate_Definition;
263 ---------------------------------
264 -- Generate_Operator_Reference --
265 ---------------------------------
267 procedure Generate_Operator_Reference
272 if not In_Extended_Main_Source_Unit (N) then
276 -- If the operator is not a Standard operator, then we generate a real
277 -- reference to the user defined operator.
279 if Sloc (Entity (N)) /= Standard_Location then
280 Generate_Reference (Entity (N), N);
282 -- A reference to an implicit inequality operator is also a reference
283 -- to the user-defined equality.
285 if Nkind (N) = N_Op_Ne
286 and then not Comes_From_Source (Entity (N))
287 and then Present (Corresponding_Equality (Entity (N)))
289 Generate_Reference (Corresponding_Equality (Entity (N)), N);
292 -- For the case of Standard operators, we mark the result type as
293 -- referenced. This ensures that in the case where we are using a
294 -- derived operator, we mark an entity of the unit that implicitly
295 -- defines this operator as used. Otherwise we may think that no entity
296 -- of the unit is used. The actual entity marked as referenced is the
297 -- first subtype, which is the relevant user defined entity.
299 -- Note: we only do this for operators that come from source. The
300 -- generated code sometimes reaches for entities that do not need to be
301 -- explicitly visible (for example, when we expand the code for
302 -- comparing two record objects, the fields of the record may not be
305 elsif Comes_From_Source (N) then
306 Set_Referenced (First_Subtype (T));
308 end Generate_Operator_Reference;
310 ---------------------------------
311 -- Generate_Prim_Op_References --
312 ---------------------------------
314 procedure Generate_Prim_Op_References (Typ : Entity_Id) is
317 Prim_List : Elist_Id;
320 -- Handle subtypes of synchronized types
322 if Ekind (Typ) = E_Protected_Subtype
323 or else Ekind (Typ) = E_Task_Subtype
325 Base_T := Etype (Typ);
330 -- References to primitive operations are only relevant for tagged types
332 if not Is_Tagged_Type (Base_T)
333 or else Is_Class_Wide_Type (Base_T)
338 -- Ada 2005 (AI-345): For synchronized types generate reference to the
339 -- wrapper that allow us to dispatch calls through their implemented
340 -- abstract interface types.
342 -- The check for Present here is to protect against previously reported
345 Prim_List := Primitive_Operations (Base_T);
347 if No (Prim_List) then
351 Prim := First_Elmt (Prim_List);
352 while Present (Prim) loop
354 -- If the operation is derived, get the original for cross-reference
355 -- reference purposes (it is the original for which we want the xref
356 -- and for which the comes_from_source test must be performed).
359 (Typ, Ultimate_Alias (Node (Prim)), 'p', Set_Ref => False);
362 end Generate_Prim_Op_References;
364 ------------------------
365 -- Generate_Reference --
366 ------------------------
368 procedure Generate_Reference
371 Typ : Character := 'r';
372 Set_Ref : Boolean := True;
373 Force : Boolean := False)
375 Actual_Typ : Character := Typ;
379 Ent_Scope : Entity_Id;
384 Ref_Scope : Entity_Id;
386 function Get_Through_Renamings (E : Entity_Id) return Entity_Id;
387 -- Get the enclosing entity through renamings, which may come from
388 -- source or from the translation of generic instantiations.
390 function Is_On_LHS (Node : Node_Id) return Boolean;
391 -- Used to check if a node is on the left hand side of an assignment.
392 -- The following cases are handled:
394 -- Variable Node is a direct descendant of left hand side of an
395 -- assignment statement.
397 -- Prefix Of an indexed or selected component that is present in
398 -- a subtree rooted by an assignment statement. There is
399 -- no restriction of nesting of components, thus cases
400 -- such as A.B (C).D are handled properly. However a prefix
401 -- of a dereference (either implicit or explicit) is never
402 -- considered as on a LHS.
404 -- Out param Same as above cases, but OUT parameter
406 function OK_To_Set_Referenced return Boolean;
407 -- Returns True if the Referenced flag can be set. There are a few
408 -- exceptions where we do not want to set this flag, see body for
409 -- details of these exceptional cases.
411 ---------------------------
412 -- Get_Through_Renamings --
413 ---------------------------
415 function Get_Through_Renamings (E : Entity_Id) return Entity_Id is
419 -- For subprograms we just need to check once if they are have a
420 -- Renamed_Entity, because Renamed_Entity is set transitively.
422 when Subprogram_Kind =>
424 Renamed : constant Entity_Id := Renamed_Entity (E);
427 if Present (Renamed) then
434 -- For objects we need to repeatedly call Renamed_Object, because
435 -- it is not transitive.
439 Obj : Entity_Id := E;
443 pragma Assert (Present (Obj));
446 Renamed : constant Entity_Id := Renamed_Object (Obj);
449 if Present (Renamed) then
450 Obj := Get_Enclosing_Object (Renamed);
452 -- The renamed expression denotes a non-object,
453 -- e.g. function call, slicing of a function call,
454 -- pointer dereference, etc.
470 end Get_Through_Renamings;
476 -- ??? There are several routines here and there that perform a similar
477 -- (but subtly different) computation, which should be factored:
480 -- Sem_Util.May_Be_Lvalue
481 -- Sem_Util.Known_To_Be_Assigned
482 -- Exp_Ch2.Expand_Entry_Parameter.In_Assignment_Context
483 -- Exp_Smem.Is_Out_Actual
485 function Is_On_LHS (Node : Node_Id) return Boolean is
491 -- Only identifiers are considered, is this necessary???
493 if Nkind (Node) /= N_Identifier then
497 -- Immediate return if appeared as OUT parameter
499 if Kind = E_Out_Parameter then
503 -- Search for assignment statement subtree root
510 if K = N_Assignment_Statement then
513 -- Check whether the parent is a component and the current node is
514 -- its prefix, but return False if the current node has an access
515 -- type, as in that case the selected or indexed component is an
516 -- implicit dereference, and the LHS is the designated object, not
517 -- the access object.
519 -- ??? case of a slice assignment?
521 elsif (K = N_Selected_Component or else K = N_Indexed_Component)
522 and then Prefix (P) = N
524 -- Check for access type. First a special test, In some cases
525 -- this is called too early (see comments in Find_Direct_Name),
526 -- at a point where the tree is not fully typed yet. In that
527 -- case we may lack an Etype for N, and we can't check the
528 -- Etype. For now, we always return False in such a case,
529 -- but this is clearly not right in all cases ???
531 if No (Etype (N)) then
534 elsif Is_Access_Type (Etype (N)) then
537 -- Access type case dealt with, keep going
543 -- All other cases, definitely not on left side
551 ---------------------------
552 -- OK_To_Set_Referenced --
553 ---------------------------
555 function OK_To_Set_Referenced return Boolean is
559 -- A reference from a pragma Unreferenced or pragma Unmodified or
560 -- pragma Warnings does not cause the Referenced flag to be set.
561 -- This avoids silly warnings about things being referenced and
562 -- not assigned when the only reference is from the pragma.
564 if Nkind (N) = N_Identifier then
567 if Nkind (P) = N_Pragma_Argument_Association then
570 if Nkind (P) = N_Pragma then
571 if Nam_In (Pragma_Name_Unmapped (P),
580 -- A reference to a formal in a named parameter association does
581 -- not make the formal referenced. Formals that are unused in the
582 -- subprogram body are properly flagged as such, even if calls
583 -- elsewhere use named notation.
585 elsif Nkind (P) = N_Parameter_Association
586 and then N = Selector_Name (P)
593 end OK_To_Set_Referenced;
595 -- Start of processing for Generate_Reference
598 pragma Assert (Nkind (E) in N_Entity);
599 Find_Actual (N, Formal, Call);
601 if Present (Formal) then
602 Kind := Ekind (Formal);
607 -- Check for obsolescent reference to package ASCII. GNAT treats this
608 -- element of annex J specially since in practice, programs make a lot
609 -- of use of this feature, so we don't include it in the set of features
610 -- diagnosed when Warn_On_Obsolescent_Features mode is set. However we
611 -- are required to note it as a violation of the RM defined restriction.
613 if E = Standard_ASCII then
614 Check_Restriction (No_Obsolescent_Features, N);
617 -- Check for reference to entity marked with Is_Obsolescent
619 -- Note that we always allow obsolescent references in the compiler
620 -- itself and the run time, since we assume that we know what we are
621 -- doing in such cases. For example the calls in Ada.Characters.Handling
622 -- to its own obsolescent subprograms are just fine.
624 -- In any case we only generate warnings if we are in the extended main
625 -- source unit, and the entity itself is not in the extended main source
626 -- unit, since we assume the source unit itself knows what is going on
627 -- (and for sure we do not want silly warnings, e.g. on the end line of
628 -- an obsolescent procedure body).
630 if Is_Obsolescent (E)
631 and then not GNAT_Mode
632 and then not In_Extended_Main_Source_Unit (E)
633 and then In_Extended_Main_Source_Unit (N)
635 Check_Restriction (No_Obsolescent_Features, N);
637 if Warn_On_Obsolescent_Feature then
638 Output_Obsolescent_Entity_Warnings (N, E);
642 -- Warn if reference to Ada 2005 entity not in Ada 2005 mode. We only
643 -- detect real explicit references (modifications and references).
645 if Comes_From_Source (N)
646 and then Is_Ada_2005_Only (E)
647 and then Ada_Version < Ada_2005
648 and then Warn_On_Ada_2005_Compatibility
649 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's')
651 Error_Msg_NE ("& is only defined in Ada 2005?y?", N, E);
654 -- Warn if reference to Ada 2012 entity not in Ada 2012 mode. We only
655 -- detect real explicit references (modifications and references).
657 if Comes_From_Source (N)
658 and then Is_Ada_2012_Only (E)
659 and then Ada_Version < Ada_2012
660 and then Warn_On_Ada_2012_Compatibility
661 and then (Typ = 'm' or else Typ = 'r')
663 Error_Msg_NE ("& is only defined in Ada 2012?y?", N, E);
666 -- Do not generate references if we are within a postcondition sub-
667 -- program, because the reference does not comes from source, and the
668 -- pre-analysis of the aspect has already created an entry for the ALI
669 -- file at the proper source location.
671 if Chars (Current_Scope) = Name_uPostconditions then
675 -- Never collect references if not in main source unit. However, we omit
676 -- this test if Typ is 'e' or 'k', since these entries are structural,
677 -- and it is useful to have them in units that reference packages as
678 -- well as units that define packages. We also omit the test for the
679 -- case of 'p' since we want to include inherited primitive operations
680 -- from other packages.
682 -- We also omit this test is this is a body reference for a subprogram
683 -- instantiation. In this case the reference is to the generic body,
684 -- which clearly need not be in the main unit containing the instance.
685 -- For the same reason we accept an implicit reference generated for
686 -- a default in an instance.
688 -- We also set the referenced flag in a generic package that is not in
689 -- then main source unit, when the variable is of a formal private type,
690 -- to warn in the instance if the corresponding type is not a fully
693 if not In_Extended_Main_Source_Unit (N) then
699 or else (Typ = 'b' and then Is_Generic_Instance (E))
701 -- Allow the generation of references to reads, writes and calls
702 -- in SPARK mode when the related context comes from an instance.
706 and then In_Extended_Main_Code_Unit (N)
707 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's'))
711 elsif In_Instance_Body
712 and then In_Extended_Main_Code_Unit (N)
713 and then Is_Generic_Type (Etype (E))
718 elsif Inside_A_Generic
719 and then Is_Generic_Type (Etype (E))
729 -- For reference type p, the entity must be in main source unit
731 if Typ = 'p' and then not In_Extended_Main_Source_Unit (E) then
735 -- Unless the reference is forced, we ignore references where the
736 -- reference itself does not come from source.
738 if not Force and then not Comes_From_Source (N) then
742 -- Deal with setting entity as referenced, unless suppressed. Note that
743 -- we still do Set_Referenced on entities that do not come from source.
744 -- This situation arises when we have a source reference to a derived
745 -- operation, where the derived operation itself does not come from
746 -- source, but we still want to mark it as referenced, since we really
747 -- are referencing an entity in the corresponding package (this avoids
748 -- wrong complaints that the package contains no referenced entities).
752 -- Assignable object appearing on left side of assignment or as
756 and then Is_On_LHS (N)
757 and then Ekind (E) /= E_In_Out_Parameter
759 -- For objects that are renamings, just set as simply referenced
760 -- we do not try to do assignment type tracking in this case.
762 if Present (Renamed_Object (E)) then
765 -- Out parameter case
767 elsif Kind = E_Out_Parameter then
769 -- If warning mode for all out parameters is set, or this is
770 -- the only warning parameter, then we want to mark this for
771 -- later warning logic by setting Referenced_As_Out_Parameter
773 if Warn_On_Modified_As_Out_Parameter (Formal) then
774 Set_Referenced_As_Out_Parameter (E, True);
775 Set_Referenced_As_LHS (E, False);
777 -- For OUT parameter not covered by the above cases, we simply
778 -- regard it as a normal reference (in this case we do not
779 -- want any of the warning machinery for out parameters).
785 -- For the left hand of an assignment case, we do nothing here.
786 -- The processing for Analyze_Assignment_Statement will set the
787 -- Referenced_As_LHS flag.
793 -- Check for a reference in a pragma that should not count as a
794 -- making the variable referenced for warning purposes.
796 elsif Is_Non_Significant_Pragma_Reference (N) then
799 -- A reference in an attribute definition clause does not count as a
800 -- reference except for the case of Address. The reason that 'Address
801 -- is an exception is that it creates an alias through which the
802 -- variable may be referenced.
804 elsif Nkind (Parent (N)) = N_Attribute_Definition_Clause
805 and then Chars (Parent (N)) /= Name_Address
806 and then N = Name (Parent (N))
810 -- Constant completion does not count as a reference
813 and then Ekind (E) = E_Constant
817 -- Record representation clause does not count as a reference
819 elsif Nkind (N) = N_Identifier
820 and then Nkind (Parent (N)) = N_Record_Representation_Clause
824 -- Discriminants do not need to produce a reference to record type
827 and then Nkind (Parent (N)) = N_Discriminant_Specification
834 -- Special processing for IN OUT parameters, where we have an
835 -- implicit assignment to a simple variable.
837 if Kind = E_In_Out_Parameter
838 and then Is_Assignable (E)
840 -- For sure this counts as a normal read reference
843 Set_Last_Assignment (E, Empty);
845 -- We count it as being referenced as an out parameter if the
846 -- option is set to warn on all out parameters, except that we
847 -- have a special exclusion for an intrinsic subprogram, which
848 -- is most likely an instantiation of Unchecked_Deallocation
849 -- which we do not want to consider as an assignment since it
850 -- generates false positives. We also exclude the case of an
851 -- IN OUT parameter if the name of the procedure is Free,
852 -- since we suspect similar semantics.
854 if Warn_On_All_Unread_Out_Parameters
855 and then Is_Entity_Name (Name (Call))
856 and then not Is_Intrinsic_Subprogram (Entity (Name (Call)))
857 and then Chars (Name (Call)) /= Name_Free
859 Set_Referenced_As_Out_Parameter (E, True);
860 Set_Referenced_As_LHS (E, False);
863 -- Don't count a recursive reference within a subprogram as a
864 -- reference (that allows detection of a recursive subprogram
865 -- whose only references are recursive calls as unreferenced).
867 elsif Is_Subprogram (E)
868 and then E = Nearest_Dynamic_Scope (Current_Scope)
872 -- Any other occurrence counts as referencing the entity
874 elsif OK_To_Set_Referenced then
877 -- If variable, this is an OK reference after an assignment
878 -- so we can clear the Last_Assignment indication.
880 if Is_Assignable (E) then
881 Set_Last_Assignment (E, Empty);
886 -- Check for pragma Unreferenced given and reference is within
887 -- this source unit (occasion for possible warning to be issued).
888 -- Note that the entity may be marked as unreferenced by pragma
891 if Has_Unreferenced (E)
892 and then In_Same_Extended_Unit (E, N)
894 -- A reference as a named parameter in a call does not count as a
895 -- violation of pragma Unreferenced for this purpose...
897 if Nkind (N) = N_Identifier
898 and then Nkind (Parent (N)) = N_Parameter_Association
899 and then Selector_Name (Parent (N)) = N
903 -- ... Neither does a reference to a variable on the left side of
906 elsif Is_On_LHS (N) then
909 -- Do not consider F'Result as a violation of pragma Unreferenced
910 -- since the attribute acts as an anonymous alias of the function
911 -- result and not as a real reference to the function.
913 elsif Ekind_In (E, E_Function, E_Generic_Function)
914 and then Is_Entity_Name (N)
915 and then Is_Attribute_Result (Parent (N))
919 -- No warning if the reference is in a call that does not come
920 -- from source (e.g. a call to a controlled type primitive).
922 elsif not Comes_From_Source (Parent (N))
923 and then Nkind (Parent (N)) = N_Procedure_Call_Statement
927 -- For entry formals, we want to place the warning message on the
928 -- corresponding entity in the accept statement. The current scope
929 -- is the body of the accept, so we find the formal whose name
930 -- matches that of the entry formal (there is no link between the
931 -- two entities, and the one in the accept statement is only used
932 -- for conformance checking).
934 elsif Ekind (Scope (E)) = E_Entry then
939 BE := First_Entity (Current_Scope);
940 while Present (BE) loop
941 if Chars (BE) = Chars (E) then
942 if Has_Pragma_Unused (E) then
943 Error_Msg_NE -- CODEFIX
944 ("??pragma Unused given for&!", N, BE);
946 Error_Msg_NE -- CODEFIX
947 ("??pragma Unreferenced given for&!", N, BE);
956 -- Here we issue the warning, since this is a real reference
958 elsif Has_Pragma_Unused (E) then
959 Error_Msg_NE -- CODEFIX
960 ("??pragma Unused given for&!", N, E);
962 Error_Msg_NE -- CODEFIX
963 ("??pragma Unreferenced given for&!", N, E);
967 -- If this is a subprogram instance, mark as well the internal
968 -- subprogram in the wrapper package, which may be a visible
971 if Is_Overloadable (E)
972 and then Is_Generic_Instance (E)
973 and then Present (Alias (E))
975 Set_Referenced (Alias (E));
979 -- Generate reference if all conditions are met:
982 -- Cross referencing must be active
986 -- The entity must be one for which we collect references
988 and then Xref_Entity_Letters (Ekind (E)) /= ' '
990 -- Both Sloc values must be set to something sensible
992 and then Sloc (E) > No_Location
993 and then Sloc (N) > No_Location
995 -- Ignore references from within an instance. The only exceptions to
996 -- this are default subprograms, for which we generate an implicit
997 -- reference and compilations in SPARK mode.
1000 (Instantiation_Location (Sloc (N)) = No_Location
1002 or else GNATprove_Mode)
1004 -- Ignore dummy references
1008 if Nkind_In (N, N_Identifier,
1009 N_Defining_Identifier,
1010 N_Defining_Operator_Symbol,
1012 N_Defining_Character_Literal)
1013 or else Nkind (N) in N_Op
1014 or else (Nkind (N) = N_Character_Literal
1015 and then Sloc (Entity (N)) /= Standard_Location)
1019 elsif Nkind_In (N, N_Expanded_Name, N_Selected_Component) then
1020 Nod := Selector_Name (N);
1026 -- Normal case of source entity comes from source
1028 if Comes_From_Source (E) then
1031 -- Because a declaration may be generated for a subprogram body
1032 -- without declaration in GNATprove mode, for inlining, some
1033 -- parameters may end up being marked as not coming from source
1034 -- although they are. Take these into account specially.
1036 elsif GNATprove_Mode and then Ekind (E) in Formal_Kind then
1039 -- Entity does not come from source, but is a derived subprogram and
1040 -- the derived subprogram comes from source (after one or more
1041 -- derivations) in which case the reference is to parent subprogram.
1043 elsif Is_Overloadable (E)
1044 and then Present (Alias (E))
1047 while not Comes_From_Source (Ent) loop
1048 if No (Alias (Ent)) then
1055 -- The internally created defining entity for a child subprogram
1056 -- that has no previous spec has valid references.
1058 elsif Is_Overloadable (E)
1059 and then Is_Child_Unit (E)
1063 -- Ditto for the formals of such a subprogram
1065 elsif Is_Overloadable (Scope (E))
1066 and then Is_Child_Unit (Scope (E))
1070 -- Record components of discriminated subtypes or derived types must
1071 -- be treated as references to the original component.
1073 elsif Ekind (E) = E_Component
1074 and then Comes_From_Source (Original_Record_Component (E))
1076 Ent := Original_Record_Component (E);
1078 -- If this is an expanded reference to a discriminant, recover the
1079 -- original discriminant, which gets the reference.
1081 elsif Ekind (E) = E_In_Parameter
1082 and then Present (Discriminal_Link (E))
1084 Ent := Discriminal_Link (E);
1085 Set_Referenced (Ent);
1087 -- Ignore reference to any other entity that is not from source
1093 -- In SPARK mode, consider the underlying entity renamed instead of
1094 -- the renaming, which is needed to compute a valid set of effects
1095 -- (reads, writes) for the enclosing subprogram.
1097 if GNATprove_Mode then
1098 Ent := Get_Through_Renamings (Ent);
1100 -- If no enclosing object, then it could be a reference to any
1101 -- location not tracked individually, like heap-allocated data.
1102 -- Conservatively approximate this possibility by generating a
1103 -- dereference, and return.
1106 if Actual_Typ = 'w' then
1107 SPARK_Specific.Generate_Dereference (Nod, 'r');
1108 SPARK_Specific.Generate_Dereference (Nod, 'w');
1110 SPARK_Specific.Generate_Dereference (Nod, 'r');
1117 -- Record reference to entity
1120 and then Is_Subprogram (Nod)
1121 and then Present (Overridden_Operation (Nod))
1126 -- Comment needed here for special SPARK code ???
1128 if GNATprove_Mode then
1133 SPARK_Specific.Enclosing_Subprogram_Or_Library_Package (Nod);
1135 SPARK_Specific.Enclosing_Subprogram_Or_Library_Package (Ent);
1137 -- Since we are reaching through renamings in SPARK mode, we may
1138 -- end up with standard constants. Ignore those.
1140 if Sloc (Ent_Scope) <= Standard_Location
1141 or else Def <= Standard_Location
1150 Eun => Get_Top_Level_Code_Unit (Def),
1151 Lun => Get_Top_Level_Code_Unit (Ref),
1152 Ref_Scope => Ref_Scope,
1153 Ent_Scope => Ent_Scope),
1154 Ent_Scope_File => Get_Top_Level_Code_Unit (Ent));
1157 Ref := Original_Location (Sloc (Nod));
1158 Def := Original_Location (Sloc (Ent));
1160 -- If this is an operator symbol, skip the initial quote for
1161 -- navigation purposes. This is not done for the end label,
1162 -- where we want the actual position after the closing quote.
1167 elsif Nkind (N) = N_Defining_Operator_Symbol
1168 or else Nkind (Nod) = N_Operator_Symbol
1177 Eun => Get_Source_Unit (Def),
1178 Lun => Get_Source_Unit (Ref),
1180 Ent_Scope => Empty),
1181 Ent_Scope_File => No_Unit);
1183 -- Generate reference to the first private entity
1186 and then Comes_From_Source (E)
1187 and then Nkind (Ent) = N_Defining_Identifier
1188 and then (Is_Package_Or_Generic_Package (Ent)
1189 or else Is_Concurrent_Type (Ent))
1190 and then Present (First_Private_Entity (E))
1191 and then In_Extended_Main_Source_Unit (N)
1193 -- Handle case in which the full-view and partial-view of the
1194 -- first private entity are swapped.
1197 First_Private : Entity_Id := First_Private_Entity (E);
1200 if Is_Private_Type (First_Private)
1201 and then Present (Full_View (First_Private))
1203 First_Private := Full_View (First_Private);
1208 Loc => Sloc (First_Private),
1210 Eun => Get_Source_Unit (Def),
1211 Lun => Get_Source_Unit (Ref),
1213 Ent_Scope => Empty),
1214 Ent_Scope_File => No_Unit);
1219 end Generate_Reference;
1221 -----------------------------------
1222 -- Generate_Reference_To_Formals --
1223 -----------------------------------
1225 procedure Generate_Reference_To_Formals (E : Entity_Id) is
1229 if Is_Generic_Subprogram (E) then
1230 Formal := First_Entity (E);
1232 while Present (Formal)
1233 and then not Is_Formal (Formal)
1235 Next_Entity (Formal);
1238 elsif Ekind (E) in Access_Subprogram_Kind then
1239 Formal := First_Formal (Designated_Type (E));
1242 Formal := First_Formal (E);
1245 while Present (Formal) loop
1246 if Ekind (Formal) = E_In_Parameter then
1248 if Nkind (Parameter_Type (Parent (Formal))) = N_Access_Definition
1250 Generate_Reference (E, Formal, '^', False);
1252 Generate_Reference (E, Formal, '>', False);
1255 elsif Ekind (Formal) = E_In_Out_Parameter then
1256 Generate_Reference (E, Formal, '=', False);
1259 Generate_Reference (E, Formal, '<', False);
1262 Next_Formal (Formal);
1264 end Generate_Reference_To_Formals;
1266 -------------------------------------------
1267 -- Generate_Reference_To_Generic_Formals --
1268 -------------------------------------------
1270 procedure Generate_Reference_To_Generic_Formals (E : Entity_Id) is
1274 Formal := First_Entity (E);
1275 while Present (Formal) loop
1276 if Comes_From_Source (Formal) then
1277 Generate_Reference (E, Formal, 'z', False);
1280 Next_Entity (Formal);
1282 end Generate_Reference_To_Generic_Formals;
1288 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number is
1293 ----------------------------
1294 -- Has_Deferred_Reference --
1295 ----------------------------
1297 function Has_Deferred_Reference (Ent : Entity_Id) return Boolean is
1299 for J in Deferred_References.First .. Deferred_References.Last loop
1300 if Deferred_References.Table (J).E = Ent then
1306 end Has_Deferred_Reference;
1312 function Hash (F : Xref_Entry_Number) return Header_Num is
1313 -- It is unlikely to have two references to the same entity at the same
1314 -- source location, so the hash function depends only on the Ent and Loc
1317 XE : Xref_Entry renames Xrefs.Table (F);
1318 type M is mod 2**32;
1320 H : constant M := M (XE.Key.Ent) + 2 ** 7 * M (abs XE.Key.Loc);
1321 -- It would be more natural to write:
1323 -- H : constant M := M'Mod (XE.Key.Ent) + 2**7 * M'Mod (XE.Key.Loc);
1325 -- But we can't use M'Mod, because it prevents bootstrapping with older
1326 -- compilers. Loc can be negative, so we do "abs" before converting.
1327 -- One day this can be cleaned up ???
1330 return Header_Num (H mod Num_Buckets);
1337 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number) is
1339 Xrefs.Table (E).HTable_Next := Next;
1346 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number is
1348 return Xrefs.Table (E).HTable_Next;
1355 procedure Initialize is
1364 function Lt (T1, T2 : Xref_Entry) return Boolean is
1366 -- First test: if entity is in different unit, sort by unit
1368 if T1.Key.Eun /= T2.Key.Eun then
1369 return Dependency_Num (T1.Key.Eun) < Dependency_Num (T2.Key.Eun);
1371 -- Second test: within same unit, sort by entity Sloc
1373 elsif T1.Def /= T2.Def then
1374 return T1.Def < T2.Def;
1376 -- Third test: sort definitions ahead of references
1378 elsif T1.Key.Loc = No_Location then
1381 elsif T2.Key.Loc = No_Location then
1384 -- Fourth test: for same entity, sort by reference location unit
1386 elsif T1.Key.Lun /= T2.Key.Lun then
1387 return Dependency_Num (T1.Key.Lun) < Dependency_Num (T2.Key.Lun);
1389 -- Fifth test: order of location within referencing unit
1391 elsif T1.Key.Loc /= T2.Key.Loc then
1392 return T1.Key.Loc < T2.Key.Loc;
1394 -- Finally, for two locations at the same address, we prefer
1395 -- the one that does NOT have the type 'r' so that a modification
1396 -- or extension takes preference, when there are more than one
1397 -- reference at the same location. As a result, in the case of
1398 -- entities that are in-out actuals, the read reference follows
1399 -- the modify reference.
1402 return T2.Key.Typ = 'r';
1406 -----------------------
1407 -- Output_References --
1408 -----------------------
1410 procedure Output_References is
1412 procedure Get_Type_Reference
1414 Tref : out Entity_Id;
1415 Left : out Character;
1416 Right : out Character);
1417 -- Given an Entity_Id Ent, determines whether a type reference is
1418 -- required. If so, Tref is set to the entity for the type reference
1419 -- and Left and Right are set to the left/right brackets to be output
1420 -- for the reference. If no type reference is required, then Tref is
1421 -- set to Empty, and Left/Right are set to space.
1423 procedure Output_Import_Export_Info (Ent : Entity_Id);
1424 -- Output language and external name information for an interfaced
1425 -- entity, using the format <language, external_name>.
1427 ------------------------
1428 -- Get_Type_Reference --
1429 ------------------------
1431 procedure Get_Type_Reference
1433 Tref : out Entity_Id;
1434 Left : out Character;
1435 Right : out Character)
1440 -- See if we have a type reference
1449 -- Processing for types
1451 if Is_Type (Tref) then
1453 -- Case of base type
1455 if Base_Type (Tref) = Tref then
1457 -- If derived, then get first subtype
1459 if Tref /= Etype (Tref) then
1460 Tref := First_Subtype (Etype (Tref));
1462 -- Set brackets for derived type, but don't override
1463 -- pointer case since the fact that something is a
1464 -- pointer is more important.
1471 -- If the completion of a private type is itself a derived
1472 -- type, we need the parent of the full view.
1474 elsif Is_Private_Type (Tref)
1475 and then Present (Full_View (Tref))
1476 and then Etype (Full_View (Tref)) /= Full_View (Tref)
1478 Tref := Etype (Full_View (Tref));
1485 -- If non-derived pointer, get directly designated type.
1486 -- If the type has a full view, all references are on the
1487 -- partial view that is seen first.
1489 elsif Is_Access_Type (Tref) then
1490 Tref := Directly_Designated_Type (Tref);
1494 elsif Is_Private_Type (Tref)
1495 and then Present (Full_View (Tref))
1497 if Is_Access_Type (Full_View (Tref)) then
1498 Tref := Directly_Designated_Type (Full_View (Tref));
1502 -- If the full view is an array type, we also retrieve
1503 -- the corresponding component type, because the ali
1504 -- entry already indicates that this is an array.
1506 elsif Is_Array_Type (Full_View (Tref)) then
1507 Tref := Component_Type (Full_View (Tref));
1512 -- If non-derived array, get component type. Skip component
1513 -- type for case of String or Wide_String, saves worthwhile
1516 elsif Is_Array_Type (Tref)
1517 and then Tref /= Standard_String
1518 and then Tref /= Standard_Wide_String
1520 Tref := Component_Type (Tref);
1524 -- For other non-derived base types, nothing
1530 -- For a subtype, go to ancestor subtype
1533 Tref := Ancestor_Subtype (Tref);
1535 -- If no ancestor subtype, go to base type
1538 Tref := Base_Type (Sav);
1542 -- For objects, functions, enum literals, just get type from
1545 elsif Is_Object (Tref)
1546 or else Ekind (Tref) = E_Enumeration_Literal
1547 or else Ekind (Tref) = E_Function
1548 or else Ekind (Tref) = E_Operator
1550 Tref := Etype (Tref);
1552 -- Another special case: an object of a classwide type
1553 -- initialized with a tag-indeterminate call gets a subtype
1554 -- of the classwide type during expansion. See if the original
1555 -- type in the declaration is named, and return it instead
1556 -- of going to the root type. The expression may be a class-
1557 -- wide function call whose result is on the secondary stack,
1558 -- which forces the declaration to be rewritten as a renaming,
1559 -- so examine the source declaration.
1561 if Ekind (Tref) = E_Class_Wide_Subtype then
1563 Decl : constant Node_Id := Original_Node (Parent (Ent));
1565 if Nkind (Decl) = N_Object_Declaration
1566 and then Is_Entity_Name
1567 (Original_Node (Object_Definition (Decl)))
1570 Entity (Original_Node (Object_Definition (Decl)));
1574 -- For a function that returns a class-wide type, Tref is
1577 elsif Is_Overloadable (Ent)
1578 and then Is_Class_Wide_Type (Tref)
1583 -- For anything else, exit
1589 -- Exit if no type reference, or we are stuck in some loop trying
1590 -- to find the type reference, or if the type is standard void
1591 -- type (the latter is an implementation artifact that should not
1592 -- show up in the generated cross-references).
1596 or else Tref = Standard_Void_Type;
1598 -- If we have a usable type reference, return, otherwise keep
1599 -- looking for something useful (we are looking for something
1600 -- that either comes from source or standard)
1602 if Sloc (Tref) = Standard_Location
1603 or else Comes_From_Source (Tref)
1605 -- If the reference is a subtype created for a generic actual,
1606 -- go actual directly, the inner subtype is not user visible.
1608 if Nkind (Parent (Tref)) = N_Subtype_Declaration
1609 and then not Comes_From_Source (Parent (Tref))
1611 (Is_Wrapper_Package (Scope (Tref))
1612 or else Is_Generic_Instance (Scope (Tref)))
1614 Tref := First_Subtype (Base_Type (Tref));
1621 -- If we fall through the loop, no type reference
1626 end Get_Type_Reference;
1628 -------------------------------
1629 -- Output_Import_Export_Info --
1630 -------------------------------
1632 procedure Output_Import_Export_Info (Ent : Entity_Id) is
1633 Language_Name : Name_Id;
1634 Conv : constant Convention_Id := Convention (Ent);
1637 -- Generate language name from convention
1639 if Conv = Convention_C then
1640 Language_Name := Name_C;
1642 elsif Conv = Convention_CPP then
1643 Language_Name := Name_CPP;
1645 elsif Conv = Convention_Ada then
1646 Language_Name := Name_Ada;
1649 -- For the moment we ignore all other cases ???
1654 Write_Info_Char ('<');
1655 Get_Unqualified_Name_String (Language_Name);
1657 for J in 1 .. Name_Len loop
1658 Write_Info_Char (Name_Buffer (J));
1661 if Present (Interface_Name (Ent)) then
1662 Write_Info_Char (',');
1663 String_To_Name_Buffer (Strval (Interface_Name (Ent)));
1665 for J in 1 .. Name_Len loop
1666 Write_Info_Char (Name_Buffer (J));
1670 Write_Info_Char ('>');
1671 end Output_Import_Export_Info;
1673 -- Start of processing for Output_References
1676 -- First we add references to the primitive operations of tagged types
1677 -- declared in the main unit.
1679 Handle_Prim_Ops : declare
1683 for J in 1 .. Xrefs.Last loop
1684 Ent := Xrefs.Table (J).Key.Ent;
1687 and then Is_Tagged_Type (Ent)
1688 and then Is_Base_Type (Ent)
1689 and then In_Extended_Main_Source_Unit (Ent)
1691 Generate_Prim_Op_References (Ent);
1694 end Handle_Prim_Ops;
1696 -- Before we go ahead and output the references we have a problem
1697 -- that needs dealing with. So far we have captured things that are
1698 -- definitely referenced by the main unit, or defined in the main
1699 -- unit. That's because we don't want to clutter up the ali file
1700 -- for this unit with definition lines for entities in other units
1701 -- that are not referenced.
1703 -- But there is a glitch. We may reference an entity in another unit,
1704 -- and it may have a type reference to an entity that is not directly
1705 -- referenced in the main unit, which may mean that there is no xref
1706 -- entry for this entity yet in the list of references.
1708 -- If we don't do something about this, we will end with an orphan type
1709 -- reference, i.e. it will point to an entity that does not appear
1710 -- within the generated references in the ali file. That is not good for
1711 -- tools using the xref information.
1713 -- To fix this, we go through the references adding definition entries
1714 -- for any unreferenced entities that can be referenced in a type
1715 -- reference. There is a recursion problem here, and that is dealt with
1716 -- by making sure that this traversal also traverses any entries that
1717 -- get added by the traversal.
1719 Handle_Orphan_Type_References : declare
1725 pragma Warnings (Off, L);
1726 pragma Warnings (Off, R);
1728 procedure New_Entry (E : Entity_Id);
1729 -- Make an additional entry into the Xref table for a type entity
1730 -- that is related to the current entity (parent, type ancestor,
1731 -- progenitor, etc.).
1737 procedure New_Entry (E : Entity_Id) is
1739 pragma Assert (Present (E));
1741 if not Has_Xref_Entry (Implementation_Base_Type (E))
1742 and then Sloc (E) > No_Location
1747 Typ => Character'First,
1748 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
1751 Ent_Scope => Empty),
1752 Ent_Scope_File => No_Unit);
1756 -- Start of processing for Handle_Orphan_Type_References
1759 -- Note that this is not a for loop for a very good reason. The
1760 -- processing of items in the table can add new items to the table,
1761 -- and they must be processed as well.
1764 while J <= Xrefs.Last loop
1765 Ent := Xrefs.Table (J).Key.Ent;
1767 -- Do not generate reference information for an ignored Ghost
1768 -- entity because neither the entity nor its references will
1769 -- appear in the final tree.
1771 if Is_Ignored_Ghost_Entity (Ent) then
1772 goto Orphan_Continue;
1775 Get_Type_Reference (Ent, Tref, L, R);
1778 and then not Has_Xref_Entry (Tref)
1779 and then Sloc (Tref) > No_Location
1783 if Is_Record_Type (Ent)
1784 and then Present (Interfaces (Ent))
1786 -- Add an entry for each one of the given interfaces
1787 -- implemented by type Ent.
1790 Elmt : Elmt_Id := First_Elmt (Interfaces (Ent));
1792 while Present (Elmt) loop
1793 New_Entry (Node (Elmt));
1800 -- Collect inherited primitive operations that may be declared in
1801 -- another unit and have no visible reference in the current one.
1804 and then Is_Tagged_Type (Ent)
1805 and then Is_Derived_Type (Ent)
1806 and then Is_Base_Type (Ent)
1807 and then In_Extended_Main_Source_Unit (Ent)
1810 Op_List : constant Elist_Id := Primitive_Operations (Ent);
1814 function Parent_Op (E : Entity_Id) return Entity_Id;
1815 -- Find original operation, which may be inherited through
1816 -- several derivations.
1818 function Parent_Op (E : Entity_Id) return Entity_Id is
1819 Orig_Op : constant Entity_Id := Alias (E);
1822 if No (Orig_Op) then
1825 elsif not Comes_From_Source (E)
1826 and then not Has_Xref_Entry (Orig_Op)
1827 and then Comes_From_Source (Orig_Op)
1831 return Parent_Op (Orig_Op);
1836 Op := First_Elmt (Op_List);
1837 while Present (Op) loop
1838 Prim := Parent_Op (Node (Op));
1840 if Present (Prim) then
1844 Typ => Character'First,
1845 Eun => Get_Source_Unit (Sloc (Prim)),
1848 Ent_Scope => Empty),
1849 Ent_Scope_File => No_Unit);
1860 end Handle_Orphan_Type_References;
1862 -- Now we have all the references, including those for any embedded type
1863 -- references, so we can sort them, and output them.
1865 Output_Refs : declare
1866 Nrefs : constant Nat := Xrefs.Last;
1867 -- Number of references in table
1869 Rnums : array (0 .. Nrefs) of Nat;
1870 -- This array contains numbers of references in the Xrefs table.
1871 -- This list is sorted in output order. The extra 0'th entry is
1872 -- convenient for the call to sort. When we sort the table, we
1873 -- move the entries in Rnums around, but we do not move the
1874 -- original table entries.
1876 Curxu : Unit_Number_Type;
1877 -- Current xref unit
1879 Curru : Unit_Number_Type;
1880 -- Current reference unit for one entity
1885 Curnam : String (1 .. Name_Buffer'Length);
1887 -- Simple name and length of current entity
1889 Curdef : Source_Ptr;
1890 -- Original source location for current entity
1893 -- Current reference location
1896 -- Entity type character
1899 -- reference kind of previous reference
1905 -- Renaming reference
1907 Trunit : Unit_Number_Type;
1908 -- Unit number for type reference
1910 function Lt (Op1, Op2 : Natural) return Boolean;
1911 -- Comparison function for Sort call
1913 function Name_Change (X : Entity_Id) return Boolean;
1914 -- Determines if entity X has a different simple name from Curent
1916 procedure Move (From : Natural; To : Natural);
1917 -- Move procedure for Sort call
1919 package Sorting is new GNAT.Heap_Sort_G (Move, Lt);
1925 function Lt (Op1, Op2 : Natural) return Boolean is
1926 T1 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op1)));
1927 T2 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op2)));
1937 procedure Move (From : Natural; To : Natural) is
1939 Rnums (Nat (To)) := Rnums (Nat (From));
1946 -- Why a string comparison here??? Why not compare Name_Id values???
1948 function Name_Change (X : Entity_Id) return Boolean is
1950 Get_Unqualified_Name_String (Chars (X));
1952 if Name_Len /= Curlen then
1955 return Name_Buffer (1 .. Curlen) /= Curnam (1 .. Curlen);
1959 -- Start of processing for Output_Refs
1962 -- Capture the definition Sloc values. We delay doing this till now,
1963 -- since at the time the reference or definition is made, private
1964 -- types may be swapped, and the Sloc value may be incorrect. We
1965 -- also set up the pointer vector for the sort.
1967 -- For user-defined operators we need to skip the initial quote and
1968 -- point to the first character of the name, for navigation purposes.
1970 for J in 1 .. Nrefs loop
1972 E : constant Entity_Id := Xrefs.Table (J).Key.Ent;
1973 Loc : constant Source_Ptr := Original_Location (Sloc (E));
1978 if Nkind (E) = N_Defining_Operator_Symbol then
1979 Xrefs.Table (J).Def := Loc + 1;
1981 Xrefs.Table (J).Def := Loc;
1986 -- Sort the references
1988 Sorting.Sort (Integer (Nrefs));
1990 -- Initialize loop through references
1994 Curdef := No_Location;
1996 Crloc := No_Location;
1999 -- Loop to output references
2001 for Refno in 1 .. Nrefs loop
2002 Output_One_Ref : declare
2005 XE : Xref_Entry renames Xrefs.Table (Rnums (Refno));
2006 -- The current entry to be accessed
2010 -- Used for {} or <> or () for type reference
2012 procedure Check_Type_Reference
2014 List_Interface : Boolean;
2015 Is_Component : Boolean := False);
2016 -- Find whether there is a meaningful type reference for
2017 -- Ent, and display it accordingly. If List_Interface is
2018 -- true, then Ent is a progenitor interface of the current
2019 -- type entity being listed. In that case list it as is,
2020 -- without looking for a type reference for it. Flag is also
2021 -- used for index types of an array type, where the caller
2022 -- supplies the intended type reference. Is_Component serves
2023 -- the same purpose, to display the component type of a
2024 -- derived array type, for which only the parent type has
2025 -- ben displayed so far.
2027 procedure Output_Instantiation_Refs (Loc : Source_Ptr);
2028 -- Recursive procedure to output instantiation references for
2029 -- the given source ptr in [file|line[...]] form. No output
2030 -- if the given location is not a generic template reference.
2032 procedure Output_Overridden_Op (Old_E : Entity_Id);
2033 -- For a subprogram that is overriding, display information
2034 -- about the inherited operation that it overrides.
2036 --------------------------
2037 -- Check_Type_Reference --
2038 --------------------------
2040 procedure Check_Type_Reference
2042 List_Interface : Boolean;
2043 Is_Component : Boolean := False)
2046 if List_Interface then
2048 -- This is a progenitor interface of the type for which
2049 -- xref information is being generated.
2055 -- The following is not documented in lib-xref.ads ???
2057 elsif Is_Component then
2063 Get_Type_Reference (Ent, Tref, Left, Right);
2066 if Present (Tref) then
2068 -- Case of standard entity, output name
2070 if Sloc (Tref) = Standard_Location then
2071 Write_Info_Char (Left);
2072 Write_Info_Name (Chars (Tref));
2073 Write_Info_Char (Right);
2075 -- Case of source entity, output location
2078 Write_Info_Char (Left);
2079 Trunit := Get_Source_Unit (Sloc (Tref));
2081 if Trunit /= Curxu then
2082 Write_Info_Nat (Dependency_Num (Trunit));
2083 Write_Info_Char ('|');
2087 (Int (Get_Logical_Line_Number (Sloc (Tref))));
2095 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2098 and then Present (Full_View (Ent))
2100 Ent := Underlying_Type (Ent);
2102 if Present (Ent) then
2103 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2107 Write_Info_Char (Ctyp);
2111 (Int (Get_Column_Number (Sloc (Tref))));
2113 -- If the type comes from an instantiation, add the
2114 -- corresponding info.
2116 Output_Instantiation_Refs (Sloc (Tref));
2117 Write_Info_Char (Right);
2120 end Check_Type_Reference;
2122 -------------------------------
2123 -- Output_Instantiation_Refs --
2124 -------------------------------
2126 procedure Output_Instantiation_Refs (Loc : Source_Ptr) is
2127 Iloc : constant Source_Ptr := Instantiation_Location (Loc);
2128 Lun : Unit_Number_Type;
2129 Cu : constant Unit_Number_Type := Curru;
2132 -- Nothing to do if this is not an instantiation
2134 if Iloc = No_Location then
2138 -- Output instantiation reference
2140 Write_Info_Char ('[');
2141 Lun := Get_Source_Unit (Iloc);
2143 if Lun /= Curru then
2145 Write_Info_Nat (Dependency_Num (Curru));
2146 Write_Info_Char ('|');
2149 Write_Info_Nat (Int (Get_Logical_Line_Number (Iloc)));
2151 -- Recursive call to get nested instantiations
2153 Output_Instantiation_Refs (Iloc);
2155 -- Output final ] after call to get proper nesting
2157 Write_Info_Char (']');
2160 end Output_Instantiation_Refs;
2162 --------------------------
2163 -- Output_Overridden_Op --
2164 --------------------------
2166 procedure Output_Overridden_Op (Old_E : Entity_Id) is
2170 -- The overridden operation has an implicit declaration
2171 -- at the point of derivation. What we want to display
2172 -- is the original operation, which has the actual body
2173 -- (or abstract declaration) that is being overridden.
2174 -- The overridden operation is not always set, e.g. when
2175 -- it is a predefined operator.
2180 -- Follow alias chain if one is present
2182 elsif Present (Alias (Old_E)) then
2184 -- The subprogram may have been implicitly inherited
2185 -- through several levels of derivation, so find the
2186 -- ultimate (source) ancestor.
2188 Op := Ultimate_Alias (Old_E);
2190 -- Normal case of no alias present. We omit generated
2191 -- primitives like tagged equality, that have no source
2199 and then Sloc (Op) /= Standard_Location
2200 and then Comes_From_Source (Op)
2203 Loc : constant Source_Ptr := Sloc (Op);
2204 Par_Unit : constant Unit_Number_Type :=
2205 Get_Source_Unit (Loc);
2208 Write_Info_Char ('<');
2210 if Par_Unit /= Curxu then
2211 Write_Info_Nat (Dependency_Num (Par_Unit));
2212 Write_Info_Char ('|');
2215 Write_Info_Nat (Int (Get_Logical_Line_Number (Loc)));
2216 Write_Info_Char ('p');
2217 Write_Info_Nat (Int (Get_Column_Number (Loc)));
2218 Write_Info_Char ('>');
2221 end Output_Overridden_Op;
2223 -- Start of processing for Output_One_Ref
2228 -- Do not generate reference information for an ignored Ghost
2229 -- entity because neither the entity nor its references will
2230 -- appear in the final tree.
2232 if Is_Ignored_Ghost_Entity (Ent) then
2236 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2238 -- Skip reference if it is the only reference to an entity,
2239 -- and it is an END line reference, and the entity is not in
2240 -- the current extended source. This prevents junk entries
2241 -- consisting only of packages with END lines, where no
2242 -- entity from the package is actually referenced.
2245 and then Ent /= Curent
2246 and then (Refno = Nrefs
2248 Ent /= Xrefs.Table (Rnums (Refno + 1)).Key.Ent)
2249 and then not In_Extended_Main_Source_Unit (Ent)
2254 -- For private type, get full view type
2257 and then Present (Full_View (XE.Key.Ent))
2259 Ent := Underlying_Type (Ent);
2261 if Present (Ent) then
2262 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2266 -- Special exception for Boolean
2268 if Ctyp = 'E' and then Is_Boolean_Type (Ent) then
2272 -- For variable reference, get corresponding type
2275 Ent := Etype (XE.Key.Ent);
2276 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2278 -- If variable is private type, get full view type
2281 and then Present (Full_View (Etype (XE.Key.Ent)))
2283 Ent := Underlying_Type (Etype (XE.Key.Ent));
2285 if Present (Ent) then
2286 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2289 elsif Is_Generic_Type (Ent) then
2291 -- If the type of the entity is a generic private type,
2292 -- there is no usable full view, so retain the indication
2293 -- that this is an object.
2298 -- Special handling for access parameters and objects and
2299 -- components of an anonymous access type.
2301 if Ekind_In (Etype (XE.Key.Ent),
2302 E_Anonymous_Access_Type,
2303 E_Anonymous_Access_Subprogram_Type,
2304 E_Anonymous_Access_Protected_Subprogram_Type)
2306 if Is_Formal (XE.Key.Ent)
2309 (XE.Key.Ent, E_Variable, E_Constant, E_Component)
2314 -- Special handling for Boolean
2316 elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
2321 -- Special handling for abstract types and operations
2323 if Is_Overloadable (XE.Key.Ent)
2324 and then Is_Abstract_Subprogram (XE.Key.Ent)
2327 Ctyp := 'x'; -- Abstract procedure
2329 elsif Ctyp = 'V' then
2330 Ctyp := 'y'; -- Abstract function
2333 elsif Is_Type (XE.Key.Ent)
2334 and then Is_Abstract_Type (XE.Key.Ent)
2336 if Is_Interface (XE.Key.Ent) then
2339 elsif Ctyp = 'R' then
2340 Ctyp := 'H'; -- Abstract type
2344 -- Only output reference if interesting type of entity
2348 -- Suppress references to object definitions, used for local
2351 or else XE.Key.Typ = 'D'
2352 or else XE.Key.Typ = 'I'
2354 -- Suppress self references, except for bodies that act as
2357 or else (XE.Key.Loc = XE.Def
2360 or else not Is_Subprogram (XE.Key.Ent)))
2362 -- Also suppress definitions of body formals (we only
2363 -- treat these as references, and the references were
2364 -- separately recorded).
2366 or else (Is_Formal (XE.Key.Ent)
2367 and then Present (Spec_Entity (XE.Key.Ent)))
2372 -- Start new Xref section if new xref unit
2374 if XE.Key.Eun /= Curxu then
2375 if Write_Info_Col > 1 then
2379 Curxu := XE.Key.Eun;
2381 Write_Info_Initiate ('X');
2382 Write_Info_Char (' ');
2383 Write_Info_Nat (Dependency_Num (XE.Key.Eun));
2384 Write_Info_Char (' ');
2386 (Reference_Name (Source_Index (XE.Key.Eun)));
2389 -- Start new Entity line if new entity. Note that we
2390 -- consider two entities the same if they have the same
2391 -- name and source location. This causes entities in
2392 -- instantiations to be treated as though they referred
2397 (XE.Key.Ent /= Curent
2399 (Name_Change (XE.Key.Ent) or else XE.Def /= Curdef))
2401 Curent := XE.Key.Ent;
2404 Get_Unqualified_Name_String (Chars (XE.Key.Ent));
2406 Curnam (1 .. Curlen) := Name_Buffer (1 .. Curlen);
2408 if Write_Info_Col > 1 then
2412 -- Write column number information
2414 Write_Info_Nat (Int (Get_Logical_Line_Number (XE.Def)));
2415 Write_Info_Char (Ctyp);
2416 Write_Info_Nat (Int (Get_Column_Number (XE.Def)));
2418 -- Write level information
2420 Write_Level_Info : declare
2421 function Is_Visible_Generic_Entity
2422 (E : Entity_Id) return Boolean;
2423 -- Check whether E is declared in the visible part
2424 -- of a generic package. For source navigation
2425 -- purposes, treat this as a visible entity.
2427 function Is_Private_Record_Component
2428 (E : Entity_Id) return Boolean;
2429 -- Check whether E is a non-inherited component of a
2430 -- private extension. Even if the enclosing record is
2431 -- public, we want to treat the component as private
2432 -- for navigation purposes.
2434 ---------------------------------
2435 -- Is_Private_Record_Component --
2436 ---------------------------------
2438 function Is_Private_Record_Component
2439 (E : Entity_Id) return Boolean
2441 S : constant Entity_Id := Scope (E);
2444 Ekind (E) = E_Component
2445 and then Nkind (Declaration_Node (S)) =
2446 N_Private_Extension_Declaration
2447 and then Original_Record_Component (E) = E;
2448 end Is_Private_Record_Component;
2450 -------------------------------
2451 -- Is_Visible_Generic_Entity --
2452 -------------------------------
2454 function Is_Visible_Generic_Entity
2455 (E : Entity_Id) return Boolean
2460 -- The Present check here is an error defense
2462 if Present (Scope (E))
2463 and then Ekind (Scope (E)) /= E_Generic_Package
2469 while Present (Par) loop
2471 Nkind (Par) = N_Generic_Package_Declaration
2473 -- Entity is a generic formal
2478 Nkind (Parent (Par)) = N_Package_Specification
2481 Is_List_Member (Par)
2482 and then List_Containing (Par) =
2483 Visible_Declarations (Parent (Par));
2485 Par := Parent (Par);
2490 end Is_Visible_Generic_Entity;
2492 -- Start of processing for Write_Level_Info
2495 if Is_Hidden (Curent)
2496 or else Is_Private_Record_Component (Curent)
2498 Write_Info_Char (' ');
2502 or else Is_Visible_Generic_Entity (Curent)
2504 Write_Info_Char ('*');
2507 Write_Info_Char (' ');
2509 end Write_Level_Info;
2511 -- Output entity name. We use the occurrence from the
2512 -- actual source program at the definition point.
2515 Ent_Name : constant String :=
2516 Exact_Source_Name (Sloc (XE.Key.Ent));
2518 for C in Ent_Name'Range loop
2519 Write_Info_Char (Ent_Name (C));
2523 -- See if we have a renaming reference
2525 if Is_Object (XE.Key.Ent)
2526 and then Present (Renamed_Object (XE.Key.Ent))
2528 Rref := Renamed_Object (XE.Key.Ent);
2530 elsif Is_Overloadable (XE.Key.Ent)
2531 and then Nkind (Parent (Declaration_Node (XE.Key.Ent)))
2532 = N_Subprogram_Renaming_Declaration
2534 Rref := Name (Parent (Declaration_Node (XE.Key.Ent)));
2536 elsif Ekind (XE.Key.Ent) = E_Package
2537 and then Nkind (Declaration_Node (XE.Key.Ent)) =
2538 N_Package_Renaming_Declaration
2540 Rref := Name (Declaration_Node (XE.Key.Ent));
2546 if Present (Rref) then
2547 if Nkind (Rref) = N_Expanded_Name then
2548 Rref := Selector_Name (Rref);
2551 if Nkind (Rref) = N_Identifier
2552 or else Nkind (Rref) = N_Operator_Symbol
2556 -- For renamed array components, use the array name
2557 -- for the renamed entity, which reflect the fact that
2558 -- in general the whole array is aliased.
2560 elsif Nkind (Rref) = N_Indexed_Component then
2561 if Nkind (Prefix (Rref)) = N_Identifier then
2562 Rref := Prefix (Rref);
2563 elsif Nkind (Prefix (Rref)) = N_Expanded_Name then
2564 Rref := Selector_Name (Prefix (Rref));
2574 -- Write out renaming reference if we have one
2576 if Present (Rref) then
2577 Write_Info_Char ('=');
2579 (Int (Get_Logical_Line_Number (Sloc (Rref))));
2580 Write_Info_Char (':');
2582 (Int (Get_Column_Number (Sloc (Rref))));
2585 -- Indicate that the entity is in the unit of the current
2590 -- Write out information about generic parent, if entity
2593 if Is_Generic_Instance (XE.Key.Ent) then
2595 Gen_Par : constant Entity_Id :=
2598 (Unit_Declaration_Node
2600 Loc : constant Source_Ptr := Sloc (Gen_Par);
2601 Gen_U : constant Unit_Number_Type :=
2602 Get_Source_Unit (Loc);
2605 Write_Info_Char ('[');
2607 if Curru /= Gen_U then
2608 Write_Info_Nat (Dependency_Num (Gen_U));
2609 Write_Info_Char ('|');
2613 (Int (Get_Logical_Line_Number (Loc)));
2614 Write_Info_Char (']');
2618 -- See if we have a type reference and if so output
2620 Check_Type_Reference (XE.Key.Ent, False);
2622 -- Additional information for types with progenitors,
2623 -- including synchronized tagged types.
2626 Typ : constant Entity_Id := XE.Key.Ent;
2630 if Is_Record_Type (Typ)
2631 and then Present (Interfaces (Typ))
2633 Elmt := First_Elmt (Interfaces (Typ));
2635 elsif Is_Concurrent_Type (Typ)
2636 and then Present (Corresponding_Record_Type (Typ))
2638 Interfaces (Corresponding_Record_Type (Typ)))
2642 Interfaces (Corresponding_Record_Type (Typ)));
2648 while Present (Elmt) loop
2649 Check_Type_Reference (Node (Elmt), True);
2654 -- For array types, list index types as well. (This is
2655 -- not C, indexes have distinct types).
2657 if Is_Array_Type (XE.Key.Ent) then
2659 A_Typ : constant Entity_Id := XE.Key.Ent;
2663 -- If this is a derived array type, we have
2664 -- output the parent type, so add the component
2667 if Is_Derived_Type (A_Typ) then
2668 Check_Type_Reference
2669 (Component_Type (A_Typ), False, True);
2672 -- Add references to index types.
2674 Indx := First_Index (XE.Key.Ent);
2675 while Present (Indx) loop
2676 Check_Type_Reference
2677 (First_Subtype (Etype (Indx)), True);
2683 -- If the entity is an overriding operation, write info
2684 -- on operation that was overridden.
2686 if Is_Subprogram (XE.Key.Ent)
2687 and then Present (Overridden_Operation (XE.Key.Ent))
2689 Output_Overridden_Op
2690 (Overridden_Operation (XE.Key.Ent));
2693 -- End of processing for entity output
2695 Crloc := No_Location;
2698 -- Output the reference if it is not as the same location
2699 -- as the previous one, or it is a read-reference that
2700 -- indicates that the entity is an in-out actual in a call.
2702 if XE.Key.Loc /= No_Location
2704 (XE.Key.Loc /= Crloc
2705 or else (Prevt = 'm' and then XE.Key.Typ = 'r'))
2707 Crloc := XE.Key.Loc;
2708 Prevt := XE.Key.Typ;
2710 -- Start continuation if line full, else blank
2712 if Write_Info_Col > 72 then
2714 Write_Info_Initiate ('.');
2717 Write_Info_Char (' ');
2719 -- Output file number if changed
2721 if XE.Key.Lun /= Curru then
2722 Curru := XE.Key.Lun;
2723 Write_Info_Nat (Dependency_Num (Curru));
2724 Write_Info_Char ('|');
2728 (Int (Get_Logical_Line_Number (XE.Key.Loc)));
2729 Write_Info_Char (XE.Key.Typ);
2731 if Is_Overloadable (XE.Key.Ent) then
2732 if (Is_Imported (XE.Key.Ent) and then XE.Key.Typ = 'b')
2734 (Is_Exported (XE.Key.Ent) and then XE.Key.Typ = 'i')
2736 Output_Import_Export_Info (XE.Key.Ent);
2740 Write_Info_Nat (Int (Get_Column_Number (XE.Key.Loc)));
2742 Output_Instantiation_Refs (Sloc (XE.Key.Ent));
2753 end Output_References;
2755 ---------------------------------
2756 -- Process_Deferred_References --
2757 ---------------------------------
2759 procedure Process_Deferred_References is
2761 for J in Deferred_References.First .. Deferred_References.Last loop
2763 D : Deferred_Reference_Entry renames Deferred_References.Table (J);
2766 case Is_LHS (D.N) is
2768 Generate_Reference (D.E, D.N, 'm');
2771 Generate_Reference (D.E, D.N, 'r');
2773 -- Not clear if Unknown can occur at this stage, but if it
2774 -- does we will treat it as a normal reference.
2777 Generate_Reference (D.E, D.N, 'r');
2782 -- Clear processed entries from table
2784 Deferred_References.Init;
2785 end Process_Deferred_References;
2787 -- Start of elaboration for Lib.Xref
2790 -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
2791 -- because it's not an access type.