1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1998-2016, 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
416 Result : Entity_Id := E;
419 while Present (Result)
420 and then Is_Object (Result)
421 and then Present (Renamed_Object (Result))
423 Result := Get_Enclosing_Object (Renamed_Object (Result));
427 end Get_Through_Renamings;
433 -- ??? There are several routines here and there that perform a similar
434 -- (but subtly different) computation, which should be factored:
437 -- Sem_Util.May_Be_Lvalue
438 -- Sem_Util.Known_To_Be_Assigned
439 -- Exp_Ch2.Expand_Entry_Parameter.In_Assignment_Context
440 -- Exp_Smem.Is_Out_Actual
442 function Is_On_LHS (Node : Node_Id) return Boolean is
448 -- Only identifiers are considered, is this necessary???
450 if Nkind (Node) /= N_Identifier then
454 -- Immediate return if appeared as OUT parameter
456 if Kind = E_Out_Parameter then
460 -- Search for assignment statement subtree root
467 if K = N_Assignment_Statement then
470 -- Check whether the parent is a component and the current node is
471 -- its prefix, but return False if the current node has an access
472 -- type, as in that case the selected or indexed component is an
473 -- implicit dereference, and the LHS is the designated object, not
474 -- the access object.
476 -- ??? case of a slice assignment?
478 elsif (K = N_Selected_Component or else K = N_Indexed_Component)
479 and then Prefix (P) = N
481 -- Check for access type. First a special test, In some cases
482 -- this is called too early (see comments in Find_Direct_Name),
483 -- at a point where the tree is not fully typed yet. In that
484 -- case we may lack an Etype for N, and we can't check the
485 -- Etype. For now, we always return False in such a case,
486 -- but this is clearly not right in all cases ???
488 if No (Etype (N)) then
491 elsif Is_Access_Type (Etype (N)) then
494 -- Access type case dealt with, keep going
500 -- All other cases, definitely not on left side
508 ---------------------------
509 -- OK_To_Set_Referenced --
510 ---------------------------
512 function OK_To_Set_Referenced return Boolean is
516 -- A reference from a pragma Unreferenced or pragma Unmodified or
517 -- pragma Warnings does not cause the Referenced flag to be set.
518 -- This avoids silly warnings about things being referenced and
519 -- not assigned when the only reference is from the pragma.
521 if Nkind (N) = N_Identifier then
524 if Nkind (P) = N_Pragma_Argument_Association then
527 if Nkind (P) = N_Pragma then
528 if Nam_In (Pragma_Name (P), Name_Warnings,
536 -- A reference to a formal in a named parameter association does
537 -- not make the formal referenced. Formals that are unused in the
538 -- subprogram body are properly flagged as such, even if calls
539 -- elsewhere use named notation.
541 elsif Nkind (P) = N_Parameter_Association
542 and then N = Selector_Name (P)
549 end OK_To_Set_Referenced;
551 -- Start of processing for Generate_Reference
554 pragma Assert (Nkind (E) in N_Entity);
555 Find_Actual (N, Formal, Call);
557 if Present (Formal) then
558 Kind := Ekind (Formal);
563 -- Check for obsolescent reference to package ASCII. GNAT treats this
564 -- element of annex J specially since in practice, programs make a lot
565 -- of use of this feature, so we don't include it in the set of features
566 -- diagnosed when Warn_On_Obsolescent_Features mode is set. However we
567 -- are required to note it as a violation of the RM defined restriction.
569 if E = Standard_ASCII then
570 Check_Restriction (No_Obsolescent_Features, N);
573 -- Check for reference to entity marked with Is_Obsolescent
575 -- Note that we always allow obsolescent references in the compiler
576 -- itself and the run time, since we assume that we know what we are
577 -- doing in such cases. For example the calls in Ada.Characters.Handling
578 -- to its own obsolescent subprograms are just fine.
580 -- In any case we only generate warnings if we are in the extended main
581 -- source unit, and the entity itself is not in the extended main source
582 -- unit, since we assume the source unit itself knows what is going on
583 -- (and for sure we do not want silly warnings, e.g. on the end line of
584 -- an obsolescent procedure body).
586 if Is_Obsolescent (E)
587 and then not GNAT_Mode
588 and then not In_Extended_Main_Source_Unit (E)
589 and then In_Extended_Main_Source_Unit (N)
591 Check_Restriction (No_Obsolescent_Features, N);
593 if Warn_On_Obsolescent_Feature then
594 Output_Obsolescent_Entity_Warnings (N, E);
598 -- Warn if reference to Ada 2005 entity not in Ada 2005 mode. We only
599 -- detect real explicit references (modifications and references).
601 if Comes_From_Source (N)
602 and then Is_Ada_2005_Only (E)
603 and then Ada_Version < Ada_2005
604 and then Warn_On_Ada_2005_Compatibility
605 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's')
607 Error_Msg_NE ("& is only defined in Ada 2005?y?", N, E);
610 -- Warn if reference to Ada 2012 entity not in Ada 2012 mode. We only
611 -- detect real explicit references (modifications and references).
613 if Comes_From_Source (N)
614 and then Is_Ada_2012_Only (E)
615 and then Ada_Version < Ada_2012
616 and then Warn_On_Ada_2012_Compatibility
617 and then (Typ = 'm' or else Typ = 'r')
619 Error_Msg_NE ("& is only defined in Ada 2012?y?", N, E);
622 -- Do not generate references if we are within a postcondition sub-
623 -- program, because the reference does not comes from source, and the
624 -- pre-analysis of the aspect has already created an entry for the ALI
625 -- file at the proper source location.
627 if Chars (Current_Scope) = Name_uPostconditions then
631 -- Never collect references if not in main source unit. However, we omit
632 -- this test if Typ is 'e' or 'k', since these entries are structural,
633 -- and it is useful to have them in units that reference packages as
634 -- well as units that define packages. We also omit the test for the
635 -- case of 'p' since we want to include inherited primitive operations
636 -- from other packages.
638 -- We also omit this test is this is a body reference for a subprogram
639 -- instantiation. In this case the reference is to the generic body,
640 -- which clearly need not be in the main unit containing the instance.
641 -- For the same reason we accept an implicit reference generated for
642 -- a default in an instance.
644 -- We also set the referenced flag in a generic package that is not in
645 -- then main source unit, when the variable is of a formal private type,
646 -- to warn in the instance if the corresponding type is not a fully
649 if not In_Extended_Main_Source_Unit (N) then
655 or else (Typ = 'b' and then Is_Generic_Instance (E))
657 -- Allow the generation of references to reads, writes and calls
658 -- in SPARK mode when the related context comes from an instance.
662 and then In_Extended_Main_Code_Unit (N)
663 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's'))
667 elsif In_Instance_Body
668 and then In_Extended_Main_Code_Unit (N)
669 and then Is_Generic_Type (Etype (E))
674 elsif Inside_A_Generic
675 and then Is_Generic_Type (Etype (E))
685 -- For reference type p, the entity must be in main source unit
687 if Typ = 'p' and then not In_Extended_Main_Source_Unit (E) then
691 -- Unless the reference is forced, we ignore references where the
692 -- reference itself does not come from source.
694 if not Force and then not Comes_From_Source (N) then
698 -- Deal with setting entity as referenced, unless suppressed. Note that
699 -- we still do Set_Referenced on entities that do not come from source.
700 -- This situation arises when we have a source reference to a derived
701 -- operation, where the derived operation itself does not come from
702 -- source, but we still want to mark it as referenced, since we really
703 -- are referencing an entity in the corresponding package (this avoids
704 -- wrong complaints that the package contains no referenced entities).
708 -- Assignable object appearing on left side of assignment or as
712 and then Is_On_LHS (N)
713 and then Ekind (E) /= E_In_Out_Parameter
715 -- For objects that are renamings, just set as simply referenced
716 -- we do not try to do assignment type tracking in this case.
718 if Present (Renamed_Object (E)) then
721 -- Out parameter case
723 elsif Kind = E_Out_Parameter then
725 -- If warning mode for all out parameters is set, or this is
726 -- the only warning parameter, then we want to mark this for
727 -- later warning logic by setting Referenced_As_Out_Parameter
729 if Warn_On_Modified_As_Out_Parameter (Formal) then
730 Set_Referenced_As_Out_Parameter (E, True);
731 Set_Referenced_As_LHS (E, False);
733 -- For OUT parameter not covered by the above cases, we simply
734 -- regard it as a normal reference (in this case we do not
735 -- want any of the warning machinery for out parameters).
741 -- For the left hand of an assignment case, we do nothing here.
742 -- The processing for Analyze_Assignment_Statement will set the
743 -- Referenced_As_LHS flag.
749 -- Check for a reference in a pragma that should not count as a
750 -- making the variable referenced for warning purposes.
752 elsif Is_Non_Significant_Pragma_Reference (N) then
755 -- A reference in an attribute definition clause does not count as a
756 -- reference except for the case of Address. The reason that 'Address
757 -- is an exception is that it creates an alias through which the
758 -- variable may be referenced.
760 elsif Nkind (Parent (N)) = N_Attribute_Definition_Clause
761 and then Chars (Parent (N)) /= Name_Address
762 and then N = Name (Parent (N))
766 -- Constant completion does not count as a reference
769 and then Ekind (E) = E_Constant
773 -- Record representation clause does not count as a reference
775 elsif Nkind (N) = N_Identifier
776 and then Nkind (Parent (N)) = N_Record_Representation_Clause
780 -- Discriminants do not need to produce a reference to record type
783 and then Nkind (Parent (N)) = N_Discriminant_Specification
790 -- Special processing for IN OUT parameters, where we have an
791 -- implicit assignment to a simple variable.
793 if Kind = E_In_Out_Parameter
794 and then Is_Assignable (E)
796 -- For sure this counts as a normal read reference
799 Set_Last_Assignment (E, Empty);
801 -- We count it as being referenced as an out parameter if the
802 -- option is set to warn on all out parameters, except that we
803 -- have a special exclusion for an intrinsic subprogram, which
804 -- is most likely an instantiation of Unchecked_Deallocation
805 -- which we do not want to consider as an assignment since it
806 -- generates false positives. We also exclude the case of an
807 -- IN OUT parameter if the name of the procedure is Free,
808 -- since we suspect similar semantics.
810 if Warn_On_All_Unread_Out_Parameters
811 and then Is_Entity_Name (Name (Call))
812 and then not Is_Intrinsic_Subprogram (Entity (Name (Call)))
813 and then Chars (Name (Call)) /= Name_Free
815 Set_Referenced_As_Out_Parameter (E, True);
816 Set_Referenced_As_LHS (E, False);
819 -- Don't count a recursive reference within a subprogram as a
820 -- reference (that allows detection of a recursive subprogram
821 -- whose only references are recursive calls as unreferenced).
823 elsif Is_Subprogram (E)
824 and then E = Nearest_Dynamic_Scope (Current_Scope)
828 -- Any other occurrence counts as referencing the entity
830 elsif OK_To_Set_Referenced then
833 -- If variable, this is an OK reference after an assignment
834 -- so we can clear the Last_Assignment indication.
836 if Is_Assignable (E) then
837 Set_Last_Assignment (E, Empty);
842 -- Check for pragma Unreferenced given and reference is within
843 -- this source unit (occasion for possible warning to be issued).
844 -- Note that the entity may be marked as unreferenced by pragma
847 if Has_Unreferenced (E)
848 and then In_Same_Extended_Unit (E, N)
850 -- A reference as a named parameter in a call does not count
851 -- as a violation of pragma Unreferenced for this purpose...
853 if Nkind (N) = N_Identifier
854 and then Nkind (Parent (N)) = N_Parameter_Association
855 and then Selector_Name (Parent (N)) = N
859 -- ... Neither does a reference to a variable on the left side
862 elsif Is_On_LHS (N) then
865 -- For entry formals, we want to place the warning message on the
866 -- corresponding entity in the accept statement. The current scope
867 -- is the body of the accept, so we find the formal whose name
868 -- matches that of the entry formal (there is no link between the
869 -- two entities, and the one in the accept statement is only used
870 -- for conformance checking).
872 elsif Ekind (Scope (E)) = E_Entry then
877 BE := First_Entity (Current_Scope);
878 while Present (BE) loop
879 if Chars (BE) = Chars (E) then
880 if Has_Pragma_Unused (E) then
881 Error_Msg_NE -- CODEFIX
882 ("??pragma Unused given for&!", N, BE);
884 Error_Msg_NE -- CODEFIX
885 ("??pragma Unreferenced given for&!", N, BE);
894 -- Here we issue the warning, since this is a real reference
896 elsif Has_Pragma_Unused (E) then
897 Error_Msg_NE -- CODEFIX
898 ("??pragma Unused given for&!", N, E);
900 Error_Msg_NE -- CODEFIX
901 ("??pragma Unreferenced given for&!", N, E);
905 -- If this is a subprogram instance, mark as well the internal
906 -- subprogram in the wrapper package, which may be a visible
909 if Is_Overloadable (E)
910 and then Is_Generic_Instance (E)
911 and then Present (Alias (E))
913 Set_Referenced (Alias (E));
917 -- Generate reference if all conditions are met:
920 -- Cross referencing must be active
924 -- The entity must be one for which we collect references
926 and then Xref_Entity_Letters (Ekind (E)) /= ' '
928 -- Both Sloc values must be set to something sensible
930 and then Sloc (E) > No_Location
931 and then Sloc (N) > No_Location
933 -- Ignore references from within an instance. The only exceptions to
934 -- this are default subprograms, for which we generate an implicit
935 -- reference and compilations in SPARK mode.
938 (Instantiation_Location (Sloc (N)) = No_Location
940 or else GNATprove_Mode)
942 -- Ignore dummy references
946 if Nkind_In (N, N_Identifier,
947 N_Defining_Identifier,
948 N_Defining_Operator_Symbol,
950 N_Defining_Character_Literal)
951 or else Nkind (N) in N_Op
952 or else (Nkind (N) = N_Character_Literal
953 and then Sloc (Entity (N)) /= Standard_Location)
957 elsif Nkind_In (N, N_Expanded_Name, N_Selected_Component) then
958 Nod := Selector_Name (N);
964 -- Normal case of source entity comes from source
966 if Comes_From_Source (E) then
969 -- Because a declaration may be generated for a subprogram body
970 -- without declaration in GNATprove mode, for inlining, some
971 -- parameters may end up being marked as not coming from source
972 -- although they are. Take these into account specially.
974 elsif GNATprove_Mode and then Ekind (E) in Formal_Kind then
977 -- Entity does not come from source, but is a derived subprogram and
978 -- the derived subprogram comes from source (after one or more
979 -- derivations) in which case the reference is to parent subprogram.
981 elsif Is_Overloadable (E)
982 and then Present (Alias (E))
985 while not Comes_From_Source (Ent) loop
986 if No (Alias (Ent)) then
993 -- The internally created defining entity for a child subprogram
994 -- that has no previous spec has valid references.
996 elsif Is_Overloadable (E)
997 and then Is_Child_Unit (E)
1001 -- Ditto for the formals of such a subprogram
1003 elsif Is_Overloadable (Scope (E))
1004 and then Is_Child_Unit (Scope (E))
1008 -- Record components of discriminated subtypes or derived types must
1009 -- be treated as references to the original component.
1011 elsif Ekind (E) = E_Component
1012 and then Comes_From_Source (Original_Record_Component (E))
1014 Ent := Original_Record_Component (E);
1016 -- If this is an expanded reference to a discriminant, recover the
1017 -- original discriminant, which gets the reference.
1019 elsif Ekind (E) = E_In_Parameter
1020 and then Present (Discriminal_Link (E))
1022 Ent := Discriminal_Link (E);
1023 Set_Referenced (Ent);
1025 -- Ignore reference to any other entity that is not from source
1031 -- In SPARK mode, consider the underlying entity renamed instead of
1032 -- the renaming, which is needed to compute a valid set of effects
1033 -- (reads, writes) for the enclosing subprogram.
1035 if GNATprove_Mode then
1036 Ent := Get_Through_Renamings (Ent);
1038 -- If no enclosing object, then it could be a reference to any
1039 -- location not tracked individually, like heap-allocated data.
1040 -- Conservatively approximate this possibility by generating a
1041 -- dereference, and return.
1044 if Actual_Typ = 'w' then
1045 SPARK_Specific.Generate_Dereference (Nod, 'r');
1046 SPARK_Specific.Generate_Dereference (Nod, 'w');
1048 SPARK_Specific.Generate_Dereference (Nod, 'r');
1055 -- Record reference to entity
1058 and then Is_Subprogram (Nod)
1059 and then Present (Overridden_Operation (Nod))
1064 -- Comment needed here for special SPARK code ???
1066 if GNATprove_Mode then
1071 SPARK_Specific.Enclosing_Subprogram_Or_Library_Package (Nod);
1073 SPARK_Specific.Enclosing_Subprogram_Or_Library_Package (Ent);
1075 -- Since we are reaching through renamings in SPARK mode, we may
1076 -- end up with standard constants. Ignore those.
1078 if Sloc (Ent_Scope) <= Standard_Location
1079 or else Def <= Standard_Location
1088 Eun => Get_Top_Level_Code_Unit (Def),
1089 Lun => Get_Top_Level_Code_Unit (Ref),
1090 Ref_Scope => Ref_Scope,
1091 Ent_Scope => Ent_Scope),
1092 Ent_Scope_File => Get_Top_Level_Code_Unit (Ent));
1095 Ref := Original_Location (Sloc (Nod));
1096 Def := Original_Location (Sloc (Ent));
1098 -- If this is an operator symbol, skip the initial quote for
1099 -- navigation purposes. This is not done for the end label,
1100 -- where we want the actual position after the closing quote.
1105 elsif Nkind (N) = N_Defining_Operator_Symbol
1106 or else Nkind (Nod) = N_Operator_Symbol
1115 Eun => Get_Source_Unit (Def),
1116 Lun => Get_Source_Unit (Ref),
1118 Ent_Scope => Empty),
1119 Ent_Scope_File => No_Unit);
1121 -- Generate reference to the first private entity
1124 and then Comes_From_Source (E)
1125 and then Nkind (Ent) = N_Defining_Identifier
1126 and then (Is_Package_Or_Generic_Package (Ent)
1127 or else Is_Concurrent_Type (Ent))
1128 and then Present (First_Private_Entity (E))
1129 and then In_Extended_Main_Source_Unit (N)
1131 -- Handle case in which the full-view and partial-view of the
1132 -- first private entity are swapped.
1135 First_Private : Entity_Id := First_Private_Entity (E);
1138 if Is_Private_Type (First_Private)
1139 and then Present (Full_View (First_Private))
1141 First_Private := Full_View (First_Private);
1146 Loc => Sloc (First_Private),
1148 Eun => Get_Source_Unit (Def),
1149 Lun => Get_Source_Unit (Ref),
1151 Ent_Scope => Empty),
1152 Ent_Scope_File => No_Unit);
1157 end Generate_Reference;
1159 -----------------------------------
1160 -- Generate_Reference_To_Formals --
1161 -----------------------------------
1163 procedure Generate_Reference_To_Formals (E : Entity_Id) is
1167 if Is_Generic_Subprogram (E) then
1168 Formal := First_Entity (E);
1170 while Present (Formal)
1171 and then not Is_Formal (Formal)
1173 Next_Entity (Formal);
1176 elsif Ekind (E) in Access_Subprogram_Kind then
1177 Formal := First_Formal (Designated_Type (E));
1180 Formal := First_Formal (E);
1183 while Present (Formal) loop
1184 if Ekind (Formal) = E_In_Parameter then
1186 if Nkind (Parameter_Type (Parent (Formal))) = N_Access_Definition
1188 Generate_Reference (E, Formal, '^', False);
1190 Generate_Reference (E, Formal, '>', False);
1193 elsif Ekind (Formal) = E_In_Out_Parameter then
1194 Generate_Reference (E, Formal, '=', False);
1197 Generate_Reference (E, Formal, '<', False);
1200 Next_Formal (Formal);
1202 end Generate_Reference_To_Formals;
1204 -------------------------------------------
1205 -- Generate_Reference_To_Generic_Formals --
1206 -------------------------------------------
1208 procedure Generate_Reference_To_Generic_Formals (E : Entity_Id) is
1212 Formal := First_Entity (E);
1213 while Present (Formal) loop
1214 if Comes_From_Source (Formal) then
1215 Generate_Reference (E, Formal, 'z', False);
1218 Next_Entity (Formal);
1220 end Generate_Reference_To_Generic_Formals;
1226 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number is
1231 ----------------------------
1232 -- Has_Deferred_Reference --
1233 ----------------------------
1235 function Has_Deferred_Reference (Ent : Entity_Id) return Boolean is
1237 for J in Deferred_References.First .. Deferred_References.Last loop
1238 if Deferred_References.Table (J).E = Ent then
1244 end Has_Deferred_Reference;
1250 function Hash (F : Xref_Entry_Number) return Header_Num is
1251 -- It is unlikely to have two references to the same entity at the same
1252 -- source location, so the hash function depends only on the Ent and Loc
1255 XE : Xref_Entry renames Xrefs.Table (F);
1256 type M is mod 2**32;
1258 H : constant M := M (XE.Key.Ent) + 2 ** 7 * M (abs XE.Key.Loc);
1259 -- It would be more natural to write:
1261 -- H : constant M := M'Mod (XE.Key.Ent) + 2**7 * M'Mod (XE.Key.Loc);
1263 -- But we can't use M'Mod, because it prevents bootstrapping with older
1264 -- compilers. Loc can be negative, so we do "abs" before converting.
1265 -- One day this can be cleaned up ???
1268 return Header_Num (H mod Num_Buckets);
1275 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number) is
1277 Xrefs.Table (E).HTable_Next := Next;
1284 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number is
1286 return Xrefs.Table (E).HTable_Next;
1293 procedure Initialize is
1302 function Lt (T1, T2 : Xref_Entry) return Boolean is
1304 -- First test: if entity is in different unit, sort by unit
1306 if T1.Key.Eun /= T2.Key.Eun then
1307 return Dependency_Num (T1.Key.Eun) < Dependency_Num (T2.Key.Eun);
1309 -- Second test: within same unit, sort by entity Sloc
1311 elsif T1.Def /= T2.Def then
1312 return T1.Def < T2.Def;
1314 -- Third test: sort definitions ahead of references
1316 elsif T1.Key.Loc = No_Location then
1319 elsif T2.Key.Loc = No_Location then
1322 -- Fourth test: for same entity, sort by reference location unit
1324 elsif T1.Key.Lun /= T2.Key.Lun then
1325 return Dependency_Num (T1.Key.Lun) < Dependency_Num (T2.Key.Lun);
1327 -- Fifth test: order of location within referencing unit
1329 elsif T1.Key.Loc /= T2.Key.Loc then
1330 return T1.Key.Loc < T2.Key.Loc;
1332 -- Finally, for two locations at the same address, we prefer
1333 -- the one that does NOT have the type 'r' so that a modification
1334 -- or extension takes preference, when there are more than one
1335 -- reference at the same location. As a result, in the case of
1336 -- entities that are in-out actuals, the read reference follows
1337 -- the modify reference.
1340 return T2.Key.Typ = 'r';
1344 -----------------------
1345 -- Output_References --
1346 -----------------------
1348 procedure Output_References is
1350 procedure Get_Type_Reference
1352 Tref : out Entity_Id;
1353 Left : out Character;
1354 Right : out Character);
1355 -- Given an Entity_Id Ent, determines whether a type reference is
1356 -- required. If so, Tref is set to the entity for the type reference
1357 -- and Left and Right are set to the left/right brackets to be output
1358 -- for the reference. If no type reference is required, then Tref is
1359 -- set to Empty, and Left/Right are set to space.
1361 procedure Output_Import_Export_Info (Ent : Entity_Id);
1362 -- Output language and external name information for an interfaced
1363 -- entity, using the format <language, external_name>.
1365 ------------------------
1366 -- Get_Type_Reference --
1367 ------------------------
1369 procedure Get_Type_Reference
1371 Tref : out Entity_Id;
1372 Left : out Character;
1373 Right : out Character)
1378 -- See if we have a type reference
1387 -- Processing for types
1389 if Is_Type (Tref) then
1391 -- Case of base type
1393 if Base_Type (Tref) = Tref then
1395 -- If derived, then get first subtype
1397 if Tref /= Etype (Tref) then
1398 Tref := First_Subtype (Etype (Tref));
1400 -- Set brackets for derived type, but don't override
1401 -- pointer case since the fact that something is a
1402 -- pointer is more important.
1409 -- If the completion of a private type is itself a derived
1410 -- type, we need the parent of the full view.
1412 elsif Is_Private_Type (Tref)
1413 and then Present (Full_View (Tref))
1414 and then Etype (Full_View (Tref)) /= Full_View (Tref)
1416 Tref := Etype (Full_View (Tref));
1423 -- If non-derived pointer, get directly designated type.
1424 -- If the type has a full view, all references are on the
1425 -- partial view that is seen first.
1427 elsif Is_Access_Type (Tref) then
1428 Tref := Directly_Designated_Type (Tref);
1432 elsif Is_Private_Type (Tref)
1433 and then Present (Full_View (Tref))
1435 if Is_Access_Type (Full_View (Tref)) then
1436 Tref := Directly_Designated_Type (Full_View (Tref));
1440 -- If the full view is an array type, we also retrieve
1441 -- the corresponding component type, because the ali
1442 -- entry already indicates that this is an array.
1444 elsif Is_Array_Type (Full_View (Tref)) then
1445 Tref := Component_Type (Full_View (Tref));
1450 -- If non-derived array, get component type. Skip component
1451 -- type for case of String or Wide_String, saves worthwhile
1454 elsif Is_Array_Type (Tref)
1455 and then Tref /= Standard_String
1456 and then Tref /= Standard_Wide_String
1458 Tref := Component_Type (Tref);
1462 -- For other non-derived base types, nothing
1468 -- For a subtype, go to ancestor subtype
1471 Tref := Ancestor_Subtype (Tref);
1473 -- If no ancestor subtype, go to base type
1476 Tref := Base_Type (Sav);
1480 -- For objects, functions, enum literals, just get type from
1483 elsif Is_Object (Tref)
1484 or else Ekind (Tref) = E_Enumeration_Literal
1485 or else Ekind (Tref) = E_Function
1486 or else Ekind (Tref) = E_Operator
1488 Tref := Etype (Tref);
1490 -- Another special case: an object of a classwide type
1491 -- initialized with a tag-indeterminate call gets a subtype
1492 -- of the classwide type during expansion. See if the original
1493 -- type in the declaration is named, and return it instead
1494 -- of going to the root type. The expression may be a class-
1495 -- wide function call whose result is on the secondary stack,
1496 -- which forces the declaration to be rewritten as a renaming,
1497 -- so examine the source declaration.
1499 if Ekind (Tref) = E_Class_Wide_Subtype then
1501 Decl : constant Node_Id := Original_Node (Parent (Ent));
1503 if Nkind (Decl) = N_Object_Declaration
1504 and then Is_Entity_Name
1505 (Original_Node (Object_Definition (Decl)))
1508 Entity (Original_Node (Object_Definition (Decl)));
1512 -- For a function that returns a class-wide type, Tref is
1515 elsif Is_Overloadable (Ent)
1516 and then Is_Class_Wide_Type (Tref)
1521 -- For anything else, exit
1527 -- Exit if no type reference, or we are stuck in some loop trying
1528 -- to find the type reference, or if the type is standard void
1529 -- type (the latter is an implementation artifact that should not
1530 -- show up in the generated cross-references).
1534 or else Tref = Standard_Void_Type;
1536 -- If we have a usable type reference, return, otherwise keep
1537 -- looking for something useful (we are looking for something
1538 -- that either comes from source or standard)
1540 if Sloc (Tref) = Standard_Location
1541 or else Comes_From_Source (Tref)
1543 -- If the reference is a subtype created for a generic actual,
1544 -- go actual directly, the inner subtype is not user visible.
1546 if Nkind (Parent (Tref)) = N_Subtype_Declaration
1547 and then not Comes_From_Source (Parent (Tref))
1549 (Is_Wrapper_Package (Scope (Tref))
1550 or else Is_Generic_Instance (Scope (Tref)))
1552 Tref := First_Subtype (Base_Type (Tref));
1559 -- If we fall through the loop, no type reference
1564 end Get_Type_Reference;
1566 -------------------------------
1567 -- Output_Import_Export_Info --
1568 -------------------------------
1570 procedure Output_Import_Export_Info (Ent : Entity_Id) is
1571 Language_Name : Name_Id;
1572 Conv : constant Convention_Id := Convention (Ent);
1575 -- Generate language name from convention
1577 if Conv = Convention_C then
1578 Language_Name := Name_C;
1580 elsif Conv = Convention_CPP then
1581 Language_Name := Name_CPP;
1583 elsif Conv = Convention_Ada then
1584 Language_Name := Name_Ada;
1587 -- For the moment we ignore all other cases ???
1592 Write_Info_Char ('<');
1593 Get_Unqualified_Name_String (Language_Name);
1595 for J in 1 .. Name_Len loop
1596 Write_Info_Char (Name_Buffer (J));
1599 if Present (Interface_Name (Ent)) then
1600 Write_Info_Char (',');
1601 String_To_Name_Buffer (Strval (Interface_Name (Ent)));
1603 for J in 1 .. Name_Len loop
1604 Write_Info_Char (Name_Buffer (J));
1608 Write_Info_Char ('>');
1609 end Output_Import_Export_Info;
1611 -- Start of processing for Output_References
1614 -- First we add references to the primitive operations of tagged types
1615 -- declared in the main unit.
1617 Handle_Prim_Ops : declare
1621 for J in 1 .. Xrefs.Last loop
1622 Ent := Xrefs.Table (J).Key.Ent;
1625 and then Is_Tagged_Type (Ent)
1626 and then Is_Base_Type (Ent)
1627 and then In_Extended_Main_Source_Unit (Ent)
1629 Generate_Prim_Op_References (Ent);
1632 end Handle_Prim_Ops;
1634 -- Before we go ahead and output the references we have a problem
1635 -- that needs dealing with. So far we have captured things that are
1636 -- definitely referenced by the main unit, or defined in the main
1637 -- unit. That's because we don't want to clutter up the ali file
1638 -- for this unit with definition lines for entities in other units
1639 -- that are not referenced.
1641 -- But there is a glitch. We may reference an entity in another unit,
1642 -- and it may have a type reference to an entity that is not directly
1643 -- referenced in the main unit, which may mean that there is no xref
1644 -- entry for this entity yet in the list of references.
1646 -- If we don't do something about this, we will end with an orphan type
1647 -- reference, i.e. it will point to an entity that does not appear
1648 -- within the generated references in the ali file. That is not good for
1649 -- tools using the xref information.
1651 -- To fix this, we go through the references adding definition entries
1652 -- for any unreferenced entities that can be referenced in a type
1653 -- reference. There is a recursion problem here, and that is dealt with
1654 -- by making sure that this traversal also traverses any entries that
1655 -- get added by the traversal.
1657 Handle_Orphan_Type_References : declare
1663 pragma Warnings (Off, L);
1664 pragma Warnings (Off, R);
1666 procedure New_Entry (E : Entity_Id);
1667 -- Make an additional entry into the Xref table for a type entity
1668 -- that is related to the current entity (parent, type ancestor,
1669 -- progenitor, etc.).
1675 procedure New_Entry (E : Entity_Id) is
1677 pragma Assert (Present (E));
1679 if not Has_Xref_Entry (Implementation_Base_Type (E))
1680 and then Sloc (E) > No_Location
1685 Typ => Character'First,
1686 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
1689 Ent_Scope => Empty),
1690 Ent_Scope_File => No_Unit);
1694 -- Start of processing for Handle_Orphan_Type_References
1697 -- Note that this is not a for loop for a very good reason. The
1698 -- processing of items in the table can add new items to the table,
1699 -- and they must be processed as well.
1702 while J <= Xrefs.Last loop
1703 Ent := Xrefs.Table (J).Key.Ent;
1705 -- Do not generate reference information for an ignored Ghost
1706 -- entity because neither the entity nor its references will
1707 -- appear in the final tree.
1709 if Is_Ignored_Ghost_Entity (Ent) then
1710 goto Orphan_Continue;
1713 Get_Type_Reference (Ent, Tref, L, R);
1716 and then not Has_Xref_Entry (Tref)
1717 and then Sloc (Tref) > No_Location
1721 if Is_Record_Type (Ent)
1722 and then Present (Interfaces (Ent))
1724 -- Add an entry for each one of the given interfaces
1725 -- implemented by type Ent.
1728 Elmt : Elmt_Id := First_Elmt (Interfaces (Ent));
1730 while Present (Elmt) loop
1731 New_Entry (Node (Elmt));
1738 -- Collect inherited primitive operations that may be declared in
1739 -- another unit and have no visible reference in the current one.
1742 and then Is_Tagged_Type (Ent)
1743 and then Is_Derived_Type (Ent)
1744 and then Is_Base_Type (Ent)
1745 and then In_Extended_Main_Source_Unit (Ent)
1748 Op_List : constant Elist_Id := Primitive_Operations (Ent);
1752 function Parent_Op (E : Entity_Id) return Entity_Id;
1753 -- Find original operation, which may be inherited through
1754 -- several derivations.
1756 function Parent_Op (E : Entity_Id) return Entity_Id is
1757 Orig_Op : constant Entity_Id := Alias (E);
1760 if No (Orig_Op) then
1763 elsif not Comes_From_Source (E)
1764 and then not Has_Xref_Entry (Orig_Op)
1765 and then Comes_From_Source (Orig_Op)
1769 return Parent_Op (Orig_Op);
1774 Op := First_Elmt (Op_List);
1775 while Present (Op) loop
1776 Prim := Parent_Op (Node (Op));
1778 if Present (Prim) then
1782 Typ => Character'First,
1783 Eun => Get_Source_Unit (Sloc (Prim)),
1786 Ent_Scope => Empty),
1787 Ent_Scope_File => No_Unit);
1798 end Handle_Orphan_Type_References;
1800 -- Now we have all the references, including those for any embedded type
1801 -- references, so we can sort them, and output them.
1803 Output_Refs : declare
1804 Nrefs : constant Nat := Xrefs.Last;
1805 -- Number of references in table
1807 Rnums : array (0 .. Nrefs) of Nat;
1808 -- This array contains numbers of references in the Xrefs table.
1809 -- This list is sorted in output order. The extra 0'th entry is
1810 -- convenient for the call to sort. When we sort the table, we
1811 -- move the entries in Rnums around, but we do not move the
1812 -- original table entries.
1814 Curxu : Unit_Number_Type;
1815 -- Current xref unit
1817 Curru : Unit_Number_Type;
1818 -- Current reference unit for one entity
1823 Curnam : String (1 .. Name_Buffer'Length);
1825 -- Simple name and length of current entity
1827 Curdef : Source_Ptr;
1828 -- Original source location for current entity
1831 -- Current reference location
1834 -- Entity type character
1837 -- reference kind of previous reference
1843 -- Renaming reference
1845 Trunit : Unit_Number_Type;
1846 -- Unit number for type reference
1848 function Lt (Op1, Op2 : Natural) return Boolean;
1849 -- Comparison function for Sort call
1851 function Name_Change (X : Entity_Id) return Boolean;
1852 -- Determines if entity X has a different simple name from Curent
1854 procedure Move (From : Natural; To : Natural);
1855 -- Move procedure for Sort call
1857 package Sorting is new GNAT.Heap_Sort_G (Move, Lt);
1863 function Lt (Op1, Op2 : Natural) return Boolean is
1864 T1 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op1)));
1865 T2 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op2)));
1875 procedure Move (From : Natural; To : Natural) is
1877 Rnums (Nat (To)) := Rnums (Nat (From));
1884 -- Why a string comparison here??? Why not compare Name_Id values???
1886 function Name_Change (X : Entity_Id) return Boolean is
1888 Get_Unqualified_Name_String (Chars (X));
1890 if Name_Len /= Curlen then
1893 return Name_Buffer (1 .. Curlen) /= Curnam (1 .. Curlen);
1897 -- Start of processing for Output_Refs
1900 -- Capture the definition Sloc values. We delay doing this till now,
1901 -- since at the time the reference or definition is made, private
1902 -- types may be swapped, and the Sloc value may be incorrect. We
1903 -- also set up the pointer vector for the sort.
1905 -- For user-defined operators we need to skip the initial quote and
1906 -- point to the first character of the name, for navigation purposes.
1908 for J in 1 .. Nrefs loop
1910 E : constant Entity_Id := Xrefs.Table (J).Key.Ent;
1911 Loc : constant Source_Ptr := Original_Location (Sloc (E));
1916 if Nkind (E) = N_Defining_Operator_Symbol then
1917 Xrefs.Table (J).Def := Loc + 1;
1919 Xrefs.Table (J).Def := Loc;
1924 -- Sort the references
1926 Sorting.Sort (Integer (Nrefs));
1928 -- Initialize loop through references
1932 Curdef := No_Location;
1934 Crloc := No_Location;
1937 -- Loop to output references
1939 for Refno in 1 .. Nrefs loop
1940 Output_One_Ref : declare
1943 XE : Xref_Entry renames Xrefs.Table (Rnums (Refno));
1944 -- The current entry to be accessed
1948 -- Used for {} or <> or () for type reference
1950 procedure Check_Type_Reference
1952 List_Interface : Boolean;
1953 Is_Component : Boolean := False);
1954 -- Find whether there is a meaningful type reference for
1955 -- Ent, and display it accordingly. If List_Interface is
1956 -- true, then Ent is a progenitor interface of the current
1957 -- type entity being listed. In that case list it as is,
1958 -- without looking for a type reference for it. Flag is also
1959 -- used for index types of an array type, where the caller
1960 -- supplies the intended type reference. Is_Component serves
1961 -- the same purpose, to display the component type of a
1962 -- derived array type, for which only the parent type has
1963 -- ben displayed so far.
1965 procedure Output_Instantiation_Refs (Loc : Source_Ptr);
1966 -- Recursive procedure to output instantiation references for
1967 -- the given source ptr in [file|line[...]] form. No output
1968 -- if the given location is not a generic template reference.
1970 procedure Output_Overridden_Op (Old_E : Entity_Id);
1971 -- For a subprogram that is overriding, display information
1972 -- about the inherited operation that it overrides.
1974 --------------------------
1975 -- Check_Type_Reference --
1976 --------------------------
1978 procedure Check_Type_Reference
1980 List_Interface : Boolean;
1981 Is_Component : Boolean := False)
1984 if List_Interface then
1986 -- This is a progenitor interface of the type for which
1987 -- xref information is being generated.
1993 -- The following is not documented in lib-xref.ads ???
1995 elsif Is_Component then
2001 Get_Type_Reference (Ent, Tref, Left, Right);
2004 if Present (Tref) then
2006 -- Case of standard entity, output name
2008 if Sloc (Tref) = Standard_Location then
2009 Write_Info_Char (Left);
2010 Write_Info_Name (Chars (Tref));
2011 Write_Info_Char (Right);
2013 -- Case of source entity, output location
2016 Write_Info_Char (Left);
2017 Trunit := Get_Source_Unit (Sloc (Tref));
2019 if Trunit /= Curxu then
2020 Write_Info_Nat (Dependency_Num (Trunit));
2021 Write_Info_Char ('|');
2025 (Int (Get_Logical_Line_Number (Sloc (Tref))));
2033 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2036 and then Present (Full_View (Ent))
2038 Ent := Underlying_Type (Ent);
2040 if Present (Ent) then
2041 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2045 Write_Info_Char (Ctyp);
2049 (Int (Get_Column_Number (Sloc (Tref))));
2051 -- If the type comes from an instantiation, add the
2052 -- corresponding info.
2054 Output_Instantiation_Refs (Sloc (Tref));
2055 Write_Info_Char (Right);
2058 end Check_Type_Reference;
2060 -------------------------------
2061 -- Output_Instantiation_Refs --
2062 -------------------------------
2064 procedure Output_Instantiation_Refs (Loc : Source_Ptr) is
2065 Iloc : constant Source_Ptr := Instantiation_Location (Loc);
2066 Lun : Unit_Number_Type;
2067 Cu : constant Unit_Number_Type := Curru;
2070 -- Nothing to do if this is not an instantiation
2072 if Iloc = No_Location then
2076 -- Output instantiation reference
2078 Write_Info_Char ('[');
2079 Lun := Get_Source_Unit (Iloc);
2081 if Lun /= Curru then
2083 Write_Info_Nat (Dependency_Num (Curru));
2084 Write_Info_Char ('|');
2087 Write_Info_Nat (Int (Get_Logical_Line_Number (Iloc)));
2089 -- Recursive call to get nested instantiations
2091 Output_Instantiation_Refs (Iloc);
2093 -- Output final ] after call to get proper nesting
2095 Write_Info_Char (']');
2098 end Output_Instantiation_Refs;
2100 --------------------------
2101 -- Output_Overridden_Op --
2102 --------------------------
2104 procedure Output_Overridden_Op (Old_E : Entity_Id) is
2108 -- The overridden operation has an implicit declaration
2109 -- at the point of derivation. What we want to display
2110 -- is the original operation, which has the actual body
2111 -- (or abstract declaration) that is being overridden.
2112 -- The overridden operation is not always set, e.g. when
2113 -- it is a predefined operator.
2118 -- Follow alias chain if one is present
2120 elsif Present (Alias (Old_E)) then
2122 -- The subprogram may have been implicitly inherited
2123 -- through several levels of derivation, so find the
2124 -- ultimate (source) ancestor.
2126 Op := Ultimate_Alias (Old_E);
2128 -- Normal case of no alias present. We omit generated
2129 -- primitives like tagged equality, that have no source
2137 and then Sloc (Op) /= Standard_Location
2138 and then Comes_From_Source (Op)
2141 Loc : constant Source_Ptr := Sloc (Op);
2142 Par_Unit : constant Unit_Number_Type :=
2143 Get_Source_Unit (Loc);
2146 Write_Info_Char ('<');
2148 if Par_Unit /= Curxu then
2149 Write_Info_Nat (Dependency_Num (Par_Unit));
2150 Write_Info_Char ('|');
2153 Write_Info_Nat (Int (Get_Logical_Line_Number (Loc)));
2154 Write_Info_Char ('p');
2155 Write_Info_Nat (Int (Get_Column_Number (Loc)));
2156 Write_Info_Char ('>');
2159 end Output_Overridden_Op;
2161 -- Start of processing for Output_One_Ref
2166 -- Do not generate reference information for an ignored Ghost
2167 -- entity because neither the entity nor its references will
2168 -- appear in the final tree.
2170 if Is_Ignored_Ghost_Entity (Ent) then
2174 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2176 -- Skip reference if it is the only reference to an entity,
2177 -- and it is an END line reference, and the entity is not in
2178 -- the current extended source. This prevents junk entries
2179 -- consisting only of packages with END lines, where no
2180 -- entity from the package is actually referenced.
2183 and then Ent /= Curent
2184 and then (Refno = Nrefs
2186 Ent /= Xrefs.Table (Rnums (Refno + 1)).Key.Ent)
2187 and then not In_Extended_Main_Source_Unit (Ent)
2192 -- For private type, get full view type
2195 and then Present (Full_View (XE.Key.Ent))
2197 Ent := Underlying_Type (Ent);
2199 if Present (Ent) then
2200 Ctyp := Xref_Entity_Letters (Ekind (Ent));
2204 -- Special exception for Boolean
2206 if Ctyp = 'E' and then Is_Boolean_Type (Ent) then
2210 -- For variable reference, get corresponding type
2213 Ent := Etype (XE.Key.Ent);
2214 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2216 -- If variable is private type, get full view type
2219 and then Present (Full_View (Etype (XE.Key.Ent)))
2221 Ent := Underlying_Type (Etype (XE.Key.Ent));
2223 if Present (Ent) then
2224 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
2227 elsif Is_Generic_Type (Ent) then
2229 -- If the type of the entity is a generic private type,
2230 -- there is no usable full view, so retain the indication
2231 -- that this is an object.
2236 -- Special handling for access parameters and objects and
2237 -- components of an anonymous access type.
2239 if Ekind_In (Etype (XE.Key.Ent),
2240 E_Anonymous_Access_Type,
2241 E_Anonymous_Access_Subprogram_Type,
2242 E_Anonymous_Access_Protected_Subprogram_Type)
2244 if Is_Formal (XE.Key.Ent)
2247 (XE.Key.Ent, E_Variable, E_Constant, E_Component)
2252 -- Special handling for Boolean
2254 elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
2259 -- Special handling for abstract types and operations
2261 if Is_Overloadable (XE.Key.Ent)
2262 and then Is_Abstract_Subprogram (XE.Key.Ent)
2265 Ctyp := 'x'; -- Abstract procedure
2267 elsif Ctyp = 'V' then
2268 Ctyp := 'y'; -- Abstract function
2271 elsif Is_Type (XE.Key.Ent)
2272 and then Is_Abstract_Type (XE.Key.Ent)
2274 if Is_Interface (XE.Key.Ent) then
2277 elsif Ctyp = 'R' then
2278 Ctyp := 'H'; -- Abstract type
2282 -- Only output reference if interesting type of entity
2286 -- Suppress references to object definitions, used for local
2289 or else XE.Key.Typ = 'D'
2290 or else XE.Key.Typ = 'I'
2292 -- Suppress self references, except for bodies that act as
2295 or else (XE.Key.Loc = XE.Def
2298 or else not Is_Subprogram (XE.Key.Ent)))
2300 -- Also suppress definitions of body formals (we only
2301 -- treat these as references, and the references were
2302 -- separately recorded).
2304 or else (Is_Formal (XE.Key.Ent)
2305 and then Present (Spec_Entity (XE.Key.Ent)))
2310 -- Start new Xref section if new xref unit
2312 if XE.Key.Eun /= Curxu then
2313 if Write_Info_Col > 1 then
2317 Curxu := XE.Key.Eun;
2319 Write_Info_Initiate ('X');
2320 Write_Info_Char (' ');
2321 Write_Info_Nat (Dependency_Num (XE.Key.Eun));
2322 Write_Info_Char (' ');
2324 (Reference_Name (Source_Index (XE.Key.Eun)));
2327 -- Start new Entity line if new entity. Note that we
2328 -- consider two entities the same if they have the same
2329 -- name and source location. This causes entities in
2330 -- instantiations to be treated as though they referred
2335 (XE.Key.Ent /= Curent
2337 (Name_Change (XE.Key.Ent) or else XE.Def /= Curdef))
2339 Curent := XE.Key.Ent;
2342 Get_Unqualified_Name_String (Chars (XE.Key.Ent));
2344 Curnam (1 .. Curlen) := Name_Buffer (1 .. Curlen);
2346 if Write_Info_Col > 1 then
2350 -- Write column number information
2352 Write_Info_Nat (Int (Get_Logical_Line_Number (XE.Def)));
2353 Write_Info_Char (Ctyp);
2354 Write_Info_Nat (Int (Get_Column_Number (XE.Def)));
2356 -- Write level information
2358 Write_Level_Info : declare
2359 function Is_Visible_Generic_Entity
2360 (E : Entity_Id) return Boolean;
2361 -- Check whether E is declared in the visible part
2362 -- of a generic package. For source navigation
2363 -- purposes, treat this as a visible entity.
2365 function Is_Private_Record_Component
2366 (E : Entity_Id) return Boolean;
2367 -- Check whether E is a non-inherited component of a
2368 -- private extension. Even if the enclosing record is
2369 -- public, we want to treat the component as private
2370 -- for navigation purposes.
2372 ---------------------------------
2373 -- Is_Private_Record_Component --
2374 ---------------------------------
2376 function Is_Private_Record_Component
2377 (E : Entity_Id) return Boolean
2379 S : constant Entity_Id := Scope (E);
2382 Ekind (E) = E_Component
2383 and then Nkind (Declaration_Node (S)) =
2384 N_Private_Extension_Declaration
2385 and then Original_Record_Component (E) = E;
2386 end Is_Private_Record_Component;
2388 -------------------------------
2389 -- Is_Visible_Generic_Entity --
2390 -------------------------------
2392 function Is_Visible_Generic_Entity
2393 (E : Entity_Id) return Boolean
2398 -- The Present check here is an error defense
2400 if Present (Scope (E))
2401 and then Ekind (Scope (E)) /= E_Generic_Package
2407 while Present (Par) loop
2409 Nkind (Par) = N_Generic_Package_Declaration
2411 -- Entity is a generic formal
2416 Nkind (Parent (Par)) = N_Package_Specification
2419 Is_List_Member (Par)
2420 and then List_Containing (Par) =
2421 Visible_Declarations (Parent (Par));
2423 Par := Parent (Par);
2428 end Is_Visible_Generic_Entity;
2430 -- Start of processing for Write_Level_Info
2433 if Is_Hidden (Curent)
2434 or else Is_Private_Record_Component (Curent)
2436 Write_Info_Char (' ');
2440 or else Is_Visible_Generic_Entity (Curent)
2442 Write_Info_Char ('*');
2445 Write_Info_Char (' ');
2447 end Write_Level_Info;
2449 -- Output entity name. We use the occurrence from the
2450 -- actual source program at the definition point.
2453 Ent_Name : constant String :=
2454 Exact_Source_Name (Sloc (XE.Key.Ent));
2456 for C in Ent_Name'Range loop
2457 Write_Info_Char (Ent_Name (C));
2461 -- See if we have a renaming reference
2463 if Is_Object (XE.Key.Ent)
2464 and then Present (Renamed_Object (XE.Key.Ent))
2466 Rref := Renamed_Object (XE.Key.Ent);
2468 elsif Is_Overloadable (XE.Key.Ent)
2469 and then Nkind (Parent (Declaration_Node (XE.Key.Ent)))
2470 = N_Subprogram_Renaming_Declaration
2472 Rref := Name (Parent (Declaration_Node (XE.Key.Ent)));
2474 elsif Ekind (XE.Key.Ent) = E_Package
2475 and then Nkind (Declaration_Node (XE.Key.Ent)) =
2476 N_Package_Renaming_Declaration
2478 Rref := Name (Declaration_Node (XE.Key.Ent));
2484 if Present (Rref) then
2485 if Nkind (Rref) = N_Expanded_Name then
2486 Rref := Selector_Name (Rref);
2489 if Nkind (Rref) = N_Identifier
2490 or else Nkind (Rref) = N_Operator_Symbol
2494 -- For renamed array components, use the array name
2495 -- for the renamed entity, which reflect the fact that
2496 -- in general the whole array is aliased.
2498 elsif Nkind (Rref) = N_Indexed_Component then
2499 if Nkind (Prefix (Rref)) = N_Identifier then
2500 Rref := Prefix (Rref);
2501 elsif Nkind (Prefix (Rref)) = N_Expanded_Name then
2502 Rref := Selector_Name (Prefix (Rref));
2512 -- Write out renaming reference if we have one
2514 if Present (Rref) then
2515 Write_Info_Char ('=');
2517 (Int (Get_Logical_Line_Number (Sloc (Rref))));
2518 Write_Info_Char (':');
2520 (Int (Get_Column_Number (Sloc (Rref))));
2523 -- Indicate that the entity is in the unit of the current
2528 -- Write out information about generic parent, if entity
2531 if Is_Generic_Instance (XE.Key.Ent) then
2533 Gen_Par : constant Entity_Id :=
2536 (Unit_Declaration_Node
2538 Loc : constant Source_Ptr := Sloc (Gen_Par);
2539 Gen_U : constant Unit_Number_Type :=
2540 Get_Source_Unit (Loc);
2543 Write_Info_Char ('[');
2545 if Curru /= Gen_U then
2546 Write_Info_Nat (Dependency_Num (Gen_U));
2547 Write_Info_Char ('|');
2551 (Int (Get_Logical_Line_Number (Loc)));
2552 Write_Info_Char (']');
2556 -- See if we have a type reference and if so output
2558 Check_Type_Reference (XE.Key.Ent, False);
2560 -- Additional information for types with progenitors,
2561 -- including synchronized tagged types.
2564 Typ : constant Entity_Id := XE.Key.Ent;
2568 if Is_Record_Type (Typ)
2569 and then Present (Interfaces (Typ))
2571 Elmt := First_Elmt (Interfaces (Typ));
2573 elsif Is_Concurrent_Type (Typ)
2574 and then Present (Corresponding_Record_Type (Typ))
2576 Interfaces (Corresponding_Record_Type (Typ)))
2580 Interfaces (Corresponding_Record_Type (Typ)));
2586 while Present (Elmt) loop
2587 Check_Type_Reference (Node (Elmt), True);
2592 -- For array types, list index types as well. (This is
2593 -- not C, indexes have distinct types).
2595 if Is_Array_Type (XE.Key.Ent) then
2597 A_Typ : constant Entity_Id := XE.Key.Ent;
2601 -- If this is a derived array type, we have
2602 -- output the parent type, so add the component
2605 if Is_Derived_Type (A_Typ) then
2606 Check_Type_Reference
2607 (Component_Type (A_Typ), False, True);
2610 -- Add references to index types.
2612 Indx := First_Index (XE.Key.Ent);
2613 while Present (Indx) loop
2614 Check_Type_Reference
2615 (First_Subtype (Etype (Indx)), True);
2621 -- If the entity is an overriding operation, write info
2622 -- on operation that was overridden.
2624 if Is_Subprogram (XE.Key.Ent)
2625 and then Present (Overridden_Operation (XE.Key.Ent))
2627 Output_Overridden_Op
2628 (Overridden_Operation (XE.Key.Ent));
2631 -- End of processing for entity output
2633 Crloc := No_Location;
2636 -- Output the reference if it is not as the same location
2637 -- as the previous one, or it is a read-reference that
2638 -- indicates that the entity is an in-out actual in a call.
2640 if XE.Key.Loc /= No_Location
2642 (XE.Key.Loc /= Crloc
2643 or else (Prevt = 'm' and then XE.Key.Typ = 'r'))
2645 Crloc := XE.Key.Loc;
2646 Prevt := XE.Key.Typ;
2648 -- Start continuation if line full, else blank
2650 if Write_Info_Col > 72 then
2652 Write_Info_Initiate ('.');
2655 Write_Info_Char (' ');
2657 -- Output file number if changed
2659 if XE.Key.Lun /= Curru then
2660 Curru := XE.Key.Lun;
2661 Write_Info_Nat (Dependency_Num (Curru));
2662 Write_Info_Char ('|');
2666 (Int (Get_Logical_Line_Number (XE.Key.Loc)));
2667 Write_Info_Char (XE.Key.Typ);
2669 if Is_Overloadable (XE.Key.Ent) then
2670 if (Is_Imported (XE.Key.Ent) and then XE.Key.Typ = 'b')
2672 (Is_Exported (XE.Key.Ent) and then XE.Key.Typ = 'i')
2674 Output_Import_Export_Info (XE.Key.Ent);
2678 Write_Info_Nat (Int (Get_Column_Number (XE.Key.Loc)));
2680 Output_Instantiation_Refs (Sloc (XE.Key.Ent));
2691 end Output_References;
2693 ---------------------------------
2694 -- Process_Deferred_References --
2695 ---------------------------------
2697 procedure Process_Deferred_References is
2699 for J in Deferred_References.First .. Deferred_References.Last loop
2701 D : Deferred_Reference_Entry renames Deferred_References.Table (J);
2704 case Is_LHS (D.N) is
2706 Generate_Reference (D.E, D.N, 'm');
2709 Generate_Reference (D.E, D.N, 'r');
2711 -- Not clear if Unknown can occur at this stage, but if it
2712 -- does we will treat it as a normal reference.
2715 Generate_Reference (D.E, D.N, 'r');
2720 -- Clear processed entries from table
2722 Deferred_References.Init;
2723 end Process_Deferred_References;
2725 -- Start of elaboration for Lib.Xref
2728 -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
2729 -- because it's not an access type.