1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 1998-2011, 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 Alfa 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 -- Alfa Information --
156 ----------------------
158 package body Alfa is separate;
160 ------------------------
161 -- Local Subprograms --
162 ------------------------
164 procedure Generate_Prim_Op_References (Typ : Entity_Id);
165 -- For a tagged type, generate implicit references to its primitive
166 -- operations, for source navigation. This is done right before emitting
167 -- cross-reference information rather than at the freeze point of the type
168 -- in order to handle late bodies that are primitive operations.
170 function Lt (T1, T2 : Xref_Entry) return Boolean;
171 -- Order cross-references
173 procedure Add_Entry (Key : Xref_Key; Ent_Scope_File : Unit_Number_Type);
174 -- Add an entry to the tables of Xref_Entries, avoiding duplicates
180 procedure Add_Entry (Key : Xref_Key; Ent_Scope_File : Unit_Number_Type) is
182 Xrefs.Increment_Last; -- tentative
183 Xrefs.Table (Xrefs.Last).Key := Key;
185 -- Set the entry in Xref_Set, and if newly set, keep the above
186 -- tentative increment.
188 if Xref_Set.Set_If_Not_Present (Xrefs.Last) then
189 Xrefs.Table (Xrefs.Last).Ent_Scope_File := Ent_Scope_File;
190 -- Leave Def and HTable_Next uninitialized
192 Set_Has_Xref_Entry (Key.Ent);
194 -- It was already in Xref_Set, so throw away the tentatively-added
198 Xrefs.Decrement_Last;
206 function Equal (F1, F2 : Xref_Entry_Number) return Boolean is
207 Result : constant Boolean :=
208 Xrefs.Table (F1).Key = Xrefs.Table (F2).Key;
213 -------------------------
214 -- Generate_Definition --
215 -------------------------
217 procedure Generate_Definition (E : Entity_Id) is
219 pragma Assert (Nkind (E) in N_Entity);
221 -- Note that we do not test Xref_Entity_Letters here. It is too early
222 -- to do so, since we are often called before the entity is fully
223 -- constructed, so that the Ekind is still E_Void.
227 -- Definition must come from source
229 -- We make an exception for subprogram child units that have no spec.
230 -- For these we generate a subprogram declaration for library use,
231 -- and the corresponding entity does not come from source.
232 -- Nevertheless, all references will be attached to it and we have
233 -- to treat is as coming from user code.
235 and then (Comes_From_Source (E) or else Is_Child_Unit (E))
237 -- And must have a reasonable source location that is not
238 -- within an instance (all entities in instances are ignored)
240 and then Sloc (E) > No_Location
241 and then Instantiation_Location (Sloc (E)) = No_Location
243 -- And must be a non-internal name from the main source unit
245 and then In_Extended_Main_Source_Unit (E)
246 and then not Is_Internal_Name (Chars (E))
252 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
256 Ent_Scope_File => No_Unit);
258 if In_Inlined_Body then
262 end Generate_Definition;
264 ---------------------------------
265 -- Generate_Operator_Reference --
266 ---------------------------------
268 procedure Generate_Operator_Reference
273 if not In_Extended_Main_Source_Unit (N) then
277 -- If the operator is not a Standard operator, then we generate a real
278 -- reference to the user defined operator.
280 if Sloc (Entity (N)) /= Standard_Location then
281 Generate_Reference (Entity (N), N);
283 -- A reference to an implicit inequality operator is also a reference
284 -- to the user-defined equality.
286 if Nkind (N) = N_Op_Ne
287 and then not Comes_From_Source (Entity (N))
288 and then Present (Corresponding_Equality (Entity (N)))
290 Generate_Reference (Corresponding_Equality (Entity (N)), N);
293 -- For the case of Standard operators, we mark the result type as
294 -- referenced. This ensures that in the case where we are using a
295 -- derived operator, we mark an entity of the unit that implicitly
296 -- defines this operator as used. Otherwise we may think that no entity
297 -- of the unit is used. The actual entity marked as referenced is the
298 -- first subtype, which is the relevant user defined entity.
300 -- Note: we only do this for operators that come from source. The
301 -- generated code sometimes reaches for entities that do not need to be
302 -- explicitly visible (for example, when we expand the code for
303 -- comparing two record objects, the fields of the record may not be
306 elsif Comes_From_Source (N) then
307 Set_Referenced (First_Subtype (T));
309 end Generate_Operator_Reference;
311 ---------------------------------
312 -- Generate_Prim_Op_References --
313 ---------------------------------
315 procedure Generate_Prim_Op_References (Typ : Entity_Id) is
318 Prim_List : Elist_Id;
321 -- Handle subtypes of synchronized types
323 if Ekind (Typ) = E_Protected_Subtype
324 or else Ekind (Typ) = E_Task_Subtype
326 Base_T := Etype (Typ);
331 -- References to primitive operations are only relevant for tagged types
333 if not Is_Tagged_Type (Base_T)
334 or else Is_Class_Wide_Type (Base_T)
339 -- Ada 2005 (AI-345): For synchronized types generate reference to the
340 -- wrapper that allow us to dispatch calls through their implemented
341 -- abstract interface types.
343 -- The check for Present here is to protect against previously reported
346 Prim_List := Primitive_Operations (Base_T);
348 if No (Prim_List) then
352 Prim := First_Elmt (Prim_List);
353 while Present (Prim) loop
355 -- If the operation is derived, get the original for cross-reference
356 -- reference purposes (it is the original for which we want the xref
357 -- and for which the comes_from_source test must be performed).
360 (Typ, Ultimate_Alias (Node (Prim)), 'p', Set_Ref => False);
363 end Generate_Prim_Op_References;
365 ------------------------
366 -- Generate_Reference --
367 ------------------------
369 procedure Generate_Reference
372 Typ : Character := 'r';
373 Set_Ref : Boolean := True;
374 Force : Boolean := False)
381 Actual_Typ : Character := Typ;
383 Ref_Scope : Entity_Id;
384 Ent_Scope : Entity_Id;
385 Ent_Scope_File : Unit_Number_Type;
389 -- Used for call to Find_Actual
392 -- If Formal is non-Empty, then its Ekind, otherwise E_Void
394 function Is_On_LHS (Node : Node_Id) return Boolean;
395 -- Used to check if a node is on the left hand side of an assignment.
396 -- The following cases are handled:
398 -- Variable Node is a direct descendant of left hand side of an
399 -- assignment statement.
401 -- Prefix Of an indexed or selected component that is present in
402 -- a subtree rooted by an assignment statement. There is
403 -- no restriction of nesting of components, thus cases
404 -- such as A.B (C).D are handled properly. However a prefix
405 -- of a dereference (either implicit or explicit) is never
406 -- considered as on a LHS.
408 -- Out param Same as above cases, but OUT parameter
410 function OK_To_Set_Referenced return Boolean;
411 -- Returns True if the Referenced flag can be set. There are a few
412 -- exceptions where we do not want to set this flag, see body for
413 -- details of these exceptional cases.
419 -- ??? There are several routines here and there that perform a similar
420 -- (but subtly different) computation, which should be factored:
422 -- Sem_Util.May_Be_Lvalue
423 -- Sem_Util.Known_To_Be_Assigned
424 -- Exp_Ch2.Expand_Entry_Parameter.In_Assignment_Context
425 -- Exp_Smem.Is_Out_Actual
427 function Is_On_LHS (Node : Node_Id) return Boolean is
433 -- Only identifiers are considered, is this necessary???
435 if Nkind (Node) /= N_Identifier then
439 -- Immediate return if appeared as OUT parameter
441 if Kind = E_Out_Parameter then
445 -- Search for assignment statement subtree root
452 if K = N_Assignment_Statement then
455 -- Check whether the parent is a component and the current node is
456 -- its prefix, but return False if the current node has an access
457 -- type, as in that case the selected or indexed component is an
458 -- implicit dereference, and the LHS is the designated object, not
459 -- the access object.
461 -- ??? case of a slice assignment?
463 -- ??? Note that in some cases this is called too early
464 -- (see comments in Sem_Ch8.Find_Direct_Name), at a point where
465 -- the tree is not fully typed yet. In that case we may lack
466 -- an Etype for N, and we must disable the check for an implicit
467 -- dereference. If the dereference is on an LHS, this causes a
470 elsif (K = N_Selected_Component or else K = N_Indexed_Component)
471 and then Prefix (P) = N
472 and then not (Present (Etype (N))
474 Is_Access_Type (Etype (N)))
478 -- All other cases, definitely not on left side
486 ---------------------------
487 -- OK_To_Set_Referenced --
488 ---------------------------
490 function OK_To_Set_Referenced return Boolean is
494 -- A reference from a pragma Unreferenced or pragma Unmodified or
495 -- pragma Warnings does not cause the Referenced flag to be set.
496 -- This avoids silly warnings about things being referenced and
497 -- not assigned when the only reference is from the pragma.
499 if Nkind (N) = N_Identifier then
502 if Nkind (P) = N_Pragma_Argument_Association then
505 if Nkind (P) = N_Pragma then
506 if Pragma_Name (P) = Name_Warnings
508 Pragma_Name (P) = Name_Unmodified
510 Pragma_Name (P) = Name_Unreferenced
519 end OK_To_Set_Referenced;
521 -- Start of processing for Generate_Reference
524 pragma Assert (Nkind (E) in N_Entity);
525 Find_Actual (N, Formal, Call);
527 if Present (Formal) then
528 Kind := Ekind (Formal);
533 -- Check for obsolescent reference to package ASCII. GNAT treats this
534 -- element of annex J specially since in practice, programs make a lot
535 -- of use of this feature, so we don't include it in the set of features
536 -- diagnosed when Warn_On_Obsolescent_Features mode is set. However we
537 -- are required to note it as a violation of the RM defined restriction.
539 if E = Standard_ASCII then
540 Check_Restriction (No_Obsolescent_Features, N);
543 -- Check for reference to entity marked with Is_Obsolescent
545 -- Note that we always allow obsolescent references in the compiler
546 -- itself and the run time, since we assume that we know what we are
547 -- doing in such cases. For example the calls in Ada.Characters.Handling
548 -- to its own obsolescent subprograms are just fine.
550 -- In any case we do not generate warnings within the extended source
551 -- unit of the entity in question, since we assume the source unit
552 -- itself knows what is going on (and for sure we do not want silly
553 -- warnings, e.g. on the end line of an obsolescent procedure body).
555 if Is_Obsolescent (E)
556 and then not GNAT_Mode
557 and then not In_Extended_Main_Source_Unit (E)
559 Check_Restriction (No_Obsolescent_Features, N);
561 if Warn_On_Obsolescent_Feature then
562 Output_Obsolescent_Entity_Warnings (N, E);
566 -- Warn if reference to Ada 2005 entity not in Ada 2005 mode. We only
567 -- detect real explicit references (modifications and references).
569 if Comes_From_Source (N)
570 and then Is_Ada_2005_Only (E)
571 and then Ada_Version < Ada_2005
572 and then Warn_On_Ada_2005_Compatibility
573 and then (Typ = 'm' or else Typ = 'r' or else Typ = 's')
575 Error_Msg_NE ("& is only defined in Ada 2005?", N, E);
578 -- Warn if reference to Ada 2012 entity not in Ada 2012 mode. We only
579 -- detect real explicit references (modifications and references).
581 if Comes_From_Source (N)
582 and then Is_Ada_2012_Only (E)
583 and then Ada_Version < Ada_2012
584 and then Warn_On_Ada_2012_Compatibility
585 and then (Typ = 'm' or else Typ = 'r')
587 Error_Msg_NE ("& is only defined in Ada 2012?", N, E);
590 -- Never collect references if not in main source unit. However, we omit
591 -- this test if Typ is 'e' or 'k', since these entries are structural,
592 -- and it is useful to have them in units that reference packages as
593 -- well as units that define packages. We also omit the test for the
594 -- case of 'p' since we want to include inherited primitive operations
595 -- from other packages.
597 -- We also omit this test is this is a body reference for a subprogram
598 -- instantiation. In this case the reference is to the generic body,
599 -- which clearly need not be in the main unit containing the instance.
600 -- For the same reason we accept an implicit reference generated for
601 -- a default in an instance.
603 if not In_Extended_Main_Source_Unit (N) then
609 or else (Typ = 'b' and then Is_Generic_Instance (E))
617 -- For reference type p, the entity must be in main source unit
619 if Typ = 'p' and then not In_Extended_Main_Source_Unit (E) then
623 -- Unless the reference is forced, we ignore references where the
624 -- reference itself does not come from source.
626 if not Force and then not Comes_From_Source (N) then
630 -- Deal with setting entity as referenced, unless suppressed. Note that
631 -- we still do Set_Referenced on entities that do not come from source.
632 -- This situation arises when we have a source reference to a derived
633 -- operation, where the derived operation itself does not come from
634 -- source, but we still want to mark it as referenced, since we really
635 -- are referencing an entity in the corresponding package (this avoids
636 -- wrong complaints that the package contains no referenced entities).
640 -- Assignable object appearing on left side of assignment or as
644 and then Is_On_LHS (N)
645 and then Ekind (E) /= E_In_Out_Parameter
647 -- For objects that are renamings, just set as simply referenced
648 -- we do not try to do assignment type tracking in this case.
650 if Present (Renamed_Object (E)) then
653 -- Out parameter case
655 elsif Kind = E_Out_Parameter then
657 -- If warning mode for all out parameters is set, or this is
658 -- the only warning parameter, then we want to mark this for
659 -- later warning logic by setting Referenced_As_Out_Parameter
661 if Warn_On_Modified_As_Out_Parameter (Formal) then
662 Set_Referenced_As_Out_Parameter (E, True);
663 Set_Referenced_As_LHS (E, False);
665 -- For OUT parameter not covered by the above cases, we simply
666 -- regard it as a normal reference (in this case we do not
667 -- want any of the warning machinery for out parameters).
673 -- For the left hand of an assignment case, we do nothing here.
674 -- The processing for Analyze_Assignment_Statement will set the
675 -- Referenced_As_LHS flag.
681 -- Check for a reference in a pragma that should not count as a
682 -- making the variable referenced for warning purposes.
684 elsif Is_Non_Significant_Pragma_Reference (N) then
687 -- A reference in an attribute definition clause does not count as a
688 -- reference except for the case of Address. The reason that 'Address
689 -- is an exception is that it creates an alias through which the
690 -- variable may be referenced.
692 elsif Nkind (Parent (N)) = N_Attribute_Definition_Clause
693 and then Chars (Parent (N)) /= Name_Address
694 and then N = Name (Parent (N))
698 -- Constant completion does not count as a reference
701 and then Ekind (E) = E_Constant
705 -- Record representation clause does not count as a reference
707 elsif Nkind (N) = N_Identifier
708 and then Nkind (Parent (N)) = N_Record_Representation_Clause
712 -- Discriminants do not need to produce a reference to record type
715 and then Nkind (Parent (N)) = N_Discriminant_Specification
722 -- Special processing for IN OUT parameters, where we have an
723 -- implicit assignment to a simple variable.
725 if Kind = E_In_Out_Parameter
726 and then Is_Assignable (E)
728 -- For sure this counts as a normal read reference
731 Set_Last_Assignment (E, Empty);
733 -- We count it as being referenced as an out parameter if the
734 -- option is set to warn on all out parameters, except that we
735 -- have a special exclusion for an intrinsic subprogram, which
736 -- is most likely an instantiation of Unchecked_Deallocation
737 -- which we do not want to consider as an assignment since it
738 -- generates false positives. We also exclude the case of an
739 -- IN OUT parameter if the name of the procedure is Free,
740 -- since we suspect similar semantics.
742 if Warn_On_All_Unread_Out_Parameters
743 and then Is_Entity_Name (Name (Call))
744 and then not Is_Intrinsic_Subprogram (Entity (Name (Call)))
745 and then Chars (Name (Call)) /= Name_Free
747 Set_Referenced_As_Out_Parameter (E, True);
748 Set_Referenced_As_LHS (E, False);
751 -- Don't count a recursive reference within a subprogram as a
752 -- reference (that allows detection of a recursive subprogram
753 -- whose only references are recursive calls as unreferenced).
755 elsif Is_Subprogram (E)
756 and then E = Nearest_Dynamic_Scope (Current_Scope)
760 -- Any other occurrence counts as referencing the entity
762 elsif OK_To_Set_Referenced then
765 -- If variable, this is an OK reference after an assignment
766 -- so we can clear the Last_Assignment indication.
768 if Is_Assignable (E) then
769 Set_Last_Assignment (E, Empty);
774 -- Check for pragma Unreferenced given and reference is within
775 -- this source unit (occasion for possible warning to be issued).
777 if Has_Unreferenced (E)
778 and then In_Same_Extended_Unit (E, N)
780 -- A reference as a named parameter in a call does not count
781 -- as a violation of pragma Unreferenced for this purpose...
783 if Nkind (N) = N_Identifier
784 and then Nkind (Parent (N)) = N_Parameter_Association
785 and then Selector_Name (Parent (N)) = N
789 -- ... Neither does a reference to a variable on the left side
792 elsif Is_On_LHS (N) then
795 -- For entry formals, we want to place the warning message on the
796 -- corresponding entity in the accept statement. The current scope
797 -- is the body of the accept, so we find the formal whose name
798 -- matches that of the entry formal (there is no link between the
799 -- two entities, and the one in the accept statement is only used
800 -- for conformance checking).
802 elsif Ekind (Scope (E)) = E_Entry then
807 BE := First_Entity (Current_Scope);
808 while Present (BE) loop
809 if Chars (BE) = Chars (E) then
810 Error_Msg_NE -- CODEFIX
811 ("?pragma Unreferenced given for&!", N, BE);
819 -- Here we issue the warning, since this is a real reference
822 Error_Msg_NE -- CODEFIX
823 ("?pragma Unreferenced given for&!", N, E);
827 -- If this is a subprogram instance, mark as well the internal
828 -- subprogram in the wrapper package, which may be a visible
831 if Is_Overloadable (E)
832 and then Is_Generic_Instance (E)
833 and then Present (Alias (E))
835 Set_Referenced (Alias (E));
839 -- Generate reference if all conditions are met:
842 -- Cross referencing must be active
846 -- The entity must be one for which we collect references
848 and then Xref_Entity_Letters (Ekind (E)) /= ' '
850 -- Both Sloc values must be set to something sensible
852 and then Sloc (E) > No_Location
853 and then Sloc (N) > No_Location
855 -- We ignore references from within an instance, except for default
856 -- subprograms, for which we generate an implicit reference.
859 (Instantiation_Location (Sloc (N)) = No_Location or else Typ = 'i')
861 -- Ignore dummy references
865 if Nkind (N) = N_Identifier
867 Nkind (N) = N_Defining_Identifier
871 Nkind (N) = N_Defining_Operator_Symbol
873 Nkind (N) = N_Operator_Symbol
875 (Nkind (N) = N_Character_Literal
876 and then Sloc (Entity (N)) /= Standard_Location)
878 Nkind (N) = N_Defining_Character_Literal
882 elsif Nkind (N) = N_Expanded_Name
884 Nkind (N) = N_Selected_Component
886 Nod := Selector_Name (N);
892 -- Normal case of source entity comes from source
894 if Comes_From_Source (E) then
897 -- Entity does not come from source, but is a derived subprogram and
898 -- the derived subprogram comes from source (after one or more
899 -- derivations) in which case the reference is to parent subprogram.
901 elsif Is_Overloadable (E)
902 and then Present (Alias (E))
905 while not Comes_From_Source (Ent) loop
906 if No (Alias (Ent)) then
913 -- The internally created defining entity for a child subprogram
914 -- that has no previous spec has valid references.
916 elsif Is_Overloadable (E)
917 and then Is_Child_Unit (E)
921 -- Record components of discriminated subtypes or derived types must
922 -- be treated as references to the original component.
924 elsif Ekind (E) = E_Component
925 and then Comes_From_Source (Original_Record_Component (E))
927 Ent := Original_Record_Component (E);
929 -- If this is an expanded reference to a discriminant, recover the
930 -- original discriminant, which gets the reference.
932 elsif Ekind (E) = E_In_Parameter
933 and then Present (Discriminal_Link (E))
935 Ent := Discriminal_Link (E);
936 Set_Referenced (Ent);
938 -- Ignore reference to any other entity that is not from source
944 -- Record reference to entity
946 Ref := Original_Location (Sloc (Nod));
947 Def := Original_Location (Sloc (Ent));
950 and then Is_Subprogram (N)
951 and then Present (Overridden_Operation (N))
957 Ref_Scope := Alfa.Enclosing_Subprogram_Or_Package (N);
958 Ent_Scope := Alfa.Enclosing_Subprogram_Or_Package (Ent);
959 Ent_Scope_File := Get_Source_Unit (Ent_Scope);
964 Ent_Scope_File := No_Unit;
971 Eun => Get_Source_Unit (Def),
972 Lun => Get_Source_Unit (Ref),
973 Ref_Scope => Ref_Scope,
974 Ent_Scope => Ent_Scope),
975 Ent_Scope_File => Ent_Scope_File);
977 end Generate_Reference;
979 -----------------------------------
980 -- Generate_Reference_To_Formals --
981 -----------------------------------
983 procedure Generate_Reference_To_Formals (E : Entity_Id) is
987 if Is_Generic_Subprogram (E) then
988 Formal := First_Entity (E);
990 while Present (Formal)
991 and then not Is_Formal (Formal)
993 Next_Entity (Formal);
997 Formal := First_Formal (E);
1000 while Present (Formal) loop
1001 if Ekind (Formal) = E_In_Parameter then
1003 if Nkind (Parameter_Type (Parent (Formal)))
1004 = N_Access_Definition
1006 Generate_Reference (E, Formal, '^', False);
1008 Generate_Reference (E, Formal, '>', False);
1011 elsif Ekind (Formal) = E_In_Out_Parameter then
1012 Generate_Reference (E, Formal, '=', False);
1015 Generate_Reference (E, Formal, '<', False);
1018 Next_Formal (Formal);
1020 end Generate_Reference_To_Formals;
1022 -------------------------------------------
1023 -- Generate_Reference_To_Generic_Formals --
1024 -------------------------------------------
1026 procedure Generate_Reference_To_Generic_Formals (E : Entity_Id) is
1030 Formal := First_Entity (E);
1031 while Present (Formal) loop
1032 if Comes_From_Source (Formal) then
1033 Generate_Reference (E, Formal, 'z', False);
1036 Next_Entity (Formal);
1038 end Generate_Reference_To_Generic_Formals;
1044 function Get_Key (E : Xref_Entry_Number) return Xref_Entry_Number is
1053 function Hash (F : Xref_Entry_Number) return Header_Num is
1054 -- It is unlikely to have two references to the same entity at the same
1055 -- source location, so the hash function depends only on the Ent and Loc
1058 XE : Xref_Entry renames Xrefs.Table (F);
1059 type M is mod 2**32;
1061 H : constant M := M (XE.Key.Ent) + 2**7 * M (abs XE.Key.Loc);
1062 -- We can't use M'Mod above, because it prevents bootstrapping with
1063 -- older compilers. Loc can be negative, so we do "abs" before
1066 return Header_Num (H mod Num_Buckets);
1073 procedure HT_Set_Next (E : Xref_Entry_Number; Next : Xref_Entry_Number) is
1075 Xrefs.Table (E).HTable_Next := Next;
1082 function HT_Next (E : Xref_Entry_Number) return Xref_Entry_Number is
1084 return Xrefs.Table (E).HTable_Next;
1091 procedure Initialize is
1100 function Lt (T1, T2 : Xref_Entry) return Boolean is
1102 -- First test: if entity is in different unit, sort by unit
1104 if T1.Key.Eun /= T2.Key.Eun then
1105 return Dependency_Num (T1.Key.Eun) < Dependency_Num (T2.Key.Eun);
1107 -- Second test: within same unit, sort by entity Sloc
1109 elsif T1.Def /= T2.Def then
1110 return T1.Def < T2.Def;
1112 -- Third test: sort definitions ahead of references
1114 elsif T1.Key.Loc = No_Location then
1117 elsif T2.Key.Loc = No_Location then
1120 -- Fourth test: for same entity, sort by reference location unit
1122 elsif T1.Key.Lun /= T2.Key.Lun then
1123 return Dependency_Num (T1.Key.Lun) < Dependency_Num (T2.Key.Lun);
1125 -- Fifth test: order of location within referencing unit
1127 elsif T1.Key.Loc /= T2.Key.Loc then
1128 return T1.Key.Loc < T2.Key.Loc;
1130 -- Finally, for two locations at the same address, we prefer
1131 -- the one that does NOT have the type 'r' so that a modification
1132 -- or extension takes preference, when there are more than one
1133 -- reference at the same location. As a result, in the case of
1134 -- entities that are in-out actuals, the read reference follows
1135 -- the modify reference.
1138 return T2.Key.Typ = 'r';
1142 -----------------------
1143 -- Output_References --
1144 -----------------------
1146 procedure Output_References is
1148 procedure Get_Type_Reference
1150 Tref : out Entity_Id;
1151 Left : out Character;
1152 Right : out Character);
1153 -- Given an Entity_Id Ent, determines whether a type reference is
1154 -- required. If so, Tref is set to the entity for the type reference
1155 -- and Left and Right are set to the left/right brackets to be output
1156 -- for the reference. If no type reference is required, then Tref is
1157 -- set to Empty, and Left/Right are set to space.
1159 procedure Output_Import_Export_Info (Ent : Entity_Id);
1160 -- Output language and external name information for an interfaced
1161 -- entity, using the format <language, external_name>,
1163 ------------------------
1164 -- Get_Type_Reference --
1165 ------------------------
1167 procedure Get_Type_Reference
1169 Tref : out Entity_Id;
1170 Left : out Character;
1171 Right : out Character)
1176 -- See if we have a type reference
1185 -- Processing for types
1187 if Is_Type (Tref) then
1189 -- Case of base type
1191 if Base_Type (Tref) = Tref then
1193 -- If derived, then get first subtype
1195 if Tref /= Etype (Tref) then
1196 Tref := First_Subtype (Etype (Tref));
1198 -- Set brackets for derived type, but don't override
1199 -- pointer case since the fact that something is a
1200 -- pointer is more important.
1207 -- If non-derived ptr, get directly designated type.
1208 -- If the type has a full view, all references are on the
1209 -- partial view, that is seen first.
1211 elsif Is_Access_Type (Tref) then
1212 Tref := Directly_Designated_Type (Tref);
1216 elsif Is_Private_Type (Tref)
1217 and then Present (Full_View (Tref))
1219 if Is_Access_Type (Full_View (Tref)) then
1220 Tref := Directly_Designated_Type (Full_View (Tref));
1224 -- If the full view is an array type, we also retrieve
1225 -- the corresponding component type, because the ali
1226 -- entry already indicates that this is an array.
1228 elsif Is_Array_Type (Full_View (Tref)) then
1229 Tref := Component_Type (Full_View (Tref));
1234 -- If non-derived array, get component type. Skip component
1235 -- type for case of String or Wide_String, saves worthwhile
1238 elsif Is_Array_Type (Tref)
1239 and then Tref /= Standard_String
1240 and then Tref /= Standard_Wide_String
1242 Tref := Component_Type (Tref);
1246 -- For other non-derived base types, nothing
1252 -- For a subtype, go to ancestor subtype
1255 Tref := Ancestor_Subtype (Tref);
1257 -- If no ancestor subtype, go to base type
1260 Tref := Base_Type (Sav);
1264 -- For objects, functions, enum literals, just get type from
1267 elsif Is_Object (Tref)
1268 or else Ekind (Tref) = E_Enumeration_Literal
1269 or else Ekind (Tref) = E_Function
1270 or else Ekind (Tref) = E_Operator
1272 Tref := Etype (Tref);
1274 -- For anything else, exit
1280 -- Exit if no type reference, or we are stuck in some loop trying
1281 -- to find the type reference, or if the type is standard void
1282 -- type (the latter is an implementation artifact that should not
1283 -- show up in the generated cross-references).
1287 or else Tref = Standard_Void_Type;
1289 -- If we have a usable type reference, return, otherwise keep
1290 -- looking for something useful (we are looking for something
1291 -- that either comes from source or standard)
1293 if Sloc (Tref) = Standard_Location
1294 or else Comes_From_Source (Tref)
1296 -- If the reference is a subtype created for a generic actual,
1297 -- go actual directly, the inner subtype is not user visible.
1299 if Nkind (Parent (Tref)) = N_Subtype_Declaration
1300 and then not Comes_From_Source (Parent (Tref))
1302 (Is_Wrapper_Package (Scope (Tref))
1303 or else Is_Generic_Instance (Scope (Tref)))
1305 Tref := First_Subtype (Base_Type (Tref));
1312 -- If we fall through the loop, no type reference
1317 end Get_Type_Reference;
1319 -------------------------------
1320 -- Output_Import_Export_Info --
1321 -------------------------------
1323 procedure Output_Import_Export_Info (Ent : Entity_Id) is
1324 Language_Name : Name_Id;
1325 Conv : constant Convention_Id := Convention (Ent);
1328 -- Generate language name from convention
1330 if Conv = Convention_C then
1331 Language_Name := Name_C;
1333 elsif Conv = Convention_CPP then
1334 Language_Name := Name_CPP;
1336 elsif Conv = Convention_Ada then
1337 Language_Name := Name_Ada;
1340 -- For the moment we ignore all other cases ???
1345 Write_Info_Char ('<');
1346 Get_Unqualified_Name_String (Language_Name);
1348 for J in 1 .. Name_Len loop
1349 Write_Info_Char (Name_Buffer (J));
1352 if Present (Interface_Name (Ent)) then
1353 Write_Info_Char (',');
1354 String_To_Name_Buffer (Strval (Interface_Name (Ent)));
1356 for J in 1 .. Name_Len loop
1357 Write_Info_Char (Name_Buffer (J));
1361 Write_Info_Char ('>');
1362 end Output_Import_Export_Info;
1364 -- Start of processing for Output_References
1367 -- First we add references to the primitive operations of tagged types
1368 -- declared in the main unit.
1370 Handle_Prim_Ops : declare
1374 for J in 1 .. Xrefs.Last loop
1375 Ent := Xrefs.Table (J).Key.Ent;
1378 and then Is_Tagged_Type (Ent)
1379 and then Is_Base_Type (Ent)
1380 and then In_Extended_Main_Source_Unit (Ent)
1382 Generate_Prim_Op_References (Ent);
1385 end Handle_Prim_Ops;
1387 -- Before we go ahead and output the references we have a problem
1388 -- that needs dealing with. So far we have captured things that are
1389 -- definitely referenced by the main unit, or defined in the main
1390 -- unit. That's because we don't want to clutter up the ali file
1391 -- for this unit with definition lines for entities in other units
1392 -- that are not referenced.
1394 -- But there is a glitch. We may reference an entity in another unit,
1395 -- and it may have a type reference to an entity that is not directly
1396 -- referenced in the main unit, which may mean that there is no xref
1397 -- entry for this entity yet in the list of references.
1399 -- If we don't do something about this, we will end with an orphan type
1400 -- reference, i.e. it will point to an entity that does not appear
1401 -- within the generated references in the ali file. That is not good for
1402 -- tools using the xref information.
1404 -- To fix this, we go through the references adding definition entries
1405 -- for any unreferenced entities that can be referenced in a type
1406 -- reference. There is a recursion problem here, and that is dealt with
1407 -- by making sure that this traversal also traverses any entries that
1408 -- get added by the traversal.
1410 Handle_Orphan_Type_References : declare
1416 pragma Warnings (Off, L);
1417 pragma Warnings (Off, R);
1419 procedure New_Entry (E : Entity_Id);
1420 -- Make an additional entry into the Xref table for a type entity
1421 -- that is related to the current entity (parent, type ancestor,
1422 -- progenitor, etc.).
1428 procedure New_Entry (E : Entity_Id) is
1430 pragma Assert (Present (E));
1432 if not Has_Xref_Entry (Implementation_Base_Type (E))
1433 and then Sloc (E) > No_Location
1438 Typ => Character'First,
1439 Eun => Get_Source_Unit (Original_Location (Sloc (E))),
1442 Ent_Scope => Empty),
1443 Ent_Scope_File => No_Unit);
1447 -- Start of processing for Handle_Orphan_Type_References
1450 -- Note that this is not a for loop for a very good reason. The
1451 -- processing of items in the table can add new items to the table,
1452 -- and they must be processed as well.
1455 while J <= Xrefs.Last loop
1456 Ent := Xrefs.Table (J).Key.Ent;
1457 Get_Type_Reference (Ent, Tref, L, R);
1460 and then not Has_Xref_Entry (Tref)
1461 and then Sloc (Tref) > No_Location
1465 if Is_Record_Type (Ent)
1466 and then Present (Interfaces (Ent))
1468 -- Add an entry for each one of the given interfaces
1469 -- implemented by type Ent.
1472 Elmt : Elmt_Id := First_Elmt (Interfaces (Ent));
1474 while Present (Elmt) loop
1475 New_Entry (Node (Elmt));
1482 -- Collect inherited primitive operations that may be declared in
1483 -- another unit and have no visible reference in the current one.
1486 and then Is_Tagged_Type (Ent)
1487 and then Is_Derived_Type (Ent)
1488 and then Is_Base_Type (Ent)
1489 and then In_Extended_Main_Source_Unit (Ent)
1492 Op_List : constant Elist_Id := Primitive_Operations (Ent);
1496 function Parent_Op (E : Entity_Id) return Entity_Id;
1497 -- Find original operation, which may be inherited through
1498 -- several derivations.
1500 function Parent_Op (E : Entity_Id) return Entity_Id is
1501 Orig_Op : constant Entity_Id := Alias (E);
1504 if No (Orig_Op) then
1507 elsif not Comes_From_Source (E)
1508 and then not Has_Xref_Entry (Orig_Op)
1509 and then Comes_From_Source (Orig_Op)
1513 return Parent_Op (Orig_Op);
1518 Op := First_Elmt (Op_List);
1519 while Present (Op) loop
1520 Prim := Parent_Op (Node (Op));
1522 if Present (Prim) then
1526 Typ => Character'First,
1527 Eun => Get_Source_Unit (Sloc (Prim)),
1530 Ent_Scope => Empty),
1531 Ent_Scope_File => No_Unit);
1541 end Handle_Orphan_Type_References;
1543 -- Now we have all the references, including those for any embedded
1544 -- type references, so we can sort them, and output them.
1546 Output_Refs : declare
1548 Nrefs : constant Nat := Xrefs.Last;
1549 -- Number of references in table
1551 Rnums : array (0 .. Nrefs) of Nat;
1552 -- This array contains numbers of references in the Xrefs table.
1553 -- This list is sorted in output order. The extra 0'th entry is
1554 -- convenient for the call to sort. When we sort the table, we
1555 -- move the entries in Rnums around, but we do not move the
1556 -- original table entries.
1558 Curxu : Unit_Number_Type;
1559 -- Current xref unit
1561 Curru : Unit_Number_Type;
1562 -- Current reference unit for one entity
1567 Curnam : String (1 .. Name_Buffer'Length);
1569 -- Simple name and length of current entity
1571 Curdef : Source_Ptr;
1572 -- Original source location for current entity
1575 -- Current reference location
1578 -- Entity type character
1581 -- reference kind of previous reference
1587 -- Renaming reference
1589 Trunit : Unit_Number_Type;
1590 -- Unit number for type reference
1592 function Lt (Op1, Op2 : Natural) return Boolean;
1593 -- Comparison function for Sort call
1595 function Name_Change (X : Entity_Id) return Boolean;
1596 -- Determines if entity X has a different simple name from Curent
1598 procedure Move (From : Natural; To : Natural);
1599 -- Move procedure for Sort call
1601 package Sorting is new GNAT.Heap_Sort_G (Move, Lt);
1607 function Lt (Op1, Op2 : Natural) return Boolean is
1608 T1 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op1)));
1609 T2 : Xref_Entry renames Xrefs.Table (Rnums (Nat (Op2)));
1619 procedure Move (From : Natural; To : Natural) is
1621 Rnums (Nat (To)) := Rnums (Nat (From));
1628 -- Why a string comparison here??? Why not compare Name_Id values???
1630 function Name_Change (X : Entity_Id) return Boolean is
1632 Get_Unqualified_Name_String (Chars (X));
1634 if Name_Len /= Curlen then
1637 return Name_Buffer (1 .. Curlen) /= Curnam (1 .. Curlen);
1641 -- Start of processing for Output_Refs
1644 -- Capture the definition Sloc values. We delay doing this till now,
1645 -- since at the time the reference or definition is made, private
1646 -- types may be swapped, and the Sloc value may be incorrect. We
1647 -- also set up the pointer vector for the sort.
1649 for J in 1 .. Nrefs loop
1651 Xrefs.Table (J).Def :=
1652 Original_Location (Sloc (Xrefs.Table (J).Key.Ent));
1655 -- Sort the references
1657 Sorting.Sort (Integer (Nrefs));
1659 -- Initialize loop through references
1663 Curdef := No_Location;
1665 Crloc := No_Location;
1668 -- Loop to output references
1670 for Refno in 1 .. Nrefs loop
1671 Output_One_Ref : declare
1674 XE : Xref_Entry renames Xrefs.Table (Rnums (Refno));
1675 -- The current entry to be accessed
1679 -- Used for {} or <> or () for type reference
1681 procedure Check_Type_Reference
1683 List_Interface : Boolean);
1684 -- Find whether there is a meaningful type reference for
1685 -- Ent, and display it accordingly. If List_Interface is
1686 -- true, then Ent is a progenitor interface of the current
1687 -- type entity being listed. In that case list it as is,
1688 -- without looking for a type reference for it.
1690 procedure Output_Instantiation_Refs (Loc : Source_Ptr);
1691 -- Recursive procedure to output instantiation references for
1692 -- the given source ptr in [file|line[...]] form. No output
1693 -- if the given location is not a generic template reference.
1695 procedure Output_Overridden_Op (Old_E : Entity_Id);
1696 -- For a subprogram that is overriding, display information
1697 -- about the inherited operation that it overrides.
1699 --------------------------
1700 -- Check_Type_Reference --
1701 --------------------------
1703 procedure Check_Type_Reference
1705 List_Interface : Boolean)
1708 if List_Interface then
1710 -- This is a progenitor interface of the type for which
1711 -- xref information is being generated.
1718 Get_Type_Reference (Ent, Tref, Left, Right);
1721 if Present (Tref) then
1723 -- Case of standard entity, output name
1725 if Sloc (Tref) = Standard_Location then
1726 Write_Info_Char (Left);
1727 Write_Info_Name (Chars (Tref));
1728 Write_Info_Char (Right);
1730 -- Case of source entity, output location
1733 Write_Info_Char (Left);
1734 Trunit := Get_Source_Unit (Sloc (Tref));
1736 if Trunit /= Curxu then
1737 Write_Info_Nat (Dependency_Num (Trunit));
1738 Write_Info_Char ('|');
1742 (Int (Get_Logical_Line_Number (Sloc (Tref))));
1750 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1753 and then Present (Full_View (Ent))
1755 Ent := Underlying_Type (Ent);
1757 if Present (Ent) then
1758 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1762 Write_Info_Char (Ctyp);
1766 (Int (Get_Column_Number (Sloc (Tref))));
1768 -- If the type comes from an instantiation, add the
1769 -- corresponding info.
1771 Output_Instantiation_Refs (Sloc (Tref));
1772 Write_Info_Char (Right);
1775 end Check_Type_Reference;
1777 -------------------------------
1778 -- Output_Instantiation_Refs --
1779 -------------------------------
1781 procedure Output_Instantiation_Refs (Loc : Source_Ptr) is
1782 Iloc : constant Source_Ptr := Instantiation_Location (Loc);
1783 Lun : Unit_Number_Type;
1784 Cu : constant Unit_Number_Type := Curru;
1787 -- Nothing to do if this is not an instantiation
1789 if Iloc = No_Location then
1793 -- Output instantiation reference
1795 Write_Info_Char ('[');
1796 Lun := Get_Source_Unit (Iloc);
1798 if Lun /= Curru then
1800 Write_Info_Nat (Dependency_Num (Curru));
1801 Write_Info_Char ('|');
1804 Write_Info_Nat (Int (Get_Logical_Line_Number (Iloc)));
1806 -- Recursive call to get nested instantiations
1808 Output_Instantiation_Refs (Iloc);
1810 -- Output final ] after call to get proper nesting
1812 Write_Info_Char (']');
1815 end Output_Instantiation_Refs;
1817 --------------------------
1818 -- Output_Overridden_Op --
1819 --------------------------
1821 procedure Output_Overridden_Op (Old_E : Entity_Id) is
1825 -- The overridden operation has an implicit declaration
1826 -- at the point of derivation. What we want to display
1827 -- is the original operation, which has the actual body
1828 -- (or abstract declaration) that is being overridden.
1829 -- The overridden operation is not always set, e.g. when
1830 -- it is a predefined operator.
1835 -- Follow alias chain if one is present
1837 elsif Present (Alias (Old_E)) then
1839 -- The subprogram may have been implicitly inherited
1840 -- through several levels of derivation, so find the
1841 -- ultimate (source) ancestor.
1843 Op := Ultimate_Alias (Old_E);
1845 -- Normal case of no alias present
1852 and then Sloc (Op) /= Standard_Location
1855 Loc : constant Source_Ptr := Sloc (Op);
1856 Par_Unit : constant Unit_Number_Type :=
1857 Get_Source_Unit (Loc);
1860 Write_Info_Char ('<');
1862 if Par_Unit /= Curxu then
1863 Write_Info_Nat (Dependency_Num (Par_Unit));
1864 Write_Info_Char ('|');
1867 Write_Info_Nat (Int (Get_Logical_Line_Number (Loc)));
1868 Write_Info_Char ('p');
1869 Write_Info_Nat (Int (Get_Column_Number (Loc)));
1870 Write_Info_Char ('>');
1873 end Output_Overridden_Op;
1875 -- Start of processing for Output_One_Ref
1879 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1881 -- Skip reference if it is the only reference to an entity,
1882 -- and it is an END line reference, and the entity is not in
1883 -- the current extended source. This prevents junk entries
1884 -- consisting only of packages with END lines, where no
1885 -- entity from the package is actually referenced.
1888 and then Ent /= Curent
1889 and then (Refno = Nrefs
1891 Ent /= Xrefs.Table (Rnums (Refno + 1)).Key.Ent)
1892 and then not In_Extended_Main_Source_Unit (Ent)
1897 -- For private type, get full view type
1900 and then Present (Full_View (XE.Key.Ent))
1902 Ent := Underlying_Type (Ent);
1904 if Present (Ent) then
1905 Ctyp := Xref_Entity_Letters (Ekind (Ent));
1909 -- Special exception for Boolean
1911 if Ctyp = 'E' and then Is_Boolean_Type (Ent) then
1915 -- For variable reference, get corresponding type
1918 Ent := Etype (XE.Key.Ent);
1919 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
1921 -- If variable is private type, get full view type
1924 and then Present (Full_View (Etype (XE.Key.Ent)))
1926 Ent := Underlying_Type (Etype (XE.Key.Ent));
1928 if Present (Ent) then
1929 Ctyp := Fold_Lower (Xref_Entity_Letters (Ekind (Ent)));
1932 elsif Is_Generic_Type (Ent) then
1934 -- If the type of the entity is a generic private type,
1935 -- there is no usable full view, so retain the indication
1936 -- that this is an object.
1941 -- Special handling for access parameters and objects of
1942 -- an anonymous access type.
1944 if Ekind_In (Etype (XE.Key.Ent),
1945 E_Anonymous_Access_Type,
1946 E_Anonymous_Access_Subprogram_Type,
1947 E_Anonymous_Access_Protected_Subprogram_Type)
1949 if Is_Formal (XE.Key.Ent)
1950 or else Ekind_In (XE.Key.Ent, E_Variable, E_Constant)
1955 -- Special handling for Boolean
1957 elsif Ctyp = 'e' and then Is_Boolean_Type (Ent) then
1962 -- Special handling for abstract types and operations
1964 if Is_Overloadable (XE.Key.Ent)
1965 and then Is_Abstract_Subprogram (XE.Key.Ent)
1968 Ctyp := 'x'; -- Abstract procedure
1970 elsif Ctyp = 'V' then
1971 Ctyp := 'y'; -- Abstract function
1974 elsif Is_Type (XE.Key.Ent)
1975 and then Is_Abstract_Type (XE.Key.Ent)
1977 if Is_Interface (XE.Key.Ent) then
1980 elsif Ctyp = 'R' then
1981 Ctyp := 'H'; -- Abstract type
1985 -- Only output reference if interesting type of entity
1989 -- Suppress references to object definitions, used for local
1992 or else XE.Key.Typ = 'D'
1993 or else XE.Key.Typ = 'I'
1995 -- Suppress self references, except for bodies that act as
1998 or else (XE.Key.Loc = XE.Def
2001 or else not Is_Subprogram (XE.Key.Ent)))
2003 -- Also suppress definitions of body formals (we only
2004 -- treat these as references, and the references were
2005 -- separately recorded).
2007 or else (Is_Formal (XE.Key.Ent)
2008 and then Present (Spec_Entity (XE.Key.Ent)))
2013 -- Start new Xref section if new xref unit
2015 if XE.Key.Eun /= Curxu then
2016 if Write_Info_Col > 1 then
2020 Curxu := XE.Key.Eun;
2022 Write_Info_Initiate ('X');
2023 Write_Info_Char (' ');
2024 Write_Info_Nat (Dependency_Num (XE.Key.Eun));
2025 Write_Info_Char (' ');
2027 (Reference_Name (Source_Index (XE.Key.Eun)));
2030 -- Start new Entity line if new entity. Note that we
2031 -- consider two entities the same if they have the same
2032 -- name and source location. This causes entities in
2033 -- instantiations to be treated as though they referred
2038 (XE.Key.Ent /= Curent
2040 (Name_Change (XE.Key.Ent) or else XE.Def /= Curdef))
2042 Curent := XE.Key.Ent;
2045 Get_Unqualified_Name_String (Chars (XE.Key.Ent));
2047 Curnam (1 .. Curlen) := Name_Buffer (1 .. Curlen);
2049 if Write_Info_Col > 1 then
2053 -- Write column number information
2055 Write_Info_Nat (Int (Get_Logical_Line_Number (XE.Def)));
2056 Write_Info_Char (Ctyp);
2057 Write_Info_Nat (Int (Get_Column_Number (XE.Def)));
2059 -- Write level information
2061 Write_Level_Info : declare
2062 function Is_Visible_Generic_Entity
2063 (E : Entity_Id) return Boolean;
2064 -- Check whether E is declared in the visible part
2065 -- of a generic package. For source navigation
2066 -- purposes, treat this as a visible entity.
2068 function Is_Private_Record_Component
2069 (E : Entity_Id) return Boolean;
2070 -- Check whether E is a non-inherited component of a
2071 -- private extension. Even if the enclosing record is
2072 -- public, we want to treat the component as private
2073 -- for navigation purposes.
2075 ---------------------------------
2076 -- Is_Private_Record_Component --
2077 ---------------------------------
2079 function Is_Private_Record_Component
2080 (E : Entity_Id) return Boolean
2082 S : constant Entity_Id := Scope (E);
2085 Ekind (E) = E_Component
2086 and then Nkind (Declaration_Node (S)) =
2087 N_Private_Extension_Declaration
2088 and then Original_Record_Component (E) = E;
2089 end Is_Private_Record_Component;
2091 -------------------------------
2092 -- Is_Visible_Generic_Entity --
2093 -------------------------------
2095 function Is_Visible_Generic_Entity
2096 (E : Entity_Id) return Boolean
2101 -- The Present check here is an error defense
2103 if Present (Scope (E))
2104 and then Ekind (Scope (E)) /= E_Generic_Package
2110 while Present (Par) loop
2112 Nkind (Par) = N_Generic_Package_Declaration
2114 -- Entity is a generic formal
2119 Nkind (Parent (Par)) = N_Package_Specification
2122 Is_List_Member (Par)
2123 and then List_Containing (Par) =
2124 Visible_Declarations (Parent (Par));
2126 Par := Parent (Par);
2131 end Is_Visible_Generic_Entity;
2133 -- Start of processing for Write_Level_Info
2136 if Is_Hidden (Curent)
2137 or else Is_Private_Record_Component (Curent)
2139 Write_Info_Char (' ');
2143 or else Is_Visible_Generic_Entity (Curent)
2145 Write_Info_Char ('*');
2148 Write_Info_Char (' ');
2150 end Write_Level_Info;
2152 -- Output entity name. We use the occurrence from the
2153 -- actual source program at the definition point.
2156 Ent_Name : constant String :=
2157 Exact_Source_Name (Sloc (XE.Key.Ent));
2159 for C in Ent_Name'Range loop
2160 Write_Info_Char (Ent_Name (C));
2164 -- See if we have a renaming reference
2166 if Is_Object (XE.Key.Ent)
2167 and then Present (Renamed_Object (XE.Key.Ent))
2169 Rref := Renamed_Object (XE.Key.Ent);
2171 elsif Is_Overloadable (XE.Key.Ent)
2172 and then Nkind (Parent (Declaration_Node (XE.Key.Ent)))
2173 = N_Subprogram_Renaming_Declaration
2175 Rref := Name (Parent (Declaration_Node (XE.Key.Ent)));
2177 elsif Ekind (XE.Key.Ent) = E_Package
2178 and then Nkind (Declaration_Node (XE.Key.Ent)) =
2179 N_Package_Renaming_Declaration
2181 Rref := Name (Declaration_Node (XE.Key.Ent));
2187 if Present (Rref) then
2188 if Nkind (Rref) = N_Expanded_Name then
2189 Rref := Selector_Name (Rref);
2192 if Nkind (Rref) = N_Identifier
2193 or else Nkind (Rref) = N_Operator_Symbol
2197 -- For renamed array components, use the array name
2198 -- for the renamed entity, which reflect the fact that
2199 -- in general the whole array is aliased.
2201 elsif Nkind (Rref) = N_Indexed_Component then
2202 if Nkind (Prefix (Rref)) = N_Identifier then
2203 Rref := Prefix (Rref);
2204 elsif Nkind (Prefix (Rref)) = N_Expanded_Name then
2205 Rref := Selector_Name (Prefix (Rref));
2215 -- Write out renaming reference if we have one
2217 if Present (Rref) then
2218 Write_Info_Char ('=');
2220 (Int (Get_Logical_Line_Number (Sloc (Rref))));
2221 Write_Info_Char (':');
2223 (Int (Get_Column_Number (Sloc (Rref))));
2226 -- Indicate that the entity is in the unit of the current
2231 -- Write out information about generic parent, if entity
2234 if Is_Generic_Instance (XE.Key.Ent) then
2236 Gen_Par : constant Entity_Id :=
2239 (Unit_Declaration_Node
2241 Loc : constant Source_Ptr := Sloc (Gen_Par);
2242 Gen_U : constant Unit_Number_Type :=
2243 Get_Source_Unit (Loc);
2246 Write_Info_Char ('[');
2248 if Curru /= Gen_U then
2249 Write_Info_Nat (Dependency_Num (Gen_U));
2250 Write_Info_Char ('|');
2254 (Int (Get_Logical_Line_Number (Loc)));
2255 Write_Info_Char (']');
2259 -- See if we have a type reference and if so output
2261 Check_Type_Reference (XE.Key.Ent, False);
2263 -- Additional information for types with progenitors
2265 if Is_Record_Type (XE.Key.Ent)
2266 and then Present (Interfaces (XE.Key.Ent))
2270 First_Elmt (Interfaces (XE.Key.Ent));
2272 while Present (Elmt) loop
2273 Check_Type_Reference (Node (Elmt), True);
2278 -- For array types, list index types as well. (This is
2279 -- not C, indexes have distinct types).
2281 elsif Is_Array_Type (XE.Key.Ent) then
2285 Indx := First_Index (XE.Key.Ent);
2286 while Present (Indx) loop
2287 Check_Type_Reference
2288 (First_Subtype (Etype (Indx)), True);
2294 -- If the entity is an overriding operation, write info
2295 -- on operation that was overridden.
2297 if Is_Subprogram (XE.Key.Ent)
2298 and then Present (Overridden_Operation (XE.Key.Ent))
2300 Output_Overridden_Op
2301 (Overridden_Operation (XE.Key.Ent));
2304 -- End of processing for entity output
2306 Crloc := No_Location;
2309 -- Output the reference if it is not as the same location
2310 -- as the previous one, or it is a read-reference that
2311 -- indicates that the entity is an in-out actual in a call.
2313 if XE.Key.Loc /= No_Location
2315 (XE.Key.Loc /= Crloc
2316 or else (Prevt = 'm' and then XE.Key.Typ = 'r'))
2318 Crloc := XE.Key.Loc;
2319 Prevt := XE.Key.Typ;
2321 -- Start continuation if line full, else blank
2323 if Write_Info_Col > 72 then
2325 Write_Info_Initiate ('.');
2328 Write_Info_Char (' ');
2330 -- Output file number if changed
2332 if XE.Key.Lun /= Curru then
2333 Curru := XE.Key.Lun;
2334 Write_Info_Nat (Dependency_Num (Curru));
2335 Write_Info_Char ('|');
2339 (Int (Get_Logical_Line_Number (XE.Key.Loc)));
2340 Write_Info_Char (XE.Key.Typ);
2342 if Is_Overloadable (XE.Key.Ent)
2343 and then Is_Imported (XE.Key.Ent)
2344 and then XE.Key.Typ = 'b'
2346 Output_Import_Export_Info (XE.Key.Ent);
2349 Write_Info_Nat (Int (Get_Column_Number (XE.Key.Loc)));
2351 Output_Instantiation_Refs (Sloc (XE.Key.Ent));
2362 end Output_References;
2365 -- Reset is necessary because Elmt_Ptr does not default to Null_Ptr,
2366 -- because it's not an access type.