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
1130 -- Ignore references to an entity which is a Part_Of single
1131 -- concurrent object. Ideally we would prefer to add it as a
1132 -- reference to the corresponding concurrent type, but it is quite
1133 -- difficult (as such references are not currently added even for)
1134 -- reads/writes of private protected components) and not worth the
1137 if Ekind_In (Ent, E_Abstract_State, E_Constant, E_Variable)
1138 and then Present (Encapsulating_State (Ent))
1139 and then Is_Single_Concurrent_Object (Encapsulating_State (Ent))
1148 SPARK_Specific.Enclosing_Subprogram_Or_Library_Package (Nod);
1150 SPARK_Specific.Enclosing_Subprogram_Or_Library_Package (Ent);
1152 -- Since we are reaching through renamings in SPARK mode, we may
1153 -- end up with standard constants. Ignore those.
1155 if Sloc (Ent_Scope) <= Standard_Location
1156 or else Def <= Standard_Location
1165 Eun => Get_Top_Level_Code_Unit (Def),
1166 Lun => Get_Top_Level_Code_Unit (Ref),
1167 Ref_Scope => Ref_Scope,
1168 Ent_Scope => Ent_Scope),
1169 Ent_Scope_File => Get_Top_Level_Code_Unit (Ent));
1172 Ref := Original_Location (Sloc (Nod));
1173 Def := Original_Location (Sloc (Ent));
1175 -- If this is an operator symbol, skip the initial quote for
1176 -- navigation purposes. This is not done for the end label,
1177 -- where we want the actual position after the closing quote.
1182 elsif Nkind (N) = N_Defining_Operator_Symbol
1183 or else Nkind (Nod) = N_Operator_Symbol
1192 Eun => Get_Source_Unit (Def),
1193 Lun => Get_Source_Unit (Ref),
1195 Ent_Scope => Empty),
1196 Ent_Scope_File => No_Unit);
1198 -- Generate reference to the first private entity
1201 and then Comes_From_Source (E)
1202 and then Nkind (Ent) = N_Defining_Identifier
1203 and then (Is_Package_Or_Generic_Package (Ent)
1204 or else Is_Concurrent_Type (Ent))
1205 and then Present (First_Private_Entity (E))
1206 and then In_Extended_Main_Source_Unit (N)
1208 -- Handle case in which the full-view and partial-view of the
1209 -- first private entity are swapped.
1212 First_Private : Entity_Id := First_Private_Entity (E);
1215 if Is_Private_Type (First_Private)
1216 and then Present (Full_View (First_Private))
1218 First_Private := Full_View (First_Private);
1223 Loc => Sloc (First_Private),
1225 Eun => Get_Source_Unit (Def),
1226 Lun => Get_Source_Unit (Ref),
1228 Ent_Scope => Empty),
1229 Ent_Scope_File => No_Unit);
1234 end Generate_Reference;
1236 -----------------------------------
1237 -- Generate_Reference_To_Formals --
1238 -----------------------------------
1240 procedure Generate_Reference_To_Formals (E : Entity_Id) is
1244 if Is_Generic_Subprogram (E) then
1245 Formal := First_Entity (E);
1247 while Present (Formal)
1248 and then not Is_Formal (Formal)
1250 Next_Entity (Formal);
1253 elsif Ekind (E) in Access_Subprogram_Kind then
1254 Formal := First_Formal (Designated_Type (E));
1257 Formal := First_Formal (E);
1260 while Present (Formal) loop
1261 if Ekind (Formal) = E_In_Parameter then
1263 if Nkind (Parameter_Type (Parent (Formal))) = N_Access_Definition
1265 Generate_Reference (E, Formal, '^', False);
1267 Generate_Reference (E, Formal, '>', False);
1270 elsif Ekind (Formal) = E_In_Out_Parameter then
1271 Generate_Reference (E, Formal, '=', False);
1274 Generate_Reference (E, Formal, '<', False);
1277 Next_Formal (Formal);
1279 end Generate_Reference_To_Formals;
1281 -------------------------------------------
1282 -- Generate_Reference_To_Generic_Formals --
1283 -------------------------------------------
1285 procedure Generate_Reference_To_Generic_Formals (E : Entity_Id) is
1289 Formal := First_Entity (E);
1290 while Present (Formal) loop
1291 if Comes_From_Source (Formal) then
1292 Generate_Reference (E, Formal, 'z', False);
1295 Next_Entity (Formal);
1297 end Generate_Reference_To_Generic_Formals;
1303 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number is
1308 ----------------------------
1309 -- Has_Deferred_Reference --
1310 ----------------------------
1312 function Has_Deferred_Reference (Ent : Entity_Id) return Boolean is
1314 for J in Deferred_References.First .. Deferred_References.Last loop
1315 if Deferred_References.Table (J).E = Ent then
1321 end Has_Deferred_Reference;
1327 function Hash (F : Xref_Entry_Number) return Header_Num is
1328 -- It is unlikely to have two references to the same entity at the same
1329 -- source location, so the hash function depends only on the Ent and Loc
1332 XE : Xref_Entry renames Xrefs.Table (F);
1333 type M is mod 2**32;
1335 H : constant M := M (XE.Key.Ent) + 2 ** 7 * M (abs XE.Key.Loc);
1336 -- It would be more natural to write:
1338 -- H : constant M := M'Mod (XE.Key.Ent) + 2**7 * M'Mod (XE.Key.Loc);
1340 -- But we can't use M'Mod, because it prevents bootstrapping with older
1341 -- compilers. Loc can be negative, so we do "abs" before converting.
1342 -- One day this can be cleaned up ???
1345 return Header_Num (H mod Num_Buckets);
1352 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number) is
1354 Xrefs.Table (E).HTable_Next := Next;
1361 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number is
1363 return Xrefs.Table (E).HTable_Next;
1370 procedure Initialize is
1379 function Lt (T1, T2 : Xref_Entry) return Boolean is
1381 -- First test: if entity is in different unit, sort by unit
1383 if T1.Key.Eun /= T2.Key.Eun then
1384 return Dependency_Num (T1.Key.Eun) < Dependency_Num (T2.Key.Eun);
1386 -- Second test: within same unit, sort by entity Sloc
1388 elsif T1.Def /= T2.Def then
1389 return T1.Def < T2.Def;
1391 -- Third test: sort definitions ahead of references
1393 elsif T1.Key.Loc = No_Location then
1396 elsif T2.Key.Loc = No_Location then
1399 -- Fourth test: for same entity, sort by reference location unit
1401 elsif T1.Key.Lun /= T2.Key.Lun then
1402 return Dependency_Num (T1.Key.Lun) < Dependency_Num (T2.Key.Lun);
1404 -- Fifth test: order of location within referencing unit
1406 elsif T1.Key.Loc /= T2.Key.Loc then
1407 return T1.Key.Loc < T2.Key.Loc;
1409 -- Finally, for two locations at the same address, we prefer
1410 -- the one that does NOT have the type 'r' so that a modification
1411 -- or extension takes preference, when there are more than one
1412 -- reference at the same location. As a result, in the case of
1413 -- entities that are in-out actuals, the read reference follows
1414 -- the modify reference.
1417 return T2.Key.Typ = 'r';
1421 -----------------------
1422 -- Output_References --
1423 -----------------------
1425 procedure Output_References is
1427 procedure Get_Type_Reference
1429 Tref : out Entity_Id;
1430 Left : out Character;
1431 Right : out Character);
1432 -- Given an Entity_Id Ent, determines whether a type reference is
1433 -- required. If so, Tref is set to the entity for the type reference
1434 -- and Left and Right are set to the left/right brackets to be output
1435 -- for the reference. If no type reference is required, then Tref is
1436 -- set to Empty, and Left/Right are set to space.
1438 procedure Output_Import_Export_Info (Ent : Entity_Id);
1439 -- Output language and external name information for an interfaced
1440 -- entity, using the format <language, external_name>.
1442 ------------------------
1443 -- Get_Type_Reference --
1444 ------------------------
1446 procedure Get_Type_Reference
1448 Tref : out Entity_Id;
1449 Left : out Character;
1450 Right : out Character)
1455 -- See if we have a type reference
1464 -- Processing for types
1466 if Is_Type (Tref) then
1468 -- Case of base type
1470 if Base_Type (Tref) = Tref then
1472 -- If derived, then get first subtype
1474 if Tref /= Etype (Tref) then
1475 Tref := First_Subtype (Etype (Tref));
1477 -- Set brackets for derived type, but don't override
1478 -- pointer case since the fact that something is a
1479 -- pointer is more important.
1486 -- If the completion of a private type is itself a derived
1487 -- type, we need the parent of the full view.
1489 elsif Is_Private_Type (Tref)
1490 and then Present (Full_View (Tref))
1491 and then Etype (Full_View (Tref)) /= Full_View (Tref)
1493 Tref := Etype (Full_View (Tref));
1500 -- If non-derived pointer, get directly designated type.
1501 -- If the type has a full view, all references are on the
1502 -- partial view that is seen first.
1504 elsif Is_Access_Type (Tref) then
1505 Tref := Directly_Designated_Type (Tref);
1509 elsif Is_Private_Type (Tref)
1510 and then Present (Full_View (Tref))
1512 if Is_Access_Type (Full_View (Tref)) then
1513 Tref := Directly_Designated_Type (Full_View (Tref));
1517 -- If the full view is an array type, we also retrieve
1518 -- the corresponding component type, because the ali
1519 -- entry already indicates that this is an array.
1521 elsif Is_Array_Type (Full_View (Tref)) then
1522 Tref := Component_Type (Full_View (Tref));
1527 -- If non-derived array, get component type. Skip component
1528 -- type for case of String or Wide_String, saves worthwhile
1531 elsif Is_Array_Type (Tref)
1532 and then Tref /= Standard_String
1533 and then Tref /= Standard_Wide_String
1535 Tref := Component_Type (Tref);
1539 -- For other non-derived base types, nothing
1545 -- For a subtype, go to ancestor subtype
1548 Tref := Ancestor_Subtype (Tref);
1550 -- If no ancestor subtype, go to base type
1553 Tref := Base_Type (Sav);
1557 -- For objects, functions, enum literals, just get type from
1560 elsif Is_Object (Tref)
1561 or else Ekind (Tref) = E_Enumeration_Literal
1562 or else Ekind (Tref) = E_Function
1563 or else Ekind (Tref) = E_Operator
1565 Tref := Etype (Tref);
1567 -- Another special case: an object of a classwide type
1568 -- initialized with a tag-indeterminate call gets a subtype
1569 -- of the classwide type during expansion. See if the original
1570 -- type in the declaration is named, and return it instead
1571 -- of going to the root type. The expression may be a class-
1572 -- wide function call whose result is on the secondary stack,
1573 -- which forces the declaration to be rewritten as a renaming,
1574 -- so examine the source declaration.
1576 if Ekind (Tref) = E_Class_Wide_Subtype then
1578 Decl : constant Node_Id := Original_Node (Parent (Ent));
1580 if Nkind (Decl) = N_Object_Declaration
1581 and then Is_Entity_Name
1582 (Original_Node (Object_Definition (Decl)))
1585 Entity (Original_Node (Object_Definition (Decl)));
1589 -- For a function that returns a class-wide type, Tref is
1592 elsif Is_Overloadable (Ent)
1593 and then Is_Class_Wide_Type (Tref)
1598 -- For anything else, exit
1604 -- Exit if no type reference, or we are stuck in some loop trying
1605 -- to find the type reference, or if the type is standard void
1606 -- type (the latter is an implementation artifact that should not
1607 -- show up in the generated cross-references).
1611 or else Tref = Standard_Void_Type;
1613 -- If we have a usable type reference, return, otherwise keep
1614 -- looking for something useful (we are looking for something
1615 -- that either comes from source or standard)
1617 if Sloc (Tref) = Standard_Location
1618 or else Comes_From_Source (Tref)
1620 -- If the reference is a subtype created for a generic actual,
1621 -- go actual directly, the inner subtype is not user visible.
1623 if Nkind (Parent (Tref)) = N_Subtype_Declaration
1624 and then not Comes_From_Source (Parent (Tref))
1626 (Is_Wrapper_Package (Scope (Tref))
1627 or else Is_Generic_Instance (Scope (Tref)))
1629 Tref := First_Subtype (Base_Type (Tref));
1636 -- If we fall through the loop, no type reference
1641 end Get_Type_Reference;
1643 -------------------------------
1644 -- Output_Import_Export_Info --
1645 -------------------------------
1647 procedure Output_Import_Export_Info (Ent : Entity_Id) is
1648 Language_Name : Name_Id;
1649 Conv : constant Convention_Id := Convention (Ent);
1652 -- Generate language name from convention
1654 if Conv = Convention_C then
1655 Language_Name := Name_C;
1657 elsif Conv = Convention_CPP then
1658 Language_Name := Name_CPP;
1660 elsif Conv = Convention_Ada then
1661 Language_Name := Name_Ada;
1664 -- For the moment we ignore all other cases ???
1669 Write_Info_Char ('<');
1670 Get_Unqualified_Name_String (Language_Name);
1672 for J in 1 .. Name_Len loop
1673 Write_Info_Char (Name_Buffer (J));
1676 if Present (Interface_Name (Ent)) then
1677 Write_Info_Char (',');
1678 String_To_Name_Buffer (Strval (Interface_Name (Ent)));
1680 for J in 1 .. Name_Len loop
1681 Write_Info_Char (Name_Buffer (J));
1685 Write_Info_Char ('>');
1686 end Output_Import_Export_Info;
1688 -- Start of processing for Output_References
1691 -- First we add references to the primitive operations of tagged types
1692 -- declared in the main unit.
1694 Handle_Prim_Ops : declare
1698 for J in 1 .. Xrefs.Last loop
1699 Ent := Xrefs.Table (J).Key.Ent;
1702 and then Is_Tagged_Type (Ent)
1703 and then Is_Base_Type (Ent)
1704 and then In_Extended_Main_Source_Unit (Ent)
1706 Generate_Prim_Op_References (Ent);
1709 end Handle_Prim_Ops;
1711 -- Before we go ahead and output the references we have a problem
1712 -- that needs dealing with. So far we have captured things that are
1713 -- definitely referenced by the main unit, or defined in the main
1714 -- unit. That's because we don't want to clutter up the ali file
1715 -- for this unit with definition lines for entities in other units
1716 -- that are not referenced.
1718 -- But there is a glitch. We may reference an entity in another unit,
1719 -- and it may have a type reference to an entity that is not directly
1720 -- referenced in the main unit, which may mean that there is no xref
1721 -- entry for this entity yet in the list of references.
1723 -- If we don't do something about this, we will end with an orphan type
1724 -- reference, i.e. it will point to an entity that does not appear
1725 -- within the generated references in the ali file. That is not good for
1726 -- tools using the xref information.
1728 -- To fix this, we go through the references adding definition entries
1729 -- for any unreferenced entities that can be referenced in a type
1730 -- reference. There is a recursion problem here, and that is dealt with
1731 -- by making sure that this traversal also traverses any entries that
1732 -- get added by the traversal.
1734 Handle_Orphan_Type_References : declare
1740 pragma Warnings (Off, L);
1741 pragma Warnings (Off, R);
1743 procedure New_Entry (E : Entity_Id);
1744 -- Make an additional entry into the Xref table for a type entity
1745 -- that is related to the current entity (parent, type ancestor,
1746 -- progenitor, etc.).
1752 procedure New_Entry (E : Entity_Id) is
1754 pragma Assert (Present (E));
1756 if not Has_Xref_Entry (Implementation_Base_Type (E))
1757 and then Sloc (E) > No_Location
1762 Typ => Character'First,
1763 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
1766 Ent_Scope => Empty),
1767 Ent_Scope_File => No_Unit);
1771 -- Start of processing for Handle_Orphan_Type_References
1774 -- Note that this is not a for loop for a very good reason. The
1775 -- processing of items in the table can add new items to the table,
1776 -- and they must be processed as well.
1779 while J <= Xrefs.Last loop
1780 Ent := Xrefs.Table (J).Key.Ent;
1782 -- Do not generate reference information for an ignored Ghost
1783 -- entity because neither the entity nor its references will
1784 -- appear in the final tree.
1786 if Is_Ignored_Ghost_Entity (Ent) then
1787 goto Orphan_Continue;
1790 Get_Type_Reference (Ent, Tref, L, R);
1793 and then not Has_Xref_Entry (Tref)
1794 and then Sloc (Tref) > No_Location
1798 if Is_Record_Type (Ent)
1799 and then Present (Interfaces (Ent))
1801 -- Add an entry for each one of the given interfaces
1802 -- implemented by type Ent.
1805 Elmt : Elmt_Id := First_Elmt (Interfaces (Ent));
1807 while Present (Elmt) loop
1808 New_Entry (Node (Elmt));
1815 -- Collect inherited primitive operations that may be declared in
1816 -- another unit and have no visible reference in the current one.
1819 and then Is_Tagged_Type (Ent)
1820 and then Is_Derived_Type (Ent)
1821 and then Is_Base_Type (Ent)
1822 and then In_Extended_Main_Source_Unit (Ent)
1825 Op_List : constant Elist_Id := Primitive_Operations (Ent);
1829 function Parent_Op (E : Entity_Id) return Entity_Id;
1830 -- Find original operation, which may be inherited through
1831 -- several derivations.
1833 function Parent_Op (E : Entity_Id) return Entity_Id is
1834 Orig_Op : constant Entity_Id := Alias (E);
1837 if No (Orig_Op) then
1840 elsif not Comes_From_Source (E)
1841 and then not Has_Xref_Entry (Orig_Op)
1842 and then Comes_From_Source (Orig_Op)
1846 return Parent_Op (Orig_Op);
1851 Op := First_Elmt (Op_List);
1852 while Present (Op) loop
1853 Prim := Parent_Op (Node (Op));
1855 if Present (Prim) then
1859 Typ => Character'First,
1860 Eun => Get_Source_Unit (Sloc (Prim)),
1863 Ent_Scope => Empty),
1864 Ent_Scope_File => No_Unit);
1875 end Handle_Orphan_Type_References;
1877 -- Now we have all the references, including those for any embedded type
1878 -- references, so we can sort them, and output them.
1880 Output_Refs : declare
1881 Nrefs : constant Nat := Xrefs.Last;
1882 -- Number of references in table
1884 Rnums : array (0 .. Nrefs) of Nat;
1885 -- This array contains numbers of references in the Xrefs table.
1886 -- This list is sorted in output order. The extra 0'th entry is
1887 -- convenient for the call to sort. When we sort the table, we
1888 -- move the entries in Rnums around, but we do not move the
1889 -- original table entries.
1891 Curxu : Unit_Number_Type;
1892 -- Current xref unit
1894 Curru : Unit_Number_Type;
1895 -- Current reference unit for one entity
1900 Curnam : String (1 .. Name_Buffer'Length);
1902 -- Simple name and length of current entity
1904 Curdef : Source_Ptr;
1905 -- Original source location for current entity
1908 -- Current reference location
1911 -- Entity type character
1914 -- reference kind of previous reference
1920 -- Renaming reference
1922 Trunit : Unit_Number_Type;
1923 -- Unit number for type reference
1925 function Lt (Op1, Op2 : Natural) return Boolean;
1926 -- Comparison function for Sort call
1928 function Name_Change (X : Entity_Id) return Boolean;
1929 -- Determines if entity X has a different simple name from Curent
1931 procedure Move (From : Natural; To : Natural);
1932 -- Move procedure for Sort call
1934 package Sorting is new GNAT.Heap_Sort_G (Move, Lt);
1940 function Lt (Op1, Op2 : Natural) return Boolean is
1941 T1 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op1)));
1942 T2 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op2)));
1952 procedure Move (From : Natural; To : Natural) is
1954 Rnums (Nat (To)) := Rnums (Nat (From));
1961 -- Why a string comparison here??? Why not compare Name_Id values???
1963 function Name_Change (X : Entity_Id) return Boolean is
1965 Get_Unqualified_Name_String (Chars (X));
1967 if Name_Len /= Curlen then
1970 return Name_Buffer (1 .. Curlen) /= Curnam (1 .. Curlen);
1974 -- Start of processing for Output_Refs
1977 -- Capture the definition Sloc values. We delay doing this till now,
1978 -- since at the time the reference or definition is made, private
1979 -- types may be swapped, and the Sloc value may be incorrect. We
1980 -- also set up the pointer vector for the sort.
1982 -- For user-defined operators we need to skip the initial quote and
1983 -- point to the first character of the name, for navigation purposes.
1985 for J in 1 .. Nrefs loop
1987 E : constant Entity_Id := Xrefs.Table (J).Key.Ent;
1988 Loc : constant Source_Ptr := Original_Location (Sloc (E));
1993 if Nkind (E) = N_Defining_Operator_Symbol then
1994 Xrefs.Table (J).Def := Loc + 1;
1996 Xrefs.Table (J).Def := Loc;
2001 -- Sort the references
2003 Sorting.Sort (Integer (Nrefs));
2005 -- Initialize loop through references
2009 Curdef := No_Location;
2011 Crloc := No_Location;
2014 -- Loop to output references
2016 for Refno in 1 .. Nrefs loop
2017 Output_One_Ref : declare
2020 XE : Xref_Entry renames Xrefs.Table (Rnums (Refno));
2021 -- The current entry to be accessed
2025 -- Used for {} or <> or () for type reference
2027 procedure Check_Type_Reference
2029 List_Interface : Boolean;
2030 Is_Component : Boolean := False);
2031 -- Find whether there is a meaningful type reference for
2032 -- Ent, and display it accordingly. If List_Interface is
2033 -- true, then Ent is a progenitor interface of the current
2034 -- type entity being listed. In that case list it as is,
2035 -- without looking for a type reference for it. Flag is also
2036 -- used for index types of an array type, where the caller
2037 -- supplies the intended type reference. Is_Component serves
2038 -- the same purpose, to display the component type of a
2039 -- derived array type, for which only the parent type has
2040 -- ben displayed so far.
2042 procedure Output_Instantiation_Refs (Loc : Source_Ptr);
2043 -- Recursive procedure to output instantiation references for
2044 -- the given source ptr in [file|line[...]] form. No output
2045 -- if the given location is not a generic template reference.
2047 procedure Output_Overridden_Op (Old_E : Entity_Id);
2048 -- For a subprogram that is overriding, display information
2049 -- about the inherited operation that it overrides.
2051 --------------------------
2052 -- Check_Type_Reference --
2053 --------------------------
2055 procedure Check_Type_Reference
2057 List_Interface : Boolean;
2058 Is_Component : Boolean := False)
2061 if List_Interface then
2063 -- This is a progenitor interface of the type for which
2064 -- xref information is being generated.
2070 -- The following is not documented in lib-xref.ads ???
2072 elsif Is_Component then
2078 Get_Type_Reference (Ent, Tref, Left, Right);
2081 if Present (Tref) then
2083 -- Case of standard entity, output name
2085 if Sloc (Tref) = Standard_Location then
2086 Write_Info_Char (Left);
2087 Write_Info_Name (Chars (Tref));
2088 Write_Info_Char (Right);
2090 -- Case of source entity, output location
2093 Write_Info_Char (Left);
2094 Trunit := Get_Source_Unit (Sloc (Tref));
2096 if Trunit /= Curxu then
2097 Write_Info_Nat (Dependency_Num (Trunit));
2098 Write_Info_Char ('|');
2102 (Int (Get_Logical_Line_Number (Sloc (Tref))));
2110 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2113 and then Present (Full_View (Ent))
2115 Ent := Underlying_Type (Ent);
2117 if Present (Ent) then
2118 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2122 Write_Info_Char (Ctyp);
2126 (Int (Get_Column_Number (Sloc (Tref))));
2128 -- If the type comes from an instantiation, add the
2129 -- corresponding info.
2131 Output_Instantiation_Refs (Sloc (Tref));
2132 Write_Info_Char (Right);
2135 end Check_Type_Reference;
2137 -------------------------------
2138 -- Output_Instantiation_Refs --
2139 -------------------------------
2141 procedure Output_Instantiation_Refs (Loc : Source_Ptr) is
2142 Iloc : constant Source_Ptr := Instantiation_Location (Loc);
2143 Lun : Unit_Number_Type;
2144 Cu : constant Unit_Number_Type := Curru;
2147 -- Nothing to do if this is not an instantiation
2149 if Iloc = No_Location then
2153 -- Output instantiation reference
2155 Write_Info_Char ('[');
2156 Lun := Get_Source_Unit (Iloc);
2158 if Lun /= Curru then
2160 Write_Info_Nat (Dependency_Num (Curru));
2161 Write_Info_Char ('|');
2164 Write_Info_Nat (Int (Get_Logical_Line_Number (Iloc)));
2166 -- Recursive call to get nested instantiations
2168 Output_Instantiation_Refs (Iloc);
2170 -- Output final ] after call to get proper nesting
2172 Write_Info_Char (']');
2175 end Output_Instantiation_Refs;
2177 --------------------------
2178 -- Output_Overridden_Op --
2179 --------------------------
2181 procedure Output_Overridden_Op (Old_E : Entity_Id) is
2185 -- The overridden operation has an implicit declaration
2186 -- at the point of derivation. What we want to display
2187 -- is the original operation, which has the actual body
2188 -- (or abstract declaration) that is being overridden.
2189 -- The overridden operation is not always set, e.g. when
2190 -- it is a predefined operator.
2195 -- Follow alias chain if one is present
2197 elsif Present (Alias (Old_E)) then
2199 -- The subprogram may have been implicitly inherited
2200 -- through several levels of derivation, so find the
2201 -- ultimate (source) ancestor.
2203 Op := Ultimate_Alias (Old_E);
2205 -- Normal case of no alias present. We omit generated
2206 -- primitives like tagged equality, that have no source
2214 and then Sloc (Op) /= Standard_Location
2215 and then Comes_From_Source (Op)
2218 Loc : constant Source_Ptr := Sloc (Op);
2219 Par_Unit : constant Unit_Number_Type :=
2220 Get_Source_Unit (Loc);
2223 Write_Info_Char ('<');
2225 if Par_Unit /= Curxu then
2226 Write_Info_Nat (Dependency_Num (Par_Unit));
2227 Write_Info_Char ('|');
2230 Write_Info_Nat (Int (Get_Logical_Line_Number (Loc)));
2231 Write_Info_Char ('p');
2232 Write_Info_Nat (Int (Get_Column_Number (Loc)));
2233 Write_Info_Char ('>');
2236 end Output_Overridden_Op;
2238 -- Start of processing for Output_One_Ref
2243 -- Do not generate reference information for an ignored Ghost
2244 -- entity because neither the entity nor its references will
2245 -- appear in the final tree.
2247 if Is_Ignored_Ghost_Entity (Ent) then
2251 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2253 -- Skip reference if it is the only reference to an entity,
2254 -- and it is an END line reference, and the entity is not in
2255 -- the current extended source. This prevents junk entries
2256 -- consisting only of packages with END lines, where no
2257 -- entity from the package is actually referenced.
2260 and then Ent /= Curent
2261 and then (Refno = Nrefs
2263 Ent /= Xrefs.Table (Rnums (Refno + 1)).Key.Ent)
2264 and then not In_Extended_Main_Source_Unit (Ent)
2269 -- For private type, get full view type
2272 and then Present (Full_View (XE.Key.Ent))
2274 Ent := Underlying_Type (Ent);
2276 if Present (Ent) then
2277 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2281 -- Special exception for Boolean
2283 if Ctyp = 'E' and then Is_Boolean_Type (Ent) then
2287 -- For variable reference, get corresponding type
2290 Ent := Etype (XE.Key.Ent);
2291 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2293 -- If variable is private type, get full view type
2296 and then Present (Full_View (Etype (XE.Key.Ent)))
2298 Ent := Underlying_Type (Etype (XE.Key.Ent));
2300 if Present (Ent) then
2301 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2304 elsif Is_Generic_Type (Ent) then
2306 -- If the type of the entity is a generic private type,
2307 -- there is no usable full view, so retain the indication
2308 -- that this is an object.
2313 -- Special handling for access parameters and objects and
2314 -- components of an anonymous access type.
2316 if Ekind_In (Etype (XE.Key.Ent),
2317 E_Anonymous_Access_Type,
2318 E_Anonymous_Access_Subprogram_Type,
2319 E_Anonymous_Access_Protected_Subprogram_Type)
2321 if Is_Formal (XE.Key.Ent)
2324 (XE.Key.Ent, E_Variable, E_Constant, E_Component)
2329 -- Special handling for Boolean
2331 elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
2336 -- Special handling for abstract types and operations
2338 if Is_Overloadable (XE.Key.Ent)
2339 and then Is_Abstract_Subprogram (XE.Key.Ent)
2342 Ctyp := 'x'; -- Abstract procedure
2344 elsif Ctyp = 'V' then
2345 Ctyp := 'y'; -- Abstract function
2348 elsif Is_Type (XE.Key.Ent)
2349 and then Is_Abstract_Type (XE.Key.Ent)
2351 if Is_Interface (XE.Key.Ent) then
2354 elsif Ctyp = 'R' then
2355 Ctyp := 'H'; -- Abstract type
2359 -- Only output reference if interesting type of entity
2363 -- Suppress references to object definitions, used for local
2366 or else XE.Key.Typ = 'D'
2367 or else XE.Key.Typ = 'I'
2369 -- Suppress self references, except for bodies that act as
2372 or else (XE.Key.Loc = XE.Def
2375 or else not Is_Subprogram (XE.Key.Ent)))
2377 -- Also suppress definitions of body formals (we only
2378 -- treat these as references, and the references were
2379 -- separately recorded).
2381 or else (Is_Formal (XE.Key.Ent)
2382 and then Present (Spec_Entity (XE.Key.Ent)))
2387 -- Start new Xref section if new xref unit
2389 if XE.Key.Eun /= Curxu then
2390 if Write_Info_Col > 1 then
2394 Curxu := XE.Key.Eun;
2396 Write_Info_Initiate ('X');
2397 Write_Info_Char (' ');
2398 Write_Info_Nat (Dependency_Num (XE.Key.Eun));
2399 Write_Info_Char (' ');
2401 (Reference_Name (Source_Index (XE.Key.Eun)));
2404 -- Start new Entity line if new entity. Note that we
2405 -- consider two entities the same if they have the same
2406 -- name and source location. This causes entities in
2407 -- instantiations to be treated as though they referred
2412 (XE.Key.Ent /= Curent
2414 (Name_Change (XE.Key.Ent) or else XE.Def /= Curdef))
2416 Curent := XE.Key.Ent;
2419 Get_Unqualified_Name_String (Chars (XE.Key.Ent));
2421 Curnam (1 .. Curlen) := Name_Buffer (1 .. Curlen);
2423 if Write_Info_Col > 1 then
2427 -- Write column number information
2429 Write_Info_Nat (Int (Get_Logical_Line_Number (XE.Def)));
2430 Write_Info_Char (Ctyp);
2431 Write_Info_Nat (Int (Get_Column_Number (XE.Def)));
2433 -- Write level information
2435 Write_Level_Info : declare
2436 function Is_Visible_Generic_Entity
2437 (E : Entity_Id) return Boolean;
2438 -- Check whether E is declared in the visible part
2439 -- of a generic package. For source navigation
2440 -- purposes, treat this as a visible entity.
2442 function Is_Private_Record_Component
2443 (E : Entity_Id) return Boolean;
2444 -- Check whether E is a non-inherited component of a
2445 -- private extension. Even if the enclosing record is
2446 -- public, we want to treat the component as private
2447 -- for navigation purposes.
2449 ---------------------------------
2450 -- Is_Private_Record_Component --
2451 ---------------------------------
2453 function Is_Private_Record_Component
2454 (E : Entity_Id) return Boolean
2456 S : constant Entity_Id := Scope (E);
2459 Ekind (E) = E_Component
2460 and then Nkind (Declaration_Node (S)) =
2461 N_Private_Extension_Declaration
2462 and then Original_Record_Component (E) = E;
2463 end Is_Private_Record_Component;
2465 -------------------------------
2466 -- Is_Visible_Generic_Entity --
2467 -------------------------------
2469 function Is_Visible_Generic_Entity
2470 (E : Entity_Id) return Boolean
2475 -- The Present check here is an error defense
2477 if Present (Scope (E))
2478 and then Ekind (Scope (E)) /= E_Generic_Package
2484 while Present (Par) loop
2486 Nkind (Par) = N_Generic_Package_Declaration
2488 -- Entity is a generic formal
2493 Nkind (Parent (Par)) = N_Package_Specification
2496 Is_List_Member (Par)
2497 and then List_Containing (Par) =
2498 Visible_Declarations (Parent (Par));
2500 Par := Parent (Par);
2505 end Is_Visible_Generic_Entity;
2507 -- Start of processing for Write_Level_Info
2510 if Is_Hidden (Curent)
2511 or else Is_Private_Record_Component (Curent)
2513 Write_Info_Char (' ');
2517 or else Is_Visible_Generic_Entity (Curent)
2519 Write_Info_Char ('*');
2522 Write_Info_Char (' ');
2524 end Write_Level_Info;
2526 -- Output entity name. We use the occurrence from the
2527 -- actual source program at the definition point.
2530 Ent_Name : constant String :=
2531 Exact_Source_Name (Sloc (XE.Key.Ent));
2533 for C in Ent_Name'Range loop
2534 Write_Info_Char (Ent_Name (C));
2538 -- See if we have a renaming reference
2540 if Is_Object (XE.Key.Ent)
2541 and then Present (Renamed_Object (XE.Key.Ent))
2543 Rref := Renamed_Object (XE.Key.Ent);
2545 elsif Is_Overloadable (XE.Key.Ent)
2546 and then Nkind (Parent (Declaration_Node (XE.Key.Ent)))
2547 = N_Subprogram_Renaming_Declaration
2549 Rref := Name (Parent (Declaration_Node (XE.Key.Ent)));
2551 elsif Ekind (XE.Key.Ent) = E_Package
2552 and then Nkind (Declaration_Node (XE.Key.Ent)) =
2553 N_Package_Renaming_Declaration
2555 Rref := Name (Declaration_Node (XE.Key.Ent));
2561 if Present (Rref) then
2562 if Nkind (Rref) = N_Expanded_Name then
2563 Rref := Selector_Name (Rref);
2566 if Nkind (Rref) = N_Identifier
2567 or else Nkind (Rref) = N_Operator_Symbol
2571 -- For renamed array components, use the array name
2572 -- for the renamed entity, which reflect the fact that
2573 -- in general the whole array is aliased.
2575 elsif Nkind (Rref) = N_Indexed_Component then
2576 if Nkind (Prefix (Rref)) = N_Identifier then
2577 Rref := Prefix (Rref);
2578 elsif Nkind (Prefix (Rref)) = N_Expanded_Name then
2579 Rref := Selector_Name (Prefix (Rref));
2589 -- Write out renaming reference if we have one
2591 if Present (Rref) then
2592 Write_Info_Char ('=');
2594 (Int (Get_Logical_Line_Number (Sloc (Rref))));
2595 Write_Info_Char (':');
2597 (Int (Get_Column_Number (Sloc (Rref))));
2600 -- Indicate that the entity is in the unit of the current
2605 -- Write out information about generic parent, if entity
2608 if Is_Generic_Instance (XE.Key.Ent) then
2610 Gen_Par : constant Entity_Id :=
2613 (Unit_Declaration_Node
2615 Loc : constant Source_Ptr := Sloc (Gen_Par);
2616 Gen_U : constant Unit_Number_Type :=
2617 Get_Source_Unit (Loc);
2620 Write_Info_Char ('[');
2622 if Curru /= Gen_U then
2623 Write_Info_Nat (Dependency_Num (Gen_U));
2624 Write_Info_Char ('|');
2628 (Int (Get_Logical_Line_Number (Loc)));
2629 Write_Info_Char (']');
2633 -- See if we have a type reference and if so output
2635 Check_Type_Reference (XE.Key.Ent, False);
2637 -- Additional information for types with progenitors,
2638 -- including synchronized tagged types.
2641 Typ : constant Entity_Id := XE.Key.Ent;
2645 if Is_Record_Type (Typ)
2646 and then Present (Interfaces (Typ))
2648 Elmt := First_Elmt (Interfaces (Typ));
2650 elsif Is_Concurrent_Type (Typ)
2651 and then Present (Corresponding_Record_Type (Typ))
2653 Interfaces (Corresponding_Record_Type (Typ)))
2657 Interfaces (Corresponding_Record_Type (Typ)));
2663 while Present (Elmt) loop
2664 Check_Type_Reference (Node (Elmt), True);
2669 -- For array types, list index types as well. (This is
2670 -- not C, indexes have distinct types).
2672 if Is_Array_Type (XE.Key.Ent) then
2674 A_Typ : constant Entity_Id := XE.Key.Ent;
2678 -- If this is a derived array type, we have
2679 -- output the parent type, so add the component
2682 if Is_Derived_Type (A_Typ) then
2683 Check_Type_Reference
2684 (Component_Type (A_Typ), False, True);
2687 -- Add references to index types.
2689 Indx := First_Index (XE.Key.Ent);
2690 while Present (Indx) loop
2691 Check_Type_Reference
2692 (First_Subtype (Etype (Indx)), True);
2698 -- If the entity is an overriding operation, write info
2699 -- on operation that was overridden.
2701 if Is_Subprogram (XE.Key.Ent)
2702 and then Present (Overridden_Operation (XE.Key.Ent))
2704 Output_Overridden_Op
2705 (Overridden_Operation (XE.Key.Ent));
2708 -- End of processing for entity output
2710 Crloc := No_Location;
2713 -- Output the reference if it is not as the same location
2714 -- as the previous one, or it is a read-reference that
2715 -- indicates that the entity is an in-out actual in a call.
2717 if XE.Key.Loc /= No_Location
2719 (XE.Key.Loc /= Crloc
2720 or else (Prevt = 'm' and then XE.Key.Typ = 'r'))
2722 Crloc := XE.Key.Loc;
2723 Prevt := XE.Key.Typ;
2725 -- Start continuation if line full, else blank
2727 if Write_Info_Col > 72 then
2729 Write_Info_Initiate ('.');
2732 Write_Info_Char (' ');
2734 -- Output file number if changed
2736 if XE.Key.Lun /= Curru then
2737 Curru := XE.Key.Lun;
2738 Write_Info_Nat (Dependency_Num (Curru));
2739 Write_Info_Char ('|');
2743 (Int (Get_Logical_Line_Number (XE.Key.Loc)));
2744 Write_Info_Char (XE.Key.Typ);
2746 if Is_Overloadable (XE.Key.Ent) then
2747 if (Is_Imported (XE.Key.Ent) and then XE.Key.Typ = 'b')
2749 (Is_Exported (XE.Key.Ent) and then XE.Key.Typ = 'i')
2751 Output_Import_Export_Info (XE.Key.Ent);
2755 Write_Info_Nat (Int (Get_Column_Number (XE.Key.Loc)));
2757 Output_Instantiation_Refs (Sloc (XE.Key.Ent));
2768 end Output_References;
2770 ---------------------------------
2771 -- Process_Deferred_References --
2772 ---------------------------------
2774 procedure Process_Deferred_References is
2776 for J in Deferred_References.First .. Deferred_References.Last loop
2778 D : Deferred_Reference_Entry renames Deferred_References.Table (J);
2781 case Is_LHS (D.N) is
2783 Generate_Reference (D.E, D.N, 'm');
2786 Generate_Reference (D.E, D.N, 'r');
2788 -- Not clear if Unknown can occur at this stage, but if it
2789 -- does we will treat it as a normal reference.
2792 Generate_Reference (D.E, D.N, 'r');
2797 -- Clear processed entries from table
2799 Deferred_References.Init;
2800 end Process_Deferred_References;
2802 -- Start of elaboration for Lib.Xref
2805 -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
2806 -- because it's not an access type.